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

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

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

20 21 22 23 24
#include "Rts.h"
#include "RtsFlags.h"
#include "HsFFI.h"
#include "Hash.h"
#include "Linker.h"
25
#include "LinkerInternals.h"
26
#include "RtsUtils.h"
27
#include "Schedule.h"
28
#include "Storage.h"
29
#include "Sparks.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 98 99 100 101 102 103 104 105
typedef struct {
  void *addr;
} rootEntry;

/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;
rootEntry *root_ptr_table = NULL;
static rootEntry *root_ptr_free = NULL;

static unsigned int RPT_size = 0;

106 107 108
/* List of currently loaded objects */
ObjectCode *objects = NULL;	/* initially empty */

109
#if defined(OBJFORMAT_ELF)
110 111 112
static int ocVerifyImage_ELF    ( ObjectCode* oc );
static int ocGetNames_ELF       ( ObjectCode* oc );
static int ocResolve_ELF        ( ObjectCode* oc );
113
#if defined(powerpc_HOST_ARCH)
114 115
static int ocAllocateJumpIslands_ELF ( ObjectCode* oc );
#endif
116
#elif defined(OBJFORMAT_PEi386)
117 118 119
static int ocVerifyImage_PEi386 ( ObjectCode* oc );
static int ocGetNames_PEi386    ( ObjectCode* oc );
static int ocResolve_PEi386     ( ObjectCode* oc );
120 121 122 123
#elif defined(OBJFORMAT_MACHO)
static int ocVerifyImage_MachO    ( ObjectCode* oc );
static int ocGetNames_MachO       ( ObjectCode* oc );
static int ocResolve_MachO        ( ObjectCode* oc );
124

125
static int machoGetMisalignment( FILE * );
126 127
#ifdef powerpc_HOST_ARCH
static int ocAllocateJumpIslands_MachO ( ObjectCode* oc );
128
static void machoInitSymbolsWithoutUnderscore( void );
129
#endif
130
#endif
131

132 133 134 135
#if defined(x86_64_HOST_ARCH)
static void*x86_64_high_symbol( char *lbl, void *addr );
#endif

136 137 138 139
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

140 141 142 143 144 145
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;


146 147 148 149 150 151 152 153
#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
154

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

162
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
163 164 165
#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
166
 * exports; sigh.
sof's avatar
sof committed
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 241 242 243
 */
#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)                               \
244
      SymX(waitpid)
245

246
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
247 248
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
249
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
250 251
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
252

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

262 263
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
264
#define RTS_MINGW_ONLY_SYMBOLS                  \
sof's avatar
sof committed
265 266
      SymX(asyncReadzh_fast)			\
      SymX(asyncWritezh_fast)			\
sof's avatar
sof committed
267
      SymX(asyncDoProczh_fast)			\
268
      SymX(memset)                              \
269 270 271 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
      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)                              \
301 302 303
      SymX(memmove)                             \
      SymX(realloc)                             \
      SymX(malloc)                              \
304 305 306 307 308 309 310 311 312 313 314 315 316
      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)                                \
317 318 319 320 321 322 323 324 325 326 327 328 329
      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)                                \
330
      SymX(memcpy)                              \
sof's avatar
sof committed
331 332
      SymX(rts_InstallConsoleEvent)             \
      SymX(rts_ConsoleHandlerDone)              \
333
      Sym(mktime)                               \
334
      Sym(_imp___timezone)                      \
335
      Sym(_imp___tzname)                        \
336
      Sym(_imp__tzname)                         \
337
      Sym(_imp___iob)                           \
sof's avatar
sof committed
338
      Sym(_imp___osver)                         \
339 340 341 342
      Sym(localtime)                            \
      Sym(gmtime)                               \
      Sym(opendir)                              \
      Sym(readdir)                              \
sof's avatar
sof committed
343
      Sym(rewinddir)                            \
344
      RTS_MINGW_EXTRA_SYMS                      \
345
      Sym(closedir)
346
#endif
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 390 391 392 393 394 395 396 397
#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
398 399 400 401 402
#ifndef SMP
# define MAIN_CAP_SYM SymX(MainCapability)
#else
# define MAIN_CAP_SYM
#endif
403

sof's avatar
sof committed
404 405 406 407 408 409 410
#if !defined(mingw32_HOST_OS)
#define RTS_USER_SIGNALS_SYMBOLS \
   SymX(setIOManagerPipe)
#else
#define RTS_USER_SIGNALS_SYMBOLS /* nothing */
#endif

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
#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

