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