Linker.c 136 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
/* Linux needs _GNU_SOURCE to get RTLD_DEFAULT from <dlfcn.h> and
14 15
   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 "Sparks.h"
ei@vuokko.info's avatar
ei@vuokko.info committed
29
#include "RtsTypeable.h"
30

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

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

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

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

46
#if defined(cygwin32_HOST_OS)
sof's avatar
sof committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
#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

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

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

73 74
#endif

75
#if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
76
#  define OBJFORMAT_ELF
77
#elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
78
#  define OBJFORMAT_PEi386
79
#  include <windows.h>
sof's avatar
sof committed
80
#  include <math.h>
81
#elif defined(darwin_HOST_OS)
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 89
#if defined(powerpc_HOST_ARCH)
#  include <mach-o/ppc/reloc.h>
#endif
90 91
#endif

92
/* Hash table mapping symbol names to Symbol */
93
static /*Str*/HashTable *symhash;
94

95 96 97
/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;

98 99 100
/* List of currently loaded objects */
ObjectCode *objects = NULL;	/* initially empty */

101
#if defined(OBJFORMAT_ELF)
102 103 104
static int ocVerifyImage_ELF    ( ObjectCode* oc );
static int ocGetNames_ELF       ( ObjectCode* oc );
static int ocResolve_ELF        ( ObjectCode* oc );
105
#if defined(powerpc_HOST_ARCH)
106 107
static int ocAllocateJumpIslands_ELF ( ObjectCode* oc );
#endif
108
#elif defined(OBJFORMAT_PEi386)
109 110 111
static int ocVerifyImage_PEi386 ( ObjectCode* oc );
static int ocGetNames_PEi386    ( ObjectCode* oc );
static int ocResolve_PEi386     ( ObjectCode* oc );
112 113 114 115
#elif defined(OBJFORMAT_MACHO)
static int ocVerifyImage_MachO    ( ObjectCode* oc );
static int ocGetNames_MachO       ( ObjectCode* oc );
static int ocResolve_MachO        ( ObjectCode* oc );
116

117
static int machoGetMisalignment( FILE * );
118 119
#ifdef powerpc_HOST_ARCH
static int ocAllocateJumpIslands_MachO ( ObjectCode* oc );
120
static void machoInitSymbolsWithoutUnderscore( void );
121
#endif
122
#endif
123

124 125 126 127
#if defined(x86_64_HOST_ARCH)
static void*x86_64_high_symbol( char *lbl, void *addr );
#endif

128 129 130 131
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

132 133 134 135 136 137
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;


138 139 140 141 142 143 144 145
#if !defined(PAR)
#define Maybe_Stable_Names      SymX(mkWeakzh_fast)			\
      				SymX(makeStableNamezh_fast)		\
      				SymX(finalizzeWeakzh_fast)
#else
/* These are not available in GUM!!! -- HWL */
#define Maybe_Stable_Names
#endif
146

147
#if !defined (mingw32_HOST_OS)
148
#define RTS_POSIX_ONLY_SYMBOLS                  \
149
      SymX(signal_handlers)			\
150 151
      SymX(stg_sig_install)			\
      Sym(nocldstop)
sof's avatar
sof committed
152
#endif
153

154
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
155 156 157
#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
158
 * exports; sigh.
sof's avatar
sof committed
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 225 226 227 228 229 230 231 232 233 234 235
 */
#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)                               \
236
      SymX(waitpid)
237

238
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
239 240
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
241
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
242 243
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
244

245 246 247 248
/* Extra syms gen'ed by mingw-2's gcc-3.2: */
#if __GNUC__>=3
#define RTS_MINGW_EXTRA_SYMS                    \
      Sym(_imp____mb_cur_max)                   \
249
      Sym(_imp___pctype)
250 251 252 253
#else
#define RTS_MINGW_EXTRA_SYMS
#endif

254 255
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
256
#define RTS_MINGW_ONLY_SYMBOLS                  \
sof's avatar
sof committed
257 258
      SymX(asyncReadzh_fast)			\
      SymX(asyncWritezh_fast)			\
sof's avatar
sof committed
259
      SymX(asyncDoProczh_fast)			\
260
      SymX(memset)                              \
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
      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)                              \
