2 @setfilename stabs.info
7 * Stabs: (stabs). The "stabs" debugging information format.
13 This document describes GNU stabs (debugging symbol tables) in a.out files.
15 Copyright 1992 Free Software Foundation, Inc.
16 Contributed by Cygnus Support. Written by Julia Menapace.
18 Permission is granted to make and distribute verbatim copies of
19 this manual provided the copyright notice and this permission notice
20 are preserved on all copies.
23 Permission is granted to process this file through Tex and print the
24 results, provided the printed document carries copying permission
25 notice identical to this one except for the removal of this paragraph
26 (this paragraph not being relevant to the printed manual).
29 Permission is granted to copy or distribute modified versions of this
30 manual under the terms of the GPL (for which purpose this text may be
31 regarded as a program in the language TeX).
34 @setchapternewpage odd
37 @title The ``stabs'' debug format
38 @author Julia Menapace
39 @author Cygnus Support
42 \def\$#1${{#1}} % Kluge: collect RCS revision info without $...$
43 \xdef\manvers{\$Revision$} % For use in headers, footers too
45 \hfill Cygnus Support\par
47 \hfill \TeX{}info \texinfoversion\par
51 @vskip 0pt plus 1filll
52 Copyright @copyright{} 1992 Free Software Foundation, Inc.
53 Contributed by Cygnus Support.
55 Permission is granted to make and distribute verbatim copies of
56 this manual provided the copyright notice and this permission notice
57 are preserved on all copies.
63 @top The "stabs" representation of debugging information
65 This document describes the GNU stabs debugging format in a.out files.
68 * Overview:: Overview of stabs
69 * Program structure:: Encoding of the structure of the program
71 * Example:: A comprehensive example in C
74 * Symbol tables:: Symbol information in symbol tables
75 * GNU Cplusplus stabs::
78 * Example2.c:: Source code for extended example
79 * Example2.s:: Assembly code for extended example
80 * Quick reference:: Various refernce tables
81 * Expanded reference:: Reference information by stab type
82 * Questions:: Questions and anomolies
83 * xcoff-differences:: Differences between GNU stabs in a.out
84 and GNU stabs in xcoff
85 * Sun-differences:: Differences between GNU stabs and Sun
92 @chapter Overview of stabs
94 @dfn{Stabs} refers to a format for information that describes a program
95 to a debugger. This format was apparently invented by
96 @c FIXME! <<name of inventor>> at
97 the University of California at Berkeley, for the @code{pdx} Pascal
98 debugger; the format has spread widely since then.
101 * Flow:: Overview of debugging information flow
102 * Stabs format:: Overview of stab format
103 * C example:: A simple example in C source
104 * Assembly code:: The simple example at the assembly level
108 @section Overview of debugging information flow
110 The GNU C compiler compiles C source in a @file{.c} file into assembly
111 language in a @file{.s} file, which is translated by the assembler into
112 a @file{.o} file, and then linked with other @file{.o} files and
113 libraries to produce an executable file.
115 With the @samp{-g} option, GCC puts additional debugging information in
116 the @file{.s} file, which is slightly transformed by the assembler and
117 linker, and carried through into the final executable. This debugging
118 information describes features of the source file like line numbers,
119 the types and scopes of variables, and functions, their parameters and
122 For some object file formats, the debugging information is
123 encapsulated in assembler directives known collectively as `stab' (symbol
124 table) directives, interspersed with the generated code. Stabs are
125 the native format for debugging information in the a.out and xcoff
126 object file formats. The GNU tools can also emit stabs in the coff
127 and ecoff object file formats.
129 The assembler adds the information from stabs to the symbol information
130 it places by default in the symbol table and the string table of the
131 @file{.o} file it is building. The linker consolidates the @file{.o}
132 files into one executable file, with one symbol table and one string
133 table. Debuggers use the symbol and string tables in the executable as
134 a source of debugging information about the program.
137 @section Overview of stab format
139 There are three overall formats for stab assembler directives
140 differentiated by the first word of the stab. The name of the directive
141 describes what combination of four possible data fields will follow. It
142 is either @code{.stabs} (string), @code{.stabn} (number), or
145 The overall format of each class of stab is:
148 .stabs "@var{string}",@var{type},0,@var{desc},@var{value}
149 .stabn @var{type},0,@var{desc},@var{value}
150 .stabd @var{type},0,@var{desc}
153 In general, in @code{.stabs} the @var{string} field contains name and type
154 information. For @code{.stabd} the value field is implicit and has the value
155 of the current file location. Otherwise the value field often
156 contains a relocatable address, frame pointer offset, or register
157 number, that maps to the source code element described by the stab.
159 The real key to decoding the meaning of a stab is the number in its type
160 field. Each possible type number defines a different stab type. The
161 stab type further defines the exact interpretation of, and possible
162 values for, any remaining @code{"@var{string}"}, @var{desc}, or
163 @var{value} fields present in the stab. Table A (@pxref{Stab
164 types,,Table A: Symbol types from stabs}) lists in numeric order
165 the possible type field values for stab directives. The reference
166 section that follows Table A describes the meaning of the fields for
167 each stab type in detail. The examples that follow this overview
168 introduce the stab types in terms of the source code elements they
171 For @code{.stabs} the @code{"@var{string}"} field holds the meat of the
172 debugging information. The generally unstructured nature of this field
173 is what makes stabs extensible. For some stab types the string field
174 contains only a name. For other stab types the contents can be a great
177 The overall format is of the @code{"@var{string}"} field is:
180 "@var{name}@r{[}:@var{symbol_descriptor}@r{]}
181 @r{[}@var{type_number}@r{[}=@var{type_descriptor} @r{@dots{}]]}"
184 @var{name} is the name of the symbol represented by the stab.
186 The @var{symbol_descriptor} following the @samp{:} is an alphabetic
187 character that tells more specifically what kind of symbol the stab
188 represents. If the @var{symbol_descriptor} is omitted, but type
189 information follows, then the stab represents a local variable. For a
190 list of symbol_descriptors, see @ref{Symbol descriptors,,Table C: Symbol
193 Type information is either a @var{type_number}, or a
194 @samp{@var{type_number}=}. The @var{type_number} alone is a type
195 reference, referring directly to a type that has already been defined.
197 The @samp{@var{type_number}=} is a type definition, where the number
198 represents a new type which is about to be defined. The type definition
199 may refer to other types by number, and those type numbers may be
200 followed by @samp{=} and nested definitions.
202 In a type definition, if the character that follows the equals sign is
203 non-numeric then it is a @var{type_descriptor}, and tells what kind of
204 type is about to be defined. Any other values following the
205 @var{type_descriptor} vary, depending on the @var{type_descriptor}. If
206 a number follows the @samp{=} then the number is a @var{type_reference}.
207 This is described more thoroughly in the section on types. @xref{Type
208 Descriptors,,Table D: Type Descriptors}, for a list of
209 @var{type_descriptor} values.
211 @c FIXME! "too long" below introduced at J Gilmore's request; used to
212 @c say "more than 80 chars". Why is vaguer better?
213 All this can make the @code{"@var{string}"} field quite long. When the
214 @code{"@var{string}"} part of a stab is too long, the compiler splits
215 the @code{.stabs} directive into two @code{.stabs} directives. Both
216 stabs duplicate exactly all but the @code{"@var{string}"} field. The
217 @code{"@var{string}"} field of the first stab contains the first part of
218 the overlong string, marked as continued with a double-backslash at the
219 end. The @code{"@var{string}"} field of the second stab holds the
220 second half of the overlong string.
223 @section A simple example in C source
225 To get the flavor of how stabs describe source information for a C
226 program, let's look at the simple program:
231 printf("Hello world");
235 When compiled with @samp{-g}, the program above yields the following
236 @file{.s} file. Line numbers have been added to make it easier to refer
237 to parts of the @file{.s} file in the description of the stabs that
241 @section The simple example at the assembly level
245 2 .stabs "/cygint/s1/users/jcm/play/",100,0,0,Ltext0
246 3 .stabs "hello.c",100,0,0,Ltext0
249 6 .stabs "int:t1=r1;-2147483648;2147483647;",128,0,0,0
250 7 .stabs "char:t2=r2;0;127;",128,0,0,0
251 8 .stabs "long int:t3=r1;-2147483648;2147483647;",128,0,0,0
252 9 .stabs "unsigned int:t4=r1;0;-1;",128,0,0,0
253 10 .stabs "long unsigned int:t5=r1;0;-1;",128,0,0,0
254 11 .stabs "short int:t6=r1;-32768;32767;",128,0,0,0
255 12 .stabs "long long int:t7=r1;0;-1;",128,0,0,0
256 13 .stabs "short unsigned int:t8=r1;0;65535;",128,0,0,0
257 14 .stabs "long long unsigned int:t9=r1;0;-1;",128,0,0,0
258 15 .stabs "signed char:t10=r1;-128;127;",128,0,0,0
259 16 .stabs "unsigned char:t11=r1;0;255;",128,0,0,0
260 17 .stabs "float:t12=r1;4;0;",128,0,0,0
261 18 .stabs "double:t13=r1;8;0;",128,0,0,0
262 19 .stabs "long double:t14=r1;8;0;",128,0,0,0
263 20 .stabs "void:t15=15",128,0,0,0
266 23 .ascii "Hello, world!\12\0"
281 38 sethi %hi(LC0),%o1
282 39 or %o1,%lo(LC0),%o0
293 50 .stabs "main:F1",36,0,0,_main
294 51 .stabn 192,0,0,LBB2
295 52 .stabn 224,0,0,LBE2
298 This simple ``hello world'' example demonstrates several of the stab
299 types used to describe C language source files.
301 @node Program structure
302 @chapter Encoding for the structure of the program
305 * Source file:: The path and name of the source file
312 @section The path and name of the source file
321 The first stabs in the .s file contain the name and path of the source
322 file that was compiled to produce the .s file. This information is
323 contained in two records of stab type N_SO (100).
326 .stabs "path_name", N_SO, NIL, NIL, Code_address_of_program_start
327 .stabs "file_name:", N_SO, NIL, NIL, Code_address_of_program_start
331 2 .stabs "/cygint/s1/users/jcm/play/",100,0,0,Ltext0
332 3 .stabs "hello.c",100,0,0,Ltext0
338 @section Line Numbers
347 The start of source lines is represented by the @code{N_SLINE} (68) stab
351 .stabn N_SLINE, NIL, @var{line}, @var{address}
354 @var{line} is a source line number; @var{address} represents the code
355 address for the start of that source line.
372 @item Symbol Descriptors:
373 @code{f} (local), @code{F} (global)
376 Procedures are described by the @code{N_FUN} stab type. The symbol
377 descriptor for a procedure is @samp{F} if the procedure is globally
378 scoped and @samp{f} if the procedure is static (locally scoped).
380 The @code{N_FUN} stab representing a procedure is located immediately
381 following the code of the procedure. The @code{N_FUN} stab is in turn
382 directly followed by a group of other stabs describing elements of the
383 procedure. These other stabs describe the procedure's parameters, its
384 block local variables and its block structure.
391 The @code{.stabs} entry after this code fragment shows the @var{name} of
392 the procedure (@code{main}); the type descriptor @var{desc} (@code{F},
393 for a global procedure); a reference to the predefined type @code{int}
394 for the return type; and the starting @var{address} of the procedure.
396 Here is an exploded summary (with whitespace introduced for clarity),
397 followed by line 50 of our sample assembly output, which has this form:
401 @var{desc} @r{(global proc @samp{F})}
402 @var{return_type_ref} @r{(int)}
408 50 .stabs "main:F1",36,0,0,_main
411 @node Block Structure
412 @section Block Structure
418 @code{N_LBRAC}, @code{N_RBRAC}
421 The program's block structure is represented by the @code{N_LBRAC} (left
422 brace) and the @code{N_RBRAC} (right brace) stab types. The following code
423 range, which is the body of @code{main}, is labeled with @samp{LBB2:} at the
424 beginning and @samp{LBE2:} at the end.
428 38 sethi %hi(LC0),%o1
429 39 or %o1,%lo(LC0),%o0
437 The @code{N_LBRAC} and @code{N_RBRAC} stabs that describe the block
438 scope of the procedure are located after the @code{N_FUNC} stab that
439 represents the procedure itself. The @code{N_LBRAC} uses the
440 @code{LBB2} label as the code address in its value field, and the
441 @code{N_RBRAC} uses @code{LBE2}.
444 50 .stabs "main:F1",36,0,0,_main
448 .stabn N_LBRAC, NIL, NIL, @var{left-brace-address}
449 .stabn N_RBRAC, NIL, NIL, @var{right-brace-address}
453 51 .stabn 192,0,0,LBB2
454 52 .stabn 224,0,0,LBE2
458 @chapter Simple types
461 * Basic types:: Basic type definitions
462 * Range types:: Range types defined by min and max value
463 * Float "range" types:: Range type defined by size in bytes
467 @section Basic type definitions
474 @item Symbol Descriptor:
478 The basic types for the language are described using the @code{N_LSYM} stab
479 type. They are boilerplate and are emited by the compiler for each
480 compilation unit. Basic type definitions are not always a complete
481 description of the type and are sometimes circular. The debugger
482 recognizes the type anyway, and knows how to read bits as that type.
484 Each language and compiler defines a slightly different set of basic
485 types. In this example we are looking at the basic types for C emited
486 by the GNU compiler targeting the Sun4. Here the basic types are
487 mostly defined as range types.
491 @section Range types defined by min and max value
494 @item Type Descriptor:
498 When defining a range type, if the number after the first semicolon is
499 smaller than the number after the second one, then the two numbers
500 represent the smallest and the largest values in the range.
507 @var{descriptor} @r{(type)}
514 N_LSYM, NIL, NIL, NIL
516 6 .stabs "int:t1=r1;-2147483648;2147483647;",128,0,0,0
517 7 .stabs "char:t2=r2;0;127;",128,0,0,0
520 Here the integer type (@code{1}) is defined as a range of the integer
521 type (@code{1}). Likewise @code{char} is a range of @code{char}. This
522 part of the definition is circular, but at least the high and low bound
523 values of the range hold more information about the type.
525 Here short unsigned int is defined as type number 8 and described as a
526 range of type @code{int}, with a minimum value of 0 and a maximum of 65535.
529 13 .stabs "short unsigned int:t8=r1;0;65535;",128,0,0,0
532 @node Float "range" types
533 @section Range type defined by size in bytes
536 @item Type Descriptor:
540 In a range definition, if the first number after the semicolon is
541 positive and the second is zero, then the type being defined is a
542 floating point type, and the number after the first semicolon is the
543 number of bytes needed to represent the type. Note that this does not
544 provide a way to distinguish 8-byte real floating point types from
545 8-byte complex floating point types.
556 N_LSYM, NIL, NIL, NIL
558 17 .stabs "float:t12=r1;4;0;",128,0,0,0
559 18 .stabs "double:t13=r1;8;0;",128,0,0,0
560 19 .stabs "long double:t14=r1;8;0;",128,0,0,0
563 Cosmically enough, the @code{void} type is defined directly in terms of
573 20 .stabs "void:t15=15",128,0,0,0
578 @chapter A Comprehensive Example in C
580 Now we'll examine a second program, @code{example2}, which builds on the
581 first example to introduce the rest of the stab types, symbol
582 descriptors, and type descriptors used in C.
583 @xref{Example2.c} for the complete @file{.c} source,
584 and @pxref{Example2.s} for the @file{.s} assembly code.
585 This description includes parts of those files.
587 @section Flow of control and nested scopes
593 @code{N_SLINE}, @code{N_LBRAC}, @code{N_RBRAC} (cont.)
596 Consider the body of @code{main}, from @file{example2.c}. It shows more
597 about how @code{N_SLINE}, @code{N_RBRAC}, and @code{N_LBRAC} stabs are used.
601 21 static float s_flap;
603 23 for (times=0; times < s_g_repeat; times++)@{
605 25 printf ("Hello world\n");
610 Here we have a single source line, the @samp{for} line, that generates
611 non-linear flow of control, and non-contiguous code. In this case, an
612 @code{N_SLINE} stab with the same line number proceeds each block of
613 non-contiguous code generated from the same source line.
615 The example also shows nested scopes. The @code{N_LBRAC} and
616 @code{N_LBRAC} stabs that describe block structure are nested in the
617 same order as the corresponding code blocks, those of the for loop
618 inside those for the body of main.
621 This is the label for the @code{N_LBRAC} (left brace) stab marking the
622 start of @code{main}.
629 In the first code range for C source line 23, the @code{for} loop
630 initialize and test, @code{N_SLINE} (68) records the line number:
637 58 .stabn 68,0,23,LM2
641 62 sethi %hi(_s_g_repeat),%o0
643 64 ld [%o0+%lo(_s_g_repeat)],%o0
648 @exdent label for the @code{N_LBRAC} (start block) marking the start of @code{for} loop
651 69 .stabn 68,0,25,LM3
653 71 sethi %hi(LC0),%o1
654 72 or %o1,%lo(LC0),%o0
657 75 .stabn 68,0,26,LM4
660 @exdent label for the @code{N_RBRAC} (end block) stab marking the end of the @code{for} loop
666 Now we come to the second code range for source line 23, the @code{for}
667 loop increment and return. Once again, @code{N_SLINE} (68) records the
671 .stabn, N_SLINE, NIL,
675 78 .stabn 68,0,23,LM5
683 86 .stabn 68,0,27,LM6
686 @exdent label for the @code{N_RBRAC} (end block) stab marking the end of the @code{for} loop
689 89 .stabn 68,0,27,LM7
694 94 .stabs "main:F1",36,0,0,_main
695 95 .stabs "argc:p1",160,0,0,68
696 96 .stabs "argv:p20=*21=*2",160,0,0,72
697 97 .stabs "s_flap:V12",40,0,0,_s_flap.0
698 98 .stabs "times:1",128,0,0,-20
702 Here is an illustration of stabs describing nested scopes. The scope
703 nesting is reflected in the nested bracketing stabs (@code{N_LBRAC},
707 .stabn N_LBRAC,NIL,NIL,
708 @var{block-start-address}
710 99 .stabn 192,0,0,LBB2 ## begin proc label
711 100 .stabs "inner:1",128,0,0,-24
712 101 .stabn 192,0,0,LBB3 ## begin for label
716 @code{N_RBRAC} (224), ``right brace'' ends a lexical block (scope).
719 .stabn N_RBRAC,NIL,NIL,
720 @var{block-end-address}
722 102 .stabn 224,0,0,LBE3 ## end for label
723 103 .stabn 224,0,0,LBE2 ## end proc label
730 * Automatic variables:: locally scoped
732 * Register variables::
733 * Initialized statics::
734 * Un-initialized statics::
738 @node Automatic variables
739 @section Locally scoped automatic variables
746 @item Symbol Descriptor:
751 In addition to describing types, the @code{N_LSYM} stab type also
752 describes locally scoped automatic variables. Refer again to the body
753 of @code{main} in @file{example2.c}. It allocates two automatic
754 variables: @samp{times} is scoped to the body of @code{main}, and
755 @samp{inner} is scoped to the body of the @code{for} loop.
756 @samp{s_flap} is locally scoped but not automatic, and will be discussed
761 21 static float s_flap;
763 23 for (times=0; times < s_g_repeat; times++)@{
765 25 printf ("Hello world\n");
770 The @code{N_LSYM} stab for an automatic variable is located just before the
771 @code{N_LBRAC} stab describing the open brace of the block to which it is
775 @exdent @code{N_LSYM} (128): automatic variable, scoped locally to @code{main}
780 @var{frame-pointer-offset}
782 98 .stabs "times:1",128,0,0,-20
783 99 .stabn 192,0,0,LBB2 ## begin `main' N_LBRAC
785 @exdent @code{N_LSYM} (128): automatic variable, scoped locally to the @code{for} loop
790 @var{frame-pointer-offset}
792 100 .stabs "inner:1",128,0,0,-24
793 101 .stabn 192,0,0,LBB3 ## begin `for' loop N_LBRAC
796 Since the character in the string field following the colon is not a
797 letter, there is no symbol descriptor. This means that the stab
798 describes a local variable, and that the number after the colon is a
799 type reference. In this case it a a reference to the basic type @code{int}.
800 Notice also that the frame pointer offset is negative number for
804 @node Global Variables
805 @section Global Variables
812 @item Symbol Descriptor:
816 Global variables are represented by the @code{N_GSYM} stab type. The symbol
817 descriptor, following the colon in the string field, is @samp{G}. Following
818 the @samp{G} is a type reference or type definition. In this example it is a
819 type reference to the basic C type, @code{char}. The first source line in
827 yields the following stab. The stab immediately precedes the code that
828 allocates storage for the variable it describes.
831 @exdent @code{N_GSYM} (32): global symbol
836 N_GSYM, NIL, NIL, NIL
838 21 .stabs "g_foo:G2",32,0,0,0
845 The address of the variable represented by the @code{N_GSYM} is not contained
846 in the @code{N_GSYM} stab. The debugger gets this information from the
847 external symbol for the global variable.
849 @node Register variables
850 @section Global register variables
857 @item Symbol Descriptor:
861 The following source line defines a global variable, @code{g_bar}, which is
862 explicitly allocated in global register @code{%g5}.
865 2 register int g_bar asm ("%g5");
868 Register variables have their own stab type, @code{N_RSYM}, and their own
869 symbol descriptor, @code{r}. The stab's value field contains the number of
870 the register where the variable data will be stored. Since the
871 variable was not initialized in this compilation unit, the stab is
872 emited at the end of the object file, with the stabs for other
873 uninitialized globals (@code{bcc}).
876 @exdent @code{N_RSYM} (64): register variable
884 133 .stabs "g_bar:r1",64,0,0,5
888 @node Initialized statics
889 @section Initialized static variables
896 @item Symbol Descriptors:
897 @code{S} (file scope), @code{V} (procedure scope)
900 Initialized static variables are represented by the @code{N_STSYM} stab
901 type. The symbol descriptor part of the string field shows if the
902 variable is file scope static (@samp{S}) or procedure scope static
903 (@samp{V}). The source line
906 3 static int s_g_repeat = 2;
910 yields the following code. The stab is located immediately preceding
911 the storage for the variable it represents. Since the variable in
912 this example is file scope static the symbol descriptor is @samp{S}.
915 @exdent @code{N_STSYM} (38): initialized static variable (data seg w/internal linkage)
923 26 .stabs "s_g_repeat:S1",38,0,0,_s_g_repeat
930 @node Un-initialized statics
931 @section Un-initialized static variables
938 @item Symbol Descriptors:
939 @code{S} (file scope), @code{V} (procedure scope)
942 Un-initialized static variables are represented by the @code{N_LCSYM}
943 stab type. The symbol descriptor part of the string shows if the
944 variable is file scope static (@samp{S}) or procedure scope static
945 (@samp{V}). In this example it is procedure scope static. The source
946 line allocating @code{s_flap} immediately follows the open brace for the
947 procedure @code{main}.
951 21 static float s_flap;
954 The code that reserves storage for the variable @code{s_flap} precedes the
955 body of body of @code{main}.
958 39 .reserve _s_flap.0,4,"bss",4
961 But since @code{s_flap} is scoped locally to @code{main}, its stab is
962 located with the other stabs representing symbols local to @code{main}.
963 The stab for @code{s_flap} is located just before the @code{N_LBRAC} for
967 @exdent @code{N_LCSYM} (40): uninitialized static var (BSS seg w/internal linkage)
975 97 .stabs "s_flap:V12",40,0,0,_s_flap.0
976 98 .stabs "times:1",128,0,0,-20
977 99 .stabn 192,0,0,LBB2 # N_LBRAC for main.
980 @c ............................................................
990 @item Symbol Descriptor:
994 Procedure parameters are represented by the N_PSYM stab type. The
995 following source lines show the parameters of the main routine.
1004 The N_PSYM stabs describing parameters to a function directly follow
1005 the N_FUN stab that represents the procedure itself. The N_FUN stab
1006 immediately follows the code of the procedure it describes. Following
1007 the N_PSYM parameter stabs are any N_LSYM stabs representing local
1011 @exdent <36> N_FUN - describing the procedure main
1013 94 .stabs "main:F1",36,0,0,_main
1015 @exdent <160> N_PSYM - parameters
1016 @exdent .stabs "name:sym_desc(value_param)type_ref(int)", N_PSYM,
1017 @exdent NIL, NIL, frame_ptr_offset
1019 95 .stabs "argc:p1",160,0,0,68
1021 @exdent <160> N_PSYM - parameter
1022 @exdent .stabs "name:sym_desc(value_param)type_def(20)=ptr_to type_def(21)=
1023 @exdent ptr_to type_ref(char)
1025 96 .stabs "argv:p20=*21=*2",160,0,0,72
1028 The type definition of argv is interesting because it defines two new
1029 types in terms of an existing one. The array argv contains character
1030 pointers. The type of the array name is a pointer to the type the
1031 array holds. Thus the type of argv is ptr to ptr to char. The stab
1032 for argv contains nested type_definitions. Type 21 is ptr to type 2
1033 (char) and argv (type 20) is ptr to type 21.
1035 @node Aggregate Types
1036 @chapter Aggregate Types
1038 Now let's look at some variable definitions involving complex types.
1039 This involves understanding better how types are described. In the
1040 examples so far types have been described as references to previously
1041 defined types or defined in terms of subranges of or pointers to
1042 previously defined types. The section that follows will talk about
1043 the various other type descriptors that may follow the = sign in a
1056 @section Array types
1062 @code{N_GSYM}, @code{N_LSYM}
1063 @item Symbol Descriptor:
1065 @item Type Descriptor:
1069 As an example of an array type consider the global variable below.
1072 15 char char_vec[3] = @{'a','b','c'@};
1075 Since the array is a global variable, it is described by the N_GSYM
1076 stab type. The symbol descriptor G, following the colon in stab's
1077 string field, also says the array is a global variable. Following the
1078 G is a definition for type (19) as shown by the equals sign after the
1081 After the equals sign is a type descriptor, ar, which says that the
1082 type being defined is an array. Following the type descriptor for an
1083 array is the type of the index, the lower bound for array indexing
1084 (always 0 in C), the upper bound for array indexing (in C: one less
1085 than the length of the array), and the type of the array elements.
1087 The array definition above generates the assembly language that
1091 @exdent <32> N_GSYM - global variable
1092 @exdent .stabs "name:sym_desc(global)type_def(19)=type_desc(array)
1093 @exdent index_type_ref(int);NIL;high_bound(2);element_type_ref(char)";
1094 @exdent N_GSYM, NIL, NIL, NIL
1096 32 .stabs "char_vec:G19=ar1;0;2;2",32,0,0,0
1097 33 .global _char_vec
1106 @section Enumerations
1113 @item Symbol Descriptor:
1115 @item Type Descriptor:
1119 The source line below declares an enumeration type. It is defined at
1120 file scope between the bodies of main and s_proc in example2.c.
1121 Because the N_LSYM is located after the N_RBRAC that marks the end of
1122 the previous procedure's block scope, and before the N_FUN that marks
1123 the beginning of the next procedure's block scope, the N_LSYM does not
1124 describe a block local symbol, but a file local one. The source line:
1127 29 enum e_places @{first,second=3,last@};
1131 generates the following stab, located just after the N_RBRAC (close
1132 brace stab) for main. The type definition is in an N_LSYM stab
1133 because type definitions are file scope not global scope.
1136 <128> N_LSYM - local symbol
1137 .stab "name:sym_dec(type)type_def(22)=sym_desc(enum)
1138 enum_name:value(0),enum_name:value(3),enum_name:value(4),;",
1139 N_LSYM, NIL, NIL, NIL
1143 104 .stabs "e_places:T22=efirst:0,second:3,last:4,;",128,0,0,0
1146 The symbol descriptor (T) says that the stab describes a structure,
1147 enumeration, or type tag. The type descriptor e, following the 22= of
1148 the type definition narrows it down to an enumeration type. Following
1149 the e is a list of the elements of the enumeration. The format is
1150 name:value,. The list of elements ends with a ;.
1152 @node Structure tags
1153 @section Structure Tags
1160 @item Symbol Descriptor:
1162 @item Type Descriptor:
1166 The following source code declares a structure tag and defines an
1167 instance of the structure in global scope. Then a typedef equates the
1168 structure tag with a new type. A seperate stab is generated for the
1169 structure tag, the structure typedef, and the structure instance. The
1170 stabs for the tag and the typedef are emited when the definitions are
1171 encountered. Since the structure elements are not initialized, the
1172 stab and code for the structure variable itself is located at the end
1173 of the program in .common.
1179 9 char s_char_vec[8];
1180 10 struct s_tag* s_next;
1183 13 typedef struct s_tag s_typedef;
1186 The structure tag is an N_LSYM stab type because, like the enum, the
1187 symbol is file scope. Like the enum, the symbol descriptor is T, for
1188 enumeration, struct or tag type. The symbol descriptor s following
1189 the 16= of the type definition narrows the symbol type to struct.
1191 Following the struct symbol descriptor is the number of bytes the
1192 struct occupies, followed by a description of each structure element.
1193 The structure element descriptions are of the form name:type, bit
1194 offset from the start of the struct, and number of bits in the
1199 <128> N_LSYM - type definition
1200 .stabs "name:sym_desc(struct tag) Type_def(16)=type_desc(struct type)
1202 elem_name:type_ref(int),bit_offset,field_bits;
1203 elem_name:type_ref(float),bit_offset,field_bits;
1204 elem_name:type_def(17)=type_desc(dynamic array) index_type(int);NIL;
1205 high_bound(7);element_type(char),bit_offset,field_bits;;",
1208 30 .stabs "s_tag:T16=s20s_int:1,0,32;s_float:12,32,32;
1209 s_char_vec:17=ar1;0;7;2,64,64;s_next:18=*16,128,32;;",128,0,0,0
1212 In this example, two of the structure elements are previously defined
1213 types. For these, the type following the name: part of the element
1214 description is a simple type reference. The other two structure
1215 elements are new types. In this case there is a type definition
1216 embedded after the name:. The type definition for the array element
1217 looks just like a type definition for a standalone array. The s_next
1218 field is a pointer to the same kind of structure that the field is an
1219 element of. So the definition of structure type 16 contains an type
1220 definition for an element which is a pointer to type 16.
1230 @item Symbol Descriptor:
1234 Here is the stab for the typedef equating the structure tag with a
1238 <128> N_LSYM - type definition
1239 .stabs "name:sym_desc(type name)type_ref(struct_tag)",N_LSYM,NIL,NIL,NIL
1243 31 .stabs "s_typedef:t16",128,0,0,0
1246 And here is the code generated for the structure variable.
1249 <32> N_GSYM - global symbol
1250 .stabs "name:sym_desc(global)type_ref(struct_tag)",N_GSYM,NIL,NIL,NIL
1254 136 .stabs "g_an_s:G16",32,0,0,0
1255 137 .common _g_an_s,20,"bss"
1258 Notice that the structure tag has the same type number as the typedef
1259 for the structure tag. It is impossible to distinguish between a
1260 variable of the struct type and one of its typedef by looking at the
1261 debugging information.
1272 @item Symbol Descriptor:
1274 @item Type Descriptor:
1278 Next let's look at unions. In example2 this union type is declared
1279 locally to a procedure and an instance of the union is defined.
1289 This code generates a stab for the union tag and a stab for the union
1290 variable. Both use the N_LSYM stab type. Since the union variable is
1291 scoped locally to the procedure in which it is defined, its stab is
1292 located immediately preceding the N_LBRAC for the procedure's block
1295 The stab for the union tag, however is located preceding the code for
1296 the procedure in which it is defined. The stab type is N_LSYM. This
1297 would seem to imply that the union type is file scope, like the struct
1298 type s_tag. This is not true. The contents and position of the stab
1299 for u_type do not convey any infomation about its procedure local
1304 .stabs "name:sym_desc(union tag)type_def(22)=type_desc(union)
1306 elem_name:type_ref(int),bit_offset(0),bit_size(32);
1307 elem_name:type_ref(float),bit_offset(0),bit_size(32);
1308 elem_name:type_ref(ptr to char),bit_offset(0),bit_size(32);;"
1309 N_LSYM, NIL, NIL, NIL
1313 105 .stabs "u_tag:T23=u4u_int:1,0,32;u_float:12,0,32;u_char:21,0,32;;",
1317 The symbol descriptor, T, following the name: means that the stab
1318 describes an enumeration struct or type tag. The type descriptor u,
1319 following the 23= of the type definition, narrows it down to a union
1320 type definition. Following the u is the number of bytes in the union.
1321 After that is a list of union element descriptions. Their format is
1322 name:type, bit offset into the union, and number of bytes for the
1325 The stab for the union variable follows. Notice that the frame
1326 pointer offset for local variables is negative.
1329 <128> N_LSYM - local variable (with no symbol descriptor)
1330 .stabs "name:type_ref(u_tag)", N_LSYM, NIL, NIL, frame_ptr_offset
1334 130 .stabs "an_u:23",128,0,0,-20
1337 @node Function types
1338 @section Function types
1344 The last type descriptor in C which remains to be described is used
1345 for function types. Consider the following source line defining a
1346 global function pointer.
1352 It generates the following code. Since the variable is not
1353 initialized, the code is located in the common area at the end of the
1357 <32> N_GSYM - global variable
1358 .stabs "name:sym_desc(global)type_def(24)=ptr_to(25)=
1359 type_def(func)type_ref(int)
1363 134 .stabs "g_pf:G24=*25=f1",32,0,0,0
1364 135 .common _g_pf,4,"bss"
1367 Since the variable is global, the stab type is N_GSYM and the symbol
1368 descriptor is G. The variable defines a new type, 24, which is a
1369 pointer to another new type, 25, which is defined as a function
1373 @chapter Symbol information in symbol tables
1375 This section examines more closely the format of symbol table entries
1376 and how stab assembler directives map to them. It also describes what
1377 transformations the assembler and linker make on data from stabs.
1379 Each time the assembler encounters a stab in its input file it puts
1380 each field of the stab into corresponding fields in a symbol table
1381 entry of its output file. If the stab contains a string field, the
1382 symbol table entry for that stab points to a string table entry
1383 containing the string data from the stab. Assembler labels become
1384 relocatable addresses. Symbol table entries in a.out have the format:
1387 struct internal_nlist @{
1388 unsigned long n_strx; /* index into string table of name */
1389 unsigned char n_type; /* type of symbol */
1390 unsigned char n_other; /* misc info (usually empty) */
1391 unsigned short n_desc; /* description field */
1392 bfd_vma n_value; /* value of symbol */
1396 For .stabs directives, the n_strx field holds the character offset
1397 from the start of the string table to the string table entry
1398 containing the "string" field. For other classes of stabs (.stabn and
1399 .stabd) this field is null.
1401 Symbol table entries with n_type fields containing a value greater or
1402 equal to 0x20 originated as stabs generated by the compiler (with one
1403 random exception). Those with n_type values less than 0x20 were
1404 placed in the symbol table of the executable by the assembler or the
1407 The linker concatenates object files and does fixups of externally
1408 defined symbols. You can see the transformations made on stab data by
1409 the assembler and linker by examining the symbol table after each pass
1410 of the build, first the assemble and then the link.
1412 To do this use nm with the -ap options. This dumps the symbol table,
1413 including debugging information, unsorted. For stab entries the
1414 columns are: value, other, desc, type, string. For assembler and
1415 linker symbols, the columns are: value, type, string.
1417 There are a few important things to notice about symbol tables. Where
1418 the value field of a stab contains a frame pointer offset, or a
1419 register number, that value is unchanged by the rest of the build.
1421 Where the value field of a stab contains an assembly language label,
1422 it is transformed by each build step. The assembler turns it into a
1423 relocatable address and the linker turns it into an absolute address.
1424 This source line defines a static variable at file scope:
1427 3 static int s_g_repeat
1431 The following stab describes the symbol.
1434 26 .stabs "s_g_repeat:S1",38,0,0,_s_g_repeat
1438 The assembler transforms the stab into this symbol table entry in the
1439 @file{.o} file. The location is expressed as a data segment offset.
1442 21 00000084 - 00 0000 STSYM s_g_repeat:S1
1446 in the symbol table entry from the executable, the linker has made the
1447 relocatable address absolute.
1450 22 0000e00c - 00 0000 STSYM s_g_repeat:S1
1453 Stabs for global variables do not contain location information. In
1454 this case the debugger finds location information in the assembler or
1455 linker symbol table entry describing the variable. The source line:
1465 21 .stabs "g_foo:G2",32,0,0,0
1468 The variable is represented by the following two symbol table entries
1469 in the object file. The first one originated as a stab. The second
1470 one is an external symbol. The upper case D signifies that the n_type
1471 field of the symbol table contains 7, N_DATA with local linkage (see
1472 Table B). The value field following the file's line number is empty
1473 for the stab entry. For the linker symbol it contains the
1474 rellocatable address corresponding to the variable.
1477 19 00000000 - 00 0000 GSYM g_foo:G2
1478 20 00000080 D _g_foo
1482 These entries as transformed by the linker. The linker symbol table
1483 entry now holds an absolute address.
1486 21 00000000 - 00 0000 GSYM g_foo:G2
1488 215 0000e008 D _g_foo
1491 @node GNU Cplusplus stabs
1492 @chapter GNU C++ stabs
1495 * Basic Cplusplus types::
1498 * Methods:: Method definition
1500 * Method Modifiers:: (const, volatile, const volatile)
1503 * Virtual Base Classes::
1508 @subsection Symbol descriptors added for C++ descriptions:
1511 P - register parameter.
1514 @subsection type descriptors added for C++ descriptions
1518 method type (two ## if minimal debug)
1525 @node Basic Cplusplus types
1526 @section Basic types for C++
1528 << the examples that follow are based on a01.C >>
1531 C++ adds two more builtin types to the set defined for C. These are
1532 the unknown type and the vtable record type. The unknown type, type
1533 16, is defined in terms of itself like the void type.
1535 The vtable record type, type 17, is defined as a structure type and
1536 then as a structure tag. The structure has four fields, delta, index,
1537 pfn, and delta2. pfn is the function pointer.
1539 << In boilerplate $vtbl_ptr_type, what are the fields delta,
1540 index, and delta2 used for? >>
1542 This basic type is present in all C++ programs even if there are no
1543 virtual methods defined.
1546 .stabs "struct_name:sym_desc(type)type_def(17)=type_desc(struct)struct_bytes(8)
1547 elem_name(delta):type_ref(short int),bit_offset(0),field_bits(16);
1548 elem_name(index):type_ref(short int),bit_offset(16),field_bits(16);
1549 elem_name(pfn):type_def(18)=type_desc(ptr to)type_ref(void),
1550 bit_offset(32),field_bits(32);
1551 elem_name(delta2):type_def(short int);bit_offset(32),field_bits(16);;"
1556 .stabs "$vtbl_ptr_type:t17=s8
1557 delta:6,0,16;index:6,16,16;pfn:18=*15,32,32;delta2:6,32,16;;"
1562 .stabs "name:sym_dec(struct tag)type_ref($vtbl_ptr_type)",N_LSYM,NIL,NIL,NIL
1566 .stabs "$vtbl_ptr_type:T17",128,0,0,0
1569 @node Simple classes
1570 @section Simple class definition
1572 The stabs describing C++ language features are an extension of the
1573 stabs describing C. Stabs representing C++ class types elaborate
1574 extensively on the stab format used to describe structure types in C.
1575 Stabs representing class type variables look just like stabs
1576 representing C language variables.
1578 Consider the following very simple class definition.
1584 int Ameth(int in, char other);
1588 The class baseA is represented by two stabs. The first stab describes
1589 the class as a structure type. The second stab describes a structure
1590 tag of the class type. Both stabs are of stab type N_LSYM. Since the
1591 stab is not located between an N_FUN and a N_LBRAC stab this indicates
1592 that the class is defined at file scope. If it were, then the N_LSYM
1593 would signify a local variable.
1595 A stab describing a C++ class type is similar in format to a stab
1596 describing a C struct, with each class member shown as a field in the
1597 structure. The part of the struct format describing fields is
1598 expanded to include extra information relevent to C++ class members.
1599 In addition, if the class has multiple base classes or virtual
1600 functions the struct format outside of the field parts is also
1603 In this simple example the field part of the C++ class stab
1604 representing member data looks just like the field part of a C struct
1605 stab. The section on protections describes how its format is
1606 sometimes extended for member data.
1608 The field part of a C++ class stab representing a member function
1609 differs substantially from the field part of a C struct stab. It
1610 still begins with `name:' but then goes on to define a new type number
1611 for the member function, describe its return type, its argument types,
1612 its protection level, any qualifiers applied to the method definition,
1613 and whether the method is virtual or not. If the method is virtual
1614 then the method description goes on to give the vtable index of the
1615 method, and the type number of the first base class defining the
1618 When the field name is a method name it is followed by two colons
1619 rather than one. This is followed by a new type definition for the
1620 method. This is a number followed by an equal sign and then the
1621 symbol descriptor `##', indicating a method type. This is followed by
1622 a type reference showing the return type of the method and a
1625 The format of an overloaded operator method name differs from that
1626 of other methods. It is "op$::XXXX." where XXXX is the operator name
1627 such as + or +=. The name ends with a period, and any characters except
1628 the period can occur in the XXXX string.
1630 The next part of the method description represents the arguments to
1631 the method, preceeded by a colon and ending with a semi-colon. The
1632 types of the arguments are expressed in the same way argument types
1633 are expressed in C++ name mangling. In this example an int and a char
1636 This is followed by a number, a letter, and an asterisk or period,
1637 followed by another semicolon. The number indicates the protections
1638 that apply to the member function. Here the 2 means public. The
1639 letter encodes any qualifier applied to the method definition. In
1640 this case A means that it is a normal function definition. The dot
1641 shows that the method is not virtual. The sections that follow
1642 elaborate further on these fields and describe the additional
1643 information present for virtual methods.
1647 .stabs "class_name:sym_desc(type)type_def(20)=type_desc(struct)struct_bytes(4)
1648 field_name(Adat):type(int),bit_offset(0),field_bits(32);
1650 method_name(Ameth)::type_def(21)=type_desc(method)return_type(int);
1651 :arg_types(int char);
1652 protection(public)qualifier(normal)virtual(no);;"
1657 .stabs "baseA:t20=s4Adat:1,0,32;Ameth::21=##1;:ic;2A.;;",128,0,0,0
1659 .stabs "class_name:sym_desc(struct tag)",N_LSYM,NIL,NIL,NIL
1661 .stabs "baseA:T20",128,0,0,0
1664 @node Class instance
1665 @section Class instance
1667 As shown above, describing even a simple C++ class definition is
1668 accomplished by massively extending the stab format used in C to
1669 describe structure types. However, once the class is defined, C stabs
1670 with no modifications can be used to describe class instances. The
1680 yields the following stab describing the class instance. It looks no
1681 different from a standard C stab describing a local variable.
1684 .stabs "name:type_ref(baseA)", N_LSYM, NIL, NIL, frame_ptr_offset
1688 .stabs "AbaseA:20",128,0,0,-20
1692 @section Method defintion
1694 The class definition shown above declares Ameth. The C++ source below
1699 baseA::Ameth(int in, char other)
1706 This method definition yields three stabs following the code of the
1707 method. One stab describes the method itself and following two
1708 describe its parameters. Although there is only one formal argument
1709 all methods have an implicit argument which is the `this' pointer.
1710 The `this' pointer is a pointer to the object on which the method was
1711 called. Note that the method name is mangled to encode the class name
1712 and argument types. << Name mangling is not described by this
1713 document - Is there already such a doc? >>
1716 .stabs "name:symbol_desriptor(global function)return_type(int)",
1717 N_FUN, NIL, NIL, code_addr_of_method_start
1719 .stabs "Ameth__5baseAic:F1",36,0,0,_Ameth__5baseAic
1722 Here is the stab for the `this' pointer implicit argument. The name
1723 of the `this' pointer is always `this.' Type 19, the `this' pointer is
1724 defined as a pointer to type 20, baseA, but a stab defining baseA has
1725 not yet been emited. Since the compiler knows it will be emited
1726 shortly, here it just outputs a cross reference to the undefined
1727 symbol, by prefixing the symbol name with xs.
1730 .stabs "name:sym_desc(register param)type_def(19)=
1731 type_desc(ptr to)type_ref(baseA)=
1732 type_desc(cross-reference to)baseA:",N_RSYM,NIL,NIL,register_number
1734 .stabs "this:P19=*20=xsbaseA:",64,0,0,8
1737 The stab for the explicit integer argument looks just like a parameter
1738 to a C function. The last field of the stab is the offset from the
1739 argument pointer, which in most systems is the same as the frame
1743 .stabs "name:sym_desc(value parameter)type_ref(int)",
1744 N_PSYM,NIL,NIL,offset_from_arg_ptr
1746 .stabs "in:p1",160,0,0,72
1749 << The examples that follow are based on A1.C >>
1752 @section Protections
1755 In the simple class definition shown above all member data and
1756 functions were publicly accessable. The example that follows
1757 contrasts public, protected and privately accessable fields and shows
1758 how these protections are encoded in C++ stabs.
1760 Protections for class member data are signified by two characters
1761 embeded in the stab defining the class type. These characters are
1762 located after the name: part of the string. /0 means private, /1
1763 means protected, and /2 means public. If these characters are omited
1764 this means that the member is public. The following C++ source:
1778 generates the following stab to describe the class type all_data.
1781 .stabs "class_name:sym_desc(type)type_def(19)=type_desc(struct)struct_bytes
1782 data_name:/protection(private)type_ref(int),bit_offset,num_bits;
1783 data_name:/protection(protected)type_ref(char),bit_offset,num_bits;
1784 data_name:(/num omited, private)type_ref(float),bit_offset,num_bits;;"
1789 .stabs "all_data:t19=s12
1790 priv_dat:/01,0,32;prot_dat:/12,32,8;pub_dat:12,64,32;;",128,0,0,0
1793 Protections for member functions are signified by one digit embeded in
1794 the field part of the stab describing the method. The digit is 0 if
1795 private, 1 if protected and 2 if public. Consider the C++ class
1799 class all_methods @{
1801 int priv_meth(int in)@{return in;@};
1803 char protMeth(char in)@{return in;@};
1805 float pubMeth(float in)@{return in;@};
1809 It generates the following stab. The digit in question is to the left
1810 of an `A' in each case. Notice also that in this case two symbol
1811 descriptors apply to the class name struct tag and struct type.
1814 .stabs "class_name:sym_desc(struct tag&type)type_def(21)=
1815 sym_desc(struct)struct_bytes(1)
1816 meth_name::type_def(22)=sym_desc(method)returning(int);
1817 :args(int);protection(private)modifier(normal)virtual(no);
1818 meth_name::type_def(23)=sym_desc(method)returning(char);
1819 :args(char);protection(protected)modifier(normal)virual(no);
1820 meth_name::type_def(24)=sym_desc(method)returning(float);
1821 :args(float);protection(public)modifier(normal)virtual(no);;",
1826 .stabs "all_methods:Tt21=s1priv_meth::22=##1;:i;0A.;protMeth::23=##2;:c;1A.;
1827 pubMeth::24=##12;:f;2A.;;",128,0,0,0
1830 @node Method Modifiers
1831 @section Method Modifiers (const, volatile, const volatile)
1835 In the class example described above all the methods have the normal
1836 modifier. This method modifier information is located just after the
1837 protection information for the method. This field has four possible
1838 character values. Normal methods use A, const methods use B, volatile
1839 methods use C, and const volatile methods use D. Consider the class
1845 int ConstMeth (int arg) const @{ return arg; @};
1846 char VolatileMeth (char arg) volatile @{ return arg; @};
1847 float ConstVolMeth (float arg) const volatile @{return arg; @};
1851 This class is described by the following stab:
1854 .stabs "class(A):sym_desc(struct)type_def(20)=type_desc(struct)struct_bytes(1)
1855 meth_name(ConstMeth)::type_def(21)sym_desc(method)
1856 returning(int);:arg(int);protection(public)modifier(const)virtual(no);
1857 meth_name(VolatileMeth)::type_def(22)=sym_desc(method)
1858 returning(char);:arg(char);protection(public)modifier(volatile)virt(no)
1859 meth_name(ConstVolMeth)::type_def(23)=sym_desc(method)
1860 returning(float);:arg(float);protection(public)modifer(const volatile)
1861 virtual(no);;", @dots{}
1865 .stabs "A:T20=s1ConstMeth::21=##1;:i;2B.;VolatileMeth::22=##2;:c;2C.;
1866 ConstVolMeth::23=##12;:f;2D.;;",128,0,0,0
1869 @node Virtual Methods
1870 @section Virtual Methods
1872 << The following examples are based on a4.C >>
1874 The presence of virtual methods in a class definition adds additional
1875 data to the class description. The extra data is appended to the
1876 description of the virtual method and to the end of the class
1877 description. Consider the class definition below:
1883 virtual int A_virt (int arg) @{ return arg; @};
1887 This results in the stab below describing class A. It defines a new
1888 type (20) which is an 8 byte structure. The first field of the class
1889 struct is Adat, an integer, starting at structure offset 0 and
1892 The second field in the class struct is not explicitly defined by the
1893 C++ class definition but is implied by the fact that the class
1894 contains a virtual method. This field is the vtable pointer. The
1895 name of the vtable pointer field starts with $vf and continues with a
1896 type reference to the class it is part of. In this example the type
1897 reference for class A is 20 so the name of its vtable pointer field is
1898 $vf20, followed by the usual colon.
1900 Next there is a type definition for the vtable pointer type (21).
1901 This is in turn defined as a pointer to another new type (22).
1903 Type 22 is the vtable itself, which is defined as an array, indexed by
1904 integers, with a high bound of 1, and elements of type 17. Type 17
1905 was the vtable record type defined by the boilerplate C++ type
1906 definitions, as shown earlier.
1908 The bit offset of the vtable pointer field is 32. The number of bits
1909 in the field are not specified when the field is a vtable pointer.
1911 Next is the method definition for the virtual member function A_virt.
1912 Its description starts out using the same format as the non-virtual
1913 member functions described above, except instead of a dot after the
1914 `A' there is an asterisk, indicating that the function is virtual.
1915 Since is is virtual some addition information is appended to the end
1916 of the method description.
1918 The first number represents the vtable index of the method. This is a
1919 32 bit unsigned number with the high bit set, followed by a
1922 The second number is a type reference to the first base class in the
1923 inheritence hierarchy defining the virtual member function. In this
1924 case the class stab describes a base class so the virtual function is
1925 not overriding any other definition of the method. Therefore the
1926 reference is to the type number of the class that the stab is
1929 This is followed by three semi-colons. One marks the end of the
1930 current sub-section, one marks the end of the method field, and the
1931 third marks the end of the struct definition.
1933 For classes containing virtual functions the very last section of the
1934 string part of the stab holds a type reference to the first base
1935 class. This is preceeded by `~%' and followed by a final semi-colon.
1938 .stabs "class_name(A):type_def(20)=sym_desc(struct)struct_bytes(8)
1939 field_name(Adat):type_ref(int),bit_offset(0),field_bits(32);
1940 field_name(A virt func ptr):type_def(21)=type_desc(ptr to)type_def(22)=
1941 sym_desc(array)index_type_ref(int);NIL;elem_type_ref(vtbl elem type);
1943 meth_name(A_virt)::typedef(23)=sym_desc(method)returning(int);
1944 :arg_type(int),protection(public)normal(yes)virtual(yes)
1945 vtable_index(1);class_first_defining(A);;;~%first_base(A);",
1950 .stabs "A:t20=s8Adat:1,0,32;$vf20:21=*22=ar1;0;1;17,32;A_virt::23=##1;:i;2A*-2147483647;20;;;~%20;",128,0,0,0
1954 @section Inheritence
1956 Stabs describing C++ derived classes include additional sections that
1957 describe the inheritence hierarchy of the class. A derived class stab
1958 also encodes the number of base classes. For each base class it tells
1959 if the base class is virtual or not, and if the inheritence is private
1960 or public. It also gives the offset into the object of the portion of
1961 the object corresponding to each base class.
1963 This additional information is embeded in the class stab following the
1964 number of bytes in the struct. First the number of base classes
1965 appears bracketed by an exclamation point and a comma.
1967 Then for each base type there repeats a series: two digits, a number,
1968 a comma, another number, and a semi-colon.
1970 The first of the two digits is 1 if the base class is virtual and 0 if
1971 not. The second digit is 2 if the derivation is public and 0 if not.
1973 The number following the first two digits is the offset from the start
1974 of the object to the part of the object pertaining to the base class.
1976 After the comma, the second number is a type_descriptor for the base
1977 type. Finally a semi-colon ends the series, which repeats for each
1980 The source below defines three base classes A, B, and C and the
1988 virtual int A_virt (int arg) @{ return arg; @};
1994 virtual int B_virt (int arg) @{return arg; @};
2000 virtual int C_virt (int arg) @{return arg; @};
2003 class D : A, virtual B, public C @{
2006 virtual int A_virt (int arg ) @{ return arg+1; @};
2007 virtual int B_virt (int arg) @{ return arg+2; @};
2008 virtual int C_virt (int arg) @{ return arg+3; @};
2009 virtual int D_virt (int arg) @{ return arg; @};
2013 Class stabs similar to the ones described earlier are generated for
2016 @c FIXME!!! the linebreaks in the following example probably make the
2017 @c examples literally unusable, but I don't know any other way to get
2018 @c them on the page.
2020 .stabs "A:T20=s8Adat:1,0,32;$vf20:21=*22=ar1;0;1;17,32;
2021 A_virt::23=##1;:i;2A*-2147483647;20;;;~%20;",128,0,0,0
2023 .stabs "B:Tt25=s8Bdat:1,0,32;$vf25:21,32;B_virt::26=##1;
2024 :i;2A*-2147483647;25;;;~%25;",128,0,0,0
2026 .stabs "C:Tt28=s8Cdat:1,0,32;$vf28:21,32;C_virt::29=##1;
2027 :i;2A*-2147483647;28;;;~%28;",128,0,0,0
2030 In the stab describing derived class D below, the information about
2031 the derivation of this class is encoded as follows.
2034 .stabs "derived_class_name:symbol_descriptors(struct tag&type)=
2035 type_descriptor(struct)struct_bytes(32)!num_bases(3),
2036 base_virtual(no)inheritence_public(no)base_offset(0),
2037 base_class_type_ref(A);
2038 base_virtual(yes)inheritence_public(no)base_offset(NIL),
2039 base_class_type_ref(B);
2040 base_virtual(no)inheritence_public(yes)base_offset(64),
2041 base_class_type_ref(C); @dots{}
2044 @c FIXME! fake linebreaks.
2046 .stabs "D:Tt31=s32!3,000,20;100,25;0264,28;$vb25:24,128;Ddat:
2047 1,160,32;A_virt::32=##1;:i;2A*-2147483647;20;;B_virt:
2048 :32:i;2A*-2147483647;25;;C_virt::32:i;2A*-2147483647;
2049 28;;D_virt::32:i;2A*-2147483646;31;;;~%20;",128,0,0,0
2052 @node Virtual Base Classes
2053 @section Virtual Base Classes
2055 A derived class object consists of a concatination in memory of the
2056 data areas defined by each base class, starting with the leftmost and
2057 ending with the rightmost in the list of base classes. The exception
2058 to this rule is for virtual inheritence. In the example above, class
2059 D inherits virtually from base class B. This means that an instance
2060 of a D object will not contain it's own B part but merely a pointer to
2061 a B part, known as a virtual base pointer.
2063 In a derived class stab, the base offset part of the derivation
2064 information, described above, shows how the base class parts are
2065 ordered. The base offset for a virtual base class is always given as
2066 0. Notice that the base offset for B is given as 0 even though B is
2067 not the first base class. The first base class A starts at offset 0.
2069 The field information part of the stab for class D describes the field
2070 which is the pointer to the virtual base class B. The vbase pointer
2071 name is $vb followed by a type reference to the virtual base class.
2072 Since the type id for B in this example is 25, the vbase pointer name
2075 @c FIXME!! fake linebreaks below
2077 .stabs "D:Tt31=s32!3,000,20;100,25;0264,28;$vb25:24,128;Ddat:1,
2078 160,32;A_virt::32=##1;:i;2A*-2147483647;20;;B_virt::32:i;
2079 2A*-2147483647;25;;C_virt::32:i;2A*-2147483647;28;;D_virt:
2080 :32:i;2A*-2147483646;31;;;~%20;",128,0,0,0
2083 Following the name and a semicolon is a type reference describing the
2084 type of the virtual base class pointer, in this case 24. Type 24 was
2085 defined earlier as the type of the B class `this` pointer. The
2086 `this' pointer for a class is a pointer to the class type.
2089 .stabs "this:P24=*25=xsB:",64,0,0,8
2092 Finally the field offset part of the vbase pointer field description
2093 shows that the vbase pointer is the first field in the D object,
2094 before any data fields defined by the class. The layout of a D class
2095 object is a follows, Adat at 0, the vtable pointer for A at 32, Cdat
2096 at 64, the vtable pointer for C at 96, the virtual ase pointer for B
2097 at 128, and Ddat at 160.
2100 @node Static Members
2101 @section Static Members
2103 The data area for a class is a concatenation of the space used by the
2104 data members of the class. If the class has virtual methods, a vtable
2105 pointer follows the class data. The field offset part of each field
2106 description in the class stab shows this ordering.
2108 << How is this reflected in stabs? See Cygnus bug #677 for some info. >>
2111 @appendix Example2.c - source code for extended example
2115 2 register int g_bar asm ("%g5");
2116 3 static int s_g_repeat = 2;
2122 9 char s_char_vec[8];
2123 10 struct s_tag* s_next;
2126 13 typedef struct s_tag s_typedef;
2128 15 char char_vec[3] = @{'a','b','c'@};
2130 17 main (argc, argv)
2134 21 static float s_flap;
2136 23 for (times=0; times < s_g_repeat; times++)@{
2138 25 printf ("Hello world\n");
2142 29 enum e_places @{first,second=3,last@};
2144 31 static s_proc (s_arg, s_ptr_arg, char_vec)
2146 33 s_typedef* s_ptr_arg;
2160 @appendix Example2.s - assembly code for extended example
2164 2 .stabs "/cygint/s1/users/jcm/play/",100,0,0,Ltext0
2165 3 .stabs "example2.c",100,0,0,Ltext0
2168 6 .stabs "int:t1=r1;-2147483648;2147483647;",128,0,0,0
2169 7 .stabs "char:t2=r2;0;127;",128,0,0,0
2170 8 .stabs "long int:t3=r1;-2147483648;2147483647;",128,0,0,0
2171 9 .stabs "unsigned int:t4=r1;0;-1;",128,0,0,0
2172 10 .stabs "long unsigned int:t5=r1;0;-1;",128,0,0,0
2173 11 .stabs "short int:t6=r1;-32768;32767;",128,0,0,0
2174 12 .stabs "long long int:t7=r1;0;-1;",128,0,0,0
2175 13 .stabs "short unsigned int:t8=r1;0;65535;",128,0,0,0
2176 14 .stabs "long long unsigned int:t9=r1;0;-1;",128,0,0,0
2177 15 .stabs "signed char:t10=r1;-128;127;",128,0,0,0
2178 16 .stabs "unsigned char:t11=r1;0;255;",128,0,0,0
2179 17 .stabs "float:t12=r1;4;0;",128,0,0,0
2180 18 .stabs "double:t13=r1;8;0;",128,0,0,0
2181 19 .stabs "long double:t14=r1;8;0;",128,0,0,0
2182 20 .stabs "void:t15=15",128,0,0,0
2183 21 .stabs "g_foo:G2",32,0,0,0
2188 26 .stabs "s_g_repeat:S1",38,0,0,_s_g_repeat
2192 @c FIXME! fake linebreak in line 30
2193 30 .stabs "s_tag:T16=s20s_int:1,0,32;s_float:12,32,32;s_char_vec:
2194 17=ar1;0;7;2,64,64;s_next:18=*16,128,32;;",128,0,0,0
2195 31 .stabs "s_typedef:t16",128,0,0,0
2196 32 .stabs "char_vec:G19=ar1;0;2;2",32,0,0,0
2197 33 .global _char_vec
2203 39 .reserve _s_flap.0,4,"bss",4
2207 43 .ascii "Hello world\12\0"
2212 48 .stabn 68,0,20,LM1
2215 51 save %sp,-144,%sp
2222 58 .stabn 68,0,23,LM2
2226 62 sethi %hi(_s_g_repeat),%o0
2228 64 ld [%o0+%lo(_s_g_repeat)],%o0
2233 69 .stabn 68,0,25,LM3
2235 71 sethi %hi(LC0),%o1
2236 72 or %o1,%lo(LC0),%o0
2239 75 .stabn 68,0,26,LM4
2242 78 .stabn 68,0,23,LM5
2250 86 .stabn 68,0,27,LM6
2253 89 .stabn 68,0,27,LM7
2258 94 .stabs "main:F1",36,0,0,_main
2259 95 .stabs "argc:p1",160,0,0,68
2260 96 .stabs "argv:p20=*21=*2",160,0,0,72
2261 97 .stabs "s_flap:V12",40,0,0,_s_flap.0
2262 98 .stabs "times:1",128,0,0,-20
2263 99 .stabn 192,0,0,LBB2
2264 100 .stabs "inner:1",128,0,0,-24
2265 101 .stabn 192,0,0,LBB3
2266 102 .stabn 224,0,0,LBE3
2267 103 .stabn 224,0,0,LBE2
2268 104 .stabs "e_places:T22=efirst:0,second:3,last:4,;",128,0,0,0
2269 @c FIXME: fake linebreak in line 105
2270 105 .stabs "u_tag:T23=u4u_int:1,0,32;u_float:12,0,32;u_char:21,0,32;;",
2275 109 .stabn 68,0,35,LM8
2278 112 save %sp,-120,%sp
2284 118 .stabn 68,0,41,LM9
2287 121 .stabn 68,0,41,LM10
2292 126 .stabs "s_proc:f1",36,0,0,_s_proc
2293 127 .stabs "s_arg:p16",160,0,0,0
2294 128 .stabs "s_ptr_arg:p18",160,0,0,72
2295 129 .stabs "char_vec:p21",160,0,0,76
2296 130 .stabs "an_u:23",128,0,0,-20
2297 131 .stabn 192,0,0,LBB4
2298 132 .stabn 224,0,0,LBE4
2299 133 .stabs "g_bar:r1",64,0,0,5
2300 134 .stabs "g_pf:G24=*25=f1",32,0,0,0
2301 135 .common _g_pf,4,"bss"
2302 136 .stabs "g_an_s:G16",32,0,0,0
2303 137 .common _g_an_s,20,"bss"
2307 @node Quick reference
2308 @appendix Quick reference
2311 * Stab types:: Table A: Symbol types from stabs
2312 * Assembler types:: Table B: Symbol types from assembler and linker
2313 * Symbol descriptors:: Table C
2314 * Type Descriptors:: Table D
2318 @section Table A: Symbol types from stabs
2320 Table A lists stab types sorted by type number. Stab type numbers are
2321 32 and greater. This is the full list of stab numbers, including stab
2322 types that are used in languages other than C.
2324 The #define names for these stab types are defined in:
2325 devo/include/aout/stab.def
2328 type type #define used to describe
2329 dec hex name source program feature
2330 ------------------------------------------------
2331 32 0x20 N_GYSM global symbol
2332 34 0X22 N_FNAME function name (for BSD Fortran)
2333 36 0x24 N_FUN function name or text segment variable for C
2334 38 0x26 N_STSYM static symbol (data segment w/internal linkage)
2335 40 0x28 N_LCSYM .lcomm symbol(BSS-seg variable w/internal linkage)
2336 42 0x2a N_MAIN Name of main routine (not used in C)
2337 48 0x30 N_PC global symbol (for Pascal)
2338 50 0x32 N_NSYMS number of symbols (according to Ultrix V4.0)
2339 52 0x34 N_NOMAP no DST map for sym (according to Ultrix V4.0)
2340 64 0x40 N_RSYM register variable
2341 66 0x42 N_M2C Modula-2 compilation unit
2342 68 0x44 N_SLINE line number in text segment
2343 70 0x46 N_DSLINE line number in data segment
2345 72 0x48 N_BSLINE line number in bss segment
2346 72 0x48 N_BROWS Sun source code browser, path to .cb file
2348 74 0x4a N_DEFD GNU Modula2 definition module dependency
2350 80 0x50 N_EHDECL GNU C++ exception variable
2351 80 0x50 N_MOD2 Modula2 info "for imc" (according to Ultrix V4.0)
2353 84 0x54 N_CATCH GNU C++ "catch" clause
2354 96 0x60 N_SSYM structure of union element
2355 100 0x64 N_SO path and name of source file
2356 128 0x80 N_LSYM automatic var in the stack
2357 (also used for type desc.)
2358 130 0x82 N_BINCL beginning of an include file (Sun only)
2359 132 0x84 N_SOL Name of sub-source (#include) file.
2360 160 0xa0 N_PSYM parameter variable
2361 162 0xa2 N_EINCL end of an include file
2362 164 0xa4 N_ENTRY alternate entry point
2363 192 0xc0 N_LBRAC beginning of a lexical block
2364 194 0xc2 N_EXCL place holder for a deleted include file
2365 196 0xc4 N_SCOPE modula2 scope information (Sun linker)
2366 224 0xe0 N_RBRAC end of a lexical block
2367 226 0xe2 N_BCOMM begin named common block
2368 228 0xe4 N_ECOMM end named common block
2369 232 0xe8 N_ECOML end common (local name)
2371 << used on Gould systems for non-base registers syms >>
2372 240 0xf0 N_NBTEXT ??
2373 242 0xf2 N_NBDATA ??
2379 @node Assembler types
2380 @section Table B: Symbol types from assembler and linker
2382 Table B shows the types of symbol table entries that hold assembler
2385 The #define names for these n_types values are defined in
2386 /include/aout/aout64.h
2390 n_type n_type name used to describe
2391 ------------------------------------------
2392 1 0x0 N_UNDF undefined symbol
2393 2 0x2 N_ABS absolute symbol -- defined at a particular address
2394 3 0x3 extern " (vs. file scope)
2395 4 0x4 N_TEXT text symbol -- defined at offset in text segment
2396 5 0x5 extern " (vs. file scope)
2397 6 0x6 N_DATA data symbol -- defined at offset in data segment
2398 7 0x7 extern " (vs. file scope)
2399 8 0x8 N_BSS BSS symbol -- defined at offset in zero'd segment
2400 9 extern " (vs. file scope)
2402 12 0x0C N_FN_SEQ func name for Sequent compilers (stab exception)
2404 49 0x12 N_COMM common sym -- visable after shared lib dynamic link
2405 31 0x1f N_FN file name of a .o file
2408 @node Symbol descriptors
2409 @section Table C: Symbol descriptors
2413 -------------------------------------------------
2414 (empty) local variable
2420 S static global variable
2422 T enumeration, struct or type tag
2423 V static local variable
2426 @node Type Descriptors
2427 @section Table D: Type Descriptors
2431 -------------------------------------
2432 (empty) type reference
2438 u union specifications
2443 @node Expanded reference
2444 @appendix Expanded reference by stab type.
2448 The first line is the symbol type expressed in decimal, hexadecimal,
2449 and as a #define (see devo/include/aout/stab.def).
2451 The second line describes the language constructs the symbol type
2454 The third line is the stab format with the significant stab fields
2455 named and the rest NIL.
2457 Subsequent lines expand upon the meaning and possible values for each
2458 significant stab field. # stands in for the type descriptor.
2460 Finally, any further information.
2463 * N_GSYM:: Global variable
2464 * N_FNAME:: Function name (BSD Fortran)
2465 * N_FUN:: C Function name or text segment variable
2466 * N_STSYM:: Initialized static symbol
2467 * N_LCSYM:: Uninitialized static symbol
2468 * N_MAIN:: Name of main routine (not for C)
2469 * N_PC:: Pascal global symbol
2470 * N_NSYMS:: Number of symbols
2471 * N_NOMAP:: No DST map
2472 * N_RSYM:: Register variable
2473 * N_M2C:: Modula-2 compilation unit
2474 * N_SLINE:: Line number in text segment
2475 * N_DSLINE:: Line number in data segment
2476 * N_BSLINE:: Line number in bss segment
2477 * N_BROWS:: Path to .cb file for Sun source code browser
2478 * N_DEFD:: GNU Modula2 definition module dependency
2479 * N_EHDECL:: GNU C++ exception variable
2480 * N_MOD2:: Modula2 information "for imc"
2481 * N_CATCH:: GNU C++ "catch" clause
2482 * N_SSYM:: Structure or union element
2483 * N_SO:: Source file containing main
2484 * N_LSYM:: Automatic variable
2485 * N_BINCL:: Beginning of include file (Sun only)
2486 * N_SOL:: Name of include file
2487 * N_PSYM:: Parameter variable
2488 * N_EINCL:: End of include file
2489 * N_ENTRY:: Alternate entry point
2490 * N_LBRAC:: Beginning of lexical block
2491 * N_EXCL:: Deleted include file
2492 * N_SCOPE:: Modula2 scope information (Sun only)
2493 * N_RBRAC:: End of lexical block
2494 * N_BCOMM:: Begin named common block
2495 * N_ECOMM:: End named common block
2496 * N_ECOML:: End common
2497 * Gould:: non-base register symbols used on Gould systems
2498 * N_LENG:: Length of preceding entry
2502 @section 32 - 0x20 - N_GYSM
2507 .stabs "name", N_GSYM, NIL, NIL, NIL
2511 "name" -> "symbol_name:#type"
2515 Only the "name" field is significant. the location of the variable is
2516 obtained from the corresponding external symbol.
2519 @section 34 - 0x22 - N_FNAME
2520 Function name (for BSD Fortran)
2523 .stabs "name", N_FNAME, NIL, NIL, NIL
2527 "name" -> "function_name"
2530 Only the "name" field is significant. The location of the symbol is
2531 obtained from the corresponding extern symbol.
2534 @section 36 - 0x24 - N_FUN
2535 Function name or text segment variable for C.
2538 .stabs "name", N_FUN, NIL, desc, value
2542 @exdent @emph{For functions:}
2543 "name" -> "proc_name:#return_type"
2544 # -> F (global function)
2546 desc -> line num for proc start. (GCC doesn't set and DBX doesn't miss it.)
2547 value -> Code address of proc start.
2549 @exdent @emph{For text segment variables:}
2550 <<How to create one?>>
2554 @section 38 - 0x26 - N_STSYM
2555 Initialized static symbol (data segment w/internal linkage).
2558 .stabs "name", N_STSYM, NIL, NIL, value
2562 "name" -> "symbol_name#type"
2563 # -> S (scope global to compilation unit)
2564 -> V (scope local to a procedure)
2565 value -> Data Address
2569 @section 40 - 0x28 - N_LCSYM
2570 Unitialized static (.lcomm) symbol(BSS segment w/internal linkage).
2573 .stabs "name", N_LCLSYM, NIL, NIL, value
2577 "name" -> "symbol_name#type"
2578 # -> S (scope global to compilation unit)
2579 -> V (scope local to procedure)
2580 value -> BSS Address
2584 @section 42 - 0x2a - N_MAIN
2585 Name of main routine (not used in C)
2588 .stabs "name", N_MAIN, NIL, NIL, NIL
2592 "name" -> "name_of_main_routine"
2596 @section 48 - 0x30 - N_PC
2597 Global symbol (for Pascal)
2600 .stabs "name", N_PC, NIL, NIL, value
2604 "name" -> "symbol_name" <<?>>
2605 value -> supposedly the line number (stab.def is skeptical)
2611 global pascal symbol: name,,0,subtype,line
2616 @section 50 - 0x32 - N_NSYMS
2617 Number of symbols (according to Ultrix V4.0)
2620 0, files,,funcs,lines (stab.def)
2624 @section 52 - 0x34 - N_NOMAP
2625 no DST map for sym (according to Ultrix V4.0)
2628 name, ,0,type,ignored (stab.def)
2632 @section 64 - 0x40 - N_RSYM
2636 .stabs "name:type",N_RSYM,0,RegSize,RegNumber (Sun doc)
2640 @section 66 - 0x42 - N_M2C
2641 Modula-2 compilation unit
2644 .stabs "name", N_M2C, 0, desc, value
2648 "name" -> "unit_name,unit_time_stamp[,code_time_stamp]
2650 value -> 0 (main unit)
2655 @section 68 - 0x44 - N_SLINE
2656 Line number in text segment
2659 .stabn N_SLINE, 0, desc, value
2664 value -> code_address (relocatable addr where the corresponding code starts)
2667 For single source lines that generate discontiguous code, such as flow
2668 of control statements, there may be more than one N_SLINE stab for the
2669 same source line. In this case there is a stab at the start of each
2670 code range, each with the same line number.
2673 @section 70 - 0x46 - N_DSLINE
2674 Line number in data segment
2677 .stabn N_DSLINE, 0, desc, value
2682 value -> data_address (relocatable addr where the corresponding code
2686 See comment for N_SLINE above.
2689 @section 72 - 0x48 - N_BSLINE
2690 Line number in bss segment
2693 .stabn N_BSLINE, 0, desc, value
2698 value -> bss_address (relocatable addr where the corresponding code
2702 See comment for N_SLINE above.
2705 @section 72 - 0x48 - N_BROWS
2706 Sun source code browser, path to .cb file
2709 "path to associated .cb file"
2711 Note: type field value overlaps with N_BSLINE
2714 @section 74 - 0x4a - N_DEFD
2715 GNU Modula2 definition module dependency
2717 GNU Modula-2 definition module dependency. Value is the modification
2718 time of the definition file. Other is non-zero if it is imported with
2719 the GNU M2 keyword %INITIALIZE. Perhaps N_M2C can be used if there
2720 are enough empty fields?
2723 @section 80 - 0x50 - N_EHDECL
2724 GNU C++ exception variable <<?>>
2726 "name is variable name"
2728 Note: conflicts with N_MOD2.
2731 @section 80 - 0x50 - N_MOD2
2732 Modula2 info "for imc" (according to Ultrix V4.0)
2734 Note: conflicts with N_EHDECL <<?>>
2737 @section 84 - 0x54 - N_CATCH
2738 GNU C++ "catch" clause
2740 GNU C++ `catch' clause. Value is its address. Desc is nonzero if
2741 this entry is immediately followed by a CAUGHT stab saying what
2742 exception was caught. Multiple CAUGHT stabs means that multiple
2743 exceptions can be caught here. If Desc is 0, it means all exceptions
2747 @section 96 - 0x60 - N_SSYM
2748 Structure or union element
2750 Value is offset in the structure.
2752 <<?looking at structs and unions in C I didn't see these>>
2755 @section 100 - 0x64 - N_SO
2756 Path and name of source file containing main routine
2759 .stabs "name", N_SO, NIL, NIL, value
2763 "name" -> /path/to/source/file
2764 -> source_file_terminal_name
2766 value -> the starting text address of the compilation.
2769 These are found two in a row. The name field of the first N_SO
2770 contains the path to the source file. The name field of the second
2771 N_SO contains the terminal name of the source file itself.
2774 @section 128 - 0x80 - N_LSYM
2775 Automatic var in the stack (also used for type descriptors.)
2778 .stabs "name" N_LSYM, NIL, NIL, value
2782 @exdent @emph{For stack based local variables:}
2784 "name" -> name of the variable
2785 value -> offset from frame pointer (negative)
2787 @exdent @emph{For type descriptors:}
2789 "name" -> "name_of_the_type:#type"
2792 type -> type_ref (or) type_def
2794 type_ref -> type_number
2795 type_def -> type_number=type_desc etc.
2798 Type may be either a type reference or a type definition. A type
2799 reference is a number that refers to a previously defined type. A
2800 type definition is the number that will refer to this type, followed
2801 by an equals sign, a type descriptor and the additional data that
2802 defines the type. See the Table D for type descriptors and the
2803 section on types for what data follows each type descriptor.
2806 @section 130 - 0x82 - N_BINCL
2808 Beginning of an include file (Sun only)
2810 Beginning of an include file. Only Sun uses this. In an object file,
2811 only the name is significant. The Sun linker puts data into some of
2815 @section 132 - 0x84 - N_SOL
2817 Name of a sub-source file (#include file). Value is starting address
2822 @section 160 - 0xa0 - N_PSYM
2827 stabs. "name", N_PSYM, NIL, NIL, value
2831 "name" -> "param_name:#type"
2832 # -> p (value parameter)
2833 -> i (value parameter by reference, indirect access)
2834 -> v (variable parameter by reference)
2835 -> C ( read-only parameter, conformant array bound)
2836 -> x (confomant array value parameter)
2839 -> X (function result variable)
2840 -> b (based variable)
2842 value -> offset from the argument pointer (positive).
2845 On most machines the argument pointer is the same as the frame
2849 @section 162 - 0xa2 - N_EINCL
2851 End of an include file. This and N_BINCL act as brackets around the
2852 file's output. In an ojbect file, there is no significant data in
2853 this entry. The Sun linker puts data into some of the fields.
2857 @section 164 - 0xa4 - N_ENTRY
2859 Alternate entry point.
2860 Value is its address.
2864 @section 192 - 0xc0 - N_LBRAC
2866 Beginning of a lexical block (left brace). The variable defined
2867 inside the block precede the N_LBRAC symbol. Or can they follow as
2868 well as long as a new N_FUNC was not encountered. <<?>>
2871 .stabn N_LBRAC, NIL, NIL, value
2875 value -> code address of block start.
2879 @section 194 - 0xc2 - N_EXCL
2881 Place holder for a deleted include file. Replaces a N_BINCL and
2882 everything up to the corresponding N_EINCL. The Sun linker generates
2883 these when it finds multiple indentical copies of the symbols from an
2884 included file. This appears only in output from the Sun linker.
2888 @section 196 - 0xc4 - N_SCOPE
2890 Modula2 scope information (Sun linker)
2894 @section 224 - 0xe0 - N_RBRAC
2896 End of a lexical block (right brace)
2899 .stabn N_RBRAC, NIL, NIL, value
2903 value -> code address of the end of the block.
2907 @section 226 - 0xe2 - N_BCOMM
2909 Begin named common block.
2911 Only the name is significant.
2915 @section 228 - 0xe4 - N_ECOMM
2917 End named common block.
2919 Only the name is significant and it should match the N_BCOMM
2923 @section 232 - 0xe8 - N_ECOML
2925 End common (local name)
2931 @section Non-base registers on Gould systems
2932 << used on Gould systems for non-base registers syms, values assigned
2933 at random, need real info from Gould. >>
2937 240 0xf0 N_NBTEXT ??
2938 242 0xf2 N_NBDATA ??
2945 @section - 0xfe - N_LENG
2947 Second symbol entry containing a length-value for the preceding entry.
2948 The value is the length.
2951 @appendix Questions and anomalies
2955 For GNU C stabs defining local and global variables (N_LSYM and
2956 N_GSYM), the desc field is supposed to contain the source line number
2957 on which the variable is defined. In reality the desc field is always
2958 0. (This behavour is defined in dbxout.c and putting a line number in
2959 desc is controlled by #ifdef WINNING_GDB which defaults to false). Gdb
2960 supposedly uses this information if you say 'list var'. In reality
2961 var can be a variable defined in the program and gdb says `function
2965 In GNU C stabs there seems to be no way to differentiate tag types:
2966 structures, unions, and enums (symbol descriptor T) and typedefs
2967 (symbol descriptor t) defined at file scope from types defined locally
2968 to a procedure or other more local scope. They all use the N_LSYM
2969 stab type. Types defined at procedure scope are emited after the
2970 N_RBRAC of the preceding function and before the code of the
2971 procedure in which they are defined. This is exactly the same as
2972 types defined in the source file between the two procedure bodies.
2973 GDB overcompensates by placing all types in block #1 the block for
2974 symbols of file scope. This is true for default, -ansi and
2975 -traditional compiler options. (p0001063-gcc, p0001066-gdb)
2978 What ends the procedure scope? Is it the proc block's N_RBRAC or the
2979 next N_FUN? (I believe its the first.)
2982 The comment in xcoff.h says DBX_STATIC_CONST_VAR_CODE is used for
2983 static const variables. DBX_STATIC_CONST_VAR_CODE is set to N_FUN by
2984 default, in dbxout.c. If included, xcoff.h redefines it to N_STSYM.
2985 But testing the default behaviour, my Sun4 native example shows
2986 N_STSYM not N_FUN is used to describe file static initialized
2987 variables. (the code tests for TREE_READONLY(decl) &&
2988 !TREE_THIS_VOLATILE(decl) and if true uses DBX_STATIC_CONST_VAR_CODE).
2991 Global variable stabs don't have location information. This comes
2992 from the external symbol for the same variable. The external symbol
2993 has a leading underbar on the _name of the variable and the stab does
2994 not. How do we know these two symbol table entries are talking about
2995 the same symbol when their names are different?
2998 Can gcc be configured to output stabs the way the Sun compiler
2999 does, so that their native debugging tools work? <NO?> It doesn't by
3000 default. GDB reads either format of stab. (gcc or SunC). How about
3004 @node xcoff-differences
3005 @appendix Differences between GNU stabs in a.out and GNU stabs in xcoff
3007 (The AIX/RS6000 native object file format is xcoff with stabs)
3011 Instead of .stabs, xcoff uses .stabx.
3014 The data fields of an xcoff .stabx are in a different order than an
3015 a.out .stabs. The order is: string, value, type. The desc and null
3016 fields present in a.out stabs are missing in xcoff stabs. For N_GSYM
3017 the value field is the name of the symbol.
3020 BSD a.out stab types correspond to AIX xcoff storage classes. In general the
3021 mapping is N_STABTYPE becomes C_STABTYPE. Some stab types in a.out
3022 are not supported in xcoff. See Table E. for full mappings.
3025 initialised static N_STSYM and un-initialized static N_LCSYM both map
3026 to the C_STSYM storage class. But the destinction is preserved
3027 because in xcoff N_STSYM and N_LCSYM must be emited in a named static
3028 block. Begin the block with .bs s[RW] data_section_name for N_STSYM
3029 or .bs s bss_section_name for N_LCSYM. End the block with .es
3032 xcoff stabs describing tags and typedefs use the N_DECL (0x8c)instead
3033 of N_LSYM stab type.
3036 xcoff uses N_RPSYM (0x8e) instead of the N_RSYM stab type for register
3037 variables. If the register variable is also a value parameter, then
3038 use R instead of P for the symbol descriptor.
3041 xcoff uses negative numbers as type references to the basic types.
3042 There are no boilerplate type definitions emited for these basic
3043 types. << make table of basic types and type numbers for C >>
3046 xcoff .stabx sometimes don't have the name part of the string field.
3049 xcoff uses a .file stab type to represent the source file name. There
3050 is no stab for the path to the source file.
3053 xcoff uses a .line stab type to represent source lines. The format
3054 is: .line line_number.
3057 xcoff emits line numbers relative to the start of the current
3058 function. The start of a function is marked by .bf. If a function
3059 includes lines from a seperate file, then those line numbers are
3060 absolute line numbers in the <<sub-?>> file being compiled.
3063 The start of current include file is marked with: .bi "filename" and
3064 the end marked with .ei "filename"
3067 If the xcoff stab is a N_FUN (C_FUN) then follow the string field with
3068 ,. instead of just ,
3071 The symbol descriptor for register parameters is P for a.out and R for
3076 (I think that's it for .s file differences. They could stand to be
3077 better presented. This is just a list of what I have noticed so far.
3078 There are a *lot* of differences in the information in the symbol
3079 tables of the executable and object files.)
3081 Table E: mapping a.out stab types to xcoff storage classes
3084 stab type storage class
3085 -------------------------------
3094 N_RPSYM (0x8e) C_RPSYM
3104 N_DECL (0x8c) C_DECL
3121 @node Sun-differences
3122 @appendix Differences between GNU stabs and Sun native stabs.
3126 GNU C stabs define *all* types, file or procedure scope, as
3127 N_LSYM. Sun doc talks about using N_GSYM too.
3130 GNU C stabs use `ar' as type descriptor when defining arrays vs. just
3134 Stabs describing block scopes, N_LBRAC and N_RBRAC are supposed to
3135 contain the nesting level of the block in the desc field, re Sun doc.
3136 GNU stabs always have 0 in that field.
3139 Sun C stabs use type number pairs in the format (a,b) where a is a
3140 number starting with 1 and incremented for each sub-source file in the
3141 compilation. b is a number starting with 1 and incremented for each
3142 new type defined in the compilation. GNU C stabs use the type number
3143 alone, with no source file number.