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"
ei@vuokko.info's avatar
ei@vuokko.info committed
30
#include "RtsTypeable.h"
31

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

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

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

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

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

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

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

74 75
#endif

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

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

96 97 98 99 100 101 102 103 104 105 106
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;

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

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829

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

Simon Marlow's avatar
Simon Marlow committed
830
static void
831 832 833 834 835 836 837 838 839 840 841 842 843
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);
}


Simon Marlow's avatar
Simon Marlow committed
844
static void
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
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;
863
  initRootPtrTable();
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 897 898
  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.
 * -------------------------------------------------------------------------- */


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


933 934 935
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
936 937 938 939


static int linker_init_done = 0 ;

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

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

949 950 951
void
initLinker( void )
{
952
    RtsSymbolVal *sym;
953

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

961
    stablehash = allocStrHashTable();
962 963 964 965
    symhash = allocStrHashTable();

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

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

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

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

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

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

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

1028 1029
   initLinker();

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

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

1042
#  elif defined(OBJFORMAT_PEi386)
1043
   /* ------------------- Win32 DLL loader ------------------- */
1044

1045
   char*      buf;
1046
   OpenedDLL* o_dll;
1047
   HINSTANCE  instance;
1048

1049 1050
   initLinker();

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

   /* 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;
1057 1058
   }

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

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

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

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

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

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
/* -----------------------------------------------------------------------------
 * 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);
}

1118 1119
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
1120
 */
1121 1122 1123
void *
lookupSymbol( char *lbl )
{
1124
    void *val;
1125
    initLinker() ;
1126
    ASSERT(symhash != NULL);
1127 1128 1129
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
1130
#       if defined(OBJFORMAT_ELF)
1131
#	if defined(openbsd_HOST_OS)
dons's avatar
dons committed
1132 1133
	val = dlsym(dl_prog_handle, lbl);
	return (val != NULL) ? val : dlsym(dl_libc_handle,lbl);
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
#	elif defined(x86_64_HOST_ARCH)
	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;
	}
dons's avatar
dons committed
1144
#	else /* not openbsd */
1145
	return dlsym(dl_prog_handle, lbl);
dons's avatar
dons committed
1146
#	endif
1147 1148