293 294 295
      SymX(memmove)                             \
      SymX(realloc)                             \
      SymX(malloc)                              \
296 297 298 299 300 301 302 303 304 305 306 307 308
      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)                                \
309 310 311 312 313 314 315 316 317 318 319 320 321
      SymX(powf)                                 \
      SymX(tanhf)                                \
      SymX(coshf)                                \
      SymX(sinhf)                                \
      SymX(atanf)                                \
      SymX(acosf)                                \
      SymX(asinf)                                \
      SymX(tanf)                                 \
      SymX(cosf)                                 \
      SymX(sinf)                                 \
      SymX(expf)                                 \
      SymX(logf)                                 \
      SymX(sqrtf)                                \
322
      SymX(memcpy)                              \
sof's avatar
sof committed
323 324
      SymX(rts_InstallConsoleEvent)             \
      SymX(rts_ConsoleHandlerDone)              \
325
      Sym(mktime)                               \
326
      Sym(_imp___timezone)                      \
327
      Sym(_imp___tzname)                        \
328
      Sym(_imp__tzname)                         \
329
      Sym(_imp___iob)                           \
sof's avatar
sof committed
330
      Sym(_imp___osver)                         \
331 332 333 334
      Sym(localtime)                            \
      Sym(gmtime)                               \
      Sym(opendir)                              \
      Sym(readdir)                              \
sof's avatar
sof committed
335
      Sym(rewinddir)                            \
336
      RTS_MINGW_EXTRA_SYMS                      \
337
      Sym(closedir)
338
#endif
339

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
#if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
#define RTS_DARWIN_ONLY_SYMBOLS			\
     Sym(asprintf$LDBLStub)                     \
     Sym(err$LDBLStub)                          \
     Sym(errc$LDBLStub)                         \
     Sym(errx$LDBLStub)                         \
     Sym(fprintf$LDBLStub)                      \
     Sym(fscanf$LDBLStub)                       \
     Sym(fwprintf$LDBLStub)                     \
     Sym(fwscanf$LDBLStub)                      \
     Sym(printf$LDBLStub)                       \
     Sym(scanf$LDBLStub)                        \
     Sym(snprintf$LDBLStub)                     \
     Sym(sprintf$LDBLStub)                      \
     Sym(sscanf$LDBLStub)                       \
     Sym(strtold$LDBLStub)                      \
     Sym(swprintf$LDBLStub)                     \
     Sym(swscanf$LDBLStub)                      \
     Sym(syslog$LDBLStub)                       \
     Sym(vasprintf$LDBLStub)                    \
     Sym(verr$LDBLStub)                         \
     Sym(verrc$LDBLStub)                        \
     Sym(verrx$LDBLStub)                        \
     Sym(vfprintf$LDBLStub)                     \
     Sym(vfscanf$LDBLStub)                      \
     Sym(vfwprintf$LDBLStub)                    \
     Sym(vfwscanf$LDBLStub)                     \
     Sym(vprintf$LDBLStub)                      \
     Sym(vscanf$LDBLStub)                       \
     Sym(vsnprintf$LDBLStub)                    \
     Sym(vsprintf$LDBLStub)                     \
     Sym(vsscanf$LDBLStub)                      \
     Sym(vswprintf$LDBLStub)                    \
     Sym(vswscanf$LDBLStub)                     \
     Sym(vsyslog$LDBLStub)                      \
     Sym(vwarn$LDBLStub)                        \
     Sym(vwarnc$LDBLStub)                       \
     Sym(vwarnx$LDBLStub)                       \
     Sym(vwprintf$LDBLStub)                     \
     Sym(vwscanf$LDBLStub)                      \
     Sym(warn$LDBLStub)                         \
     Sym(warnc$LDBLStub)                        \
     Sym(warnx$LDBLStub)                        \
     Sym(wcstold$LDBLStub)                      \
     Sym(wprintf$LDBLStub)                      \
     Sym(wscanf$LDBLStub)
#else
#define RTS_DARWIN_ONLY_SYMBOLS
#endif

sof's avatar
sof committed
390 391 392 393 394
#ifndef SMP
# define MAIN_CAP_SYM SymX(MainCapability)
#else
# define MAIN_CAP_SYM
#endif
395

