private Type getSootType(AnnotationElem e) {
Type annotationType;
switch (e.getKind()) {
case '[': // array
// Until now we only know it's some kind of array.
annotationType = ARRAY_TYPE;
AnnotationArrayElem array = (AnnotationArrayElem) e;
if (array.getNumValues() > 0) {
// Try to determine type of the array
AnnotationElem firstElement = array.getValueAt(0);
Type type = getSootType(firstElement);
if (type == null) return null;
if (type.equals(ARRAY_TYPE)) return ARRAY_TYPE;
return ArrayType.v(type, 1);
}
break;
case 's': // string
annotationType = RefType.v("java.lang.String");
break;
case 'c': // class
annotationType = RefType.v("java.lang.Class");
break;
case 'e': // enum
AnnotationEnumElem enumElem = (AnnotationEnumElem) e;
annotationType = Util.getType(enumElem.getTypeName());
;
break;
case 'L':
case 'J':
case 'S':
case 'D':
case 'I':
case 'F':
case 'B':
case 'C':
case 'V':
case 'Z':
annotationType = Util.getType(String.valueOf(e.getKind()));
break;
default:
annotationType = null;
break;
}
return annotationType;
}
public void outAFullIdentNonvoidType(AFullIdentNonvoidType node) {
String typeName = (String) mProductions.removeLast();
Type t = RefType.v(typeName);
int dim = node.getArrayBrackets().size();
if (dim > 0) t = ArrayType.v(t, dim);
mProductions.addLast(t);
}
/**
* Utility method which prints the abbreviations of the elements in a passed {@link Set} of
* exception types.
*
* @param s The exceptions to print.
* @param connector The character to insert between exceptions.
* @return An abbreviated representation of the exceptions.
*/
private String toAbbreviatedString(Set s, char connector) {
final String JAVA_LANG = "java.lang.";
final int JAVA_LANG_LENGTH = JAVA_LANG.length();
final String EXCEPTION = "Exception";
final int EXCEPTION_LENGTH = EXCEPTION.length();
Collection vmErrorThrowables = ThrowableSet.Manager.v().VM_ERRORS.exceptionsIncluded;
boolean containsAllVmErrors = s.containsAll(vmErrorThrowables);
StringBuffer buf = new StringBuffer();
if (containsAllVmErrors) {
buf.append(connector);
buf.append("vmErrors");
}
for (Iterator it = sortedThrowableIterator(s); it.hasNext(); ) {
RefLikeType reflikeType = (RefLikeType) it.next();
RefType baseType = null;
if (reflikeType instanceof RefType) {
baseType = (RefType) reflikeType;
if (vmErrorThrowables.contains(baseType) && containsAllVmErrors) {
continue; // Already accounted for vmErrors.
} else {
buf.append(connector);
}
} else if (reflikeType instanceof AnySubType) {
buf.append(connector);
buf.append('(');
baseType = ((AnySubType) reflikeType).getBase();
}
String typeName = baseType.toString();
if (typeName.startsWith(JAVA_LANG)) {
typeName = typeName.substring(JAVA_LANG_LENGTH);
}
if (typeName.length() > EXCEPTION_LENGTH && typeName.endsWith(EXCEPTION)) {
typeName = typeName.substring(0, typeName.length() - EXCEPTION_LENGTH);
}
buf.append(typeName);
if (reflikeType instanceof AnySubType) {
buf.append(')');
}
}
return buf.toString();
}
public int compare(Object o1, Object o2) {
RefType t1 = baseType(o1);
RefType t2 = baseType(o2);
if (t1.equals(t2)) {
// There should never be both AnySubType(t) and
// t in a ThrowableSet, but if it happens, put
// AnySubType(t) first:
if (o1 instanceof AnySubType) {
if (o2 instanceof AnySubType) {
return 0;
} else {
return -1;
}
} else if (o2 instanceof AnySubType) {
return 1;
} else {
return 0;
}
} else {
return t1.toString().compareTo(t2.toString());
}
}
/** Given a set of definite receiver types, returns a list of possible targets. */
public List resolveConcreteDispatch(List classes, SootMethod m) {
m.getDeclaringClass().checkLevel(SootClass.HIERARCHY);
checkState();
ArraySet s = new ArraySet();
Iterator classesIt = classes.iterator();
while (classesIt.hasNext()) {
Object cls = classesIt.next();
if (cls instanceof RefType) s.add(resolveConcreteDispatch(((RefType) cls).getSootClass(), m));
else if (cls instanceof ArrayType) {
s.add(resolveConcreteDispatch((RefType.v("java.lang.Object")).getSootClass(), m));
} else throw new RuntimeException("Unable to resolve concrete dispatch of type " + cls);
}
List l = new ArrayList();
l.addAll(s);
return Collections.unmodifiableList(l);
}
/**
* Returns a <code>ThrowableSet</code> which contains <code>e</code> and all of its subclasses as
* well as the exceptions in this set.
*
* <p><code>e</code> should be an instance of {@link AnySubType} if you know that the compile-time
* type of the exception you are representing is <code>e</code>, but the exception may be
* instantiated at run-time by a subclass of <code>e</code>.
*
* <p>For example, if you were recording the type of the exception thrown by
*
* <pre>
* catch (IOException e) {
* throw e;
* }
* </pre>
*
* you would call
*
* <pre>
* <code>add(AnySubtype.v(Scene.v().getRefType("java.lang.Exception.IOException")))</code>
* </pre>
*
* since the handler might rethrow any subclass of <code>IOException</code>.
*
* @param e represents a subtree of the exception class hierarchy to add to this set.
* @return a set containing <code>e</code> and all its subclasses, as well as the exceptions
* represented by this set.
* @throws ThrowableSet.AlreadyHasExclusionsException if this <code>ThrowableSet</code> is the
* result of a {@link #whichCatchableAs(RefType)} operation and, thus, unable to represent the
* addition of <code>e</code>.
*/
public ThrowableSet add(AnySubType e) throws ThrowableSet.AlreadyHasExclusionsException {
if (INSTRUMENTING) {
Manager.v().addsOfAnySubType++;
}
ThrowableSet result = getMemoizedAdds(e);
if (result != null) {
if (INSTRUMENTING) {
Manager.v().addsInclusionFromMemo++;
Manager.v().addsExclusionWithoutSearch++;
}
return result;
} else {
FastHierarchy hierarchy = Scene.v().getOrMakeFastHierarchy();
RefType newBase = e.getBase();
if (INSTRUMENTING) {
if (exceptionsExcluded.size() != 0) {
Manager.v().addsExclusionWithSearch++;
} else {
Manager.v().addsExclusionWithoutSearch++;
}
}
for (Iterator i = exceptionsExcluded.iterator(); i.hasNext(); ) {
RefType exclusionBase = ((AnySubType) i.next()).getBase();
if (hierarchy.canStoreType(newBase, exclusionBase)
|| hierarchy.canStoreType(exclusionBase, newBase)) {
if (INSTRUMENTING) {
// To ensure that the subcategories total properly:
Manager.v().addsInclusionInterrupted++;
}
throw new AlreadyHasExclusionsException(
"ThrowableSet.add("
+ e.toString()
+ ") to the set [ "
+ this.toString()
+ "] where "
+ exclusionBase.toString()
+ " is excluded.");
}
}
if (this.exceptionsIncluded.contains(e)) {
if (INSTRUMENTING) {
Manager.v().addsInclusionFromMap++;
}
return this;
} else {
if (INSTRUMENTING) {
Manager.v().addsInclusionFromSearch++;
}
int changes = 0;
boolean addNewException = true;
Set resultSet = new HashSet();
for (Iterator i = this.exceptionsIncluded.iterator(); i.hasNext(); ) {
RefLikeType incumbent = (RefLikeType) i.next();
if (incumbent instanceof RefType) {
if (hierarchy.canStoreType(incumbent, newBase)) {
// Omit incumbent from result.
changes++;
} else {
resultSet.add(incumbent);
}
} else if (incumbent instanceof AnySubType) {
RefType incumbentBase = ((AnySubType) incumbent).getBase();
// We have to use the base types in these hierarchy calls
// because we want to know if _all_ possible
// types represented by e can be represented by
// the incumbent, or vice versa.
if (hierarchy.canStoreType(newBase, incumbentBase)) {
addNewException = false;
resultSet.add(incumbent);
} else if (hierarchy.canStoreType(incumbentBase, newBase)) {
// Omit incumbent from result;
changes++;
} else {
resultSet.add(incumbent);
}
} else { // assertion failure.
throw new IllegalStateException(
"ThrowableSet.add(AnySubType): Set element "
+ incumbent.toString()
+ " is neither a RefType nor an AnySubType.");
}
}
if (addNewException) {
resultSet.add(e);
changes++;
}
if (changes > 0) {
result = Manager.v().registerSetIfNew(resultSet, this.exceptionsExcluded);
} else {
result = this;
}
memoizedAdds.put(e, result);
return result;
}
}
}
/**
* Returns a <code>ThrowableSet</code> which contains <code>e</code> in addition to the exceptions
* in this <code>ThrowableSet</code>.
*
* <p>Add <code>e</code> as a {@link RefType} when you know that the run-time class of the
* exception you are representing is necessarily <code>e</code> and cannot be a subclass of <code>
* e</code>.
*
* <p>For example, if you were recording the type of the exception thrown by
*
* <pre>
* throw new IOException("Permission denied");
* </pre>
*
* you would call
*
* <pre>
* <code>add(Scene.v().getRefType("java.lang.Exception.IOException"))</code>
* </pre>
*
* since the class of the exception is necessarily <code>IOException</code>.
*
* @param e the exception class
* @return a set containing <code>e</code> as well as the exceptions in this set.
* @throws {@link ThrowableSet.IllegalStateException} if this <code>ThrowableSet</code> is the
* result of a {@link #whichCatchableAs(RefType)} operation and, thus, unable to represent the
* addition of <code>e</code>.
*/
public ThrowableSet add(RefType e) throws ThrowableSet.AlreadyHasExclusionsException {
if (INSTRUMENTING) {
Manager.v().addsOfRefType++;
}
if (this.exceptionsIncluded.contains(e)) {
if (INSTRUMENTING) {
Manager.v().addsInclusionFromMap++;
Manager.v().addsExclusionWithoutSearch++;
}
return this;
} else {
ThrowableSet result = getMemoizedAdds(e);
if (result != null) {
if (INSTRUMENTING) {
Manager.v().addsInclusionFromMemo++;
Manager.v().addsExclusionWithoutSearch++;
}
return result;
} else {
if (INSTRUMENTING) {
Manager.v().addsInclusionFromSearch++;
if (exceptionsExcluded.size() != 0) {
Manager.v().addsExclusionWithSearch++;
} else {
Manager.v().addsExclusionWithoutSearch++;
}
}
FastHierarchy hierarchy = Scene.v().getOrMakeFastHierarchy();
for (Iterator i = exceptionsExcluded.iterator(); i.hasNext(); ) {
RefType exclusionBase = ((AnySubType) i.next()).getBase();
if (hierarchy.canStoreType(e, exclusionBase)) {
throw new AlreadyHasExclusionsException(
"ThrowableSet.add(RefType): adding"
+ e.toString()
+ " to the set [ "
+ this.toString()
+ "] where "
+ exclusionBase.toString()
+ " is excluded.");
}
}
for (Iterator i = exceptionsIncluded.iterator(); i.hasNext(); ) {
RefLikeType incumbent = (RefLikeType) i.next();
if (incumbent instanceof AnySubType) {
// Need to use incumbent.getBase() because
// hierarchy.canStoreType() assumes that parent
// is not an AnySubType.
RefType incumbentBase = ((AnySubType) incumbent).getBase();
if (hierarchy.canStoreType(e, incumbentBase)) {
memoizedAdds.put(e, this);
return this;
}
} else if (!(incumbent instanceof RefType)) {
// assertion failure.
throw new IllegalStateException(
"ThrowableSet.add(RefType): Set element "
+ incumbent.toString()
+ " is neither a RefType nor an AnySubType.");
}
}
Set resultSet = new HashSet(this.exceptionsIncluded);
resultSet.add(e);
result = Manager.v().registerSetIfNew(resultSet, this.exceptionsExcluded);
memoizedAdds.put(e, result);
return result;
}
}
}
public void outAClassNameBaseType(AClassNameBaseType node) {
String type = (String) mProductions.removeLast();
if (type.equals("int")) throw new RuntimeException();
mProductions.addLast(RefType.v(type));
}
/*
* Generates the sequence of instructions needed to instrument ifStmtUnit
*
* @param ifStmtUnit: the unit to be instrumented
* @return A Chain of Units that represent the instrumentation of ifStmtUnit
*/
private static Chain<Unit> generateInstrumentationUnits(Unit ifStmtUnit, Body b) {
AbstractBinopExpr expression =
(AbstractBinopExpr)
((JIfStmt) ifStmtUnit).getCondition(); // implementation of AbstractBinopExpr
Value operand1 = expression.getOp1();
Value operand2 = expression.getOp2();
JimpleLocal op1Local = (JimpleLocal) operand1;
// Local localOperand = Jimple.v().newLocal("op1", operand1.getType());
// b.getLocals().add(localOperand);
// We need to use these operand as Locals or constants
/**
* JimpleLocal test; if(operand1 instanceof soot.jimple.internal.JimpleLocal) test =
* (JimpleLocal)operand1; else test = null;
*/
String op = expression.getClass().toString();
Chain<Unit> resultUnits = new HashChain<Unit>();
Local tmpRef;
// Add locals directely on the top of the body, java.io.printStream tmpRef
tmpRef = Jimple.v().newLocal("tmpRef", RefType.v("java.io.PrintStream"));
b.getLocals().addFirst(tmpRef);
// add "tmpRef = java.lang.System.out"
resultUnits.add(
Jimple.v()
.newAssignStmt(
tmpRef,
Jimple.v()
.newStaticFieldRef(
Scene.v()
.getField("<java.lang.System: java.io.PrintStream out>")
.makeRef())));
{
SootMethod toCall =
Scene.v().getMethod("<java.io.PrintStream: void println(java.lang.String)>");
resultUnits.add(
Jimple.v()
.newInvokeStmt(
Jimple.v()
.newVirtualInvokeExpr(
tmpRef, toCall.makeRef(), StringConstant.v("Operande 1: "))));
resultUnits.add(
Jimple.v()
.newInvokeStmt(
Jimple.v()
.newVirtualInvokeExpr(
tmpRef,
toCall.makeRef(),
StringConstant.v(operand1.getClass().toString()))));
resultUnits.add(
Jimple.v()
.newInvokeStmt(
Jimple.v()
.newVirtualInvokeExpr(
tmpRef, toCall.makeRef(), StringConstant.v("Operande 2:"))));
resultUnits.add(
Jimple.v()
.newInvokeStmt(
Jimple.v()
.newVirtualInvokeExpr(
tmpRef,
toCall.makeRef(),
StringConstant.v(operand2.getClass().toString()))));
resultUnits.add(
Jimple.v()
.newInvokeStmt(
Jimple.v()
.newVirtualInvokeExpr(
tmpRef, toCall.makeRef(), StringConstant.v("Operateur: "))));
resultUnits.add(
Jimple.v()
.newInvokeStmt(
Jimple.v().newVirtualInvokeExpr(tmpRef, toCall.makeRef(), StringConstant.v(op))));
}
return resultUnits;
}
public Code(TypeVars tvars) {
this.j = Jimple.v();
this.localX = j.newLocal("x", IntType.v());
this.localY = j.newLocal("y", IntType.v());
this.localZ = j.newLocal("z", IntType.v());
this.localO = j.newLocal("o", RefType.v("java.lang.Object"));
this.localT = j.newLocal("t", RefType.v("TestClass"));
this.localThis = j.newLocal("this", RefType.v("TestClass"));
this.varX = Var.fromLocal(localX);
this.varY = Var.fromLocal(localY);
this.varZ = Var.fromLocal(localZ);
this.varO = Var.fromLocal(localO);
this.varT = Var.fromLocal(localT);
this.varThis = Var.fromLocal(localThis);
this.tvarX = tvars.testParam(varX, "");
this.tvarY = tvars.testParam(varY, "");
this.tvarZ = tvars.testParam(varZ, "");
this.tvarO = tvars.testParam(varO, "");
this.tvarT = tvars.testParam(varT, "");
this.tvarThis = tvars.testParam(varThis, "");
this.init =
Environments.makeEmpty()
.add(varX, tvarX)
.add(varY, tvarY)
.add(varZ, tvarZ)
.add(varO, tvarO)
.add(varT, tvarT)
.add(varThis, tvarThis);
this.testClass = makeFreshClass("TestClass");
Map<SootField, TypeDomain.Type<Level>> fieldMap = new HashMap<>();
this.testLowField_int = new SootField("testLowField", IntType.v(), 0);
testClass.addField(this.testLowField_int);
fieldMap.put(testLowField_int, TLOW);
this.testHighField_int = new SootField("testHighField", IntType.v(), 0);
testClass.addField(this.testHighField_int);
fieldMap.put(testHighField_int, THIGH);
this.testStaticDynField_int = new SootField("testStaticDynField", IntType.v(), Modifier.STATIC);
testClass.addField(this.testStaticDynField_int);
fieldMap.put(testStaticDynField_int, DYN);
// freeze field map
this.fields = new FieldTable<>(fieldMap);
Map<SootMethod, Signature<Level>> sigMap = new HashMap<>();
Symbol.Param<LowHigh.Level> param_x = param(0);
Symbol.Param<LowHigh.Level> param_y = param(1);
// Method:
// int testCallee()
// with {} effect {}
this.testCallee__int =
new SootMethod("testCallee", Collections.emptyList(), IntType.v(), Modifier.ABSTRACT);
this.testClass.addMethod(testCallee__int);
sigMap.put(
this.testCallee__int,
makeSignature(
this.testCallee__int.getParameterCount(),
Stream.of(leS(Symbol.literal(PUB), ret())).collect(toList()),
Effects.emptyEffect()));
// Method:
// int testCallee_int_int__int (int, int)
// with {@param1 <= @ret, @param2 <= @ret} effect {}
this.testCallee_int_int__int =
new SootMethod(
"testCallee", asList(IntType.v(), IntType.v()), IntType.v(), Modifier.ABSTRACT);
this.testClass.addMethod(testCallee_int_int__int);
Stream<SigConstraint<Level>> sigCstrs = Stream.of(leS(param_x, ret()), leS(param_y, ret()));
sigMap.put(
this.testCallee_int_int__int,
makeSignature(
this.testCallee_int_int__int.getParameterCount(),
sigCstrs.collect(toList()),
Effects.emptyEffect()));
// Method:
// int ignoreSnd(int, int)
// with { @param1 <= @ret } effect {}
this.ignoreSnd_int_int__int =
new SootMethod(
"ignoreSnd", asList(IntType.v(), IntType.v()), IntType.v(), Modifier.ABSTRACT);
this.testClass.addMethod(ignoreSnd_int_int__int);
sigCstrs = Stream.of(leS(param_x, ret()), leS(param_y, param_y));
sigMap.put(
this.ignoreSnd_int_int__int,
makeSignature(
this.ignoreSnd_int_int__int.getParameterCount(),
sigCstrs.collect(toList()),
Effects.emptyEffect()));
// Method:
// int writeToLowReturn0(int)
// with { @param0 <= LOW } effect { LOW }
this.writeToLowReturn0_int__int =
new SootMethod("writeToLow", singletonList(IntType.v()), IntType.v(), Modifier.ABSTRACT);
this.testClass.addMethod(this.writeToLowReturn0_int__int);
sigCstrs = Stream.of((leS(param_x, literal(TLOW))), leS(ret(), ret()));
sigMap.put(
this.writeToLowReturn0_int__int,
makeSignature(
this.writeToLowReturn0_int__int.getParameterCount(),
sigCstrs.collect(toList()),
Effects.makeEffects(TLOW)));
// Method:
// int ignore0Low1ReturnHigh(int, int)
// with { @param1 <= LOW, HIGH <= ret } effect {}
this.ignore0Low1ReturnHigh =
new SootMethod(
"ignore0Low1ReturnHigh",
asList(IntType.v(), IntType.v()),
IntType.v(),
Modifier.ABSTRACT);
this.testClass.addMethod(this.ignore0Low1ReturnHigh);
sigCstrs = Stream.of(leS(param(1), literal(TLOW)), leS(literal(THIGH), ret()));
sigMap.put(
this.ignore0Low1ReturnHigh,
makeSignature(
this.ignore0Low1ReturnHigh.getParameterCount(),
sigCstrs.collect(toList()),
Effects.emptyEffect()));
// freeze signatures
this.signatures = makeTable(sigMap);
}
/**
* @param annotations
* @return
*/
private List<Tag> handleAnnotation(
Set<? extends org.jf.dexlib2.iface.Annotation> annotations, String classType) {
if (annotations == null || annotations.size() == 0) return null;
List<Tag> tags = new ArrayList<Tag>();
VisibilityAnnotationTag[] vatg =
new VisibilityAnnotationTag[3]; // RUNTIME_VISIBLE, RUNTIME_INVISIBLE, SOURCE_VISIBLE, see
// soot.tagkit.AnnotationConstants
for (Annotation a : annotations) {
int v = getVisibility(a.getVisibility());
Tag t = null;
Type atype = DexType.toSoot(a.getType());
String atypes = atype.toString();
int eSize = a.getElements().size();
Debug.printDbg("annotation type: ", atypes, " elements: ", eSize);
if (atypes.equals("dalvik.annotation.AnnotationDefault")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation Default. Got " + eSize + " instead.");
// get element
AnnotationElem e = getElements(a.getElements()).get(0);
AnnotationTag adt = new AnnotationTag(a.getType());
adt.addElem(e);
if (vatg[v] == null) vatg[v] = new VisibilityAnnotationTag(v);
vatg[v].addAnnotation(adt);
} else if (atypes.equals("dalvik.annotation.EnclosingClass")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation EnclosingClass. Got "
+ eSize
+ " instead.");
for (AnnotationElement elem : a.getElements()) {
String outerClass = ((TypeEncodedValue) elem.getValue()).getValue();
outerClass = Util.dottedClassName(outerClass);
deps.typesToSignature.add(RefType.v(outerClass));
clazz.setOuterClass(SootResolver.v().makeClassRef(outerClass));
assert clazz.getOuterClass() != clazz;
}
// EnclosingClass comes in pair with InnerClass.
// Those are generated from a single InnerClassTag,
// that is re-constructed only for the InnerClass Dalvik
// annotation.
continue;
} else if (atypes.equals("dalvik.annotation.EnclosingMethod")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation EnclosingMethod. Got "
+ eSize
+ " instead.");
AnnotationStringElem e = (AnnotationStringElem) getElements(a.getElements()).get(0);
String[] split1 = e.getValue().split("\\ \\|");
String classString = split1[0];
String methodString = split1[1];
String parameters = split1[2];
String returnType = split1[3];
String methodSigString = "(" + parameters + ")" + returnType;
t = new EnclosingMethodTag(classString, methodString, methodSigString);
String outerClass = classString.replace("/", ".");
deps.typesToSignature.add(RefType.v(outerClass));
clazz.setOuterClass(SootResolver.v().makeClassRef(outerClass));
assert clazz.getOuterClass() != clazz;
} else if (atypes.equals("dalvik.annotation.InnerClass")) {
int accessFlags = -1; // access flags of the inner class
String name = null; // name of the inner class
for (AnnotationElem ele : getElements(a.getElements())) {
if (ele instanceof AnnotationIntElem && ele.getName().equals("accessFlags"))
accessFlags = ((AnnotationIntElem) ele).getValue();
else if (ele instanceof AnnotationStringElem && ele.getName().equals("name"))
name = ((AnnotationStringElem) ele).getValue();
else throw new RuntimeException("Unexpected inner class annotation element");
}
String outerClass; // outer class name
if (name == null) outerClass = classType.replaceAll("\\$[0-9,a-z,A-Z]*;$", ";");
else outerClass = classType.replaceFirst("\\$" + name + ";$", ";");
// Make sure that no funny business is going on if the
// annotation is broken and does not end in $nn.
if (outerClass.equals(classType)) {
outerClass = null;
}
Tag innerTag =
new InnerClassTag(
DexType.toSootICAT(classType),
outerClass == null ? null : DexType.toSootICAT(outerClass),
name,
accessFlags);
tags.add(innerTag);
if (outerClass != null && !clazz.hasOuterClass()) {
String sootOuterClass = Util.dottedClassName(outerClass);
deps.typesToSignature.add(RefType.v(sootOuterClass));
clazz.setOuterClass(SootResolver.v().makeClassRef(sootOuterClass));
assert clazz.getOuterClass() != clazz;
}
continue;
} else if (atypes.equals("dalvik.annotation.MemberClasses")) {
AnnotationArrayElem e = (AnnotationArrayElem) getElements(a.getElements()).get(0);
for (AnnotationElem ae : e.getValues()) {
AnnotationClassElem c = (AnnotationClassElem) ae;
String innerClass = c.getDesc();
String outerClass = innerClass.replaceAll("\\$[^\\$]*$", "");
String name = innerClass.replaceAll("^.*\\$", "").replaceAll(";$", "");
if (name.replaceAll("[0-9].*", "").equals("")) { // anonymous or local inner classes
name = null;
}
int accessFlags =
0; // seems like this information is lost during the .class -- dx --> .dex process.
Tag innerTag =
new InnerClassTag(
DexType.toSootICAT(innerClass),
DexType.toSootICAT(outerClass),
name,
accessFlags);
tags.add(innerTag);
}
continue;
} else if (atypes.equals("dalvik.annotation.Signature")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation Signature. Got " + eSize + " instead.");
AnnotationArrayElem e = (AnnotationArrayElem) getElements(a.getElements()).get(0);
String sig = "";
for (AnnotationElem ae : e.getValues()) {
AnnotationStringElem s = (AnnotationStringElem) ae;
sig += s.getValue();
}
t = new SignatureTag(sig);
} else if (atypes.equals("dalvik.annotation.Throws")) {
// this is handled in soot.dexpler.DexMethod
continue;
} else if (atypes.equals("java.lang.Deprecated")) {
if (eSize != 0)
throw new RuntimeException(
"error: expected 1 element for annotation Deprecated. Got " + eSize + " instead.");
t = new DeprecatedTag();
AnnotationTag adt = new AnnotationTag("Ljava/lang/Deprecated;");
if (vatg[v] == null) vatg[v] = new VisibilityAnnotationTag(v);
vatg[v].addAnnotation(adt);
} else {
Debug.printDbg("read visibility tag: ", a.getType());
if (vatg[v] == null) vatg[v] = new VisibilityAnnotationTag(v);
AnnotationTag tag = new AnnotationTag(a.getType());
for (AnnotationElem e : getElements(a.getElements())) tag.addElem(e);
vatg[v].addAnnotation(tag);
}
tags.add(t);
}
for (VisibilityAnnotationTag vat : vatg) if (vat != null) tags.add(vat);
return tags;
}
/**
* Converts annotations from Dexlib to Jimple.
*
* @author alex
*/
public class DexAnnotation {
private final Type ARRAY_TYPE = RefType.v("Array");
private final SootClass clazz;
private final Dependencies deps;
DexAnnotation(SootClass clazz, Dependencies deps) {
this.clazz = clazz;
this.deps = deps;
}
/**
* Converts Class annotations from Dexlib to Jimple.
*
* @param h
* @param classDef
*/
// .annotation "Ldalvik/annotation/AnnotationDefault;"
// .annotation "Ldalvik/annotation/EnclosingClass;"
// .annotation "Ldalvik/annotation/EnclosingMethod;"
// .annotation "Ldalvik/annotation/InnerClass;"
// .annotation "Ldalvik/annotation/MemberClasses;"
// .annotation "Ldalvik/annotation/Signature;"
// .annotation "Ldalvik/annotation/Throws;"
void handleClassAnnotation(ClassDef classDef) {
Set<? extends Annotation> aSet = classDef.getAnnotations();
if (aSet == null || aSet.isEmpty()) return;
List<Tag> tags = handleAnnotation(aSet, classDef.getType());
if (tags == null) return;
InnerClassAttribute ica = null;
for (Tag t : tags)
if (t != null) {
if (t instanceof InnerClassTag) {
if (ica == null) {
// Do we already have an InnerClassAttribute?
ica = (InnerClassAttribute) clazz.getTag("InnerClassAttribute");
// If not, create one
if (ica == null) {
ica = new InnerClassAttribute();
clazz.addTag(ica);
}
}
ica.add((InnerClassTag) t);
} else if (t instanceof VisibilityAnnotationTag) {
// If a dalvik/annotation/AnnotationDefault tag is present
// in a class, its AnnotationElements must be propagated
// to methods through the creation of new AnnotationDefaultTag.
VisibilityAnnotationTag vt = (VisibilityAnnotationTag) t;
for (AnnotationTag a : vt.getAnnotations()) {
if (a.getType().equals("Ldalvik/annotation/AnnotationDefault;")) {
for (AnnotationElem ae : a.getElems()) {
if (ae instanceof AnnotationAnnotationElem) {
AnnotationAnnotationElem aae = (AnnotationAnnotationElem) ae;
AnnotationTag at = aae.getValue();
// extract default elements
Map<String, AnnotationElem> defaults = new HashMap<String, AnnotationElem>();
for (AnnotationElem aelem : at.getElems()) {
defaults.put(aelem.getName(), aelem);
}
// create default tags containing default elements
// and add tags on methods
for (SootMethod sm : clazz.getMethods()) {
String methodName = sm.getName();
if (defaults.containsKey(methodName)) {
AnnotationElem e = defaults.get(methodName);
// Okay, the name is the same, but is it actually the same type?
Type annotationType = getSootType(e);
boolean isCorrectType = false;
if (annotationType == null) {
// we do not know the type of the annotation, so we guess it's the correct
// type.
isCorrectType = true;
} else {
if (annotationType.equals(sm.getReturnType())) {
isCorrectType = true;
} else if (annotationType.equals(ARRAY_TYPE)) {
if (sm.getReturnType() instanceof ArrayType) isCorrectType = true;
}
}
if (isCorrectType && sm.getParameterCount() == 0) {
e.setName("default");
AnnotationDefaultTag d = new AnnotationDefaultTag(e);
sm.addTag(d);
// In case there is more than one matching method, we only use the first one
defaults.remove(sm.getName());
}
}
}
for (Entry<String, AnnotationElem> leftOverEntry : defaults.entrySet()) {
// We were not able to find a matching method for the tag, because the return
// signature
// does not match
SootMethod found = clazz.getMethodByNameUnsafe(leftOverEntry.getKey());
AnnotationElem element = leftOverEntry.getValue();
if (found != null) {
element.setName("default");
AnnotationDefaultTag d = new AnnotationDefaultTag(element);
found.addTag(d);
}
}
}
}
}
}
if (!(vt.getVisibility() == AnnotationConstants.RUNTIME_INVISIBLE)) clazz.addTag(vt);
} else {
clazz.addTag(t);
}
Debug.printDbg("add class annotation: ", t, " type: ", t.getClass());
}
}
private Type getSootType(AnnotationElem e) {
Type annotationType;
switch (e.getKind()) {
case '[': // array
// Until now we only know it's some kind of array.
annotationType = ARRAY_TYPE;
AnnotationArrayElem array = (AnnotationArrayElem) e;
if (array.getNumValues() > 0) {
// Try to determine type of the array
AnnotationElem firstElement = array.getValueAt(0);
Type type = getSootType(firstElement);
if (type == null) return null;
if (type.equals(ARRAY_TYPE)) return ARRAY_TYPE;
return ArrayType.v(type, 1);
}
break;
case 's': // string
annotationType = RefType.v("java.lang.String");
break;
case 'c': // class
annotationType = RefType.v("java.lang.Class");
break;
case 'e': // enum
AnnotationEnumElem enumElem = (AnnotationEnumElem) e;
annotationType = Util.getType(enumElem.getTypeName());
;
break;
case 'L':
case 'J':
case 'S':
case 'D':
case 'I':
case 'F':
case 'B':
case 'C':
case 'V':
case 'Z':
annotationType = Util.getType(String.valueOf(e.getKind()));
break;
default:
annotationType = null;
break;
}
return annotationType;
}
/**
* Converts field annotations from Dexlib to Jimple
*
* @param h
* @param f
*/
void handleFieldAnnotation(Host h, Field f) {
Set<? extends Annotation> aSet = f.getAnnotations();
if (aSet != null && !aSet.isEmpty()) {
List<Tag> tags = handleAnnotation(aSet, null);
if (tags != null)
for (Tag t : tags)
if (t != null) {
h.addTag(t);
Debug.printDbg("add field annotation: ", t);
}
}
}
/**
* Converts method and method parameters annotations from Dexlib to Jimple
*
* @param h
* @param method
*/
void handleMethodAnnotation(Host h, Method method) {
Set<? extends Annotation> aSet = method.getAnnotations();
if (!(aSet == null || aSet.isEmpty())) {
List<Tag> tags = handleAnnotation(aSet, null);
if (tags != null)
for (Tag t : tags)
if (t != null) {
h.addTag(t);
Debug.printDbg("add method annotation: ", t);
}
}
ArrayList<String> parameterNames = new ArrayList<String>();
boolean addParameterNames = false;
for (MethodParameter p : method.getParameters()) {
String name = p.getName();
parameterNames.add(name);
if (name != null) addParameterNames = true;
}
if (addParameterNames) {
h.addTag(new ParamNamesTag(parameterNames));
}
// Is there any parameter annotation?
boolean doParam = false;
List<? extends MethodParameter> parameters = method.getParameters();
for (MethodParameter p : parameters) {
Debug.printDbg("parameter ", p, " annotations: ", p.getAnnotations());
if (p.getAnnotations().size() > 0) {
doParam = true;
break;
}
}
if (doParam) {
VisibilityParameterAnnotationTag tag =
new VisibilityParameterAnnotationTag(
parameters.size(), AnnotationConstants.RUNTIME_VISIBLE);
for (MethodParameter p : parameters) {
List<Tag> tags = handleAnnotation(p.getAnnotations(), null);
// If we have no tag for this parameter, add a placeholder
// so that we keep the order intact.
if (tags == null) {
tag.addVisibilityAnnotation(null);
continue;
}
VisibilityAnnotationTag paramVat =
new VisibilityAnnotationTag(AnnotationConstants.RUNTIME_VISIBLE);
tag.addVisibilityAnnotation(paramVat);
for (Tag t : tags) {
if (t == null) continue;
AnnotationTag vat = null;
if (!(t instanceof VisibilityAnnotationTag)) {
if (t instanceof DeprecatedTag) {
vat = new AnnotationTag("Ljava/lang/Deprecated;");
} else if (t instanceof SignatureTag) {
SignatureTag sig = (SignatureTag) t;
ArrayList<AnnotationElem> sigElements = new ArrayList<AnnotationElem>();
for (String s : SootToDexUtils.splitSignature(sig.getSignature()))
sigElements.add(new AnnotationStringElem(s, 's', "value"));
AnnotationElem elem = new AnnotationArrayElem(sigElements, 's', "value");
vat = new AnnotationTag("Ldalvik/annotation/Signature;", Collections.singleton(elem));
} else {
throw new RuntimeException(
"error: unhandled tag for parameter annotation in method " + h + " (" + t + ").");
}
} else {
vat = ((VisibilityAnnotationTag) t).getAnnotations().get(0);
}
Debug.printDbg("add parameter annotation: ", t);
paramVat.addAnnotation(vat);
}
}
if (tag.getVisibilityAnnotations().size() > 0) h.addTag(tag);
}
}
class MyAnnotations {
List<AnnotationTag> annotationList = new ArrayList<AnnotationTag>();
List<Integer> visibilityList = new ArrayList<Integer>();
public void add(AnnotationTag a, int visibility) {
annotationList.add(a);
visibilityList.add(new Integer(visibility));
}
public List<AnnotationTag> getAnnotations() {
return annotationList;
}
public List<Integer> getVisibilityList() {
return visibilityList;
}
}
/**
* @param annotations
* @return
*/
private List<Tag> handleAnnotation(
Set<? extends org.jf.dexlib2.iface.Annotation> annotations, String classType) {
if (annotations == null || annotations.size() == 0) return null;
List<Tag> tags = new ArrayList<Tag>();
VisibilityAnnotationTag[] vatg =
new VisibilityAnnotationTag[3]; // RUNTIME_VISIBLE, RUNTIME_INVISIBLE, SOURCE_VISIBLE, see
// soot.tagkit.AnnotationConstants
for (Annotation a : annotations) {
int v = getVisibility(a.getVisibility());
Tag t = null;
Type atype = DexType.toSoot(a.getType());
String atypes = atype.toString();
int eSize = a.getElements().size();
Debug.printDbg("annotation type: ", atypes, " elements: ", eSize);
if (atypes.equals("dalvik.annotation.AnnotationDefault")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation Default. Got " + eSize + " instead.");
// get element
AnnotationElem e = getElements(a.getElements()).get(0);
AnnotationTag adt = new AnnotationTag(a.getType());
adt.addElem(e);
if (vatg[v] == null) vatg[v] = new VisibilityAnnotationTag(v);
vatg[v].addAnnotation(adt);
} else if (atypes.equals("dalvik.annotation.EnclosingClass")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation EnclosingClass. Got "
+ eSize
+ " instead.");
for (AnnotationElement elem : a.getElements()) {
String outerClass = ((TypeEncodedValue) elem.getValue()).getValue();
outerClass = Util.dottedClassName(outerClass);
deps.typesToSignature.add(RefType.v(outerClass));
clazz.setOuterClass(SootResolver.v().makeClassRef(outerClass));
assert clazz.getOuterClass() != clazz;
}
// EnclosingClass comes in pair with InnerClass.
// Those are generated from a single InnerClassTag,
// that is re-constructed only for the InnerClass Dalvik
// annotation.
continue;
} else if (atypes.equals("dalvik.annotation.EnclosingMethod")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation EnclosingMethod. Got "
+ eSize
+ " instead.");
AnnotationStringElem e = (AnnotationStringElem) getElements(a.getElements()).get(0);
String[] split1 = e.getValue().split("\\ \\|");
String classString = split1[0];
String methodString = split1[1];
String parameters = split1[2];
String returnType = split1[3];
String methodSigString = "(" + parameters + ")" + returnType;
t = new EnclosingMethodTag(classString, methodString, methodSigString);
String outerClass = classString.replace("/", ".");
deps.typesToSignature.add(RefType.v(outerClass));
clazz.setOuterClass(SootResolver.v().makeClassRef(outerClass));
assert clazz.getOuterClass() != clazz;
} else if (atypes.equals("dalvik.annotation.InnerClass")) {
int accessFlags = -1; // access flags of the inner class
String name = null; // name of the inner class
for (AnnotationElem ele : getElements(a.getElements())) {
if (ele instanceof AnnotationIntElem && ele.getName().equals("accessFlags"))
accessFlags = ((AnnotationIntElem) ele).getValue();
else if (ele instanceof AnnotationStringElem && ele.getName().equals("name"))
name = ((AnnotationStringElem) ele).getValue();
else throw new RuntimeException("Unexpected inner class annotation element");
}
String outerClass; // outer class name
if (name == null) outerClass = classType.replaceAll("\\$[0-9,a-z,A-Z]*;$", ";");
else outerClass = classType.replaceFirst("\\$" + name + ";$", ";");
// Make sure that no funny business is going on if the
// annotation is broken and does not end in $nn.
if (outerClass.equals(classType)) {
outerClass = null;
}
Tag innerTag =
new InnerClassTag(
DexType.toSootICAT(classType),
outerClass == null ? null : DexType.toSootICAT(outerClass),
name,
accessFlags);
tags.add(innerTag);
if (outerClass != null && !clazz.hasOuterClass()) {
String sootOuterClass = Util.dottedClassName(outerClass);
deps.typesToSignature.add(RefType.v(sootOuterClass));
clazz.setOuterClass(SootResolver.v().makeClassRef(sootOuterClass));
assert clazz.getOuterClass() != clazz;
}
continue;
} else if (atypes.equals("dalvik.annotation.MemberClasses")) {
AnnotationArrayElem e = (AnnotationArrayElem) getElements(a.getElements()).get(0);
for (AnnotationElem ae : e.getValues()) {
AnnotationClassElem c = (AnnotationClassElem) ae;
String innerClass = c.getDesc();
String outerClass = innerClass.replaceAll("\\$[^\\$]*$", "");
String name = innerClass.replaceAll("^.*\\$", "").replaceAll(";$", "");
if (name.replaceAll("[0-9].*", "").equals("")) { // anonymous or local inner classes
name = null;
}
int accessFlags =
0; // seems like this information is lost during the .class -- dx --> .dex process.
Tag innerTag =
new InnerClassTag(
DexType.toSootICAT(innerClass),
DexType.toSootICAT(outerClass),
name,
accessFlags);
tags.add(innerTag);
}
continue;
} else if (atypes.equals("dalvik.annotation.Signature")) {
if (eSize != 1)
throw new RuntimeException(
"error: expected 1 element for annotation Signature. Got " + eSize + " instead.");
AnnotationArrayElem e = (AnnotationArrayElem) getElements(a.getElements()).get(0);
String sig = "";
for (AnnotationElem ae : e.getValues()) {
AnnotationStringElem s = (AnnotationStringElem) ae;
sig += s.getValue();
}
t = new SignatureTag(sig);
} else if (atypes.equals("dalvik.annotation.Throws")) {
// this is handled in soot.dexpler.DexMethod
continue;
} else if (atypes.equals("java.lang.Deprecated")) {
if (eSize != 0)
throw new RuntimeException(
"error: expected 1 element for annotation Deprecated. Got " + eSize + " instead.");
t = new DeprecatedTag();
AnnotationTag adt = new AnnotationTag("Ljava/lang/Deprecated;");
if (vatg[v] == null) vatg[v] = new VisibilityAnnotationTag(v);
vatg[v].addAnnotation(adt);
} else {
Debug.printDbg("read visibility tag: ", a.getType());
if (vatg[v] == null) vatg[v] = new VisibilityAnnotationTag(v);
AnnotationTag tag = new AnnotationTag(a.getType());
for (AnnotationElem e : getElements(a.getElements())) tag.addElem(e);
vatg[v].addAnnotation(tag);
}
tags.add(t);
}
for (VisibilityAnnotationTag vat : vatg) if (vat != null) tags.add(vat);
return tags;
}
private ArrayList<AnnotationElem> getElements(Set<? extends AnnotationElement> set) {
ArrayList<AnnotationElem> aelemList = new ArrayList<AnnotationElem>();
for (AnnotationElement ae : set) {
// Debug.printDbg("element: ", ae.getName() ," ", ae.getValue() ," type: ", ae.getClass());
// Debug.printDbg("value type: ", ae.getValue().getValueType() ," class: ",
// ae.getValue().getClass());
Debug.printDbg(" element type: ", ae.getValue().getClass());
List<AnnotationElem> eList =
handleAnnotationElement(ae, Collections.singletonList(ae.getValue()));
if (eList != null) aelemList.addAll(eList);
}
return aelemList;
}
private ArrayList<AnnotationElem> handleAnnotationElement(
AnnotationElement ae, List<? extends EncodedValue> evList) {
ArrayList<AnnotationElem> aelemList = new ArrayList<AnnotationElem>();
for (EncodedValue ev : evList) {
int type = ev.getValueType();
AnnotationElem elem = null;
Debug.printDbg("encoded value type: ", type);
switch (type) {
case 0x00: // BYTE
{
ByteEncodedValue v = (ByteEncodedValue) ev;
elem = new AnnotationIntElem(v.getValue(), 'B', ae.getName());
break;
}
case 0x02: // SHORT
{
ShortEncodedValue v = (ShortEncodedValue) ev;
elem = new AnnotationIntElem(v.getValue(), 'S', ae.getName());
break;
}
case 0x03: // CHAR
{
CharEncodedValue v = (CharEncodedValue) ev;
elem = new AnnotationIntElem(v.getValue(), 'C', ae.getName());
break;
}
case 0x04: // INT
{
IntEncodedValue v = (IntEncodedValue) ev;
elem = new AnnotationIntElem(v.getValue(), 'I', ae.getName());
break;
}
case 0x06: // LONG
{
LongEncodedValue v = (LongEncodedValue) ev;
elem = new AnnotationLongElem(v.getValue(), 'J', ae.getName());
break;
}
case 0x10: // FLOAT
{
FloatEncodedValue v = (FloatEncodedValue) ev;
elem = new AnnotationFloatElem(v.getValue(), 'F', ae.getName());
break;
}
case 0x11: // DOUBLE
{
DoubleEncodedValue v = (DoubleEncodedValue) ev;
elem = new AnnotationDoubleElem(v.getValue(), 'D', ae.getName());
break;
}
case 0x17: // STRING
{
StringEncodedValue v = (StringEncodedValue) ev;
elem = new AnnotationStringElem(v.getValue(), 's', ae.getName());
Debug.printDbg("value for string: ", v.getValue());
break;
}
case 0x18: // TYPE
{
TypeEncodedValue v = (TypeEncodedValue) ev;
elem = new AnnotationClassElem(DexType.toSootAT(v.getValue()), 'c', ae.getName());
break;
}
case 0x19: // FIELD (Dalvik specific?)
{
FieldEncodedValue v = (FieldEncodedValue) ev;
FieldReference fr = v.getValue();
String fieldSig = "";
fieldSig += DexType.toSootAT(fr.getDefiningClass()) + ": ";
fieldSig += DexType.toSootAT(fr.getType()) + " ";
fieldSig += fr.getName();
Debug.printDbg("FIELD: ", fieldSig);
elem = new AnnotationStringElem(fieldSig, 'f', ae.getName());
break;
}
case 0x1a: // METHOD (Dalvik specific?)
{
MethodEncodedValue v = (MethodEncodedValue) ev;
MethodReference mr = v.getValue();
String className = DexType.toSootICAT(mr.getDefiningClass());
String returnType = DexType.toSootAT(mr.getReturnType());
String methodName = mr.getName();
String parameters = "";
for (CharSequence p : mr.getParameterTypes()) {
parameters += DexType.toSootAT(p.toString());
}
String mSig = className + " |" + methodName + " |" + parameters + " |" + returnType;
elem = new AnnotationStringElem(mSig, 'M', ae.getName());
break;
}
case 0x1b: // ENUM : Warning -> encoding Dalvik specific!
{
EnumEncodedValue v = (EnumEncodedValue) ev;
FieldReference fr = v.getValue();
elem =
new AnnotationEnumElem(
DexType.toSootAT(fr.getType()).toString(), fr.getName(), 'e', ae.getName());
break;
}
case 0x1c: // ARRAY
{
ArrayEncodedValue v = (ArrayEncodedValue) ev;
ArrayList<AnnotationElem> l = handleAnnotationElement(ae, v.getValue());
if (l != null) elem = new AnnotationArrayElem(l, '[', ae.getName());
break;
}
case 0x1d: // ANNOTATION
{
AnnotationEncodedValue v = (AnnotationEncodedValue) ev;
AnnotationTag t = new AnnotationTag(DexType.toSootAT(v.getType()).toString());
for (AnnotationElement newElem : v.getElements()) {
List<EncodedValue> l = new ArrayList<EncodedValue>();
l.add(newElem.getValue());
List<AnnotationElem> aList = handleAnnotationElement(newElem, l);
if (aList != null) for (AnnotationElem e : aList) t.addElem(e);
}
elem = new AnnotationAnnotationElem(t, '@', ae.getName());
break;
}
case 0x1e: // NULL (Dalvik specific?)
{
elem = new AnnotationStringElem(null, 'N', ae.getName());
break;
}
case 0x1f: // BOOLEAN
{
BooleanEncodedValue v = (BooleanEncodedValue) ev;
elem = new AnnotationBooleanElem(v.getValue(), 'Z', ae.getName());
break;
}
default:
{
throw new RuntimeException("Unknown annotation element 0x" + Integer.toHexString(type));
}
} // switch (type)
if (elem != null) aelemList.add(elem);
} // for (EncodedValue)
return aelemList;
}
/**
* Converts Dexlib visibility to Jimple visibility.
*
* <p>In Dalvik: VISIBILITY_BUILD 0x00 intended only to be visible at build time (e.g., during
* compilation of other code) VISIBILITY_RUNTIME 0x01 intended to visible at runtime
* VISIBILITY_SYSTEM 0x02 intended to visible at runtime, but only to the underlying system (and
* not to regular user code)
*
* @param visibility Dexlib visibility
* @return Jimple visibility
*/
private int getVisibility(int visibility) {
if ("runtime".equals(AnnotationVisibility.getVisibility(visibility)))
return AnnotationConstants.RUNTIME_VISIBLE;
if ("system".equals(AnnotationVisibility.getVisibility(visibility)))
return AnnotationConstants.RUNTIME_INVISIBLE;
if ("build".equals(AnnotationVisibility.getVisibility(visibility))) //
return AnnotationConstants.SOURCE_VISIBLE;
throw new RuntimeException("error: unknown annotation visibility: '" + visibility + "'");
}
}