Linker.c 121 KB
Newer Older
1
2
/* -----------------------------------------------------------------------------
 *
3
 * (c) The GHC Team, 2000-2004
4
5
6
7
8
 *
 * RTS Object Linker
 *
 * ---------------------------------------------------------------------------*/

sof's avatar
sof committed
9
#if 0
10
#include "PosixSource.h"
sof's avatar
sof committed
11
#endif
12

13
14
15
/* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and 
   MREMAP_MAYMOVE from <sys/mman.h>.
 */
16
17
18
19
#ifdef __linux__
#define _GNU_SOURCE
#endif

20
21
22
23
24
#include "Rts.h"
#include "RtsFlags.h"
#include "HsFFI.h"
#include "Hash.h"
#include "Linker.h"
25
#include "LinkerInternals.h"
26
#include "RtsUtils.h"
27
#include "Schedule.h"
28
#include "Storage.h"
29

30
#ifdef HAVE_SYS_TYPES_H
31
#include <sys/types.h>
32
33
#endif

34
35
36
#include <stdlib.h>
#include <string.h>

37
#ifdef HAVE_SYS_STAT_H
38
#include <sys/stat.h>
39
#endif
40

41
#if defined(HAVE_DLFCN_H)
42
#include <dlfcn.h>
43
#endif
44

45
#if defined(cygwin32_HOST_OS)
sof's avatar
sof committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#ifdef HAVE_DIRENT_H
#include <dirent.h>
#endif

#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#include <regex.h>
#include <sys/fcntl.h>
#include <sys/termios.h>
#include <sys/utime.h>
#include <sys/utsname.h>
#include <sys/wait.h>
#endif

61
#if defined(ia64_HOST_ARCH) || defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
62
63
64
#define USE_MMAP
#include <fcntl.h>
#include <sys/mman.h>
dons's avatar
dons committed
65

66
#if defined(openbsd_HOST_OS) || defined(linux_HOST_OS) || defined(freebsd_HOST_OS)
dons's avatar
dons committed
67
68
69
70
71
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#endif

72
73
#endif

74
#if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
75
#  define OBJFORMAT_ELF
76
#elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
77
#  define OBJFORMAT_PEi386
78
#  include <windows.h>
sof's avatar
sof committed
79
#  include <math.h>
80
#elif defined(darwin_HOST_OS)
81
#  include <mach-o/ppc/reloc.h>
82
83
84
85
#  define OBJFORMAT_MACHO
#  include <mach-o/loader.h>
#  include <mach-o/nlist.h>
#  include <mach-o/reloc.h>
86
#  include <mach-o/dyld.h>
87
88
#endif

89
/* Hash table mapping symbol names to Symbol */
90
static /*Str*/HashTable *symhash;
91

92
93
94
/* List of currently loaded objects */
ObjectCode *objects = NULL;	/* initially empty */

95
#if defined(OBJFORMAT_ELF)
96
97
98
static int ocVerifyImage_ELF    ( ObjectCode* oc );
static int ocGetNames_ELF       ( ObjectCode* oc );
static int ocResolve_ELF        ( ObjectCode* oc );
99
#if defined(powerpc_HOST_ARCH)
100
101
static int ocAllocateJumpIslands_ELF ( ObjectCode* oc );
#endif
102
#elif defined(OBJFORMAT_PEi386)
103
104
105
static int ocVerifyImage_PEi386 ( ObjectCode* oc );
static int ocGetNames_PEi386    ( ObjectCode* oc );
static int ocResolve_PEi386     ( ObjectCode* oc );
106
#elif defined(OBJFORMAT_MACHO)
107
static int ocAllocateJumpIslands_MachO ( ObjectCode* oc );
108
109
110
static int ocVerifyImage_MachO    ( ObjectCode* oc );
static int ocGetNames_MachO       ( ObjectCode* oc );
static int ocResolve_MachO        ( ObjectCode* oc );
111

112
static void machoInitSymbolsWithoutUnderscore( void );
113
114
115
116
117
118
#endif

/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

119
120
121
122
123
124
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;


125
126
127
128
129
130
131
132
133
134
135
#if !defined(PAR)
#define Maybe_ForeignObj        SymX(mkForeignObjzh_fast)

#define Maybe_Stable_Names      SymX(mkWeakzh_fast)			\
      				SymX(makeStableNamezh_fast)		\
      				SymX(finalizzeWeakzh_fast)
#else
/* These are not available in GUM!!! -- HWL */
#define Maybe_ForeignObj
#define Maybe_Stable_Names
#endif
136

137
#if !defined (mingw32_HOST_OS)
138
#define RTS_POSIX_ONLY_SYMBOLS                  \
139
140
      SymX(stg_sig_install)			\
      Sym(nocldstop)
sof's avatar
sof committed
141
#endif
142

