From 3be1ed05101f73d65971c3dacae677a1edf3b983 Mon Sep 17 00:00:00 2001
From: Pat Tullmann <pat.github@tullmann.org>
Date: Thu, 15 Aug 2024 23:28:09 -0700
Subject: [PATCH] wasi c.zig: Update comments around wasi-libc constants

Point to the correct header files where the wasi-libc constants are
defined that the Zig lib/std/c.zig is replicating.

Zig's current copy of wasi-libc has a bug in the file-mode constants.
Both S_IFIFO and S_IFSOCK are 0xc000, but S_IFIFO should be 0x1000.  See
https://github.com/WebAssembly/wasi-libc/pull/463.
---
 lib/std/c.zig | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/lib/std/c.zig b/lib/std/c.zig
index 2829069dce84..6a0a57ae04e4 100644
--- a/lib/std/c.zig
+++ b/lib/std/c.zig
@@ -672,6 +672,7 @@ pub const F = switch (native_os) {
     .linux => linux.F,
     .emscripten => emscripten.F,
     .wasi => struct {
+        // Match F_* constants from lib/libc/include/wasm-wasi-musl/__header_fcntl.h
         pub const GETFD = 1;
         pub const SETFD = 2;
         pub const GETFL = 3;
@@ -1703,14 +1704,20 @@ pub const S = switch (native_os) {
     .linux => linux.S,
     .emscripten => emscripten.S,
     .wasi => struct {
-        // Match wasi-libc's libc-bottom-half/headers/public/__mode_t.h
+        // Match S_* constants from lib/libc/include/wasm-wasi-musl/__mode_t.h
+        //
+        // Note, a bug in wasi-libc means both IFIFO and IFSOCK have the same value (0xc000).
+        // IFIFO should be 0x1000 (see https://github.com/WebAssembly/wasi-libc/pull/463), and
+        // 0x1000 is used by the wasi-libc bottom-half.  So we use 0x1000 here.  But the actual bit
+        // values we get back from a wasi-libc may get masked with the wrong values, or may get
+        // mistranslated.  So the FIFO and Socket file-type bits are not trustworthy.
         pub const IFBLK = 0x6000;
         pub const IFCHR = 0x2000;
         pub const IFDIR = 0x4000;
-        pub const IFIFO = 0x1000;
+        pub const IFIFO = 0x1000; // buggy
         pub const IFLNK = 0xa000;
         pub const IFREG = 0x8000;
-        pub const IFSOCK = 0xc000;
+        pub const IFSOCK = 0xc000; // buggy
         pub const IFMT = IFBLK | IFCHR | IFDIR | IFIFO | IFLNK | IFREG | IFSOCK;
 
         pub fn ISBLK(m: u32) bool {
@@ -6513,7 +6520,7 @@ pub const Stat = switch (native_os) {
     },
     .emscripten => emscripten.Stat,
     .wasi => extern struct {
-        // Matches wasi-libc's libc-bottom-half/headers/public/__struct_stat.h
+        // Matches wasi-libc's struct stat in lib/libc/include/wasm-wasi-musl/__struct_stat.h
         dev: dev_t,
         ino: ino_t,
         nlink: nlink_t,
@@ -7213,7 +7220,7 @@ pub const AT = switch (native_os) {
         pub const RECURSIVE = 0x8000;
     },
     .wasi => struct {
-        // Match AT_* constants in wasi-libc libc-bottom-half/headers/public/__header_fcntl.h
+        // Match AT_* constants in lib/libc/include/wasm-wasi-musl/__header_fcntl.h
         pub const FDCWD = -2;
         pub const EACCESS = 0x0;
         pub const SYMLINK_NOFOLLOW = 0x1;
@@ -7248,7 +7255,7 @@ pub const O = switch (native_os) {
         _: u9 = 0,
     },
     .wasi => packed struct(u32) {
-        // Match layout from wasi-libc libc-bottom-half/headers/public/__header_fcntl.h
+        // Match O_* bits from lib/libc/include/wasm-wasi-musl/__header_fcntl.h
         APPEND: bool = false,
         DSYNC: bool = false,
         NONBLOCK: bool = false,