Add a FreeBSD 12 build job and test FreeBSD12 APIs

This commits adds a second FreeBSD 12 build job,
and splits the implementation of the FreeBSD module
into two modules, one for FreeBSD 11, and one for FreeBSD 12.

The FreeBSD 11 module is compiled always by default, and is
mostly forward compatible with FreeBSD 12 systems.

The FreeBSD 12 module is only built for now in libc's CI,
and uses FreeBSD 12 data types and APIs, linking to symbols
that are only available in FreeBSD 12.

Basically, when LIBC_CI env variable is defined, and the host
system is a FreeBSD 12 system, then the FreeBSD 12 module is
automatically built and tested. Conditional compilation is done
using a `cfg(freebsd12)` flag.

This commit also re-enables many tests, and documents why
some remain disabled.

Author: gnzlbg

.cirrus.yml

@@ -1,8 +1,7 @@
-freebsd_instance:
-  image: freebsd-11-1-release-amd64
-
 task:
-  name: stable x86_64-unknown-freebsd
+  name: stable x86_64-unknown-freebsd-11
+  freebsd_instance:
+    image: freebsd-11-2-release-amd64
   setup_script:
     - pkg install -y curl
     - curl https://sh.rustup.rs -sSf --output rustup.sh
@@ -12,9 +11,11 @@ task:
   test_script:
     - . $HOME/.cargo/env
     - sh ci/run.sh x86_64-unknown-freebsd
-
+    
 task:
-  name: nightly x86_64-unknown-freebsd
+  name: nightly x86_64-unknown-freebsd-12
+  freebsd_instance:
+    image: freebsd-12-0-release-amd64
   setup_script:
     - pkg install -y curl
     - curl https://sh.rustup.rs -sSf --output rustup.sh

build.rs