143
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
144
145
146
#define RTS_MINGW_ONLY_SYMBOLS /**/
/* Don't have the ability to read import libs / archives, so
 * we have to stupidly list a lot of what libcygwin.a
147
 * exports; sigh.
sof's avatar
sof committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 */
#define RTS_CYGWIN_ONLY_SYMBOLS                 \
      SymX(regfree)                             \
      SymX(regexec)                             \
      SymX(regerror)                            \
      SymX(regcomp)                             \
      SymX(__errno)                             \
      SymX(access)                              \
      SymX(chmod)                               \
      SymX(chdir)                               \
      SymX(close)                               \
      SymX(creat)                               \
      SymX(dup)                                 \
      SymX(dup2)                                \
      SymX(fstat)                               \
      SymX(fcntl)                               \
      SymX(getcwd)                              \
      SymX(getenv)                              \
      SymX(lseek)                               \
      SymX(open)                                \
      SymX(fpathconf)                           \
      SymX(pathconf)                            \
      SymX(stat)                                \
      SymX(pow)                                 \
      SymX(tanh)                                \
      SymX(cosh)                                \
      SymX(sinh)                                \
      SymX(atan)                                \
      SymX(acos)                                \
      SymX(asin)                                \
      SymX(tan)                                 \
      SymX(cos)                                 \
      SymX(sin)                                 \
      SymX(exp)                                 \
      SymX(log)                                 \
      SymX(sqrt)                                \
      SymX(localtime_r)                         \
      SymX(gmtime_r)                            \
      SymX(mktime)                              \
      Sym(_imp___tzname)                        \
      SymX(gettimeofday)                        \
      SymX(timezone)                            \
      SymX(tcgetattr)                           \
      SymX(tcsetattr)                           \
      SymX(memcpy)                              \
      SymX(memmove)                             \
      SymX(realloc)                             \
      SymX(malloc)                              \
      SymX(free)                                \
      SymX(fork)                                \
      SymX(lstat)                               \
      SymX(isatty)                              \
      SymX(mkdir)                               \
      SymX(opendir)                             \
      SymX(readdir)                             \
      SymX(rewinddir)                           \
      SymX(closedir)                            \
      SymX(link)                                \
      SymX(mkfifo)                              \
      SymX(pipe)                                \
      SymX(read)                                \
      SymX(rename)                              \
      SymX(rmdir)                               \
      SymX(select)                              \
      SymX(system)                              \
      SymX(write)                               \
      SymX(strcmp)                              \
      SymX(strcpy)                              \
      SymX(strncpy)                             \
      SymX(strerror)                            \
      SymX(sigaddset)                           \
      SymX(sigemptyset)                         \
      SymX(sigprocmask)                         \
      SymX(umask)                               \
      SymX(uname)                               \
      SymX(unlink)                              \
      SymX(utime)                               \
225
      SymX(waitpid)
226

227
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
228
229
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
230
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
231
232
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
233

234
235
236
237
/* Extra syms gen'ed by mingw-2's gcc-3.2: */
#if __GNUC__>=3
#define RTS_MINGW_EXTRA_SYMS                    \
      Sym(_imp____mb_cur_max)                   \
238
      Sym(_imp___pctype)
239
240
241
242
#else
#define RTS_MINGW_EXTRA_SYMS
#endif

243
244
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
245
#define RTS_MINGW_ONLY_SYMBOLS                  \
sof's avatar
sof committed
246
247
      SymX(asyncReadzh_fast)			\
      SymX(asyncWritezh_fast)			\
sof's avatar
sof committed
248
      SymX(asyncDoProczh_fast)			\
249
      SymX(memset)                              \
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
      SymX(inet_ntoa)                           \
      SymX(inet_addr)                           \
      SymX(htonl)                               \
      SymX(recvfrom)                            \
      SymX(listen)                              \
      SymX(bind)                                \
      SymX(shutdown)                            \
      SymX(connect)                             \
      SymX(htons)                               \
      SymX(ntohs)                               \
      SymX(getservbyname)                       \
      SymX(getservbyport)                       \
      SymX(getprotobynumber)                    \
      SymX(getprotobyname)                      \
      SymX(gethostbyname)                       \
      SymX(gethostbyaddr)                       \
      SymX(gethostname)                         \
      SymX(strcpy)                              \
      SymX(strncpy)                             \
      SymX(abort)                               \
      Sym(_alloca)                              \
      Sym(isxdigit)                             \
      Sym(isupper)                              \
      Sym(ispunct)                              \
      Sym(islower)                              \
      Sym(isspace)                              \
      Sym(isprint)                              \
      Sym(isdigit)                              \
      Sym(iscntrl)                              \
      Sym(isalpha)                              \
      Sym(isalnum)                              \
      SymX(strcmp)                              \
282
283
284
      SymX(memmove)                             \
      SymX(realloc)                             \
      SymX(malloc)                              \
285
286
287
288
289
290
291
292
293
294
295
296
297
298
      SymX(pow)                                 \
      SymX(tanh)                                \
      SymX(cosh)                                \
      SymX(sinh)                                \
      SymX(atan)                                \
      SymX(acos)                                \
      SymX(asin)                                \
      SymX(tan)                                 \
      SymX(cos)                                 \
      SymX(sin)                                 \
      SymX(exp)                                 \
      SymX(log)                                 \
      SymX(sqrt)                                \
      SymX(memcpy)                              \
299
      SymX(stg_InstallConsoleEvent)             \
300
      Sym(mktime)                               \
301
      Sym(_imp___timezone)                      \
302
      Sym(_imp___tzname)                        \
303
      Sym(_imp___iob)                           \
sof's avatar
sof committed
304
      Sym(_imp___osver)                         \
305
306
307
308
      Sym(localtime)                            \
      Sym(gmtime)                               \
      Sym(opendir)                              \
      Sym(readdir)                              \
sof's avatar
sof committed
309
      Sym(rewinddir)                            \
310
      RTS_MINGW_EXTRA_SYMS                      \
311
      Sym(closedir)
312
#endif
313

sof's avatar
sof committed
314
315
316
317
318
#ifndef SMP
# define MAIN_CAP_SYM SymX(MainCapability)
#else
# define MAIN_CAP_SYM
#endif
319

