Linker.c 142 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 92
#if defined(x86_64_HOST_ARCH)
#  include <mach-o/x86_64/reloc.h>
#endif
93 94
#endif

95
/* Hash table mapping symbol names to Symbol */
96
static /*Str*/HashTable *symhash;
97

98 99 100
/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;

101 102 103
/* List of currently loaded objects */
ObjectCode *objects = NULL;	/* initially empty */

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

120
static int machoGetMisalignment( FILE * );
121 122 123
#if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
#endif
124
#ifdef powerpc_HOST_ARCH
125
static void machoInitSymbolsWithoutUnderscore( void );
126
#endif
127
#endif
128

129
#if defined(x86_64_HOST_ARCH) && defined(OBJFORMAT_ELF)
130 131 132
static void*x86_64_high_symbol( char *lbl, void *addr );
#endif

133 134 135 136
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

137 138 139 140 141 142
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;


143 144 145 146 147 148 149 150
#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
151

152
#if !defined (mingw32_HOST_OS)
153
#define RTS_POSIX_ONLY_SYMBOLS                  \
154
      SymX(signal_handlers)			\
155 156
      SymX(stg_sig_install)			\
      Sym(nocldstop)
sof's avatar
sof committed
157
#endif
158

159
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
160 161 162
#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
163
 * exports; sigh.
sof's avatar
sof committed
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 236 237 238 239 240
 */
#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)                               \
241
      SymX(waitpid)
242

243
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
244 245
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
246
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
247 248
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
249

250 251 252 253
/* Extra syms gen'ed by mingw-2's gcc-3.2: */
#if __GNUC__>=3
#define RTS_MINGW_EXTRA_SYMS                    \
      Sym(_imp____mb_cur_max)                   \
254
      Sym(_imp___pctype)
255 256 257 258
#else
#define RTS_MINGW_EXTRA_SYMS
#endif

259 260 261 262 263 264
#if HAVE_GETTIMEOFDAY
#define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
#else
#define RTS_MINGW_GETTIMEOFDAY_SYM /**/
#endif

265 266
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
267
#define RTS_MINGW_ONLY_SYMBOLS                  \
sof's avatar
sof committed
268 269
      SymX(asyncReadzh_fast)			\
      SymX(asyncWritezh_fast)			\
sof's avatar
sof committed
270
      SymX(asyncDoProczh_fast)			\
271
      SymX(memset)                              \
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
      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)                              \
304 305 306
      SymX(memmove)                             \
      SymX(realloc)                             \
      SymX(malloc)                              \
307 308 309 310 311 312 313 314 315 316 317 318 319
      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)                                \
320 321 322 323 324 325 326 327 328 329 330 331 332
      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)                                \
333
      SymX(memcpy)                              \
sof's avatar
sof committed
334 335
      SymX(rts_InstallConsoleEvent)             \
      SymX(rts_ConsoleHandlerDone)              \
336
      Sym(mktime)                               \
337
      Sym(_imp___timezone)                      \
338
      Sym(_imp___tzname)                        \
339
      Sym(_imp__tzname)                         \
340
      Sym(_imp___iob)                           \
sof's avatar
sof committed
341
      Sym(_imp___osver)                         \
342 343 344 345
      Sym(localtime)                            \
      Sym(gmtime)                               \
      Sym(opendir)                              \
      Sym(readdir)                              \
sof's avatar
sof committed
346
      Sym(rewinddir)                            \
347
      RTS_MINGW_EXTRA_SYMS                      \
348
      RTS_MINGW_GETTIMEOFDAY_SYM		\
349
      Sym(closedir)
350
#endif
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 390 391 392 393 394 395 396 397 398 399 400 401
#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
402 403 404 405 406
#ifndef SMP
# define MAIN_CAP_SYM SymX(MainCapability)
#else
# define MAIN_CAP_SYM
#endif
407

