Add --build-data switch to mbed compile and test #4110

theotherjimmy · 2017-04-04T16:39:56Z

The --build-data switch is used to specify a file that will be filled
with build metadata.

Testing

/morph test
mbed 2 tests

jupe · 2017-04-04T19:36:19Z

could you add builds -property back ? :) like:

{
  builds: []
}

I think its still usefull..

theotherjimmy · 2017-04-04T19:37:42Z

~~I suppose, but~~Done. what is it useful for?

theotherjimmy · 2017-04-04T20:06:40Z

So, this is what the file looks like for an incremental build:

{
    "builds": [
        {
            "bin": "./BUILD/K64F/gcc_arm/mbed-os-example-fat-filesystem.bin",
            "linker": {
                "flags": [
                    "-Wl,--gc-sections",
                    "-Wl,--wrap,main",
                    "-Wl,--wrap,_malloc_r",
                    "-Wl,--wrap,_free_r",
                    "-Wl,--wrap,_realloc_r",
                    "-Wl,--wrap,_calloc_r",
                    "-Wl,--wrap,exit",
                    "-Wl,--wrap,atexit",
                    "-Wl,-n",
                    "-mcpu=cortex-m4",
                    "-mthumb",
                    "-mfpu=fpv4-sp-d16",
                    "-mfloat-abi=softfp"
                ]
            },
            "description": "mbed-os-example-fat-filesystem",
            "library_configs": [
                "mbed-os/features/netsocket/mbed_lib.json",
                "mbed-os/features/frameworks/utest/mbed_lib.json",
                "mbed-os/features/filesystem/mbed_lib.json",
                "mbed-os/rtos/mbed_lib.json",
                "mbed-os/platform/mbed_lib.json",
                "mbed-os/events/mbed_lib.json",
                "mbed-os/features/FEATURE_LWIP/lwip-interface/mbed_lib.json",
                "mbed-os/features/storage/FEATURE_STORAGE/cfstore/mbed_lib.json"
            ],
            "target_name": "K64F",
            "assembler": {
                "symbols": [
                    "__CORTEX_M4",
                    "CPU_MK64FN1M0VMD12",
                    "ARM_MATH_CM4",
                    "__FPU_PRESENT=1",
                    "__MBED_CMSIS_RTOS_CM",
                    "__CMSIS_RTOS",
                    "FSL_RTOS_MBED"
                ],
                "flags": [
                    "-x",
                    "assembler-with-cpp"
                ]
            },
            "elf": "./BUILD/K64F/gcc_arm/mbed-os-example-fat-filesystem.elf",
            "cxx_compiler": {
                "symbols": [
                    "FEATURE_LWIP=1",
                    "__MBED__=1",
                    "DEVICE_I2CSLAVE=1",
                    "__FPU_PRESENT=1",
                    "TARGET_Freescale",
                    "DEVICE_PORTINOUT=1",
                    "TARGET_RTOS_M4_M7",
                    "DEVICE_LOWPOWERTIMER=1",
                    "DEVICE_RTC=1",
                    "TOOLCHAIN_object",
                    "DEVICE_SERIAL_ASYNCH=1",
                    "__CMSIS_RTOS",
                    "FSL_RTOS_MBED",
                    "DEVICE_STORAGE=1",
                    "TARGET_KPSDK_MCUS",
                    "TARGET_FLASH_CMSIS_ALGO",
                    "TOOLCHAIN_GCC",
                    "ARM_MATH_CM4",
                    "TARGET_KSDK2_MCUS",
                    "TARGET_LIKE_CORTEX_M4",
                    "DEVICE_ANALOGOUT=1",
                    "TARGET_M4",
                    "TARGET_UVISOR_UNSUPPORTED",
                    "TARGET_K64F",
                    "DEVICE_SPI_ASYNCH=1",
                    "DEVICE_PWMOUT=1",
                    "DEVICE_INTERRUPTIN=1",
                    "DEVICE_I2C=1",
                    "DEVICE_PORTOUT=1",
                    "__CORTEX_M4",
                    "DEVICE_STDIO_MESSAGES=1",
                    "CPU_MK64FN1M0VMD12",
                    "TARGET_LIKE_MBED",
                    "TARGET_FF_ARDUINO",
                    "TARGET_KPSDK_CODE",
                    "TARGET_RELEASE",
                    "DEVICE_SERIAL_FC=1",
                    "DEVICE_ERROR_RED=1",
                    "DEVICE_TRNG=1",
                    "__MBED_CMSIS_RTOS_CM",
                    "DEVICE_SLEEP=1",
                    "TOOLCHAIN_GCC_ARM",
                    "TARGET_FRDM",
                    "TARGET_MCUXpresso_MCUS",
                    "DEVICE_SPI=1",
                    "FEATURE_STORAGE=1",
                    "MBED_BUILD_TIMESTAMP=1491336376.18",
                    "DEVICE_SPISLAVE=1",
                    "DEVICE_ANALOGIN=1",
                    "DEVICE_SERIAL=1",
                    "DEVICE_FLASH=1",
                    "DEVICE_PORTIN=1",
                    "TARGET_MCU_K64F",
                    "TARGET_CORTEX_M"
                ],
                "flags": [
                    "-std=gnu++98",
                    "-fno-rtti",
                    "-Wvla"
                ]
            },
            "elapsed_time": 0.5062179565429688,
            "c_compiler": {
                "symbols": [
                    "FEATURE_LWIP=1",
                    "__MBED__=1",
                    "DEVICE_I2CSLAVE=1",
                    "__FPU_PRESENT=1",
                    "TARGET_Freescale",
                    "DEVICE_PORTINOUT=1",
                    "TARGET_RTOS_M4_M7",
                    "DEVICE_LOWPOWERTIMER=1",
                    "DEVICE_RTC=1",
                    "TOOLCHAIN_object",
                    "DEVICE_SERIAL_ASYNCH=1",
                    "__CMSIS_RTOS",
                    "FSL_RTOS_MBED",
                    "DEVICE_STORAGE=1",
                    "TARGET_KPSDK_MCUS",
                    "TARGET_FLASH_CMSIS_ALGO",
                    "TOOLCHAIN_GCC",
                    "ARM_MATH_CM4",
                    "TARGET_KSDK2_MCUS",
                    "TARGET_LIKE_CORTEX_M4",
                    "DEVICE_ANALOGOUT=1",
                    "TARGET_M4",
                    "TARGET_UVISOR_UNSUPPORTED",
                    "TARGET_K64F",
                    "DEVICE_SPI_ASYNCH=1",
                    "DEVICE_PWMOUT=1",
                    "DEVICE_INTERRUPTIN=1",
                    "DEVICE_I2C=1",
                    "DEVICE_PORTOUT=1",
                    "__CORTEX_M4",
                    "DEVICE_STDIO_MESSAGES=1",
                    "CPU_MK64FN1M0VMD12",
                    "TARGET_LIKE_MBED",
                    "TARGET_FF_ARDUINO",
                    "TARGET_KPSDK_CODE",
                    "TARGET_RELEASE",
                    "DEVICE_SERIAL_FC=1",
                    "DEVICE_ERROR_RED=1",
                    "DEVICE_TRNG=1",
                    "__MBED_CMSIS_RTOS_CM",
                    "DEVICE_SLEEP=1",
                    "TOOLCHAIN_GCC_ARM",
                    "TARGET_FRDM",
                    "TARGET_MCUXpresso_MCUS",
                    "DEVICE_SPI=1",
                    "FEATURE_STORAGE=1",
                    "MBED_BUILD_TIMESTAMP=1491336376.18",
                    "DEVICE_SPISLAVE=1",
                    "DEVICE_ANALOGIN=1",
                    "DEVICE_SERIAL=1",
                    "DEVICE_FLASH=1",
                    "DEVICE_PORTIN=1",
                    "TARGET_MCU_K64F",
                    "TARGET_CORTEX_M"
                ],
                "flags": [
                    "-std=gnu99"
                ]
            },
            "app_config": null,
            "result": "OK",
            "toolchain_name": "GCC_ARM",
            "date": "2017-04-04 15:06:16.690662",
            "output": "Building project mbed-os-example-fat-filesystem (K64F, GCC_ARM)\nScan: .\nScan: FEATURE_LWIP\nScan: FEATURE_COMMON_PAL\nScan: FEATURE_UVISOR\nScan: FEATURE_BLE\nScan: FEATURE_LOWPAN_ROUTER\nScan: FEATURE_ETHERNET_HOST\nScan: FEATURE_NANOSTACK\nScan: FEATURE_THREAD_END_DEVICE\nScan: FEATURE_THREAD_ROUTER\nScan: FEATURE_THREAD_BORDER_ROUTER\nScan: FEATURE_LOWPAN_BORDER_ROUTER\nScan: FEATURE_NANOSTACK_FULL\nScan: FEATURE_LOWPAN_HOST\nScan: FEATURE_STORAGE\nScan: env\nScan: mbed\nCompile [100.0%]: main.cpp\nLink: mbed-os-example-fat-filesystem\nElf2Bin: mbed-os-example-fat-filesystem\n+--------------------------+-------+-------+-------+\n| Module                   | .text | .data |  .bss |\n+--------------------------+-------+-------+-------+\n| Fill                     |   172 |     0 |  2391 |\n| Misc                     | 54505 |  2556 |   754 |\n| drivers                  |   148 |     0 |     0 |\n| features/filesystem      | 15821 |     0 |   807 |\n| features/storage         |    42 |     0 |   184 |\n| hal                      |   418 |     0 |     8 |\n| platform                 |  2787 |    20 |   614 |\n| rtos                     |   135 |     4 |     4 |\n| rtos/rtx                 |  5869 |    20 |  6870 |\n| targets/TARGET_Freescale |  8382 |    12 |   384 |\n| Subtotals                | 88279 |  2612 | 12016 |\n+--------------------------+-------+-------+-------+\nAllocated Heap: 24576 bytes\nAllocated Stack: unknown\nTotal Static RAM memory (data + bss): 14628 bytes\nTotal RAM memory (data + bss + heap + stack): 39204 bytes\nTotal Flash memory (text + data + misc): 91931 bytes\n",
            "id": "MBED-OS-EXAMPLE-FAT-FILESYSTEM",
            "memory_usage": [
                {
                    "module": "Fill",
                    "size": {
                        ".data": 0,
                        ".bss": 2391,
                        ".text": 172
                    }
                },
                {
                    "module": "Misc",
                    "size": {
                        ".data": 2556,
                        ".bss": 754,
                        ".text": 54505
                    }
                },
                {
                    "module": "drivers",
                    "size": {
                        ".data": 0,
                        ".bss": 0,
                        ".text": 148
                    }
                },
                {
                    "module": "features/filesystem",
                    "size": {
                        ".data": 0,
                        ".bss": 807,
                        ".text": 15821
                    }
                },
                {
                    "module": "features/storage",
                    "size": {
                        ".data": 0,
                        ".bss": 184,
                        ".text": 42
                    }
                },
                {
                    "module": "hal",
                    "size": {
                        ".data": 0,
                        ".bss": 8,
                        ".text": 418
                    }
                },
                {
                    "module": "platform",
                    "size": {
                        ".data": 20,
                        ".bss": 614,
                        ".text": 2787
                    }
                },
                {
                    "module": "rtos",
                    "size": {
                        ".data": 4,
                        ".bss": 4,
                        ".text": 135
                    }
                },
                {
                    "module": "rtos/rtx",
                    "size": {
                        ".data": 20,
                        ".bss": 6870,
                        ".text": 5869
                    }
                },
                {
                    "module": "targets/TARGET_Freescale",
                    "size": {
                        ".data": 12,
                        ".bss": 384,
                        ".text": 8382
                    }
                },
                {
                    "summary": {
                        "total_flash": 91931,
                        "static_ram": 14628,
                        "stack": 0,
                        "heap": 24576,
                        "total_ram": 39204
                    }
                }
            ]
        }
    ]
}

