Linker.c 145 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
#if !defined(HAVE_DLFCN_H)
87
#  include <mach-o/dyld.h>
88
#endif
89 90 91
#if defined(powerpc_HOST_ARCH)
#  include <mach-o/ppc/reloc.h>
#endif
92 93 94
#if defined(x86_64_HOST_ARCH)
#  include <mach-o/x86_64/reloc.h>
#endif
95 96
#endif

97
/* Hash table mapping symbol names to Symbol */
98
static /*Str*/HashTable *symhash;
99

100 101 102
/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;

103 104 105
/* List of currently loaded objects */
ObjectCode *objects = NULL;	/* initially empty */

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

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

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
/* on x86_64 we have a problem with relocating symbol references in
 * code that was compiled without -fPIC.  By default, the small memory
 * model is used, which assumes that symbol references can fit in a
 * 32-bit slot.  The system dynamic linker makes this work for
 * references to shared libraries by either (a) allocating a jump
 * table slot for code references, or (b) moving the symbol at load
 * time (and copying its contents, if necessary) for data references.
 *
 * We unfortunately can't tell whether symbol references are to code
 * or data.  So for now we assume they are code (the vast majority
 * are), and allocate jump-table slots.  Unfortunately this will
 * SILENTLY generate crashing code for data references.  This hack is
 * enabled by X86_64_ELF_NONPIC_HACK.
 * 
 * One workaround is to use shared Haskell libraries.  This is
 * coming.  Another workaround is to keep the static libraries but
 * compile them with -fPIC, because that will generate PIC references
 * to data which can be relocated.  The PIC code is still too green to
 * do this systematically, though.
 *
 * See bug #781
 * See thread http://www.haskell.org/pipermail/cvs-ghc/2007-September/038458.html
 */
#define X86_64_ELF_NONPIC_HACK 1
155

156 157 158 159
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

160 161 162 163 164 165
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;


166 167 168 169 170 171 172 173
#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
174

175
#if !defined (mingw32_HOST_OS)
176
#define RTS_POSIX_ONLY_SYMBOLS                  \
177 178
      Sym(lockFile)                             \
      Sym(unlockFile)                           \
179
      SymX(signal_handlers)			\
180 181
      SymX(stg_sig_install)			\
      Sym(nocldstop)
sof's avatar
sof committed
182
#endif
183

184
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
185 186 187
#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
188
 * exports; sigh.
sof's avatar
sof committed
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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
 */
#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)                               \
266
      SymX(waitpid)
267

268
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
269 270
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
271
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
272 273
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
274

275 276 277 278
/* Extra syms gen'ed by mingw-2's gcc-3.2: */
#if __GNUC__>=3
#define RTS_MINGW_EXTRA_SYMS                    \
      Sym(_imp____mb_cur_max)                   \
279
      Sym(_imp___pctype)
280 281 282 283
#else
#define RTS_MINGW_EXTRA_SYMS
#endif

284 285 286 287 288 289
#if HAVE_GETTIMEOFDAY
#define RTS_MINGW_GETTIMEOFDAY_SYM Sym(gettimeofday)
#else
#define RTS_MINGW_GETTIMEOFDAY_SYM /**/
#endif

290 291
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
292
#define RTS_MINGW_ONLY_SYMBOLS                  \
sof's avatar
sof committed
293 294
      SymX(asyncReadzh_fast)			\
      SymX(asyncWritezh_fast)			\
sof's avatar
sof committed
295
      SymX(asyncDoProczh_fast)			\
296
      SymX(memset)                              \
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
      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)                              \
329 330 331
      SymX(memmove)                             \
      SymX(realloc)                             \
      SymX(malloc)                              \
332 333 334 335 336 337 338 339 340 341 342 343 344
      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)                                \
345 346 347 348 349 350 351 352 353 354 355 356 357
      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)                                \
358
      SymX(memcpy)                              \
sof's avatar
sof committed
359 360
      SymX(rts_InstallConsoleEvent)             \
      SymX(rts_ConsoleHandlerDone)              \
361
      Sym(mktime)                               \
362
      Sym(_imp___timezone)                      \
363
      Sym(_imp___tzname)                        \
364
      Sym(_imp__tzname)                         \
