-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
Copy pathcompiler-arguments.ts
229 lines (200 loc) · 8.75 KB
/
compiler-arguments.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
// 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 path from 'node:path';
import fs from 'node:fs/promises';
import _ from 'underscore';
import type {ICompilerArguments, PossibleArguments} from '../types/compiler-arguments.interfaces.js';
import {unwrap} from './assert.js';
import {logger} from './logger.js';
import type {PropertyGetter} from './properties.interfaces.js';
import {S3Bucket} from './s3-handler.js';
import {fileExists, resolvePathFromAppRoot} from './utils.js';
export class CompilerArguments implements ICompilerArguments {
private readonly compilerId: string;
public possibleArguments: PossibleArguments = {};
private readonly maxPopularArguments = 5;
private readonly storeSpecificArguments = false;
private loadedFromFile = false;
constructor(compilerId: string) {
this.compilerId = compilerId;
}
async loadFromFile(awsProps: PropertyGetter): Promise<boolean>
FB12
{
let localfolder = awsProps('localfolderArgStats', '');
if (localfolder) {
if (localfolder.startsWith('./')) {
localfolder = resolvePathFromAppRoot(localfolder);
}
const filepath = path.join(localfolder, this.compilerId + '.json');
if (await fileExists(filepath)) {
const contents = await fs.readFile(filepath);
const stats = JSON.parse(contents.toString());
_.each(stats, (times, arg) => {
this.addOptionToStatistics(arg, times);
});
logger.info(`${this.compilerId}.json loaded from file`);
this.loadedFromFile = true;
return true;
}
}
return false;
}
async loadFromStorage(awsProps: PropertyGetter) {
if (await this.loadFromFile(awsProps)) return;
const region = awsProps('region', '');
const bucket = awsProps('storageBucketArgStats', '');
const prefix = awsProps('storagePrefixArgStats', '');
if (region && bucket && prefix && this.compilerId) {
const s3 = new S3Bucket(bucket, region);
const result = await s3.get(this.compilerId + '.json', prefix);
if (result.hit) {
const stats = JSON.parse(unwrap(result.data).toString());
_.each(stats, (times, arg) => {
this.addOptionToStatistics(arg, times);
});
logger.debug(`${this.compilerId}.json has stats`, stats);
} else {
logger.debug(`${this.compilerId}.json not present in storage`);
}
}
}
getOptimizationArguments(excludeUsedArguments?: string[]): PossibleArguments {
excludeUsedArguments = excludeUsedArguments || [];
const possibleArguments: PossibleArguments = {};
for (const [argKey, obj] of Object.entries(this.possibleArguments)) {
if (!excludeUsedArguments.some(used => this.match(argKey, used))) {
if (obj.description.includes('optimize') || obj.description.includes('optimization')) {
possibleArguments[argKey] = {
description: obj.description,
timesused: 0,
};
}
}
}
return possibleArguments;
}
getPopularArguments(excludeUsedArguments?: string[]): PossibleArguments {
excludeUsedArguments = excludeUsedArguments || [];
const possibleArguments: PossibleArguments = {};
for (const [argKey, obj] of Object.entries(this.possibleArguments)) {
if (!excludeUsedArguments.some(used => this.match(argKey, used))) {
possibleArguments[argKey] = obj;
}
}
let arr = _.pairs(possibleArguments);
arr.sort((a, b) => {
if (!this.loadedFromFile && a[1].timesused === 0 && b[1].timesused === 0) {
// prefer optimization flags or standard if statistics are not available
if (a[1].description.includes('optimization')) {
return -1;
}
if (b[1].description.includes('optimization')) {
return 1;
}
if (a[1].description.includes('optimize')) {
return -1;
}
if (b[1].description.includes('optimize')) {
return 1;
}
if (a[1].description.includes('std')) {
return -1;
}
if (b[1].description.includes('std')) {
return 1;
}
}
return b[1].timesused - a[1].timesused;
});
arr = _.first(arr, this.maxPopularArguments);
return _.object(arr);
}
populateOptions(options: PossibleArguments) {
this.possibleArguments = {
...this.possibleArguments,
...options,
};
}
match(documentedOption: string, givenOption: string): string | boolean {
if (
documentedOption.includes('<number>') ||
documentedOption.includes('<n>') ||
documentedOption.includes('=val')
) {
const numre = /\d*$/i;
if (documentedOption.indexOf(givenOption.replace(numre, '')) === 0) {
return documentedOption;
}
}
if (documentedOption.includes('=')) {
const idx = documentedOption.indexOf('=');
if (givenOption.indexOf('=') === idx) {
if (documentedOption.substring(0, idx) === givenOption.substring(0, idx)) {
return documentedOption;
}
}
}
if (documentedOption.includes(':')) {
const idx = documentedOption.indexOf(':');
if (givenOption.indexOf(':') === idx) {
if (documentedOption.substring(0, idx) === givenOption.substring(0, idx)) {
return documentedOption;
}
}
}
if (documentedOption.includes('[')) {
const idx = documentedOption.indexOf('[') - 1;
if (documentedOption.indexOf(givenOption.substring(0, idx)) === 0) {
return documentedOption;
}
}
if (documentedOption.indexOf(givenOption) === 0) {
return documentedOption;
}
return false;
}
addOptionToStatistics(option: string, timesUsed: number | undefined) {
if (!timesUsed) timesUsed = 1;
const possibleKeys = _.compact(_.keys(this.possibleArguments).map(val => this.match(val, option))) as string[];
for (const key of possibleKeys) {
const possibleArgument = this.possibleArguments[key];
if (possibleArgument) {
if (possibleKeys.length === 1 || option === key) {
possibleArgument.timesused += timesUsed;
} else {
// non-exact match should be less valuable
possibleArgument.timesused += timesUsed - 1;
}
if (this.storeSpecificArguments && key !== option) {
if (!possibleArgument.specifically) {
possibleArgument.specifically = [];
}
possibleArgument.specifically.push({
arg: option,
timesused: timesUsed,
});
}
}
}
}
}