jupe · 2017-04-04T21:16:58Z

for me this is good now. 👍

bridadan

Looks good, brought up one point but it's definitely bikeshedding, so don't spend too much time arguing with me 😄

bridadan · 2017-04-04T22:19:58Z

tools/make.py

@@ -173,6 +186,11 @@
                      default=False,
                      help="Link with mbed test library")

+    parser.add_argument("--metadata",


I realize this is bikeshedding, so feel free to shut this down immediately. Is metadata really a descriptive enough name? Perhaps this could be --build-data or --json-report? --metadata almost sounds like it could affect the build, which may be confusing with --app-config.

yesh metadata might not be the best name for this. I was also thinking do we need this parameter at all - could we generate it just always - just like we do with test_spec..?

how long does it take to generate this? costs nothing? The build could contain this. Or do we consider this to be part of logging (=verbose) ?

probably just some milliseconds, perhaps ten - I think - this seems to just pick pre-defined properties all over the place and put them all to one place - json file.

Metadata is probably not descriptive enough.

bridadan · 2017-04-04T22:21:48Z

Also, relevant:

0xc0170

+1 for generating this json file with relevant data. However thinking as my comment above how to treat this. do we need special option for it? can't be by default ?

jupe

I think we doesn't need any cli option for this - it's kind of final report for whole build process which contains all details how build was done. Useful for bug reporting as well in future ;)

