Added FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::ControlMessageOwned #2187

recatek · 2023-11-13T01:58:11Z

What does this PR do

Adds FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::ControlMessageOwned to read socket control messages after setting SO_TS_CLOCK to either SO_TS_REALTIME or SO_TS_MONOTONIC. Note that this does not also support SO_TS_BINTIME yet as that requires a new data structure. See man setsockopt for FreeBSD for more info on these settings.

Also adds a proper enum as a parameter to sockopt::TsClock for choosing which clock to timestamp with. Previously this took a raw i32 and required libc as a dependency to properly configure.

Resolves #2186.

Checklist:

I have read CONTRIBUTING.md
I have written necessary tests and rustdoc comments
A change log has been added if this PR modifies nix's API

…rolMessageOwned.

…eeBSD.

src/sys/socket/mod.rs

recatek · 2023-11-14T05:44:48Z

Regarding the changelog entry, I noticed there isn't a section for upcoming changes. Should I create one?

SteveLauC · 2023-11-14T07:16:23Z

Regarding the changelog entry, I noticed there isn't a section for upcoming changes. Should I create one?

Yep, a changelog entry is needed, but we don't edit that CHANGELOG.md file, instead, we add a new file to the changelog directory, please see CONTRIBUTING.md on how to add a change log

asomers · 2023-11-18T15:28:33Z

This looks good @recatek . Would it be possible to add a test too?

…imestamp control messages for FreeBSD

recatek · 2023-11-18T21:23:21Z

Added tests for the new enum and the two new control messages.

test/sys/test_socket.rs

recatek · 2023-11-21T03:59:02Z

Not sure what happened there in that CI / tier3 (armv7-unknown-linux-uclibceabihf) test -- any ideas?

SteveLauC · 2023-11-21T05:13:57Z

Well, that CI error does not seem to be related to this PR

Related commit: rust-lang/rust@12efa53
Related code snippet: https://github.com/rust-lang/rust/blame/baf4abff314cad946a3b7335024e3e2756e3828b/library/std/src/sys/unix/process/process_unix.rs#L867-L917
Related libc type and methods: https://docs.rs/libc/latest/libc/struct.siginfo_t.html#impl-siginfo_t-1

I can reproduce it on my Linux host:

$ cargo +nightly -v
cargo 1.76.0-nightly (71cd3a926 2023-11-20)

$ cargo new hello

$ cd hello

$ cargo +nightly b -Zbuild-std --target armv7-unknown-linux-uclibceabihf
   Compiling compiler_builtins v0.1.103
   Compiling core v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/core)
   Compiling libc v0.2.150
   Compiling memchr v2.5.0
   Compiling std v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/std)
   Compiling rustc-std-workspace-core v1.99.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/rustc-std-workspace-core)
   Compiling alloc v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/alloc)
   Compiling cfg-if v1.0.0
   Compiling adler v1.0.2
   Compiling rustc-demangle v0.1.23
   Compiling unwind v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/unwind)
   Compiling rustc-std-workspace-alloc v1.99.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/rustc-std-workspace-alloc)
   Compiling panic_abort v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/panic_abort)
   Compiling panic_unwind v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/panic_unwind)
   Compiling gimli v0.28.0
   Compiling hashbrown v0.14.2
   Compiling object v0.32.1
   Compiling std_detect v0.1.5 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/stdarch/crates/std_detect)
   Compiling miniz_oxide v0.7.1
   Compiling addr2line v0.21.0
error[E0599]: no method named `si_pid` found for struct `siginfo_t` in the current scope
   --> /home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/std/src/sys/unix/process/process_unix.rs:879:33
    |
