Home | History | Annotate | Download | only in stdlib
      1 /*	$OpenBSD: atexit.c,v 1.14 2007/09/05 20:47:47 chl Exp $ */
      2 /*
      3  * Copyright (c) 2002 Daniel Hartmeier
      4  * All rights reserved.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions
      8  * are met:
      9  *
     10  *    - Redistributions of source code must retain the above copyright
     11  *      notice, this list of conditions and the following disclaimer.
     12  *    - Redistributions in binary form must reproduce the above
     13  *      copyright notice, this list of conditions and the following
     14  *      disclaimer in the documentation and/or other materials provided
     15  *      with the distribution.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
     20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     21  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
     25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     28  * POSSIBILITY OF SUCH DAMAGE.
     29  *
     30  */
     31 
     32 #include <sys/types.h>
     33 #include <sys/mman.h>
     34 #include <stdlib.h>
     35 #include <string.h>
     36 #include <unistd.h>
     37 #include "atexit.h"
     38 #include "thread_private.h"
     39 
     40 int __atexit_invalid = 1;
     41 struct atexit *__atexit;
     42 
     43 /*
     44  * Function pointers are stored in a linked list of pages. The list
     45  * is initially empty, and pages are allocated on demand. The first
     46  * function pointer in the first allocated page (the last one in
     47  * the linked list) is reserved for the cleanup function.
     48  *
     49  * Outside the following functions, all pages are mprotect()'ed
     50  * to prevent unintentional/malicious corruption.
     51  */
     52 
     53 /*
     54  * Register a function to be performed at exit or when a shared object
     55  * with the given dso handle is unloaded dynamically.  Also used as
     56  * the backend for atexit().  For more info on this API, see:
     57  *
     58  *	http://www.codesourcery.com/cxx-abi/abi.html#dso-dtor
     59  */
     60 int
     61 __cxa_atexit(void (*func)(void *), void *arg, void *dso)
     62 {
     63 	struct atexit *p = __atexit;
     64 	struct atexit_fn *fnp;
     65 	int pgsize = getpagesize();
     66 	int ret = -1;
     67 
     68 	if (pgsize < (int)sizeof(*p))
     69 		return (-1);
     70 	_ATEXIT_LOCK();
     71 	p = __atexit;
     72 	if (p != NULL) {
     73 		if (p->ind + 1 >= p->max)
     74 			p = NULL;
     75 		else if (mprotect(p, pgsize, PROT_READ | PROT_WRITE))
     76 			goto unlock;
     77 	}
     78 	if (p == NULL) {
     79 		p = mmap(NULL, pgsize, PROT_READ | PROT_WRITE,
     80 		    MAP_ANON | MAP_PRIVATE, -1, 0);
     81 		if (p == MAP_FAILED)
     82 			goto unlock;
     83 		if (__atexit == NULL) {
     84 			memset(&p->fns[0], 0, sizeof(p->fns[0]));
     85 			p->ind = 1;
     86 		} else
     87 			p->ind = 0;
     88 		p->max = (pgsize - ((char *)&p->fns[0] - (char *)p)) /
     89 		    sizeof(p->fns[0]);
     90 		p->next = __atexit;
     91 		__atexit = p;
     92 		if (__atexit_invalid)
     93 			__atexit_invalid = 0;
     94 	}
     95 	fnp = &p->fns[p->ind++];
     96 	fnp->fn_ptr.cxa_func = func;
     97 	fnp->fn_arg = arg;
     98 	fnp->fn_dso = dso;
     99 	if (mprotect(p, pgsize, PROT_READ))
    100 		goto unlock;
    101 	ret = 0;
    102 unlock:
    103 	_ATEXIT_UNLOCK();
    104 	return (ret);
    105 }
    106 
    107 /*
    108  * Register a function to be performed at exit.
    109  */
    110 int
    111 atexit(void (*func)(void))
    112 {
    113 	return (__cxa_atexit((void (*)(void *))func, NULL, NULL));
    114 }
    115 
    116 /*
    117  * Call all handlers registered with __cxa_atexit() for the shared
    118  * object owning 'dso'.
    119  * Note: if 'dso' is NULL, then all remaining handlers are called.
    120  */
    121 void
    122 __cxa_finalize(void *dso)
    123 {
    124 	struct atexit *p, *q;
    125 	struct atexit_fn fn;
    126 	int n, pgsize = getpagesize();
    127 	static int call_depth;
    128 
    129 	if (__atexit_invalid)
    130 		return;
    131 
    132 	call_depth++;
    133 
    134 	for (p = __atexit; p != NULL; p = p->next) {
    135 		for (n = p->ind; --n >= 0;) {
    136 			if (p->fns[n].fn_ptr.cxa_func == NULL)
    137 				continue;	/* already called */
    138 			if (dso != NULL && dso != p->fns[n].fn_dso)
    139 				continue;	/* wrong DSO */
    140 
    141 			/*
    142 			 * Mark handler as having been already called to avoid
    143 			 * dupes and loops, then call the appropriate function.
    144 			 */
    145 			fn = p->fns[n];
    146 			if (mprotect(p, pgsize, PROT_READ | PROT_WRITE) == 0) {
    147 				p->fns[n].fn_ptr.cxa_func = NULL;
    148 				mprotect(p, pgsize, PROT_READ);
    149 			}
    150 #if ANDROID
    151                         /* it looks like we should always call the function
    152                          * with an argument, even if dso is not NULL. Otherwise
    153                          * static destructors will not be called properly on
    154                          * the ARM.
    155                          */
    156                         (*fn.fn_ptr.cxa_func)(fn.fn_arg);
    157 #else /* !ANDROID */
    158 			if (dso != NULL)
    159 				(*fn.fn_ptr.cxa_func)(fn.fn_arg);
    160 			else
    161 				(*fn.fn_ptr.std_func)();
    162 #endif /* !ANDROID */
    163 		}
    164 	}
    165 
    166 	/*
    167 	 * If called via exit(), unmap the pages since we have now run
    168 	 * all the handlers.  We defer this until calldepth == 0 so that
    169 	 * we don't unmap things prematurely if called recursively.
    170 	 */
    171 	if (dso == NULL && --call_depth == 0) {
    172 		for (p = __atexit; p != NULL; ) {
    173 			q = p;
    174 			p = p->next;
    175 			munmap(q, pgsize);
    176 		}
    177 		__atexit = NULL;
    178 	}
    179 }
    180 
    181 /*
    182  * Register the cleanup function
    183  */
    184 void
    185 __atexit_register_cleanup(void (*func)(void))
    186 {
    187 	struct atexit *p;
    188 	int pgsize = getpagesize();
    189 
    190 	if (pgsize < (int)sizeof(*p))
    191 		return;
    192 	_ATEXIT_LOCK();
    193 	p = __atexit;
    194 	while (p != NULL && p->next != NULL)
    195 		p = p->next;
    196 	if (p == NULL) {
    197 		p = mmap(NULL, pgsize, PROT_READ | PROT_WRITE,
    198 		    MAP_ANON | MAP_PRIVATE, -1, 0);
    199 		if (p == MAP_FAILED)
    200 			goto unlock;
    201 		p->ind = 1;
    202 		p->max = (pgsize - ((char *)&p->fns[0] - (char *)p)) /
    203 		    sizeof(p->fns[0]);
    204 		p->next = NULL;
    205 		__atexit = p;
    206 		if (__atexit_invalid)
    207 			__atexit_invalid = 0;
    208 	} else {
    209 		if (mprotect(p, pgsize, PROT_READ | PROT_WRITE))
    210 			goto unlock;
    211 	}
    212 	p->fns[0].fn_ptr.std_func = func;
    213 	p->fns[0].fn_arg = NULL;
    214 	p->fns[0].fn_dso = NULL;
    215 	mprotect(p, pgsize, PROT_READ);
    216 unlock:
    217 	_ATEXIT_UNLOCK();
    218 }
    219