ziglang/zig
264
6.0k
Fork
You've already forked zig
795

Implement CMSG_*-equivalent functionality to std.c, enabling the effective use of std.c.cmsghdr. #30629

Open
opened 2025年12月30日 20:58:24 +01:00 by pltrz · 2 comments

This comment brought up this concern, and sums it up pretty well. Unfortunately it wasn't made into it's own issue.

To send and receive file descriptors in C, you need to interface with the libc cmsghdr struct, and you're supposed to do so via the CMSG_* macros which are defined in <sys/socket.h> in the C standard library.

I see that there is already a std.c.cmsghdr struct (see also: std.c.posix_cmsghdr, std.os.linux.cmsghdr).

But, there isn't a way to interface with this API in Zig (as far as I understand).

This comment explains some stuff as well on the topic.

I put together the list of the macros from <sys/socket.h>:

  • CMSG_DATA(): Defined in POSIX at least since Issue 6
  • CMSG_NXTHDR(): Defined in POSIX at least since Issue 6
  • CMSG_FIRSTHDR(): Defined in POSIX at least since Issue 6
  • CMSG_SPACE(): Defined in POSIX at least since Issue 8
  • CMSG_LEN(): Defined in POSIX at least since Issue 8
  • CMSG_ALIGN(): Linux Extension, since v2.1.15

Some further reading:

