add spsc
[cdsspec-compiler.git] / src / edu / uci / eecs / specCompiler / codeGenerator / CodeVariables.java
index c87e6883681c5196185fc1962a006bdc555cb514..ea1cb66dcdf3c9799d32261cb46b029d18a70eb7 100644 (file)
@@ -1,6 +1,7 @@
 package edu.uci.eecs.specCompiler.codeGenerator;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.io.File;
 
@@ -26,6 +27,7 @@ public class CodeVariables {
        public static final String HEADER_STDLIB = "<stdlib.h>";
        public static final String HEADER_THREADS = "<threads.h>";
        public static final String HEADER_STDINT = "<stdint.h>";
+       public static final String HEADER_MODELMEMORY = "<model_memory.h>";
        public static final String ThreadIDType = "thrd_t";
        public static final String GET_THREAD_ID = "thrd_current";
        public static final String BOOLEAN = "bool";
@@ -36,13 +38,14 @@ public class CodeVariables {
        public static final String HEADER_COMMON = "<common.h>";
        public static final String HEADER_SPECANNOTATION = "<specannotation.h>";
        public static final String HEADER_CDSTRACE = "<cdstrace.h>";
+       public static final String CDSAnnotate = "cdsannotate";
+       public static final String C_CDSAnnotate = "_Z11cdsannotatemPv";
        // public static final String CDSAnnotate = "cdsannotate";
-       public static final String CDSAnnotate = "_Z11cdsannotatemPv";
        public static final String CDSAnnotateType = "SPEC_ANALYSIS";
        public static final String IDType = "call_id_t";
 
        public static final String SPEC_ANNO_TYPE = "spec_anno_type";
-       public static final String SPEC_ANNO_TYPE_FUNC_TABLE_INIT = "FUNC_TABLE_INIT";
+       public static final String SPEC_ANNO_TYPE_INIT = "INIT";
        public static final String SPEC_ANNO_TYPE_HB_INIT = "HB_INIT";
        public static final String SPEC_ANNO_TYPE_INTERFACE_BEGIN = "INTERFACE_BEGIN";
        public static final String SPEC_ANNO_TYPE_HB_CONDITION = "HB_CONDITION";
@@ -54,11 +57,11 @@ public class CodeVariables {
        public static final String SPEC_ANNOTATION_FIELD_TYPE = "type";
        public static final String SPEC_ANNOTATION_FIELD_ANNO = "annotation";
 
-       public static final String ANNO_FUNC_TABLE_INIT = "anno_func_table_init";
+       public static final String ANNO_INIT = "anno_init";
        public static final String ANNO_HB_INIT = "anno_hb_init";
        public static final String ANNO_INTERFACE_BEGIN = "anno_interface_begin";
        public static final String ANNO_INTERFACE_END = "anno_interface_end";
-       public static final String ANNO_POTENTIAL_CP_DEFINE = "anno_potentail_cp_define";
+       public static final String ANNO_POTENTIAL_CP_DEFINE = "anno_potential_cp_define";
        public static final String ANNO_CP_DEFINE = "anno_cp_define";
        public static final String ANNO_CP_DEFINE_CHECK = "anno_cp_define_check";
        public static final String ANNO_HB_CONDITION = "anno_hb_condition";
@@ -78,11 +81,22 @@ public class CodeVariables {
        public static final String SPEC_TAG_CURRENT = "current";
        public static final String SPEC_TAG_NEXT = "next";
 
+
        // Macro
        public static final String MACRO_ID = "__ID__";
        public static final String MACRO_COND = "__COND_SAT__";
        public static final String MACRO_RETURN = "__RET__";
        public static final String MACRO_ATOMIC_RETURN = "__ATOMIC_RET__";
+       
+       public static String CDSAnnotate(SemanticsChecker semantics) {
+               String LANG = semantics.getOption("LANG");
+               boolean isCPP = LANG == null || !LANG.equals("C");
+               if (isCPP) {
+                       return CDSAnnotate;
+               } else {
+                       return C_CDSAnnotate;
+               }
+       }
 
        public static void printCode(ArrayList<String> code) {
                for (int i = 0; i < code.size(); i++) {
@@ -158,8 +172,8 @@ public class CodeVariables {
                return type + " " + var + " = " + val + ";";
        }
 
-       private static String ANNOTATE(String structName) {
-               return CDSAnnotate + "(" + CDSAnnotateType + ", " + structName + ");";
+       private static String ANNOTATE(SemanticsChecker semantics, String structName) {
+               return CDSAnnotate(semantics) + "(" + CDSAnnotateType + ", " + structName + ");";
        }
 
        private static ArrayList<String> DEFINE_INFO_STRUCT(String interfaceName,
@@ -194,8 +208,9 @@ public class CodeVariables {
                        InterfaceConstruct construct, FunctionHeader header) {
                String interfaceName = construct.name;
                ArrayList<String> code = new ArrayList<String>();
-               code.add("inline static bool " + interfaceName + "_check_action(void *info, "
-                               + IDType + " " + MACRO_ID + ") {");
+               code.add("inline static bool " + interfaceName
+                               + "_check_action(void *info, " + IDType + " " + MACRO_ID
+                               + ") {");
                code.add(DECLARE("bool", "check_passed"));
                // Read info struct
                if (!header.returnType.equals("void") || header.args.size() != 0) {
@@ -243,12 +258,20 @@ public class CodeVariables {
                return code;
        }
 
-       private static HashSet<String> getAllHeaders(SemanticsChecker semantics) {
+       public static HashSet<String> getAllHeaders(SemanticsChecker semantics) {
                HashSet<String> headers = new HashSet<String>();
                for (String interfaceName : semantics.interfaceName2Construct.keySet()) {
                        File f = semantics.interfaceName2Construct.get(interfaceName).file;
                        headers.addAll(semantics.srcFilesInfo.get(f).headers);
                }
+               headers.add(HEADER_STDLIB);
+               headers.add(HEADER_STDINT);
+               headers.add(HEADER_MODELMEMORY);
+               headers.add(HEADER_STDINT);
+               headers.add(HEADER_CDSANNOTATE);
+//             headers.add(HEADER_COMMON);
+               headers.add(HEADER_SPEC_LIB);
+               headers.add(HEADER_SPECANNOTATION);
                return headers;
        }
 
@@ -291,20 +314,6 @@ public class CodeVariables {
                ArrayList<String> newCode = new ArrayList<String>();
                HashSet<String> allHeaders = getAllHeaders(semantics);
 
-               // All headers needed by the interface decalration
-               newCode.add(COMMENT("Include all the header files that contains the interface declaration"));
-               for (String header : allHeaders) {
-                       newCode.add(INCLUDE(header));
-               }
-               newCode.add("");
-               // Other necessary headers
-               newCode.add(INCLUDE(HEADER_STDLIB));
-               newCode.add(INCLUDE(HEADER_STDINT));
-               newCode.add(INCLUDE(HEADER_CDSANNOTATE));
-               newCode.add(INCLUDE(HEADER_COMMON));
-               newCode.add(INCLUDE(HEADER_SPEC_LIB));
-               newCode.add(INCLUDE(HEADER_SPECANNOTATION));
-               newCode.add("");
 
                SequentialDefineSubConstruct code = construct.code;
                // User-defined structs first
@@ -365,7 +374,11 @@ public class CodeVariables {
                String interfaceSize = Integer
                                .toString(semantics.interfaceName2Construct.size());
                newCode.add(DEFINE("INTERFACE_SIZE", interfaceSize));
-               newCode.add(DECLARE("void**", "func_ptr_table"));
+               // Make it static
+               newCode.add("static " + DECLARE("void**", "func_ptr_table"));
+               // Happens-before initialization rules
+               // Should make it static
+               newCode.add("static " + DECLARE(ANNO_HB_INIT + "**", "hb_init_table"));
 
                newCode.add("");
                newCode.add(COMMENT("Define function for sequential code initialization"));
@@ -382,22 +395,28 @@ public class CodeVariables {
                        newCode.add(ASSIGN("func_ptr_table[2 * " + interfaceNum + " + 1]",
                                        "(void*) &" + interfaceName + "_check_action"));
                }
+               // Init Happens-before rules table
+               newCode.addAll(generateHBInitAnnotation(semantics));
+
+               // Pass init info, including function table info & HB rules
+               newCode.add(COMMENT("Pass init info, including function table info & HB rules"));
+               String structName = "anno_init", anno = "init";
+               newCode.add(STRUCT_NEW_DECLARE_DEFINE(ANNO_INIT, structName));
+               newCode.add(ASSIGN_TO_PTR(structName, "func_table", "func_ptr_table"));
+               newCode.add(ASSIGN_TO_PTR(structName, "func_table_size",
+                               "INTERFACE_SIZE"));
+               newCode.add(ASSIGN_TO_PTR(structName, "hb_init_table", "hb_init_table"));
+               newCode.add(ASSIGN_TO_PTR(structName, "hb_init_table_size",
+                               "HB_INIT_TABLE_SIZE"));
+               newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
+               newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_INIT));
+               newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
+               newCode.add(ANNOTATE(semantics, anno));
+
                newCode.add("");
                // Init user-defined variables
                newCode.addAll(construct.code.initVar);
-               // Pass function table info
-               newCode.add(COMMENT("Pass function table info"));
-               String structName = "anno_func_table_init", anno = "func_init";
-               newCode.add(STRUCT_NEW_DECLARE_DEFINE(ANNO_FUNC_TABLE_INIT, structName));
-               newCode.add(ASSIGN_TO_PTR(structName, "size", "INTERFACE_SIZE"));
-               newCode.add(ASSIGN_TO_PTR(structName, "table", "func_ptr_table"));
-               newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
-               newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_FUNC_TABLE_INIT));
-               newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-               newCode.add(ANNOTATE(anno));
 
-               // Pass Happens-before relationship
-               newCode.addAll(generateHBInitAnnotation(semantics));
                newCode.add("}");
                newCode.add(COMMENT("End of Global construct generation in class"));
 
@@ -421,6 +440,7 @@ public class CodeVariables {
                String templateDecl = semantics.getTemplateFullStr();
                if (templateList == null) {
                        newCode.add(DECLARE("void**", varPrefix + "func_ptr_table"));
+                       newCode.add(DECLARE("anno_hb_init**", varPrefix + "hb_init_table"));
                        for (int i = 0; i < construct.code.declareVar.size(); i++) {
                                VariableDeclaration varDecl = construct.code.declareVar.get(i);
                                newCode.add(DECLARE(varDecl.type, varPrefix + varDecl.name));
@@ -428,6 +448,8 @@ public class CodeVariables {
                } else {
                        newCode.add(templateDecl);
                        newCode.add(DECLARE("void**", varPrefix + "func_ptr_table"));
+                       newCode.add(templateDecl);
+                       newCode.add(DECLARE("anno_hb_init**", varPrefix + "hb_init_table"));
                        for (int i = 0; i < construct.code.declareVar.size(); i++) {
                                VariableDeclaration varDecl = construct.code.declareVar.get(i);
                                newCode.add(templateDecl);
@@ -440,12 +462,13 @@ public class CodeVariables {
        private static ArrayList<String> generateHBInitAnnotation(
                        SemanticsChecker semantics) {
                ArrayList<String> newCode = new ArrayList<String>();
+
                int hbConditionInitIdx = 0;
                for (ConditionalInterface left : semantics.getHBConditions().keySet()) {
                        for (ConditionalInterface right : semantics.getHBConditions().get(
                                        left)) {
                                String structVarName = "hbConditionInit" + hbConditionInitIdx;
-                               String annotationVarName = "hb_init" + hbConditionInitIdx;
+                               // String annotationVarName = "hb_init" + hbConditionInitIdx;
                                hbConditionInitIdx++;
                                String interfaceNumBefore = Integer
                                                .toString(semantics.interface2Num
@@ -469,36 +492,55 @@ public class CodeVariables {
                                newCode.add(ASSIGN_TO_PTR(structVarName,
                                                "hb_condition_num_after", hbLabelNumAfter));
 
-                               newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION,
-                                               annotationVarName));
-                               newCode.add(ASSIGN_TO_PTR(annotationVarName,
-                                               SPEC_ANNOTATION_FIELD_TYPE, SPEC_ANNO_TYPE_HB_INIT));
-                               newCode.add(ASSIGN_TO_PTR(annotationVarName,
-                                               SPEC_ANNOTATION_FIELD_ANNO, structVarName));
-                               newCode.add(ANNOTATE(annotationVarName));
+                               // newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION,
+                               // annotationVarName));
+                               // newCode.add(ASSIGN_TO_PTR(annotationVarName,
+                               // SPEC_ANNOTATION_FIELD_TYPE, SPEC_ANNO_TYPE_HB_INIT));
+                               // newCode.add(ASSIGN_TO_PTR(annotationVarName,
+                               // SPEC_ANNOTATION_FIELD_ANNO, structVarName));
+                               // newCode.add(ANNOTATE(annotationVarName));
                        }
                }
+               // Init hb_init_table
+               newCode.add(COMMENT("Init hb_init_table"));
+               newCode.add(ASSIGN("hb_init_table", "(" + ANNO_HB_INIT
+                               + "**) malloc(sizeof(" + ANNO_HB_INIT + "*) * "
+                               + hbConditionInitIdx + ")"));
+               // Define HB_INIT_TABLE_SIZE
+               newCode.add(DEFINE("HB_INIT_TABLE_SIZE",
+                               Integer.toString(hbConditionInitIdx)));
+               for (int i = 0; i < hbConditionInitIdx; i++) {
+                       newCode.add(ASSIGN("hb_init_table[" + i + "]", "hbConditionInit"
+                                       + i));
+               }
                return newCode;
        }
 
        public static ArrayList<String> generateEntryPointInitCall() {
-               ArrayList<String> newCode = new ArrayList<String>(1);
+               ArrayList<String> newCode = new ArrayList<String>();
                newCode.add("__sequential_init();");
                return newCode;
        }
 
        // Only generate the declaration of the wrapper, don't do any renaming
-       public static ArrayList<String> generateInterfaceWrapperDeclaration(
-                       SemanticsChecker semantics, InterfaceConstruct construct) {
-               ArrayList<String> newCode = new ArrayList<String>();
+//     public static ArrayList<String> generateInterfaceWrapperDeclaration(
+//                     SemanticsChecker semantics, InterfaceConstruct construct) {
+//             ArrayList<String> newCode = new ArrayList<String>();
+//             FunctionHeader header = getFunctionHeader(semantics, construct);
+//             newCode.add(COMMENT("Declaration of the wrapper"));
+//             String templateStr = header.getTemplateFullStr();
+//             newCode.add(templateStr);
+//             newCode.add(header.getFuncStr() + ";");
+//             newCode.add("");
+//
+//             return newCode;
+//     }
+       
+       public static ArrayList<String> generateInterfaceWrapperDeclaration(SemanticsChecker semantics, InterfaceConstruct construct) {
                FunctionHeader header = getFunctionHeader(semantics, construct);
-               newCode.add(COMMENT("Declaration of the wrapper"));
-               String templateStr = header.getTemplateFullStr();
-               newCode.add(templateStr);
-               newCode.add(header.getFuncStr() + ";");
-               newCode.add("");
-
-               return newCode;
+               ArrayList<String> declaration = new ArrayList<String>();
+               declaration.add(header.getRenamedHeader(SPEC_INTERFACE_WRAPPER).getDeclaration() + ";");
+               return declaration;
        }
 
        // Only generate the definition of the wrapper, don't do any renaming
@@ -506,16 +548,11 @@ public class CodeVariables {
                        SemanticsChecker semantics, InterfaceConstruct construct) {
                ArrayList<String> newCode = new ArrayList<String>();
                String interfaceName = construct.name;
-               // Generate necessary header file (might be redundant but never mind)
-               newCode.add(INCLUDE(HEADER_STDLIB));
-               newCode.add(INCLUDE(HEADER_CDSANNOTATE));
-               newCode.add(INCLUDE(HEADER_SPECANNOTATION));
-               newCode.add(INCLUDE(HEADER_SPEC_LIB));
 
                FunctionHeader header = getFunctionHeader(semantics, construct);
                String interfaceNum = Integer.toString(semantics.interface2Num
                                .get(construct.name));
-                       
+
                newCode.add(header.getTemplateFullStr());
                newCode.add(header.getFuncStr() + " {");
                // Wrapper function body
@@ -529,7 +566,7 @@ public class CodeVariables {
                newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
                newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_INTERFACE_BEGIN));
                newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-               newCode.add(ANNOTATE(anno));
+               newCode.add(ANNOTATE(semantics, anno));
                // Call original renamed function
                if (header.returnType.equals("void")) {
                        newCode.add(header.getRenamedCall(SPEC_INTERFACE_WRAPPER) + ";");
@@ -552,7 +589,7 @@ public class CodeVariables {
                        newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
                        newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_HB_CONDITION));
                        newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-                       newCode.add(ANNOTATE(anno));
+                       newCode.add(ANNOTATE(semantics, anno));
                        newCode.add("}");
                        newCode.add("");
                }
@@ -567,7 +604,7 @@ public class CodeVariables {
                        newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
                        newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_HB_CONDITION));
                        newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-                       newCode.add(ANNOTATE(anno));
+                       newCode.add(ANNOTATE(semantics, anno));
                        newCode.add("");
                }
                // Interface end
@@ -596,7 +633,7 @@ public class CodeVariables {
                newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
                newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_INTERFACE_END));
                newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-               newCode.add(ANNOTATE(anno));
+               newCode.add(ANNOTATE(semantics, anno));
                // Return __RET__ if it's not void
                if (!header.returnType.equals("void")) {
                        newCode.add("return " + MACRO_RETURN + ";");
@@ -657,10 +694,6 @@ public class CodeVariables {
                // Generate redundant header files
                newCode.add(COMMENT("Automatically generated code for potential commit point: "
                                + construct.label));
-               newCode.add(COMMENT("Include redundant headers"));
-               newCode.add(INCLUDE(HEADER_STDINT));
-               newCode.add(INCLUDE(HEADER_CDSANNOTATE));
-               newCode.add(INCLUDE(HEADER_SPECANNOTATION));
                newCode.add("");
                // Add annotation
                newCode.add("if (" + construct.condition + ") {");
@@ -674,7 +707,7 @@ public class CodeVariables {
                newCode.add(ASSIGN_TO_PTR(anno, "type",
                                SPEC_ANNO_TYPE_POTENTIAL_CP_DEFINE));
                newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-               newCode.add(ANNOTATE(anno));
+               newCode.add(ANNOTATE(semantics, anno));
                newCode.add("}");
                return newCode;
        }
@@ -689,9 +722,6 @@ public class CodeVariables {
                // Generate redundant header files
                newCode.add(COMMENT("Automatically generated code for commit point define check: "
                                + construct.label));
-               newCode.add(COMMENT("Include redundant headers"));
-               newCode.add(INCLUDE(HEADER_STDINT));
-               newCode.add(INCLUDE(HEADER_CDSANNOTATE));
                newCode.add("");
                // Add annotation
                newCode.add("if (" + construct.condition + ") {");
@@ -703,7 +733,7 @@ public class CodeVariables {
                newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
                newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_CP_DEFINE_CHECK));
                newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-               newCode.add(ANNOTATE(anno));
+               newCode.add(ANNOTATE(semantics, anno));
                newCode.add("}");
                return newCode;
        }
@@ -725,7 +755,7 @@ public class CodeVariables {
                newCode.add(STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
                newCode.add(ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_CP_DEFINE));
                newCode.add(ASSIGN_TO_PTR(anno, "annotation", structName));
-               newCode.add(ANNOTATE(anno));
+               newCode.add(ANNOTATE(semantics, anno));
                newCode.add("}");
                return newCode;
        }