original/man3/atexit.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   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 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified 1993-03-29, David Metcalfe
  30 .\" Modified 1993-07-24, Rik Faith (faith@cs.unc.edu)
  31 .\" Modified 2003-10-25, Walter Harms
  32 .\"
  33 .TH ATEXIT 3  2008-12-05 "Linux" "Linux Programmer's Manual"
  34 .SH NAME
  35 atexit \- register a function to be called at normal process termination
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <stdlib.h>
  39 .sp
  40 .BI "int atexit(void (*" function )(void));
  41 .fi
  42 .SH DESCRIPTION
  43 The
  44 .BR atexit ()
  45 function registers the given
  46 .I function
  47 to be
  48 called at normal process termination, either via
  49 .BR exit (3)
  50 or via return from the program's
  51 .IR main ().
  52 Functions so registered are called in
  53 the reverse order of their registration; no arguments are passed.
  54
  55 The same function may be registered multiple times:
  56 it is called once for each registration.
  57 .LP
  58 POSIX.1-2001 requires that an implementation allow at least
  59 .B ATEXIT_MAX
  60 (32) such functions to be registered.
  61 The actual limit supported by an implementation can be obtained using
  62 .BR sysconf (3).
  63 .LP
  64 When a child process is created via
  65 .BR fork (2),
  66 it inherits copies of its parent's registrations.
  67 Upon a successful call to one of the
  68 .BR exec (3)
  69 functions,
  70 all registrations are removed.
  71 .SH RETURN VALUE
  72 The
  73 .BR atexit ()
  74 function returns the value 0 if successful; otherwise
  75 it returns a nonzero value.
  76 .SH CONFORMING TO
  77 SVr4, 4.3BSD, C89, C99, POSIX.1-2001.
  78 .SH NOTES
  79 Functions registered using
  80 .BR atexit ()
  81 (and
  82 .BR on_exit (3))
  83 are not called if a process terminates abnormally because
  84 of the delivery of a signal.
  85
  86 If one of the functions registered functions calls
  87 .BR _exit (2),
  88 then any remaining functions are not invoked,
  89 and the other process termination steps performed by
  90 .BR exit (3)
  91 are not performed.
  92
  93 POSIX.1-2001 says that the result of calling
  94 .BR exit (3)
  95 more than once (i.e., calling
  96 .BR exit (3)
  97 within a function registered using
  98 .BR atexit ())
  99 is undefined.
 100 On some systems (but not Linux), this can result in an infinite recursion;
 101 .\" This can happen on OpenBSD 4.2 for example, and is documented
 102 .\" as occurring on FreeBSD as well.
 103 .\" Glibc does "the Right Thing" -- invocation of the remaining
 104 .\" exit handlers carries on as normal.
 105 portable programs should not invoke
 106 .BR exit (3)
 107 inside a function registered using
 108 .BR atexit ().
 109
 110 The
 111 .BR atexit ()
 112 and
 113 .BR on_exit (3)
 114 functions register functions on the same list:
 115 at normal process termination,
 116 the registered functions are invoked in reverse order
 117 of their registration by these two functions.
 118
 119 POSIX.1-2001 says that the result is undefined if
 120 .BR longjmp (3)
 121 is used to terminate execution of one of the functions registered
 122 .BR atexit ().
 123 .\" In glibc, things seem to be handled okay
 124 .SS Linux notes
 125 Since glibc 2.2.3,
 126 .BR atexit ()
 127 (and
 128 .BR on_exit (3))
 129 can be used within a shared library to establish functions
 130 that are called when the shared library is unloaded.
 131 .SH EXAMPLE
 132 .nf
 133 #include <stdio.h>
 134 #include <stdlib.h>
 135 #include <unistd.h>
 136
 137 void
 138 bye(void)
 139 {
 140     printf("That was all, folks\en");
 141 }
 142
 143 int
 144 main(void)
 145 {
 146     long a;
 147     int i;
 148
 149     a = sysconf(_SC_ATEXIT_MAX);
 150     printf("ATEXIT_MAX = %ld\en", a);
 151
 152     i = atexit(bye);
 153     if (i != 0) {
 154         fprintf(stderr, "cannot set exit function\en");
 155         exit(EXIT_FAILURE);
 156     }
 157
 158     exit(EXIT_SUCCESS);
 159 }
 160 .fi
 161 .SH SEE ALSO
 162 .BR _exit (2),
 163 .BR exit (3),
 164 .BR on_exit (3)
 165 .SH COLOPHON
 166 This page is part of release 3.79 of the Linux
 167 .I man-pages
 168 project.
 169 A description of the project,
 170 information about reporting bugs,
 171 and the latest version of this page,
 172 can be found at
 173 \%http://www.kernel.org/doc/man\-pages/.