more fix
[cdsspec-compiler.git] / src / edu / uci / eecs / specCompiler / codeGenerator / CodeGenerator.java
index 8f4537a43a6b33a39d65be969978e3a660be00c8..30e185d71ff7303d1e2c4b79c28001977b8330d5 100644 (file)
@@ -6,20 +6,27 @@ import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Iterator;
 
-import edu.uci.eecs.specCompiler.specExtraction.ActionSubConstruct.DefineVar;
 import edu.uci.eecs.specCompiler.specExtraction.CPDefineCheckConstruct;
 import edu.uci.eecs.specCompiler.specExtraction.CPDefineConstruct;
+import edu.uci.eecs.specCompiler.specExtraction.ClassEndConstruct;
+import edu.uci.eecs.specCompiler.specExtraction.ConditionalInterface;
 import edu.uci.eecs.specCompiler.specExtraction.Construct;
+import edu.uci.eecs.specCompiler.specExtraction.EntryPointConstruct;
+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;
-import edu.uci.eecs.specCompiler.specExtraction.SpecConstruct;
+import edu.uci.eecs.specCompiler.specExtraction.SourceFileInfo;
 import edu.uci.eecs.specCompiler.specExtraction.SpecExtractor;
-import edu.uci.eecs.specCompiler.specExtraction.SpecNotMatchException;
 
 /**
  * <p>
@@ -36,25 +43,20 @@ public class CodeGenerator {
 
        private File[] srcFiles;
 
-       private HashMap<File, ArrayList<String>> contents;
+       private HashMap<File, SourceFileInfo> srcFilesInfo;
 
        private HashMap<File, ArrayList<CodeAddition>> codeAdditions;
 
        public CodeGenerator(File[] srcFiles) {
                this.srcFiles = srcFiles;
-               this.contents = new HashMap<File, ArrayList<String>>();
-               readSrcFiles();
-               this.codeAdditions = new HashMap<File, ArrayList<CodeAddition>>();
-
                _extractor = new SpecExtractor();
+               _extractor.extract(srcFiles);
 
-               try {
-                       _extractor.extract(srcFiles);
-               } catch (SpecNotMatchException e1) {
-                       e1.printStackTrace();
-               }
+               this.srcFilesInfo = _extractor.srcFilesInfo;
 
-               _semantics = new SemanticsChecker(_extractor.getConstructs());
+               this.codeAdditions = new HashMap<File, ArrayList<CodeAddition>>();
+
+               _semantics = new SemanticsChecker(_extractor);
                try {
                        _semantics.check();
                        System.out.println(_semantics);
@@ -63,270 +65,250 @@ public class CodeGenerator {
                }
        }
 
-       private ArrayList<String> readSrcFile(File f) throws IOException {
-               BufferedReader bf = new BufferedReader(new FileReader(f));
-               ArrayList<String> content = new ArrayList<String>();
-               String curLine;
-               while ((curLine = bf.readLine()) != null) {
-                       content.add(curLine);
-               }
-               return content;
-       }
-
-       private void readSrcFiles() {
-               for (int i = 0; i < srcFiles.length; i++) {
-                       File f = srcFiles[i];
-                       if (!contents.containsKey(f)) {
-                               try {
-                                       contents.put(f, readSrcFile(f));
-                               } catch (IOException e) {
-                                       e.printStackTrace();
-                               }
-                       }
-               }
-       }
-
        /**
         * <p>
         * Generate all the global code, including the "@DefineVar" in each
         * "@Interface" define
         * </p>
         */