365
      Sym(_imp___iob)                           \
sof's avatar
sof committed
366
      Sym(_imp___osver)                         \
367 368 369 370
      Sym(localtime)                            \
      Sym(gmtime)                               \
      Sym(opendir)                              \
      Sym(readdir)                              \
sof's avatar
sof committed
371
      Sym(rewinddir)                            \
372
      RTS_MINGW_EXTRA_SYMS                      \
373
      RTS_MINGW_GETTIMEOFDAY_SYM		\
374
      Sym(closedir)
375
#endif
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 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
#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
427 428 429 430 431
#ifndef SMP
# define MAIN_CAP_SYM SymX(MainCapability)
#else
# define MAIN_CAP_SYM
#endif
432

sof's avatar
sof committed
433 434 435 436
#if !defined(mingw32_HOST_OS)
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(setIOManagerPipe)
#else
Simon Marlow's avatar
Simon Marlow committed
437 438 439 440 441
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(sendIOManagerEvent) \
   SymX(readIOManagerEvent) \
   SymX(getIOManagerEvent) \
   SymX(console_handler)
sof's avatar
sof committed
442 443
#endif

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
#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

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
/* On Windows, we link libgmp.a statically into libHSrts.dll */
#ifdef mingw32_HOST_OS
#define GMP_SYMS				\
      SymX(__gmpz_cmp)				\
      SymX(__gmpz_cmp_si)			\
      SymX(__gmpz_cmp_ui)			\
      SymX(__gmpz_get_si)			\
      SymX(__gmpz_get_ui)
#else
#define GMP_SYMS				\
      SymExtern(__gmpz_cmp)			\
      SymExtern(__gmpz_cmp_si)			\
      SymExtern(__gmpz_cmp_ui)			\
      SymExtern(__gmpz_get_si)			\
      SymExtern(__gmpz_get_ui)
#endif

483
#define RTS_SYMBOLS				\
484
      Maybe_Stable_Names			\
485
      SymX(StgReturn)				\
486 487
      SymX(stg_enter_info)			\
      SymX(stg_gc_void_info)			\
488 489
      SymX(__stg_gc_enter_1)			\
      SymX(stg_gc_noregs)			\
490
      SymX(stg_gc_unpt_r1_info)			\
491
      SymX(stg_gc_unpt_r1)			\
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
      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)			\
508
      SymX(stg_yield_to_interpreter)		\
509 510 511 512 513
      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
514
      MAIN_CAP_SYM                              \
515 516 517 518 519 520
      SymX(MallocFailHook)			\
      SymX(OnExitHook)				\
      SymX(OutOfHeapHook)			\
      SymX(StackOverflowHook)			\
      SymX(__encodeDouble)			\
      SymX(__encodeFloat)			\
dons's avatar
dons committed
521
      SymX(addDLL)               		\
522
      GMP_SYMS					\
523 524 525
      SymX(__int_encodeDouble)			\
      SymX(__int_encodeFloat)			\
      SymX(andIntegerzh_fast)			\
526
      SymX(atomicallyzh_fast)			\
527
      SymX(barf)				\
528 529
      SymX(debugBelch)				\
      SymX(errorBelch)				\
530 531
      SymX(blockAsyncExceptionszh_fast)		\
      SymX(catchzh_fast)			\
532 533
      SymX(catchRetryzh_fast)			\
      SymX(catchSTMzh_fast)			\
tharris@microsoft.com's avatar
tharris@microsoft.com committed
534
      SymX(checkzh_fast)                        \
sof's avatar
sof committed
535
      SymX(closure_flags)                       \
536
      SymX(cmp_thread)				\
sof's avatar
sof committed
537 538
      SymX(cmpIntegerzh_fast)	        	\
      SymX(cmpIntegerIntzh_fast)	      	\
sof's avatar
sof committed
539
      SymX(complementIntegerzh_fast)		\
540 541 542 543 544
      SymX(createAdjustor)			\
      SymX(decodeDoublezh_fast)			\
      SymX(decodeFloatzh_fast)			\
      SymX(defaultsHook)			\
      SymX(delayzh_fast)			\
sof's avatar
sof committed
545 546
      SymX(deRefWeakzh_fast)			\
      SymX(deRefStablePtrzh_fast)		\
