[apple/libc.git] / stdlib / FreeBSD / atexit.c

/*-
 * Copyright (c) 1990, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Chris Torek.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#if defined(LIBC_SCCS) && !defined(lint)
static char sccsid[] = "@(#)atexit.c	8.2 (Berkeley) 7/3/94";
#endif /* LIBC_SCCS and not lint */
#include <sys/cdefs.h>
__FBSDID("$FreeBSD: src/lib/libc/stdlib/atexit.c,v 1.8 2007/01/09 00:28:09 imp Exp $");

#include "namespace.h"
#include <stddef.h>
#include <stdlib.h>
#include <unistd.h>
#include <pthread.h>
#if defined(__DYNAMIC__) || defined (__BLOCKS__)
#include <dlfcn.h>
#endif /* defined(__DYNAMIC__) */
#include "atexit.h"
#include "un-namespace.h"

#ifdef __BLOCKS__
#include <Block.h>
#endif /* __BLOCKS__ */
#include "libc_private.h"

#include <TargetConditionals.h>

#define	ATEXIT_FN_EMPTY	0
#define	ATEXIT_FN_STD	1
#define	ATEXIT_FN_CXA	2
#ifdef __BLOCKS__
#define	ATEXIT_FN_BLK	3
#endif /* __BLOCKS__ */

static pthread_mutex_t atexit_mutex = PTHREAD_MUTEX_INITIALIZER;

#define _MUTEX_LOCK(x)		if (__isthreaded) _pthread_mutex_lock(x)
#define _MUTEX_UNLOCK(x)	if (__isthreaded) _pthread_mutex_unlock(x)

struct atexit {
	struct atexit *next;			/* next in list */
	int ind;				/* next index in this table */
	struct atexit_fn {
		int fn_type;			/* ATEXIT_? from above */
		union {
			void (*std_func)(void);
			void (*cxa_func)(void *);
#ifdef __BLOCKS__
			void (^block)(void);
#endif /* __BLOCKS__ */
		} fn_ptr;			/* function pointer */
		void *fn_arg;			/* argument for CXA callback */
		void *fn_dso;			/* shared module handle */
	} fns[ATEXIT_SIZE];			/* the table itself */
};

static struct atexit *__atexit;		/* points to head of LIFO stack */
static int new_registration;

/*
 * Register the function described by 'fptr' to be called at application
 * exit or owning shared object unload time. This is a helper function
 * for atexit and __cxa_atexit.
 */
static int
atexit_register(struct atexit_fn *fptr)
{
	static struct atexit __atexit0;	/* one guaranteed table */
	struct atexit *p;

	_MUTEX_LOCK(&atexit_mutex);
	if ((p = __atexit) == NULL)
		__atexit = p = &__atexit0;
	else while (p->ind >= ATEXIT_SIZE) {
		struct atexit *old__atexit;
		old__atexit = __atexit;
	        _MUTEX_UNLOCK(&atexit_mutex);
		if ((p = (struct atexit *)malloc(sizeof(*p))) == NULL)
			return (-1);
		_MUTEX_LOCK(&atexit_mutex);
		if (old__atexit != __atexit) {
			/* Lost race, retry operation */
			_MUTEX_UNLOCK(&atexit_mutex);
			free(p);
			_MUTEX_LOCK(&atexit_mutex);
			p = __atexit;
			continue;
		}
		p->ind = 0;
		p->next = __atexit;
		__atexit = p;
	}
	p->fns[p->ind++] = *fptr;
	new_registration = 1;
	_MUTEX_UNLOCK(&atexit_mutex);
	return 0;
}

/*
 * Register a function to be performed at exit.
 */
int
atexit(void (*func)(void))
{
	struct atexit_fn fn;
	struct dl_info info;
	int error;

	fn.fn_type = ATEXIT_FN_STD;
	fn.fn_ptr.std_func = func;
	fn.fn_arg = NULL;
#if defined(__DYNAMIC__)
	if ( dladdr(func, &info) )
		fn.fn_dso = info.dli_fbase;
	else 
		fn.fn_dso = NULL;
#else /* ! defined(__DYNAMIC__) */
	fn.fn_dso = NULL;
#endif /* defined(__DYNAMIC__) */

 	error = atexit_register(&fn);	
	return (error);
}

