glibc/posix/spawn.h
Adhemerval Zanella 342cc934a3 posix: Add terminal control setting support for posix_spawn
Currently there is no proper way to set the controlling terminal through
posix_spawn in race free manner [1].  This forces shell implementations
to keep using fork+exec when launching background process groups,
even when using posix_spawn yields better performance.

This patch adds a new GNU extension so the creating process can
configure the created process terminal group.  This is done with a new
flag, POSIX_SPAWN_TCSETPGROUP, along with two new attribute functions:
posix_spawnattr_tcsetpgrp_np, and posix_spawnattr_tcgetpgrp_np.
The function sets a new attribute, spawn-tcgroupfd, that references to
the controlling terminal.

The controlling terminal is set after the spawn-pgroup attribute, and
uses the spawn-tcgroupfd along with current creating process group
(so it is composable with POSIX_SPAWN_SETPGROUP).

To create a process and set the controlling terminal, one can use the
following sequence:

    posix_spawnattr_t attr;
    posix_spawnattr_init (&attr);
    posix_spawnattr_setflags (&attr, POSIX_SPAWN_TCSETPGROUP);
    posix_spawnattr_tcsetpgrp_np (&attr, tcfd);

If the idea is also to create a new process groups:

    posix_spawnattr_t attr;
    posix_spawnattr_init (&attr);
    posix_spawnattr_setflags (&attr, POSIX_SPAWN_TCSETPGROUP
				     | POSIX_SPAWN_SETPGROUP);
    posix_spawnattr_tcsetpgrp_np (&attr, tcfd);
    posix_spawnattr_setpgroup (&attr, 0);

The controlling terminal file descriptor is ignored if the new flag is
not set.

This interface is slight different than the one provided by QNX [2],
which only provides the POSIX_SPAWN_TCSETPGROUP flag.  The QNX
documentation does not specify how the controlling terminal is obtained
nor how it iteracts with POSIX_SPAWN_SETPGROUP.  Since a glibc
implementation is library based, it is more straightforward and avoid
requires additional file descriptor operations to request the caller
to setup the controlling terminal file descriptor (and it also allows
a bit less error handling by posix_spawn).

Checked on x86_64-linux-gnu and i686-linux-gnu.

[1] https://github.com/ksh93/ksh/issues/79
[2] https://www.qnx.com/developers/docs/7.0.0/index.html#com.qnx.doc.neutrino.lib_ref/topic/p/posix_spawn.html

Reviewed-by: Carlos O'Donell <carlos@redhat.com>
Tested-by: Carlos O'Donell <carlos@redhat.com>
2022-01-25 14:07:53 -03:00

243 lines
8.4 KiB
C

