rename StgSync to SpinLock
[ghc-hetmet.git] / rts / LinkerInternals.h
1 /* -----------------------------------------------------------------------------
2  *
3  * (c) The GHC Team, 2000
4  *
5  * RTS Object Linker
6  *
7  * ---------------------------------------------------------------------------*/
8
9 #ifndef LINKERINTERNALS_H
10 #define LINKERINTERNALS_H
11
12 typedef enum { OBJECT_LOADED, OBJECT_RESOLVED } OStatus;
13
14 /* Indication of section kinds for loaded objects.  Needed by
15    the GC for deciding whether or not a pointer on the stack
16    is a code pointer.
17 */
18 typedef 
19    enum { SECTIONKIND_CODE_OR_RODATA,
20           SECTIONKIND_RWDATA,
21           SECTIONKIND_OTHER,
22           SECTIONKIND_NOINFOAVAIL } 
23    SectionKind;
24
25 typedef 
26    struct _Section { 
27       void* start; 
28       void* end; 
29       SectionKind kind;
30       struct _Section* next;
31    } 
32    Section;
33
34 typedef 
35    struct _ProddableBlock {
36       void* start;
37       int   size;
38       struct _ProddableBlock* next;
39    }
40    ProddableBlock;
41
42 /* Jump Islands are sniplets of machine code required for relative
43  * address relocations on the PowerPC.
44  */
45 typedef struct {
46 #ifdef powerpc_HOST_ARCH
47     struct {
48         short lis_r12, hi_addr;
49         short ori_r12_r12, lo_addr;
50         long mtctr_r12;
51         long bctr;
52     } jumpIsland;
53 #elif x86_64_TARGET_ARCH
54     uint64_t    addr;
55     uint8_t     jumpIsland[6];
56 #endif
57 } SymbolExtra;
58
59 /* Top-level structure for an object module.  One of these is allocated
60  * for each object file in use.
61  */
62 typedef struct _ObjectCode {
63     OStatus    status;
64     char*      fileName;
65     int        fileSize;
66     char*      formatName;            /* eg "ELF32", "DLL", "COFF", etc. */
67
68     /* An array containing ptrs to all the symbol names copied from
69        this object into the global symbol hash table.  This is so that
70        we know which parts of the latter mapping to nuke when this
71        object is removed from the system. */
72     char**     symbols;
73     int        n_symbols;
74
75     /* ptr to malloc'd lump of memory holding the obj file */
76     char*      image;
77
78 #ifdef darwin_HOST_OS
79     /* record by how much image has been deliberately misaligned
80        after allocation, so that we can use realloc */
81     int        misalignment;
82 #endif
83
84     /* The section-kind entries for this object module.  Linked
85        list. */
86     Section* sections;
87
88     /* A private hash table for local symbols. */
89     HashTable* lochash;
90     
91     /* Allow a chain of these things */
92     struct _ObjectCode * next;
93
94     /* SANITY CHECK ONLY: a list of the only memory regions which may
95        safely be prodded during relocation.  Any attempt to prod
96        outside one of these is an error in the linker. */
97     ProddableBlock* proddables;
98
99 #ifdef ia64_HOST_ARCH
100     /* Procedure Linkage Table for this object */
101     void *plt;
102     unsigned int pltIndex;
103 #endif
104
105 #if powerpc_HOST_ARCH || x86_64_HOST_ARCH
106     SymbolExtra    *symbol_extras;
107     unsigned long   first_symbol_extra;
108     unsigned long   n_symbol_extras;
109 #endif
110
111 } ObjectCode;
112
113 extern ObjectCode *objects;
114
115 #endif /* LINKERINTERNALS_H */