C Programming/POSIX Reference/spawn

Spawn refers to a function that loads and executes a new child process. The current process may or may not continue to execute asynchronously. Creating a new subprocess requires enough memory in which both the child process and the current program can execute.

There is a family of spawn functions in the Microsoft Windows line of operating systems. There is also a different family of spawn functions in an optional extension of the POSIX standards .

Different versions

The Microsoft Windows spawn functions are inspired by Unix functions fork and exec; however, as Windows does not support fork (at least in the Win32 API; POSIX emulation environments such as Cygwin or SFU do), the spawn function was supplied as a replacement for the fork-exec combination. However, the spawn function, although it deals adequately with the most common use cases, lacks the full power of fork-exec, since after fork any process settings which will survive an exec may be changed. However, in most cases, this deficiency can be made up for by using the more low-level CreateProcess API.

The Posix spawn functions were introduced to enable support for processes in Posix implementations for embedded environments that don't support swapping or dynamic address translation .

Microsoft Windows spawn functions

In the spawnl, spawnlp, spawnv, and spawnvp calls, the child process inherits the environment of the parent. Files that are open when a spawn call is made remain open in the child process.

Prototype

int spawnl(int mode, char *path, char *arg0, ...);

int spawnle(int mode, char *path, char *arg0, ..., char ** envp);

int spawnlp(int mode, char *path, char *arg0, ...);

int spawnlpe(int mode, char *path, char *arg0, ..., char ** envp);

int spawnv(int mode, char *path, char **argv);

int spawnve(int mode, char *path, char **argv, char ** envp);

int spawnvp(int mode, char *path, char **argv);

int spawnvpe(int mode, char *path, char **argv, char ** envp);

Function names

The base name of each function is spawn, followed by one or more letters:

Name	Notes
e	An array of pointers to environment arguments is explicitly passed to the child process.
l	Command line arguments are passed individually to the function.
p	Uses the PATH argument variable to find the file to be executed.
v	Command line arguments are passed to the function as an array of pointers.

Mode

The mode argument determines the way the child is run. Values for mode are:

Name	Notes
P_OVERLAY	Overlays parent process with child, which destroys the parent. This has the same effect as the exec* functions.
P_WAIT	Suspends parent process until the child process has finished executing (synchronous spawn).
P_NOWAIT, P_NOWAITO	Continues to execute calling process concurrently with new process (asynchronous spawn).
P_DETACH	the child is run in background without access to the console or keyboard. Calls to _cwait upon the new process will fail (asynchronous spawn)

Path

The path argument specifies the filename of the program to execute. For spawnlp and spawnvp only, if the filename does not have a path and is not in the current directory, the PATH environment variable determines which directories to search for the file. The string pointed to by argv[0] is the name of the program to run.

The command line passed to the spawned program is made up of the character strings, arg0 through argn, in the spawn call. The accepted maximum combined length of these strings differs between compilers, ranging from 128 characters on Digital Mars to 1024 on Microsoft Visual C++ or as much as memory permits, on DJGPP.. The last argument after argn has to be a NULL pointer.

argv

The argv argument is an array of character pointers. The last pointer in the array must be null to indicate the end of the list.

envp

The spawnle, spawnlpe, spawnve, and spawnvpe calls allow the user to alter the child process's environment by passing a list of environment settings in the envp argument. This argument is an array of character pointers; each pointer (except for the last one) points to a null-terminated string defining an environment variable. An environment variable has the form:

name=value

where name is the variable name and value is its value. The last pointer in the array is null. When the envp argument is null, the child inherits the parent's environment settings.

The spawn functions can be used under Microsoft Windows. They use LoadModule to run the spawned process. If this fails, an attempt is made to spawn a normal MS-DOS process. If a Windows application is spawned, the instance handle can be obtained using exec_instancehandleget. It is possible to specify how the spawned program will be shown using the functions _exec_showset, _exec_showget, and _exec_showreset.

Return values

The return value indicates the exit status of the spawned program. A value of zero indicates that the spawned program executed successfully. A positive value indicates that the spawned program executed, but was aborted or ended in error, the value returned is the exit status of the child process. A negative value indicates that the spawned program did not execute, and errno is set. Under Microsoft Windows, spawn returns the negated error code returned from LoadModule for compatibility with the C run-time library. The following error codes may be encountered:

Value	Notes
-2	File not found
-3	Path not found
-11	Invalid .exe file (for Windows)
-13	DOS 4. 0 application
-14	Unknown .exe type (may be DOS extended)

See also

• Fork
• Exec
• fork-exec
• Path (variable)
• Process.h