forked from embench/embench-iot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
benchmark_size.py
executable file
·440 lines (378 loc) · 14.7 KB
/
benchmark_size.py
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
#!/usr/bin/env python3
# Script to benchmark size
# Copyright (C) 2017, 2019 Embecosm Limited
# Copyright (C) 2021 Roger Shepherd
#
# Contributor: Graham Markall <graham.markall@embecosm.com>
# Contributor: Jeremy Bennett <jeremy.bennett@embecosm.com>
# Contributor: Roger Shepherd <roger.shepherd@rcjd.net>
#
# This file is part of Embench.
# SPDX-License-Identifier: GPL-3.0-or-later
"""
Compute the size benchmark for a set of compiled Embench programs.
"""
import argparse
import codecs
import os
import sys
from json import loads
import lief
sys.path.append(
os.path.join(os.path.abspath(os.path.dirname(__file__)), 'pylib')
)
from embench_core import check_python_version
from embench_core import log
from embench_core import gp
from embench_core import setup_logging
from embench_core import log_args
from embench_core import find_benchmarks
from embench_core import log_benchmarks
from embench_core import embench_stats
from embench_core import output_format
"""
This script was originally written to handle elf format files and has been
extended to handle macho (Apple) format in a way that should make further extension
to pe (Microsoft) straightforward.
Categories of sections
This script is concerned with 4 categories of section. These sections are associated
by default with the name of a section (elf), or sections (macho). The default
associations are:
category of section elf macho
----------------------------------- ----- -----------------
executable code .text __text
non-zero initialized writeable data .data __data
read onlydata .rodata __cstring __const
zero initialised data .bss __bss
"""
# the default sections names are used both in validate_args and in collect_data
DEFAULT_SECNAMELIST_ELF = {'text' : ['.text'],
'rodata': ['.rodata'],
'data' : ['.data'],
'bss' : ['.bss']
}
DEFAULT_SECNAMELIST_MACHO = {'text' : ['__text'],
'rodata': ['__cstring', '__const'],
'data' : ['__data'],
'bss' : ['__bss']
}
DEFAULT_SECNAMELIST_DICT = {'elf': DEFAULT_SECNAMELIST_ELF,
'macho': DEFAULT_SECNAMELIST_MACHO
}
"""
For each category, the user can override the default and explicitly set the names
of sections in that category. This is done by using command line parameters named
after the default elf sections. On the command line the parameters are followed
by the name(s) of the section(s)
category of section parameter
----------------------------------- ---------
executable code --text
non-zero initialized writeable data --data
read-only data --rodata
zero initialised data --bss
Metrics
The script reports a metric which is the sum of the sizes of a number of the
categories of sections. By default the metric reported is executable code (text)
category. This can be overridden using the `—metric` parameter which takes the space
separated list of categories to be included in the metric. [NB the category names
are the same for elf and macho].
"""
# the categories and the metrics happen to be the same; they could be different
ALL_CATEGORIES = ['text', 'rodata', 'data', 'bss']
ALL_METRICS = ['text', 'rodata', 'data', 'bss']
def build_parser():
"""Build a parser for all the arguments"""
parser = argparse.ArgumentParser(description='Compute the size benchmark')
parser.add_argument('--format', default='elf', choices=['elf', 'macho'],
help='File format')
parser.add_argument(
'--builddir',
type=str,
default='bd',
help='Directory holding all the binaries',
)
parser.add_argument(
'--logdir',
type=str,
default='logs',
help='Directory in which to store logs',
)
parser.add_argument(
'--baselinedir',
type=str,
default='baseline-data',
help='Directory which contains baseline data',
)
parser.add_argument(
'--absolute',
action='store_true',
help='Specify to show absolute results',
)
parser.add_argument(
'--relative',
dest='absolute',
action='store_false',
help='Specify to show relative results (the default)',
)
parser.add_argument(
'--json-output',
dest='output_format',
action='store_const',
const=output_format.JSON,
help='Specify to output in JSON format',
)
parser.add_argument(
'--text-output',
dest='output_format',
action='store_const',
const=output_format.TEXT,
help='Specify to output as plain text (the default)',
)
parser.add_argument(
'--baseline-output',
dest='output_format',
action='store_const',
const=output_format.BASELINE,
help='Specify to output in a format suitable for use as a baseline'
)
parser.add_argument(
'--json-comma',
action='store_true',
help='Specify to append a comma to the JSON output',
)
parser.add_argument(
'--no-json-comma',
dest='json_comma',
action='store_false',
help='Specify to not append a comma to the JSON output',
)
# List arguments are empty by default, a user specified value then takes
# precedence. If the list is empty after parsing, then we can install a
# default value.
parser.add_argument(
'--text',
type=str,
default=[],
nargs='+',
help='Section name(s) containing code'
)
parser.add_argument(
'--data',
type=str,
default=[],
nargs='+',
help='Section name(s) containing non-zero initialized writable data'
)
parser.add_argument(
'--rodata',
type=str,
default=[],
nargs='+',
help='Section name(s) containing read only data'
)
parser.add_argument(
'--bss',
type=str,
default=[],
nargs='+',
help='Section name(s) containing zero initialized writable data'
)
parser.add_argument(
'--metric',
type=str,
default=[],
nargs='+',
choices=ALL_METRICS,
help='Section categories to include in metric: one or more of "text", "rodata", '
+ '"data" or "bss". Default "text"',
)
return parser
def validate_args(args):
"""Check that supplied args are all valid. By definition logging is
working when we get here.
Update the gp dictionary with all the useful info"""
gp['format'] = args.format
if os.path.isabs(args.builddir):
gp['bd'] = args.builddir
else:
gp['bd'] = os.path.join(gp['rootdir'], args.builddir)
if not os.path.isdir(gp['bd']):
log.error(f'ERROR: build directory {gp["bd"]} not found: exiting')
sys.exit(1)
if not os.access(gp['bd'], os.R_OK):
log.error(f'ERROR: Unable to read build directory {gp["bd"]}: exiting')
sys.exit(1)
if os.path.isabs(args.baselinedir):
gp['baseline_dir'] = args.baselinedir
else:
gp['baseline_dir'] = os.path.join(gp['rootdir'], args.baselinedir)
gp['absolute'] = args.absolute
if args.output_format:
gp['output_format'] = args.output_format
else:
gp['output_format'] = output_format.TEXT
# Produce the list of section names associated with each category
gp['secnames'] = dict()
for argname in ALL_CATEGORIES:
secnames = getattr(args, argname)
if secnames:
gp['secnames'][argname] = secnames
else:
gp['secnames'][argname] = (DEFAULT_SECNAMELIST_DICT[gp['format']])[argname]
# If no categories are specified, we just use text
if args.metric:
gp['metric'] = args.metric
else:
gp['metric'] = ['text']
def benchmark_size(bench, metrics):
"""Compute the total size of the desired sections in a benchmark. Returns
the size in bytes, which may be zero if the section wasn't found."""
appexe = os.path.join(gp['bd_benchdir'], bench, bench)
sec_sizes = {}
# If the benchmark failed to build, then return a 0 size instead of
# crashing when failing to open the file.
if not os.path.exists(appexe):
return {}
# read format from file and check it is as expected
with open(appexe, 'rb') as fileh:
magic = fileh.read(4)
# lief does not appear to have ability to work from an already opened file
fileh.close()
if (((gp['format'] == 'elf') and (magic != b'\x7fELF')) or
((gp['format'] == 'macho') and (magic != b'\xcf\xfa\xed\xfe'))):
log.info('ERROR: File format does not match parameter')
sys.exit(1)
binary = lief.parse(appexe)
sections = binary.sections
for metric in metrics:
sec_sizes[metric] = 0
for target_name in gp['secnames'][metric]:
for section in sections:
if ((gp['format'] == 'elf' and section.name.startswith(target_name)) or
(target_name == section.name)):
sec_sizes[metric] += section.size
# Return the section (group) size
return sec_sizes
def collect_data(benchmarks):
"""Collect and log all the raw and optionally relative data associated with
the list of benchmarks supplied in the "benchmarks" argument. Return
the raw data and relative data as a list. The raw data may be empty if
there is a failure. The relative data will be empty if only absolute
results have been requested.
Note that we manually generate the JSON output, rather than using the
dumps method, because the result will be manually edited, and we want
to guarantee the layout."""
# Baseline data is held external to the script. Import it here.
size_baseline = os.path.join(gp['baseline_dir'], 'size.json')
with open(size_baseline) as fileh:
baseline_all = loads(fileh.read())
# Compute the baseline data we need
baseline = {}
for bench, data in baseline_all.items():
baseline[bench] = 0
for sec in gp['metric']:
baseline[bench] += data[sec]
successful = True
raw_section_data = {}
raw_totals = {}
rel_data = {}
# Collect data
for bench in benchmarks:
if gp['output_format'] == output_format.BASELINE:
raw_section_data[bench] = benchmark_size(bench, ALL_METRICS)
else:
raw_section_data[bench] = benchmark_size(bench, gp['metric'])
raw_totals[bench] = sum(raw_section_data[bench].values())
# Calculate data relative to the baseline if needed
if gp['absolute'] or gp['output_format'] == output_format.BASELINE:
rel_data[bench] = {}
else:
# Want relative results (the default). If baseline is zero, just
# use 0.0 as the value. Note this is inverted compared to the
# speed benchmark, so SMALL is good.
if baseline[bench] > 0:
rel_data[bench] = raw_totals[bench] / baseline[bench]
else:
rel_data[bench] = 0.0
# Output it
if gp['output_format'] == output_format.JSON:
log.info(' "size results" :')
log.info(' { "detailed size results" :')
for bench in benchmarks:
res_output = ''
if gp['absolute']:
res_output = f'{raw_totals[bench]}'
else:
res_output = f'{rel_data[bench]:.2f}'
if bench == benchmarks[0]:
log.info(' { ' + f'"{bench}" : {res_output},')
elif bench == benchmarks[-1]:
log.info(f' "{bench}" : {res_output}')
else:
log.info(f' "{bench}" : {res_output},')
log.info(' },')
elif gp['output_format'] == output_format.TEXT:
log.info('Benchmark size')
log.info('--------- ----')
for bench in benchmarks:
res_output = ''
if gp['absolute']:
res_output = f' {raw_totals[bench]:8,}'
else:
res_output = f' {rel_data[bench]:6.2f}'
log.info(f'{bench:15} {res_output:8}')
elif gp['output_format'] == output_format.BASELINE:
log.info('{')
for bench in benchmarks:
res_output = ''
for metric in ALL_METRICS:
# newline before the first metric
if metric != ALL_METRICS[0]:
res_output += ',\n'
value = raw_section_data[bench][metric]
res_output += f' "{metric}" : {value}'
# comma after all but last benchmark in the log
if bench == benchmarks[-1]:
log.info(f' "{bench}" : {{\n{res_output}\n }}')
else:
log.info(f' "{bench}" : {{\n{res_output}\n }},')
log.info('}')
if successful:
return raw_totals, rel_data
# Otherwise failure return
return [], []
def main():
"""Main program driving measurement of benchmark size"""
# Establish the root directory of the repository, since we know this file is
# in that directory.
gp['rootdir'] = os.path.abspath(os.path.dirname(__file__))
# Parse arguments using standard technology
parser = build_parser()
args = parser.parse_args()
# Establish logging
setup_logging(args.logdir, 'size')
log_args(args)
# Check args are OK (have to have logging and build directory set up first)
validate_args(args)
# Find the benchmarks
benchmarks = find_benchmarks()
log_benchmarks(benchmarks)
# Collect the size data for the benchmarks
raw_data, rel_data = collect_data(benchmarks)
# We can't compute geometric SD on the fly, so we need to collect all the
# data and then process it in two passes. We could do the first processing
# as we collect the data, but it is clearer to do the three things
# separately. Given the size of datasets with which we are concerned the
# compute overhead is not significant.
if raw_data:
if gp['output_format'] != output_format.BASELINE:
opt_comma = ',' if args.json_comma else ''
embench_stats(benchmarks, raw_data, rel_data, 'size', opt_comma)
log.info('All benchmarks sized successfully')
else:
log.info('ERROR: Failed to compute size benchmarks')
sys.exit(1)
# Make sure we have new enough Python and only run if this is the main package
check_python_version(3, 6)
if __name__ == '__main__':
sys.exit(main())