/**
* Utility method used in the construction of {@link UnitGraph}s, to be called only after the
* unitToPreds and unitToSuccs maps have been built.
*
* <p><code>UnitGraph</code> provides an implementation of <code>buildHeadsAndTails()</code> which
* defines the graph's set of heads to include the first {@link Unit} in the graph's body,
* together with any other <tt>Unit</tt> which has no predecessors. It defines the graph's set of
* tails to include all <tt>Unit</tt>s with no successors. Subclasses of <code>UnitGraph</code>
* may override this method to change the criteria for classifying a node as a head or tail.
*/
protected void buildHeadsAndTails() {
List tailList = new ArrayList();
List headList = new ArrayList();
for (Iterator unitIt = unitChain.iterator(); unitIt.hasNext(); ) {
Unit s = (Unit) unitIt.next();
List succs = (List) unitToSuccs.get(s);
if (succs.size() == 0) {
tailList.add(s);
}
List preds = (List) unitToPreds.get(s);
if (preds.size() == 0) {
headList.add(s);
}
}
// Add the first Unit, even if it is the target of
// a branch.
Unit entryPoint = (Unit) unitChain.getFirst();
if (!headList.contains(entryPoint)) {
headList.add(entryPoint);
}
tails = Collections.unmodifiableList(tailList);
heads = Collections.unmodifiableList(headList);
}
public void staticBlockInlining(SootClass sootClass) {
this.sootClass = sootClass;
// retrieve the clinit method if any for sootClass
if (!sootClass.declaresMethod("void <clinit>()")) {
System.out.println("no clinit");
return;
}
SootMethod clinit = sootClass.getMethod("void <clinit>()");
// System.out.println(clinit);
// retireve the active body
if (!clinit.hasActiveBody())
throw new RuntimeException("method " + clinit.getName() + " has no active body!");
Body clinitBody = clinit.getActiveBody();
Chain units = ((DavaBody) clinitBody).getUnits();
if (units.size() != 1) {
throw new RuntimeException("DavaBody AST doesn't have single root.");
}
ASTNode AST = (ASTNode) units.getFirst();
if (!(AST instanceof ASTMethodNode))
throw new RuntimeException("Starting node of DavaBody AST is not an ASTMethodNode");
AST.apply(new MethodCallFinder(this));
}
private void printStatementsInBody(Body body, java.io.PrintWriter out) {
if (Options.v().verbose()) System.out.println("Printing " + body.getMethod().getName());
Chain<Unit> units = ((DavaBody) body).getUnits();
if (units.size() != 1) {
throw new RuntimeException("DavaBody AST doesn't have single root.");
}
UnitPrinter up = new DavaUnitPrinter((DavaBody) body);
((ASTNode) units.getFirst()).toString(up);
out.print(up.toString());
}
public ASTMethodNode inline(SootMethod maybeInline) {
// check if this method should be inlined
if (sootClass != null) {
// 1, method should belong to the same class as the clinit method
if (sootClass.declaresMethod(maybeInline.getSubSignature())) {
// System.out.println("The method invoked is from the same class");
// 2, method should be static
if (Modifier.isStatic(maybeInline.getModifiers())) {
// decided to inline
// send the ASTMethod node of the TO BE INLINED METHOD
// retireve the active body
if (!maybeInline.hasActiveBody())
throw new RuntimeException("method " + maybeInline.getName() + " has no active body!");
Body bod = maybeInline.getActiveBody();
Chain units = ((DavaBody) bod).getUnits();
if (units.size() != 1) {
throw new RuntimeException("DavaBody AST doesn't have single root.");
}
ASTNode ASTtemp = (ASTNode) units.getFirst();
if (!(ASTtemp instanceof ASTMethodNode))
throw new RuntimeException("Starting node of DavaBody AST is not an ASTMethodNode");
// restricting to methods which do not have any variables declared
ASTMethodNode toReturn = (ASTMethodNode) ASTtemp;
ASTStatementSequenceNode declarations = toReturn.getDeclarations();
if (declarations.getStatements().size() == 0) {
// inline only if there are no declarations in the method inlined
System.out.println("No declarations in the method. we can inline this method");
return toReturn;
}
}
}
}
return null; // meaning dont inline
}
void doWeave(
SootMethod method,
LocalGeneratorEx lg,
AdviceApplication adviceappl,
Residue residue,
WeavingContext wc) {
AdviceInliner.v().addShadowMethod(method);
ShadowPoints shadowpoints = adviceappl.shadowmatch.sp;
AbstractAdviceDecl advicedecl = adviceappl.advice;
Body b = method.getActiveBody();
Chain units = b.getUnits().getNonPatchingChain();
// end of shadow
Stmt endshadow = shadowpoints.getEnd();
NopStmt nop2 = Jimple.v().newNopStmt();
GotoStmt goto1 = Jimple.v().newGotoStmt(nop2);
if (advicedecl instanceof CflowSetup) {
Tagger.tagStmt(goto1, InstructionKindTag.CFLOW_EXIT);
} else if (advicedecl instanceof PerCflowSetup) {
Tagger.tagStmt(goto1, InstructionKindTag.PERCFLOW_EXIT);
} else if (advicedecl instanceof DeclareSoft) {
Tagger.tagStmt(goto1, InstructionKindTag.EXCEPTION_SOFTENER);
} else if (advicedecl instanceof DeclareMessage) {
Tagger.tagStmt(goto1, InstructionKindTag.DECLARE_MESSAGE);
} else {
Tagger.tagStmt(goto1, InstructionKindTag.AFTER_THROWING_HANDLER);
}
Tagger.tagStmt(goto1, new InstructionSourceTag(advicedecl.sourceId));
Tagger.tagStmt(goto1, new InstructionShadowTag(adviceappl.shadowmatch.shadowId));
units.insertBefore(nop2, endshadow);
units.insertBefore(goto1, nop2);
// have ...
// goto1: goto nop2;
// nop2: nop;
// endshadow: nop;
RefType catchType = getCatchType();
Local exception = lg.generateLocal(catchType, "exception");
bindException(wc, advicedecl, exception);
CaughtExceptionRef exceptRef = Jimple.v().newCaughtExceptionRef();
IdentityStmt idStmt = Jimple.v().newIdentityStmt(exception, exceptRef);
units.insertAfter(idStmt, goto1);
ThrowStmt throwStmt = Jimple.v().newThrowStmt(exception);
throwStmt.addTag(new ThrowCreatedByCompilerTag());
if (advicedecl instanceof CflowSetup) {
Tagger.tagStmt(throwStmt, InstructionKindTag.CFLOW_EXIT);
} else if (advicedecl instanceof PerCflowSetup) {
Tagger.tagStmt(throwStmt, InstructionKindTag.PERCFLOW_EXIT);
} else if (advicedecl instanceof DeclareSoft) {
Tagger.tagStmt(throwStmt, InstructionKindTag.EXCEPTION_SOFTENER);
} else if (advicedecl instanceof DeclareMessage) {
Tagger.tagStmt(throwStmt, InstructionKindTag.DECLARE_MESSAGE);
} else {
Tagger.tagStmt(throwStmt, InstructionKindTag.AFTER_THROWING_HANDLER);
}
Tagger.tagStmt(throwStmt, new InstructionSourceTag(advicedecl.sourceId));
Tagger.tagStmt(throwStmt, new InstructionShadowTag(adviceappl.shadowmatch.shadowId));
// store shadow/source tag for this residue in weaving context
if (advicedecl instanceof CflowSetup) {
wc.setKindTag(InstructionKindTag.CFLOW_TEST);
}
if (advicedecl instanceof PerCflowSetup) {
wc.setKindTag(InstructionKindTag.CFLOW_TEST);
}
wc.setShadowTag(new InstructionShadowTag(adviceappl.shadowmatch.shadowId));
wc.setSourceTag(new InstructionSourceTag(adviceappl.advice.sourceId));
Stmt endresidue = residue.codeGen(method, lg, units, idStmt, throwStmt, true, wc);
// have ...
// java.lang.Exception exception;
//
// goto1: goto nop2;
// idStmt: exception := @caughtexception
// nop2: nop;
// endshadow: nop;
units.insertAfter(throwStmt, endresidue);
Chain invokestmts = advicedecl.makeAdviceExecutionStmts(adviceappl, lg, wc);
for (Iterator stmtlist = invokestmts.iterator(); stmtlist.hasNext(); ) {
Stmt nextstmt = (Stmt) stmtlist.next();
units.insertBefore(nextstmt, throwStmt);
}
if (method.getName().equals("<clinit>"))
// have to handle case of ExceptionInInitialzerError
{ // if (exception instanceof java.lang.ExceptionInIntializerError)
// throw (exception);
debug("Adding extra check in clinit");
Local isInitError = lg.generateLocal(soot.BooleanType.v(), "isInitError");
Stmt assignbool =
Jimple.v()
.newAssignStmt(
isInitError,
Jimple.v()
.newInstanceOfExpr(
exception, RefType.v("java.lang.ExceptionInInitializerError")));
Stmt ifstmt =
Jimple.v().newIfStmt(Jimple.v().newNeExpr(isInitError, IntConstant.v(0)), throwStmt);
// ThrowStmt throwInitError = Jimple.v().newThrowStmt(exception);
// units.insertAfter(throwInitError, idStmt);
units.insertAfter(ifstmt, idStmt);
units.insertAfter(assignbool, idStmt);
}
Stmt beginshadow = shadowpoints.getBegin();
Stmt begincode = (Stmt) units.getSuccOf(beginshadow);
// have ...
// java.lang.Exception exception;
// <AspectType> theAspect;
//
// beginshadow: nop
// begincode: <some statement>
// .... <stuff in between>
// goto1: goto nop2;
// idStmt: exception := @caughtexception;
// assignStmt: theAspect = new AspectOf();
// .... invoke statements ....
// throwStmt: throw exception;
// nop2: nop;
// endshadow: nop;
Chain traps = b.getTraps();
Trap t = traps.size() > 0 ? (Trap) traps.getFirst() : null;
// assume no exception ranges overlap with this one; make sure
// we go after any that would be enclosed within this one.
while (t != null
&& (units.follows(t.getBeginUnit(), begincode)
|| (t.getBeginUnit() == begincode && units.follows(idStmt, t.getEndUnit()))))
t = (Trap) traps.getSuccOf(t);
Trap newt = Jimple.v().newTrap(catchType.getSootClass(), begincode, idStmt, idStmt);
if (t == null) traps.addLast(newt);
else traps.insertBefore(newt, t);
// added
// catch java.lang.Throwable
// from begincode upto idStmt handlewith idStmt
} // method doWeave
/** Prints the given <code>JimpleBody</code> to the specified <code>PrintWriter</code>. */
private void printStatementsInBody(
Body body, java.io.PrintWriter out, LabeledUnitPrinter up, UnitGraph unitGraph) {
Chain units = body.getUnits();
Iterator unitIt = units.iterator();
Unit currentStmt = null, previousStmt;
while (unitIt.hasNext()) {
previousStmt = currentStmt;
currentStmt = (Unit) unitIt.next();
// Print appropriate header.
{
// Put an empty line if the previous node was a branch node, the current node is a join node
// or the previous statement does not have body statement as a successor, or if
// body statement has a label on it
if (currentStmt != units.getFirst()) {
if (unitGraph.getSuccsOf(previousStmt).size() != 1
|| unitGraph.getPredsOf(currentStmt).size() != 1
|| up.labels().containsKey(currentStmt)) {
up.newline();
} else {
// Or if the previous node does not have body statement as a successor.
List succs = unitGraph.getSuccsOf(previousStmt);
if (succs.get(0) != currentStmt) {
up.newline();
}
}
}
if (up.labels().containsKey(currentStmt)) {
up.unitRef(currentStmt, true);
up.literal(":");
up.newline();
}
if (up.references().containsKey(currentStmt)) {
up.unitRef(currentStmt, false);
}
}
up.startUnit(currentStmt);
currentStmt.toString(up);
up.endUnit(currentStmt);
up.literal(";");
up.newline();
// only print them if not generating attributes files
// because they mess up line number
// if (!addJimpleLn()) {
if (Options.v().print_tags_in_output()) {
Iterator tagIterator = currentStmt.getTags().iterator();
while (tagIterator.hasNext()) {
Tag t = (Tag) tagIterator.next();
up.noIndent();
up.literal("/*");
up.literal(t.toString());
up.literal("*/");
up.newline();
}
/*Iterator udIt = currentStmt.getUseAndDefBoxes().iterator();
while (udIt.hasNext()) {
ValueBox temp = (ValueBox)udIt.next();
Iterator vbtags = temp.getTags().iterator();
while (vbtags.hasNext()) {
Tag t = (Tag) vbtags.next();
up.noIndent();
up.literal("VB Tag: "+t.toString());
up.newline();
}
}*/
}
}
out.print(up.toString());
if (addJimpleLn()) {
setJimpleLnNum(up.getPositionTagger().getEndLn());
}
// Print out exceptions
{
Iterator trapIt = body.getTraps().iterator();
if (trapIt.hasNext()) {
out.println();
incJimpleLnNum();
}
while (trapIt.hasNext()) {
Trap trap = (Trap) trapIt.next();
out.println(
" catch "
+ Scene.v().quotedNameOf(trap.getException().getName())
+ " from "
+ up.labels().get(trap.getBeginUnit())
+ " to "
+ up.labels().get(trap.getEndUnit())
+ " with "
+ up.labels().get(trap.getHandlerUnit())
+ ";");
incJimpleLnNum();
}
}
}