[This comment](https://github.com/ziglang/zig/pull/24603#issuecomment-3136040106) brought up this concern, and sums it up pretty well. Unfortunately it wasn't made into it's own issue. To send and receive file descriptors in C, you need to interface with the libc `cmsghdr` struct, and you're supposed to do so via the `CMSG_*` macros which are defined in `<sys/socket.h>` in the C standard library. I see that there is already a `std.c.cmsghdr` struct (see also: `std.c.posix_cmsghdr`, `std.os.linux.cmsghdr`). But, there isn't a way to interface with this API in Zig (as far as I understand). [This comment](https://github.com/ziglang/zig/pull/25118#issuecomment-3246571861) explains some stuff as well on the topic. I put together the list of the macros from `<sys/socket.h>`: - `CMSG_DATA()`: Defined in POSIX at least since Issue 6 - `CMSG_NXTHDR()`: Defined in POSIX at least since Issue 6 - `CMSG_FIRSTHDR()`: Defined in POSIX at least since Issue 6 - `CMSG_SPACE()`: Defined in POSIX at least since Issue 8 - `CMSG_LEN()`: Defined in POSIX at least since Issue 8 - `CMSG_ALIGN()`: Linux Extension, since v2.1.15 ## Some further reading: - [ZIG: GH: Comment that describes this issue](https://github.com/ziglang/zig/pull/24603#issuecomment-3136040106) - [ZIG: An example of another user's Zig abstraction for using the `cmsg_hdr` struct](https://github.com/gdnsd/gdnsd/blob/3.99-alpha/gks/ancil.zig) - [ZIG: GH: PR #25118](https://github.com/ziglang/zig/pull/25118#issuecomment-3246571861) - [POSIX: ISSUE 6: socket.h](https://pubs.opengroup.org/onlinepubs/009695399/basedefs/sys/socket.h.html) - [POSIX: ISSUE 7: socket.h](https://pubs.opengroup.org/onlinepubs/9699919799.2008edition/basedefs/sys_socket.h.html) - [POSIX: ISSUE 8: socket.h](https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/sys_socket.h.html) - [LINUX: CMSG_ALIGN patch](https://ftp.funet.fi/index/Linux/kernel/v2.1/patch-html/patch-2.1.15/linux_include_linux_socket.h.html) - [LINUX: v2.1.14: socket.h](https://elixir.bootlin.com/linux/2.1.14/source/include/linux/socket.h) - [LINUX: v2.1.15: socket.h](https://elixir.bootlin.com/linux/2.1.15/source/include/linux/socket.h) - [MUSL: socket.h](https://git.musl-libc.org/cgit/musl/plain/include/sys/socket.h) - [GLIBC: socket.h](https://sourceware.org/git/gitweb.cgi?p=glibc.git;a=blob_plain;f=include/sys/socket.h;hb=HEAD) - [RUST: cmsghdr](https://docs.rs/libc/latest/libc/struct.cmsghdr.html)

I am working with unix sockets for one of my projects and I encountered this problem.
In Zig 0.16 the Io operations moved to the Io interface. The Io.net.UnixAddress struct has the method connect which gives you a Io.net.Stream struct wich represents the connection and has a reader and writer.

The problem is that the reader and writer both use the functions io.vtable.netRead and io.vtable.netWrite which doesn't manage the ancillary data at all. So now you must use the io.vtable functions that manage this ancillary data, manually.

In this case those functions are io.vtable.netSend and io.vtable.netOperate with the operation net_receive. Both sends and receive the data using the structs Io.net.OutgoingMessage and Io.net.IncomingMessage respectively.

These structs are not exactly posix.msghdr so is impossible to use the macros imported from <sys/socket.h> to iterate safely over the control: []u8 field inside Io.net.IncomingMessage and Io.net.OutgoingMessage.

I am thinking of implementing some sort of cross platform iterator which takes the control field of these structs, iterates on it safely, aligning memory correctly, bounds check, etc. And gives you a struct ControlMessage whith this data:

constControlMessage=struct{header:std.c.cmsghdr,data:[]u8};

This is only a fast thought implementation. We could discuss how to really implement this feature.
Also I can be the one implementing this too.

I am working with unix sockets for one of my projects and I encountered this problem. In Zig 0.16 the Io operations moved to the `Io` interface. The `Io.net.UnixAddress` struct has the method `connect` which gives you a `Io.net.Stream` struct wich represents the connection and has a reader and writer. The problem is that the reader and writer both use the functions `io.vtable.netRead` and `io.vtable.netWrite` which doesn't manage the ancillary data at all. So now you must use the `io.vtable` functions that manage this ancillary data, manually. In this case those functions are `io.vtable.netSend` and `io.vtable.netOperate` with the operation `net_receive`. Both sends and receive the data using the structs `Io.net.OutgoingMessage` and `Io.net.IncomingMessage` respectively. These structs are not exactly `posix.msghdr` so is impossible to use the macros imported from `<sys/socket.h>` to iterate safely over the `control: []u8` field inside `Io.net.IncomingMessage` and `Io.net.OutgoingMessage`. I am thinking of implementing some sort of cross platform iterator which takes the `control` field of these structs, iterates on it safely, aligning memory correctly, bounds check, etc. And gives you a struct `ControlMessage` whith this data: ```zig const ControlMessage = struct { header: std.c.cmsghdr, data: []u8 }; ``` This is only a fast thought implementation. We could discuss how to really implement this feature. Also I can be the one implementing this too.

Sorry I looked better at the standard library and the Io.net.Socket struct has the methods sendMany and receive/receiveManyTimeout so there's not only the raw io.vtable.netSend and io.vtable.netOperate functions.

But the problem is still the same. Neither Io.net.IncomingMessage nor Io.net.OutgoingMessage has any way to handle their control field.

Sorry I looked better at the standard library and the `Io.net.Socket` struct has the methods `sendMany` and `receive`/`receiveManyTimeout` so there's not only the raw `io.vtable.netSend` and `io.vtable.netOperate` functions. But the problem is still the same. Neither `Io.net.IncomingMessage` nor `Io.net.OutgoingMessage` has any way to handle their `control` field.
Sign in to join this conversation.
No Branch/Tag specified
master
elfv2
spork8
restricted
0.16.x
panic-rewrite
parking-futex-lockfree
windows-Io-cleanup
Io-watch
ParseCommandLineOptions
windows-async-files
poll-ring
debug-file-leaks-differently
debug-file-leaks
ProcessPrng
elfv2-dyn
jobserver
threadtheft
io-threaded-no-queue
0.15.x
Io.net
comptime-allocator
restricted-function-pointers
cli
wasm-linker-writer
wrangle-writer-buffering
sha1-stream
async-await-demo
fixes
0.14.x
ast-node-methods
macos-debug-info
make-vs-configure
fuzz-macos
sans-aro
ArrayList-reserve
incr-bug
llvm-ir-nosanitize-metadata
ci-tarballs
ci-scripts
threadpool
0.12.x
new-pkg-hash
json-diagnostics
more-doctests
rework-comptime-mutation
0.11.x
ci-perf-comment
stage2-async
0.10.x
autofix
0.9.x
aro
hcs
0.8.x
0.7.x
0.16.0
0.15.2
0.15.1
0.15.0
0.14.1
0.14.0
0.12.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.1
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.1
0.1.0
Labels
Clear labels
abi/f32
abi/ilp32
abi/sf
accepted
This proposal is planned.
arch/21k
arch/6502
arch/aarch64
arch/alpha
arch/amdgcn
arch/arc
arch/arc32
arch/arc64
arch/arm
arch/avr
arch/bfin
arch/bpf
arch/colossus
arch/cris
arch/csky
arch/dlx
arch/epiphany
arch/fr30
arch/frv
arch/hexagon
arch/hppa
arch/hppa64
arch/ia64
arch/kalimba
arch/kvx
arch/lanai
arch/lm32
arch/loongarch32
arch/loongarch64
arch/m32r
arch/m68k
arch/m88k
arch/mcore
arch/microblaze
arch/mips
arch/mips64
arch/mmix
arch/moxie
arch/mrisc32
arch/msp430
arch/nds32
arch/ns32k
arch/nvptx
arch/or1k
arch/powerpc
arch/powerpc64
arch/propeller
arch/riscv32
arch/riscv64
arch/rl78
arch/rx
arch/s390x
arch/sh
arch/sparc
arch/sparc64
arch/spirv
arch/spu
arch/tricore
arch/v850
arch/vax
arch/vc4
arch/ve
arch/wasm
arch/x86
arch/x86_64
arch/xcore
arch/xtensa
autodoc
The web application for interactive documentation and generation of its assets.
backend/c
The C backend outputs C source code.
backend/llvm
The LLVM backend outputs an LLVM bitcode module.
backend/self-hosted
The self-hosted backends produce machine code directly.
binutils
Zig's included binary utilities: zig ar, zig dlltool, zig lib, zig ranlib, zig objcopy, and zig rc.
breaking
Implementing this issue could cause existing code to no longer compile or have different behavior.
build system
The Zig build system - zig build, std.Build, the build runner, and package management.
debug info
An issue related to debug information (e.g. DWARF) produced by the Zig compiler.
docs
An issue with documentation, e.g. the language reference or standard library doc comments.
error message
This issue points out an error message that is unhelpful and should be improved.
frontend
Tokenization, parsing, AstGen, ZonGen, Sema, Legalize, and Liveness.
fuzzing
An issue related to Zig's integrated fuzz testing.
incremental
Reuse of internal compiler state for faster compilation.
lib/c
This issue relates to Zig's libc implementation and/or vendored libcs.
lib/compiler-rt
This issue relates to Zig's compiler-rt library.
lib/cxx
This issue relates to Zig's vendored libc++ and/or libc++abi.
lib/std
This issue relates to Zig's standard library.
lib/tsan
This issue relates to Zig's vendored libtsan.
lib/ubsan-rt
This issue relates to Zig's ubsan-rt library.
lib/unwind
This issue relates to Zig's vendored libunwind.
linking
Zig's integrated object file and incremental linker.
miscompilation
The compiler reports success but produces semantically incorrect code.
os/android
os/contiki
os/dragonfly
os/driverkit
os/emscripten
os/freebsd
os/fuchsia
os/haiku
os/hermit
os/hurd
os/illumos
os/ios
os/linux
os/maccatalyst
os/macos
os/managarm
os/netbsd
os/ohos
os/openbsd
os/plan9
os/redox
os/rtems
os/serenity
os/tvos
os/uefi
os/visionos
os/wasi
os/watchos
os/windows
proposal
This issue suggests language modifications. If it also has the "accepted" label then it is planned.
release notes
This issue or pull request should be mentioned in the release notes.
testing
This issue is related to testing the compiler, standard library, or other parts of Zig.
zig cc
Zig as a drop-in C-family compiler.
zig fmt
The Zig source code formatter.
zig reduce
The Zig source code reduction tool.
bounty
https://ziglang.org/news/announcing-donor-bounties
bug
Observed behavior contradicts documented or intended behavior.
contributor-friendly
This issue is limited in scope and/or knowledge of project internals.
downstream
An issue with a third-party project that uses this project.
enhancement
Solving this issue will likely involve adding new logic or components to the codebase.
infra
An issue related to project infrastructure, e.g. continuous integration.
optimization
A task to improve performance and/or resource usage.
question
No questions on the issue tracker; use a community space instead.
regression
Something that used to work in a previous version stopped working
upstream
An issue with a third-party project that this project uses.
use case
Describes a real use case that is difficult or impossible, but does not propose a solution.
No labels
abi/f32
abi/ilp32
abi/sf
accepted
arch/21k
arch/6502
arch/aarch64
arch/alpha
arch/amdgcn
arch/arc
arch/arc32
arch/arc64
arch/arm
arch/avr
arch/bfin
arch/bpf
arch/colossus
arch/cris
arch/csky
arch/dlx
arch/epiphany
arch/fr30
arch/frv
arch/hexagon
arch/hppa
arch/hppa64
arch/ia64
arch/kalimba
arch/kvx
arch/lanai
arch/lm32
arch/loongarch32
arch/loongarch64
arch/m32r
arch/m68k
arch/m88k
arch/mcore
arch/microblaze
arch/mips
arch/mips64
arch/mmix
arch/moxie
arch/mrisc32
arch/msp430
arch/nds32
arch/ns32k
arch/nvptx
arch/or1k
arch/powerpc
arch/powerpc64
arch/propeller
arch/riscv32
arch/riscv64
arch/rl78
arch/rx
arch/s390x
arch/sh
arch/sparc
arch/sparc64
arch/spirv
arch/spu
arch/tricore
arch/v850
arch/vax
arch/vc4
arch/ve
arch/wasm
arch/x86
arch/x86_64
arch/xcore
arch/xtensa
autodoc
backend/c
backend/llvm
backend/self-hosted
binutils
breaking
build system
debug info
docs
error message
frontend
fuzzing
incremental
lib/c
lib/compiler-rt
lib/cxx
lib/std
lib/tsan
lib/ubsan-rt
lib/unwind
linking
miscompilation
os/android
os/contiki
os/dragonfly
os/driverkit
os/emscripten
os/freebsd
os/fuchsia
os/haiku
os/hermit
os/hurd
os/illumos
os/ios
os/linux
os/maccatalyst
os/macos
os/managarm
os/netbsd
os/ohos
os/openbsd
os/plan9
os/redox
os/rtems
os/serenity
os/tvos
os/uefi
os/visionos
os/wasi
os/watchos
os/windows
proposal
release notes
testing
zig cc
zig fmt
zig reduce
bounty
bug
contributor-friendly
downstream
enhancement
infra
optimization
question
regression
upstream
use case
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ziglang/zig#30629
Reference in a new issue
ziglang/zig
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?