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