Merge branch 'main' into issues/4340

Author: sanstzu

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,8 +12,20 @@ Please fill out the below template.
 
 # Sources
 
-<!-- All API changes must have links to headers and/or documentation,
-preferably both -->
+<!-- All API changes must have permalinks to headers. Common sources:
+
+* Linux uapi https://github.com/torvalds/linux/tree/master/include/uapi
+* Glibc https://github.com/bminor/glibc
+* Musl https://github.com/bminor/musl
+* Apple XNU https://github.com/apple-oss-distributions/xnu
+* Android https://cs.android.com/android/platform/superproject/main
+
+After navigating to the relevant file, click the triple dots and select "copy
+permalink" if on GitHub, or l-r (links->commit) for the Android source to get a
+link to the current version of the header.
+
+If sources are closed, link to documentation or paste relevant C definitions.
+-->
 
 # Checklist
 
@@ -25,3 +37,9 @@ or mark it as a draft if you are not sure. -->
   included (see [#3131](https://github.com/rust-lang/libc/issues/3131))
 - [ ] Tested locally (`cd libc-test && cargo test --target mytarget`);
   especially relevant for platforms that may not be checked in CI
+
+<!-- labels: is this PR a breaking change? If not, we can probably get it in a
+0.2 release. Just uncomment the following:
+
+@rustbot label +stable-nominated
+-->

.github/workflows/ci.yaml

@@ -29,6 +29,22 @@ jobs:
       - name: Check style
         run: ./ci/style.sh
 
+  clippy:
+    name: Clippy on ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-24.04, macos-14, windows-2022]
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - run: rustup update stable --no-self-update
+      - uses: Swatinem/rust-cache@v2
+      # Here we use the latest stable Rust toolchain already installed by GitHub
+      # Ideally we should run it for every target, but we cannot rely on unstable toolchains
+      # due to Clippy not being consistent between them.
+      - run: cargo clippy --workspace --exclude libc-test --exclude ctest-test --all-targets -- -D warnings
+
   # This runs `cargo build --target ...` for all T1 and T2 targets`
   verify_build:
     name: Verify build
@@ -76,6 +92,12 @@ jobs:
           - target: i686-unknown-linux-gnu
             docker: true
             os: ubuntu-24.04
+          - target: i686-unknown-linux-gnu
+            docker: true
+            os: ubuntu-24.04
+            artifact-tag: offset-bits64
+            env:
+              RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS: 64
           - target: x86_64-unknown-linux-gnu
             docker: true
             os: ubuntu-24.04
@@ -107,6 +129,13 @@ jobs:
         with:
           key: ${{ matrix.target }}
 
+      - name: Add matrix env variables to the environment
+        if: matrix.env
+        run: |
+          echo '${{ toJson(matrix.env) }}' |
+            jq -r 'to_entries | map("\(.key)=\(.value|tostring)") | .[]' >>$GITHUB_ENV
+        shell: bash
+
       - name: Run natively
         if: "!matrix.docker"
         run: ./ci/run.sh ${{ matrix.target }}
@@ -115,11 +144,13 @@ jobs:
         run: ./ci/run-docker.sh ${{ matrix.target }}
 
       - name: Create CI artifacts
+        id: create_artifacts
         if: always()
         run: ./ci/create-artifacts.py
       - uses: actions/upload-artifact@v4
+        if: always() && steps.create_artifacts.outcome == 'success'
         with:
-          name: ${{ env.ARCHIVE_NAME }}-${{ matrix.target }}
+          name: ${{ env.ARCHIVE_NAME }}-${{ matrix.target }}${{ matrix.artifact-tag && format('-{0}', matrix.artifact-tag) }}
           path: ${{ env.ARCHIVE_PATH }}
           retention-days: 5
 
@@ -139,15 +170,11 @@ jobs:
           - aarch64-unknown-linux-gnu
           - aarch64-unknown-linux-musl
           - arm-linux-androideabi
-          - arm-unknown-linux-gnueabihf
           - arm-unknown-linux-musleabihf
           - i686-linux-android
           - i686-unknown-linux-musl
           - loongarch64-unknown-linux-gnu
           - loongarch64-unknown-linux-musl
-          # FIXME(ppc): SIGILL running tests, see
-          # https://github.com/rust-lang/libc/pull/4254#issuecomment-2636288713
-          # - powerpc-unknown-linux-gnu
           - powerpc64-unknown-linux-gnu
           - powerpc64le-unknown-linux-gnu
           - riscv64gc-unknown-linux-gnu
@@ -162,6 +189,19 @@ jobs:
           # FIXME: It seems some items in `src/unix/mod.rs`
           # aren't defined on redox actually.
           # - x86_64-unknown-redox
+        include:
+          - target: arm-unknown-linux-gnueabihf
+          - target: arm-unknown-linux-gnueabihf
+            env:
+              RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS: 64
+            artifact-tag: offset-bits64
+          # FIXME(ppc): SIGILL running tests, see
+          # https://github.com/rust-lang/libc/pull/4254#issuecomment-2636288713
+          # - target: powerpc-unknown-linux-gnu
+          # - target: powerpc-unknown-linux-gnu
+          #   env:
+          #     RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS: 64
+          #   artifact-tag: offset-bits64
     timeout-minutes: 25
     env:
       TARGET: ${{ matrix.target }}
@@ -173,15 +213,24 @@ jobs:
         with:
           key: ${{ matrix.target }}
 
+      - name: Add matrix env variables to the environment
+        if: matrix.env
+        run: |
+          echo '${{ toJson(matrix.env) }}' |
+            jq -r 'to_entries | map("\(.key)=\(.value|tostring)") | .[]' >>$GITHUB_ENV
+        shell: bash
+
       - name: Execute run-docker.sh
         run: ./ci/run-docker.sh ${{ matrix.target }}
 
       - name: Create CI artifacts
+        id: create_artifacts
         if: always()
         run: ./ci/create-artifacts.py
       - uses: actions/upload-artifact@v4
+        if: always() && steps.create_artifacts.outcome == 'success'
         with:
-          name: ${{ env.ARCHIVE_NAME }}-${{ matrix.target }}
+          name: ${{ env.ARCHIVE_NAME }}-${{ matrix.target }}${{ matrix.artifact-tag && format('-{0}', matrix.artifact-tag) }}
           path: ${{ env.ARCHIVE_PATH }}
           retention-days: 5
 
@@ -222,14 +271,25 @@ jobs:
     steps:
     - uses: actions/checkout@master
     - run: |
-        msrv="$(perl -ne 'print if s/rust-version\s*=\s*"(.*)"/\1/g' ctest/Cargo.toml)"
+        msrv="$(cargo metadata --format-version 1 | jq -r --arg CRATE_NAME ctest  '.packages | map(select(.name == $CRATE_NAME)) | first | .rust_version')"
         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
 
+  docs:
+    name: Ensure docs build
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@master
+    - name: Install Rust
+      run: rustup update nightly --no-self-update && rustup default nightly
+    - uses: Swatinem/rust-cache@v2
+    - run: cargo doc --workspace --no-deps
+
   # 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:
@@ -242,7 +302,9 @@ jobs:
       - test_tier2_vm
       - verify_build
       - ctest_msrv
-    # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency
+      - docs
+      - clippy
+    # 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.
     if: always() # make sure this is never "skipped"

.github/workflows/release.yaml

@@ -24,9 +24,10 @@ jobs:
         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 }}