320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
#ifdef TABLES_NEXT_TO_CODE
#define RTS_RET_SYMBOLS /* nothing */
#else
#define RTS_RET_SYMBOLS 			\
      SymX(stg_enter_ret)			\
      SymX(stg_gc_fun_ret)			\
      SymX(stg_ap_0_ret)			\
      SymX(stg_ap_v_ret)			\
      SymX(stg_ap_f_ret)			\
      SymX(stg_ap_d_ret)			\
      SymX(stg_ap_l_ret)			\
      SymX(stg_ap_n_ret)			\
      SymX(stg_ap_p_ret)			\
      SymX(stg_ap_pv_ret)			\
      SymX(stg_ap_pp_ret)			\
      SymX(stg_ap_ppv_ret)			\
      SymX(stg_ap_ppp_ret)			\
      SymX(stg_ap_pppv_ret)			\
      SymX(stg_ap_pppp_ret)			\
      SymX(stg_ap_ppppp_ret)			\
      SymX(stg_ap_pppppp_ret)
#endif

343
#define RTS_SYMBOLS				\
344
345
346
      Maybe_ForeignObj				\
      Maybe_Stable_Names			\
      Sym(StgReturn)				\
347
348
      SymX(stg_enter_info)			\
      SymX(stg_gc_void_info)			\
349
350
      SymX(__stg_gc_enter_1)			\
      SymX(stg_gc_noregs)			\
351
      SymX(stg_gc_unpt_r1_info)			\
352
      SymX(stg_gc_unpt_r1)			\
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
      SymX(stg_gc_unbx_r1_info)			\
      SymX(stg_gc_unbx_r1)			\
      SymX(stg_gc_f1_info)			\
      SymX(stg_gc_f1)				\
      SymX(stg_gc_d1_info)			\
      SymX(stg_gc_d1)				\
      SymX(stg_gc_l1_info)			\
      SymX(stg_gc_l1)				\
      SymX(__stg_gc_fun)			\
      SymX(stg_gc_fun_info)			\
      SymX(stg_gc_gen)				\
      SymX(stg_gc_gen_info)			\
      SymX(stg_gc_gen_hp)			\
      SymX(stg_gc_ut)				\
      SymX(stg_gen_yield)			\
      SymX(stg_yield_noregs)			\
369
      SymX(stg_yield_to_interpreter)		\
370
371
372
373
374
375
      SymX(stg_gen_block)			\
      SymX(stg_block_noregs)			\
      SymX(stg_block_1)				\
      SymX(stg_block_takemvar)			\
      SymX(stg_block_putmvar)			\
      SymX(stg_seq_frame_info)			\
sof's avatar
sof committed
376
      MAIN_CAP_SYM                              \
377
378
379
380
381
382
      SymX(MallocFailHook)			\
      SymX(OnExitHook)				\
      SymX(OutOfHeapHook)			\
      SymX(StackOverflowHook)			\
      SymX(__encodeDouble)			\
      SymX(__encodeFloat)			\
dons's avatar
dons committed
383
      SymX(addDLL)               		\
384
385
386
387
388
389
390
391
392
      SymX(__gmpn_gcd_1)			\
      SymX(__gmpz_cmp)				\
      SymX(__gmpz_cmp_si)			\
      SymX(__gmpz_cmp_ui)			\
      SymX(__gmpz_get_si)			\
      SymX(__gmpz_get_ui)			\
      SymX(__int_encodeDouble)			\
      SymX(__int_encodeFloat)			\
      SymX(andIntegerzh_fast)			\
393
      SymX(atomicallyzh_fast)			\
394
      SymX(barf)				\
395
396
      SymX(debugBelch)				\
      SymX(errorBelch)				\
397
398
      SymX(blockAsyncExceptionszh_fast)		\
      SymX(catchzh_fast)			\
399
400
      SymX(catchRetryzh_fast)			\
      SymX(catchSTMzh_fast)			\
sof's avatar
sof committed
401
      SymX(closure_flags)                       \
402
      SymX(cmp_thread)				\
sof's avatar
sof committed
403
404
      SymX(cmpIntegerzh_fast)	        	\
      SymX(cmpIntegerIntzh_fast)	      	\
sof's avatar
sof committed
405
      SymX(complementIntegerzh_fast)		\
406
407
408
409
410
      SymX(createAdjustor)			\
      SymX(decodeDoublezh_fast)			\
      SymX(decodeFloatzh_fast)			\
      SymX(defaultsHook)			\
      SymX(delayzh_fast)			\
sof's avatar
sof committed
411
412
      SymX(deRefWeakzh_fast)			\
      SymX(deRefStablePtrzh_fast)		\
413
414
415
      SymX(divExactIntegerzh_fast)		\
      SymX(divModIntegerzh_fast)		\
      SymX(forkzh_fast)				\
416
      SymX(forkProcess)				\
417
      SymX(forkOS_createThread)			\
418
      SymX(freeHaskellFunctionPtr)		\
sof's avatar
sof committed
419
      SymX(freeStablePtr)		        \
420
      SymX(gcdIntegerzh_fast)			\
sof's avatar
sof committed
421
422
      SymX(gcdIntegerIntzh_fast)		\
      SymX(gcdIntzh_fast)			\
423
      SymX(genSymZh)				\
dons's avatar
dons committed
424
      SymX(genericRaise)			\
425
426
      SymX(getProgArgv)				\
      SymX(getStablePtr)			\
427
428
429
430
431
432
433
434
      SymX(hs_init)				\
      SymX(hs_exit)				\
      SymX(hs_set_argv)				\
      SymX(hs_add_root)				\
      SymX(hs_perform_gc)			\
      SymX(hs_free_stable_ptr)			\
      SymX(hs_free_fun_ptr)			\
      SymX(initLinker)				\
