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