433
#define RTS_SYMBOLS				\
434 435
      Maybe_Stable_Names			\
      Sym(StgReturn)				\
436 437
      SymX(stg_enter_info)			\
      SymX(stg_gc_void_info)			\
438 439
      SymX(__stg_gc_enter_1)			\
      SymX(stg_gc_noregs)			\
440
      SymX(stg_gc_unpt_r1_info)			\
441
      SymX(stg_gc_unpt_r1)			\
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
      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)			\
458
      SymX(stg_yield_to_interpreter)		\
459 460 461 462 463 464
      SymX(stg_gen_block)			\
      SymX(stg_block_noregs)			\
      SymX(stg_block_1)				\
      SymX(stg_block_takemvar)			\
      SymX(stg_block_putmvar)			\
      SymX(stg_seq_frame_info)			\
sof's avatar
sof committed
465
      MAIN_CAP_SYM                              \
466 467 468 469 470 471
      SymX(MallocFailHook)			\
      SymX(OnExitHook)				\
      SymX(OutOfHeapHook)			\
      SymX(StackOverflowHook)			\
      SymX(__encodeDouble)			\
      SymX(__encodeFloat)			\
dons's avatar
dons committed
472
      SymX(addDLL)               		\
473 474 475 476 477 478 479 480 481
      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)			\
482
      SymX(atomicallyzh_fast)			\
483
      SymX(barf)				\
484 485
      SymX(debugBelch)				\
      SymX(errorBelch)				\
486 487
      SymX(blockAsyncExceptionszh_fast)		\
      SymX(catchzh_fast)			\
488 489
      SymX(catchRetryzh_fast)			\
      SymX(catchSTMzh_fast)			\
sof's avatar
sof committed
490
      SymX(closure_flags)                       \
491
      SymX(cmp_thread)				\
sof's avatar
sof committed
492 493
      SymX(cmpIntegerzh_fast)	        	\
      SymX(cmpIntegerIntzh_fast)	      	\
sof's avatar
sof committed
494
      SymX(complementIntegerzh_fast)		\
495 496 497 498 499
      SymX(createAdjustor)			\
      SymX(decodeDoublezh_fast)			\
      SymX(decodeFloatzh_fast)			\
      SymX(defaultsHook)			\
      SymX(delayzh_fast)			\
sof's avatar
sof committed
500 501
      SymX(deRefWeakzh_fast)			\
      SymX(deRefStablePtrzh_fast)		\
502
      SymX(dirty_MUT_VAR)			\
503 504 505
      SymX(divExactIntegerzh_fast)		\
      SymX(divModIntegerzh_fast)		\
      SymX(forkzh_fast)				\
Simon Marlow's avatar
Simon Marlow committed
506
      SymX(forkOnzh_fast)			\
507
      SymX(forkProcess)				\
508
      SymX(forkOS_createThread)			\
509
      SymX(freeHaskellFunctionPtr)		\
sof's avatar
sof committed
510
      SymX(freeStablePtr)		        \
511
      SymX(gcdIntegerzh_fast)			\
sof's avatar
sof committed
512 513
      SymX(gcdIntegerIntzh_fast)		\
      SymX(gcdIntzh_fast)			\
514
      SymX(genSymZh)				\
dons's avatar
dons committed
515
      SymX(genericRaise)			\
516 517
      SymX(getProgArgv)				\
      SymX(getStablePtr)			\
518 519 520 521 522 523 524 525
      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)				\
526
      SymX(int2Integerzh_fast)			\
sof's avatar
sof committed
527 528
      SymX(integer2Intzh_fast)			\
      SymX(integer2Wordzh_fast)			\
529
      SymX(isCurrentThreadBoundzh_fast)		\
530 531 532 533
      SymX(isDoubleDenormalized)		\
      SymX(isDoubleInfinite)			\
      SymX(isDoubleNaN)				\
      SymX(isDoubleNegativeZero)		\
sof's avatar
sof committed
534
      SymX(isEmptyMVarzh_fast)			\
535 536 537 538 539
      SymX(isFloatDenormalized)			\
      SymX(isFloatInfinite)			\
      SymX(isFloatNaN)				\
      SymX(isFloatNegativeZero)			\
      SymX(killThreadzh_fast)			\
dons's avatar
dons committed
540
      SymX(loadObj)          			\
541 542
      SymX(insertStableSymbol) 			\
      SymX(insertSymbol)     			\
dons's avatar
dons committed
543
      SymX(lookupSymbol)     			\
