version: use generated version_def.h

[kernelchuk]

Using command line to define the OPENAMP_VERSION string macro breaks Cygwin build on some releases of Microsoft Windows and CMake. Remove all OPENAMP_VERSION macros from cmake compiler flags and use the ones from the generated version_def.h file.

[tnmysh]

looks good to me.

[arnopo]

Please Could you please provide more details on the issue ? I would like to understand the problem you are facing.

[edmooring]

This change looks reasonable, but I'd like to see more detail about that goes wrong with Cygwin in the commit message.

[kernelchuk]

The error

src/open-amp/lib/version.c: In function 'openamp_version':
        <command-line>: error: too many decimal points in number
C:src/open-amp/lib/version.c:24:16: note: in expansion of macro 'OPENAMP_VERSION'
24 |         return OPENAMP_VERSION;
   |                ^~~~~~~~~~~~~~~

happens during open-amp build in Vitis on MS-Windows under Cygwin. The top-level make is started via

make -C psu_cortexr5_0/libsrc/openamp_v1_8/src -s libs "SHELL=CMD"
  "COMPILER=armr5-none-eabi-gcc" "ASSEMBLER=armr5-none-eabi-as"  "ARCHIVER=armr5-none-eabi-ar"
  "COMPILER_FLAGS= -O2 -c -mcpu=cortex-r5" ...

where each compiler option is enclosed in double quotes. This collides with the quotes from

open-amp/cmake/options.cmake

Line 19 in 246540f

add_definitions( -DOPENAMP_VERSION="${PROJECT_VERSION}" )

One option is to try to get the quotes to work for both Linux and Windows build. The other is to follow the libmetal example of lib/config.h. The open-amp repo does not have config.h, but it generates version_def.h from VERSION. This way we avoid the build system shell dependencies and rely only on the CMake and the preprocessor.

[arnopo]

The error

src/open-amp/lib/version.c: In function 'openamp_version':
        <command-line>: error: too many decimal points in number
C:src/open-amp/lib/version.c:24:16: note: in expansion of macro 'OPENAMP_VERSION'
24 |         return OPENAMP_VERSION;
   |                ^~~~~~~~~~~~~~~

happens during open-amp build in Vitis on MS-Windows under Cygwin. The top-level make is started via

make -C psu_cortexr5_0/libsrc/openamp_v1_8/src -s libs "SHELL=CMD"
  "COMPILER=armr5-none-eabi-gcc" "ASSEMBLER=armr5-none-eabi-as"  "ARCHIVER=armr5-none-eabi-ar"
  "COMPILER_FLAGS= -O2 -c -mcpu=cortex-r5" ...

where each compiler option is enclosed in double quotes. This collides with the quotes from

open-amp/cmake/options.cmake

Line 19 in 246540f

add_definitions( -DOPENAMP_VERSION="${PROJECT_VERSION}" )

One option is to try to get the quotes to work for both Linux and Windows build. The other is to follow the libmetal example of lib/config.h. The open-amp repo does not have config.h, but it generates version_def.h from VERSION. This way we avoid the build system shell dependencies and rely only on the CMake and the preprocessor.

Thanks for the explanation, it's much clearer now.
Regarding some posts, seems that another way to fix this is to use
add_definitions( -DOPENAMP_VERSION="\\"${PROJECT_VERSION}\\"" )

That said, I can not find any reason to keep definitions in cmake, so your proposal seems to me ok

[arnopo]

@edmooring can you give a feedback on this one as it is a candidate for the release?
Thanks!

[edmooring]

Looks good to me.