+        with:
+          # FIXME(release): release-pr is broken since we have two release tracks for
+          # `libc` :(
+          command: release

.release-plz.toml

@@ -3,12 +3,13 @@ name = "libc"
 changelog_path = "CHANGELOG.md"
 git_release_name = "{{ version }}"
 git_tag_name = "{{ version }}"
+publish = false # On the main branch, we don't want to publish anything
 
 [[package]]
 name = "ctest"
 changelog_path = "ctest/CHANGELOG.md"
 git_release_name = "ctest-{{ version }}"
-git_tag_name = "ctest-{{ version }}"
+git_tag_name = "ctest-v{{ version }}"
 
 [changelog]
 body = """

Cargo.toml

@@ -1,19 +1,16 @@
 [package]
 name = "libc"
 version = "1.0.0-alpha.1"
-authors = ["The Rust Project Developers"]
-license = "MIT OR Apache-2.0"
-readme = "README.md"
-edition = "2021"
-repository = "https://github.com/rust-lang/libc"
-homepage = "https://github.com/rust-lang/libc"
-documentation = "https://docs.rs/libc/"
 keywords = ["libc", "ffi", "bindings", "operating", "system"]
 categories = ["external-ffi-bindings", "no-std", "os"]
-build = "build.rs"
 exclude = ["/ci/*", "/.github/*", "/.cirrus.yml", "/triagebot.toml"]
-rust-version = "1.63"
 description = "Raw FFI bindings to platform libraries like libc."
+publish = false # On the main branch, we don't want to publish anything
+authors = ["The Rust Project Developers"]
+edition = "2021"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/rust-lang/libc"
+rust-version = "1.63"
 
 [package.metadata.docs.rs]
 features = ["extra_traits"]
@@ -145,3 +142,24 @@ members = [
     "ctest-test",
     "libc-test",
 ]
+
+# FIXME(msrv): These should be renamed as `[workspace.lints.*]` once MSRV is above 1.64
+#       This way all crates can use it with `[lints] workspace=true` section
+
+[lints.rust]
+# FIXME(cleanup): make ident usage consistent in each file
+unused_qualifications = "allow"
+
+[lints.clippy]
+missing_safety_doc = "allow"
+
+# FIXME(clippy): all these are default lints and should probably be fixed
+identity_op = "allow"
+if_same_then_else = "allow"
+non_minimal_cfg = "allow"
+precedence = "allow"
+redundant_field_names = "allow"
+redundant_static_lifetimes = "allow"
+unnecessary_cast = "allow"
+unused_unit = "allow"
+zero_ptr = "allow"

build.rs

@@ -13,6 +13,8 @@ const ALLOWED_CFGS: &'static [&'static str] = &[
     "freebsd13",
     "freebsd14",
     "freebsd15",
+    // Corresponds to `_FILE_OFFSET_BITS=64` in glibc
+    "gnu_file_offset_bits64",
     // FIXME(ctest): this config shouldn't be needed but ctest can't parse `const extern fn`
     "libc_const_extern_fn",
     "libc_deny_warnings",
@@ -29,7 +31,10 @@ const CHECK_CFG_EXTRA: &'static [(&'static str, &'static [&'static str])] = &[
             "switch", "aix", "ohos", "hurd", "rtems", "visionos", "nuttx", "cygwin",
         ],
     ),
-    ("target_env", &["illumos", "wasi", "aix", "ohos"]),
+    (
+        "target_env",
+        &["illumos", "wasi", "aix", "ohos", "nto71_iosock", "nto80"],
+    ),
     (
         "target_arch",
         &["loongarch64", "mips32r6", "mips64r6", "csky"],
@@ -43,6 +48,10 @@ fn main() {
     let (rustc_minor_ver, _is_nightly) = rustc_minor_nightly();
     let rustc_dep_of_std = env::var("CARGO_FEATURE_RUSTC_DEP_OF_STD").is_ok();
     let libc_ci = env::var("LIBC_CI").is_ok();
+    let target_env = env::var("CARGO_CFG_TARGET_ENV").unwrap_or_default();
+    let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap_or_default();
+    let target_ptr_width = env::var("CARGO_CFG_TARGET_POINTER_WIDTH").unwrap_or_default();
+    let target_arch = env::var("CARGO_CFG_TARGET_ARCH").unwrap_or_default();
 
     // The ABI of libc used by std is backward compatible with FreeBSD 12.
     // The ABI of libc from crates.io is backward compatible with FreeBSD 12.
@@ -84,6 +93,23 @@ fn main() {
     if linux_time_bits64 {
         set_cfg("linux_time_bits64");
     }
+    println!("cargo:rerun-if-env-changed=RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS");
+    match env::var("RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS") {
+        Ok(val) if val == "64" => {
+            if target_env == "gnu"
+                && target_os == "linux"
+                && target_ptr_width == "32"
+                && target_arch != "riscv32"
+                && target_arch != "x86_64"
+            {
+                set_cfg("gnu_file_offset_bits64");
+            }
+        }
+        Ok(val) if val != "32" => {
+            panic!("RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS may only be set to '32' or '64'")
+        }
+        _ => {}
+    }
 
     // On CI: deny all warnings
     if libc_ci {
@@ -98,17 +124,17 @@ fn main() {
     if rustc_minor_ver >= 80 {
         for cfg in ALLOWED_CFGS {
             if rustc_minor_ver >= 75 {
-                println!("cargo:rustc-check-cfg=cfg({})", cfg);
+                println!("cargo:rustc-check-cfg=cfg({cfg})");
             } else {
-                println!("cargo:rustc-check-cfg=values({})", cfg);
+                println!("cargo:rustc-check-cfg=values({cfg})");
             }
         }
         for &(name, values) in CHECK_CFG_EXTRA {
             let values = values.join("\",\"");
             if rustc_minor_ver >= 75 {
-                println!("cargo:rustc-check-cfg=cfg({},values(\"{}\"))", name, values);
+                println!("cargo:rustc-check-cfg=cfg({name},values(\"{values}\"))");
             } else {
-                println!("cargo:rustc-check-cfg=values({},\"{}\")", name, values);
+                println!("cargo:rustc-check-cfg=values({name},\"{values}\")");
             }
         }
     }
@@ -229,7 +255,7 @@ fn emcc_version_code() -> Option<u64> {
 
 fn set_cfg(cfg: &str) {
     if !ALLOWED_CFGS.contains(&cfg) {
-        panic!("trying to set cfg {}, but it is not in ALLOWED_CFGS", cfg);
+        panic!("trying to set cfg {cfg}, but it is not in ALLOWED_CFGS");
     }
-    println!("cargo:rustc-cfg={}", cfg);
+    println!("cargo:rustc-cfg={cfg}");
 }

ci/ios/deploy_and_run_on_ios_simulator.rs

@@ -16,7 +16,7 @@ use std::process::Command;
 macro_rules! t {
     ($e:expr) => (match $e {
         Ok(e) => e,
-        Err(e) => panic!("{} failed with: {}", stringify!($e), e),
+        Err(e) => panic!("{} failed with: {e}", stringify!($e)),
     })
 }
 
@@ -143,7 +143,7 @@ trait CheckStatus {
 
 impl CheckStatus for Command {
     fn check_status(&mut self) {
-        println!("\trunning: {:?}", self);
+        println!("\trunning: {self:?}");
         assert!(t!(self.status()).success());
     }
 }

ci/run-docker.sh

@@ -43,12 +43,13 @@ run() {
         --user "$(id -u)":"$(id -g)" \
         --env LIBC_CI \
         --env LIBC_CI_ZBUILD_STD \
+        --env RUST_LIBC_UNSTABLE_GNU_FILE_OFFSET_BITS \
         --env CARGO_HOME=/cargo \
         --env CARGO_TARGET_DIR=/checkout/target \
         --volume "$CARGO_HOME":/cargo \
         --volume "$(rustc --print sysroot)":/rust:ro \
-        --volume "$(pwd)":/checkout:ro \
-        --volume "$(pwd)"/target:/checkout/target \
+        --volume "$PWD":/checkout:ro \
+        --volume "$PWD"/target:/checkout/target \
         $kvm \
         --init \
         --workdir /checkout \