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