547
      SymX(dirty_MUT_VAR)			\
548 549 550
      SymX(divExactIntegerzh_fast)		\
      SymX(divModIntegerzh_fast)		\
      SymX(forkzh_fast)				\
Simon Marlow's avatar
Simon Marlow committed
551
      SymX(forkOnzh_fast)			\
552
      SymX(forkProcess)				\
553
      SymX(forkOS_createThread)			\
554
      SymX(freeHaskellFunctionPtr)		\
sof's avatar
sof committed
555
      SymX(freeStablePtr)		        \
ei@vuokko.info's avatar
ei@vuokko.info committed
556
      SymX(getOrSetTypeableStore)		\
557
      SymX(gcdIntegerzh_fast)			\
sof's avatar
sof committed
558 559
      SymX(gcdIntegerIntzh_fast)		\
      SymX(gcdIntzh_fast)			\
560
      SymX(genSymZh)				\
dons's avatar
dons committed
561
      SymX(genericRaise)			\
562
      SymX(getProgArgv)				\
563
      SymX(getFullProgArgv)				\
564
      SymX(getStablePtr)			\
565 566 567 568 569 570 571
      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)			\
572
      SymX(hs_hpc_rootModule)		        \
573
      SymX(initLinker)				\
574 575
      SymX(unpackClosurezh_fast)                \
      SymX(getApStackValzh_fast)                \
576
      SymX(int2Integerzh_fast)			\
sof's avatar
sof committed
577 578
      SymX(integer2Intzh_fast)			\
      SymX(integer2Wordzh_fast)			\
579
      SymX(isCurrentThreadBoundzh_fast)		\
580 581 582 583
      SymX(isDoubleDenormalized)		\
      SymX(isDoubleInfinite)			\
      SymX(isDoubleNaN)				\
      SymX(isDoubleNegativeZero)		\
sof's avatar
sof committed
584
      SymX(isEmptyMVarzh_fast)			\
585 586 587 588 589
      SymX(isFloatDenormalized)			\
      SymX(isFloatInfinite)			\
      SymX(isFloatNaN)				\
      SymX(isFloatNegativeZero)			\
      SymX(killThreadzh_fast)			\
dons's avatar
dons committed
590
      SymX(loadObj)          			\
591 592
      SymX(insertStableSymbol) 			\
      SymX(insertSymbol)     			\
dons's avatar
dons committed
593
      SymX(lookupSymbol)     			\
sof's avatar
sof committed
594
      SymX(makeStablePtrzh_fast)		\
595 596
      SymX(minusIntegerzh_fast)			\
      SymX(mkApUpd0zh_fast)			\
sof's avatar
sof committed
597
      SymX(myThreadIdzh_fast)			\
598
      SymX(labelThreadzh_fast)                  \
599 600 601
      SymX(newArrayzh_fast)			\
      SymX(newBCOzh_fast)			\
      SymX(newByteArrayzh_fast)			\
602
      SymX_redirect(newCAF, newDynCAF)		\
603 604
      SymX(newMVarzh_fast)			\
      SymX(newMutVarzh_fast)			\
605
      SymX(newTVarzh_fast)			\
606
      SymX(noDuplicatezh_fast)			\
607
      SymX(atomicModifyMutVarzh_fast)		\
608
      SymX(newPinnedByteArrayzh_fast)		\
609
      SymX(newSpark)				\
610 611
      SymX(orIntegerzh_fast)			\
      SymX(performGC)				\
612
      SymX(performMajorGC)			\
613 614 615 616 617 618 619
      SymX(plusIntegerzh_fast)			\
      SymX(prog_argc)				\
      SymX(prog_argv)				\
      SymX(putMVarzh_fast)			\
      SymX(quotIntegerzh_fast)			\
      SymX(quotRemIntegerzh_fast)		\
      SymX(raisezh_fast)			\
620
      SymX(raiseIOzh_fast)			\
621
      SymX(readTVarzh_fast)			\
622 623 624
      SymX(remIntegerzh_fast)			\
      SymX(resetNonBlockingFd)			\
      SymX(resumeThread)			\
dons's avatar
dons committed
625
      SymX(resolveObjs)                         \
