當前位置:網站首頁>frame介紹

frame介紹

2022-05-15 08:28:36吳聲子夜歌

frame介紹

1. ClassFile中的StackMapTable

在ClassFile結構中,有一個StackMapTable結構:

  1. 在ClassFile結構中,每一個方法都對應於method_info結構;
  2. 在method_info結構中,方法體的代碼存儲在Code結構內;
  3. 在Code結構中,frame的變化存儲在StackMapTable結構中。

在這裏插入圖片描述

假如有一個HelloWorld類,內容如下:

public class HelloWorld {
    
    public void test(boolean flag) {
    
        if (flag) {
    
            System.out.println("value is true");
        }
        else {
    
            System.out.println("value is false");
        }
    }
}

1.1. 查看Instruction

在.class文件中,方法體的內容會被編譯成一條一條的instruction。我們可以通過使用javap -c sample.HelloWorld來查看Instruction的內容。

public void test(boolean);
  Code:
     0: iload_1
     1: ifeq          15
     4: getstatic     #2                  // Field java/lang/System.out:Ljava/io/PrintStream;
     7: ldc           #3                  // String value is true
     9: invokevirtual #4                  // Method java/io/PrintStream.println:(Ljava/lang/String;)V
    12: goto          23
    15: getstatic     #2                  // Field java/lang/System.out:Ljava/io/PrintStream;
    18: ldc           #5                  // String value is false
    20: invokevirtual #4                  // Method java/io/PrintStream.println:(Ljava/lang/String;)V
    23: return

1.2. 查看Frame

在方法當中,每一條Instruction都有對應的Frame。

我們可以通過運行HelloWorldFrameCore來查看Frame的具體情况:

test(Z)V
[sample/HelloWorld, int] []
[sample/HelloWorld, int] [int]
[sample/HelloWorld, int] []
[sample/HelloWorld, int] [java/io/PrintStream]
[sample/HelloWorld, int] [java/io/PrintStream, java/lang/String]
[sample/HelloWorld, int] []
[] []
[sample/HelloWorld, int] [java/io/PrintStream]
[sample/HelloWorld, int] [java/io/PrintStream, java/lang/String]
[sample/HelloWorld, int] []
[] []

或者運行HelloWorldFrameCore02來查看Frame的具體情况:

test:(Z)V
                               // {this, int} | {}
0000: iload_1                  // {this, int} | {int}
0001: ifeq            14       // {this, int} | {}
0004: getstatic       #2       // {this, int} | {PrintStream}
0007: ldc             #3       // {this, int} | {PrintStream, String}
0009: invokevirtual   #4       // {this, int} | {}
0012: goto            11       // {} | {}
                               // {this, int} | {}
0015: getstatic       #2       // {this, int} | {PrintStream}
0018: ldc             #5       // {this, int} | {PrintStream, String}
0020: invokevirtual   #4       // {this, int} | {}
                               // {this, int} | {}
0023: return                   // {} | {}

嚴格的來說,每一條Instruction都對應兩個frame,一個是instruction執行之前的frame,另一個是instruction執行之後的frame。但是,當多個instruction放到一起的時候來說,第n個instruction執行之後的frame,就成為第n+1個instruction執行之前的frame,所以也可以理解成:每一條instruction對應一個frame。

這些frames是要存儲起來的。我們知道,每一個instruction對應一個frame,如果都要存儲起來,那麼在.class文件中就會占用非常多的空間;而.class文件設計的一個主要目標就是盡量占用較小的存儲空間,那麼就需要對這些frames進行壓縮。

1.3. 壓縮frames

為了讓.class文件占用的存儲空間盡可能的小,因此要對frames進行壓縮。

對frames進行壓縮,從本質上來說,就是忽略掉一些不重要的frames,而只留下一些重要的frames。

那麼,怎樣區分哪些frames重要,哪些frames不重要呢?我們從instruction執行順序的角度來看待這個問題。

如果說,instruction是按照“一個挨一個向下順序執行”的,那麼它們對應的frames就不重要;相應的,instruction在執行過程時,它是從某個地方“跳轉”過來的,那麼對應的frames就重要。

為什麼說instruction按照“一個挨一個向下順序執行”的frames不重要呢?因為這些instruction對應的frame可以很容易的推導出來。 相反,如果當前的instruction是從某個地方跳轉過來的,就必須要記錄它執行之前的frame的情况,否則就沒有辦法計算它執行之後的frame的情况。當然,我們這裏講的只是大體的思路,而不是具體的判斷細節。

經過壓縮之後的frames,就存放在ClassFile的StackMapTable結構中。

2. 如何使用visitFrame()方法

如果想添加frame的相關信息,可以通過調用MethodVisitor.visitFrame()方法來實現:

                                                          ┌─── ClassReader
                                                          │
                                                          │
                                                          │                    ┌─── FieldVisitor
                                                          │                    │
                                  ┌─── asm.jar ───────────┼─── ClassVisitor ───┤
                                  │                       │                    │                     ┌─── visitLabel
                                  │                       │                    └─── MethodVisitor ───┤
                                  │                       │                                          └─── visitFrame
                                  │                       │                    ┌─── FieldWriter
                 ┌─── Core API ───┤                       └─── ClassWriter ────┤
                 │                │                                            └─── MethodWriter
                 │                │
                 │                ├─── asm-util.jar