jupe · 2017-04-05T12:06:26Z

tools/build_api.py

@@ -548,6 +550,9 @@ def build_project(src_paths, build_path, target, toolchain_name,
            cur_result["output"] = toolchain.get_output() + memap_table
            cur_result["result"] = "OK"
            cur_result["memory_usage"] = toolchain.map_outputs
+            cur_result["bin"] = res
+            cur_result["elf"] = splitext(res)[0] + ".elf"


does this exists every time ?

after #3994 is merged, yes.

jupe · 2017-04-05T12:09:12Z

tools/make.py

@@ -173,6 +186,11 @@
                      default=False,
                      help="Link with mbed test library")

+    parser.add_argument("--metadata",


probably just some milliseconds, perhaps ten - I think - this seems to just pick pre-defined properties all over the place and put them all to one place - json file.

jupe · 2017-04-05T12:11:35Z

CC: @sg- This would help e.g. to collect static memory information from any kind of test binaries we have.

bridadan · 2017-04-05T14:33:49Z

FYI, we already generate a JSON file in the build directory upon every build. This contains the memap data. Are we looking to replace this, or have this sit next to it? Might make the build dir pretty cluttered, maybe in another release we can look at consolidating a bit.

0xc0170 · 2017-04-05T16:40:13Z

Might make the build dir pretty cluttered, maybe in another release we can look at consolidating a bit.

Lets do it now !

theotherjimmy · 2017-04-05T16:48:58Z

@bridadan The purpose of adding the flag was to give the user the option of placing it outside the build directory. The expected use case puts it in the root of the project.

sg- · 2017-04-05T18:49:41Z

@bridadan The purpose of adding the flag was to give the user the option of placing it outside the build directory. The expected use case puts it in the root of the project.

I think keeping in the build directory by default is best and should be consolidated with what memmap creates so we don't just create duplicates of everything. Also, mind looking at why user libraries and main doesn't seem to be itemized in the memory dump?

jupe · 2017-04-05T18:50:19Z

adding the flag was to give the user the option of placing it outside the build directory.

Is those relative paths working then.. ?

already generate a JSON file in the build directory upon every build.

yes there is some - but to get that using external script we have to dig folders deeply to find it - this simplify also that step - user can rely that file is available every time in exactly same place with all details - including individual build details when we build all unit tests.

theotherjimmy · 2017-04-05T18:51:42Z

Is those relative paths working then.. ?

The paths are always relative from the root of the project. I can change that behavior in a bit.

jupe · 2017-04-05T18:54:47Z

The paths are always relative from the root of the project. I can change that behavior in a bit.

ok good. What you are changing ?

theotherjimmy · 2017-04-05T18:55:35Z

ok good. What you are changing ?

Make all paths relative to the location of the file.

bridadan · 2017-04-05T20:19:14Z

yes there is some - but to get that using external script we have to dig folders deeply to find it - this simplify also that step - user can rely that file is available every time in exactly same place with all details - including individual build details when we build all unit tests.

This becomes difficult when you are building for multiple targets or toolchains. As soon as you switch your target/toolchain you'll overwrite the already created json file. At least this way there is a unique and consistent place to dump build data.

Also, people don't like us cluttering up the root directory 😄 ARMmbed/mbed-cli#467

theotherjimmy · 2017-04-05T21:34:58Z

. As soon as you switch your target/toolchain you'll overwrite the already created json file.

Nope. you append.

theotherjimmy · 2017-04-05T21:35:23Z

Also, people don't like us cluttering up the root directory 😄 ARMmbed/mbed-cli#467

That's why I had the switch.

bridadan · 2017-04-05T21:36:34Z

Oops, I goofed :) You're right @theotherjimmy, thanks!