626
      SymX(retryzh_fast)                        \
627 628 629 630 631
      SymX(rts_apply)				\
      SymX(rts_checkSchedStatus)		\
      SymX(rts_eval)				\
      SymX(rts_evalIO)				\
      SymX(rts_evalLazyIO)			\
632
      SymX(rts_evalStableIO)			\
633 634 635 636 637 638
      SymX(rts_eval_)				\
      SymX(rts_getBool)				\
      SymX(rts_getChar)				\
      SymX(rts_getDouble)			\
      SymX(rts_getFloat)			\
      SymX(rts_getInt)				\
639 640
      SymX(rts_getInt8)				\
      SymX(rts_getInt16)			\
641
      SymX(rts_getInt32)			\
642
      SymX(rts_getInt64)			\
643
      SymX(rts_getPtr)				\
644
      SymX(rts_getFunPtr)			\
645
      SymX(rts_getStablePtr)			\
646
      SymX(rts_getThreadId)			\
647
      SymX(rts_getWord)				\
648 649
      SymX(rts_getWord8)			\
      SymX(rts_getWord16)			\
650
      SymX(rts_getWord32)			\
651
      SymX(rts_getWord64)			\
652
      SymX(rts_lock)				\
653 654 655 656 657
      SymX(rts_mkBool)				\
      SymX(rts_mkChar)				\
      SymX(rts_mkDouble)			\
      SymX(rts_mkFloat)				\
      SymX(rts_mkInt)				\
658
      SymX(rts_mkInt8)				\
659 660 661 662
      SymX(rts_mkInt16)				\
      SymX(rts_mkInt32)				\
      SymX(rts_mkInt64)				\
      SymX(rts_mkPtr)				\
663
      SymX(rts_mkFunPtr)			\
664 665 666
      SymX(rts_mkStablePtr)			\
      SymX(rts_mkString)			\
      SymX(rts_mkWord)				\
667
      SymX(rts_mkWord8)				\
668 669 670
      SymX(rts_mkWord16)			\
      SymX(rts_mkWord32)			\
      SymX(rts_mkWord64)			\
671
      SymX(rts_unlock)				\
672
      SymX(rtsSupportsBoundThreads)		\
673 674
      SymX(__hscore_get_saved_termios)		\
      SymX(__hscore_set_saved_termios)		\
675
      SymX(setProgArgv)				\
676 677
      SymX(startupHaskell)			\
      SymX(shutdownHaskell)			\
678 679 680 681
      SymX(shutdownHaskellAndExit)		\
      SymX(stable_ptr_table)			\
      SymX(stackOverflow)			\
      SymX(stg_CAF_BLACKHOLE_info)		\
682
      SymX(awakenBlockedQueue)			\
683
      SymX(stg_CHARLIKE_closure)		\
684 685
      SymX(stg_MVAR_CLEAN_info)			\
      SymX(stg_MVAR_DIRTY_info)			\
686 687
      SymX(stg_IND_STATIC_info)			\
      SymX(stg_INTLIKE_closure)			\
688
      SymX(stg_MUT_ARR_PTRS_DIRTY_info)		\
689
      SymX(stg_MUT_ARR_PTRS_FROZEN_info)	\
690
      SymX(stg_MUT_ARR_PTRS_FROZEN0_info)	\
691
      SymX(stg_WEAK_info)                       \
692 693 694 695 696 697 698 699 700 701
      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)			\
702
      SymX(stg_ap_pppv_info)			\
703 704 705
      SymX(stg_ap_pppp_info)			\
      SymX(stg_ap_ppppp_info)			\
      SymX(stg_ap_pppppp_info)			\
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
      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)			\
721
      SymX(stg_ap_1_upd_info)			\
722 723 724 725 726 727
      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)			\
728
      SymX(stg_exit)				\
729
      SymX(stg_sel_0_upd_info)			\
730 731 732 733 734 735
      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)			\
736 737 738 739 740 741 742 743 744
      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)			\
745 746
      SymX(stg_upd_frame_info)			\
      SymX(suspendThread)			\
747
      SymX(takeMVarzh_fast)			\
748
      SymX(timesIntegerzh_fast)			\
