-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathllvm-ir.ts
289 lines (258 loc) · 10.5 KB
/
llvm-ir.ts
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
// Copyright (c) 2018, 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
10000
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 {isString} from '../shared/common-utils.js';
import type {IRResultLine, ParsedAsmResult} from '../types/asmresult/asmresult.interfaces.js';
import {LLVMIrBackendOptions} from '../types/compilation/ir.interfaces.js';
import {ParseFiltersAndOutputOptions} from '../types/features/filters.interfaces.js';
import {LLVMIRDemangler} from './demangler/llvm.js';
import {PropertyGetter} from './properties.interfaces.js';
import * as utils from './utils.js';
type MetaNode = {
[key: string]: string | number | undefined;
metaId: string;
metaType: string;
file?: string;
filename?: string;
line?: number;
column?: number;
scope?: string;
};
export class LlvmIrParser {
private maxIrLines: number;
private debugReference: RegExp;
private metaNodeRe: RegExp;
private otherMetaDirective: RegExp;
private namedMetaDirective: RegExp;
private metaNodeOptionsRe: RegExp;
private llvmDebugIntrinsicLine: RegExp;
private llvmDebugRecordLine: RegExp;
private llvmDebugAnnotation: RegExp;
private otherMetadataAnnotation: RegExp;
private attributeAnnotation: RegExp;
private attributeDirective: RegExp;
private moduleMetadata: RegExp;
private functionAttrs: RegExp;
private commentOnly: RegExp;
private commentAtEOL: RegExp;
constructor(
compilerProps: PropertyGetter,
private readonly irDemangler: LLVMIRDemangler,
) {
this.maxIrLines = 5000;
if (compilerProps) {
this.maxIrLines = compilerProps('maxLinesOfAsm', this.maxIrLines);
}
this.debugReference = /!dbg (!\d+)/;
this.metaNodeRe = /^(!\d+) = (?:distinct )?!DI([A-Za-z]+)\(([^)]+?)\)/;
this.otherMetaDirective = /^(!\d+) = (?:distinct )?!{.*}/;
this.namedMetaDirective = /^(![.A-Z_a-z-]+) = (?:distinct )?!{.*}/;
this.metaNodeOptionsRe = /(\w+): (!?\d+|\w+|""|"(?:[^"]|\\")*[^\\]")/gi;
this.llvmDebugIntrinsicLine = /^\s*(tail\s)?call void @llvm\.dbg\..*$/;
this.llvmDebugRecordLine = /^\s*#dbg_.*$/;
this.llvmDebugAnnotation = /,? !dbg !\d+/;
this.otherMetadataAnnotation = /,? !(?!dbg)[\w.]+ (!\d+)/;
this.attributeAnnotation = /,? #\d+(?= )/;
this.attributeDirective = /^attributes #\d+ = { .+ }$/;
this.functionAttrs = /^; Function Attrs: .+$/;
this.moduleMetadata = /^((source_filename|target datalayout|target triple) = ".+"|; ModuleID = '.+')$/;
this.commentOnly = /^\s*;.*$/;
// Issue #5923: make sure the comment mark `;` is outside quotes
this.commentAtEOL = /\s*;(?=(?:[^"]|"[^"]*")*$).*$/;
}
getFileName(debugInfo: Record<string, MetaNode>, scope: string): string | null {
const stdInLooking = /.*<stdin>|^-$|example\.[^/]+$|<source>/;
if (!debugInfo[scope]) {
// No such meta info.
return null;
}
// MetaInfo is a file node
if (debugInfo[scope].filename) {
const filename = debugInfo[scope].filename;
return stdInLooking.test(filename!) ? null : filename!;
}
// MetaInfo has a file reference.
if (debugInfo[scope].file) {
return this.getFileName(debugInfo, debugInfo[scope].file!);
}
if (!debugInfo[scope].scope) {
// No higher scope => can't find file.
return null;
}
// "Bubbling" up.
return this.getFileName(debugInfo, debugInfo[scope].scope!);
}
getSourceLineNumber(debugInfo: Record<string, MetaNode>, scope: string): number | null {
if (!debugInfo[scope]) {
return null;
}
if (debugInfo[scope].line) {
return Number(debugInfo[scope].line);
}
if (debugInfo[scope].scope) {
return this.getSourceLineNumber(debugInfo, debugInfo[scope].scope!);
}
return null;
}
getSourceColumn(debugInfo: Record<string, MetaNode>, scope: string): number | undefined {
if (!debugInfo[scope]) {
return;
}
if (debugInfo[scope].column) {
return Number(debugInfo[scope].column);
}
if (debugInfo[scope].scope) {
return this.getSourceColumn(debugInfo, debugInfo[scope].scope!);
}
}
parseMetaNode(line: string): MetaNode | null {
// Metadata Nodes
// See: https://llvm.org/docs/LangRef.html#metadata
const match = line.match(this.metaNodeRe);
if (!match) {
return null;
}
const metaNode: MetaNode = {
metaId: match[1],
metaType: match[2],
};
let keyValuePair;
while ((keyValuePair = this.metaNodeOptionsRe.exec(match[3]))) {
const key = keyValuePair[1];
let val = keyValuePair[2];
// Remove "" from string
if (isString(val) && val[0] === '"') {
val = val.substring(1, val.length - 1);
}
metaNode[key] = val;
}
return metaNode;
}
async processIr(ir: string, options: LLVMIrBackendOptions) {
const result: IRResultLine[] = [];
const irLines = utils.splitLines(ir);
const debugInfo: Record<string, MetaNode> = {};
// Set to true initially to prevent any leading newlines as a result of filtering
let prevLineEmpty = true;
const filters: RegExp[] = [];
const lineFilters: RegExp[] = [];
if (options.filterDebugInfo) {
filters.push(this.llvmDebugIntrinsicLine, this.llvmDebugRecordLine);
lineFilters.push(this.llvmDebugAnnotation);
}
if (options.filterIRMetadata) {
filters.push(this.moduleMetadata, this.metaNodeRe, this.otherMetaDirective, this.namedMetaDirective);
lineFilters.push(this.otherMetadataAnnotation);
}
if (options.filterAttributes) {
filters.push(this.attributeDirective, this.functionAttrs);
lineFilters.push(this.attributeAnnotation);
}
if (options.filterComments) {
filters.push(this.commentOnly);
lineFilters.push(this.commentAtEOL);
}
for (const line of irLines) {
if (line.trim().length === 0) {
// Avoid multiple successive empty lines.
if (!prevLineEmpty) {
result.push({text: ''});
}
prevLineEmpty = true;
} else {
let newLine = line;
while (true) {
const temp = newLine;
for (const re of lineFilters) {
newLine = newLine.replace(re, '');
}
if (newLine === temp) {
break;
}
}
const resultLine: IRResultLine = {
text: newLine,
};
// Non-Meta IR line. Metadata is attached to it using "!dbg !123"
const debugReferenceMatch = line.match(this.debugReference);
if (debugReferenceMatch) {
resultLine.scope = debugReferenceMatch[1];
}
const metaNode = this.parseMetaNode(line);
if (metaNode) {
debugInfo[metaNode.metaId] = metaNode;
}
// Filtering a full line
if (filters.some(re => line.match(re))) {
continue;
}
result.push(resultLine);
prevLineEmpty = false;
}
}
if (result.length >= this.maxIrLines) {
result.length = this.maxIrLines + 1;
result[this.maxIrLines] = {text: '[truncated; too many lines]'};
}
for (const line of result) {
if (!line.scope) continue;
line.source = {
file: this.getFileName(debugInfo, line.scope),
line: this.getSourceLineNumber(debugInfo, line.scope),
column: this.getSourceColumn(debugInfo, line.scope),
};
}
if (options.demangle && this.irDemangler.canDemangle()) {
const demangled = await this.irDemangler.process({asm: result});
return {
asm: demangled.asm,
languageId: 'llvm-ir',
};
}
return {
asm: result,
languageId: 'llvm-ir',
};
}
async processFromFilters(ir: string, filters: ParseFiltersAndOutputOptions): Promise<ParsedAsmResult> {
if (isString(ir)) {
return await this.processIr(ir, {
filterDebugInfo: !!filters.debugCalls,
filterIRMetadata: !!filters.directives,
filterAttributes: false,
filterComments: !!filters.commentOnly,
demangle: !!filters.demangle,
// discard value names is handled earlier
});
}
return {
asm: [],
};
}
async process(ir: string, irOptions: LLVMIrBackendOptions) {
return await this.processIr(ir, irOptions);
}
isLlvmIr(code: string) {
return code.includes('@llvm') && code.includes('!DI') && code.includes('!dbg');
}
}