Repository navigation
[BUG] Incorrect cmake command while building fuzzer with build-tools.sh #2656
Description
Describe the bug
When using the build-tools script to build the fuzzer, in build step for sof_parser_ep, one of the cmake commands is not correct. Getting the following halfway in the output:
[ 42%] Performing build step for 'sof_parser_ep'
Usage
cmake [options] <path-to-source>
cmake [options] <path-to-existing-build>
Specify a source directory to (re-)generate a build system for it in the
current working directory. Specify an existing build directory to
re-generate its build system.
Run 'cmake --help' for more information.
[ 50%] Performing install step for 'sof_parser_ep'
Despite this, the script and build both are running successfully or so it seems, so this may or may not be a bug, but this certainly doesn't look right since one of the intermediate cmake commands is not getting executed. I tried tracing this, but seems like these files are generated from CMakeLists.txt file located in tools/fuzzer directory.
To Reproduce
./scripts/build-tools.sh -f
Reproduction Rate
1/1
Expected behavior
All cmake commands run successfully and not get help midway execution.
Impact
What impact does this issue have on your progress (e.g., annoyance, showstopper)
Environment
- Branch name and commit hash of the 2 repositories: sof (firmware/topology) and linux (kernel driver).
- SOF: master / de0d11c
Screenshots or console output
https://gist.github.com/crazoes/8542f5c90bad18644a66e63d331ef622#file-logs-L9820-L9829
Activity
lgirdwood commentedon Mar 29, 2020
@jajanusz any inputs ?
marc-hb commentedon Mar 30, 2020
Good catch, even more impressive catch without #2654 :-)
I had a very quick look at this.
Here's a more "focused" reproduction:
The
tools/fuzzer/CMakeLists.txt:ExternalProject_Add(sof_parser_ep,...)command looks suspicious.It's very scary that this failure doesn't stop the build, but maybe it's just because this library is not used anywhere now yet built anyway because of
BUILD_ALWAYS 1?[-][BUG](maybe) Incorrect cmake command while building fuzzer with build-tools.sh[/-][+][BUG] Incorrect cmake command while building fuzzer with build-tools.sh[/+]singalsu commentedon Aug 27, 2020
Yep, just confirm as assigned that this still happens. I'll see if I can fix this or need to get help.
singalsu commentedon Aug 27, 2020
Umm, deleting line for BUILD_COMMAND seems to avoid the error and everything seems to be working. How did I find this out? Looked other examples of ExternalProject_Add() in SOF... I'll do a PR.
marc-hb commentedon Aug 27, 2020
I spent more time testing this and I now understand why this
BUILD_COMMAND cmakemistake was not fatal. It's the tricky combination of two things:With
BUILD_COMMAND fubarthe build aborts immediately - but not withBUILD_COMMAND cmakeSo at this point
ExternalCommandwrongly believes/lib/libsof_tplg_parser.sowas built. Yet that library was not built, so how come the rest of the build is successful? Because the next,install step for sof_parser_epwhich is only meant to install "accidentally" builds+installs. Easy to spot in the build logs when looking specifically for it.singalsu commentedon Aug 28, 2020
Thanks for explanation @marc-hb ! Is there a way to debug cmake execution somehow? Tutorials? I've found it hard to understand, and out of the two nuisances even the m4 feels better to me.
marc-hb commentedon Aug 29, 2020
Yes and no. Both cmake and make are very difficult to debug. There are a few tricks.
BUILD_COMMAND fubarcmake -v,VERBOSE=1,make -dr, etc. etc.|& _.logmakeandninjabuild as little as possible to reduce the noise. Either 1. build very specific targets or 2. build everything thentouchonly one (relevant) file, don't clean and rebuild. Or both.printfas usualgrep -C 5CMake-generated codeTools: Fuzzer: Do not use illegal BUILD_COMMAND in CMakeLists.txt