spawnve()
Spawn a child process, given a vector of arguments and an environment
Synopsis:
#include <process.h>
int spawnve( int mode,
const char * path,
char * const argv[],
char * const envp[] );
Arguments:
- mode
- How you want to load the child process, and how you want the parent
program to behave after the child program is initiated:
- P_WAIT — load the child program into available memory, execute it, and make the parent program resume execution after the child process ends.
- P_NOWAIT — execute the parent program concurrently with the new child process.
- P_NOWAITO — execute the parent program concurrently with the new child process. You can't use wait() to obtain the exit code.
- P_OVERLAY — replace the parent program with the child program in memory and execute the child. No return is made to the parent program. This is equivalent to calling the appropriate exec*() function.
- path
- The full path name of the executable.
- argv
- A pointer to an argument vector; this argument can't be NULL. The value in argv[0] can't be NULL, and should represent the filename of the program being loaded. The last member of argv must be a NULL pointer.
- envp
- NULL, or a pointer to an array of character pointers,
each pointing to a string that defines an environment variable.
The array is terminated with a NULL pointer.
Each pointer points to a character string of the form:
variable=value
that's used to define an environment variable.
Library:
libc
Use the -l c option to qcc to link against this library. This library is usually included automatically.
Description:
The spawnve() function creates and executes a new child process, named in path with the NULL-terminated list of arguments in the argv vector.
- In order to create a child process, your process must have the PROCMGR_AID_SPAWN ability enabled. For more information, see procmgr_ability().
- If the new child process is a shell script, the first line must start with
#!
, followed by the path of the program to run to interpret the script, optionally followed by one argument. The script must also be marked as executable. For more information, seeThe first line
in the Writing Shell Scripts chapter of the QNX OS User's Guide.
The spawnve() function is a QNX OS-specific convenience function. For greater portability and control, use posix_spawn().
If the value of envp is NULL, then the child process inherits the environment of the parent process. The new process can access its environment by using the environ global variable (found in <unistd.h>).
The following arguments are passed to the underlying call (spawn()):
- spawnve(mode, path, argv, envp)
-
- Create temporary attribute structure and set the flags member based on the mode:
- 0 if mode = P_WAIT/P_NOWAIT
- SPAWN_EXEC if mode = P_OVERLAY
- SPAWN_NOZOMBIE if mode = P_NOWAITO
- Call spawn(path, 0, 0, attr, argv, envp).
- Create temporary attribute structure and set the flags member based on the mode:
Returns:
The spawnve() function's return value depends on the mode argument:
mode | Return value |
---|---|
P_WAIT | The exit status of the child process.
For information about macros that extract information from this status, see
Status macrosin the documentation for wait(). |
P_NOWAIT | The process ID of the child process. To get the exit status for a P_NOWAIT process, you must use the waitpid() function, giving it this process ID. |
P_NOWAITO | The process ID of the child process. You can't get the exit status of a P_NOWAITO process. |
If an error occurs, -1 is returned (errno is set).
Errors:
- E2BIG
- The number of bytes used by the argument list or environment list of the new child process is greater than ARG_MAX bytes.
- EACCES
- The calling process doesn't have permission to search a directory listed in path, or it doesn't have permission to execute path, or path's filesystem was mounted with the ST_NOEXEC flag.
- EAGAIN
- Insufficient resources available to create the child process.
- EBADF
- An error occurred duplicating open file descriptors to the new process.
- ECHILD
- The mode is P_WAIT, and the spawned process terminated before the call to waitpid() was completed.
- EFAULT
- One of the buffers specified in the function call is invalid.
- EINTR
- The function was interrupted by a signal.
- EINVAL
- An argument is invalid (e.g., arg0 is NULL, or the value of mode isn't valid).
- ELOOP
- Too many levels of symbolic links or prefixes.
- EMFILE
- Insufficient resources available to load the new executable image or to remap file descriptors in the child process.
- ENAMETOOLONG
- The length of path exceeds PATH_MAX or a pathname component is longer than NAME_MAX.
- ENOENT
- The file identified by the path argument is empty, or one or more components of the pathname of the child process don't exist.
- ENOEXEC
- The child process's file has the correct permissions, but isn't in the correct format for an executable.
- ENOMEM
- Insufficient memory available to create the child process.
- ENOSYS
- The spawnve() function isn't implemented for the filesystem underlying the path specified in path.
- ENOTDIR
- A component of the path prefix of the child process isn't a directory.
- EPERM
- The calling process doesn't have the required permission (see procmgr_ability()), or an underlying call to mmap() failed because it attempted to set PROT_EXEC for a region of memory covered by an untrusted memory-mapped file.
- ETXTBSY
- The text file that you're trying to execute is busy (e.g., it might be open for writing).
See also the errors for ConnectAttach() and MsgSendvnc().
Classification:
Safety: | |
---|---|
Cancellation point | Read the Caveats |
Signal handler | No |
Thread | Yes |
Caveats:
If mode is P_WAIT, this function is a cancellation point.