Add all definitions from linux/ptp-clock.h #3865

folkertdev · 2024-08-21T22:18:39Z

code is the same as #3559, but rebased on main instead of 0.2

folkertdev · 2024-08-21T22:21:42Z

hmm this needs some extra data types now, and reading kernel C code will need a better-rested brain. I'll continue with this tomorrow.

folkertdev

This hits a CI error that I don't understand

  --- stderr
  thread 'main' panicked at /cargo/registry/src/index.crates.io-6f17d22bba15001f/garando_syntax-0.1.1/src/ext/expand.rs:337:21:
  internal error: entered unreachable code
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

so that is here https://github.com/JohnTitor/garando/blob/master/garando_syntax/src/ext/expand.rs#L337

but there is no context about what actually failed in this case.

@rustbot review

in the sense that I'm kind of stuck

folkertdev · 2024-08-22T10:04:55Z

src/unix/linux_like/linux/mod.rs

+mod ioctl {
+    const _IOC_NRBITS: u32 = 8;
+    const _IOC_TYPEBITS: u32 = 8;


should this move somewhere else?

I also get a style error on the const definition

src/unix/linux_like/linux/mod.rs:6295: constant found after module when it belongs before

not sure what that is about

the error is back. Maybe the check is too strict, and just does not allow consts defined in inner modules? I can remove the module wrapper but bundling the symbols/logic with a mod is kind of nice

rustbot · 2024-08-22T10:10:20Z

Failed to set assignee to ready: cannot assign: response: {"message":"Not Found","documentation_url":"https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue","status":"404"}

Note: Only org members with at least the repository "read" role, users with write permissions, or people who have commented on the PR may be assigned.

rustbot · 2024-08-22T10:10:20Z

Failed to set assignee to ready: cannot assign: response: {"message":"Not Found","documentation_url":"https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue","status":"404"}

Note: Only org members with at least the repository "read" role, users with write permissions, or people who have commented on the PR may be assigned.

tgross35 · 2024-08-28T20:01:26Z

This hits a CI error that I don't understand
  --- stderr
  thread 'main' panicked at /cargo/registry/src/index.crates.io-6f17d22bba15001f/garando_syntax-0.1.1/src/ext/expand.rs:337:21:
  internal error: entered unreachable code
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
so that is here https://github.com/JohnTitor/garando/blob/master/garando_syntax/src/ext/expand.rs#L337

but there is no context about what actually failed in this case.

@rustbot review

in the sense that I'm kind of stuck

Ah, I don't know anything about this crate but I suspect it will need to be patched somehow. I don't know what that would be (I have never worked with that crate), I know it has problems parsing some newer syntax.

Since this is seemingly blocked on that:

@rustbot blocked

tgross35 · 2024-08-28T20:03:35Z

If you aren't up for figuring out how to fix that, you could also just try disabling chunks of these changes until things work. Not ideal, but maybe better than waiting.

folkertdev · 2024-08-28T20:20:09Z

well I did just reproduce this locally and that library just performs an out-of-bounds lookup

  thread 'main' panicked at library/core/src/panicking.rs:219:5:
  unsafe precondition(s) violated: slice::get_unchecked requires that the index is within the slice
  stack backtrace:
     0: rust_begin_unwind
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/std/src/panicking.rs:652:5
     1: core::panicking::panic_nounwind_fmt::runtime
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/core/src/panicking.rs:110:18
     2: core::panicking::panic_nounwind_fmt
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/core/src/panicking.rs:120:5
     3: core::panicking::panic_nounwind
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/core/src/panicking.rs:219:5
     4: <usize as core::slice::index::SliceIndex<[T]>>::get_unchecked::precondition_check
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/core/src/ub_checks.rs:68:21
     5: <usize as core::slice::index::SliceIndex<[T]>>::get_unchecked
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/core/src/ub_checks.rs:75:17
     6: core::slice::<impl [T]>::get_unchecked
               at /rustc/3f5fd8dd41153bc5fdca9427e9e05be2c767ba23/library/core/src/slice/mod.rs:686:20
     7: <alloc::vec::Vec<T> as garando_syntax::util::move_map::MoveMap<T>>::move_flat_map
               at /home/folkertdev/.cargo/registry/src/index.crates.io-6f17d22bba15001f/garando_syntax-0.1.0/src/util/move_map.rs:32:35
     8: garando_syntax::fold::fold_attrs
               at /home/folkertdev/.cargo/registry/src/index.crates.io-6f17d22bba15001f/garando_syntax-0.1.0/src/fold.rs:329:5
     9: garando_syntax::fold::noop_fold_item_simple
               at /home/folkertdev/.cargo/registry/src/index.crates.io-6f17d22bba15001f/garando_syntax-0.1.0/src/fold.rs:1111:16

I'll see what we can do here. My guess is const fn being the most recent/weird bit of syntax here?

tgross35 · 2024-08-28T20:42:18Z

Well that's concerning.

I'll see what we can do here. My guess is const fn being the most recent/weird bit of syntax here?

Ah, that's a good guess. We have a macro that handles this, search for things with {const} syntax. This needs to change at some point before 1.0, but should work here if that is the problem.

folkertdev · 2024-08-28T20:53:27Z

btw that out-of-bounds access also happens on the current main branch locally for me. I tried upgrading ctest2 to the latest version, and it appears to just be broken (some function inside ctest2 expects another argument). So yeah, not great.

That also means that I can't actually locally reproduce the CI error unless I start messing with docker (which, I really don't want to do)

