[apple/xnu.git] / bsd / sys / linker_set.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1999 John D. Polstra
 * All rights reserved.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
 *
 */

#ifndef _SYS_LINKER_SET_H_
#define _SYS_LINKER_SET_H_

#include <sys/appleapiopts.h>

#if !defined(KERNEL) || defined(__APPLE_API_PRIVATE)
/*
 * The following macros are used to declare global sets of objects, which
 * are collected by the linker into a `struct linker_set' as defined below.
 * For ELF, this is done by constructing a separate segment for each set.
 * For a.out, it is done automatically by the linker.
 */

#define __ELF__
#ifdef __ELF__

#define MAKE_SET(seg, set, sym)						\
	static void const * const __set_##set##_sym_##sym = &sym;	\
	__asm(".section  seg, " #set ""); 	\
	__asm(".long " #sym);						

/*	__asm(".previous") */


#define TEXT_SET(set, sym) MAKE_SET(__TEXT, set, sym)
#define DATA_SET(set, sym) MAKE_SET(__DATA, set, sym)
#define BSS_SET(set, sym)  MAKE_SET(__BSS,  set, sym)
#define ABS_SET(set, sym)  MAKE_SET(__ABS,  set, sym)

#else

/*
 * NB: the constants defined below must match those defined in
 * nlist.h.  Since their calculation requires arithmetic, we
 * can't name them symbolically (e.g., 7 is N_DATA | N_EXT).
 */
#define MAKE_SET(set, sym, type) \
	static void const * const __set_##set##_sym_##sym = &sym; \
	__asm(".stabs \"_" #set "\", " #type ", 0, 0, _" #sym)

#define TEXT_SET(set, sym) MAKE_SET(set, sym, 5)
#define DATA_SET(set, sym) MAKE_SET(set, sym, 7)
#define BSS_SET(set, sym)  MAKE_SET(set, sym, 9)
#define ABS_SET(set, sym)  MAKE_SET(set, sym, 3)

#endif

struct linker_set {
	int		ls_length;
	const void	*ls_items[1];		/* really ls_length of them,
						 * trailing NULL */
};
#endif /* !KERNEL || __APPLE_API_PRIVATE */

#endif /* _SYS_LINKER_SET_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*-
	29	* Copyright (c) 1999 John D. Polstra
	30	* All rights reserved.
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright
	38	* notice, this list of conditions and the following disclaimer in the
	39	* documentation and/or other materials provided with the distribution.
	40	*
	41	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	42	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	43	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	44	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	45	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	46	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	47	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	48	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	49	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	50	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	51	* SUCH DAMAGE.
	52	*
	53	*/
	54
	55	#ifndef _SYS_LINKER_SET_H_
	56	#define _SYS_LINKER_SET_H_
	57
9bccf70c A	58	#include <sys/appleapiopts.h>
	59
	60	#if !defined(KERNEL) \|\| defined(__APPLE_API_PRIVATE)
1c79356b A	61	/*
	62	* The following macros are used to declare global sets of objects, which
	63	* are collected by the linker into a `struct linker_set' as defined below.
	64	* For ELF, this is done by constructing a separate segment for each set.
	65	* For a.out, it is done automatically by the linker.
	66	*/
	67
	68	#define __ELF__
	69	#ifdef __ELF__
	70
	71	#define MAKE_SET(seg, set, sym) \
	72	static void const * const __set_##set##_sym_##sym = &sym; \
	73	__asm(".section seg, " #set ""); \
	74	__asm(".long " #sym);
	75
	76	/* __asm(".previous") */
	77
	78
	79	#define TEXT_SET(set, sym) MAKE_SET(__TEXT, set, sym)
	80	#define DATA_SET(set, sym) MAKE_SET(__DATA, set, sym)
	81	#define BSS_SET(set, sym) MAKE_SET(__BSS, set, sym)
	82	#define ABS_SET(set, sym) MAKE_SET(__ABS, set, sym)
	83
	84	#else
	85
	86	/*
	87	* NB: the constants defined below must match those defined in
	88	* nlist.h. Since their calculation requires arithmetic, we
	89	* can't name them symbolically (e.g., 7 is N_DATA \| N_EXT).
	90	*/
	91	#define MAKE_SET(set, sym, type) \
	92	static void const * const __set_##set##_sym_##sym = &sym; \
	93	__asm(".stabs \"_" #set "\", " #type ", 0, 0, _" #sym)
	94
	95	#define TEXT_SET(set, sym) MAKE_SET(set, sym, 5)
	96	#define DATA_SET(set, sym) MAKE_SET(set, sym, 7)
	97	#define BSS_SET(set, sym) MAKE_SET(set, sym, 9)
	98	#define ABS_SET(set, sym) MAKE_SET(set, sym, 3)
	99
	100	#endif
	101
	102	struct linker_set {
	103	int ls_length;
	104	const void ls_items[1]; / really ls_length of them,
	105	* trailing NULL */
	106	};
9bccf70c	107	#endif /* !KERNEL \|\| __APPLE_API_PRIVATE */
1c79356b A	108
	109	#endif /* _SYS_LINKER_SET_H_ */
	110