Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

as(1)

cc(1)

dbx(1)

ld(1)

pc(1)

a.out(5)

stab(5)  —  VAX

Name

stab − symbol table types

Syntax

#include <stab.h>

Description

The stab.h file defines some values of the n_type field of the symbol table of a.out files. These are the types for permanent symbols (that is, not local labels, and so on) used by the debugger dbx and the Berkeley Pascal compiler pc(.). Symbol table entries can be produced by the .stabs assembler directive, which allows you to specify a double-quote delimited name, a symbol type, one char and one short of information about the symbol, and an unsigned long (usually an address).

To avoid having to produce an explicit label for the address field, the .stabd directive can be used to implicitly address the current location.  If no name is needed, symbol table entries can be generated using the .stabn directive.  The loader promises to preserve the order of symbol table entries produced by .stab directives.  As described in a.out(,), an element of the symbol table consists of the following structure:

/*
struct nlist {
   union {
        char   *n_name; /* for use when in-core */
        long    n_strx; /* index into file string table */
   } n_un;
        unsigned char   n_type;    /* type flag */
        char            n_other;   /* unused */
        short           n_desc;    /* see struct desc, below */
        unsigned        n_value;   /* address or offset or line */
};

The low bits of the n_type field are used to place a symbol into one segment, maximum, according to the following masks defined in <a.out.h>. If none of the segment bits are set, a symbol cannot be in any of these segments.

* Simple values for n_type.
#define N_UNDF  0x0     /* undefined */
#define N_ABS   0x2     /* absolute */
#define N_TEXT  0x4     /* text */
#define N_DATA  0x6     /* data */
#define N_BSS   0x8     /* bss */
 #define N_EXT   01      /* external bit, or’ed in */

The n_value field of a symbol is relocated by the linker, ld, as an address within the appropriate segment. N_value fields of symbols not in any segment are unchanged by the linker. In addition, the linker will discard certain symbols, according to rules of its own, unless the n_type field has one of the following bits set:

/*
* Other permanent symbol table entries have some of the
* N_STAB bits set.  These are given in <stab.h>
*/
#define N_STAB 0xe0 /* if any of these bits set, don’t discard */

This allows up to 112 (7 ∗ 16) symbol types, split between the various segments.  Some of these have already been claimed.  The C compiler generates the following n_type values, where the comments give the use for .stabs and the n_name, n_other, n_desc, and n_value fields of the given n_type:

#define N_GSYM  0x20 /* global symbol: name,,0,type,0 */
#define N_FNAME 0x22 /* procedure name (f77 kludge): name,,0 */
#define N_FUN   0x24 /* procedure: name,,0,linenumber,address */
#define N_STSYM 0x26 /* static symbol: name,,0,type,address */
#define N_LCSYM 0x28 /* .lcomm symbol: name,,0,type,address */
#define N_RSYM  0x40 /* register sym: name,,0,type,register */
#define N_SLINE 0x44 /* src line: 0,,0,linenumber,address */
#define N_SSYM  0x60 /* struct elt: name,,0,type,struct_offset */
#define N_SO    0x64 /* source file name: name,,0,0,address */
#define N_LSYM  0x80 /* local sym: name,,0,type,offset */
#define N_SOL   0x84 /* #included file name: name,,0,0,address */
#define N_PSYM  0xa0 /* parameter: name,,0,type,offset */
#define N_ENTRY 0xa4 /* alt entry: name,linenumber,address */
#define N_LBRAC 0xc0 /* lft bracket: 0,,0,nesting level,address */
#define N_RBRAC 0xe0 /* rt bracket: 0,,0,nesting level,address */
#define N_BCOMM 0xe2 /* begin common: name,, */
#define N_ECOMM 0xe4 /* end common: name,, */
#define N_ECOML 0xe8 /* end common (local name): ,,address */
#define N_LENG  0xfe /* second stab entry with length information */

The n_desc holds a type specifier in the form used by the Portable C Compiler, cc(,), in which a base type is qualified in the following structure:

struct desc {
shortq6:2,
q5:2,
q4:2,
q3:2,
q2:2,
q1:2,
basic:4;
};

There are 4 qualifications, with q1 the most significant and q6 the least significant:

0None

1Pointer

2Function

3Array

The 16 basic types are assigned as follows:

0Undefined

1Function argument

2Character

3Short

4Int

5Long

6Float

7Double

8Structure

9Union

10Enumeration

11Member of enumeration

12Unsigned character

13Unsigned short

14Unsigned int

15Unsigned long

The same information is encoded in a more useful form in the symbolic string.  The symbol’s name is followed by a colon, which is followed by a description of the symbol’s type.  This begins with one of the following letters:

cConstant

fLocal function

FFunction name

GGlobal variable

pArgument (by value)

PExternal procedure

rRegister variable

sStatic variable

tTypedef name

TLocal variable

vArgument (by ref)

VLocal static variable

No letter
Local dynamic variable

This is followed by the variable’s type, where type is any of the following:

integerSame as previously defined type integer

integer=typeDefine type integer to have form type

*typePointer to type

rtype;low;high;Range of type from low to high

arangetypeArray with bounds range of type

ename:value,;Enumerated type.  The phrase "name:value," repeats as needed. 

ssizename:type,offset,size;;
Structure.  The size is the number of bytes in the complete structure.  The phrase "name:type,offset,size;" repeats as needed, giving the offset from the start of the structure (in bits) and the size in bits of each member. 

usizename:type,offset,size;;
Union.  Analogous to structure entry.

StypeSet of type. 

ftype,integer;type,class;
Function returning type with integer parameters, described by the repeating "type,class;" phrase. 

pinteger;type,class;
Procedure−like function

dtypeFile of type

The Berkeley Pascal compiler, pc(,), uses the following n_type value:

#defineN_PC0x30/* global pascal symbol: name,,0,subtype,line */

The complier uses the following subtypes to do type checking across separately compiled files:

1Source file name

2Included file name

3Global label

4Global constant

5Global type

6Global variable

7Global function

8Global procedure

9External function

10External procedure

11Library variable

12Library routine

See Also

as(1), cc(1), dbx(1), ld(1), pc(1), a.out(5)

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026