Robust/src/Analysis/TaskStateAnalysis/TaskAnalysis.java

   1 package Analysis.TaskStateAnalysis;
   2 import IR.*;
   3 import IR.Tree.*;
   4 import IR.Flat.*;
   5 import java.util.*;
   6 import java.io.File;
   7 import java.io.FileWriter;
   8 import java.io.FileOutputStream;
   9
  10 public class TaskAnalysis {
  11     State state;
  12     Hashtable flagstates;
  13     Hashtable flags;
  14     Hashtable extern_flags;
  15     Queue<FlagState> toprocess;
  16     TagAnalysis taganalysis;
  17     Hashtable cdtorootnodes;
  18
  19     TypeUtil typeutil;
  20
  21     /**
  22      * Class Constructor
  23      *
  24      * @param state a flattened State object
  25      * @see State
  26      */
  27     public TaskAnalysis(State state, TagAnalysis taganalysis)
  28     {
  29         this.state=state;
  30         this.typeutil=new TypeUtil(state);
  31         this.taganalysis=taganalysis;
  32
  33     }
  34
  35     /** Builds a table of flags for each class in the Bristlecone program.
  36      *  It creates two hashtables: one which holds the ClassDescriptors and arrays of
  37      *  FlagDescriptors as key-value pairs; the other holds the ClassDescriptor and the
  38      *  number of external flags for that specific class.
  39      */
  40
  41     private void getFlagsfromClasses() {
  42         flags=new Hashtable();
  43         extern_flags = new Hashtable();
  44
  45         /** Iterate through the classes used in the program to build the table of flags
  46          */
  47         for(Iterator it_classes=state.getClassSymbolTable().getDescriptorsIterator();it_classes.hasNext();) {
  48
  49             ClassDescriptor cd = (ClassDescriptor)it_classes.next();
  50             System.out.println(cd.getSymbol());
  51             Vector vFlags=new Vector();
  52             FlagDescriptor flag[];
  53             int ctr=0;
  54
  55
  56             /* Adding the flags of the super class */
  57             if (cd.getSuper()!=null) {
  58                 ClassDescriptor superdesc=cd.getSuperDesc();
  59
  60                 for(Iterator it_cflags=superdesc.getFlags();it_cflags.hasNext();) {
  61                     FlagDescriptor fd = (FlagDescriptor)it_cflags.next();
  62                     System.out.println(fd.toString());
  63                     vFlags.add(fd);
  64                 }
  65             }
  66
  67             for(Iterator it_cflags=cd.getFlags();it_cflags.hasNext();) {
  68                 FlagDescriptor fd = (FlagDescriptor)it_cflags.next();
  69                 vFlags.add(fd);
  70             }
  71
  72             if (vFlags.size()!=0) {
  73                 flag=new FlagDescriptor[vFlags.size()];
  74
  75                 for(int i=0;i < vFlags.size() ; i++) {
  76                     if (((FlagDescriptor)vFlags.get(i)).getExternal()) {
  77                         flag[ctr]=(FlagDescriptor)vFlags.get(i);
  78                         vFlags.remove(flag[ctr]);
  79                         ctr++;
  80                     }
  81                 }
  82                 for(int i=0;i < vFlags.size() ; i++) {
  83                     flag[i+ctr]=(FlagDescriptor)vFlags.get(i);
  84                 }
  85                 extern_flags.put(cd,new Integer(ctr));
  86                 flags.put(cd,flag);
  87
  88             }
  89         }
  90     }
  91     /** Method which starts up the analysis
  92      *
  93     */
  94
  95     public void taskAnalysis() throws java.io.IOException {
  96         flagstates=new Hashtable();
  97         Hashtable<FlagState,FlagState> sourcenodes;
  98         cdtorootnodes=new Hashtable();
  99
 100         getFlagsfromClasses();
 101
 102         int externs;
 103         toprocess=new LinkedList<FlagState>();
 104
 105         for(Iterator it_classes=(Iterator)flags.keys();it_classes.hasNext();) {
 106             ClassDescriptor cd=(ClassDescriptor)it_classes.next();
 107             externs=((Integer)extern_flags.get(cd)).intValue();
 108             FlagDescriptor[] fd=(FlagDescriptor[])flags.get(cd);
 109
 110             //Debug block
 111             System.out.println("Inside taskAnalysis;\n Class:"+ cd.getSymbol());
 112             System.out.println("No of externs " + externs);
 113             System.out.println("No of flags: "+fd.length);
 114             //Debug block
 115
 116             flagstates.put(cd,new Hashtable<FlagState,FlagState>());
 117             cdtorootnodes.put(cd,new Vector());
 118         }
 119
 120
 121         ClassDescriptor startupobject=typeutil.getClass(TypeUtil.StartupClass);
 122
 123         sourcenodes=(Hashtable<FlagState,FlagState>)flagstates.get(startupobject);
 124         FlagState fsstartup=new FlagState(startupobject);
 125
 126
 127         FlagDescriptor[] fd=(FlagDescriptor[])flags.get(startupobject);
 128
 129         fsstartup=fsstartup.setFlag(fd[0],true);
 130         fsstartup.setAsSourceNode();
 131         ((Vector)cdtorootnodes.get(startupobject)).add(fsstartup);
 132
 133         sourcenodes.put(fsstartup,fsstartup);
 134         toprocess.add(fsstartup);
 135
 136         /** Looping through the flagstates in the toprocess queue to perform the state analysis */
 137         while (!toprocess.isEmpty()) {
 138             FlagState trigger=toprocess.poll();
 139             createPossibleRuntimeStates(trigger);
 140
 141             analyseTasks(trigger);
 142         }
 143
 144
 145
 146         /** Creating DOT files */
 147         Enumeration e=flagstates.keys();
 148
 149         while (e.hasMoreElements()) {
 150             System.out.println("creating dot file");
 151             ClassDescriptor cdtemp=(ClassDescriptor)e.nextElement();
 152             System.out.println((cdtemp.getSymbol()));
 153
 154
 155             createDOTfile(cdtemp);
 156         }
 157     }
 158
 159
 160     /** Analyses the set of tasks based on the given flagstate, checking
 161      *  to see which tasks are triggered and what new flagstates are created
 162      *  from the base flagstate.
 163      *  @param fs A FlagState object which is used to analyse the task
 164      *  @see FlagState
 165      */
 166
 167 private void analyseTasks(FlagState fs) {
 168     ClassDescriptor cd=fs.getClassDescriptor();
 169     Hashtable<FlagState,FlagState> sourcenodes=(Hashtable<FlagState,FlagState>)flagstates.get(cd);
 170
 171     for(Iterator it_tasks=state.getTaskSymbolTable().getDescriptorsIterator();it_tasks.hasNext();) {
 172         TaskDescriptor td = (TaskDescriptor)it_tasks.next();
 173         String taskname=td.getSymbol();
 174
 175         //**Debug***/
 176         System.out.println();
 177         System.out.println(cd.getSymbol()+" : "+fs.getTextLabel());
 178         System.out.println("Task: "+taskname);
 179         //***********
 180
 181         /** counter to keep track of the number of parameters (of the task being analyzed) that
 182          *  are satisfied by the flagstate.
 183          */
 184         int trigger_ctr=0;
 185         TempDescriptor temp=null;
 186         FlatMethod fm = state.getMethodFlat(td);
 187
 188         for(int i=0; i < td.numParameters(); i++) {
 189             FlagExpressionNode fen=td.getFlag(td.getParameter(i));
 190             TagExpressionList tel=td.getTag(td.getParameter(i));
 191
 192             /** Checking to see if the parameter is of the same type/class as the
 193              *  flagstate's and also if the flagstate fs triggers the given task*/
 194             if (typeutil.isSuperorType(td.getParamType(i).getClassDesc(),cd)
 195                 && isTaskTrigger_flag(fen,fs)
 196                 && isTaskTrigger_tag(tel,fs)) {
 197                 temp=fm.getParameter(i);
 198                 trigger_ctr++;
 199             }
 200         }
 201
 202         if (trigger_ctr==0) //Look at next task
 203             continue;
 204
 205         if (trigger_ctr>1)
 206             throw new Error("Illegal Operation: A single flagstate cannot satisfy more than one parameter of a task.");
 207
 208
 209         //** debug
 210         System.out.println("Task:" + taskname +" is triggered");
 211
 212
 213         Set newstates=taganalysis.getFlagStates(td);
 214         for(Iterator fsit=newstates.iterator();fsit.hasNext();) {
 215             FlagState fsnew=(FlagState) fsit.next();
 216             fsnew.setAsSourceNode();
 217             fsnew.addAllocatingTask(td);
 218             ((Vector)cdtorootnodes.get(fsnew.getClassDescriptor())).add(fsnew);
 219
 220             if (! ((Hashtable<FlagState,FlagState>)flagstates.get(fsnew.getClassDescriptor())).containsKey(fsnew)) {
 221                 ((Hashtable<FlagState,FlagState>)flagstates.get(fsnew.getClassDescriptor())).put(fsnew, fsnew);
 222                 toprocess.add(fsnew);
 223             }
 224         }
 225
 226         Stack nodestack=new Stack();
 227         HashSet discovered=new HashSet();
 228         nodestack.push(fm);
 229         discovered.add(fm);
 230         //Iterating through the nodes
 231
 232         while(!nodestack.isEmpty()) {
 233             FlatNode fn1 = (FlatNode) nodestack.pop();
 234
 235             if (fn1.kind()==FKind.FlatReturnNode) {
 236                 /* Self edge */
 237                 FEdge newedge=new FEdge(fs, taskname);
 238                 fs.addEdge(newedge);
 239                 continue;
 240             } else if (fn1.kind()==FKind.FlatFlagActionNode) {
 241                 FlatFlagActionNode ffan=(FlatFlagActionNode)fn1;
 242                 if (ffan.getTaskType() == FlatFlagActionNode.PRE) {
 243                     if (ffan.getTempFlagPairs().hasNext()||ffan.getTempTagPairs().hasNext())
 244                         throw new Error("PRE FlagActions not supported");
 245
 246                 } else if (ffan.getTaskType() == FlatFlagActionNode.TASKEXIT) {
 247                     //***
 248                     System.out.println("TASKEXIT");
 249                     //***
 250
 251                     Vector<FlagState> fsv_taskexit=evalTaskExitNode(ffan,cd,fs,temp);
 252
 253                     for(Enumeration en=fsv_taskexit.elements();en.hasMoreElements();){
 254                         FlagState fs_taskexit=(FlagState)en.nextElement();
 255                         if (!sourcenodes.containsKey(fs_taskexit)) {
 256                             toprocess.add(fs_taskexit);
 257
 258                         }
 259                         //seen this node already
 260                         fs_taskexit=canonicalizeFlagState(sourcenodes,fs_taskexit);
 261                         FEdge newedge=new FEdge(fs_taskexit,taskname);
 262                         //FEdge newedge=new FEdge(fs_taskexit,td);
 263                         fs.addEdge(newedge);
 264                     }
 265                     continue;
 266                 }
 267             }
 268             /* Queue other nodes past this one */
 269             for(int i=0;i<fn1.numNext();i++) {
 270                 FlatNode fnext=fn1.getNext(i);
 271                 if (!discovered.contains(fnext)) {
 272                     discovered.add(fnext);
 273                     nodestack.push(fnext);
 274                 }
 275             }
 276         }
 277     }
 278 }
 279
 280
 281 /** Determines whether the given flagstate satisfies a
 282  *  single parameter in the given task.
 283  *  @param fen FlagExpressionNode
 284  *  @see FlagExpressionNode
 285  *  @param fs  FlagState
 286  *  @see FlagState
 287  *  @return <CODE>true</CODE> if fs satisfies the boolean expression
 288     denoted by fen else <CODE>false</CODE>.
 289  */
 290
 291
 292 private boolean isTaskTrigger_flag(FlagExpressionNode fen,FlagState fs) {
 293     if (fen==null)
 294         return true;
 295     else if (fen instanceof FlagNode)
 296         return fs.get(((FlagNode)fen).getFlag());
 297     else
 298         switch (((FlagOpNode)fen).getOp().getOp()) {
 299         case Operation.LOGIC_AND:
 300             return ((isTaskTrigger_flag(((FlagOpNode)fen).getLeft(),fs)) && (isTaskTrigger_flag(((FlagOpNode)fen).getRight(),fs)));
 301         case Operation.LOGIC_OR:
 302             return ((isTaskTrigger_flag(((FlagOpNode)fen).getLeft(),fs)) || (isTaskTrigger_flag(((FlagOpNode)fen).getRight(),fs)));
 303         case Operation.LOGIC_NOT:
 304             return !(isTaskTrigger_flag(((FlagOpNode)fen).getLeft(),fs));
 305         default:
 306             return false;
 307         }
 308 }
 309
 310 private boolean isTaskTrigger_tag(TagExpressionList tel, FlagState fs){
 311
 312         if (tel!=null){
 313         for (int i=0;i<tel.numTags() ; i++){
 314                 switch (fs.getTagCount(tel.getType(i))){
 315                         case FlagState.ONETAG:
 316                         case FlagState.MULTITAGS:
 317                                 break;
 318                         case FlagState.NOTAGS:
 319                                 return false;
 320                 }
 321         }
 322         }
 323         return true;
 324 }
 325
 326 /*private int tagTypeCount(TagExpressionList tel, String tagtype){
 327         int ctr=0;
 328         for(int i=0;i<tel.numTags() ; i++){
 329                 if (tel.getType(i).equals(tagtype))
 330                         ctr++;
 331         }
 332         return ctr;
 333 } */
 334
 335     private Vector<FlagState> evalTaskExitNode(FlatFlagActionNode ffan,ClassDescriptor cd,FlagState fs, TempDescriptor temp){
 336         FlagState fstemp=fs;
 337         Vector<FlagState> processed=new Vector<FlagState>();
 338
 339         //Process the flag changes
 340
 341         for(Iterator it_tfp=ffan.getTempFlagPairs();it_tfp.hasNext();) {
 342             TempFlagPair tfp=(TempFlagPair)it_tfp.next();
 343             if (temp==tfp.getTemp())
 344                 fstemp=fstemp.setFlag(tfp.getFlag(),ffan.getFlagChange(tfp));
 345         }
 346
 347         //Process the tag changes
 348
 349         processed.add(fstemp);
 350
 351         for(Iterator it_ttp=ffan.getTempTagPairs();it_ttp.hasNext();) {
 352             TempTagPair ttp=(TempTagPair)it_ttp.next();
 353
 354             if (temp==ttp.getTemp()) {
 355                 Vector<FlagState> oldprocess=processed;
 356                 processed=new Vector<FlagState>();
 357
 358                 for (Enumeration en=oldprocess.elements();en.hasMoreElements();){
 359                     FlagState fsworking=(FlagState)en.nextElement();
 360                     if (ffan.getTagChange(ttp)){
 361                         processed.addAll(Arrays.asList(fsworking.setTag(ttp.getTag())));
 362                     } else {
 363                         processed.addAll(Arrays.asList(fsworking.clearTag(ttp.getTag())));
 364                     }
 365                 }
 366             }
 367         }
 368         return processed;
 369
 370     }
 371
 372
 373     private FlagState canonicalizeFlagState(Hashtable sourcenodes, FlagState fs){
 374         if (sourcenodes.containsKey(fs))
 375             return (FlagState)sourcenodes.get(fs);
 376         else{
 377             sourcenodes.put(fs,fs);
 378             return fs;
 379         }
 380     }
 381
 382    /** Creates a DOT file using the flagstates for a given class
 383     *  @param cd ClassDescriptor of the class
 384     *  @throws java.io.IOException
 385     *  @see ClassDescriptor
 386     */
 387
 388     public void createDOTfile(ClassDescriptor cd) throws java.io.IOException {
 389                 File dotfile_flagstates= new File("graph"+cd.getSymbol()+".dot");
 390                 FileOutputStream dotstream=new FileOutputStream(dotfile_flagstates,true);
 391                 FlagState.DOTVisitor.visit(dotstream,((Hashtable)flagstates.get(cd)).values());
 392
 393     }
 394
 395     /** Returns the flag states for the class descriptor. */
 396     public Set getFlagStates(ClassDescriptor cd) {
 397         if (flagstates.containsKey(cd))
 398             return ((Hashtable)flagstates.get(cd)).keySet();
 399         else
 400             return null;
 401     }
 402
 403
 404     private void createPossibleRuntimeStates(FlagState fs) {
 405     ClassDescriptor cd = fs.getClassDescriptor();
 406     Hashtable<FlagState,FlagState> sourcenodes=(Hashtable<FlagState,FlagState>)flagstates.get(cd);
 407     FlagDescriptor[] fd=(FlagDescriptor[])flags.get(cd);
 408     int externs=((Integer)extern_flags.get(cd)).intValue();
 409
 410     if(externs==0)
 411         return;
 412
 413     int noOfIterations=(1<<externs) - 1;
 414     boolean BoolValTable[]=new boolean[externs];
 415
 416
 417     for(int i=0; i < externs ; i++) {
 418         BoolValTable[i]=fs.get(fd[i]);
 419     }
 420
 421         for(int k=0; k<noOfIterations; k++) {
 422         for(int j=0; j < externs ;j++) {
 423             if ((k% (1<<j)) == 0)
 424                 BoolValTable[j]=(!BoolValTable[j]);
 425         }
 426
 427         FlagState fstemp=fs;
 428
 429         for(int i=0; i < externs;i++) {
 430             fstemp=fstemp.setFlag(fd[i],BoolValTable[i]);
 431         }
 432         if (!sourcenodes.containsKey(fstemp))
 433             toprocess.add(fstemp);
 434
 435         fstemp=canonicalizeFlagState(sourcenodes,fstemp);
 436         fs.addEdge(new FEdge(fstemp,"Runtime"));
 437     }
 438         }
 439
 440         public Vector getRootNodes(ClassDescriptor cd){
 441                 return (Vector)cdtorootnodes.get(cd);
 442         }
 443
 444
 445
 446 }
 447