src/edu/uci/eecs/specCompiler/codeGenerator/CodeGenerator.java

   1 package edu.uci.eecs.specCompiler.codeGenerator;
   2
   3 import java.io.BufferedReader;
   4 import java.io.File;
   5 import java.io.FileNotFoundException;
   6 import java.io.FileReader;
   7 import java.io.IOException;
   8 import java.util.ArrayList;
   9 import java.util.Collections;
  10 import java.util.HashMap;
  11 import java.util.Iterator;
  12
  13 import edu.uci.eecs.specCompiler.specExtraction.CPDefineCheckConstruct;
  14 import edu.uci.eecs.specCompiler.specExtraction.CPDefineConstruct;
  15 import edu.uci.eecs.specCompiler.specExtraction.ClassEndConstruct;
  16 import edu.uci.eecs.specCompiler.specExtraction.ConditionalInterface;
  17 import edu.uci.eecs.specCompiler.specExtraction.Construct;
  18 import edu.uci.eecs.specCompiler.specExtraction.EntryPointConstruct;
  19 import edu.uci.eecs.specCompiler.specExtraction.GlobalConstruct;
  20 import edu.uci.eecs.specCompiler.specExtraction.IDExtractor;
  21 import edu.uci.eecs.specCompiler.specExtraction.InterfaceConstruct;
  22 import edu.uci.eecs.specCompiler.specExtraction.InterfaceDefineConstruct;
  23 import edu.uci.eecs.specCompiler.specExtraction.ParserUtils;
  24 import edu.uci.eecs.specCompiler.specExtraction.PotentialCPDefineConstruct;
  25 import edu.uci.eecs.specCompiler.specExtraction.SequentialDefineSubConstruct;
  26 import edu.uci.eecs.specCompiler.specExtraction.SourceFileInfo;
  27 import edu.uci.eecs.specCompiler.specExtraction.SpecExtractor;
  28
  29 /**
  30  * <p>
  31  * This class will generate the annotated C code that can run on the current
  32  * model checker.
  33  * </p>
  34  *
  35  * @author peizhaoo
  36  *
  37  */
  38 public class CodeGenerator {
  39         private SemanticsChecker _semantics;
  40         private SpecExtractor _extractor;
  41
  42         private File[] srcFiles;
  43
  44         private HashMap<File, SourceFileInfo> srcFilesInfo;
  45
  46         private HashMap<File, ArrayList<CodeAddition>> codeAdditions;
  47
  48         public CodeGenerator(File[] srcFiles) {
  49                 this.srcFiles = srcFiles;
  50                 _extractor = new SpecExtractor();
  51                 _extractor.extract(srcFiles);
  52
  53                 this.srcFilesInfo = _extractor.srcFilesInfo;
  54
  55                 this.codeAdditions = new HashMap<File, ArrayList<CodeAddition>>();
  56
  57                 _semantics = new SemanticsChecker(_extractor);
  58                 try {
  59                         _semantics.check();
  60                         System.out.println(_semantics);
  61                 } catch (SemanticsCheckerException e) {
  62                         e.printStackTrace();
  63                 }
  64         }
  65
  66         /**
  67          * <p>
  68          * Generate all the global code, including the "@DefineVar" in each
  69          * "@Interface" define
  70          * </p>
  71          */
  72         private void globalConstruct2Code(GlobalConstruct construct) {
  73                 ArrayList<String> newCode = CodeVariables.generateGlobalVarDeclaration(
  74                                 _semantics, construct);
  75                 // Add it to the codeAdditions
  76                 if (!codeAdditions.containsKey(construct.file)) {
  77                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
  78                 }
  79                 CodeAddition addition = new CodeAddition(construct.beginLineNum,
  80                                 newCode);
  81                 codeAdditions.get(construct.file).add(addition);
  82                 newCode = CodeVariables.generateStaticVarDefine(_semantics, construct);
  83                 if (newCode.size() > 0) {
  84                         addition = new CodeAddition(
  85                                         _semantics.getClassEndConstruct().beginLineNum, newCode);
  86                         codeAdditions.get(construct.file).add(addition);
  87                 }
  88         }
  89
  90         // Mainly rename and wrap the interface
  91         private void interface2Code(InterfaceConstruct construct) {
  92                 ArrayList<String> newCode = CodeVariables.generateInterfaceWrapper(
  93                                 _semantics, construct);
  94                 int lineNum = construct.beginLineNum;
  95                 // Add it to the codeAdditions
  96                 CodeAddition addition = new CodeAddition(lineNum, newCode);
  97                 if (!codeAdditions.containsKey(construct.file)) {
  98                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
  99                 }
 100                 codeAdditions.get(construct.file).add(addition);
 101         }
 102
 103         private void potentialCPDefine2Code(PotentialCPDefineConstruct construct) {
 104                 int lineNum = construct.beginLineNum;
 105                 ArrayList<String> newCode = CodeVariables.generatePotentialCPDefine(
 106                                 _semantics, construct);
 107
 108                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 109                 if (!codeAdditions.containsKey(construct.file)) {
 110                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 111                 }
 112                 codeAdditions.get(construct.file).add(addition);
 113         }
 114
 115         private void CPDefine2Code(CPDefineConstruct construct) {
 116                 int lineNum = construct.beginLineNum;
 117                 ArrayList<String> newCode = CodeVariables.generateCPDefine(_semantics,
 118                                 construct);
 119
 120                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 121                 if (!codeAdditions.containsKey(construct.file)) {
 122                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 123                 }
 124                 codeAdditions.get(construct.file).add(addition);
 125         }
 126
 127         private void CPDefineCheck2Code(CPDefineCheckConstruct construct) {
 128                 int lineNum = construct.beginLineNum;
 129                 ArrayList<String> newCode = CodeVariables.generateCPDefineCheck(
 130                                 _semantics, construct);
 131
 132                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 133                 if (!codeAdditions.containsKey(construct.file)) {
 134                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 135                 }
 136                 codeAdditions.get(construct.file).add(addition);
 137         }
 138
 139         private void EntryPoint2Code(EntryPointConstruct construct) {
 140                 int lineNum = construct.beginLineNum;
 141                 ArrayList<String> newCode = new ArrayList<String>();
 142                 newCode.addAll(CodeVariables.generateEntryPointInitCall());
 143
 144                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 145                 if (!codeAdditions.containsKey(construct.file)) {
 146                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 147                 }
 148                 codeAdditions.get(construct.file).add(addition);
 149         }
 150
 151         private ArrayList<String> insertAnnotation2Src(
 152                         ArrayList<CodeAddition> additions, ArrayList<String> content) {
 153                 int totalSize = content.size();
 154                 for (int i = 0; i < additions.size(); i++) {
 155                         totalSize += additions.size();
 156                 }
 157                 ArrayList<String> newContent = new ArrayList<String>(totalSize);
 158                 int curSrcLine = 0;
 159                 for (int i = 0; i < additions.size(); i++) {
 160                         CodeAddition addition = additions.get(i);
 161                         if (curSrcLine <  addition.lineNum) {
 162                                 // Be careful, subList is the interval [begin, end)
 163                                 newContent.addAll(content.subList(curSrcLine, addition.lineNum));
 164                                 curSrcLine = addition.lineNum;
 165                         }
 166                         newContent.addAll(addition.newCode);
 167                 }
 168                 newContent.addAll(content.subList(curSrcLine, content.size()));
 169                 return newContent;
 170         }
 171
 172         public void generateCode() {
 173                 for (int i = 0; i < _semantics.constructs.size(); i++) {
 174                         Construct construct = _semantics.constructs.get(i);
 175                         if (construct instanceof GlobalConstruct) {
 176                                 globalConstruct2Code((GlobalConstruct) construct);
 177                         } else if (construct instanceof InterfaceConstruct) {
 178                                 interface2Code((InterfaceConstruct) construct);
 179                         } else if (construct instanceof PotentialCPDefineConstruct) {
 180                                 potentialCPDefine2Code((PotentialCPDefineConstruct) construct);
 181                         } else if (construct instanceof CPDefineConstruct) {
 182                                 CPDefine2Code((CPDefineConstruct) construct);
 183                         } else if (construct instanceof CPDefineCheckConstruct) {
 184                                 CPDefineCheck2Code((CPDefineCheckConstruct) construct);
 185                         } else if (construct instanceof EntryPointConstruct) {
 186                                 EntryPoint2Code((EntryPointConstruct) construct);
 187                         }
 188                 }
 189                 // Sort code additions
 190                 for (File file : codeAdditions.keySet()) {
 191                         ArrayList<CodeAddition> additions = codeAdditions.get(file);
 192                         if (additions.size() == 0) // Simply do nothing, already written
 193                                                                                 // once
 194                                 continue;
 195                         ArrayList<String> content = _semantics.srcFilesInfo.get(file).content;
 196                         Collections.sort(additions, CodeAddition.lineNumComparator);
 197                         // Insert generated annotation to the source files
 198                         ArrayList<String> newContent = insertAnnotation2Src(additions,
 199                                         content);
 200                         // Write it back to file
 201                         ParserUtils.write2File(file, newContent);
 202                 }
 203
 204         }
 205
 206         public static void main(String[] argvs) {
 207                 String homeDir = Environment.HOME_DIRECTORY;
 208                 File[] srcFiles = {
 209 //                              new File(Environment.MODEL_CHECKER_TEST_DIR + "/backup_linuxrwlocks.c") };
 210 //               new File(homeDir + "/benchmark/linuxrwlocks/linuxrwlocks.c") };
 211                 new File(homeDir
 212                                 + "/benchmark/cliffc-hashtable/simplified_cliffc_hashtable.h"), };
 213 //               new File(homeDir + "/benchmark/ms-queue/my_queue.c"),
 214 //               new File(homeDir + "/benchmark/ms-queue/my_queue.c") };
 215 //              new File(homeDir + "/benchmark/test/test.c") };
 216                 CodeGenerator gen = new CodeGenerator(srcFiles);
 217                 gen.generateCode();
 218         }
 219 }