879 |             if unsafe { siginfo.si_pid() } == 0 {
    |                                 ^^^^^^ method not found in `siginfo_t`

error[E0599]: no method named `si_status` found for struct `siginfo_t` in the current scope
   --> /home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/std/src/sys/unix/process/process_unix.rs:917:39
    |
917 |         let status = unsafe { siginfo.si_status() };
    |                                       ^^^^^^^^^ method not found in `siginfo_t`

For more information about this error, try `rustc --explain E0599`.
error: could not compile `std` (lib) due to 2 previous errors

Though I can not reproduce it if I choose the target to be x86_64-unknown-linux-gnu:

$ cargo +nightly b -Zbuild-std --target x86_64-unknown-linux-gnu
   Compiling compiler_builtins v0.1.103
   Compiling core v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/core)
   Compiling libc v0.2.150
   Compiling memchr v2.5.0
   Compiling std v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/std)
   Compiling rustc-std-workspace-core v1.99.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/rustc-std-workspace-core)
   Compiling alloc v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/alloc)
   Compiling cfg-if v1.0.0
   Compiling adler v1.0.2
   Compiling rustc-demangle v0.1.23
   Compiling unwind v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/unwind)
   Compiling rustc-std-workspace-alloc v1.99.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/rustc-std-workspace-alloc)
   Compiling panic_abort v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/panic_abort)
   Compiling panic_unwind v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/panic_unwind)
   Compiling gimli v0.28.0
   Compiling std_detect v0.1.5 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/stdarch/crates/std_detect)
   Compiling miniz_oxide v0.7.1
   Compiling object v0.32.1
   Compiling hashbrown v0.14.2
   Compiling addr2line v0.21.0
   Compiling proc_macro v0.0.0 (/home/steve/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/proc_macro)
   Compiling hello v0.1.0 (/tmp/hello)
    Finished dev [unoptimized + debuginfo] target(s) in 8.37s

SteveLauC · 2023-11-24T12:45:06Z

Hi @recatek, you need to handle that CI failure, wrap unsafe functions in unsafe blocks. Though it does confuse me why the check for this PR actually passed then it failed in the merge queue

recatek · 2023-11-24T20:00:47Z

Looks like we're good now. Got caught up in upstream changes.

recatek added 4 commits November 12, 2023 20:48

Added FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::Cont…

c60b743

…rolMessageOwned.

Creating a SocketTimestamp enum for the SO_TS_CLOCK setsockopt for Fr…

9ebb8f3

…eeBSD.

Fixing whitespace

f1252a3

Fixing CI error on cfg attributes

dc7baed

SteveLauC reviewed Nov 14, 2023

View reviewed changes

src/sys/socket/mod.rs Outdated Show resolved Hide resolved

recatek added 2 commits November 14, 2023 00:43

Removing legacy doc attributes

25ed375

Formatting cleanup

9664ea0

Updating changelog

f795c4e

recatek requested a review from SteveLauC November 17, 2023 03:11

recatek added 2 commits November 18, 2023 14:45

Adding tests for new TsClock setsockopt enum and the two new packet t…

37c3998

…imestamp control messages for FreeBSD

Replacing an assert_eq with an assert in new tests.

d30ea30

asomers requested changes Nov 19, 2023

View reviewed changes

recatek added 3 commits November 20, 2023 22:49

Removing qemu ignore for new FreeBSD tests

333d815

Giving new FreeBSD timestamping tests each a unique socket

668e7fb

Updating monotonic packet timestamp test to account for monotonicity

e9098e2

recatek requested a review from asomers November 21, 2023 03:55

SteveLauC mentioned this pull request Nov 21, 2023

Add fanotify API wrappers #2194

Merged

3 tasks

Moving test ports again to line up with changes in nix-rust#2196

9b38430

SteveLauC mentioned this pull request Nov 23, 2023

Safer poll timeout #1876

Merged

Attempting checks again

71abb61

asomers approved these changes Nov 23, 2023

View reviewed changes

SteveLauC added this pull request to the merge queue Nov 24, 2023

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 24, 2023

Wrapping ptr::read_unaligned calls in unsafe blocks

ec8a1b6

SteveLauC added this pull request to the merge queue Nov 25, 2023

Merged via the queue into nix-rust:master with commit 3541bdd Nov 25, 2023
34 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::ControlMessageOwned #2187

Added FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::ControlMessageOwned #2187

recatek commented Nov 13, 2023 •

edited

recatek commented Nov 14, 2023

SteveLauC commented Nov 14, 2023

asomers commented Nov 18, 2023

recatek commented Nov 18, 2023

recatek commented Nov 21, 2023

SteveLauC commented Nov 21, 2023

SteveLauC commented Nov 24, 2023

recatek commented Nov 24, 2023

Added FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::ControlMessageOwned #2187

Added FreeBSD's SCM_REALTIME and SCM_MONOTONIC into sys::socket::ControlMessageOwned #2187

Conversation

recatek commented Nov 13, 2023 • edited

What does this PR do

Checklist:

recatek commented Nov 14, 2023

SteveLauC commented Nov 14, 2023

asomers commented Nov 18, 2023

recatek commented Nov 18, 2023

recatek commented Nov 21, 2023

SteveLauC commented Nov 21, 2023

SteveLauC commented Nov 24, 2023

recatek commented Nov 24, 2023

recatek commented Nov 13, 2023 •

edited