-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathcompiler-finder.ts
More file actions
621 lines (580 loc) · 27.8 KB
/
compiler-finder.ts
File metadata and controls
621 lines (580 loc) · 27.8 KB
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
// 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 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 fs from 'node:fs';
import http from 'node:http';
import https from 'node:https';
import path from 'node:path';
import {promisify} from 'node:util';
import _ from 'underscore';
import urljoin from 'url-join';
import {basic_comparator, remove} from '../shared/common-utils.js';
import type {CompilerInfo, PreliminaryCompilerInfo} from '../types/compiler.interfaces.js';
import {InstructionSet, InstructionSetsList} from '../types/instructionsets.js';
import type {Language, LanguageKey} from '../types/languages.interfaces.js';
import {Tool, ToolInfo} from '../types/tool.interfaces.js';
import {AppArguments} from './app.interfaces.js';
import {assert, unwrap, unwrapString} from './assert.js';
import {CompileHandler} from './handlers/compile.js';
import {logger} from './logger.js';
import {ClientOptionsHandler} from './options-handler.js';
import type {PropertyGetter} from './properties.interfaces.js';
import {CompilerProps, getRawProperties} from './properties.js';
import {getPossibleGccToolchainsFromCompilerInfo} from './toolchain-utils.js';
const sleep = promisify(setTimeout);
/***
* Finds and initializes the compilers stored on the properties files
*/
export class CompilerFinder {
compilerProps: CompilerProps['get'];
ceProps: PropertyGetter;
args: AppArguments;
compileHandler: CompileHandler;
languages: Record<string, Language>;
optionsHandler: ClientOptionsHandler;
constructor(
compileHandler: CompileHandler,
compilerProps: CompilerProps,
args: AppArguments,
optionsHandler: ClientOptionsHandler,
) {
this.compilerProps = compilerProps.get.bind(compilerProps);
this.ceProps = compilerProps.ceProps;
this.args = args;
this.compileHandler = compileHandler;
this.languages = compilerProps.languages;
this.optionsHandler = optionsHandler;
}
static prepareRemoteUrlParts(host: string, port: number, uriBase: string, langId: string | null) {
const uriSchema = port === 443 ? 'https' : 'http';
return {
uriSchema: uriSchema,
uri: urljoin(`${uriSchema}://${host}:${port}`, uriBase),
apiPath: urljoin('/', uriBase || '', 'api/compilers', langId || '', '?fields=all'),
};
}
static getRemoteInfo(uriSchema: string, host: string, port: number, uriBase: string, compilerId: string) {
return {
target: `${uriSchema}://${host}:${port}`,
path: urljoin('/', uriBase, 'api/compiler', compilerId, 'compile'),
cmakePath: urljoin('/', uriBase, 'api/compiler', compilerId, 'cmake'),
basePath: urljoin('/', uriBase),
};
}
async fetchRemote(
host: string,
port: number,
uriBase: string,
props: PropertyGetter,
langId: string | null,
): Promise<CompilerInfo[] | null> {
const requestLib = port === 443 ? https : http;
const {uriSchema, uri, apiPath} = CompilerFinder.prepareRemoteUrlParts(host, port, uriBase, langId);
logger.info(`Fetching compilers from remote source ${uri}`);
return this.retryPromise(
() => {
return new Promise<CompilerInfo[]>((resolve, reject) => {
const request = requestLib
.get(
{
hostname: host,
port: port,
path: apiPath,
headers: {
Accept: 'application/json',
},
},
res => {
let error;
const {
statusCode,
headers: {'content-type': contentType},
} = res;
if (statusCode !== 200) {
error = new Error(
'Failed fetching remote compilers from ' +
`${uriSchema}://${host}:${port}${apiPath}\n` +
`Status Code: ${statusCode}`,
);
} else if (!contentType || !/^application\/json/.test(contentType)) {
error = new Error(
'Invalid content-type.\n' +
`Expected application/json but received ${contentType}`,
);
}
if (error) {
logger.error(error.message);
// consume response data to free up memory
res.resume();
reject(error);
return;
}
let str = '';
res.on('data', chunk => {
str += chunk;
});
res.on('end', () => {
try {
const compilers = (JSON.parse(str) as CompilerInfo[]).map(compiler => {
compiler.exe = '/dev/null';
compiler.remote = CompilerFinder.getRemoteInfo(
uriSchema,
host,
port,
uriBase,
compiler.id,
);
return compiler;
});
resolve(compilers);
} catch (e: any) {
logger.error(`Error parsing response from ${uri} '${str}': ${e.message}`);
reject(e);
}
});
},
)
.on('error', reject)
.on('timeout', () => reject('timeout'));
request.setTimeout(this.ceProps('proxyTimeout', 1000));
});
},
`${host}:${port}`,
props('proxyRetries', 5),
props('proxyRetryMs', 500),
).catch(() => {
logger.warn(`Unable to contact ${host}:${port}; skipping`);
return [];
});
}
async compilerConfigFor(
langId: string,
compilerId: string,
parentProps: CompilerProps['get'],
): Promise<PreliminaryCompilerInfo | null> {
const base = `compiler.${compilerId}.`;
const props: PropertyGetter = (propName: string, defaultValue?: any) => {
const propsForCompiler = parentProps(langId, base + propName);
if (propsForCompiler !== undefined) return propsForCompiler;
return parentProps(langId, propName, defaultValue);
};
const splitArrayProps = (propName: string, split: string) => {
return props<string | undefined>(propName)?.split(split);
};
const splitArrayPropsOrEmpty = (propName: string, split: string) => {
const value = props<string>(propName, '');
return value === '' ? [] : value.split(split);
};
const ceToolsPath = props('ceToolsPath', './');
const supportsBinary = !!props('supportsBinary', true);
const supportsBinaryObject = !!props('supportsBinaryObject', false);
const emulated = !!props('emulated', false);
const interpreted = !!props('interpreted', false);
const supportsExecute = (interpreted || supportsBinary) && !!props('supportsExecute', true);
const executionWrapper = props('executionWrapper', '');
const executionWrapperArgs = splitArrayPropsOrEmpty('executionWrapperArgs', '|');
const supportsLibraryCodeFilter = !!props('supportsLibraryCodeFilter', true);
const group = props('group', '');
const demanglerProp = props('demangler', '');
// biome-ignore lint/suspicious/noTemplateCurlyInString: This is an intentional placeholder replaced at runtime
const demangler = demanglerProp ? path.normalize(demanglerProp.replace('${ceToolsPath}', ceToolsPath)) : '';
const isSemVer = props('isSemVer', false);
const baseName = props<string | undefined>('baseName');
const semverVer = props('semver', '');
const name = props<string>('name');
// If name set, display that as the name
// If not, check if we have a baseName + semver and display that
// Else display compilerId as its name
const displayName =
name === undefined ? (isSemVer && baseName ? `${baseName} ${semverVer}` : compilerId) : name;
const baseOptions = props('baseOptions', '');
const options = props('options', '');
const actualOptions = [baseOptions, options].filter(x => x.length > 0).join(' ');
const envVars = (() => {
const envVarsString = props('envVars', '');
if (envVarsString === '') {
return [];
}
const arr: [string, string][] = [];
for (const el of envVarsString.split(':')) {
const [env, setting] = el.split('=');
arr.push([env, setting]);
}
return arr;
})();
const exe = props('exe', compilerId);
const exePath = path.dirname(exe);
const instructionSet = props<string | number>('instructionSet', '').toString() as InstructionSet | '';
assert(
instructionSet === '' || InstructionSetsList.includes(instructionSet),
`Unexpected instruction set ${instructionSet} ${compilerId}`,
);
const compilerInfo: PreliminaryCompilerInfo = {
id: compilerId,
exe: exe,
name: displayName,
alias: props('alias', '')
.split(':')
.filter(a => a !== ''),
options: actualOptions,
versionFlag: splitArrayProps('versionFlag', '|'),
versionRe: props<string>('versionRe'),
explicitVersion: props<string>('explicitVersion'),
compilerType: props('compilerType', ''),
compilerCategories: splitArrayPropsOrEmpty('compilerCategories', ':'),
debugPatched: props('debugPatched', false),
demangler: demangler,
demanglerType: props('demanglerType', ''),
demanglerArgs: splitArrayPropsOrEmpty('demanglerArgs', '|'),
nvdisasm: props('nvdisasm', ''),
objdumper: props('objdumper', ''),
objdumperType: props('objdumperType', ''),
objdumperArgs: splitArrayPropsOrEmpty('objdumperArgs', '|'),
llvmObjdumper: props('llvmObjdumper', ''),
intelAsm: props('intelAsm', ''),
supportsAsmDocs: props('supportsAsmDocs', true),
instructionSet: instructionSet === '' ? null : instructionSet,
needsMulti: !!props('needsMulti', true),
adarts: props('adarts', ''),
supportsDemangle: !!demangler,
supportsBinary,
supportsBinaryObject,
emulated,
interpreted,
supportsExecute,
executionWrapper,
executionWrapperArgs,
supportsLibraryCodeFilter: supportsLibraryCodeFilter,
postProcess: splitArrayPropsOrEmpty('postProcess', '|'),
lang: langId as LanguageKey,
group: group,
groupName: props('groupName', ''),
includeFlag: props('includeFlag', '-isystem'),
includePath: props('includePath', ''),
linkFlag: props('linkFlag', '-l'),
rpathFlag: props('rpathFlag', '-Wl,-rpath,'),
libpathFlag: props('libpathFlag', '-L'),
libPath: props('libPath', '')
.split(path.delimiter)
.filter(p => p !== '')
// biome-ignore lint/suspicious/noTemplateCurlyInString: This is an intentional placeholder replaced at runtime
.map(x => path.normalize(x.replace('${exePath}', exePath))),
ldPath: props('ldPath', '')
.split('|')
// biome-ignore lint/suspicious/noTemplateCurlyInString: This is an intentional placeholder replaced at runtime
.map(x => path.normalize(x.replace('${exePath}', exePath))),
extraPath: props('extraPath', '')
.split(path.delimiter)
.filter(p => p !== '')
// biome-ignore lint/suspicious/noTemplateCurlyInString: This is an intentional placeholder replaced at runtime
.map(x => path.normalize(x.replace('${exePath}', exePath))),
envVars: envVars,
notification: props('notification', ''),
isSemVer: isSemVer,
semver: semverVer,
isNightly: props('isNightly', false),
libsArr: this.getSupportedLibrariesArr(props),
tools: _.omit(this.optionsHandler.get().tools[langId], tool => tool.isCompilerExcluded(compilerId, props)),
unwiseOptions: splitArrayPropsOrEmpty('unwiseOptions', '|'),
hidden: props('hidden', false),
buildenvsetup: {
id: props('buildenvsetup', ''),
// NB: This props function can't be serialized to JSON. For prediscovered compilers,
// it gets recreated in loadPrediscovered() but only has language-level context,
// not group-level. This works because buildenvsetup properties are defined at
// the language level (e.g., c++.buildenvsetup.host). If group-level properties
// are ever needed, they should be stored directly like externalparser.exe/args.
// See #7150 for a potential long-term fix to the properties system.
props: (name, def) => {
return props(`buildenvsetup.${name}`, def);
},
},
externalparser: {
id: props('externalparser', ''),
exe: props('externalparser.exe', ''),
args: props('externalparser.args', ''),
},
license: {
link: props<string>('licenseLink'),
name: props<string>('licenseName'),
preamble: props<string>('licensePreamble'),
invasive: props<boolean>('licenseInvasive', false),
},
possibleOverrides: [],
possibleRuntimeTools: [],
$order: undefined as unknown as number, // TODO(jeremy-rifkin): Very dirty
};
if (props('demanglerClassFile') !== undefined) {
logger.error(
`Error in compiler.${compilerId}: ` +
'demanglerClassFile is no longer supported, please use demanglerType',
);
return null;
}
logger.debug('Found compiler', compilerInfo);
return compilerInfo;
}
getSupportedLibrariesArr(props: PropertyGetter) {
return props('supportsLibraries', '')
.split(':')
.filter(a => a !== '');
}
static getRemotePartsFromCompilerName(remoteCompilerName: string) {
const bits = remoteCompilerName.split('@');
const pathParts = bits[1].split('/');
return {
host: bits[0],
port: Number.parseInt(unwrap(pathParts.shift()), 10),
uriBase: pathParts.join('/'),
};
}
async recurseGetCompilers(
langId: string,
compilerName: string,
parentProps: CompilerProps['get'],
): Promise<PreliminaryCompilerInfo[]> {
// Don't treat @ in paths as remote addresses if requested
if (this.args.fetchCompilersFromRemote && compilerName.includes('@')) {
const {host, port, uriBase} = CompilerFinder.getRemotePartsFromCompilerName(compilerName);
return (await this.fetchRemote(host, port, uriBase, this.ceProps, langId)) || [];
}
if (compilerName.indexOf('&') === 0) {
const groupName = compilerName.substring(1);
const props: CompilerProps['get'] = (langId, name: string, def?): any => {
if (name === 'group') {
return groupName;
}
return this.compilerProps(langId, `group.${groupName}.${name}`, parentProps(langId, name, def));
};
const exes = this.compilerProps(langId, `group.${groupName}.compilers`, '')
.split(':')
.filter(s => s !== '');
logger.debug(`Processing compilers from group ${groupName}`);
const allCompilers = await Promise.all(
exes.map(compiler => this.recurseGetCompilers(langId, compiler, props)),
);
return allCompilers.flat();
}
const configs = [await this.compilerConfigFor(langId, compilerName, parentProps)];
return remove(configs, null);
}
async getCompilers() {
const compilers: Promise<PreliminaryCompilerInfo[]>[] = [];
for (const [langId, exs] of Object.entries(this.getExes())) {
for (const exe of exs) {
compilers.push(this.recurseGetCompilers(langId, exe, this.compilerProps));
}
}
const completeCompilers = await Promise.all(compilers);
return completeCompilers.flat();
}
ensureDistinct(compilers: CompilerInfo[]) {
const ids: Record<string, CompilerInfo[]> = {};
let foundClash = false;
for (const compiler of compilers) {
if (!ids[compiler.id]) ids[compiler.id] = [];
ids[compiler.id].push(compiler);
}
for (const [id, list] of Object.entries(ids)) {
if (list.length !== 1) {
foundClash = true;
logger.error(
`Compiler ID clash for '${id}' - used by ${list
.map(o => `lang:${o.lang} name:${o.name}`)
.join(', ')}`,
);
}
}
return {compilers, foundClash};
}
async retryPromise<T>(promiseFunc: () => Promise<T>, name: string, maxFails: number, retryMs: number) {
for (let fails = 0; fails < maxFails; ++fails) {
try {
return await promiseFunc();
} catch (e) {
if (fails < maxFails - 1) {
logger.warn(`Failed ${name} : ${e}, retrying`);
await sleep(retryMs);
} else {
logger.error(`Too many retries for ${name} : ${e}`);
throw e;
}
}
}
return null;
}
getExes() {
const langToCompilers = this.compilerProps(this.languages, 'compilers', '', exs =>
exs.split(':').filter(s => s !== ''),
);
this.addNdkExes(langToCompilers);
logger.info('Exes found:', langToCompilers);
return langToCompilers;
}
addNdkExes(langToCompilers: Record<LanguageKey, string[]>) {
const ndkPaths = this.compilerProps(this.languages, 'androidNdk') as unknown as Record<string, string>;
for (const [langId, ndkPath] of Object.entries(ndkPaths)) {
if (ndkPath) {
const toolchains = fs.readdirSync(`${ndkPath}/toolchains`);
for (const version of toolchains) {
const path = `${ndkPath}/toolchains/${version}/prebuilt/linux-x86_64/bin`;
for (const exe of fs.readdirSync(path)) {
if (exe.endsWith('clang++') || exe.endsWith('g++')) {
langToCompilers[langId as LanguageKey].push(`${path}/${exe}`);
}
}
}
}
}
}
checkOrphanedProperties() {
// Quickly check for any orphaned compilers
let error = false;
for (const domains of [
['amazon', 'amazonwin', 'gpu'],
['defaults', 'local'],
]) {
const compilers = new Set<string>();
// duplicate groups across languages is ok, so storing lang.group in the set
const groups = new Set<string>();
const reachableCompilers = new Set<string>();
const reachableGroups = new Set<string>();
const rawProps = getRawProperties();
for (const [prop, props] of Object.entries(rawProps)) {
const [lang, domain] = prop.split('.');
if (domains.includes(domain)) {
if (domain === 'defaults' && `${lang}.local` in rawProps) {
continue; // let .local override
}
for (const [prop, value] of Object.entries(props)) {
const propParts = prop.split('.');
if (prop === 'compilers') {
for (const compiler of unwrapString(value).split(':')) {
if (compiler.startsWith('&')) {
reachableGroups.add(`${lang}.${compiler.slice(1)}`);
} else {
reachableCompilers.add(compiler);
}
}
}
if (propParts[0] === 'group') {
if (propParts[2] === 'compilers') {
// should appear exactly once
const fullGroup = `${lang}.${propParts[1]}`;
if (groups.has(fullGroup)) {
const [lang, realGroup] = fullGroup.split('.');
logger.error(
`Duplicate group id ${realGroup} for ${lang} in domain ${domains.join(',')}`,
);
error = true;
}
groups.add(fullGroup);
for (const compiler of unwrapString(value).split(':')) {
if (compiler.startsWith('&')) {
reachableGroups.add(`${lang}.${compiler.slice(1)}`);
} else {
reachableCompilers.add(compiler);
}
}
}
}
if (propParts[0] === 'compiler') {
if (propParts[2] === 'exe') {
// should appear exactly once
if (compilers.has(propParts[1])) {
logger.error(
`Duplicate compiler id ${propParts[1]} in domain ${domains.join(',')}`,
);
// android-java and android-kotlin are
// expected to use the exact same compilers.
if (lang !== 'android-java' && lang !== 'android-kotlin') {
error = true;
}
}
compilers.add(propParts[1]);
}
}
}
}
}
for (const group of groups) {
if (!reachableGroups.has(group)) {
const [lang, realGroup] = group.split('.');
logger.error(
`Group ${realGroup} is orphaned from the language compilers list for ` +
`${lang} in domain ${domains.join(',')}`,
);
error = true;
}
}
for (const compiler of compilers) {
if (!reachableCompilers.has(compiler)) {
logger.error(`Compiler ${compiler} is not part of any group in domain ${domains.join(',')}`);
error = true;
}
}
}
if (error) {
logger.error(
'Note there are orphaned compiler properties, please fix them unless you are doing this on purpose',
);
}
}
async find() {
this.checkOrphanedProperties();
const compilerList = await this.getCompilers();
const toolchains = await getPossibleGccToolchainsFromCompilerInfo(compilerList);
this.compileHandler.setPossibleToolchains(toolchains);
const compilers = await this.compileHandler.setCompilers(compilerList, this.optionsHandler.get());
if (!compilers) {
logger.error('#### No compilers found: no compilation will be done!');
throw new Error('No compilers found due to error or no configuration');
}
const result = this.ensureDistinct(compilers);
return {
foundClash: result.foundClash,
compilers: result.compilers.sort((a, b) => basic_comparator(a.name, b.name)),
};
}
async loadPrediscovered(compilers: CompilerInfo[]) {
for (const compiler of compilers) {
const langId = compiler.lang;
if (compiler.buildenvsetup) {
compiler.buildenvsetup.props = (propName, def) => {
return this.compilerProps(langId, 'buildenvsetup.' + propName, def);
};
}
if (!compiler.remote && compiler.tools) {
const fullOptions = this.optionsHandler.get();
const toolinstances: Record<ToolInfo['id'], Tool> = {};
for (const toolId in compiler.tools) {
if (fullOptions.tools[langId][toolId]) {
toolinstances[toolId] = fullOptions.tools[langId][toolId];
}
}
compiler.tools = toolinstances;
}
}
return this.compileHandler.setCompilers(compilers, this.optionsHandler.get());
}
}