Skip to content

Add segment size printout to standard build process #6525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions platform.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ runtime.tools.python3.path={runtime.platform.path}/tools/python3
runtime.tools.esptool.path={runtime.platform.path}/tools/esptool
runtime.tools.signing={runtime.platform.path}/tools/signing.py
runtime.tools.elf2bin={runtime.platform.path}/tools/elf2bin.py
runtime.tools.sizes={runtime.platform.path}/tools/sizes.py
runtime.tools.makecorever={runtime.platform.path}/tools/makecorever.py
runtime.tools.eboot={runtime.platform.path}/bootloaders/eboot/eboot.elf

Expand Down Expand Up @@ -112,6 +113,7 @@ recipe.objcopy.eep.pattern=
## Create hex
recipe.objcopy.hex.1.pattern="{runtime.tools.python3.path}/python3" "{runtime.tools.elf2bin}" --eboot "{runtime.tools.eboot}" --app "{build.path}/{build.project_name}.elf" --flash_mode {build.flash_mode} --flash_freq {build.flash_freq} --flash_size {build.flash_size} --path "{runtime.tools.xtensa-lx106-elf-gcc.path}/bin" --out "{build.path}/{build.project_name}.bin"
recipe.objcopy.hex.2.pattern="{runtime.tools.python3.path}/python3" "{runtime.tools.signing}" --mode sign --privatekey "{build.source.path}/private.key" --bin "{build.path}/{build.project_name}.bin" --out "{build.path}/{build.project_name}.bin.signed" --legacy "{build.path}/{build.project_name}.bin.legacy_sig"
recipe.objcopy.hex.3.pattern="{runtime.tools.python3.path}/python3" "{runtime.tools.sizes}" --elf "{build.path}/{build.project_name}.elf" --path "{runtime.tools.xtensa-lx106-elf-gcc.path}/bin"

## Save hex
recipe.output.tmp_file={build.project_name}.bin
Expand Down
64 changes: 64 additions & 0 deletions tools/sizes.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
#!/usr/bin/env python3

# Display the segment sizes used by an ELF
#
# Copyright (C) 2019 - Earle F. Philhower, III
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

from __future__ import print_function
import argparse
import os
import subprocess
import sys

def get_segment_sizes(elf, path):
sizes = {}
sizes['IROM'] = 0
sizes['IRAM'] = 0
sizes['DATA'] = 0
sizes['RODATA'] = 0
sizes['BSS'] = 0
p = subprocess.Popen([path + "/xtensa-lx106-elf-size", '-A', elf], stdout=subprocess.PIPE, universal_newlines=True )
lines = p.stdout.readlines()
for line in lines:
words = line.split()
if line.startswith('.irom0.text'):
sizes['IROM'] = sizes['IROM'] + int(words[1])
elif line.startswith('.text'): # Gets .text and .text1
sizes['IRAM'] = sizes['IRAM'] + int(words[1])
elif line.startswith('.data'): # Gets .text and .text1
sizes['DATA'] = sizes['DATA'] + int(words[1])
elif line.startswith('.rodata'): # Gets .text and .text1
sizes['RODATA'] = sizes['RODATA'] + int(words[1])
elif line.startswith('.bss'): # Gets .text and .text1
sizes['BSS'] = sizes['BSS'] + int(words[1])
return sizes

def main():
parser = argparse.ArgumentParser(description='Report the different segment sizes of a compiled ELF file')
parser.add_argument('-e', '--elf', action='store', required=True, help='Path to the Arduino sketch ELF')
parser.add_argument('-p', '--path', action='store', required=True, help='Path to Xtensa toolchain binaries')

args = parser.parse_args()
sizes = get_segment_sizes(args.elf, args.path)

sys.stderr.write("Executable segment sizes:" + os.linesep)
for k in sizes.keys():
sys.stderr.write("%-7s: %d%s" % (k, sizes[k], os.linesep))

return 0

if __name__ == '__main__':
sys.exit(main())