Merge branch 'main' into issues/4340

Author: sanstzu

.github/workflows/ci.yaml

@@ -6,8 +6,12 @@ on:
     types: [opened, synchronize, reopened]
 
 env:
+  CARGO_TERM_COLOR: always
   CARGO_TERM_VERBOSE: true
   LIBC_CI: 1
+  RUSTDOCFLAGS: -Dwarnings
+  RUSTFLAGS: -Dwarnings
+  RUST_BACKTRACE: full
 
 defaults:
   run:
@@ -41,6 +45,12 @@ jobs:
       TOOLCHAIN: ${{ matrix.toolchain }}
     steps:
       - uses: actions/checkout@v4
+      # Remove `-Dwarnings` at the MSRV since lints may be different or buffier
+      - name: Update RUSTFLAGS
+        run: |
+          set -eux
+          [ "${{ matrix.toolchain }}" = "1.63.0" ] && echo 'RUSTFLAGS=' >> "$GITHUB_ENV" || true
+          
       - name: Setup Rust toolchain
         run: ./ci/install-rust.sh
 
@@ -203,6 +213,23 @@ jobs:
             export PATH=$HOME/.rust_solaris/bin:$PATH
             ./ci/run.sh ${{ matrix.target }}
 
+  ctest_msrv:
+    name: Check MSRV
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    env:
+      RUSTFLAGS: # No need to check warnings on old MSRV, unset `-Dwarnings`
+    steps:
+    - uses: actions/checkout@master
+    - run: |
+        msrv="$(perl -ne 'print if s/rust-version\s*=\s*"(.*)"/\1/g' ctest/Cargo.toml)"
+        echo "MSRV: $msrv"
+        echo "MSRV=$msrv" >> "$GITHUB_ENV"
+    - name: Install Rust
+      run: rustup update "$MSRV" --no-self-update && rustup default "$MSRV"
+    - uses: Swatinem/rust-cache@v2
+    - run: cargo build -p ctest
+
   # One job that "summarizes" the success state of this pipeline. This can then be added to branch
   # protection, rather than having to add each job separately.
   success:
@@ -214,6 +241,7 @@ jobs:
       - test_tier2
       - test_tier2_vm
       - verify_build
+      - ctest_msrv
     # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency
     # failed" as success. So we have to do some contortions to ensure the job fails if any of its
     # dependencies fails.

.github/workflows/release.yaml

@@ -0,0 +1,32 @@
+# release-plz for the stable 0.2 branch
+
+name: Release-plz
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-plz:
+    name: Release-plz
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust (rustup)
+        run: rustup update stable --no-self-update && rustup default stable
+      - name: Run release-plz
+        uses: MarcoIeni/[email protected]
+        with:
+          # On the main branch, only release ctest
+          manifest_path: ctest/Cargo.toml
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

.release-plz.toml

@@ -1,7 +1,15 @@
-[workspace]
+[[package]]
+name = "libc"
+changelog_path = "CHANGELOG.md"
 git_release_name = "{{ version }}"
 git_tag_name = "{{ version }}"
 
