fixed bugs
[cdsspec-compiler.git] / src / edu / uci / eecs / specCompiler / codeGenerator / CodeVariables.java
index 29006016147c712cf0848e376f8d6a178e476f3c..8e87cd5c4a1b1534c1904f742cd6d125283c75eb 100644 (file)
@@ -6,11 +6,15 @@ import java.io.File;
 
 import edu.uci.eecs.specCompiler.grammerParser.ParseException;
 import edu.uci.eecs.specCompiler.grammerParser.SpecParser;
+import edu.uci.eecs.specCompiler.specExtraction.CPDefineCheckConstruct;
+import edu.uci.eecs.specCompiler.specExtraction.CPDefineConstruct;
 import edu.uci.eecs.specCompiler.specExtraction.ConditionalInterface;
+import edu.uci.eecs.specCompiler.specExtraction.Construct;
 import edu.uci.eecs.specCompiler.specExtraction.FunctionHeader;
 import edu.uci.eecs.specCompiler.specExtraction.GlobalConstruct;
 import edu.uci.eecs.specCompiler.specExtraction.IDExtractor;
 import edu.uci.eecs.specCompiler.specExtraction.InterfaceConstruct;
+import edu.uci.eecs.specCompiler.specExtraction.InterfaceDefineConstruct;
 import edu.uci.eecs.specCompiler.specExtraction.ParserUtils;
 import edu.uci.eecs.specCompiler.specExtraction.PotentialCPDefineConstruct;
 import edu.uci.eecs.specCompiler.specExtraction.SequentialDefineSubConstruct;
