soot基础 -- soot中基本的对象

  soot有着庞大的类层次结构。这篇文章将给读者介绍扩展soot时候一些非常重要的类。
  这里我们主要介绍Body,Unit,Local,Value，UnitBox以及ValueBox的概念。

关于body的介绍

  在指导手册中，说明了如何创建一个类，Body的概念被简单提到了，这里将进行更详细的介绍。
  Soot使用Body来存储一个方法的代码。在Soot中有4种类型的Body–也就是BafBody,JimpleBody,ShimpleBody以及GrimpBody–每个代表一种中间表示。
  需要注意的是，Chain是一个类似于List的数据结构，提供了常量时间访问chain中的元素，包括插入，删除。
  Body中有三类主要的Chain，分别是Units Chain, Locals Chain , Traps Chain。下面的例子说明了这些chain的角色。
考虑下面一个java方法：

public static void main(String[] argv) throws Exception
{
    int x = 2, y = 6;

    System.out.println("Hi!");
    System.out.println(x * y + y);
    try
    {
        int z = y * x;
    }
    catch (Exception e)
    {
        throw e;
    }
}

  转化成jimple格式之后如下：

public static void main(java.lang.String[]) throws java.lang.Exception
{
    java.lang.String[] r0;
    int i0, i1, i2, $i3, $i4;
    java.io.PrintStream $r1, $r2;
    java.lang.Exception $r3, r4;

    r0 := @parameter0;
    i0 = 2;
    i1 = 6;
    $r1 = java.lang.System.out;
    $r1.println(``Hi!'');
    $r2 = java.lang.System.out;
    $i3 = i0 * i1;
    $i4 = $i3 + i1;
    $r2.println($i4);

 label0:
    i2 = i1 * i0;

 label1:
    goto label3;

 label2:
    $r3 := @caughtexception;
    r4 = $r3;
    throw r4;

 label3:
    return;

    catch java.lang.Exception from label0 to label1 with label2;
}

局部变量（Local variables）

  这个方法的局部变量可以在这个方法的顶部看到：

    java.lang.String[] r0;
    int i0, i1, i2, $i3, $i4;
    java.io.PrintStream $r1, $r2;
    java.lang.Exception $r3, r4;

  Local的集合存储在localChain中，可以通过body.getLocals()获得。每个中间表示可以定义他自己的对于Local的实现；但是，它必须满足，对于每个Local r0,都有r0.getName(),r0.getType(),R0.setName(),以及r0.setType.
注意局部变量一定要有类型。

异常（Traps）

  为了支持java的异常处理，Soot的Body中定义了Traps的概念。基于的思想是在java字节码中，异常处理用一种多元组的形式（exception,start，top,handler）表示;在start 和 stop之间的语句（包括start但是不包括stop）,如果异常被抛出，执行将在handler中继续进行。
在例子中，有一个异常：

catch java.lang.Exception from label0 to label1 with label2;

语句（Units）

  Body中最有趣的部分是它的units chain。这是实际包含在Body中的代码。Jimple提供了Stmt来实现Unit,Grimp提供了Inst来实现。这说明每个IR（中间代码）都有自己对于语句的定义。
  关于Jimple Stmt的一个例子是AssignStmt,表示的是分配语句。一个AssignStmt的形式如下：

x = y + z;

值（Value）

  代码(code)总是作用在数据（data）之上。为了表示数据，Soot提供了Value接口。一些类型的Value s是：

• Local s
• Constant s
• Expressions(Expr)
• ParameterRef s, CaughtExccptionRef s, 以及 ThisRef s.
  
    Expr 接口，有着丰富的实现；他们其中有NewExpr以及AddExpr.通常，一个Expr带有一些操作，这些操作针对一个或者多个Value s 并且返回另一个Value。
    这里是一些关于Value s的使用：

x = y + 2;

  这是一个赋值语句（AssignStmt）.它的左操作数为x ,有操作数为 y + 2,一个加法表达式（AddExpr）.这个加法表达式（AddExpr），包含值（Value）y 和 2作为操作数；前面一个是Local（局部变量）,后面一个是Constant（常量）。
  在Jimple中，我们强制要求所有的Value(值) s 包含至多一个表达式。
  在Grimp中我们取消了这个限制，产生容易阅读的但是更难分析的代码