sof's avatar
sof committed
408 409 410 411
#if !defined(mingw32_HOST_OS)
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(setIOManagerPipe)
#else
Simon Marlow's avatar
Simon Marlow committed
412 413 414 415 416
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(sendIOManagerEvent) \
   SymX(readIOManagerEvent) \
   SymX(getIOManagerEvent) \
   SymX(console_handler)
sof's avatar
sof committed
417 418
#endif

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
#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

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

725
#ifdef SUPPORT_LONG_LONGS
726
#define RTS_LONG_LONG_SYMS			\
727 728
      SymX(int64ToIntegerzh_fast)		\
      SymX(word64ToIntegerzh_fast)
729 730 731 732
#else
#define RTS_LONG_LONG_SYMS /* nothing */
#endif

733 734 735
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
#define RTS_LIBGCC_SYMBOLS			\
736 737 738
      Sym(__divdi3)                             \
      Sym(__udivdi3)                            \
      Sym(__moddi3)                             \
739
      Sym(__umoddi3)				\
740
      Sym(__muldi3)				\
741 742 743 744
      Sym(__ashldi3)				\
      Sym(__ashrdi3)				\
      Sym(__lshrdi3)				\
      Sym(__eprintf)
745
#elif defined(ia64_HOST_ARCH)
746 747 748 749 750 751 752
#define RTS_LIBGCC_SYMBOLS			\
      Sym(__divdi3)				\
      Sym(__udivdi3)                            \
      Sym(__moddi3)				\
      Sym(__umoddi3)				\
      Sym(__divsf3)				\
      Sym(__divdf3)
753 754 755 756
#else
#define RTS_LIBGCC_SYMBOLS
#endif

757
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
758 759 760 761 762 763
      // 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)
764
#endif
765 766

/* entirely bogus claims about types of these symbols */
767
#define Sym(vvv)  extern void vvv(void);
768
#define SymX(vvv) /**/
769
#define SymX_redirect(vvv,xxx) /**/
770
RTS_SYMBOLS
771
RTS_RET_SYMBOLS
772
RTS_LONG_LONG_SYMS
773
RTS_POSIX_ONLY_SYMBOLS
774
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
775
RTS_CYGWIN_ONLY_SYMBOLS
776
RTS_DARWIN_ONLY_SYMBOLS
777
RTS_LIBGCC_SYMBOLS
778 779
#undef Sym
#undef SymX
780
#undef SymX_redirect
781 782 783 784 785 786 787 788 789 790 791

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

792 793 794 795 796 797
// 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)) },

798
static RtsSymbolVal rtsSyms[] = {
799
      RTS_SYMBOLS
800
      RTS_RET_SYMBOLS
801
      RTS_LONG_LONG_SYMS
802
      RTS_POSIX_ONLY_SYMBOLS
803
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
804
      RTS_CYGWIN_ONLY_SYMBOLS
805
      RTS_DARWIN_ONLY_SYMBOLS
806
      RTS_LIBGCC_SYMBOLS
807 808 809 810
#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.
811
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
812
#endif
813 814 815
      { 0, 0 } /* sentinel */
};

816 817


818 819 820
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
821

822 823
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
824
                                     char* key,
825 826 827 828 829 830 831 832
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
833
   debugBelch(
834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
      "\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);
}
851 852 853
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
854 855 856 857


static int linker_init_done = 0 ;

858
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
859
static void *dl_prog_handle;
860
#endif
861 862 863 864

void
initLinker( void )
{
865
    RtsSymbolVal *sym;
866

867 868 869 870 871 872 873
    /* 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;
    }

874
    stablehash = allocStrHashTable();
875 876 877 878
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
879 880
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
881
    }
882
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
883 884 885
    machoInitSymbolsWithoutUnderscore();
#   endif

886
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
887
#   if defined(RTLD_DEFAULT)
888 889
    dl_prog_handle = RTLD_DEFAULT;
#   else
890
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
891
#   endif /* RTLD_DEFAULT */
892
#   endif
893 894
}

