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 ClearState = "Clear";
  25         public static final String FinalState = "Final";
  26         public static final String PrintState = "Print";
  27         public static final String Commutativity = "Commutativity";
  28
  29         // Define construct
  30         public static final String Define = "Define";
  31
  32         // Interface construct
  33         public static final String Interface = "Interface";
  34         public static final String Transition = "Transition";
  35         public static final String PreCondition = "PreCondition";
  36         public static final String JustifyingCondition = "JustifyingCondition";
  37         public static final String SideEffect = "SideEffect";
  38         public static final String PostCondition = "PostCondition";
  39         public static final String PrintValue = "Print";
  40
  41         public static final String PrintStateType = "PRINT_STATE";
  42         public static final String PrintValueType = "PRINT_VALUE";
  43         public static final String TransitionType = "TRANSITION";
  44         public static final String PreConditionType = "PRE_CONDITION";
  45         public static final String JustifyingConditionType = "JUSTIFYING_CONDITION";
  46         public static final String SideEffectType = "SIDE_EFFECT";
  47         public static final String PostConditionType = "POST_CONDITION";
  48
  49         // Ordering point construct
  50         public static final String OPDefine = "OPDefine";
  51         public static final String PotentialOP = "PotentialOP";
  52         public static final String OPCheck = "OPCheck";
  53         public static final String OPClear = "OPClear";
  54         public static final String OPClearDefine = "OPClearDefine";
  55         // Entry construct
  56         public static final String Entry = "Entry";
  57
  58         // Generated header file name
  59         public static final String CDSSpecGeneratedName = "cdsspec-generated";
  60         public static final String CDSSpecGeneratedHeader = "\""
  61                         + CDSSpecGeneratedName + ".h\"";
  62         // Generated hedaer file comment
  63         public static final String CDSSpecGeneratedHeaderComment = "This is a header file auto-generated by CDSSpec compiler; together, CDSSpec\n"
  64                         + "compiler should have generated the accompanying implementation file that\n"
  65                         + "implements the some functions declared in this file. In order to instrument\n"
  66                         + "your benchmark for CDSSpec checker to check, you should include this header\n"
  67                         + "file in every file you use an CDSSpec annotation. Note that it should be\n"
  68                         + "placed in the end of all other header files. Currently we require a C++\n"
  69                         + "compiler that supports C++11.";
  70
  71         // Generated CPP file name
  72         public static final String CDSSpecGeneratedCPP = "cdsspec-generated.cc";
  73         // Generated CPP file comment
  74         public static final String CDSSpecGeneratedCPPComment = "This is an implementation file auto-generated by CDSSpec compiler to\n"
  75                         + "instrument your benchmark for CDSSpec checker to check. Currently we require\n"
  76                         + "a C++ compiler that supports C++11.";
  77
  78         // Pre-included header files
  79         public static final HashSet<String> includedHeaders;
  80         public static final ArrayList<String> includedHeadersList;
  81
  82         public static final String ATOMIC = "<atomic>";
  83         public static final String THREADS = "<threads.h>";
  84         public static final String STDATOMIC = "<stdatomic.h>";
  85         public static final String STDLIB = "<stdlib.h>";
  86         public static final String STDIO = "<stdio.h>";
  87
  88         public static final String MODELTYPES = "<modeltypes.h>";
  89         public static final String CDSANNOTATE = "<cdsannotate.h>";
  90         public static final String MYMEMORY = "\"mymemory.h\"";
  91         public static final String MODELASSERT = "\"model-assert.h\"";
  92         public static final String LIBRACE = "\"librace.h\"";
  93         public static final String SPECANNOTATION = "\"specannotation.h\"";
  94         public static final String SPEC_COMMON = "\"spec_common.h\"";
  95         public static final String CDSSPEC = "\"cdsspec.h\"";
  96         public static final String METHODCALL = "\"methodcall.h\"";
  97
  98         // Header files to include in the cdsspec-generated.h
  99         public static final String SPECANNOTATION_API = "\"specannotation-api.h\"";
 100
 101         // Header files to include in the cdsspec-generated.cc
 102         // <cdsannotate.h>
 103         // "spec_common.h"
 104         // "methodcall.h"
 105         // "cdsspec.h"
 106         // "specannotation.h"
 107
 108         static {
 109                 // Initialize the header set and list
 110                 includedHeaders = new HashSet<String>();
 111                 includedHeadersList = new ArrayList<String>();
 112
 113                 // Add each header to the set
 114                 includedHeadersList.add(ATOMIC);
 115                 includedHeadersList.add(THREADS);
 116                 includedHeadersList.add(STDATOMIC);
 117                 includedHeadersList.add(STDLIB);
 118                 includedHeadersList.add(STDIO);
 119
 120                 includedHeadersList.add(MODELTYPES);
 121                 includedHeadersList.add(CDSANNOTATE);
 122                 includedHeadersList.add(MYMEMORY);
 123                 includedHeadersList.add(MODELASSERT);
 124                 includedHeadersList.add(LIBRACE);
 125                 includedHeadersList.add(SPECANNOTATION);
 126                 includedHeadersList.add(SPEC_COMMON);
 127                 includedHeadersList.add(METHODCALL);
 128                 includedHeadersList.add(CDSSPEC);
 129
 130                 // Add files to list
 131                 for (String header : includedHeadersList) {
 132                         includedHeaders.add(header);
 133                 }
 134         }
 135
 136         public static boolean isPreIncludedHeader(String header) {
 137                 return includedHeaders.contains(header)
 138                                 || header.equals(CDSSpecGeneratedHeader);
 139         }
 140
 141         // Some CDSSpec keywords and function names
 142         public static final String NewSize = "NEW_SIZE";
 143         public static final String New = "NEW";
 144         // Some CDSSpec types
 145         public static final String CString = "CSTR";
 146         public static final String EmptyCString = "_EMPTY";
 147         public static final String NullFunc = "NULL_FUNC";
 148
 149         public static final String StateStruct = "StateStruct";
 150         public static final String Method = "Method";
 151         public static final String MethodValueField = "value";
 152         public static final String CommutativityRule = "CommutativityRule";
 153         public static final String StateFunctions = "StateFunctions";
 154         public static final String NamedFunction = "NamedFunction";
 155
 156         public static final String SPEC_ANALYSIS = "SPEC_ANALYSIS";
 157         // Spec annotations
 158         public static final String AnnoInit = "AnnoInit";
 159         public static final String AnnoTypeInit = "INIT";
 160         public static final String AnnoInterfaceInfo = "AnnoInterfaceInfo";
 161         public static final String CAnnoInterfaceInfo = "CAnnoInterfaceInfo";
 162         public static final String SpecAnnotation = "SpecAnnotation";
 163
 164         // Some CDSSpec state functions
 165         public static final String InitialFunc = "_Initial";
 166         public static final String CopyFunc = "_Copy";
 167         public static final String FinalFunc = "_Final";
 168         public static final String PrintStateFunc = "_PrintState";
 169
 170         // Functions for instrumenting annotation
 171         public static final String CreateInitAnnoFunc = "_createInitAnnotation";
 172         public static final String CreateInterfaceBeginAnnoFunc = "_createInterfaceBeginAnnotation";
 173         public static final String SetInterfaceBeginAnnoValueFunc = "_setInterfaceBeginAnnotationValue";
 174         public static final String CreateInterfaceEndAnnoFunc = "_createInterfaceEndAnnotation";
 175         public static final String CreateOPDefineAnnoFunc = "_createOPDefineAnnotation";
 176         public static final String CreateOPDefineUnattachedFunc = "_createOPDefineUnattached";
 177         public static final String CreateOPClearDefineUnattachedFunc = "_createOPClearDefineUnattached";
 178         public static final String CreatePotentialOPAnnoFunc = "_createPotentialOPAnnotation";
 179         public static final String CreateOPCheckAnnoFunc = "_createOPCheckAnnotation";
 180         public static final String CreateOPClearAnnoFunc = "_createOPClearAnnotation";
 181         public static final String CreateOPClearDefineAnnoFunc = "_createOPClearDefineAnnotation";
 182
 183         // Other CDSSpec functions
 184         public static final String AddInterfaceFunctions = "addInterfaceFunctions";
 185         public static final String CDSAnnotateFunc = "cdsannotate";
 186         public static final String PRINT = "PRINT";
 187         public static final String PrintContainer = "printContainer";
 188         public static final String PrintMap = "printMap";
 189
 190         // Special instances
 191         public static final String Method1 = "_M";
 192         public static final String Method2 = "_exec";
 193         public static final String StateInst = "state";
 194         public static final String OldStateInst = "OLD";
 195         public static final String NewStateInst = "NEW";
 196         // Specification types and macros
 197         public static final String RET = "RET";
 198         public static final String InterfaceValueInst = "__value";
 199
 200         // The fake ordering point operation
 201         public static final String FakeOP = "_FAKE_OP_";
 202
 203         // The wrapper prefix that we want to attach to the function name
 204         public static final String WrapperPrefix = "Wrapper";
 205
 206         public static final String CommutativityRuleInst = "commuteRules";
 207         public static final String CommutativityRuleSizeInst = "CommuteRuleSize";
 208         public static final String StateFunctionsInst = "stateFuncs";
 209         public static final String AnnoInitInst = "init";
 210         public static final String AnnoInterfaceInfoInst = "info";
 211
 212         public static String AppendStr(String original) {
 213                 return "_" + original + "_str";
 214         }
 215
 216         public static String CheckCommutativity(int ruleNum) {
 217                 return "_checkCommutativity" + ruleNum;
 218         }
 219
 220 }