mirror of
https://github.com/ARMmbed/mbedtls.git
synced 2025-05-10 08:59:05 +08:00
764 lines
30 KiB
Python
Executable File
764 lines
30 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
"""
|
|
This script is for comparing the size of the library files from two
|
|
different Git revisions within an Mbed TLS repository.
|
|
The results of the comparison is formatted as csv and stored at a
|
|
configurable location.
|
|
Note: must be run from Mbed TLS root.
|
|
"""
|
|
|
|
# Copyright The Mbed TLS Contributors
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import argparse
|
|
import logging
|
|
import os
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
import typing
|
|
from enum import Enum
|
|
|
|
from types import SimpleNamespace
|
|
from mbedtls_dev import build_tree
|
|
from mbedtls_dev import logging_util
|
|
from mbedtls_dev import typing_util
|
|
|
|
class SupportedArch(Enum):
|
|
"""Supported architecture for code size measurement."""
|
|
AARCH64 = 'aarch64'
|
|
AARCH32 = 'aarch32'
|
|
ARMV8_M = 'armv8-m'
|
|
X86_64 = 'x86_64'
|
|
X86 = 'x86'
|
|
|
|
CONFIG_TFM_MEDIUM_MBEDCRYPTO_H = '../configs/tfm_mbedcrypto_config_profile_medium.h'
|
|
CONFIG_TFM_MEDIUM_PSA_CRYPTO_H = '../configs/crypto_config_profile_medium.h'
|
|
class SupportedConfig(Enum):
|
|
"""Supported configuration for code size measurement."""
|
|
DEFAULT = 'default'
|
|
TFM_MEDIUM = 'tfm-medium'
|
|
|
|
# Static library
|
|
MBEDTLS_STATIC_LIB = {
|
|
'CRYPTO': 'library/libmbedcrypto.a',
|
|
'X509': 'library/libmbedx509.a',
|
|
'TLS': 'library/libmbedtls.a',
|
|
}
|
|
|
|
DETECT_ARCH_CMD = "cc -dM -E - < /dev/null"
|
|
def detect_arch() -> str:
|
|
"""Auto-detect host architecture."""
|
|
cc_output = subprocess.check_output(DETECT_ARCH_CMD, shell=True).decode()
|
|
if '__aarch64__' in cc_output:
|
|
return SupportedArch.AARCH64.value
|
|
if '__arm__' in cc_output:
|
|
return SupportedArch.AARCH32.value
|
|
if '__x86_64__' in cc_output:
|
|
return SupportedArch.X86_64.value
|
|
if '__x86__' in cc_output:
|
|
return SupportedArch.X86.value
|
|
else:
|
|
print("Unknown host architecture, cannot auto-detect arch.")
|
|
sys.exit(1)
|
|
|
|
class CodeSizeBuildInfo: # pylint: disable=too-few-public-methods
|
|
"""Gather information used to measure code size.
|
|
|
|
It collects information about architecture, configuration in order to
|
|
infer build command for code size measurement.
|
|
"""
|
|
|
|
SupportedArchConfig = [
|
|
'-a ' + SupportedArch.AARCH64.value + ' -c ' + SupportedConfig.DEFAULT.value,
|
|
'-a ' + SupportedArch.AARCH32.value + ' -c ' + SupportedConfig.DEFAULT.value,
|
|
'-a ' + SupportedArch.X86_64.value + ' -c ' + SupportedConfig.DEFAULT.value,
|
|
'-a ' + SupportedArch.X86.value + ' -c ' + SupportedConfig.DEFAULT.value,
|
|
'-a ' + SupportedArch.ARMV8_M.value + ' -c ' + SupportedConfig.TFM_MEDIUM.value,
|
|
]
|
|
|
|
def __init__(
|
|
self,
|
|
size_version: SimpleNamespace,
|
|
host_arch: str,
|
|
logger: logging.Logger,
|
|
) -> None:
|
|
"""
|
|
:param size_version:
|
|
SimpleNamespace containing info for code size measurement.
|
|
- size_version.arch: architecture to measure code size on.
|
|
- size_version.config: configuration type to measure code size
|
|
with.
|
|
:param host_arch: host architecture.
|
|
:param logger: logging module
|
|
"""
|
|
self.size_version = size_version
|
|
self.host_arch = host_arch
|
|
self.logger = logger
|
|
|
|
def infer_make_command(self) -> str:
|
|
"""Infer make command based on architecture and configuration."""
|
|
|
|
# make command by default
|
|
if self.size_version.config == SupportedConfig.DEFAULT.value and \
|
|
self.size_version.arch == self.host_arch:
|
|
return 'make -j lib CFLAGS=\'-Os \' '
|
|
# make command for TF-M
|
|
elif self.size_version.arch == SupportedArch.ARMV8_M.value and \
|
|
self.size_version.config == SupportedConfig.TFM_MEDIUM.value:
|
|
return \
|
|
'make -j lib CC=armclang \
|
|
CFLAGS=\'--target=arm-arm-none-eabi -mcpu=cortex-m33 -Os \
|
|
-DMBEDTLS_CONFIG_FILE=\\\"' + CONFIG_TFM_MEDIUM_MBEDCRYPTO_H + '\\\" \
|
|
-DMBEDTLS_PSA_CRYPTO_CONFIG_FILE=\\\"' + CONFIG_TFM_MEDIUM_PSA_CRYPTO_H + '\\\" \''
|
|
# unsupported combinations
|
|
else:
|
|
self.logger.error("Unsupported combination of architecture: {} " \
|
|
"and configuration: {}.\n"
|
|
.format(self.size_version.arch,
|
|
self.size_version.config))
|
|
self.logger.info("Please use supported combination of " \
|
|
"architecture and configuration:")
|
|
for comb in CodeSizeBuildInfo.SupportedArchConfig:
|
|
self.logger.info(comb)
|
|
self.logger.info("")
|
|
self.logger.info("For your system, please use:")
|
|
for comb in CodeSizeBuildInfo.SupportedArchConfig:
|
|
if "default" in comb and self.host_arch not in comb:
|
|
continue
|
|
self.logger.info(comb)
|
|
sys.exit(1)
|
|
|
|
|
|
class CodeSizeCalculator:
|
|
""" A calculator to calculate code size of library/*.o based on
|
|
Git revision and code size measurement tool.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
revision: str,
|
|
make_cmd: str,
|
|
measure_cmd: str,
|
|
logger: logging.Logger,
|
|
) -> None:
|
|
"""
|
|
:param revision: Git revision.(E.g: commit)
|
|
:param make_cmd: command to build library/*.o.
|
|
:param measure_cmd: command to measure code size for library/*.o.
|
|
:param logger: logging module
|
|
"""
|
|
self.repo_path = "."
|
|
self.git_command = "git"
|
|
self.make_clean = 'make clean'
|
|
|
|
self.revision = revision
|
|
self.make_cmd = make_cmd
|
|
self.measure_cmd = measure_cmd
|
|
self.logger = logger
|
|
|
|
@staticmethod
|
|
def validate_revision(revision: str) -> str:
|
|
result = subprocess.check_output(["git", "rev-parse", "--verify",
|
|
revision + "^{commit}"], shell=False,
|
|
universal_newlines=True)
|
|
return result[:7]
|
|
|
|
def _create_git_worktree(self) -> str:
|
|
"""Create a separate worktree for revision.
|
|
If revision is current, use current worktree instead."""
|
|
|
|
if self.revision == "current":
|
|
self.logger.debug("Using current work directory.")
|
|
git_worktree_path = self.repo_path
|
|
else:
|
|
self.logger.debug("Creating git worktree for {}."
|
|
.format(self.revision))
|
|
git_worktree_path = os.path.join(self.repo_path,
|
|
"temp-" + self.revision)
|
|
subprocess.check_output(
|
|
[self.git_command, "worktree", "add", "--detach",
|
|
git_worktree_path, self.revision], cwd=self.repo_path,
|
|
stderr=subprocess.STDOUT
|
|
)
|
|
|
|
return git_worktree_path
|
|
|
|
def _build_libraries(self, git_worktree_path: str) -> None:
|
|
"""Build library/*.o in the specified worktree."""
|
|
|
|
self.logger.debug("Building library/*.o for {}."
|
|
.format(self.revision))
|
|
my_environment = os.environ.copy()
|
|
try:
|
|
subprocess.check_output(
|
|
self.make_clean, env=my_environment, shell=True,
|
|
cwd=git_worktree_path, stderr=subprocess.STDOUT,
|
|
universal_newlines=True
|
|
)
|
|
subprocess.check_output(
|
|
self.make_cmd, env=my_environment, shell=True,
|
|
cwd=git_worktree_path, stderr=subprocess.STDOUT,
|
|
universal_newlines=True
|
|
)
|
|
except subprocess.CalledProcessError as e:
|
|
self._handle_called_process_error(e, git_worktree_path)
|
|
|
|
def _gen_raw_code_size(self, git_worktree_path: str) -> typing.Dict[str, str]:
|
|
"""Measure code size by a tool and return in UTF-8 encoding."""
|
|
|
|
self.logger.debug("Measuring code size for {} by `{}`."
|
|
.format(self.revision,
|
|
self.measure_cmd.strip().split(' ')[0]))
|
|
|
|
res = {}
|
|
for mod, st_lib in MBEDTLS_STATIC_LIB.items():
|
|
try:
|
|
result = subprocess.check_output(
|
|
[self.measure_cmd + ' ' + st_lib], cwd=git_worktree_path,
|
|
shell=True, universal_newlines=True
|
|
)
|
|
res[mod] = result
|
|
except subprocess.CalledProcessError as e:
|
|
self._handle_called_process_error(e, git_worktree_path)
|
|
|
|
return res
|
|
|
|
def _remove_worktree(self, git_worktree_path: str) -> None:
|
|
"""Remove temporary worktree."""
|
|
if git_worktree_path != self.repo_path:
|
|
self.logger.debug("Removing temporary worktree {}."
|
|
.format(git_worktree_path))
|
|
subprocess.check_output(
|
|
[self.git_command, "worktree", "remove", "--force",
|
|
git_worktree_path], cwd=self.repo_path,
|
|
stderr=subprocess.STDOUT
|
|
)
|
|
|
|
def _handle_called_process_error(self, e: subprocess.CalledProcessError,
|
|
git_worktree_path: str) -> None:
|
|
"""Handle a CalledProcessError and quit the program gracefully.
|
|
Remove any extra worktrees so that the script may be called again."""
|
|
|
|
# Tell the user what went wrong
|
|
self.logger.error(e, exc_info=True)
|
|
self.logger.error("Process output:\n {}".format(e.output))
|
|
|
|
# Quit gracefully by removing the existing worktree
|
|
self._remove_worktree(git_worktree_path)
|
|
sys.exit(-1)
|
|
|
|
def cal_libraries_code_size(self) -> typing.Dict[str, str]:
|
|
"""Do a complete round to calculate code size of library/*.o
|
|
by measurement tool.
|
|
|
|
:return A dictionary of measured code size
|
|
- typing.Dict[mod: str]
|
|
"""
|
|
|
|
git_worktree_path = self._create_git_worktree()
|
|
self._build_libraries(git_worktree_path)
|
|
res = self._gen_raw_code_size(git_worktree_path)
|
|
self._remove_worktree(git_worktree_path)
|
|
|
|
return res
|
|
|
|
|
|
class CodeSizeGenerator:
|
|
""" A generator based on size measurement tool for library/*.o.
|
|
|
|
This is an abstract class. To use it, derive a class that implements
|
|
size_generator_write_record and size_generator_write_comparison methods,
|
|
then call both of them with proper arguments.
|
|
"""
|
|
def __init__(self, logger: logging.Logger) -> None:
|
|
"""
|
|
:param logger: logging module
|
|
"""
|
|
self.logger = logger
|
|
|
|
def size_generator_write_record(
|
|
self,
|
|
revision: str,
|
|
code_size_text: typing.Dict,
|
|
output_file: str
|
|
) -> None:
|
|
"""Write size record into a file.
|
|
|
|
:param revision: Git revision.(E.g: commit)
|
|
:param code_size_text:
|
|
string output (utf-8) from measurement tool of code size.
|
|
- typing.Dict[mod: str]
|
|
:param output_file: file which the code size record is written to.
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
def size_generator_write_comparison(
|
|
self,
|
|
old_rev: str,
|
|
new_rev: str,
|
|
output_stream: str,
|
|
result_options: SimpleNamespace
|
|
) -> None:
|
|
"""Write a comparision result into a stream between two revisions.
|
|
|
|
:param old_rev: old Git revision to compared with.
|
|
:param new_rev: new Git revision to compared with.
|
|
:param output_stream: stream which the code size record is written to.
|
|
:param result_options:
|
|
SimpleNamespace containing options for comparison result.
|
|
- result_options.with_markdown: write comparision result in a
|
|
markdown table. (Default: False)
|
|
- result_options.stdout: direct comparison result into
|
|
sys.stdout. (Default: False)
|
|
"""
|
|
raise NotImplementedError
|
|
|
|
|
|
class CodeSizeGeneratorWithSize(CodeSizeGenerator):
|
|
"""Code Size Base Class for size record saving and writing."""
|
|
|
|
class SizeEntry: # pylint: disable=too-few-public-methods
|
|
"""Data Structure to only store information of code size."""
|
|
def __init__(self, text, data, bss, dec):
|
|
self.text = text
|
|
self.data = data
|
|
self.bss = bss
|
|
self.total = dec # total <=> dec
|
|
|
|
def __init__(self, logger: logging.Logger) -> None:
|
|
""" Variable code_size is used to store size info for any revisions.
|
|
:param code_size:
|
|
Data Format as following:
|
|
{revision: {module: {file_name: [text, data, bss, dec],
|
|
etc ...
|
|
},
|
|
etc ...
|
|
},
|
|
etc ...
|
|
}
|
|
"""
|
|
super().__init__(logger)
|
|
self.code_size = {} #type: typing.Dict[str, typing.Dict]
|
|
|
|
def _set_size_record(self, revision: str, mod: str, size_text: str) -> None:
|
|
"""Store size information for target revision and high-level module.
|
|
|
|
size_text Format: text data bss dec hex filename
|
|
"""
|
|
size_record = {}
|
|
for line in size_text.splitlines()[1:]:
|
|
data = line.split()
|
|
# file_name: SizeEntry(text, data, bss, dec)
|
|
size_record[data[5]] = CodeSizeGeneratorWithSize.SizeEntry(
|
|
data[0], data[1], data[2], data[3])
|
|
if revision in self.code_size:
|
|
self.code_size[revision].update({mod: size_record})
|
|
else:
|
|
self.code_size[revision] = {mod: size_record}
|
|
|
|
def read_size_record(self, revision: str, fname: str) -> None:
|
|
"""Read size information from csv file and write it into code_size.
|
|
|
|
fname Format: filename text data bss dec
|
|
"""
|
|
mod = ""
|
|
size_record = {}
|
|
with open(fname, 'r') as csv_file:
|
|
for line in csv_file:
|
|
data = line.strip().split()
|
|
# check if we find the beginning of a module
|
|
if data and data[0] in MBEDTLS_STATIC_LIB:
|
|
mod = data[0]
|
|
continue
|
|
|
|
if mod:
|
|
# file_name: SizeEntry(text, data, bss, dec)
|
|
size_record[data[0]] = CodeSizeGeneratorWithSize.SizeEntry(
|
|
data[1], data[2], data[3], data[4])
|
|
|
|
# check if we hit record for the end of a module
|
|
m = re.match(r'.?TOTALS', line)
|
|
if m:
|
|
if revision in self.code_size:
|
|
self.code_size[revision].update({mod: size_record})
|
|
else:
|
|
self.code_size[revision] = {mod: size_record}
|
|
mod = ""
|
|
size_record = {}
|
|
|
|
def _size_reader_helper(
|
|
self,
|
|
revision: str,
|
|
output: typing_util.Writable,
|
|
with_markdown=False
|
|
) -> typing.Iterator[tuple]:
|
|
"""A helper function to peel code_size based on revision."""
|
|
for mod, file_size in self.code_size[revision].items():
|
|
if not with_markdown:
|
|
output.write("\n" + mod + "\n")
|
|
for fname, size_entry in file_size.items():
|
|
yield mod, fname, size_entry
|
|
|
|
def _write_size_record(
|
|
self,
|
|
revision: str,
|
|
output: typing_util.Writable
|
|
) -> None:
|
|
"""Write size information to a file.
|
|
|
|
Writing Format: file_name text data bss total(dec)
|
|
"""
|
|
format_string = "{:<30} {:>7} {:>7} {:>7} {:>7}\n"
|
|
output.write(format_string.format("filename",
|
|
"text", "data", "bss", "total"))
|
|
for _, fname, size_entry in self._size_reader_helper(revision, output):
|
|
output.write(format_string.format(fname,
|
|
size_entry.text, size_entry.data,
|
|
size_entry.bss, size_entry.total))
|
|
|
|
def _write_comparison(
|
|
self,
|
|
old_rev: str,
|
|
new_rev: str,
|
|
output: typing_util.Writable,
|
|
with_markdown: bool
|
|
) -> None:
|
|
"""Write comparison result into a file.
|
|
|
|
Writing Format: file_name current(text,data) old(text,data)\
|
|
change(text,data) change_pct%(text,data)
|
|
"""
|
|
|
|
def cal_size_section_variation(mod, fname, size_entry, attr):
|
|
new_size = int(size_entry.__dict__[attr])
|
|
# check if we have the file in old revision
|
|
if fname in self.code_size[old_rev][mod]:
|
|
old_size = int(self.code_size[old_rev][mod][fname].__dict__[attr])
|
|
change = new_size - old_size
|
|
if old_size != 0:
|
|
change_pct = change / old_size
|
|
else:
|
|
change_pct = 0
|
|
return [new_size, old_size, change, change_pct]
|
|
else:
|
|
return [new_size]
|
|
|
|
if with_markdown:
|
|
format_string = "| {:<30} | {:<18} | {:<14} | {:<17} | {:<18} |\n"
|
|
else:
|
|
format_string = "{:<30} {:<18} {:<14} {:<17} {:<18}\n"
|
|
|
|
output.write(format_string
|
|
.format("filename",
|
|
"current(text,data)", "old(text,data)",
|
|
"change(text,data)", "change%(text,data)"))
|
|
if with_markdown:
|
|
output.write(format_string
|
|
.format("----:", "----:", "----:", "----:", "----:"))
|
|
|
|
for mod, fname, size_entry in \
|
|
self._size_reader_helper(new_rev, output, with_markdown):
|
|
text_vari = cal_size_section_variation(mod, fname,
|
|
size_entry, 'text')
|
|
data_vari = cal_size_section_variation(mod, fname,
|
|
size_entry, 'data')
|
|
|
|
if len(text_vari) != 1:
|
|
# skip the files that haven't changed in code size if we write
|
|
# comparison result in a markdown table.
|
|
if with_markdown and text_vari[2] == 0 and data_vari[2] == 0:
|
|
continue
|
|
output.write(
|
|
format_string
|
|
.format(fname,
|
|
str(text_vari[0]) + "," + str(data_vari[0]),
|
|
str(text_vari[1]) + "," + str(data_vari[1]),
|
|
str(text_vari[2]) + "," + str(data_vari[2]),
|
|
"{:.2%}".format(text_vari[3]) + ","
|
|
+ "{:.2%}".format(data_vari[3])))
|
|
else:
|
|
output.write("{:<30} {:<18}\n"
|
|
.format(fname,
|
|
str(text_vari[0]) + "," + str(data_vari[0])))
|
|
|
|
def size_generator_write_record(
|
|
self,
|
|
revision: str,
|
|
code_size_text: typing.Dict,
|
|
output_file: str
|
|
) -> None:
|
|
"""Write size record into a specified file based on Git revision and
|
|
output from `size` tool."""
|
|
self.logger.debug("Generating code size csv for {}.".format(revision))
|
|
|
|
for mod, size_text in code_size_text.items():
|
|
self._set_size_record(revision, mod, size_text)
|
|
|
|
output = open(output_file, "w")
|
|
self._write_size_record(revision, output)
|
|
|
|
def size_generator_write_comparison(
|
|
self,
|
|
old_rev: str,
|
|
new_rev: str,
|
|
output_stream: str,
|
|
result_options: SimpleNamespace
|
|
) -> None:
|
|
"""Write a comparision result into a stream between two revisions.
|
|
|
|
By default, it's written into a file called output_stream.
|
|
Once result_options.stdout is set, it's written into sys.stdout instead.
|
|
"""
|
|
self.logger.debug("Generating comparison results between {} and {}."
|
|
.format(old_rev, new_rev))
|
|
|
|
if result_options.stdout:
|
|
output = sys.stdout
|
|
else:
|
|
output = open(output_stream, "w")
|
|
self._write_comparison(old_rev, new_rev, output,
|
|
result_options.with_markdown)
|
|
|
|
|
|
class CodeSizeComparison:
|
|
"""Compare code size between two Git revisions."""
|
|
|
|
def __init__(
|
|
self,
|
|
old_size_version: SimpleNamespace,
|
|
new_size_version: SimpleNamespace,
|
|
code_size_common: SimpleNamespace,
|
|
logger: logging.Logger,
|
|
) -> None:
|
|
"""
|
|
:param old_size_version: SimpleNamespace containing old version info
|
|
to compare code size with.
|
|
:param new_size_version: SimpleNamespace containing new version info
|
|
to take as comparision base.
|
|
:param code_size_common: SimpleNamespace containing common info for
|
|
both old and new size version,
|
|
measurement tool and result options.
|
|
:param logger: logging module
|
|
"""
|
|
self.result_dir = os.path.abspath(
|
|
code_size_common.result_options.result_dir)
|
|
os.makedirs(self.result_dir, exist_ok=True)
|
|
|
|
self.csv_dir = os.path.abspath("code_size_records/")
|
|
os.makedirs(self.csv_dir, exist_ok=True)
|
|
|
|
self.logger = logger
|
|
|
|
self.old_size_version = old_size_version
|
|
self.new_size_version = new_size_version
|
|
self.code_size_common = code_size_common
|
|
# infer make command
|
|
self.old_size_version.make_cmd = CodeSizeBuildInfo(
|
|
self.old_size_version, self.code_size_common.host_arch,
|
|
self.logger).infer_make_command()
|
|
self.new_size_version.make_cmd = CodeSizeBuildInfo(
|
|
self.new_size_version, self.code_size_common.host_arch,
|
|
self.logger).infer_make_command()
|
|
# initialize size parser with corresponding measurement tool
|
|
self.code_size_generator = self.__generate_size_parser()
|
|
|
|
def __generate_size_parser(self):
|
|
"""Generate a parser for the corresponding measurement tool."""
|
|
if re.match(r'size', self.code_size_common.measure_cmd.strip()):
|
|
return CodeSizeGeneratorWithSize(self.logger)
|
|
else:
|
|
self.logger.error("Unsupported measurement tool: `{}`."
|
|
.format(self.code_size_common.measure_cmd
|
|
.strip().split(' ')[0]))
|
|
sys.exit(1)
|
|
|
|
|
|
def cal_code_size(
|
|
self,
|
|
size_version: SimpleNamespace
|
|
) -> typing.Dict[str, str]:
|
|
"""Calculate code size of library/*.o in a UTF-8 encoding"""
|
|
|
|
return CodeSizeCalculator(size_version.revision, size_version.make_cmd,
|
|
self.code_size_common.measure_cmd,
|
|
self.logger).cal_libraries_code_size()
|
|
|
|
def gen_file_name(
|
|
self,
|
|
old_size_version: SimpleNamespace,
|
|
new_size_version=None
|
|
) -> str:
|
|
"""Generate a literal string as csv file name."""
|
|
if new_size_version:
|
|
return '{}-{}-{}-{}-{}-{}-{}.csv'\
|
|
.format(old_size_version.revision, old_size_version.arch,
|
|
old_size_version.config,
|
|
new_size_version.revision, new_size_version.arch,
|
|
new_size_version.config,
|
|
self.code_size_common.measure_cmd.strip()\
|
|
.split(' ')[0])
|
|
else:
|
|
return '{}-{}-{}-{}.csv'\
|
|
.format(old_size_version.revision, old_size_version.arch,
|
|
old_size_version.config,
|
|
self.code_size_common.measure_cmd.strip()\
|
|
.split(' ')[0])
|
|
|
|
def gen_code_size_report(self, size_version: SimpleNamespace) -> None:
|
|
"""Generate code size record and write it into a file."""
|
|
|
|
self.logger.info("Start to generate code size record for {}."
|
|
.format(size_version.revision))
|
|
output_file = os.path.join(self.csv_dir,
|
|
self.gen_file_name(size_version))
|
|
# Check if the corresponding record exists
|
|
if size_version.revision != "current" and \
|
|
os.path.exists(output_file):
|
|
self.logger.debug("Code size csv file for {} already exists."
|
|
.format(size_version.revision))
|
|
self.code_size_generator.read_size_record(
|
|
size_version.revision, output_file)
|
|
else:
|
|
self.code_size_generator.size_generator_write_record(
|
|
size_version.revision, self.cal_code_size(size_version),
|
|
output_file)
|
|
|
|
def gen_code_size_comparison(self) -> None:
|
|
"""Generate results of code size changes between two revisions,
|
|
old and new.
|
|
|
|
- Measured code size results of these two revisions must be available.
|
|
- The result is directed into either file / stdout depending on
|
|
the option, code_size_common.result_options.stdout. (Default: file)
|
|
"""
|
|
|
|
self.logger.info("Start to generate comparision result between "\
|
|
"{} and {}."
|
|
.format(self.old_size_version.revision,
|
|
self.new_size_version.revision))
|
|
output_file = os.path.join(
|
|
self.result_dir,
|
|
self.gen_file_name(self.old_size_version, self.new_size_version))
|
|
|
|
self.code_size_generator.size_generator_write_comparison(
|
|
self.old_size_version.revision, self.new_size_version.revision,
|
|
output_file, self.code_size_common.result_options)
|
|
|
|
def get_comparision_results(self) -> None:
|
|
"""Compare size of library/*.o between self.old_size_version and
|
|
self.old_size_version and generate the result file."""
|
|
build_tree.check_repo_path()
|
|
self.gen_code_size_report(self.old_size_version)
|
|
self.gen_code_size_report(self.new_size_version)
|
|
self.gen_code_size_comparison()
|
|
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(description=(__doc__))
|
|
group_required = parser.add_argument_group(
|
|
'required arguments',
|
|
'required arguments to parse for running ' + os.path.basename(__file__))
|
|
group_required.add_argument(
|
|
'-o', '--old-rev', type=str, required=True,
|
|
help='old revision for comparison.')
|
|
|
|
group_optional = parser.add_argument_group(
|
|
'optional arguments',
|
|
'optional arguments to parse for running ' + os.path.basename(__file__))
|
|
group_optional.add_argument(
|
|
'-r', '--result-dir', type=str, default='comparison',
|
|
help='directory where comparison result is stored. '
|
|
'(Default: comparison)')
|
|
group_optional.add_argument(
|
|
'-n', '--new-rev', type=str, default=None,
|
|
help='new revision as comparison base. '
|
|
'(Default is the current work directory, including uncommitted '
|
|
'changes.)')
|
|
group_optional.add_argument(
|
|
'-a', '--arch', type=str, default=detect_arch(),
|
|
choices=list(map(lambda s: s.value, SupportedArch)),
|
|
help='Specify architecture for code size comparison. '
|
|
'(Default is the host architecture.)')
|
|
group_optional.add_argument(
|
|
'-c', '--config', type=str, default=SupportedConfig.DEFAULT.value,
|
|
choices=list(map(lambda s: s.value, SupportedConfig)),
|
|
help='Specify configuration type for code size comparison. '
|
|
'(Default is the current MbedTLS configuration.)')
|
|
group_optional.add_argument(
|
|
'--markdown', action='store_true', dest='markdown',
|
|
help='Show comparision of code size in a markdown table. '
|
|
'(Only show the files that have changed).')
|
|
group_optional.add_argument(
|
|
'--stdout', action='store_true', dest='stdout',
|
|
help='Set this option to direct comparison result into sys.stdout. '
|
|
'(Default: file)')
|
|
group_optional.add_argument(
|
|
'--verbose', action='store_true', dest='verbose',
|
|
help='Show logs in detail for code size measurement. '
|
|
'(Default: False)')
|
|
comp_args = parser.parse_args()
|
|
|
|
logger = logging.getLogger()
|
|
logging_util.configure_logger(logger)
|
|
logger.setLevel(logging.DEBUG if comp_args.verbose else logging.INFO)
|
|
|
|
if os.path.isfile(comp_args.result_dir):
|
|
logger.error("{} is not a directory".format(comp_args.result_dir))
|
|
parser.exit()
|
|
|
|
old_revision = CodeSizeCalculator.validate_revision(comp_args.old_rev)
|
|
if comp_args.new_rev is not None:
|
|
new_revision = CodeSizeCalculator.validate_revision(comp_args.new_rev)
|
|
else:
|
|
new_revision = "current"
|
|
|
|
old_size_version = SimpleNamespace(
|
|
version='old',
|
|
revision=old_revision,
|
|
config=comp_args.config,
|
|
arch=comp_args.arch,
|
|
make_cmd='',
|
|
)
|
|
new_size_version = SimpleNamespace(
|
|
version='new',
|
|
revision=new_revision,
|
|
config=comp_args.config,
|
|
arch=comp_args.arch,
|
|
make_cmd='',
|
|
)
|
|
code_size_common = SimpleNamespace(
|
|
result_options=SimpleNamespace(
|
|
result_dir=comp_args.result_dir,
|
|
with_markdown=comp_args.markdown,
|
|
stdout=comp_args.stdout,
|
|
),
|
|
host_arch=detect_arch(),
|
|
measure_cmd='size -t',
|
|
)
|
|
|
|
logger.info("Measure code size between {}:{}-{} and {}:{}-{} by `{}`."
|
|
.format(old_size_version.revision, old_size_version.config,
|
|
old_size_version.arch,
|
|
new_size_version.revision, old_size_version.config,
|
|
new_size_version.arch,
|
|
code_size_common.measure_cmd.strip().split(' ')[0]))
|
|
CodeSizeComparison(old_size_version, new_size_version,
|
|
code_size_common, logger).get_comparision_results()
|
|
|
|
if __name__ == "__main__":
|
|
main()
|