rust/libcsp-rust
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Compare commits

merge into: rust:main
Branches Tags
rust:main
rust:bak
rust:libcsp-cargo-build-v0.2.0
rust:libcsp-v0.1.3
rust:libcsp-sys-v0.1.1
rust:libcsp-v0.1.2
rust:libcsp-v0.1.1
rust:libcsp-v0.1.0
rust:libcsp-sys-v0.1.0
...
pull from: rust:bak
Branches Tags
rust:main
rust:bak
rust:libcsp-cargo-build-v0.2.0
rust:libcsp-v0.1.3
rust:libcsp-sys-v0.1.1
rust:libcsp-v0.1.2
rust:libcsp-v0.1.1
rust:libcsp-v0.1.0
rust:libcsp-sys-v0.1.0

No commits in common. "main" and "bak" have entirely different histories.
main ... bak

28 changed files with 312 additions and 346 deletions
Show Stats Expand all files Collapse all files

25
CHANGELOG.md
View File

@ -1,25 +0,0 @@
Change Log
=======
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
# [unreleased]
# [v0.1.3] 2024-06-01
Fixed documentation build.
# [v0.1.2] 2024-06-01
Restructured crate to be the root package of a workspace.
# [v0.1.1] 2024-06-01
Possible bugfix with dependency resolver not being able to select the correct `-sys` crate.
# [v0.1.0] 2024-06-01
Initial release

47
Cargo.lock generated
View File