749
      SymX(tryPutMVarzh_fast)			\
750 751
      SymX(tryTakeMVarzh_fast)			\
      SymX(unblockAsyncExceptionszh_fast)	\
dons's avatar
dons committed
752
      SymX(unloadObj)                           \
753
      SymX(unsafeThawArrayzh_fast)		\
754 755
      SymX(waitReadzh_fast)			\
      SymX(waitWritezh_fast)			\
756
      SymX(word2Integerzh_fast)			\
757
      SymX(writeTVarzh_fast)			\
758
      SymX(xorIntegerzh_fast)			\
sof's avatar
sof committed
759
      SymX(yieldzh_fast)                        \
760
      SymX(stg_interp_constr_entry)             \
761 762
      SymX(allocateExec)	                \
      SymX(freeExec)		                \
763 764 765
      SymX(getAllocations)                      \
      SymX(revertCAFs)                          \
      SymX(RtsFlags)                            \
766
      SymX(rts_breakpoint_io_action)		\
767 768
      SymX(rts_stop_next_breakpoint)		\
      SymX(rts_stop_on_exception)		\
769
      SymX(stopTimer)				\
770
      SymX(n_capabilities)			\
sof's avatar
sof committed
771
      RTS_USER_SIGNALS_SYMBOLS
772

773
#ifdef SUPPORT_LONG_LONGS
774
#define RTS_LONG_LONG_SYMS			\
775 776
      SymX(int64ToIntegerzh_fast)		\
      SymX(word64ToIntegerzh_fast)
777 778 779 780
#else
#define RTS_LONG_LONG_SYMS /* nothing */
#endif

781 782 783
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
#define RTS_LIBGCC_SYMBOLS			\
784 785 786
      Sym(__divdi3)                             \
      Sym(__udivdi3)                            \
      Sym(__moddi3)                             \
787
      Sym(__umoddi3)				\
788
      Sym(__muldi3)				\
789 790 791 792
      Sym(__ashldi3)				\
      Sym(__ashrdi3)				\
      Sym(__lshrdi3)				\
      Sym(__eprintf)
793
#elif defined(ia64_HOST_ARCH)
794 795 796 797 798 799 800
#define RTS_LIBGCC_SYMBOLS			\
      Sym(__divdi3)				\
      Sym(__udivdi3)                            \
      Sym(__moddi3)				\
      Sym(__umoddi3)				\
      Sym(__divsf3)				\
      Sym(__divdf3)
801 802 803 804
#else
#define RTS_LIBGCC_SYMBOLS
#endif

805
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
806 807 808 809 810 811
      // 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)
812
#endif
813 814

/* entirely bogus claims about types of these symbols */
815
#define Sym(vvv)  extern void vvv(void);
816
#if defined(__PIC__) && defined(mingw32_TARGET_OS)
817 818 819 820
#define SymExtern(vvv)  extern void _imp__ ## vvv (void);
#else
#define SymExtern(vvv)  SymX(vvv)
#endif
821
#define SymX(vvv) /**/
822
#define SymX_redirect(vvv,xxx) /**/
823
RTS_SYMBOLS
824
RTS_RET_SYMBOLS
825
RTS_LONG_LONG_SYMS
826
RTS_POSIX_ONLY_SYMBOLS
827
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
828
RTS_CYGWIN_ONLY_SYMBOLS
829
RTS_DARWIN_ONLY_SYMBOLS
830
RTS_LIBGCC_SYMBOLS
831 832
#undef Sym
#undef SymX
833
#undef SymX_redirect
834
#undef SymExtern
835 836 837 838 839 840 841 842 843 844

#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)
845
#define SymExtern(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
846
	    (void*)DLL_IMPORT_DATA_REF(vvv) },
847

848 849 850 851 852 853
// 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)) },

854
static RtsSymbolVal rtsSyms[] = {
855
      RTS_SYMBOLS
856
      RTS_RET_SYMBOLS
857
      RTS_LONG_LONG_SYMS
858
      RTS_POSIX_ONLY_SYMBOLS
859
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
860
      RTS_CYGWIN_ONLY_SYMBOLS
861
      RTS_DARWIN_ONLY_SYMBOLS
862
      RTS_LIBGCC_SYMBOLS
863 864 865 866
#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.
867
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
868
#endif
869 870 871
      { 0, 0 } /* sentinel */
};

