Skip to content

Commit

Permalink
Update documentation to include QNX 8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
flba-eb committed Dec 10, 2024
1 parent 63691a8 commit 6e472e4
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 47 deletions.
2 changes: 2 additions & 0 deletions src/doc/rustc/src/platform-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ target | std | host | notes
[`aarch64-unknown-nto-qnx700`](platform-support/nto-qnx.md) | ? | | ARM64 QNX Neutrino 7.0 RTOS |
[`aarch64-unknown-nto-qnx710`](platform-support/nto-qnx.md) | ✓ | | ARM64 QNX Neutrino 7.1 RTOS with default network stack (io-pkt) |
[`aarch64-unknown-nto-qnx710_iosock`](platform-support/nto-qnx.md) | ✓ | | ARM64 QNX Neutrino 7.1 RTOS with new network stack (io-sock) |
[`aarch64-unknown-nto-qnx800`](platform-support/nto-qnx.md) | ✓ | | ARM64 QNX Neutrino 8.0 RTOS |
`aarch64-unknown-freebsd` | ✓ | ✓ | ARM64 FreeBSD
[`aarch64-unknown-hermit`](platform-support/hermit.md) | ✓ | | ARM64 Hermit
`aarch64-unknown-illumos` | ✓ | ✓ | ARM64 illumos
Expand Down Expand Up @@ -383,6 +384,7 @@ target | std | host | notes
[`x86_64-apple-watchos-sim`](platform-support/apple-watchos.md) | ✓ | | x86 64-bit Apple WatchOS simulator
[`x86_64-pc-nto-qnx710`](platform-support/nto-qnx.md) | ✓ | | x86 64-bit QNX Neutrino 7.1 RTOS with default network stack (io-pkt) |
[`x86_64-pc-nto-qnx710_iosock`](platform-support/nto-qnx.md) | ✓ | | x86 64-bit QNX Neutrino 7.1 RTOS with new network stack (io-sock) |
[`x86_64-pc-nto-qnx800`](platform-support/nto-qnx.md) | ✓ | | x86 64-bit QNX Neutrino 8.0 RTOS |
[`x86_64-unikraft-linux-musl`](platform-support/unikraft-linux-musl.md) | ✓ | | 64-bit Unikraft with musl 1.2.3
`x86_64-unknown-dragonfly` | ✓ | ✓ | 64-bit DragonFlyBSD
`x86_64-unknown-haiku` | ✓ | ✓ | 64-bit Haiku
Expand Down
100 changes: 53 additions & 47 deletions src/doc/rustc/src/platform-support/nto-qnx.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Currently, the following QNX Neutrino versions and compilation targets are suppo

| QNX Neutrino Version | Target Architecture | Full support | `no_std` support |
|----------------------|---------------------|:------------:|:----------------:|
| 8.0 | AArch64 | ? ||
| 8.0 | x86 | ? ||
| 7.1 with io-pkt | AArch64 |||
| 7.1 with io-sock | AArch64 | ? ||
| 7.1 with io-pkt | x86_64 |||
Expand All @@ -31,6 +33,8 @@ Currently, the following QNX Neutrino versions and compilation targets are suppo

On QNX 7.0 and 7.1, `io-pkt` is used as network stack by default. QNX 7.1 includes
the optional network stack `io-sock`.
QNX 8.0 always uses `io-sock`. QNX 8.0 support is currently in development
and not tested.

Adding other architectures that are supported by QNX Neutrino is possible.

Expand Down Expand Up @@ -121,53 +125,55 @@ For conditional compilation, following QNX Neutrino specific attributes are defi

1. Create a `config.toml`

Example content:

```toml
profile = "compiler"
change-id = 115898
```

2. Compile the Rust toolchain for an `x86_64-unknown-linux-gnu` host (for both `aarch64` and `x86_64` targets)