ObjectWeb ASM ───┤                │
                 │                └─── asm-commons.jar
                 │
                 │                ┌─── asm-tree.jar
                 └─── Tree API ───┤
                                  └─── asm-analysis.jar

2.1. 預期目標

public class HelloWorld {
    
    public void test(boolean flag) {
    
        if (flag) {
    
            System.out.println("value is true");
        }
        else {
    
            System.out.println("value is false");
        }
    }
}

2.2. 編碼實現

import lsieun.utils.FileUtils;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.Label;
import org.objectweb.asm.MethodVisitor;

import static org.objectweb.asm.Opcodes.*;

public class HelloWorldGenerateCore {
    
    public static void main(String[] args) throws Exception {
    
        String relative_path = "sample/HelloWorld.class";
        String filepath = FileUtils.getFilePath(relative_path);

        // (1) 生成byte[]內容
        byte[] bytes = dump();

        // (2) 保存byte[]到文件
        FileUtils.writeBytes(filepath, bytes);
    }

    public static byte[] dump() throws Exception {
    
        // (1) 創建ClassWriter對象
        ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_MAXS);

        // (2) 調用visitXxx()方法
        cw.visit(V1_8, ACC_PUBLIC + ACC_SUPER, "sample/HelloWorld",
                null, "java/lang/Object", null);

        {
    
            MethodVisitor mv1 = cw.visitMethod(ACC_PUBLIC, "<init>", "()V", null, null);
            mv1.visitCode();
            mv1.visitVarInsn(ALOAD, 0);
            mv1.visitMethodInsn(INVOKESPECIAL, "java/lang/Object", "<init>", "()V", false);
            mv1.visitInsn(RETURN);
            mv1.visitMaxs(0, 0);
            mv1.visitEnd();
        }

        {
    
            MethodVisitor mv2 = cw.visitMethod(ACC_PUBLIC, "test", "(Z)V", null, null);
            Label elseLabel = new Label();
            Label returnLabel = new Label();

            // 第1段
            mv2.visitCode();
            mv2.visitVarInsn(ILOAD, 1);
            mv2.visitJumpInsn(IFEQ, elseLabel);
            mv2.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
            mv2.visitLdcInsn("value is true");
            mv2.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
            mv2.visitJumpInsn(GOTO, returnLabel);

            // 第2段
            mv2.visitLabel(elseLabel);
            mv2.visitFrame(F_SAME, 0, null, 0, null); //調用visitFrame()方法
            mv2.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
            mv2.visitLdcInsn("value is false");
            mv2.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);

            // 第3段
            mv2.visitLabel(returnLabel);
            mv2.visitFrame(F_SAME, 0, null, 0, null); //調用visitFrame()方法
            mv2.visitInsn(RETURN);
            mv2.visitMaxs(2, 2);
            mv2.visitEnd();
        }

        cw.visitEnd();

        // (3) 調用toByteArray()方法
        return cw.toByteArray();
    }
}

在上面的代碼中,我們創建ClassWriter對象時,使用了ClassWriter.COMPUTE_MAXS參數,這樣ASM就會只計算max locals和max stack的值;在實現test()方法的時候,就需要明確的調用MethodVisitor.visitFrame()方法來添加相應的frame信息。

同時,我們也要注意到:MethodVisitor.visitLabel()方法的調用在前,MethodVisitor.visitFrame()方法的調用在後。因為MethodVisitor.visitLabel()方法是放置了一個潜在的跳轉label目標,程序在跳轉之後,就需要使用MethodVisitor.visitFrame()方法給出跳轉之後Frame的具體情况。

2.3. 驗證結果


import java.lang.reflect.Method;

public class HelloWorldRun {
    
    public static void main(String[] args) throws Exception {
    
        Class<?> clazz = Class.forName("sample.HelloWorld");
        Object obj = clazz.newInstance();

        Method method = clazz.getDeclaredMethod("test", boolean.class);
        method.invoke(obj, true);
        method.invoke(obj, false);
    }
}

3. 不推薦使用visitFrame()方法

為什麼我們不推薦調用MethodVisitor.visitFrame()方法呢?原因是計算frame本身就很麻煩,還容易出錯。

我們在創建ClassWriter對象的時候,使用了ClassWriter.COMPUTE_FRAMES參數:

ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES);

在使用了ClassWriter.COMPUTE_FRAMES參數之後,ASM會忽略代碼當中對於MethodVisitor.visitFrame()方法的調用,並且自動幫助我們計算stack map frame的具體內容。

4. 總結

  • 第一點,在ClassFile結構中,StackMapTable結構是如何得到的。
  • 第二點,不推薦使用MethodVisitor.visitFrame()方法,原因是frame的計算複雜,容易出錯。我們可以在創建ClassWriter對象的時候,使用ClassWriter.COMPUTE_FRAMES參數,這樣ASM就會幫助我們計算frame的值到底是多少。

版權聲明
本文為[吳聲子夜歌]所創,轉載請帶上原文鏈接,感謝
https://cht.chowdera.com/2022/135/202205150000331977.html

隨機推薦