Initial version of libcsp-rust
This commit is contained in:
409
libcsp-cargo-build/src/lib.rs
Normal file
409
libcsp-cargo-build/src/lib.rs
Normal file
@ -0,0 +1,409 @@
|
||||
//! This crate provides a library to allow building the [`libcsp`](https://github.com/libcsp/libcsp)
|
||||
//! C library with cargo. You can find some more high-level information and examples in the
|
||||
//! [main repository](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
|
||||
use std::{
|
||||
io::{self, Write},
|
||||
path::{Path, PathBuf},
|
||||
};
|
||||
|
||||
pub mod cfg_keys {
|
||||
pub const POSIX: &str = "CSP_POSIX";
|
||||
pub const ZEPHYR: &str = "CSP_ZEPHYR";
|
||||
|
||||
pub const HAVE_STDIO: &str = "CSP_HAVE_STDIO";
|
||||
pub const ENABLE_CSP_PRINT: &str = "CSP_ENABLE_CSP_PRINT";
|
||||
pub const PRINT_STDIO: &str = "CSP_PRINT_STDIO";
|
||||
|
||||
pub const REPRODUCIBLE_BUILDS: &str = "CSP_REPRODUCIBLE_BUILDS";
|
||||
|
||||
pub const QFIFO_LEN: &str = "CSP_QFIFO_LEN";
|
||||
pub const PORT_MAX_BIND: &str = "CSP_PORT_MAX_BIND";
|
||||
pub const CONN_RXQUEUE_LEN: &str = "CSP_CONN_RXQUEUE_LEN";
|
||||
pub const CONN_MAX: &str = "CSP_CONN_MAX";
|
||||
pub const BUFFER_SIZE: &str = "CSP_BUFFER_SIZE";
|
||||
pub const BUFFER_COUNT: &str = "CSP_BUFFER_COUNT";
|
||||
pub const RDP_MAX_WINDOW: &str = "CSP_RDP_MAX_WINDOW";
|
||||
pub const RTABLE_SIZE: &str = "CSP_RTABLE_SIZE";
|
||||
|
||||
pub const USE_RDP: &str = "CSP_USE_RDP";
|
||||
pub const USE_HMAC: &str = "CSP_USE_HMAC";
|
||||
pub const USE_PROMISC: &str = "CSP_USE_PROMISC";
|
||||
pub const USE_RTABLE: &str = "CSP_USE_RTABLE";
|
||||
pub const HAVE_LIBSOCKETCAN: &str = "CSP_HAVE_LIBSOCKETCAN";
|
||||
pub const HAVE_LIBZMQ: &str = "CSP_HAVE_LIBZMQ";
|
||||
}
|
||||
|
||||
const SRCS_LIST: &[&str] = &[
|
||||
"csp_bridge.c",
|
||||
"csp_buffer.c",
|
||||
"csp_crc32.c",
|
||||
"csp_debug.c",
|
||||
"csp_id.c",
|
||||
"csp_iflist.c",
|
||||
"csp_conn.c",
|
||||
"csp_init.c",
|
||||
"csp_io.c",
|
||||
"csp_port.c",
|
||||
"csp_promisc.c",
|
||||
"csp_qfifo.c",
|
||||
"csp_port.c",
|
||||
"csp_route.c",
|
||||
"csp_dedup.c",
|
||||
"csp_services.c",
|
||||
"csp_service_handler.c",
|
||||
"interfaces/csp_if_lo.c",
|
||||
"interfaces/csp_if_kiss.c",
|
||||
"interfaces/csp_if_tun.c",
|
||||
"interfaces/csp_if_udp.c",
|
||||
"crypto/csp_hmac.c",
|
||||
"crypto/csp_sha1.c",
|
||||
];
|
||||
|
||||
const ARCH_SRCS_UNIX: &[&str] = &[
|
||||
"arch/posix/csp_clock.c",
|
||||
"arch/posix/csp_semaphore.c",
|
||||
"arch/posix/csp_system.c",
|
||||
"arch/posix/csp_time.c",
|
||||
"arch/posix/csp_queue.c",
|
||||
"arch/posix/pthread_queue.c",
|
||||
];
|
||||
|
||||
pub struct Config {
|
||||
pub have_stdio: bool,
|
||||
pub print_stdio: bool,
|
||||
pub reproducible_builds: bool,
|
||||
pub qfifo_len: u32,
|
||||
pub port_max_bind: u32,
|
||||
pub conn_rx_queue_len: u32,
|
||||
pub conn_max: u32,
|
||||
pub buffer_size: u32,
|
||||
pub buffer_count: u32,
|
||||
pub rdp_max_window: u32,
|
||||
pub rtable_size: u32,
|
||||
pub hmac: bool,
|
||||
pub rtable: bool,
|
||||
pub csp_print: bool,
|
||||
pub promisc: bool,
|
||||
pub rdp: bool,
|
||||
pub yaml: bool,
|
||||
}
|
||||
|
||||
impl Default for Config {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
have_stdio: true,
|
||||
print_stdio: true,
|
||||
reproducible_builds: false,
|
||||
qfifo_len: 16,
|
||||
port_max_bind: 16,
|
||||
conn_rx_queue_len: 16,
|
||||
conn_max: 8,
|
||||
buffer_size: 256,
|
||||
buffer_count: 15,
|
||||
rdp_max_window: 5,
|
||||
rtable_size: 10,
|
||||
hmac: true,
|
||||
rtable: false,
|
||||
csp_print: true,
|
||||
promisc: true,
|
||||
rdp: true,
|
||||
yaml: false,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Primary builder structure used to compile the `libcsp` C library.
|
||||
///
|
||||
/// The [Self::cfg] field can be used to configure the library build. The will also take care
|
||||
/// of generating the autoconfig.h file required for the library configuration automatically based
|
||||
/// on the build [Config]. An API is also provided to generate the autoconfig.rs file required
|
||||
/// for compiling the [`libcsp-sys`](https://crates.io/crates/libcp-sys) Rust FFI bindings crate.
|
||||
///
|
||||
/// ## Example
|
||||
///
|
||||
/// The [example buildscript](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/build.rs)
|
||||
/// uses this builder structure to compile the library.
|
||||
pub struct Builder {
|
||||
generate_autoconf_file: bool,
|
||||
libcsp_path: PathBuf,
|
||||
libcsp_src_path_base: PathBuf,
|
||||
out_dir: PathBuf,
|
||||
pub cfg: Config,
|
||||
pub compiler_warnings: bool,
|
||||
build: cc::Build,
|
||||
}
|
||||
|
||||
impl Builder {
|
||||
/// Create a new builder instance.
|
||||
pub fn new(libcsp_path: PathBuf, out_dir: PathBuf) -> Self {
|
||||
let mut libcsp_src_path_base = libcsp_path.clone();
|
||||
libcsp_src_path_base.push("src");
|
||||
Self {
|
||||
generate_autoconf_file: true,
|
||||
libcsp_path,
|
||||
libcsp_src_path_base,
|
||||
out_dir,
|
||||
cfg: Default::default(),
|
||||
compiler_warnings: true,
|
||||
build: Default::default(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Access to the underlying [cc::Build] builder object.
|
||||
pub fn cc(&mut self) -> &cc::Build {
|
||||
&self.build
|
||||
}
|
||||
|
||||
/// Mutable access to the underlying [cc::Build] builder object.
|
||||
pub fn cc_mut(&mut self) -> &mut cc::Build {
|
||||
&mut self.build
|
||||
}
|
||||
|
||||
pub fn compile(&mut self) -> io::Result<()> {
|
||||
if self.generate_autoconf_file {
|
||||
self.generate_autoconf_header_file_default_location()?;
|
||||
}
|
||||
for src in SRCS_LIST {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push(src);
|
||||
self.build.file(next_file);
|
||||
}
|
||||
if self.cfg.rdp {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push("csp_rdp.c");
|
||||
self.build.file(next_file);
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push("csp_rdp_queue.c");
|
||||
self.build.file(next_file);
|
||||
}
|
||||
if self.cfg.promisc {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push("csp_promisc.c");
|
||||
self.build.file(next_file);
|
||||
}
|
||||
if self.cfg.csp_print {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push("csp_hex_dump.c");
|
||||
self.build.file(next_file);
|
||||
}
|
||||
if self.cfg.yaml {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push("csp_yaml.c");
|
||||
self.build.file(next_file);
|
||||
}
|
||||
if self.cfg.rtable {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push("csp_rtable_cidr.c");
|
||||
self.build.file(next_file);
|
||||
}
|
||||
|
||||
// TODO: UNIX does not necesarilly mean POSIX? Details to deal with later..
|
||||
#[cfg(unix)]
|
||||
self.posix_arch_files();
|
||||
|
||||
let mut inc_path = self.libcsp_path.clone();
|
||||
inc_path.push("include");
|
||||
self.build.include(inc_path);
|
||||
self.build.include(&self.libcsp_src_path_base);
|
||||
self.build.cargo_warnings(self.compiler_warnings);
|
||||
|
||||
self.build.compile("csp");
|
||||
// TODO: We could generate some sort of information file which contains the
|
||||
// compilation information and the version of hte library.
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
fn posix_arch_files(&mut self) {
|
||||
for src in ARCH_SRCS_UNIX {
|
||||
let mut next_file = self.libcsp_src_path_base.clone();
|
||||
next_file.push(src);
|
||||
self.build.file(next_file);
|
||||
}
|
||||
}
|
||||
|
||||
pub fn generate_autoconf_header_file_default_location(&mut self) -> io::Result<()> {
|
||||
let mut autoconf_dir = self.out_dir.join("cfg");
|
||||
self.build.include(&autoconf_dir);
|
||||
autoconf_dir.push("csp");
|
||||
std::fs::create_dir_all(&autoconf_dir)?;
|
||||
generate_autoconf_header_file(&autoconf_dir, &self.cfg)
|
||||
}
|
||||
|
||||
pub fn generate_autoconf_header_file(&mut self, dir: impl AsRef<Path>) -> io::Result<()> {
|
||||
generate_autoconf_header_file(dir, &self.cfg)
|
||||
}
|
||||
|
||||
pub fn generate_autoconf_rust_file(&self, dir: impl AsRef<Path>) -> io::Result<()> {
|
||||
generate_autoconf_rust_file(dir, &self.cfg)
|
||||
}
|
||||
}
|
||||
|
||||
/// Generate the autoconfig.h file which is required to build the C library. This file contains
|
||||
/// important configuration defines.
|
||||
pub fn generate_autoconf_header_file(out_dir: impl AsRef<Path>, cfg: &Config) -> io::Result<()> {
|
||||
let out_dir = out_dir.as_ref();
|
||||
let mut autoconf_file_string = String::new();
|
||||
let version = env!("CARGO_PKG_VERSION");
|
||||
let name = env!("CARGO_PKG_NAME");
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"// This file was auto-generated by {} v{}\n",
|
||||
name, version
|
||||
));
|
||||
#[cfg(unix)]
|
||||
autoconf_file_string.push_str("#define CSP_POSIX 1\n");
|
||||
#[cfg(not(unix))]
|
||||
autoconf_file_string.push_str("#define CSP_POSIX 0\n");
|
||||
autoconf_file_string.push_str("#define CSP_ZEPHYR 0\n");
|
||||
autoconf_file_string.push('\n');
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::HAVE_STDIO,
|
||||
cfg.have_stdio as u32
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::ENABLE_CSP_PRINT,
|
||||
cfg.csp_print as u32
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::PRINT_STDIO,
|
||||
cfg.print_stdio as u32
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::REPRODUCIBLE_BUILDS,
|
||||
cfg.reproducible_builds as u32
|
||||
));
|
||||
autoconf_file_string.push('\n');
|
||||
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::QFIFO_LEN,
|
||||
cfg.qfifo_len
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::PORT_MAX_BIND,
|
||||
cfg.port_max_bind
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::CONN_RXQUEUE_LEN,
|
||||
cfg.conn_rx_queue_len
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::CONN_MAX,
|
||||
cfg.conn_max
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::BUFFER_SIZE,
|
||||
cfg.buffer_size
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::BUFFER_COUNT,
|
||||
cfg.buffer_count
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::RDP_MAX_WINDOW,
|
||||
cfg.rdp_max_window
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::RTABLE_SIZE,
|
||||
cfg.rtable_size
|
||||
));
|
||||
|
||||
autoconf_file_string.push('\n');
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::USE_RDP,
|
||||
cfg.rdp as u32
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::USE_HMAC,
|
||||
cfg.hmac as u32
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::USE_PROMISC,
|
||||
cfg.promisc as u32
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"#define {} {}\n",
|
||||
cfg_keys::USE_RTABLE,
|
||||
cfg.rtable as u32
|
||||
));
|
||||
|
||||
autoconf_file_string.push('\n');
|
||||
// TODO: Maybe those will be added at some point.. For now, they are hardcoded to 0.
|
||||
autoconf_file_string.push_str(&format!("#define {} {}\n", cfg_keys::HAVE_LIBSOCKETCAN, 0));
|
||||
autoconf_file_string.push_str(&format!("#define {} {}\n", cfg_keys::HAVE_LIBZMQ, 0));
|
||||
let out_file = out_dir.join("autoconfig.h");
|
||||
let mut file = std::fs::File::create(out_file)?;
|
||||
file.write_all(autoconf_file_string.as_bytes())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Generate the autoconfig.rs file which is required by the
|
||||
/// [`libcsp-sys`](https://crates.io/crates/libcsp-sys) Rust bindings crate.
|
||||
pub fn generate_autoconf_rust_file(out_dir: impl AsRef<Path>, cfg: &Config) -> io::Result<()> {
|
||||
let out_dir = out_dir.as_ref();
|
||||
let mut autoconf_file_string = String::new();
|
||||
let version = env!("CARGO_PKG_VERSION");
|
||||
let name = env!("CARGO_PKG_NAME");
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"// This file was auto-generated by {} v{}\n",
|
||||
name, version
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::CONN_RXQUEUE_LEN,
|
||||
cfg.conn_rx_queue_len
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::QFIFO_LEN,
|
||||
cfg.qfifo_len
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::PORT_MAX_BIND,
|
||||
cfg.port_max_bind
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::CONN_MAX,
|
||||
cfg.conn_max
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::BUFFER_SIZE,
|
||||
cfg.buffer_size
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::RDP_MAX_WINDOW,
|
||||
cfg.rdp_max_window
|
||||
));
|
||||
autoconf_file_string.push_str(&format!(
|
||||
"pub const {}: usize = {};\n",
|
||||
cfg_keys::RTABLE_SIZE,
|
||||
cfg.rtable_size
|
||||
));
|
||||
let out_file = out_dir.join("autoconfig.rs");
|
||||
let mut file = std::fs::File::create(out_file)?;
|
||||
file.write_all(autoconf_file_string.as_bytes())?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
// TODO: Unittest autoconf generators.
|
||||
}
|
Reference in New Issue
Block a user