Merge branch 'feature/idf_size_report_symbols' into 'master'

Feature/idf-size: report per-archive symbols and their sizes

See merge request idf/esp-idf!1956

make/project.mk

@@ -10,7 +10,7 @@
 # where this file is located.
 #
 
-.PHONY: build-components menuconfig defconfig all build clean all_binaries check-submodules size size-components size-files list-components
+.PHONY: build-components menuconfig defconfig all build clean all_binaries check-submodules size size-components size-files size-symbols list-components
 
 MAKECMDGOALS ?= all
 all: all_binaries
@@ -32,6 +32,7 @@ help:
 	@echo "make clean - Remove all build output"
 	@echo "make size - Display the static memory footprint of the app"
 	@echo "make size-components, size-files - Finer-grained memory footprints"
+	@echo "make size-symbols - Per symbol memory footprint. Requires COMPONENT=<component>"
 	@echo "make erase_flash - Erase entire flash contents"
 	@echo "make monitor - Run idf_monitor tool to monitor serial output from app"
 	@echo "make simple_monitor - Monitor serial output on terminal console"
@@ -479,6 +480,13 @@ size-files: $(APP_ELF)
 size-components: $(APP_ELF)
 	$(PYTHON) $(IDF_PATH)/tools/idf_size.py --archives $(APP_MAP)
 
+size-symbols: $(APP_ELF)
+ifndef COMPONENT
+	$(error "ERROR: Please enter the component to look symbols for, e.g. COMPONENT=heap")
+else
+	$(PYTHON) $(IDF_PATH)/tools/idf_size.py --archive_details lib$(COMPONENT).a $(APP_MAP)
+endif
+
 # NB: this ordering is deliberate (app-clean & bootloader-clean before
 # _config-clean), so config remains valid during all component clean
 # targets

tools/idf_size.py

@@ -85,6 +85,7 @@ def load_sections(map_file):
     scan_to_header(map_file, "END GROUP")
     sections = {}
     section = None
+    sym_backup = None
     for line in map_file:
         # output section header, ie '.iram0.text     0x0000000040080400    0x129a5'
         RE_SECTION_HEADER = r"(?P<name>[^ ]+) +0x(?P<address>[\da-f]+) +0x(?P<size>[\da-f]+)$"
@@ -101,18 +102,27 @@ def load_sections(map_file):
 
         # source file line, ie
         # 0x0000000040080400       0xa4 /home/gus/esp/32/idf/examples/get-started/hello_world/build/esp32/libesp32.a(cpu_start.o)
-        RE_SOURCE_LINE = r".*? +0x(?P<address>[\da-f]+) +0x(?P<size>[\da-f]+) (?P<archive>.+\.a)\((?P<object_file>.+\.o)\)"
-        m = re.match(RE_SOURCE_LINE, line)
+        RE_SOURCE_LINE = r"\s*(?P<sym_name>\S*).* +0x(?P<address>[\da-f]+) +0x(?P<size>[\da-f]+) (?P<archive>.+\.a)\((?P<object_file>.+\.o)\)"
+
+        m = re.match(RE_SOURCE_LINE, line, re.M)
         if section is not None and m is not None:  # input source file details
+            sym_name = m.group("sym_name") if len(m.group("sym_name")) > 0 else sym_backup
             source = {
                 "size" : int(m.group("size"), 16),
                 "address" : int(m.group("address"), 16),
                 "archive" : os.path.basename(m.group("archive")),
                 "object_file" : m.group("object_file"),
+                "sym_name" : sym_name,
             }
             source["file"] = "%s:%s" % (source["archive"], source["object_file"])
             section["sources"] += [ source ]
 
+        # In some cases the section name appears on the previous line, back it up in here
+        RE_SYMBOL_ONLY_LINE = r"^ (?P<sym_name>\S*)$"
+        m = re.match(RE_SYMBOL_ONLY_LINE, line)
+        if section is not None and m is not None:
+            sym_backup = m.group("sym_name")
+
     return sections
 
 def sizes_by_key(sections, key):
@@ -147,6 +157,9 @@ def main():
     parser.add_argument(
         '--archives', help='Print per-archive sizes', action='store_true')
 
+    parser.add_argument(
+        '--archive_details', help='Print detailed symbols per archive')
+
     parser.add_argument(
         '--files', help='Print per-file sizes', action='store_true')
 
@@ -161,6 +174,9 @@ def main():
     if args.files:
         print("Per-file contributions to ELF file:")
         print_detailed_sizes(sections, "file", "Object File")
+    if args.archive_details:
+        print "Symbols within the archive:", args.archive_details, "(Not all symbols may be reported)"
+        print_archive_symbols(sections, args.archive_details)
 
 def print_summary(memory_config, sections):
     def get_size(section):
@@ -230,6 +246,28 @@ def print_detailed_sizes(sections, key, header):
                                                   v["flash_rodata"],
                                                   v["total"]))
 
+def print_archive_symbols(sections, archive):
+    interested_sections = [".dram0.data", ".dram0.bss", ".iram0.text", ".iram0.vectors", ".flash.text", ".flash.rodata"]
+    result = {}
+    for t in interested_sections:
+        result[t] = {}
+    for section in sections.values():
+        section_name = section["name"]
+        if section_name not in interested_sections:
+            continue
+        for s in section["sources"]:
+            if archive != s["archive"]:
+                continue
+            s["sym_name"] = re.sub("(.text.|.literal.|.data.|.bss.|.rodata.)", "", s["sym_name"]);
+            result[section_name][s["sym_name"]] = result[section_name].get(s["sym_name"], 0) + s["size"]
+    for t in interested_sections:
+        print "\nSymbols from section:", t
+        section_total = 0
+        for key,val in sorted(result[t].items(), key=lambda (k,v): v, reverse=True):
+            print("%s(%d)"% (key.replace(t + ".", ""), val)),
+            section_total += val
+        print "\nSection total:",section_total
+
 if __name__ == "__main__":
     main()