.. image:: https://img.shields.io/pypi/v/fpvgcc.svg?logo=pypi
:target: https://pypi.org/project/fpvgcc
.. image:: https://img.shields.io/pypi/pyversions/fpvgcc.svg?logo=pypi
:target: https://pypi.org/project/fpvgcc
.. image:: https://img.shields.io/travis/ebs-universe/fpv-gcc.svg?logo=travis
:target: https://travis-ci.org/ebs-universe/fpv-gcc
.. image:: https://img.shields.io/coveralls/github/ebs-universe/fpv-gcc.svg?logo=coveralls
:target: https://coveralls.io/github/ebs-universe/fpv-gcc
.. image:: https://img.shields.io/requires/github/ebs-universe/fpv-gcc.svg
:target: https://requires.io/github/ebs-universe/fpv-gcc/requirements
.. image:: https://img.shields.io/pypi/l/fpvgcc.svg
:target: https://www.gnu.org/licenses/gpl-3.0.en.html
.. inclusion-marker-do-not-remove
Introduction
------------
``fpvgcc`` is a python script/package to help analyse code footprint on
embedded microcontrollers using GCC generated Map files.
This module uses information contained within ``.map`` files generated by
gcc (when invoked with ``-Wl,-Map,out.map``), to provide easily
readable summaries of static memory usage at various levels of the code
hierarchy. This package generates no information that isn't already contained
within the ``.map`` file.
The provided outputs can be used to gain insight into the relative sizes of
included code, and aid in prioritizing static memory optimization for very
low memory platforms. Some provided functionality may also deliver minor
usability improvements to the workflow involved in parsing though generated
assembly listings.
.. warning::
This package does not attempt to perform any kind of dynamic analysis.
All memory usage reported refers only to **static** memory usage. This
means the size of actual functions and global variables which are
instantiated in the C code itself.
Anything on the call stack, such as function locals, will **not** be
accounted for. Similarly, anything in the heap which is allocated at
runtime using ``malloc`` or similar will **not** be accounted for.
Due to this, the utility of this module is likely limited to code
written for highly memory constrained embedded microcontrollers, where
dynamic memory allocation is anyway avoided when possible.
Known Issues
------------
This script was first written based on the format of mapfiles
generated by ``msp430-elf-gcc, v4.9.1``. Over time, it was modifed to
accept elements found in mapfiles generated by later versions and gcc-based
toolchains for other platforms.
Still, remember that the file parsing was implemented by observing the
content of real mapfiles, and not based on a file format specification.
Even with toolchains it was written to support, there are large sections
of the file that are not actually used. Due to this, the outputs generated
are not always accurate. Various boundary conditions result in minor errors
in size reporting.
The following more serious issues are known. They should be fixed at some
point, but for the moment I've chosen to work around them :
- Having two C filenames with the same name (or generating the same
obj name) in your tree will cause parsing to break on some
platforms / toolchains.
Project Information
-------------------
The latest version of the documentation, including installation, usage, and
API/developer notes can be found at
`ReadTheDocs <https://fpv-gcc.readthedocs.io/en/latest/index.html>`_.
The latest version of the sources can be found at
`GitHub <https://github.com/ebs-universe/fpv-gcc>`_. Please use GitHub's features
to report bugs, request features, or submit pull/merge requests.
The principle author for ``fpvgcc`` is Chintalagiri Shashank. The author can
be contacted if necessary via the information on the
`author's github profile <https://github.com/chintal>`_ . See the AUTHORS file
for a full list of collaborators and/or contributing authors, if any.
``fpvgcc`` is distributed under the terms of the
`GPLv3 license <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_ .
A copy of the text of the license is included along with the sources.
Raw data
{
"_id": null,
"home_page": "https://github.com/ebs-universe/fpv-gcc",
"name": "fpvgcc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"maintainer_email": "",
"keywords": "utilities",
"author": "Chintalagiri Shashank",
"author_email": "shashank@chintal.in",
"download_url": "https://files.pythonhosted.org/packages/5b/8a/0bdc333d6320de92b49735c94e1dcfdbe15f9067841fb5b4d1b49ac250b1/fpvgcc-1.1.1.tar.gz",
"platform": "any",
"description": ".. image:: https://img.shields.io/pypi/v/fpvgcc.svg?logo=pypi\n :target: https://pypi.org/project/fpvgcc\n\n.. image:: https://img.shields.io/pypi/pyversions/fpvgcc.svg?logo=pypi\n :target: https://pypi.org/project/fpvgcc\n\n.. image:: https://img.shields.io/travis/ebs-universe/fpv-gcc.svg?logo=travis\n :target: https://travis-ci.org/ebs-universe/fpv-gcc\n\n.. image:: https://img.shields.io/coveralls/github/ebs-universe/fpv-gcc.svg?logo=coveralls\n :target: https://coveralls.io/github/ebs-universe/fpv-gcc\n\n.. image:: https://img.shields.io/requires/github/ebs-universe/fpv-gcc.svg\n :target: https://requires.io/github/ebs-universe/fpv-gcc/requirements\n\n.. image:: https://img.shields.io/pypi/l/fpvgcc.svg\n :target: https://www.gnu.org/licenses/gpl-3.0.en.html\n\n\n\n.. inclusion-marker-do-not-remove\n\nIntroduction\n------------\n\n``fpvgcc`` is a python script/package to help analyse code footprint on\nembedded microcontrollers using GCC generated Map files.\n\nThis module uses information contained within ``.map`` files generated by\ngcc (when invoked with ``-Wl,-Map,out.map``), to provide easily\nreadable summaries of static memory usage at various levels of the code\nhierarchy. This package generates no information that isn't already contained\nwithin the ``.map`` file.\n\nThe provided outputs can be used to gain insight into the relative sizes of\nincluded code, and aid in prioritizing static memory optimization for very\nlow memory platforms. Some provided functionality may also deliver minor\nusability improvements to the workflow involved in parsing though generated\nassembly listings.\n\n\n.. warning::\n This package does not attempt to perform any kind of dynamic analysis.\n All memory usage reported refers only to **static** memory usage. This\n means the size of actual functions and global variables which are\n instantiated in the C code itself.\n\n Anything on the call stack, such as function locals, will **not** be\n accounted for. Similarly, anything in the heap which is allocated at\n runtime using ``malloc`` or similar will **not** be accounted for.\n\n Due to this, the utility of this module is likely limited to code\n written for highly memory constrained embedded microcontrollers, where\n dynamic memory allocation is anyway avoided when possible.\n\nKnown Issues\n------------\n\nThis script was first written based on the format of mapfiles\ngenerated by ``msp430-elf-gcc, v4.9.1``. Over time, it was modifed to\naccept elements found in mapfiles generated by later versions and gcc-based\ntoolchains for other platforms.\n\nStill, remember that the file parsing was implemented by observing the\ncontent of real mapfiles, and not based on a file format specification.\nEven with toolchains it was written to support, there are large sections\nof the file that are not actually used. Due to this, the outputs generated\nare not always accurate. Various boundary conditions result in minor errors\nin size reporting.\n\nThe following more serious issues are known. They should be fixed at some\npoint, but for the moment I've chosen to work around them :\n\n - Having two C filenames with the same name (or generating the same\n obj name) in your tree will cause parsing to break on some\n platforms / toolchains.\n\n\nProject Information\n-------------------\n\nThe latest version of the documentation, including installation, usage, and\nAPI/developer notes can be found at\n`ReadTheDocs <https://fpv-gcc.readthedocs.io/en/latest/index.html>`_.\n\nThe latest version of the sources can be found at\n`GitHub <https://github.com/ebs-universe/fpv-gcc>`_. Please use GitHub's features\nto report bugs, request features, or submit pull/merge requests.\n\nThe principle author for ``fpvgcc`` is Chintalagiri Shashank. The author can\nbe contacted if necessary via the information on the\n`author's github profile <https://github.com/chintal>`_ . See the AUTHORS file\nfor a full list of collaborators and/or contributing authors, if any.\n\n``fpvgcc`` is distributed under the terms of the\n`GPLv3 license <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_ .\nA copy of the text of the license is included along with the sources.",
"bugtrack_url": null,
"license": "",
"summary": "Analysing code footprint on embedded microcontrollers using GCC generated Map files",
"version": "1.1.1",
"split_keywords": [
"utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "5c7078e30a93e83d5845cd195bb0ab0d",
"sha256": "b1fae186da3a5fdb865a2d61ebac8d0bd6f2482d1bd69f3bbe86acee13387d6f"
},
"downloads": -1,
"filename": "fpvgcc-1.1.1.tar.gz",
"has_sig": true,
"md5_digest": "5c7078e30a93e83d5845cd195bb0ab0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*",
"size": 208558,
"upload_time": "2022-11-30T06:21:06",
"upload_time_iso_8601": "2022-11-30T06:21:06.746101Z",
"url": "https://files.pythonhosted.org/packages/5b/8a/0bdc333d6320de92b49735c94e1dcfdbe15f9067841fb5b4d1b49ac250b1/fpvgcc-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-30 06:21:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ebs-universe",
"github_project": "fpv-gcc",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "six",
"specs": []
},
{
"name": "prettytable",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "sphinx-argparse",
"specs": []
}
],
"tox": true,
"lcname": "fpvgcc"
}
JSON
