Sai platform tuples

Platform names in sai capture the OS, arch and toolchain details in a string in a way that allows more or less specificity for matching.

The general format is "os/arch[/toolchain]", eg, "linux-fedora/x86_64/gcc". The elements may contain increasingly specific details by -, eg, "linux-fedora-32/x86_64-amd", or "freertos-espidf/xl6-esp32"

Builders should describe their platform in full detail, applications that want to use the platforms to perform tests should only provide the detail level they care about.

Instead of direct string matching between what the builders offer and the project wants to be built on, the builders are matched from the left for both the platform and architecture individually. So, a project wanting "linux-fedora/x86_64" will successfully match on a builder offering "linux-fedora-32/x86_64-amd". But a project requesting "linux-fedora-31/x86_64" will not match it.

NOTE: dots may not be used in platform tuple strings

OS part

The OS class name should be first and is mandatory, eg, "linux" or "freertos". The OS name is next, eg, "linux-fedora" or "freertos-espidf".

Builders should go on to give more details, eg, versioning if that is relevant for the platform, eg, "fedora-32".

Projects using .sai.json to specify tests may choose how much specificity to provide, eg, just "linux-fedora" to run on whatever fedora version the builders provide.

Well-known OS strings

Architecture part

Similarly builders should specify at least both the arch and the vendor name of the architecture, eg, "x86_64-amd", or "x86_64-intel". Projects that don't care can just specify "x86_64", ones that do care can control what it can build on more specifically, eg, "x86_64-amd".

Well-known architecture strings

Toolchain part

On many platforms there is a choice of toolchain between, eg, gcc and llvm now, and sometimes others like Intel compiler, mingw, etc. For that reason it has to be treated as another "dimension" in the platform tuple.

Well-known toolchain strings

-cross may be appended indicating it's a cross-build rather than targeted at the same host.

Examples

Sai builder conf host names

The "host": member of the builder configuration also has structure. It indicates build host platform details and the location and virtualization situation of the sai-builder instance using that conf.

Its format is "<plat>[,<plat>]"; the platform specification follows the platform description above, except the toolchain part is optionally replaced by the hostname.

Eg, "linux-fedora-32/riscv-qemu,linux-fedora/x86_64-amd/noi".

Indicating virtualization

The host part of the string can indicate its virtualization by adding a well-known suffix to the arch part, ie, indicating that the "implementor" of the arch "device" is qemu.

Eg, "windows-10/x86_64-amd-qemu, linux-fedora/x86_64-amd/noi"