xref: /dragonfly/include/nlist.h (revision cae2835b)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)nlist.h	8.2 (Berkeley) 1/21/94
35  *
36  * $FreeBSD: src/include/nlist.h,v 1.7 1999/08/27 23:44:51 peter Exp $
37  * $DragonFly: src/include/nlist.h,v 1.4 2004/11/18 12:38:43 joerg Exp $
38  */
39 
40 #ifndef _NLIST_H_
41 #define	_NLIST_H_
42 
43 /*
44  * Symbol table entries in a.out files.
45  */
46 
47 /*
48  * Layout of each symbol.  The "#ifdef _AOUT_INCLUDE_" is so that
49  * programs including nlist.h can initialize nlist structures
50  * statically.
51  */
52 struct nlist {
53 #ifdef _AOUT_INCLUDE_
54 	union {
55 		const char *n_name;	/* symbol name (in memory) */
56 		long n_strx;		/* file string table offset (on disk) */
57 	} n_un;
58 #else
59 	const char *n_name;	/* symbol name (in memory) */
60 #endif
61 	unsigned char n_type;	/* type defines */
62 	char n_other;		/* ".type" and binding information */
63 	short n_desc;		/* used by stab entries */
64 	unsigned long n_value;	/* address/value of the symbol */
65 };
66 
67 #define	n_hash	n_desc		/* used internally by ld(1); XXX */
68 
69 /*
70  * Defines for n_type.
71  */
72 #define	N_UNDF	0x00		/* undefined */
73 #define	N_ABS	0x02		/* absolute address */
74 #define	N_TEXT	0x04		/* text segment */
75 #define	N_DATA	0x06		/* data segment */
76 #define	N_BSS	0x08		/* bss segment */
77 #define	N_INDR	0x0a		/* alias definition */
78 #define	N_SIZE	0x0c		/* pseudo type, defines a symbol's size */
79 #define	N_COMM	0x12		/* common reference */
80 /* GNU extensions */
81 #define N_SETA	0x14		/* Absolute set element symbol */
82 #define N_SETT  0x16		/* Text set element symbol */
83 #define N_SETD  0x18		/* Data set element symbol */
84 #define N_SETB  0x1a		/* Bss set element symbol */
85 #define N_SETV  0x1c		/* Pointer to set vector in data area. */
86 /* end GNU extensions */
87 #define	N_FN	0x1e		/* file name (N_EXT on) */
88 #define	N_WARN	0x1e		/* warning message (N_EXT off) */
89 
90 #define	N_EXT	0x01		/* external (global) bit, OR'ed in */
91 #define	N_TYPE	0x1e		/* mask for all the type bits */
92 #define	N_STAB	0xe0		/* mask for debugger symbols -- stab(5) */
93 
94 /*
95  * Defines for n_other.  It contains the ".type" (AUX) field in the least
96  * significant 4 bits, and the binding (for weak symbols) in the most
97  * significant 4 bits.
98  */
99 #define N_AUX(p)	((p)->n_other & 0xf)
100 #define N_BIND(p)	(((unsigned int)(p)->n_other >> 4) & 0xf)
101 #define N_OTHER(r, v)	(((unsigned int)(r) << 4) | ((v) & 0xf))
102 
103 #define AUX_OBJECT	1	/* data object */
104 #define AUX_FUNC	2	/* function */
105 
106 /*#define BIND_LOCAL	0	not used */
107 /*#define BIND_GLOBAL	1	not used */
108 #define BIND_WEAK	2	/* weak binding */
109 
110 #define	N_FORMAT	"%08x"	/* namelist value format; XXX */
111 
112 #include <sys/cdefs.h>
113 
114 __BEGIN_DECLS
115 int nlist (const char *, struct nlist *);
116 __END_DECLS
117 
118 #endif /* !_NLIST_H_ */
119