mirror of https://github.com/ARMmbed/mbed-os.git
Format and add docstrings to memmap
Jimmy Brisson
parent
ea63a4d9a7
commit
cb5e61028d
370
tools/memap.py
370
tools/memap.py
|
|
@ -1,8 +1,6 @@
|
||||||
#!/usr/bin/env python
|
#!/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 sys
|
||||||
import os
|
import os
|
||||||
|
|
@ -10,37 +8,46 @@ import re
|
||||||
import csv
|
import csv
|
||||||
import json
|
import json
|
||||||
import argparse
|
import argparse
|
||||||
from utils import argparse_uppercase_type, argparse_lowercase_hyphen_type, argparse_filestring_type
|
|
||||||
from prettytable import PrettyTable
|
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):
|
class MemapParser(object):
|
||||||
|
"""An object that represents parsed results, parses the memory map files,
|
||||||
def __init__(self):
|
and writes out different file types of memory results
|
||||||
"""
|
|
||||||
General initialization
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
# list of all modules and their sections
|
print_sections = ('.text', '.data', '.bss')
|
||||||
self.modules = dict()
|
|
||||||
|
|
||||||
self.misc_flash_sections = ('.interrupts', '.flash_config')
|
misc_flash_sections = ('.interrupts', '.flash_config')
|
||||||
|
|
||||||
self.other_sections = ('.interrupts_ram', '.init', '.ARM.extab',
|
other_sections = ('.interrupts_ram', '.init', '.ARM.extab',
|
||||||
'.ARM.exidx', '.ARM.attributes', '.eh_frame',
|
'.ARM.exidx', '.ARM.attributes', '.eh_frame',
|
||||||
'.init_array', '.fini_array', '.jcr', '.stab',
|
'.init_array', '.fini_array', '.jcr', '.stab',
|
||||||
'.stabstr', '.ARM.exidx', '.ARM')
|
'.stabstr', '.ARM.exidx', '.ARM')
|
||||||
|
|
||||||
# sections to print info (generic for all toolchains)
|
# sections to print info (generic for all toolchains)
|
||||||
self.sections = ('.text', '.data', '.bss', '.heap', '.stack')
|
sections = ('.text', '.data', '.bss', '.heap', '.stack')
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
""" General initialization
|
||||||
|
"""
|
||||||
|
|
||||||
|
# list of all modules and their sections
|
||||||
|
self.modules = dict()
|
||||||
|
|
||||||
# sections must be defined in this order to take irrelevant out
|
# sections must be defined in this order to take irrelevant out
|
||||||
self.all_sections = self.sections + self.other_sections + \
|
self.all_sections = self.sections + self.other_sections + \
|
||||||
self.misc_flash_sections + ('unknown', 'OUTPUT')
|
self.misc_flash_sections + ('unknown', 'OUTPUT')
|
||||||
|
|
||||||
self.print_sections = ('.text', '.data', '.bss')
|
|
||||||
|
|
||||||
# list of all object files and mappting to module names
|
# list of all object files and mappting to module names
|
||||||
self.object_to_module = dict()
|
self.object_to_module = dict()
|
||||||
|
|
||||||
|
|
@ -48,8 +55,12 @@ class MemapParser(object):
|
||||||
self.mem_summary = dict()
|
self.mem_summary = dict()
|
||||||
|
|
||||||
def module_add(self, module_name, size, section):
|
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:
|
if module_name in self.modules:
|
||||||
|
|
@ -62,22 +73,29 @@ class MemapParser(object):
|
||||||
self.modules[module_name] = temp_dic
|
self.modules[module_name] = temp_dic
|
||||||
|
|
||||||
def check_new_section_gcc(self, line):
|
def check_new_section_gcc(self, line):
|
||||||
"""
|
""" Check whether a new section in a map file has been detected (only
|
||||||
Check whether a new section in a map file has been detected (only applies to gcc)
|
applies to gcc)
|
||||||
|
|
||||||
|
Positional arguments:
|
||||||
|
line - the line to check for a new section
|
||||||
"""
|
"""
|
||||||
|
|
||||||
for i in self.all_sections:
|
for i in self.all_sections:
|
||||||
if line.startswith(i):
|
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('.'):
|
if line.startswith('.'):
|
||||||
return 'unknown' # all others are classified are unknown
|
return 'unknown' # all others are classified are unknown
|
||||||
else:
|
else:
|
||||||
return False # everything else, means no change in section
|
return False # everything else, means no change in section
|
||||||
|
|
||||||
def path_object_to_module_name(self, txt):
|
@staticmethod
|
||||||
"""
|
def path_object_to_module_name(txt):
|
||||||
Parses path to object file and extracts module / object data
|
""" 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('\\', '/')
|
txt = txt.replace('\\', '/')
|
||||||
|
|
@ -101,13 +119,17 @@ class MemapParser(object):
|
||||||
|
|
||||||
|
|
||||||
def parse_section_gcc(self, line):
|
def parse_section_gcc(self, line):
|
||||||
|
""" 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
|
||||||
"""
|
"""
|
||||||
Parse data from a section of gcc map file
|
rex_address_len_name = re.compile(
|
||||||
"""
|
r'^\s+.*0x(\w{8,16})\s+0x(\w+)\s(.+)$')
|
||||||
# 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(.+)$'
|
|
||||||
|
|
||||||
test_address_len_name = re.match(rex_address_len_name, line)
|
test_address_len_name = re.match(rex_address_len_name, line)
|
||||||
|
|
||||||
|
|
@ -116,7 +138,8 @@ class MemapParser(object):
|
||||||
if int(test_address_len_name.group(2), 16) == 0: # size == 0
|
if int(test_address_len_name.group(2), 16) == 0: # size == 0
|
||||||
return ["", 0] # no valid entry
|
return ["", 0] # no valid entry
|
||||||
else:
|
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)
|
m_size = int(test_address_len_name.group(2), 16)
|
||||||
return [m_name, m_size]
|
return [m_name, m_size]
|
||||||
|
|
||||||
|
|
@ -137,8 +160,10 @@ class MemapParser(object):
|
||||||
return ["", 0] # no valid entry
|
return ["", 0] # no valid entry
|
||||||
|
|
||||||
def parse_map_file_gcc(self, file_desc):
|
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'
|
current_section = 'unknown'
|
||||||
|
|
@ -168,22 +193,25 @@ class MemapParser(object):
|
||||||
else:
|
else:
|
||||||
self.module_add(module_name, module_size, current_section)
|
self.module_add(module_name, module_size, current_section)
|
||||||
|
|
||||||
if debug:
|
if DEBUG:
|
||||||
print "Line: %s" % line,
|
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("----------")
|
raw_input("----------")
|
||||||
|
|
||||||
def parse_section_armcc(self, line):
|
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)
|
|
||||||
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)
|
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
|
||||||
|
"""
|
||||||
|
|
||||||
|
test_rex_armcc = re.match(RE_ARMCC, line)
|
||||||
|
|
||||||
if test_rex_armcc:
|
if test_rex_armcc:
|
||||||
|
|
||||||
|
|
@ -213,30 +241,34 @@ class MemapParser(object):
|
||||||
return ["", 0, ""] # no valid entry
|
return ["", 0, ""] # no valid entry
|
||||||
|
|
||||||
def parse_section_iar(self, line):
|
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>
|
|
||||||
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)
|
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
|
||||||
|
"""
|
||||||
|
|
||||||
|
test_rex_iar = re.match(RE_IAR, line)
|
||||||
|
|
||||||
if test_rex_iar:
|
if test_rex_iar:
|
||||||
|
|
||||||
size = int(test_rex_iar.group(4), 16)
|
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'
|
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':
|
if test_rex_iar.group(1)[0:4] == 'HEAP':
|
||||||
section = '.heap'
|
section = '.heap'
|
||||||
elif test_rex_iar.group(1)[0:6] == 'CSTACK':
|
elif test_rex_iar.group(1)[0:6] == 'CSTACK':
|
||||||
|
|
@ -263,8 +295,10 @@ class MemapParser(object):
|
||||||
return ["", 0, ""] # no valid entry
|
return ["", 0, ""] # no valid entry
|
||||||
|
|
||||||
def parse_map_file_armcc(self, file_desc):
|
def parse_map_file_armcc(self, file_desc):
|
||||||
"""
|
""" Main logic to decode armc5 map files
|
||||||
Main logic to decode armcc map files
|
|
||||||
|
Positional arguments:
|
||||||
|
file_desc - a file like object to parse as an armc5 map file
|
||||||
"""
|
"""
|
||||||
|
|
||||||
with file_desc as infile:
|
with file_desc as infile:
|
||||||
|
|
@ -285,8 +319,10 @@ class MemapParser(object):
|
||||||
self.module_add(name, size, section)
|
self.module_add(name, size, section)
|
||||||
|
|
||||||
def parse_map_file_iar(self, file_desc):
|
def parse_map_file_iar(self, file_desc):
|
||||||
"""
|
""" Main logic to decode IAR map files
|
||||||
Main logic to decode armcc map files
|
|
||||||
|
Positional arguments:
|
||||||
|
file_desc - a file like object to parse as an IAR map file
|
||||||
"""
|
"""
|
||||||
|
|
||||||
with file_desc as infile:
|
with file_desc as infile:
|
||||||
|
|
@ -307,9 +343,12 @@ class MemapParser(object):
|
||||||
self.module_add(name, size, section)
|
self.module_add(name, size, section)
|
||||||
|
|
||||||
def search_objects(self, path, toolchain):
|
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
|
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('\\', '/')
|
path = path.replace('\\', '/')
|
||||||
|
|
@ -323,18 +362,22 @@ class MemapParser(object):
|
||||||
else:
|
else:
|
||||||
# It looks this is not an mbed project
|
# It looks this is not an mbed project
|
||||||
# object-to-module mapping cannot be generated
|
# 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
|
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:
|
for obj_file in obj_files:
|
||||||
if obj_file.endswith(".o"):
|
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 object_name in self.object_to_module:
|
||||||
if debug:
|
if DEBUG:
|
||||||
print "WARNING: multiple usages of object file: %s" % object_name
|
print "WARNING: multiple usages of object file: %s"\
|
||||||
print " Current: %s" % self.object_to_module[object_name]
|
% object_name
|
||||||
|
print " Current: %s" % \
|
||||||
|
self.object_to_module[object_name]
|
||||||
print " New: %s" % module_name
|
print " New: %s" % module_name
|
||||||
print " "
|
print " "
|
||||||
else:
|
else:
|
||||||
|
|
@ -343,12 +386,13 @@ class MemapParser(object):
|
||||||
export_formats = ["json", "csv-ci", "table"]
|
export_formats = ["json", "csv-ci", "table"]
|
||||||
|
|
||||||
def generate_output(self, export_format, file_output=None):
|
def generate_output(self, export_format, file_output=None):
|
||||||
"""
|
""" Generates summary of memory map data
|
||||||
Generates summary of memory map data
|
|
||||||
|
|
||||||
Parameters
|
Positional arguments:
|
||||||
json_mode: generates output in json formal (True/False)
|
export_format - the format to dump
|
||||||
file_desc: descriptor (either stdout or file)
|
|
||||||
|
Keyword arguments:
|
||||||
|
file_desc - descriptor (either stdout or file)
|
||||||
"""
|
"""
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|
@ -360,6 +404,10 @@ class MemapParser(object):
|
||||||
print "I/O error({0}): {1}".format(error.errno, error.strerror)
|
print "I/O error({0}): {1}".format(error.errno, error.strerror)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
subtotal = dict()
|
||||||
|
for k in self.sections:
|
||||||
|
subtotal[k] = 0
|
||||||
|
|
||||||
# Calculate misc flash sections
|
# Calculate misc flash sections
|
||||||
misc_flash_mem = 0
|
misc_flash_mem = 0
|
||||||
for i in self.modules:
|
for i in self.modules:
|
||||||
|
|
@ -367,22 +415,6 @@ class MemapParser(object):
|
||||||
if self.modules[i][k]:
|
if self.modules[i][k]:
|
||||||
misc_flash_mem += self.modules[i][k]
|
misc_flash_mem += self.modules[i][k]
|
||||||
|
|
||||||
# Create table
|
|
||||||
columns = ['Module']
|
|
||||||
columns.extend(self.print_sections)
|
|
||||||
|
|
||||||
table = PrettyTable(columns)
|
|
||||||
table.align["Module"] = "l"
|
|
||||||
for col in self.print_sections:
|
|
||||||
table.align[col] = 'r'
|
|
||||||
|
|
||||||
for i in list(self.print_sections):
|
|
||||||
table.align[i] = 'r'
|
|
||||||
|
|
||||||
subtotal = dict()
|
|
||||||
for k in self.sections:
|
|
||||||
subtotal[k] = 0
|
|
||||||
|
|
||||||
json_obj = []
|
json_obj = []
|
||||||
for i in sorted(self.modules):
|
for i in sorted(self.modules):
|
||||||
|
|
||||||
|
|
@ -402,32 +434,49 @@ class MemapParser(object):
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
table.add_row(row)
|
|
||||||
|
|
||||||
subtotal_row = ['Subtotals']
|
|
||||||
for k in self.print_sections:
|
|
||||||
subtotal_row.append(subtotal[k])
|
|
||||||
|
|
||||||
table.add_row(subtotal_row)
|
|
||||||
|
|
||||||
summary = {
|
summary = {
|
||||||
'summary':{
|
'summary':{
|
||||||
'static_ram': (subtotal['.data'] + subtotal['.bss']),
|
'static_ram': (subtotal['.data'] + subtotal['.bss']),
|
||||||
'heap': (subtotal['.heap']),
|
'heap': (subtotal['.heap']),
|
||||||
'stack': (subtotal['.stack']),
|
'stack': (subtotal['.stack']),
|
||||||
'total_ram':(subtotal['.data']+subtotal['.bss']+subtotal['.heap']+subtotal['.stack']),
|
'total_ram': (subtotal['.data'] + subtotal['.bss'] +
|
||||||
'total_flash':(subtotal['.text']+subtotal['.data']+misc_flash_mem),
|
subtotal['.heap']+subtotal['.stack']),
|
||||||
|
'total_flash': (subtotal['.text'] + subtotal['.data'] +
|
||||||
|
misc_flash_mem),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if export_format == 'json':
|
self.mem_summary = json_obj + [summary]
|
||||||
json_to_file = json_obj + [summary]
|
|
||||||
file_desc.write(json.dumps(json_to_file, indent=4))
|
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')
|
file_desc.write('\n')
|
||||||
|
|
||||||
elif export_format == 'csv-ci': # CSV format for the CI system
|
def generate_csv(self, subtotal, misc_flash_mem, file_desc):
|
||||||
|
"""Generate a CSV file from a memoy map
|
||||||
|
|
||||||
csv_writer = csv.writer(file_desc, delimiter=',', quoting=csv.QUOTE_NONE)
|
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_module_section = []
|
||||||
csv_sizes = []
|
csv_sizes = []
|
||||||
|
|
@ -452,7 +501,8 @@ class MemapParser(object):
|
||||||
csv_sizes += [subtotal['.stack']]
|
csv_sizes += [subtotal['.stack']]
|
||||||
|
|
||||||
csv_module_section += ['total_ram']
|
csv_module_section += ['total_ram']
|
||||||
csv_sizes += [subtotal['.data']+subtotal['.bss']+subtotal['.heap']+subtotal['.stack']]
|
csv_sizes += [subtotal['.data'] + subtotal['.bss'] +
|
||||||
|
subtotal['.heap'] + subtotal['.stack']]
|
||||||
|
|
||||||
csv_module_section += ['total_flash']
|
csv_module_section += ['total_flash']
|
||||||
csv_sizes += [subtotal['.text']+subtotal['.data']+misc_flash_mem]
|
csv_sizes += [subtotal['.text']+subtotal['.data']+misc_flash_mem]
|
||||||
|
|
@ -460,48 +510,73 @@ class MemapParser(object):
|
||||||
csv_writer.writerow(csv_module_section)
|
csv_writer.writerow(csv_module_section)
|
||||||
csv_writer.writerow(csv_sizes)
|
csv_writer.writerow(csv_sizes)
|
||||||
|
|
||||||
else: # default format is 'table'
|
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)
|
||||||
|
|
||||||
|
table = PrettyTable(columns)
|
||||||
|
table.align["Module"] = "l"
|
||||||
|
for col in self.print_sections:
|
||||||
|
table.align[col] = 'r'
|
||||||
|
|
||||||
|
for i in list(self.print_sections):
|
||||||
|
table.align[i] = 'r'
|
||||||
|
|
||||||
|
|
||||||
|
subtotal_row = ['Subtotals']
|
||||||
|
for k in self.print_sections:
|
||||||
|
subtotal_row.append(subtotal[k])
|
||||||
|
|
||||||
|
table.add_row(subtotal_row)
|
||||||
|
|
||||||
file_desc.write(table.get_string())
|
file_desc.write(table.get_string())
|
||||||
file_desc.write('\n')
|
file_desc.write('\n')
|
||||||
|
|
||||||
if subtotal['.heap'] == 0:
|
if subtotal['.heap'] == 0:
|
||||||
file_desc.write("Allocated Heap: unknown\n")
|
file_desc.write("Allocated Heap: unknown\n")
|
||||||
else:
|
else:
|
||||||
file_desc.write("Allocated Heap: %s bytes\n" % str(subtotal['.heap']))
|
file_desc.write("Allocated Heap: %s bytes\n" %
|
||||||
|
str(subtotal['.heap']))
|
||||||
|
|
||||||
if subtotal['.stack'] == 0:
|
if subtotal['.stack'] == 0:
|
||||||
file_desc.write("Allocated Stack: unknown\n")
|
file_desc.write("Allocated Stack: unknown\n")
|
||||||
else:
|
else:
|
||||||
file_desc.write("Allocated Stack: %s bytes\n" % str(subtotal['.stack']))
|
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 Static RAM memory (data + bss): %s bytes\n" %
|
||||||
file_desc.write("Total RAM memory (data + bss + heap + stack): %s bytes\n" % (str(subtotal['.data']+subtotal['.bss']+subtotal['.heap']+subtotal['.stack'])))
|
(str(subtotal['.data'] + subtotal['.bss'])))
|
||||||
file_desc.write("Total Flash memory (text + data + misc): %s bytes\n" % (str(subtotal['.text']+subtotal['.data']+misc_flash_mem)))
|
file_desc.write(
|
||||||
|
"Total RAM memory (data + bss + heap + stack): %s bytes\n"
|
||||||
if file_desc is not sys.stdout:
|
% (str(subtotal['.data'] + subtotal['.bss'] + subtotal['.heap'] +
|
||||||
file_desc.close()
|
subtotal['.stack'])))
|
||||||
|
file_desc.write("Total Flash memory (text + data + misc): %s bytes\n" %
|
||||||
self.mem_summary = json_obj + [summary]
|
(str(subtotal['.text'] + subtotal['.data'] +
|
||||||
|
misc_flash_mem)))
|
||||||
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
|
|
||||||
|
|
||||||
toolchains = ["ARM", "ARM_STD", "ARM_MICRO", "GCC_ARM", "IAR"]
|
toolchains = ["ARM", "ARM_STD", "ARM_MICRO", "GCC_ARM", "IAR"]
|
||||||
|
|
||||||
def parse(self, mapfile, toolchain):
|
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
|
result = True
|
||||||
try:
|
try:
|
||||||
with open(mapfile, 'rt') as file_input:
|
with open(mapfile, 'r') as file_input:
|
||||||
if toolchain == "ARM" or toolchain == "ARM_STD" or toolchain == "ARM_MICRO":
|
if toolchain == "ARM" or toolchain == "ARM_STD" or\
|
||||||
|
toolchain == "ARM_MICRO":
|
||||||
self.search_objects(os.path.abspath(mapfile), "ARM")
|
self.search_objects(os.path.abspath(mapfile), "ARM")
|
||||||
self.parse_map_file_armcc(file_input)
|
self.parse_map_file_armcc(file_input)
|
||||||
elif toolchain == "GCC_ARM":
|
elif toolchain == "GCC_ARM":
|
||||||
|
|
@ -517,21 +592,34 @@ class MemapParser(object):
|
||||||
return result
|
return result
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
|
"""Entry Point"""
|
||||||
|
|
||||||
version = '0.3.11'
|
version = '0.3.11'
|
||||||
|
|
||||||
# Parser handling
|
# 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),\
|
parser.add_argument(
|
||||||
required=True, type=argparse_uppercase_type(MemapParser.toolchains, "toolchain"))
|
'-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'),\
|
parser.add_argument(
|
||||||
help="export format (examples: %s: default)" % ", ".join(MemapParser.export_formats))
|
'-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)
|
parser.add_argument('-v', '--version', action='version', version=version)
|
||||||
|
|
||||||
|
|
@ -541,7 +629,7 @@ def main():
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
args, remainder = parser.parse_known_args()
|
args = parser.parse_args()
|
||||||
|
|
||||||
# Create memap object
|
# Create memap object
|
||||||
memap = MemapParser()
|
memap = MemapParser()
|
||||||
|
|
|
||||||
|
|
@ -1035,7 +1035,7 @@ class mbedToolchain:
|
||||||
# Here we return memory statistics structure (constructed after
|
# Here we return memory statistics structure (constructed after
|
||||||
# call to generate_output) which contains raw data in bytes
|
# call to generate_output) which contains raw data in bytes
|
||||||
# about sections + summary
|
# about sections + summary
|
||||||
return memap.get_memory_summary()
|
return memap.mem_summary
|
||||||
|
|
||||||
# Set the configuration data
|
# Set the configuration data
|
||||||
def set_config_data(self, config_data):
|
def set_config_data(self, config_data):
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue