_atexit.c 9.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. /* Copyright (C) 1995,1996 Robert de Bath <rdebath@cix.compulink.co.uk>
  2. * This file is part of the Linux-8086 C library and is distributed
  3. * under the GNU Library General Public License.
  4. */
  5. /*
  6. * Dec 2000 Manuel Novoa III
  7. *
  8. * Made atexit handling conform to standards... i.e. no args.
  9. * Removed on_exit since it did not match gnu libc definition.
  10. * Combined atexit and __do_exit into one object file.
  11. *
  12. * Feb 2001 Manuel Novoa III
  13. *
  14. * Reworked file after addition of __uClibc_main.
  15. * Changed name of __do_exit to atexit_handler.
  16. * Changed name of __cleanup to __uClibc_cleanup.
  17. * Moved declaration of __uClibc_cleanup to __uClibc_main
  18. * where it is initialized with (possibly weak alias)
  19. * _stdio_term.
  20. *
  21. * Jul 2001 Steve Thayer
  22. *
  23. * Added an on_exit implementation (that now matches gnu libc definition.)
  24. * Pulled atexit_handler out of the atexit object since it is now required by
  25. * on_exit as well. Renamed it to __exit_handler.
  26. * Fixed a problem where exit functions stop getting called if one of
  27. * them calls exit().
  28. * As a side effect of these changes, abort() no longer calls the exit
  29. * functions (it now matches the gnu libc definition).
  30. *
  31. * August 2002 Erik Andersen
  32. * Added locking so atexit and friends can be thread safe
  33. *
  34. * August 2005 Stephen Warren
  35. * Added __cxa_atexit and __cxa_finalize support
  36. *
  37. */
  38. #include <features.h>
  39. #include <unistd.h>
  40. #include <stdlib.h>
  41. #include <errno.h>
  42. #include <atomic.h>
  43. #include <bits/uClibc_mutex.h>
  44. __UCLIBC_MUTEX_EXTERN(__atexit_lock);
  45. libc_hidden_proto(exit)
  46. libc_hidden_proto(_exit)
  47. typedef void (*aefuncp) (void); /* atexit function pointer */
  48. typedef void (*oefuncp) (int, void *); /* on_exit function pointer */
  49. typedef void (*cxaefuncp) (void *); /* __cxa_atexit function pointer */
  50. typedef enum {
  51. ef_free,
  52. ef_in_use,
  53. ef_on_exit,
  54. ef_cxa_atexit
  55. } ef_type; /* exit function types */
  56. /* this is in the L_exit object */
  57. extern void (*__exit_cleanup) (int) attribute_hidden;
  58. /* these are in the L___do_exit object */
  59. extern int __exit_slots attribute_hidden;
  60. extern int __exit_count attribute_hidden;
  61. extern void __exit_handler(int) attribute_hidden;
  62. struct exit_function {
  63. /*
  64. * 'type' should be of type of the 'enum ef_type' above but since we
  65. * need this element in an atomic operation we have to use 'long int'.
  66. */
  67. long int type; /* enum ef_type */
  68. union {
  69. struct {
  70. oefuncp func;
  71. void *arg;
  72. } on_exit;
  73. struct {
  74. cxaefuncp func;
  75. void *arg;
  76. void* dso_handle;
  77. } cxa_atexit;
  78. } funcs;
  79. };
  80. #ifdef __UCLIBC_DYNAMIC_ATEXIT__
  81. extern struct exit_function *__exit_function_table attribute_hidden;
  82. #else
  83. extern struct exit_function __exit_function_table[__UCLIBC_MAX_ATEXIT] attribute_hidden;
  84. #endif
  85. extern struct exit_function *__new_exitfn (void) attribute_hidden;
  86. /* this is in the L___cxa_atexit object */
  87. extern int __cxa_atexit (cxaefuncp, void *arg, void *dso_handle);
  88. /* remove old_atexit after 0.9.29 */
  89. #if defined(L_atexit) || defined(L_old_atexit)
  90. extern void *__dso_handle __attribute__ ((__weak__));
  91. /*
  92. * register a function to be called at normal program termination
  93. * (the registered function takes no arguments)
  94. */
  95. #ifdef L_atexit
  96. int attribute_hidden atexit(aefuncp func)
  97. #else
  98. int old_atexit(aefuncp func);
  99. int old_atexit(aefuncp func)
  100. #endif
  101. {
  102. /*
  103. * glibc casts aefuncp to cxaefuncp.
  104. * This seems dodgy, but I guess calling a function with more
  105. * parameters than it needs will work everywhere?
  106. */
  107. return __cxa_atexit((cxaefuncp)func, NULL,
  108. &__dso_handle == NULL ? NULL : __dso_handle);
  109. }
  110. #ifndef L_atexit
  111. weak_alias(old_atexit,atexit)
  112. #endif
  113. #endif
  114. #ifdef L_on_exit
  115. /*
  116. * register a function to be called at normal program termination
  117. * the registered function takes two arguments:
  118. * status - the exit status that was passed to the exit() function
  119. * arg - generic argument
  120. */
  121. int on_exit(oefuncp func, void *arg)
  122. {
  123. struct exit_function *efp;
  124. if (func == NULL) {
  125. return 0;
  126. }
  127. efp = __new_exitfn();
  128. if (efp == NULL) {
  129. return -1;
  130. }
  131. efp->funcs.on_exit.func = func;
  132. efp->funcs.on_exit.arg = arg;
  133. /* assign last for thread safety, since we're now unlocked */
  134. efp->type = ef_on_exit;
  135. return 0;
  136. }
  137. #endif
  138. #ifdef L___cxa_atexit
  139. libc_hidden_proto(__cxa_atexit)
  140. int __cxa_atexit (cxaefuncp func, void *arg, void *dso_handle)
  141. {
  142. struct exit_function *efp;
  143. if (func == NULL) {
  144. return 0;
  145. }
  146. efp = __new_exitfn();
  147. if (efp == NULL) {
  148. return -1;
  149. }
  150. efp->funcs.cxa_atexit.func = func;
  151. efp->funcs.cxa_atexit.arg = arg;
  152. efp->funcs.cxa_atexit.dso_handle = dso_handle;
  153. /* assign last for thread safety, since we're now unlocked */
  154. efp->type = ef_cxa_atexit;
  155. return 0;
  156. }
  157. libc_hidden_def(__cxa_atexit)
  158. #endif
  159. #ifdef L___cxa_finalize
  160. /*
  161. * If D is non-NULL, call all functions registered with `__cxa_atexit'
  162. * with the same dso handle. Otherwise, if D is NULL, call all of the
  163. * registered handlers.
  164. */
  165. void __cxa_finalize (void *dso_handle);
  166. void __cxa_finalize (void *dso_handle)
  167. {
  168. struct exit_function *efp;
  169. int exit_count_snapshot = __exit_count;
  170. /* In reverse order */
  171. while (exit_count_snapshot) {
  172. efp = &__exit_function_table[--exit_count_snapshot];
  173. /*
  174. * We check dso_handle match before we verify the type of the union entry.
  175. * However, the atomic_exchange will validate that we were really "allowed"
  176. * to read dso_handle...
  177. */
  178. if ((dso_handle == NULL || dso_handle == efp->funcs.cxa_atexit.dso_handle)
  179. /* We don't want to run this cleanup more than once. */
  180. && !atomic_compare_and_exchange_bool_acq(&efp->type, ef_free, ef_cxa_atexit)
  181. ) {
  182. /* glibc passes status (0) too, but that's not in the prototype */
  183. (*efp->funcs.cxa_atexit.func)(efp->funcs.cxa_atexit.arg);
  184. }
  185. }
  186. #if 0 /* haven't looked into this yet... */
  187. /*
  188. * Remove the registered fork handlers. We do not have to
  189. * unregister anything if the program is going to terminate anyway.
  190. */
  191. #ifdef UNREGISTER_ATFORK
  192. if (d != NULL) {
  193. UNREGISTER_ATFORK (d);
  194. }
  195. #endif
  196. #endif
  197. }
  198. #endif
  199. #ifdef L___exit_handler
  200. int __exit_count = 0; /* Number of registered exit functions */
  201. #ifdef __UCLIBC_DYNAMIC_ATEXIT__
  202. struct exit_function *__exit_function_table = NULL;
  203. int __exit_slots = 0; /* Size of __exit_function_table */
  204. #else
  205. struct exit_function __exit_function_table[__UCLIBC_MAX_ATEXIT];
  206. #endif
  207. /*
  208. * Find and return a new exit_function pointer, for atexit,
  209. * onexit and __cxa_atexit to initialize
  210. */
  211. struct exit_function attribute_hidden *__new_exitfn(void)
  212. {
  213. struct exit_function *efp;
  214. __UCLIBC_MUTEX_LOCK(__atexit_lock);
  215. #ifdef __UCLIBC_DYNAMIC_ATEXIT__
  216. /* If we are out of function table slots, make some more */
  217. if (__exit_slots < __exit_count+1) {
  218. efp=realloc(__exit_function_table,
  219. (__exit_slots+20)*sizeof(struct exit_function));
  220. if (efp == NULL) {
  221. __set_errno(ENOMEM);
  222. goto DONE;
  223. }
  224. __exit_function_table = efp;
  225. __exit_slots += 20;
  226. }
  227. #else
  228. if (__exit_count >= __UCLIBC_MAX_ATEXIT) {
  229. __set_errno(ENOMEM);
  230. efp = NULL;
  231. goto DONE;
  232. }
  233. #endif
  234. __exit_cleanup = __exit_handler; /* enable cleanup */
  235. efp = &__exit_function_table[__exit_count++];
  236. efp->type = ef_in_use;
  237. DONE:
  238. __UCLIBC_MUTEX_UNLOCK(__atexit_lock);
  239. return efp;
  240. }
  241. /*
  242. * Handle the work of executing the registered exit functions
  243. * This is called while we are locked, so no additional locking
  244. * is needed...
  245. */
  246. void __exit_handler(int status)
  247. {
  248. struct exit_function *efp;
  249. /* In reverse order */
  250. while ( __exit_count ) {
  251. efp = &__exit_function_table[--__exit_count];
  252. switch (efp->type) {
  253. case ef_on_exit:
  254. if (efp->funcs.on_exit.func) {
  255. (efp->funcs.on_exit.func) (status, efp->funcs.on_exit.arg);
  256. }
  257. break;
  258. case ef_cxa_atexit:
  259. if (efp->funcs.cxa_atexit.func) {
  260. /* glibc passes status too, but that's not in the prototype */
  261. (efp->funcs.cxa_atexit.func) (efp->funcs.cxa_atexit.arg);
  262. }
  263. break;
  264. }
  265. }
  266. #ifdef __UCLIBC_DYNAMIC_ATEXIT__
  267. /* Free up memory used by the __exit_function_table structure */
  268. free(__exit_function_table);
  269. #endif
  270. }
  271. #endif
  272. #ifdef L_exit
  273. extern void weak_function _stdio_term(void) attribute_hidden;
  274. attribute_hidden void (*__exit_cleanup) (int) = 0;
  275. __UCLIBC_MUTEX_INIT(__atexit_lock, PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP);
  276. extern void __uClibc_fini(void);
  277. libc_hidden_proto(__uClibc_fini)
  278. /*
  279. * Normal program termination
  280. */
  281. void exit(int rv)
  282. {
  283. /* Perform exit-specific cleanup (atexit and on_exit) */
  284. __UCLIBC_MUTEX_LOCK(__atexit_lock);
  285. if (__exit_cleanup) {
  286. __exit_cleanup(rv);
  287. }
  288. __UCLIBC_MUTEX_UNLOCK(__atexit_lock);
  289. __uClibc_fini();
  290. /* If we are using stdio, try to shut it down. At the very least,
  291. * this will attempt to commit all buffered writes. It may also
  292. * unbuffer all writable files, or close them outright.
  293. * Check the stdio routines for details. */
  294. if (_stdio_term)
  295. _stdio_term();
  296. _exit(rv);
  297. }
  298. libc_hidden_def(exit)
  299. #endif