1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
//! libbpf-cargo helps you develop and build eBPF (BPF) programs with standard rust tooling. //! //! libbpf-cargo supports two interfaces: //! * [`SkeletonBuilder`] API, for use with [build scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html) //! * `cargo-libbpf` cargo subcommand, for use with `cargo` //! //! The **build script interface is recommended** over the cargo subcommand interface because: //! * once set up, you cannot forget to update the generated skeletons if your source changes //! * build scripts are standard practice for projects that include codegen //! * newcomers to your project can `cargo build` and it will "just work" //! //! The following sections in this document describe the `cargo-libbpf` plugin. See the API //! reference for documentation on the build script interface. //! //! # Configuration //! //! cargo-libbpf consumes the following Cargo.toml configuration options: //! //! ```text //! [package.metadata.libbpf] //! prog_dir = "src/other_bpf_dir" # default: <manifest_directory>/src/bpf //! target_dir = "other_target_dir" # default: <target_dir>/bpf //! ``` //! //! * `prog_dir`: path relative to package Cargo.toml to search for bpf progs //! * `target_dir`: path relative to workspace target directory to place compiled bpf progs //! //! # Subcommands //! //! ## build //! //! `cargo libbpf build` compiles `<NAME>.bpf.c` C files into corresponding `<NAME>.bpf.o` ELF //! object files. Each object file may contain one or more BPF programs, maps, and associated //! metadata. The object file may then be handed over to `libbpf-rs` for loading and interaction. //! //! cargo-libbpf-build enforces a few conventions: //! //! * source file names must be in the `<NAME>.bpf.c` format //! * object file names will be generated in `<NAME>.bpf.o` format //! * there may not be any two identical `<NAME>.bpf.c` file names in any two projects in a //! cargo workspace //! //! ## gen //! //! `cargo libbpf gen` generates a skeleton module for each BPF object file in the project. Each //! `<NAME>.bpf.o` object file will have its own module. One `mod.rs` file is also generated. All //! output files are placed into `package.metadata.libbpf.prog_dir`. //! //! Be careful to run cargo-libbpf-build before running cargo-libbpf-gen. cargo-libbpf-gen reads //! object files from `package.metadata.libbpf.target_dir`. //! //! ## make //! //! `cargo libbpf make` sequentially runs cargo-libbpf-build, cargo-libbpf-gen, and `cargo //! build`. This is a convenience command so you don't forget any steps. Alternatively, you could //! write a Makefile for your project. use std::path::{Path, PathBuf}; use std::result; use tempfile::tempdir; use thiserror::Error; // libbpf-cargo binary is the primary consumer of the following modules. As such, // we do not use all the symbols. Silence any unused code warnings. #[allow(dead_code)] mod btf; #[allow(dead_code)] mod build; #[allow(dead_code)] mod gen; #[allow(dead_code)] mod make; #[allow(dead_code)] mod metadata; #[cfg(test)] mod test; /// Canonical error type for this crate. #[derive(Error, Debug)] pub enum Error { #[error("Error building BPF object file: {0}")] Build(String), #[error("Error generating skeleton: {0}")] Generate(String), } pub type Result<T> = result::Result<T, Error>; /// `SkeletonBuilder` builds and generates a single skeleton. /// /// This interface is meant to be used in build scripts. /// /// # Examples /// /// ```no_run /// use libbpf_cargo::SkeletonBuilder; /// /// SkeletonBuilder::new("myobject.bpf.c") /// .debug(true) /// .clang("/opt/clang/clang") /// .generate("/output/path") /// .unwrap(); /// ``` pub struct SkeletonBuilder { debug: bool, source: PathBuf, clang: Option<PathBuf>, clang_args: String, skip_clang_version_check: bool, rustfmt: PathBuf, } impl SkeletonBuilder { /// Create a new builder instance, where `source` is the path to the BPF object source /// (typically suffixed by `.bpf.c`) pub fn new<P: AsRef<Path>>(source: P) -> Self { SkeletonBuilder { debug: false, source: source.as_ref().to_path_buf(), clang: None, clang_args: String::new(), skip_clang_version_check: false, rustfmt: "rustfmt".into(), } } /// Turn debug output on or off /// /// Default is off pub fn debug(&mut self, debug: bool) -> &mut SkeletonBuilder { self.debug = debug; self } /// Specify which `clang` binary to use /// /// Default searchs `$PATH` for `clang` pub fn clang<P: AsRef<Path>>(&mut self, clang: P) -> &mut SkeletonBuilder { self.clang = Some(clang.as_ref().to_path_buf()); self } /// Pass additional arguments to `clang` when buildling BPF object file /// /// # Examples /// /// ```no_run /// use libbpf_cargo::SkeletonBuilder; /// /// SkeletonBuilder::new("myobject.bpf.c") /// .clang_args("-DMACRO=value -I/some/include/dir") /// .generate("/output/path") /// .unwrap(); /// ``` pub fn clang_args<S: AsRef<str>>(&mut self, opts: S) -> &mut SkeletonBuilder { self.clang_args = opts.as_ref().to_string(); self } /// Specify whether or not to skip clang version check /// /// Default is `false` pub fn skip_clang_version_check(&mut self, skip: bool) -> &mut SkeletonBuilder { self.skip_clang_version_check = skip; self } /// Specify which `rustfmt` binary to use /// /// Default searches `$PATH` for `rustfmt` pub fn rustfmt<P: AsRef<Path>>(&mut self, rustfmt: P) -> &mut SkeletonBuilder { self.rustfmt = rustfmt.as_ref().to_path_buf(); self } /// Generate the skeleton at path `output` pub fn generate<P: AsRef<Path>>(&self, output: P) -> Result<()> { let filename = self .source .file_name() .ok_or_else(|| Error::Build("Missing file name".into()))? .to_str() .ok_or_else(|| Error::Build("Invalid unicode in file name".into()))?; if !filename.ends_with(".bpf.c") { return Err(Error::Build(format!( "Source file={} does not have .bpf.c suffix", self.source.display() ))); } // Safe to unwrap b/c we already checked suffix let name = filename.split('.').next().unwrap(); let dir = tempdir().map_err(|e| Error::Build(e.to_string()))?; let objfile = dir.path().join(format!("{}.o", name)); build::build_single( self.debug, &self.source, &objfile, self.clang.as_ref(), self.skip_clang_version_check, &self.clang_args, ) .map_err(|e| Error::Build(e.to_string()))?; gen::gen_single( self.debug, &objfile, gen::OutputDest::File(output.as_ref()), Some(&self.rustfmt), ) .map_err(|e| Error::Generate(e.to_string()))?; Ok(()) } }