sof's avatar
sof committed
544
      SymX(makeStablePtrzh_fast)		\
545 546
      SymX(minusIntegerzh_fast)			\
      SymX(mkApUpd0zh_fast)			\
sof's avatar
sof committed
547
      SymX(myThreadIdzh_fast)			\
548
      SymX(labelThreadzh_fast)                  \
549 550 551
      SymX(newArrayzh_fast)			\
      SymX(newBCOzh_fast)			\
      SymX(newByteArrayzh_fast)			\
552
      SymX_redirect(newCAF, newDynCAF)		\
553 554
      SymX(newMVarzh_fast)			\
      SymX(newMutVarzh_fast)			\
555
      SymX(newTVarzh_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 703 704 705 706 707 708 709 710
      SymX(stg_interp_constr_entry)             \
      SymX(stg_interp_constr1_entry)            \
      SymX(stg_interp_constr2_entry)            \
      SymX(stg_interp_constr3_entry)            \
      SymX(stg_interp_constr4_entry)            \
      SymX(stg_interp_constr5_entry)            \
      SymX(stg_interp_constr6_entry)            \
      SymX(stg_interp_constr7_entry)            \
      SymX(stg_interp_constr8_entry)            \
711 712
      SymX(allocateExec)	                \
      SymX(freeExec)		                \
713 714 715
      SymX(getAllocations)                      \
      SymX(revertCAFs)                          \
      SymX(RtsFlags)                            \
sof's avatar
sof committed
716
      RTS_USER_SIGNALS_SYMBOLS
717

718
#ifdef SUPPORT_LONG_LONGS
719
#define RTS_LONG_LONG_SYMS			\
720 721
      SymX(int64ToIntegerzh_fast)		\
      SymX(word64ToIntegerzh_fast)
722 723 724 725
#else
#define RTS_LONG_LONG_SYMS /* nothing */
#endif

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

750
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
751 752 753 754 755 756
      // 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)
757
#endif
758 759

/* entirely bogus claims about types of these symbols */
760
#define Sym(vvv)  extern void vvv(void);
761
#define SymX(vvv) /**/
762
#define SymX_redirect(vvv,xxx) /**/
763
RTS_SYMBOLS
764
RTS_RET_SYMBOLS
765
RTS_LONG_LONG_SYMS
766
RTS_POSIX_ONLY_SYMBOLS
767
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
768
RTS_CYGWIN_ONLY_SYMBOLS
769
RTS_DARWIN_ONLY_SYMBOLS
770
RTS_LIBGCC_SYMBOLS
771 772
#undef Sym
#undef SymX
773
#undef SymX_redirect
774 775 776 777 778 779 780 781 782 783 784

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

785 786 787 788 789 790
// 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)) },

791
static RtsSymbolVal rtsSyms[] = {
792
      RTS_SYMBOLS
793
      RTS_RET_SYMBOLS
794
      RTS_LONG_LONG_SYMS
795
      RTS_POSIX_ONLY_SYMBOLS
796
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
797
      RTS_CYGWIN_ONLY_SYMBOLS
798
      RTS_LIBGCC_SYMBOLS
799 800 801 802
#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.
803
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
804
#endif
805 806 807
      { 0, 0 } /* sentinel */
};

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860

/* -----------------------------------------------------------------------------
 * Utilities for handling root pointers.
 * -------------------------------------------------------------------------- */


#define INIT_RPT_SIZE 64

STATIC_INLINE void
initFreeList(rootEntry *table, nat n, rootEntry *free)
{
  rootEntry *p;

  for (p = table + n - 1; p >= table; p--) {
    p->addr   = (P_)free;
    free = p;
  }
  root_ptr_free = table;
}

void
initRootPtrTable(void)
{
  if (RPT_size > 0)
    return;

  RPT_size = INIT_RPT_SIZE;
  root_ptr_table = stgMallocBytes(RPT_size * sizeof(rootEntry),
                                    "initRootPtrTable");

  initFreeList(root_ptr_table,INIT_RPT_SIZE,NULL);
}


void
enlargeRootPtrTable(void)
{
  nat old_RPT_size = RPT_size;

  // 2nd and subsequent times
  RPT_size *= 2;
  root_ptr_table =
    stgReallocBytes(root_ptr_table,
                    RPT_size * sizeof(rootEntry),
                    "enlargeRootPtrTable");

  initFreeList(root_ptr_table + old_RPT_size, old_RPT_size, NULL);
}

static void
addRootObject(void *addr)
{
  StgWord rt;
861
  initRootPtrTable();
862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
  if (root_ptr_free == NULL) {
    enlargeRootPtrTable();
  }

  rt = root_ptr_free - root_ptr_table;
  root_ptr_free  = (rootEntry*)(root_ptr_free->addr);
  root_ptr_table[rt].addr = addr;
}

/* -----------------------------------------------------------------------------
 * Treat root pointers as roots for the garbage collector.
 * -------------------------------------------------------------------------- */

void
markRootPtrTable(evac_fn evac)
{
  rootEntry *p, *end_root_ptr_table;
  StgPtr q;

  end_root_ptr_table = &root_ptr_table[RPT_size];

  for (p = root_ptr_table; p < end_root_ptr_table; p++) {
    q = p->addr;

    if (q && (q < (P_)root_ptr_table || q >= (P_)end_root_ptr_table)) {
        evac((StgClosure **)p->addr);
    }
  }
}

/* -----------------------------------------------------------------------------
 * End of utilities for handling root pointers.
 * -------------------------------------------------------------------------- */


897 898 899 900 901
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
902
                                     char* key,
903 904 905 906 907 908 909 910
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
911
   debugBelch(
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
      "\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);
}


931 932 933
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
934 935 936 937


static int linker_init_done = 0 ;

938
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
939
static void *dl_prog_handle;
940
#endif
941

dons's avatar
dons committed
942
/* dlopen(NULL,..) doesn't work so we grab libc explicitly */
943
#if defined(openbsd_HOST_OS)
dons's avatar
dons committed
944 945 946
static void *dl_libc_handle;
#endif

947 948 949
void
initLinker( void )
{
950
    RtsSymbolVal *sym;
951

952 953 954 955 956 957 958
    /* 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;
    }

959
    stablehash = allocStrHashTable();
960 961 962 963
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
964 965
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
966
    }
967
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
968 969 970
    machoInitSymbolsWithoutUnderscore();
#   endif

971
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
972
#   if defined(RTLD_DEFAULT)
973 974
    dl_prog_handle = RTLD_DEFAULT;
#   else
975
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
976
#   if defined(openbsd_HOST_OS)
dons's avatar
dons committed
977 978
    dl_libc_handle = dlopen("libc.so", RTLD_LAZY);
#   endif
979
#   endif /* RTLD_DEFAULT */
980
#   endif
981 982
}

983
/* -----------------------------------------------------------------------------
984 985 986
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
987 988 989 990
 * 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
991 992
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
993
 * In the PEi386 case, open the DLLs and put handles to them in a
994
 * linked list.  When looking for a symbol, try all handles in the
995 996 997 998 999
 * 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.
1000
 *
1001
 */
1002 1003 1004 1005 1006 1007

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

typedef
   struct _OpenedDLL {
1008
      char*              name;
1009 1010
      struct _OpenedDLL* next;
      HINSTANCE instance;
1011
   }
1012 1013 1014 1015 1016 1017
   OpenedDLL;

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

1018 1019
char *
addDLL( char *dll_name )
1020
{
1021
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1022
   /* ------------------- ELF DLL loader ------------------- */
1023
   void *hdl;
1024
   char *errmsg;
1025

1026 1027
   initLinker();

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

1030 1031 1032 1033 1034 1035 1036 1037
   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;
   }
1038 1039
   /*NOTREACHED*/

1040
#  elif defined(OBJFORMAT_PEi386)
1041
   /* ------------------- Win32 DLL loader ------------------- */
1042

1043
   char*      buf;
1044
   OpenedDLL* o_dll;
1045
   HINSTANCE  instance;
1046

1047 1048
   initLinker();

1049
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1050 1051 1052 1053 1054

   /* 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;
1055 1056
   }

1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
   /* 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. */

1067
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1068 1069 1070
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
1071
	 sprintf(buf, "%s.DRV", dll_name);	// KAA: allow loading of drivers (like winspool.drv)
1072 1073
	 instance = LoadLibrary(buf);
	 if (instance == NULL) {
sof's avatar
sof committed
1074
		stgFree(buf);
1075 1076 1077 1078

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

1082
   /* Add this DLL to the list of DLLs in which to search for symbols. */
1083
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1084 1085
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
1086
   o_dll->instance = instance;
1087 1088
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
1089 1090

   return NULL;
1091 1092 1093 1094 1095
#  else
   barf("addDLL: not implemented on this platform");
#  endif
}

1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112