home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / gnu / gdb-4.12.tar.gz / gdb-4.12.tar / gdb-4.12 / include / aout / aout64.h < prev    next >
C/C++ Source or Header  |  1994-02-03  |  17KB  |  456 lines
  1. /* `a.out' object-file definitions, including extensions to 64-bit fields */
  2.  
  3. #ifndef __A_OUT_64_H__
  4. #define __A_OUT_64_H__
  5.  
  6. /* This is the layout on disk of the 32-bit or 64-bit exec header. */
  7.  
  8. #ifndef external_exec
  9. struct external_exec 
  10. {
  11.   bfd_byte e_info[4];        /* magic number and stuff        */
  12.   bfd_byte e_text[BYTES_IN_WORD]; /* length of text section in bytes    */
  13.   bfd_byte e_data[BYTES_IN_WORD]; /* length of data section in bytes    */
  14.   bfd_byte e_bss[BYTES_IN_WORD]; /* length of bss area in bytes         */
  15.   bfd_byte e_syms[BYTES_IN_WORD]; /* length of symbol table in bytes     */
  16.   bfd_byte e_entry[BYTES_IN_WORD]; /* start address             */
  17.   bfd_byte e_trsize[BYTES_IN_WORD]; /* length of text relocation info    */
  18.   bfd_byte e_drsize[BYTES_IN_WORD]; /* length of data relocation info     */
  19. };
  20.  
  21. #define    EXEC_BYTES_SIZE    (4 + BYTES_IN_WORD * 7)
  22.  
  23. /* Magic numbers for a.out files */
  24.  
  25. #if ARCH_SIZE==64
  26. #define OMAGIC 0x1001        /* Code indicating object file  */
  27. #define ZMAGIC 0x1002        /* Code indicating demand-paged executable.  */
  28. #define NMAGIC 0x1003        /* Code indicating pure executable.  */
  29.  
  30. /* There is no 64-bit QMAGIC as far as I know.  */
  31.  
  32. #define N_BADMAG(x)      (N_MAGIC(x) != OMAGIC        \
  33.             && N_MAGIC(x) != NMAGIC        \
  34.               && N_MAGIC(x) != ZMAGIC)
  35. #else
  36. #define OMAGIC 0407        /* ...object file or impure executable.  */
  37. #define NMAGIC 0410        /* Code indicating pure executable.  */
  38. #define ZMAGIC 0413        /* Code indicating demand-paged executable.  */
  39.  
  40. /* This indicates a demand-paged executable with the header in the text.
  41.    It is used by 386BSD (and variants) and Linux, at least.  */
  42. #define QMAGIC 0314
  43. # ifndef N_BADMAG
  44. #  define N_BADMAG(x)      (N_MAGIC(x) != OMAGIC        \
  45.             && N_MAGIC(x) != NMAGIC        \
  46.               && N_MAGIC(x) != ZMAGIC \
  47.                 && N_MAGIC(x) != QMAGIC)
  48. # endif /* N_BADMAG */
  49. #endif
  50.  
  51. #endif
  52.  
  53. #ifdef QMAGIC
  54. #define N_IS_QMAGIC(x) (N_MAGIC (x) == QMAGIC)
  55. #else
  56. #define N_IS_QMAGIC(x) (0)
  57. #endif
  58.  
  59. /* The difference between PAGE_SIZE and N_SEGSIZE is that PAGE_SIZE is
  60.    the finest granularity at which you can page something, thus it
  61.    controls the padding (if any) before the text segment of a ZMAGIC
  62.    file.  N_SEGSIZE is the resolution at which things can be marked as
  63.    read-only versus read/write, so it controls the padding between the
  64.    text segment and the data segment (in memory; on disk the padding
  65.    between them is PAGE_SIZE).  PAGE_SIZE and N_SEGSIZE are the same
  66.    for most machines, but different for sun3.  */
  67.  
  68. /* By default, segment size is constant.  But some machines override this
  69.    to be a function of the a.out header (e.g. machine type).  */
  70.  
  71. #ifndef    N_SEGSIZE
  72. #define    N_SEGSIZE(x)    SEGMENT_SIZE
  73. #endif
  74.  
  75. /* Virtual memory address of the text section.
  76.    This is getting very complicated.  A good reason to discard a.out format
  77.    for something that specifies these fields explicitly.  But til then...
  78.  
  79.    * OMAGIC and NMAGIC files:
  80.        (object files: text for "relocatable addr 0" right after the header)
  81.        start at 0, offset is EXEC_BYTES_SIZE, size as stated.
  82.    * The text address, offset, and size of ZMAGIC files depend
  83.      on the entry point of the file:
  84.      * entry point below TEXT_START_ADDR:
  85.        (hack for SunOS shared libraries)
  86.        start at 0, offset is 0, size as stated.
  87.      * If N_HEADER_IN_TEXT(x) is true (which defaults to being the
  88.        case when the entry point is EXEC_BYTES_SIZE or further into a page):
  89.        no padding is needed; text can start after exec header.  Sun
  90.        considers the text segment of such files to include the exec header;
  91.        for BFD's purposes, we don't, which makes more work for us.
  92.        start at TEXT_START_ADDR + EXEC_BYTES_SIZE, offset is EXEC_BYTES_SIZE,
  93.        size as stated minus EXEC_BYTES_SIZE.
  94.      * If N_HEADER_IN_TEXT(x) is false (which defaults to being the case when
  95.        the entry point is less than EXEC_BYTES_SIZE into a page (e.g. page
  96.        aligned)): (padding is needed so that text can start at a page boundary)
  97.        start at TEXT_START_ADDR, offset PAGE_SIZE, size as stated.
  98.  
  99.     Specific configurations may want to hardwire N_HEADER_IN_TEXT,
  100.     for efficiency or to allow people to play games with the entry point.
  101.     In that case, you would #define N_HEADER_IN_TEXT(x) as 1 for sunos,
  102.     and as 0 for most other hosts (Sony News, Vax Ultrix, etc).
  103.     (Do this in the appropriate bfd target file.)
  104.     (The default is a heuristic that will break if people try changing
  105.     the entry point, perhaps with the ld -e flag.)
  106.  
  107.     * QMAGIC is always like a ZMAGIC for which N_HEADER_IN_TEXT is true,
  108.     and for which the starting address is PAGE_SIZE (or should this be
  109.     SEGMENT_SIZE?) (TEXT_START_ADDR only applies to ZMAGIC, not to QMAGIC).
  110.     */
  111.  
  112. /* This macro is only relevant for ZMAGIC files; QMAGIC always has the header
  113.    in the text.  */
  114. #ifndef N_HEADER_IN_TEXT
  115. #define N_HEADER_IN_TEXT(x) (((x).a_entry & (PAGE_SIZE-1)) >= EXEC_BYTES_SIZE)
  116. #endif
  117.  
  118. /* Sun shared libraries, not linux.  This macro is only relevant for ZMAGIC
  119.    files.  */
  120. #ifndef N_SHARED_LIB
  121. #define N_SHARED_LIB(x) ((x).a_entry < TEXT_START_ADDR)
  122. #endif
  123.  
  124. /* Returning 0 not TEXT_START_ADDR for OMAGIC and NMAGIC is based on
  125.    the assumption that we are dealing with a .o file, not an
  126.    executable.  This is necessary for OMAGIC (but means we don't work
  127.    right on the output from ld -N); more questionable for NMAGIC.  */
  128.  
  129. #ifndef N_TXTADDR
  130. #define N_TXTADDR(x) \
  131.     (/* The address of a QMAGIC file is always one page in, */ \
  132.      /* with the header in the text.  */ \
  133.      N_IS_QMAGIC (x) ? PAGE_SIZE + EXEC_BYTES_SIZE : \
  134.      N_MAGIC(x) != ZMAGIC ? 0 :    /* object file or NMAGIC */\
  135.      N_SHARED_LIB(x) ? 0 :    \
  136.      N_HEADER_IN_TEXT(x)  ?    \
  137.         TEXT_START_ADDR + EXEC_BYTES_SIZE :    /* no padding */\
  138.         TEXT_START_ADDR            /* a page of padding */\
  139.     )
  140. #endif
  141.  
  142. /* If N_HEADER_IN_TEXT is not true for ZMAGIC, there is some padding
  143.    to make the text segment start at a certain boundary.  For most
  144.    systems, this boundary is PAGE_SIZE.  But for Linux, in the
  145.    time-honored tradition of crazy ZMAGIC hacks, it is 1024 which is
  146.    not what PAGE_SIZE needs to be for QMAGIC.  */
  147.  
  148. #ifndef ZMAGIC_DISK_BLOCK_SIZE
  149. #define ZMAGIC_DISK_BLOCK_SIZE PAGE_SIZE
  150. #endif
  151.  
  152. #define N_DISK_BLOCK_SIZE(x) \
  153.   (N_MAGIC(x) == ZMAGIC ? ZMAGIC_DISK_BLOCK_SIZE : PAGE_SIZE)
  154.  
  155. /* Offset in an a.out of the start of the text section. */
  156. #ifndef N_TXTOFF
  157. #define N_TXTOFF(x)    \
  158.     (/* For {O,N,Q}MAGIC, no padding.  */ \
  159.      N_MAGIC(x) != ZMAGIC ? EXEC_BYTES_SIZE : \
  160.      N_SHARED_LIB(x) ? 0 : \
  161.      N_HEADER_IN_TEXT(x) ?    \
  162.         EXEC_BYTES_SIZE :            /* no padding */\
  163.         ZMAGIC_DISK_BLOCK_SIZE        /* a page of padding */\
  164.     )
  165. #endif
  166. /* Size of the text section.  It's always as stated, except that we
  167.    offset it to `undo' the adjustment to N_TXTADDR and N_TXTOFF
  168.    for ZMAGIC files that nominally include the exec header
  169.    as part of the first page of text.  (BFD doesn't consider the
  170.    exec header to be part of the text segment.)  */
  171. #ifndef N_TXTSIZE
  172. #define    N_TXTSIZE(x) \
  173.     (/* For QMAGIC, we don't consider the header part of the text section.  */\
  174.      N_IS_QMAGIC (x) ? (x).a_text - EXEC_BYTES_SIZE : \
  175.      (N_MAGIC(x) != ZMAGIC || N_SHARED_LIB(x)) ? (x).a_text : \
  176.      N_HEADER_IN_TEXT(x)  ?    \
  177.         (x).a_text - EXEC_BYTES_SIZE:    /* no padding */\
  178.         (x).a_text                /* a page of padding */\
  179.     )
  180. #endif
  181. /* The address of the data segment in virtual memory.
  182.    It is the text segment address, plus text segment size, rounded
  183.    up to a N_SEGSIZE boundary for pure or pageable files. */
  184. #ifndef N_DATADDR
  185. #define N_DATADDR(x) \
  186.     (N_MAGIC(x)==OMAGIC? (N_TXTADDR(x)+N_TXTSIZE(x)) \
  187.      :  (N_SEGSIZE(x) + ((N_TXTADDR(x)+N_TXTSIZE(x)-1) & ~(N_SEGSIZE(x)-1))))
  188. #endif
  189. /* The address of the BSS segment -- immediately after the data segment.  */
  190.  
  191. #define N_BSSADDR(x)    (N_DATADDR(x) + (x).a_data)
  192.  
  193. /* Offsets of the various portions of the file after the text segment.  */
  194.  
  195. /* For {Q,Z}MAGIC, there is padding to make the data segment start on
  196.    a page boundary.  Most of the time the a_text field (and thus
  197.    N_TXTSIZE) already contains this padding.  It is possible that for
  198.    BSDI and/or 386BSD it sometimes doesn't contain the padding, and
  199.    perhaps we should be adding it here.  But this seems kind of
  200.    questionable and probably should be BSDI/386BSD-specific if we do
  201.    do it.
  202.  
  203.    For NMAGIC (at least for hp300 BSD, probably others), there is
  204.    padding in memory only, not on disk, so we must *not* ever pad here
  205.    for NMAGIC.  */
  206.  
  207. #ifndef N_DATOFF
  208. #define N_DATOFF(x) \
  209.  (N_TXTOFF(x) + N_TXTSIZE(x))
  210. #endif
  211.  
  212. #ifndef N_TRELOFF
  213. #define N_TRELOFF(x)    ( N_DATOFF(x) + (x).a_data )
  214. #endif
  215. #ifndef N_DRELOFF
  216. #define N_DRELOFF(x)    ( N_TRELOFF(x) + (x).a_trsize )
  217. #endif
  218. #ifndef N_SYMOFF
  219. #define N_SYMOFF(x)    ( N_DRELOFF(x) + (x).a_drsize )
  220. #endif
  221. #ifndef N_STROFF
  222. #define N_STROFF(x)    ( N_SYMOFF(x) + (x).a_syms )
  223. #endif
  224.  
  225. /* Symbols */
  226. #ifndef external_nlist
  227. struct external_nlist {
  228.   bfd_byte e_strx[BYTES_IN_WORD];    /* index into string table of name */
  229.   bfd_byte e_type[1];            /* type of symbol */
  230.   bfd_byte e_other[1];            /* misc info (usually empty) */
  231.   bfd_byte e_desc[2];            /* description field */
  232.   bfd_byte e_value[BYTES_IN_WORD];    /* value of symbol */
  233. };
  234. #define EXTERNAL_NLIST_SIZE (BYTES_IN_WORD+4+BYTES_IN_WORD)
  235. #endif
  236.  
  237. struct internal_nlist {
  238.   unsigned long n_strx;            /* index into string table of name */
  239.   unsigned char n_type;            /* type of symbol */
  240.   unsigned char n_other;        /* misc info (usually empty) */
  241.   unsigned short n_desc;        /* description field */
  242.   bfd_vma n_value;            /* value of symbol */
  243. };
  244.  
  245. /* The n_type field is the symbol type, containing:  */
  246.  
  247. #define N_UNDF    0    /* Undefined symbol */
  248. #define N_ABS     2    /* Absolute symbol -- defined at particular addr */
  249. #define N_TEXT     4    /* Text sym -- defined at offset in text seg */
  250. #define N_DATA     6    /* Data sym -- defined at offset in data seg */
  251. #define N_BSS     8    /* BSS  sym -- defined at offset in zero'd seg */
  252. #define    N_COMM    0x12    /* Common symbol (visible after shared lib dynlink) */
  253. #define N_FN    0x1f    /* File name of .o file */
  254. #define    N_FN_SEQ 0x0C    /* N_FN from Sequent compilers (sigh) */
  255. /* Note: N_EXT can only be usefully OR-ed with N_UNDF, N_ABS, N_TEXT,
  256.    N_DATA, or N_BSS.  When the low-order bit of other types is set,
  257.    (e.g. N_WARNING versus N_FN), they are two different types.  */
  258. #define N_EXT     1    /* External symbol (as opposed to local-to-this-file) */
  259. #define N_TYPE  0x1e
  260. #define N_STAB     0xe0    /* If any of these bits are on, it's a debug symbol */
  261.  
  262. #define N_INDR 0x0a
  263.  
  264. /* The following symbols refer to set elements.
  265.    All the N_SET[ATDB] symbols with the same name form one set.
  266.    Space is allocated for the set in the text section, and each set
  267.    elements value is stored into one word of the space.
  268.    The first word of the space is the length of the set (number of elements).
  269.  
  270.    The address of the set is made into an N_SETV symbol
  271.    whose name is the same as the name of the set.
  272.    This symbol acts like a N_DATA global symbol
  273.    in that it can satisfy undefined external references.  */
  274.  
  275. /* These appear as input to LD, in a .o file.  */
  276. #define    N_SETA    0x14        /* Absolute set element symbol */
  277. #define    N_SETT    0x16        /* Text set element symbol */
  278. #define    N_SETD    0x18        /* Data set element symbol */
  279. #define    N_SETB    0x1A        /* Bss set element symbol */
  280.  
  281. /* This is output from LD.  */
  282. #define N_SETV    0x1C        /* Pointer to set vector in data area.  */
  283.  
  284. /* Warning symbol. The text gives a warning message, the next symbol
  285.    in the table will be undefined. When the symbol is referenced, the
  286.    message is printed.  */
  287.  
  288. #define    N_WARNING 0x1e
  289.  
  290. /* Relocations 
  291.  
  292.   There    are two types of relocation flavours for a.out systems,
  293.   standard and extended. The standard form is used on systems where the
  294.   instruction has room for all the bits of an offset to the operand, whilst
  295.   the extended form is used when an address operand has to be split over n
  296.   instructions. Eg, on the 68k, each move instruction can reference
  297.   the target with a displacement of 16 or 32 bits. On the sparc, move
  298.   instructions use an offset of 14 bits, so the offset is stored in
  299.   the reloc field, and the data in the section is ignored.
  300. */
  301.  
  302. /* This structure describes a single relocation to be performed.
  303.    The text-relocation section of the file is a vector of these structures,
  304.    all of which apply to the text section.
  305.    Likewise, the data-relocation section applies to the data section.  */
  306.  
  307. struct reloc_std_external {
  308.   bfd_byte    r_address[BYTES_IN_WORD];    /* offset of of data to relocate     */
  309.   bfd_byte r_index[3];    /* symbol table index of symbol     */
  310.   bfd_byte r_type[1];    /* relocation type            */
  311. };
  312.  
  313. #define    RELOC_STD_BITS_PCREL_BIG    0x80
  314. #define    RELOC_STD_BITS_PCREL_LITTLE    0x01
  315.  
  316. #define    RELOC_STD_BITS_LENGTH_BIG    0x60
  317. #define    RELOC_STD_BITS_LENGTH_SH_BIG    5    /* To shift to units place */
  318. #define    RELOC_STD_BITS_LENGTH_LITTLE    0x06
  319. #define    RELOC_STD_BITS_LENGTH_SH_LITTLE    1
  320.  
  321. #define    RELOC_STD_BITS_EXTERN_BIG    0x10
  322. #define    RELOC_STD_BITS_EXTERN_LITTLE    0x08
  323.  
  324. #define    RELOC_STD_BITS_BASEREL_BIG    0x08
  325. #define    RELOC_STD_BITS_BASEREL_LITTLE    0x10
  326.  
  327. #define    RELOC_STD_BITS_JMPTABLE_BIG    0x04
  328. #define    RELOC_STD_BITS_JMPTABLE_LITTLE    0x20
  329.  
  330. #define    RELOC_STD_BITS_RELATIVE_BIG    0x02
  331. #define    RELOC_STD_BITS_RELATIVE_LITTLE    0x40
  332.  
  333. #define    RELOC_STD_SIZE    (BYTES_IN_WORD + 3 + 1)        /* Bytes per relocation entry */
  334.  
  335. struct reloc_std_internal
  336. {
  337.   bfd_vma r_address;        /* Address (within segment) to be relocated.  */
  338.   /* The meaning of r_symbolnum depends on r_extern.  */
  339.   unsigned int r_symbolnum:24;
  340.   /* Nonzero means value is a pc-relative offset
  341.      and it should be relocated for changes in its own address
  342.      as well as for changes in the symbol or section specified.  */
  343.   unsigned int r_pcrel:1;
  344.   /* Length (as exponent of 2) of the field to be relocated.
  345.      Thus, a value of 2 indicates 1<<2 bytes.  */
  346.   unsigned int r_length:2;
  347.   /* 1 => relocate with value of symbol.
  348.      r_symbolnum is the index of the symbol
  349.      in files the symbol table.
  350.      0 => relocate with the address of a segment.
  351.      r_symbolnum is N_TEXT, N_DATA, N_BSS or N_ABS
  352.      (the N_EXT bit may be set also, but signifies nothing).  */
  353.   unsigned int r_extern:1;
  354.   /* The next three bits are for SunOS shared libraries, and seem to
  355.      be undocumented.  */
  356.   unsigned int r_baserel:1;    /* Linkage table relative */
  357.   unsigned int r_jmptable:1;    /* pc-relative to jump table */
  358.   unsigned int r_relative:1;    /* "relative relocation" */
  359.   /* unused */
  360.   unsigned int r_pad:1;        /* Padding -- set to zero */
  361. };
  362.  
  363.  
  364. /* EXTENDED RELOCS  */
  365.  
  366. struct reloc_ext_external {
  367.   bfd_byte r_address[BYTES_IN_WORD];    /* offset of of data to relocate     */
  368.   bfd_byte r_index[3];    /* symbol table index of symbol     */
  369.   bfd_byte r_type[1];    /* relocation type            */
  370.   bfd_byte r_addend[BYTES_IN_WORD];    /* datum addend                */
  371. };
  372.  
  373. #define    RELOC_EXT_BITS_EXTERN_BIG    0x80
  374. #define    RELOC_EXT_BITS_EXTERN_LITTLE    0x01
  375.  
  376. #define    RELOC_EXT_BITS_TYPE_BIG        0x1F
  377. #define    RELOC_EXT_BITS_TYPE_SH_BIG    0
  378. #define    RELOC_EXT_BITS_TYPE_LITTLE    0xF8
  379. #define    RELOC_EXT_BITS_TYPE_SH_LITTLE    3
  380.  
  381. /* Bytes per relocation entry */
  382. #define    RELOC_EXT_SIZE    (BYTES_IN_WORD + 3 + 1 + BYTES_IN_WORD)
  383.  
  384. enum reloc_type
  385. {
  386.   /* simple relocations */
  387.   RELOC_8,            /* data[0:7] = addend + sv         */
  388.   RELOC_16,            /* data[0:15] = addend + sv         */
  389.   RELOC_32,            /* data[0:31] = addend + sv         */
  390.   /* pc-rel displacement */
  391.   RELOC_DISP8,            /* data[0:7] = addend - pc + sv     */
  392.   RELOC_DISP16,            /* data[0:15] = addend - pc + sv     */
  393.   RELOC_DISP32,            /* data[0:31] = addend - pc + sv     */
  394.   /* Special */
  395.   RELOC_WDISP30,        /* data[0:29] = (addend + sv - pc)>>2     */
  396.   RELOC_WDISP22,        /* data[0:21] = (addend + sv - pc)>>2     */
  397.   RELOC_HI22,            /* data[0:21] = (addend + sv)>>10     */
  398.   RELOC_22,            /* data[0:21] = (addend + sv)         */
  399.   RELOC_13,            /* data[0:12] = (addend + sv)        */
  400.   RELOC_LO10,            /* data[0:9] = (addend + sv)        */
  401.   RELOC_SFA_BASE,        
  402.   RELOC_SFA_OFF13,
  403.   /* P.I.C. (base-relative) */
  404.   RELOC_BASE10,          /* Not sure - maybe we can do this the */
  405.   RELOC_BASE13,            /* right way now */
  406.   RELOC_BASE22,
  407.   /* for some sort of pc-rel P.I.C. (?) */
  408.   RELOC_PC10,
  409.   RELOC_PC22,
  410.   /* P.I.C. jump table */
  411.   RELOC_JMP_TBL,
  412.   /* reputedly for shared libraries somehow */
  413.   RELOC_SEGOFF16,
  414.   RELOC_GLOB_DAT,
  415.   RELOC_JMP_SLOT,
  416.   RELOC_RELATIVE,
  417.  
  418.   RELOC_11,    
  419.   RELOC_WDISP2_14,
  420.   RELOC_WDISP19,
  421.   RELOC_HHI22,            /* data[0:21] = (addend + sv) >> 42     */
  422.   RELOC_HLO10,            /* data[0:9] = (addend + sv) >> 32      */
  423.   
  424.   /* 29K relocation types */
  425.   RELOC_JUMPTARG,
  426.   RELOC_CONST,
  427.   RELOC_CONSTH,
  428.   
  429.  
  430.   /* Q .
  431.      What are the other ones,
  432.      Since this is a clean slate, can we throw away the ones we dont
  433.      understand ? Should we sort the values ? What about using a
  434.      microcode format like the 68k ?
  435.      */
  436.   NO_RELOC
  437.   };
  438.  
  439.  
  440. struct reloc_internal {
  441.   bfd_vma r_address;        /* offset of of data to relocate     */
  442.   long    r_index;        /* symbol table index of symbol     */
  443.   enum reloc_type r_type;    /* relocation type            */
  444.   bfd_vma r_addend;        /* datum addend                */
  445. };
  446.  
  447. /* Q.
  448.    Should the length of the string table be 4 bytes or 8 bytes ?
  449.  
  450.    Q.
  451.    What about archive indexes ?
  452.  
  453.  */
  454.  
  455. #endif                /* __A_OUT_64_H__ */
  456.