How to find a custom toolchain that may have a prefix or suffix?

[davidchisnall]

Some people who package our toolchain want to put it in the same directory as their normal tools and add a -cheriot suffix to all of the tools (LLVM's build system has a thing to add a suffix for a modified build of LLVM). Unfortunately, our current custom toolchain logic (which is basically the same as the documentation), then finds clang, not clang-cheriot.

If I do:

set_toolset("cc", "clang-cheriot", "clang")

Then it seems to find the tool, but then errors saying:

error: cannot find known tool script for /usr/local/bin/clang-cheriot

Is there a way of saying 'clang might be called clang-{something} or {something}-clang, but it's still clang'?

[waruqi]

set_toolset("cc", "clang@clang-cheriot", "clang")

[davidchisnall]

Full output from xmake -vD -j1 (without -j1 the errors are interleaved):

Board file saved as  build/cheriot/cheriot/release/test-suite.board.json
Remapping priority of thread 1 from 3 to 2
Remapping priority of thread 2 from 2 to 1
Remapping priority of thread 3 from 1 to 0
checkinfo: cannot runv(clang++-cheriot --version), No such file or directory
checking for clang++-cheriot ... no
checking for the c++ compiler (cxx) ... clang++-cheriot
checkinfo: cannot runv(clang++-cheriot --version), No such file or directory
checking for clang++-cheriot ... no
[ 23%]: cache compiling.release thread_pool-test.cc
clang++-cheriot -c -std=c++20 -Qunused-arguments -target riscv32cheriot-unknown-unknown -mcpu=cheriot -mabi=cheriot -mxcheri-rvc -mrelax -fshort-wchar -nostdinc -Oz -g -ffunction-sections -fdata-sections -fomit-frame-pointer -fno-builtin-setjmp -fno-builtin-longjmp -fno-builtin-printf -fno-exceptions -fno-asynchronous-unwind-tables -fno-c++-static-destructors -fno-rtti -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/include/c++-config -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/include/libc++ -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/include -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/boards/../include/platform/generic-riscv -DTEMPORAL_SAFETY -DSOFTWARE_REVOKER -DSAIL -DRISCV_HTIF -DCPU_TIMER_HZ=2000 -DTICK_RATE_HZ=10 -DSIMULATION -DCONFIG_MSHWM -DDEVICE_EXISTS_clint -DDEVICE_EXISTS_shadow -DDEVICE_EXISTS_uart -DREVOKABLE_MEMORY_START=0x80000000 "-DCHERIOT_INTERRUPT_NAMES=FakeInterrupt=4, " -cheri-compartment=thread_pool_test -o build/.objs/thread_pool_test/cheriot/cheriot/release/thread_pool-test.cc.o thread_pool-test.cc
error: @programdir/core/main.lua:329: @programdir/actions/build/main.lua:148: @programdir/modules/async/runjobs.lua:325: @programdir/modules/private/action/build/object.lua:91: @programdir/modules/core/tools/gcc.lua:966: cannot runv(clang++-cheriot -c -std=c++20 -Qunused-arguments -target riscv32cheriot-unknown-unknown -mcpu=cheriot -mabi=cheriot -mxcheri-rvc -mrelax -fshort-wchar -nostdinc -Oz -g -ffunction-sections -fdata-sections -fomit-frame-pointer -fno-builtin-setjmp -fno-builtin-longjmp -fno-builtin-printf -fno-exceptions -fno-asynchronous-unwind-tables -fno-c++-static-destructors -fno-rtti -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/include/c++-config -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/include/libc++ -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/include -I/Users/theraven/Documents/cheriot/cheriot-rtos/sdk/boards/../include/platform/generic-riscv -DTEMPORAL_SAFETY -DSOFTWARE_REVOKER -DSAIL -DRISCV_HTIF -DCPU_TIMER_HZ=2000 -DTICK_RATE_HZ=10 -DSIMULATION -DCONFIG_MSHWM -DDEVICE_EXISTS_clint -DDEVICE_EXISTS_shadow -DDEVICE_EXISTS_uart -DREVOKABLE_MEMORY_START=0x80000000 "-DCHERIOT_INTERRUPT_NAMES=FakeInterrupt=4, " -cheri-compartment=thread_pool_test -o build/.objs/thread_pool_test/cheriot/cheriot/release/thread_pool-test.cc.o thread_pool-test.cc), No such file or directory
stack traceback:
    [C]: in function 'error'
    [@programdir/core/base/os.lua:1004]:
    [@programdir/modules/core/tools/gcc.lua:966]: in function 'catch'
    [@programdir/core/sandbox/modules/try.lua:123]: in function 'try'
    [@programdir/modules/core/tools/gcc.lua:908]:
    [C]: in function 'xpcall'
    [@programdir/core/base/utils.lua:244]:
    [@programdir/core/tool/compiler.lua:288]: in function 'compile'
    [@programdir/modules/private/action/build/object.lua:91]: in function 'script'
    [@programdir/modules/private/action/build/object.lua:122]: in function 'build_object'
    [@programdir/modules/private/action/build/object.lua:147]: in function 'jobfunc'
    [@programdir/modules/async/runjobs.lua:241]:
    [C]: in function 'xpcall'
    [@programdir/core/base/utils.lua:244]: in function 'trycall'
    [@programdir/core/sandbox/modules/try.lua:117]: in function 'try'
    [@programdir/modules/async/runjobs.lua:224]: in function 'cotask'
    [@programdir/core/base/scheduler.lua:406]:

stack traceback:
	[C]: in function 'error'
	@programdir/core/base/os.lua:1004: in function 'base/os.raiselevel'
	(...tail calls...)
	@programdir/core/main.lua:329: in upvalue 'cotask'
	@programdir/core/base/scheduler.lua:406: in function <@programdir/core/base/scheduler.lua:399>

[davidchisnall]

This is the PR trying to enable it:

CHERIoT-Platform/cheriot-rtos#532

Our CI builds in this dev container, if you want to try reproducing it in a container:

https://github.com/orgs/CHERIoT-Platform/packages/container/package/devcontainer

The test build is in the tests directory, with the SDK directory in the dev container supplied as xmake config --sdk=/cheriot-tools.

[waruqi]

I have no time to try it.

Did you add clang++-cheriot to $PATH?

[davidchisnall]

No, the location of the compiler is specified with --sdk= (this was working without that PR). It is working if clang++-cheriot exists, but if clang++-cheriot does not exist then it is not finding clang, it is just trying to invoke a non-existent clang++-cheriot and failing. But the set_toolset line tells it to try clang++ if clang++-cheriot does not exist.

[waruqi]

try it again. use dev version