435
      SymX(int2Integerzh_fast)			\
sof's avatar
sof committed
436
437
      SymX(integer2Intzh_fast)			\
      SymX(integer2Wordzh_fast)			\
438
      SymX(isCurrentThreadBoundzh_fast)		\
439
440
441
442
      SymX(isDoubleDenormalized)		\
      SymX(isDoubleInfinite)			\
      SymX(isDoubleNaN)				\
      SymX(isDoubleNegativeZero)		\
sof's avatar
sof committed
443
      SymX(isEmptyMVarzh_fast)			\
444
445
446
447
448
      SymX(isFloatDenormalized)			\
      SymX(isFloatInfinite)			\
      SymX(isFloatNaN)				\
      SymX(isFloatNegativeZero)			\
      SymX(killThreadzh_fast)			\
dons's avatar
dons committed
449
450
      SymX(loadObj)          			\
      SymX(lookupSymbol)     			\
sof's avatar
sof committed
451
      SymX(makeStablePtrzh_fast)		\
452
453
      SymX(minusIntegerzh_fast)			\
      SymX(mkApUpd0zh_fast)			\
sof's avatar
sof committed
454
      SymX(myThreadIdzh_fast)			\
455
      SymX(labelThreadzh_fast)                  \
456
457
458
      SymX(newArrayzh_fast)			\
      SymX(newBCOzh_fast)			\
      SymX(newByteArrayzh_fast)			\
459
      SymX_redirect(newCAF, newDynCAF)		\
460
461
      SymX(newMVarzh_fast)			\
      SymX(newMutVarzh_fast)			\
462
      SymX(newTVarzh_fast)			\
463
      SymX(atomicModifyMutVarzh_fast)		\
464
465
466
      SymX(newPinnedByteArrayzh_fast)		\
      SymX(orIntegerzh_fast)			\
      SymX(performGC)				\
467
      SymX(performMajorGC)			\
468
469
470
471
472
473
474
      SymX(plusIntegerzh_fast)			\
      SymX(prog_argc)				\
      SymX(prog_argv)				\
      SymX(putMVarzh_fast)			\
      SymX(quotIntegerzh_fast)			\
      SymX(quotRemIntegerzh_fast)		\
      SymX(raisezh_fast)			\
475
      SymX(raiseIOzh_fast)			\
476
      SymX(readTVarzh_fast)			\
477
478
479
      SymX(remIntegerzh_fast)			\
      SymX(resetNonBlockingFd)			\
      SymX(resumeThread)			\
dons's avatar
dons committed
480
      SymX(resolveObjs)                         \
481
      SymX(retryzh_fast)                        \
482
483
484
485
486
      SymX(rts_apply)				\
      SymX(rts_checkSchedStatus)		\
      SymX(rts_eval)				\
      SymX(rts_evalIO)				\
      SymX(rts_evalLazyIO)			\
487
      SymX(rts_evalStableIO)			\
488
489
490
491
492
493
494
495
      SymX(rts_eval_)				\
      SymX(rts_getBool)				\
      SymX(rts_getChar)				\
      SymX(rts_getDouble)			\
      SymX(rts_getFloat)			\
      SymX(rts_getInt)				\
      SymX(rts_getInt32)			\
      SymX(rts_getPtr)				\
496
      SymX(rts_getFunPtr)			\
497
      SymX(rts_getStablePtr)			\
498
      SymX(rts_getThreadId)			\
499
500
      SymX(rts_getWord)				\
      SymX(rts_getWord32)			\
501
      SymX(rts_lock)				\
502
503
504
505
506
507
508
509
510
511
      SymX(rts_mkBool)				\
      SymX(rts_mkChar)				\
      SymX(rts_mkDouble)			\
      SymX(rts_mkFloat)				\
      SymX(rts_mkInt)				\
      SymX(rts_mkInt16)				\
      SymX(rts_mkInt32)				\
      SymX(rts_mkInt64)				\
      SymX(rts_mkInt8)				\
      SymX(rts_mkPtr)				\
512
      SymX(rts_mkFunPtr)			\
513
514
515
516
517
518
519
      SymX(rts_mkStablePtr)			\
      SymX(rts_mkString)			\
      SymX(rts_mkWord)				\
      SymX(rts_mkWord16)			\
      SymX(rts_mkWord32)			\
      SymX(rts_mkWord64)			\
      SymX(rts_mkWord8)				\
520
      SymX(rts_unlock)				\
521
      SymX(rtsSupportsBoundThreads)		\
522
      SymX(run_queue_hd)			\
523
524
      SymX(__hscore_get_saved_termios)		\
      SymX(__hscore_set_saved_termios)		\
525
      SymX(setProgArgv)				\
526
527
      SymX(startupHaskell)			\
      SymX(shutdownHaskell)			\
528
529
530
531
      SymX(shutdownHaskellAndExit)		\
      SymX(stable_ptr_table)			\
      SymX(stackOverflow)			\
      SymX(stg_CAF_BLACKHOLE_info)		\
532
      SymX(awakenBlockedQueue)			\
533
534
535
536
537
      SymX(stg_CHARLIKE_closure)		\
      SymX(stg_EMPTY_MVAR_info)			\
      SymX(stg_IND_STATIC_info)			\
      SymX(stg_INTLIKE_closure)			\
      SymX(stg_MUT_ARR_PTRS_FROZEN_info)	\
538
      SymX(stg_MUT_ARR_PTRS_FROZEN0_info)	\