sof's avatar
sof committed
396 397 398 399
#if !defined(mingw32_HOST_OS)
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(setIOManagerPipe)
#else
Simon Marlow's avatar
Simon Marlow committed
400 401 402 403 404
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(sendIOManagerEvent) \
   SymX(readIOManagerEvent) \
   SymX(getIOManagerEvent) \
   SymX(console_handler)
sof's avatar
sof committed
405 406
#endif

407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
#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_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

429
#define RTS_SYMBOLS				\
430 431
      Maybe_Stable_Names			\
      Sym(StgReturn)				\
432 433
      SymX(stg_enter_info)			\
      SymX(stg_gc_void_info)			\
434 435
      SymX(__stg_gc_enter_1)			\
      SymX(stg_gc_noregs)			\
436
      SymX(stg_gc_unpt_r1_info)			\
437
      SymX(stg_gc_unpt_r1)			\
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
      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)			\
454
      SymX(stg_yield_to_interpreter)		\
455 456 457 458 459
      SymX(stg_gen_block)			\
      SymX(stg_block_noregs)			\
      SymX(stg_block_1)				\
      SymX(stg_block_takemvar)			\
      SymX(stg_block_putmvar)			\
sof's avatar
sof committed
460
      MAIN_CAP_SYM                              \
461 462 463 464 465 466
      SymX(MallocFailHook)			\
      SymX(OnExitHook)				\
      SymX(OutOfHeapHook)			\
      SymX(StackOverflowHook)			\
      SymX(__encodeDouble)			\
      SymX(__encodeFloat)			\
dons's avatar
dons committed
467
      SymX(addDLL)               		\
468 469 470 471 472 473 474 475 476
      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)			\
477
      SymX(atomicallyzh_fast)			\
478
      SymX(barf)				\
479 480
      SymX(debugBelch)				\
      SymX(errorBelch)				\
481 482
      SymX(blockAsyncExceptionszh_fast)		\
      SymX(catchzh_fast)			\
483 484
      SymX(catchRetryzh_fast)			\
      SymX(catchSTMzh_fast)			\
tharris@microsoft.com's avatar
tharris@microsoft.com committed
485
      SymX(checkzh_fast)                        \
sof's avatar
sof committed
486
      SymX(closure_flags)                       \
487
      SymX(cmp_thread)				\
sof's avatar
sof committed
488 489
      SymX(cmpIntegerzh_fast)	        	\
      SymX(cmpIntegerIntzh_fast)	      	\
sof's avatar
sof committed
490
      SymX(complementIntegerzh_fast)		\
491 492 493 494 495
      SymX(createAdjustor)			\
      SymX(decodeDoublezh_fast)			\
      SymX(decodeFloatzh_fast)			\
      SymX(defaultsHook)			\
      SymX(delayzh_fast)			\
sof's avatar
sof committed
496 497
      SymX(deRefWeakzh_fast)			\
      SymX(deRefStablePtrzh_fast)		\
498
      SymX(dirty_MUT_VAR)			\
499 500 501
      SymX(divExactIntegerzh_fast)		\
      SymX(divModIntegerzh_fast)		\
      SymX(forkzh_fast)				\
Simon Marlow's avatar
Simon Marlow committed
502
      SymX(forkOnzh_fast)			\
503
      SymX(forkProcess)				\
504
      SymX(forkOS_createThread)			\
505
      SymX(freeHaskellFunctionPtr)		\
sof's avatar
sof committed
506
      SymX(freeStablePtr)		        \
ei@vuokko.info's avatar
ei@vuokko.info committed
507
      SymX(getOrSetTypeableStore)		\
508
      SymX(gcdIntegerzh_fast)			\
sof's avatar
sof committed
509 510
      SymX(gcdIntegerIntzh_fast)		\
      SymX(gcdIntzh_fast)			\
511
      SymX(genSymZh)				\
dons's avatar
dons committed
512
      SymX(genericRaise)			\
513 514
      SymX(getProgArgv)				\
      SymX(getStablePtr)			\
515 516 517 518 519 520 521 522
      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)				\
523 524
      SymX(infoPtrzh_fast)                      \
      SymX(closurePayloadzh_fast)               \
525
      SymX(int2Integerzh_fast)			\
sof's avatar
sof committed
526 527
      SymX(integer2Intzh_fast)			\
      SymX(integer2Wordzh_fast)			\
