Skip to content

freebsd(13.2): add netlink/netlink.h support - #5326

Open
dybucc wants to merge 2 commits into
rust-lang:mainfrom
dybucc:freebsd-netlink
Open

freebsd(13.2): add netlink/netlink.h support#5326
dybucc wants to merge 2 commits into
rust-lang:mainfrom
dybucc:freebsd-netlink

Conversation

@dybucc

@dybucc dybucc commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Description

This PR updates #3201 with merge conflicts resolved and follows the new plan at
1.

The patch adds support for netlink.h interfaces in OpenBSD, where there's an
item resolution conflict if we expose the Rust bindings alongside those of
if_mib.h. This set of APIs is "scoped" in C because they live on separate
headers. In rust-lang/libc, we reexport all items at the root crate level, which
makes item resolution fail.

Note this depends on #5325. It won't pass tests but it will build. This is
because the test templates will gather all items in a single file, so item
resolution fails. We can't really skip these items altogether from the tests, so
it may just be necessary to extend ctest to allow skipping module-specific
Rust items.

Closes: #3201
Closes: #3194

Checklist

  • Relevant tests in libc-test/semver have been updated
  • Commit messages permalink to headers for added or changed API
  • Placeholder or unstable values like *LAST or *MAX have the standard
    doc comment
  • Tested locally (cargo test -p libc-test --target mytarget); especially
    relevant for platforms that may not be checked in CI

@rustbot label +stable-nominated

Footnotes

  1. https://github.com/rust-lang/libc/pull/3201#issuecomment-4736374182

@rustbot rustbot added O-bsd O-freebsd S-waiting-on-review stable-nominated This PR should be considered for cherry-pick to libc's stable release branch labels Jul 24, 2026
@dybucc dybucc mentioned this pull request Jul 24, 2026
2 tasks
@dybucc
dybucc force-pushed the freebsd-netlink branch from f53fbf1 to c7886ff Compare July 27, 2026 06:28
@rustbot rustbot added the A-CI Area: CI-related items label Jul 27, 2026
@rustbot

This comment has been minimized.

@dybucc
dybucc force-pushed the freebsd-netlink branch 3 times, most recently from 653f197 to 0b6bb29 Compare July 29, 2026 07:34
@rustbot

This comment has been minimized.

@tgross35

Copy link
Copy Markdown
Member

The API looks fine from a quick skim, but since there is no hurry, I think it may be worth trying to add support to ctest first so the tricky test setup isn't needed. (It's useful otherwise too.)

Sketched some of that up at #5344

@dybucc

dybucc commented Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Noted. Since you already pinged some contributor on that issue, I'll wait and
see whether they want to implement it. Otherwise, I'll do it.

@tgross35

tgross35 commented Aug 4, 2026

Copy link
Copy Markdown
Member

Could you try adding a separate TestGenerator instance like @mbyx recommended in that issue? Since it's split off, that should avoid the need to reexport libc::netlink at test root too.

@tgross35

tgross35 commented Aug 4, 2026

Copy link
Copy Markdown
Member

Either author or blocked, depending on whether that works.

@rustbot author

@rustbot

rustbot commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

Reminder, once the PR becomes ready for a review, use @rustbot ready.

@rustbot

This comment has been minimized.

@rustbot

This comment has been minimized.

@rustbot

This comment has been minimized.

Comment thread libc-test/build/main.rs Outdated
Comment thread libc-test/build/main.rs Outdated
Comment thread src/new/freebsd/netlink/mod.rs Outdated
@dybucc

dybucc commented Aug 10, 2026

Copy link
Copy Markdown
Contributor Author

It seems having separate invocations gets the job done just fine. Still, that
was the same thing I tried in the initial patch. The added complexity comes when
we need to get the SemVer tests to pass.

Those seem to me like they're going to need extending (though it's notably less
work than with ctest as it's all in libc-test's build script.)

@rustbot

This comment has been minimized.

@dybucc
dybucc force-pushed the freebsd-netlink branch 2 times, most recently from 745bf15 to be6cc74 Compare August 12, 2026 07:14
@dybucc

dybucc commented Aug 15, 2026

Copy link
Copy Markdown
Contributor Author

@rustbot ready

@tgross35 tgross35 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cc @asomers, could you take a look when you get the chance?

View changes since this review

Comment thread libc-test/build/main.rs Outdated
Comment thread libc-test/build/main.rs Outdated
Comment thread src/new/freebsd/netlink/mod.rs Outdated
Comment thread src/new/freebsd/netlink/netlink_generic.rs Outdated
Comment thread src/new/mod.rs Outdated
@rustbot