/* Definitions for POSIX spawn interface.
Copyright (C) 2000-2022 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_H
#define _SPAWN_H 1
#include <features.h>
#include <sched.h>
#include <sys/types.h>
#include <bits/types/sigset_t.h>
/* Data structure to contain attributes for thread creation. */
typedef struct
{
short int __flags;
pid_t __pgrp;
sigset_t __sd;
sigset_t __ss;
struct sched_param __sp;
int __policy;
int __ctty_fd;
int __pad[15];
} posix_spawnattr_t;
/* Data structure to contain information about the actions to be
performed in the new process with respect to file descriptors. */
typedef struct
{
int __allocated;
int __used;
struct __spawn_action *__actions;
int __pad[16];
} posix_spawn_file_actions_t;
/* Flags to be set in the `posix_spawnattr_t'. */
#define POSIX_SPAWN_RESETIDS 0x01
#define POSIX_SPAWN_SETPGROUP 0x02
#define POSIX_SPAWN_SETSIGDEF 0x04
#define POSIX_SPAWN_SETSIGMASK 0x08
#define POSIX_SPAWN_SETSCHEDPARAM 0x10
#define POSIX_SPAWN_SETSCHEDULER 0x20
#ifdef __USE_GNU
# define POSIX_SPAWN_USEVFORK 0x40
# define POSIX_SPAWN_SETSID 0x80
# define POSIX_SPAWN_TCSETPGROUP 0x100
#endif
__BEGIN_DECLS
/* Spawn a new process executing PATH with the attributes describes in *ATTRP.
Before running the process perform the actions described in FILE-ACTIONS.
This function is a possible cancellation point and therefore not
marked with __THROW. */
extern int posix_spawn (pid_t *__restrict __pid,
const char *__restrict __path,
const posix_spawn_file_actions_t *__restrict
__file_actions,
const posix_spawnattr_t *__restrict __attrp,
char *const __argv[__restrict_arr],
char *const __envp[__restrict_arr])
__nonnull ((2, 5));
/* Similar to `posix_spawn' but search for FILE in the PATH.
This function is a possible cancellation point and therefore not
marked with __THROW. */
extern int posix_spawnp (pid_t *__pid, const char *__file,
const posix_spawn_file_actions_t *__file_actions,
const posix_spawnattr_t *__attrp,
char *const __argv[], char *const __envp[])
__nonnull ((2, 5));
/* Initialize data structure with attributes for `spawn' to default values. */
extern int posix_spawnattr_init (posix_spawnattr_t *__attr)
__THROW __nonnull ((1));
/* Free resources associated with ATTR. */
extern int posix_spawnattr_destroy (posix_spawnattr_t *__attr)
__THROW __nonnull ((1));
/* Store signal mask for signals with default handling from ATTR in
SIGDEFAULT. */
extern int posix_spawnattr_getsigdefault (const posix_spawnattr_t *
__restrict __attr,
sigset_t *__restrict __sigdefault)
__THROW __nonnull ((1, 2));
/* Set signal mask for signals with default handling in ATTR to SIGDEFAULT. */
extern int posix_spawnattr_setsigdefault (posix_spawnattr_t *__restrict __attr,
const sigset_t *__restrict
__sigdefault)
__THROW __nonnull ((1, 2));
/* Store signal mask for the new process from ATTR in SIGMASK. */
extern int posix_spawnattr_getsigmask (const posix_spawnattr_t *__restrict
__attr,
sigset_t *__restrict __sigmask)
__THROW __nonnull ((1, 2));
/* Set signal mask for the new process in ATTR to SIGMASK. */
extern int posix_spawnattr_setsigmask (posix_spawnattr_t *__restrict __attr,
const sigset_t *__restrict __sigmask)
__THROW __nonnull ((1, 2));
/* Get flag word from the attribute structure. */
extern int posix_spawnattr_getflags (const posix_spawnattr_t *__restrict
__attr,
short int *__restrict __flags)
__THROW __nonnull ((1, 2));
/* Store flags in the attribute structure. */
extern int posix_spawnattr_setflags (posix_spawnattr_t *_attr,
short int __flags)
__THROW __nonnull ((1));
/* Get process group ID from the attribute structure. */
extern int posix_spawnattr_getpgroup (const posix_spawnattr_t *__restrict
__attr, pid_t *__restrict __pgroup)
__THROW __nonnull ((1, 2));
/* Store process group ID in the attribute structure. */
extern int posix_spawnattr_setpgroup (posix_spawnattr_t *__attr,
pid_t __pgroup)
__THROW __nonnull ((1));
/* Get scheduling policy from the attribute structure. */
extern int posix_spawnattr_getschedpolicy (const posix_spawnattr_t *
__restrict __attr,
int *__restrict __schedpolicy)
__THROW __nonnull ((1, 2));
/* Store scheduling policy in the attribute structure. */
extern int posix_spawnattr_setschedpolicy (posix_spawnattr_t *__attr,
int __schedpolicy)
__THROW __nonnull ((1));
/* Get scheduling parameters from the attribute structure. */
extern int posix_spawnattr_getschedparam (const posix_spawnattr_t *
__restrict __attr,
struct sched_param *__restrict
__schedparam)
__THROW __nonnull ((1, 2));
/* Store scheduling parameters in the attribute structure. */
extern int posix_spawnattr_setschedparam (posix_spawnattr_t *__restrict __attr,
const struct sched_param *
__restrict __schedparam)
__THROW __nonnull ((1, 2));
#ifdef __USE_GNU
/* Make the spawned process the foreground process group on the terminal
associated with FD (which must be a controlling terminal, and still be
associated with its session). */
extern int posix_spawnattr_tcsetpgrp_np (posix_spawnattr_t *__attr, int fd)
__THROW __nonnull ((1));
/* Return the associated terminal FD in the attribute structure. */
extern int posix_spawnattr_tcgetpgrp_np (const posix_spawnattr_t *
__restrict __attr, int *fd)
__THROW __nonnull ((1, 2));
#endif
/* Initialize data structure for file attribute for `spawn' call. */
extern int posix_spawn_file_actions_init (posix_spawn_file_actions_t *
__file_actions)
__THROW __nonnull ((1));
/* Free resources associated with FILE-ACTIONS. */
extern int posix_spawn_file_actions_destroy (posix_spawn_file_actions_t *
__file_actions)
__THROW __nonnull ((1));
/* Add an action to FILE-ACTIONS which tells the implementation to call
`open' for the given file during the `spawn' call. */
extern int posix_spawn_file_actions_addopen (posix_spawn_file_actions_t *
__restrict __file_actions,
int __fd,
const char *__restrict __path,
int __oflag, mode_t __mode)
__THROW __nonnull ((1, 3));
/* Add an action to FILE-ACTIONS which tells the implementation to call
`close' for the given file descriptor during the `spawn' call. */
extern int posix_spawn_file_actions_addclose (posix_spawn_file_actions_t *
__file_actions, int __fd)
__THROW __nonnull ((1));
/* Add an action to FILE-ACTIONS which tells the implementation to call
`dup2' for the given file descriptors during the `spawn' call. */
extern int posix_spawn_file_actions_adddup2 (posix_spawn_file_actions_t *
__file_actions,
int __fd, int __newfd)
__THROW __nonnull ((1));
#ifdef __USE_GNU
/* Add an action changing the directory to PATH during spawn. This
affects the subsequent file actions. */
extern int posix_spawn_file_actions_addchdir_np (posix_spawn_file_actions_t *
__restrict __actions,
const char *__restrict __path)
__THROW __nonnull ((1, 2));
/* Add an action changing the directory to FD during spawn. This
affects the subsequent file actions. FD is not duplicated and must
be open when the file action is executed. */
extern int posix_spawn_file_actions_addfchdir_np (posix_spawn_file_actions_t *,
int __fd)
__THROW __nonnull ((1));
/* Add an action to close all file descriptor greater than or equal to FROM
during spawn. This affects the subsequent file actions. */
extern int
posix_spawn_file_actions_addclosefrom_np (posix_spawn_file_actions_t *,
int __from)
__THROW __nonnull ((1));
#endif
__END_DECLS
#endif /* spawn.h */