Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
| 2 | |
| 3 | """ |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 4 | This script is for comparing the size of the library files from two |
| 5 | different Git revisions within an Mbed TLS repository. |
| 6 | The results of the comparison is formatted as csv and stored at a |
| 7 | configurable location. |
| 8 | Note: must be run from Mbed TLS root. |
| 9 | """ |
| 10 | |
| 11 | # Copyright The Mbed TLS Contributors |
| 12 | # SPDX-License-Identifier: Apache-2.0 |
| 13 | # |
| 14 | # Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 15 | # not use this file except in compliance with the License. |
| 16 | # You may obtain a copy of the License at |
| 17 | # |
| 18 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 19 | # |
| 20 | # Unless required by applicable law or agreed to in writing, software |
| 21 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 22 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 23 | # See the License for the specific language governing permissions and |
| 24 | # limitations under the License. |
| 25 | |
| 26 | import argparse |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 27 | import logging |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 28 | import os |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 29 | import re |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 30 | import shutil |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 31 | import subprocess |
| 32 | import sys |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 33 | import typing |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 34 | from enum import Enum |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 35 | |
Gilles Peskine | d9071e7 | 2022-09-18 21:17:09 +0200 | [diff] [blame] | 36 | from mbedtls_dev import build_tree |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 37 | from mbedtls_dev import logging_util |
| 38 | from mbedtls_dev import typing_util |
Gilles Peskine | d9071e7 | 2022-09-18 21:17:09 +0200 | [diff] [blame] | 39 | |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 40 | class SupportedArch(Enum): |
| 41 | """Supported architecture for code size measurement.""" |
| 42 | AARCH64 = 'aarch64' |
| 43 | AARCH32 = 'aarch32' |
Yanray Wang | aba7158 | 2023-05-29 16:45:56 +0800 | [diff] [blame] | 44 | ARMV8_M = 'armv8-m' |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 45 | X86_64 = 'x86_64' |
| 46 | X86 = 'x86' |
| 47 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 48 | |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 49 | class SupportedConfig(Enum): |
| 50 | """Supported configuration for code size measurement.""" |
| 51 | DEFAULT = 'default' |
| 52 | TFM_MEDIUM = 'tfm-medium' |
| 53 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 54 | |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 55 | # Static library |
| 56 | MBEDTLS_STATIC_LIB = { |
| 57 | 'CRYPTO': 'library/libmbedcrypto.a', |
| 58 | 'X509': 'library/libmbedx509.a', |
| 59 | 'TLS': 'library/libmbedtls.a', |
| 60 | } |
| 61 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 62 | class CodeSizeDistinctInfo: # pylint: disable=too-few-public-methods |
| 63 | """Data structure to store possibly distinct information for code size |
| 64 | comparison.""" |
| 65 | def __init__( #pylint: disable=too-many-arguments |
| 66 | self, |
| 67 | version: str, |
| 68 | git_rev: str, |
| 69 | arch: str, |
| 70 | config: str, |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 71 | compiler: str, |
| 72 | opt_level: str, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 73 | ) -> None: |
| 74 | """ |
| 75 | :param: version: which version to compare with for code size. |
| 76 | :param: git_rev: Git revision to calculate code size. |
| 77 | :param: arch: architecture to measure code size on. |
| 78 | :param: config: Configuration type to calculate code size. |
| 79 | (See SupportedConfig) |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 80 | :param: compiler: compiler used to build library/*.o. |
| 81 | :param: opt_level: Options that control optimization. (E.g. -Os) |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 82 | """ |
| 83 | self.version = version |
| 84 | self.git_rev = git_rev |
| 85 | self.arch = arch |
| 86 | self.config = config |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 87 | self.compiler = compiler |
| 88 | self.opt_level = opt_level |
| 89 | # Note: Variables below are not initialized by class instantiation. |
| 90 | self.pre_make_cmd = [] #type: typing.List[str] |
| 91 | self.make_cmd = '' |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 92 | |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 93 | def get_info_indication(self): |
| 94 | """Return a unique string to indicate Code Size Distinct Information.""" |
Yanray Wang | 6ef5049 | 2023-07-26 14:59:37 +0800 | [diff] [blame] | 95 | return '{git_rev}-{arch}-{config}-{compiler}'.format(**self.__dict__) |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 96 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 97 | |
| 98 | class CodeSizeCommonInfo: # pylint: disable=too-few-public-methods |
| 99 | """Data structure to store common information for code size comparison.""" |
| 100 | def __init__( |
| 101 | self, |
| 102 | host_arch: str, |
| 103 | measure_cmd: str, |
| 104 | ) -> None: |
| 105 | """ |
| 106 | :param host_arch: host architecture. |
| 107 | :param measure_cmd: command to measure code size for library/*.o. |
| 108 | """ |
| 109 | self.host_arch = host_arch |
| 110 | self.measure_cmd = measure_cmd |
| 111 | |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 112 | def get_info_indication(self): |
| 113 | """Return a unique string to indicate Code Size Common Information.""" |
Yanray Wang | e4a3636 | 2023-07-25 10:37:11 +0800 | [diff] [blame] | 114 | return '{measure_tool}'\ |
| 115 | .format(measure_tool=self.measure_cmd.strip().split(' ')[0]) |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 116 | |
| 117 | class CodeSizeResultInfo: # pylint: disable=too-few-public-methods |
| 118 | """Data structure to store result options for code size comparison.""" |
| 119 | def __init__( |
| 120 | self, |
| 121 | record_dir: str, |
| 122 | comp_dir: str, |
| 123 | with_markdown=False, |
| 124 | stdout=False, |
| 125 | ) -> None: |
| 126 | """ |
| 127 | :param record_dir: directory to store code size record. |
| 128 | :param comp_dir: directory to store results of code size comparision. |
| 129 | :param with_markdown: write comparision result into a markdown table. |
| 130 | (Default: False) |
| 131 | :param stdout: direct comparison result into sys.stdout. |
| 132 | (Default False) |
| 133 | """ |
| 134 | self.record_dir = record_dir |
| 135 | self.comp_dir = comp_dir |
| 136 | self.with_markdown = with_markdown |
| 137 | self.stdout = stdout |
| 138 | |
| 139 | |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 140 | DETECT_ARCH_CMD = "cc -dM -E - < /dev/null" |
| 141 | def detect_arch() -> str: |
| 142 | """Auto-detect host architecture.""" |
| 143 | cc_output = subprocess.check_output(DETECT_ARCH_CMD, shell=True).decode() |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 144 | if '__aarch64__' in cc_output: |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 145 | return SupportedArch.AARCH64.value |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 146 | if '__arm__' in cc_output: |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 147 | return SupportedArch.AARCH32.value |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 148 | if '__x86_64__' in cc_output: |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 149 | return SupportedArch.X86_64.value |
Yanray Wang | ca9a3cb | 2023-07-26 17:16:29 +0800 | [diff] [blame] | 150 | if '__i386__' in cc_output: |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 151 | return SupportedArch.X86.value |
| 152 | else: |
| 153 | print("Unknown host architecture, cannot auto-detect arch.") |
| 154 | sys.exit(1) |
Gilles Peskine | d9071e7 | 2022-09-18 21:17:09 +0200 | [diff] [blame] | 155 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 156 | TFM_MEDIUM_CONFIG_H = 'configs/tfm_mbedcrypto_config_profile_medium.h' |
| 157 | TFM_MEDIUM_CRYPTO_CONFIG_H = 'configs/crypto_config_profile_medium.h' |
| 158 | |
| 159 | CONFIG_H = 'include/mbedtls/mbedtls_config.h' |
| 160 | CRYPTO_CONFIG_H = 'include/psa/crypto_config.h' |
| 161 | BACKUP_SUFFIX = '.code_size.bak' |
| 162 | |
Yanray Wang | 923f943 | 2023-07-17 12:43:00 +0800 | [diff] [blame] | 163 | class CodeSizeBuildInfo: # pylint: disable=too-few-public-methods |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 164 | """Gather information used to measure code size. |
| 165 | |
| 166 | It collects information about architecture, configuration in order to |
| 167 | infer build command for code size measurement. |
| 168 | """ |
| 169 | |
Yanray Wang | c18cd89 | 2023-05-31 11:08:04 +0800 | [diff] [blame] | 170 | SupportedArchConfig = [ |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 171 | '-a ' + SupportedArch.AARCH64.value + ' -c ' + SupportedConfig.DEFAULT.value, |
| 172 | '-a ' + SupportedArch.AARCH32.value + ' -c ' + SupportedConfig.DEFAULT.value, |
| 173 | '-a ' + SupportedArch.X86_64.value + ' -c ' + SupportedConfig.DEFAULT.value, |
| 174 | '-a ' + SupportedArch.X86.value + ' -c ' + SupportedConfig.DEFAULT.value, |
| 175 | '-a ' + SupportedArch.ARMV8_M.value + ' -c ' + SupportedConfig.TFM_MEDIUM.value, |
Yanray Wang | c18cd89 | 2023-05-31 11:08:04 +0800 | [diff] [blame] | 176 | ] |
| 177 | |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 178 | def __init__( |
| 179 | self, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 180 | size_dist_info: CodeSizeDistinctInfo, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 181 | host_arch: str, |
| 182 | logger: logging.Logger, |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 183 | ) -> None: |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 184 | """ |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 185 | :param size_dist_info: |
| 186 | CodeSizeDistinctInfo containing info for code size measurement. |
| 187 | - size_dist_info.arch: architecture to measure code size on. |
| 188 | - size_dist_info.config: configuration type to measure |
| 189 | code size with. |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 190 | - size_dist_info.compiler: compiler used to build library/*.o. |
| 191 | - size_dist_info.opt_level: Options that control optimization. |
| 192 | (E.g. -Os) |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 193 | :param host_arch: host architecture. |
| 194 | :param logger: logging module |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 195 | """ |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 196 | self.arch = size_dist_info.arch |
| 197 | self.config = size_dist_info.config |
| 198 | self.compiler = size_dist_info.compiler |
| 199 | self.opt_level = size_dist_info.opt_level |
| 200 | |
| 201 | self.make_cmd = ['make', '-j', 'lib'] |
| 202 | |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 203 | self.host_arch = host_arch |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 204 | self.logger = logger |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 205 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 206 | def check_correctness(self) -> bool: |
| 207 | """Check whether we are using proper / supported combination |
| 208 | of information to build library/*.o.""" |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 209 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 210 | # default config |
| 211 | if self.config == SupportedConfig.DEFAULT.value and \ |
| 212 | self.arch == self.host_arch: |
| 213 | return True |
| 214 | # TF-M |
| 215 | elif self.arch == SupportedArch.ARMV8_M.value and \ |
| 216 | self.config == SupportedConfig.TFM_MEDIUM.value: |
| 217 | return True |
| 218 | |
| 219 | return False |
| 220 | |
| 221 | def infer_pre_make_command(self) -> typing.List[str]: |
| 222 | """Infer command to set up proper configuration before running make.""" |
| 223 | pre_make_cmd = [] #type: typing.List[str] |
| 224 | if self.config == SupportedConfig.TFM_MEDIUM.value: |
Yanray Wang | a279ca9 | 2023-07-26 15:01:10 +0800 | [diff] [blame] | 225 | pre_make_cmd.append('cp {src} {dest}' |
Yanray Wang | e4a3636 | 2023-07-25 10:37:11 +0800 | [diff] [blame] | 226 | .format(src=TFM_MEDIUM_CONFIG_H, dest=CONFIG_H)) |
Yanray Wang | a279ca9 | 2023-07-26 15:01:10 +0800 | [diff] [blame] | 227 | pre_make_cmd.append('cp {src} {dest}' |
Yanray Wang | e4a3636 | 2023-07-25 10:37:11 +0800 | [diff] [blame] | 228 | .format(src=TFM_MEDIUM_CRYPTO_CONFIG_H, |
| 229 | dest=CRYPTO_CONFIG_H)) |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 230 | |
| 231 | return pre_make_cmd |
| 232 | |
| 233 | def infer_make_cflags(self) -> str: |
| 234 | """Infer CFLAGS by instance attributes in CodeSizeDistinctInfo.""" |
| 235 | cflags = [] #type: typing.List[str] |
| 236 | |
| 237 | # set optimization level |
| 238 | cflags.append(self.opt_level) |
| 239 | # set compiler by config |
| 240 | if self.config == SupportedConfig.TFM_MEDIUM.value: |
| 241 | self.compiler = 'armclang' |
| 242 | cflags.append('-mcpu=cortex-m33') |
| 243 | # set target |
| 244 | if self.compiler == 'armclang': |
| 245 | cflags.append('--target=arm-arm-none-eabi') |
| 246 | |
| 247 | return ' '.join(cflags) |
| 248 | |
| 249 | def infer_make_command(self) -> str: |
| 250 | """Infer make command by CFLAGS and CC.""" |
| 251 | |
| 252 | if self.check_correctness(): |
| 253 | # set CFLAGS= |
| 254 | self.make_cmd.append('CFLAGS=\'{}\''.format(self.infer_make_cflags())) |
| 255 | # set CC= |
| 256 | self.make_cmd.append('CC={}'.format(self.compiler)) |
| 257 | return ' '.join(self.make_cmd) |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 258 | else: |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 259 | self.logger.error("Unsupported combination of architecture: {} " \ |
| 260 | "and configuration: {}.\n" |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 261 | .format(self.arch, |
| 262 | self.config)) |
Yanray Wang | 2ba9df2 | 2023-07-26 10:11:31 +0800 | [diff] [blame] | 263 | self.logger.error("Please use supported combination of " \ |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 264 | "architecture and configuration:") |
Yanray Wang | 923f943 | 2023-07-17 12:43:00 +0800 | [diff] [blame] | 265 | for comb in CodeSizeBuildInfo.SupportedArchConfig: |
Yanray Wang | 2ba9df2 | 2023-07-26 10:11:31 +0800 | [diff] [blame] | 266 | self.logger.error(comb) |
| 267 | self.logger.error("") |
| 268 | self.logger.error("For your system, please use:") |
Yanray Wang | 923f943 | 2023-07-17 12:43:00 +0800 | [diff] [blame] | 269 | for comb in CodeSizeBuildInfo.SupportedArchConfig: |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 270 | if "default" in comb and self.host_arch not in comb: |
Yanray Wang | 21f1744 | 2023-06-01 11:29:06 +0800 | [diff] [blame] | 271 | continue |
Yanray Wang | 2ba9df2 | 2023-07-26 10:11:31 +0800 | [diff] [blame] | 272 | self.logger.error(comb) |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 273 | sys.exit(1) |
| 274 | |
| 275 | |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 276 | class CodeSizeCalculator: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 277 | """ A calculator to calculate code size of library/*.o based on |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 278 | Git revision and code size measurement tool. |
| 279 | """ |
| 280 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 281 | def __init__( #pylint: disable=too-many-arguments |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 282 | self, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 283 | git_rev: str, |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 284 | pre_make_cmd: typing.List[str], |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 285 | make_cmd: str, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 286 | measure_cmd: str, |
| 287 | logger: logging.Logger, |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 288 | ) -> None: |
| 289 | """ |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 290 | :param git_rev: Git revision. (E.g: commit) |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 291 | :param pre_make_cmd: command to set up proper config before running make. |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 292 | :param make_cmd: command to build library/*.o. |
| 293 | :param measure_cmd: command to measure code size for library/*.o. |
| 294 | :param logger: logging module |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 295 | """ |
| 296 | self.repo_path = "." |
| 297 | self.git_command = "git" |
| 298 | self.make_clean = 'make clean' |
| 299 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 300 | self.git_rev = git_rev |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 301 | self.pre_make_cmd = pre_make_cmd |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 302 | self.make_cmd = make_cmd |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 303 | self.measure_cmd = measure_cmd |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 304 | self.logger = logger |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 305 | |
| 306 | @staticmethod |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 307 | def validate_git_revision(git_rev: str) -> str: |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 308 | result = subprocess.check_output(["git", "rev-parse", "--verify", |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 309 | git_rev + "^{commit}"], |
| 310 | shell=False, universal_newlines=True) |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 311 | return result[:7] |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 312 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 313 | def _create_git_worktree(self) -> str: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 314 | """Create a separate worktree for Git revision. |
| 315 | If Git revision is current, use current worktree instead.""" |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 316 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 317 | if self.git_rev == 'current': |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 318 | self.logger.debug("Using current work directory.") |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 319 | git_worktree_path = self.repo_path |
| 320 | else: |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 321 | self.logger.debug("Creating git worktree for {}." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 322 | .format(self.git_rev)) |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 323 | git_worktree_path = os.path.join(self.repo_path, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 324 | "temp-" + self.git_rev) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 325 | subprocess.check_output( |
| 326 | [self.git_command, "worktree", "add", "--detach", |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 327 | git_worktree_path, self.git_rev], cwd=self.repo_path, |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 328 | stderr=subprocess.STDOUT |
| 329 | ) |
| 330 | |
| 331 | return git_worktree_path |
| 332 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 333 | @staticmethod |
| 334 | def backup_config_files(restore: bool) -> None: |
| 335 | """Backup / Restore config files.""" |
| 336 | if restore: |
| 337 | shutil.move(CONFIG_H + BACKUP_SUFFIX, CONFIG_H) |
| 338 | shutil.move(CRYPTO_CONFIG_H + BACKUP_SUFFIX, CRYPTO_CONFIG_H) |
| 339 | else: |
| 340 | shutil.copy(CONFIG_H, CONFIG_H + BACKUP_SUFFIX) |
| 341 | shutil.copy(CRYPTO_CONFIG_H, CRYPTO_CONFIG_H + BACKUP_SUFFIX) |
| 342 | |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 343 | def _build_libraries(self, git_worktree_path: str) -> None: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 344 | """Build library/*.o in the specified worktree.""" |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 345 | |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 346 | self.logger.debug("Building library/*.o for {}." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 347 | .format(self.git_rev)) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 348 | my_environment = os.environ.copy() |
| 349 | try: |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 350 | if self.git_rev == 'current': |
| 351 | self.backup_config_files(restore=False) |
| 352 | for pre_cmd in self.pre_make_cmd: |
| 353 | subprocess.check_output( |
| 354 | pre_cmd, env=my_environment, shell=True, |
| 355 | cwd=git_worktree_path, stderr=subprocess.STDOUT, |
| 356 | universal_newlines=True |
| 357 | ) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 358 | subprocess.check_output( |
| 359 | self.make_clean, env=my_environment, shell=True, |
| 360 | cwd=git_worktree_path, stderr=subprocess.STDOUT, |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 361 | universal_newlines=True |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 362 | ) |
| 363 | subprocess.check_output( |
| 364 | self.make_cmd, env=my_environment, shell=True, |
| 365 | cwd=git_worktree_path, stderr=subprocess.STDOUT, |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 366 | universal_newlines=True |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 367 | ) |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 368 | if self.git_rev == 'current': |
| 369 | self.backup_config_files(restore=True) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 370 | except subprocess.CalledProcessError as e: |
| 371 | self._handle_called_process_error(e, git_worktree_path) |
| 372 | |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 373 | def _gen_raw_code_size(self, git_worktree_path: str) -> typing.Dict[str, str]: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 374 | """Measure code size by a tool and return in UTF-8 encoding.""" |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 375 | |
| 376 | self.logger.debug("Measuring code size for {} by `{}`." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 377 | .format(self.git_rev, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 378 | self.measure_cmd.strip().split(' ')[0])) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 379 | |
| 380 | res = {} |
| 381 | for mod, st_lib in MBEDTLS_STATIC_LIB.items(): |
| 382 | try: |
| 383 | result = subprocess.check_output( |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 384 | [self.measure_cmd + ' ' + st_lib], cwd=git_worktree_path, |
| 385 | shell=True, universal_newlines=True |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 386 | ) |
| 387 | res[mod] = result |
| 388 | except subprocess.CalledProcessError as e: |
| 389 | self._handle_called_process_error(e, git_worktree_path) |
| 390 | |
| 391 | return res |
| 392 | |
| 393 | def _remove_worktree(self, git_worktree_path: str) -> None: |
| 394 | """Remove temporary worktree.""" |
| 395 | if git_worktree_path != self.repo_path: |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 396 | self.logger.debug("Removing temporary worktree {}." |
| 397 | .format(git_worktree_path)) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 398 | subprocess.check_output( |
| 399 | [self.git_command, "worktree", "remove", "--force", |
| 400 | git_worktree_path], cwd=self.repo_path, |
| 401 | stderr=subprocess.STDOUT |
| 402 | ) |
| 403 | |
| 404 | def _handle_called_process_error(self, e: subprocess.CalledProcessError, |
| 405 | git_worktree_path: str) -> None: |
| 406 | """Handle a CalledProcessError and quit the program gracefully. |
| 407 | Remove any extra worktrees so that the script may be called again.""" |
| 408 | |
| 409 | # Tell the user what went wrong |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 410 | self.logger.error(e, exc_info=True) |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 411 | self.logger.error("Process output:\n {}".format(e.output)) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 412 | |
| 413 | # Quit gracefully by removing the existing worktree |
| 414 | self._remove_worktree(git_worktree_path) |
| 415 | sys.exit(-1) |
| 416 | |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 417 | def cal_libraries_code_size(self) -> typing.Dict[str, str]: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 418 | """Do a complete round to calculate code size of library/*.o |
| 419 | by measurement tool. |
| 420 | |
| 421 | :return A dictionary of measured code size |
| 422 | - typing.Dict[mod: str] |
| 423 | """ |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 424 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 425 | git_worktree_path = self._create_git_worktree() |
Yanray Wang | 6ae94a0 | 2023-07-26 17:12:57 +0800 | [diff] [blame] | 426 | try: |
| 427 | self._build_libraries(git_worktree_path) |
| 428 | res = self._gen_raw_code_size(git_worktree_path) |
| 429 | finally: |
| 430 | self._remove_worktree(git_worktree_path) |
Yanray Wang | e0e2760 | 2023-07-14 17:37:45 +0800 | [diff] [blame] | 431 | |
| 432 | return res |
| 433 | |
| 434 | |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 435 | class CodeSizeGenerator: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 436 | """ A generator based on size measurement tool for library/*.o. |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 437 | |
| 438 | This is an abstract class. To use it, derive a class that implements |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 439 | write_record and write_comparison methods, then call both of them with |
| 440 | proper arguments. |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 441 | """ |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 442 | def __init__(self, logger: logging.Logger) -> None: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 443 | """ |
| 444 | :param logger: logging module |
| 445 | """ |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 446 | self.logger = logger |
| 447 | |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 448 | def write_record( |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 449 | self, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 450 | git_rev: str, |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 451 | code_size_text: typing.Dict[str, str], |
| 452 | output: typing_util.Writable |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 453 | ) -> None: |
| 454 | """Write size record into a file. |
| 455 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 456 | :param git_rev: Git revision. (E.g: commit) |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 457 | :param code_size_text: |
| 458 | string output (utf-8) from measurement tool of code size. |
| 459 | - typing.Dict[mod: str] |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 460 | :param output: output stream which the code size record is written to. |
| 461 | (Note: Normally write code size record into File) |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 462 | """ |
| 463 | raise NotImplementedError |
| 464 | |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 465 | def write_comparison( |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 466 | self, |
| 467 | old_rev: str, |
| 468 | new_rev: str, |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 469 | output: typing_util.Writable, |
| 470 | with_markdown=False |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 471 | ) -> None: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 472 | """Write a comparision result into a stream between two Git revisions. |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 473 | |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 474 | :param old_rev: old Git revision to compared with. |
| 475 | :param new_rev: new Git revision to compared with. |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 476 | :param output: output stream which the code size record is written to. |
| 477 | (File / sys.stdout) |
| 478 | :param with_markdown: write comparision result in a markdown table. |
| 479 | (Default: False) |
Yanray Wang | 15c43f3 | 2023-07-17 11:17:12 +0800 | [diff] [blame] | 480 | """ |
| 481 | raise NotImplementedError |
| 482 | |
| 483 | |
| 484 | class CodeSizeGeneratorWithSize(CodeSizeGenerator): |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 485 | """Code Size Base Class for size record saving and writing.""" |
| 486 | |
Yanray Wang | fc6ed4d | 2023-07-14 17:33:09 +0800 | [diff] [blame] | 487 | class SizeEntry: # pylint: disable=too-few-public-methods |
| 488 | """Data Structure to only store information of code size.""" |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 489 | def __init__(self, text: int, data: int, bss: int, dec: int): |
Yanray Wang | fc6ed4d | 2023-07-14 17:33:09 +0800 | [diff] [blame] | 490 | self.text = text |
| 491 | self.data = data |
| 492 | self.bss = bss |
| 493 | self.total = dec # total <=> dec |
| 494 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 495 | def __init__(self, logger: logging.Logger) -> None: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 496 | """ Variable code_size is used to store size info for any Git revisions. |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 497 | :param code_size: |
| 498 | Data Format as following: |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 499 | code_size = { |
| 500 | git_rev: { |
| 501 | module: { |
| 502 | file_name: SizeEntry, |
| 503 | ... |
| 504 | }, |
| 505 | ... |
| 506 | }, |
| 507 | ... |
| 508 | } |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 509 | """ |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 510 | super().__init__(logger) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 511 | self.code_size = {} #type: typing.Dict[str, typing.Dict] |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 512 | self.mod_total_suffix = '-' + 'TOTALS' |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 513 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 514 | def _set_size_record(self, git_rev: str, mod: str, size_text: str) -> None: |
| 515 | """Store size information for target Git revision and high-level module. |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 516 | |
| 517 | size_text Format: text data bss dec hex filename |
| 518 | """ |
| 519 | size_record = {} |
| 520 | for line in size_text.splitlines()[1:]: |
| 521 | data = line.split() |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 522 | if re.match(r'\s*\(TOTALS\)', data[5]): |
| 523 | data[5] = mod + self.mod_total_suffix |
Yanray Wang | 9b174e9 | 2023-07-17 17:59:53 +0800 | [diff] [blame] | 524 | # file_name: SizeEntry(text, data, bss, dec) |
| 525 | size_record[data[5]] = CodeSizeGeneratorWithSize.SizeEntry( |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 526 | int(data[0]), int(data[1]), int(data[2]), int(data[3])) |
Yanray Wang | 6ef5049 | 2023-07-26 14:59:37 +0800 | [diff] [blame] | 527 | self.code_size.setdefault(git_rev, {}).update({mod: size_record}) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 528 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 529 | def read_size_record(self, git_rev: str, fname: str) -> None: |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 530 | """Read size information from csv file and write it into code_size. |
| 531 | |
| 532 | fname Format: filename text data bss dec |
| 533 | """ |
| 534 | mod = "" |
| 535 | size_record = {} |
| 536 | with open(fname, 'r') as csv_file: |
| 537 | for line in csv_file: |
| 538 | data = line.strip().split() |
| 539 | # check if we find the beginning of a module |
| 540 | if data and data[0] in MBEDTLS_STATIC_LIB: |
| 541 | mod = data[0] |
| 542 | continue |
| 543 | |
| 544 | if mod: |
Yanray Wang | 9b174e9 | 2023-07-17 17:59:53 +0800 | [diff] [blame] | 545 | # file_name: SizeEntry(text, data, bss, dec) |
| 546 | size_record[data[0]] = CodeSizeGeneratorWithSize.SizeEntry( |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 547 | int(data[1]), int(data[2]), int(data[3]), int(data[4])) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 548 | |
| 549 | # check if we hit record for the end of a module |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 550 | m = re.match(r'\w+' + self.mod_total_suffix, line) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 551 | if m: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 552 | if git_rev in self.code_size: |
| 553 | self.code_size[git_rev].update({mod: size_record}) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 554 | else: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 555 | self.code_size[git_rev] = {mod: size_record} |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 556 | mod = "" |
| 557 | size_record = {} |
| 558 | |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 559 | def write_record( |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 560 | self, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 561 | git_rev: str, |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 562 | code_size_text: typing.Dict[str, str], |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 563 | output: typing_util.Writable |
| 564 | ) -> None: |
| 565 | """Write size information to a file. |
| 566 | |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 567 | Writing Format: filename text data bss total(dec) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 568 | """ |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 569 | for mod, size_text in code_size_text.items(): |
| 570 | self._set_size_record(git_rev, mod, size_text) |
| 571 | |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 572 | format_string = "{:<30} {:>7} {:>7} {:>7} {:>7}\n" |
| 573 | output.write(format_string.format("filename", |
| 574 | "text", "data", "bss", "total")) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 575 | |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 576 | for mod, f_size in self.code_size[git_rev].items(): |
| 577 | output.write("\n" + mod + "\n") |
| 578 | for fname, size_entry in f_size.items(): |
| 579 | output.write(format_string |
| 580 | .format(fname, |
| 581 | size_entry.text, size_entry.data, |
| 582 | size_entry.bss, size_entry.total)) |
| 583 | |
| 584 | def write_comparison( # pylint: disable=too-many-locals |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 585 | self, |
| 586 | old_rev: str, |
| 587 | new_rev: str, |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 588 | output: typing_util.Writable, |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 589 | with_markdown=False |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 590 | ) -> None: |
| 591 | """Write comparison result into a file. |
| 592 | |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 593 | Writing Format: filename new(text) new(data) change(text) change(data) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 594 | """ |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 595 | header_line = ["filename", "new(text)", "change(text)", "new(data)", |
| 596 | "change(data)"] |
Yanray Wang | 9b174e9 | 2023-07-17 17:59:53 +0800 | [diff] [blame] | 597 | |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 598 | if with_markdown: |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 599 | dash_line = [":----", "----:", "----:", "----:", "----:"] |
| 600 | line_format = "| {0:<30} | {1:<10} | {3:<10} | {2:<12} | {4:<12} |\n" |
| 601 | bold_text = lambda x: '**' + str(x) + '**' |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 602 | else: |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 603 | line_format = "{0:<30} {1:<10} {3:<10} {2:<12} {4:<12}\n" |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 604 | |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 605 | def cal_sect_change( |
| 606 | old_size: typing.Optional[CodeSizeGeneratorWithSize.SizeEntry], |
| 607 | new_size: typing.Optional[CodeSizeGeneratorWithSize.SizeEntry], |
| 608 | sect: str |
| 609 | ) -> typing.List: |
| 610 | """Inner helper function to calculate size change for a section. |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 611 | |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 612 | Convention for special cases: |
| 613 | - If the object has been removed in new Git revision, |
| 614 | the size is minus code size of old Git revision; |
| 615 | the size change is marked as `Removed`, |
| 616 | - If the object only exists in new Git revision, |
| 617 | the size is code size of new Git revision; |
| 618 | the size change is marked as `None`, |
Yanray Wang | 9b174e9 | 2023-07-17 17:59:53 +0800 | [diff] [blame] | 619 | |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 620 | :param: old_size: code size for objects in old Git revision. |
| 621 | :param: new_size: code size for objects in new Git revision. |
| 622 | :param: sect: section to calculate from `size` tool. This could be |
| 623 | any instance variable in SizeEntry. |
| 624 | :return: List of [section size of objects for new Git revision, |
| 625 | section size change of objects between two Git revisions] |
| 626 | """ |
| 627 | if old_size and new_size: |
| 628 | new_attr = new_size.__dict__[sect] |
| 629 | change_attr = new_size.__dict__[sect] - old_size.__dict__[sect] |
| 630 | elif old_size: |
| 631 | new_attr = - old_size.__dict__[sect] |
| 632 | change_attr = 'Removed' |
| 633 | elif new_size: |
| 634 | new_attr = new_size.__dict__[sect] |
| 635 | change_attr = 'None' |
Yanray Wang | 9b174e9 | 2023-07-17 17:59:53 +0800 | [diff] [blame] | 636 | else: |
Yanray Wang | dcf360d | 2023-07-27 15:28:20 +0800 | [diff] [blame] | 637 | # Should never happen |
| 638 | new_attr = 'Error' |
| 639 | change_attr = 'Error' |
| 640 | return [new_attr, change_attr] |
| 641 | |
| 642 | # sort dictionary by key |
| 643 | sort_by_k = lambda item: item[0].lower() |
| 644 | def get_results( |
| 645 | f_rev_size: |
| 646 | typing.Dict[str, |
| 647 | typing.Dict[str, |
| 648 | CodeSizeGeneratorWithSize.SizeEntry]] |
| 649 | ) -> typing.List: |
| 650 | """Return List of results in the format of: |
| 651 | [filename, new(text), change(text), new(data), change(data)] |
| 652 | """ |
| 653 | res = [] |
| 654 | for fname, revs_size in sorted(f_rev_size.items(), key=sort_by_k): |
| 655 | old_size = revs_size.get(old_rev) |
| 656 | new_size = revs_size.get(new_rev) |
| 657 | |
| 658 | text_sect = cal_sect_change(old_size, new_size, 'text') |
| 659 | data_sect = cal_sect_change(old_size, new_size, 'data') |
| 660 | # skip the files that haven't changed in code size |
| 661 | if text_sect[1] == 0 and data_sect[1] == 0: |
| 662 | continue |
| 663 | |
| 664 | res.append([fname, *text_sect, *data_sect]) |
| 665 | return res |
| 666 | |
| 667 | # write header |
| 668 | output.write(line_format.format(*header_line)) |
| 669 | if with_markdown: |
| 670 | output.write(line_format.format(*dash_line)) |
| 671 | for mod in MBEDTLS_STATIC_LIB: |
| 672 | # convert self.code_size to: |
| 673 | # { |
| 674 | # file_name: { |
| 675 | # old_rev: SizeEntry, |
| 676 | # new_rev: SizeEntry |
| 677 | # }, |
| 678 | # ... |
| 679 | # } |
| 680 | f_rev_size = {} #type: typing.Dict[str, typing.Dict] |
| 681 | for fname, size_entry in self.code_size[old_rev][mod].items(): |
| 682 | f_rev_size.setdefault(fname, {}).update({old_rev: size_entry}) |
| 683 | for fname, size_entry in self.code_size[new_rev][mod].items(): |
| 684 | f_rev_size.setdefault(fname, {}).update({new_rev: size_entry}) |
| 685 | |
| 686 | mod_total_sz = f_rev_size.pop(mod + self.mod_total_suffix) |
| 687 | res = get_results(f_rev_size) |
| 688 | total_clm = get_results({mod + self.mod_total_suffix: mod_total_sz}) |
| 689 | if with_markdown: |
| 690 | # bold row of mod-TOTALS in markdown table |
| 691 | total_clm = [[bold_text(j) for j in i] for i in total_clm] |
| 692 | res += total_clm |
| 693 | |
| 694 | # write comparison result |
| 695 | for line in res: |
| 696 | output.write(line_format.format(*line)) |
Yanray Wang | 16ebc57 | 2023-05-30 18:10:20 +0800 | [diff] [blame] | 697 | |
| 698 | |
Yanray Wang | fc6ed4d | 2023-07-14 17:33:09 +0800 | [diff] [blame] | 699 | class CodeSizeComparison: |
Xiaofei Bai | 2400b50 | 2021-10-21 12:22:58 +0000 | [diff] [blame] | 700 | """Compare code size between two Git revisions.""" |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 701 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 702 | def __init__( #pylint: disable=too-many-arguments |
Yanray Wang | 72b105f | 2023-05-31 15:20:39 +0800 | [diff] [blame] | 703 | self, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 704 | old_size_dist_info: CodeSizeDistinctInfo, |
| 705 | new_size_dist_info: CodeSizeDistinctInfo, |
| 706 | size_common_info: CodeSizeCommonInfo, |
| 707 | result_options: CodeSizeResultInfo, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 708 | logger: logging.Logger, |
Yanray Wang | 72b105f | 2023-05-31 15:20:39 +0800 | [diff] [blame] | 709 | ) -> None: |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 710 | """ |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 711 | :param old_size_dist_info: CodeSizeDistinctInfo containing old distinct |
| 712 | info to compare code size with. |
| 713 | :param new_size_dist_info: CodeSizeDistinctInfo containing new distinct |
| 714 | info to take as comparision base. |
| 715 | :param size_common_info: CodeSizeCommonInfo containing common info for |
| 716 | both old and new size distinct info and |
| 717 | measurement tool. |
| 718 | :param result_options: CodeSizeResultInfo containing results options for |
| 719 | code size record and comparision. |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 720 | :param logger: logging module |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 721 | """ |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 722 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 723 | self.logger = logger |
| 724 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 725 | self.old_size_dist_info = old_size_dist_info |
| 726 | self.new_size_dist_info = new_size_dist_info |
| 727 | self.size_common_info = size_common_info |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 728 | # infer pre make command |
| 729 | self.old_size_dist_info.pre_make_cmd = CodeSizeBuildInfo( |
| 730 | self.old_size_dist_info, self.size_common_info.host_arch, |
| 731 | self.logger).infer_pre_make_command() |
| 732 | self.new_size_dist_info.pre_make_cmd = CodeSizeBuildInfo( |
| 733 | self.new_size_dist_info, self.size_common_info.host_arch, |
| 734 | self.logger).infer_pre_make_command() |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 735 | # infer make command |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 736 | self.old_size_dist_info.make_cmd = CodeSizeBuildInfo( |
| 737 | self.old_size_dist_info, self.size_common_info.host_arch, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 738 | self.logger).infer_make_command() |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 739 | self.new_size_dist_info.make_cmd = CodeSizeBuildInfo( |
| 740 | self.new_size_dist_info, self.size_common_info.host_arch, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 741 | self.logger).infer_make_command() |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 742 | # initialize size parser with corresponding measurement tool |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 743 | self.code_size_generator = self.__generate_size_parser() |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 744 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 745 | self.result_options = result_options |
| 746 | self.csv_dir = os.path.abspath(self.result_options.record_dir) |
| 747 | os.makedirs(self.csv_dir, exist_ok=True) |
| 748 | self.comp_dir = os.path.abspath(self.result_options.comp_dir) |
| 749 | os.makedirs(self.comp_dir, exist_ok=True) |
| 750 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 751 | def __generate_size_parser(self): |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 752 | """Generate a parser for the corresponding measurement tool.""" |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 753 | if re.match(r'size', self.size_common_info.measure_cmd.strip()): |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 754 | return CodeSizeGeneratorWithSize(self.logger) |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 755 | else: |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 756 | self.logger.error("Unsupported measurement tool: `{}`." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 757 | .format(self.size_common_info.measure_cmd |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 758 | .strip().split(' ')[0])) |
Yanray Wang | 802af16 | 2023-07-17 14:04:30 +0800 | [diff] [blame] | 759 | sys.exit(1) |
| 760 | |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 761 | def cal_code_size( |
| 762 | self, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 763 | size_dist_info: CodeSizeDistinctInfo |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 764 | ) -> typing.Dict[str, str]: |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 765 | """Calculate code size of library/*.o in a UTF-8 encoding""" |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 766 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 767 | return CodeSizeCalculator(size_dist_info.git_rev, |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 768 | size_dist_info.pre_make_cmd, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 769 | size_dist_info.make_cmd, |
| 770 | self.size_common_info.measure_cmd, |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 771 | self.logger).cal_libraries_code_size() |
Yanray Wang | 8804db9 | 2023-05-30 18:18:18 +0800 | [diff] [blame] | 772 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 773 | def gen_code_size_report(self, size_dist_info: CodeSizeDistinctInfo) -> None: |
Yanray Wang | 5e9130a | 2023-07-17 11:55:54 +0800 | [diff] [blame] | 774 | """Generate code size record and write it into a file.""" |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 775 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 776 | self.logger.info("Start to generate code size record for {}." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 777 | .format(size_dist_info.git_rev)) |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 778 | output_file = os.path.join( |
| 779 | self.csv_dir, |
| 780 | '{}-{}.csv' |
| 781 | .format(size_dist_info.get_info_indication(), |
| 782 | self.size_common_info.get_info_indication())) |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 783 | # Check if the corresponding record exists |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 784 | if size_dist_info.git_rev != "current" and \ |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 785 | os.path.exists(output_file): |
| 786 | self.logger.debug("Code size csv file for {} already exists." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 787 | .format(size_dist_info.git_rev)) |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 788 | self.code_size_generator.read_size_record( |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 789 | size_dist_info.git_rev, output_file) |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 790 | else: |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 791 | # measure code size |
| 792 | code_size_text = self.cal_code_size(size_dist_info) |
| 793 | |
| 794 | self.logger.debug("Generating code size csv for {}." |
| 795 | .format(size_dist_info.git_rev)) |
| 796 | output = open(output_file, "w") |
| 797 | self.code_size_generator.write_record( |
| 798 | size_dist_info.git_rev, code_size_text, output) |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 799 | |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 800 | def gen_code_size_comparison(self) -> None: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 801 | """Generate results of code size changes between two Git revisions, |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 802 | old and new. |
| 803 | |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 804 | - Measured code size result of these two Git revisions must be available. |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 805 | - The result is directed into either file / stdout depending on |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 806 | the option, size_common_info.result_options.stdout. (Default: file) |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 807 | """ |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 808 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 809 | self.logger.info("Start to generate comparision result between "\ |
| 810 | "{} and {}." |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 811 | .format(self.old_size_dist_info.git_rev, |
| 812 | self.new_size_dist_info.git_rev)) |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 813 | if self.result_options.stdout: |
| 814 | output = sys.stdout |
| 815 | else: |
| 816 | output_file = os.path.join( |
| 817 | self.comp_dir, |
Yanray Wang | b167320 | 2023-07-28 13:47:19 +0800 | [diff] [blame^] | 818 | '{}-{}-{}.{}' |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 819 | .format(self.old_size_dist_info.get_info_indication(), |
| 820 | self.new_size_dist_info.get_info_indication(), |
Yanray Wang | b167320 | 2023-07-28 13:47:19 +0800 | [diff] [blame^] | 821 | self.size_common_info.get_info_indication(), |
| 822 | 'md' if self.result_options.with_markdown else 'csv')) |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 823 | output = open(output_file, "w") |
Xiaofei Bai | 184e8b6 | 2021-10-26 09:23:42 +0000 | [diff] [blame] | 824 | |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 825 | self.logger.debug("Generating comparison results between {} and {}." |
| 826 | .format(self.old_size_dist_info.git_rev, |
| 827 | self.new_size_dist_info.git_rev)) |
Yanray Wang | ea842e7 | 2023-07-26 10:34:39 +0800 | [diff] [blame] | 828 | if self.result_options.with_markdown or self.result_options.stdout: |
| 829 | print("Measure code size between {} and {} by `{}`." |
| 830 | .format(self.old_size_dist_info.get_info_indication(), |
| 831 | self.new_size_dist_info.get_info_indication(), |
| 832 | self.size_common_info.get_info_indication()), |
| 833 | file=output) |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 834 | self.code_size_generator.write_comparison( |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 835 | self.old_size_dist_info.git_rev, |
| 836 | self.new_size_dist_info.git_rev, |
Yanray Wang | 9505900 | 2023-07-24 12:29:22 +0800 | [diff] [blame] | 837 | output, self.result_options.with_markdown) |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 838 | |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 839 | def get_comparision_results(self) -> None: |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 840 | """Compare size of library/*.o between self.old_size_dist_info and |
| 841 | self.old_size_dist_info and generate the result file.""" |
Gilles Peskine | d9071e7 | 2022-09-18 21:17:09 +0200 | [diff] [blame] | 842 | build_tree.check_repo_path() |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 843 | self.gen_code_size_report(self.old_size_dist_info) |
| 844 | self.gen_code_size_report(self.new_size_dist_info) |
Yanray Wang | 386c2f9 | 2023-07-20 15:32:15 +0800 | [diff] [blame] | 845 | self.gen_code_size_comparison() |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 846 | |
Xiaofei Bai | 2400b50 | 2021-10-21 12:22:58 +0000 | [diff] [blame] | 847 | def main(): |
Yanray Wang | 502c54f | 2023-05-31 11:41:36 +0800 | [diff] [blame] | 848 | parser = argparse.ArgumentParser(description=(__doc__)) |
| 849 | group_required = parser.add_argument_group( |
| 850 | 'required arguments', |
| 851 | 'required arguments to parse for running ' + os.path.basename(__file__)) |
| 852 | group_required.add_argument( |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 853 | '-o', '--old-rev', type=str, required=True, |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 854 | help='old Git revision for comparison.') |
Yanray Wang | 502c54f | 2023-05-31 11:41:36 +0800 | [diff] [blame] | 855 | |
| 856 | group_optional = parser.add_argument_group( |
| 857 | 'optional arguments', |
| 858 | 'optional arguments to parse for running ' + os.path.basename(__file__)) |
| 859 | group_optional.add_argument( |
Yanray Wang | 9e8b671 | 2023-07-26 15:37:26 +0800 | [diff] [blame] | 860 | '--record-dir', type=str, default='code_size_records', |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 861 | help='directory where code size record is stored. ' |
| 862 | '(Default: code_size_records)') |
| 863 | group_optional.add_argument( |
Yanray Wang | 9e8b671 | 2023-07-26 15:37:26 +0800 | [diff] [blame] | 864 | '--comp-dir', type=str, default='comparison', |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 865 | help='directory where comparison result is stored. ' |
| 866 | '(Default: comparison)') |
Yanray Wang | 502c54f | 2023-05-31 11:41:36 +0800 | [diff] [blame] | 867 | group_optional.add_argument( |
Yanray Wang | 68265f4 | 2023-07-26 14:44:52 +0800 | [diff] [blame] | 868 | '-n', '--new-rev', type=str, default='current', |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 869 | help='new Git revision as comparison base. ' |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 870 | '(Default is the current work directory, including uncommitted ' |
| 871 | 'changes.)') |
Yanray Wang | 502c54f | 2023-05-31 11:41:36 +0800 | [diff] [blame] | 872 | group_optional.add_argument( |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 873 | '-a', '--arch', type=str, default=detect_arch(), |
Yanray Wang | 23bd532 | 2023-05-24 11:03:59 +0800 | [diff] [blame] | 874 | choices=list(map(lambda s: s.value, SupportedArch)), |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 875 | help='Specify architecture for code size comparison. ' |
| 876 | '(Default is the host architecture.)') |
Yanray Wang | 502c54f | 2023-05-31 11:41:36 +0800 | [diff] [blame] | 877 | group_optional.add_argument( |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 878 | '-c', '--config', type=str, default=SupportedConfig.DEFAULT.value, |
Yanray Wang | 6a86258 | 2023-05-24 12:24:38 +0800 | [diff] [blame] | 879 | choices=list(map(lambda s: s.value, SupportedConfig)), |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 880 | help='Specify configuration type for code size comparison. ' |
| 881 | '(Default is the current MbedTLS configuration.)') |
Yanray Wang | b664cb7 | 2023-07-18 12:28:35 +0800 | [diff] [blame] | 882 | group_optional.add_argument( |
| 883 | '--markdown', action='store_true', dest='markdown', |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 884 | help='Show comparision of code size in a markdown table. ' |
| 885 | '(Only show the files that have changed).') |
Yanray Wang | 227576a | 2023-07-18 14:35:05 +0800 | [diff] [blame] | 886 | group_optional.add_argument( |
| 887 | '--stdout', action='store_true', dest='stdout', |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 888 | help='Set this option to direct comparison result into sys.stdout. ' |
| 889 | '(Default: file)') |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 890 | group_optional.add_argument( |
| 891 | '--verbose', action='store_true', dest='verbose', |
Yanray Wang | 5b64e4c | 2023-07-20 15:09:51 +0800 | [diff] [blame] | 892 | help='Show logs in detail for code size measurement. ' |
| 893 | '(Default: False)') |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 894 | comp_args = parser.parse_args() |
| 895 | |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 896 | logger = logging.getLogger() |
| 897 | logging_util.configure_logger(logger) |
Yanray Wang | 533cde2 | 2023-07-26 10:17:17 +0800 | [diff] [blame] | 898 | if comp_args.stdout and not comp_args.verbose: |
| 899 | logger.setLevel(logging.ERROR) |
| 900 | else: |
| 901 | logger.setLevel(logging.DEBUG if comp_args.verbose else logging.INFO) |
Yanray Wang | 21127f7 | 2023-07-19 12:09:45 +0800 | [diff] [blame] | 902 | |
Yanray Wang | 9e8b671 | 2023-07-26 15:37:26 +0800 | [diff] [blame] | 903 | if os.path.isfile(comp_args.record_dir): |
| 904 | logger.error("record directory: {} is not a directory" |
| 905 | .format(comp_args.record_dir)) |
| 906 | sys.exit(1) |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 907 | if os.path.isfile(comp_args.comp_dir): |
Yanray Wang | 9e8b671 | 2023-07-26 15:37:26 +0800 | [diff] [blame] | 908 | logger.error("comparison directory: {} is not a directory" |
| 909 | .format(comp_args.comp_dir)) |
| 910 | sys.exit(1) |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 911 | |
Yanray Wang | 68265f4 | 2023-07-26 14:44:52 +0800 | [diff] [blame] | 912 | comp_args.old_rev = CodeSizeCalculator.validate_git_revision( |
| 913 | comp_args.old_rev) |
| 914 | if comp_args.new_rev != 'current': |
| 915 | comp_args.new_rev = CodeSizeCalculator.validate_git_revision( |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 916 | comp_args.new_rev) |
Xiaofei Bai | 2400b50 | 2021-10-21 12:22:58 +0000 | [diff] [blame] | 917 | |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 918 | # version, git_rev, arch, config, compiler, opt_level |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 919 | old_size_dist_info = CodeSizeDistinctInfo( |
Yanray Wang | 68265f4 | 2023-07-26 14:44:52 +0800 | [diff] [blame] | 920 | 'old', comp_args.old_rev, comp_args.arch, comp_args.config, 'cc', '-Os') |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 921 | new_size_dist_info = CodeSizeDistinctInfo( |
Yanray Wang | 68265f4 | 2023-07-26 14:44:52 +0800 | [diff] [blame] | 922 | 'new', comp_args.new_rev, comp_args.arch, comp_args.config, 'cc', '-Os') |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 923 | # host_arch, measure_cmd |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 924 | size_common_info = CodeSizeCommonInfo( |
| 925 | detect_arch(), 'size -t') |
Yanray Wang | 5605c6f | 2023-07-21 16:09:00 +0800 | [diff] [blame] | 926 | # record_dir, comp_dir, with_markdown, stdout |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 927 | result_options = CodeSizeResultInfo( |
| 928 | comp_args.record_dir, comp_args.comp_dir, |
| 929 | comp_args.markdown, comp_args.stdout) |
Yanray Wang | 923f943 | 2023-07-17 12:43:00 +0800 | [diff] [blame] | 930 | |
Yanray Wang | a6cf692 | 2023-07-24 15:20:42 +0800 | [diff] [blame] | 931 | logger.info("Measure code size between {} and {} by `{}`." |
| 932 | .format(old_size_dist_info.get_info_indication(), |
| 933 | new_size_dist_info.get_info_indication(), |
| 934 | size_common_info.get_info_indication())) |
Yanray Wang | 955671b | 2023-07-21 12:08:27 +0800 | [diff] [blame] | 935 | CodeSizeComparison(old_size_dist_info, new_size_dist_info, |
| 936 | size_common_info, result_options, |
| 937 | logger).get_comparision_results() |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 938 | |
Xiaofei Bai | bca03e5 | 2021-09-09 09:42:37 +0000 | [diff] [blame] | 939 | if __name__ == "__main__": |
Xiaofei Bai | 2400b50 | 2021-10-21 12:22:58 +0000 | [diff] [blame] | 940 | main() |