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