glibc/posix/spawn_int.h
Adhemerval Zanella Netto 0d6f9f6265 posix: Add pidfd_spawn and pidfd_spawnp (BZ 30349)
Returning a pidfd allows a process to keep a race-free handle for a
child process, otherwise, the caller will need to either use pidfd_open
(which still might be subject to TOCTOU) or keep the old racy interface
base on pid_t.

To correct use pifd_spawn, the kernel must support not only returning
the pidfd with clone/clone3 but also waitid (P_PIDFD) (added on Linux
5.4).  If kernel does not support the waitid, pidfd return ENOSYS.
It avoids the need to racy workarounds, such as reading the procfs
fdinfo to get the pid to use along with other wait interfaces.

These interfaces are similar to the posix_spawn and posix_spawnp, with
the only difference being it returns a process file descriptor (int)
instead of a process ID (pid_t).  Their prototypes are:

  int pidfd_spawn (int *restrict pidfd,
                   const char *restrict file,
                   const posix_spawn_file_actions_t *restrict facts,
                   const posix_spawnattr_t *restrict attrp,
                   char *const argv[restrict],
                   char *const envp[restrict])

  int pidfd_spawnp (int *restrict pidfd,
                    const char *restrict path,
                    const posix_spawn_file_actions_t *restrict facts,
                    const posix_spawnattr_t *restrict attrp,
                    char *const argv[restrict_arr],
                    char *const envp[restrict_arr]);

A new symbol is used instead of a posix_spawn extension to avoid
possible issues with language bindings that might track the return
argument lifetime.  Although on Linux pid_t and int are interchangeable,
POSIX only states that pid_t should be a signed integer.

Both symbols reuse the posix_spawn posix_spawn_file_actions_t and
posix_spawnattr_t, to void rehash posix_spawn API or add a new one. It
also means that both interfaces support the same attribute and file
actions, and a new flag or file action on posix_spawn is also added
automatically for pidfd_spawn.

Also, using posix_spawn plumbing allows the reusing of most of the
current testing with some changes:

  - waitid is used instead of waitpid since it is a more generic
    interface.

  - tst-posix_spawn-setsid.c is adapted to take into consideration that
    the caller can check for session id directly.  The test now spawns
itself and writes the session id as a file instead.

  - tst-spawn3.c need to know where pidfd_spawn is used so it keeps an
    extra file description unused.

Checked on x86_64-linux-gnu on Linux 4.15 (no CLONE_PIDFD or waitid
support), Linux 5.4 (full support), and Linux 6.2.
Reviewed-by: Florian Weimer <fweimer@redhat.com>
2023-09-05 13:08:59 -03:00

95 lines
2.3 KiB
C

/* Internal definitions for posix_spawn functionality.
Copyright (C) 2000-2023 Free Software Foundation, Inc.
This file is part of the GNU C Library.
The GNU C Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The GNU C Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the GNU C Library; if not, see
<https://www.gnu.org/licenses/>. */
#ifndef _SPAWN_INT_H
#define _SPAWN_INT_H
#include <spawn.h>
#include <spawn_int_def.h>
#include <stdbool.h>
/* Data structure to contain the action information. */
struct __spawn_action
{
enum
{
spawn_do_close,
spawn_do_dup2,
spawn_do_open,
spawn_do_chdir,
spawn_do_fchdir,
spawn_do_closefrom,
spawn_do_tcsetpgrp
} tag;
union
{
struct
{
int fd;
} close_action;
struct
{
int fd;
int newfd;
} dup2_action;
struct
{
int fd;
char *path;
int oflag;
mode_t mode;
} open_action;
struct
{
char *path;
} chdir_action;
struct
{
int fd;
} fchdir_action;
struct
{
int from;
} closefrom_action;
struct
{
int fd;
} setpgrp_action;
} action;
};
#define SPAWN_XFLAGS_USE_PATH 0x1
#define SPAWN_XFLAGS_TRY_SHELL 0x2
#define SPAWN_XFLAGS_RET_PIDFD 0x4
extern int __posix_spawn_file_actions_realloc (posix_spawn_file_actions_t *
file_actions)
attribute_hidden;
extern int __spawni (int *pid, const char *path,
const posix_spawn_file_actions_t *file_actions,
const posix_spawnattr_t *attrp, char *const argv[],
char *const envp[], int xflags) attribute_hidden;
/* Return true if FD falls into the range valid for file descriptors.
The check in this form is mandated by POSIX. */
bool __spawn_valid_fd (int fd) attribute_hidden;
#endif /* _SPAWN_INT_H */