Merge #291

291: Add the `libtock2` crate. r=hudson-ayers a=jrvanwhy

`libtock2` is the "one stop shop" for using `libtock-rs`. It is intended to be easy to use and will provide everything needed to create a `libtock-rs` process binary. However, in order to be easy to use, it will not support unit testing, as described in the [Overview](https://github.com/tock/libtock-rs/tree/master/doc/Overview.md) doc.

`make test` contained several commands that tested `libtock_runtime` specifically. I reworked those commands so they test `libtock2` as well. The new structure uses only exclusion lists to select crates, which means they will never miss newly-added crates.

Co-authored-by: Johnathan Van Why <[email protected]>

Author: bors[bot]

.github/workflows/mac-os.yml

@@ -24,5 +24,5 @@ jobs:
       - name: Build and Test
         run: |
           cd "${GITHUB_WORKSPACE}"
-          LIBTOCK_PLATFORM=nrf52 cargo build -p libtock_runtime \
+          LIBTOCK_PLATFORM=nrf52 cargo build -p libtock2 \
             --target=thumbv7em-none-eabi

Cargo.toml

@@ -86,6 +86,7 @@ exclude = [ "tock" ]
 members = [
     "codegen",
     "core",
+    "libtock2",
     "platform",
     "runtime",
     "test_runner",

Makefile

@@ -86,17 +86,30 @@ examples:
 
 # Arguments to pass to cargo to exclude libtock_runtime and crates that depend
 # on libtock_runtime. Used when we need to build a crate for the host OS, as
-# libtock_runtime only suppors running on Tock.
-EXCLUDE_RUNTIME := --exclude libtock_runtime
+# libtock_runtime only supports running on Tock.
+EXCLUDE_RUNTIME := --exclude libtock2 --exclude libtock_runtime
+
+# Arguments to pass to cargo to exclude `std` and crates that depend on it. Used
+# when we build a crate for an embedded target, as those targets lack `std`.
+EXCLUDE_STD := --exclude libtock_unittest --exclude print_sizes --exclude test_runner
 
 .PHONY: test
 test: examples test-qemu-hifive
-	# TODO: Remove the libtock_runtime build when we have a code example for the
-	# 2.0 crates.
-	LIBTOCK_PLATFORM=nrf52 cargo build --release --target=thumbv7em-none-eabi -p libtock_runtime
+	# TODO: When we have a working embedded test harness, change the libtock2
+	# builds to --all-targets rather than --examples.
+	# Build libtock2 on both a RISC-V target and an ARM target. We pick
+	# opentitan as the RISC-V target because it lacks atomics.
+	LIBTOCK_PLATFORM=opentitan cargo build --examples --release \
+		--target=riscv32imc-unknown-none-elf -p libtock2
+	LIBTOCK_PLATFORM=nrf52 cargo build --examples --release \
+		--target=thumbv7em-none-eabi -p libtock2
 	LIBTOCK_PLATFORM=nrf52 PLATFORM=nrf52 cargo fmt --all -- --check
-	PLATFORM=nrf52 cargo clippy --all-targets --exclude libtock_runtime --workspace
-	LIBTOCK_PLATFORM=hifive1 cargo clippy --target=riscv32imac-unknown-none-elf -p libtock_runtime
+	PLATFORM=nrf52 cargo clippy --all-targets $(EXCLUDE_RUNTIME) --workspace
+	# TODO: Add a clippy invocation for an ARM platform, once the Tock 1.0
+	# crates are removed. It is omitted because the Tock 1.0 crates don't
+	# currently pass clippy on ARM.
+	LIBTOCK_PLATFORM=hifive1 PLATFORM=hifive1 cargo clippy $(EXCLUDE_STD) \
+		--target=riscv32imac-unknown-none-elf --workspace
 	PLATFORM=nrf52 cargo miri test $(EXCLUDE_RUNTIME) --workspace
 	MIRIFLAGS="-Zmiri-symbolic-alignment-check -Zmiri-track-raw-pointers" \
 		PLATFORM=nrf52 cargo miri test $(EXCLUDE_RUNTIME) --workspace

libtock2/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+authors = ["Tock Project Developers <[email protected]>"]
+categories = ["embedded", "no-std", "os"]
+description = """Tock Rust userspace library collection. Provides all the \
+                 tools needed to create a Tock Rust process binary."""
+edition = "2018"
+license = "Apache-2.0 OR MIT"
+name = "libtock2"
+repository = "https://www.github.com/tock/libtock-rs"
+version = "0.1.0"
+
+[dependencies]
+libtock_platform = { path = "../platform" }
+libtock_runtime = { path = "../runtime" }

libtock2/src/lib.rs

@@ -0,0 +1,5 @@
+#![forbid(unsafe_code)]
+#![no_std]
+
+pub use libtock_platform as platform;
+pub use libtock_runtime as runtime;