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 .\"     @(#)exit.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd August 5, 2021
  36 .Dt EXIT 3
  37 .Os
  38 .Sh NAME
  39 .Nm exit , _Exit
  40 .Nd perform normal program termination
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In stdlib.h
  45 .Ft void
  46 .Fn exit "int status"
  47 .Ft void
  48 .Fn _Exit "int status"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn exit
  52 and
  53 .Fn _Exit
  54 functions terminate a process.
  55 .Pp
  56 Before termination,
  57 .Fn exit
  58 performs the following functions in the order listed:
  59 .Bl -enum -offset indent
  60 .It
  61 Call all functions registered with the
  62 .Xr __cxa_atexit 3
  63 function
  64 (which are typically destructors from the loaded dynamic objects),
  65 and the functions registered with the
  66 .Xr atexit 3
  67 function, in the reverse order of their registration.
  68 .It
  69 Flush all open output streams.
  70 .It
  71 Close all open streams.
  72 .El
  73 .Pp
  74 The
  75 .Fn _Exit
  76 function terminates without calling the functions registered with the
  77 .Xr atexit 3
  78 function, and may or may not perform the other actions listed.
  79 The
  80 .Fx
  81 implementation of the
  82 .Fn _Exit
  83 function does not call destructors registered with
  84 .Xr __cxa_atexit 3,
  85 does not flush buffers, and does not close streams.
  86 .Pp
  87 Both functions make the low-order eight bits of the
  88 .Fa status
  89 argument available to a parent process which has called a
  90 .Xr wait 2 Ns -family
  91 function.
  92 .Pp
  93 The C Standard
  94 .Pq St -isoC-99
  95 defines the values
  96 .Li 0 ,
  97 .Dv EXIT_SUCCESS ,
  98 and
  99 .Dv EXIT_FAILURE
 100 as possible values of
 101 .Fa status .
 102 Cooperating processes may use other values;
 103 in a program which might be called by a mail transfer agent, the
 104 values described in
 105 .Xr sysexits 3
 106 may be used to provide more information to the parent process.
 107 .Pp
 108 Note that
 109 .Fn exit
 110 does nothing to prevent bottomless recursion should a function registered
 111 using
 112 .Xr atexit 3
 113 itself call
 114 .Fn exit .
 115 Such functions must call
 116 .Fn _Exit
 117 instead (although this has other effects as well which may not be desired).
 118 .Sh RETURN VALUES
 119 The
 120 .Fn exit
 121 and
 122 .Fn _Exit
 123 functions
 124 never return.
 125 .Sh SEE ALSO
 126 .Xr _exit 2 ,
 127 .Xr abort2 2 ,
 128 .Xr wait 2 ,
 129 .Xr at_quick_exit 3 ,
 130 .Xr atexit 3 ,
 131 .Xr intro 3 ,
 132 .Xr quick_exit 3 ,
 133 .Xr sysexits 3 ,
 134 .Xr tmpfile 3
 135 .Sh STANDARDS
 136 The
 137 .Fn exit
 138 and
 139 .Fn _Exit
 140 functions conform to
 141 .St -isoC-99 .
 142 .Sh HISTORY
 143 The
 144 .Fn exit
 145 function appeared in
 146 .At v1 .