-       private void globalConstruct2Code(SpecConstruct inst) {
-               int lineNum = inst.endLineNum + 1;
-               GlobalConstruct construct = (GlobalConstruct) inst.construct;
-               ArrayList<String> newCode = new ArrayList<String>();
-
-               // Generate the inner class definition
-               newCode.add("class " + CodeVariables.SPEC_CLASS + " {\n");
-               newCode.add("public:\n");
-
-               // Generate the code in global construct first
-               SequentialDefineSubConstruct globalCode = construct.code;
-               breakCodeLines(newCode, globalCode.declareVar);
-
-               // Generate code from the DefineVar, __COND_SAT__ and __ID__
-               // __COND_SAT__
-               newCode.add(CodeVariables.SPEC_HASHTABLE + "<" + CodeVariables.BOOLEAN
-                               + "> " + CodeVariables.SPEC_CONDITION + ";");
-               // __ID__
-               newCode.add(CodeVariables.SPEC_HASHTABLE + "<" + CodeVariables.SPEC_TAG
-                               + "> " + CodeVariables.SPEC_ID + ";");
-
-               // DefineVars
-               for (String interfaceName : _semantics.interfaceName2Construct.keySet()) {
-                       InterfaceConstruct iConstruct = (InterfaceConstruct) _semantics.interfaceName2Construct
-                                       .get(interfaceName).construct;
-                       ArrayList<DefineVar> defineVars = iConstruct.action.defineVars;
-                       for (int i = 0; i < defineVars.size(); i++) {
-                               DefineVar var = defineVars.get(i);
-                               newCode.add(CodeVariables.SPEC_HASHTABLE + "<" + var.varType
-                                               + "> " + var.getNewVarName() + ";");
-                       }
-               }
-
-               // Enum of all interface
-               String enumDefinition = "enum " + CodeVariables.SPEC_INTERFACE_ENUM
-                               + " {";
-               Iterator<String> iter = _semantics.interfaceName2Construct.keySet()
-                               .iterator();
-               String interfaceName;
-               if (iter.hasNext()) {
-                       interfaceName = iter.next();
-                       enumDefinition = enumDefinition + "_" + interfaceName + "_";
+       private void globalConstruct2Code(GlobalConstruct construct) {
+               ArrayList<String> newCode = CodeVariables.generateGlobalVarDeclaration(
+                               _semantics, construct);
+               // Add it to the codeAdditions
+               if (!codeAdditions.containsKey(construct.file)) {
+                       codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
                }
-               while (iter.hasNext()) {
-                       interfaceName = iter.next();
-                       enumDefinition = enumDefinition + ", _" + interfaceName + "_";
-               }
-               enumDefinition = enumDefinition + "};";
-               newCode.add(enumDefinition);
-
-               // __interface
-               newCode.add(CodeVariables.SPEC_HASHTABLE + "<enum "
-                               + CodeVariables.SPEC_INTERFACE_ENUM + "> "
-                               + CodeVariables.SPEC_INTERFACE + ";");
-
-               // Generate constructor (the place to initialize everything!)
-               newCode.add("\n");
-               newCode.add(CodeVariables.SPEC_CLASS + "() {");
-
-               breakCodeLines(newCode, globalCode.initVar);
-               // __COND_SAT__
-               newCode.add(CodeVariables.SPEC_CONDITION + " = "
-                               + CodeVariables.SPEC_HASHTABLE + "<" + CodeVariables.BOOLEAN
-                               + ">();");
-               // __ID__
-               newCode.add(CodeVariables.SPEC_ID + " = "
-                               + CodeVariables.SPEC_HASHTABLE + "<" + CodeVariables.SPEC_TAG
-                               + ">();");
-               // __interface
-               newCode.add(CodeVariables.SPEC_INTERFACE + " = "
-                               + CodeVariables.SPEC_HASHTABLE + "<enum "
-                               + CodeVariables.SPEC_INTERFACE_ENUM + ">();");
-               // FIXME: Pass the happens-before relationship check here
-               newCode.add("}");
-
-               // Generate the sequential functions
-               breakCodeLines(newCode, globalCode.defineFunc);
-
-               // Generate the end of the inner class definition
-               newCode.add("};\n");
-               printCode(newCode);
-
-               CodeAddition addition = new CodeAddition(lineNum, newCode);
-               if (!codeAdditions.containsKey(inst.file)) {
-                       codeAdditions.put(inst.file, new ArrayList<CodeAddition>());
+               CodeAddition addition = new CodeAddition(construct.beginLineNum,
+                               newCode);
+               codeAdditions.get(construct.file).add(addition);
+               newCode = CodeVariables.generateStaticVarDefine(_semantics, construct);
+               if (newCode.size() > 0) {
+                       addition = new CodeAddition(
+                                       _semantics.getClassEndConstruct().beginLineNum, newCode);
+                       codeAdditions.get(construct.file).add(addition);
                }
-               codeAdditions.get(inst.file).add(addition);
        }
 
-       // Break the code (String) into multiple lines and add it to newCode
-       private void breakCodeLines(ArrayList<String> newCode, String code) {
-               int begin = 0, end = 0;
-               while (end < code.length()) {
-                       if (code.charAt(end) == '\n') {
-                               String line = code.substring(begin, end);
-                               newCode.add(line);
-                               begin = end + 1;
+       // Wrap the interface and then renaem it
+       private void interface2Code(InterfaceConstruct construct) {
+               // If there's no define construct for it, we generate the wrapper just
+               // in place without declaration
+               InterfaceDefineConstruct defineConstruct = _semantics.interfaceName2DefineConstruct
+                               .get(construct.name);
+               ArrayList<String> newCode;
+               int lineNum;
+               CodeAddition addition;
+               // Then generate the wrapper if necessary
+               if (defineConstruct != null) { // Need to have a wrapper declaration
+                       newCode = CodeVariables.generateInterfaceWrapperDeclaration(
+                                       _semantics, construct);
+                       lineNum = construct.beginLineNum;
+                       // Add the wrapper declaration
+                       addition = new CodeAddition(lineNum, newCode);
+                       if (!codeAdditions.containsKey(construct.file)) {
+                               codeAdditions
+                                               .put(construct.file, new ArrayList<CodeAddition>());
                        }
-                       end++;
+                       codeAdditions.get(construct.file).add(addition);
+
+                       // Add the wrapper definition
+                       newCode = CodeVariables.generateInterfaceWrapperDefinition(
+                                       _semantics, construct);
+                       lineNum = defineConstruct.beginLineNum;
+                       // Add the wrapper declaration
+                       addition = new CodeAddition(lineNum, newCode);
+                       if (!codeAdditions.containsKey(defineConstruct.file)) {
+                               codeAdditions.put(defineConstruct.file,
+                                               new ArrayList<CodeAddition>());
+                       }
+                       codeAdditions.get(defineConstruct.file).add(addition);
+               } else { // No declaration needed but should add forward declaration in
+                                       // Class
+                       // Last generate the definition
+                       newCode = new ArrayList<String>();
+                       if (_semantics.getOption("CLASS") == null) {
+                               newCode.addAll(CodeVariables
+                                               .generateInterfaceWrapperDeclaration(_semantics,
+                                                               construct));
+                       }
+                       newCode.addAll(CodeVariables.generateInterfaceWrapperDefinition(
+                                       _semantics, construct));
+                       lineNum = construct.beginLineNum;
+                       // Add the wrapper declaration
+                       addition = new CodeAddition(lineNum, newCode);
+                       if (!codeAdditions.containsKey(construct.file)) {
+                               codeAdditions
+                                               .put(construct.file, new ArrayList<CodeAddition>());
+                       }
+                       codeAdditions.get(construct.file).add(addition);
                }
-       }
 
-       private void printCode(ArrayList<String> code) {
-               for (int i = 0; i < code.size(); i++) {
-                       System.out.println(code.get(i));
-               }
+               // Don't forget to rename the interface
+               CodeVariables.renameInterface(_semantics, construct);
        }
 
-       // Mainly rename and wrap the interface
-       private void interface2Code(SpecConstruct inst)
-                       throws InterfaceWrongFormatException {
-               int lineNum = inst.endLineNum + 1;
-               InterfaceConstruct construct = (InterfaceConstruct) inst.construct;
-               ArrayList<String> newCode = new ArrayList<String>();
-
-               // Rename the interface name
-               File file = inst.file;
-               ArrayList<String> content = contents.get(file);
-               String funcDecl = inst.interfaceDeclBody;
-               String funcName = renameInterface(funcDecl, content, lineNum);
+       private void potentialCPDefine2Code(PotentialCPDefineConstruct construct) {
+               int lineNum = construct.beginLineNum;
+               ArrayList<String> newCode = CodeVariables.generatePotentialCPDefine(
+                               _semantics, construct);
 
-               // Generate new wrapper
-               breakCodeLines(newCode, funcDecl);
-               newCode.add("{");
-               
-               // Generate 
-               
-               // FIXME: Add Happens-before check here
-               
-               newCode.add("}");
                CodeAddition addition = new CodeAddition(lineNum, newCode);
-               if (!codeAdditions.containsKey(inst.file)) {
-                       codeAdditions.put(inst.file, new ArrayList<CodeAddition>());
+               if (!codeAdditions.containsKey(construct.file)) {
+                       codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
                }
-               codeAdditions.get(inst.file).add(addition);
+               codeAdditions.get(construct.file).add(addition);
        }
 
-       // Returns the function name that has been renamed and replace the old line
-       private String renameInterface(String funcDecl, ArrayList<String> content,
-                       int lineNum) throws InterfaceWrongFormatException {
-               int begin = 0, end = funcDecl.indexOf('(');
-               if (end == -1) {
-                       throw new InterfaceWrongFormatException(funcDecl
-                                       + "\n has wrong format!");
-               }
-               end--;
-               while (end > 0) {
-                       char ch = funcDecl.charAt(end);
-                       if (ch == '\n' || ch == '\t' || ch == ' ')
-                               continue;
-               }
-               begin = end;
-               while (begin > 0) {
-                       char ch = funcDecl.charAt(begin);
-                       if (ch == '_' || (ch >= 'a' && ch <= 'z')
-                                       || (ch >= 'A' && ch <= 'Z') || (ch >= '0' && ch <= '9')) {
-                               continue;
-                       }
+       private void CPDefine2Code(CPDefineConstruct construct) {
+               int lineNum = construct.beginLineNum;
+               ArrayList<String> newCode = CodeVariables.generateCPDefine(_semantics,
+                               construct);
+
+               CodeAddition addition = new CodeAddition(lineNum, newCode);
+               if (!codeAdditions.containsKey(construct.file)) {
+                       codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
                }
-               String funcName = funcDecl.substring(begin + 1, end + 1), newLine;
-               int lineBreakIdx = funcDecl.indexOf('\n');
-               int firstLineBreak = lineBreakIdx == -1 ? funcDecl.length() : lineBreakIdx;  
-               newLine = funcDecl.substring(0, begin + 1)
-                               + CodeVariables.SPEC_INTERFACE_WRAPPER + funcName
-                               + funcDecl.substring(end + 1, firstLineBreak);
-               content.set(lineNum, newLine);
-               return funcName;
+               codeAdditions.get(construct.file).add(addition);
        }
 
-       private void potentialCP2Code(SpecConstruct inst) {
-               int lineNum = inst.endLineNum + 1;
-               GlobalConstruct construct = (GlobalConstruct) inst.construct;
-               ArrayList<String> newCode = new ArrayList<String>();
+       private void CPDefineCheck2Code(CPDefineCheckConstruct construct) {
+               int lineNum = construct.beginLineNum;
+               ArrayList<String> newCode = CodeVariables.generateCPDefineCheck(
+                               _semantics, construct);
 
                CodeAddition addition = new CodeAddition(lineNum, newCode);
-               if (!codeAdditions.containsKey(inst.file)) {
-                       codeAdditions.put(inst.file, new ArrayList<CodeAddition>());
+               if (!codeAdditions.containsKey(construct.file)) {
+                       codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
                }
-               codeAdditions.get(inst.file).add(addition);
+               codeAdditions.get(construct.file).add(addition);
        }
 
-       private void CPDefine2Code(SpecConstruct inst) {
-               int lineNum = inst.endLineNum + 1;
-               GlobalConstruct construct = (GlobalConstruct) inst.construct;
-               ArrayList<String> newCode = new ArrayList<String>();
+       /**
+       private void ClassEnd2Code(ClassEndConstruct construct) {
+               int lineNum = construct.beginLineNum;
+               ArrayList<String> newCode = CodeVariables.generateStaticVarDefine(_semantics,
+                               _semantics.getGlobalConstruct());
 
                CodeAddition addition = new CodeAddition(lineNum, newCode);
-               if (!codeAdditions.containsKey(inst.file)) {
-                       codeAdditions.put(inst.file, new ArrayList<CodeAddition>());
+               if (!codeAdditions.containsKey(construct.file)) {
+                       codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
                }
-               codeAdditions.get(inst.file).add(addition);
+               codeAdditions.get(construct.file).add(addition);
        }
-
-       private void CPDefineCheck2Code(SpecConstruct inst) {
-               int lineNum = inst.endLineNum + 1;
-               GlobalConstruct construct = (GlobalConstruct) inst.construct;
+       */
+       
+       private void EntryPoint2Code(EntryPointConstruct construct) {
+               int lineNum = construct.beginLineNum;
                ArrayList<String> newCode = new ArrayList<String>();
+               newCode.addAll(CodeVariables.generateEntryPointInitCall());
 
                CodeAddition addition = new CodeAddition(lineNum, newCode);
-               if (!codeAdditions.containsKey(inst.file)) {
-                       codeAdditions.put(inst.file, new ArrayList<CodeAddition>());
+               if (!codeAdditions.containsKey(construct.file)) {
+                       codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
                }
-               codeAdditions.get(inst.file).add(addition);
+               codeAdditions.get(construct.file).add(addition);
+       }
+
+       private ArrayList<String> insertAnnotation2Src(
+                       ArrayList<CodeAddition> additions, ArrayList<String> content) {
+               int totalSize = content.size();
+               for (int i = 0; i < additions.size(); i++) {
+                       totalSize += additions.size();
+               }
+               ArrayList<String> newContent = new ArrayList<String>(totalSize);
+               int curSrcLine = 0;
+               for (int i = 0; i < additions.size(); i++) {
+                       CodeAddition addition = additions.get(i);
+                       if (curSrcLine < addition.lineNum) {
+                               // Be careful, subList is the interval [begin, end)
+                               newContent
+                                               .addAll(content.subList(curSrcLine, addition.lineNum));
+                               curSrcLine = addition.lineNum;
+                       }
+                       newContent.addAll(addition.newCode);
+               }
+               newContent.addAll(content.subList(curSrcLine, content.size()));
+               return newContent;
        }
 
        public void generateCode() {
                for (int i = 0; i < _semantics.constructs.size(); i++) {
-                       SpecConstruct inst = _semantics.constructs.get(i);
-                       Construct construct = inst.construct;
+                       Construct construct = _semantics.constructs.get(i);
                        if (construct instanceof GlobalConstruct) {
-                               globalConstruct2Code(inst);
+                               globalConstruct2Code((GlobalConstruct) construct);
                        } else if (construct instanceof InterfaceConstruct) {
-                               try {
-                                       interface2Code(inst);
-                               } catch (InterfaceWrongFormatException e) {
-                                       e.printStackTrace();
-                               }
+                               interface2Code((InterfaceConstruct) construct);
                        } else if (construct instanceof PotentialCPDefineConstruct) {
-                               potentialCP2Code(inst);
+                               potentialCPDefine2Code((PotentialCPDefineConstruct) construct);
                        } else if (construct instanceof CPDefineConstruct) {
-                               CPDefine2Code(inst);
+                               CPDefine2Code((CPDefineConstruct) construct);
                        } else if (construct instanceof CPDefineCheckConstruct) {
-                               CPDefineCheck2Code(inst);
+                               CPDefineCheck2Code((CPDefineCheckConstruct) construct);
+                       } else if (construct instanceof EntryPointConstruct) {
+                               EntryPoint2Code((EntryPointConstruct) construct);
                        }
                }
+
+//             ClassEndConstruct endConstruct = _semantics.getClassEndConstruct();
+//             if (endConstruct != null) {
+//                     ClassEnd2Code(endConstruct);
+//             }
+
+               // Sort code additions
+               HashSet<String> headers = CodeVariables.getAllHeaders(_semantics);
+               ArrayList<String> headerCode = new ArrayList<String>();
+               for (String header : headers) {
+                       headerCode.add("#include " + header);
+               }
+               for (File file : codeAdditions.keySet()) {
+                       ArrayList<CodeAddition> additions = codeAdditions.get(file);
+
+                       if (additions.size() == 0) // Simply do nothing
+                               continue;
+                       ArrayList<String> content = _semantics.srcFilesInfo.get(file).content;
+                       Collections.sort(additions, CodeAddition.lineNumComparator);
+                       // Insert generated annotation to the source files
+                       ArrayList<String> newContent = insertAnnotation2Src(additions,
+                                       content);
+                       ArrayList<String> finalContent = new ArrayList<String>(
+                                       headerCode.size() + newContent.size());
+                       finalContent.addAll(headerCode);
+                       finalContent.addAll(newContent);
+                       // Write it back to file
+                       ParserUtils.write2File(file, finalContent);
+               }
        }
 
        public static void main(String[] argvs) {
                String homeDir = Environment.HOME_DIRECTORY;
                File[] srcFiles = {
-               // new File(homeDir + "/benchmark/linuxrwlocks/linuxrwlocks.c"),
-               new File(homeDir
-                               + "/benchmark/cliffc-hashtable/simplified_cliffc_hashtable.h"),
-               // new File(homeDir + "/benchmark/ms-queue/my_queue.c")
-               };
+                                new File(homeDir
+                                + "/benchmark/linuxrwlocks/linuxrwlocks.c") };
+//                              new File(homeDir
+//                              +
+//                              "/benchmark/cliffc-hashtable/simplified_cliffc_hashtable.h"),
+//                              };
+//                              new File(homeDir + "/benchmark/ms-queue/my_queue.c"),
+//                              new File(homeDir + "/benchmark/ms-queue/main.c"),
+//                              new File(homeDir + "/benchmark/ms-queue/my_queue.h") };
+
+//                              new File(homeDir + "/benchmark/read-copy-update/rcu.cc") };
+
+//                              new File(homeDir +
+//                              "/benchmark/chase-lev-deque-bugfix/deque.c"),
+//                              new File(homeDir +
+//                              "/benchmark/chase-lev-deque-bugfix/main.c"),
+//                              new File(homeDir +
+//                              "/benchmark/chase-lev-deque-bugfix/deque.h") };
+
+//                             new File(homeDir + "/benchmark/mcs-lock/mcs-lock.cc"),
+//                             new File(homeDir + "/benchmark/mcs-lock/mcs-lock.h") };
+               
+//                             new File(homeDir + "/benchmark/spsc-bugfix/spsc-queue.cc"),
+//                             new File(homeDir + "/benchmark/spsc-bugfix/eventcount.h"),
+//                             new File(homeDir + "/benchmark/spsc-bugfix/queue.h") };
+               
+
                CodeGenerator gen = new CodeGenerator(srcFiles);
                gen.generateCode();
        }