895
/* -----------------------------------------------------------------------------
896 897 898
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
899 900 901 902
 * 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
903 904
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
905
 * In the PEi386 case, open the DLLs and put handles to them in a
906
 * linked list.  When looking for a symbol, try all handles in the
907 908 909 910 911
 * 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.
912
 *
913
 */
914 915 916 917 918 919

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

typedef
   struct _OpenedDLL {
920
      char*              name;
921 922
      struct _OpenedDLL* next;
      HINSTANCE instance;
923
   }
924 925 926 927 928 929
   OpenedDLL;

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

930 931
char *
addDLL( char *dll_name )
932
{
933
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
934
   /* ------------------- ELF DLL loader ------------------- */
935
   void *hdl;
936
   char *errmsg;
937

938 939
   initLinker();

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

942 943 944 945 946 947 948 949
   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;
   }
950 951
   /*NOTREACHED*/

952
#  elif defined(OBJFORMAT_PEi386)
953
   /* ------------------- Win32 DLL loader ------------------- */
954

955
   char*      buf;
956
   OpenedDLL* o_dll;
957
   HINSTANCE  instance;
958

959 960
   initLinker();

961
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
962 963 964 965 966

   /* 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;
967 968
   }

969 970 971 972 973 974 975 976 977 978
   /* 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. */

979
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
980 981 982
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
983
	 sprintf(buf, "%s.DRV", dll_name);	// KAA: allow loading of drivers (like winspool.drv)
984 985
	 instance = LoadLibrary(buf);
	 if (instance == NULL) {
sof's avatar
sof committed
986
		stgFree(buf);
987 988 989 990

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

994
   /* Add this DLL to the list of DLLs in which to search for symbols. */
995
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
996 997
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
998
   o_dll->instance = instance;
999 1000
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
1001 1002

   return NULL;
1003 1004 1005 1006 1007
#  else
   barf("addDLL: not implemented on this platform");
#  endif
}

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
/* -----------------------------------------------------------------------------
 * 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);
}

1028 1029
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
1030
 */
1031 1032 1033
void *
lookupSymbol( char *lbl )
{
1034
    void *val;
1035
    initLinker() ;
1036
    ASSERT(symhash != NULL);
1037 1038 1039
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
1040
#       if defined(OBJFORMAT_ELF)
1041
#	if defined(x86_64_HOST_ARCH)
1042 1043 1044 1045 1046 1047 1048 1049 1050
	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;
	}
1051
#	else
1052
	return dlsym(dl_prog_handle, lbl);
dons's avatar
dons committed
1053
#	endif
1054 1055 1056 1057 1058 1059 1060
#       elif defined(OBJFORMAT_MACHO)
	if(NSIsSymbolNameDefined(lbl)) {
	    NSSymbol symbol = NSLookupAndBindSymbol(lbl);
	    return NSAddressOfSymbol(symbol);
	} else {
	    return NULL;
	}
1061
#       elif defined(OBJFORMAT_PEi386)
1062 1063 1064
        OpenedDLL* o_dll;
        void* sym;
        for (o_dll = opened_dlls; o_dll != NULL; o_dll = o_dll->next) {
1065
	  /* debugBelch("look in %s for %s\n", o_dll->name, lbl); */
1066 1067 1068 1069 1070 1071 1072
           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
1073
              if (sym != NULL) {
1074
		/*debugBelch("found %s in %s\n", lbl+1,o_dll->name);*/
sof's avatar
sof committed
1075
		return sym;
1076
	      }
1077
           }
1078
           sym = GetProcAddress(o_dll->instance, lbl);
sof's avatar
sof committed
1079
           if (sym != NULL) {
1080
	     /*debugBelch("found %s in %s\n", lbl,o_dll->name);*/
sof's avatar
sof committed
1081 1082
	     return sym;
	   }
1083
        }