@@ -9,6 +9,12 @@ fn main() {
         std::env::var("CARGO_FEATURE_RUSTC_DEP_OF_STD").is_ok();
     let align_cargo_feature = std::env::var("CARGO_FEATURE_ALIGN").is_ok();
 
+    if std::env::var("LIBC_CI").is_ok() {
+        if let Some(12) = which_freebsd() {
+            println!("cargo:rustc-cfg=freebsd12");
+        }
+    }
+
     // Rust >= 1.15 supports private module use:
     if rustc_minor_ver >= 15 || rustc_dep_of_std {
         println!("cargo:rustc-cfg=libc_priv_mod_use");
@@ -63,3 +69,20 @@ fn rustc_minor_version() -> Option<u32> {
 
     otry!(pieces.next()).parse().ok()
 }
+
+fn which_freebsd() -> Option<i32> {
+    let output = std::process::Command::new("freebsd-version")
+        .output()
+        .ok()?;
+    if !output.status.success() {
+        return None;
+    }
+
+    let stdout = String::from_utf8(output.stdout).ok()?;
+
+    match &stdout {
+        s if s.starts_with("11") => Some(11),
+        s if s.starts_with("12") => Some(12),
+        _ => None,
+    }
+}

ci/run.sh

@@ -87,10 +87,12 @@ if [ "$TARGET" = "x86_64-unknown-linux-gnux32" ]; then
   opt="--release"
 fi
 
-cargo test $opt --no-default-features --manifest-path libc-test/Cargo.toml \
+export LIBC_CI=1
+
+cargo test -vv $opt --no-default-features --manifest-path libc-test/Cargo.toml \
       --target "${TARGET}"
 
-cargo test $opt --manifest-path libc-test/Cargo.toml --target "${TARGET}"
+cargo test -vv $opt --manifest-path libc-test/Cargo.toml --target "${TARGET}"
 
-cargo test $opt --features extra_traits --manifest-path libc-test/Cargo.toml \
+cargo test -vv $opt --features extra_traits --manifest-path libc-test/Cargo.toml \
       --target "${TARGET}"

libc-test/build.rs

@@ -1444,11 +1444,19 @@ fn test_android(target: &str) {
 
 fn test_freebsd(target: &str) {
     assert!(target.contains("freebsd"));
-    let x86 = target.contains("i686") || target.contains("x86_64");
-
     let mut cfg = ctest::TestGenerator::new();
+
+    let freebsd_ver = which_freebsd();
+
+    if let Some(12) = freebsd_ver {
+        // If the host is FreeBSD 12, run FreeBSD 12 tests
+        cfg.cfg("freebsd12", None);
+    }
+
     // Required for `getline`:
     cfg.define("_WITH_GETLINE", None);
+    // Required for making freebsd11_stat available in the headers
+    cfg.define("_WANT_FREEBSD11_STAT", None);
 
     headers! { cfg:
                 "aio.h",
@@ -1530,12 +1538,16 @@ fn test_freebsd(target: &str) {
             // Just pass all these through, no need for a "struct" prefix
             "FILE" | "fd_set" | "Dl_info" | "DIR" => ty.to_string(),
 
+            // FIXME: https://github.com/rust-lang/libc/issues/1273
             "sighandler_t" => "sig_t".to_string(),
 
             t if is_union => format!("union {}", t),
 
             t if t.ends_with("_t") => t.to_string(),
 
+            // sigval is a struct in Rust, but a union in C:
+            "sigval" => format!("union sigval"),
+
             // put `struct` in front of all structs:.
             t if is_struct => format!("struct {}", t),
 
@@ -1557,169 +1569,76 @@ fn test_freebsd(target: &str) {
         }
     });
 
-    cfg.skip_struct(move |ty| {
-        match ty {
-            // This is actually a union, not a struct
-            // FIXME: still required?
-            "sigval" => true,
-
-            _ => false,
-        }
-    });
-
-    cfg.skip_signededness(move |c| {
-        match c {
-            // FIXME: still required?
-            "LARGE_INTEGER" | "float" | "double" => true,
-            // FIXME: still required?
-            n if n.starts_with("pthread") => true,
-            // sem_t is a struct or pointer
-            // FIXME: still required?
-            "sem_t" => true,
-            // mqd_t is a pointer on FreeBSD
-            // FIXME: still required?
-            "mqd_t" => true,
-
-            _ => false,
-        }
-    });
-
     cfg.skip_const(move |name| {
         match name {
-            // FIXME: still required?
-            "SIG_DFL" | "SIG_ERR" | "SIG_IGN" => true, // sighandler_t weirdness
+            // These constants were introduced in FreeBSD 12:
+            "SF_USER_READAHEAD"
+            | "EVFILT_EMPTY"
+            | "SO_REUSEPORT_LB"
+            | "IP_ORIGDSTADDR"
+            | "IP_RECVORIGDSTADDR"
+            | "IPV6_ORIGDSTADDR"
+            | "IPV6_RECVORIGDSTADDR"
+                if Some(12) != freebsd_ver =>
+            {
+                true
+            }
 
+            // FIXME: There are deprecated - remove in a couple of releases.
             // These constants were removed in FreeBSD 11 (svn r273250) but will
             // still be accepted and ignored at runtime.
-            "MAP_RENAME" | "MAP_NORESERVE" => true,
+            "MAP_RENAME" | "MAP_NORESERVE" if Some(10) != freebsd_ver => true,
 
+            // FIXME: There are deprecated - remove in a couple of releases.
             // These constants were removed in FreeBSD 11 (svn r262489),
             // and they've never had any legitimate use outside of the
             // base system anyway.
             "CTL_MAXID" | "KERN_MAXID" | "HW_MAXID" | "NET_MAXID"
             | "USER_MAXID" => true,
 
-            // These constants were added in FreeBSD 11
-            // FIXME: still required?
-            "EVFILT_PROCDESC" | "EVFILT_SENDFILE" | "EVFILT_EMPTY"
-            | "PD_CLOEXEC" | "PD_ALLOWED_AT_FORK" => true,
-
-            // These constants were added in FreeBSD 12
-            // FIXME: still required?
-            "SF_USER_READAHEAD" | "SO_REUSEPORT_LB" => true,
-
-            // These constants are tested in a separate test program generated
-            // below because there are header conflicts if we try to include the
-            // headers that define them here.
-            // FIXME: still required?
-            "F_CANCELLK" | "F_ADD_SEALS" | "F_GET_SEALS" => true,
-            // FIXME: still required?
-            "F_SEAL_SEAL" | "F_SEAL_SHRINK" | "F_SEAL_GROW"
-            | "F_SEAL_WRITE" => true,
-            // FIXME: still required?
-            "BOTHER" => true,
-
-            // MFD_HUGETLB is not available in some older libc versions on the
-            // CI builders. On the x86_64 and i686 builders it seems to be
-            // available for all targets, so at least test it there.
-            // FIXME: still required?
-            "MFD_HUGETLB" if !x86 => true,
-
-            // These change all the time from release to release of linux
-            // distros, let's just not bother trying to verify them. They
-            // shouldn't be used in code anyway...
-            // FIXME: still required?
-            "AF_MAX" | "PF_MAX" => true,
-
-            // FreeBSD 12 required, but CI has FreeBSD 11.
-            // FIXME: still required?
-            "IP_ORIGDSTADDR"
-            | "IP_RECVORIGDSTADDR"
-            | "IPV6_ORIGDSTADDR"
-            | "IPV6_RECVORIGDSTADDR" => true,
-
             _ => false,
         }
     });
 
     cfg.skip_fn(move |name| {
         // skip those that are manually verified
         match name {
-            // FIXME: still required?
-            "execv" |       // crazy stuff with const/mut
-            "execve" |
-            "execvp" |
-            "execvpe" |
-            "fexecve" => true,
+            // FIXME: https://github.com/rust-lang/libc/issues/1272
+            "execv" | "execve" | "execvp" | "execvpe" | "fexecve" => true,
 
             // The `uname` function in freebsd is now an inline wrapper that
             // delegates to another, but the symbol still exists, so don't check
             // the symbol.
-            // FIXME: still required?
             "uname" => true,
 
-            // FIXME: need to upgrade FreeBSD version; see https://github.com/rust-lang/libc/issues/938
-            // FIXME: still required?
-            "setgrent" => true,
-
-            // aio_waitcomplete's return type changed between FreeBSD 10 and 11.
-            // FIXME: still required?
-            "aio_waitcomplete"  => true,
-
-            // lio_listio confuses the checker, probably because one of its
-            // arguments is an array
-            // FIXME: still required?
+            // FIXME: Our API is unsound. The Rust API allows aliasing
+            // pointers, but the C API requires pointers not to alias.
+            // We should probably be at least using `&`/`&mut` here, see:
+            // https://github.com/gnzlbg/ctest/issues/68
             "lio_listio" => true,
 
-            // Definition of those functions as changed since unified headers from NDK r14b
-            // These changes imply some API breaking changes but are still ABI compatible.
-            // We can wait for the next major release to be compliant with the new API.
-            // FIXME: unskip these for next major release
-            // FIXME: still required ?
-            "strerror_r" | "madvise" | "msync" | "mprotect" | "recvfrom" | "getpriority" |
-
             _ => false,
         }
     });
 
-    cfg.skip_field_type(move |struct_, field| {
-        // This is a weird union, don't check the type.
-        // FIXME: still required?
-        (struct_ == "ifaddrs" && field == "ifa_ifu") ||
-        // FIXME: still required?
-        // sighandler_t type is super weird
-            (struct_ == "sigaction" && field == "sa_sigaction") ||
-        // FIXME: still required?
-        // sigval is actually a union, but we pretend it's a struct
-            (struct_ == "sigevent" && field == "sigev_value") ||
-        // aio_buf is "volatile void*" and Rust doesn't understand volatile
-        // FIXME: still required?
-            (struct_ == "aiocb" && field == "aio_buf") ||
-        // stack_t.ss_sp's type changed from FreeBSD 10 to 11 in svn r294930
-        // FIXME: still required?
-            (struct_ == "stack_t" && field == "ss_sp")
+    cfg.volatile_item(|i| {
+        use ctest::VolatileItemKind::*;
+        match i {
+            // aio_buf is a volatile void** but since we cannot express that in
+            // Rust types, we have to explicitly tell the checker about it here:
+            StructField(ref n, ref f) if n == "aiocb" && f == "aio_buf" => {
+                true
+            }
+            _ => false,
+        }
     });
 
     cfg.skip_field(move |struct_, field| {
-        // this is actually a union on linux, so we can't represent it well and
-        // just insert some padding.
-        // FIXME: still required?
-        (struct_ == "siginfo_t" && field == "_pad") ||
-        // sigev_notify_thread_id is actually part of a sigev_un union
-        // FIXME: still required?
-        (struct_ == "sigevent" && field == "sigev_notify_thread_id") ||
-        // signalfd had SIGSYS fields added in Linux 4.18, but no libc release has them yet.
-        // FIXME: still required?
-        (struct_ == "signalfd_siginfo" && (field == "ssi_addr_lsb" ||
-                                           field == "_pad2" ||
-                                           field == "ssi_syscall" ||
-                                           field == "ssi_call_addr" ||
-                                           field == "ssi_arch"))
+        // FIXME: `sa_sigaction` has type `sighandler_t` but that type is
+        // incorrect, see: https://github.com/rust-lang/libc/issues/1359
+        (struct_ == "sigaction" && field == "sa_sigaction")
     });
 
-    // FIXME: remove
-    cfg.fn_cname(move |name, _cname| name.to_string());
-
     cfg.generate("../src/lib.rs", "main.rs");
 }
 
@@ -2686,3 +2605,20 @@ fn test_linux_termios2(target: &str) {
     });
     cfg.generate("../src/lib.rs", "linux_fcntl.rs");
 }
+
+fn which_freebsd() -> Option<i32> {
+    let output = std::process::Command::new("freebsd-version")
+        .output()
+        .ok()?;
+    if !output.status.success() {
+        return None;
+    }
+
+    let stdout = String::from_utf8(output.stdout).ok()?;
+
+    match &stdout {
+        s if s.starts_with("11") => Some(11),
+        s if s.starts_with("12") => Some(12),
+        _ => None,
+    }
+}

src/unix/bsd/apple/mod.rs

@@ -3018,6 +3018,7 @@ f! {
 }
 
 extern {
+    pub fn setgrent();
     #[doc(hidden)]
     #[deprecated(since="0.2.49", note="Deprecated in MacOSX 10.5")]
     #[link_name = "daemon$1050"]

src/unix/bsd/freebsdlike/dragonfly/mod.rs

@@ -1,3 +1,4 @@
+pub type dev_t = u32;
 pub type c_char = i8;
 pub type clock_t = u64;
 pub type ino_t = u64;
@@ -27,6 +28,15 @@ impl ::Clone for sem {
 }
 
 s! {
+    pub struct kevent {
+        pub ident: ::uintptr_t,
+        pub filter: ::c_short,
+        pub flags: ::c_ushort,
+        pub fflags: ::c_uint,
+        pub data: ::intptr_t,
+        pub udata: *mut ::c_void,
+    }
+
     pub struct exit_status {
         pub e_termination: u16,
         pub e_exit: u16
@@ -1008,6 +1018,7 @@ f! {
 }
 
 extern {
+    pub fn setgrent();
     pub fn mprotect(addr: *mut ::c_void, len: ::size_t, prot: ::c_int)
                     -> ::c_int;
     pub fn clock_getres(clk_id: ::clockid_t, tp: *mut ::timespec) -> ::c_int;