man3/exit.3

   1 .\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" FIXME . There are a lot of other process termination actions that
  26 .\" could be listed on this page. See, for example, the list in the
  27 .\" POSIX exit(3p) page.
  28 .\"
  29 .TH EXIT 3  2021-03-22 "Linux" "Linux Programmer's Manual"
  30 .SH NAME
  31 exit \- cause normal process termination
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <stdlib.h>
  35 .PP
  36 .BI "noreturn void exit(int " status );
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR exit ()
  41 function causes normal process termination and the least significant byte of
  42 .I status
  43 (i.e., \fIstatus & 0xFF\fP) is returned to the parent (see
  44 .BR wait (2)).
  45 .PP
  46 All functions registered with
  47 .BR atexit (3)
  48 and
  49 .BR on_exit (3)
  50 are called, in the reverse order of their registration.
  51 (It is possible for one of these functions to use
  52 .BR atexit (3)
  53 or
  54 .BR on_exit (3)
  55 to register an additional
  56 function to be executed during exit processing;
  57 the new registration is added to the front of the list of functions
  58 that remain to be called.)
  59 If one of these functions does not return
  60 (e.g., it calls
  61 .BR _exit (2),
  62 or kills itself with a signal),
  63 then none of the remaining functions is called,
  64 and further exit processing (in particular, flushing of
  65 .BR stdio (3)
  66 streams) is abandoned.
  67 If a function has been registered multiple times using
  68 .BR atexit (3)
  69 or
  70 .BR on_exit (3),
  71 then it is called as many times as it was registered.
  72 .PP
  73 All open
  74 .BR stdio (3)
  75 streams are flushed and closed.
  76 Files created by
  77 .BR tmpfile (3)
  78 are removed.
  79 .PP
  80 The C standard specifies two constants,
  81 \fBEXIT_SUCCESS\fP and \fBEXIT_FAILURE\fP,
  82 that may be passed to
  83 .BR exit ()
  84 to indicate successful or unsuccessful
  85 termination, respectively.
  86 .SH RETURN VALUE
  87 The
  88 .BR exit ()
  89 function does not return.
  90 .SH ATTRIBUTES
  91 For an explanation of the terms used in this section, see
  92 .BR attributes (7).
  93 .ad l
  94 .nh
  95 .TS
  96 allbox;
  97 lbx lb lb
  98 l l l.
  99 Interface       Attribute       Value
 100 T{
 101 .BR exit ()
 102 T}      Thread safety   MT-Unsafe race:exit
 103 .TE
 104 .hy
 105 .ad
 106 .sp 1
 107 .PP
 108 The
 109 .BR exit ()
 110 function uses a global variable that is not protected,
 111 so it is not thread-safe.
 112 .SH CONFORMING TO
 113 POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
 114 .SH NOTES
 115 The behavior is undefined if one of the functions registered using
 116 .BR atexit (3)
 117 and
 118 .BR on_exit (3)
 119 calls either
 120 .BR exit ()
 121 or
 122 .BR longjmp (3).
 123 Note that a call to
 124 .BR execve (2)
 125 removes registrations created using
 126 .BR atexit (3)
 127 and
 128 .BR on_exit (3).
 129 .PP
 130 The use of
 131 .B EXIT_SUCCESS
 132 and
 133 .B EXIT_FAILURE
 134 is slightly more portable
 135 (to non-UNIX environments) than the use of 0 and some nonzero value
 136 like 1 or \-1.
 137 In particular, VMS uses a different convention.
 138 .PP
 139 BSD has attempted to standardize exit codes
 140 (which some C libraries such as the GNU C library have also adopted);
 141 see the file
 142 .IR <sysexits.h> .
 143 .PP
 144 After
 145 .BR exit (),
 146 the exit status must be transmitted to the
 147 parent process.
 148 There are three cases:
 149 .IP \(bu 3
 150 If the parent has set
 151 .BR SA_NOCLDWAIT ,
 152 or has set the
 153 .B SIGCHLD
 154 handler to
 155 .BR SIG_IGN ,
 156 the status is discarded and the child dies immediately.
 157 .IP \(bu
 158 If the parent was waiting on the child,
 159 it is notified of the exit status and the child dies immediately.
 160 .IP \(bu
 161 Otherwise,
 162 the child becomes a "zombie" process:
 163 most of the process resources are recycled,
 164 but a slot containing minimal information about the child process
 165 (termination status, resource usage statistics) is retained in process table.
 166 This allows the parent to subsequently use
 167 .BR waitpid (2)
 168 (or similar) to learn the termination status of the child;
 169 at that point the zombie process slot is released.
 170 .PP
 171 If the implementation supports the
 172 .B SIGCHLD
 173 signal, this signal
 174 is sent to the parent.
 175 If the parent has set
 176 .BR SA_NOCLDWAIT ,
 177 it is undefined whether a
 178 .B SIGCHLD
 179 signal is sent.
 180 .\"
 181 .SS Signals sent to other processes
 182 If the exiting process is a session leader and its controlling terminal
 183 is the controlling terminal of the session, then each process in
 184 the foreground process group of this controlling terminal
 185 is sent a
 186 .B SIGHUP
 187 signal, and the terminal is disassociated
 188 from this session, allowing it to be acquired by a new controlling
 189 process.
 190 .PP
 191 If the exit of the process causes a process group to become orphaned,
 192 and if any member of the newly orphaned process group is stopped,
 193 then a
 194 .B SIGHUP
 195 signal followed by a
 196 .B SIGCONT
 197 signal will be
 198 sent to each process in this process group.
 199 See
 200 .BR setpgid (2)
 201 for an explanation of orphaned process groups.
 202 .PP
 203 Except in the above cases,
 204 where the signalled processes may be children of the terminating process,
 205 termination of a process does
 206 .I not
 207 in general cause a signal to be sent to children of that process.
 208 However, a process can use the
 209 .BR prctl (2)
 210 .B PR_SET_PDEATHSIG
 211 operation to arrange that it receives a signal if its parent terminates.
 212 .SH SEE ALSO
 213 .BR _exit (2),
 214 .BR get_robust_list (2),
 215 .BR setpgid (2),
 216 .BR wait (2),
 217 .BR atexit (3),
 218 .BR on_exit (3),
 219 .BR tmpfile (3)