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(""))
 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     if (genericSignature == null || genericSignature.equals(""))
 593       return Types.getReturnTypeName(signature);
 594     return Types.getGenericReturnTypeName(genericSignature);
 595   }
 596
 597   public String getSourceFileName () {
 598     if (ci != null) {
 599       return ci.getSourceFileName();
 600     } else {
 601       return "[VM]";
 602     }
 603   }
 604
 605   public String getClassName () {
 606     if (ci != null) {
 607       return ci.getName();
 608     } else {
 609       return "[VM]";
 610     }
 611   }
 612
 613   /**
 614    * Returns the class the method belongs to.
 615    */
 616   public ClassInfo getClassInfo () {
 617     return ci;
 618   }
 619
 620   /**
 621    * @deprecated - use getFullName
 622    */
 623   @Deprecated
 624 public String getCompleteName () {
 625     return getFullName();
 626   }
 627
 628   /**
 629    * return classname.name (but w/o signature)
 630    */
 631   public String getBaseName() {
 632     return getClassName() + '.' + name;
 633   }
 634
 635   public boolean isCtor () {
 636     return (name.equals("<init>"));
 637   }
 638
 639   public boolean isInternalMethod () {
 640     // <2do> pcm - should turn this into an attribute for efficiency reasons
 641     return (name.equals("<clinit>") || uniqueName.equals("finalize()V"));
 642   }
 643
 644   public boolean isThreadEntry (ThreadInfo ti) {
 645     return (uniqueName.equals("run()V") && (ti.countStackFrames() == 1));
 646   }
 647
 648   /**
 649    * Returns the full classname (if any) + name + signature.
 650    */
 651   public String getFullName () {
 652     if (ci != null) {
 653       return ci.getName() + '.' + getUniqueName();
 654     } else {
 655       return getUniqueName();
 656     }
 657   }
 658
 659   /**
 660    * returns stack trace name: classname (if any) + name
 661    */
 662   public String getStackTraceName(){
 663     if (ci != null) {
 664       return ci.getName() + '.' + name;
 665     } else {
 666       return name;
 667     }
 668   }
 669
 670   /**
 671    * return number of instructions
 672    */
 673   public int getNumberOfInstructions() {
 674     if (code == null){
 675       return 0;
 676     }
 677
 678     return code.length;
 679   }
 680
 681   /**
 682    * Returns a specific instruction.
 683    */
 684   public Instruction getInstruction (int i) {
 685     if (code == null) {
 686       return null;
 687     }
 688
 689     if ((i < 0) || (i >= code.length)) {
 690       return null;
 691     }
 692
 693     return code[i];
 694   }
 695
 696   /**
 697    * Returns the instruction at a certain position.
 698    */
 699   public Instruction getInstructionAt (int position) {
 700     if (code == null) {
 701       return null;
 702     }
 703
 704     for (int i = 0, l = code.length; i < l; i++) {
 705       if ((code[i] != null) && (code[i].getPosition() == position)) {
 706         return code[i];
 707       }
 708     }
 709
 710     throw new JPFException("instruction not found");
 711   }
 712
 713   /**
 714    * Returns the instructions of the method.
 715    */
 716   public Instruction[] getInstructions () {
 717     return code;
 718   }
 719
 720   public boolean includesLine (int line){
 721     int len = code.length;
 722     return (code[0].getLineNumber() <= line) && (code[len].getLineNumber() >= line);
 723   }
 724
 725   public Instruction[] getInstructionsForLine (int line){
 726     return getInstructionsForLineInterval(line,line);
 727   }
 728
 729   public Instruction[] getInstructionsForLineInterval (int l1, int l2){
 730     Instruction[] c = code;
 731
 732     // instruction line numbers don't have to be monotonic (they can decrease for loops)
 733     // hence we cannot easily check for overlapping ranges
 734
 735     if (c != null){
 736        ArrayList<Instruction> matchingInsns = null;
 737
 738        for (int i = 0; i < c.length; i++) {
 739         Instruction insn = c[i];
 740         int line = insn.getLineNumber();
 741         if (line == l1 || line == l2 || (line > l1 && line < l2)) {
 742           if (matchingInsns == null) {
 743             matchingInsns = new ArrayList<Instruction>();
 744           }
 745           matchingInsns.add(insn);
 746         }
 747       }
 748
 749       if (matchingInsns == null) {
 750         return null;
 751       } else {
 752         return matchingInsns.toArray(new Instruction[matchingInsns.size()]);
 753       }
 754
 755     } else {
 756       return null;
 757     }
 758   }
 759
 760   public Instruction[] getMatchingInstructions (LocationSpec lspec){
 761     return getInstructionsForLineInterval(lspec.getFromLine(), lspec.getToLine());
 762   }
 763
 764
 765   /**
 766    * Returns the line number for a given position.
 767    */
 768   public int getLineNumber (Instruction pc) {
 769     if (lineNumbers == null) {
 770       if (pc == null)
 771         return -1;
 772       else
 773         return pc.getPosition();
 774     }
 775
 776     if (pc != null) {
 777       int idx = pc.getInstructionIndex();
 778       if (idx < 0) idx = 0;
 779       return lineNumbers[idx];
 780     } else {
 781       return -1;
 782     }
 783   }
 784
 785   /**
 786    * Returns a table to translate positions into line numbers.
 787    */
 788   public int[] getLineNumbers () {
 789     return lineNumbers;
 790   }
 791
 792   public boolean containsLineNumber (int n){
 793     if (lineNumbers != null){
 794       return (lineNumbers[0] <= n) && (lineNumbers[lineNumbers.length-1] <= n);
 795     }
 796
 797     return false;
 798   }
 799
 800   public boolean intersectsLineNumbers( int first, int last){
 801     if (lineNumbers != null){
 802       if ((last < lineNumbers[0]) || (first > lineNumbers[lineNumbers.length-1])){
 803         return false;
 804       }
 805       return true;
 806     }
 807
 808     return false;
 809   }
 810
 811   public ExceptionHandler getHandlerFor (ClassInfo ciException, Instruction insn){
 812     if (exceptionHandlers != null){
 813       int position = insn.getPosition();
 814       for (int i=0; i<exceptionHandlers.length; i++){
 815         ExceptionHandler handler = exceptionHandlers[i];
 816         if ((position >= handler.getBegin()) && (position < handler.getEnd())) {
 817           // checks if this type of exception is caught here (null means 'any')
 818           String handledType = handler.getName();
 819           if ((handledType == null)   // a catch-all handler
 820                   || ciException.isInstanceOf(handledType)) {
 821             return handler;
 822           }
 823         }
 824       }
 825     }
 826
 827     return null;
 828   }
 829
 830   public boolean isMJI () {
 831     return false;
 832   }
 833
 834   public int getMaxLocals () {
 835     return maxLocals;
 836   }
 837
 838   public int getMaxStack () {
 839     return maxStack;
 840   }
 841
 842   public ExceptionHandler[] getExceptions () {
 843     return exceptionHandlers;
 844   }
 845
 846   public String[] getThrownExceptionClassNames () {
 847     return thrownExceptionClassNames;
 848   }
 849
 850
 851   public LocalVarInfo getLocalVar(String name, int pc){
 852     LocalVarInfo[] vars = localVars;
 853     if (vars != null){
 854       for (int i = 0; i < vars.length; i++) {
 855         LocalVarInfo lv = vars[i];
 856         if (lv.matches(name, pc)) {
 857           return lv;
 858         }
 859       }
 860     }
 861
 862     return null;
 863
 864   }
 865
 866   public LocalVarInfo getLocalVar (int slotIdx, int pc){
 867     LocalVarInfo[] vars = localVars;
 868
 869     if (vars != null){
 870       for (int i = 0; i < vars.length; i++) {
 871         LocalVarInfo lv = vars[i];
 872         if (lv.matches(slotIdx, pc)) {
 873           return lv;
 874         }
 875       }
 876     }
 877
 878     return null;
 879   }
 880
 881   public LocalVarInfo[] getLocalVars() {
 882     return localVars;
 883   }
 884
 885
 886   /**
 887    * note that this might contain duplicates for variables with multiple
 888    * scope entries
 889    */
 890   public String[] getLocalVariableNames() {
 891     String[] names = new String[localVars.length];
 892
 893     for (int i=0; i<localVars.length; i++){
 894       names[i] = localVars[i].getName();
 895     }
 896
 897     return names;
 898   }
 899
 900
 901   public MethodInfo getOverriddenMethodInfo(){
 902     MethodInfo smi = null;
 903
 904     if (ci != null) {
 905       ClassInfo sci = ci.getSuperClass();
 906       if (sci != null){
 907         smi = sci.getMethod(getUniqueName(), true);
 908       }
 909     }
 910
 911     return smi;
 912   }
 913
 914   /**
 915    * Returns the name of the method.
 916    */
 917   public String getName () {
 918     return name;
 919   }
 920
 921   public String getJNIName () {
 922     return Types.getJNIMangledMethodName(null, name, signature);
 923   }
 924
 925   public int getModifiers () {
 926     return modifiers;
 927   }
 928
 929   /**
 930    * Returns true if the method is native
 931    */
 932   public boolean isNative () {
 933     return ((modifiers & Modifier.NATIVE) != 0);
 934   }
 935
 936   public boolean isAbstract () {
 937     return ((modifiers & Modifier.ABSTRACT) != 0);
 938   }
 939
 940   // overridden by NativeMethodInfo
 941   public boolean isUnresolvedNativeMethod(){
 942     return ((modifiers & Modifier.NATIVE) != 0);
 943   }
 944
 945   // overridden by NativeMethodInfo
 946   public boolean isJPFExecutable (){
 947     return !hasAttr(NoJPFExec.class);
 948   }
 949
 950   public int getNumberOfArguments () {
 951     if (nArgs < 0) {
 952       nArgs = Types.getNumberOfArguments(signature);
 953     }
 954
 955     return nArgs;
 956   }
 957
 958   /**
 959    * Returns the size of the arguments.
 960    * This returns the number of parameters passed on the stack, incl. 'this'
 961    */
 962   public int getNumberOfStackArguments () {
 963     int n = getNumberOfArguments();
 964
 965     return isStatic() ? n : n + 1;
 966   }
 967
 968   public int getNumberOfCallerStackSlots () {
 969     return Types.getNumberOfStackSlots(signature, isStatic()); // includes return type
 970   }
 971
 972   public Instruction getFirstInsn(){
 973     if (code != null){
 974       return code[0];
 975     }
 976     return null;
 977   }
 978
 979   public Instruction getLastInsn() {
 980     if (code != null){
 981       return code[code.length-1];
 982     }
 983     return null;
 984   }
 985
 986   /**
 987    * do we return Object references?
 988    */
 989   public boolean isReferenceReturnType () {
 990     int r = getReturnTypeCode();
 991
 992     return ((r == Types.T_REFERENCE) || (r == Types.T_ARRAY));
 993   }
 994
 995   public byte getReturnTypeCode () {
 996     if (returnType < 0) {
 997       returnType = Types.getReturnBuiltinType(signature);
 998     }
 999
1000     return returnType;
1001   }
1002
1003   /**
1004    * what is the slot size of the return value
1005    */
1006   public int getReturnSize() {
1007     if (retSize == -1){
1008       switch (getReturnTypeCode()) {
1009         case Types.T_VOID:
1010           retSize = 0;
1011           break;
1012
1013         case Types.T_LONG:
1014         case Types.T_DOUBLE:
1015           retSize = 2;
1016           break;
1017
1018         default:
1019           retSize = 1;
1020           break;
1021       }
1022     }
1023
1024     return retSize;
1025   }
1026
1027   public Class<? extends ChoiceGenerator<?>> getReturnChoiceGeneratorType (){
1028     switch (getReturnTypeCode()){
1029       case Types.T_BOOLEAN:
1030         return BooleanChoiceGenerator.class;
1031
1032       case Types.T_BYTE:
1033       case Types.T_CHAR:
1034       case Types.T_SHORT:
1035       case Types.T_INT:
1036         return IntChoiceGenerator.class;
1037
1038       case Types.T_LONG:
1039         return LongChoiceGenerator.class;
1040
1041       case Types.T_FLOAT:
1042         return FloatChoiceGenerator.class;
1043
1044       case Types.T_DOUBLE:
1045         return DoubleChoiceGenerator.class;
1046
1047       case Types.T_ARRAY:
1048       case Types.T_REFERENCE:
1049       case Types.T_VOID:
1050         return ReferenceChoiceGenerator.class;
1051     }
1052
1053     return null;
1054   }
1055
1056   /**
1057    * Returns the signature of the method.
1058    */
1059   public String getSignature () {
1060     return signature;
1061   }
1062
1063   @Override
1064   public String getGenericSignature() {
1065     return genericSignature;
1066   }
1067
1068   @Override
1069   public void setGenericSignature(String sig){
1070     genericSignature = sig;
1071   }
1072
1073   /**
1074    * Returns true if the method is static.
1075    */
1076   public boolean isStatic () {
1077     return ((modifiers & Modifier.STATIC) != 0);
1078   }
1079
1080   /**
1081    * is this a public method
1082    */
1083   public boolean isPublic() {
1084     return ((modifiers & Modifier.PUBLIC) != 0);
1085   }
1086
1087   public boolean isPrivate() {
1088     return ((modifiers & Modifier.PRIVATE) != 0);
1089   }
1090
1091   public boolean isProtected() {
1092     return ((modifiers & Modifier.PROTECTED) != 0);
1093   }
1094
1095   /**
1096    * Returns true if the method is synchronized.
1097    */
1098   public boolean isSynchronized () {
1099     return ((modifiers & Modifier.SYNCHRONIZED) != 0);
1100   }
1101
1102   // <2do> these modifiers are still java.lang.reflect internal and not
1103   // supported by public Modifier methods, but since we want to keep this
1104   // similar to the Method reflection and we get the modifiers from the
1105   // classfile we implement this with explicit values
1106
1107   public boolean isSynthetic(){
1108     return ((modifiers & 0x00001000) != 0);
1109   }
1110   public boolean isVarargs(){
1111     return ((modifiers & 0x00000080) != 0);
1112   }
1113
1114   /*
1115    * is this from a classfile or was it created by JPF (and hence should not
1116    * be visible in stacktraces etc)
1117    */
1118   public boolean isJPFInternal(){
1119     // note this has a different meaning than Method.isSynthetic(), which
1120     // is defined in VM spec 4.7.8. What we mean here is that this MethodInfo
1121     // is not associated with any class (such as direct call MethodInfos), but
1122     // there might be more in the future
1123     return (ci == null);
1124   }
1125
1126   public String getUniqueName () {
1127     return uniqueName;
1128   }
1129
1130   public boolean hasCode(){
1131     return (code != null);
1132   }
1133
1134   public boolean hasEmptyBody (){
1135     // only instruction is a return
1136     return (code.length == 1 && (code[0] instanceof ReturnInstruction));
1137   }
1138
1139
1140   //--- parameter annotations
1141   //<2do> these are going away
1142   protected void startParameterAnnotations(int annotationCount){
1143     parameterAnnotations = new AnnotationInfo[annotationCount][];
1144   }
1145   protected void setParameterAnnotations(int index, AnnotationInfo[] ai){
1146     parameterAnnotations[index] = ai;
1147   }
1148   protected void finishParameterAnnotations(){
1149     // nothing
1150   }
1151
1152   public void setParameterAnnotations (AnnotationInfo[][] parameterAnnotations){
1153     this.parameterAnnotations = parameterAnnotations;
1154   }
1155
1156   //--- thrown exceptions
1157   //<2do> these are going away
1158   protected void startTrownExceptions (int exceptionCount){
1159     thrownExceptionClassNames = new String[exceptionCount];
1160   }
1161   protected void setException (int index, String exceptionType){
1162     thrownExceptionClassNames[index] = Types.getClassNameFromTypeName(exceptionType);
1163   }
1164   protected void finishThrownExceptions(){
1165     // nothing
1166   }
1167
1168   public void setThrownExceptions (String[] exceptions){
1169     thrownExceptionClassNames = exceptions;
1170   }
1171
1172
1173   //--- exception handler table initialization
1174   //<2do> these are going away
1175   protected void startExceptionHandlerTable (int handlerCount){
1176     exceptionHandlers = new ExceptionHandler[handlerCount];
1177   }
1178   protected void setExceptionHandler (int index, int startPc, int endPc, int handlerPc, String catchType){
1179     exceptionHandlers[index] = new ExceptionHandler(catchType, startPc, endPc, handlerPc);
1180   }
1181   protected void finishExceptionHandlerTable(){
1182     // nothing
1183   }
1184
1185   public void setExceptionHandlers (ExceptionHandler[] handlers){
1186     exceptionHandlers = handlers;
1187   }
1188
1189   //--- local var table initialization
1190   // <2do> these are going away
1191   protected void startLocalVarTable (int localVarCount){
1192     localVars = new LocalVarInfo[localVarCount];
1193   }
1194   protected void setLocalVar(int index, String varName, String descriptor, int scopeStartPc, int scopeEndPc, int slotIndex){
1195     localVars[index] = new LocalVarInfo(varName, descriptor, "", scopeStartPc, scopeEndPc, slotIndex);
1196   }
1197   protected void finishLocalVarTable(){
1198     // nothing to do
1199   }
1200
1201   public void setLocalVarTable (LocalVarInfo[] locals){
1202     localVars = locals;
1203   }
1204
1205   public void setLocalVarAnnotations (){
1206     if (localVars != null){
1207       for (VariableAnnotationInfo ai : getTargetTypeAnnotations(VariableAnnotationInfo.class)){
1208         for (int i = 0; i < ai.getNumberOfScopeEntries(); i++) {
1209           for (LocalVarInfo lv : localVars) {
1210             if (lv.getStartPC() == ai.getStartPC(i) && lv.getSlotIndex() == ai.getSlotIndex(i)) {
1211               lv.addTypeAnnotation(ai);
1212             }
1213           }
1214         }
1215       }
1216     }
1217   }
1218
1219   public boolean hasTypeAnnotatedLocalVars (){
1220     if (localVars != null){
1221       for (LocalVarInfo lv : localVars){
1222         if (lv.hasTypeAnnotations()){
1223           return true;
1224         }
1225       }
1226     }
1227
1228     return false;
1229   }
1230
1231   public List<LocalVarInfo> getTypeAnnotatedLocalVars (){
1232     List<LocalVarInfo> list = null;
1233
1234     if (localVars != null){
1235       for (LocalVarInfo lv : localVars){
1236         if (lv.hasTypeAnnotations()){
1237           if (list == null){
1238             list = new ArrayList<LocalVarInfo>();
1239           }
1240           list.add(lv);
1241         }
1242       }
1243     }
1244
1245     if (list == null){
1246       list = Collections.emptyList();
1247     }
1248
1249     return list;
1250   }
1251
1252   public List<LocalVarInfo> getTypeAnnotatedLocalVars (String annotationClsName){
1253     List<LocalVarInfo> list = null;
1254
1255     if (localVars != null){
1256       for (LocalVarInfo lv : localVars){
1257         AbstractTypeAnnotationInfo tai = lv.getTypeAnnotation(annotationClsName);
1258         if (tai != null){
1259           if (list == null){
1260             list = new ArrayList<LocalVarInfo>();
1261           }
1262           list.add(lv);
1263         }
1264       }
1265     }
1266
1267     if (list == null){
1268       list = Collections.emptyList();
1269     }
1270
1271     return list;
1272   }
1273
1274
1275   //--- line number table initialization
1276   // <2do> these are going away
1277   protected void startLineNumberTable(int lineNumberCount){
1278     int len = code.length;
1279     int[] ln = new int[len];
1280
1281     lineNumbers = ln;
1282   }
1283   protected void setLineNumber(int index, int lineNumber, int startPc){
1284     int len = code.length;
1285     int[] ln = lineNumbers;
1286
1287     for (int i=0; i<len; i++){
1288       Instruction insn = code[i];
1289       int pc = insn.getPosition();
1290
1291       if (pc == startPc){ // this is the first insn with this line number
1292         ln[i] = lineNumber;
1293         return;
1294       }
1295     }
1296   }
1297   protected void finishLineNumberTable (){
1298     int len = code.length;
1299     int[] ln = lineNumbers;
1300     int lastLine = ln[0];
1301
1302     for (int i=1; i<len; i++){
1303       if (ln[i] == 0){
1304         ln[i] = lastLine;
1305       } else {
1306         lastLine = ln[i];
1307       }
1308     }
1309   }
1310
1311   /**
1312    * note - this depends on that we already have a code array
1313    * and that the lines/startPcs are sorted (monotonic increasing)
1314    */
1315   public void setLineNumbers (int[] lines, int[] startPcs){
1316     int j=0;
1317     int lastLine = -1;
1318
1319     int len = code.length;
1320     int[] ln = new int[len];
1321
1322     for (int i=0; i<len; i++){
1323       Instruction insn = code[i];
1324       int pc = insn.getPosition();
1325
1326       if ((j < startPcs.length) && pc == startPcs[j]){
1327         lastLine = lines[j];
1328         j++;
1329       }
1330
1331       ln[i] = lastLine;
1332     }
1333
1334     lineNumbers = ln;
1335   }
1336
1337   /**
1338    * this version takes an already expanded line number array which has to be of
1339    * the same size as the code array
1340    */
1341   public void setLineNumbers (int[] lines){
1342     if (lines.length != code.length){
1343       throw new JPFException("inconsitent code/line number size");
1344     }
1345     lineNumbers = lines;
1346   }
1347
1348   @Override
1349   public String toString() {
1350     return "MethodInfo[" + getFullName() + ']';
1351   }
1352
1353   // for debugging purposes
1354   public void dump(){
1355     System.out.println("--- " + this);
1356     for (int i = 0; i < code.length; i++) {
1357       System.out.printf("%2d [%d]: %s\n", i, code[i].getPosition(), code[i].toString());
1358     }
1359   }
1360
1361   /**
1362    * Creates a method for a given class, by cloning this MethodInfo
1363    * and all the instructions belong to the method
1364    */
1365   public MethodInfo getInstanceFor(ClassInfo ci) {
1366     MethodInfo clone;
1367
1368     try {
1369       clone = (MethodInfo)super.clone();
1370       clone.ci = ci;
1371
1372       clone.globalId = mthTable.size();
1373       mthTable.add(this);
1374
1375       if(code == null) {
1376         clone.code = null;
1377       } else {
1378         clone.code = new Instruction[code.length];
1379
1380         for(int i=0; i<code.length; i++) {
1381           clone.code[i] = code[i].typeSafeClone(clone);
1382         }
1383       }
1384
1385     } catch (CloneNotSupportedException cnsx){
1386       cnsx.printStackTrace();
1387       return null;
1388     }
1389
1390     return clone;
1391   }
1392 }