Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of mbed-sdk-tools by
Diff: memap.py
- Revision:
- 29:1210849dba19
- Parent:
- 24:25bff2709c20
- Child:
- 30:f12ce67666d0
--- a/memap.py Mon Aug 29 10:55:42 2016 +0100 +++ b/memap.py Mon Aug 29 11:18:36 2016 +0100 @@ -1,8 +1,6 @@ #!/usr/bin/env python -# pylint: disable=too-many-arguments, too-many-locals, too-many-branches, too-many-lines, line-too-long, too-many-nested-blocks, too-many-public-methods, too-many-instance-attributes -# pylint: disable=invalid-name, missing-docstring -# Memory Map File Analyser for ARM mbed +"""Memory Map File Analyser for ARM mbed""" import sys import os @@ -10,37 +8,46 @@ import csv import json import argparse -from utils import argparse_uppercase_type, argparse_lowercase_hyphen_type, argparse_filestring_type from prettytable import PrettyTable -debug = False +from tools.utils import argparse_filestring_type, \ + argparse_lowercase_hyphen_type, argparse_uppercase_type + +DEBUG = False +RE_ARMCC = re.compile( + r'^\s+0x(\w{8})\s+0x(\w{8})\s+(\w+)\s+(\w+)\s+(\d+)\s+[*]?.+\s+(.+)$') +RE_IAR = re.compile( + r'^\s+(.+)\s+(zero|const|ro code|inited|uninit)\s' + r'+0x(\w{8})\s+0x(\w+)\s+(.+)\s.+$') class MemapParser(object): + """An object that represents parsed results, parses the memory map files, + and writes out different file types of memory results + """ + + print_sections = ('.text', '.data', '.bss') + + misc_flash_sections = ('.interrupts', '.flash_config') + + other_sections = ('.interrupts_ram', '.init', '.ARM.extab', + '.ARM.exidx', '.ARM.attributes', '.eh_frame', + '.init_array', '.fini_array', '.jcr', '.stab', + '.stabstr', '.ARM.exidx', '.ARM') + + # sections to print info (generic for all toolchains) + sections = ('.text', '.data', '.bss', '.heap', '.stack') def __init__(self): - """ - General initialization + """ General initialization """ # list of all modules and their sections self.modules = dict() - self.misc_flash_sections = ('.interrupts', '.flash_config') - - self.other_sections = ('.interrupts_ram', '.init', '.ARM.extab', - '.ARM.exidx', '.ARM.attributes', '.eh_frame', - '.init_array', '.fini_array', '.jcr', '.stab', - '.stabstr', '.ARM.exidx', '.ARM') - - # sections to print info (generic for all toolchains) - self.sections = ('.text', '.data', '.bss', '.heap', '.stack') - # sections must be defined in this order to take irrelevant out self.all_sections = self.sections + self.other_sections + \ self.misc_flash_sections + ('unknown', 'OUTPUT') - self.print_sections = ('.text', '.data', '.bss') - # list of all object files and mappting to module names self.object_to_module = dict() @@ -48,8 +55,12 @@ self.mem_summary = dict() def module_add(self, module_name, size, section): - """ - Adds a module / section to the list + """ Adds a module / section to the list + + Positional arguments: + module_name - name of the module to add + size - the size of the module being added + section - the section the module contributes to """ if module_name in self.modules: @@ -62,22 +73,29 @@ self.modules[module_name] = temp_dic def check_new_section_gcc(self, line): - """ - Check whether a new section in a map file has been detected (only applies to gcc) + """ Check whether a new section in a map file has been detected (only + applies to gcc) + + Positional arguments: + line - the line to check for a new section """ for i in self.all_sections: if line.startswith(i): - return i # should name of the section (assuming it's a known one) + # should name of the section (assuming it's a known one) + return i if line.startswith('.'): return 'unknown' # all others are classified are unknown else: return False # everything else, means no change in section - def path_object_to_module_name(self, txt): - """ - Parses path to object file and extracts module / object data + @staticmethod + def path_object_to_module_name(txt): + """ Parse a path to object file to extract it's module and object data + + Positional arguments: + txt - the path to parse the object and module name from """ txt = txt.replace('\\', '/') @@ -101,13 +119,17 @@ def parse_section_gcc(self, line): - """ - Parse data from a section of gcc map file + """ Parse data from a section of gcc map file + + examples: + 0x00004308 0x7c ./.build/K64F/GCC_ARM/mbed-os/hal/targets/hal/TARGET_Freescale/TARGET_KPSDK_MCUS/spi_api.o + .text 0x00000608 0x198 ./.build/K64F/GCC_ARM/mbed-os/core/mbed-rtos/rtx/TARGET_CORTEX_M/TARGET_RTOS_M4_M7/TOOLCHAIN_GCC/HAL_CM4.o + + Positional arguments: + line - the line to parse a section from """ - # examples - # 0x00004308 0x7c ./.build/K64F/GCC_ARM/mbed-os/hal/targets/hal/TARGET_Freescale/TARGET_KPSDK_MCUS/spi_api.o - # .text 0x00000608 0x198 ./.build/K64F/GCC_ARM/mbed-os/core/mbed-rtos/rtx/TARGET_CORTEX_M/TARGET_RTOS_M4_M7/TOOLCHAIN_GCC/HAL_CM4.o - rex_address_len_name = r'^\s+.*0x(\w{8,16})\s+0x(\w+)\s(.+)$' + rex_address_len_name = re.compile( + r'^\s+.*0x(\w{8,16})\s+0x(\w+)\s(.+)$') test_address_len_name = re.match(rex_address_len_name, line) @@ -116,7 +138,8 @@ if int(test_address_len_name.group(2), 16) == 0: # size == 0 return ["", 0] # no valid entry else: - m_name, m_object = self.path_object_to_module_name(test_address_len_name.group(3)) + m_name, _ = self.path_object_to_module_name( + test_address_len_name.group(3)) m_size = int(test_address_len_name.group(2), 16) return [m_name, m_size] @@ -137,8 +160,10 @@ return ["", 0] # no valid entry def parse_map_file_gcc(self, file_desc): - """ - Main logic to decode gcc map files + """ Main logic to decode gcc map files + + Positional arguments: + file_desc - a stream object to parse as a gcc map file """ current_section = 'unknown' @@ -168,22 +193,25 @@ else: self.module_add(module_name, module_size, current_section) - if debug: + if DEBUG: print "Line: %s" % line, - print "Module: %s\tSection: %s\tSize: %s" % (module_name, current_section, module_size) + print "Module: %s\tSection: %s\tSize: %s" % \ + (module_name, current_section, module_size) raw_input("----------") def parse_section_armcc(self, line): - """ - Parse data from an armcc map file + """ Parse data from an armcc map file + + Examples of armcc map file: + Base_Addr Size Type Attr Idx E Section Name Object + 0x00000000 0x00000400 Data RO 11222 RESET startup_MK64F12.o + 0x00000410 0x00000008 Code RO 49364 * !!!main c_w.l(__main.o) + + Positional arguments: + line - the line to parse the section data from """ - # Examples of armcc map file: - # Base_Addr Size Type Attr Idx E Section Name Object - # 0x00000000 0x00000400 Data RO 11222 RESET startup_MK64F12.o - # 0x00000410 0x00000008 Code RO 49364 * !!!main c_w.l(__main.o) - rex_armcc = r'^\s+0x(\w{8})\s+0x(\w{8})\s+(\w+)\s+(\w+)\s+(\d+)\s+[*]?.+\s+(.+)$' - test_rex_armcc = re.match(rex_armcc, line) + test_rex_armcc = re.match(RE_ARMCC, line) if test_rex_armcc: @@ -213,30 +241,34 @@ return ["", 0, ""] # no valid entry def parse_section_iar(self, line): - """ - Parse data from an IAR map file + """ Parse data from an IAR map file + + Examples of IAR map file: + Section Kind Address Size Object + .intvec ro code 0x00000000 0x198 startup_MK64F12.o [15] + .rodata const 0x00000198 0x0 zero_init3.o [133] + .iar.init_table const 0x00008384 0x2c - Linker created - + Initializer bytes const 0x00000198 0xb2 <for P3 s0> + .data inited 0x20000000 0xd4 driverAtmelRFInterface.o [70] + .bss zero 0x20000598 0x318 RTX_Conf_CM.o [4] + .iar.dynexit uninit 0x20001448 0x204 <Block tail> + HEAP uninit 0x20001650 0x10000 <Block tail> + + Positional_arguments: + line - the line to parse section data from """ - # Examples of IAR map file: - # Section Kind Address Size Object - # .intvec ro code 0x00000000 0x198 startup_MK64F12.o [15] - # .rodata const 0x00000198 0x0 zero_init3.o [133] - # .iar.init_table const 0x00008384 0x2c - Linker created - - # Initializer bytes const 0x00000198 0xb2 <for P3 s0> - # .data inited 0x20000000 0xd4 driverAtmelRFInterface.o [70] - # .bss zero 0x20000598 0x318 RTX_Conf_CM.o [4] - # .iar.dynexit uninit 0x20001448 0x204 <Block tail> - # HEAP uninit 0x20001650 0x10000 <Block tail> - rex_iar = r'^\s+(.+)\s+(zero|const|ro code|inited|uninit)\s+0x(\w{8})\s+0x(\w+)\s+(.+)\s.+$' - test_rex_iar = re.match(rex_iar, line) + test_rex_iar = re.match(RE_IAR, line) if test_rex_iar: size = int(test_rex_iar.group(4), 16) - if test_rex_iar.group(2) == 'const' or test_rex_iar.group(2) == 'ro code': + if test_rex_iar.group(2) == 'const' or \ + test_rex_iar.group(2) == 'ro code': section = '.text' - elif test_rex_iar.group(2) == 'zero' or test_rex_iar.group(2) == 'uninit': + elif test_rex_iar.group(2) == 'zero' or \ + test_rex_iar.group(2) == 'uninit': if test_rex_iar.group(1)[0:4] == 'HEAP': section = '.heap' elif test_rex_iar.group(1)[0:6] == 'CSTACK': @@ -263,8 +295,10 @@ return ["", 0, ""] # no valid entry def parse_map_file_armcc(self, file_desc): - """ - Main logic to decode armcc map files + """ Main logic to decode armc5 map files + + Positional arguments: + file_desc - a file like object to parse as an armc5 map file """ with file_desc as infile: @@ -285,8 +319,10 @@ self.module_add(name, size, section) def parse_map_file_iar(self, file_desc): - """ - Main logic to decode armcc map files + """ Main logic to decode IAR map files + + Positional arguments: + file_desc - a file like object to parse as an IAR map file """ with file_desc as infile: @@ -307,9 +343,12 @@ self.module_add(name, size, section) def search_objects(self, path, toolchain): - """ - Check whether the specified map file matches with the toolchain. + """ Check whether the specified map file matches with the toolchain. Searches for object files and creates mapping: object --> module + + Positional arguments: + path - the path to an object file + toolchain - the toolchain used to build the object file """ path = path.replace('\\', '/') @@ -323,18 +362,22 @@ else: # It looks this is not an mbed project # object-to-module mapping cannot be generated - print "Warning: specified toolchain doesn't match with path to the memory map file." + print "Warning: specified toolchain doesn't match with"\ + " path to the memory map file." return - for root, dir, obj_files in os.walk(search_path): + for root, _, obj_files in os.walk(search_path): for obj_file in obj_files: if obj_file.endswith(".o"): - module_name, object_name = self.path_object_to_module_name(os.path.join(root, obj_file)) + module_name, object_name = self.path_object_to_module_name( + os.path.join(root, obj_file)) if object_name in self.object_to_module: - if debug: - print "WARNING: multiple usages of object file: %s" % object_name - print " Current: %s" % self.object_to_module[object_name] + if DEBUG: + print "WARNING: multiple usages of object file: %s"\ + % object_name + print " Current: %s" % \ + self.object_to_module[object_name] print " New: %s" % module_name print " " else: @@ -343,12 +386,13 @@ export_formats = ["json", "csv-ci", "table"] def generate_output(self, export_format, file_output=None): - """ - Generates summary of memory map data + """ Generates summary of memory map data - Parameters - json_mode: generates output in json formal (True/False) - file_desc: descriptor (either stdout or file) + Positional arguments: + export_format - the format to dump + + Keyword arguments: + file_desc - descriptor (either stdout or file) """ try: @@ -360,6 +404,10 @@ print "I/O error({0}): {1}".format(error.errno, error.strerror) return False + subtotal = dict() + for k in self.sections: + subtotal[k] = 0 + # Calculate misc flash sections misc_flash_mem = 0 for i in self.modules: @@ -367,6 +415,102 @@ if self.modules[i][k]: misc_flash_mem += self.modules[i][k] + json_obj = [] + for i in sorted(self.modules): + + row = [] + + json_obj.append({ + "module":i, + "size":{ + k:self.modules[i][k] for k in self.print_sections + } + }) + + summary = { + 'summary':{ + 'static_ram': (subtotal['.data'] + subtotal['.bss']), + 'heap': (subtotal['.heap']), + 'stack': (subtotal['.stack']), + 'total_ram': (subtotal['.data'] + subtotal['.bss'] + + subtotal['.heap']+subtotal['.stack']), + 'total_flash': (subtotal['.text'] + subtotal['.data'] + + misc_flash_mem), + } + } + + self.mem_summary = json_obj + [summary] + + to_call = {'json': self.generate_json, + 'csv-ci': self.generate_csv, + 'table': self.generate_table}[export_format] + to_call(subtotal, misc_flash_mem, file_desc) + + if file_desc is not sys.stdout: + file_desc.close() + + def generate_json(self, _, dummy, file_desc): + """Generate a json file from a memory map + + Positional arguments: + subtotal - total sizes for each module + misc_flash_mem - size of misc flash sections + file_desc - the file to write out the final report to + """ + file_desc.write(json.dumps(self.mem_summary, indent=4)) + file_desc.write('\n') + + def generate_csv(self, subtotal, misc_flash_mem, file_desc): + """Generate a CSV file from a memoy map + + Positional arguments: + subtotal - total sizes for each module + misc_flash_mem - size of misc flash sections + file_desc - the file to write out the final report to + """ + csv_writer = csv.writer(file_desc, delimiter=',', + quoting=csv.QUOTE_NONE) + + csv_module_section = [] + csv_sizes = [] + for i in sorted(self.modules): + for k in self.print_sections: + csv_module_section += [i+k] + csv_sizes += [self.modules[i][k]] + + csv_module_section += ['static_ram'] + csv_sizes += [subtotal['.data']+subtotal['.bss']] + + csv_module_section += ['heap'] + if subtotal['.heap'] == 0: + csv_sizes += ['unknown'] + else: + csv_sizes += [subtotal['.heap']] + + csv_module_section += ['stack'] + if subtotal['.stack'] == 0: + csv_sizes += ['unknown'] + else: + csv_sizes += [subtotal['.stack']] + + csv_module_section += ['total_ram'] + csv_sizes += [subtotal['.data'] + subtotal['.bss'] + + subtotal['.heap'] + subtotal['.stack']] + + csv_module_section += ['total_flash'] + csv_sizes += [subtotal['.text']+subtotal['.data']+misc_flash_mem] + + csv_writer.writerow(csv_module_section) + csv_writer.writerow(csv_sizes) + + def generate_table(self, subtotal, misc_flash_mem, file_desc): + """Generate a table from a memoy map + + Positional arguments: + subtotal - total sizes for each module + misc_flash_mem - size of misc flash sections + file_desc - the file to write out the final report to + """ # Create table columns = ['Module'] columns.extend(self.print_sections) @@ -379,15 +523,8 @@ for i in list(self.print_sections): table.align[i] = 'r' - subtotal = dict() - for k in self.sections: - subtotal[k] = 0 - - json_obj = [] for i in sorted(self.modules): - - row = [] - row.append(i) + row = [i] for k in self.sections: subtotal[k] += self.modules[i][k] @@ -395,13 +532,6 @@ for k in self.print_sections: row.append(self.modules[i][k]) - json_obj.append({ - "module":i, - "size":{ - k:self.modules[i][k] for k in self.print_sections - } - }) - table.add_row(row) subtotal_row = ['Subtotals'] @@ -410,98 +540,46 @@ table.add_row(subtotal_row) - summary = { - 'summary':{ - 'static_ram':(subtotal['.data']+subtotal['.bss']), - 'heap':(subtotal['.heap']), - 'stack':(subtotal['.stack']), - 'total_ram':(subtotal['.data']+subtotal['.bss']+subtotal['.heap']+subtotal['.stack']), - 'total_flash':(subtotal['.text']+subtotal['.data']+misc_flash_mem), - } - } - - if export_format == 'json': - json_to_file = json_obj + [summary] - file_desc.write(json.dumps(json_to_file, indent=4)) - file_desc.write('\n') - - elif export_format == 'csv-ci': # CSV format for the CI system + file_desc.write(table.get_string()) + file_desc.write('\n') - csv_writer = csv.writer(file_desc, delimiter=',', quoting=csv.QUOTE_NONE) - - csv_module_section = [] - csv_sizes = [] - for i in sorted(self.modules): - for k in self.print_sections: - csv_module_section += [i+k] - csv_sizes += [self.modules[i][k]] - - csv_module_section += ['static_ram'] - csv_sizes += [subtotal['.data']+subtotal['.bss']] - - csv_module_section += ['heap'] - if subtotal['.heap'] == 0: - csv_sizes += ['unknown'] - else: - csv_sizes += [subtotal['.heap']] + if subtotal['.heap'] == 0: + file_desc.write("Allocated Heap: unknown\n") + else: + file_desc.write("Allocated Heap: %s bytes\n" % + str(subtotal['.heap'])) - csv_module_section += ['stack'] - if subtotal['.stack'] == 0: - csv_sizes += ['unknown'] - else: - csv_sizes += [subtotal['.stack']] - - csv_module_section += ['total_ram'] - csv_sizes += [subtotal['.data']+subtotal['.bss']+subtotal['.heap']+subtotal['.stack']] - - csv_module_section += ['total_flash'] - csv_sizes += [subtotal['.text']+subtotal['.data']+misc_flash_mem] - - csv_writer.writerow(csv_module_section) - csv_writer.writerow(csv_sizes) - - else: # default format is 'table' - file_desc.write(table.get_string()) - file_desc.write('\n') + if subtotal['.stack'] == 0: + file_desc.write("Allocated Stack: unknown\n") + else: + file_desc.write("Allocated Stack: %s bytes\n" % + str(subtotal['.stack'])) - if subtotal['.heap'] == 0: - file_desc.write("Allocated Heap: unknown\n") - else: - file_desc.write("Allocated Heap: %s bytes\n" % str(subtotal['.heap'])) - - if subtotal['.stack'] == 0: - file_desc.write("Allocated Stack: unknown\n") - else: - file_desc.write("Allocated Stack: %s bytes\n" % str(subtotal['.stack'])) - - file_desc.write("Total Static RAM memory (data + bss): %s bytes\n" % (str(subtotal['.data']+subtotal['.bss']))) - file_desc.write("Total RAM memory (data + bss + heap + stack): %s bytes\n" % (str(subtotal['.data']+subtotal['.bss']+subtotal['.heap']+subtotal['.stack']))) - file_desc.write("Total Flash memory (text + data + misc): %s bytes\n" % (str(subtotal['.text']+subtotal['.data']+misc_flash_mem))) - - if file_desc is not sys.stdout: - file_desc.close() - - self.mem_summary = json_obj + [summary] - - return True - - def get_memory_summary(self): - """! Object is available only after self.generate_output('json') is called - @return Return memory summary object - """ - return self.mem_summary + file_desc.write("Total Static RAM memory (data + bss): %s bytes\n" % + (str(subtotal['.data'] + subtotal['.bss']))) + file_desc.write( + "Total RAM memory (data + bss + heap + stack): %s bytes\n" + % (str(subtotal['.data'] + subtotal['.bss'] + subtotal['.heap'] + + subtotal['.stack']))) + file_desc.write("Total Flash memory (text + data + misc): %s bytes\n" % + (str(subtotal['.text'] + subtotal['.data'] + + misc_flash_mem))) toolchains = ["ARM", "ARM_STD", "ARM_MICRO", "GCC_ARM", "IAR"] def parse(self, mapfile, toolchain): - """ - Parse and decode map file depending on the toolchain + """ Parse and decode map file depending on the toolchain + + Positional arguments: + mapfile - the file name of the memory map file + toolchain - the toolchain used to create the file """ result = True try: - with open(mapfile, 'rt') as file_input: - if toolchain == "ARM" or toolchain == "ARM_STD" or toolchain == "ARM_MICRO": + with open(mapfile, 'r') as file_input: + if toolchain == "ARM" or toolchain == "ARM_STD" or\ + toolchain == "ARM_MICRO": self.search_objects(os.path.abspath(mapfile), "ARM") self.parse_map_file_armcc(file_input) elif toolchain == "GCC_ARM": @@ -517,21 +595,34 @@ return result def main(): + """Entry Point""" version = '0.3.11' # Parser handling - parser = argparse.ArgumentParser(description="Memory Map File Analyser for ARM mbed\nversion %s" % version) + parser = argparse.ArgumentParser( + description="Memory Map File Analyser for ARM mbed\nversion %s" % + version) - parser.add_argument('file', type=argparse_filestring_type, help='memory map file') + parser.add_argument( + 'file', type=argparse_filestring_type, help='memory map file') - parser.add_argument('-t', '--toolchain', dest='toolchain', help='select a toolchain used to build the memory map file (%s)' % ", ".join(MemapParser.toolchains),\ - required=True, type=argparse_uppercase_type(MemapParser.toolchains, "toolchain")) + parser.add_argument( + '-t', '--toolchain', dest='toolchain', + help='select a toolchain used to build the memory map file (%s)' % + ", ".join(MemapParser.toolchains), + required=True, + type=argparse_uppercase_type(MemapParser.toolchains, "toolchain")) - parser.add_argument('-o', '--output', help='output file name', required=False) + parser.add_argument( + '-o', '--output', help='output file name', required=False) - parser.add_argument('-e', '--export', dest='export', required=False, default='table', type=argparse_lowercase_hyphen_type(MemapParser.export_formats,'export format'),\ - help="export format (examples: %s: default)" % ", ".join(MemapParser.export_formats)) + parser.add_argument( + '-e', '--export', dest='export', required=False, default='table', + type=argparse_lowercase_hyphen_type(MemapParser.export_formats, + 'export format'), + help="export format (examples: %s: default)" % + ", ".join(MemapParser.export_formats)) parser.add_argument('-v', '--version', action='version', version=version) @@ -541,7 +632,7 @@ sys.exit(1) - args, remainder = parser.parse_known_args() + args = parser.parse_args() # Create memap object memap = MemapParser()