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