528
      SymX(isCurrentThreadBoundzh_fast)		\
529 530 531 532
      SymX(isDoubleDenormalized)		\
      SymX(isDoubleInfinite)			\
      SymX(isDoubleNaN)				\
      SymX(isDoubleNegativeZero)		\
sof's avatar
sof committed
533
      SymX(isEmptyMVarzh_fast)			\
534 535 536 537 538
      SymX(isFloatDenormalized)			\
      SymX(isFloatInfinite)			\
      SymX(isFloatNaN)				\
      SymX(isFloatNegativeZero)			\
      SymX(killThreadzh_fast)			\
dons's avatar
dons committed
539
      SymX(loadObj)          			\
540 541
      SymX(insertStableSymbol) 			\
      SymX(insertSymbol)     			\
dons's avatar
dons committed
542
      SymX(lookupSymbol)     			\
sof's avatar
sof committed
543
      SymX(makeStablePtrzh_fast)		\
544 545
      SymX(minusIntegerzh_fast)			\
      SymX(mkApUpd0zh_fast)			\
sof's avatar
sof committed
546
      SymX(myThreadIdzh_fast)			\
547
      SymX(labelThreadzh_fast)                  \
548 549 550
      SymX(newArrayzh_fast)			\
      SymX(newBCOzh_fast)			\
      SymX(newByteArrayzh_fast)			\
551
      SymX_redirect(newCAF, newDynCAF)		\
552 553
      SymX(newMVarzh_fast)			\
      SymX(newMutVarzh_fast)			\
554
      SymX(newTVarzh_fast)			\
555
      SymX(noDuplicatezh_fast)			\
556
      SymX(atomicModifyMutVarzh_fast)		\
557
      SymX(newPinnedByteArrayzh_fast)		\
558
      SymX(newSpark)				\
559 560
      SymX(orIntegerzh_fast)			\
      SymX(performGC)				\
561
      SymX(performMajorGC)			\
562 563 564 565 566 567 568
      SymX(plusIntegerzh_fast)			\
      SymX(prog_argc)				\
      SymX(prog_argv)				\
      SymX(putMVarzh_fast)			\
      SymX(quotIntegerzh_fast)			\
      SymX(quotRemIntegerzh_fast)		\
      SymX(raisezh_fast)			\
569
      SymX(raiseIOzh_fast)			\
570
      SymX(readTVarzh_fast)			\
571 572 573
      SymX(remIntegerzh_fast)			\
      SymX(resetNonBlockingFd)			\
      SymX(resumeThread)			\
dons's avatar
dons committed
574
      SymX(resolveObjs)                         \
575
      SymX(retryzh_fast)                        \
576 577 578 579 580
      SymX(rts_apply)				\
      SymX(rts_checkSchedStatus)		\
      SymX(rts_eval)				\
      SymX(rts_evalIO)				\
      SymX(rts_evalLazyIO)			\
581
      SymX(rts_evalStableIO)			\
582 583 584 585 586 587 588 589
      SymX(rts_eval_)				\
      SymX(rts_getBool)				\
      SymX(rts_getChar)				\
      SymX(rts_getDouble)			\
      SymX(rts_getFloat)			\
      SymX(rts_getInt)				\
      SymX(rts_getInt32)			\
      SymX(rts_getPtr)				\
590
      SymX(rts_getFunPtr)			\
591
      SymX(rts_getStablePtr)			\
592
      SymX(rts_getThreadId)			\
593 594
      SymX(rts_getWord)				\
      SymX(rts_getWord32)			\
595
      SymX(rts_lock)				\
596 597 598 599 600 601 602 603 604 605
      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)				\
606
      SymX(rts_mkFunPtr)			\
607 608 609 610 611 612 613
      SymX(rts_mkStablePtr)			\
      SymX(rts_mkString)			\
      SymX(rts_mkWord)				\
      SymX(rts_mkWord16)			\
      SymX(rts_mkWord32)			\
      SymX(rts_mkWord64)			\
      SymX(rts_mkWord8)				\
614
      SymX(rts_unlock)				\
615
      SymX(rtsSupportsBoundThreads)		\
616 617
      SymX(__hscore_get_saved_termios)		\
      SymX(__hscore_set_saved_termios)		\
