Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Mon, 03 Aug 2020 18:24:12 GMT

Thanks for your help, Amanda. You can close this ticket.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Tue, 28 Jul 2020 08:25:52 GMT

Hi Mike,

Sorry for the delay. The support staff is reduced during the summer holidays, and you may experience delayed answers.

I agree with you all, and thanks for the nice sharing detail.

You can put the .conf file like app_ZRelease.conf anywhere in the project only if the CONF_FILE variable could be set in the CMakeLists.txt, and any modification of setting in .conf, .proj, .yaml, .overlay, etc., need to reopen the SES to source them again.

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Tue, 21 Jul 2020 21:31:55 GMT

Hi Amanda,

From my experiments, I’ve determined that

It does matter where we place the CONF_FILE assignment in CMakeLists.txt.
It does not matter where we actually put the .conf file within the project.

In other words: The .conf file like app_ZRelease.conf can be placed anywhere in the project, so the CONF_FILE value itself doesn’t matter. But it does matter where in CMakeLists.txt that the CONF_FILE assignment is placed.

With the first bullet being met, I was able to control the compile optimizations specified in the .conf file.

Per the first bullet: In CMakeLists.txt, the CONF_FILE setting must be before the find_package for Zephyr, as in:

#
# Copyright (c) 2018 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-BSD-5-Clause-Nordic
#

cmake_minimum_required(VERSION 3.8.2)

# changes to specify CONF_FILE
if (CMAKE_BUILD_TYPE)
  set(CONF_FILE "arbitrary/app_${CMAKE_BUILD_TYPE}.conf")