folkertdev · 2024-08-28T22:28:40Z

well, I figured it out. There were really two syntax problems that this crate cannot parse.

one issue is the expression for the length of the array

pub struct ptp_sys_offset {
    pub n_samples: ::c_uint,
    pub rsv: [::c_uint; 3],
    pub ts: [ptp_clock_time; 2 * PTP_MAX_SAMPLES as usize + 1],
}

which gave an error like this

  --- stderr
  rust version: 1.82.0-nightly
  thread 'main' panicked at /cargo/registry/src/index.crates.io-6f17d22bba15001f/ctest2-0.4.8/src/lib.rs:2233:26:
  unknown op: Spanned { node: Mul, span: Span { lo: BytePos(1434930), hi: BytePos(1434931), ctxt: #1760 } }

and then also the debug_asserts here cannot be parsed, giving the error we saw before

/// Build an ioctl number, analogous to the C macro of the same name.
const fn _IOC(dir: u32, ty: u32, nr: u32, size: usize) -> u32 {
    debug_assert!(dir <= _IOC_DIRMASK);
    debug_assert!(ty <= _IOC_TYPEMASK);
    debug_assert!(nr <= _IOC_NRMASK);
    debug_assert!(size <= (_IOC_SIZEMASK as usize));

    (dir << _IOC_DIRSHIFT)
        | (ty << _IOC_TYPESHIFT)
        | (nr << _IOC_NRSHIFT)
        | ((size as u32) << _IOC_SIZESHIFT)
}

so, I guess we just use a literal for that length, and I've commented the asserts for now. I am seeing another error that I'm not sure about. These constants are defined like so many of the other constants, so is it more that these constants are not defined in the libc that we're comparing with? They are defined here https://github.com/torvalds/linux/blob/928f79a188aacc057ba36c85b36b6d1e99c8f595/include/uapi/linux/ptp_clock.h#L234 and don't seem special otherwise.

  cargo:warning=/checkout/target/i686-unknown-linux-gnu/debug/build/libc-test-fa10219da99c25be/out/main.c:45289:77: error: 'PTP_MASK_CLEAR_ALL' undeclared here (not in a function)
  cargo:warning=45289 |             static const unsigned int __test_const_PTP_MASK_CLEAR_ALL_val = PTP_MASK_CLEAR_ALL;
  cargo:warning=      |                                                                             ^~~~~~~~~~~~~~~~~~
  cargo:warning=/checkout/target/i686-unknown-linux-gnu/debug/build/libc-test-fa10219da99c25be/out/main.c:45295:77: error: 'PTP_MASK_EN_SINGLE' undeclared here (not in a function)
  cargo:warning=45295 |             static const unsigned int __test_const_PTP_MASK_EN_SINGLE_val = PTP_MASK_EN_SINGLE;
  cargo:warning=      |                                                                             ^~~~~~~~~~~~~~~~~~

also there is some musl stuff that I'll need to figure out. Anyway, progress!

folkertdev · 2024-08-29T13:43:15Z

@tgross35 how do you recommend implementing this?

cfg_if! {
    if #[cfg(any(target_arch = "sparc", target_arch = "sparc64"))] {
        s!{
            pub struct ptp_clock_caps {
                pub max_adj: ::c_int,
                pub n_alarm: ::c_int,
                pub n_ext_ts: ::c_int,
                pub n_per_out: ::c_int,
                pub pps: ::c_int,
                pub n_pins: ::c_int,
                pub cross_timestamping: ::c_int,
                pub adjust_phase: ::c_int,
                pub rsv: [::c_int; 12],
            }
        }
    } else if #[cfg(any(target_env = "musl", target_env = "ohos"))] {
        s!{
            pub struct ptp_clock_caps {
                pub max_adj: ::c_int,
                pub n_alarm: ::c_int,
                pub n_ext_ts: ::c_int,
                pub n_per_out: ::c_int,
                pub pps: ::c_int,
                pub n_pins: ::c_int,
                pub cross_timestamping: ::c_int,
                pub rsv: [::c_int; 13],
            }
        }
    } else {
        s! {
            pub struct ptp_clock_caps {
                pub max_adj: ::c_int,
                pub n_alarm: ::c_int,
                pub n_ext_ts: ::c_int,
                pub n_per_out: ::c_int,
                pub pps: ::c_int,
                pub n_pins: ::c_int,
                pub cross_timestamping: ::c_int,
                pub adjust_phase: ::c_int,
                pub max_phase_adj: ::c_int,
                pub rsv: [::c_int; 11],
            }
        }
    }
}

