Replace underscores with dashes inside @var.
[kopensolaris-gnu/glibc.git] / manual / process.texi
1 @node Child Processes, Jo- Control, Process Startup, Top
2 @chapter Child Processes
3
4 @cindex process
5 @dfn{Processes} are the primitive units for allocation of system
6 resources.  Each process has its own address space and (usually) one
7 thread of control.  A process executes a program; you can have multiple
8 processes executing the same program, but each process has its own copy
9 of the program within its own address space and executes it
10 independently of the other copies.
11
12 @cindex child process
13 @cindex parent process
14 Processes are organized hierarchically.  Each process has a @dfn{parent
15 process} which explicitly arranged to create it.  The processes created
16 by a given parent are called its @dfn{child processes}.  A child
17 inherits many of its attributes from the parent process.
18
19 This chapter describes how a program can create, terminate, and control
20 child processes.  Actually, there are three distinct operations
21 involved: creating a new child process, causing the new process to
22 execute a program, and coordinating the completion of the child process
23 with the original program.
24
25 The @code{system} function provides a simple, portable mechanism for
26 running another program; it does all three steps automatically.  If you
27 need more control over the details of how this is done, you can use the
28 primitive functions to do each step individually instead.
29
30 @menu
31 * Running a Command::           The easy way to run another program.
32 * Process Creation Concepts::   An overview of the hard way to do it.
33 * Process Identification::      How to get the process ID of a process.
34 * Creating a Process::          How to fork a child process.
35 * Executing a File::            How to make a process execute another program.
36 * Process Completion::          How to tell when a child process has completed.
37 * Process Completion Status::   How to interpret the status value 
38                                  returned from a child process.
39 * BSD Wait Functions::          More functions, for backward compatibility.
40 * Process Creation Example::    A complete example program.
41 @end menu
42
43
44 @node Running a Command
45 @section Running a Command
46 @cindex running a command
47
48 The easy way to run another program is to use the @code{system}
49 function.  This function does all the work of running a subprogram, but
50 it doesn't give you much control over the details: you have to wait
51 until the subprogram terminates before you can do anything else.
52
53 @comment stdlib.h
54 @comment ANSI
55 @deftypefun int system (const char *@var{command})
56 @pindex sh
57 This function executes @var{command} as a shell command.  In the GNU C
58 library, it always uses the default shell @code{sh} to run the command.
59 In particular, it searches the directories in @code{PATH} to find
60 programs to execute.  The return value is @code{-1} if it wasn't
61 possible to create the shell process, and otherwise is the status of the
62 shell process.  @xref{Process Completion}, for details on how this
63 status code can be interpreted.
64
65 @pindex stdlib.h
66 The @code{system} function is declared in the header file
67 @file{stdlib.h}.
68 @end deftypefun
69
70 @strong{Portability Note:} Some C implementations may not have any
71 notion of a command processor that can execute other programs.  You can
72 determine whether a command processor exists by executing
73 @w{@code{system (NULL)}}; if the return value is nonzero, a command
74 processor is available.
75
76 The @code{popen} and @code{pclose} functions (@pxref{Pipe to a
77 Subprocess}) are closely related to the @code{system} function.  They
78 allow the parent process to communicate with the standard input and
79 output channels of the command being executed.
80
81 @node Process Creation Concepts
82 @section Process Creation Concepts
83
84 This section gives an overview of processes and of the steps involved in
85 creating a process and making it run another program.
86
87 @cindex process ID
88 @cindex process lifetime
89 Each process is named by a @dfn{process ID} number.  A unique process ID
90 is allocated to each process when it is created.  The @dfn{lifetime} of
91 a process ends when its termination is reported to its parent process;
92 at that time, all of the process resources, including its process ID,
93 are freed.
94
95 @cindex creating a process
96 @cindex forking a process
97 @cindex child process
98 @cindex parent process
99 Processes are created with the @code{fork} system call (so the operation
100 of creating a new process is sometimes called @dfn{forking} a process).
101 The @dfn{child process} created by @code{fork} is an exact clone of the
102 original @dfn{parent process}, except that it has its own process ID.
103
104 After forking a child process, both the parent and child processes
105 continue to execute normally.  If you want your program to wait for a
106 child process to finish executing before continuing, you must do this
107 explicitly after the fork operation, by calling @code{wait} or
108 @code{waitpid} (@pxref{Process Completion}).  These functions give you
109 limited information about why the child terminated---for example, its
110 exit status code.
111
112 A newly forked child process continues to execute the same program as
113 its parent process, at the point where the @code{fork} call returns.
114 You can use the return value from @code{fork} to tell whether the program
115 is running in the parent process or the child.
116
117 @cindex process image
118 Having several processes run the same program is only occasionally
119 useful.  But the child can execute another program using one of the
120 @code{exec} functions; see @ref{Executing a File}.  The program that the
121 process is executing is called its @dfn{process image}.  Starting
122 execution of a new program causes the process to forget all about its
123 previous process image; when the new program exits, the process exits
124 too, instead of returning to the previous process image.
125
126 @node Process Identification
127 @section Process Identification
128
129 The @code{pid_t} data type represents process IDs.  You can get the
130 process ID of a process by calling @code{getpid}.  The function
131 @code{getppid} returns the process ID of the parent of the current
132 process (this is also known as the @dfn{parent process ID}).  Your
133 program should include the header files @file{unistd.h} and
134 @file{sys/types.h} to use these functions.
135 @pindex sys/types.h
136 @pindex unistd.h
137
138 @comment sys/types.h
139 @comment POSIX.1
140 @deftp {Data Type} pid_t
141 The @code{pid_t} data type is a signed integer type which is capable
142 of representing a process ID.  In the GNU library, this is an @code{int}.
143 @end deftp
144
145 @comment unistd.h
146 @comment POSIX.1
147 @deftypefun pid_t getpid (void)
148 The @code{getpid} function returns the process ID of the current process.
149 @end deftypefun
150
151 @comment unistd.h
152 @comment POSIX.1
153 @deftypefun pid_t getppid (void)
154 The @code{getppid} function returns the process ID of the parent of the
155 current process.
156 @end deftypefun
157
158 @node Creating a Process
159 @section Creating a Process
160
161 The @code{fork} function is the primitive for creating a process.
162 It is declared in the header file @file{unistd.h}.
163 @pindex unistd.h
164
165 @comment unistd.h
166 @comment POSIX.1
167 @deftypefun pid_t fork (void)
168 The @code{fork} function creates a new process.
169
170 If the operation is successful, there are then both parent and child
171 processes and both see @code{fork} return, but with different values: it
172 returns a value of @code{0} in the child process and returns the child's
173 process ID in the parent process.
174
175 If process creation failed, @code{fork} returns a value of @code{-1} in
176 the parent process.  The following @code{errno} error conditions are
177 defined for @code{fork}:
178
179 @table @code
180 @item EAGAIN
181 There aren't enough system resources to create another process, or the
182 user already has too many processes running.
183
184 @item ENOMEM
185 The process requires more space than the system can supply.
186 @end table
187 @end deftypefun
188
189 The specific attributes of the child process that differ from the
190 parent process are:
191
192 @itemize @bullet
193 @item
194 The child process has its own unique process ID.
195
196 @item
197 The parent process ID of the child process is the process ID of its
198 parent process.
199
200 @item
201 The child process gets its own copies of the parent process's open file
202 descriptors.  Subsequently changing attributes of the file descriptors
203 in the parent process won't affect the file descriptors in the child,
204 and vice versa.  @xref{Control Operations}.
205
206 @item
207 The elapsed processor times for the child process are set to zero;
208 see @ref{Processor Time}.
209
210 @item
211 The child doesn't inherit file locks set by the parent process.
212 @xref{Control Operations}.
213
214 @item
215 The child doesn't inherit alarms set by the parent process.
216 @xref{Setting an Alarm}.
217
218 @item
219 The set of pending signals (@pxref{Delivery of Signal}) for the child
220 process is cleared.  (The child process inherits its mask of blocked
221 signals and signal actions from the parent process.)
222 @end itemize 
223
224
225 @comment unistd.h
226 @comment BSD
227 @deftypefun pid_t vfork (void)
228 The @code{vfork} function is similar to @code{fork} but more efficient;
229 however, there are restrictions you must follow to use it safely.
230
231 While @code{fork} makes a complete copy of the calling process's address
232 space and allows both the parent and child to execute independently,
233 @code{vfork} does not make this copy.  Instead, the child process
234 created with @code{vfork} shares its parent's address space until it calls
235 one of the @code{exec} functions.  In the meantime, the parent process
236 suspends execution.
237
238 You must be very careful not to allow the child process created with
239 @code{vfork} to modify any global data or even local variables shared
240 with the parent.  Furthermore, the child process cannot return from (or
241 do a long jump out of) the function that called @code{vfork}!  This
242 would leave the parent process's control information very confused.  If
243 in doubt, use @code{fork} instead.
244
245 Some operating systems don't really implement @code{vfork}.  The GNU C
246 library permits you to use @code{vfork} on all systems, but actually
247 executes @code{fork} if @code{vfork} isn't available.  If you follow
248 the proper precautions for using @code{vfork}, your program will still
249 work even if the system uses @code{fork} instead.
250 @end deftypefun
251
252 @node Executing a File
253 @section Executing a File
254 @cindex executing a file
255 @cindex @code{exec} functions
256
257 This section describes the @code{exec} family of functions, for executing
258 a file as a process image.  You can use these functions to make a child
259 process execute a new program after it has been forked.
260
261 @pindex unistd.h
262 The functions in this family differ in how you specify the arguments,
263 but otherwise they all do the same thing.  They are declared in the
264 header file @file{unistd.h}.
265
266 @comment unistd.h
267 @comment POSIX.1
268 @deftypefun int execv (const char *@var{filename}, char *const @var{argv}@t{[]})
269 The @code{execv} function executes the file named by @var{filename} as a
270 new process image.
271
272 The @var{argv} argument is an array of null-terminated strings that is
273 used to provide a value for the @code{argv} argument to the @code{main}
274 function of the program to be executed.  The last element of this array
275 must be a null pointer.  By convention, the first element of this array
276 is the file name of the program sans directory names.  @xref{Program
277 Arguments}, for full details on how programs can access these arguments.
278
279 The environment for the new process image is taken from the
280 @code{environ} variable of the current process image; see
281 @ref{Environment Variables}, for information about environments.
282 @end deftypefun
283
284 @comment unistd.h
285 @comment POSIX.1
286 @deftypefun int execl (const char *@var{filename}, const char *@var{arg0}, @dots{})
287 This is similar to @code{execv}, but the @var{argv} strings are
288 specified individually instead of as an array.  A null pointer must be
289 passed as the last such argument.
290 @end deftypefun
291
292 @comment unistd.h
293 @comment POSIX.1
294 @deftypefun int execve (const char *@var{filename}, char *const @var{argv}@t{[]}, char *const @var{env}@t{[]})
295 This is similar to @code{execv}, but permits you to specify the environment
296 for the new program explicitly as the @var{env} argument.  This should
297 be an array of strings in the same format as for the @code{environ} 
298 variable; see @ref{Environment Access}.
299 @end deftypefun
300
301 @comment unistd.h
302 @comment POSIX.1
303 @deftypefun int execle (const char *@var{filename}, const char *@var{arg0}, char *const @var{env}@t{[]}, @dots{})
304 This is similar to @code{execl}, but permits you to specify the
305 environment for the new program explicitly.  The environment argument is
306 passed following the null pointer that marks the last @var{argv}
307 argument, and should be an array of strings in the same format as for
308 the @code{environ} variable.
309 @end deftypefun
310
311 @comment unistd.h
312 @comment POSIX.1
313 @deftypefun int execvp (const char *@var{filename}, char *const @var{argv}@t{[]})
314 The @code{execvp} function is similar to @code{execv}, except that it
315 searches the directories listed in the @code{PATH} environment variable
316 (@pxref{Standard Environment}) to find the full file name of a
317 file from @var{filename} if @var{filename} does not contain a slash.
318
319 This function is useful for executing system utility programs, because
320 it looks for them in the places that the user has chosen.  Shells use it
321 to run the commands that users type.
322 @end deftypefun
323
324 @comment unistd.h
325 @comment POSIX.1
326 @deftypefun int execlp (const char *@var{filename}, const char *@var{arg0}, @dots{})
327 This function is like @code{execl}, except that it performs the same
328 file name searching as the @code{execvp} function.
329 @end deftypefun
330
331 The size of the argument list and environment list taken together must
332 not be greater than @code{ARG_MAX} bytes.  @xref{General Limits}.  In
333 the GNU system, the size (which compares against @code{ARG_MAX})
334 includes, for each string, the number of characters in the string, plus
335 the size of a @code{char *}, plus one, rounded up to a multiple of the
336 size of a @code{char *}.  Other systems may have somewhat different
337 rules for counting.
338
339 These functions normally don't return, since execution of a new program
340 causes the currently executing program to go away completely.  A value
341 of @code{-1} is returned in the event of a failure.  In addition to the
342 usual file name syntax errors (@pxref{File Name Errors}), the following
343 @code{errno} error conditions are defined for these functions:
344
345 @table @code
346 @item E2BIG
347 The combined size of the new program's argument list and environment
348 list is larger than @code{ARG_MAX} bytes.  The GNU system has no
349 specific limit on the argument list size, so this error code cannot
350 result, but you may get @code{ENOMEM} instead if the arguments are too
351 big for available memory.
352
353 @item ENOEXEC
354 The specified file can't be executed because it isn't in the right format.
355
356 @item ENOMEM
357 Executing the specified file requires more storage than is available.
358 @end table
359
360 If execution of the new file succeeds, it updates the access time field
361 of the file as if the file had been read.  @xref{File Times}, for more
362 details about access times of files.
363
364 The point at which the file is closed again is not specified, but
365 is at some point before the process exits or before another process
366 image is executed.
367
368 Executing a new process image completely changes the contents of memory,
369 copying only the argument and environment strings to new locations.  But
370 many other attributes of the process are unchanged:
371
372 @itemize @bullet
373 @item
374 The process ID and the parent process ID.  @xref{Process Creation Concepts}.
375
376 @item
377 Session and process group membership.  @xref{Concepts of Job Control}.
378
379 @item
380 Real user ID and group ID, and supplementary group IDs.  @xref{Process
381 Persona}.
382
383 @item
384 Pending alarms.  @xref{Setting an Alarm}.
385
386 @item
387 Current working directory and root directory.  @xref{Working Directory}.
388
389 @item
390 File mode creation mask.  @xref{Setting Permissions}.
391
392 @item
393 Process signal mask; see @ref{Process Signal Mask}.
394
395 @item
396 Pending signals; see @ref{Blocking Signals}.
397
398 @item
399 Elapsed processor time associated with the process; see @ref{Processor Time}.
400 @end itemize
401
402 If the set-user-ID and set-group-ID mode bits of the process image file
403 are set, this affects the effective user ID and effective group ID
404 (respectively) of the process.  These concepts are discussed in detail
405 in @ref{Process Persona}.
406
407 Signals that are set to be ignored in the existing process image are
408 also set to be ignored in the new process image.  All other signals are
409 set to the default action in the new process image.  For more
410 information about signals, see @ref{Signal Handling}.
411
412 File descriptors open in the existing process image remain open in the
413 new process image, unless they have the @code{FD_CLOEXEC}
414 (close-on-exec) flag set.  The files that remain open inherit all
415 attributes of the open file description from the existing process image,
416 including file locks.  File descriptors are discussed in @ref{Low-Level I/O}.
417
418 Streams, by contrast, cannot survive through @code{exec} functions,
419 because they are located in the memory of the process itself.  The new
420 process image has no streams except those it creates afresh.  Each of
421 the streams in the pre-@code{exec} process image has a descriptor inside
422 it, and these descriptors do survive through @code{exec} (provided that
423 they do not have @code{FD_CLOEXEC} set.  The new process image can
424 reconnect these to new streams using @code{fdopen} (@pxref{Descriptors
425 and Streams}).
426 @c ??? this is a bad thing to recommend.  it won't work in GNU, where
427 @c fopen doesn't go thru a file descriptor.
428 @c ??? I think Posix.1 requires this to work -- rms.
429
430 @node Process Completion
431 @section Process Completion
432 @cindex process completion
433 @cindex waiting for completion of child process
434 @cindex testing exit status of child process
435
436 The functions described in this section are used to wait for a child
437 process to terminate or stop, and determine its status.  These functions
438 are declared in the header file @file{sys/wait.h}.
439 @pindex sys/wait.h
440
441 @comment sys/wait.h
442 @comment POSIX.1
443 @deftypefun pid_t waitpid (pid_t @var{pid}, int *@var{status-ptr}, int @var{options})
444 The @code{waitpid} function is used to request status information from a
445 child process whose process ID is @var{pid}.  Normally, the calling
446 process is suspended until the child process makes status information
447 available by terminating.
448
449 Other values for the @var{pid} argument have special interpretations.  A
450 value of @code{-1} or @code{WAIT_ANY} requests status information for
451 any child process; a value of @code{0} or @code{WAIT_MYPGRP} requests
452 information for any child process in the same process group as the
453 calling process; and any other negative value @minus{} @var{pgid}
454 requests information for any child process whose process group ID is
455 @var{pgid}.
456
457 If status information for a child process is available immediately, this
458 function returns immediately without waiting.  If more than one eligible
459 child process has status information available, one of them is chosen
460 randomly, and its status is returned immediately.  To get the status
461 from the other eligible child processes, you need to call @code{waitpid}
462 again.
463
464 The @var{options} argument is a bit mask.  Its value should be the
465 bitwise OR (that is, the @samp{|} operator) of zero or more of the
466 @code{WNOHANG} and @code{WUNTRACED} flags.  You can use the
467 @code{WNOHANG} flag to indicate that the parent process shouldn't wait;
468 and the @code{WUNTRACED} flag to request status information from stopped
469 processes as well as processes that have terminated.
470
471 The status information from the child process is stored in the object
472 that @var{status-ptr} points to, unless @var{status-ptr} is a null pointer.
473
474 The return value is normally the process ID of the child process whose
475 status is reported.  If the @code{WNOHANG} option was specified and no
476 child process is waiting to be noticed, the value is zero.  A value of
477 @code{-1} is returned in case of error.  The following @code{errno}
478 error conditions are defined for this function:
479
480 @table @code
481 @item EINTR
482 The function was interrupted by delivery of a signal to the calling
483 process.  @xref{Interrupted Primitives}.
484
485 @item ECHILD
486 There are no child processes to wait for, or the specified @var{pid}
487 is not a child of the calling process.
488
489 @item EINVAL
490 An invalid value was provided for the @var{options} argument.
491 @end table
492 @end deftypefun
493
494 These symbolic constants are defined as values for the @var{pid} argument
495 to the @code{waitpid} function.
496
497 @comment Extra blank lines make it look better.
498 @table @code
499 @item WAIT_ANY
500
501 This constant macro (whose value is @code{-1}) specifies that
502 @code{waitpid} should return status information about any child process.
503
504
505 @item WAIT_MYPGRP
506 This constant (with value @code{0}) specifies that @code{waitpid} should
507 return status information about any child process in the same process
508 group as the calling process.
509 @end table
510
511 These symbolic constants are defined as flags for the @var{options}
512 argument to the @code{waitpid} function.  You can bitwise-OR the flags
513 together to obtain a value to use as the argument.
514
515 @table @code
516 @item WNOHANG
517
518 This flag specifies that @code{waitpid} should return immediately
519 instead of waiting, if there is no child process ready to be noticed.
520
521 @item WUNTRACED
522
523 This flag specifies that @code{waitpid} should report the status of any
524 child processes that have been stopped as well as those that have
525 terminated.
526 @end table
527
528 @comment sys/wait.h
529 @comment POSIX.1
530 @deftypefun pid_t wait (int *@var{status-ptr})
531 This is a simplified version of @code{waitpid}, and is used to wait
532 until any one child process terminates.  The call:
533
534 @smallexample
535 wait (&status)
536 @end smallexample
537
538 @noindent
539 is exactly equivalent to:
540
541 @smallexample
542 waitpid (-1, &status, 0)
543 @end smallexample
544 @end deftypefun
545
546 Here's an example of how to use @code{waitpid} to get the status from
547 all child processes that have terminated, without ever waiting.  This
548 function is designed to be a handler for @code{SIGCHLD}, the signal that
549 indicates that at least one child process has terminated.
550
551 @smallexample
552 @group
553 void
554 sigchld_handler (int signum)
555 @{
556   int pid;
557   int status;
558   while (1)
559     @{
560       pid = waitpid (WAIT_ANY, &status, WNOHANG);
561       if (pid < 0)
562         @{
563           perror ("waitpid");
564           break;
565         @}
566       if (pid == 0)
567         break;
568       notice_termination (pid, status);
569     @}
570 @}
571 @end group
572 @end smallexample
573
574 @node Process Completion Status
575 @section Process Completion Status
576
577 If the exit status value (@pxref{Program Termination}) of the child
578 process is zero, then the status value reported by @code{waitpid} or
579 @code{wait} is also zero.  You can test for other kinds of information
580 encoded in the returned status value using the following macros.
581 These macros are defined in the header file @file{sys/wait.h}.
582 @pindex sys/wait.h
583
584 @comment sys/wait.h
585 @comment POSIX.1
586 @deftypefn Macro int WIFEXITED (int @var{status})
587 This macro returns a nonzero value if the child process terminated
588 normally with @code{exit} or @code{_exit}.
589 @end deftypefn
590
591 @comment sys/wait.h
592 @comment POSIX.1
593 @deftypefn Macro int WEXITSTATUS (int @var{status})
594 If @code{WIFEXITED} is true of @var{status}, this macro returns the
595 low-order 8 bits of the exit status value from the child process.
596 @xref{Exit Status}.
597 @end deftypefn
598
599 @comment sys/wait.h
600 @comment POSIX.1
601 @deftypefn Macro int WIFSIGNALED (int @var{status})
602 This macro returns a nonzero value if the child process terminated
603 because it received a signal that was not handled.
604 @xref{Signal Handling}.
605 @end deftypefn
606
607 @comment sys/wait.h
608 @comment POSIX.1
609 @deftypefn Macro int WTERMSIG (int @var{status})
610 If @code{WIFSIGNALED} is true of @var{status}, this macro returns the
611 signal number of the signal that terminated the child process.
612 @end deftypefn
613
614 @comment sys/wait.h
615 @comment BSD
616 @deftypefn Macro int WCOREDUMP (int @var{status})
617 This macro returns a nonzero value if the child process terminated
618 and produced a core dump.
619 @end deftypefn
620
621 @comment sys/wait.h
622 @comment POSIX.1
623 @deftypefn Macro int WIFSTOPPED (int @var{status})
624 This macro returns a nonzero value if the child process is stopped.
625 @end deftypefn
626
627 @comment sys/wait.h
628 @comment POSIX.1
629 @deftypefn Macro int WSTOPSIG (int @var{status})
630 If @code{WIFSTOPPED} is true of @var{status}, this macro returns the
631 signal number of the signal that caused the child process to stop.
632 @end deftypefn
633
634
635 @node BSD Wait Functions
636 @section BSD Process Wait Functions
637
638 The GNU library also provides these related facilities for compatibility
639 with BSD Unix.  BSD uses the @code{union wait} data type to represent
640 status values rather than an @code{int}.  The two representations are
641 actually interchangeable; they describe the same bit patterns.  The GNU
642 C Library defines macros such as @code{WEXITSTATUS} so that they will
643 work on either kind of object, and the @code{wait} function is defined
644 to accept either type of pointer as its @var{status-ptr} argument.
645
646 These functions are declared in @file{sys/wait.h}.
647 @pindex sys/wait.h
648
649 @comment sys/wait.h
650 @comment BSD
651 @deftp {Data Type} {union wait}
652 This data type represents program termination status values.  It has
653 the following members:
654
655 @table @code
656 @item int w_termsig
657 The value of this member is the same as the result of the
658 @code{WTERMSIG} macro.
659
660 @item int w_coredump
661 The value of this member is the same as the result of the
662 @code{WCOREDUMP} macro.
663
664 @item int w_retcode
665 The value of this member is the same as the result of the
666 @code{WEXITSTATUS} macro.
667
668 @item int w_stopsig
669 The value of this member is the same as the result of the
670 @code{WSTOPSIG} macro.
671 @end table
672
673 Instead of accessing these members directly, you should use the
674 equivalent macros.
675 @end deftp
676
677 @comment sys/wait.h
678 @comment BSD
679 @deftypefun pid_t wait3 (union wait *@var{status-ptr}, int @var{options}, struct rusage *@var{usage})
680 If @var{usage} is a null pointer, @code{wait3} is equivalent to
681 @code{waitpid (-1, @var{status-ptr}, @var{options})}.
682
683 If @var{usage} is not null, @code{wait3} stores usage figures for the
684 child process in @code{*@var{rusage}} (but only if the child has
685 terminated, not if it has stopped).  @xref{Resource Usage}.
686 @end deftypefun
687
688 @comment sys/wait.h
689 @comment BSD
690 @deftypefun pid_t wait4 (pid_t @var{pid}, union wait *@var{status-ptr}, int @var{options}, struct rusage *@var{usage})
691 If @var{usage} is a null pointer, @code{wait4} is equivalent to
692 @code{waitpid (@var{pid}, @var{status-ptr}, @var{options})}.
693
694 If @var{usage} is not null, @code{wait4} stores usage figures for the
695 child process in @code{*@var{rusage}} (but only if the child has
696 terminated, not if it has stopped).  @xref{Resource Usage}.
697 @end deftypefun
698
699 @node Process Creation Example
700 @section Process Creation Example
701
702 Here is an example program showing how you might write a function
703 similar to the built-in @code{system}.  It executes its @var{command}
704 argument using the equivalent of @samp{sh -c @var{command}}.
705
706 @smallexample
707 #include <stddef.h>
708 #include <stdlib.h>
709 #include <unistd.h>
710 #include <sys/types.h>
711 #include <sys/wait.h>
712
713 /* @r{Execute the command using this shell program.}  */
714 #define SHELL "/bin/sh"
715
716 @group
717 int 
718 my_system (const char *command)
719 @{
720   int status;
721   pid_t pid;
722 @end group
723
724   pid = fork ();
725   if (pid == 0)
726     @{
727       /* @r{This is the child process.  Execute the shell command.} */
728       execl (SHELL, SHELL, "-c", command, NULL);
729       _exit (EXIT_FAILURE);
730     @}
731   else if (pid < 0)
732     /* @r{The fork failed.  Report failure.}  */
733     status = -1;
734   else
735     /* @r{This is the parent process.  Wait for the child to complete.}  */
736     if (waitpid (pid, &status, 0) != pid)
737       status = -1;
738   return status;
739 @}
740 @end smallexample
741
742 @comment Yes, this example has been tested.
743
744 There are a couple of things you should pay attention to in this
745 example.
746
747 Remember that the first @code{argv} argument supplied to the program
748 represents the name of the program being executed.  That is why, in the
749 call to @code{execl}, @code{SHELL} is supplied once to name the program
750 to execute and a second time to supply a value for @code{argv[0]}.  
751
752 The @code{execl} call in the child process doesn't return if it is
753 successful.  If it fails, you must do something to make the child
754 process terminate.  Just returning a bad status code with @code{return}
755 would leave two processes running the original program.  Instead, the
756 right behavior is for the child process to report failure to its parent
757 process.
758
759 Call @code{_exit} to accomplish this.  The reason for using @code{_exit}
760 instead of @code{exit} is to avoid flushing fully buffered streams such
761 as @code{stdout}.  The buffers of these streams probably contain data
762 that was copied from the parent process by the @code{fork}, data that
763 will be output eventually by the parent process.  Calling @code{exit} in
764 the child would output the data twice.  @xref{Termination Internals}.