endif()
message(STATUS "NOTE: CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
message(STATUS "NOTE: CONF_FILE: ${CONF_FILE}")
# end CONF_FILE changes

find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
project(central_uart)

Note in the above that the actual location of the .conf file is in an arbitrary place (per the second bullet), under a directory called “arbitrary”, which is under the project directory central_uart. I could have just as well put the .conf file in the central_uart top-level directory, as in:

set(CONF_FILE "app_${CMAKE_BUILD_TYPE}.conf")

Do you agree?

The advantage of using CMAKE_CURRENT_SOURCE_DIR when specifying the value of CONF_FILE in CMakeLists.txt is that you can later use an assert_exists() to make sure that the .conf file pointed to by CONF_FILE exists. I was not able to get the assert_exists() to work properly without using CMAKE_CURRENT_SOURCE_DIR to set the path in the CONF_FILE value.

Here's an example using CMAKE_CURRENT_SOURCE_DIR in CONF_FILE, and then using the assert_exists(), which is at the end of the snippet:

if (CMAKE_BUILD_TYPE)
  set(CONF_FILE "${CMAKE_CURRENT_SOURCE_DIR}/app_${CMAKE_BUILD_TYPE}.conf")
endif()
message(STATUS "NOTE: CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
message(STATUS "NOTE: CONF_FILE: ${CONF_FILE}")

find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
project(central_uart)
assert_exists(CONF_FILE)

Also, as a reminder, mainly for my benefit: Whenever you change the CONF_FILE value in CMakeLists.txt, you must re-open the solution in SES with the Clean Build Directory checked for that change to take affect. If you don’t change the CONF_FILE value in CMakeLists.txt but change a value within the .conf file (e.g., change the value of CONFIG_SPEED_OPTIMIZATIONS in app_ZRelease.conf), you must re-open the solution in SES, but you don’t need to have the Clean Build Directory checked.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Fri, 17 Jul 2020 09:01:12 GMT

Hi Mike,

[quote user="variant"]Is the issue where the location that we put the conf file?[/quote]

It might be. I use your code in the CMakeLists.txt and modify the location as:

if (CMAKE_BUILD_TYPE) 
   #set(CONF_FILE "${CMAKE_CURRENT_SOURCE_DIR}/app_${CMAKE_BUILD_TYPE}.conf")
   set(CONF_FILE "configuration/${BOARD}/app_${CMAKE_BUILD_TYPE}.conf")
   message(STATUS "NOTE: CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
   message(STATUS "NOTE: CONF_FILE: ${CONF_FILE}")
endif()

It works as expected. Try this devzone.nordicsemi.com/.../central_5F00_uart_5F00_build_5F00_type_5F00_0717.zip

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Thu, 16 Jul 2020 14:31:11 GMT

In my comment way above (it says 21 days ago right now), I wrote:

In CMakeLists.txt, I added this in the Nordic SDK App section:

if (CMAKE_BUILD_TYPE) 
   set(CONF_FILE "${CMAKE_CURRENT_SOURCE_DIR}/app_${CMAKE_BUILD_TYPE}.conf")
endif()
message(STATUS "NOTE: CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
message(STATUS "NOTE: CONF_FILE: ${CONF_FILE}")

Then I showed in that old comment that my status messages inserted above showed up in the output:

-- NOTE: CMAKE_BUILD_TYPE: ZDebug
-- NOTE: CONF_FILE: C:/ncs/v1.3.0/nrf/samples/bluetooth/central_uart/app_ZDebug.conf

So I'm not sure what you are doing differently than what I already did. My output above shows that CMAKE found the CONF_FILE.

Is the issue where the location that we put the conf file?

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Thu, 16 Jul 2020 10:29:55 GMT

Hi Mike,

It seems that the config files are not used. You can modify like this:

# Define configuration files.
set(CONF_FILE "configuration/${BOARD}/app_${CMAKE_BUILD_TYPE}.conf")

#########################################
find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
project(central_uart)

# NORDIC SDK APP START
target_sources(app PRIVATE
  src/main.c
)
# NORDIC SDK APP END

zephyr_library_include_directories(${CMAKE_CURRENT_SOURCE_DIR})

I also modify central_uart as this project devzone.nordicsemi.com/.../central_5F00_uart_5F00_build_5F00_type.zip to use build type, and it can work as expected in west build and Segger.

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Wed, 15 Jul 2020 15:45:55 GMT

Thanks for the reply and the update, Amanda!

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Wed, 15 Jul 2020 06:11:18 GMT

Hi Mike,

I can reproduce the issue as you. I will report to the internal.

Please note that we are moving into the summer vacation period here in Norway, so it might take a bit longer to get to the bottom of this than expected, as staff during the month of July will be reduced. I'm sorry about the inconvenience, but please be patient. And I'll get back to you as soon as I hear something from the devs.

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Fri, 10 Jul 2020 15:54:32 GMT

Hi Amanda,

When I use west to build the project, with "CONFIG_SPEED_OPTIMIZATIONS=y" added into the proj.conf, I get the same desired result as you did: 176 files compiled with the -O2 option.

So the question remains, what is the missing step or mistake I am making to achieve the same result using the SES "Integrated" Development Environment? In four replies above, I tried my best to list all the steps that I performed for the SES build.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Fri, 10 Jul 2020 07:14:41 GMT

Hi Mike,

[quote user="variant"]Did you use a command line to build yours instead of using SES (which this ticket is about)?[/quote]

I used west build to build the project as

## before run the west build, please set the environment variable
setx -m GNUARMEMB_TOOLCHAIN_PATH C:\ncs\v1.3.0\toolchain\opt
echo %GNUARMEMB_TOOLCHAIN_PATH% & echo %ZEPHYR_TOOLCHAIN_VARIANT%
set ZEPHYR_BASE=C:\ncs\v1.3.0\zephyr
echo %ZEPHYR_BASE%

v1.3.0\nrf\samples\bluetooth\central_uart>west -v build -b nrf52840dk_nrf52840

Please try that and let me know the result.

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Fri, 10 Jul 2020 02:08:30 GMT

Thank you for the update about delayed replies. I understand. And thank you very much for trying the build yourself.

You got 176 files compiled with -O2. That is what I expect. I'm glad you attached a build log. I should have, so I'm attaching mine now (my logs has 176 files compiled with -Os, of which 28 of them have a -O2 following the -Os):

devzone.nordicsemi.com/.../build_5F00_central_5F00_uart_5F00_zrelease_5F00_opt_5F00_for_5F00_speedYes_5F00_176_5F00_Os_5F00_28_5F00_O2.txt

My build output is from the SES "Output" window after I use the SES menu Build / Build zephyr/zephyr.elf (after following the pre-build steps that I outlined in my previous reply, using CONFIG_SPEED_OPTIMIZATIONS=y).

My build output format is very different from yours. Did you use a command line to build yours instead of using SES (which this ticket is about)?

Your build lines begin with "cmd.exe" and "C:\gnuarmemb\bin\arm-none-eabi-gcc.exe".

My build lines begin with "Building" and "Compiling", which I think are from SES. And my compiler commands are invoked as c:/ncs/v1.3.0/toolchain/opt/bin/arm-none-eabi-gcc, which shows that I am indeed using the NCS environment.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Tue, 07 Jul 2020 09:42:59 GMT

Updated.

Hi Mike,

Sorry for the delay. I add CONFIG_SPEED_OPTIMIZATIONS=y into the porj.conf as

####
CONFIG_SPEED_OPTIMIZATIONS=y
###

And I got 176 files compiled with -O2 as devzone.nordicsemi.com/.../251642.log.

Is that as you expect?

The support staff is reduced during the summer holidays, and you may experience delayed answers.

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Fri, 26 Jun 2020 00:48:09 GMT

Hi Amanda,

Thank you for the responses. I’m still having trouble with item 1.

I can effect a compiler optimization change in the nrf_desktop app, but not in a sample project such as nrf\samples\bluetooth\central_uart.

The nrf_desktop\configuration\nrf52840dk_nrf52840\app_ZDebug.conf has

CONFIG_SPEED_OPTIMIZATIONS=y

In fact, all 50 .conf files in that project, be it ZDebug or ZRelease variants, have the CONFIG_SPEED_OPTIMIZATIONS=y.

That default config results in all 207 compile commands in the build output to have the “-O2” option, which makes sense.

If I change that CONFIG line in nrf_desktop’s nrf52840dk_nrf52840\app_ZDebug.conf to this:

CONFIG_SIZE_OPTIMIZATIONS=y

Then I see all 207 compile commands have the “-Os” option instead of the “-O2” option, which also makes sense. So far so good.

Now, whatever I do for the central_uart project, I can’t get the compiler optimization to change in the build output.

First, the default prj.conf file for central_uart (with no changes on my part) results in:

176 compiles, of which all 176 compiles have the “-Os” option.
Also, 28 of the 176 files additionally have a “-O2” (the later -O2 overrules the earlier -Os in the compile command) for the 28 files in the bluetooth_controller library.

So that’s the default baseline: -Os, with some additional -O2 just for one library. Now, here's my attempt to make a change in the compiler optimization.

In CMakeLists.txt, I added this in the Nordic SDK App section:

if (CMAKE_BUILD_TYPE) 
   set(CONF_FILE "${CMAKE_CURRENT_SOURCE_DIR}/app_${CMAKE_BUILD_TYPE}.conf")
endif()
message(STATUS "NOTE: CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
message(STATUS "NOTE: CONF_FILE: ${CONF_FILE}")

In SES/Tools/Options/nRF Connect/Additional CMake Options, I added this: '

-DCMAKE_BUILD_TYPE=ZDebug

I copied prj.conf to app_ZDebug.conf.

In app_ZDebug.conf, I added the line shown below. (I also tried this in app_ZRelease.conf when selecting ZRelease instead of ZDebug.)

CONFIG_NCS_SAMPLES_DEFAULTS=y
# My addition
CONFIG_SPEED_OPTIMIZATIONS=y
#end my addition.

I also tried this:

CONFIG_NCS_SAMPLES_DEFAULTS=y
# My additions
CONFIG_SIZE_OPTIMIZATIONS=n
CONFIG_SPEED_OPTIMIZATIONS=y
#end my additions.

When I open the nRF SDK project in SES (with the Clean Build Directory option selected), I see this (i.e., I see my NOTE prints that I added in CMakeLists.txt):

-- Cache files will be written to: C:/ncs/v1.3.0/zephyr/.cache
CMake Warning at C:/ncs/v1.3.0/zephyr/CMakeLists.txt:1384 (message):
  __ASSERT() statements are globally ENABLED

-- NOTE: CMAKE_BUILD_TYPE: ZDebug
-- NOTE: CONF_FILE: C:/ncs/v1.3.0/nrf/samples/bluetooth/central_uart/app_ZDebug.conf

No matter what I do in the conf file, I get the same compiler optimization flag in the build output as does the default config (128 -Os, with 28 -O2). I should be getting 128 files compiled with -O2.

I also tried the same type of above CONFIG_* changes in prj.conf when I remove the CMAKE_BUILD_TYPE selection so that the plain old prj.conf is used. Same thing. I can’t effect a change in the build output compiler optimization flags in central_uart.

Can you try using SES as the build tool with the central_uart app and see if you can get the build output to show a change in the compiler optimization flag from the default output, such as trying to get all compile commands to show -O2 instead of all -Os?

Thanks!

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Thu, 25 Jun 2020 07:58:07 GMT

Hi Mike,

[quote user="variant"]would there be any hidden problem if I go unconventional (not that I would) and use names app_debug.conf and app_release.conf instead of app_ZDebug.conf and app_ZRelease.conf, as long as I account for those names in the CMakeLists.txt?[/quote]

From the engineer:

The CMAKE_BUILD_TYPE is actually a special variable in cmake. Zephyr does not handle it, so if you use one of the values from the documentation cmake will take over and add some changes to variables used during the building process (for example cflags). You don't want this to happen as it may contradict definitions from kconfig.

I didn't want to introduce yet another variable so I reused cmake_build_type with "Z" prefix to build chose configuration. Since these are unknown to cmake it won't add anything specific by itself.

(At the moment I tend to think that it might have been better to introduce the new variable to have more flexibility and avoid confusion.)

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

variant — Tue, 23 Jun 2020 02:38:25 GMT

Thanks Amanda.

1. I understand your reply, and it makes perfect sense. I'm trying this out on the central_uart sample, but I'm not seeing any affect yet in the build output. I'll double check my steps tomorrow and provide more details if I am still unsuccessful.

As an aside, I think it would helpful in the section maintaining-cmakelist-txt-in-ses, where it says "In the window that is displayed, you can define compilation options for the project", that someone adds a note there that you can set the compiler optimization levels (which to me are still compilation options) in the conf file, as you explained. That is, that "window" they are talking about there is not the only place you can define compilation options. You can also do so in the conf files. Just a suggestion.

2. You pointed to the same place that I pointed to. I was just making a suggestion that that section could possibly be more helpful with the information I suggested to add.

3. Thanks. By the way, my discovery here was for the central_uart sample.

4. I see. So it seems that the Z (for Zephyr) is just a convention, as in ZDebug/ZRelease. So in my own projects, would there be any hidden problem if I go unconventional (not that I would) and use names app_debug.conf and app_release.conf instead of app_ZDebug.conf and app_ZRelease.conf, as long as I account for those names in the CMakeLists.txt?

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Mon, 22 Jun 2020 13:09:36 GMT

Hi Mike,

[quote user=""]For example, if we want the ZDebug build to include compiler options like "-g -O0 -DDEBUG" but the ZRelease build to instead include compiler options like "-O3 -DNDEBUG", how do we do this?[/quote]

You can edit prj.conf and add "NO_OPTIMIZATIONS=Y" to set compiler optimizations as -O0 or "DEBUG_OPTIMIZATIONS=Y" to set the compiler optimizations as -Og. Please see <choice: Optimization level>.

[quote user=""]I was hoping to see at least some optimization differences, or at least a "-DDEBUG" difference, between the two build outputs to help me figure out the answer to this question.[/quote]

If you want to see the difference between compile optimization, you should see <choice: Optimization level>.

[quote user=""]2. In my opinion, the section selecting-a-build-type-in-ses or the previous section should indicate that the SES menus "Build/Build Configuration" and "Build/Set Active Build Configuration" are not applicable with this SDK. I originally was looking for ZDebug and ZRelease options to show up in those menus after following the instructions in the previous section.[/quote]

See the Selecting a build type in SES section on how to build the project with the app_ZDebug .conf and app_ZRelease.conf.

[quote user=""]3. In the instruction on how to set the CONF_FILE variable for the build configs (see step 2 in Creating build type files), doesn't the path "${CMAKE_CURRENT_SOURCE_DIR}" need to be in the CONF_FILE setting, as in:[/quote]

I will report it.

[quote user=""]4. Is there something special with the names ZDebug and ZRelease vs traditional build config names Debug and Release?[/quote]

The nRF Desktop does not use a single prj.conf file. Configuration files are provided for different build types for each supported board as here as the Creating build type files section described. If you take a look at configuration/nrf52840gmouse_nrf52840, you could see the files named with ZRelease and ZDebug as nRF Desktop build types describe:

ZRelease – Release version of the application with no debugging features.

ZDebug – Debug version of the application; the same as the ZRelease build type, but with debug options enabled.

Comparing the app_ZDebug.conf and app_ZRelease.conf, you could see what debug options are enabled.

[quote user=""]is there any additional meaning here for nRF usage in the SDK not described in that link?[/quote]

Please see build types are available for various boards in nRF Desktop in the nRF Desktop build types.

[quote user=""]5. Is building with the command line, and perhaps just using SES for a debugger tool, the easier way to go with this SDK?[/quote]

SES also can build the project. It depends on your habit.

-Amanda H.

RE: Differentiating compiler options between ZDebug and ZRelease build configs with NCS/SES

Amanda Hsieh — Fri, 19 Jun 2020 13:22:32 GMT

Hi Mike,

I am working on your case and will reply next week.

-Amanda H.