872 873


874 875 876
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
877

878 879
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
880
                                     char* key,
881 882 883 884 885 886 887 888
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
889
   debugBelch(
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
      "\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);
}
907 908 909
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
910 911 912 913


static int linker_init_done = 0 ;

914
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
915
static void *dl_prog_handle;
916
#endif
917 918 919 920

void
initLinker( void )
{
921
    RtsSymbolVal *sym;
922

923 924 925 926 927 928 929
    /* 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;
    }

930
    stablehash = allocStrHashTable();
931 932 933 934
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
935 936
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
937
    }
938
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
939 940 941
    machoInitSymbolsWithoutUnderscore();
#   endif

942
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
943
#   if defined(RTLD_DEFAULT)
944 945
    dl_prog_handle = RTLD_DEFAULT;
#   else
946
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
947
#   endif /* RTLD_DEFAULT */
948
#   endif
949 950
}

951
/* -----------------------------------------------------------------------------
952 953 954
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
955 956 957 958
 * 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
959 960
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
961
 * In the PEi386 case, open the DLLs and put handles to them in a
962
 * linked list.  When looking for a symbol, try all handles in the
963 964 965 966 967
 * 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.
968
 *
969
 */
970 971 972 973 974 975

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

typedef
   struct _OpenedDLL {
976
      char*              name;
977 978
      struct _OpenedDLL* next;
      HINSTANCE instance;
979
   }
980 981 982 983 984 985
   OpenedDLL;

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

986
const char *
987
addDLL( char *dll_name )
988
{
989
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
990
   /* ------------------- ELF DLL loader ------------------- */
991
   void *hdl;
992
   const char *errmsg;
993

994 995
   initLinker();

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

998 999 1000 1001 1002 1003 1004 1005
   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;
   }
1006 1007
   /*NOTREACHED*/

1008
#  elif defined(OBJFORMAT_PEi386)
1009
   /* ------------------- Win32 DLL loader ------------------- */
1010

1011
   char*      buf;
1012
   OpenedDLL* o_dll;
1013
   HINSTANCE  instance;
1014

1015 1016
   initLinker();

1017
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1018 1019 1020 1021 1022

   /* 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;
1023 1024
   }

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
   /* 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. */

1035
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1036 1037 1038
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
1039
	 sprintf(buf, "%s.DRV", dll_name);	// KAA: allow loading of drivers (like winspool.drv)
1040 1041
	 instance = LoadLibrary(buf);
	 if (instance == NULL) {
sof's avatar
sof committed
1042
		stgFree(buf);
1043 1044 1045 1046

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

1050
   /* Add this DLL to the list of DLLs in which to search for symbols. */
1051
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1052 1053
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
1054
   o_dll->instance = instance;
1055 1056
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
1057 1058

   return NULL;
1059 1060 1061 1062 1063
#  else
   barf("addDLL: not implemented on this platform");
#  endif
}

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
/* -----------------------------------------------------------------------------
 * 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);
}

1084 1085
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
1086
 */
1087 1088 1089
void *
lookupSymbol( char *lbl )
{
1090
    void *val;
1091
    initLinker() ;
1092
    ASSERT(symhash != NULL);
1093 1094 1095
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
1096
#       if defined(OBJFORMAT_ELF)
1097
	return dlsym(dl_prog_handle, lbl);
1098
#       elif defined(OBJFORMAT_MACHO)
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
#       if HAVE_DLFCN_H
        /* On OS X 10.3 and later, we use dlsym instead of the old legacy
           interface.

           HACK: On OS X, global symbols are prefixed with an underscore.
                 However, dlsym wants us to omit the leading underscore from the
                 symbol name. For now, we simply strip it off here (and ONLY
                 here).
        */
        ASSERT(lbl[0] == '_');
        return dlsym(dl_prog_handle, lbl+1);
#       else
1111 1112 1113 1114 1115 1116
	if(NSIsSymbolNameDefined(lbl)) {
	    NSSymbol symbol = NSLookupAndBindSymbol(lbl);
	    return NSAddressOfSymbol(symbol);
	} else {