it runs into a lint of having more than one s! per module. I can sort of inline the cfgs but that looks awful. cfg_if! can't be parsed when it's inside of the s! macro. So, ?

folkertdev · 2024-08-31T11:34:54Z

@rustbot review

bors · 2024-09-03T20:18:20Z

☔ The latest upstream changes (presumably #3480) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2024-11-06T20:48:04Z

☔ The latest upstream changes (presumably #3922) made this pull request unmergeable. Please resolve the merge conflicts.

tgross35

I didn't realize this was no longer blocked. Overall it looks pretty good to me, just some small refactoring suggestions and a clarification question.

libc-test/build.rs

src/unix/linux_like/linux/mod.rs

tgross35 · 2024-11-12T21:28:36Z

src/unix/linux_like/linux/mod.rs

+        #[cfg(any(target_arch = "sparc", target_arch = "sparc64"))]
+        pub adjust_phase: ::c_int,
+        #[cfg(any(target_arch = "sparc", target_arch = "sparc64"))]
+        pub rsv: [::c_int; 12],
+        #[cfg(any(target_env = "musl", target_env = "ohos"))]
+        pub rsv: [::c_int; 13],
+        #[cfg(not(any(
+            any(target_arch = "sparc", target_arch = "sparc64"),
+            any(target_env = "musl", target_env = "ohos"),
+        )))]
+        pub adjust_phase: ::c_int,
+        #[cfg(not(any(
+            any(target_arch = "sparc", target_arch = "sparc64"),
+            any(target_env = "musl", target_env = "ohos"),
+        )))]
+        pub max_phase_adj: ::c_int,
+        #[cfg(not(any(
+            any(target_arch = "sparc", target_arch = "sparc64"),
+            any(target_env = "musl", target_env = "ohos"),
+        )))]
+        pub rsv: [::c_int; 11],


Do you have a link to where these different configurations come from? I don't see anything sparc-specific in uapi

Also, to make this slightly cleaner you could add a cfg_if to specify a per-platform const PTP_CLOCK_CAPS_RSV_LEN: usize = /* 11 or 12 or 13 */;, then only have rsv: [::c_int; PTP_CLOCK_CAPS_RSV_LEN]

right now, this is just what makes CI happy. Honestly I don't know anything about sparc. Some fields were added later, so maybe the sparc version on CI is just old and still uses the older bigger rsv value?

src/unix/linux_like/linux/mod.rs

src/unix/linux_like/linux/ioctl.rs

tgross35 · 2024-11-12T21:50:53Z

src/unix/linux_like/linux/ioctl.rs

+    // TODO the `garando_syntax` crate (used by ctest2 in the CI test suite)
+    // cannot currently parse these `debug_assert!`s
+    //
+    // debug_assert!(dir <= _IOC_DIRMASK);
+    // debug_assert!(ty <= _IOC_TYPEMASK);
+    // debug_assert!(nr <= _IOC_NRMASK);
+    // debug_assert!(size <= (_IOC_SIZEMASK as usize));


Can it handle assert!? That would be fine anyway since this never gets called at runtime

sadly no https://github.com/rust-lang/libc/actions/runs/11823989236/job/32944513235

