Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix for #272 #274

Merged
merged 3 commits into from
Jun 24, 2024
Merged

Fix for #272 #274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bab738b
Fix for #272
cd1m0 Jun 24, 2024
f0e148c
review nit
cd1m0 Jun 24, 2024
8bf53da
lint
cd1m0 Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/instrumenter/annotations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ export class UserFunctionDefinitionMetaData extends AnnotationMetaData<SUserFunc
export class PropertyMetaData extends AnnotationMetaData<SProperty> {}

/**
* Metadata specific to a ghost var definition (invariant, if_succeeds)
* Metadata specific to a ghost var definition (let)
*/
export class LetAnnotationMetaData extends AnnotationMetaData<SLetAnnotation> {}

Expand Down
300 changes: 146 additions & 154 deletions src/instrumenter/instrument.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,89 +132,82 @@ export function findExternalCalls(
}

/**
* Build a debug event/debug event emission statement for each of the provided `annotations`. Return
* an array of the computed tuples `[EventDefinition, EmitStatement]`.
* Build a debug event and debug event emission statement for the provided
* `annotation`. Return a tuple `[EventDefinition, EmitStatement]`.
*
* If a given annotation doesn't have any identifiers to output for debugging purposes, return `undefined`
* in that respective index.
* If the given annotation doesn't have any identifiers to output for debugging
* purposes, return `undefined`.
*/
function getDebugInfoEmits(
annotations: Array<PropertyMetaData | TryAnnotationMetaData>,
function getDebugInfoEmit(
annotation: PropertyMetaData | TryAnnotationMetaData,
transCtx: TranspilingContext
): Array<Statement | Statement[] | undefined> {
const res: Array<Statement | Statement[] | undefined> = [];
): Statement | Statement[] | undefined {
const factory = transCtx.factory;
const instrCtx = transCtx.instrCtx;
const inference = instrCtx.typeEnv.inference;

for (const annot of annotations) {
const dbgIdsMap = transCtx.annotationDebugMap.get(annot);

// If there are no debug ids for the current annotation, there is no debug event to build
if (dbgIdsMap.size() == 0) {
res.push(undefined);

continue;
}
const dbgIdsMap = transCtx.annotationDebugMap.get(annotation);

const evtArgs: Expression[] = [...dbgIdsMap.values()].map((v) => v[1]);

if (!instrCtx.debugEventsDescMap.has(annot)) {
instrCtx.debugEventsDescMap.set(
annot,
[...dbgIdsMap.values()].map((v) => [v[0], v[2]])
);
}
// If there are no debug ids for the current annotation, there is no debug event to build
if (dbgIdsMap.size() == 0) {
return undefined;
}

// Finally construct the emit statement for the debug event.
if (instrCtx.assertionMode === "hardhat") {
const emitStmts: Statement[] = [];
const evtArgs: Expression[] = [...dbgIdsMap.values()].map((v) => v[1]);

const encoderVersion = inference.getUnitLevelAbiEncoderVersion(annot.target);
if (!instrCtx.debugEventsDescMap.has(annotation)) {
instrCtx.debugEventsDescMap.set(
annotation,
[...dbgIdsMap.values()].map((v) => [v[0], v[2]])
);
}

for (let expr of evtArgs) {
const exprT = inference.typeOf(expr);
// Finally construct the emit statement for the debug event.
if (instrCtx.assertionMode === "hardhat") {
const emitStmts: Statement[] = [];

let logFunc = getHardHatLogFuncName(exprT);
const encoderVersion = inference.getUnitLevelAbiEncoderVersion(annotation.target);

if (logFunc === undefined) {
assert(
inference.isABIEncodable(exprT, encoderVersion),
"Can not wrap {0} of type {1} with abi.encode() - type is not encodable",
expr,
exprT
);
for (let expr of evtArgs) {
const exprT = inference.typeOf(expr);

expr = factory.abiEncode(expr);
logFunc = "logBytes";
}
let logFunc = getHardHatLogFuncName(exprT);

emitStmts.push(
makeHardHatConsoleLogCall(instrCtx, annot, expr, logFunc),
makeHardHatConsoleLogCall(
instrCtx,
annot,
factory.makeLiteral("str", LiteralKind.String, "", print(expr))
)
if (logFunc === undefined) {
assert(
inference.isABIEncodable(exprT, encoderVersion),
"Can not wrap {0} of type {1} with abi.encode() - type is not encodable",
expr,
exprT
);
}

res.push(emitStmts.length === 0 ? undefined : emitStmts);
} else {
const assertionFailedDataExpr = gt(instrCtx.compilerVersion, "0.6.2")
? instrCtx.getAssertionFailedDataEvent(annot.target)
: instrCtx.getAssertionFailedDataFun(annot.target);

const emitStmt = makeEmitStmt(instrCtx, assertionFailedDataExpr, [
factory.makeLiteral("int", LiteralKind.Number, "", String(annot.id)),
factory.abiEncode(...evtArgs)
]);
expr = factory.abiEncode(expr);
logFunc = "logBytes";
}

res.push(emitStmt);
emitStmts.push(
makeHardHatConsoleLogCall(instrCtx, annotation, expr, logFunc),
makeHardHatConsoleLogCall(
instrCtx,
annotation,
factory.makeLiteral("str", LiteralKind.String, "", print(expr))
)
);
}

return emitStmts.length === 0 ? undefined : emitStmts;
}

return res;
const assertionFailedDataExpr = gt(instrCtx.compilerVersion, "0.6.2")
? instrCtx.getAssertionFailedDataEvent(annotation.target)
: instrCtx.getAssertionFailedDataFun(annotation.target);

const emitStmt = makeEmitStmt(instrCtx, assertionFailedDataExpr, [
factory.makeLiteral("int", LiteralKind.Number, "", String(annotation.id)),
factory.abiEncode(...evtArgs)
]);

return emitStmt;
}

function getBitPattern(factory: ASTNodeFactory, id: number): Literal {
Expand Down Expand Up @@ -491,119 +484,118 @@ export function insertAnnotations(
const factory = ctx.factory;
const contract = ctx.containerContract;
const instrCtx = ctx.instrCtx;
const predicates: Array<[PropertyMetaData | TryAnnotationMetaData, Expression | Expression[]]> =
[];

for (const annotation of annotations) {
predicates.push([annotation, transpileAnnotation(annotation, ctx)]);
}
// Re-sort the annotations so that #try and #require are always instrumented first.
// This makes sure they are hit before any old() statements in subsequent properties,
// that the fuzzer may get stuck on.
const isTryOrReq = (md: any) =>
md instanceof TryAnnotationMetaData ||
(md instanceof PropertyMetaData && md.type === AnnotationType.Require);

const sortedAnnotations = [
...annotations.filter((md) => isTryOrReq(md)),
...annotations.filter((md) => !isTryOrReq(md))
];

for (let i = 0; i < sortedAnnotations.length; i++) {
const annotation = sortedAnnotations[i];
const predicate = transpileAnnotation(annotation, ctx);

let check: Statement | Statement[];
let isOld: boolean;

// Note: we don't emit assertion failed debug events in mstore mode, as that
// defeats the purpose of mstore mode (to not emit additional events to
// preserve interface compatibility)
const emitStmt =
instrCtx.debugEvents && instrCtx.assertionMode !== "mstore"
? getDebugInfoEmit(annotation, ctx)
: undefined;

const targetIsStmt =
annotation.target instanceof Statement ||
annotation.target instanceof StatementWithChildren;

if (annotation.type === AnnotationType.Require) {
assert(
predicate instanceof Expression,
`Annotation type "${annotation.type}" expected single expression (got array)`
);

// Note: we don't emit assertion failed debug events in mstore mode, as that
// defeats the purpose of mstore mode (to not emit additional events to
// preserve interface compatibility)
const debugInfos =
instrCtx.debugEvents && instrCtx.assertionMode !== "mstore"
? getDebugInfoEmits(annotations, ctx)
: [];

const checkStmts: Array<[Statement | Statement[], boolean]> = predicates.map(
([annotation, predicate], i) => {
const emitStmt = debugInfos[i];
const targetIsStmt =
annotation.target instanceof Statement ||
annotation.target instanceof StatementWithChildren;

if (annotation.type === AnnotationType.Require) {
assert(
predicate instanceof Expression,
`Annotation type "${annotation.type}" expected single expression (got array)`
);
const reqStmt = factory.makeExpressionStatement(
factory.makeFunctionCall(
"<missing>",
FunctionCallKind.FunctionCall,
factory.makeIdentifier("<missing>", "require", -1),
[predicate]
)
);

const reqStmt = factory.makeExpressionStatement(
factory.makeFunctionCall(
"<missing>",
FunctionCallKind.FunctionCall,
factory.makeIdentifier("<missing>", "require", -1),
[predicate]
)
);
instrCtx.addAnnotationInstrumentation(annotation, reqStmt);
instrCtx.addAnnotationCheck(annotation, predicate);

instrCtx.addAnnotationInstrumentation(annotation, reqStmt);
instrCtx.addAnnotationCheck(annotation, predicate);
check = reqStmt;
isOld = !targetIsStmt;
} else if (annotation.type === AnnotationType.Try) {
assert(
predicate instanceof Array,
`Annotation type "${annotation.type}" expected array of expressions (got expression instance)`
);

return [reqStmt, !targetIsStmt];
if (!ctx.hasBinding(ctx.instrCtx.scratchField)) {
ctx.addBinding(
ctx.instrCtx.scratchField,
factory.makeElementaryTypeName("<missing>", "uint256")
);
}

if (annotation.type === AnnotationType.Try) {
assert(
predicate instanceof Array,
`Annotation type "${annotation.type}" expected array of expressions (got expression instance)`
check = predicate.map((expr) => {
const lhs = ctx.refBinding(ctx.instrCtx.scratchField);
const scratchAssign = factory.makeExpressionStatement(
factory.makeAssignment(
"<missing>",
"=",
lhs,
factory.makeLiteral("uint256", LiteralKind.Number, "", "42")
)
);

if (!ctx.hasBinding(ctx.instrCtx.scratchField)) {
ctx.addBinding(
ctx.instrCtx.scratchField,
factory.makeElementaryTypeName("<missing>", "uint256")
);
}

return [
predicate.map((expr) => {
const lhs = ctx.refBinding(ctx.instrCtx.scratchField);
const scratchAssign = factory.makeExpressionStatement(
factory.makeAssignment(
"<missing>",
"=",
lhs,
factory.makeLiteral("uint256", LiteralKind.Number, "", "42")
)
);

const stmt = factory.makeIfStatement(expr, scratchAssign);

instrCtx.addAnnotationInstrumentation(annotation, stmt);
instrCtx.addAnnotationCheck(annotation, expr);

return stmt;
}),
!targetIsStmt
];
}
const stmt = factory.makeIfStatement(expr, scratchAssign);

if (annotation.type === AnnotationType.LetAnnotation) {
assert(
predicate instanceof Expression,
`Annotation type "${annotation.type}" expected single expression (got array)`
);
instrCtx.addAnnotationInstrumentation(annotation, stmt);
instrCtx.addAnnotationCheck(annotation, expr);

const parsedAnnot = annotation.parsedAnnot as SLetAnnotation;
const name = ctx.getLetAnnotationBinding(parsedAnnot);
const stmt = factory.makeAssignment(
"<missing>",
"=",
ctx.refBinding(name),
predicate
);
return stmt;
});
isOld = !targetIsStmt;
} else if (annotation.type === AnnotationType.LetAnnotation) {
assert(
predicate instanceof Expression,
`Annotation type "${annotation.type}" expected single expression (got array)`
);

/// For now keep #let annotations as 'general' annotation, as to not
/// confuse consumers of the instrumentation metadata (they only
/// expect actual "check" annotations). This however is hacky.
/// TODO: Separate src mapping information for all annotations as a separate entity in metadata
instrCtx.addGeneralInstrumentation(stmt);
const parsedAnnot = annotation.parsedAnnot as SLetAnnotation;
const name = ctx.getLetAnnotationBinding(parsedAnnot);
const stmt = factory.makeAssignment("<missing>", "=", ctx.refBinding(name), predicate);

return [stmt, false];
}
/// For now keep #let annotations as 'general' annotation, as to not
/// confuse consumers of the instrumentation metadata (they only
/// expect actual "check" annotations). This however is hacky.
/// TODO: Separate src mapping information for all annotations as a separate entity in metadata
instrCtx.addGeneralInstrumentation(stmt);

check = stmt;
isOld = false;
} else {
assert(
predicate instanceof Expression,
`Annotation type "${annotation.type}" expected single expression (got array)`
);

return [emitAssert(ctx, predicate, annotation, contract, emitStmt), false];
check = emitAssert(ctx, predicate, annotation, contract, emitStmt);
isOld = false;
}
);

for (const [check, isOld] of checkStmts) {
if (check instanceof Array) {
for (const stmt of check) {
ctx.insertStatement(stmt, isOld);
Expand Down
Loading