618
      SymX(setProgArgv)				\
619 620
      SymX(startupHaskell)			\
      SymX(shutdownHaskell)			\
621 622 623 624
      SymX(shutdownHaskellAndExit)		\
      SymX(stable_ptr_table)			\
      SymX(stackOverflow)			\
      SymX(stg_CAF_BLACKHOLE_info)		\
625
      SymX(awakenBlockedQueue)			\
626 627 628 629
      SymX(stg_CHARLIKE_closure)		\
      SymX(stg_EMPTY_MVAR_info)			\
      SymX(stg_IND_STATIC_info)			\
      SymX(stg_INTLIKE_closure)			\
630
      SymX(stg_MUT_ARR_PTRS_DIRTY_info)		\
631
      SymX(stg_MUT_ARR_PTRS_FROZEN_info)	\
632
      SymX(stg_MUT_ARR_PTRS_FROZEN0_info)	\
633
      SymX(stg_WEAK_info)                       \
634 635 636 637 638 639 640 641 642 643
      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)			\
644
      SymX(stg_ap_pppv_info)			\
645 646 647
      SymX(stg_ap_pppp_info)			\
      SymX(stg_ap_ppppp_info)			\
      SymX(stg_ap_pppppp_info)			\
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
      SymX(stg_ap_0_fast)			\
      SymX(stg_ap_v_fast)			\
      SymX(stg_ap_f_fast)			\
      SymX(stg_ap_d_fast)			\
      SymX(stg_ap_l_fast)			\
      SymX(stg_ap_n_fast)			\
      SymX(stg_ap_p_fast)			\
      SymX(stg_ap_pv_fast)			\
      SymX(stg_ap_pp_fast)			\
      SymX(stg_ap_ppv_fast)			\
      SymX(stg_ap_ppp_fast)			\
      SymX(stg_ap_pppv_fast)			\
      SymX(stg_ap_pppp_fast)			\
      SymX(stg_ap_ppppp_fast)			\
      SymX(stg_ap_pppppp_fast)			\
663
      SymX(stg_ap_1_upd_info)			\
664 665 666 667 668 669
      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)			\
670
      SymX(stg_exit)				\
671
      SymX(stg_sel_0_upd_info)			\
672 673 674 675 676 677
      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)			\
678 679 680 681 682 683 684 685 686
      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)			\
687 688
      SymX(stg_upd_frame_info)			\
      SymX(suspendThread)			\
689
      SymX(takeMVarzh_fast)			\
690
      SymX(timesIntegerzh_fast)			\
691
      SymX(tryPutMVarzh_fast)			\
692 693
      SymX(tryTakeMVarzh_fast)			\
      SymX(unblockAsyncExceptionszh_fast)	\
dons's avatar
dons committed
694
      SymX(unloadObj)                           \
695
      SymX(unsafeThawArrayzh_fast)		\
696 697
      SymX(waitReadzh_fast)			\
      SymX(waitWritezh_fast)			\
698
      SymX(word2Integerzh_fast)			\
699
      SymX(writeTVarzh_fast)			\
700
      SymX(xorIntegerzh_fast)			\
sof's avatar
sof committed
701
      SymX(yieldzh_fast)                        \
702
      SymX(stg_interp_constr_entry)             \
703 704
      SymX(allocateExec)	                \
      SymX(freeExec)		                \
705 706 707
      SymX(getAllocations)                      \
      SymX(revertCAFs)                          \
      SymX(RtsFlags)                            \
sof's avatar
sof committed
708
      RTS_USER_SIGNALS_SYMBOLS
709

710
#ifdef SUPPORT_LONG_LONGS
711
#define RTS_LONG_LONG_SYMS			\
712 713
      SymX(int64ToIntegerzh_fast)		\
      SymX(word64ToIntegerzh_fast)
714 715 716 717
#else
#define RTS_LONG_LONG_SYMS /* nothing */
#endif

718 719 720
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
#define RTS_LIBGCC_SYMBOLS			\
721 722 723
      Sym(__divdi3)                             \
      Sym(__udivdi3)                            \
      Sym(__moddi3)                             \
724
      Sym(__umoddi3)				\
725
      Sym(__muldi3)				\
726 727 728 729
      Sym(__ashldi3)				\
      Sym(__ashrdi3)				\
      Sym(__lshrdi3)				\
      Sym(__eprintf)
