Fri Jan 8 16:19:26 1993 Ian Lance Taylor (ian@tweedledumb.cygnus.com)
[external/binutils.git] / include / coff / internal.h
1 /* Internal format of COFF object file data structures, for GNU BFD.
2    This file is part of BFD, the Binary File Descriptor library.  */
3
4 /* First, make "signed char" work, even on old compilers. */
5 #ifndef signed
6 #ifndef __STDC__
7 #define signed                  /**/
8 #endif
9 #endif
10
11 /********************** FILE HEADER **********************/
12 struct internal_filehdr
13 {
14   unsigned short f_magic;       /* magic number                 */
15   unsigned short f_nscns;       /* number of sections           */
16   long f_timdat;                /* time & date stamp            */
17   long f_symptr;                /* file pointer to symtab       */
18   long f_nsyms;                 /* number of symtab entries     */
19   unsigned short f_opthdr;      /* sizeof(optional hdr)         */
20   unsigned short f_flags;       /* flags                        */
21 };
22
23 /* Bits for f_flags:
24  *      F_RELFLG        relocation info stripped from file
25  *      F_EXEC          file is executable (no unresolved external references)
26  *      F_LNNO          line numbers stripped from file
27  *      F_LSYMS         local symbols stripped from file
28  *      F_AR16WR        file is 16-bit little-endian
29  *      F_AR32WR        file is 32-bit little-endian
30  *      F_AR32W         file is 32-bit big-endian
31  *      F_DYNLOAD       rs/6000 aix: dynamically loadable w/imports & exports
32  *      F_SHROBJ        rs/6000 aix: file is a shared object
33  */
34
35 #define F_RELFLG        (0x0001)
36 #define F_EXEC          (0x0002)
37 #define F_LNNO          (0x0004)
38 #define F_LSYMS         (0x0008)
39 #define F_AR16WR        (0x0080)
40 #define F_AR32WR        (0x0100)
41 #define F_AR32W         (0x0200)
42 #define F_DYNLOAD       (0x1000)
43 #define F_SHROBJ        (0x2000)
44
45 /********************** AOUT "OPTIONAL HEADER" **********************/
46 struct internal_aouthdr
47 {
48   short magic;                  /* type of file                         */
49   short vstamp;                 /* version stamp                        */
50   unsigned long tsize;          /* text size in bytes, padded to FW bdry*/
51   unsigned long dsize;          /* initialized data "  "                */
52   unsigned long bsize;          /* uninitialized data "   "             */
53   unsigned long entry;          /* entry pt.                            */
54   unsigned long text_start;     /* base of text used for this file */
55   unsigned long data_start;     /* base of data used for this file */
56
57   /* i960 stuff */
58   unsigned long tagentries;     /* number of tag entries to follow */
59
60   /* RS/6000 stuff */
61   unsigned long o_toc;          /* address of TOC                       */
62   short o_snentry;              /* section number for entry point */
63   short o_sntext;               /* section number for text      */
64   short o_sndata;               /* section number for data      */
65   short o_sntoc;                /* section number for toc       */
66   short o_snloader;             /* section number for loader section */
67   short o_snbss;                /* section number for bss       */
68   short o_algntext;             /* max alignment for text       */
69   short o_algndata;             /* max alignment for data       */
70   short o_modtype;              /* Module type field, 1R,RE,RO  */
71   unsigned long o_maxstack;     /* max stack size allowed.      */
72 };
73
74 /********************** STORAGE CLASSES **********************/
75
76 #define C_EFCN          -1      /* physical end of function     */
77 #define C_NULL          0
78 #define C_AUTO          1       /* automatic variable           */
79 #define C_EXT           2       /* external symbol              */
80 #define C_STAT          3       /* static                       */
81 #define C_REG           4       /* register variable            */
82 #define C_EXTDEF        5       /* external definition          */
83 #define C_LABEL         6       /* label                        */
84 #define C_ULABEL        7       /* undefined label              */
85 #define C_MOS           8       /* member of structure          */
86 #define C_ARG           9       /* function argument            */
87 #define C_STRTAG        10      /* structure tag                */
88 #define C_MOU           11      /* member of union              */
89 #define C_UNTAG         12      /* union tag                    */
90 #define C_TPDEF         13      /* type definition              */
91 #define C_USTATIC       14      /* undefined static             */
92 #define C_ENTAG         15      /* enumeration tag              */
93 #define C_MOE           16      /* member of enumeration        */
94 #define C_REGPARM       17      /* register parameter           */
95 #define C_FIELD         18      /* bit field                    */
96 #define C_AUTOARG       19      /* auto argument                */
97 #define C_LASTENT       20      /* dummy entry (end of block)   */
98 #define C_BLOCK         100     /* ".bb" or ".eb"               */
99 #define C_FCN           101     /* ".bf" or ".ef"               */
100 #define C_EOS           102     /* end of structure             */
101 #define C_FILE          103     /* file name                    */
102 #define C_LINE          104     /* line # reformatted as symbol table entry */
103 #define C_ALIAS         105     /* duplicate tag                */
104 #define C_HIDDEN        106     /* ext symbol in dmert public lib */
105
106  /* New storage classes for 80960 */
107
108 /* C_LEAFPROC is obsolete.  Use C_LEAFEXT or C_LEAFSTAT */
109 #define C_LEAFPROC      108     /* Leaf procedure, "call" via BAL */
110
111 #define C_SCALL         107     /* Procedure reachable via system call */
112 #define C_LEAFEXT       108     /* External leaf */
113 #define C_LEAFSTAT      113     /* Static leaf */
114 #define C_OPTVAR        109     /* Optimized variable           */
115 #define C_DEFINE        110     /* Preprocessor #define         */
116 #define C_PRAGMA        111     /* Advice to compiler or linker */
117 #define C_SEGMENT       112     /* 80960 segment name           */
118
119  /* New storage classes for RS/6000 */
120 #define C_HIDEXT        107     /* Un-named external symbol */
121 #define C_BINCL         108     /* Marks beginning of include file */
122 #define C_EINCL         109     /* Marks ending of include file */
123
124  /* storage classes for stab symbols for RS/6000 */
125 #define C_GSYM          ((signed char)0x80)
126 #define C_LSYM          ((signed char)0x81)
127 #define C_PSYM          ((signed char)0x82)
128 #define C_RSYM          ((signed char)0x83)
129 #define C_RPSYM         ((signed char)0x84)
130 #define C_STSYM         ((signed char)0x85)
131 #define C_TCSYM         ((signed char)0x86)
132 #define C_BCOMM         ((signed char)0x87)
133 #define C_ECOML         ((signed char)0x88)
134 #define C_ECOMM         ((signed char)0x89)
135 #define C_DECL          ((signed char)0x8c)
136 #define C_ENTRY         ((signed char)0x8d)
137 #define C_FUN           ((signed char)0x8e)
138 #define C_BSTAT         ((signed char)0x8f)
139 #define C_ESTAT         ((signed char)0x90)
140
141 /********************** SECTION HEADER **********************/
142 struct internal_scnhdr
143 {
144   char s_name[8];               /* section name                 */
145   long s_paddr;                 /* physical address, aliased s_nlib */
146   long s_vaddr;                 /* virtual address              */
147   long s_size;                  /* section size                 */
148   long s_scnptr;                /* file ptr to raw data for section */
149   long s_relptr;                /* file ptr to relocation       */
150   long s_lnnoptr;               /* file ptr to line numbers     */
151   unsigned long s_nreloc;       /* number of relocation entries */
152   unsigned long s_nlnno;        /* number of line number entries*/
153   long s_flags;                 /* flags                        */
154   long s_align;                 /* used on I960                 */
155 };
156
157 /*
158  * s_flags "type"
159  */
160 #define STYP_REG         (0x0000)       /* "regular": allocated, relocated, loaded */
161 #define STYP_DSECT       (0x0001)       /* "dummy":  relocated only*/
162 #define STYP_NOLOAD      (0x0002)       /* "noload": allocated, relocated, not loaded */
163 #define STYP_GROUP       (0x0004)       /* "grouped": formed of input sections */
164 #define STYP_PAD         (0x0008)       /* "padding": not allocated, not relocated, loaded */
165 #define STYP_COPY        (0x0010)       /* "copy": for decision function used by field update;  not allocated, not relocated,
166                                                                              loaded; reloc & lineno entries processed normally */
167 #define STYP_TEXT        (0x0020)       /* section contains text only */
168 #define S_SHRSEG         (0x0020)       /* In 3b Update files (output of ogen), sections which appear in SHARED segments of the Pfile
169                                                                              will have the S_SHRSEG flag set by ogen, to inform dufr that updating 1 copy of the proc. will
170                                                                              update all process invocations. */
171 #define STYP_DATA        (0x0040)       /* section contains data only */
172 #define STYP_BSS         (0x0080)       /* section contains bss only */
173 #define S_NEWFCN         (0x0100)       /* In a minimal file or an update file, a new function (as compared with a replaced function) */
174 #define STYP_INFO        (0x0200)       /* comment: not allocated not relocated, not loaded */
175 #define STYP_OVER        (0x0400)       /* overlay: relocated not allocated or loaded */
176 #define STYP_LIB         (0x0800)       /* for .lib: same as INFO */
177 #define STYP_MERGE       (0x2000)       /* merge section -- combines with text, data or bss sections only */
178 #define STYP_REVERSE_PAD (0x4000)       /* section will be padded with no-op instructions wherever padding is necessary and there is a
179                                         
180                                                                              word of contiguous bytes
181                                                                              beginning on a word boundary. */
182
183 #define STYP_LIT        0x8020  /* Literal data (like STYP_TEXT) */
184 /********************** LINE NUMBERS **********************/
185
186 /* 1 line number entry for every "breakpointable" source line in a section.
187  * Line numbers are grouped on a per function basis; first entry in a function
188  * grouping will have l_lnno = 0 and in place of physical address will be the
189  * symbol table index of the function name.
190  */
191
192 struct internal_lineno
193 {
194   union
195   {
196     long l_symndx;              /* function name symbol index, iff l_lnno == 0*/
197     long l_paddr;               /* (physical) address of line number    */
198   }     l_addr;
199   unsigned long l_lnno;         /* line number          */
200 };
201
202 /********************** SYMBOLS **********************/
203
204 #define SYMNMLEN        8       /* # characters in a symbol name        */
205 #define FILNMLEN        14      /* # characters in a file name          */
206 #define DIMNUM          4       /* # array dimensions in auxiliary entry */
207
208 struct internal_syment
209 {
210   union
211   {
212     char _n_name[SYMNMLEN];     /* old COFF version     */
213     struct
214     {
215       long _n_zeroes;           /* new == 0             */
216       long _n_offset;           /* offset into string table */
217     }      _n_n;
218     char *_n_nptr[2];           /* allows for overlaying        */
219   }     _n;
220   long n_value;                 /* value of symbol              */
221   short n_scnum;                /* section number               */
222   unsigned short n_flags;       /* copy of flags from filhdr    */
223   unsigned short n_type;        /* type and derived type        */
224   signed char n_sclass;         /* storage class                */
225   char n_numaux;                /* number of aux. entries       */
226 };
227
228 #define n_name          _n._n_name
229 #define n_zeroes        _n._n_n._n_zeroes
230 #define n_offset        _n._n_n._n_offset
231
232
233 /* Relocatable symbols have number of the section in which they are defined,
234    or one of the following: */
235
236 #define N_UNDEF ((short)0)      /* undefined symbol */
237 #define N_ABS   ((short)-1)     /* value of symbol is absolute */
238 #define N_DEBUG ((short)-2)     /* debugging symbol -- value is meaningless */
239 #define N_TV    ((short)-3)     /* indicates symbol needs preload transfer vector */
240 #define P_TV    ((short)-4)     /* indicates symbol needs postload transfer vector*/
241
242 /*
243  * Type of a symbol, in low N bits of the word
244  */
245 #define T_NULL          0
246 #define T_VOID          1       /* function argument (only used by compiler) */
247 #define T_CHAR          2       /* character            */
248 #define T_SHORT         3       /* short integer        */
249 #define T_INT           4       /* integer              */
250 #define T_LONG          5       /* long integer         */
251 #define T_FLOAT         6       /* floating point       */
252 #define T_DOUBLE        7       /* double word          */
253 #define T_STRUCT        8       /* structure            */
254 #define T_UNION         9       /* union                */
255 #define T_ENUM          10      /* enumeration          */
256 #define T_MOE           11      /* member of enumeration*/
257 #define T_UCHAR         12      /* unsigned character   */
258 #define T_USHORT        13      /* unsigned short       */
259 #define T_UINT          14      /* unsigned integer     */
260 #define T_ULONG         15      /* unsigned long        */
261 #define T_LNGDBL        16      /* long double          */
262
263 /*
264  * derived types, in n_type
265 */
266 #define DT_NON          (0)     /* no derived type */
267 #define DT_PTR          (1)     /* pointer */
268 #define DT_FCN          (2)     /* function */
269 #define DT_ARY          (3)     /* array */
270
271 #define BTYPE(x)        ((x) & N_BTMASK)
272
273 #define ISPTR(x)        (((x) & N_TMASK) == (DT_PTR << N_BTSHFT))
274 #define ISFCN(x)        (((x) & N_TMASK) == (DT_FCN << N_BTSHFT))
275 #define ISARY(x)        (((x) & N_TMASK) == (DT_ARY << N_BTSHFT))
276 #define ISTAG(x)        ((x)==C_STRTAG||(x)==C_UNTAG||(x)==C_ENTAG)
277 #define DECREF(x) ((((x)>>N_TSHIFT)&~N_BTMASK)|((x)&N_BTMASK))
278
279
280 union internal_auxent
281 {
282   struct
283   {
284
285     union
286     {
287       long l;                   /* str, un, or enum tag indx */
288       struct coff_ptr_struct *p;
289     }     x_tagndx;
290
291     union
292     {
293       struct
294       {
295         unsigned short x_lnno;  /* declaration line number */
296         unsigned short x_size;  /* str/union/array size */
297       }      x_lnsz;
298       long x_fsize;             /* size of function */
299     }     x_misc;
300
301     union
302     {
303       struct
304       {                         /* if ISFCN, tag, or .bb */
305         long x_lnnoptr;         /* ptr to fcn line # */
306         union
307         {                       /* entry ndx past block end */
308           long l;
309           struct coff_ptr_struct *p;
310         }     x_endndx;
311       }      x_fcn;
312
313       struct
314       {                         /* if ISARY, up to 4 dimen. */
315         unsigned short x_dimen[DIMNUM];
316       }      x_ary;
317     }     x_fcnary;
318
319     unsigned short x_tvndx;     /* tv index */
320   }      x_sym;
321
322   union
323   {
324     char x_fname[FILNMLEN];
325     struct
326     {
327       long x_zeroes;
328       long x_offset;
329     }      x_n;
330   }     x_file;
331
332   struct
333   {
334     long x_scnlen;              /* section length */
335     unsigned short x_nreloc;    /* # relocation entries */
336     unsigned short x_nlinno;    /* # line numbers */
337   }      x_scn;
338
339   struct
340   {
341     long x_tvfill;              /* tv fill value */
342     unsigned short x_tvlen;     /* length of .tv */
343     unsigned short x_tvran[2];  /* tv range */
344   }      x_tv;                  /* info about .tv section (in auxent of symbol .tv)) */
345
346   /******************************************
347    * RS/6000-specific auxent - last auxent for every external symbol
348    ******************************************/
349   struct
350   {
351     long x_scnlen;              /* csect length */
352     long x_parmhash;            /* parm type hash index */
353     unsigned short x_snhash;    /* sect num with parm hash */
354     unsigned char x_smtyp;      /* symbol align and type */
355     /* 0-4 - Log 2 of alignment */
356     /* 5-7 - symbol type */
357     unsigned char x_smclas;     /* storage mapping class */
358     long x_stab;                /* dbx stab info index */
359     unsigned short x_snstab;    /* sect num with dbx stab */
360   }      x_csect;               /* csect definition information */
361
362 /* x_smtyp values:  */
363
364 #define SMTYP_ALIGN(x)  ((x) >> 3)      /* log2 of alignment */
365 #define SMTYP_SMTYP(x)  ((x) & 0x7)     /* symbol type */
366 /* Symbol type values:  */
367 #define XTY_ER  0               /* External reference */
368 #define XTY_SD  1               /* Csect definition */
369 #define XTY_LD  2               /* Label definition */
370 #define XTY_CM  3               /* .BSS */
371 #define XTY_EM  4               /* Error message */
372 #define XTY_US  5               /* "Reserved for internal use" */
373
374 /* x_smclas values:  */
375
376 #define XMC_PR  0               /* Read-only program code */
377 #define XMC_RO  1               /* Read-only constant */
378 #define XMC_DB  2               /* Read-only debug dictionary table */
379 #define XMC_TC  3               /* Read-write general TOC entry */
380 #define XMC_UA  4               /* Read-write unclassified */
381 #define XMC_RW  5               /* Read-write data */
382 #define XMC_GL  6               /* Read-only global linkage */
383 #define XMC_XO  7               /* Read-only extended operation (simulated insn) */
384 #define XMC_SV  8               /* Read-only supervisor call */
385 #define XMC_BS  9               /* Read-write BSS */
386 #define XMC_DS  10              /* Read-write descriptor csect */
387 #define XMC_UC  11              /* Read-write unnamed Fortran common */
388 #define XMC_TI  12              /* Read-only traceback index csect */
389 #define XMC_TB  13              /* Read-only traceback table csect */
390 /*              14      ??? */
391 #define XMC_TC0 15              /* Read-write TOC anchor for TOC addressability */
392
393
394   /******************************************
395    *  I960-specific *2nd* aux. entry formats
396    ******************************************/
397   struct
398   {
399     /* This is a very old typo that keeps getting propagated. */
400 #define x_stdindx x_stindx
401     long x_stindx;              /* sys. table entry */
402   }      x_sc;                  /* system call entry */
403
404   struct
405   {
406     unsigned long x_balntry;    /* BAL entry point */
407   }      x_bal;                 /* BAL-callable function */
408
409   struct
410   {
411     unsigned long x_timestamp;  /* time stamp */
412     char x_idstring[20];        /* producer identity string */
413   }      x_ident;               /* Producer ident info */
414
415 };
416
417 /********************** RELOCATION DIRECTIVES **********************/
418
419 struct internal_reloc
420 {
421   long r_vaddr;                 /* Virtual address of reference */
422   long r_symndx;                /* Index into symbol table      */
423   unsigned short r_type;        /* Relocation type              */
424   unsigned char r_size;         /* Used on RS/6000              */
425   unsigned long r_offset;
426
427 };
428
429 #define R_RELBYTE       017
430 #define R_RELWORD       020
431 #define R_PCRBYTE       022
432 #define R_PCRWORD       023
433 #define R_PCRLONG       024
434
435 #define R_DIR32         06
436 #define R_PCLONG        020
437 #define R_RELBYTE       017
438 #define R_RELWORD       020
439
440
441
442 #define R_PCR16L 128
443 #define R_PCR26L 129
444 #define R_VRT16  130
445 #define R_HVRT16 131
446 #define R_LVRT16 132
447 #define R_VRT32  133
448 #define R_RELLONG       (0x11)  /* Direct 32-bit relocation */
449 #define R_IPRSHORT      (0x18)
450 #define R_IPRMED        (0x19)  /* 24-bit ip-relative relocation */
451 #define R_IPRLONG       (0x1a)
452 #define R_OPTCALL       (0x1b)  /* 32-bit optimizable call (leafproc/sysproc) */
453 #define R_OPTCALLX      (0x1c)  /* 64-bit optimizable call (leafproc/sysproc) */
454 #define R_GETSEG        (0x1d)
455 #define R_GETPA         (0x1e)
456 #define R_TAGWORD       (0x1f)
457 #define R_JUMPTARG      0x20    /* strange 29k 00xx00xx reloc */
458 #define R_MOVB1    0x41         /* Special h8 16bit or 8 bit reloc for  mov.b */
459 #define R_MOVB2    0x42         /* Special h8 opcode for 8bit which could
460                                                               be 16 */
461 #define R_JMP1     0x43         /* Special h8 16bit jmp which could be
462                                                               pcrel */
463 #define R_JMP2 0x44             /* a branch which used to be a jmp */
464 #define R_RELLONG_NEG  0x45
465
466
467 /* Z8k modes */
468 #define R_DA      0x01          /* 16 bit Absolute direct address */
469 #define R_JR      0x02          /* jr  8 bit disp */
470 #define R_IMM4L   0x23          /* low nibble */
471 #define R_IMM8    0x22          /* 8 bit abs */
472 #define R_IMM32   0x21          /* 32 bit abs */
473 #define R_CALL    R_DA          /* Absolute address which could be a callr */
474 #define R_JP      R_DA          /* Absolute address which could be a jp */
475 #define R_REL16   0x04          /* 16 bit PC rel */
476 #define R_CALLR   0x05          /* callr 12 bit disp */
477 #define R_SEG     0x10          /* set if in segmented mode */
478 #define R_IMM4H   0x24          /* high nibble */