share/man/man5/stab.5

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  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 .\"     @(#)stab.5      8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 10, 2010
  36 .Dt STAB 5
  37 .Os
  38 .Sh NAME
  39 .Nm stab
  40 .Nd symbol table types
  41 .Sh SYNOPSIS
  42 .In stab.h
  43 .Sh DESCRIPTION
  44 The file
  45 .In stab.h
  46 defines some of the symbol table
  47 .Fa n_type
  48 field values for a.out files.
  49 These are the types for permanent symbols (i.e., not local labels, etc.)
  50 used by the old debugger
  51 .Em sdb
  52 and the Berkeley Pascal compiler
  53 .Xr pc 1 .
  54 Symbol table entries can be produced by the
  55 .Pa .stabs
  56 assembler directive.
  57 This allows one to specify a double-quote delimited name, a symbol type,
  58 one char and one short of information about the symbol, and an unsigned
  59 long (usually an address).
  60 To avoid having to produce an explicit label for the address field,
  61 the
  62 .Pa .stabd
  63 directive can be used to implicitly address the current location.
  64 If no name is needed, symbol table entries can be generated using the
  65 .Pa .stabn
  66 directive.
  67 The loader promises to preserve the order of symbol table entries produced
  68 by
  69 .Pa .stab
  70 directives.
  71 As described in
  72 .Xr a.out 5 ,
  73 an element of the symbol table
  74 consists of the following structure:
  75 .Bd -literal
  76 /*
  77 * Format of a symbol table entry.
  78 */
  79
  80 struct nlist {
  81         union {
  82                 const char *n_name;     /* for use when in-core */
  83                 long    n_strx;         /* index into file string table */
  84         } n_un;
  85         unsigned char   n_type;         /* type flag */
  86         char            n_other;        /* unused */
  87         short           n_desc;         /* see struct desc, below */
  88         unsigned        n_value;        /* address or offset or line */
  89 };
  90 .Ed
  91 .Pp
  92 The low bits of the
  93 .Fa n_type
  94 field are used to place a symbol into
  95 at most one segment, according to
  96 the following masks, defined in
  97 .In a.out.h .
  98 A symbol can be in none of these segments by having none of these segment
  99 bits set.
 100 .Bd -literal
 101 /*
 102 * Simple values for n_type.
 103 */
 104
 105 #define N_UNDF  0x0     /* undefined */
 106 #define N_ABS   0x2     /* absolute */
 107 #define N_TEXT  0x4     /* text */
 108 #define N_DATA  0x6     /* data */
 109 #define N_BSS   0x8     /* bss */
 110
 111 #define N_EXT   01      /* external bit, or'ed in */
 112 .Ed
 113 .Pp
 114 The
 115 .Fa n_value
 116 field of a symbol is relocated by the linker,
 117 .Xr ld 1
 118 as an address within the appropriate segment.
 119 .Fa N_value
 120 fields of symbols not in any segment are unchanged by the linker.
 121 In addition, the linker will discard certain symbols, according to rules
 122 of its own, unless the
 123 .Fa n_type
 124 field has one of the following bits set:
 125 .Bd -literal
 126 /*
 127 * Other permanent symbol table entries have some of the N_STAB bits set.
 128 * These are given in <stab.h>
 129 */
 130
 131 #define N_STAB  0xe0    /* if any of these bits set, don't discard */
 132 .Ed
 133 .Pp
 134 This allows up to 112 (7 \(** 16) symbol types, split between the various
 135 segments.
 136 Some of these have already been claimed.
 137 The old symbolic debugger,
 138 .Em sdb ,
 139 uses the following n_type values:
 140 .Bd -literal
 141 #define N_GSYM  0x20    /* global symbol: name,,0,type,0 */
 142 #define N_FNAME 0x22    /* procedure name (f77 kludge): name,,0 */
 143 #define N_FUN   0x24    /* procedure: name,,0,linenumber,address */
 144 #define N_STSYM 0x26    /* static symbol: name,,0,type,address */
 145 #define N_LCSYM 0x28    /* .lcomm symbol: name,,0,type,address */
 146 #define N_RSYM  0x40    /* register sym: name,,0,type,register */
 147 #define N_SLINE 0x44    /* src line: 0,,0,linenumber,address */
 148 #define N_SSYM  0x60    /* structure elt: name,,0,type,struct_offset */
 149 #define N_SO    0x64    /* source file name: name,,0,0,address */
 150 #define N_LSYM  0x80    /* local sym: name,,0,type,offset */
 151 #define N_SOL   0x84    /* #included file name: name,,0,0,address */
 152 #define N_PSYM  0xa0    /* parameter: name,,0,type,offset */
 153 #define N_ENTRY 0xa4    /* alternate entry: name,linenumber,address */
 154 #define N_LBRAC 0xc0    /* left bracket: 0,,0,nesting level,address */
 155 #define N_RBRAC 0xe0    /* right bracket: 0,,0,nesting level,address */
 156 #define N_BCOMM 0xe2    /* begin common: name,, */
 157 #define N_ECOMM 0xe4    /* end common: name,, */
 158 #define N_ECOML 0xe8    /* end common (local name): ,,address */
 159 #define N_LENG  0xfe    /* second stab entry with length information */
 160 .Ed
 161 .Pp
 162 where the comments give
 163 .Em sdb
 164 conventional use for
 165 .Pa .stab
 166 .Fa s
 167 and the
 168 .Fa n_name ,
 169 .Fa n_other ,
 170 .Fa n_desc ,
 171 and
 172 .Fa n_value
 173 fields
 174 of the given
 175 .Fa n_type .
 176 .Em Sdb
 177 uses the
 178 .Fa n_desc
 179 field to hold a type specifier in the form used
 180 by the Portable C Compiler,
 181 .Xr cc 1 ;
 182 see the header file
 183 .Pa pcc.h
 184 for details on the format of these type values.
 185 .Pp
 186 The Berkeley Pascal compiler,
 187 .Xr pc 1 ,
 188 uses the following
 189 .Fa n_type
 190 value:
 191 .Bd -literal
 192 #define N_PC    0x30    /* global pascal symbol: name,,0,subtype,line */
 193 .Ed
 194 .Pp
 195 and uses the following subtypes to do type checking across separately
 196 compiled files:
 197 .Bd -unfilled -offset indent
 198 1       source file name
 199 2       included file name
 200 3       global label
 201 4       global constant
 202 5       global type
 203 6       global variable
 204 7       global function
 205 8       global procedure
 206 9       external function
 207 10      external procedure
 208 11      library variable
 209 12      library routine
 210 .Ed
 211 .Sh SEE ALSO
 212 .Xr as 1 ,
 213 .Xr ld 1 ,
 214 .Xr a.out 5
 215 .Sh HISTORY
 216 The
 217 .Nm
 218 file appeared in
 219 .Bx 4.0 .
 220 .Sh BUGS
 221 More basic types are needed.