Compiling the Rust toolchain requires the same environment variables used for compiling C binaries.
Refer to the [QNX developer manual](https://www.qnx.com/developers/docs/7.1/#com.qnx.doc.neutrino.prog/topic/devel_OS_version.html).

To compile for QNX Neutrino (aarch64 and x86_64) and Linux (x86_64):

```bash
export build_env='
CC_i586_pc_nto_qnx700=qcc
CFLAGS_i586_pc_nto_qnx700=-Vgcc_ntox86_cxx
CXX_i586_pc_nto_qnx700=qcc
AR_i586_pc_nto_qnx700=ntox86-ar
CC_aarch64_unknown_nto_qnx710=qcc
CFLAGS_aarch64_unknown_nto_qnx710=-Vgcc_ntoaarch64le_cxx
CXX_aarch64_unknown_nto_qnx710=qcc
AR_aarch64_unknown_nto_qnx710=ntoaarch64-ar
CC_aarch64_unknown_nto_qnx710_iosock=qcc
CFLAGS_aarch64_unknown_nto_qnx710_iosock=-Vgcc_ntoaarch64le_cxx
CXX_aarch64_unknown_nto_qnx710_iosock=qcc
AR_aarch64_unknown_nto_qnx710_iosock=ntoaarch64-ar
CC_aarch64_unknown_nto_qnx700=qcc
CFLAGS_aarch64_unknown_nto_qnx700=-Vgcc_ntoaarch64le_cxx
CXX_aarch64_unknown_nto_qnx700=qcc
AR_aarch64_unknown_nto_qnx700=ntoaarch64-ar
CC_x86_64_pc_nto_qnx710=qcc
CFLAGS_x86_64_pc_nto_qnx710=-Vgcc_ntox86_64_cxx
CXX_x86_64_pc_nto_qnx710=qcc
AR_x86_64_pc_nto_qnx710=ntox86_64-ar
'

env $build_env \
./x.py build \
--target aarch64-unknown-nto-qnx710_iosock,aarch64-unknown-nto-qnx710,x86_64-pc-nto-qnx710,x86_64-unknown-linux-gnu \
rustc library/core library/alloc library/std
```
Example content:

```toml
profile = "compiler"
change-id = 115898
```

2. Compile the Rust toolchain for an `x86_64-unknown-linux-gnu` host

Compiling the Rust toolchain requires the same environment variables used for compiling C binaries.
Refer to the [QNX developer manual](https://www.qnx.com/developers/docs/7.1/#com.qnx.doc.neutrino.prog/topic/devel_OS_version.html).

Check failure on line 139 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
To compile for QNX Neutrino, environment variables must be set to use the correct tools and compiler switches:

Check failure on line 141 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
- `CC_<target>=qcc`
- `CFLAGS_<target>=<nto_cflag>`
- `CXX_<target>=qcc`
- `AR_<target>=<nto_ar>`

Check failure on line 146 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
With:

Check failure on line 148 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
- `<target>` target triplet using underscores instead of hyphens, e.g. `aarch64_unknown_nto_qnx710`
- `<nto_cflag>`

Check failure on line 151 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
- `-Vgcc_ntox86_cxx` for x86 (32 bit)
- `-Vgcc_ntox86_64_cxx` for x86_64 (64 bit)
- `-Vgcc_ntoaarch64le_cxx` for Aarch64 (64 bit)

Check failure on line 155 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
- `<nto_ar>`

Check failure on line 157 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
- `ntox86-ar` for x86 (32 bit)
- `ntox86_64-ar` for x86_64 (64 bit)
- `ntoaarch64-ar` for Aarch64 (64 bit)

Check failure on line 161 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
Example to build the Rust toolchain including a standard library for x86_64-linux-gnu and Aarch64-QNX-7.1:

Check failure on line 163 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
```bash
export build_env='
CC_aarch64_unknown_nto_qnx710=qcc
CFLAGS_aarch64_unknown_nto_qnx710=-Vgcc_ntoaarch64le_cxx
CXX_aarch64_unknown_nto_qnx710=qcc
AR_aarch64_unknown_nto_qnx710=ntoaarch64-ar
'

Check failure on line 171 in src/doc/rustc/src/platform-support/nto-qnx.md

View workflow job for this annotation

GitHub Actions / PR - mingw-check-tidy

trailing whitespace
env $build_env \
./x.py build \
--target x86_64-unknown-linux-gnu,aarch64-unknown-nto-qnx710 \
rustc library/core library/alloc library/std
```

## Running the Rust test suite

Expand Down

0 comments on commit 6e472e4

Please sign in to comment.