730
#elif defined(ia64_HOST_ARCH)
731 732 733 734 735 736 737
#define RTS_LIBGCC_SYMBOLS			\
      Sym(__divdi3)				\
      Sym(__udivdi3)                            \
      Sym(__moddi3)				\
      Sym(__umoddi3)				\
      Sym(__divsf3)				\
      Sym(__divdf3)
738 739 740 741
#else
#define RTS_LIBGCC_SYMBOLS
#endif

742
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
743 744 745 746 747 748
      // 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)
749
#endif
750 751

/* entirely bogus claims about types of these symbols */
752
#define Sym(vvv)  extern void vvv(void);
753
#define SymX(vvv) /**/
754
#define SymX_redirect(vvv,xxx) /**/
755
RTS_SYMBOLS
756
RTS_RET_SYMBOLS
757
RTS_LONG_LONG_SYMS
758
RTS_POSIX_ONLY_SYMBOLS
759
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
760
RTS_CYGWIN_ONLY_SYMBOLS
761
RTS_DARWIN_ONLY_SYMBOLS
762
RTS_LIBGCC_SYMBOLS
763 764
#undef Sym
#undef SymX
765
#undef SymX_redirect
766 767 768 769 770 771 772 773 774 775 776

#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)

777 778 779 780 781 782
// 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)) },

783
static RtsSymbolVal rtsSyms[] = {
784
      RTS_SYMBOLS
785
      RTS_RET_SYMBOLS
786
      RTS_LONG_LONG_SYMS
787
      RTS_POSIX_ONLY_SYMBOLS
788
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
789
      RTS_CYGWIN_ONLY_SYMBOLS
790
      RTS_DARWIN_ONLY_SYMBOLS
791
      RTS_LIBGCC_SYMBOLS
792 793 794 795
#if defined(darwin_HOST_OS) && defined(i386_HOST_ARCH)
      // dyld stub code contains references to this,
      // but it should never be called because we treat
      // lazy pointers as nonlazy.
796
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
797
#endif
798 799 800
      { 0, 0 } /* sentinel */
};

801 802


803 804 805
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
806

807 808
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
809
                                     char* key,
810 811 812 813 814 815 816 817
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
818
   debugBelch(
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
      "\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);
}
836 837 838
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
839 840 841 842


static int linker_init_done = 0 ;

843
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
844
static void *dl_prog_handle;
845
#endif
846 847 848 849

void
initLinker( void )
{
850
    RtsSymbolVal *sym;
851

852 853 854 855 856 857 858
    /* 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;
    }

859
    stablehash = allocStrHashTable();
860 861 862 863
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
864 865
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
866
    }
867
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
868 869 870
    machoInitSymbolsWithoutUnderscore();
#   endif

871
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
872
#   if defined(RTLD_DEFAULT)
873 874
    dl_prog_handle = RTLD_DEFAULT;
#   else
875
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
876
#   endif /* RTLD_DEFAULT */
877
#   endif
878 879
}

880
/* -----------------------------------------------------------------------------
881 882 883
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
884 885 886 887
 * 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
888 889
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
890
 * In the PEi386 case, open the DLLs and put handles to them in a
891
 * linked list.  When looking for a symbol, try all handles in the
892 893 894 895 896
 * 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.
897
 *
898
 */
899 900 901 902 903 904

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

typedef
   struct _OpenedDLL {
905
      char*              name;
906 907
      struct _OpenedDLL* next;
      HINSTANCE instance;
908
   }
909 910 911 912 913 914
   OpenedDLL;

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

915 916
char *
addDLL( char *dll_name )
917
{
918
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
919
   /* ------------------- ELF DLL loader ------------------- */
920
   void *hdl;
921
   char *errmsg;
922

923 924
   initLinker();

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

927 928 929 930 931 932 933 934
   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;
   }
935 936
   /*NOTREACHED*/

937
#  elif defined(OBJFORMAT_PEi386)
938
   /* ------------------- Win32 DLL loader ------------------- */
939

940
   char*      buf;
941
   OpenedDLL* o_dll;
942
   HINSTANCE  instance;
943

944 945
   initLinker();

946
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
947 948 949 950 951

   /* 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;
952 953
   }

954 955 956 957 958 959 960 961 962 963
   /* 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. */