#ifdef __BLOCKS__
int
atexit_b(void (^block)(void))
{
	struct atexit_fn fn;
	struct dl_info info;
	int error;

	fn.fn_type = ATEXIT_FN_BLK;
	fn.fn_ptr.block = Block_copy(block);
	fn.fn_arg = NULL;
#if defined(__DYNAMIC__)
	if ( dladdr(block, &info) )
		fn.fn_dso = info.dli_fbase;
	else 
		fn.fn_dso = NULL;
#else /* ! defined(__DYNAMIC__) */
	fn.fn_dso = NULL;
#endif /* defined(__DYNAMIC__) */

 	error = atexit_register(&fn);	
	return (error);
}
#endif /* __BLOCKS__ */

/*
 * Register a function to be performed at exit or when an shared object
 * with given dso handle is unloaded dynamically.
 */
int
__cxa_atexit(void (*func)(void *), void *arg, void *dso)
{
	struct atexit_fn fn;
	int error;

	fn.fn_type = ATEXIT_FN_CXA;
	fn.fn_ptr.cxa_func = func;;
	fn.fn_arg = arg;
	fn.fn_dso = dso;

 	error = atexit_register(&fn);	
	return (error);
}

/*
 * Call all handlers registered with __cxa_atexit for the shared
 * object owning 'dso'.  Note: if 'dso' is NULL, then all remaining
 * handlers are called.
 */
void
__cxa_finalize(const void *dso)
{
	struct atexit *p;
	struct atexit_fn fn;
	int n;

	_MUTEX_LOCK(&atexit_mutex);
restart:
	for (p = __atexit; p; p = p->next) {
		for (n = p->ind; --n >= 0;) {
			if (p->fns[n].fn_type == ATEXIT_FN_EMPTY)
				continue; /* already been called */
			if (dso != NULL && dso != p->fns[n].fn_dso)
				continue; /* wrong DSO */
			fn = p->fns[n];
			/*
			  Mark entry to indicate that this particular handler
			  has already been called.
			*/
			p->fns[n].fn_type = ATEXIT_FN_EMPTY;
			new_registration = 0;
		        _MUTEX_UNLOCK(&atexit_mutex);
		
			/* Call the function of correct type. */
			if (fn.fn_type == ATEXIT_FN_CXA)
				fn.fn_ptr.cxa_func(fn.fn_arg);
			else if (fn.fn_type == ATEXIT_FN_STD)
				fn.fn_ptr.std_func();
#ifdef __BLOCKS__
			else if (fn.fn_type == ATEXIT_FN_BLK)
				fn.fn_ptr.block();
#endif /* __BLOCKS__ */
			_MUTEX_LOCK(&atexit_mutex);
			if (new_registration)
			    goto restart;
		}
	}
	_MUTEX_UNLOCK(&atexit_mutex);
}

#if !TARGET_IPHONE_SIMULATOR && (__i386__ || __x86_64__)
/*
 * Support for thread_local in C++, using existing _tlv_atexit() in libdyld
 */

void _tlv_atexit(void(*f)(void*), void* arg); /* in libdyld */

void
__cxa_thread_atexit(void(*f)(void*), void* arg)
{
    _tlv_atexit(f, arg);
}
#endif
Commit	Line	Data
9385eb3d	1	/*-
e9ce8d39 A	2	* Copyright (c) 1990, 1993
	3	* The Regents of the University of California. All rights reserved.
	4	*
	5	* This code is derived from software contributed to Berkeley by
	6	* Chris Torek.
	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.
e9ce8d39 A	16	* 4. 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
9385eb3d A	33	#if defined(LIBC_SCCS) && !defined(lint)
	34	static char sccsid[] = "@(#)atexit.c 8.2 (Berkeley) 7/3/94";
	35	#endif /* LIBC_SCCS and not lint */
	36	#include <sys/cdefs.h>
1f2f436a	37	__FBSDID("$FreeBSD: src/lib/libc/stdlib/atexit.c,v 1.8 2007/01/09 00:28:09 imp Exp $");
e9ce8d39	38
9385eb3d	39	#include "namespace.h"
e9ce8d39 A	40	#include <stddef.h>
e9ce8d39 A	41	#include <stdlib.h>
9385eb3d A	42	#include <unistd.h>
9385eb3d A	43	#include <pthread.h>
ad3c9f2a A	44	#if defined(__DYNAMIC__) \|\| defined (__BLOCKS__)
	45	#include <dlfcn.h>
	46	#endif /* defined(__DYNAMIC__) */
