src/edu/uci/eecs/specExtraction/SpecNaming.java

   1 package edu.uci.eecs.specExtraction;
   2
   3 import java.util.ArrayList;
   4 import java.util.Collections;
   5 import java.util.HashSet;
   6
   7 /**
   8  * <p>
   9  * This class contains most of the constant strings that we will be using
  10  * throughout the whole annotation extraction and code generation process.
  11  * </p>
  12  *
  13  * @author Peizhao Ou
  14  *
  15  */
  16 public class SpecNaming {
  17
  18         // Specification annotation naming
  19
  20         // Global construct
  21         public static final String DeclareState = "DeclareState";
  22         public static final String InitalState = "Initial";
  23         public static final String CopyState = "Copy";
  24         public static final String FinalState = "Final";
  25         public static final String PrintState = "Print";
  26         public static final String Commutativity = "Commutativity";
  27
  28         // Interface construct
  29         public static final String Interface = "Interface";
  30         public static final String Transition = "Transition";
  31         public static final String PreCondition = "PreCondition";
  32         public static final String SideEffect = "SideEffect";
  33         public static final String PostCondition = "PostCondition";
  34         public static final String PrintValue = "Print";
  35
  36         public static final String PrintStateType = "PRINT_STATE";
  37         public static final String PrintValueType = "PRINT_VALUE";
  38         public static final String TransitionType = "TRANSITION";
  39         public static final String PreConditionType = "PRE_CONDITION";
  40         public static final String SideEffectType = "SIDE_EFFECT";
  41         public static final String PostConditionType = "POST_CONDITION";
  42
  43         // Ordering point construct
  44         public static final String OPDefine = "OPDefine";
  45         public static final String PotentialOP = "PotentialOP";
  46         public static final String OPCheck = "OPCheck";
  47         public static final String OPClear = "OPClear";
  48         public static final String OPClearDefine = "OPClearDefine";
  49         // Entry construct
  50         public static final String Entry = "Entry";
  51
  52         // Generated header file name
  53         public static final String CDSSpecGeneratedName = "cdsspec-generated";
  54         public static final String CDSSpecGeneratedHeader = "\""
  55                         + CDSSpecGeneratedName + ".h\"";
  56         // Generated hedaer file comment
  57         public static final String CDSSpecGeneratedHeaderComment = "This is a header file auto-generated by CDSSpec compiler; together, CDSSpec\n"
  58                         + "compiler should have generated the accompanying implementation file that\n"
  59                         + "implements the some functions declared in this file. In order to instrument\n"
  60                         + "your benchmark for CDSSpec checker to check, you should include this header\n"
  61                         + "file in every file you use an CDSSpec annotation. Note that it should be\n"
  62                         + "placed in the end of all other header files. Currently we require a C++\n"
  63                         + "compiler that supports C++11.";
  64
  65         // Generated CPP file name
  66         public static final String CDSSpecGeneratedCPP = "cdsspec-generated.cc";
  67         // Generated CPP file comment
  68         public static final String CDSSpecGeneratedCPPComment = "This is an implementation file auto-generated by CDSSpec compiler to\n"
  69                         + "instrument your benchmark for CDSSpec checker to check. Currently we require\n"
  70                         + "a C++ compiler that supports C++11.";
  71
  72         // Pre-included header files
  73         public static final HashSet<String> includedHeaders;
  74         public static final ArrayList<String> includedHeadersList;
  75
  76         public static final String ATOMIC = "<atomic>";
  77         public static final String THREADS = "<threads.h>";
  78         public static final String STDATOMIC = "<stdatomic.h>";
  79         public static final String STDLIB = "<stdlib.h>";
  80         public static final String STDIO = "<stdio.h>";
  81
  82         public static final String MODELTYPES = "<modeltypes.h>";
  83         public static final String CDSANNOTATE = "<cdsannotate.h>";
  84         public static final String MYMEMORY = "\"mymemory.h\"";
  85         public static final String MODELASSERT = "\"model-assert.h\"";
  86         public static final String LIBRACE = "\"librace.h\"";
  87         public static final String SPECANNOTATION = "\"specannotation.h\"";
  88         public static final String SPECCOMMON = "\"spec_common.h\"";
  89         public static final String CDSSPEC = "\"cdsspec.h\"";
  90         public static final String METHODCALL = "\"methodcall.h\"";
  91
  92         static {
  93                 // Initialize the header set and list
  94                 includedHeaders = new HashSet<String>();
  95                 includedHeadersList = new ArrayList<String>();
  96
  97                 // Add each header to the set
  98                 includedHeadersList.add(ATOMIC);
  99                 includedHeadersList.add(THREADS);
 100                 includedHeadersList.add(STDATOMIC);
 101                 includedHeadersList.add(STDLIB);
 102                 includedHeadersList.add(STDIO);
 103
 104                 includedHeadersList.add(MODELTYPES);
 105                 includedHeadersList.add(CDSANNOTATE);
 106                 includedHeadersList.add(MYMEMORY);
 107                 includedHeadersList.add(MODELASSERT);
 108                 includedHeadersList.add(LIBRACE);
 109                 includedHeadersList.add(SPECANNOTATION);
 110                 includedHeadersList.add(SPECCOMMON);
 111                 includedHeadersList.add(METHODCALL);
 112                 includedHeadersList.add(CDSSPEC);
 113
 114                 // Add files to list
 115                 for (String header : includedHeadersList) {
 116                         includedHeaders.add(header);
 117                 }
 118         }
 119
 120         public static boolean isPreIncludedHeader(String header) {
 121                 return includedHeaders.contains(header)
 122                                 || header.equals(CDSSpecGeneratedHeader);
 123         }
 124
 125         // Some CDSSpec keywords and function names
 126         public static final String NewSize = "NEW_SIZE";
 127         // Some CDSSpec types
 128         public static final String CString = "CSTR";
 129         public static final String EmptyCString = "_EMPTY";
 130         public static final String NullFunc = "NULL_FUNC";
 131
 132         public static final String StateStruct = "StateStruct";
 133         public static final String Method = "Method";
 134         public static final String CommutativityRule = "CommutativityRule";
 135         public static final String StateFunctions = "StateFunctions";
 136         public static final String NamedFunction = "NamedFunction";
 137
 138         public static final String SPEC_ANALYSIS = "SPEC_ANALYSIS";
 139         // Spec annotations
 140         public static final String AnnoInit = "AnnoInit";
 141         public static final String AnnoTypeInit = "INIT";
 142         public static final String AnnoInterfaceInfo = "AnnoInterfaceInfo";
 143         public static final String SpecAnnotation = "SpecAnnotation";
 144
 145         // Some CDSSpec state functions
 146         public static final String InitialFunc = "_Initial";
 147         public static final String CopyFunc = "_Copy";
 148         public static final String FinalFunc = "_Final";
 149         public static final String PrintStateFunc = "_PrintState";
 150
 151         // Functions for instrumenting annotation
 152         public static final String CreateInitAnnoFunc = "_createInitAnnotation";
 153         public static final String CreateInterfaceBeginAnnoFunc = "_createInterfaceBeginAnnotation";
 154         public static final String CreateOPDefineAnnoFunc = "_createOPDefineAnnotation";
 155         public static final String CreatePotentialOPAnnoFunc = "_createPotentialOPAnnotation";
 156         public static final String CreateOPCheckAnnoFunc = "_createOPCheckAnnotation";
 157         public static final String CreateOPClearAnnoFunc = "_createOPClearAnnotation";
 158         public static final String CreateOPClearDefineAnnoFunc = "_createOPClearDefineAnnotation";
 159
 160         // Other CDSSpec functions
 161         public static final String AddInterfaceFunctions = "addInterfaceFunctions";
 162         public static final String CDSAnnotateFunc = "cdsannotate";
 163
 164         // Special instances
 165         public static final String Method1 = "_M";
 166         public static final String Method2 = "_exec";
 167         public static final String StateInst = "state";
 168         public static final String OldStateInst = "OLD";
 169         public static final String NewStateInst = "NEW";
 170         // Specification types and macros
 171         public static final String RET = "RET";
 172
 173         // The wrapper prefix that we want to attach to the function name
 174         public static final String WrapperPrefix = "Wrapper";
 175
 176         public static final String CommutativityRuleInst = "commuteRules";
 177         public static final String CommutativityRuleSizeInst = "CommuteRuleSize";
 178         public static final String StateFunctionsInst = "stateFuncs";
 179         public static final String AnnoInitInst = "init";
 180         public static final String AnnoInterfaceInfoInst = "info";
 181
 182         public static String AppendStr(String original) {
 183                 return "_" + original + "_str";
 184         }
 185
 186         public static String CheckCommutativity(int ruleNum) {
 187                 return "_checkCommutativity" + ruleNum;
 188         }
 189
 190 }