539
      SymX(stg_WEAK_info)                       \
540
      SymX(stg_ap_0_info)			\
541
542
543
544
545
546
547
548
549
550
      SymX(stg_ap_v_info)			\
      SymX(stg_ap_f_info)			\
      SymX(stg_ap_d_info)			\
      SymX(stg_ap_l_info)			\
      SymX(stg_ap_n_info)			\
      SymX(stg_ap_p_info)			\
      SymX(stg_ap_pv_info)			\
      SymX(stg_ap_pp_info)			\
      SymX(stg_ap_ppv_info)			\
      SymX(stg_ap_ppp_info)			\
551
      SymX(stg_ap_pppv_info)			\
552
553
554
      SymX(stg_ap_pppp_info)			\
      SymX(stg_ap_ppppp_info)			\
      SymX(stg_ap_pppppp_info)			\
555
      SymX(stg_ap_1_upd_info)			\
556
557
558
559
560
561
      SymX(stg_ap_2_upd_info)			\
      SymX(stg_ap_3_upd_info)			\
      SymX(stg_ap_4_upd_info)			\
      SymX(stg_ap_5_upd_info)			\
      SymX(stg_ap_6_upd_info)			\
      SymX(stg_ap_7_upd_info)			\
562
      SymX(stg_exit)				\
563
      SymX(stg_sel_0_upd_info)			\
564
565
566
567
568
569
      SymX(stg_sel_10_upd_info)			\
      SymX(stg_sel_11_upd_info)			\
      SymX(stg_sel_12_upd_info)			\
      SymX(stg_sel_13_upd_info)			\
      SymX(stg_sel_14_upd_info)			\
      SymX(stg_sel_15_upd_info)			\
570
571
572
573
574
575
576
577
578
      SymX(stg_sel_1_upd_info)			\
      SymX(stg_sel_2_upd_info)			\
      SymX(stg_sel_3_upd_info)			\
      SymX(stg_sel_4_upd_info)			\
      SymX(stg_sel_5_upd_info)			\
      SymX(stg_sel_6_upd_info)			\
      SymX(stg_sel_7_upd_info)			\
      SymX(stg_sel_8_upd_info)			\
      SymX(stg_sel_9_upd_info)			\
579
580
      SymX(stg_upd_frame_info)			\
      SymX(suspendThread)			\
581
      SymX(takeMVarzh_fast)			\
582
      SymX(timesIntegerzh_fast)			\
583
      SymX(tryPutMVarzh_fast)			\
584
585
      SymX(tryTakeMVarzh_fast)			\
      SymX(unblockAsyncExceptionszh_fast)	\
dons's avatar
dons committed
586
      SymX(unloadObj)                           \
587
      SymX(unsafeThawArrayzh_fast)		\
588
589
      SymX(waitReadzh_fast)			\
      SymX(waitWritezh_fast)			\
590
      SymX(word2Integerzh_fast)			\
591
      SymX(writeTVarzh_fast)			\
592
      SymX(xorIntegerzh_fast)			\
593
      SymX(yieldzh_fast)
594

595
#ifdef SUPPORT_LONG_LONGS
596
#define RTS_LONG_LONG_SYMS			\
597
598
      SymX(int64ToIntegerzh_fast)		\
      SymX(word64ToIntegerzh_fast)
599
600
601
602
#else
#define RTS_LONG_LONG_SYMS /* nothing */
#endif

603
604
605
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
#define RTS_LIBGCC_SYMBOLS			\
606
607
608
      Sym(__divdi3)                             \
      Sym(__udivdi3)                            \
      Sym(__moddi3)                             \
609
      Sym(__umoddi3)				\
610
      Sym(__muldi3)				\
611
612
613
614
      Sym(__ashldi3)				\
      Sym(__ashrdi3)				\
      Sym(__lshrdi3)				\
      Sym(__eprintf)
615
#elif defined(ia64_HOST_ARCH)
616
617
618
619
620
621
622
#define RTS_LIBGCC_SYMBOLS			\
      Sym(__divdi3)				\
      Sym(__udivdi3)                            \
      Sym(__moddi3)				\
      Sym(__umoddi3)				\
      Sym(__divsf3)				\
      Sym(__divdf3)
623
624
625
626
#else
#define RTS_LIBGCC_SYMBOLS
#endif

627
#ifdef darwin_HOST_OS
628
629
630
631
632
633
      // Symbols that don't have a leading underscore
      // on Mac OS X. They have to receive special treatment,
      // see machoInitSymbolsWithoutUnderscore()
#define RTS_MACHO_NOUNDERLINE_SYMBOLS		\
      Sym(saveFP)				\
      Sym(restFP)
634
#endif
635
636

/* entirely bogus claims about types of these symbols */
637
#define Sym(vvv)  extern void vvv(void);
638
#define SymX(vvv) /**/
639
#define SymX_redirect(vvv,xxx) /**/
640
RTS_SYMBOLS
641
RTS_RET_SYMBOLS
642
RTS_LONG_LONG_SYMS
643
RTS_POSIX_ONLY_SYMBOLS
644
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
645
RTS_CYGWIN_ONLY_SYMBOLS
646
RTS_LIBGCC_SYMBOLS
647
648
#undef Sym
#undef SymX
649
#undef SymX_redirect
650
651
652
653
654
655
656
657
658
659
660

#ifdef LEADING_UNDERSCORE
#define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
#else
#define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
#endif

#define Sym(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
                    (void*)(&(vvv)) },
#define SymX(vvv) Sym(vvv)