e9ce8d39	47	#include "atexit.h"
9385eb3d A	48	#include "un-namespace.h"
9385eb3d A	49
ad3c9f2a A	50	#ifdef __BLOCKS__
	51	#include <Block.h>
	52	#endif /* __BLOCKS__ */
9385eb3d A	53	#include "libc_private.h"
9385eb3d A	54
6465356a A	55	#include <TargetConditionals.h>
6465356a A	56
59e0d9fe A	57	#define ATEXIT_FN_EMPTY 0
	58	#define ATEXIT_FN_STD 1
	59	#define ATEXIT_FN_CXA 2
ad3c9f2a A	60	#ifdef __BLOCKS__
	61	#define ATEXIT_FN_BLK 3
	62	#endif /* __BLOCKS__ */
59e0d9fe	63
9385eb3d A	64	static pthread_mutex_t atexit_mutex = PTHREAD_MUTEX_INITIALIZER;
	65
	66	#define _MUTEX_LOCK(x) if (__isthreaded) _pthread_mutex_lock(x)
	67	#define _MUTEX_UNLOCK(x) if (__isthreaded) _pthread_mutex_unlock(x)
e9ce8d39	68
59e0d9fe A	69	struct atexit {
	70	struct atexit next; / next in list */
	71	int ind; /* next index in this table */
	72	struct atexit_fn {
	73	int fn_type; /* ATEXIT_? from above */
	74	union {
	75	void (*std_func)(void);
	76	void (cxa_func)(void );
ad3c9f2a A	77	#ifdef __BLOCKS__
	78	void (^block)(void);
	79	#endif /* __BLOCKS__ */
59e0d9fe A	80	} fn_ptr; /* function pointer */
	81	void fn_arg; / argument for CXA callback */
	82	void fn_dso; / shared module handle */
	83	} fns[ATEXIT_SIZE]; /* the table itself */
	84	};
	85
	86	static struct atexit __atexit; / points to head of LIFO stack */
ad3c9f2a	87	static int new_registration;
e9ce8d39 A	88
e9ce8d39 A	89	/*
59e0d9fe A	90	* Register the function described by 'fptr' to be called at application
	91	* exit or owning shared object unload time. This is a helper function
	92	* for atexit and __cxa_atexit.
e9ce8d39	93	*/
59e0d9fe A	94	static int
59e0d9fe A	95	atexit_register(struct atexit_fn *fptr)
e9ce8d39 A	96	{
e9ce8d39 A	97	static struct atexit __atexit0; /* one guaranteed table */
9385eb3d	98	struct atexit *p;
e9ce8d39	99
9385eb3d	100	_MUTEX_LOCK(&atexit_mutex);
e9ce8d39 A	101	if ((p = __atexit) == NULL)
e9ce8d39 A	102	__atexit = p = &__atexit0;
9385eb3d A	103	else while (p->ind >= ATEXIT_SIZE) {
	104	struct atexit *old__atexit;
	105	old__atexit = __atexit;
	106	_MUTEX_UNLOCK(&atexit_mutex);
	107	if ((p = (struct atexit )malloc(sizeof(p))) == NULL)
e9ce8d39	108	return (-1);
9385eb3d A	109	_MUTEX_LOCK(&atexit_mutex);
	110	if (old__atexit != __atexit) {
	111	/* Lost race, retry operation */
	112	_MUTEX_UNLOCK(&atexit_mutex);
	113	free(p);
	114	_MUTEX_LOCK(&atexit_mutex);
	115	p = __atexit;
	116	continue;
	117	}
e9ce8d39 A	118	p->ind = 0;
	119	p->next = __atexit;
	120	__atexit = p;
	121	}
59e0d9fe	122	p->fns[p->ind++] = *fptr;
ad3c9f2a	123	new_registration = 1;
59e0d9fe A	124	_MUTEX_UNLOCK(&atexit_mutex);
	125	return 0;
	126	}
	127
	128	/*
	129	* Register a function to be performed at exit.
	130	*/
	131	int
	132	atexit(void (*func)(void))
	133	{
	134	struct atexit_fn fn;
ad3c9f2a	135	struct dl_info info;
59e0d9fe A	136	int error;
	137
	138	fn.fn_type = ATEXIT_FN_STD;
ad3c9f2a	139	fn.fn_ptr.std_func = func;
59e0d9fe	140	fn.fn_arg = NULL;
ad3c9f2a A	141	#if defined(__DYNAMIC__)
	142	if ( dladdr(func, &info) )
	143	fn.fn_dso = info.dli_fbase;
	144	else
	145	fn.fn_dso = NULL;
	146	#else /* ! defined(__DYNAMIC__) */
59e0d9fe	147	fn.fn_dso = NULL;
ad3c9f2a	148	#endif /* defined(__DYNAMIC__) */
59e0d9fe A	149
	150	error = atexit_register(&fn);
	151	return (error);
	152	}
	153