This comment has been minimized.

@dybucc

dybucc commented Aug 21, 2026

Copy link
Copy Markdown
Contributor Author

@rustbot ready

@tgross35 tgross35 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also it looks like CI isn't yet passing, currently stuck on style but make sure the FreeBSD tests pass too.

View changes since this review

Comment thread libc-test/build/main.rs Outdated
Comment thread src/new/freebsd/mod.rs Outdated
Comment thread src/new/mod.rs

pub use freebsd::netlink::netlink::*;
pub use freebsd::netlink::netlink_generic::*;
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just rename src/new/freebsd/netlink/netlink.rs to netlink_.rs or something, so we can keep the glob export? Think this might be done elsewhere as well.

Just add a comment by the mod netlink_ explaining why it has that name.

@dybucc dybucc Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is a good idea. The new module's directory layout
is meant to provide a fairly accurate mapping between upstream and our
Rust module tree. Starting to allow this type of "exceptions" seems to
me like we're just muddying things up (to eventually be back at having
something as hard to grok as we have now outside new.)

I don't know of prior precedent to this, so we could very well be
already allowing this. Still, considering this is simply to replace an
inline module with the containing reexports, it doesn't seem worth it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do have a few exceptions when things don't work well, e.g. if.h is a common header that needs to be named if_.rs because of the keyword. To me it's worth a minor exception to avoid duplicate the API list in new/mod.rs, those should be pretty few and far between. But I won't block on it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am guessing you mean to rename the top-level freebsd::netlink
module, as that is the one that is reexported in new's root module. If
so, done.

Comment thread libc-test/build/main.rs
Comment on lines +2617 to +2621
.skip_union(|_| true)
.skip_alias(|_| true)
.skip_static(|_| true)
.skip_fn(|_| true)
.skip_c_enum(|_| true);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These shouldn't be needed anymore right?

@dybucc dybucc Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so. IIUC, TestGenerator will parse the Rust files, which
we presently can't restrict to a subset of the codebase. If these are
removed, we'd be setting up test for all the types that are not part of
the netlink module, even if we've only provided the #include for the
netlink interfaces (a few lines above this comment.)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, right, that's inconvenient. Mind adding a comment?

Would be nice if we had a way to restrict to certain modules, feel free to open an issue if you're up to it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flawless nerd sniping.

Comment thread libc-test/build/main.rs Outdated
@dybucc

dybucc commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

CI fails now because of a recent unused-group lint that was added in
rust-lang/rust#157036. We happen to have macros that add this by
default, but that don't merge them when munching the repr attributes.
Maybe that is the solution, but I have other PR reviews to go through
first, so I can't work on that just yet.

Edit: The CI failures are already being addressed at #5446.

@rustbot ready

@rustbot

This comment has been minimized.

@tgross35

Copy link
Copy Markdown
Member

Overall looks pretty good to me, @asomers or original PR author @ydirson would you mind taking a look?

dybucc and others added 2 commits August 31, 2026 16:29
This is an early subset of the Netlink interface, but it proves
sufficient for monitoring changes in IP addresses. Coverage can be
extended later as needed.  See [^1] and [^2].

[^1]: <https://github.com/freebsd/freebsd-src/blob/df9d6403caa6426e92f5e100602f4d2be474bbae/sys/netlink/netlink.h>
[^2]: <https://github.com/freebsd/freebsd-src/blob/df9d6403caa6426e92f5e100602f4d2be474bbae/sys/netlink/netlink_generic.h>

A small workaround has been necessary in the SemVer tests to ensure we
get the right paths to the public submodules for the `netlink/netlink.h`
and `netlink/netling_generic.h` interfaces. Those symbols now are
prepended a `netlink` super module path.

Signed-off-by: Yann Dirson <yann.dirson@vates.fr>

Co-authored-by: Yann Dirson <yann.dirson@vates.fr>
Add specific test for `netlink/netlink.h` bindings. This is necessary to
avoid conflicts with the bindings for `net/if_mib.h`. libc-test now
builds two different `TestGenerator` instances.

One of the instances builds tests for the same set of bindings as before
this patchset, while the other builds tests only for the
`netlink/netlink.h` bindings.
@rustbot

rustbot commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-CI Area: CI-related items O-bsd O-freebsd S-waiting-on-maintainer S-waiting-on-review stable-nominated This PR should be considered for cherry-pick to libc's stable release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Netlink support on FreeBSD 13.2+

3 participants