theotherjimmy · 2017-04-05T21:41:45Z

After offline bikeshedding, I'm deciding that the switch will be --build-data.

jupe · 2017-04-05T21:52:50Z

would be needed also when building tests :)

bridadan · 2017-04-05T22:08:10Z

would be needed also when building tests :)

In that case would there just a be a big json file in the root dir with all the builds in an array?

jupe · 2017-04-06T14:05:34Z

In that case would there just a be a big json file in the root dir with all the builds in an array?

yes big json file with builds array - main user will be tools which eat that file so no reason to split it to multiple places - it just make tool more complicated. But target folder is user configurable (--build-data <path>)

mbed-bot · 2017-04-18T17:44:59Z

Result: SUCCESS

Your command has finished executing! Here's what you wrote!

/morph test

Output

mbed Build Number: 24

All builds and test passed!

bridadan · 2017-04-18T18:36:01Z

Marking as needs: review for final sign-off from @0xc0170 and @jupe

jupe · 2017-04-19T07:13:30Z

could we integrate this whole thing inside elf file to own section ?

theotherjimmy · 2017-04-19T19:30:47Z

@jupe I don't know how we could do that.

jupe · 2017-04-21T04:22:41Z

something like:

objcopy –add-section build_data=build_data.json --set-section-flags .build_data=noload,readonly build.elf