661
662
663
664
665
666
// SymX_redirect allows us to redirect references to one symbol to
// another symbol.  See newCAF/newDynCAF for an example.
#define SymX_redirect(vvv,xxx) \
    { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
      (void*)(&(xxx)) },

667
static RtsSymbolVal rtsSyms[] = {
668
      RTS_SYMBOLS
669
      RTS_RET_SYMBOLS
670
      RTS_LONG_LONG_SYMS
671
      RTS_POSIX_ONLY_SYMBOLS
672
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
673
      RTS_CYGWIN_ONLY_SYMBOLS
674
      RTS_LIBGCC_SYMBOLS
675
676
677
      { 0, 0 } /* sentinel */
};

678
679
680
681
682
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
683
                                     char* key,
684
685
686
687
688
689
690
691
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
692
   debugBelch(
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
      "\n\n"
      "GHCi runtime linker: fatal error: I found a duplicate definition for symbol\n"
      "   %s\n"
      "whilst processing object file\n"
      "   %s\n"
      "This could be caused by:\n"
      "   * Loading two different object files which export the same symbol\n"
      "   * Specifying the same object file twice on the GHCi command line\n"
      "   * An incorrect `package.conf' entry, causing some object to be\n"
      "     loaded twice.\n"
      "GHCi cannot safely continue in this situation.  Exiting now.  Sorry.\n"
      "\n",
      (char*)key,
      obj_name
   );
   exit(1);
}


712
713
714
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
715
716
717
718


static int linker_init_done = 0 ;

719
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
720
static void *dl_prog_handle;
721
#endif
722

dons's avatar
dons committed
723
/* dlopen(NULL,..) doesn't work so we grab libc explicitly */
724
#if defined(openbsd_HOST_OS)
dons's avatar
dons committed
725
726
727
static void *dl_libc_handle;
#endif

728
729
730
void
initLinker( void )
{
731
    RtsSymbolVal *sym;
732

733
734
735
736
737
738
739
    /* Make initLinker idempotent, so we can call it
       before evey relevant operation; that means we
       don't need to initialise the linker separately */
    if (linker_init_done == 1) { return; } else {
      linker_init_done = 1;
    }

740
741
742
743
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
744
745
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
746
    }
747
748
749
750
#   if defined(OBJFORMAT_MACHO)
    machoInitSymbolsWithoutUnderscore();
#   endif

751
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
752
#   if defined(RTLD_DEFAULT)
753
754
    dl_prog_handle = RTLD_DEFAULT;
#   else
755
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
756
#   if defined(openbsd_HOST_OS)
dons's avatar
dons committed
757
758
    dl_libc_handle = dlopen("libc.so", RTLD_LAZY);
#   endif
759
#   endif /* RTLD_DEFAULT */
760
#   endif
761
762
}

763
/* -----------------------------------------------------------------------------
764
765
766
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
767
768
769
770
 * Add a DLL from which symbols may be found.  In the ELF case, just
 * do RTLD_GLOBAL-style add, so no further messing around needs to
 * happen in order that symbols in the loaded .so are findable --
 * lookupSymbol() will subsequently see them by dlsym on the program's
771
772
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
773
 * In the PEi386 case, open the DLLs and put handles to them in a
774
 * linked list.  When looking for a symbol, try all handles in the
775
776
777
778
779
 * list.  This means that we need to load even DLLs that are guaranteed
 * to be in the ghc.exe image already, just so we can get a handle
 * to give to loadSymbol, so that we can find the symbols.  For such
 * libraries, the LoadLibrary call should be a no-op except for returning
 * the handle.
780
 *
781
 */
782
783
784
785
786
787

#if defined(OBJFORMAT_PEi386)
/* A record for storing handles into DLLs. */

typedef
   struct _OpenedDLL {
788
      char*              name;
789
790
      struct _OpenedDLL* next;
      HINSTANCE instance;
791
   }
792
793
794
795
796
797
   OpenedDLL;

/* A list thereof. */
static OpenedDLL* opened_dlls = NULL;
#endif

798
799
char *
addDLL( char *dll_name )
800
{
801
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
802
   /* ------------------- ELF DLL loader ------------------- */
803
   void *hdl;
804
   char *errmsg;
805

806
807
   initLinker();

808
   hdl= dlopen(dll_name, RTLD_NOW | RTLD_GLOBAL);
dons's avatar
dons committed
809

810
811
812
813
814
815
816
817
   if (hdl == NULL) {
      /* dlopen failed; return a ptr to the error msg. */
      errmsg = dlerror();
      if (errmsg == NULL) errmsg = "addDLL: unknown error";
      return errmsg;
   } else {
      return NULL;
   }
818
819
   /*NOTREACHED*/

820
#  elif defined(OBJFORMAT_PEi386)
821
   /* ------------------- Win32 DLL loader ------------------- */
822

823
   char*      buf;
824
   OpenedDLL* o_dll;
825
   HINSTANCE  instance;
826

827
828
   initLinker();

829
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
830
831
832
833
834

   /* See if we've already got it, and ignore if so. */
   for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
      if (0 == strcmp(o_dll->name, dll_name))
         return NULL;
835
836
   }

837
838
839
840
841
842
843
844
845
846
   /* The file name has no suffix (yet) so that we can try
      both foo.dll and foo.drv

      The documentation for LoadLibrary says:
      	If no file name extension is specified in the lpFileName
      	parameter, the default library extension .dll is
      	appended. However, the file name string can include a trailing
      	point character (.) to indicate that the module name has no
      	extension. */

847
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
848
849
850
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
851
	 sprintf(buf, "%s.DRV", dll_name);	// KAA: allow loading of drivers (like winspool.drv)