@ -4,15 +4,15 @@ version = 3
[[package]] [[package]]
name = "bitflags" name = "bitflags"
version = "2.6.0" version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de" checksum = "cf4b9d6a944f767f8e5e0db018570623c85f3d925ac718db4e06d0187adb21c1"
[[package]] [[package]]
name = "cc" name = "cc"
version = "1.1.5" version = "1.0.98"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "324c74f2155653c90b04f25b2a47a8a631360cb908f92a772695f430c7e31052" checksum = "41c270e7540d725e65ac7f1b212ac8ce349719624d7bcff99f8e2e488e8cf03f"
[[package]] [[package]]
name = "equivalent" name = "equivalent"
@ -44,7 +44,7 @@ checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c"
[[package]] [[package]]
name = "libcsp" name = "libcsp"
version = "0.1.3" version = "0.1.0"
dependencies = [ dependencies = [
"bitflags", "bitflags",
"libc", "libc",
@ -54,10 +54,9 @@ dependencies = [
[[package]] [[package]]
name = "libcsp-cargo-build" name = "libcsp-cargo-build"
version = "0.2.0" version = "0.1.0"
dependencies = [ dependencies = [
"cc", "cc",
"thiserror",
] ]
[[package]] [[package]]
@ -70,16 +69,16 @@ dependencies = [
[[package]] [[package]]
name = "libcsp-sys" name = "libcsp-sys"
version = "0.1.1" version = "0.1.0"
dependencies = [ dependencies = [
"libc", "libc",
] ]
[[package]] [[package]]
name = "memchr" name = "memchr"
version = "2.7.4" version = "2.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" checksum = "6c8640c5d730cb13ebd907d8d04b52f55ac9a2eec55b440c8892f40d56c76c1d"
[[package]] [[package]]
name = "num_enum" name = "num_enum"
@ -113,9 +112,9 @@ dependencies = [
[[package]] [[package]]
name = "proc-macro2" name = "proc-macro2"
version = "1.0.86" version = "1.0.84"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77" checksum = "ec96c6a92621310b51366f1e28d05ef11489516e93be030060e5fc12024a49d6"
dependencies = [ dependencies = [
"unicode-ident", "unicode-ident",
] ]
@ -131,35 +130,15 @@ dependencies = [
[[package]] [[package]]
name = "syn" name = "syn"
version = "2.0.71" version = "2.0.66"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b146dcf730474b4bcd16c311627b31ede9ab149045db4d6088b3becaea046462" checksum = "c42f3f41a2de00b01c0aaad383c5a45241efc8b2d1eda5661812fda5f3cdcff5"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
"unicode-ident", "unicode-ident",
] ]
[[package]]
name = "thiserror"
version = "1.0.62"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2675633b1499176c2dff06b0856a27976a8f9d436737b4cf4f312d4d91d8bbb"
dependencies = [
"thiserror-impl",
]
[[package]]
name = "thiserror-impl"
version = "1.0.62"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d20468752b09f49e909e55a5d338caa8bedf615594e9d80bc4c565d30faf798c"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]] [[package]]
name = "toml_datetime" name = "toml_datetime"
version = "0.6.6" version = "0.6.6"

23
Cargo.toml
View File

@ -1,26 +1,5 @@
[workspace] [workspace]
members = [ members = [
"libcsp-cargo-build", "libcsp-cargo-build", "libcsp", "libcsp-sys", "examples"
"examples"
] ]
default-members = ["examples"]
resolver = "2" resolver = "2"
[package]
name = "libcsp"
version = "0.1.3"
edition = "2021"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
description = "Safe and ergonomic Rust API for libcsp on top on libcsp-sys"
homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
repository = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
license = "Apache-2.0"
keywords = ["no-std", "space", "aerospace", "ffi", "csp"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
categories = ["aerospace", "external-ffi-bindings", "no-std", "hardware-support", "embedded"]
[dependencies]
bitflags = "2"
num_enum = "0.7"
libc = "0.2"
libcsp-sys = { version = "0.1", path = "libcsp-sys" }

20
README.md
View File

@ -1,6 +1,3 @@
[![Crates.io](https://img.shields.io/crates/v/libcsp)](https://crates.io/crates/libcsp)
[![docs.rs](https://img.shields.io/docsrs/libcsp)](https://docs.rs/libcsp)
libcsp-rust libcsp-rust
========= =========
@ -9,10 +6,10 @@ the [`libcsp`](https://github.com/libcsp/libcsp) C library in your Rust project.
It provides 3 crates for this: It provides 3 crates for this:
- [`libcsp`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main) - [`libcsp`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-rust)
provides a safe and ergonomic Rust interface on top of the `libcsp-sys` crate. provides a safe and ergonomic Rust interface on top of the `libcsp-sys` crate.
- [`libcsp-sys`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-sys) - [`libcsp-sys`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-sys)
provides the Rust bindings to [`libcsp`](https://github.com/libcsp/libcsp). provides the Rust bindings to `libcsp`.
- [`libcsp-cargo-build`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-cargo-build) - [`libcsp-cargo-build`](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/libcsp-cargo-build)
provides an API to build the `libcsp` using `cargo` with the [`cc`](https://docs.rs/cc/latest/cc/) crate. provides an API to build the `libcsp` using `cargo` with the [`cc`](https://docs.rs/cc/latest/cc/) crate.
@ -20,10 +17,6 @@ In addition, it provides a workspace to allow updating the `libcsp` C sources an
bindings more easily inside the `clib` directory. Some of the examples `libcsp` provides were ported bindings more easily inside the `clib` directory. Some of the examples `libcsp` provides were ported
to Rust and are showcased in the `examples` directory. to Rust and are showcased in the `examples` directory.
Please note that this is early-stage/experimental software. Important features might be missing.
PRs and improvement suggestions are welcome! This project was primarily tested on a Linux/POSIX
system so far.
## How it works ## How it works
We assume that cargo should also take care of building the library. We assume that cargo should also take care of building the library.
@ -37,8 +30,7 @@ We assume that cargo should also take care of building the library.
the `libcsp` C library. the `libcsp` C library.
It is recommended to have a look at the [example build script](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/build.rs) It is recommended to have a look at the [example build script](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/build.rs)
which should give you a general idea of how a build script which does the 4 steps above might look which should give you a general idea of how a build script might look like to integrate `libcsp`.
like.
## Running the example ## Running the example
@ -48,7 +40,7 @@ in Rust. You can run the example using the following steps:
1. Clone/Copy `libcsp` into the `lib` folder, for example by using the provided `lib/clone-csp.sh` 1. Clone/Copy `libcsp` into the `lib` folder, for example by using the provided `lib/clone-csp.sh`
script or adding `libcsp` as a git submodule. script or adding `libcsp` as a git submodule.
2. You can now use `cargo run` to run the server/client example. 2. You can now use `cargo run -p libcsp-rust-examples` to run the server/client example.
## Compile-time configuration of the `libcsp-sys` library ## Compile-time configuration of the `libcsp-sys` library
@ -59,8 +51,8 @@ The user has to provide the path to a directory containing this `autoconfig.rs`
`CSP_CONFIG_DIR` environmental variable. `CSP_CONFIG_DIR` environmental variable.
You can automatically generate this file when using `libcsp-cargo-build` by using the You can automatically generate this file when using `libcsp-cargo-build` by using the
[`generate_autoconf_rust_file`](https://docs.rs/libcsp-cargo-build/latest/libcsp_cargo_build/fn.generate_autoconf_rust_file.html) [`generate_autoconf_rust_file`](here be link soon) method of the Builder object as done in the
method of the Builder object as done in the example build script. example build script.
In this workspace, the `CSP_CONFIG_DIR` variable is hardcoded using the following `.cargo/config.toml` In this workspace, the `CSP_CONFIG_DIR` variable is hardcoded using the following `.cargo/config.toml`
configuration: configuration:

8
clib/bindings.rs
View File

@ -343,9 +343,9 @@ pub const CSP_DBG_ETH_ERR_RX_OUT: u32 = 3;
pub const CSP_DBG_ETH_ERR_SHORT_BEGIN: u32 = 4; pub const CSP_DBG_ETH_ERR_SHORT_BEGIN: u32 = 4;
pub const CSP_DBG_ETH_ERR_INCOMPLETE: u32 = 5; pub const CSP_DBG_ETH_ERR_INCOMPLETE: u32 = 5;
pub const CSP_DBG_ETH_ERR_UNKNOWN: u32 = 6; pub const CSP_DBG_ETH_ERR_UNKNOWN: u32 = 6;
pub const __bool_true_false_are_defined: u32 = 1;
pub const true_: u32 = 1; pub const true_: u32 = 1;
pub const false_: u32 = 0; pub const false_: u32 = 0;
pub const __bool_true_false_are_defined: u32 = 1;
pub const CSP_QUEUE_OK: u32 = 0; pub const CSP_QUEUE_OK: u32 = 0;
pub const CSP_QUEUE_ERROR: i32 = -1; pub const CSP_QUEUE_ERROR: i32 = -1;
pub const CSP_ANY: u32 = 255; pub const CSP_ANY: u32 = 255;
@ -2411,11 +2411,7 @@ extern "C" {
) -> ::core::ffi::c_int; ) -> ::core::ffi::c_int;
} }
extern "C" { extern "C" {
pub fn bcopy( pub fn bcopy(__src: *const ::core::ffi::c_void, __dest: *mut ::core::ffi::c_void, __n: usize);
__src: *const ::core::ffi::c_void,
__dest: *mut ::core::ffi::c_void,
__n: ::core::ffi::c_ulong,
);
} }
extern "C" { extern "C" {
pub fn bzero(__s: *mut ::core::ffi::c_void, __n: ::core::ffi::c_ulong); pub fn bzero(__s: *mut ::core::ffi::c_void, __n: ::core::ffi::c_ulong);

2
clib/cfg/csp/autoconfig.h
View File

@ -1,4 +1,4 @@
// This file was auto-generated by libcsp-cargo-build v0.2.0 // This file was auto-generated by libcsp-cargo-build v0.1.0
#define CSP_POSIX 1 #define CSP_POSIX 1
#define CSP_ZEPHYR 0 #define CSP_ZEPHYR 0

1
clib/clone-csp.sh
View File

@ -1,4 +1,3 @@
#!/bin/bash #!/bin/bash
git clone https://github.com/us-irs/libcsp.git git clone https://github.com/us-irs/libcsp.git
cd libcsp
git checkout const-correctness git checkout const-correctness

6
examples/Cargo.toml
View File

@ -4,9 +4,7 @@ version = "0.1.0"
edition = "2021" edition = "2021"
[dependencies] [dependencies]
# Must use local verion here, otherwise there will be multiple versions of `libcsp-sys`, and libcsp = { path = "../libcsp" }
# cargo can not deal with this due to the link section.
libcsp = { version = "0.1", path = ".." }
[build-dependencies] [build-dependencies]
libcsp-cargo-build = { version = "0.2", path = "../libcsp-cargo-build" } libcsp-cargo-build = { path = "../libcsp-cargo-build" }

2
examples/autoconfig.h
View File

@ -1,4 +1,4 @@
// This file was auto-generated by libcsp-cargo-build v0.2.0 // This file was auto-generated by libcsp-cargo-build v0.1.0
#define CSP_POSIX 1 #define CSP_POSIX 1
#define CSP_ZEPHYR 0 #define CSP_ZEPHYR 0

2
examples/autoconfig.rs
View File

@ -1,4 +1,4 @@
// This file was auto-generated by libcsp-cargo-build v0.2.0 // This file was auto-generated by libcsp-cargo-build v0.1.0
pub const CSP_CONN_RXQUEUE_LEN: usize = 16; pub const CSP_CONN_RXQUEUE_LEN: usize = 16;
pub const CSP_QFIFO_LEN: usize = 16; pub const CSP_QFIFO_LEN: usize = 16;
pub const CSP_PORT_MAX_BIND: usize = 16; pub const CSP_PORT_MAX_BIND: usize = 16;

3
examples/build.rs
View File

@ -11,8 +11,7 @@ fn main() {
// This helper structure will take care of the majority of work to compile libcsp using the // This helper structure will take care of the majority of work to compile libcsp using the
// cc crate. // cc crate.
let mut csp_builder = Builder::new(PathBuf::from(libcsp_path), PathBuf::from(&out_dir)) let mut csp_builder = Builder::new(PathBuf::from(libcsp_path), PathBuf::from(&out_dir));
.expect("creating libcsp builder failed");
// A lot of spam we are not interested in usually. // A lot of spam we are not interested in usually.
csp_builder.compiler_warnings = false; csp_builder.compiler_warnings = false;

17
libcsp-cargo-build/CHANGELOG.md
View File

@ -1,17 +0,0 @@
Change Log
=======
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
# [unreleased]
# [v0.2.0] 2024-06-01
Added basic sanity checks for the user-provided `libcsp` location.
# [v0.1.0] 2024-06-01
Initial release

3
libcsp-cargo-build/Cargo.toml
View File

@ -1,6 +1,6 @@
[package] [package]
name = "libcsp-cargo-build" name = "libcsp-cargo-build"
version = "0.2.0" version = "0.1.0"
edition = "2021" edition = "2021"
description = "Tools to build libcsp using cargo" description = "Tools to build libcsp using cargo"
homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust" homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
@ -12,4 +12,3 @@ categories = ["aerospace", "external-ffi-bindings", "no-std", "hardware-support"
[dependencies] [dependencies]
cc = "1" cc = "1"
thiserror = "1"

3
libcsp-cargo-build/README.md
View File

@ -1,6 +1,3 @@
[![Crates.io](https://img.shields.io/crates/v/libcsp-cargo-build)](https://crates.io/crates/libcsp-cargo-build)
[![docs.rs](https://img.shields.io/docsrs/libcsp-cargo-build)](https://docs.rs/libcsp-cargo-build)
libcsp-cargo-build libcsp-cargo-build
======== ========

22
libcsp-cargo-build/release-checklist.md
View File

@ -1,22 +0,0 @@
Checklist for new releases
=======
# Pre-Release
1. Make sure any new modules are documented sufficiently enough and check docs with
`cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --open`.
2. Bump version specifier in `Cargo.toml`.
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
`unreleased` section.
4. Run `cargo test --all-features` or `cargo nextest r --all-features`.
5. Run `cargo fmt` and `cargo clippy`.
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
targets.
# Release
1. `cargo publish`
# Post-Release
1. Create a new release on `EGit` based on the release branch.

30
libcsp-cargo-build/src/lib.rs
View File

@ -133,34 +133,12 @@ pub struct Builder {
build: cc::Build, build: cc::Build,
} }
#[derive(Debug, Copy, Clone, PartialEq, Eq, thiserror::Error)]
pub enum BuildCreationError {
#[error("The specified libcsp path does not exist")]
PathDoesNotExist,
#[error("The specified libcsp path does not have the expected format of the library")]
InvalidLibcspFormat,
}
impl Builder { impl Builder {
/// Create a new builder instance. Returns [BuildCreationError] if the specified libcsp path /// Create a new builder instance.
/// does not exist or does not have the expected format. pub fn new(libcsp_path: PathBuf, out_dir: PathBuf) -> Self {
pub fn new(libcsp_path: PathBuf, out_dir: PathBuf) -> Result<Self, BuildCreationError> {
// Basic sanity checks for the passed libcsp path.
if !libcsp_path.exists() {
return Err(BuildCreationError::PathDoesNotExist);
}
if !libcsp_path
.join("include")
.join("csp")
.join("csp.h")
.exists()
{
return Err(BuildCreationError::InvalidLibcspFormat);
}
let mut libcsp_src_path_base = libcsp_path.clone(); let mut libcsp_src_path_base = libcsp_path.clone();
libcsp_src_path_base.push("src"); libcsp_src_path_base.push("src");
Ok(Self { Self {
generate_autoconf_file: true, generate_autoconf_file: true,
libcsp_path, libcsp_path,
libcsp_src_path_base, libcsp_src_path_base,
@ -168,7 +146,7 @@ impl Builder {
cfg: Default::default(), cfg: Default::default(),
compiler_warnings: true, compiler_warnings: true,
build: Default::default(), build: Default::default(),
}) }
} }
/// Access to the underlying [cc::Build] builder object. /// Access to the underlying [cc::Build] builder object.

17
libcsp-sys/CHANGELOG.md
View File

@ -1,17 +0,0 @@
Change Log
=======
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
# [unreleased]
# [v0.1.1] 2024-06-01
Try to fix the documentation build.
# [v0.1.0] 2024-06-01
Initial release

5
libcsp-sys/Cargo.toml
View File

@ -1,6 +1,6 @@
[package] [package]
name = "libcsp-sys" name = "libcsp-sys"
version = "0.1.1" version = "0.1.0"
edition = "2021" edition = "2021"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"] authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
description = "FFI bindings for libcsp" description = "FFI bindings for libcsp"
@ -14,6 +14,3 @@ links = "csp"
[dependencies] [dependencies]
libc = "0.2" libc = "0.2"
[package.metadata.docs.rs]
rustdoc-args = ["--cfg", "docs_rs"]

17
libcsp-sys/README.md
View File

@ -1,6 +1,3 @@
[![Crates.io](https://img.shields.io/crates/v/libcsp-sys)](https://crates.io/crates/libcsp-sys)
[![docs.rs](https://img.shields.io/docsrs/libcsp-sys)](https://docs.rs/libcsp-sys)
libcsp-sys libcsp-sys
======== ========
@ -22,17 +19,3 @@ The user has to provide the path to a directory containing this `autoconfig.rs`
It is recommended to read the [main workspace README](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust) It is recommended to read the [main workspace README](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust)
for more information to make the generation and specification of this auto-configuration file for more information to make the generation and specification of this auto-configuration file
as conveniently and easy as possible. as conveniently and easy as possible.
## Run unittests
Running unittests required the `RUN_TESTS` environmental variable to be set to 1. This is because
the actual `libcsp` library might be built and linked in a separate crate, so the linker is not
able to process `-l csp` when running the tests.
You can use
```sh
RUN_TESTS=1 cargo test
```
to run the unittests.

38
libcsp-sys/build.rs
View File

@ -1,38 +1,20 @@
use std::{env, path::PathBuf}; use std::{env, path::PathBuf};
pub const ENV_KEY_CSP_CONFIG_DIR: &str = "CSP_CONFIG_DIR"; pub const ENV_KEY_CSP_CONFIG_DIR: &str = "CSP_CONFIG_DIR";
pub const ENV_KEY_TEST: &str = "RUN_TESTS";
fn main() { fn main() {
// libcsp is built in a separate project, so linking it for tests will fail. println!("cargo:rustc-link-lib=csp");
// For tests, we do not want to have the link directive to csp.
let run_tests = if let Ok(val) = env::var(ENV_KEY_TEST) {
val == "1"
} else {
false
};
if !run_tests {
println!("cargo:rustc-link-lib=csp");
}
let mut csp_conf_path = if std::env::var("DOCS_RS").is_ok() {
PathBuf::from("./templates")
} else {
match env::var(ENV_KEY_CSP_CONFIG_DIR) {
Ok(conf_path) => conf_path.into(),
Err(_e) => {
println!(
"cargo:warning={} not set, using CARGO_MANIFEST_DIR to search for autoconfig.rs",
ENV_KEY_CSP_CONFIG_DIR
);
env::var("CARGO_MANIFEST_DIR")
.expect("CARGO_MANIFEST_DIR not set")
.into()
}
}
};
let out_path = env::var("OUT_DIR").unwrap(); let out_path = env::var("OUT_DIR").unwrap();
let csp_conf_dir = match env::var("CSP_CONFIG_DIR") {
Ok(conf_path) => conf_path,
Err(_e) => {
println!("cargo:warning=CSP_CONFIG_DIR not set, using CARGO_MANIFEST_DIR to search for autoconfig.rs");
env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR not set")
}
};
let mut csp_conf_path = PathBuf::new();
csp_conf_path.push(csp_conf_dir);
csp_conf_path.push("autoconfig.rs"); csp_conf_path.push("autoconfig.rs");
if !csp_conf_path.exists() { if !csp_conf_path.exists() {
panic!( panic!(

22
libcsp-sys/release-checklist.md
View File

@ -1,22 +0,0 @@
Checklist for new releases
=======
# Pre-Release
1. Make sure any new modules are documented sufficiently enough and check docs with
`cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --open`.
2. Bump version specifier in `Cargo.toml`.
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
`unreleased` section.
4. Run `cargo test --all-features` or `cargo nextest r --all-features`.
5. Run `cargo fmt` and `cargo clippy`.
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
targets.
# Release
1. `cargo publish`
# Post-Release
1. Create a new release on `EGit` based on the release branch.

75
libcsp-sys/src/lib.rs
View File

@ -14,14 +14,10 @@
//! [here](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/autoconfig.rs). //! [here](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/autoconfig.rs).
//! The user has to provide the path to a directory containing this `autoconfig.rs` file using the //! The user has to provide the path to a directory containing this `autoconfig.rs` file using the
//! `CSP_CONFIG_DIR` environmental variable. //! `CSP_CONFIG_DIR` environmental variable.
#![no_std]
#![cfg_attr(docs_rs, feature(doc_auto_cfg))]
#![allow(non_upper_case_globals)] #![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)] #![allow(non_camel_case_types)]
#![allow(non_snake_case)] #![allow(non_snake_case)]
pub mod config;
// This file will be created by the build script by copying a user-provided file to the output // This file will be created by the build script by copying a user-provided file to the output
// directory. It contains important compile time constants. Compilation of the library is not // directory. It contains important compile time constants. Compilation of the library is not
// possible without these constants. // possible without these constants.
@ -483,7 +479,7 @@ extern "C" {
pub fn csp_buffer_get(unused: usize) -> *mut csp_packet_t; pub fn csp_buffer_get(unused: usize) -> *mut csp_packet_t;
#[doc = " Free buffer (from task context).\n\n @param[in] buffer buffer to free. NULL is handled gracefully."] #[doc = " Free buffer (from task context).\n\n @param[in] buffer buffer to free. NULL is handled gracefully."]
pub fn csp_buffer_free(buffer: *const ::core::ffi::c_void); pub fn csp_buffer_free(buffer: *mut ::core::ffi::c_void);
#[doc = " Print connection table to stdout."] #[doc = " Print connection table to stdout."]
pub fn csp_conn_print_table(); pub fn csp_conn_print_table();
@ -551,7 +547,8 @@ pub mod hooks {
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use core::mem::{align_of, size_of, MaybeUninit}; use core::mem::{align_of, size_of};
use std::mem::MaybeUninit;
#[test] #[test]
fn bindgen_test_layout_csp_timestamp_t() { fn bindgen_test_layout_csp_timestamp_t() {
@ -563,12 +560,12 @@ mod tests {
concat!("Size of: ", stringify!(csp_timestamp_t)) concat!("Size of: ", stringify!(csp_timestamp_t))
); );
assert_eq!( assert_eq!(
core::mem::align_of::<csp_timestamp_t>(), std::mem::align_of::<csp_timestamp_t>(),
4usize, 4usize,
concat!("Alignment of ", stringify!(csp_timestamp_t)) concat!("Alignment of ", stringify!(csp_timestamp_t))
); );
assert_eq!( assert_eq!(
unsafe { ::core::ptr::addr_of!((*ptr).tv_sec) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).tv_sec) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -578,7 +575,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { ::core::ptr::addr_of!((*ptr).tv_nsec) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).tv_nsec) as usize - ptr as usize },
4usize, 4usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -604,7 +601,7 @@ mod tests {
concat!("Alignment of ", stringify!(__packed)) concat!("Alignment of ", stringify!(__packed))
); );
assert_eq!( assert_eq!(
unsafe { ::core::ptr::addr_of!((*ptr).pri) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).pri) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -614,7 +611,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).flags) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).flags) as usize - ptr as usize },
1usize, 1usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -624,7 +621,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).src) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).src) as usize - ptr as usize },
2usize, 2usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -634,7 +631,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).dst) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).dst) as usize - ptr as usize },
4usize, 4usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -644,7 +641,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).dport) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).dport) as usize - ptr as usize },
6usize, 6usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -654,7 +651,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).sport) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).sport) as usize - ptr as usize },
7usize, 7usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -686,7 +683,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).rdp_quarantine) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).rdp_quarantine) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -696,7 +693,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).timestamp_tx) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).timestamp_tx) as usize - ptr as usize },
4usize, 4usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -706,7 +703,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).timestamp_rx) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).timestamp_rx) as usize - ptr as usize },
8usize, 8usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -716,7 +713,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).conn) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).conn) as usize - ptr as usize },
16usize, 16usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -748,7 +745,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).rx_count) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).rx_count) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -758,7 +755,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).remain) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).remain) as usize - ptr as usize },
2usize, 2usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -768,7 +765,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).cfpid) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).cfpid) as usize - ptr as usize },
4usize, 4usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -778,7 +775,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).last_used) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).last_used) as usize - ptr as usize },
8usize, 8usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -788,7 +785,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).frame_begin) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).frame_begin) as usize - ptr as usize },
16usize, 16usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -798,7 +795,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).frame_length) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).frame_length) as usize - ptr as usize },
24usize, 24usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -837,7 +834,7 @@ mod tests {
concat!("Alignment of ", stringify!(csp_packet_s__bindgen_ty_2)) concat!("Alignment of ", stringify!(csp_packet_s__bindgen_ty_2))
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).data) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).data) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -847,7 +844,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).data16) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).data16) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -857,7 +854,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).data32) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).data32) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -882,7 +879,7 @@ mod tests {
concat!("Alignment of ", stringify!(csp_packet_s)) concat!("Alignment of ", stringify!(csp_packet_s))
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).length) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).length) as usize - ptr as usize },
32usize, 32usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -892,7 +889,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).id) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).id) as usize - ptr as usize },
34usize, 34usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -902,7 +899,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).next) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).next) as usize - ptr as usize },
48usize, 48usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -912,7 +909,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).header) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).header) as usize - ptr as usize },
56usize, 56usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -925,20 +922,20 @@ mod tests {
#[test] #[test]
fn bindgen_test_layout_csp_socket_s() { fn bindgen_test_layout_csp_socket_s() {
const UNINIT: core::mem::MaybeUninit<csp_socket_s> = core::mem::MaybeUninit::uninit(); const UNINIT: ::std::mem::MaybeUninit<csp_socket_s> = ::std::mem::MaybeUninit::uninit();
let ptr = UNINIT.as_ptr(); let ptr = UNINIT.as_ptr();
assert_eq!( assert_eq!(
core::mem::size_of::<csp_socket_s>(), ::std::mem::size_of::<csp_socket_s>(),
152usize, 152usize,
concat!("Size of: ", stringify!(csp_socket_s)) concat!("Size of: ", stringify!(csp_socket_s))
); );
assert_eq!( assert_eq!(
core::mem::align_of::<csp_socket_s>(), ::std::mem::align_of::<csp_socket_s>(),
8usize, 8usize,
concat!("Alignment of ", stringify!(csp_socket_s)) concat!("Alignment of ", stringify!(csp_socket_s))
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).rx_queue) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).rx_queue) as usize - ptr as usize },
0usize, 0usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -948,7 +945,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).rx_queue_static) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).rx_queue_static) as usize - ptr as usize },
8usize, 8usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -958,7 +955,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).rx_queue_static_data) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).rx_queue_static_data) as usize - ptr as usize },
16usize, 16usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",
@ -968,7 +965,7 @@ mod tests {
) )
); );
assert_eq!( assert_eq!(
unsafe { core::ptr::addr_of!((*ptr).opts) as usize - ptr as usize }, unsafe { ::std::ptr::addr_of!((*ptr).opts) as usize - ptr as usize },
144usize, 144usize,
concat!( concat!(
"Offset of field: ", "Offset of field: ",

18
libcsp/Cargo.toml Normal file
View File

@ -0,0 +1,18 @@
[package]
name = "libcsp"
version = "0.1.0"
edition = "2021"
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
description = "Safe and ergonomic Rust API for libcsp on top on libcsp-sys"
homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
repository = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
license = "Apache-2.0"
keywords = ["no-std", "space", "aerospace", "ffi", "csp"]
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
categories = ["aerospace", "external-ffi-bindings", "no-std", "hardware-support", "embedded"]
[dependencies]
bitflags = "2"
num_enum = "0.7"
libc = "0.2"
libcsp-sys = { path = "../libcsp-sys" }

201
libcsp/LICENSE-APACHE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

1
libcsp/NOTICE Normal file
View File

@ -0,0 +1 @@
This software contains code developed at the University of Stuttgart's Institute of Space Systems.

11
libcsp/README.md Normal file
View File

@ -0,0 +1,11 @@
libcsp-rust
========
This crate provides a (mostly) safe and ergonomic Rust API for the
[`libcsp` library](https://github.com/libcsp/libcsp) on top of the
[`libcsp-sys`](https://crates.io/crates/libcsp-sys) crate.
You can find some more high-level information and examples in the
[main repository](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
The API documentation should provide all additional information required to use this library.

17
src/lib.rs → libcsp/src/lib.rs
View File

@ -398,21 +398,6 @@ pub fn csp_accept(socket: &mut CspSocket, timeout: Duration) -> Option<CspConnRe
})) }))
} }
/// Rust wrapper for [ffi::csp_socket_close] which returns the result code directly.
pub fn csp_socket_close_raw(sock: &mut CspSocket) -> i32 {
unsafe { ffi::csp_socket_close(&mut sock.0) }
}
/// Rust wrapper for [ffi::csp_socket_close].
///
/// This function will panic if the error code returned from [ffi::csp_socket_close] is not one of
/// [CspError]. [csp_socket_close_raw] can be used if this is not acceptable.
pub fn csp_socket_close(sock: &mut CspSocket) -> Result<(), CspError> {
let result = unsafe { ffi::csp_socket_close(&mut sock.0) };
Err(CspError::try_from(result)
.unwrap_or_else(|_| panic!("unexpected error value {} from csp_socket_close", result)))
}
/// Rust wrapper for [ffi::csp_read]. /// Rust wrapper for [ffi::csp_read].
pub fn csp_read(conn: &mut CspConnRef, timeout: Duration) -> Option<CspPacketRef> { pub fn csp_read(conn: &mut CspConnRef, timeout: Duration) -> Option<CspPacketRef> {
let timeout_millis = timeout.as_millis(); let timeout_millis = timeout.as_millis();
@ -604,7 +589,7 @@ pub fn csp_conn_print_table() {
pub fn csp_buffer_free(packet: impl Into<CspPacketRef>) { pub fn csp_buffer_free(packet: impl Into<CspPacketRef>) {
// SAFETY: FFI call and the Rust type system actually ensure the correct type // SAFETY: FFI call and the Rust type system actually ensure the correct type
// is free'd here, while also taking the packet by value. // is free'd here, while also taking the packet by value.
unsafe { ffi::csp_buffer_free(packet.into().0 as *const libc::c_void) } unsafe { ffi::csp_buffer_free(packet.into().0 as *mut libc::c_void) }
} }
/// Rust wrapper for [ffi::csp_transaction_persistent]. /// Rust wrapper for [ffi::csp_transaction_persistent].

22
release-checklist.md
View File

@ -1,22 +0,0 @@
Checklist for new releases
=======
# Pre-Release
1. Make sure any new modules are documented sufficiently enough and check docs with
`cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --open`.
2. Bump version specifier in `Cargo.toml`.
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
`unreleased` section.
4. Run `cargo test --all-features` or `cargo nextest r --all-features`.
5. Run `cargo fmt` and `cargo clippy`.
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
targets.
# Release
1. `cargo publish`
# Post-Release
1. Create a new release on `EGit` based on the release branch.