Add a running flag 'methodeffects' for new analysis.
[IRC.git] / Robust / src / Main / Main.java
1 package Main;
2
3 import java.io.FileOutputStream;
4 import java.io.PrintStream;
5 import java.io.Reader;
6 import java.io.BufferedReader;
7 import java.io.FileReader;
8 import java.io.FileInputStream;
9 import java.util.Hashtable;
10 import java.util.Iterator;
11 import java.util.Set;
12 import java.util.Vector;
13
14 import IR.Tree.ParseNode;
15 import IR.Tree.BuildIR;
16 import IR.Tree.SemanticCheck;
17 import IR.Flat.BuildCodeMultiCore;
18 import IR.Flat.BuildFlat;
19 import IR.Flat.BuildCode;
20 import IR.Flat.Inliner;
21 import IR.ClassDescriptor;
22 import IR.State;
23 import IR.TaskDescriptor;
24 import IR.TypeUtil;
25 import Analysis.Scheduling.MCImplSynthesis;
26 import Analysis.Scheduling.Schedule;
27 import Analysis.Scheduling.ScheduleAnalysis;
28 import Analysis.Scheduling.ScheduleSimulator;
29 import Analysis.TaskStateAnalysis.TaskAnalysis;
30 import Analysis.TaskStateAnalysis.TaskTagAnalysis;
31 import Analysis.TaskStateAnalysis.TaskGraph;
32 import Analysis.CallGraph.CallGraph;
33 import Analysis.TaskStateAnalysis.FEdge;
34 import Analysis.TaskStateAnalysis.FlagState;
35 import Analysis.TaskStateAnalysis.TagAnalysis;
36 import Analysis.TaskStateAnalysis.GarbageAnalysis;
37 import Analysis.TaskStateAnalysis.ExecutionGraph;
38 import Analysis.TaskStateAnalysis.SafetyAnalysis;
39 import Analysis.Locality.LocalityAnalysis;
40 import Analysis.Locality.GenerateConversions;
41 import Analysis.Prefetch.PrefetchAnalysis;
42 import Analysis.FlatIRGraph.FlatIRGraph;
43 import Analysis.OwnershipAnalysis.OwnershipAnalysis;
44 import Analysis.MLP.MLPAnalysis;
45 import Analysis.Loops.*;
46 import IR.MethodDescriptor;
47 import IR.Flat.FlatMethod;
48 import Interface.*;
49 import Util.GraphNode;
50 import Util.GraphNode.DFS;
51 import Util.GraphNode.SCC;
52
53 public class Main {
54
55   /** Main method for the compiler.  */
56
57   public static void main(String args[]) throws Exception {
58     String ClassLibraryPrefix="./ClassLibrary/";
59     State state=new State();
60     Vector sourcefiles=new Vector();
61     state.classpath.add(".");
62
63     String outputdir = null;
64     boolean isDistributeInfo = false;
65     boolean isDisAll = false;
66     int startnum = 0;
67
68     for(int i=0; i<args.length; i++) {
69       String option=args[i];
70       if (option.equals("-precise"))
71         IR.Flat.BuildCode.GENERATEPRECISEGC=true;
72       else if (option.equals("-prefetch"))
73         state.PREFETCH=true;
74       else if (option.equals("-dir"))
75         IR.Flat.BuildCode.PREFIX=args[++i]+"/";
76       else if (option.equals("-fastcheck"))
77         state.FASTCHECK=true;
78       else if (option.equals("-selfloop"))
79         state.selfloops.add(args[++i]);
80           else if (option.equals("-outputdir"))
81         state.outputdir = args[++i];
82       else if (option.equals("-excprefetch"))
83         state.excprefetch.add(args[++i]);
84       else if (option.equals("-classlibrary"))
85         state.classpath.add(args[++i]);
86       else if (option.equals("-inlineatomic")) {
87         state.INLINEATOMIC=true;
88         state.inlineatomicdepth=Integer.parseInt(args[++i]);
89       } else if(option.equals("-numcore")) {
90         ++i;
91         state.CORENUM = Integer.parseInt(args[i]);
92       } else if (option.equals("-mainclass"))
93         state.main=args[++i];
94       else if (option.equals("-trueprob")) {
95         state.TRUEPROB=Double.parseDouble(args[++i]);
96       } else if (option.equals("-printflat"))
97         State.PRINTFLAT=true;
98       else if (option.equals("-printscheduling"))
99         State.PRINTSCHEDULING=true;
100       else if (option.equals("-minimize"))
101         state.MINIMIZE=true;
102       else if (option.equals("-printschedulesim"))
103         State.PRINTSCHEDULESIM=true;
104       else if (option.equals("-printcriticalpath"))
105           State.PRINTCRITICALPATH=true;
106       else if (option.equals("-struct"))
107         state.structfile=args[++i];
108       else if (option.equals("-conscheck"))
109         state.CONSCHECK=true;
110       else if (option.equals("-task"))
111         state.TASK=true;
112       else if (option.equals("-abortreaders"))
113         state.ABORTREADERS=true;
114       else if (option.equals("-taskstate"))
115         state.TASKSTATE=true;
116       else if (option.equals("-tagstate"))
117         state.TAGSTATE=true;
118       else if (option.equals("-flatirtasks")) {
119         state.FLATIRGRAPH=true;
120         state.FLATIRGRAPHTASKS=true;
121       } else if (option.equals("-flatirusermethods")) {
122         state.FLATIRGRAPH=true;
123         state.FLATIRGRAPHUSERMETHODS=true;
124       } else if (option.equals("-flatirlibmethods")) {
125         state.FLATIRGRAPH=true;
126         state.FLATIRGRAPHLIBMETHODS=true;
127       } else if (option.equals("-multicore"))
128         state.MULTICORE=true;
129       else if (option.equals("-multicoregc"))
130         state.MULTICOREGC=true;
131       else if (option.equals("-ownership"))
132         state.OWNERSHIP=true;
133       else if (option.equals("-ownallocdepth")) {
134         state.OWNERSHIPALLOCDEPTH=Integer.parseInt(args[++i]);
135       } else if (option.equals("-ownwritedots")) {
136         state.OWNERSHIPWRITEDOTS=true;
137         if (args[++i].equals("all")) {
138           state.OWNERSHIPWRITEALL=true;
139         }
140       } else if (option.equals("-ownaliasfile"))
141         state.OWNERSHIPALIASFILE=args[++i];
142       else if (option.equals("-optional"))
143         state.OPTIONAL=true;
144       else if (option.equals("-optimize"))
145         state.OPTIMIZE=true;
146       else if (option.equals("-dcopts"))
147         state.DCOPTS=true;
148       else if (option.equals("-arraypad"))
149         state.ARRAYPAD=true;
150       else if (option.equals("-delaycomp"))
151         state.DELAYCOMP=true;
152       else if (option.equals("-raw"))
153         state.RAW=true;
154       else if (option.equals("-scheduling"))
155         state.SCHEDULING=true;
156       else if (option.equals("-distributioninfo"))
157         isDistributeInfo=true;
158       else if (option.equals("-disall"))
159         isDisAll=true;
160       else if (option.equals("-disstart"))
161         startnum = Integer.parseInt(args[++i]);
162       else if (option.equals("-useprofile")) {
163         state.USEPROFILE=true;
164     state.profilename = args[++i];
165       }
166       else if (option.equals("-thread"))
167         state.THREAD=true;
168       else if (option.equals("-dsm"))
169         state.DSM=true;
170       else if (option.equals("-singleTM"))
171         state.SINGLETM=true;
172       else if (option.equals("-readset"))
173         state.READSET=true;
174       else if (option.equals("-webinterface"))
175         state.WEBINTERFACE=true;
176       else if (option.equals("-instructionfailures"))
177         state.INSTRUCTIONFAILURE=true;
178       else if (option.equals("-abcclose"))
179         state.ARRAYBOUNDARYCHECK=false;
180
181       else if (option.equals("-mlp")) {
182         state.MLP            = true;
183         state.OWNERSHIP      = true;
184         state.MLP_NUMCORES   = Integer.parseInt( args[++i] );
185         state.MLP_MAXSESEAGE = Integer.parseInt( args[++i] );
186
187       } else if (option.equals("-mlpdebug")) {
188         state.MLPDEBUG=true;
189
190       } else if (option.equals("-methodeffects")) {
191         state.METHODEFFECTS=true;
192       }else if (option.equals("-help")) {
193         System.out.println("-classlibrary classlibrarydirectory -- directory where classlibrary is located");
194         System.out.println("-selfloop task -- this task doesn't self loop its parameters forever");
195         System.out.println("-dir outputdirectory -- output code in outputdirectory");
196         System.out.println("-struct structfile -- output structure declarations for repair tool");
197         System.out.println("-mainclass -- main function to call");
198         System.out.println("-dsm -- distributed shared memory support");
199         System.out.println("-singleTM -- single machine committing transactions");
200         System.out.println("-abortreaders -- abort readers");
201         System.out.println("-precise -- use precise garbage collection");
202         System.out.println("-conscheck -- turn on consistency checking");
203         System.out.println("-task -- compiler for tasks");
204         System.out.println("-fastcheck -- fastcheckpointing for Bristlecone");
205         System.out.println("-thread -- threads");
206         System.out.println("-trueprob <d> -- probability of true branch");
207         System.out.println("-printflat -- print out flat representation");
208         System.out.println("-instructionfailures -- insert code for instruction level failures");
209         System.out.println("-taskstate -- do task state analysis");
210         System.out.println("-flatirtasks -- create dot files for flat IR graphs of tasks");
211         System.out.println("-flatirusermethods -- create dot files for flat IR graphs of user methods");
212         System.out.println("-flatirlibmethods -- create dot files for flat IR graphs of library class methods");
213         System.out.println("  note: -flatirusermethods or -flatirlibmethods currently generate all class method flat IR graphs");
214         System.out.println("-ownership -- do ownership analysis");
215         System.out.println("-ownallocdepth <d> -- set allocation depth for ownership analysis");
216         System.out.println("-ownwritedots <all/final> -- write ownership graphs; can be all results or just final results");
217         System.out.println("-ownaliasfile <filename> -- write a text file showing all detected aliases in program tasks");
218         System.out.println("-optimize -- enable optimizations");
219         System.out.println("-optional -- enable optional arguments");
220         System.out.println("-abcclose close the array boundary check");
221         System.out.println("-scheduling do task scheduling");
222         System.out.println("-mlp <num cores> <max sese age> build mlp code");
223         System.out.println("-mlpdebug if mlp, report progress and interim results");
224         System.out.println("-multicore generate multi-core version binary");
225         System.out.println("-numcore set the number of cores (should be used together with -multicore), defaultly set as 1");
226         System.out.println("-interrupt generate raw version binary with interruption (should be used togethere with -raw)");
227         System.out.println("-rawconfig config raw simulator as 4xn (should be used together with -raw)");
228         System.out.println("-rawpath print out execute path information for raw version (should be used together with -raw)");
229         System.out.println("-useprofile use profiling data for scheduling (should be used together with -raw)");
230         System.out.println("-threadsimulate generate multi-thread simulate version binary");
231         System.out.println("-rawuseio use standard io to output profiling data (should be used together with -raw and -profile), it only works with single core version");
232         System.out.println("-printscheduling -- print out scheduling graphs");
233         System.out.println("-printschedulesim -- print out scheduling simulation result graphs");
234         System.out.println("-webinterface -- enable web interface");
235         System.out.println("-help -- print out help");
236         System.exit(0);
237       } else {
238         sourcefiles.add(args[i]);
239       }
240     }
241
242     //add default classpath
243     if (state.classpath.size()==1)
244       state.classpath.add(ClassLibraryPrefix);
245
246     BuildIR bir=new BuildIR(state);
247     TypeUtil tu=new TypeUtil(state, bir);
248     
249
250     SemanticCheck sc=new SemanticCheck(state,tu);
251
252     for(int i=0;i<sourcefiles.size();i++)
253       loadClass(state, bir,(String)sourcefiles.get(i));
254
255     //Stuff the runtime wants to see
256     sc.getClass("String");
257     sc.getClass("Math");
258     sc.getClass("File");
259     sc.getClass("Socket");
260     sc.getClass("ServerSocket");
261     sc.getClass("FileInputStream");
262     sc.getClass("FileOutputStream");
263     if (state.TASK) {
264       sc.getClass("TagDescriptor");
265     }
266     if (state.THREAD||state.DSM||state.SINGLETM) {
267       sc.getClass("Thread");
268     }
269
270     sc.semanticCheck();
271
272     tu.createFullTable();
273
274     BuildFlat bf=new BuildFlat(state,tu);
275     bf.buildFlat();
276     SafetyAnalysis sa=null;
277     PrefetchAnalysis pa=null;
278     MLPAnalysis mlpa=null;
279     if (state.INLINEATOMIC) {
280       Iterator classit=state.getClassSymbolTable().getDescriptorsIterator();
281       while(classit.hasNext()) {
282         ClassDescriptor cn=(ClassDescriptor)classit.next();
283         Iterator methodit=cn.getMethods();
284         while(methodit.hasNext()) {
285           // do inlining
286           MethodDescriptor md=(MethodDescriptor)methodit.next();
287           FlatMethod fm=state.getMethodFlat(md);
288           Inliner.inlineAtomic(state, tu, fm, state.inlineatomicdepth);
289         }
290       }
291     }
292
293
294     if (state.OPTIMIZE) {
295       CallGraph callgraph=new CallGraph(state);
296       CopyPropagation cp=new CopyPropagation();
297       DeadCode dc=new DeadCode();
298       GlobalFieldType gft=new GlobalFieldType(callgraph, state, tu.getMain());
299       CSE cse=new CSE(gft, tu);
300       localCSE lcse=new localCSE(gft, tu);
301       LoopOptimize lo=new LoopOptimize(gft, tu);
302       Iterator classit=state.getClassSymbolTable().getDescriptorsIterator();
303       while(classit.hasNext()) {
304         ClassDescriptor cn=(ClassDescriptor)classit.next();
305         Iterator methodit=cn.getMethods();
306         while(methodit.hasNext()) {
307           /* Classify parameters */
308           MethodDescriptor md=(MethodDescriptor)methodit.next();
309           FlatMethod fm=state.getMethodFlat(md);
310           cp.optimize(fm);
311           dc.optimize(fm);
312           lo.optimize(fm);
313           cp.optimize(fm);
314           dc.optimize(fm);
315           lcse.doAnalysis(fm);
316           cse.doAnalysis(fm);
317           cp.optimize(fm);
318           dc.optimize(fm);
319           cp.optimize(fm);
320           dc.optimize(fm);
321         }
322       }
323     }
324
325     if (state.FLATIRGRAPH) {
326       FlatIRGraph firg = new FlatIRGraph(state,
327                                          state.FLATIRGRAPHTASKS,
328                                          state.FLATIRGRAPHUSERMETHODS,
329                                          state.FLATIRGRAPHLIBMETHODS);
330     }
331     
332     if (state.OWNERSHIP && !state.MLP) {
333       CallGraph callGraph = new CallGraph(state);
334       OwnershipAnalysis oa = new OwnershipAnalysis(state,
335                                                    tu,
336                                                    callGraph,
337                                                    state.OWNERSHIPALLOCDEPTH,
338                                                    state.OWNERSHIPWRITEDOTS,
339                                                    state.OWNERSHIPWRITEALL,
340                                                    state.OWNERSHIPALIASFILE,
341                                                    state.METHODEFFECTS);
342     }
343
344     if (state.MLP) {
345       CallGraph callGraph = new CallGraph(state);
346       OwnershipAnalysis oa = new OwnershipAnalysis(state,
347                                                    tu,
348                                                    callGraph,
349                                                    state.OWNERSHIPALLOCDEPTH,
350                                                    state.OWNERSHIPWRITEDOTS,
351                                                    state.OWNERSHIPWRITEALL,
352                                                    state.OWNERSHIPALIASFILE,
353                                                    state.METHODEFFECTS);
354       mlpa = new MLPAnalysis(state,
355                              tu,
356                              callGraph,
357                              oa);
358     }    
359
360     if (state.TAGSTATE) {
361       CallGraph callgraph=new CallGraph(state);
362       TagAnalysis taganalysis=new TagAnalysis(state, callgraph);
363       TaskTagAnalysis tta=new TaskTagAnalysis(state, taganalysis, tu);
364     }
365
366     if (state.TASKSTATE) {
367       CallGraph callgraph=new CallGraph(state);
368       TagAnalysis taganalysis=new TagAnalysis(state, callgraph);
369       TaskAnalysis ta=new TaskAnalysis(state, taganalysis, tu);
370       ta.taskAnalysis();
371       TaskGraph tg=new TaskGraph(state, ta);
372       tg.createDOTfiles();
373
374       if (state.OPTIONAL) {
375         ExecutionGraph et=new ExecutionGraph(state, ta);
376         et.createExecutionGraph();
377         sa = new SafetyAnalysis(et.getExecutionGraph(), state, ta);
378         sa.doAnalysis();
379         state.storeAnalysisResult(sa.getResult());
380         state.storeOptionalTaskDescriptors(sa.getOptionalTaskDescriptors());
381       }
382
383       if (state.WEBINTERFACE) {
384         GarbageAnalysis ga=new GarbageAnalysis(state, ta);
385         WebInterface wi=new WebInterface(state, ta, tg, ga, taganalysis);
386         JhttpServer serve=new JhttpServer(8000,wi);
387         serve.run();
388       }
389
390       if (state.SCHEDULING) {
391         // Use ownership analysis to get alias information
392         CallGraph callGraph = new CallGraph(state);
393         OwnershipAnalysis oa = new OwnershipAnalysis(state,
394                                                      tu,
395                                                      callGraph,
396                                                      state.OWNERSHIPALLOCDEPTH,
397                                                      state.OWNERSHIPWRITEDOTS,
398                                                      state.OWNERSHIPWRITEALL,
399                                                      state.OWNERSHIPALIASFILE);
400         
401         // synthesis a layout according to target multicore processor
402         MCImplSynthesis mcImplSynthesis = new MCImplSynthesis(state,
403                                                               ta,
404                                                               oa);
405         if(isDistributeInfo) {
406             mcImplSynthesis.distribution(isDisAll, startnum);
407         } else {
408             //double timeStartAnalysis = (double) System.nanoTime();
409             mcImplSynthesis.setScheduleThreshold(20);
410             mcImplSynthesis.setProbThreshold(0);
411             mcImplSynthesis.setGenerateThreshold(30);
412             Vector<Schedule> scheduling = mcImplSynthesis.synthesis();
413             
414             //double timeEndAnalysis = (double) System.nanoTime();
415             //double dt = (timeEndAnalysis - timeStartAnalysis)/(Math.pow( 10.0, 9.0 ) );
416             //System.err.println("The analysis took" + dt +  "sec.");
417         //System.exit(0);
418
419             // generate multicore codes
420             if(state.MULTICORE) {
421                 BuildCodeMultiCore bcm=new BuildCodeMultiCore(state,
422                                                               bf.getMap(),
423                                                               tu,
424                                                               sa,
425                                                               scheduling,
426                                                               mcImplSynthesis.getCoreNum(),
427                                                               pa);
428                 bcm.setOwnershipAnalysis(oa);
429                 bcm.buildCode();
430             }
431             scheduling.clear();
432             scheduling = null;
433         }
434       }
435     }
436     if(!state.MULTICORE) {
437       if (state.DSM||state.SINGLETM) {
438         CallGraph callgraph=new CallGraph(state);
439         if (state.PREFETCH) {
440           //speed up prefetch generation using locality analysis results
441           LocalityAnalysis la=new LocalityAnalysis(state, callgraph, tu);
442           pa=new PrefetchAnalysis(state, callgraph, tu, la);
443         }
444         LocalityAnalysis la=new LocalityAnalysis(state, callgraph, tu);
445         GenerateConversions gc=new GenerateConversions(la, state);
446         BuildCode bc=new BuildCode(state, bf.getMap(), tu, la, pa, mlpa);
447         bc.buildCode();
448       } else {
449         BuildCode bc=new BuildCode(state, bf.getMap(), tu, sa, pa, mlpa);
450         bc.buildCode();
451       }
452     }
453
454     System.out.println("Lines="+state.lines);
455     System.exit(0);
456   }
457
458   public static void loadClass(State state, BuildIR bir, String sourcefile) {
459     ParseNode pn=readSourceFile(state, sourcefile);
460     bir.buildtree(pn, null);
461   }
462
463   /** Reads in a source file and adds the parse tree to the state object. */
464
465   public static ParseNode readSourceFile(State state, String sourcefile) {
466     try {
467       Reader fr= new BufferedReader(new FileReader(sourcefile));
468       Lex.Lexer l = new Lex.Lexer(fr);
469       java_cup.runtime.lr_parser g;
470       g = new Parse.Parser(l);
471       ParseNode p=null;
472       try {
473         p=(ParseNode) g./*debug_*/parse().value;
474       } catch (Exception e) {
475         System.err.println("Error parsing file:"+sourcefile);
476         e.printStackTrace();
477         System.exit(-1);
478       }
479       state.addParseNode(p);
480       if (l.numErrors()!=0) {
481         System.out.println("Error parsing "+sourcefile);
482         System.exit(l.numErrors());
483       }
484       state.lines+=l.line_num;
485       return p;
486
487     } catch (Exception e) {
488       throw new Error(e);
489     }
490   }
491 }