[3.11] gh-95174: Handle missing dup() and constants in WASI (GH-95229)

tiran · tiran · commit dfdb0d3fc0fb · 2022-07-31T14:18:41.000+02:00
- check for ``dup()`` libc function - handle missing ``F_DUPFD`` in ``dup2()`` replacement function - add workaround for WASI libc bug in MSG_TRUNC - ESHUTDOWN is missing, use EPIPE instead - POLLPRI is missing, define as 0 (no-op). (cherry picked from commit 0d35a59) Co-authored-by: Christian Heimes <christian@python.org>
diff --git a/Misc/NEWS.d/next/Build/2022-07-25-08-59-35.gh-issue-95174.g8woUW.rst b/Misc/NEWS.d/next/Build/2022-07-25-08-59-35.gh-issue-95174.g8woUW.rst
@@ -0,0 +1,2 @@
+Python now detects missing ``dup`` function in WASI and works around some
+missing :mod:`errno`, :mod:`select`, and :mod:`socket` constants.
diff --git a/Modules/clinic/posixmodule.c.h b/Modules/clinic/posixmodule.c.h
diff --git a/Modules/errnomodule.c b/Modules/errnomodule.c
@@ -280,6 +280,10 @@ errno_exec(PyObject *module)
 #ifdef ENOANO
     add_errcode("ENOANO", ENOANO, "No anode");
 #endif
+#if defined(__wasi__) && !defined(ESHUTDOWN)
+    // WASI SDK 16 does not have ESHUTDOWN, shutdown results in EPIPE.
+    #define ESHUTDOWN EPIPE
+#endif
 #ifdef ESHUTDOWN
     add_errcode("ESHUTDOWN", ESHUTDOWN, "Cannot send after transport endpoint shutdown");
 #else
diff --git a/Modules/posixmodule.c b/Modules/posixmodule.c
@@ -9346,7 +9346,9 @@ os_dup_impl(PyObject *module, int fd)
     return _Py_dup(fd);
 }
 
-
+// dup2() is either provided by libc or dup2.c with AC_REPLACE_FUNCS().
+// dup2.c provides working dup2() if and only if F_DUPFD is available.
+#if (defined(HAVE_DUP3) || defined(F_DUPFD) || defined(MS_WINDOWS))
 /*[clinic input]
 os.dup2 -> int
     fd: int
@@ -9446,6 +9448,7 @@ os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)
 
     return res;
 }
+#endif
 
 
 #ifdef HAVE_LOCKF
diff --git a/Modules/selectmodule.c b/Modules/selectmodule.c
@@ -63,6 +63,11 @@ extern void bzero(void *, int);
 #  define SOCKET int
 #endif
 
+// WASI SDK 16 does not have POLLPRIO, define as no-op
+#if defined(__wasi__) && !defined(POLLPRI)
+#  define POLLPRI 0
+#endif
+
 typedef struct {
     PyObject *close;
     PyTypeObject *poll_Type;
diff --git a/Modules/socketmodule.c b/Modules/socketmodule.c
@@ -7650,6 +7650,10 @@ PyInit__socket(void)
     PyModule_AddIntMacro(m, MSG_EOR);
 #endif
 #ifdef  MSG_TRUNC
+    // workaround for https://github.com/WebAssembly/wasi-libc/issues/305
+    #if defined(__wasi__) && !defined(__WASI_RIFLAGS_RECV_DATA_TRUNCATED)
+    #  define __WASI_RIFLAGS_RECV_DATA_TRUNCATED 2
+    #endif
     PyModule_AddIntMacro(m, MSG_TRUNC);
 #endif
 #ifdef  MSG_CTRUNC
diff --git a/PC/pyconfig.h b/PC/pyconfig.h
@@ -681,6 +681,9 @@ Py_NO_ENABLE_SHARED to find out.  Also support MS_NO_COREDLL for b/w compat */
 /* Define if you have the 'inet_pton' function. */
 #define HAVE_INET_PTON 1
 
+/* Define to 1 if you have the `dup' function. */
+#define HAVE_DUP 1
+
 /* framework name */
 #define _PYTHONFRAMEWORK ""
 
diff --git a/Python/dup2.c b/Python/dup2.c
@@ -11,6 +11,7 @@
  * Return fd2 if all went well; return BADEXIT otherwise.
  */
 
+#include <errno.h>
 #include <fcntl.h>
 #include <unistd.h>
 
