src/main/gov/nasa/jpf/vm/MethodInfo.java

   1 /*
   2  * Copyright (C) 2014, United States Government, as represented by the
   3  * Administrator of the National Aeronautics and Space Administration.
   4  * All rights reserved.
   5  *
   6  * The Java Pathfinder core (jpf-core) platform is licensed under the
   7  * Apache License, Version 2.0 (the "License"); you may not use this file except
   8  * in compliance with the License. You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0.
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package gov.nasa.jpf.vm;
  19
  20 import gov.nasa.jpf.Config;
  21 import gov.nasa.jpf.JPF;
  22 import gov.nasa.jpf.JPFException;
  23 import gov.nasa.jpf.util.JPFLogger;
  24 import gov.nasa.jpf.util.LocationSpec;
  25 import gov.nasa.jpf.vm.bytecode.ReturnInstruction;
  26 import java.lang.reflect.Modifier;
  27 import java.util.ArrayList;
  28 import java.util.Collections;
  29 import java.util.List;
  30
  31
  32 /**
  33  * information associated with a method. Each method in JPF
  34  * is represented by a MethodInfo object
  35  */
  36 public class MethodInfo extends InfoObject implements GenericSignatureHolder  {
  37
  38   static JPFLogger logger = JPF.getLogger("gov.nasa.jpf.vm.MethodInfo");
  39
  40   static final int INIT_MTH_SIZE = 4096;
  41   protected static final ArrayList<MethodInfo> mthTable = new ArrayList<MethodInfo>(INIT_MTH_SIZE);
  42
  43   // special globalIds
  44   static final int DIRECT_CALL = -1;
  45
  46   static final LocalVarInfo[] EMPTY = new LocalVarInfo[0];
  47
  48   static final int[] EMPTY_INT = new int[0];
  49
  50   /**
  51    * Used to warn about local variable information.
  52    */
  53   protected static boolean warnedLocalInfo = false;
  54
  55   //--- various JPF method attributes
  56   static final int  EXEC_ATOMIC = 0x10000; // method executed atomically
  57   static final int  EXEC_HIDDEN = 0x20000; // method hidden from path
  58   static final int  FIREWALL    = 0x40000; // firewall any unhandled exceptionHandlers
  59                                            // (turn into UnhandledException throws)
  60   static final int  IS_CLINIT   = 0x80000;
  61   static final int  IS_INIT     = 0x100000;
  62
  63   static final int  IS_REFLECTION = 0x200000; // this is a reflection direct call
  64   static final int  IS_DIRECT_CALL = 0x400000;
  65
  66   /** a unique int assigned to this method */
  67   protected int globalId = -1;
  68
  69   /**
  70    * this is a lazy evaluated mangled name consisting of the name and
  71    * arg type signature
  72    */
  73   protected String uniqueName;
  74
  75   /** Name of the method */
  76   protected String name;
  77
  78   /** Signature of the method */
  79   protected String signature;
  80
  81   /** Generic signature of the method */
  82   protected String genericSignature;
  83
  84   /** Class the method belongs to */
  85   protected ClassInfo ci;
  86
  87   /** Instructions associated with the method */
  88   protected Instruction[] code;
  89
  90   /** JPFConfigException handlers */
  91   protected ExceptionHandler[] exceptionHandlers;
  92
  93   /** classnames of checked exception thrown by the method */
  94   protected String[] thrownExceptionClassNames;
  95
  96   /** Table used for line numbers
  97    * this assigns a line number to every instruction index, instead of
  98    * using an array of ranges. Assuming we have 2-3 insns per line on average,
  99    * this should still require less memory than a reference array with associated
 100    * range objects, and allows faster access of instruction line numbers, which
 101    * we might need for location specs
 102    */
 103   protected int[] lineNumbers;
 104
 105   /** Local variable information */
 106   protected LocalVarInfo localVars[] = null;
 107
 108   /** Maximum number of local variables */
 109   protected int maxLocals;
 110
 111   /** Maximum number of elements on the stack */
 112   protected int maxStack;
 113
 114   /** null if we don't have any */
 115   AnnotationInfo[][] parameterAnnotations;
 116
 117   //--- a batch of attributes
 118
 119   /** the standard Java modifier attributes */
 120   protected int modifiers;
 121
 122   /** a batch of execution related JPF attributes */
 123   protected int attributes;
 124
 125
 126   //--- all the stuff we need for native methods
 127   // <2do> pcm - turn this into a derived class
 128
 129   /**  the number of stack slots for the arguments (incl. 'this'), lazy eval */
 130   protected int argSize = -1;
 131
 132   /** number of arguments (excl. 'this'), lazy eval */
 133   protected int nArgs = -1;
 134
 135   /** what return type do we have (again, lazy evaluated) */
 136   protected byte returnType = -1;
 137
 138   /** number of stack slots for return value */
 139   protected int retSize = -1;
 140
 141   /** used for native method parameter conversion (lazy evaluated) */
 142   protected byte[] argTypes = null;
 143
 144   static boolean init (Config config) {
 145     mthTable.clear();
 146     return true;
 147   }
 148
 149   public static MethodInfo getMethodInfo (int globalId){
 150     if (globalId >=0 && globalId <mthTable.size()){
 151       return mthTable.get(globalId);
 152     } else {
 153       return null;
 154     }
 155   }
 156
 157   public static MethodInfo create (String name, String signature, int modifiers){
 158     return new MethodInfo( name, signature, modifiers);
 159   }
 160
 161   public static MethodInfo create (ClassInfo ci, String name, String signature, int modifiers){
 162     return new MethodInfo( ci, name, signature, modifiers);
 163   }
 164
 165   static MethodInfo create (ClassInfo ci, String name, String signature, int modifiers, int maxLocals, int maxStack){
 166     return new MethodInfo( ci, name, signature, modifiers, maxLocals, maxStack);
 167   }
 168
 169   /**
 170    * for direct call construction
 171    * Note: this is only a partial initialization, the code still has to be created/installed by the caller
 172    */
 173   public MethodInfo (MethodInfo callee, int nLocals, int nOperands) {
 174     globalId = DIRECT_CALL;
 175     // we don't want direct call methods in the mthTable (would be a memory leak) so don't register
 176
 177     ci = callee.ci;
 178     name = "[" + callee.name + ']'; // it doesn't allocate anything, so we don't have to be unique
 179     signature = "()V";
 180     genericSignature = "";
 181     maxLocals = nLocals;
 182     maxStack = nOperands;  // <2do> cache for optimization
 183     localVars = EMPTY;
 184     lineNumbers = null;
 185     exceptionHandlers = null;
 186     thrownExceptionClassNames = null;
 187     uniqueName = name;
 188
 189     // we need to preserve the ClassInfo so that class resolution for static method calls works
 190     ci = callee.ci;
 191
 192     attributes |= IS_DIRECT_CALL;
 193     modifiers = Modifier.STATIC;   // always treated as static
 194
 195     // code still has to be installed by caller
 196   }
 197
 198   /**
 199    * This is used to create synthetic methods of function object types
 200    */
 201   public MethodInfo(String name, String signature, int modifiers, int nLocals, int nOperands) {
 202     this( name, signature, modifiers);
 203     maxLocals = nLocals;
 204     maxStack = nOperands;
 205     localVars = EMPTY;
 206   }
 207
 208   /**
 209    * for NativeMethodInfo creation
 210    */
 211   public MethodInfo (MethodInfo mi) {
 212     globalId = mi.globalId;
 213     uniqueName = mi.uniqueName;
 214     name = mi.name;
 215     signature = mi.signature;
 216     genericSignature = mi.genericSignature;
 217     ci = mi.ci;
 218     modifiers = mi.modifiers;
 219     attributes = mi.attributes;
 220     thrownExceptionClassNames = mi.thrownExceptionClassNames;
 221     parameterAnnotations = mi.parameterAnnotations;
 222
 223     annotations = mi.annotations;
 224
 225     localVars = null; // there are no StackFrame localVarInfos, this is native
 226     // code still has to be installed by caller
 227   }
 228
 229   // <2do> this is going away
 230   public MethodInfo (ClassInfo ci, String name, String signature, int modifiers, int maxLocals, int maxStack){
 231     this.ci = ci;
 232     this.name = name;
 233     this.signature = signature;
 234     this.uniqueName = getUniqueName(name, signature);
 235     this.genericSignature = "";
 236     this.maxLocals = maxLocals;
 237     this.maxStack = maxStack;
 238     this.modifiers = modifiers;
 239
 240     this.lineNumbers = null;
 241     this.exceptionHandlers = null;
 242     this.thrownExceptionClassNames = null;
 243
 244     // set attributes we can deduce from the name and the ClassInfo
 245     if (ci != null){
 246       if (name.equals("<init>")) {
 247         attributes |= IS_INIT;
 248       } else if (name.equals("<clinit>")) {
 249         this.modifiers |= Modifier.SYNCHRONIZED;
 250         attributes |= IS_CLINIT | FIREWALL;
 251       }
 252       if (ci.isInterface()) { // all interface methods are public
 253         this.modifiers |= Modifier.PUBLIC;
 254       }
 255     }
 256
 257     this.globalId = mthTable.size();
 258     mthTable.add(this);
 259   }
 260
 261
 262   public MethodInfo (String name, String signature, int modifiers){
 263     this.name = name;
 264     this.signature = signature;
 265     this.modifiers = modifiers;
 266     this.uniqueName = getUniqueName(name, signature);
 267     this.genericSignature = "";
 268
 269     if (name.equals("<init>")) {
 270       attributes |= IS_INIT;
 271     } else if (name.equals("<clinit>")) {
 272       // for some reason clinits don't have the synchronized modifier, but they are synchronized
 273       // we keep it consistent so that we don't have to implement special lock acquisition/release for clinits
 274       this.modifiers |= Modifier.SYNCHRONIZED;
 275       attributes |= IS_CLINIT | FIREWALL;
 276     }
 277
 278     this.globalId = mthTable.size();
 279     mthTable.add(this);
 280   }
 281
 282   public MethodInfo (ClassInfo ci, String name, String signature, int modifiers){
 283     this(name, signature, modifiers);
 284
 285     this.ci = ci;
 286   }
 287
 288   //--- setters used during construction
 289
 290   public void linkToClass (ClassInfo ci){
 291     this.ci = ci;
 292
 293     if (ci.isInterface()) { // all interface methods are public
 294       this.modifiers |= Modifier.PUBLIC;
 295     }
 296   }
 297
 298   public void setMaxLocals(int maxLocals){
 299     this.maxLocals = maxLocals;
 300   }
 301
 302   public void setMaxStack(int maxStack){
 303     this.maxStack = maxStack;
 304   }
 305
 306   public void setCode (Instruction[] code){
 307     for (int i=0; i<code.length; i++){
 308       code[i].setMethodInfo(this);
 309     }
 310     this.code = code;
 311   }
 312
 313
 314   public boolean hasParameterAnnotations() {
 315     return (parameterAnnotations != null);
 316   }
 317
 318   // since some listeners might call this on every method invocation, we should do a little optimization
 319   static AnnotationInfo[][] NO_PARAMETER_ANNOTATIONS_0 = new AnnotationInfo[0][];
 320   static AnnotationInfo[][] NO_PARAMETER_ANNOTATIONS_1 = { new AnnotationInfo[0] };
 321   static AnnotationInfo[][] NO_PARAMETER_ANNOTATIONS_2 = { new AnnotationInfo[0], new AnnotationInfo[0] };
 322   static AnnotationInfo[][] NO_PARAMETER_ANNOTATIONS_3 = { new AnnotationInfo[0], new AnnotationInfo[0], new AnnotationInfo[0] };
 323
 324   public AnnotationInfo[][] getParameterAnnotations() {
 325     if (parameterAnnotations == null){ // keep this similar to getAnnotations()
 326       int n = getNumberOfArguments();
 327       switch (n){
 328       case 0: return NO_PARAMETER_ANNOTATIONS_0;
 329       case 1: return NO_PARAMETER_ANNOTATIONS_1;
 330       case 2: return NO_PARAMETER_ANNOTATIONS_2;
 331       case 3: return NO_PARAMETER_ANNOTATIONS_3;
 332       default:
 333         AnnotationInfo[][] pai = new AnnotationInfo[n][];
 334         for (int i=0; i<n; i++){
 335           pai[i] = new AnnotationInfo[0];
 336         }
 337         return pai;
 338       }
 339
 340     } else {
 341       return parameterAnnotations;
 342     }
 343   }
 344
 345   /**
 346    * return annotations for parameterIndex
 347    */
 348   public AnnotationInfo[] getParameterAnnotations(int parameterIndex){
 349     if (parameterAnnotations == null){
 350       return null;
 351     } else {
 352       if (parameterIndex >= getNumberOfArguments()){
 353         return null;
 354       } else {
 355         return parameterAnnotations[parameterIndex];
 356       }
 357     }
 358   }
 359
 360
 361
 362   public static int getNumberOfLoadedMethods () {
 363     return mthTable.size();
 364   }
 365
 366   void setAtomic (boolean isAtomic) {
 367     if (isAtomic) {
 368       attributes |= EXEC_ATOMIC;
 369     } else {
 370       attributes &= ~EXEC_ATOMIC;
 371     }
 372   }
 373   public boolean isAtomic () {
 374     return ((attributes & EXEC_ATOMIC) != 0);
 375   }
 376
 377   void setHidden (boolean isHidden) {
 378     if (isHidden) {
 379       attributes |= EXEC_HIDDEN;
 380     } else {
 381       attributes &= ~EXEC_HIDDEN;
 382     }
 383   }
 384   public boolean isHidden () {
 385     return ((attributes & EXEC_HIDDEN) != 0);
 386   }
 387
 388   /**
 389    * turn unhandled exceptionHandlers at the JPF execution level
 390    * into UnhandledException throws at the host VM level
 391    * this is useful to implement firewalls for direct calls
 392    * which should not let exceptionHandlers permeate into bytecode/
 393    * application code
 394    */
 395   public void setFirewall (boolean isFirewalled) {
 396     if (isFirewalled) {
 397       attributes |= FIREWALL;
 398     } else {
 399       attributes &= ~FIREWALL;
 400     }
 401   }
 402   public boolean isFirewall () {
 403     return ((attributes & FIREWALL) != 0);
 404   }
 405
 406
 407
 408   @Override
 409   public Object clone() {
 410     try {
 411       return super.clone();
 412     } catch (CloneNotSupportedException cnx) {
 413       return null;
 414     }
 415   }
 416
 417   public int getGlobalId() {
 418     return globalId;
 419   }
 420
 421   public DirectCallStackFrame createRunStartStackFrame (ThreadInfo ti){
 422     return ci.createRunStartStackFrame( ti, this);
 423   }
 424
 425   public DirectCallStackFrame createDirectCallStackFrame (ThreadInfo ti, int nLocals){
 426     return ci.createDirectCallStackFrame(ti, this, nLocals);
 427   }
 428
 429   public boolean isSyncRelevant () {
 430     return (name.charAt(0) != '<');
 431   }
 432
 433   public boolean isInitOrClinit (){
 434     return ((attributes & (IS_CLINIT | IS_INIT)) != 0);
 435   }
 436
 437   public boolean isClinit () {
 438     return ((attributes & IS_CLINIT) != 0);
 439   }
 440
 441   public boolean isClinit (ClassInfo ci) {
 442     return (((attributes & IS_CLINIT) != 0) && (this.ci == ci));
 443   }
 444
 445   public boolean isInit() {
 446     return ((attributes & IS_INIT) != 0);
 447   }
 448
 449   public boolean isDirectCallStub(){
 450     return ((attributes & IS_DIRECT_CALL) != 0);
 451   }
 452
 453   /**
 454    * yet another name - this time with a non-mangled, but abbreviated signature
 455    * and without return type (e.g. like "main(String[])"
 456    */
 457   public String getLongName () {
 458     StringBuilder sb = new StringBuilder();
 459     sb.append(name);
 460
 461     sb.append('(');
 462     String[] argTypeNames = getArgumentTypeNames();
 463     for (int i=0; i<argTypeNames.length; i++) {
 464       String a = argTypeNames[i];
 465       int idx = a.lastIndexOf('.');
 466       if (idx > 0) {
 467         a = a.substring(idx+1);
 468       }
 469       if (i>0) {
 470         sb.append(',');
 471       }
 472       sb.append(a);
 473     }
 474     sb.append(')');
 475
 476     return sb.toString();
 477   }
 478
 479   /**
 480    * return the minimal name that has to be unique for overloading
 481    * used as a lookup key
 482    * NOTE: with the silent introduction of covariant return types
 483    * in Java 5.0, we have to use the full signature to be unique
 484    */
 485   public static String getUniqueName (String mname, String signature) {
 486     return (mname + signature);
 487   }
 488
 489   public String getStackTraceSource() {
 490     return getSourceFileName();
 491   }
 492
 493   public byte[] getArgumentTypes () {
 494     if (argTypes == null) {
 495       argTypes = Types.getArgumentTypes(signature);
 496       nArgs = argTypes.length;
 497     }
 498
 499     return argTypes;
 500   }
 501
 502   public String[] getArgumentTypeNames () {
 503     return Types.getArgumentTypeNames(signature);
 504   }
 505
 506   // TODO: Fix for Groovy's model-checking
 507   public String[] getArgumentGenericTypeNames () {
 508     // To accommodate methods that do not have generic types
 509     if (genericSignature == null || genericSignature.equals("") || genericSignature.contains("<*>"))
 510       return getArgumentTypeNames();
 511     return Types.getArgumentTypeNames(genericSignature);
 512   }
 513
 514   public int getArgumentsSize () {
 515     if (argSize < 0) {
 516       argSize = Types.getArgumentsSize(signature);
 517
 518       if (!isStatic()) {
 519         argSize++;
 520       }
 521     }
 522
 523     return argSize;
 524   }
 525
 526   /**
 527    * return only the LocalVarInfos for arguments, in order of definition
 528    * or null if there are no localVarInfos.
 529    * throw a JPFException if there are more immediately in scope vars than args
 530    *
 531    * NOTE - it is perfectly legal for a method to have arguments but no LocalVarInfos,
 532    * which are code attributes, clients have to check for a non-null return value
 533    * even if the method has arguments.
 534    * Note also that abstract / interface methods don't have code and hence no
 535    * LocalVarInfos
 536    */
 537   public LocalVarInfo[] getArgumentLocalVars(){
 538     if (localVars == null){ // shortcut in case we don't have args or localVars;
 539       return null;
 540     }
 541
 542     int nArgs = getNumberOfStackArguments(); // we want 'this'
 543     if (nArgs == 0){
 544       return new LocalVarInfo[0]; // rare enough so that we don't use a static
 545     }
 546
 547     LocalVarInfo[] argLvis = new LocalVarInfo[nArgs];
 548     int n = 0; // how many args we've got so far
 549
 550     for (LocalVarInfo lvi : localVars){
 551       // arguments are the only ones that are immediately in scope
 552       if (lvi.getStartPC() == 0){
 553         if (n == nArgs){ // ARGH - more in-scope vars than args
 554           throw new JPFException("inconsistent localVar table for method " + getFullName());
 555         }
 556
 557         // order with respect to slot index - since this might get called
 558         // frequently, we don't use java.util.Arrays.sort() but sort in
 559         // on-the-fly. Note that we can have several localVar entries for the
 560         // same name, but only one can be immediately in scope
 561         int slotIdx = lvi.getSlotIndex();
 562
 563         int i;
 564         for (i = 0; i < n; i++) {
 565           if (slotIdx < argLvis[i].getSlotIndex()) {
 566             for (int j=n; j>i; j--){
 567               argLvis[j] = argLvis[j-1];
 568             }
 569             argLvis[i] = lvi;
 570             n++;
 571             break;
 572           }
 573         }
 574         if (i == n) { // append
 575           argLvis[n++] = lvi;
 576         }
 577       }
 578     }
 579
 580     return argLvis;
 581   }
 582
 583   public String getReturnType () {
 584     return Types.getReturnTypeSignature(signature);
 585   }
 586
 587   public String getReturnTypeName () {
 588     return Types.getReturnTypeName(signature);
 589   }
 590
 591   public String getGenericReturnTypeName () {
 592     // TODO: We need to double check but for some reason Groovy has a type of generic signature with "<*>"
 593     // TODO: in the class file.
 594     if (genericSignature == null || genericSignature.equals("") || genericSignature.contains("<*>"))
 595       return Types.getReturnTypeName(signature);
 596     return Types.getGenericReturnTypeName(genericSignature);
 597   }
 598
 599   public String getSourceFileName () {
 600     if (ci != null) {
 601       return ci.getSourceFileName();
 602     } else {
 603       return "[VM]";
 604     }
 605   }
 606
 607   public String getClassName () {
 608     if (ci != null) {
 609       return ci.getName();
 610     } else {
 611       return "[VM]";
 612     }
 613   }
 614
 615   /**
 616    * Returns the class the method belongs to.
 617    */
 618   public ClassInfo getClassInfo () {
 619     return ci;
 620   }
 621
 622   /**
 623    * @deprecated - use getFullName
 624    */
 625   @Deprecated
 626 public String getCompleteName () {
 627     return getFullName();
 628   }
 629
 630   /**
 631    * return classname.name (but w/o signature)
 632    */
 633   public String getBaseName() {
 634     return getClassName() + '.' + name;
 635   }
 636
 637   public boolean isCtor () {
 638     return (name.equals("<init>"));
 639   }
 640
 641   public boolean isInternalMethod () {
 642     // <2do> pcm - should turn this into an attribute for efficiency reasons
 643     return (name.equals("<clinit>") || uniqueName.equals("finalize()V"));
 644   }
 645
 646   public boolean isThreadEntry (ThreadInfo ti) {
 647     return (uniqueName.equals("run()V") && (ti.countStackFrames() == 1));
 648   }
 649
 650   /**
 651    * Returns the full classname (if any) + name + signature.
 652    */
 653   public String getFullName () {
 654     if (ci != null) {
 655       return ci.getName() + '.' + getUniqueName();
 656     } else {
 657       return getUniqueName();
 658     }
 659   }
 660
 661   /**
 662    * returns stack trace name: classname (if any) + name
 663    */
 664   public String getStackTraceName(){
 665     if (ci != null) {
 666       return ci.getName() + '.' + name;
 667     } else {
 668       return name;
 669     }
 670   }
 671
 672   /**
 673    * return number of instructions
 674    */
 675   public int getNumberOfInstructions() {
 676     if (code == null){
 677       return 0;
 678     }
 679
 680     return code.length;
 681   }
 682
 683   /**
 684    * Returns a specific instruction.
 685    */
 686   public Instruction getInstruction (int i) {
 687     if (code == null) {
 688       return null;
 689     }
 690
 691     if ((i < 0) || (i >= code.length)) {
 692       return null;
 693     }
 694
 695     return code[i];
 696   }
 697
 698   /**
 699    * Returns the instruction at a certain position.
 700    */
 701   public Instruction getInstructionAt (int position) {
 702     if (code == null) {
 703       return null;
 704     }
 705
 706     for (int i = 0, l = code.length; i < l; i++) {
 707       if ((code[i] != null) && (code[i].getPosition() == position)) {
 708         return code[i];
 709       }
 710     }
 711
 712     throw new JPFException("instruction not found");
 713   }
 714
 715   /**
 716    * Returns the instructions of the method.
 717    */
 718   public Instruction[] getInstructions () {
 719     return code;
 720   }
 721
 722   public boolean includesLine (int line){
 723     int len = code.length;
 724     return (code[0].getLineNumber() <= line) && (code[len].getLineNumber() >= line);
 725   }
 726
 727   public Instruction[] getInstructionsForLine (int line){
 728     return getInstructionsForLineInterval(line,line);
 729   }
 730
 731   public Instruction[] getInstructionsForLineInterval (int l1, int l2){
 732     Instruction[] c = code;
 733
 734     // instruction line numbers don't have to be monotonic (they can decrease for loops)
 735     // hence we cannot easily check for overlapping ranges
 736
 737     if (c != null){
 738        ArrayList<Instruction> matchingInsns = null;
 739
 740        for (int i = 0; i < c.length; i++) {
 741         Instruction insn = c[i];
 742         int line = insn.getLineNumber();
 743         if (line == l1 || line == l2 || (line > l1 && line < l2)) {
 744           if (matchingInsns == null) {
 745             matchingInsns = new ArrayList<Instruction>();
 746           }
 747           matchingInsns.add(insn);
 748         }
 749       }
 750
 751       if (matchingInsns == null) {
 752         return null;
 753       } else {
 754         return matchingInsns.toArray(new Instruction[matchingInsns.size()]);
 755       }
 756
 757     } else {
 758       return null;
 759     }
 760   }
 761
 762   public Instruction[] getMatchingInstructions (LocationSpec lspec){
 763     return getInstructionsForLineInterval(lspec.getFromLine(), lspec.getToLine());
 764   }
 765
 766
 767   /**
 768    * Returns the line number for a given position.
 769    */
 770   public int getLineNumber (Instruction pc) {
 771     if (lineNumbers == null) {
 772       if (pc == null)
 773         return -1;
 774       else
 775         return pc.getPosition();
 776     }
 777
 778     if (pc != null) {
 779       int idx = pc.getInstructionIndex();
 780       if (idx < 0) idx = 0;
 781       return lineNumbers[idx];
 782     } else {
 783       return -1;
 784     }
 785   }
 786
 787   /**
 788    * Returns a table to translate positions into line numbers.
 789    */
 790   public int[] getLineNumbers () {
 791     return lineNumbers;
 792   }
 793
 794   public boolean containsLineNumber (int n){
 795     if (lineNumbers != null){
 796       return (lineNumbers[0] <= n) && (lineNumbers[lineNumbers.length-1] <= n);
 797     }
 798
 799     return false;
 800   }
 801
 802   public boolean intersectsLineNumbers( int first, int last){
 803     if (lineNumbers != null){
 804       if ((last < lineNumbers[0]) || (first > lineNumbers[lineNumbers.length-1])){
 805         return false;
 806       }
 807       return true;
 808     }
 809
 810     return false;
 811   }
 812
 813   public ExceptionHandler getHandlerFor (ClassInfo ciException, Instruction insn){
 814     if (exceptionHandlers != null){
 815       int position = insn.getPosition();
 816       for (int i=0; i<exceptionHandlers.length; i++){
 817         ExceptionHandler handler = exceptionHandlers[i];
 818         if ((position >= handler.getBegin()) && (position < handler.getEnd())) {
 819           // checks if this type of exception is caught here (null means 'any')
 820           String handledType = handler.getName();
 821           if ((handledType == null)   // a catch-all handler
 822                   || ciException.isInstanceOf(handledType)) {
 823             return handler;
 824           }
 825         }
 826       }
 827     }
 828
 829     return null;
 830   }
 831
 832   public boolean isMJI () {
 833     return false;
 834   }
 835
 836   public int getMaxLocals () {
 837     return maxLocals;
 838   }
 839
 840   public int getMaxStack () {
 841     return maxStack;
 842   }
 843
 844   public ExceptionHandler[] getExceptions () {
 845     return exceptionHandlers;
 846   }
 847
 848   public String[] getThrownExceptionClassNames () {
 849     return thrownExceptionClassNames;
 850   }
 851
 852
 853   public LocalVarInfo getLocalVar(String name, int pc){
 854     LocalVarInfo[] vars = localVars;
 855     if (vars != null){
 856       for (int i = 0; i < vars.length; i++) {
 857         LocalVarInfo lv = vars[i];
 858         if (lv.matches(name, pc)) {
 859           return lv;
 860         }
 861       }
 862     }
 863
 864     return null;
 865
 866   }
 867
 868   public LocalVarInfo getLocalVar (int slotIdx, int pc){
 869     LocalVarInfo[] vars = localVars;
 870
 871     if (vars != null){
 872       for (int i = 0; i < vars.length; i++) {
 873         LocalVarInfo lv = vars[i];
 874         if (lv.matches(slotIdx, pc)) {
 875           return lv;
 876         }
 877       }
 878     }
 879
 880     return null;
 881   }
 882
 883   public LocalVarInfo[] getLocalVars() {
 884     return localVars;
 885   }
 886
 887
 888   /**
 889    * note that this might contain duplicates for variables with multiple
 890    * scope entries
 891    */
 892   public String[] getLocalVariableNames() {
 893     String[] names = new String[localVars.length];
 894
 895     for (int i=0; i<localVars.length; i++){
 896       names[i] = localVars[i].getName();
 897     }
 898
 899     return names;
 900   }
 901
 902
 903   public MethodInfo getOverriddenMethodInfo(){
 904     MethodInfo smi = null;
 905
 906     if (ci != null) {
 907       ClassInfo sci = ci.getSuperClass();
 908       if (sci != null){
 909         smi = sci.getMethod(getUniqueName(), true);
 910       }
 911     }
 912
 913     return smi;
 914   }
 915
 916   /**
 917    * Returns the name of the method.
 918    */
 919   public String getName () {
 920     return name;
 921   }
 922
 923   public String getJNIName () {
 924     return Types.getJNIMangledMethodName(null, name, signature);
 925   }
 926
 927   public int getModifiers () {
 928     return modifiers;
 929   }
 930
 931   /**
 932    * Returns true if the method is native
 933    */
 934   public boolean isNative () {
 935     return ((modifiers & Modifier.NATIVE) != 0);
 936   }
 937
 938   public boolean isAbstract () {
 939     return ((modifiers & Modifier.ABSTRACT) != 0);
 940   }
 941
 942   // overridden by NativeMethodInfo
 943   public boolean isUnresolvedNativeMethod(){
 944     return ((modifiers & Modifier.NATIVE) != 0);
 945   }
 946
 947   // overridden by NativeMethodInfo
 948   public boolean isJPFExecutable (){
 949     return !hasAttr(NoJPFExec.class);
 950   }
 951
 952   public int getNumberOfArguments () {
 953     if (nArgs < 0) {
 954       nArgs = Types.getNumberOfArguments(signature);
 955     }
 956
 957     return nArgs;
 958   }
 959
 960   /**
 961    * Returns the size of the arguments.
 962    * This returns the number of parameters passed on the stack, incl. 'this'
 963    */
 964   public int getNumberOfStackArguments () {
 965     int n = getNumberOfArguments();
 966
 967     return isStatic() ? n : n + 1;
 968   }
 969
 970   public int getNumberOfCallerStackSlots () {
 971     return Types.getNumberOfStackSlots(signature, isStatic()); // includes return type
 972   }
 973
 974   public Instruction getFirstInsn(){
 975     if (code != null){
 976       return code[0];
 977     }
 978     return null;
 979   }
 980
 981   public Instruction getLastInsn() {
 982     if (code != null){
 983       return code[code.length-1];
 984     }
 985     return null;
 986   }
 987
 988   /**
 989    * do we return Object references?
 990    */
 991   public boolean isReferenceReturnType () {
 992     int r = getReturnTypeCode();
 993
 994     return ((r == Types.T_REFERENCE) || (r == Types.T_ARRAY));
 995   }
 996
 997   public byte getReturnTypeCode () {
 998     if (returnType < 0) {
 999       returnType = Types.getReturnBuiltinType(signature);
1000     }
1001
1002     return returnType;
1003   }
1004
1005   /**
1006    * what is the slot size of the return value
1007    */
1008   public int getReturnSize() {
1009     if (retSize == -1){
1010       switch (getReturnTypeCode()) {
1011         case Types.T_VOID:
1012           retSize = 0;
1013           break;
1014
1015         case Types.T_LONG:
1016         case Types.T_DOUBLE:
1017           retSize = 2;
1018           break;
1019
1020         default:
1021           retSize = 1;
1022           break;
1023       }
1024     }
1025
1026     return retSize;
1027   }
1028
1029   public Class<? extends ChoiceGenerator<?>> getReturnChoiceGeneratorType (){
1030     switch (getReturnTypeCode()){
1031       case Types.T_BOOLEAN:
1032         return BooleanChoiceGenerator.class;
1033
1034       case Types.T_BYTE:
1035       case Types.T_CHAR:
1036       case Types.T_SHORT:
1037       case Types.T_INT:
1038         return IntChoiceGenerator.class;
1039
1040       case Types.T_LONG:
1041         return LongChoiceGenerator.class;
1042
1043       case Types.T_FLOAT:
1044         return FloatChoiceGenerator.class;
1045
1046       case Types.T_DOUBLE:
1047         return DoubleChoiceGenerator.class;
1048
1049       case Types.T_ARRAY:
1050       case Types.T_REFERENCE:
1051       case Types.T_VOID:
1052         return ReferenceChoiceGenerator.class;
1053     }
1054
1055     return null;
1056   }
1057
1058   /**
1059    * Returns the signature of the method.
1060    */
1061   public String getSignature () {
1062     return signature;
1063   }
1064
1065   @Override
1066   public String getGenericSignature() {
1067     return genericSignature;
1068   }
1069
1070   @Override
1071   public void setGenericSignature(String sig){
1072     genericSignature = sig;
1073   }
1074
1075   /**
1076    * Returns true if the method is static.
1077    */
1078   public boolean isStatic () {
1079     return ((modifiers & Modifier.STATIC) != 0);
1080   }
1081
1082   /**
1083    * is this a public method
1084    */
1085   public boolean isPublic() {
1086     return ((modifiers & Modifier.PUBLIC) != 0);
1087   }
1088
1089   public boolean isPrivate() {
1090     return ((modifiers & Modifier.PRIVATE) != 0);
1091   }
1092
1093   public boolean isProtected() {
1094     return ((modifiers & Modifier.PROTECTED) != 0);
1095   }
1096
1097   /**
1098    * Returns true if the method is synchronized.
1099    */
1100   public boolean isSynchronized () {
1101     return ((modifiers & Modifier.SYNCHRONIZED) != 0);
1102   }
1103
1104   // <2do> these modifiers are still java.lang.reflect internal and not
1105   // supported by public Modifier methods, but since we want to keep this
1106   // similar to the Method reflection and we get the modifiers from the
1107   // classfile we implement this with explicit values
1108
1109   public boolean isSynthetic(){
1110     return ((modifiers & 0x00001000) != 0);
1111   }
1112   public boolean isVarargs(){
1113     return ((modifiers & 0x00000080) != 0);
1114   }
1115
1116   /*
1117    * is this from a classfile or was it created by JPF (and hence should not
1118    * be visible in stacktraces etc)
1119    */
1120   public boolean isJPFInternal(){
1121     // note this has a different meaning than Method.isSynthetic(), which
1122     // is defined in VM spec 4.7.8. What we mean here is that this MethodInfo
1123     // is not associated with any class (such as direct call MethodInfos), but
1124     // there might be more in the future
1125     return (ci == null);
1126   }
1127
1128   public String getUniqueName () {
1129     return uniqueName;
1130   }
1131
1132   public boolean hasCode(){
1133     return (code != null);
1134   }
1135
1136   public boolean hasEmptyBody (){
1137     // only instruction is a return
1138     return (code.length == 1 && (code[0] instanceof ReturnInstruction));
1139   }
1140
1141
1142   //--- parameter annotations
1143   //<2do> these are going away
1144   protected void startParameterAnnotations(int annotationCount){
1145     parameterAnnotations = new AnnotationInfo[annotationCount][];
1146   }
1147   protected void setParameterAnnotations(int index, AnnotationInfo[] ai){
1148     parameterAnnotations[index] = ai;
1149   }
1150   protected void finishParameterAnnotations(){
1151     // nothing
1152   }
1153
1154   public void setParameterAnnotations (AnnotationInfo[][] parameterAnnotations){
1155     this.parameterAnnotations = parameterAnnotations;
1156   }
1157
1158   //--- thrown exceptions
1159   //<2do> these are going away
1160   protected void startTrownExceptions (int exceptionCount){
1161     thrownExceptionClassNames = new String[exceptionCount];
1162   }
1163   protected void setException (int index, String exceptionType){
1164     thrownExceptionClassNames[index] = Types.getClassNameFromTypeName(exceptionType);
1165   }
1166   protected void finishThrownExceptions(){
1167     // nothing
1168   }
1169
1170   public void setThrownExceptions (String[] exceptions){
1171     thrownExceptionClassNames = exceptions;
1172   }
1173
1174
1175   //--- exception handler table initialization
1176   //<2do> these are going away
1177   protected void startExceptionHandlerTable (int handlerCount){
1178     exceptionHandlers = new ExceptionHandler[handlerCount];
1179   }
1180   protected void setExceptionHandler (int index, int startPc, int endPc, int handlerPc, String catchType){
1181     exceptionHandlers[index] = new ExceptionHandler(catchType, startPc, endPc, handlerPc);
1182   }
1183   protected void finishExceptionHandlerTable(){
1184     // nothing
1185   }
1186
1187   public void setExceptionHandlers (ExceptionHandler[] handlers){
1188     exceptionHandlers = handlers;
1189   }
1190
1191   //--- local var table initialization
1192   // <2do> these are going away
1193   protected void startLocalVarTable (int localVarCount){
1194     localVars = new LocalVarInfo[localVarCount];
1195   }
1196   protected void setLocalVar(int index, String varName, String descriptor, int scopeStartPc, int scopeEndPc, int slotIndex){
1197     localVars[index] = new LocalVarInfo(varName, descriptor, "", scopeStartPc, scopeEndPc, slotIndex);
1198   }
1199   protected void finishLocalVarTable(){
1200     // nothing to do
1201   }
1202
1203   public void setLocalVarTable (LocalVarInfo[] locals){
1204     localVars = locals;
1205   }
1206
1207   public void setLocalVarAnnotations (){
1208     if (localVars != null){
1209       for (VariableAnnotationInfo ai : getTargetTypeAnnotations(VariableAnnotationInfo.class)){
1210         for (int i = 0; i < ai.getNumberOfScopeEntries(); i++) {
1211           for (LocalVarInfo lv : localVars) {
1212             if (lv.getStartPC() == ai.getStartPC(i) && lv.getSlotIndex() == ai.getSlotIndex(i)) {
1213               lv.addTypeAnnotation(ai);
1214             }
1215           }
1216         }
1217       }
1218     }
1219   }
1220
1221   public boolean hasTypeAnnotatedLocalVars (){
1222     if (localVars != null){
1223       for (LocalVarInfo lv : localVars){
1224         if (lv.hasTypeAnnotations()){
1225           return true;
1226         }
1227       }
1228     }
1229
1230     return false;
1231   }
1232
1233   public List<LocalVarInfo> getTypeAnnotatedLocalVars (){
1234     List<LocalVarInfo> list = null;
1235
1236     if (localVars != null){
1237       for (LocalVarInfo lv : localVars){
1238         if (lv.hasTypeAnnotations()){
1239           if (list == null){
1240             list = new ArrayList<LocalVarInfo>();
1241           }
1242           list.add(lv);
1243         }
1244       }
1245     }
1246
1247     if (list == null){
1248       list = Collections.emptyList();
1249     }
1250
1251     return list;
1252   }
1253
1254   public List<LocalVarInfo> getTypeAnnotatedLocalVars (String annotationClsName){
1255     List<LocalVarInfo> list = null;
1256
1257     if (localVars != null){
1258       for (LocalVarInfo lv : localVars){
1259         AbstractTypeAnnotationInfo tai = lv.getTypeAnnotation(annotationClsName);
1260         if (tai != null){
1261           if (list == null){
1262             list = new ArrayList<LocalVarInfo>();
1263           }
1264           list.add(lv);
1265         }
1266       }
1267     }
1268
1269     if (list == null){
1270       list = Collections.emptyList();
1271     }
1272
1273     return list;
1274   }
1275
1276
1277   //--- line number table initialization
1278   // <2do> these are going away
1279   protected void startLineNumberTable(int lineNumberCount){
1280     int len = code.length;
1281     int[] ln = new int[len];
1282
1283     lineNumbers = ln;
1284   }
1285   protected void setLineNumber(int index, int lineNumber, int startPc){
1286     int len = code.length;
1287     int[] ln = lineNumbers;
1288
1289     for (int i=0; i<len; i++){
1290       Instruction insn = code[i];
1291       int pc = insn.getPosition();
1292
1293       if (pc == startPc){ // this is the first insn with this line number
1294         ln[i] = lineNumber;
1295         return;
1296       }
1297     }
1298   }
1299   protected void finishLineNumberTable (){
1300     int len = code.length;
1301     int[] ln = lineNumbers;
1302     int lastLine = ln[0];
1303
1304     for (int i=1; i<len; i++){
1305       if (ln[i] == 0){
1306         ln[i] = lastLine;
1307       } else {
1308         lastLine = ln[i];
1309       }
1310     }
1311   }
1312
1313   /**
1314    * note - this depends on that we already have a code array
1315    * and that the lines/startPcs are sorted (monotonic increasing)
1316    */
1317   public void setLineNumbers (int[] lines, int[] startPcs){
1318     int j=0;
1319     int lastLine = -1;
1320
1321     int len = code.length;
1322     int[] ln = new int[len];
1323
1324     for (int i=0; i<len; i++){
1325       Instruction insn = code[i];
1326       int pc = insn.getPosition();
1327
1328       if ((j < startPcs.length) && pc == startPcs[j]){
1329         lastLine = lines[j];
1330         j++;
1331       }
1332
1333       ln[i] = lastLine;
1334     }
1335
1336     lineNumbers = ln;
1337   }
1338
1339   /**
1340    * this version takes an already expanded line number array which has to be of
1341    * the same size as the code array
1342    */
1343   public void setLineNumbers (int[] lines){
1344     if (lines.length != code.length){
1345       throw new JPFException("inconsitent code/line number size");
1346     }
1347     lineNumbers = lines;
1348   }
1349
1350   @Override
1351   public String toString() {
1352     return "MethodInfo[" + getFullName() + ']';
1353   }
1354
1355   // for debugging purposes
1356   public void dump(){
1357     System.out.println("--- " + this);
1358     for (int i = 0; i < code.length; i++) {
1359       System.out.printf("%2d [%d]: %s\n", i, code[i].getPosition(), code[i].toString());
1360     }
1361   }
1362
1363   /**
1364    * Creates a method for a given class, by cloning this MethodInfo
1365    * and all the instructions belong to the method
1366    */
1367   public MethodInfo getInstanceFor(ClassInfo ci) {
1368     MethodInfo clone;
1369
1370     try {
1371       clone = (MethodInfo)super.clone();
1372       clone.ci = ci;
1373
1374       clone.globalId = mthTable.size();
1375       mthTable.add(this);
1376
1377       if(code == null) {
1378         clone.code = null;
1379       } else {
1380         clone.code = new Instruction[code.length];
1381
1382         for(int i=0; i<code.length; i++) {
1383           clone.code[i] = code[i].typeSafeClone(clone);
1384         }
1385       }
1386
1387     } catch (CloneNotSupportedException cnsx){
1388       cnsx.printStackTrace();
1389       return null;
1390     }
1391
1392     return clone;
1393   }
1394 }