Alright, mind just changing TODO to FIXME(ctest)?

src/unix/linux_like/linux/ioctl.rs

it changed recently torvalds/linux@c259aca#diff-721f436093b6e07475c0784886e2092c2d0bc269397e0efd279fdf943ea55f27R175

folkertdev

hmm yeah splitting this up is probably a good idea. We do get a new CI error now...

  --- stderr
  error: expected `*` or `+`
     --> ../src/macros.rs:248:87
      |
  248 |                 pub $({$constness:ident})* fn $i:ident($($arg:ident: $argty:ty),* $(,)?) -> $ret:ty
      |                                                                                       ^

  error: expected `*` or `+`
     --> ../src/macros.rs:262:87
      |
  262 |                 pub $({$constness:ident})* fn $i:ident($($arg:ident: $argty:ty),* $(,)?) -> $ret:ty
      |                                                                                       ^

  error: expected `*` or `+`
     --> ../src/macros.rs:276:83
      |
  276 |                 $({$constness:ident})* fn $i:ident($($arg:ident: $argty:ty),* $(,)?) -> $ret:ty
      |                                                                                   ^

  thread 'main' panicked at /cargo/registry/src/index.crates.io-6f17d22bba15001f/garando_syntax-0.1.1/src/ext/expand.rs:337:21:
  internal error: entered unreachable code
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

folkertdev · 2024-11-19T10:55:19Z

src/unix/linux_like/linux/mod.rs

 pub type __kernel_fsid_t = __c_anonymous__kernel_fsid_t;
+pub type __kernel_clockid_t = ::c_int;


__kernel_fsid_t is not in the semver.txt, so I skipped the new one too. But maybe they should both be in there?

folkertdev · 2024-11-19T12:16:15Z

src/unix/linux_like/linux/mod.rs

