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                 // First rename the interface
  93                 CodeVariables.renameInterface(_semantics, construct);
  94
  95                 // If there's no define construct for it, we generate the wrapper just
  96                 // in place without declaration
  97                 InterfaceDefineConstruct defineConstruct = _semantics.interfaceName2DefineConstruct
  98                                 .get(construct.name);
  99                 ArrayList<String> newCode;
 100                 int lineNum;
 101                 CodeAddition addition;
 102                 // Then generate the wrapper if necessary
 103                 if (defineConstruct != null) { // Need to have a wrapper declaration
 104                         newCode = CodeVariables.generateInterfaceWrapperDeclaration(_semantics, construct);
 105                         lineNum = construct.beginLineNum;
 106                         // Add the wrapper declaration
 107                         addition = new CodeAddition(lineNum, newCode);
 108                         if (!codeAdditions.containsKey(construct.file)) {
 109                                 codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 110                         }
 111                         codeAdditions.get(construct.file).add(addition);
 112
 113                         // Add the wrapper definition
 114                         newCode = CodeVariables.generateInterfaceWrapperDefinition(_semantics, construct);
 115                         lineNum = defineConstruct.beginLineNum;
 116                         // Add the wrapper declaration
 117                         addition = new CodeAddition(lineNum, newCode);
 118                         if (!codeAdditions.containsKey(defineConstruct.file)) {
 119                                 codeAdditions.put(defineConstruct.file, new ArrayList<CodeAddition>());
 120                         }
 121                         codeAdditions.get(defineConstruct.file).add(addition);
 122                 } else { // No declaration needed
 123                         // Last generate the definition
 124                         newCode = CodeVariables.generateInterfaceWrapperDefinition(_semantics, construct);
 125                         lineNum = construct.beginLineNum;
 126                         // Add the wrapper declaration
 127                         addition = new CodeAddition(lineNum, newCode);
 128                         if (!codeAdditions.containsKey(construct.file)) {
 129                                 codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 130                         }
 131                         codeAdditions.get(construct.file).add(addition);
 132                 }
 133
 134         }
 135
 136         private void potentialCPDefine2Code(PotentialCPDefineConstruct construct) {
 137                 int lineNum = construct.beginLineNum;
 138                 ArrayList<String> newCode = CodeVariables.generatePotentialCPDefine(
 139                                 _semantics, construct);
 140
 141                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 142                 if (!codeAdditions.containsKey(construct.file)) {
 143                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 144                 }
 145                 codeAdditions.get(construct.file).add(addition);
 146         }
 147
 148         private void CPDefine2Code(CPDefineConstruct construct) {
 149                 int lineNum = construct.beginLineNum;
 150                 ArrayList<String> newCode = CodeVariables.generateCPDefine(_semantics,
 151                                 construct);
 152
 153                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 154                 if (!codeAdditions.containsKey(construct.file)) {
 155                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 156                 }
 157                 codeAdditions.get(construct.file).add(addition);
 158         }
 159
 160         private void CPDefineCheck2Code(CPDefineCheckConstruct construct) {
 161                 int lineNum = construct.beginLineNum;
 162                 ArrayList<String> newCode = CodeVariables.generateCPDefineCheck(
 163                                 _semantics, construct);
 164
 165                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 166                 if (!codeAdditions.containsKey(construct.file)) {
 167                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 168                 }
 169                 codeAdditions.get(construct.file).add(addition);
 170         }
 171
 172         private void EntryPoint2Code(EntryPointConstruct construct) {
 173                 int lineNum = construct.beginLineNum;
 174                 ArrayList<String> newCode = new ArrayList<String>();
 175                 newCode.addAll(CodeVariables.generateEntryPointInitCall());
 176
 177                 CodeAddition addition = new CodeAddition(lineNum, newCode);
 178                 if (!codeAdditions.containsKey(construct.file)) {
 179                         codeAdditions.put(construct.file, new ArrayList<CodeAddition>());
 180                 }
 181                 codeAdditions.get(construct.file).add(addition);
 182         }
 183
 184         private ArrayList<String> insertAnnotation2Src(
 185                         ArrayList<CodeAddition> additions, ArrayList<String> content) {
 186                 int totalSize = content.size();
 187                 for (int i = 0; i < additions.size(); i++) {
 188                         totalSize += additions.size();
 189                 }
 190                 ArrayList<String> newContent = new ArrayList<String>(totalSize);
 191                 int curSrcLine = 0;
 192                 for (int i = 0; i < additions.size(); i++) {
 193                         CodeAddition addition = additions.get(i);
 194                         if (curSrcLine < addition.lineNum) {
 195                                 // Be careful, subList is the interval [begin, end)
 196                                 newContent
 197                                                 .addAll(content.subList(curSrcLine, addition.lineNum));
 198                                 curSrcLine = addition.lineNum;
 199                         }
 200                         newContent.addAll(addition.newCode);
 201                 }
 202                 newContent.addAll(content.subList(curSrcLine, content.size()));
 203                 return newContent;
 204         }
 205
 206         public void generateCode() {
 207                 for (int i = 0; i < _semantics.constructs.size(); i++) {
 208                         Construct construct = _semantics.constructs.get(i);
 209                         if (construct instanceof GlobalConstruct) {
 210                                 globalConstruct2Code((GlobalConstruct) construct);
 211                         } else if (construct instanceof InterfaceConstruct) {
 212                                 interface2Code((InterfaceConstruct) construct);
 213                         } else if (construct instanceof PotentialCPDefineConstruct) {
 214                                 potentialCPDefine2Code((PotentialCPDefineConstruct) construct);
 215                         } else if (construct instanceof CPDefineConstruct) {
 216                                 CPDefine2Code((CPDefineConstruct) construct);
 217                         } else if (construct instanceof CPDefineCheckConstruct) {
 218                                 CPDefineCheck2Code((CPDefineCheckConstruct) construct);
 219                         } else if (construct instanceof EntryPointConstruct) {
 220                                 EntryPoint2Code((EntryPointConstruct) construct);
 221                         }
 222                 }
 223                 // Sort code additions
 224                 for (File file : codeAdditions.keySet()) {
 225                         ArrayList<CodeAddition> additions = codeAdditions.get(file);
 226                         if (additions.size() == 0) // Simply do nothing, already written
 227                                                                                 // once
 228                                 continue;
 229                         ArrayList<String> content = _semantics.srcFilesInfo.get(file).content;
 230                         Collections.sort(additions, CodeAddition.lineNumComparator);
 231                         // Insert generated annotation to the source files
 232                         ArrayList<String> newContent = insertAnnotation2Src(additions,
 233                                         content);
 234                         // Write it back to file
 235                         ParserUtils.write2File(file, newContent);
 236                 }
 237
 238         }
 239
 240         public static void main(String[] argvs) {
 241                 String homeDir = Environment.HOME_DIRECTORY;
 242                 File[] srcFiles = {
 243                 // new File(Environment.MODEL_CHECKER_TEST_DIR +
 244                 // "/backup_linuxrwlocks.c") };
 245                 // new File(homeDir + "/benchmark/linuxrwlocks/linuxrwlocks.c") };
 246                 new File(homeDir
 247                                 + "/benchmark/cliffc-hashtable/simplified_cliffc_hashtable.h"), };
 248                 // new File(homeDir + "/benchmark/ms-queue/my_queue.c"),
 249                 // new File(homeDir + "/benchmark/ms-queue/my_queue.c") };
 250                 // new File(homeDir + "/benchmark/test/test.c") };
 251                 CodeGenerator gen = new CodeGenerator(srcFiles);
 252                 gen.generateCode();
 253         }
 254 }