cmake: add control over inline source code disassembly

[LaurentiuM1234]

By default, the generated disassembly file (i.e: the .lst file) also contains inline source code. This has the potential to become problematic when attempting to compare the generated .lst files accross platforms since they may differ for various reasons. As such, add the option to control whether the disassembly file should contain inline source code or not.

Relevant SOF issue: thesofproject/sof#9034

[marc-hb]

Awesome, thank you!

[marc-hb]

Relevant SOF issue: thesofproject/sof#9034

A bit more context in the commit message wouldn't hurt, maybe in the Kconfig help too.

At the least the keyword "reproducible build" would be great.

[LaurentiuM1234]

Relevant SOF issue: thesofproject/sof#9034

A bit more context in the commit message wouldn't hurt, maybe in the Kconfig help too.

At the least the keyword "reproducible build" would be great.

Updated. Not sure if explanation's good enough so lmk if it needs another update.

[andyross]

Makes sense.

(Good opportunity for a general whine that the .lst file is now off by default. I'm constantly having to turn it back on and rebuild, and it wastes a minute or so for me almost every week. If CI can't handle the overhead we should have CI turn it off. Obviously not related to this PR, but while people's eyes are on this area...)

[marc-hb]

Good opportunity for a general whine that the .lst file is now off by default.

I timed it and it was VERY slow, 7 seconds on my beefy build server! Also: not concurrent with anything else so frequently doubling the total build time! Not just for CI but for everybody. I think very few people look at zephyr.lst on a regular basis. More data in cc57633 / #61023 and thesofproject/sof@dd8b932

It will be interesting to measure it again without this -S. Linking source code to optimized code is really hard (and buggy as we just found) so maybe it was -S actually taking a lot of that time?

Assuming it can be very fast now without -S, having it on by default again but without -S would probably not be very useful to users like you either?

Default configuration is hard, really hard. You can never please all use cases. So the key is configuration flexibility and convenience with overlays etc. and I find Zephyr pretty good there.

I'm constantly having to turn it back on and rebuild, and it wastes a minute or so for me almost every week.

Can't you set this "permanently" in some personal overlay? Using west config build.cmake-args?

https://docs.zephyrproject.org/latest/develop/west/build-flash-debug.html#west-building-cmake-config

[jori-nordic]

Good opportunity for a general whine that the .lst file is now off by default

I think I was the one turning it off.
As @marc-hb says it's single-threaded and was more than doubling the build time.

It doesn't matter for CI I guess, but for local development it sucks having to wait for objdump when you don't actually need it. I was certainly wasting more than a minute per week. It was more like 10-15s per-build and with 20+ builds every day it adds up.

I think having a default overlay that you apply for local development makes sense.

[marc-hb]

It doesn't matter for CI I guess,

Zephyr CI builds hundreds of different configurations for each pull request, so CONFIG_OUTPUT_DISASSEMBLY does matter very much for it. Not just for time but for money too!

CONFIG_OUTPUT_DISASSEMBLY could be easily overriden in Zephyr CI if needed though (not needed since you disabled it by default)

[aescolar]

@marc-hb removing hotfix as this is not a critical Zephyr issue introduced by a regression (what hotfix should be used for).
@tejlmand can you please take a quick look?

[tejlmand]

code works, but would like to see the else() .. if() transformed into a cleaner elseif().

[tejlmand]

why the extra if() ?

Suggested change

	else()
	set(disassembly_type "$<TARGET_PROPERTY:bintools,disassembly_flag_inline_source>")
	if (CONFIG_OUTPUT_DISASSEMBLE_WITH_SOURCE)
	set(disassembly_type "$<TARGET_PROPERTY:bintools,disassembly_flag_inline_source>")
	endif()
	endif()
	elseif (CONFIG_OUTPUT_DISASSEMBLE_WITH_SOURCE)
	set(disassembly_type "$<TARGET_PROPERTY:bintools,disassembly_flag_inline_source>")
	endif()

[LaurentiuM1234]

V2 changes

1. Included @tejlmand and @aescolar's suggestions.