Findbugs:自定义探测器

时间:2015-06-02 03:38:04

标签: java bytecode findbugs

我正在Findbugs中编写自定义检测器。我想知道是否有任何方法可以跟踪 ASTORE 以及相应的 ALOAD 指令?那就是如果 ASTORE 3 出现在我的字节码中,我想首先确定它是 ASTORE 指令然后是 index (在这种情况下:3) )并查找具有相同索引的 ALOAD 指令(在本例中为 ALOAD 3 指令)。

例如,在下面显示的字节码中,我想阅读 ASTORE 8 指令(出现在第29行),看看是否有任何 ALOAD 指令 index 8 。即, ALOAD 8 (可在第73行看到)。

  29: astore        8
  31: aload_1       
  32: iconst_0      
  .
  .
  .
  .
  .
  .
  60: ldc           #54                 // String number
  62: aload         11
  64: invokeinterface #56,  3           // InterfaceMethod javax/servlet/http/HttpSession.setAttribute:(Ljava/lang/String;Ljava/lang/Object;)V
  69: aload         12
  71: aload         7
  73: aload         8
  75: invokeinterface #62,  3           // InterfaceMethod com/ibm/itim/ws/services/WSSessionService.getNumber:(Ljava/lang/String;Ljava/lang/String;)Lcom/ibm/itim/ws/model/WSSession;
  80: astore        14

此外,如果我找到相应的ALOAD指令,那么我想检查调用哪个方法。我所知道的可以使用sawOpcode()方法进行检查,如下所示:

    if (seen == INVOKEINTERFACE){...}

简而言之,我想做这样的事情:

伪代码

    public void sawOpcode(int seen) {
    if (seen == ASTORE){
        //code to identify its index i;  i.e, ASTORE i
        if(seen == ALOAD_i){
            //if the corresponding ALOAD instruction is found...
            if(seen == INVOKEINTERFACE){

                // Identify the method invoked

            }
        }

不知道上述方法是否正确。

1 个答案:

答案 0 :(得分:2)

对于简单的情况,扩展OpcodeStackDetector会更好。此抽象类支持跟踪堆栈值并存储有关它们的信息。您根本不应该关心ASTORE,ALOAD等。只需检查INVOKEINTERFACE即可。例如,如果要查找最后一个方法参数是另一个方法的返回值的位置,可以执行以下操作:

public void sawOpcode(int seen) {
    if(seen == INVOKEINTERFACE && getMethodDescriptorOperand().getSlashedClassName()
        .equals("com/ibm/itim/ws/services/WSSessionService") &&
        getMethodDescriptorOperand().getName().equals("getNumber'))
    Item topStackItem = getStack().getStackItem(0);
    XMethod returnOf = topStackItem.getReturnValueOf();
    if(returnOf != null && returnOf.getName().equals("getParameter"))
        // here we go
    }
}

您可以将0更改为getStackItem调用中的其他号码以获取其他操作数。不幸的是,通过这种方式,您可以知道该值是getParameter方法的返回值,但不知道该方法中使用了哪些参数。

如果您需要跟踪更复杂的情况,那么最好使用ValueNumberAnalysis。它是一个简单而强大的概念:它只为静态证明相同的值分配相同的数字。假设您要跟踪所有请求参数。让我们对方法输入做一些准备(例如,在visitCode中):

private ValueNumberDataflow vna;
private Map<ValueNumber, String> vnToParameterName;

@Override
public void visit(Code code) {
    try {
        this.vna = getClassContext().getValueNumberDataflow(getMethod());
    } catch (DataflowAnalysisException | CFGBuilderException e) {
        bugReporter.logError("Unable to get VNA for "+getMethodDescriptor(), e);
        return;
    }
    this.vnToParameterName = new HashMap<>();
    super.visit(code);
}

Map将用于存储值和相应的参数名称。这可以在sawOpcode

中完成
@Override
public void sawOpcode(int seen) {
    if(seen == INVOKEINTERFACE) {
        if(getNameConstantOperand().equals("getParameter") && 
                getSigConstantOperand().equals("(Ljava/lang/String;)Ljava/lang/String;")
                /* && check the class if necessary */) {
            Object topValue = getStack().getStackItem(0).getConstant();
            if(topValue instanceof String) { // known parameter name like "name"
                // Iterate over locations corresponding to current PC 
                // (usually only one such location exists)
                for(Location location : vna.getCFG()
                        .getLocationsContainingInstructionWithOffset(getPC())) {
                    try {
                        // This frame contains value numbers 
                        // right after the INVOKEINTERFACE execution
                        ValueNumberFrame frame = vna.getFactAfterLocation(location);
                        // ValueNumber corresponding to the top stack value: 
                        // the return value of getParameters() method 
                        ValueNumber vn = frame.getTopValue();
                        vnToParameterName.put(vn, (String) topValue);
                    } catch (DataflowAnalysisException e) {
                        return;
                    }
                }
            }
        }
    }
}

所以现在你可以使用这张地图了。向sawOpcode添加更多代码:

if(seen == INVOKEINTERFACE && getMethodDescriptorOperand().getSlashedClassName()
        .equals("com/ibm/itim/ws/services/WSSessionService") &&
        getMethodDescriptorOperand().getName().equals("getNumber"))
    for(Location location : vna.getCFG()
            .getLocationsContainingInstructionWithOffset(getPC())) {
        try {
            // This frame contains value numbers 
            // right before the INVOKEINTERFACE execution
            ValueNumberFrame frame = vna.getFactAtLocation(location);
            // ValueNumber corresponding to the top stack value: 
            // the last parameter for getNumber method
            ValueNumber vn = frame.getStackValue(0);
            String parameterName = vnToParameterName.get(vn);
            if(parameterName != null) {
                // hurrah: this parameter is in fact 
                // the return value of getParameter(parameterName)
            }
        } catch (DataflowAnalysisException e) {
            return;
        }
    }

我没有测试此代码,因此可能存在一些小问题。请注意,ValueNumberAnalysis是非常强大的功能。它不仅能够跟踪ASTORE / ALOAD,而且可以将任意数量的值重新保存到另一个变量中,甚至(有一些限制)存储到后续加载的字段中。当然,如果您根本不使用局部变量(例如getNumber(request.getParameter("name"))),它也会起作用。