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

   1 package edu.uci.eecs.specCompiler.codeGenerator;
   2
   3 import java.util.ArrayList;
   4 import java.util.HashMap;
   5 import java.util.HashSet;
   6 import java.io.File;
   7
   8 import edu.uci.eecs.specCompiler.grammerParser.utilParser.UtilParser;
   9 import edu.uci.eecs.specCompiler.grammerParser.utilParser.ParseException;
  10 import edu.uci.eecs.specCompiler.specExtraction.CPClearConstruct;
  11 import edu.uci.eecs.specCompiler.specExtraction.CPDefineCheckConstruct;
  12 import edu.uci.eecs.specCompiler.specExtraction.CPDefineConstruct;
  13 import edu.uci.eecs.specCompiler.specExtraction.CommutativityRule;
  14 import edu.uci.eecs.specCompiler.specExtraction.ConditionalInterface;
  15 import edu.uci.eecs.specCompiler.specExtraction.Construct;
  16 import edu.uci.eecs.specCompiler.specExtraction.FunctionHeader;
  17 import edu.uci.eecs.specCompiler.specExtraction.GlobalConstruct;
  18 import edu.uci.eecs.specCompiler.specExtraction.InterfaceConstruct;
  19 import edu.uci.eecs.specCompiler.specExtraction.InterfaceDefineConstruct;
  20 import edu.uci.eecs.specCompiler.specExtraction.PotentialCPDefineConstruct;
  21 import edu.uci.eecs.specCompiler.specExtraction.SequentialDefineSubConstruct;
  22 import edu.uci.eecs.specCompiler.specExtraction.VariableDeclaration;
  23
  24 /**
  25  * <p>
  26  * Defines a list of commonly used constant strings.
  27  * </p>
  28  *
  29  * @author peizhaoo
  30  *
  31  */
  32 public class CodeVariables {
  33         // C++ code or library
  34         public static final String HEADER_STDLIB = "<stdlib.h>";
  35         public static final String HEADER_THREADS = "<threads.h>";
  36         public static final String HEADER_STDINT = "<stdint.h>";
  37         public static final String HEADER_MODELMEMORY = "<model_memory.h>";
  38         public static final String HEADER_MODELTYPES = "<modeltypes.h>";
  39         public static final String ThreadIDType = "thread_id_t";
  40         public static final String BOOLEAN = "bool";
  41         public static final String UINT64 = "uint64_t";
  42
  43         // Model checker code
  44         public static final String HEADER_CDSANNOTATE = "<cdsannotate.h>";
  45         public static final String HEADER_COMMON = "<common.h>";
  46         public static final String HEADER_SPECANNOTATION = "<specannotation.h>";
  47         public static final String HEADER_CDSTRACE = "<cdstrace.h>";
  48         public static final String CDSAnnotate = "cdsannotate";
  49         // public static final String CDSAnnotate = "cdsannotate";
  50         public static final String CDSAnnotateType = "SPEC_ANALYSIS";
  51         public static final String IDType = "call_id_t";
  52
  53         public static final String SPEC_ANNO_TYPE = "spec_anno_type";
  54         public static final String SPEC_ANNO_TYPE_INIT = "INIT";
  55         public static final String SPEC_ANNO_TYPE_HB_RULE = "HB_RULE";
  56         public static final String SPEC_ANNO_TYPE_INTERFACE_BEGIN = "INTERFACE_BEGIN";
  57         public static final String SPEC_ANNO_TYPE_HB_CONDITION = "HB_CONDITION";
  58         public static final String SPEC_ANNO_TYPE_INTERFACE_END = "INTERFACE_END";
  59         public static final String SPEC_ANNO_TYPE_POTENTIAL_CP_DEFINE = "POTENTIAL_CP_DEFINE";
  60         public static final String SPEC_ANNO_TYPE_CP_DEFINE_CHECK = "CP_DEFINE_CHECK";
  61         public static final String SPEC_ANNO_TYPE_CP_CLEAR = "CP_CLEAR";
  62         public static final String SPEC_ANNO_TYPE_CP_DEFINE = "CP_DEFINE";
  63         public static final String SPEC_ANNOTATION = "spec_annotation";
  64         public static final String SPEC_ANNOTATION_FIELD_TYPE = "type";
  65         public static final String SPEC_ANNOTATION_FIELD_ANNO = "annotation";
  66
  67         public static final String ANNO_INIT = "anno_init";
  68         public static final String HB_RULE = "hb_rule";
  69         public static final String COMMUTATIVITY_RULE = "commutativity_rule";
  70         public static final String ANNO_INTERFACE_BEGIN = "anno_interface_begin";
  71         public static final String ANNO_INTERFACE_END = "anno_interface_end";
  72         public static final String ANNO_POTENTIAL_CP_DEFINE = "anno_potential_cp_define";
  73         public static final String ANNO_CP_DEFINE = "anno_cp_define";
  74         public static final String ANNO_CP_DEFINE_CHECK = "anno_cp_define_check";
  75         public static final String ANNO_CP_CLEAR = "anno_cp_clear";
  76         public static final String ANNO_HB_CONDITION = "anno_hb_condition";
  77
  78         // Specification variables
  79         public static final String SPEC_INTERFACE_WRAPPER = "__wrapper_";
  80         public static final String DEFAULT_ID = "0";
  81
  82         // Specification library
  83         public static final String HEADER_SPEC_LIB = "<spec_lib.h>";
  84         public static final String SPEC_QUEUE = "spec_queue";
  85         public static final String SPEC_STACK = "spec_stack";
  86         public static final String SPEC_DEQUE = "spec_deque";
  87         public static final String SPEC_HASHTABLE = "spec_hashtable";
  88         public static final String SPEC_PRIVATE_HASHTABLE = "spec_private_hashtable";
  89         public static final String SPEC_TAG = "spec_tag";
  90         public static final String SPEC_TAG_CURRENT = "current";
  91         public static final String SPEC_TAG_NEXT = "next";
  92
  93         // Macro
  94         public static final String MACRO_ID = "__ID__";
  95         public static final String MACRO_COND = "__COND_SAT__";
  96         public static final String MACRO_RETURN = "__RET__";
  97         public static final String MACRO_ATOMIC_RETURN = "__ATOMIC_RET__";
  98         public static final String MACRO_THREAD_ID = "__TID__";
  99
 100         public static void printCode(ArrayList<String> code) {
 101                 for (int i = 0; i < code.size(); i++) {
 102                         System.out.println(code.get(i));
 103                 }
 104         }
 105
 106         private static String COMMENT(String comment) {
 107                 return "/* " + comment + " */";
 108         }
 109
 110         private static String SHORT_COMMENT(String comment) {
 111                 return " // " + comment;
 112         }
 113
 114         private static String INCLUDE(String header) {
 115                 return "#include " + header;
 116         }
 117
 118         private static String DEFINE(String left, String right) {
 119                 return "#define " + left + " " + right;
 120         }
 121
 122         private static String UNDEFINE(String macro) {
 123                 return "#undef " + macro;
 124         }
 125
 126         private static String GET_FIELD_BY_PTR(String ptr, String field) {
 127                 return ptr + "->" + field;
 128         }
 129
 130         private static String GET_FIELD(String var, String field) {
 131                 return var + "->" + field;
 132         }
 133
 134         private static String BRACE(String val) {
 135                 return "(" + val + ")";
 136         }
 137
 138         private static String ASSIGN(String structName, String field, String val) {
 139                 return structName + "." + field + " = " + val + ";";
 140         }
 141
 142         private static String ASSIGN(String varName, String val) {
 143                 return varName + " = " + val + ";";
 144         }
 145
 146         private static String ASSIGN_PTR(String structName, String field, String val) {
 147                 return structName + "." + field + " = &" + val + ";";
 148         }
 149
 150         private static String ASSIGN_TO_PTR(String structName, String field,
 151                         String val) {
 152                 return structName + "->" + field + " = " + val + ";";
 153         }
 154
 155         private static String ASSIGN_PTR_TO_PTR(String structName, String field,
 156                         String val) {
 157                 return structName + "->" + field + " = &" + val + ";";
 158         }
 159
 160         private static String STRUCT_NEW_DECLARE_DEFINE(String type, String name) {
 161                 return "struct " + type + " *" + name + " = (struct " + type
 162                                 + "*) malloc(sizeof(struct " + type + "));";
 163         }
 164
 165         private static String DECLARE(String type, String name) {
 166                 return type + " " + name + ";";
 167         }
 168
 169         private static String DECLARE(VariableDeclaration varDecl) {
 170                 String type = varDecl.type, name = varDecl.name;
 171                 return type + " " + name + ";";
 172         }
 173
 174         private static String DECLARE_DEFINE(String type, String var, String val) {
 175                 return type + " " + var + " = " + val + ";";
 176         }
 177
 178         private static String ANNOTATE(SemanticsChecker semantics, String structName) {
 179                 return CDSAnnotate + "(" + CDSAnnotateType + ", " + structName + ");";
 180         }
 181
 182         private static ArrayList<String> DEFINE_INFO_STRUCT(String interfaceName,
 183                         FunctionHeader header) {
 184                 ArrayList<String> code = new ArrayList<String>();
 185                 code.add("typedef struct " + interfaceName + "_info {");
 186                 if (!header.returnType.equals("void")) {
 187                         code.add(DECLARE(header.returnType, MACRO_RETURN));
 188                 }
 189                 for (int i = 0; i < header.args.size(); i++) {
 190                         code.add(DECLARE(header.args.get(i)));
 191                 }
 192                 code.add("} " + interfaceName + "_info;");
 193                 return code;
 194         }
 195
 196         private static ArrayList<String> DEFINE_ID_FUNC(
 197                         InterfaceConstruct construct, FunctionHeader header) {
 198                 String interfaceName = construct.name;
 199                 ArrayList<String> code = new ArrayList<String>();
 200                 String idCode = construct.idCode;
 201                 code.add("inline static " + IDType + " " + interfaceName + "_id("
 202                                 + "void *info, " + ThreadIDType + " " + MACRO_THREAD_ID + ") {");
 203
 204                 // Read info struct
 205                 if (!header.returnType.equals("void") || header.args.size() != 0) {
 206                         String infoStructType = interfaceName + "_info", infoStructName = "theInfo";
 207                         code.add(DECLARE_DEFINE("\t" + infoStructType + "*",
 208                                         infoStructName, BRACE(infoStructType + "*") + "info"));
 209                         if (!header.returnType.equals("void")) {
 210                                 code.add((DECLARE_DEFINE("\t" + header.returnType,
 211                                                 MACRO_RETURN,
 212                                                 GET_FIELD_BY_PTR(infoStructName, MACRO_RETURN))));
 213                         }
 214                         for (int i = 0; i < header.args.size(); i++) {
 215                                 String type = header.args.get(i).type, var = header.args.get(i).name;
 216                                 code.add("\t"
 217                                                 + (DECLARE_DEFINE(type, var,
 218                                                                 GET_FIELD_BY_PTR(infoStructName, var))));
 219                         }
 220                         code.add("");
 221                 }
 222
 223                 if (!idCode.equals("")) {
 224                         code.add("\t" + DECLARE_DEFINE(IDType, MACRO_ID, idCode));
 225                 } else {
 226                         code.add("\t" + DECLARE_DEFINE(IDType, MACRO_ID, DEFAULT_ID));
 227                 }
 228                 code.add("\treturn " + MACRO_ID + ";");
 229                 code.add("}");
 230                 return code;
 231         }
 232
 233         private static ArrayList<String> DEFINE_CHECK_ACTION_FUNC(
 234                         InterfaceConstruct construct, FunctionHeader header) {
 235                 String interfaceName = construct.name;
 236                 ArrayList<String> code = new ArrayList<String>();
 237                 code.add("inline static bool " + interfaceName
 238                                 + "_check_action(void *info, " + IDType + " " + MACRO_ID + ", "
 239                                 + ThreadIDType + " " + MACRO_THREAD_ID + ") {");
 240                 code.add("\t" + DECLARE("bool", "check_passed"));
 241                 // Read info struct
 242                 if (!header.returnType.equals("void") || header.args.size() != 0) {
 243                         String infoStructType = interfaceName + "_info", infoStructName = "theInfo";
 244                         code.add("\t"
 245                                         + DECLARE_DEFINE(infoStructType + "*", infoStructName,
 246                                                         BRACE(infoStructType + "*") + "info"));
 247                         if (!header.returnType.equals("void")) {
 248                                 code.add("\t"
 249                                                 + (DECLARE_DEFINE(header.returnType, MACRO_RETURN,
 250                                                                 GET_FIELD_BY_PTR(infoStructName, MACRO_RETURN))));
 251                         }
 252                         for (int i = 0; i < header.args.size(); i++) {
 253                                 String type = header.args.get(i).type, var = header.args.get(i).name;
 254                                 code.add("\t"
 255                                                 + (DECLARE_DEFINE(type, var,
 256                                                                 GET_FIELD_BY_PTR(infoStructName, var))));
 257                         }
 258                         code.add("");
 259                 }
 260                 // __COND_SAT
 261                 if (!construct.condition.equals("")) {
 262                         code.add("\t"
 263                                         + DECLARE_DEFINE("bool", MACRO_COND, construct.condition));
 264                 }
 265                 // Check
 266                 if (!construct.check.equals("")) {
 267                         code.add("\t" + ASSIGN("check_passed", construct.check));
 268                         code.add("\tif (!check_passed)");
 269                         code.add("\t\treturn false;");
 270
 271                 }
 272                 // Action
 273                 if (construct.action.size() > 0) {
 274                         addAllCodeWithIndent(code, construct.action, "\t");
 275                 }
 276                 // Post_check
 277                 if (!construct.postCheck.equals("")) {
 278                         code.add("\t" + ASSIGN("check_passed", construct.postCheck));
 279                         code.add("\tif (!check_passed)");
 280                         code.add("\t\treturn false;");
 281                 }
 282                 // Post_action
 283                 if (construct.postAction.size() > 0) {
 284                         addAllCodeWithIndent(code, construct.postAction, "\t");
 285                 }
 286                 // Return true finally
 287                 code.add("\treturn true;");
 288
 289                 code.add("}");
 290
 291                 return code;
 292         }
 293
 294         private static void addAllCodeWithIndent(ArrayList<String> allCode,
 295                         ArrayList<String> target, String indent) {
 296                 for (int i = 0; i < target.size(); i++) {
 297                         allCode.add(indent + target.get(i));
 298                 }
 299         }
 300
 301         public static HashSet<String> getAllHeaders(SemanticsChecker semantics) {
 302                 HashSet<String> headers = new HashSet<String>();
 303                 for (String interfaceName : semantics.interfaceName2Construct.keySet()) {
 304                         File f = semantics.interfaceName2Construct.get(interfaceName).file;
 305                         headers.addAll(semantics.srcFilesInfo.get(f).headers);
 306                 }
 307                 headers.add(HEADER_STDLIB);
 308                 headers.add(HEADER_STDINT);
 309                 headers.add(HEADER_MODELMEMORY);
 310                 headers.add(HEADER_MODELTYPES);
 311                 headers.add(HEADER_SPEC_LIB);
 312                 headers.add(HEADER_STDINT);
 313                 headers.add(HEADER_CDSANNOTATE);
 314                 // headers.add(HEADER_COMMON);
 315                 headers.add(HEADER_SPECANNOTATION);
 316                 return headers;
 317         }
 318
 319         private static void makeFunctionStatic(ArrayList<String> funcDefine) {
 320                 String headLine = funcDefine.get(0);
 321                 headLine = "inline static " + headLine;
 322                 funcDefine.set(0, headLine);
 323         }
 324
 325         private static String makeVariablesStatic(VariableDeclaration varDecl) {
 326                 String res = "static " + varDecl.type + " " + varDecl.name + ";";
 327                 return res;
 328         }
 329
 330         private static FunctionHeader getFunctionHeader(SemanticsChecker semantics,
 331                         Construct construct) {
 332                 ArrayList<String> content = semantics.srcFilesInfo.get(construct.file).content;
 333                 String headerLine = content.get(construct.beginLineNum + 1), templateLine = null;
 334                 if (headerLine.startsWith("template")) {
 335                         templateLine = headerLine;
 336                         headerLine = content.get(construct.beginLineNum + 2);
 337                 }
 338                 headerLine = headerLine.substring(0, headerLine.indexOf(')') + 1);
 339                 try {
 340                         FunctionHeader header = UtilParser.parseFuncHeader(headerLine);
 341                         if (templateLine != null) {
 342                                 ArrayList<VariableDeclaration> templateArgs = UtilParser
 343                                                 .getTemplateArg(templateLine);
 344                                 header.setTemplateList(templateArgs);
 345                         }
 346                         return header;
 347                 } catch (ParseException e) {
 348                         e.printStackTrace();
 349                 }
 350                 return null;
 351         }
 352
 353         public static ArrayList<String> generateGlobalVarDeclaration(
 354                         SemanticsChecker semantics, GlobalConstruct construct) {
 355                 ArrayList<String> newCode = new ArrayList<String>();
 356                 HashSet<String> allHeaders = getAllHeaders(semantics);
 357
 358                 SequentialDefineSubConstruct code = construct.code;
 359                 // User-defined structs first
 360                 newCode.add(COMMENT("All other user-defined structs"));
 361                 ArrayList<ArrayList<String>> declareStructs = code.declareStructs;
 362                 for (int i = 0; i < declareStructs.size(); i++) {
 363                         ArrayList<String> declareStruct = declareStructs.get(i);
 364                         newCode.addAll(declareStruct);
 365                         newCode.add("");
 366                 }
 367                 // User-defined variables
 368                 ArrayList<VariableDeclaration> varDecls = code.declareVar;
 369                 for (int i = 0; i < varDecls.size(); i++) {
 370                         VariableDeclaration varDecl = varDecls.get(i);
 371                         // Don't forget to make them static
 372                         newCode.add(makeVariablesStatic(varDecl));
 373                 }
 374                 // User-defined functions
 375                 newCode.add(COMMENT("All other user-defined functions"));
 376                 ArrayList<ArrayList<String>> defineFuncs = code.defineFuncs;
 377                 for (int i = 0; i < defineFuncs.size(); i++) {
 378                         ArrayList<String> defineFunc = defineFuncs.get(i);
 379                         makeFunctionStatic(defineFunc);
 380                         newCode.addAll(defineFunc);
 381                         newCode.add("");
 382                 }
 383
 384                 for (String interfaceName : semantics.interfaceName2Construct.keySet()) {
 385                         InterfaceConstruct iConstruct = semantics.interfaceName2Construct
 386                                         .get(interfaceName);
 387                         FunctionHeader funcHeader = getFunctionHeader(semantics, iConstruct);
 388                         // Define necessary info structure
 389                         if (!funcHeader.returnType.equals("void")
 390                                         || funcHeader.args.size() > 0) {
 391                                 newCode.add(COMMENT("Definition of interface info struct: "
 392                                                 + interfaceName));
 393                                 newCode.addAll(DEFINE_INFO_STRUCT(interfaceName, funcHeader));
 394                                 newCode.add(COMMENT("End of info struct definition: "
 395                                                 + interfaceName));
 396                                 newCode.add("");
 397                         }
 398
 399                         // Define ID function
 400                         newCode.add(COMMENT("ID function of interface: " + interfaceName));
 401                         newCode.addAll(DEFINE_ID_FUNC(iConstruct, funcHeader));
 402                         newCode.add(COMMENT("End of ID function: " + interfaceName));
 403                         newCode.add("");
 404
 405                         // Define check_action function
 406                         newCode.add(COMMENT("Check action function of interface: "
 407                                         + interfaceName));
 408                         newCode.addAll(DEFINE_CHECK_ACTION_FUNC(iConstruct, funcHeader));
 409                         newCode.add(COMMENT("End of check action function: "
 410                                         + interfaceName));
 411                         newCode.add("");
 412                 }
 413                 // Interface function pointer table
 414                 String interfaceSize = Integer
 415                                 .toString(semantics.interfaceName2Construct.size());
 416                 newCode.add(DEFINE("INTERFACE_SIZE", interfaceSize));
 417                 // Make it static
 418                 newCode.add("static " + DECLARE("void**", "func_ptr_table"));
 419                 // Happens-before initialization rules
 420                 // Should make it static
 421                 newCode.add("static " + DECLARE(HB_RULE + "**", "hb_rule_table"));
 422
 423                 // Declare the Commutativity Rule table
 424                 newCode.add("static "
 425                                 + DECLARE(COMMUTATIVITY_RULE + "**", "commutativity_rule_table"));
 426                 // Define the Commutativity Rule condition functions
 427                 ArrayList<CommutativityRule> rules = semantics.getGlobalConstruct().commutativityRules;
 428                 for (int i = 0; i < rules.size(); i++) {
 429                         CommutativityRule rule = rules.get(i);
 430                         String infoStructType1 = rule.method1 + "_info";
 431                         String infoStructType2 = rule.method2 + "_info";
 432                         String condition = rule.condition;
 433                         String conditionFuncName = "CommutativityCondition"
 434                                         + Integer.toString(i);
 435
 436                         // Replace the "_M1." and "_M2." with the actual info struct
 437                         condition = condition.replaceAll("_Method1 \\.", "_info1->");
 438                         condition = condition.replaceAll("_Method2 \\.", "_info2->");
 439
 440                         // Declare the signature of the condition function
 441                         newCode.add("inline static bool " + conditionFuncName
 442                                         + "(void *info1, void *info2) {");
 443
 444                         // Cast the "void*" type to the actual info type
 445                         newCode.add("\t"
 446                                         + DECLARE_DEFINE(infoStructType1, "*_info1", "("
 447                                                         + infoStructType1 + "*) info1"));
 448                         newCode.add("\t"
 449                                         + DECLARE_DEFINE(infoStructType2, "*_info2", "("
 450                                                         + infoStructType2 + "*) info2"));
 451                         newCode.add("\treturn " + condition + ";");
 452
 453                         // End of the condition function
 454                         newCode.add("}");
 455                 }
 456
 457                 newCode.add("");
 458
 459                 // Beginning initialization
 460                 // Define the __SPEC_INIT__ function to initialize user-defined
 461                 // variables
 462                 newCode.add(COMMENT("Initialization of sequential varialbes"));
 463                 newCode.add("static void __SPEC_INIT__() {");
 464                 addAllCodeWithIndent(newCode, construct.code.initVar, "\t");
 465                 newCode.add("}");
 466                 newCode.add("");
 467
 468                 // Define the __SPEC_CLEAN__ function for clean-up
 469                 newCode.add(COMMENT("Cleanup routine of sequential variables"));
 470                 newCode.add("static bool __SPEC_CLEANUP__() {");
 471                 if (construct.code.cleanupCode.size() > 0) {
 472                         addAllCodeWithIndent(newCode, construct.code.cleanupCode, "\t");
 473                 } else {
 474                         newCode.add("\treturn true;"); // If not specified return true
 475                 }
 476
 477                 newCode.add("}");
 478                 newCode.add("");
 479
 480                 newCode.add(COMMENT("Define function for sequential code initialization"));
 481                 newCode.add("inline static void __sequential_init() {");
 482
 483                 // Init func_ptr_table
 484                 newCode.add("\t" + COMMENT("Init func_ptr_table"));
 485                 newCode.add("\t"
 486                                 + ASSIGN("func_ptr_table", "(void**) malloc(sizeof(void*) * "
 487                                                 + semantics.interface2Num.size() + " * 2)"));
 488                 for (String interfaceName : semantics.interfaceName2Construct.keySet()) {
 489                         String interfaceNum = Integer.toString(semantics.interface2Num
 490                                         .get(interfaceName));
 491                         newCode.add("\t"
 492                                         + ASSIGN("func_ptr_table[2 * " + interfaceNum + "]",
 493                                                         "(void*) &" + interfaceName + "_id"));
 494                         newCode.add("\t"
 495                                         + ASSIGN("func_ptr_table[2 * " + interfaceNum + " + 1]",
 496                                                         "(void*) &" + interfaceName + "_check_action"));
 497                 }
 498
 499                 // Init Happens-before rules table
 500                 newCode.addAll(generateHBInitAnnotation(semantics));
 501
 502                 // Init Commutativity rules table
 503                 newCode.addAll(generateCommutativityAnnotation(semantics));
 504
 505                 // Pass init info, including function table info & HB rules
 506                 newCode.add("\t"
 507                                 + COMMENT("Pass init info, including function table info & HB rules & Commutativity Rules"));
 508                 String structName = "anno_init", anno = "init";
 509                 newCode.add("\t" + STRUCT_NEW_DECLARE_DEFINE(ANNO_INIT, structName));
 510                 newCode.add("\t"
 511                                 + ASSIGN_TO_PTR(structName, "init_func",
 512                                                 "(void_func_t) __SPEC_INIT__"));
 513                 newCode.add("\t"
 514                                 + ASSIGN_TO_PTR(structName, "cleanup_func",
 515                                                 "(cleanup_func_t) __SPEC_CLEANUP__"));
 516                 newCode.add("\t"
 517                                 + ASSIGN_TO_PTR(structName, "func_table", "func_ptr_table"));
 518                 newCode.add("\t"
 519                                 + ASSIGN_TO_PTR(structName, "func_table_size", "INTERFACE_SIZE"));
 520                 newCode.add("\t"
 521                                 + ASSIGN_TO_PTR(structName, "hb_rule_table", "hb_rule_table"));
 522                 newCode.add("\t"
 523                                 + ASSIGN_TO_PTR(structName, "hb_rule_table_size",
 524                                                 "HB_RULE_TABLE_SIZE"));
 525                 newCode.add("\t"
 526                                 + ASSIGN_TO_PTR(structName, "commutativity_rule_table",
 527                                                 "commutativity_rule_table"));
 528                 newCode.add("\t"
 529                                 + ASSIGN_TO_PTR(structName, "commutativity_rule_table_size",
 530                                                 Integer.toString(rules.size())));
 531
 532                 newCode.add("\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 533                 newCode.add("\t" + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_INIT));
 534                 newCode.add("\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 535                 newCode.add("\t" + ANNOTATE(semantics, anno));
 536
 537                 newCode.add("");
 538                 newCode.add("}");
 539                 newCode.add("");
 540
 541                 newCode.add(COMMENT("End of Global construct generation in class"));
 542
 543                 // printCode(newCode);
 544                 return newCode;
 545         }
 546
 547         public static ArrayList<String> generateStaticVarDefine(
 548                         SemanticsChecker semantics, GlobalConstruct construct) {
 549                 ArrayList<String> newCode = new ArrayList<String>();
 550                 String className = semantics.getClassName();
 551                 if (className == null)
 552                         return newCode; // No need to define any static variables
 553                 String templateList = semantics.getTemplateStr();
 554                 String varPrefix;
 555                 if (templateList == null) {
 556                         varPrefix = className + "::";
 557                 } else {
 558                         varPrefix = className + templateList + "::";
 559                 }
 560                 String templateDecl = semantics.getTemplateFullStr();
 561                 if (templateList == null) {
 562                         newCode.add(DECLARE("void**", varPrefix + "func_ptr_table"));
 563                         newCode.add(DECLARE("hb_rule**", varPrefix + "hb_rule_table"));
 564                         newCode.add(DECLARE("commutativity_rule**", varPrefix + "commutativity_rule_table"));
 565                         for (int i = 0; i < construct.code.declareVar.size(); i++) {
 566                                 VariableDeclaration varDecl = construct.code.declareVar.get(i);
 567                                 newCode.add(DECLARE(varDecl.type, varPrefix + varDecl.name));
 568                         }
 569                 } else {
 570                         newCode.add(templateDecl);
 571                         newCode.add(DECLARE("void**", varPrefix + "func_ptr_table"));
 572                         newCode.add(templateDecl);
 573                         newCode.add(DECLARE("hb_rule**", varPrefix + "hb_rule_table"));
 574                         newCode.add(templateDecl);
 575                         newCode.add(DECLARE("commutativity_rule**", varPrefix + "commutativity_rule_table"));
 576                         for (int i = 0; i < construct.code.declareVar.size(); i++) {
 577                                 VariableDeclaration varDecl = construct.code.declareVar.get(i);
 578                                 newCode.add(templateDecl);
 579                                 newCode.add(DECLARE(varDecl.type, varPrefix + varDecl.name));
 580                         }
 581                 }
 582                 return newCode;
 583         }
 584
 585         private static ArrayList<String> generateHBInitAnnotation(
 586                         SemanticsChecker semantics) {
 587                 ArrayList<String> newCode = new ArrayList<String>();
 588
 589                 int hbConditionInitIdx = 0;
 590                 for (ConditionalInterface left : semantics.getHBConditions().keySet()) {
 591                         for (ConditionalInterface right : semantics.getHBConditions().get(
 592                                         left)) {
 593                                 String structVarName = "hbConditionInit" + hbConditionInitIdx;
 594                                 // String annotationVarName = "hb_rule" + hbConditionInitIdx;
 595                                 hbConditionInitIdx++;
 596                                 String interfaceNumBefore = Integer
 597                                                 .toString(semantics.interface2Num
 598                                                                 .get(left.interfaceName)), hbLabelNumBefore = Integer
 599                                                 .toString(semantics.hbLabel2Num
 600                                                                 .get(left.hbConditionLabel)), interfaceNumAfter = Integer
 601                                                 .toString(semantics.interface2Num
 602                                                                 .get(right.interfaceName)), hbLabelNumAfter = Integer
 603                                                 .toString(semantics.hbLabel2Num
 604                                                                 .get(right.hbConditionLabel));
 605                                 newCode.add("\t" + COMMENT(left + " -> " + right));
 606
 607                                 newCode.add("\t"
 608                                                 + STRUCT_NEW_DECLARE_DEFINE(HB_RULE, structVarName));
 609                                 newCode.add("\t"
 610                                                 + ASSIGN_TO_PTR(structVarName, "interface_num_before",
 611                                                                 interfaceNumBefore)
 612                                                 + SHORT_COMMENT(left.interfaceName));
 613                                 newCode.add("\t"
 614                                                 + ASSIGN_TO_PTR(structVarName,
 615                                                                 "hb_condition_num_before", hbLabelNumBefore)
 616                                                 + SHORT_COMMENT(left.hbConditionLabel));
 617                                 newCode.add("\t"
 618                                                 + ASSIGN_TO_PTR(structVarName, "interface_num_after",
 619                                                                 interfaceNumAfter)
 620                                                 + SHORT_COMMENT(right.interfaceName));
 621                                 newCode.add("\t"
 622                                                 + ASSIGN_TO_PTR(structVarName,
 623                                                                 "hb_condition_num_after", hbLabelNumAfter)
 624                                                 + SHORT_COMMENT(right.hbConditionLabel));
 625                         }
 626                 }
 627                 // Init hb_rule_table
 628                 newCode.add("\t" + COMMENT("Init hb_rule_table"));
 629                 newCode.add("\t"
 630                                 + ASSIGN("hb_rule_table", "(" + HB_RULE
 631                                                 + "**) malloc(sizeof(" + HB_RULE + "*) * "
 632                                                 + hbConditionInitIdx + ")"));
 633                 // Define HB_RULE_TABLE_SIZE
 634                 newCode.add("\t"
 635                                 + DEFINE("HB_RULE_TABLE_SIZE",
 636                                                 Integer.toString(hbConditionInitIdx)));
 637                 for (int i = 0; i < hbConditionInitIdx; i++) {
 638                         newCode.add("\t"
 639                                         + ASSIGN("hb_rule_table[" + i + "]", "hbConditionInit" + i));
 640                 }
 641                 return newCode;
 642         }
 643
 644         private static ArrayList<String> generateCommutativityAnnotation(
 645                         SemanticsChecker semantics) {
 646                 ArrayList<String> newCode = new ArrayList<String>();
 647                 ArrayList<CommutativityRule> rules = semantics.getGlobalConstruct().commutativityRules;
 648
 649                 // Init commutativity_rule_table
 650                 newCode.add("\t" + COMMENT("Init commutativity_rule_table"));
 651
 652                 // Users have not defined any commutativity rules
 653                 if (rules.size() == 0)
 654                         return newCode;
 655
 656                 newCode.add("\t"
 657                                 + ASSIGN("commutativity_rule_table", "(" + COMMUTATIVITY_RULE
 658                                                 + "**) malloc(sizeof(" + COMMUTATIVITY_RULE + "*) * "
 659                                                 + rules.size() + ")"));
 660
 661                 // Declare a rule pointer
 662                 newCode.add("\t" + DECLARE("commutativity_rule*", "rule"));
 663
 664                 for (int i = 0; i < rules.size(); i++) {
 665                         CommutativityRule rule = rules.get(i);
 666                         Integer method = semantics.interface2Num.get(rule.method1);
 667                         if (method == null) {
 668                                 System.out.println("Wrong method label in commutativity rule: " + rule.method1);
 669                         }
 670                         String interfaceNumBefore = Integer.toString(method);
 671                         String interfaceNumAfter = Integer.toString(semantics.interface2Num
 672                                         .get(rule.method2));
 673                         String conditionFuncName = "CommutativityCondition" + i;
 674
 675                         // Construct a new rule
 676                         newCode.add("\t"
 677                                         + ASSIGN("rule",
 678                                                         "(commutativity_rule*) malloc (sizeof(commutativity_rule))"));
 679                         newCode.add("\t"
 680                                         + ASSIGN_TO_PTR("rule", "interface_num_before",
 681                                                         interfaceNumBefore));
 682                         newCode.add("\t"
 683                                         + ASSIGN_TO_PTR("rule", "interface_num_after",
 684                                                         interfaceNumAfter));
 685                         newCode.add("\t"
 686                                         + ASSIGN_TO_PTR("rule", "rule",
 687                                                         "\"" + rule.condition + "\""));
 688
 689                         newCode.add("\t"
 690                                         + ASSIGN_TO_PTR("rule", "condition", conditionFuncName));
 691
 692                         // Assign the rule to the corresponding commutativity table slot
 693                         newCode.add("\t"
 694                                         + ASSIGN("commutativity_rule_table[" + i + "]", "rule"));
 695                 }
 696
 697                 return newCode;
 698         }
 699
 700         public static ArrayList<String> generateEntryPointInitCall() {
 701                 ArrayList<String> newCode = new ArrayList<String>();
 702                 newCode.add("\t" + "__sequential_init();");
 703                 return newCode;
 704         }
 705
 706         public static ArrayList<String> generateInterfaceWrapperDeclaration(
 707                         SemanticsChecker semantics, InterfaceConstruct construct) {
 708                 FunctionHeader header = getFunctionHeader(semantics, construct);
 709                 ArrayList<String> declaration = new ArrayList<String>();
 710                 declaration.add(header.getRenamedHeader(SPEC_INTERFACE_WRAPPER)
 711                                 .getDeclaration() + ";");
 712                 return declaration;
 713         }
 714
 715         // Only generate the definition of the wrapper, don't do any renaming
 716         public static ArrayList<String> generateInterfaceWrapperDefinition(
 717                         SemanticsChecker semantics, InterfaceConstruct construct) {
 718                 ArrayList<String> newCode = new ArrayList<String>();
 719                 String interfaceName = construct.name;
 720
 721                 FunctionHeader header = getFunctionHeader(semantics, construct);
 722                 String interfaceNum = Integer.toString(semantics.interface2Num
 723                                 .get(construct.name));
 724
 725                 newCode.add(header.getTemplateFullStr());
 726                 newCode.add(header.getFuncStr() + " {");
 727                 // Wrapper function body
 728                 newCode.add("\t" + COMMENT("Interface begins"));
 729                 // Interface begin
 730                 String structName = "interface_begin";
 731                 newCode.add("\t"
 732                                 + STRUCT_NEW_DECLARE_DEFINE(ANNO_INTERFACE_BEGIN,
 733                                                 "interface_begin"));
 734                 newCode.add("\t"
 735                                 + ASSIGN_TO_PTR(structName, "interface_num", interfaceNum)
 736                                 + SHORT_COMMENT(construct.name));
 737                 newCode.add("\t\t"
 738                                 + ASSIGN_TO_PTR(structName, "interface_name", "\""
 739                                                 + construct.name + "\""));
 740
 741                 String anno = "annotation_interface_begin";
 742                 newCode.add("\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 743                 newCode.add("\t"
 744                                 + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_INTERFACE_BEGIN));
 745                 newCode.add("\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 746                 newCode.add("\t" + ANNOTATE(semantics, anno));
 747                 // Call original renamed function
 748                 if (header.returnType.equals("void")) {
 749                         newCode.add("\t" + header.getRenamedCall(SPEC_INTERFACE_WRAPPER)
 750                                         + ";");
 751                 } else {
 752                         newCode.add("\t"
 753                                         + DECLARE_DEFINE(header.returnType, MACRO_RETURN,
 754                                                         header.getRenamedCall(SPEC_INTERFACE_WRAPPER)));
 755                 }
 756                 // HB conditions
 757                 for (String label : construct.hbConditions.keySet()) {
 758                         String condition = construct.hbConditions.get(label);
 759                         String hbCondNum = Integer.toString(semantics.hbLabel2Num
 760                                         .get(label));
 761                         newCode.add("\t" + "if " + BRACE(condition) + " {");
 762                         structName = "hb_condition";
 763                         newCode.add("\t\t"
 764                                         + STRUCT_NEW_DECLARE_DEFINE(ANNO_HB_CONDITION, structName));
 765                         newCode.add("\t\t"
 766                                         + ASSIGN_TO_PTR(structName, "interface_num", interfaceNum)
 767                                         + SHORT_COMMENT(construct.name));
 768
 769                         newCode.add("\t\t"
 770                                         + ASSIGN_TO_PTR(structName, "hb_condition_num", hbCondNum));
 771                         anno = "annotation_hb_condition";
 772                         newCode.add("\t\t"
 773                                         + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 774                         newCode.add("\t\t"
 775                                         + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_HB_CONDITION));
 776                         newCode.add("\t\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 777                         newCode.add("\t\t" + ANNOTATE(semantics, anno));
 778                         newCode.add("\t" + "}");
 779                         newCode.add("");
 780                 }
 781                 // Also add the true condition if any
 782                 if (semantics.containsConditionalInterface(new ConditionalInterface(
 783                                 interfaceName, ""))) {
 784                         structName = "hb_condition";
 785                         newCode.add("\t"
 786                                         + STRUCT_NEW_DECLARE_DEFINE(ANNO_HB_CONDITION, structName));
 787                         newCode.add("\t"
 788                                         + ASSIGN_TO_PTR(structName, "interface_num", interfaceNum)
 789                                         + SHORT_COMMENT(construct.name));
 790                         newCode.add("\t"
 791                                         + ASSIGN_TO_PTR(structName, "hb_condition_num", "0"));
 792                         anno = "annotation_hb_condition";
 793                         newCode.add("\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 794                         newCode.add("\t"
 795                                         + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_HB_CONDITION));
 796                         newCode.add("\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 797                         newCode.add("\t" + ANNOTATE(semantics, anno));
 798                         newCode.add("");
 799                 }
 800                 // Interface end
 801                 String infoStructType = null, infoName = null;
 802                 if (!header.returnType.equals("void") || header.args.size() > 0) {
 803                         infoStructType = interfaceName + "_info";
 804                         infoName = "info";
 805                         newCode.add("\t"
 806                                         + DECLARE_DEFINE(infoStructType + "*", infoName,
 807                                                         BRACE(infoStructType + "*") + " malloc(sizeof("
 808                                                                         + infoStructType + "))"));
 809                         if (!header.returnType.equals("void")) {
 810                                 newCode.add("\t"
 811                                                 + ASSIGN_TO_PTR(infoName, MACRO_RETURN, MACRO_RETURN));
 812                         }
 813                         for (int i = 0; i < header.args.size(); i++) {
 814                                 String argName = header.args.get(i).name;
 815                                 newCode.add("\t" + ASSIGN_TO_PTR(infoName, argName, argName));
 816                         }
 817                 } else {
 818                         infoName = "NULL";
 819                 }
 820                 structName = "interface_end";
 821                 anno = "annoation_interface_end";
 822                 newCode.add("\t"
 823                                 + STRUCT_NEW_DECLARE_DEFINE(ANNO_INTERFACE_END, structName));
 824                 newCode.add("\t"
 825                                 + ASSIGN_TO_PTR(structName, "interface_num", interfaceNum)
 826                                 + SHORT_COMMENT(construct.name));
 827                 newCode.add("\t" + ASSIGN_TO_PTR(structName, "info", infoName));
 828                 newCode.add("\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 829                 newCode.add("\t"
 830                                 + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_INTERFACE_END));
 831                 newCode.add("\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 832                 newCode.add("\t" + ANNOTATE(semantics, anno));
 833                 // Return __RET__ if it's not void
 834                 if (!header.returnType.equals("void")) {
 835                         newCode.add("\t" + "return " + MACRO_RETURN + ";");
 836                 }
 837                 // End of the wrapper function
 838                 newCode.add("}");
 839
 840                 // printCode(newCode);
 841                 return newCode;
 842         }
 843
 844         // Rename the interface name for declaration or definition
 845         public static void renameInterface(SemanticsChecker semantics,
 846                         Construct construct) {
 847                 FunctionHeader header = getFunctionHeader(semantics, construct);
 848                 ArrayList<String> content = semantics.srcFilesInfo.get(construct.file).content;
 849                 int lineNum = construct.beginLineNum;
 850                 String headerLine = content.get(construct.beginLineNum);
 851                 if (headerLine.startsWith("template")) {
 852                         headerLine = content.get(construct.beginLineNum + 1);
 853                         lineNum++;
 854                 }
 855                 String newLine = header.getRenamedHeader(SPEC_INTERFACE_WRAPPER)
 856                                 .toString();
 857                 String oldLine = content.get(lineNum + 1);
 858
 859                 if (construct instanceof InterfaceConstruct) {
 860                         InterfaceConstruct iConstruct = (InterfaceConstruct) construct;
 861                         InterfaceDefineConstruct defineConstruct = semantics.interfaceName2DefineConstruct
 862                                         .get(iConstruct.name);
 863                         if (defineConstruct != null) { // There is a defineConstruct
 864                                 newLine = newLine + " ;";
 865                                 renameInterface(semantics, defineConstruct);
 866                         } else { // This is a declare & define construct
 867                                 if (oldLine.indexOf('{') != -1)
 868                                         newLine = newLine + " {";
 869                         }
 870                 } else {
 871                         if (oldLine.indexOf('{') != -1)
 872                                 newLine = newLine + " {";
 873                 }
 874
 875                 content.set(lineNum + 1, newLine);
 876         }
 877
 878         public static void addAtomicReturn(SemanticsChecker semantics,
 879                         Construct construct) {
 880                 int lineNum = construct.beginLineNum - 1;
 881                 ArrayList<String> content = semantics.srcFilesInfo.get(construct.file).content;
 882                 String oldLine = content.get(lineNum);
 883                 String newLine = "uint64_t " + MACRO_ATOMIC_RETURN + " = " + oldLine;
 884                 content.set(lineNum, newLine);
 885         }
 886
 887         public static ArrayList<String> generatePotentialCPDefine(
 888                         SemanticsChecker semantics, PotentialCPDefineConstruct construct) {
 889                 ArrayList<String> newCode = new ArrayList<String>();
 890                 // Add atomic return variable if the predicate accesses to it
 891                 if (construct.condition.indexOf(MACRO_ATOMIC_RETURN) != -1) {
 892                         addAtomicReturn(semantics, construct);
 893                 }
 894                 // Generate redundant header files
 895                 newCode.add("\t"
 896                                 + COMMENT("Automatically generated code for potential commit point: "
 897                                                 + construct.label));
 898                 newCode.add("");
 899                 // Add annotation
 900                 newCode.add("\t" + "if (" + construct.condition + ") {");
 901                 String structName = "potential_cp_define", anno = "annotation_potential_cp_define";
 902                 newCode.add("\t\t"
 903                                 + STRUCT_NEW_DECLARE_DEFINE(ANNO_POTENTIAL_CP_DEFINE,
 904                                                 structName));
 905                 String labelNum = Integer.toString(semantics.commitPointLabel2Num
 906                                 .get(construct.label));
 907                 newCode.add("\t\t" + ASSIGN_TO_PTR(structName, "label_num", labelNum));
 908                 newCode.add("\t\t"
 909                                 + ASSIGN_TO_PTR(structName, "label_name", "\""
 910                                                 + construct.label + "\""));
 911
 912                 newCode.add("\t\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 913                 newCode.add("\t\t"
 914                                 + ASSIGN_TO_PTR(anno, "type",
 915                                                 SPEC_ANNO_TYPE_POTENTIAL_CP_DEFINE));
 916                 newCode.add("\t\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 917                 newCode.add("\t\t" + ANNOTATE(semantics, anno));
 918                 newCode.add("\t" + "}");
 919                 return newCode;
 920         }
 921
 922         public static String getCPInterfaceNum(SemanticsChecker semantics,
 923                         String commitPointLabel) {
 924                 HashMap<String, InterfaceConstruct> cp2Interface = semantics.CPLabel2InterfaceConstruct;
 925                 InterfaceConstruct iConstruct = cp2Interface.get(commitPointLabel);
 926                 String interfaceName = iConstruct.name;
 927                 String interfaceNum = Integer.toString(semantics.interface2Num
 928                                 .get(interfaceName));
 929                 return interfaceNum;
 930         }
 931
 932         /**
 933          * <p>
 934          * Commit point define check should be unique to each interface, meaning
 935          * that they are not shared between different interfaces
 936          * </p>
 937          *
 938          * @param semantics
 939          * @param construct
 940          * @return
 941          */
 942         public static ArrayList<String> generateCPDefineCheck(
 943                         SemanticsChecker semantics, CPDefineCheckConstruct construct) {
 944                 ArrayList<String> newCode = new ArrayList<String>();
 945                 // Add atomic return variable if the predicate accesses to it
 946                 if (construct.condition.indexOf(MACRO_ATOMIC_RETURN) != -1) {
 947                         addAtomicReturn(semantics, construct);
 948                 }
 949                 // Generate redundant header files
 950                 newCode.add("\t"
 951                                 + COMMENT("Automatically generated code for commit point define check: "
 952                                                 + construct.label));
 953                 newCode.add("");
 954                 // Add annotation
 955
 956                 newCode.add("\t" + "if (" + construct.condition + ") {");
 957                 String structName = "cp_define_check", anno = "annotation_cp_define_check";
 958                 newCode.add("\t\t"
 959                                 + STRUCT_NEW_DECLARE_DEFINE(ANNO_CP_DEFINE_CHECK, structName));
 960                 String labelNum = Integer.toString(semantics.commitPointLabel2Num
 961                                 .get(construct.label));
 962                 String interfaceNum = getCPInterfaceNum(semantics, construct.label);
 963                 newCode.add("\t\t" + ASSIGN_TO_PTR(structName, "label_num", labelNum));
 964                 newCode.add("\t\t"
 965                                 + ASSIGN_TO_PTR(structName, "label_name", "\""
 966                                                 + construct.label + "\""));
 967                 newCode.add("\t\t"
 968                                 + ASSIGN_TO_PTR(structName, "interface_num", interfaceNum));
 969
 970                 newCode.add("\t\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
 971                 newCode.add("\t\t"
 972                                 + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_CP_DEFINE_CHECK));
 973                 newCode.add("\t\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
 974                 newCode.add("\t\t" + ANNOTATE(semantics, anno));
 975                 newCode.add("\t" + "}");
 976                 return newCode;
 977         }
 978
 979         /**
 980          * <p>
 981          * Commit point define check should be unique to each interface, meaning
 982          * that they are not shared between different interfaces
 983          * </p>
 984          *
 985          * @param semantics
 986          * @param construct
 987          * @return
 988          */
 989         public static ArrayList<String> generateCPClear(SemanticsChecker semantics,
 990                         CPClearConstruct construct) {
 991                 ArrayList<String> newCode = new ArrayList<String>();
 992                 // Add atomic return variable if the predicate accesses to it
 993                 if (construct.condition.indexOf(MACRO_ATOMIC_RETURN) != -1) {
 994                         addAtomicReturn(semantics, construct);
 995                 }
 996                 // Generate redundant header files
 997                 newCode.add("\t"
 998                                 + COMMENT("Automatically generated code for commit point clear: "
 999                                                 + construct.label));
1000                 newCode.add("");
1001                 // Add annotation
1002
1003                 newCode.add("\t" + "if (" + construct.condition + ") {");
1004                 String structName = "cp_clear", anno = "annotation_cp_clear";
1005                 newCode.add("\t\t"
1006                                 + STRUCT_NEW_DECLARE_DEFINE(ANNO_CP_CLEAR, structName));
1007
1008                 String labelNum = Integer.toString(semantics.commitPointLabel2Num
1009                                 .get(construct.label));
1010                 String labelName = construct.label;
1011                 newCode.add("\t\t" + ASSIGN_TO_PTR(structName, "label_name",
1012                                 "\"" + labelName + "\""));
1013                 newCode.add("\t\t" + ASSIGN_TO_PTR(structName, "label_num",
1014                                 labelNum));
1015
1016                 newCode.add("\t\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
1017                 newCode.add("\t\t"
1018                                 + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_CP_CLEAR));
1019                 newCode.add("\t\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
1020                 newCode.add("\t\t" + ANNOTATE(semantics, anno));
1021                 newCode.add("\t" + "}");
1022                 return newCode;
1023         }
1024
1025         /**
1026          * <p>
1027          * Commit point define should be unique to each interface, meaning that they
1028          * are not shared between different interfaces
1029          * </p>
1030          *
1031          * @param semantics
1032          * @param construct
1033          * @return
1034          */
1035         public static ArrayList<String> generateCPDefine(
1036                         SemanticsChecker semantics, CPDefineConstruct construct) {
1037                 ArrayList<String> newCode = new ArrayList<String>();
1038                 // Generate redundant header files
1039                 newCode.add("\t"
1040                                 + COMMENT("Automatically generated code for commit point define: "
1041                                                 + construct.label));
1042                 newCode.add("");
1043                 // Add annotation
1044                 newCode.add("\t" + "if (" + construct.condition + ") {");
1045                 String structName = "cp_define", anno = "annotation_cp_define";
1046                 newCode.add("\t\t"
1047                                 + STRUCT_NEW_DECLARE_DEFINE(ANNO_CP_DEFINE, structName));
1048                 String labelNum = Integer.toString(semantics.commitPointLabel2Num
1049                                 .get(construct.label));
1050                 String interfaceNum = getCPInterfaceNum(semantics, construct.label);
1051                 String potentialLabelNum = Integer
1052                                 .toString(semantics.commitPointLabel2Num
1053                                                 .get(construct.potentialCPLabel));
1054                 newCode.add("\t\t" + ASSIGN_TO_PTR(structName, "label_num", labelNum));
1055                 newCode.add("\t\t"
1056                                 + ASSIGN_TO_PTR(structName, "label_name", "\""
1057                                                 + construct.label + "\""));
1058                 newCode.add("\t\t"
1059                                 + ASSIGN_TO_PTR(structName, "potential_cp_label_num",
1060                                                 potentialLabelNum));
1061                 newCode.add("\t\t"
1062                                 + ASSIGN_TO_PTR(structName, "potential_label_name", "\""
1063                                                 + construct.potentialCPLabel + "\""));
1064                 newCode.add("\t\t"
1065                                 + ASSIGN_TO_PTR(structName, "interface_num", interfaceNum));
1066                 newCode.add("\t\t" + STRUCT_NEW_DECLARE_DEFINE(SPEC_ANNOTATION, anno));
1067                 newCode.add("\t\t"
1068                                 + ASSIGN_TO_PTR(anno, "type", SPEC_ANNO_TYPE_CP_DEFINE));
1069                 newCode.add("\t\t" + ASSIGN_TO_PTR(anno, "annotation", structName));
1070                 newCode.add("\t\t" + ANNOTATE(semantics, anno));
1071                 newCode.add("\t" + "}");
1072                 return newCode;
1073         }
1074 }