You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# {{project-name}}
|
|
|
|
## Prerequisites
|
|
|
|
1. stable rust toolchains: `rustup toolchain install stable`
|
|
1. nightly rust toolchains: `rustup toolchain install nightly --component rust-src`
|
|
1. (if cross-compiling) [rustup target](https://doc.rust-lang.org/nightly/rustc/platform-support.html#tier-1-with-host-tools): `rustup target add ${ARCH}-unknown-linux-musl`
|
|
1. (if cross-compiling) LLVM: (e.g.) `brew install llvm` (on macOS)
|
|
1. bpf-linker: `cargo install bpf-linker` (`--no-default-features` on macOS)
|
|
|
|
## Build & Run
|
|
|
|
Use `cargo build`, `cargo check`, etc. as normal. Run your program with `xtask run`.
|
|
|
|
Cargo build scripts are used to automatically build the eBPF correctly and include it in the
|
|
program. When not using `xtask run`, eBPF code generation is skipped for a faster developer
|
|
experience; this compromise necessitates the use of `xtask` to actually build the eBPF.
|
|
|
|
## Cross-compiling on macOS
|
|
|
|
Cross compilation should work on both Intel and Apple Silicon Macs.
|
|
|
|
```bash
|
|
AYA_BUILD_EBPF=true cargo build --package {{project-name}} \
|
|
--release --target=${ARCH}-unknown-linux-musl \
|
|
--config 'target.${ARCH}-unknown-linux-musl.linker = "rust-lld"'
|
|
```
|
|
The cross-compiled program `target/${ARCH}-unknown-linux-musl/release/{{project-name}}` can be
|
|
copied to a Linux server or VM and run there.
|