theotherjimmy · 2017-04-21T14:32:22Z

Thanks @jupe. Could we do that in another PR? I would like to get this one in ASAP since it's ready.

jupe · 2017-04-21T15:08:37Z

sure

0xc0170 · 2017-04-24T09:38:30Z

/morph test

0xc0170 · 2017-04-24T09:40:20Z

@bridadan Can you run mbed 2 tests for this one?

mbed-bot · 2017-04-24T20:08:38Z

Result: SUCCESS

Your command has finished executing! Here's what you wrote!

/morph test

Output

mbed Build Number: 76

All builds and test passed!

adbridge · 2017-05-05T10:21:56Z

It looks like this PR is dependent upon changes added in #3994 , which is targeted for 5.5.0 . Thus re-targeting this one to 5.5.0 also.

adbridge · 2017-05-05T10:23:15Z

@theotherjimmy please be aware that if you have any further changes coming in this area to check for dependencies on this PR or #3994 as they would also need to go to 5.5.0

theotherjimmy force-pushed the build-metadata branch 2 times, most recently from 9b1aa84 to 4c9e6dc Compare April 4, 2017 16:58

theotherjimmy force-pushed the build-metadata branch from 4c9e6dc to 0994111 Compare April 4, 2017 20:08

jupe mentioned this pull request Apr 4, 2017

feature req: build_data file from builds ARMmbed/mbed-cli#264

Closed

3 tasks

bridadan approved these changes Apr 4, 2017

View reviewed changes

0xc0170 reviewed Apr 5, 2017

View reviewed changes

0xc0170 added the needs: review label Apr 5, 2017

jupe reviewed Apr 5, 2017

View reviewed changes

bridadan added needs: review and removed needs: CI labels Apr 18, 2017

jupe approved these changes Apr 19, 2017

View reviewed changes

theotherjimmy added 7 commits April 20, 2017 11:03

Expand build reports in the tools

da9c10b

Add an option to make.py to dump build metadata

035ddfb

Rename switch to --build-data

aeb6109

Add --build-data flag to mbed test

8082799

Add type to build_data.json

6ef384b

Change date key to UTC ISO 8601 format

05dce12

Add UUID to all builds

c4c6e13

theotherjimmy force-pushed the build-metadata branch from 7464ddb to c4c6e13 Compare April 20, 2017 16:03

0xc0170 added ready for merge and removed needs: review labels Apr 25, 2017

theotherjimmy merged commit 7e03d8f into ARMmbed:master May 2, 2017

theotherjimmy added release-version: 5.4.5 and removed ready for merge labels May 2, 2017

adbridge added release-version: 5.5.0-rc1 and removed release-version: 5.4.5 labels May 5, 2017

Add --build-data switch to mbed compile and test #4110

Add --build-data switch to mbed compile and test #4110

Uh oh!

Conversation

theotherjimmy commented Apr 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jupe commented Apr 4, 2017

Uh oh!

theotherjimmy commented Apr 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theotherjimmy commented Apr 4, 2017

Uh oh!

jupe commented Apr 4, 2017

Uh oh!

bridadan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bridadan commented Apr 4, 2017

Uh oh!

0xc0170 left a comment

Choose a reason for hiding this comment

Uh oh!

jupe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jupe commented Apr 5, 2017

Uh oh!

bridadan commented Apr 5, 2017

Uh oh!

0xc0170 commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

sg- commented Apr 5, 2017

Uh oh!

jupe commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

jupe commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

bridadan commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

bridadan commented Apr 5, 2017

Uh oh!

theotherjimmy commented Apr 5, 2017

Uh oh!

jupe commented Apr 5, 2017

Uh oh!

bridadan commented Apr 5, 2017

Uh oh!

jupe commented Apr 6, 2017

Uh oh!

mbed-bot commented Apr 18, 2017

Output

Uh oh!

theotherjimmy commented Apr 4, 2017 •

edited

Loading

theotherjimmy commented Apr 4, 2017 •

edited

Loading