lib/libc/stdlib/exit.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd August 5, 2021
  33 .Dt EXIT 3
  34 .Os
  35 .Sh NAME
  36 .Nm exit , _Exit
  37 .Nd perform normal program termination
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In stdlib.h
  42 .Ft void
  43 .Fn exit "int status"
  44 .Ft void
  45 .Fn _Exit "int status"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn exit
  49 and
  50 .Fn _Exit
  51 functions terminate a process.
  52 .Pp
  53 Before termination,
  54 .Fn exit
  55 performs the following functions in the order listed:
  56 .Bl -enum -offset indent
  57 .It
  58 Call all functions registered with the
  59 .Xr __cxa_atexit 3
  60 function
  61 (which are typically destructors from the loaded dynamic objects),
  62 and the functions registered with the
  63 .Xr atexit 3
  64 function, in the reverse order of their registration.
  65 .It
  66 Flush all open output streams.
  67 .It
  68 Close all open streams.
  69 .El
  70 .Pp
  71 The
  72 .Fn _Exit
  73 function terminates without calling the functions registered with the
  74 .Xr atexit 3
  75 function, and may or may not perform the other actions listed.
  76 The
  77 .Fx
  78 implementation of the
  79 .Fn _Exit
  80 function does not call destructors registered with
  81 .Xr __cxa_atexit 3,
  82 does not flush buffers, and does not close streams.
  83 .Pp
  84 Both functions make the low-order eight bits of the
  85 .Fa status
  86 argument available to a parent process which has called a
  87 .Xr wait 2 Ns -family
  88 function.
  89 .Pp
  90 The C Standard
  91 .Pq St -isoC-99
  92 defines the values
  93 .Li 0 ,
  94 .Dv EXIT_SUCCESS ,
  95 and
  96 .Dv EXIT_FAILURE
  97 as possible values of
  98 .Fa status .
  99 Cooperating processes may use other values;
 100 in a program which might be called by a mail transfer agent, the
 101 values described in
 102 .Xr sysexits 3
 103 may be used to provide more information to the parent process.
 104 .Pp
 105 Note that
 106 .Fn exit
 107 does nothing to prevent bottomless recursion should a function registered
 108 using
 109 .Xr atexit 3
 110 itself call
 111 .Fn exit .
 112 Such functions must call
 113 .Fn _Exit
 114 instead (although this has other effects as well which may not be desired).
 115 .Sh RETURN VALUES
 116 The
 117 .Fn exit
 118 and
 119 .Fn _Exit
 120 functions
 121 never return.
 122 .Sh SEE ALSO
 123 .Xr _exit 2 ,
 124 .Xr abort2 2 ,
 125 .Xr wait 2 ,
 126 .Xr at_quick_exit 3 ,
 127 .Xr atexit 3 ,
 128 .Xr intro 3 ,
 129 .Xr quick_exit 3 ,
 130 .Xr sysexits 3 ,
 131 .Xr tmpfile 3
 132 .Sh STANDARDS
 133 The
 134 .Fn exit
 135 and
 136 .Fn _Exit
 137 functions conform to
 138 .St -isoC-99 .
 139 .Sh HISTORY
 140 The
 141 .Fn exit
 142 function appeared in
 143 .At v1 .