Skip to content

Commit ec231a2

Browse files
cgeweckecgewecke
committed
Instrument with injected function calls (#381)
1 parent d9353b6 commit ec231a2

File tree

7 files changed

+118
-75
lines changed

7 files changed

+118
-75
lines changed

‎lib/collector.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class DataCollector {
99
const self = this;
1010
if (typeof info !== 'object' || !info.opcode ) return;
1111

12-
if (info.opcode.name.includes("PUSH") && info.stack.length > 0){
12+
if (info.opcode.name.includes("PUSH1") && info.stack.length > 0){
1313
const idx = info.stack.length - 1;
1414
let hash = web3Utils.toHex(info.stack[idx]).toString();
1515
hash = self._normalizeHash(hash);

‎lib/injector.js‎

Lines changed: 76 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,65 @@
1-
const sha1 = require("sha1");
21
const web3Utils = require("web3-utils");
32

43
class Injector {
54
constructor(){
65
this.hashCounter = 0;
7-
this.definitionCounter = 0;
86
}
97

10-
/**
11-
* Generates solidity statement to inject for line, stmt, branch, fn 'events'
12-
* @param {String} memoryVariable
13-
* @param {String} hash hash key to an instrumentationData entry (see _getHash)
14-
* @param {String} type instrumentation type, e.g. line, statement
15-
// @return {String} ex: _sc_82e0891[0] = bytes32(0xdc08...08ed1); /* function */
16-
_getInjectable(memoryVariable, hash, type){
17-
return `${memoryVariable}[0] = bytes32(${hash}); /* ${type} */ \n`;
8+
_split(contract, injectionPoint){
9+
return {
10+
start: contract.instrumented.slice(0, injectionPoint),
11+
end: contract.instrumented.slice(injectionPoint)
12+
}
13+
}
14+
15+
_getInjectable(fileName, hash, type){
16+
return `${this._getMethodIdentifier(fileName)}(${hash}); /* ${type} */ \n`;
1817
}
1918

2019
_getHash(fileName) {
2120
this.hashCounter++;
2221
return web3Utils.keccak256(`${fileName}:${this.hashCounter}`);
2322
}
2423

24+
_getMethodIdentifier(fileName){
25+
return `coverage_${web3Utils.keccak256(fileName).slice(0,10)}`
26+
}
27+
28+
_getInjectionComponents(contract, injectionPoint, fileName, type){
29+
const { start, end } = this._split(contract, injectionPoint);
30+
const hash = this._getHash(fileName)
31+
const injectable = this._getInjectable(fileName, hash, type);
32+
33+
return {
34+
start: start,
35+
end: end,
36+
hash: hash,
37+
injectable: injectable
38+
}
39+
}
40+
2541
/**
2642
* Generates a solidity statement injection. Declared once per fn.
2743
* Definition is the same for every fn in file.
2844
* @param {String} fileName
2945
* @return {String} ex: bytes32[1] memory _sc_82e0891
3046
*/
31-
_getMemoryVariableDefinition(fileName){
32-
this.definitionCounter++;
33-
return `\nbytes32[1] memory _sc_${sha1(fileName).slice(0,7)};\n`;
34-
}
35-
36-
_getMemoryVariableAssignment(fileName){
37-
return `\n_sc_${sha1(fileName).slice(0,7)}`;
47+
_getHashMethodDefinition(fileName){
48+
const hash = web3Utils.keccak256(fileName).slice(0,10);
49+
const method = this._getMethodIdentifier(fileName);
50+
return `\nfunction ${method}(bytes32 c__${hash}) public pure {}\n`;
3851
}
3952

40-
4153
injectLine(contract, fileName, injectionPoint, injection, instrumentation){
4254
const type = 'line';
43-
const start = contract.instrumented.slice(0, injectionPoint);
44-
const end = contract.instrumented.slice(injectionPoint);
55+
const { start, end } = this._split(contract, injectionPoint);
4556

4657
const newLines = start.match(/\n/g);
4758
const linecount = ( newLines || []).length + 1;
4859
contract.runnableLines.push(linecount);
4960

50-
const hash = this._getHash(fileName);
51-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
52-
const injectable = this._getInjectable(memoryVariable, hash , type)
61+
const hash = this._getHash(fileName)
62+
const injectable = this._getInjectable(fileName, hash, type);
5363

5464
instrumentation[hash] = {
5565
id: linecount,
@@ -63,12 +73,13 @@ class Injector {
6373

6474
injectStatement(contract, fileName, injectionPoint, injection, instrumentation) {
6575
const type = 'statement';
66-
const start = contract.instrumented.slice(0, injectionPoint);
67-
const end = contract.instrumented.slice(injectionPoint);
6876

69-
const hash = this._getHash(fileName);
70-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
71-
const injectable = this._getInjectable(memoryVariable, hash, type)
77+
const {
78+
start,
79+
end,
80+
hash,
81+
injectable
82+
} = this._getInjectionComponents(contract, injectionPoint, fileName, type);
7283

7384
instrumentation[hash] = {
7485
id: injection.statementId,
@@ -82,13 +93,13 @@ class Injector {
8293

8394
injectFunction(contract, fileName, injectionPoint, injection, instrumentation){
8495
const type = 'function';
85-
const start = contract.instrumented.slice(0, injectionPoint);
86-
const end = contract.instrumented.slice(injectionPoint);
8796

88-
const hash = this._getHash(fileName);
89-
const memoryVariableDefinition = this._getMemoryVariableDefinition(fileName);
90-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
91-
const injectable = this._getInjectable(memoryVariable, hash, type);
97+
const {
98+
start,
99+
end,
100+
hash,
101+
injectable
102+
} = this._getInjectionComponents(contract, injectionPoint, fileName, type);
92103

93104
instrumentation[hash] = {
94105
id: injection.fnId,
@@ -97,17 +108,18 @@ class Injector {
97108
hits: 0
98109
}
99110

100-
contract.instrumented = `${start}${memoryVariableDefinition}${injectable}${end}`;
111+
contract.instrumented = `${start}${injectable}${end}`;
101112
}
102113

103114
injectBranch(contract, fileName, injectionPoint, injection, instrumentation){
104115
const type = 'branch';
105-
const start = contract.instrumented.slice(0, injectionPoint);
106-
const end = contract.instrumented.slice(injectionPoint);
107116

108-
const hash = this._getHash(fileName);
109-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
110-
const injectable = this._getInjectable(memoryVariable, hash, type);
117+
const {
118+
start,
119+
end,
120+
hash,
121+
injectable
122+
} = this._getInjectionComponents(contract, injectionPoint, fileName, type);
111123

112124
instrumentation[hash] = {
113125
id: injection.branchId,
@@ -122,12 +134,13 @@ class Injector {
122134

123135
injectEmptyBranch(contract, fileName, injectionPoint, injection, instrumentation) {
124136
const type = 'branch';
125-
const start = contract.instrumented.slice(0, injectionPoint);
126-
const end = contract.instrumented.slice(injectionPoint);
127137

128-
const hash = this._getHash(fileName);
129-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
130-
const injectable = this._getInjectable(memoryVariable, hash, type);
138+
const {
139+
start,
140+
end,
141+
hash,
142+
injectable
143+
} = this._getInjectionComponents(contract, injectionPoint, fileName, type);
131144

132145
instrumentation[hash] = {
133146
id: injection.branchId,
@@ -142,12 +155,13 @@ class Injector {
142155

143156
injectAssertPre(contract, fileName, injectionPoint, injection, instrumentation) {
144157
const type = 'assertPre';
145-
const start = contract.instrumented.slice(0, injectionPoint);
146-
const end = contract.instrumented.slice(injectionPoint);
147158

148-
const hash = this._getHash(fileName);
149-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
150-
const injectable = this._getInjectable(memoryVariable, hash, type);
159+
const {
160+
start,
161+
end,
162+
hash,
163+
injectable
164+
} = this._getInjectionComponents(contract, injectionPoint, fileName, type);
151165

152166
instrumentation[hash] = {
153167
id: injection.branchId,
@@ -161,12 +175,13 @@ class Injector {
161175

162176
injectAssertPost(contract, fileName, injectionPoint, injection, instrumentation) {
163177
const type = 'assertPost';
164-
const start = contract.instrumented.slice(0, injectionPoint);
165-
const end = contract.instrumented.slice(injectionPoint);
166178

167-
const hash = this._getHash(fileName);
168-
const memoryVariable = this._getMemoryVariableAssignment(fileName);
169-
const injectable = this._getInjectable(memoryVariable, hash, type);
179+
const {
180+
start,
181+
end,
182+
hash,
183+
injectable
184+
} = this._getInjectionComponents(contract, injectionPoint, fileName, type);
170185

171186
instrumentation[hash] = {
172187
id: injection.branchId,
@@ -177,6 +192,12 @@ class Injector {
177192

178193
contract.instrumented = `${start}${injectable}${end}`;
179194
}
195+
196+
injectHashMethod(contract, fileName, injectionPoint, injection, instrumentation){
197+
const start = contract.instrumented.slice(0, injectionPoint);
198+
const end = contract.instrumented.slice(injectionPoint);
199+
contract.instrumented = `${start}${this._getHashMethodDefinition(fileName)}${end}`;
200+
}
180201
};
181202

182203
module.exports = Injector;

‎lib/parse.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ parse.ContractDefinition = function(contract, expression) {
5151
};
5252

5353
parse.ContractOrLibraryStatement = function(contract, expression) {
54+
// We need to define a method to pass coverage hashes into at top of each contract.
55+
// This lets us get a fresh stack for the hash and avoid stack-too-deep errors.
56+
const start = expression.range[0];
57+
const end = contract.instrumented.slice(expression.range[0]).indexOf('{') + 1;
58+
const loc = start + end;;
59+
60+
(contract.injectionPoints[loc])
61+
? contract.injectionPoints[loc].push({ type: 'injectHashMethod'})
62+
: contract.injectionPoints[loc] = [{ type: 'injectHashMethod'}];
63+
5464
if (expression.subNodes) {
5565
expression.subNodes.forEach(construct => {
5666
parse[construct.type] &&

‎package.json‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
"istanbul": "^0.4.5",
2828
"node-dir": "^0.1.17",
2929
"req-cwd": "^1.0.1",
30-
"sha1": "^1.1.1",
3130
"shelljs": "^0.8.3",
3231
"solidity-parser-antlr": "^0.4.7",
3332
"web3": "1.2.1",

‎test/sources/solidity/contracts/statements/stack-too-deep.sol‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
pragma solidity ^0.5.0;
2+
3+
contract Test {
4+
// 15 fn args + 1 local variable assignment
5+
// will normally compile w/out stack too deep
6+
// error.
7+
function a(
8+
uint _a,
9+
uint _b,
10+
uint _c,
11+
uint _d,
12+
uint _e,
13+
uint _f,
14+
uint _g,
15+
uint _h,
16+
uint _i,
17+
uint _j,
18+
uint _k,
19+
uint _l,
20+
uint _m,
21+
uint _n,
22+
uint _o
23+
) public {
24+
uint x = _a;
25+
}
26+
}

‎test/units/statements.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ describe('generic statements', () => {
4848
util.report(info.solcOutput.errors);
4949
});
5050

51+
it('should instrument without triggering stack-too-deep', () => {
52+
const info = util.instrumentAndCompile('statements/stack-too-deep');
53+
util.report(info.solcOutput.errors);
54+
});
55+
5156
it('should NOT pass tests if the contract has a compilation error', () => {
5257
const info = util.instrumentAndCompile('app/SimpleError');
5358
try {

‎yarn.lock‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1614,11 +1614,6 @@ chalk@^2.0.0, chalk@^2.0.1, chalk@^2.4.2:
16141614
escape-string-regexp "^1.0.5"
16151615
supports-color "^5.3.0"
16161616

1617-
"charenc@>= 0.0.1":
1618-
version "0.0.2"
1619-
resolved "https://registry.yarnpkg.com/charenc/-/charenc-0.0.2.tgz#c0a1d2f3a7092e03774bfa83f14c0fc5790a8667"
1620-
integrity sha1-wKHS86cJLgN3S/qD8UwPxXkKhmc=
1621-
16221617
check-error@^1.0.2:
16231618
version "1.0.2"
16241619
resolved "https://registry.yarnpkg.com/check-error/-/check-error-1.0.2.tgz#574d312edd88bb5dd8912e9286dd6c0aed4aac82"
@@ -2028,11 +2023,6 @@ cross-spawn@^5.0.1:
20282023
shebang-command "^1.2.0"
20292024
which "^1.2.9"
20302025

2031-
"crypt@>= 0.0.1":
2032-
version "0.0.2"
2033-
resolved "https://registry.yarnpkg.com/crypt/-/crypt-0.0.2.tgz#88d7ff7ec0dfb86f713dc87bbb42d044d3e6c41b"
2034-
integrity sha1-iNf/fsDfuG9xPch7u0LQRNPmxBs=
2035-
20362026
[email protected]:
20372027
version "3.12.0"
20382028
resolved "https://registry.yarnpkg.com/crypto-browserify/-/crypto-browserify-3.12.0.tgz#396cf9f3137f03e4b8e532c58f698254e00f80ec"
@@ -7379,14 +7369,6 @@ sha.js@^2.4.0, sha.js@^2.4.8:
73797369
inherits "^2.0.1"
73807370
safe-buffer "^5.0.1"
73817371

7382-
sha1@^1.1.1:
7383-
version "1.1.1"
7384-
resolved "https://registry.yarnpkg.com/sha1/-/sha1-1.1.1.tgz#addaa7a93168f393f19eb2b15091618e2700f848"
7385-
integrity sha1-rdqnqTFo85PxnrKxUJFhjicA+Eg=
7386-
dependencies:
7387-
charenc ">= 0.0.1"
7388-
crypt ">= 0.0.1"
7389-
73907372
sha3@^1.2.2:
73917373
version "1.2.3"
73927374
resolved "https://registry.yarnpkg.com/sha3/-/sha3-1.2.3.tgz#ed5958fa8331df1b1b8529ca9fdf225a340c5418"

0 commit comments

Comments
 (0)