home *** CD-ROM | disk | FTP | other *** search
/ OpenStep 4.2J (Developer) / os42jdev.iso / NextDeveloper / Headers / mach-o / loader.h < prev    next >
Text File  |  1995-07-20  |  33KB  |  700 lines
  1. #ifndef _MACHO_LOADER_H_
  2. #define _MACHO_LOADER_H_
  3.  
  4. /*
  5.  * This file describes the format of mach object files.
  6.  */
  7.  
  8. /*
  9.  * <mach/machine.h> is needed here for the cpu_type_t and cpu_subtype_t types
  10.  * and contains the constants for the possible values of these types.
  11.  */
  12. #import <mach/machine.h>
  13.  
  14. /*
  15.  * <mach/vm_prot.h> is needed here for the vm_prot_t type and contains the 
  16.  * constants that are or'ed together for the possible values of this type.
  17.  */
  18. #import <mach/vm_prot.h>
  19.  
  20. /*
  21.  * <machine/thread_status.h> is expected to define the flavors of the thread
  22.  * states and the structures of those flavors for each machine.
  23.  */
  24. #import <mach/machine/thread_status.h>
  25. #import <architecture/byte_order.h>
  26.  
  27. /*
  28.  * The mach header appears at the very beginning of the object file.
  29.  */
  30. struct mach_header {
  31.     unsigned long    magic;        /* mach magic number identifier */
  32.     cpu_type_t    cputype;    /* cpu specifier */
  33.     cpu_subtype_t    cpusubtype;    /* machine specifier */
  34.     unsigned long    filetype;    /* type of file */
  35.     unsigned long    ncmds;        /* number of load commands */
  36.     unsigned long    sizeofcmds;    /* the size of all the load commands */
  37.     unsigned long    flags;        /* flags */
  38. };
  39.  
  40. /* Constant for the magic field of the mach_header */
  41. #define    MH_MAGIC    0xfeedface    /* the mach magic number */
  42. #define MH_CIGAM    NXSwapInt(MH_MAGIC)
  43.  
  44. /*
  45.  * The layout of the file depends on the filetype.  For all but the MH_OBJECT
  46.  * file type the segments are padded out and aligned on a segment alignment
  47.  * boundary for efficient demand pageing.  The MH_EXECUTE, MH_FVMLIB, MH_DYLIB,
  48.  * MH_DYLINKER and MH_BUNDLE file types also have the headers included as part
  49.  * of their first segment.
  50.  * 
  51.  * The file type MH_OBJECT is a compact format intended as output of the
  52.  * assembler and input (and possibly output) of the link editor (the .o
  53.  * format).  All sections are in one unnamed segment with no segment padding. 
  54.  * This format is used as an executable format when the file is so small the
  55.  * segment padding greatly increases it's size.
  56.  *
  57.  * The file type MH_PRELOAD is an executable format intended for things that
  58.  * not executed under the kernel (proms, stand alones, kernels, etc).  The
  59.  * format can be executed under the kernel but may demand paged it and not
  60.  * preload it before execution.
  61.  *
  62.  * A core file is in MH_CORE format and can be any in an arbritray legal
  63.  * Mach-O file.
  64.  *
  65.  * Constants for the filetype field of the mach_header
  66.  */
  67. #define    MH_OBJECT    0x1        /* relocatable object file */
  68. #define    MH_EXECUTE    0x2        /* demand paged executable file */
  69. #define    MH_FVMLIB    0x3        /* fixed VM shared library file */
  70. #define    MH_CORE        0x4        /* core file */
  71. #define    MH_PRELOAD    0x5        /* preloaded executable file */
  72. #define    MH_DYLIB    0x6        /* dynamicly bound shared library file*/
  73. #define    MH_DYLINKER    0x7        /* dynamic link editor */
  74. #define    MH_BUNDLE    0x8        /* dynamicly bound bundle file */
  75.  
  76. /* Constants for the flags field of the mach_header */
  77. #define    MH_NOUNDEFS    0x1        /* the object file has no undefined
  78.                        references, can be executed */
  79. #define    MH_INCRLINK    0x2        /* the object file is the output of an
  80.                        incremental link against a base file
  81.                        and can't be link edited again */
  82. #define MH_DYLDLINK    0x4        /* the object file is input for the
  83.                        dynamic linker and can't be staticly
  84.                        link edited again */
  85. #define MH_BINDATLOAD    0x8        /* the object file's undefined
  86.                        references are bound by the dynamic
  87.                        linker when loaded. */
  88. #define MH_PREBOUND    0x10        /* the file has it's dynamic undefined
  89.                        references prebound. */
  90.  
  91. /*
  92.  * The load commands directly follow the mach_header.  The total size of all
  93.  * of the commands is given by the sizeofcmds field in the mach_header.  All
  94.  * load commands must have as their first two fields cmd and cmdsize.  The cmd
  95.  * field is filled in with a constant for that command type.  Each command type
  96.  * has a structure specifically for it.  The cmdsize field is the size in bytes
  97.  * of the particular load command structure plus anything that follows it that
  98.  * is a part of the load command (i.e. section structures, strings, etc.).  To
  99.  * advance to the next load command the cmdsize can be added to the offset or
  100.  * pointer of the current load command.  The cmdsize MUST be a multiple of
  101.  * sizeof(long) (this is forever the maximum alignment of any load commands).
  102.  * The padded bytes must be zero.  All tables in the object file must also
  103.  * follow these rules so the file can be memory mapped.  Otherwise the pointers
  104.  * to these tables will not work well or at all on some machines.  With all
  105.  * padding zeroed like objects will compare byte for byte.
  106.  */
  107. struct load_command {
  108.     unsigned long cmd;        /* type of load command */
  109.     unsigned long cmdsize;        /* total size of command in bytes */
  110. };
  111.  
  112. /* Constants for the cmd field of all load commands, the type */
  113. #define    LC_SEGMENT    0x1    /* segment of this file to be mapped */
  114. #define    LC_SYMTAB    0x2    /* link-edit stab symbol table info */
  115. #define    LC_SYMSEG    0x3    /* link-edit gdb symbol table info (obsolete) */
  116. #define    LC_THREAD    0x4    /* thread */
  117. #define    LC_UNIXTHREAD    0x5    /* unix thread (includes a stack) */
  118. #define    LC_LOADFVMLIB    0x6    /* load a specified fixed VM shared library */
  119. #define    LC_IDFVMLIB    0x7    /* fixed VM shared library identification */
  120. #define    LC_IDENT    0x8    /* object identification info (obsolete) */
  121. #define LC_FVMFILE    0x9    /* fixed VM file inclusion (internal use) */
  122. #define LC_PREPAGE      0xa     /* prepage command (internal use) */
  123. #define    LC_DYSYMTAB    0xb    /* dynamic link-edit symbol table info */
  124. #define    LC_LOAD_DYLIB    0xc    /* load a dynamicly linked shared library */
  125. #define    LC_ID_DYLIB    0xd    /* dynamicly linked shared lib identification */
  126. #define LC_LOAD_DYLINKER 0xe    /* load a dynamic linker */
  127. #define LC_ID_DYLINKER    0xf    /* dynamic linker identification */
  128. #define    LC_PREBOUND_DYLIB 0x10    /* modules prebound for a dynamicly */
  129.                 /*  linked shared library */
  130.  
  131. /*
  132.  * A variable length string in a load command is represented by an lc_str
  133.  * union.  The strings are stored just after the load command structure and
  134.  * the offset is from the start of the load command structure.  The size
  135.  * of the string is reflected in the cmdsize field of the load command.
  136.  * Once again any padded bytes to bring the cmdsize field to a multiple
  137.  * of sizeof(long) must be zero.
  138.  */
  139. union lc_str {
  140.     unsigned long    offset;    /* offset to the string */
  141.     char        *ptr;    /* pointer to the string */
  142. };
  143.  
  144. /*
  145.  * The segment load command indicates that a part of this file is to be
  146.  * mapped into the task's address space.  The size of this segment in memory,
  147.  * vmsize, maybe equal to or larger than the amount to map from this file,
  148.  * filesize.  The file is mapped starting at fileoff to the beginning of
  149.  * the segment in memory, vmaddr.  The rest of the memory of the segment,
  150.  * if any, is allocated zero fill on demand.  The segment's maximum virtual
  151.  * memory protection and initial virtual memory protection are specified
  152.  * by the maxprot and initprot fields.  If the segment has sections then the
  153.  * section structures directly follow the segment command and their size is
  154.  * reflected in cmdsize.
  155.  */
  156. struct segment_command {
  157.     unsigned long    cmd;        /* LC_SEGMENT */
  158.     unsigned long    cmdsize;    /* includes sizeof section structs */
  159.     char        segname[16];    /* segment name */
  160.     unsigned long    vmaddr;        /* memory address of this segment */
  161.     unsigned long    vmsize;        /* memory size of this segment */
  162.     unsigned long    fileoff;    /* file offset of this segment */
  163.     unsigned long    filesize;    /* amount to map from the file */
  164.     vm_prot_t    maxprot;    /* maximum VM protection */
  165.     vm_prot_t    initprot;    /* initial VM protection */
  166.     unsigned long    nsects;        /* number of sections in segment */
  167.     unsigned long    flags;        /* flags */
  168. };
  169.  
  170. /* Constants for the flags field of the segment_command */
  171. #define    SG_HIGHVM    0x1    /* the file contents for this segment is for
  172.                    the high part of the VM space, the low part
  173.                    is zero filled (for stacks in core files) */
  174. #define    SG_FVMLIB    0x2    /* this segment is the VM that is allocated by
  175.                    a fixed VM library, for overlap checking in
  176.                    the link editor */
  177. #define    SG_NORELOC    0x4    /* this segment has nothing that was relocated
  178.                    in it and nothing relocated to it, that is
  179.                    it maybe safely replaced without relocation*/
  180.  
  181. /*
  182.  * A segment is made up of zero or more sections.  Non-MH_OBJECT files have
  183.  * all of their segments with the proper sections in each, and padded to the
  184.  * specified segment alignment when produced by the link editor.  The first
  185.  * segment of a MH_EXECUTE and MH_FVMLIB format file contains the mach_header
  186.  * and load commands of the object file before it's first section.  The zero
  187.  * fill sections are always last in their segment (in all formats).  This
  188.  * allows the zeroed segment padding to be mapped into memory where zero fill
  189.  * sections might be.
  190.  *
  191.  * The MH_OBJECT format has all of it's sections in one segment for
  192.  * compactness.  There is no padding to a specified segment boundary and the
  193.  * mach_header and load commands are not part of the segment.
  194.  *
  195.  * Sections with the same section name, sectname, going into the same segment,
  196.  * segname, are combined by the link editor.  The resulting section is aligned
  197.  * to the maximum alignment of the combined sections and is the new section's
  198.  * alignment.  The combined sections are aligned to their original alignment in
  199.  * the combined section.  Any padded bytes to get the specified alignment are
  200.  * zeroed.
  201.  *
  202.  * The format of the relocation entries referenced by the reloff and nreloc
  203.  * fields of the section structure for mach object files is described in the
  204.  * header file <reloc.h>.
  205.  */
  206. struct section {
  207.     char        sectname[16];    /* name of this section */
  208.     char        segname[16];    /* segment this section goes in */
  209.     unsigned long    addr;        /* memory address of this section */
  210.     unsigned long    size;        /* size in bytes of this section */
  211.     unsigned long    offset;        /* file offset of this section */
  212.     unsigned long    align;        /* section alignment (power of 2) */
  213.     unsigned long    reloff;        /* file offset of relocation entries */
  214.     unsigned long    nreloc;        /* number of relocation entries */
  215.     unsigned long    flags;        /* flags (section type and attributes)*/
  216.     unsigned long    reserved1;    /* reserved */
  217.     unsigned long    reserved2;    /* reserved */
  218. };
  219.  
  220. /*
  221.  * The flags field of a section structure is separated into two parts a section
  222.  * type and section attributes.  The section types are mutually exclusive (it
  223.  * can only have one type) but the section attributes are not (it may have more
  224.  * than one attribute).
  225.  */
  226. #define SECTION_TYPE         0x000000ff    /* 256 section types */
  227. #define SECTION_ATTRIBUTES     0xffffff00    /*  24 section attributes */
  228.  
  229. /* Constants for the type of a section */
  230. #define    S_REGULAR        0x0    /* regular section */
  231. #define    S_ZEROFILL        0x1    /* zero fill on demand section */
  232. #define    S_CSTRING_LITERALS    0x2    /* section with only literal C strings*/
  233. #define    S_4BYTE_LITERALS    0x3    /* section with only 4 byte literals */
  234. #define    S_8BYTE_LITERALS    0x4    /* section with only 8 byte literals */
  235. #define    S_LITERAL_POINTERS    0x5    /* section with only pointers to */
  236.                     /*  literals */
  237. /*
  238.  * For the two types of symbol pointers sections and the symbol stubs section
  239.  * they have indirect symbol table entries.  For each of the entries in the
  240.  * section the indirect symbol table entries, in corresponding order in the
  241.  * indirect symbol table, start at the index stored in the reserved1 field
  242.  * of the section structure.  Since the indirect symbol table entries
  243.  * correspond to the entries in the section the number of indirect symbol table
  244.  * entries is inferred from the size of the section divided by the size of the
  245.  * entries in the section.  For symbol pointers sections the size of the entries
  246.  * in the section is 4 bytes and for symbol stubs sections the byte size of the
  247.  * stubs is stored in the reserved2 field of the section structure.
  248.  */
  249. #define    S_NON_LAZY_SYMBOL_POINTERS    0x6    /* section with only non-lazy
  250.                            symbol pointers */
  251. #define    S_LAZY_SYMBOL_POINTERS        0x7    /* section with only lazy symbol
  252.                            pointers */
  253. #define    S_SYMBOL_STUBS            0x8    /* section with only symbol
  254.                            stubs, byte size of stub in
  255.                            the reserved2 field */
  256. #define    S_MOD_INIT_FUNC_POINTERS    0x9    /* section with only function
  257.                            pointers for initialization*/
  258. /*
  259.  * Constants for the section attributes part of the flags field of a section
  260.  * structure.
  261.  */
  262. #define SECTION_ATTRIBUTES_USR     0xff000000    /* User setable attributes */
  263. #define S_ATTR_PURE_INSTRUCTIONS 0x80000000    /* section contains only true
  264.                            machine instructions */
  265. #define SECTION_ATTRIBUTES_SYS     0x00ffff00    /* system setable attributes */
  266. #define S_ATTR_SOME_INSTRUCTIONS 0x00000400    /* section contains some
  267.                            machine instructions */
  268. #define S_ATTR_EXT_RELOC     0x00000200    /* section has external
  269.                            relocation entries */
  270. #define S_ATTR_LOC_RELOC     0x00000100    /* section has local
  271.                            relocation entries */
  272.  
  273.  
  274. /*
  275.  * The names of segments and sections in them are mostly meaningless to the
  276.  * link-editor.  But there are few things to support traditional UNIX
  277.  * executables that require the link-editor and assembler to use some names
  278.  * agreed upon by convention.
  279.  *
  280.  * The initial protection of the "__TEXT" segment has write protection turned
  281.  * off (not writeable).
  282.  *
  283.  * The link-editor will allocate common symbols at the end of the "__common"
  284.  * section in the "__DATA" segment.  It will create the section and segment
  285.  * if needed.
  286.  */
  287.  
  288. /* The currently known segment names and the section names in those segments */
  289.  
  290. #define    SEG_PAGEZERO    "__PAGEZERO"    /* the pagezero segment which has no */
  291.                     /* protections and catches NULL */
  292.                     /* references for MH_EXECUTE files */
  293.  
  294.  
  295. #define    SEG_TEXT    "__TEXT"    /* the tradition UNIX text segment */
  296. #define    SECT_TEXT    "__text"    /* the real text part of the text */
  297.                     /* section no headers, and no padding */
  298. #define SECT_FVMLIB_INIT0 "__fvmlib_init0"    /* the fvmlib initialization */
  299.                         /*  section */
  300. #define SECT_FVMLIB_INIT1 "__fvmlib_init1"    /* the section following the */
  301.                             /*  fvmlib initialization */
  302.                         /*  section */
  303.  
  304. #define    SEG_DATA    "__DATA"    /* the tradition UNIX data segment */
  305. #define    SECT_DATA    "__data"    /* the real initialized data section */
  306.                     /* no padding, no bss overlap */
  307. #define    SECT_BSS    "__bss"        /* the real uninitialized data section*/
  308.                     /* no padding */
  309. #define SECT_COMMON    "__common"    /* the section common symbols are */
  310.                     /* allocated in by the link editor */
  311.  
  312. #define    SEG_OBJC    "__OBJC"    /* objective-C runtime segment */
  313. #define SECT_OBJC_SYMBOLS "__symbol_table"    /* symbol table */
  314. #define SECT_OBJC_MODULES "__module_info"    /* module information */
  315. #define SECT_OBJC_STRINGS "__selector_strs"    /* string table */
  316. #define SECT_OBJC_REFS "__selector_refs"    /* string table */
  317.  
  318. #define    SEG_ICON     "__ICON"    /* the NeXT icon segment */
  319. #define    SECT_ICON_HEADER "__header"    /* the icon headers */
  320. #define    SECT_ICON_TIFF   "__tiff"    /* the icons in tiff format */
  321.  
  322. #define    SEG_LINKEDIT    "__LINKEDIT"    /* the segment containing all structs */
  323.                     /* created and maintained by the link */
  324.                     /* editor.  Created with -seglinkedit */
  325.                     /* option to ld(1) for MH_EXECUTE and */
  326.                     /* FVMLIB file types only */
  327. /*
  328.  * Fixed virtual memory shared libraries are identified by two things.  The
  329.  * target pathname (the name of the library as found for execution), and the
  330.  * minor version number.  The address of where the headers are loaded is in
  331.  * header_addr.
  332.  */
  333. struct fvmlib {
  334.     union lc_str    name;        /* library's target pathname */
  335.     unsigned long    minor_version;    /* library's minor version number */
  336.     unsigned long    header_addr;    /* library's header address */
  337. };
  338.  
  339. /*
  340.  * A fixed virtual shared library (filetype == MH_FVMLIB in the mach header)
  341.  * contains a fvmlib_command (cmd == LC_IDFVMLIB) to identify the library.
  342.  * An object that uses a fixed virtual shared library also contains a
  343.  * fvmlib_command (cmd == LC_LOADFVMLIB) for each library it uses.
  344.  */
  345. struct fvmlib_command {
  346.     unsigned long    cmd;        /* LC_IDFVMLIB or LC_LOADFVMLIB */
  347.     unsigned long    cmdsize;    /* includes pathname string */
  348.     struct fvmlib    fvmlib;        /* the library identification */
  349. };
  350.  
  351. /*
  352.  * Dynamicly linked shared libraries are identified by two things.  The
  353.  * pathname (the name of the library as found for execution), and the
  354.  * compatibility version number.  The pathname must match and the compatibility
  355.  * number in the user of the library must be greater than or equal to the
  356.  * library being used.  The time stamp is used to record the time a library was
  357.  * built and copied into user so it can be use to determined if the library used
  358.  * at runtime is exactly the same as used to built the program.
  359.  */
  360. struct dylib {
  361.     union lc_str  name;            /* library's path name */
  362.     unsigned long timestamp;        /* library's build time stamp */
  363.     unsigned long current_version;    /* library's current version number */
  364.     unsigned long compatibility_version;/* library's compatibility vers number*/
  365. };
  366.  
  367. /*
  368.  * A dynamicly linked shared library (filetype == MH_DYLIB in the mach header)
  369.  * contains a dylib_command (cmd == LC_ID_DYLIB) to identify the library.
  370.  * An object that uses a dynamicly linked shared library also contains a
  371.  * dylib_command (cmd == LC_LOAD_DYLIB) for each library it uses.
  372.  */
  373. struct dylib_command {
  374.     unsigned long    cmd;        /* LC_ID_DYLIB or LC_LOAD_DYLIB */
  375.     unsigned long    cmdsize;    /* includes pathname string */
  376.     struct dylib    dylib;        /* the library identification */
  377. };
  378.  
  379. /*
  380.  * A program (filetype == MH_EXECUTE) or bundle (filetype == MH_BUNDLE) that is
  381.  * prebound to it's dynamic libraries has one of these for each library that
  382.  * the static linker used in prebinding.  It contains a bit vector for the
  383.  * modules in the library.  The bits indicate which modules are bound (1) and
  384.  * which are not (0) from the library.  The bit for module 0 is the low bit
  385.  * of the first byte.  So the bit for the Nth module is:
  386.  * (linked_modules[N/8] >> N%8) & 1
  387.  */
  388. struct prebound_dylib_command {
  389.     unsigned long    cmd;        /* LC_PREBOUND_DYLIB */
  390.     unsigned long    cmdsize;    /* includes strings */
  391.     union lc_str    name;        /* library's path name */
  392.     unsigned long    nmodules;    /* number of modules in library */
  393.     union lc_str    linked_modules;    /* bit vector of linked modules */
  394. };
  395.  
  396. /*
  397.  * A program that uses a dynamic linker contains a dylinker_command to identify
  398.  * the name of the dynamic linker (LC_LOAD_DYLINKER).  And a dynamic linker
  399.  * contains a dylinker_command to identify the dynamic linker (LC_ID_DYLINKER).
  400.  * A file can have at most one of these.
  401.  */
  402. struct dylinker_command {
  403.     unsigned long    cmd;        /* LC_ID_DYLINKER or LC_LOAD_DYLINKER */
  404.     unsigned long    cmdsize;    /* includes pathname string */
  405.     union lc_str    name;        /* dynamic linker's path name */
  406. };
  407.  
  408. /*
  409.  * Thread commands contain machine-specific data structures suitable for
  410.  * use in the thread state primitives.  The machine specific data structures
  411.  * follow the struct thread_command as follows.
  412.  * Each flavor of machine specific data structure is preceded by an unsigned
  413.  * long constant for the flavor of that data structure, an unsigned long
  414.  * that is the count of longs of the size of the state data structure and then
  415.  * the state data structure follows.  This triple may be repeated for many
  416.  * flavors.  The constants for the flavors, counts and state data structure
  417.  * definitions are expected to be in the header file <machine/thread_status.h>.
  418.  * These machine specific data structures sizes must be multiples of
  419.  * sizeof(long).  The cmdsize reflects the total size of the thread_command
  420.  * and all of the sizes of the constants for the flavors, counts and state
  421.  * data structures.
  422.  *
  423.  * For executable objects that are unix processes there will be one
  424.  * thread_command (cmd == LC_UNIXTHREAD) created for it by the link-editor.
  425.  * This is the same as a LC_THREAD, except that a stack is automatically
  426.  * created (based on the shell's limit for the stack size).  Command arguments
  427.  * and environment variables are copied onto that stack.
  428.  */
  429. struct thread_command {
  430.     unsigned long    cmd;        /* LC_THREAD or  LC_UNIXTHREAD */
  431.     unsigned long    cmdsize;    /* total size of this command */
  432.     /* unsigned long flavor           flavor of thread state */
  433.     /* unsigned long count           count of longs in thread state */
  434.     /* struct XXX_thread_state state   thread state for this flavor */
  435.     /* ... */
  436. };
  437.  
  438. /*
  439.  * The symtab_command contains the offsets and sizes of the link-edit 4.3BSD
  440.  * "stab" style symbol table information as described in the header files
  441.  * <nlist.h> and <stab.h>.
  442.  */
  443. struct symtab_command {
  444.     unsigned long    cmd;        /* LC_SYMTAB */
  445.     unsigned long    cmdsize;    /* sizeof(struct symtab_command) */
  446.     unsigned long    symoff;        /* symbol table offset */
  447.     unsigned long    nsyms;        /* number of symbol table entries */
  448.     unsigned long    stroff;        /* string table offset */
  449.     unsigned long    strsize;    /* string table size in bytes */
  450. };
  451.  
  452. /*
  453.  * This is the second set of the symbolic information which is used to support
  454.  * the data structures for the dynamicly link editor.
  455.  *
  456.  * The original set of symbolic information in the symtab_command which contains
  457.  * the symbol and string tables must also be present when this load command is
  458.  * present.  When this load command is present the symbol table is organized
  459.  * into three groups of symbols:
  460.  *    local symbols (static and debugging symbols) - grouped by module
  461.  *    defined external symbols - grouped by module (sorted by name if not lib)
  462.  *    undefined external symbols (sorted by name)
  463.  * In this load command there are offsets and counts to each of the three groups
  464.  * of symbols.
  465.  *
  466.  * This load command contains a the offsets and sizes of the following new
  467.  * symbolic information tables:
  468.  *    table of contents
  469.  *    module table
  470.  *    reference symbol table
  471.  *    indirect symbol table
  472.  * The first three tables above (the table of contents, module table and
  473.  * reference symbol table) are only present if the file is a dynamicly linked
  474.  * shared library.  For executable and object modules, which are files
  475.  * containing only one module, the information that would be in these three
  476.  * tables is determined as follows:
  477.  *     table of contents - the defined external symbols are sorted by name
  478.  *    module table - the file contains only one module so everything in the
  479.  *               file is part of the module.
  480.  *    reference symbol table - is the defined and undefined external symbols
  481.  *
  482.  * For dynamicly linked shared library files this load command also contains
  483.  * offsets and sizes to the pool of relocation entries for all sections
  484.  * separated into two groups:
  485.  *    external relocation entries
  486.  *    local relocation entries
  487.  * For executable and object modules the relocation entries continue to hang
  488.  * off the section structures.
  489.  */
  490. struct dysymtab_command {
  491.     unsigned long cmd;        /* LC_DYSYMTAB */
  492.     unsigned long cmdsize;    /* sizeof(struct dysymtab_command) */
  493.  
  494.     /*
  495.      * The symbols indicated by symoff and nsyms of the LC_SYMTAB load command
  496.      * are grouped into the following three groups:
  497.      *    local symbols (further grouped by the module they are from)
  498.      *    defined external symbols (further grouped by the module they are from)
  499.      *    undefined symbols
  500.      *
  501.      * The local symbols are used only for debugging.  The dynamic binding
  502.      * process may have to use them to indicate to the debugger the local
  503.      * symbols for a module that is being bound.
  504.      *
  505.      * The last two groups are used by the dynamic binding process to do the
  506.      * binding (indirectly through the module table and the reference symbol
  507.      * table when this is a dynamicly linked shared library file).
  508.      */
  509.     unsigned long ilocalsym;    /* index to local symbols */
  510.     unsigned long nlocalsym;    /* number of local symbols */
  511.  
  512.     unsigned long iextdefsym;    /* index to externally defined symbols */
  513.     unsigned long nextdefsym;    /* number of externally defined symbols */
  514.  
  515.     unsigned long iundefsym;    /* index to undefined symbols */
  516.     unsigned long nundefsym;    /* number of undefined symbols */
  517.  
  518.     /*
  519.      * For the for the dynamic binding process to find which module a symbol
  520.      * is defined in the table of contents is used (analogous to the ranlib
  521.      * structure in an archive) which maps defined external symbols to modules
  522.      * they are defined in.  This exists only in a dynamicly linked shared
  523.      * library file.  For executable and object modules the defined external
  524.      * symbols are sorted by name and is use as the table of contents.
  525.      */
  526.     unsigned long tocoff;    /* file offset to table of contents */
  527.     unsigned long ntoc;        /* number of entries in table of contents */
  528.  
  529.     /*
  530.      * To support dynamic binding of "modules" (whole object files) the symbol
  531.      * table must reflect the modules that the file was created from.  This is
  532.      * done by having a module table that has indexes and counts into the merged
  533.      * tables for each module.  The module structure that these two entries
  534.      * refer to is described below.  This exists only in a dynamicly linked
  535.      * shared library file.  For executable and object modules the file only
  536.      * contains one module so everything in the file belongs to the module.
  537.      */
  538.     unsigned long modtaboff;    /* file offset to module table */
  539.     unsigned long nmodtab;    /* number of module table entries */
  540.  
  541.     /*
  542.      * To support dynamic module binding the module structure for each module
  543.      * indicates the external references (defined and undefined) each module
  544.      * makes.  For each module there is an offset and a count into the
  545.      * reference symbol table for the symbols that the module references.
  546.      * This exists only in a dynamicly linked shared library file.  For
  547.      * executable and object modules the defined external symbols and the
  548.      * undefined external symbols indicates the external references.
  549.      */
  550.     unsigned long extrefsymoff;  /* offset to referenced symbol table */
  551.     unsigned long nextrefsyms;     /* number of referenced symbol table entries */
  552.  
  553.     /*
  554.      * The sections that contain "symbol pointers" and "routine stubs" have
  555.      * indexes and (implied counts based on the size of the section and fixed
  556.      * size of the entry) into the "indirect symbol" table for each pointer
  557.      * and stub.  For every section of these two types the index into the
  558.      * indirect symbol table is stored in the section header in the field
  559.      * reserved1.  An indirect symbol table entry is simply a 32bit index into
  560.      * the symbol table to the symbol that the pointer or stub is referring to.
  561.      * The indirect symbol table is ordered to match the entries in the section.
  562.      */
  563.     unsigned long indirectsymoff; /* file offset to the indirect symbol table */
  564.     unsigned long nindirectsyms;  /* number of indirect symbol table entries */
  565.  
  566.     /*
  567.      * To support relocating an individual module in a library file quickly the
  568.      * external relocation entries for each module in the library need to be
  569.      * accessed efficiently.  Since the relocation entries can't be accessed
  570.      * through the section headers for a library file they are separated into
  571.      * groups of local and external entries further grouped by module.  In this
  572.      * case the presents of this load command who's extreloff, nextrel,
  573.      * locreloff and nlocrel fields are non-zero indicates that the relocation
  574.      * entries of non-merged sections are not referenced through the section
  575.      * structures (and the reloff and nreloc fields in the section headers are
  576.      * set to zero).
  577.      *
  578.      * Since the relocation entries are not accessed through the section headers
  579.      * this requires the r_address field to be something other than a section
  580.      * offset to identify the item to be relocated.  In this case r_address is
  581.      * set to the offset from the vmaddr of the first LC_SEGMENT command.
  582.      *
  583.      * The relocation entries are grouped by module and the module table
  584.      * entries have indexes and counts into them for the group of external
  585.      * relocation entries for that the module.
  586.      *
  587.      * For sections that are merged across modules there must not be any
  588.      * remaining external relocation entries for them (for merged sections
  589.      * remaining relocation entries must be local).
  590.      */
  591.     unsigned long extreloff;    /* offset to external relocation entries */
  592.     unsigned long nextrel;    /* number of external relocation entries */
  593.  
  594.     /*
  595.      * All the local relocation entries are grouped together (they are not
  596.      * grouped by their module since they are only used if the object is moved
  597.      * from it staticly link edited address).
  598.      */
  599.     unsigned long locreloff;    /* offset to local relocation entries */
  600.     unsigned long nlocrel;    /* number of local relocation entries */
  601.  
  602. };    
  603.  
  604. /*
  605.  * An indirect symbol table entry is simply a 32bit index into the symbol table 
  606.  * to the symbol that the pointer or stub is refering to.  Unless it is for a
  607.  * non-lazy symbol pointer section for a defined symbol which strip(1) as 
  608.  * removed.  In which case it has the value INDIRECT_SYMBOL_LOCAL.  If the
  609.  * symbol was also absolute INDIRECT_SYMBOL_ABS is or'ed with that.
  610.  */
  611. #define INDIRECT_SYMBOL_LOCAL    0x80000000
  612. #define INDIRECT_SYMBOL_ABS    0x40000000
  613.  
  614.  
  615. /* a table of contents entry */
  616. struct dylib_table_of_contents {
  617.     unsigned long symbol_index;    /* the defined external symbol
  618.                    (index into the symbol table) */
  619.     unsigned long module_index;    /* index into the module table this symbol
  620.                    is defined in */
  621. };    
  622.  
  623. /* a module table entry */
  624. struct dylib_module {
  625.     unsigned long module_name;    /* the module name (index into string table) */
  626.  
  627.     unsigned long iextdefsym;    /* index into externally defined symbols */
  628.     unsigned long nextdefsym;    /* number of externally defined symbols */
  629.     unsigned long irefsym;        /* index into reference symbol table */
  630.     unsigned long nrefsym;    /* number of reference symbol table entries */
  631.     unsigned long ilocalsym;    /* index into symbols for local symbols */
  632.     unsigned long nlocalsym;    /* number of local symbols */
  633.  
  634.     unsigned long iextrel;    /* index into external relocation entries */
  635.     unsigned long nextrel;    /* number of external relocation entries */
  636.  
  637.     unsigned long iinit;    /* index into the init section */
  638.     unsigned long ninit;    /* number of init section entries */
  639.  
  640.     unsigned long        /* for this module address of the start of */
  641.     objc_module_info_addr;  /*  the (__OBJC,__module_info) section */
  642.     unsigned long        /* for this module address of the size of */
  643.     objc_module_info_size;    /*  the (__OBJC,__module_info) section */
  644. };    
  645.  
  646. /* 
  647.  * The entries in the reference symbol table are used when loading the module
  648.  * (both by the static and dynamic link editors) and if the module is unloaded
  649.  * or replaced.  Therefore all external symbols (defined and undefined) are
  650.  * listed in the module's reference table.  The flags describe the type of
  651.  * reference that is being made.  The constants for the flags are defined in
  652.  * <mach-o/nlist.h> as they are also used for symbol table entries.
  653.  */
  654. struct dylib_reference {
  655.     unsigned long isym:24,    /* index into the symbol table */
  656.               flags:8;    /* flags to indicate the type of reference */
  657. };
  658.  
  659. /*
  660.  * The symseg_command contains the offset and size of the GNU style
  661.  * symbol table information as described in the header file <symseg.h>.
  662.  * The symbol roots of the symbol segments must also be aligned properly
  663.  * in the file.  So the requirement of keeping the offsets aligned to a
  664.  * multiple of a sizeof(long) translates to the length field of the symbol
  665.  * roots also being a multiple of a long.  Also the padding must again be
  666.  * zeroed. (THIS IS OBSOLETE and no longer supported).
  667.  */
  668. struct symseg_command {
  669.     unsigned long    cmd;        /* LC_SYMSEG */
  670.     unsigned long    cmdsize;    /* sizeof(struct symseg_command) */
  671.     unsigned long    offset;        /* symbol segment offset */
  672.     unsigned long    size;        /* symbol segment size in bytes */
  673. };
  674.  
  675. /*
  676.  * The ident_command contains a free format string table following the
  677.  * ident_command structure.  The strings are null terminated and the size of
  678.  * the command is padded out with zero bytes to a multiple of sizeof(long).
  679.  * (THIS IS OBSOLETE and no longer supported).
  680.  */
  681. struct ident_command {
  682.     unsigned long cmd;        /* LC_IDENT */
  683.     unsigned long cmdsize;        /* strings that follow this command */
  684. };
  685.  
  686. /*
  687.  * The fvmfile_command contains a reference to a file to be loaded at the
  688.  * specified virtual address.  (Presently, this command is reserved for NeXT
  689.  * internal use.  The kernel ignores this command when loading a program into
  690.  * memory).
  691.  */
  692. struct fvmfile_command {
  693.     unsigned long cmd;        /* LC_FVMFILE */
  694.     unsigned long cmdsize;        /* includes pathname string */
  695.     union lc_str    name;        /* files pathname */
  696.     unsigned long    header_addr;    /* files virtual address */
  697. };
  698.  
  699. #endif _MACHO_LOADER_H_
  700.