mirror of https://code.videolan.org/videolan/vlc
97 lines
3.5 KiB
C
97 lines
3.5 KiB
C
/*****************************************************************************
|
|
* vlc_spawn.h: Child process helpers
|
|
*****************************************************************************
|
|
* Copyright © 2020 Rémi Denis-Courmont
|
|
*
|
|
* This program 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.
|
|
*
|
|
* This program 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 this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_SPAWN_H
|
|
#define VLC_SPAWN_H 1
|
|
|
|
#include <unistd.h>
|
|
|
|
/**
|
|
* \defgroup spawn Process management
|
|
* \ingroup os
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Spawn a child process (by file name).
|
|
*
|
|
* This function creates a child process. For all practical purposes, it is
|
|
* identical to vlc_spawnp(), with one exception: vlc_spawn() does <b>not</b>
|
|
* look for the executable file name in the OS-defined search path. Instead the
|
|
* file name must be absolute.
|
|
*
|
|
* \param pid storage space for the child process identifier [OUT]
|
|
* \param file executable file path [IN]
|
|
* \param fdv file descriptor array [IN]
|
|
* \param argv NULL-terminated array of command line arguments [IN]
|
|
*
|
|
* \return 0 on success or a standard error code on failure
|
|
*/
|
|
VLC_API VLC_USED
|
|
int vlc_spawn(pid_t *pid, const char *file, const int *fdv,
|
|
const char *const *argv);
|
|
|
|
/**
|
|
* Spawn a child process.
|
|
*
|
|
* This function creates a child process. The created process will run with the
|
|
* same environment and privileges as the calling process.
|
|
*
|
|
* An array of file descriptors must be provided for the child process:
|
|
* - fdv[0] is the standard input (or -1 for nul input),
|
|
* - fdv[1] is the standard output (or -1 for nul output),
|
|
* - fdv[2] is the standard error (or -1 to ignore).
|
|
* The array must have at least 4 elements and be terminated by -1.
|
|
* Some platforms will ignore file descriptors other than the three standard
|
|
* ones, so those should not be used in code intended to be portable.
|
|
*
|
|
* vlc_waitpid() must be called to collect outstanding system resources
|
|
* after the child process terminates.
|
|
*
|
|
* \param pid storage space for the child process identifier [OUT]
|
|
* \param path executable path [IN]
|
|
* \param fdv file descriptor array [IN]
|
|
* \param argv NULL-terminated array of command line arguments [IN]
|
|
*
|
|
* \return 0 on success or a standard error code on failure
|
|
*/
|
|
VLC_API VLC_USED
|
|
int vlc_spawnp(pid_t *pid, const char *path, const int *fdv,
|
|
const char *const *argv);
|
|
|
|
/**
|
|
* Waits for a child process.
|
|
*
|
|
* This function waits until a child process created by vlc_spawn() or
|
|
* vlc_spawnp() has completed and releases any associated system resource.
|
|
*
|
|
* \param pid process identifier as returned by vlc_spawn() or vlc_spawnp()
|
|
*
|
|
* \return If the process terminates cleanly, this function returns the exit
|
|
* code of the process. Otherwise, it returns an implementation-defined value
|
|
* that is not a valid exit code.
|
|
*/
|
|
VLC_API
|
|
int vlc_waitpid(pid_t pid);
|
|
|
|
/** @} */
|
|
|
|
#endif
|