+mod ioctl {
+    const _IOC_NRBITS: u32 = 8;
+    const _IOC_TYPEBITS: u32 = 8;


the error is back. Maybe the check is too strict, and just does not allow consts defined in inner modules? I can remove the module wrapper but bundling the symbols/logic with a mod is kind of nice

code is originally from rust-lang#3865

code is originally from rust-lang#3865.

bors · 2024-11-20T10:38:16Z

☔ The latest upstream changes (presumably #4113) made this pull request unmergeable. Please resolve the merge conflicts.

folkertdev · 2024-11-21T19:04:55Z

this was broken up into

code is originally from rust-lang#3865. (backport <rust-lang#4113>) (cherry picked from commit 511a002)

rustbot assigned tgross35 Aug 21, 2024

rustbot added the S-waiting-on-review label Aug 21, 2024

folkertdev mentioned this pull request Aug 21, 2024

Add all definitions from linux/ptp-clock.h #3559

Closed

folkertdev force-pushed the add-ptp-clock-main branch from e4948dd to fab755b Compare August 22, 2024 09:55

folkertdev commented Aug 22, 2024

View reviewed changes

rustbot added S-blocked and removed S-waiting-on-review labels Aug 28, 2024

tgross35 added the stable-nominated This PR should be considered for cherry-pick to libc's stable release branch label Aug 28, 2024

folkertdev force-pushed the add-ptp-clock-main branch 3 times, most recently from 81cd5c7 to d558fe2 Compare August 28, 2024 22:22

rustbot added S-waiting-on-review and removed S-blocked labels Aug 31, 2024

folkertdev force-pushed the add-ptp-clock-main branch from cf84cec to a458ded Compare September 4, 2024 14:39

arctic-alpaca mentioned this pull request Oct 1, 2024

Linux: update and add missing AF_XDP API #3956

Merged

3 tasks

tgross35 reviewed Nov 12, 2024

View reviewed changes

tgross35 removed the S-waiting-on-review label Nov 12, 2024

folkertdev and others added 13 commits November 19, 2024 12:09

add missed constants

4abfd63

remove PTP_MASK_CLEAR_ALL and PTP_MASK_EN_SINGLE for now

0fa9251

please musl

66c59b8

another attempt at ptp_clock_caps

f36c3de

uglier version of ptp_clock_caps

be73cc7

fixes after code review

d857c02

add ptp_pin_function

c0dea2a

define PTP_CLOCK_CAPS_RSV_LEN

810e82d

move ioctl functions to linux/mod.rs

49cd9aa

document that constant should be computed (when garando supports it)

97b4269

update ptp_sys_offset_extended to latest version

dbbf82c

it changed recently torvalds/linux@c259aca#diff-721f436093b6e07475c0784886e2092c2d0bc269397e0efd279fdf943ea55f27R175

todo -> fixme

c9d29cc

add symbols to semver/linux.txt

f550a24

folkertdev force-pushed the add-ptp-clock-main branch from 1213a8d to f550a24 Compare November 19, 2024 11:11

fix rebase problem

b3d2389

folkertdev force-pushed the add-ptp-clock-main branch from 7839913 to b3d2389 Compare November 19, 2024 11:23

folkertdev commented Nov 19, 2024

View reviewed changes

This was referenced Nov 19, 2024

add various ptp_* structs #4113

Merged

add various PTP_ consts #4114

Merged

folkertdev added a commit to folkertdev/libc that referenced this pull request Nov 19, 2024

add various ptp_* structs

68365a0

code is originally from rust-lang#3865

folkertdev added a commit to folkertdev/libc that referenced this pull request Nov 19, 2024

add various ptp_* structs

166b3eb

code is originally from rust-lang#3865.

folkertdev added a commit to folkertdev/libc that referenced this pull request Nov 20, 2024

add various ptp_* structs

511a002

code is originally from rust-lang#3865.

folkertdev added a commit to folkertdev/libc that referenced this pull request Nov 20, 2024

add various ptp_* structs

8b66aad

code is originally from rust-lang#3865.

folkertdev mentioned this pull request Nov 21, 2024

add ptp_clock_caps #4128

Merged

3 tasks

folkertdev closed this Nov 21, 2024

tgross35 removed the stable-nominated This PR should be considered for cherry-pick to libc's stable release branch label Nov 25, 2024

tgross35 pushed a commit to tgross35/rust-libc that referenced this pull request Nov 25, 2024

add various ptp_* structs

d0ed18d

code is originally from rust-lang#3865. (backport <rust-lang#4113>) (cherry picked from commit 511a002)

arctic-alpaca mentioned this pull request Nov 27, 2024

move AF_XDP structs and constants to linux/mod.rs #4163

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add all definitions from linux/ptp-clock.h #3865

Add all definitions from linux/ptp-clock.h #3865

folkertdev commented Aug 21, 2024

folkertdev commented Aug 21, 2024

folkertdev left a comment •

edited

Loading

folkertdev Aug 22, 2024

folkertdev Nov 19, 2024

rustbot commented Aug 22, 2024

rustbot commented Aug 22, 2024

tgross35 commented Aug 28, 2024 •

edited

Loading

tgross35 commented Aug 28, 2024

folkertdev commented Aug 28, 2024

tgross35 commented Aug 28, 2024

folkertdev commented Aug 28, 2024

folkertdev commented Aug 28, 2024

folkertdev commented Aug 29, 2024

folkertdev commented Aug 31, 2024

bors commented Sep 3, 2024

bors commented Nov 6, 2024

tgross35 left a comment

tgross35 Nov 12, 2024

tgross35 Nov 12, 2024

folkertdev Nov 13, 2024

tgross35 Nov 12, 2024

folkertdev Nov 13, 2024

tgross35 Nov 19, 2024

folkertdev left a comment

folkertdev Nov 19, 2024

folkertdev Nov 19, 2024

bors commented Nov 20, 2024

folkertdev commented Nov 21, 2024

		pub type __kernel_fsid_t = __c_anonymous__kernel_fsid_t;
		pub type __kernel_clockid_t = ::c_int;

Add all definitions from linux/ptp-clock.h #3865

Add all definitions from linux/ptp-clock.h #3865

Conversation

folkertdev commented Aug 21, 2024

folkertdev commented Aug 21, 2024

folkertdev left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustbot commented Aug 22, 2024

rustbot commented Aug 22, 2024

tgross35 commented Aug 28, 2024 • edited Loading

tgross35 commented Aug 28, 2024

folkertdev commented Aug 28, 2024

tgross35 commented Aug 28, 2024

folkertdev commented Aug 28, 2024

folkertdev commented Aug 28, 2024

folkertdev commented Aug 29, 2024

folkertdev commented Aug 31, 2024

bors commented Sep 3, 2024

bors commented Nov 6, 2024

tgross35 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

folkertdev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bors commented Nov 20, 2024

folkertdev commented Nov 21, 2024

folkertdev left a comment •

edited

Loading

tgross35 commented Aug 28, 2024 •

edited

Loading