1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
// Copyright (c) 2023, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
import {OptPipelineResults, Pass} from '../../types/compilation/opt-pipeline-output.interfaces.js';
import {ResultLine} from '../../types/resultline/resultline.interfaces.js';
import {assert} from '../assert.js';
import {logger} from '../logger.js';
type PassDump = {
name: string;
lines: ResultLine[];
};
// Checks that the pairing of (before) and (after) passes is correct.
function passesMatch(before: string, after: string) {
assert(before.endsWith(' (before)'));
assert(after.endsWith(' (after)'));
before = before.slice(0, before.length - ' (before)'.length);
after = after.slice(0, after.length - ' (after)'.length);
return before === after;
}
export class Dex2OatPassDumpParser {
nameRegex: RegExp;
constructor() {
this.nameRegex = /^\s*name\s+"(.*)"\s*$/;
}
// Parses the lines from the classes.cfg file and returns a mapping of
// function names to per-function optimization pass dumps.
parsePassDumpsForFunctions(ir: string[]) {
const functionsToPassDumps: Record<string, PassDump[]> = {};
let functionName;
let passName;
let inFunctionHeader = false;
let inOptPass = false;
let inBlock = false;
let match;
for (const l of ir) {
if (l.match('begin_compilation')) {
inFunctionHeader = true;
} else if (l.match('end_compilation')) {
inFunctionHeader = false;
} else if (l.match('begin_cfg')) {
inOptPass = true;
} else if (l.match('end_cfg')) {
inOptPass = false;
} else {
if (l.match('begin_block')) {
inBlock = true;
} else if (l.match('end_block')) {
inBlock = false;
}
if (inFunctionHeader && this.nameRegex.test(l)) {
match = l.match(this.nameRegex);
functionName = match[1];
functionsToPassDumps[functionName] = [];
} else if (inOptPass && !inBlock && this.nameRegex.test(l)) {
// We check !inBlock because blocks also contain a name
// field that will match nameRegex.
match = l.match(this.nameRegex);
passName = match[1];
functionsToPassDumps[functionName].push({name: passName, lines: []});
} else if (inOptPass) {
const passDump = functionsToPassDumps[functionName].pop();
// pop() can return undefined, but we know that it won't
// because if we're in an opt pass, the previous case should
// have been met already.
if (passDump) {
passDump.lines.push({text: l});
functionsToPassDumps[functionName].push(passDump);
} else {
logger.error(`passDump for function ${functionName} is undefined!`);
}
}
}
}
return functionsToPassDumps;
}
// This method merges each function's (before) and (after) optimization
// passes' text into a series of Pass objects.
// This method was adapted from llvm-pass-dump-parser.ts.
mergeBeforeAfterPassDumps(functionsToPassDumps: Record<string, PassDump[]>) {
const finalOutput: OptPipelineResults = {};
for (const [functionName, passDumps] of Object.entries(functionsToPassDumps)) {
const passes: Pass[] = [];
for (let i = 0; i < passDumps.length; ) {
const pass: Pass = {
name: '',
machine: false,
before: [],
after: [],
irChanged: true,
};
const currentDump = passDumps[i];
const nextDump = i < passDumps.length - 1 ? passDumps[i + 1] : null;
if (currentDump.name.endsWith(' (after)')) {
pass.name = currentDump.name.slice(0, currentDump.name.length - ' (after)'.length);
pass.after = currentDump.lines;
i++;
} else if (currentDump.name.endsWith(' (before)')) {
if (nextDump !== null && nextDump.name.endsWith(' (after)')) {
assert(passesMatch(currentDump.name, nextDump.name), '', currentDump.name, nextDump.name);
pass.name = currentDump.name.slice(0, currentDump.name.length - ' (before)'.length);
pass.before = currentDump.lines;
pass.after = nextDump.lines;
i += 2;
} else {
pass.name = currentDump.name.slice(0, currentDump.name.length - ' (before)'.length);
pass.before = currentDump.lines;
i++;
}
} else {
assert(false, 'Unexpected pass name', currentDump.name);
}
pass.irChanged = pass.before.map(x => x.text).join('\n') !== pass.after.map(x => x.text).join('\n');
passes.push(pass);
}
finalOutput[functionName] = passes;
}
return finalOutput;
}
process(rawText: string): OptPipelineResults {
const lines = rawText.split(/\n/);
// Remove leading [begin|end]_compilation section, as it doesn't correspond to any methods.
const ir = lines.slice(lines.findIndex(l => l.match('end_compilation')) + 1);
const functionsToPassDumps = this.parsePassDumpsForFunctions(ir);
return this.mergeBeforeAfterPassDumps(functionsToPassDumps);
}
}
|
