You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2015/08/21 14:33:44 UTC

svn commit: r1696959 - in /commons/proper/bcel/trunk/src: changes/changes.xml main/java/org/apache/commons/bcel6/classfile/StackMap.java main/java/org/apache/commons/bcel6/classfile/StackMapEntry.java

Author: sebb
Date: Fri Aug 21 12:33:44 2015
New Revision: 1696959

URL: http://svn.apache.org/r1696959
Log:
BCEL-202 StackMapTableEntry.copy() needs to be deep; Improved support for StackMaps

Modified:
    commons/proper/bcel/trunk/src/changes/changes.xml
    commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMap.java
    commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMapEntry.java

Modified: commons/proper/bcel/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/changes/changes.xml?rev=1696959&r1=1696958&r2=1696959&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/changes/changes.xml (original)
+++ commons/proper/bcel/trunk/src/changes/changes.xml Fri Aug 21 12:33:44 2015
@@ -63,6 +63,7 @@ The <action> type attribute can be add,u
 
   <body>
     <release version="6.0" date="TBA" description="Major release with Java 7 and 8 support">
+      <action issue="BCEL-202" type="fix">StackMapTableEntry.copy() needs to be deep; Improved support for StackMaps</action>
       <action issue="BCEL-251" type="fix">Pass3aVerifier visitANEWARRAY() does not allow 255 array dimensions</action>
       <action issue="BCEL-211" type="update">Some additional clone methods should be public.</action>
       <action issue="BCEL-249" type="fix">Check for max Short seems wrong</action>

Modified: commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMap.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMap.java?rev=1696959&r1=1696958&r2=1696959&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMap.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMap.java Fri Aug 21 12:33:44 2015
@@ -102,6 +102,11 @@ public final class StackMap extends Attr
      */
     public final void setStackMap( StackMapEntry[] map ) {
         this.map = map;
+        int len = 2; // TODO - what is this?
+        for (int i = 0; i < map.length; i++) {
+            len += map[i].getMapEntrySize();
+        }
+        setLength(len);
     }
 
 