ad3c9f2a A	154	#ifdef __BLOCKS__
	155	int
	156	atexit_b(void (^block)(void))
	157	{
	158	struct atexit_fn fn;
	159	struct dl_info info;
	160	int error;
	161
	162	fn.fn_type = ATEXIT_FN_BLK;
	163	fn.fn_ptr.block = Block_copy(block);
	164	fn.fn_arg = NULL;
	165	#if defined(__DYNAMIC__)
	166	if ( dladdr(block, &info) )
	167	fn.fn_dso = info.dli_fbase;
	168	else
	169	fn.fn_dso = NULL;
	170	#else /* ! defined(__DYNAMIC__) */
	171	fn.fn_dso = NULL;
	172	#endif /* defined(__DYNAMIC__) */
	173
	174	error = atexit_register(&fn);
	175	return (error);
	176	}
	177	#endif /* __BLOCKS__ */
	178
59e0d9fe A	179	/*
	180	* Register a function to be performed at exit or when an shared object
	181	* with given dso handle is unloaded dynamically.
	182	*/
	183	int
	184	__cxa_atexit(void (func)(void ), void arg, void dso)
	185	{
	186	struct atexit_fn fn;
	187	int error;
	188
	189	fn.fn_type = ATEXIT_FN_CXA;
	190	fn.fn_ptr.cxa_func = func;;
	191	fn.fn_arg = arg;
	192	fn.fn_dso = dso;
	193
	194	error = atexit_register(&fn);
	195	return (error);
	196	}
	197
	198	/*
	199	* Call all handlers registered with __cxa_atexit for the shared
	200	* object owning 'dso'. Note: if 'dso' is NULL, then all remaining
	201	* handlers are called.
	202	*/
	203	void
ad3c9f2a	204	__cxa_finalize(const void *dso)
59e0d9fe A	205	{
	206	struct atexit *p;
	207	struct atexit_fn fn;
	208	int n;
	209
	210	_MUTEX_LOCK(&atexit_mutex);
ad3c9f2a	211	restart:
59e0d9fe A	212	for (p = __atexit; p; p = p->next) {
	213	for (n = p->ind; --n >= 0;) {
	214	if (p->fns[n].fn_type == ATEXIT_FN_EMPTY)
	215	continue; /* already been called */
	216	if (dso != NULL && dso != p->fns[n].fn_dso)
	217	continue; /* wrong DSO */
	218	fn = p->fns[n];
	219	/*
	220	Mark entry to indicate that this particular handler
	221	has already been called.
	222	*/
	223	p->fns[n].fn_type = ATEXIT_FN_EMPTY;
ad3c9f2a	224	new_registration = 0;
59e0d9fe A	225	_MUTEX_UNLOCK(&atexit_mutex);
	226
	227	/* Call the function of correct type. */
	228	if (fn.fn_type == ATEXIT_FN_CXA)
	229	fn.fn_ptr.cxa_func(fn.fn_arg);
	230	else if (fn.fn_type == ATEXIT_FN_STD)
	231	fn.fn_ptr.std_func();
ad3c9f2a A	232	#ifdef __BLOCKS__
	233	else if (fn.fn_type == ATEXIT_FN_BLK)
	234	fn.fn_ptr.block();
	235	#endif /* __BLOCKS__ */
59e0d9fe	236	_MUTEX_LOCK(&atexit_mutex);
ad3c9f2a A	237	if (new_registration)
ad3c9f2a A	238	goto restart;
59e0d9fe A	239	}
59e0d9fe A	240	}
9385eb3d	241	_MUTEX_UNLOCK(&atexit_mutex);
e9ce8d39	242	}
6465356a A	243
	244	#if !TARGET_IPHONE_SIMULATOR && (__i386__ \|\| __x86_64__)
	245	/*
	246	* Support for thread_local in C++, using existing _tlv_atexit() in libdyld
	247	*/
	248
	249	void _tlv_atexit(void(f)(void), void* arg); /* in libdyld */
	250
	251	void
	252	__cxa_thread_atexit(void(f)(void), void* arg)
	253	{
	254	_tlv_atexit(f, arg);
	255	}
	256	#endif