盒子（Boxes）

  在soot中盒子是无处不在的。需要记住的主要思想是，一个盒子（Box）是一个指针（Pointer）。它提供了一个间接访问soot 对象的入口。
  一个对于Box更具有描述性的名字应该是Ref。不幸的是，Ref在soot中有不同的含义。
  在soot中有两种类型的Box - ValueBox 以及UnitBox.可以猜到，一个UnitBox包含着Unit s , 一个ValueBox包含着 Value s.在C++中，这可以表示为（Unit *）以及（Value * ）。
  现在我们来分别每种类型的Box.

语句盒（UnitBox）

  一些类型的Unit(语句)将需要包含其他Unit的引用。比如说，GotoStmt 需要知道它的目标是什么。因此，Soot提供了UnitBox,一个包含一条语句Unit的盒子Box.
  考虑下面的jimple代码:

    x = 5;
    goto l2;
    y = 3;
l2: z = 9;

  每个Unit必须提供 getUnitBoxes().对于大多数UnitBox ，这返回的是一个空的列表。但是，对于GotoStmt,通过 getUnitBoxes()能够返回有一个元素的列表，包含一个Box指向 l2.
  注意SwitchStmt,通常将会返回包含多个box的列表。
  Box的概念对于修饰代码是十分重要的。比如说我们有一个语句 s:

  s: goto l2;

  以及一条在l2处的语句:

l2:  goto l3;

  很明显，s可以指向 l3 ,而不是l2,忽略 s 的实际类型；我们可以用一种统一的方式来进行处理，针对所有类型的Unit s:
- 下面这段代码将 s语句中的保存的指向信息，从l2变为了l3.

public void readjustJumps(Unit s, Unit oldU, Unit newU)
{
    Iterator ubIt = s.getUnitBoxes.iterator();
    while (ubIt.hasNext())
    {
        StmtBox tb = (StmtBox)ubIt.next();
        Stmt targ = (Stmt)tb.getUnit();

        if (targ == oldU)
            tb.setUnit(newU);
    }
}

  其他类似的代码也可以进行这样的处理。PatchingChain是Chain的一个实现，用来调整指向Unit s的指针，s是被Chain移除的。

值的盒子（ValueBox）

  与Unit s类似，我们通常也需要指向Value的指针。这被表示为ValueBox类。对于一个Unit,我们能够得到一系列的ValueBox ,包含了在Unit中使用的值以及定义的值。
  我们可以使用这些盒子来进行常数合并：如果一个AssignStmt被赋予了AddExpr(加法表达式)，该AddExpr用来将两个常量值进行相加，我们可以将他们静态相加，然后将结果放入到UseBox中。
  这里有一些AddExpr s合并的例子：

public void foldAdds(Unit u)
{
    Iterator ubIt = u.getUseBoxes().iterator();
    while (ubIt.hasNext())
    {
        ValueBox vb = (ValueBox) ubIt.next();
        Value v = vb.getValue();
        if (v instanceof AddExpr)
        {
            AddExpr ae = (AddExpr) v;
            Value lo = ae.getOp1(), ro = ae.getOp2();
            if (lo instanceof IntConstant && ro instanceof IntConstant)
            {
                IntConstant l = (IntConstant) lo,
                      r = (IntConstant) ro;
                int sum = l.value + r.value;
                vb.setValue(IntConstant.v(sum));
            }
        }
    }
}

注意这在任何Unit中都是可行的，不管是什么类型。

再次回顾Unit

  我们现在来讨论Unit提供的不同方法。

public List getUseBoxes();
public List getDefBoxes();
public List getUseAndDefBoxes();

  这些方法都是返回ValueBox列表，分别针对在这个Unit中使用的值，定义的值，以及两者都存在的情况。对于getUseBoxes()方法，所有被使用的值被返回；包括表达式以及组成他们的部分。

public List getUnitBoxes();

  这个方法返回Unit所指向UnitBox的列表。

public List getBoxesPointingToThis();

  这个方法返回以此Unit作为目标的UnitBox列表。

public boolean fallsThrough();
public boolean branches();

  这些方法与Unit之后流的执行有关系。前一个方法在有后继Unit的情况下，返回True .后一个方法（branches()）在后继有多个Unit的情况下，并且这些情况不回立即执行，返回true.

public void redirectJumpsToThisTo(Unit newLocation);

  这个方法使用 getBoxesPointingTothis 来改变所有跳转到这个Unit的情况，把他们指向新的位置 newLocation.

原文出处：
Fundamental Soot objects