gh-94518: Port 23-argument `_posixsubprocess.fork_exec` to Argument Clinic (#94519)

Convert fork_exec to pre-inlined-argparser Argument Clinic

Co-authored-by: Gregory P. Smith <greg@krypto.org>

1 files changed, 162 insertions, 0 deletions

diff --git a/Modules/clinic/_posixsubprocess.c.h b/Modules/clinic/_posixsubprocess.c.h
new file mode 100644
index 0000000..f08878c
--- /dev/null
+++ b/Modules/clinic/_posixsubprocess.c.h
@@ -0,0 +1,162 @@
+/*[clinic input]
+preserve
+[clinic start generated code]*/
+
+#if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
+#  include "pycore_gc.h"            // PyGC_Head
+#  include "pycore_runtime.h"       // _Py_ID()
+#endif
+
+
+PyDoc_STRVAR(subprocess_fork_exec__doc__,
+"fork_exec($module, args, executable_list, close_fds, pass_fds, cwd,\n"
+"          env, p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite,\n"
+"          errpipe_read, errpipe_write, restore_signals, call_setsid,\n"
+"          pgid_to_set, gid, extra_groups, uid, child_umask, preexec_fn,\n"
+"          allow_vfork, /)\n"
+"--\n"
+"\n"
+"Spawn a fresh new child process.\n"
+"\n"
+"Fork a child process, close parent file descriptors as appropriate in the\n"
+"child and duplicate the few that are needed before calling exec() in the\n"
+"child process.\n"
+"\n"
+"If close_fds is True, close file descriptors 3 and higher, except those listed\n"
+"in the sorted tuple pass_fds.\n"
+"\n"
+"The preexec_fn, if supplied, will be called immediately before closing file\n"
+"descriptors and exec.\n"
+"\n"
+"WARNING: preexec_fn is NOT SAFE if your application uses threads.\n"
+"         It may trigger infrequent, difficult to debug deadlocks.\n"
+"\n"
+"If an error occurs in the child process before the exec, it is\n"
+"serialized and written to the errpipe_write fd per subprocess.py.\n"
+"\n"
+"Returns: the child process\'s PID.\n"
+"\n"
+"Raises: Only on an error in the parent process.");
+
+#define SUBPROCESS_FORK_EXEC_METHODDEF    \
+    {"fork_exec", _PyCFunction_CAST(subprocess_fork_exec), METH_FASTCALL, subprocess_fork_exec__doc__},
+
+static PyObject *
+subprocess_fork_exec_impl(PyObject *module, PyObject *process_args,
+                          PyObject *executable_list, int close_fds,
+                          PyObject *py_fds_to_keep, PyObject *cwd_obj,
+                          PyObject *env_list, int p2cread, int p2cwrite,
+                          int c2pread, int c2pwrite, int errread,
+                          int errwrite, int errpipe_read, int errpipe_write,
+                          int restore_signals, int call_setsid,
+                          pid_t pgid_to_set, PyObject *gid_object,
+                          PyObject *extra_groups_packed,
+                          PyObject *uid_object, int child_umask,
+                          PyObject *preexec_fn, int allow_vfork);
+
+static PyObject *
+subprocess_fork_exec(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
+{
+    PyObject *return_value = NULL;
+    PyObject *process_args;
+    PyObject *executable_list;
+    int close_fds;
+    PyObject *py_fds_to_keep;
+    PyObject *cwd_obj;
+    PyObject *env_list;
+    int p2cread;
+    int p2cwrite;
+    int c2pread;
+    int c2pwrite;
+    int errread;
+    int errwrite;
+    int errpipe_read;
+    int errpipe_write;
+    int restore_signals;
+    int call_setsid;
+    pid_t pgid_to_set;
+    PyObject *gid_object;
+    PyObject *extra_groups_packed;
+    PyObject *uid_object;
+    int child_umask;
+    PyObject *preexec_fn;
+    int allow_vfork;
+
+    if (!_PyArg_CheckPositional("fork_exec", nargs, 23, 23)) {
+        goto exit;
+    }
+    process_args = args[0];
+    executable_list = args[1];
+    close_fds = PyObject_IsTrue(args[2]);
+    if (close_fds < 0) {
+        goto exit;
+    }
+    if (!PyTuple_Check(args[3])) {
+        _PyArg_BadArgument("fork_exec", "argument 4", "tuple", args[3]);
+        goto exit;
+    }
+    py_fds_to_keep = args[3];
+    cwd_obj = args[4];
+    env_list = args[5];
+    p2cread = _PyLong_AsInt(args[6]);
+    if (p2cread == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    p2cwrite = _PyLong_AsInt(args[7]);
+    if (p2cwrite == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    c2pread = _PyLong_AsInt(args[8]);
+    if (c2pread == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    c2pwrite = _PyLong_AsInt(args[9]);
+    if (c2pwrite == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    errread = _PyLong_AsInt(args[10]);
+    if (errread == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    errwrite = _PyLong_AsInt(args[11]);
+    if (errwrite == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    errpipe_read = _PyLong_AsInt(args[12]);
+    if (errpipe_read == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    errpipe_write = _PyLong_AsInt(args[13]);
+    if (errpipe_write == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    restore_signals = PyObject_IsTrue(args[14]);
+    if (restore_signals < 0) {
+        goto exit;
+    }
+    call_setsid = PyObject_IsTrue(args[15]);
+    if (call_setsid < 0) {
+        goto exit;
+    }
+    pgid_to_set = PyLong_AsPid(args[16]);
+    if (pgid_to_set == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    gid_object = args[17];
+    extra_groups_packed = args[18];
+    uid_object = args[19];
+    child_umask = _PyLong_AsInt(args[20]);
+    if (child_umask == -1 && PyErr_Occurred()) {
+        goto exit;
+    }
+    preexec_fn = args[21];
+    allow_vfork = PyObject_IsTrue(args[22]);
+    if (allow_vfork < 0) {
+        goto exit;
+    }
+    return_value = subprocess_fork_exec_impl(module, process_args, executable_list, close_fds, py_fds_to_keep, cwd_obj, env_list, p2cread, p2cwrite, c2pread, c2pwrite, errread, errwrite, errpipe_read, errpipe_write, restore_signals, call_setsid, pgid_to_set, gid_object, extra_groups_packed, uid_object, child_umask, preexec_fn, allow_vfork);
+
+exit:
+    return return_value;
+}
+/*[clinic end generated code: output=46d71e86845c93d7 input=a9049054013a1b77]*/