|
@@ -1,405 +1,62 @@
|
|
|
-use anyhow::{anyhow, bail, Context as _, Result};
|
|
|
-use std::{
|
|
|
- process::{Child, ChildStdout, Command, Stdio},
|
|
|
- thread::sleep,
|
|
|
- time::Duration,
|
|
|
-};
|
|
|
-
|
|
|
-use aya::{maps::Array, programs::TracePoint, util::KernelVersion, BpfLoader, Btf, Endianness};
|
|
|
-
|
|
|
-// In the tests below we often use values like 0xAAAAAAAA or -0x7AAAAAAA. Those values have no
|
|
|
-// special meaning, they just have "nice" bit patterns that can be helpful while debugging.
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_field() {
|
|
|
- let test = RelocationTest {
|
|
|
- local_definition: r#"
|
|
|
- struct foo {
|
|
|
- __u8 a;
|
|
|
- __u8 b;
|
|
|
- __u8 c;
|
|
|
- __u8 d;
|
|
|
- };
|
|
|
- "#,
|
|
|
- target_btf: r#"
|
|
|
- struct foo {
|
|
|
- __u8 a;
|
|
|
- __u8 c;
|
|
|
- __u8 b;
|
|
|
- __u8 d;
|
|
|
- } s1;
|
|
|
- "#,
|
|
|
- relocation_code: r#"
|
|
|
- __u8 memory[] = {1, 2, 3, 4};
|
|
|
- struct foo *ptr = (struct foo *) &memory;
|
|
|
- value = __builtin_preserve_access_index(ptr->c);
|
|
|
- "#,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test.run().unwrap(), 2);
|
|
|
- assert_eq!(test.run_no_btf().unwrap(), 3);
|
|
|
-}
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_enum() {
|
|
|
- let test = RelocationTest {
|
|
|
- local_definition: r#"
|
|
|
- enum foo { D = 0xAAAAAAAA };
|
|
|
- "#,
|
|
|
- target_btf: r#"
|
|
|
- enum foo { D = 0xBBBBBBBB } e1;
|
|
|
- "#,
|
|
|
- relocation_code: r#"
|
|
|
- #define BPF_ENUMVAL_VALUE 1
|
|
|
- value = __builtin_preserve_enum_value(*(typeof(enum foo) *)D, BPF_ENUMVAL_VALUE);
|
|
|
- "#,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test.run().unwrap(), 0xBBBBBBBB);
|
|
|
- assert_eq!(test.run_no_btf().unwrap(), 0xAAAAAAAA);
|
|
|
-}
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_enum_signed() {
|
|
|
- let kernel_version = KernelVersion::current().unwrap();
|
|
|
- if kernel_version < KernelVersion::new(6, 0, 0) {
|
|
|
- eprintln!("skipping test on kernel {kernel_version:?}, support for signed enum was added in 6.0.0; see https://github.com/torvalds/linux/commit/6089fb3");
|
|
|
- return;
|
|
|
- }
|
|
|
- let test = RelocationTest {
|
|
|
- local_definition: r#"
|
|
|
- enum foo { D = -0x7AAAAAAA };
|
|
|
- "#,
|
|
|
- target_btf: r#"
|
|
|
- enum foo { D = -0x7BBBBBBB } e1;
|
|
|
- "#,
|
|
|
- relocation_code: r#"
|
|
|
- #define BPF_ENUMVAL_VALUE 1
|
|
|
- value = __builtin_preserve_enum_value(*(typeof(enum foo) *)D, BPF_ENUMVAL_VALUE);
|
|
|
- "#,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test.run().unwrap() as i64, -0x7BBBBBBBi64);
|
|
|
- assert_eq!(test.run_no_btf().unwrap() as i64, -0x7AAAAAAAi64);
|
|
|
-}
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_enum64() {
|
|
|
- let kernel_version = KernelVersion::current().unwrap();
|
|
|
- if kernel_version < KernelVersion::new(6, 0, 0) {
|
|
|
- eprintln!("skipping test on kernel {kernel_version:?}, support for enum64 was added in 6.0.0; see https://github.com/torvalds/linux/commit/6089fb3");
|
|
|
- return;
|
|
|
- }
|
|
|
- let test = RelocationTest {
|
|
|
- local_definition: r#"
|
|
|
- enum foo { D = 0xAAAAAAAABBBBBBBB };
|
|
|
- "#,
|
|
|
- target_btf: r#"
|
|
|
- enum foo { D = 0xCCCCCCCCDDDDDDDD } e1;
|
|
|
- "#,
|
|
|
- relocation_code: r#"
|
|
|
- #define BPF_ENUMVAL_VALUE 1
|
|
|
- value = __builtin_preserve_enum_value(*(typeof(enum foo) *)D, BPF_ENUMVAL_VALUE);
|
|
|
- "#,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test.run().unwrap(), 0xCCCCCCCCDDDDDDDD);
|
|
|
- assert_eq!(test.run_no_btf().unwrap(), 0xAAAAAAAABBBBBBBB);
|
|
|
-}
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_enum64_signed() {
|
|
|
- let kernel_version = KernelVersion::current().unwrap();
|
|
|
- if kernel_version < KernelVersion::new(6, 0, 0) {
|
|
|
- eprintln!("skipping test on kernel {kernel_version:?}, support for enum64 was added in 6.0.0; see https://github.com/torvalds/linux/commit/6089fb3");
|
|
|
- return;
|
|
|
- }
|
|
|
- let test = RelocationTest {
|
|
|
- local_definition: r#"
|
|
|
- enum foo { D = -0xAAAAAAABBBBBBBB };
|
|
|
- "#,
|
|
|
- target_btf: r#"
|
|
|
- enum foo { D = -0xCCCCCCCDDDDDDDD } e1;
|
|
|
- "#,
|
|
|
- relocation_code: r#"
|
|
|
- #define BPF_ENUMVAL_VALUE 1
|
|
|
- value = __builtin_preserve_enum_value(*(typeof(enum foo) *)D, BPF_ENUMVAL_VALUE);
|
|
|
- "#,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test.run().unwrap() as i64, -0xCCCCCCCDDDDDDDDi64);
|
|
|
- assert_eq!(test.run_no_btf().unwrap() as i64, -0xAAAAAAABBBBBBBBi64);
|
|
|
-}
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_pointer() {
|
|
|
- let test = RelocationTest {
|
|
|
- local_definition: r#"
|
|
|
- struct foo {};
|
|
|
- struct bar { struct foo *f; };
|
|
|
- "#,
|
|
|
- target_btf: r#"
|
|
|
- struct foo {};
|
|
|
- struct bar { struct foo *f; };
|
|
|
- "#,
|
|
|
- relocation_code: r#"
|
|
|
- __u8 memory[] = {42, 0, 0, 0, 0, 0, 0, 0};
|
|
|
- struct bar* ptr = (struct bar *) &memory;
|
|
|
- value = (__u64) __builtin_preserve_access_index(ptr->f);
|
|
|
- "#,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test.run().unwrap(), 42);
|
|
|
- assert_eq!(test.run_no_btf().unwrap(), 42);
|
|
|
-}
|
|
|
-
|
|
|
-#[test]
|
|
|
-fn relocate_struct_flavors() {
|
|
|
- let definition = r#"
|
|
|
- struct foo {};
|
|
|
- struct bar { struct foo *f; };
|
|
|
- struct bar___cafe { struct foo *e; struct foo *f; };
|
|
|
- "#;
|
|
|
-
|
|
|
- let relocation_code = r#"
|
|
|
- __u8 memory[] = {42, 0, 0, 0, 0, 0, 0, 0, 21, 0, 0, 0, 0, 0, 0, 0};
|
|
|
- struct bar* ptr = (struct bar *) &memory;
|
|
|
-
|
|
|
- if (__builtin_preserve_field_info((((typeof(struct bar___cafe) *)0)->e), 2)) {
|
|
|
- value = (__u64) __builtin_preserve_access_index(((struct bar___cafe *)ptr)->e);
|
|
|
- } else {
|
|
|
- value = (__u64) __builtin_preserve_access_index(ptr->f);
|
|
|
+use test_case::test_case;
|
|
|
+
|
|
|
+use aya::{maps::Array, programs::UProbe, util::KernelVersion, BpfLoader, Btf, Endianness};
|
|
|
+
|
|
|
+#[test_case("field", false, None, 2)]
|
|
|
+#[test_case("field", true, None, 1)]
|
|
|
+#[test_case("enum_unsigned_32", false, None, 0xAAAAAAAA)]
|
|
|
+#[test_case("enum_unsigned_32", true, None, 0xBBBBBBBB)]
|
|
|
+#[test_case("pointer", false, None, 42)]
|
|
|
+#[test_case("pointer", true, None, 21)]
|
|
|
+#[test_case("struct_flavors", false, None, 1)]
|
|
|
+#[test_case("struct_flavors", true, None, 1)]
|
|
|
+#[test_case("enum_signed_32", false, Some((KernelVersion::new(6, 0, 0), "https://github.com/torvalds/linux/commit/6089fb3")), -0x7AAAAAAAi32 as u64)]
|
|
|
+#[test_case("enum_signed_32", true, Some((KernelVersion::new(6, 0, 0), "https://github.com/torvalds/linux/commit/6089fb3")), -0x7BBBBBBBi32 as u64)]
|
|
|
+#[test_case("enum_unsigned_64", false, Some((KernelVersion::new(6, 0, 0), "https://github.com/torvalds/linux/commit/6089fb3")), 0xAAAAAAAABBBBBBBB)]
|
|
|
+#[test_case("enum_unsigned_64", true, Some((KernelVersion::new(6, 0, 0), "https://github.com/torvalds/linux/commit/6089fb3")), 0xCCCCCCCCDDDDDDDD)]
|
|
|
+#[test_case("enum_signed_64", false, Some((KernelVersion::new(6, 0, 0), "https://github.com/torvalds/linux/commit/6089fb3")), -0xAAAAAAABBBBBBBBi64 as u64)]
|
|
|
+#[test_case("enum_signed_64", true, Some((KernelVersion::new(6, 0, 0), "https://github.com/torvalds/linux/commit/6089fb3")), -0xCCCCCCCDDDDDDDDi64 as u64)]
|
|
|
+fn relocation_tests(
|
|
|
+ program: &str,
|
|
|
+ with_relocations: bool,
|
|
|
+ required_kernel_version: Option<(KernelVersion, &str)>,
|
|
|
+ expected: u64,
|
|
|
+) {
|
|
|
+ if let Some((required_kernel_version, commit)) = required_kernel_version {
|
|
|
+ let current_kernel_version = KernelVersion::current().unwrap();
|
|
|
+ if current_kernel_version < required_kernel_version {
|
|
|
+ eprintln!("skipping test on kernel {current_kernel_version:?}, support for {program} was added in {required_kernel_version:?}; see {commit}");
|
|
|
+ return;
|
|
|
}
|
|
|
- "#;
|
|
|
-
|
|
|
- let test_no_flavor = RelocationTest {
|
|
|
- local_definition: definition,
|
|
|
- target_btf: definition,
|
|
|
- relocation_code,
|
|
|
- }
|
|
|
- .build()
|
|
|
- .unwrap();
|
|
|
- assert_eq!(test_no_flavor.run_no_btf().unwrap(), 42);
|
|
|
-}
|
|
|
-
|
|
|
-/// Utility code for running relocation tests:
|
|
|
-/// - Generates the eBPF program using probided local definition and relocation code
|
|
|
-/// - Generates the BTF from the target btf code
|
|
|
-struct RelocationTest {
|
|
|
- /// Data structure definition, local to the eBPF program and embedded in the eBPF bytecode
|
|
|
- local_definition: &'static str,
|
|
|
- /// Target data structure definition. What the vmlinux would actually contain.
|
|
|
- target_btf: &'static str,
|
|
|
- /// Code executed by the eBPF program to test the relocation.
|
|
|
- /// The format should be:
|
|
|
- // __u8 memory[] = { ... };
|
|
|
- // __u32 value = BPF_CORE_READ((struct foo *)&memory, ...);
|
|
|
- //
|
|
|
- // The generated code will be executed by attaching a tracepoint to sched_switch
|
|
|
- // and emitting `__u32 value` an a map. See the code template below for more details.
|
|
|
- relocation_code: &'static str,
|
|
|
-}
|
|
|
-
|
|
|
-impl RelocationTest {
|
|
|
- /// Build a RelocationTestRunner
|
|
|
- fn build(&self) -> Result<RelocationTestRunner> {
|
|
|
- Ok(RelocationTestRunner {
|
|
|
- ebpf: self.build_ebpf()?,
|
|
|
- btf: self.build_btf()?,
|
|
|
- })
|
|
|
- }
|
|
|
-
|
|
|
- /// - Generate the source eBPF filling a template
|
|
|
- /// - Compile it with clang
|
|
|
- fn build_ebpf(&self) -> Result<Vec<u8>> {
|
|
|
- use std::io::Read as _;
|
|
|
-
|
|
|
- let Self {
|
|
|
- local_definition,
|
|
|
- relocation_code,
|
|
|
- ..
|
|
|
- } = self;
|
|
|
-
|
|
|
- let mut stdout = compile(&format!(
|
|
|
- r#"
|
|
|
- #include <linux/bpf.h>
|
|
|
-
|
|
|
- static long (*bpf_map_update_elem)(void *map, const void *key, const void *value, __u64 flags) = (void *) 2;
|
|
|
-
|
|
|
- {local_definition}
|
|
|
-
|
|
|
- struct {{
|
|
|
- int (*type)[BPF_MAP_TYPE_ARRAY];
|
|
|
- __u32 *key;
|
|
|
- __u64 *value;
|
|
|
- int (*max_entries)[1];
|
|
|
- }} output_map
|
|
|
- __attribute__((section(".maps"), used));
|
|
|
-
|
|
|
- __attribute__ ((noinline)) int bpf_func() {{
|
|
|
- __u32 key = 0;
|
|
|
- __u64 value = 0;
|
|
|
- {relocation_code}
|
|
|
- bpf_map_update_elem(&output_map, &key, &value, BPF_ANY);
|
|
|
- return 0;
|
|
|
- }}
|
|
|
-
|
|
|
- __attribute__((section("tracepoint/bpf_prog"), used))
|
|
|
- int bpf_prog(void *ctx) {{
|
|
|
- bpf_func();
|
|
|
- return 0;
|
|
|
- }}
|
|
|
-
|
|
|
- char _license[] __attribute__((section("license"), used)) = "GPL";
|
|
|
- "#
|
|
|
- ))
|
|
|
- .context("failed to compile eBPF program")?;
|
|
|
- let mut output = Vec::new();
|
|
|
- stdout.read_to_end(&mut output)?;
|
|
|
- Ok(output)
|
|
|
- }
|
|
|
-
|
|
|
- /// - Generate the target BTF source with a mock main()
|
|
|
- /// - Compile it with clang
|
|
|
- /// - Extract the BTF with llvm-objcopy
|
|
|
- fn build_btf(&self) -> Result<Btf> {
|
|
|
- use std::io::Read as _;
|
|
|
-
|
|
|
- let Self {
|
|
|
- target_btf,
|
|
|
- relocation_code,
|
|
|
- ..
|
|
|
- } = self;
|
|
|
-
|
|
|
- // BTF files can be generated and inspected with these commands:
|
|
|
- // $ clang -c -g -O2 -target bpf target.c
|
|
|
- // $ pahole --btf_encode_detached=target.btf -V target.o
|
|
|
- // $ bpftool btf dump file ./target.btf format c
|
|
|
- let stdout = compile(&format!(
|
|
|
- r#"
|
|
|
- #include <linux/bpf.h>
|
|
|
-
|
|
|
- {target_btf}
|
|
|
- int main() {{
|
|
|
- __u64 value = 0;
|
|
|
- // This is needed to make sure to emit BTF for the defined types,
|
|
|
- // it could be dead code eliminated if we don't.
|
|
|
- {relocation_code};
|
|
|
- return value;
|
|
|
- }}
|
|
|
- "#
|
|
|
- ))
|
|
|
- .context("failed to compile BTF")?;
|
|
|
-
|
|
|
- let mut cmd = Command::new("llvm-objcopy");
|
|
|
- cmd.args(["--dump-section", ".BTF=-", "-"])
|
|
|
- .stdin(stdout)
|
|
|
- .stdout(Stdio::piped());
|
|
|
- let mut child = cmd
|
|
|
- .spawn()
|
|
|
- .with_context(|| format!("failed to spawn {cmd:?}"))?;
|
|
|
- let Child { stdout, .. } = &mut child;
|
|
|
- let mut stdout = stdout.take().ok_or(anyhow!("failed to open stdout"))?;
|
|
|
- let status = child
|
|
|
- .wait()
|
|
|
- .with_context(|| format!("failed to wait for {cmd:?}"))?;
|
|
|
- match status.code() {
|
|
|
- Some(code) => match code {
|
|
|
- 0 => {}
|
|
|
- code => bail!("{cmd:?} exited with code {code}"),
|
|
|
- },
|
|
|
- None => bail!("{cmd:?} terminated by signal"),
|
|
|
- }
|
|
|
-
|
|
|
- let mut output = Vec::new();
|
|
|
- stdout.read_to_end(&mut output)?;
|
|
|
-
|
|
|
- Btf::parse(output.as_slice(), Endianness::default())
|
|
|
- .context("failed to parse generated BTF")
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-/// Compile an eBPF program and return its bytes.
|
|
|
-fn compile(source_code: &str) -> Result<ChildStdout> {
|
|
|
- use std::io::Write as _;
|
|
|
-
|
|
|
- let mut cmd = Command::new("clang");
|
|
|
- cmd.args([
|
|
|
- "-c", "-g", "-O2", "-target", "bpf", "-x", "c", "-", "-o", "-",
|
|
|
- ])
|
|
|
- .stdin(Stdio::piped())
|
|
|
- .stdout(Stdio::piped());
|
|
|
- let mut child = cmd
|
|
|
- .spawn()
|
|
|
- .with_context(|| format!("failed to spawn {cmd:?}"))?;
|
|
|
- let Child { stdin, stdout, .. } = &mut child;
|
|
|
- {
|
|
|
- let mut stdin = stdin.take().ok_or(anyhow!("failed to open stdin"))?;
|
|
|
- stdin
|
|
|
- .write_all(source_code.as_bytes())
|
|
|
- .context("failed to write to stdin")?;
|
|
|
- }
|
|
|
- let stdout = stdout.take().ok_or(anyhow!("failed to open stdout"))?;
|
|
|
- let status = child
|
|
|
- .wait()
|
|
|
- .with_context(|| format!("failed to wait for {cmd:?}"))?;
|
|
|
- match status.code() {
|
|
|
- Some(code) => match code {
|
|
|
- 0 => {}
|
|
|
- code => bail!("{cmd:?} exited with code {code}"),
|
|
|
- },
|
|
|
- None => bail!("{cmd:?} terminated by signal"),
|
|
|
- }
|
|
|
- Ok(stdout)
|
|
|
-}
|
|
|
-
|
|
|
-struct RelocationTestRunner {
|
|
|
- ebpf: Vec<u8>,
|
|
|
- btf: Btf,
|
|
|
-}
|
|
|
-
|
|
|
-impl RelocationTestRunner {
|
|
|
- /// Run test and return the output value
|
|
|
- fn run(&self) -> Result<u64> {
|
|
|
- self.run_internal(true).context("Error running with BTF")
|
|
|
- }
|
|
|
-
|
|
|
- /// Run without loading btf
|
|
|
- fn run_no_btf(&self) -> Result<u64> {
|
|
|
- self.run_internal(false)
|
|
|
- .context("Error running without BTF")
|
|
|
- }
|
|
|
-
|
|
|
- fn run_internal(&self, with_relocations: bool) -> Result<u64> {
|
|
|
- let mut loader = BpfLoader::new();
|
|
|
- if with_relocations {
|
|
|
- loader.btf(Some(&self.btf));
|
|
|
- } else {
|
|
|
- loader.btf(None);
|
|
|
- }
|
|
|
- let mut bpf = loader.load(&self.ebpf).context("Loading eBPF failed")?;
|
|
|
- let program: &mut TracePoint = bpf
|
|
|
- .program_mut("bpf_prog")
|
|
|
- .context("bpf_prog not found")?
|
|
|
- .try_into()
|
|
|
- .context("program not a tracepoint")?;
|
|
|
- program.load().context("Loading tracepoint failed")?;
|
|
|
- // Attach to sched_switch and wait some time to make sure it executed at least once
|
|
|
- program
|
|
|
- .attach("sched", "sched_switch")
|
|
|
- .context("attach failed")?;
|
|
|
- sleep(Duration::from_millis(1000));
|
|
|
- // To inspect the loaded eBPF bytecode, increse the timeout and run:
|
|
|
- // $ sudo bpftool prog dump xlated name bpf_prog
|
|
|
-
|
|
|
- let output_map: Array<_, u64> = bpf.take_map("output_map").unwrap().try_into().unwrap();
|
|
|
- let key = 0;
|
|
|
- output_map.get(&key, 0).context("Getting key 0 failed")
|
|
|
}
|
|
|
+ let mut bpf = BpfLoader::new()
|
|
|
+ .btf(
|
|
|
+ with_relocations
|
|
|
+ .then(|| Btf::parse(crate::RELOC_BTF, Endianness::default()).unwrap())
|
|
|
+ .as_ref(),
|
|
|
+ )
|
|
|
+ .load(crate::RELOC_BPF)
|
|
|
+ .unwrap();
|
|
|
+ let program: &mut UProbe = bpf.program_mut(program).unwrap().try_into().unwrap();
|
|
|
+ program.load().unwrap();
|
|
|
+ program
|
|
|
+ .attach(
|
|
|
+ Some("trigger_btf_relocations_program"),
|
|
|
+ 0,
|
|
|
+ "/proc/self/exe",
|
|
|
+ None,
|
|
|
+ )
|
|
|
+ .unwrap();
|
|
|
+
|
|
|
+ trigger_btf_relocations_program();
|
|
|
+
|
|
|
+ let output_map: Array<_, u64> = bpf.take_map("output_map").unwrap().try_into().unwrap();
|
|
|
+ let key = 0;
|
|
|
+ assert_eq!(output_map.get(&key, 0).unwrap(), expected)
|
|
|
+}
|
|
|
+
|
|
|
+#[no_mangle]
|
|
|
+#[inline(never)]
|
|
|
+pub extern "C" fn trigger_btf_relocations_program() {
|
|
|
+ core::hint::black_box(trigger_btf_relocations_program);
|
|
|
}
|