@@ -40,18 +44,19 @@ public class CodeVariables {
        public static final String SPEC_ANNO_TYPE_HB_CONDITION = "HB_CONDITION";
        public static final String SPEC_ANNO_TYPE_INTERFACE_END = "INTERFACE_END";
        public static final String SPEC_ANNO_TYPE_POTENTIAL_CP_DEFINE = "POTENTIAL_CP_DEFINE";
+       public static final String SPEC_ANNO_TYPE_CP_DEFINE_CHECK = "CP_DEFINE_CHECK";
+       public static final String SPEC_ANNO_TYPE_CP_DEFINE = "CP_DEFINE";
        public static final String SPEC_ANNOTATION = "spec_annotation";
        public static final String SPEC_ANNOTATION_FIELD_TYPE = "type";
        public static final String SPEC_ANNOTATION_FIELD_ANNO = "annotation";
 
        public static final String ANNO_HB_INIT = "anno_hb_init";
-       public static final String ANNO_INTERFACE_BOUNDARY = "anno_interface_boundary";
-       public static final String ANNO_ID = "anno_id";
+       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_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";
-       public static final String ANNO_POST_CHECK = "anno_post_check";
 
        // Specification variables
        public static final String SPEC_INTERFACE_WRAPPER = "__wrapper_";
@@ -96,6 +101,14 @@ public class CodeVariables {
                return "#undef " + macro;
        }
 
+       private static String GET_FIELD_BY_PTR(String ptr, String field) {
+               return ptr + "->" + field;
+       }
+
+       private static String GET_FIELD(String var, String field) {
+               return var + "->" + field;
+       }
+
        private static String BRACE(String val) {
                return "(" + val + ")";
        }
@@ -104,10 +117,19 @@ public class CodeVariables {
                return structName + "." + field + " = " + val + ";";
        }
 
+       private static String ASSIGN(String varName, String val) {
+               return varName + " = " + val + ";";
+       }
+
        private static String ASSIGN_PTR(String structName, String field, String val) {
                return structName + "." + field + " = &" + val + ";";
        }
 
+       private static String ASSIGN_TO_PTR(String structName, String field,
+                       String val) {
+               return structName + "->" + field + " = " + val + ";";
+       }
+
        private static String DECLARE(String type, String name) {
                return type + " " + name + ";";
        }
@@ -141,7 +163,7 @@ public class CodeVariables {
                        String idCode) {
                ArrayList<String> code = new ArrayList<String>();
                code.add("static " + IDType + " " + interfaceName + "_id() {");
-               if (idCode != null) {
+               if (!idCode.equals("")) {
                        code.add(DECLARE_DEFINE(IDType, MACRO_ID, idCode));
                } else {
                        code.add(DECLARE_DEFINE(IDType, MACRO_ID, DEFAULT_ID));
@@ -151,6 +173,52 @@ public class CodeVariables {
                return code;
        }
 
+       private static ArrayList<String> DEFINE_CHECK_ACTION_FUNC(
+                       InterfaceConstruct construct, FunctionHeader header) {
+               String interfaceName = construct.name;
+               ArrayList<String> code = new ArrayList<String>();
+               code.add("static bool " + interfaceName + "_check_action(void *info, "
+                               + IDType + " " + MACRO_ID + ") {");
+               code.add(DECLARE("bool", "check_passed"));
+               String infoStructType = interfaceName + "_info", infoStructName = "theInfo";
+               code.add(DECLARE_DEFINE(infoStructType + "*", infoStructName,
+                               BRACE(infoStructType) + "info"));
+               code.add((DECLARE_DEFINE(header.returnType, MACRO_RETURN,
+                               GET_FIELD_BY_PTR(infoStructName, MACRO_RETURN))));
+               for (int i = 0; i < header.args.size(); i++) {
+                       String type = header.args.get(i).type, var = header.args.get(i).name;
+                       code.add((DECLARE_DEFINE(type, var,
+                                       GET_FIELD_BY_PTR(infoStructName, var))));
+               }
+               code.add("");
+               // __COND_SAT
+               if (!construct.condition.equals("")) {
+                       code.add(DECLARE_DEFINE("bool", MACRO_COND, construct.condition));
+               }
+               // Check
+               if (!construct.check.equals("")) {
+                       code.add(ASSIGN("check_passed", construct.check));
+                       code.add("if (!check_passed) return false;");
+               }
+               // Action
+               if (construct.action.size() > 0) {
+                       code.addAll(construct.action);
+               }
+               // Post_check
+               if (!construct.postCheck.equals("")) {
+                       code.add(ASSIGN("check_passed", construct.postCheck));
+                       code.add("if (!check_passed) return false;");
+               }
+               // Post_action
+               if (construct.postAction.size() > 0) {
+                       code.addAll(construct.postAction);
+               }
+
+               code.add("}");
+
+               return code;
+       }
+
        private static HashSet<String> getAllHeaders(SemanticsChecker semantics) {
                HashSet<String> headers = new HashSet<String>();
                for (String interfaceName : semantics.interfaceName2Construct.keySet()) {
@@ -166,18 +234,19 @@ public class CodeVariables {
                funcDefine.set(0, headLine);
        }
 
-       private static void makeVariablesStatic(ArrayList<String> varDecls) {
-               for (int i = 0; i < varDecls.size(); i++) {
-                       String varDecl = varDecls.get(i);
-                       varDecl = "static " + varDecl;
-                       varDecls.set(i, varDecl);
-               }
+       private static String makeVariablesStatic(VariableDeclaration varDecl) {
+               String res = "static " + varDecl.type + " " + varDecl.name + ";";
+               return res;
        }
 
        private static FunctionHeader getFunctionHeader(SemanticsChecker semantics,
-                       InterfaceConstruct construct) {
+                       Construct construct) {
                ArrayList<String> content = semantics.srcFilesInfo.get(construct.file).content;
                String headerLine = content.get(construct.beginLineNum);
+               if (headerLine.startsWith("template")) {
+                       headerLine = content.get(construct.beginLineNum + 1);
+               }
+               headerLine = headerLine.substring(0, headerLine.indexOf(')') + 1);
                try {
                        return SpecParser.parseFuncHeader(headerLine);
                } catch (ParseException e) {
@@ -192,7 +261,7 @@ public class CodeVariables {
                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 */"));
+               newCode.add(COMMENT("Include all the header files that contains the interface declaration"));
                for (String header : allHeaders) {
                        newCode.add(INCLUDE(header));
                }
@@ -204,6 +273,14 @@ public class CodeVariables {
                newCode.add("");
 
                SequentialDefineSubConstruct code = construct.code;
+               // User-defined structs first
+               newCode.add(COMMENT("All other user-defined structs"));
+               ArrayList<ArrayList<String>> declareStructs = code.declareStructs;
+               for (int i = 0; i < declareStructs.size(); i++) {
+                       ArrayList<String> declareStruct = declareStructs.get(i);
+                       newCode.addAll(declareStruct);
+                       newCode.add("");
+               }
                // User-defined functions
                newCode.add(COMMENT("All other user-defined functions"));
                ArrayList<ArrayList<String>> defineFuncs = code.defineFuncs;
@@ -227,25 +304,88 @@ public class CodeVariables {
                        newCode.add("");
 
                        // Define ID function
-                       newCode.add(COMMENT("ID functions of interface: " + interfaceName));
+                       newCode.add(COMMENT("ID function of interface: " + interfaceName));
                        newCode.addAll(DEFINE_ID_FUNC(interfaceName, iConstruct.idCode));
-                       newCode.add("");
                        newCode.add(COMMENT("End of ID function: + " + interfaceName));
                        newCode.add("");
-                       
-                       // Define check_action function
-                       
 
+                       // Define check_action function
+                       newCode.add(COMMENT("Check action function of interface: "
+                                       + interfaceName));
+                       newCode.addAll(DEFINE_CHECK_ACTION_FUNC(iConstruct, funcHeader));
+                       newCode.add(COMMENT("End of check action function: + "
+                                       + interfaceName));
+                       newCode.add("");
                }
-
+               // Interface function pointer table
+               String interfaceSize = Integer
+                               .toString(semantics.interfaceName2Construct.size());
+               newCode.add(DEFINE("INTERFACE_SIZE", interfaceSize));
+               newCode.add(DECLARE("void**", "func_ptr_table"));
                // User-defined variables
                ArrayList<VariableDeclaration> varDecls = code.declareVar;
                for (int i = 0; i < varDecls.size(); i++) {
                        VariableDeclaration varDecl = varDecls.get(i);
-                       newCode.add(DECLARE(varDecl.type, varDecl.name));
+                       // Don't forget to make them static
+                       newCode.add(makeVariablesStatic(varDecl));
                }
 
-               // printCode(newCode);
+               newCode.add("");
+               newCode.add(COMMENT("Define function for sequential code initialization"));
+               newCode.add("static void __sequential_init() {");
+               // Init func_ptr_table
+               newCode.add(COMMENT("Init func_ptr_table"));
+               newCode.add(ASSIGN("func_ptr_table",
+                               "(void**) malloc(sizeof(void*) * 2)"));
+               for (String interfaceName : semantics.interfaceName2Construct.keySet()) {
+                       String interfaceNum = Integer.toString(semantics.interface2Num
+                                       .get(interfaceName));
+                       newCode.add(ASSIGN("func_ptr_table[2 * " + interfaceNum + "]",
+                                       "(void*) &" + interfaceName + "_id"));
+                       newCode.add(ASSIGN("func_ptr_table[2 * " + interfaceNum + " + 1]",
+                                       "(void*) &" + interfaceName + "_check_action"));
+               }
+               newCode.add("");
+               // Init user-defined variables
+               newCode.addAll(construct.code.initVar);
+               // Pass Happens-before relationship
+               generateHBInitAnnotation(semantics);
+               newCode.add("}");
+               newCode.add(COMMENT("End of Global construct generation in class"));
+
+               printCode(newCode);
+               return newCode;
+       }
+
+       public static ArrayList<String> generateStaticVarDefine(
+                       SemanticsChecker semantics, GlobalConstruct construct) {
+               ArrayList<String> newCode = new ArrayList<String>();
+               String className = semantics.getClassName();
+               if (className == null)
+                       return newCode; // No need to define any static variables
+               String templateList = semantics.getTemplateStr();
+               String varPrefix;
+               if (templateList == null) {
+                       varPrefix = className + "::";
+               } else {
+                       varPrefix = className + templateList + "::";
+               }
+               String templateDecl = semantics.getTemplateFullStr();
+               if (templateList == null) {
+                       newCode.add(DECLARE("void**", varPrefix + "func_ptr_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));
+                       }
+               } else {
+                       newCode.add(templateDecl);
+                       newCode.add(DECLARE("void**", varPrefix + "func_ptr_table"));
+                       for (int i = 0; i < construct.code.declareVar.size(); i++) {
+                               VariableDeclaration varDecl = construct.code.declareVar.get(i);
+                               newCode.add(templateDecl);
+                               newCode.add(DECLARE(varDecl.type, varPrefix + varDecl.name));
+                       }
+               }
                return newCode;
        }
 
@@ -291,43 +431,193 @@ public class CodeVariables {
                return newCode;
        }
 
+       public static ArrayList<String> generateEntryPointInitCall() {
+               ArrayList<String> newCode = new ArrayList<String>(1);
+               newCode.add("__sequential_init();");
+               return newCode;
+       }
+
        public static ArrayList<String> generateInterfaceWrapper(
                        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_THREADS));
+               newCode.add(INCLUDE(HEADER_CDSANNOTATE));
+               newCode.add(INCLUDE(HEADER_SPECANNOTATION));
+               newCode.add(INCLUDE(HEADER_SPEC_LIB));
 
-               // Generate wrapper header
+               FunctionHeader header = getFunctionHeader(semantics, construct);
+               String interfaceNum = Integer.toString(semantics.interface2Num
+                               .get(construct.name));
+               // Rename the interface
+               renameInterface(semantics, construct);
+               InterfaceDefineConstruct defineConstruct = semantics.interfaceName2DefineConstruct
+                               .get(interfaceName);
+               if (defineConstruct != null) {
+                       renameInterface(semantics, defineConstruct);
+               }
 
+               // Generate wrapper header
+               newCode.add(header.toString() + " {");
                // Wrapper function body
-
+               newCode.add(COMMENT("Interface begins"));
                // Interface begin
-
+               String structName = "interface_begin";
+               newCode.add(DECLARE(ANNO_INTERFACE_BEGIN, "interface_begin"));
+               newCode.add(ASSIGN(structName, "interface_num", interfaceNum));
+               String anno = "annotation_interface_begin";
+               newCode.add(DECLARE(SPEC_ANNOTATION, anno));
+               newCode.add(ASSIGN(structName, "type", SPEC_ANNO_TYPE_INTERFACE_BEGIN));
+               newCode.add(ASSIGN_PTR(structName, "annotation", structName));
+               newCode.add(ANNOTATE(anno));
                // Call original renamed function
-
+               newCode.add(DECLARE_DEFINE(header.returnType, MACRO_RETURN,
+                               header.getRenamedCall(SPEC_INTERFACE_WRAPPER)));
                // HB conditions
-
+               for (String label : construct.hbConditions.keySet()) {
+                       String condition = construct.hbConditions.get(label);
+                       String hbCondNum = Integer.toString(semantics.interface2Num
+                                       .get(label));
+                       newCode.add("if " + BRACE(condition) + " {");
+                       structName = "hb_condition";
+                       newCode.add(DECLARE(ANNO_HB_CONDITION, structName));
+                       newCode.add(ASSIGN(structName, "interface_num", interfaceNum));
+
+                       newCode.add(ASSIGN(structName, "hb_condition_num", hbCondNum));
+                       anno = "annotation_hb_condition";
+                       newCode.add(DECLARE(SPEC_ANNOTATION, anno));
+                       newCode.add(ASSIGN(anno, "type", SPEC_ANNO_TYPE_HB_CONDITION));
+                       newCode.add(ASSIGN_PTR(anno, "annotation", structName));
+                       newCode.add(ANNOTATE(anno));
+               }
                // Interface end
-
+               String infoStructType = interfaceName + "_info", infoName = "info";
+               newCode.add(DECLARE_DEFINE(infoStructType, infoName,
+                               BRACE(infoStructType + "*") + " malloc(sizeof("
+                                               + infoStructType + "))"));
+               newCode.add(ASSIGN_TO_PTR(infoName, MACRO_RETURN, MACRO_RETURN));
+               for (int i = 0; i < header.args.size(); i++) {
+                       String argName = header.args.get(i).name;
+                       newCode.add(ASSIGN_TO_PTR(infoName, argName, argName));
+               }
+               structName = "interface_end";
+               anno = "annoation_interface_end";
+               newCode.add(DECLARE(ANNO_INTERFACE_END, structName));
+               newCode.add(ASSIGN(structName, "interface_num", interfaceNum));
+               newCode.add(ASSIGN(structName, "info", infoName));
+               newCode.add(DECLARE(SPEC_ANNOTATION, anno));
+               newCode.add(ASSIGN(anno, "type", SPEC_ANNO_TYPE_INTERFACE_END));
+               newCode.add(ASSIGN_PTR(anno, "annotation", structName));
+               ANNOTATE(anno);
                // End of the wrapper function
+               newCode.add("}");
 
                // printCode(newCode);
                return newCode;
        }
 
+       public static void renameInterface(SemanticsChecker semantics,
+                       Construct construct) {
+               FunctionHeader header = getFunctionHeader(semantics, construct);
+               ArrayList<String> content = semantics.srcFilesInfo.get(construct.file).content;
+               int lineNum = construct.beginLineNum;
+               String headerLine = content.get(construct.beginLineNum);
+               if (headerLine.startsWith("template")) {
+                       headerLine = content.get(construct.beginLineNum + 1);
+                       lineNum++;
+               }
+               String newLine = header.getRenamedHeader(SPEC_INTERFACE_WRAPPER)
+                               .toString() + " {";
+               content.set(lineNum, newLine);
+       }
+
+       public static void addAtomicReturn(SemanticsChecker semantics,
+                       Construct construct) {
+               int lineNum = construct.beginLineNum - 1;
+               ArrayList<String> content = semantics.srcFilesInfo.get(construct.file).content;
+               String oldLine = content.get(lineNum);
+               String newLine = "uint64_t " + MACRO_ATOMIC_RETURN + " = " + oldLine;
+               content.set(lineNum, newLine);
+       }
+
        public static ArrayList<String> generatePotentialCPDefine(
                        SemanticsChecker semantics, PotentialCPDefineConstruct construct) {
                ArrayList<String> newCode = new ArrayList<String>();
-
+               // Add atomic return variable if the predicate accesses to it
+               if (construct.condition.indexOf(MACRO_ATOMIC_RETURN) != -1) {
+                       addAtomicReturn(semantics, construct);
+               }
                // 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_THREADS));
-               newCode.add(INCLUDE(HEADER_CDSTRACE));
+               newCode.add(INCLUDE(HEADER_STDINT));
+               newCode.add(INCLUDE(HEADER_CDSANNOTATE));
+               newCode.add("");
+               // Add annotation
+               newCode.add("if (" + construct.condition + ") {");
+               String structName = "potential_cp_define", anno = "annotation_potential_cp_define";
+               newCode.add(DECLARE(ANNO_POTENTIAL_CP_DEFINE, structName));
+               String labelNum = Integer.toString(semantics.commitPointLabel2Num
+                               .get(construct.label));
+               newCode.add(ASSIGN(structName, "label_num", labelNum));
+               newCode.add(DECLARE(SPEC_ANNOTATION, anno));
+               newCode.add(ASSIGN(anno, "type", SPEC_ANNO_TYPE_POTENTIAL_CP_DEFINE));
+               newCode.add(ASSIGN_PTR(anno, "annotation", structName));
+               newCode.add(ANNOTATE(anno));
+               newCode.add("}");
+               return newCode;
+       }
+
+       public static ArrayList<String> generateCPDefineCheck(
+                       SemanticsChecker semantics, CPDefineCheckConstruct construct) {
+               ArrayList<String> newCode = new ArrayList<String>();
+               // Add atomic return variable if the predicate accesses to it
+               if (construct.condition.indexOf(MACRO_ATOMIC_RETURN) != -1) {
+                       addAtomicReturn(semantics, construct);
+               }
+               // 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("");
-               // Some necessary function calls
+               // Add annotation
+               newCode.add("if (" + construct.condition + ") {");
+               String structName = "cp_define_check", anno = "annotation_cp_define_check";
+               newCode.add(DECLARE(ANNO_CP_DEFINE_CHECK, structName));
+               String labelNum = Integer.toString(semantics.commitPointLabel2Num
+                               .get(construct.label));
+               newCode.add(ASSIGN(structName, "label_num", labelNum));
+               newCode.add(DECLARE(SPEC_ANNOTATION, anno));
+               newCode.add(ASSIGN(anno, "type", SPEC_ANNO_TYPE_CP_DEFINE_CHECK));
+               newCode.add(ASSIGN_PTR(anno, "annotation", structName));
+               newCode.add(ANNOTATE(anno));
+               newCode.add("}");
+               return newCode;
+       }
 
+       public static ArrayList<String> generateCPDefine(
+                       SemanticsChecker semantics, CPDefineConstruct construct) {
+               ArrayList<String> newCode = new ArrayList<String>();
+               // Generate redundant header files
+               newCode.add(COMMENT("Automatically generated code for commit point define check: "
+                               + construct.label));
+               newCode.add("");
+               // Add annotation
+               newCode.add("if (" + construct.condition + ") {");
+               String structName = "cp_define", anno = "annotation_cp_define";
+               newCode.add(DECLARE(ANNO_CP_DEFINE, structName));
+               String labelNum = Integer.toString(semantics.commitPointLabel2Num
+                               .get(construct.label));
+               newCode.add(ASSIGN(structName, "label_num", labelNum));
+               newCode.add(DECLARE(SPEC_ANNOTATION, anno));
+               newCode.add(ASSIGN(anno, "type", SPEC_ANNO_TYPE_CP_DEFINE));
+               newCode.add(ASSIGN_PTR(anno, "annotation", structName));
+               newCode.add(ANNOTATE(anno));
+               newCode.add("}");
                return newCode;
        }
 }