Skip to content

Commit

Permalink
libbpf-cargo: Rename build() -> build_project()
Browse files Browse the repository at this point in the history
Rename the build() function to build_project(), because that's what it
does.

Signed-off-by: Daniel Müller <deso@posteo.net>
  • Loading branch information
d-e-s-o committed Jan 16, 2025
1 parent 5738872 commit 3466998
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 20 deletions.
2 changes: 1 addition & 1 deletion libbpf-cargo/src/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ fn extract_clang_or_default(clang: Option<&PathBuf>) -> PathBuf {
}
}

pub fn build(
pub fn build_project(
manifest_path: Option<&PathBuf>,
clang: Option<&PathBuf>,
clang_args: Vec<OsString>,
Expand Down
2 changes: 1 addition & 1 deletion libbpf-cargo/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ impl SkeletonBuilder {
#[doc(hidden)]
pub mod __private {
pub mod build {
pub use crate::build::build;
pub use crate::build::build_project;
}
pub mod gen {
pub use crate::gen::gen;
Expand Down
2 changes: 1 addition & 1 deletion libbpf-cargo/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ fn main() -> Result<()> {
clang_path,
clang_args,
},
} => build::build(manifest_path.as_ref(), clang_path.as_ref(), clang_args),
} => build::build_project(manifest_path.as_ref(), clang_path.as_ref(), clang_args),
Command::Gen {
manifest_path,
rustfmt_path,
Expand Down
3 changes: 2 additions & 1 deletion libbpf-cargo/src/make.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ pub fn make(
rustfmt_path: Option<&PathBuf>,
) -> Result<()> {
debug!("Compiling BPF objects");
build::build(manifest_path, clang, clang_args).context("Failed to compile BPF objects")?;
build::build_project(manifest_path, clang, clang_args)
.context("Failed to compile BPF objects")?;

debug!("Generating skeletons");
gen::gen(manifest_path, None, rustfmt_path).context("Failed to generate skeletons")?;
Expand Down
32 changes: 16 additions & 16 deletions libbpf-cargo/src/test.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use tempfile::NamedTempFile;
use tempfile::TempDir;
use test_log::test;

use crate::build::build;
use crate::build::build_project;
use crate::gen::GenBtf;
use crate::gen::GenStructOps;
use crate::make::make;
Expand Down Expand Up @@ -140,17 +140,17 @@ fn test_build_default() {
let (_dir, proj_dir, cargo_toml) = setup_temp_project();

// No bpf progs yet
build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();

// Add prog dir
create_dir(proj_dir.join("src/bpf")).expect("failed to create prog dir");
build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();

// Add a prog
let _prog_file =
File::create(proj_dir.join("src/bpf/prog.bpf.c")).expect("failed to create prog file");

build(Some(&cargo_toml), None, Vec::new()).unwrap();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap();

// Validate generated object file
validate_bpf_o(proj_dir.as_path().join("target/bpf/prog.bpf.o").as_path());
Expand All @@ -168,7 +168,7 @@ fn test_build_invalid_prog() {
File::create(proj_dir.join("src/bpf/prog.bpf.c")).expect("failed to create prog file");
writeln!(prog_file, "1").expect("write to prog file failed");

build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();
}

#[test]
Expand All @@ -187,14 +187,14 @@ fn test_build_custom() {
.expect("write to Cargo.toml failed");

// No bpf progs yet
build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();

// Add a prog
create_dir(proj_dir.join("src/other_bpf_dir")).expect("failed to create prog dir");
let _prog_file = File::create(proj_dir.join("src/other_bpf_dir/prog.bpf.c"))
.expect("failed to create prog file");

build(Some(&cargo_toml), None, Vec::new()).unwrap();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap();

// Validate generated object file
validate_bpf_o(
Expand Down Expand Up @@ -224,13 +224,13 @@ fn test_unknown_metadata_section() {

// Add prog dir
create_dir(proj_dir.join("src/bpf")).expect("failed to create prog dir");
build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();

// Add a prog
let _prog_file =
File::create(proj_dir.join("src/bpf/prog.bpf.c")).expect("failed to create prog file");

build(Some(&cargo_toml), None, Vec::new()).unwrap();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap();

// Validate generated object file
validate_bpf_o(proj_dir.as_path().join("target/bpf/prog.bpf.o").as_path());
Expand All @@ -242,23 +242,23 @@ fn test_enforce_file_extension() {

// Add prog dir
create_dir(proj_dir.join("src/bpf")).expect("failed to create prog dir");
build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();

let _prog_file = File::create(proj_dir.join("src/bpf/prog_BAD_EXTENSION.c"))
.expect("failed to create prog file");
build(Some(&cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap_err();

let _prog_file_again = File::create(proj_dir.join("src/bpf/prog_GOOD_EXTENSION.bpf.c"))
.expect("failed to create prog file");
build(Some(&cargo_toml), None, Vec::new()).unwrap();
build_project(Some(&cargo_toml), None, Vec::new()).unwrap();
}

#[test]
fn test_build_workspace() {
let (_dir, _, workspace_cargo_toml, proj_one_dir, proj_two_dir) = setup_temp_workspace();

// No bpf progs yet
build(Some(&workspace_cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&workspace_cargo_toml), None, Vec::new()).unwrap_err();

// Create bpf prog for project one
create_dir(proj_one_dir.join("src/bpf")).expect("failed to create prog dir");
Expand All @@ -270,7 +270,7 @@ fn test_build_workspace() {
let _prog_file_2 = File::create(proj_two_dir.join("src/bpf/prog2.bpf.c"))
.expect("failed to create prog file 2");

build(Some(&workspace_cargo_toml), None, Vec::new()).unwrap();
build_project(Some(&workspace_cargo_toml), None, Vec::new()).unwrap();
}

#[test]
Expand All @@ -287,7 +287,7 @@ fn test_build_workspace_collision() {
let _prog_file_2 = File::create(proj_two_dir.join("src/bpf/prog.bpf.c"))
.expect("failed to create prog file 2");

build(Some(&workspace_cargo_toml), None, Vec::new()).unwrap_err();
build_project(Some(&workspace_cargo_toml), None, Vec::new()).unwrap_err();
}

#[test]
Expand Down Expand Up @@ -1193,7 +1193,7 @@ fn build_btf_mmap(prog_text: &str) -> Mmap {
add_vmlinux_header(&proj_dir);

// Build the .bpf.o
build(Some(&cargo_toml), None, Vec::new()).expect("failed to compile");
build_project(Some(&cargo_toml), None, Vec::new()).expect("failed to compile");

let obj = OpenOptions::new()
.read(true)
Expand Down

0 comments on commit 3466998

Please sign in to comment.