+[[package]]
+name = "ctest"
+changelog_path = "ctest/CHANGELOG.md"
+git_release_name = "ctest-{{ version }}"
+git_tag_name = "ctest-{{ version }}"
+
 [changelog]
 body = """
 ## [{{ version | trim_start_matches(pat="v") }}]\

Cargo.toml

@@ -140,4 +140,8 @@ rustc-dep-of-std = ["rustc-std-workspace-core"]
 extra_traits = []
 
 [workspace]
-members = ["libc-test"]
+members = [
+    "ctest",
+    "ctest-test",
+    "libc-test",
+]

ci/docker/x86_64-unknown-linux-gnu/Dockerfile

@@ -2,7 +2,7 @@ FROM ubuntu:24.10
 
 RUN apt-get update
 RUN apt-get install -y --no-install-recommends \
-  gcc libc6-dev ca-certificates linux-headers-generic
+  gcc g++ libc6-dev ca-certificates linux-headers-generic
 
 RUN apt search linux-headers
 RUN ls /usr/src

ci/run.sh

@@ -93,6 +93,19 @@ case "$target" in
     *) cmd="$cmd --workspace"
 esac
 
+# garando_errors only compiles on `cfg(any(unix, windows))`
+case "$target" in
+    *wasm*) cmd="$cmd --exclude ctest --exclude ctest-test"
+esac
+
+# # FIXME(ctest): duplicate symbol errors for statics, e.g. T1_static_mut_u8, on Unix-
+# # like platforms.
+# cast "$(uname -s)" in
+#     *windows*msvc) ;;
+#     *apple*) ;;
+#     *) cmd="$cmd --exclude ctest-test" ;;
+# esca
+
 if [ "$target" = "s390x-unknown-linux-gnu" ]; then
     # FIXME: s390x-unknown-linux-gnu often fails to test due to timeout,
     # so we retry this N times.

ci/style.sh

@@ -60,7 +60,8 @@ done < "$tmpfile"
 rm "$tmpfile"
 
 if shellcheck --version ; then
-    find . -name '*.sh' -print0 | xargs -0 shellcheck
+    # FIXME(ctest): update ctest scripts so we don't need to exclude them
+    find . -name '*.sh' -not -path './ctest/*' -print0 | xargs -0 shellcheck
 else
     echo "shellcheck not found"
     exit 1

ctest-test/Cargo.toml

@@ -0,0 +1,31 @@
+[package]
+name = "ctest-test"
+version = "0.1.0"
+authors = ["Alex Crichton <[email protected]>"]
+build = "build.rs"
+edition = "2021"
+publish = false
+
+[build-dependencies]
+ctest = { path = "../ctest" }
+cc = "1.0"
+
+[dependencies]
+cfg-if = "1.0.0"
+libc = { path = ".." }
+
+[[bin]]
+name = "t1"
+test = false
+
+[[bin]]
+name = "t2"
+test = false
+
+[[bin]]
+name = "t1_cxx"
+test = false
+
+[[bin]]
+name = "t2_cxx"
+test = false

ctest-test/build.rs

@@ -0,0 +1,110 @@
+use std::process::Command;
+
+fn main() {
+    use std::env;
+    let opt_level = env::var("OPT_LEVEL")
+        .ok()
+        .and_then(|s| s.parse().ok())
+        .unwrap_or(0);
+    let profile = env::var("PROFILE").unwrap_or_default();
+    if profile == "release" || opt_level >= 2 {
+        println!("cargo:rustc-cfg=optimized");
+    }
+    cc::Build::new()
+        .include("src")
+        .warnings(false)
+        .file("src/t1.c")
+        .compile("libt1.a");
+    println!("cargo:rerun-if-changed=src/t1.c");
+    println!("cargo:rerun-if-changed=src/t1.h");
+    cc::Build::new()
+        .warnings(false)
+        .file("src/t2.c")
+        .compile("libt2.a");
+    println!("cargo:rerun-if-changed=src/t2.c");
+    println!("cargo:rerun-if-changed=src/t2.h");
+    ctest::TestGenerator::new()
+        .header("t1.h")
+        .include("src")
+        .fn_cname(|a, b| b.unwrap_or(a).to_string())
+        .type_name(move |ty, is_struct, is_union| match ty {
+            "T1Union" => ty.to_string(),
+            "Transparent" => ty.to_string(),
+            t if is_struct => format!("struct {}", t),
+            t if is_union => format!("union {}", t),
+            t => t.to_string(),
+        })
+        .volatile_item(t1_volatile)
+        .array_arg(t1_arrays)
+        .skip_roundtrip(|n| n == "Arr")
+        .generate("src/t1.rs", "t1gen.rs");
+    ctest::TestGenerator::new()
+        .header("t2.h")
+        .include("src")
+        .type_name(move |ty, is_struct, is_union| match ty {
+            "T2Union" => ty.to_string(),
+            t if is_struct => format!("struct {}", t),
+            t if is_union => format!("union {}", t),
+            t => t.to_string(),
+        })
+        .skip_roundtrip(|_| true)
+        .generate("src/t2.rs", "t2gen.rs");
+
+    println!("cargo::rustc-check-cfg=cfg(has_cxx)");
+    if !cfg!(unix) || Command::new("c++").arg("v").output().is_ok() {
+        // A C compiler is always available, but these are only run if a C++ compiler is
+        // also available.
+        println!("cargo::rustc-cfg=has_cxx");
+
+        ctest::TestGenerator::new()
+            .header("t1.h")
+            .language(ctest::Lang::CXX)
+            .include("src")
+            .fn_cname(|a, b| b.unwrap_or(a).to_string())
+            .type_name(move |ty, is_struct, is_union| match ty {
+                "T1Union" => ty.to_string(),
+                "Transparent" => ty.to_string(),
+                t if is_struct => format!("struct {}", t),
+                t if is_union => format!("union {}", t),
+                t => t.to_string(),
+            })
+            .volatile_item(t1_volatile)
+            .array_arg(t1_arrays)
+            .skip_roundtrip(|n| n == "Arr")
+            .generate("src/t1.rs", "t1gen_cxx.rs");
+        ctest::TestGenerator::new()
+            .header("t2.h")
+            .language(ctest::Lang::CXX)
+            .include("src")
+            .type_name(move |ty, is_struct, is_union| match ty {
+                "T2Union" => ty.to_string(),
+                t if is_struct => format!("struct {}", t),
+                t if is_union => format!("union {}", t),
+                t => t.to_string(),
+            })
+            .skip_roundtrip(|_| true)
+            .generate("src/t2.rs", "t2gen_cxx.rs");
+    } else {
+        println!("cargo::warning=skipping C++ tests");
+    }
+}
+
+fn t1_volatile(i: ctest::VolatileItemKind) -> bool {
+    use ctest::VolatileItemKind::*;
+    match i {
+        StructField(ref n, ref f) if n == "V" && f == "v" => true,
+        Static(ref n) if n == "vol_ptr" => true,
+        FunctionArg(ref n, 0) if n == "T1_vol0" => true,
+        FunctionArg(ref n, 1) if n == "T1_vol2" => true,
+        FunctionRet(ref n) if n == "T1_vol1" || n == "T1_vol2" => true,
+        Static(ref n) if n == "T1_fn_ptr_vol" => true,
+        _ => false,
+    }
+}
+
+fn t1_arrays(n: &str, i: usize) -> bool {
+    match n {
+        "T1r" | "T1s" | "T1t" | "T1v" if i == 0 => true,
+        _ => false,
+    }
+}

ctest-test/src/bin/t1.rs

@@ -0,0 +1,7 @@
+#![cfg(not(test))]
+#![deny(warnings)]
+
+use ctest_test::t1::*;
+use libc::*;
+
+include!(concat!(env!("OUT_DIR"), "/t1gen.rs"));

ctest-test/src/bin/t1_cxx.rs

@@ -0,0 +1,12 @@
+#![cfg(not(test))]
+
+cfg_if::cfg_if! {
+    if #[cfg(has_cxx)] {
+        use ctest_test::t1::*;
+        use libc::*;
+
+        include!(concat!(env!("OUT_DIR"), "/t1gen_cxx.rs"));
+    } else {
+        fn main() {}
+    }
+}

ctest-test/src/bin/t2.rs

@@ -0,0 +1,6 @@
+#![cfg(not(test))]
+#![deny(warnings)]
+
+use ctest_test::t2::*;
+
+include!(concat!(env!("OUT_DIR"), "/t2gen.rs"));

ctest-test/src/bin/t2_cxx.rs

@@ -0,0 +1,11 @@
+#![cfg(not(test))]
+
+cfg_if::cfg_if! {
+    if #[cfg(has_cxx)] {
+        use ctest_test::t2::*;
+
+        include!(concat!(env!("OUT_DIR"), "/t2gen_cxx.rs"));
+    } else {
+        fn main() {}
+    }
+}

ctest-test/src/lib.rs

@@ -0,0 +1,2 @@
+pub mod t1;
+pub mod t2;