@@ -20,12 +21,17 @@ int
 dup2(int fd1, int fd2)
 {
     if (fd1 != fd2) {
+#ifdef F_DUPFD
         if (fcntl(fd1, F_GETFL) < 0)
             return BADEXIT;
         if (fcntl(fd2, F_GETFL) >= 0)
             close(fd2);
         if (fcntl(fd1, F_DUPFD, fd2) < 0)
             return BADEXIT;
+#else
+        errno = ENOTSUP;
+        return BADEXIT;
+#endif
     }
     return fd2;
 }
diff --git a/Python/fileutils.c b/Python/fileutils.c
@@ -2379,7 +2379,7 @@ _Py_dup(int fd)
         return -1;
     }
 
-#else
+#elif HAVE_DUP
     Py_BEGIN_ALLOW_THREADS
     _Py_BEGIN_SUPPRESS_IPH
     fd = dup(fd);
@@ -2396,6 +2396,10 @@ _Py_dup(int fd)
         _Py_END_SUPPRESS_IPH
         return -1;
     }
+#else
+    errno = ENOTSUP;
+    PyErr_SetFromErrno(PyExc_OSError);
+    return -1;
 #endif
     return fd;
 }
diff --git a/configure b/configure
diff --git a/configure.ac b/configure.ac
@@ -4537,7 +4537,7 @@ fi
 # checks for library functions
 AC_CHECK_FUNCS([ \
   accept4 alarm bind_textdomain_codeset chmod chown clock close_range confstr \
-  copy_file_range ctermid dup3 execv explicit_bzero explicit_memset \
+  copy_file_range ctermid dup dup3 execv explicit_bzero explicit_memset \
   faccessat fchmod fchmodat fchown fchownat fdopendir fdwalk fexecve \
   fork fork1 fpathconf fstatat ftime ftruncate futimens futimes futimesat \
   gai_strerror getegid getentropy geteuid getgid getgrgid getgrgid_r \
diff --git a/pyconfig.h.in b/pyconfig.h.in
@@ -278,6 +278,9 @@
 /* Define to 1 if you have the `dlopen' function. */
 #undef HAVE_DLOPEN
 
+/* Define to 1 if you have the `dup' function. */
+#undef HAVE_DUP
+
 /* Define to 1 if you have the `dup2' function. */
 #undef HAVE_DUP2
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	+Python now detects missing ``dup`` function in WASI and works around some
	`2`	+missing :mod:`errno`, :mod:`select`, and :mod:`socket` constants.
Original file line number	Diff line number	Diff line change
`@@ -9346,7 +9346,9 @@ os_dup_impl(PyObject *module, int fd)`
`9346`	`9346`	`return _Py_dup(fd);`
`9347`	`9347`	`}`
`9348`	`9348`
`9349`		`-`
	`9349`	`+// dup2() is either provided by libc or dup2.c with AC_REPLACE_FUNCS().`
	`9350`	`+// dup2.c provides working dup2() if and only if F_DUPFD is available.`
	`9351`	`+#if (defined(HAVE_DUP3) \|\| defined(F_DUPFD) \|\| defined(MS_WINDOWS))`
`9350`	`9352`	`/*[clinic input]`
`9351`	`9353`	`os.dup2 -> int`
`9352`	`9354`	`fd: int`
`@@ -9446,6 +9448,7 @@ os_dup2_impl(PyObject *module, int fd, int fd2, int inheritable)`
`9446`	`9448`
`9447`	`9449`	`return res;`
`9448`	`9450`	`}`
	`9451`	`+#endif`
`9449`	`9452`
`9450`	`9453`
`9451`	`9454`	`#ifdef HAVE_LOCKF`
Original file line number	Diff line number	Diff line change
`@@ -2379,7 +2379,7 @@ _Py_dup(int fd)`
`2379`	`2379`	`return -1;`
`2380`	`2380`	`}`
`2381`	`2381`
`2382`		`-#else`
	`2382`	`+#elif HAVE_DUP`
`2383`	`2383`	`Py_BEGIN_ALLOW_THREADS`
`2384`	`2384`	`_Py_BEGIN_SUPPRESS_IPH`
`2385`	`2385`	`fd = dup(fd);`
`@@ -2396,6 +2396,10 @@ _Py_dup(int fd)`
`2396`	`2396`	`_Py_END_SUPPRESS_IPH`
`2397`	`2397`	`return -1;`
`2398`	`2398`	`}`
	`2399`	`+#else`
	`2400`	`+ errno = ENOTSUP;`
	`2401`	`+ PyErr_SetFromErrno(PyExc_OSError);`
	`2402`	`+ return -1;`
`2399`	`2403`	`#endif`
`2400`	`2404`	`return fd;`
`2401`	`2405`	`}`