852
853
	 instance = LoadLibrary(buf);
	 if (instance == NULL) {
sof's avatar
sof committed
854
		stgFree(buf);
855
856
857
858

	    /* LoadLibrary failed; return a ptr to the error msg. */
	    return "addDLL: unknown error";
   	 }
859
   }
sof's avatar
sof committed
860
   stgFree(buf);
861

862
   /* Add this DLL to the list of DLLs in which to search for symbols. */
863
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
864
865
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
866
   o_dll->instance = instance;
867
868
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
869
870

   return NULL;
871
872
873
874
875
#  else
   barf("addDLL: not implemented on this platform");
#  endif
}

876
877
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
878
 */
879
880
881
void *
lookupSymbol( char *lbl )
{
882
    void *val;
883
    initLinker() ;
884
    ASSERT(symhash != NULL);
885
886
887
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
888
#       if defined(OBJFORMAT_ELF)
889
#	if defined(openbsd_HOST_OS)
dons's avatar
dons committed
890
891
892
	val = dlsym(dl_prog_handle, lbl);
	return (val != NULL) ? val : dlsym(dl_libc_handle,lbl);
#	else /* not openbsd */
893
	return dlsym(dl_prog_handle, lbl);
dons's avatar
dons committed
894
#	endif
895
896
897
898
899
900
901
#       elif defined(OBJFORMAT_MACHO)
	if(NSIsSymbolNameDefined(lbl)) {
	    NSSymbol symbol = NSLookupAndBindSymbol(lbl);
	    return NSAddressOfSymbol(symbol);
	} else {
	    return NULL;
	}
902
#       elif defined(OBJFORMAT_PEi386)
903
904
905
        OpenedDLL* o_dll;
        void* sym;
        for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
906
	  /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
907
908
909
910
911
912
913
           if (lbl[0] == '_') {
              /* HACK: if the name has an initial underscore, try stripping
                 it off & look that up first. I've yet to verify whether there's
                 a Rule that governs whether an initial '_' *should always* be
                 stripped off when mapping from import lib name to the DLL name.
              */
              sym = GetProcAddress(o_dll->instance, (lbl+1));
sof's avatar
sof committed
914
              if (sym != NULL) {
915
		/*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
sof's avatar
sof committed
916
		return sym;
917
	      }
918
           }
919
           sym = GetProcAddress(o_dll->instance, lbl);
sof's avatar
sof committed
920
           if (sym != NULL) {
921
	     /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
sof's avatar
sof committed
922
923
	     return sym;
	   }
924
        }
925
        return NULL;
ken's avatar
ken committed
926
927
928
#       else
        ASSERT(2+2 == 5);
        return NULL;
929
#       endif
930
    } else {
931
	return val;
932
933
934
    }
}

935
static
936
__attribute((unused))
937
938
939
void *
lookupLocalSymbol( ObjectCode* oc, char *lbl )
{
940
    void *val;
941
    initLinker() ;
942
943
944
945
946
    val = lookupStrHashTable(oc->lochash, lbl);

    if (val == NULL) {
        return NULL;
    } else {
947
	return val;
948
949
950
951
    }
}


952
953
954
955
956
957
958
959
960
961
962
963
964
965
/* -----------------------------------------------------------------------------
 * Debugging aid: look in GHCi's object symbol tables for symbols
 * within DELTA bytes of the specified address, and show their names.
 */
#ifdef DEBUG
void ghci_enquire ( char* addr );

void ghci_enquire ( char* addr )
{
   int   i;
   char* sym;
   char* a;
   const int DELTA = 64;
   ObjectCode* oc;
966
967
968

   initLinker();

969
970
971
972
   for (oc = objects; oc; oc = oc->next) {
      for (i = 0; i < oc->n_symbols; i++) {
         sym = oc->symbols[i];
         if (sym == NULL) continue;
973
         // debugBelch("enquire %p %p\n", sym, oc->lochash);
974
         a = NULL;
975
         if (oc->lochash != NULL) {
976
            a = lookupStrHashTable(oc->lochash, sym);
977
978
	 }
         if (a == NULL) {
979
            a = lookupStrHashTable(symhash, sym);
980
	 }
981
         if (a == NULL) {
982
	     // debugBelch("ghci_enquire: can't find %s\n", sym);
983
         }
984
         else if (addr-DELTA <= a && a <= addr+DELTA) {
985
            debugBelch("%p + %3d  ==  `%s'\n", addr, a - addr, sym);
986
987
988
989
990
991
         }
      }
   }
}
#endif

992
#ifdef ia64_HOST_ARCH
993
994
static unsigned int PLTSize(void);
#endif
995

996
997
998
999
1000
1001
1002
1003
1004
1005
1006
/* -----------------------------------------------------------------------------
 * Load an obj (populate the global symbol table, but don't resolve yet)
 *
 * Returns: 1 if ok, 0 on error.
 */
HsInt
loadObj( char *path )
{
   ObjectCode* oc;
   struct stat st;
   int r, n;
1007
1008
#ifdef USE_MMAP
   int fd, pagesize;
1009
   void *map_addr = NULL;
1010
#else
1011
   FILE *f;
1012
#endif
1013

1014
1015
   initLinker();

1016
   /* debugBelch("loadObj %s\n", path ); */
1017

dons's avatar
dons committed
1018
1019
   /* Check that we haven't already loaded this object. 
      Ignore requests to load multiple times */
1020
   {
1021
       ObjectCode *o;
1022
1023
       int is_dup = 0;
       for (o = objects; o; o = o->next) {
dons's avatar
dons committed
1024
          if (0 == strcmp(o->fileName, path)) {
1025
             is_dup = 1;
dons's avatar
dons committed
1026
1027
             break; /* don't need to search further */
          }
1028
1029
       }
       if (is_dup) {
1030
          IF_DEBUG(linker, debugBelch(
1031
1032
1033
            "GHCi runtime linker: warning: looks like you're trying to load the\n"
            "same object file twice:\n"
            "   %s\n"
dons's avatar
dons committed
1034
1035
1036
            "GHCi will ignore this, but be warned.\n"
            , path));
          return 1; /* success */
1037
       }
1038
1039
1040
1041
   }

   oc = stgMallocBytes(sizeof(ObjectCode), "loadObj(oc)");

1042
#  if defined(OBJFORMAT_ELF)
1043
   oc->formatName = "ELF";
1044
#  elif defined(OBJFORMAT_PEi386)
1045
   oc->formatName = "PEi386";
1046
1047
#  elif defined(OBJFORMAT_MACHO)
   oc->formatName = "Mach-O";
1048
#  else
sof's avatar
sof committed
1049
   stgFree(oc);
1050
1051
1052
1053
1054
1055
   barf("loadObj: not implemented on this platform");
#  endif

   r = stat(path, &st);
   if (r == -1) { return 0; }

1056
   /* sigh, strdup() isn't a POSIX function, so do it the long way */
1057
1058
1059
   oc->fileName = stgMallocBytes( strlen(path)+1, "loadObj" );
   strcpy(oc->fileName, path);

1060
1061
1062
   oc->fileSize          = st.st_size;
   oc->symbols           = NULL;
   oc->sections          = NULL;
1063
   oc->lochash           = allocStrHashTable();
1064
   oc->proddables        = NULL;
1065
1066
1067
1068
1069

   /* chain it onto the list of objects */
   oc->next              = objects;
   objects               = oc;

1070
1071
1072
1073
1074
#ifdef USE_MMAP
#define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))

   /* On many architectures malloc'd memory isn't executable, so we need to use mmap. */

1075
#if defined(openbsd_HOST_OS)
dons's avatar
dons committed
1076
1077
   fd = open(path, O_RDONLY, S_IRUSR);
#else
1078
   fd = open(path, O_RDONLY);
dons's avatar
dons committed
1079
#endif
1080
1081
1082
1083
1084
   if (fd == -1)
      barf("loadObj: can't open `%s'", path);

   pagesize = getpagesize();

1085
#ifdef ia64_HOST_ARCH
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
   /* The PLT needs to be right before the object */
   n = ROUND_UP(PLTSize(), pagesize);
   oc->plt = mmap(NULL, n, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
   if (oc->plt == MAP_FAILED)
      barf("loadObj: can't allocate PLT");

   oc->pltIndex = 0;
   map_addr = oc->plt + n;
#endif

   n = ROUND_UP(oc->fileSize, pagesize);
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109

   /* Link objects into the lower 2Gb on x86_64.  GHC assumes the
    * small memory model on this architecture (see gcc docs,
    * -mcmodel=small).
    */
#ifdef x86_64_HOST_ARCH
#define EXTRA_MAP_FLAGS MAP_32BIT
#else
#define EXTRA_MAP_FLAGS 0
#endif

   oc->image = mmap(map_addr, n, PROT_EXEC|PROT_READ|PROT_WRITE, 
		    MAP_PRIVATE|EXTRA_MAP_FLAGS, fd, 0);
1110
1111
1112
1113
1114
1115
1116
1117
1118
   if (oc->image == MAP_FAILED)
      barf("loadObj: can't map `%s'", path);

   close(fd);

#else /* !USE_MMAP */

   oc->image = stgMallocBytes(oc->fileSize, "loadObj(image)");

1119
1120
   /* load the image into memory */
   f = fopen(path, "rb");
1121
   if (!f)
1122
       barf("loadObj: can't read `%s'", path);
1123

1124
   n = fread ( oc->image, 1, oc->fileSize, f );
1125
   if (n != oc->fileSize)
1126
      barf("loadObj: error whilst reading `%s'", path);
1127
1128
1129
1130

   fclose(f);

#endif /* USE_MMAP */
1131

1132
1133
1134
#  if defined(OBJFORMAT_MACHO)
   r = ocAllocateJumpIslands_MachO ( oc );
   if (!r) { return r; }
1135
#  elif defined(OBJFORMAT_ELF) && defined(powerpc_HOST_ARCH)
1136
1137
   r = ocAllocateJumpIslands_ELF ( oc );
   if (!r) { return r; }
1138
1139
#endif

1140
   /* verify the in-memory image */
1141
#  if defined(OBJFORMAT_ELF)
1142
   r = ocVerifyImage_ELF ( oc );
1143
#  elif defined(OBJFORMAT_PEi386)
1144
   r = ocVerifyImage_PEi386 ( oc );
1145
1146
#  elif defined(OBJFORMAT_MACHO)
   r = ocVerifyImage_MachO ( oc );
1147
1148
1149
1150
1151
1152
#  else
   barf("loadObj: no verify method");
#  endif
   if (!r) { return r; }

   /* build the symbol list for this image */
1153
#  if defined(OBJFORMAT_ELF)
1154
   r = ocGetNames_ELF ( oc );
1155
#  elif defined(OBJFORMAT_PEi386)
1156
   r = ocGetNames_PEi386 ( oc );
1157
1158
#  elif defined(OBJFORMAT_MACHO)
   r = ocGetNames_MachO ( oc );
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172