|
| 1 | +#!/usr/bin/env python |
| 2 | +# |
| 3 | +# esp-idf alternative to "size" to print ELF file sizes, also analyzes |
| 4 | +# the linker map file to dump higher resolution details. |
| 5 | +# |
| 6 | +# Includes information which is not shown in "xtensa-esp32-elf-size", |
| 7 | +# or easy to parse from "xtensa-esp32-elf-objdump" or raw map files. |
| 8 | +# |
| 9 | +# Copyright 2017 Espressif Systems (Shanghai) PTE LTD |
| 10 | +# |
| 11 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 12 | +# you may not use this file except in compliance with the License. |
| 13 | +# You may obtain a copy of the License at |
| 14 | +# |
| 15 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 16 | +# |
| 17 | +# Unless required by applicable law or agreed to in writing, software |
| 18 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 19 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 20 | +# See the License for the specific language governing permissions and |
| 21 | +# limitations under the License. |
| 22 | +# |
| 23 | +import argparse, sys, subprocess, re |
| 24 | +import os.path |
| 25 | +import pprint |
| 26 | + |
| 27 | +DEFAULT_TOOLCHAIN_PREFIX = "xtensa-esp32-elf-" |
| 28 | + |
| 29 | +CHIP_SIZES = { |
| 30 | + "esp32" : { |
| 31 | + "total_iram" : 0x20000, |
| 32 | + "total_irom" : 0x330000, |
| 33 | + "total_drom" : 0x800000, |
| 34 | + # total dram is determined from objdump output |
| 35 | + } |
| 36 | +} |
| 37 | + |
| 38 | +def scan_to_header(f, header_line): |
| 39 | + """ Scan forward in a file until you reach 'header_line', then return """ |
| 40 | + for line in f: |
| 41 | + if line.strip() == header_line: |
| 42 | + return |
| 43 | + raise RuntimeError("Didn't find line '%s' in file" % header_line) |
| 44 | + |
| 45 | +def load_map_data(map_file): |
| 46 | + memory_config = load_memory_config(map_file) |
| 47 | + sections = load_sections(map_file) |
| 48 | + return memory_config, sections |
| 49 | + |
| 50 | +def output_section_for_address(memory_config, address): |
| 51 | + for m in memory_config.values(): |
| 52 | + if m["origin"] <= address and m["origin"] + m["length"] > address: |
| 53 | + return m["name"] |
| 54 | + return None |
| 55 | + |
| 56 | +def load_memory_config(map_file): |
| 57 | + """ Memory Configuration section is the total size of each output section """ |
| 58 | + result = {} |
| 59 | + scan_to_header(map_file, "Memory Configuration") |
| 60 | + RE_MEMORY_SECTION = r"(?P<name>[^ ]+) +0x(?P<origin>[\da-f]+) 0x(?P<length>[\da-f]+)" |
| 61 | + for line in map_file: |
| 62 | + m = re.match(RE_MEMORY_SECTION, line) |
| 63 | + if m is None: |
| 64 | + if len(result) == 0: |
| 65 | + continue # whitespace or a header |
| 66 | + else: |
| 67 | + return result # we're at the end of the Memory Configuration |
| 68 | + section = { |
| 69 | + "name" : m.group("name"), |
| 70 | + "origin" : int(m.group("origin"), 16), |
| 71 | + "length" : int(m.group("length"), 16), |
| 72 | + } |
| 73 | + if section["name"] != "*default*": |
| 74 | + result[section["name"]] = section |
| 75 | + |
| 76 | +def load_sections(map_file): |
| 77 | + """ Load section size information from the MAP file. |
| 78 | +
|
| 79 | + Returns a dict of 'sections', where each key is a section name and the value |
| 80 | + is a dict with details about this section, including a "sources" key which holds a list of source file line information for each symbol linked into the section. |
| 81 | + """ |
| 82 | + scan_to_header(map_file, "Linker script and memory map") |
| 83 | + scan_to_header(map_file, "END GROUP") |
| 84 | + sections = {} |
| 85 | + section = None |
| 86 | + for line in map_file: |
| 87 | + # output section header, ie '.iram0.text 0x0000000040080400 0x129a5' |
| 88 | + RE_SECTION_HEADER = r"(?P<name>[^ ]+) +0x(?P<address>[\da-f]+) +0x(?P<size>[\da-f]+)$" |
| 89 | + m = re.match(RE_SECTION_HEADER, line) |
| 90 | + if m is not None: # start of a new section |
| 91 | + section = { |
| 92 | + "name" : m.group("name"), |
| 93 | + "address" : int(m.group("address"), 16), |
| 94 | + "size" : int(m.group("size"), 16), |
| 95 | + "sources" : [], |
| 96 | + } |
| 97 | + sections[section["name"]] = section |
| 98 | + continue |
| 99 | + |
| 100 | + # source file line, ie |
| 101 | + # 0x0000000040080400 0xa4 /home/gus/esp/32/idf/examples/get-started/hello_world/build/esp32/libesp32.a(cpu_start.o) |
| 102 | + RE_SOURCE_LINE = r".*? +0x(?P<address>[\da-f]+) +0x(?P<size>[\da-f]+) (?P<archive>.+\.a)\((?P<object_file>.+\.o)\)" |
| 103 | + m = re.match(RE_SOURCE_LINE, line) |
| 104 | + if section is not None and m is not None: # input source file details |
| 105 | + source = { |
| 106 | + "size" : int(m.group("size"), 16), |
| 107 | + "address" : int(m.group("address"), 16), |
| 108 | + "archive" : os.path.basename(m.group("archive")), |
| 109 | + "object_file" : m.group("object_file"), |
| 110 | + } |
| 111 | + source["file"] = "%s:%s" % (source["archive"], source["object_file"]) |
| 112 | + section["sources"] += [ source ] |
| 113 | + |
| 114 | + return sections |
| 115 | + |
| 116 | +def sizes_by_key(sections, key): |
| 117 | + """ Takes a dict of sections (from load_sections) and returns |
| 118 | + a dict keyed by 'key' with aggregate output size information. |
| 119 | +
|
| 120 | + Key can be either "archive" (for per-archive data) or "file" (for per-file data) in the result. |
| 121 | + """ |
| 122 | + result = {} |
| 123 | + for section in sections.values(): |
| 124 | + for s in section["sources"]: |
| 125 | + if not s[key] in result: |
| 126 | + result[s[key]] = {} |
| 127 | + archive = result[s[key]] |
| 128 | + if not section["name"] in archive: |
| 129 | + archive[section["name"]] = 0 |
| 130 | + archive[section["name"]] += s["size"] |
| 131 | + return result |
| 132 | + |
| 133 | +def main(): |
| 134 | + parser = argparse.ArgumentParser("idf_size - a tool to print IDF elf file sizes") |
| 135 | + |
| 136 | + parser.add_argument( |
| 137 | + '--toolchain-prefix', |
| 138 | + help="Triplet prefix to add before objdump executable", |
| 139 | + default=DEFAULT_TOOLCHAIN_PREFIX) |
| 140 | + |
| 141 | + parser.add_argument( |
| 142 | + 'map_file', help='MAP file produced by linker', |
| 143 | + type=argparse.FileType('r')) |
| 144 | + |
| 145 | + parser.add_argument( |
| 146 | + '--archives', help='Print per-archive sizes', action='store_true') |
| 147 | + |
| 148 | + parser.add_argument( |
| 149 | + '--files', help='Print per-file sizes', action='store_true') |
| 150 | + |
| 151 | + args = parser.parse_args() |
| 152 | + |
| 153 | + memory_config, sections = load_map_data(args.map_file) |
| 154 | + print_summary(memory_config, sections) |
| 155 | + |
| 156 | + if args.archives: |
| 157 | + print("Per-archive contributions to ELF file:") |
| 158 | + print_detailed_sizes(sections, "archive", "Archive File") |
| 159 | + if args.files: |
| 160 | + print("Per-file contributions to ELF file:") |
| 161 | + print_detailed_sizes(sections, "file", "Object File") |
| 162 | + |
| 163 | +def print_summary(memory_config, sections): |
| 164 | + def get_size(section): |
| 165 | + try: |
| 166 | + return sections[section]["size"] |
| 167 | + except KeyError: |
| 168 | + return 0 |
| 169 | + |
| 170 | + # if linker script changes, these need to change |
| 171 | + total_iram = memory_config["iram0_0_seg"]["length"] |
| 172 | + total_dram = memory_config["dram0_0_seg"]["length"] |
| 173 | + used_data = get_size(".dram0.data") |
| 174 | + used_bss = get_size(".dram0.bss") |
| 175 | + used_dram = used_data + used_bss |
| 176 | + used_iram = sum( get_size(s) for s in sections.keys() if s.startswith(".iram0") ) |
| 177 | + flash_code = get_size(".flash.text") |
| 178 | + flash_rodata = get_size(".flash.rodata") |
| 179 | + total_size = used_data + used_iram + flash_code + flash_rodata |
| 180 | + |
| 181 | + print("Total sizes:") |
| 182 | + print(" DRAM .data size: %7d bytes" % used_data) |
| 183 | + print(" DRAM .bss size: %7d bytes" % used_bss) |
| 184 | + print("Used static DRAM: %7d bytes (%7d available, %.1f%% used)" % |
| 185 | + (used_dram, total_dram - used_dram, |
| 186 | + 100.0 * used_dram / total_dram)) |
| 187 | + print("Used static IRAM: %7d bytes (%7d available, %.1f%% used)" % |
| 188 | + (used_iram, total_iram - used_iram, |
| 189 | + 100.0 * used_iram / total_iram)) |
| 190 | + print(" Flash code: %7d bytes" % flash_code) |
| 191 | + print(" Flash rodata: %7d bytes" % flash_rodata) |
| 192 | + print("Total image size:~%7d bytes (.bin may be padded larger)" % (total_size)) |
| 193 | + |
| 194 | +def print_detailed_sizes(sections, key, header): |
| 195 | + sizes = sizes_by_key(sections, key) |
| 196 | + |
| 197 | + sub_heading = None |
| 198 | + headings = (header, |
| 199 | + "DRAM .data", |
| 200 | + "& .bss", |
| 201 | + "IRAM", |
| 202 | + "Flash code", |
| 203 | + "& rodata", |
| 204 | + "Total") |
| 205 | + print("%24s %10s %6s %6s %10s %8s %7s" % headings) |
| 206 | + for k in sorted(sizes.keys()): |
| 207 | + v = sizes[k] |
| 208 | + if ":" in k: # print subheadings for key of format archive:file |
| 209 | + sh,k = k.split(":") |
| 210 | + if sh != sub_heading: |
| 211 | + print(sh) |
| 212 | + sub_heading = sh |
| 213 | + |
| 214 | + data = v.get(".dram0.data", 0) |
| 215 | + bss = v.get(".dram0.bss", 0) |
| 216 | + iram = sum(t for (s,t) in v.items() if s.startswith(".iram0")) |
| 217 | + flash_text = v.get(".flash.text", 0) |
| 218 | + flash_rodata = v.get(".flash.rodata", 0) |
| 219 | + total = data + bss + iram + flash_text + flash_rodata |
| 220 | + print("%24s %10d %6d %6d %10d %8d %7d" % (k[:24], |
| 221 | + data, |
| 222 | + bss, |
| 223 | + iram, |
| 224 | + flash_text, |
| 225 | + flash_rodata, |
| 226 | + total)) |
| 227 | + |
| 228 | +if __name__ == "__main__": |
| 229 | + main() |
| 230 | + |
0 commit comments