964
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
965 966 967
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
968
	 sprintf(buf, "%s.DRV", dll_name);	// KAA: allow loading of drivers (like winspool.drv)
969 970
	 instance = LoadLibrary(buf);
	 if (instance == NULL) {
sof's avatar
sof committed
971
		stgFree(buf);
972 973 974 975

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

979
   /* Add this DLL to the list of DLLs in which to search for symbols. */
980
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
981 982
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
983
   o_dll->instance = instance;
984 985
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
986 987

   return NULL;
988 989 990 991 992
#  else
   barf("addDLL: not implemented on this platform");
#  endif
}

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
/* -----------------------------------------------------------------------------
 * insert a stable symbol in the hash table
 */

void
insertStableSymbol(char* obj_name, char* key, StgPtr p)
{
  ghciInsertStrHashTable(obj_name, stablehash, key, getStablePtr(p));
}


/* -----------------------------------------------------------------------------
 * insert a symbol in the hash table
 */
void
insertSymbol(char* obj_name, char* key, void* data)
{
  ghciInsertStrHashTable(obj_name, symhash, key, data);
}

1013 1014
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
1015
 */
1016 1017 1018
void *
lookupSymbol( char *lbl )
{
1019
    void *val;
1020
    initLinker() ;
1021
    ASSERT(symhash != NULL);
1022 1023 1024
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
1025
#       if defined(OBJFORMAT_ELF)
1026
#	if defined(x86_64_HOST_ARCH)
1027 1028 1029 1030 1031 1032 1033 1034 1035
	val = dlsym(dl_prog_handle, lbl);
	if (val >= (void *)0x80000000) {
	    void *new_val;
	    new_val = x86_64_high_symbol(lbl, val);
	    IF_DEBUG(linker,debugBelch("lookupSymbol: relocating out of range symbol: %s = %p, now %p\n", lbl, val, new_val));
	    return new_val;
	} else {
	    return val;
	}
1036
#	else
1037
	return dlsym(dl_prog_handle, lbl);
dons's avatar
dons committed
1038
#	endif
1039 1040 1041 1042 1043 1044 1045
#       elif defined(OBJFORMAT_MACHO)
	if(NSIsSymbolNameDefined(lbl)) {
	    NSSymbol symbol = NSLookupAndBindSymbol(lbl);
	    return NSAddressOfSymbol(symbol);
	} else {
	    return NULL;
	}
1046
#       elif defined(OBJFORMAT_PEi386)
1047 1048 1049
        OpenedDLL* o_dll;
        void* sym;
        for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1050
	  /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1051 1052 1053 1054 1055 1056 1057
           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
1058
              if (sym != NULL) {
1059
		/*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
sof's avatar
sof committed
1060
		return sym;
1061
	      }
1062
           }
1063
           sym = GetProcAddress(o_dll->instance, lbl);
sof's avatar
sof committed
1064
           if (sym != NULL) {
1065
	     /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
sof's avatar
sof committed
1066 1067
	     return sym;
	   }
1068
        }
1069
        return NULL;
ken's avatar
ken committed
1070 1071 1072
#       else
        ASSERT(2+2 == 5);
        return NULL;
1073
#       endif
1074
    } else {
1075
	return val;
1076 1077 1078
    }
}

1079
static
1080
__attribute((unused))
1081 1082 1083
void *
lookupLocalSymbol( ObjectCode* oc, char *lbl )
{
1084
    void *val;
1085
    initLinker() ;
1086 1087 1088 1089 1090
    val = lookupStrHashTable(oc->lochash, lbl);

    if (val == NULL) {
        return NULL;
    } else {
1091
	return val;
1092 1093 1094 1095
    }
}


1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
/* -----------------------------------------------------------------------------
 * 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;
1110 1111 1112

   initLinker();

1113 1114 1115 1116
   for (oc = objects; oc; oc = oc->next) {
      for (i = 0; i < oc->n_symbols; i++) {
         sym = oc->symbols[i];
         if (sym == NULL) continue;
1117
         // debugBelch("enquire %p %p\n", sym, oc->lochash);
1118
         a = NULL;
1119
         if (oc->lochash != NULL) {
1120
            a = lookupStrHashTable(oc