xref: /freebsd/lib/libc/stdlib/exit.3 (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
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
50The
51.Fn exit
52and
53.Fn _Exit
54functions terminate a process.
55.Pp
56Before termination,
57.Fn exit
58performs the following functions in the order listed:
59.Bl -enum -offset indent
60.It
61Call all functions registered with the
62.Xr __cxa_atexit 3
63function
64(which are typically destructors from the loaded dynamic objects),
65and the functions registered with the
66.Xr atexit 3
67function, in the reverse order of their registration.
68.It
69Flush all open output streams.
70.It
71Close all open streams.
72.El
73.Pp
74The
75.Fn _Exit
76function terminates without calling the functions registered with the
77.Xr atexit 3
78function, and may or may not perform the other actions listed.
79The
80.Fx
81implementation of the
82.Fn _Exit
83function does not call destructors registered with
84.Xr __cxa_atexit 3,
85does not flush buffers, and does not close streams.
86.Pp
87Both functions make the low-order eight bits of the
88.Fa status
89argument available to a parent process which has called a
90.Xr wait 2 Ns -family
91function.
92.Pp
93The C Standard
94.Pq St -isoC-99
95defines the values
96.Li 0 ,
97.Dv EXIT_SUCCESS ,
98and
99.Dv EXIT_FAILURE
100as possible values of
101.Fa status .
102Cooperating processes may use other values;
103in a program which might be called by a mail transfer agent, the
104values described in
105.Xr sysexits 3
106may be used to provide more information to the parent process.
107.Pp
108Note that
109.Fn exit
110does nothing to prevent bottomless recursion should a function registered
111using
112.Xr atexit 3
113itself call
114.Fn exit .
115Such functions must call
116.Fn _Exit
117instead (although this has other effects as well which may not be desired).
118.Sh RETURN VALUES
119The
120.Fn exit
121and
122.Fn _Exit
123functions
124never 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
136The
137.Fn exit
138and
139.Fn _Exit
140functions conform to
141.St -isoC-99 .
142.Sh HISTORY
143The
144.Fn exit
145function appeared in
146.At v1 .
147