Modified: commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMapEntry.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMapEntry.java?rev=1696959&r1=1696958&r2=1696959&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMapEntry.java (original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/commons/bcel6/classfile/StackMapEntry.java Fri Aug 21 12:33:44 2015
@@ -20,6 +20,7 @@ package org.apache.commons.bcel6.classfi
 import java.io.DataInput;
 import java.io.DataOutputStream;
 import java.io.IOException;
+import org.apache.commons.bcel6.Constants;
 
 /**
  * This class represents a stack map entry recording the types of
@@ -33,6 +34,7 @@ import java.io.IOException;
 public final class StackMapEntry implements Cloneable
 {
 
+    private int frame_type;
     private int byte_code_offset;
     private StackMapType[] types_of_locals;
     private StackMapType[] types_of_stack_items;
@@ -46,23 +48,60 @@ public final class StackMapEntry impleme
      * @throws IOException
      */
     StackMapEntry(DataInput input, ConstantPool constant_pool) throws IOException {
-        this.constant_pool = constant_pool;
-        this.byte_code_offset = input.readShort();
-
-        int number_of_locals = input.readShort();
-        types_of_locals = new StackMapType[number_of_locals];
-        for (int i = 0; i < number_of_locals; i++) {
-            types_of_locals[i] = new StackMapType(input, constant_pool);
-        }
+        this(input.readByte() & 0xFF, -1, null, null, constant_pool);
 
-        int number_of_stack_items = input.readShort();
-        types_of_stack_items = new StackMapType[number_of_stack_items];
-        for (int i = 0; i < number_of_stack_items; i++) {
-            types_of_stack_items[i] = new StackMapType(input, constant_pool);
+        if (frame_type >= Constants.SAME_FRAME && frame_type <= Constants.SAME_FRAME_MAX) {
+            byte_code_offset = frame_type - Constants.SAME_FRAME;
+        } else if (frame_type >= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME && 
+                   frame_type <= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
+            byte_code_offset = frame_type - Constants.SAME_LOCALS_1_STACK_ITEM_FRAME;
+            types_of_stack_items = new StackMapType[1];
+            types_of_stack_items[0] = new StackMapType(input, constant_pool);
+        } else if (frame_type == Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
+            byte_code_offset = input.readShort();
+            types_of_stack_items = new StackMapType[1];
+            types_of_stack_items[0] = new StackMapType(input, constant_pool);
+        } else if (frame_type >= Constants.CHOP_FRAME && frame_type <= Constants.CHOP_FRAME_MAX) {
+            byte_code_offset = input.readShort();
+        } else if (frame_type == Constants.SAME_FRAME_EXTENDED) {
+            byte_code_offset = input.readShort();
+        } else if (frame_type >= Constants.APPEND_FRAME && frame_type <= Constants.APPEND_FRAME_MAX) {
+            byte_code_offset = input.readShort();
+            int number_of_locals = frame_type - 251;
+            types_of_locals = new StackMapType[number_of_locals];
+            for (int i = 0; i < number_of_locals; i++) {
+                types_of_locals[i] = new StackMapType(input, constant_pool);
+            }            
+        } else if (frame_type == Constants.FULL_FRAME) {        
+            byte_code_offset = input.readShort();
+            int number_of_locals = input.readShort();
+            types_of_locals = new StackMapType[number_of_locals];
+            for (int i = 0; i < number_of_locals; i++) {
+                types_of_locals[i] = new StackMapType(input, constant_pool);
+            }
+            int number_of_stack_items = input.readShort();
+            types_of_stack_items = new StackMapType[number_of_stack_items];
+            for (int i = 0; i < number_of_stack_items; i++) {
+                types_of_stack_items[i] = new StackMapType(input, constant_pool);
+            }
+        } else {
+            /* Can't happen */
+            throw new ClassFormatException ("Invalid frame type found while parsing stack map table: " + frame_type);
         }
     }
 
-
+    /**
+     * DO NOT USE
+     *
+     * @param byte_code_offset
+     * @param number_of_locals NOT USED
+     * @param types_of_locals array of {@link StackMapType}s of locals
+     * @param number_of_stack_items NOT USED
+     * @param types_of_stack_items array ot {@link StackMapType}s of stack items
+     * @param constant_pool the constant pool
+     * @deprecated Since 6.0, use {@link #StackMapEntry(int, int, StackMapType[], StackMapType[], ConstantPool)}
+     * instead
+     */
     public StackMapEntry(int byte_code_offset, int number_of_locals,
             StackMapType[] types_of_locals, int number_of_stack_items,
             StackMapType[] types_of_stack_items, ConstantPool constant_pool) {
@@ -72,6 +111,25 @@ public final class StackMapEntry impleme
         this.constant_pool = constant_pool;
     }
 
+    /**
+     * Create an instance
+     *
+     * @param tag the frame_type to use
+     * @param byte_code_offset
+     * @param types_of_locals array of {@link StackMapType}s of locals
+     * @param types_of_stack_items array ot {@link StackMapType}s of stack items
+     * @param constant_pool the constant pool
+     */
+    public StackMapEntry(int tag, int byte_code_offset,
+            StackMapType[] types_of_locals,
+            StackMapType[] types_of_stack_items, ConstantPool constant_pool) {
+        this.frame_type = tag;
+        this.byte_code_offset = byte_code_offset;
+        this.types_of_locals = types_of_locals != null ? types_of_locals : new StackMapType[0];
+        this.types_of_stack_items = types_of_stack_items != null ? types_of_stack_items : new StackMapType[0];
+        this.constant_pool = constant_pool;
+    }
+
 
     /**
      * Dump stack map entry
@@ -80,14 +138,37 @@ public final class StackMapEntry impleme
      * @throws IOException
      */
     public final void dump( DataOutputStream file ) throws IOException {
-        file.writeShort(byte_code_offset);
-        file.writeShort(types_of_locals.length);
-        for (StackMapType type : types_of_locals) {
-            type.dump(file);
-        }
-        file.writeShort(types_of_stack_items.length);
-        for (StackMapType type : types_of_stack_items) {
-            type.dump(file);
+        file.write(frame_type);
+        if (frame_type >= Constants.SAME_FRAME && frame_type <= Constants.SAME_FRAME_MAX) {
+            // nothing to be done
+        } else if (frame_type >= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME &&
+                   frame_type <= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
+            types_of_stack_items[0].dump(file);
+        } else if (frame_type == Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
+            file.writeShort(byte_code_offset);
+            types_of_stack_items[0].dump(file);
+        } else if (frame_type >= Constants.CHOP_FRAME && frame_type <= Constants.CHOP_FRAME_MAX) {
+            file.writeShort(byte_code_offset);
+        } else if (frame_type == Constants.SAME_FRAME_EXTENDED) {
+            file.writeShort(byte_code_offset);
+        } else if (frame_type >= Constants.APPEND_FRAME && frame_type <= Constants.APPEND_FRAME_MAX) {
+            file.writeShort(byte_code_offset);
+            for (StackMapType type : types_of_locals) {
+                type.dump(file);
+            }            
+        } else if (frame_type == Constants.FULL_FRAME) {        
+            file.writeShort(byte_code_offset);
+            file.writeShort(types_of_locals.length);
+            for (StackMapType type : types_of_locals) {
+                type.dump(file);
+            }
+            file.writeShort(types_of_stack_items.length);
+            for (StackMapType type : types_of_stack_items) {
+                type.dump(file);
+            }
+        } else {
+            /* Can't happen */
+            throw new ClassFormatException ("Invalid Stack map table tag: " + frame_type);
         }
     }
 
@@ -98,7 +179,26 @@ public final class StackMapEntry impleme
     @Override
     public final String toString() {
         StringBuilder buf = new StringBuilder(64);
-        buf.append("(offset=").append(byte_code_offset);
+        buf.append("(");
+        if (frame_type >= Constants.SAME_FRAME && frame_type <= Constants.SAME_FRAME_MAX) {
+            buf.append("SAME");
+        } else if (frame_type >= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME &&
+                  frame_type <= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
+            buf.append("SAME_LOCALS_1_STACK");
+        } else if (frame_type == Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
+            buf.append("SAME_LOCALS_1_STACK_EXTENDED");
+        } else if (frame_type >= Constants.CHOP_FRAME && frame_type <= Constants.CHOP_FRAME_MAX) {
+            buf.append("CHOP ").append(String.valueOf(251-frame_type));
+        } else if (frame_type == Constants.SAME_FRAME_EXTENDED) {
+            buf.append("SAME_EXTENDED");
+        } else if (frame_type >= Constants.APPEND_FRAME && frame_type <= Constants.APPEND_FRAME_MAX) {
+            buf.append("APPEND ").append(String.valueOf(frame_type-251));
+        } else if (frame_type == Constants.FULL_FRAME) {        
+            buf.append("FULL");
+        } else {
+            buf.append("UNKNOWN (").append(frame_type).append(")");
+        }
+        buf.append(", offset delta=").append(byte_code_offset);
         if (types_of_locals.length > 0) {
             buf.append(", locals={");
             for (int i = 0; i < types_of_locals.length; i++) {
@@ -124,8 +224,106 @@ public final class StackMapEntry impleme
     }
 
 
-    public void setByteCodeOffset( int b ) {
-        byte_code_offset = b;
+    /**
+     * Calculate stack map entry size
+     *
+     */
+    int getMapEntrySize() {
+        if (frame_type >= Constants.SAME_FRAME && frame_type <= Constants.SAME_FRAME_MAX) {
+            return 1;
+        } else if (frame_type >= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME && frame_type <= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
+            return 1 + (types_of_stack_items[0].hasIndex() ? 3 : 1);
+        } else if (frame_type == Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
+            return 3 + (types_of_stack_items[0].hasIndex() ? 3 : 1);
+        } else if (frame_type >= Constants.CHOP_FRAME && frame_type <= Constants.CHOP_FRAME_MAX) {
+            return 3;
+        } else if (frame_type == Constants.SAME_FRAME_EXTENDED) {
+            return 3;
+        } else if (frame_type >= Constants.APPEND_FRAME && frame_type <= Constants.APPEND_FRAME_MAX) {
+            int len = 3;
+            for (int i = 0; i < types_of_locals.length; i++) {
+                len += (types_of_locals[i].hasIndex() ? 3 : 1);
+            }            
+            return len;
+        } else if (frame_type == Constants.FULL_FRAME) {        
+            int len = 7;
+            for (int i = 0; i < types_of_locals.length; i++) {
+                len += (types_of_locals[i].hasIndex() ? 3 : 1);
+            }
+            for (int i = 0; i < types_of_stack_items.length; i++) {
+                len += (types_of_stack_items[i].hasIndex() ? 3 : 1);
+            }
+            return len;
+        } else {
+            throw new RuntimeException("Invalid StackMap frame_type: " + frame_type);
+        }
+    }
+
+
+    public void setFrameType( int f ) {
+        if (f >= Constants.SAME_FRAME && f <= Constants.SAME_FRAME_MAX) {
+            byte_code_offset = f - Constants.SAME_FRAME;
+        } else if (f >= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME && f <= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
+            byte_code_offset = f - Constants.SAME_LOCALS_1_STACK_ITEM_FRAME;
+        } else if (f == Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
+        } else if (f >= Constants.CHOP_FRAME && f <= Constants.CHOP_FRAME_MAX) {
+        } else if (f == Constants.SAME_FRAME_EXTENDED) {
+        } else if (f >= Constants.APPEND_FRAME && f <= Constants.APPEND_FRAME_MAX) {
+        } else if (f == Constants.FULL_FRAME) {        
+        } else {
+            throw new RuntimeException("Invalid StackMap frame_type");
+        }
+        frame_type = f;
+    }
+
+
+    public int getFrameType() {
+        return frame_type;
+    }
+
+
+    public void setByteCodeOffset( int new_offset ) {
+        if (new_offset < 0 || new_offset > 32767) {
+            throw new RuntimeException("Invalid StackMap offset");
+        }
+
+        if (frame_type >= Constants.SAME_FRAME &&
+            frame_type <= Constants.SAME_FRAME_MAX) {
+            if (new_offset > Constants.SAME_FRAME_MAX) {
+                frame_type = Constants.SAME_FRAME_EXTENDED;
+            } else {
+                frame_type = new_offset;
+            }
+        } else if (frame_type >= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME &&
+                   frame_type <= Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
+            if (new_offset > Constants.SAME_FRAME_MAX) {
+                frame_type = Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED;
+            } else {
+                frame_type = Constants.SAME_LOCALS_1_STACK_ITEM_FRAME + new_offset;
+            }
+        } else if (frame_type == Constants.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
+        } else if (frame_type >= Constants.CHOP_FRAME &&
+                   frame_type <= Constants.CHOP_FRAME_MAX) {
+        } else if (frame_type == Constants.SAME_FRAME_EXTENDED) {
+        } else if (frame_type >= Constants.APPEND_FRAME &&
+                   frame_type <= Constants.APPEND_FRAME_MAX) {
+        } else if (frame_type == Constants.FULL_FRAME) {
+        } else {
+            throw new RuntimeException("Invalid StackMap frame_type");
+        }
+        byte_code_offset = new_offset;
+    }
+
+
+    /**
+     * Update the distance (as an offset delta) from this StackMap
+     * entry to the next.  Note that this might cause the the
+     * frame type to change.  Note also that delta may be negative.
+     *
+     * @param int offset delta
+     */
+    public void updateByteCodeOffset(int delta) {
+        setByteCodeOffset(byte_code_offset + delta);
     }
 
 
@@ -135,7 +333,7 @@ public final class StackMapEntry impleme
 
 
     public int getNumberOfLocals() {
-        return types_of_locals == null ? 0 : types_of_locals.length;
+        return types_of_locals.length;
     }
 
 
@@ -150,7 +348,7 @@ public final class StackMapEntry impleme
 
 
     public int getNumberOfStackItems() {
-        return types_of_stack_items == null ? 0 : types_of_stack_items.length;
+        return types_of_stack_items.length;
     }
 
 
@@ -168,12 +366,22 @@ public final class StackMapEntry impleme
      * @return deep copy of this object
      */
     public StackMapEntry copy() {
+        StackMapEntry e;
         try {
-            return (StackMapEntry) clone();
-        } catch (CloneNotSupportedException e) {
-            // TODO should this throw?
+            e = (StackMapEntry) clone();
+        } catch (CloneNotSupportedException ex) {
+            throw new Error("Clone Not Supported");
+        }
+
+        e.types_of_locals = new StackMapType[types_of_locals.length];
+        for (int i = 0; i < types_of_locals.length; i++) {
+            e.types_of_locals[i] = types_of_locals[i].copy();
+        }
+        e.types_of_stack_items = new StackMapType[types_of_stack_items.length];
+        for (int i = 0; i < types_of_stack_items.length; i++) {
+            e.types_of_stack_items[i] = types_of_stack_items[i].copy();
         }
-        return null;
+        return e;
     }