Linker.c 147 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
#include "Rts.h"
#include "HsFFI.h"
Simon Marlow's avatar
Simon Marlow committed
22 23

#include "sm/Storage.h"
24
#include "Hash.h"
25
#include "LinkerInternals.h"
26
#include "RtsUtils.h"
27
#include "Trace.h"
Simon Marlow's avatar
Simon Marlow committed
28 29 30 31 32 33
#include "StgPrimFloat.h" // for __int_encodeFloat etc.
#include "Stable.h"

#if !defined(mingw32_HOST_OS)
#include "posix/Signals.h"
#endif
34

35
#ifdef HAVE_SYS_TYPES_H
36
#include <sys/types.h>
37 38
#endif

39 40 41
#include <stdlib.h>
#include <string.h>

42
#ifdef HAVE_SYS_STAT_H
43
#include <sys/stat.h>
44
#endif
45

46
#if defined(HAVE_DLFCN_H)
47
#include <dlfcn.h>
48
#endif
49

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

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

71
#if defined(linux_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
dons's avatar
dons committed
72 73 74 75 76
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#endif

77 78
#endif

79
#if defined(linux_HOST_OS) || defined(solaris2_HOST_OS) || defined(freebsd_HOST_OS) || defined(netbsd_HOST_OS) || defined(openbsd_HOST_OS)
80
#  define OBJFORMAT_ELF
81
#elif defined(cygwin32_HOST_OS) || defined (mingw32_HOST_OS)
82
#  define OBJFORMAT_PEi386
83
#  include <windows.h>
sof's avatar
sof committed
84
#  include <math.h>
85
#elif defined(darwin_HOST_OS)
86 87 88 89
#  define OBJFORMAT_MACHO
#  include <mach-o/loader.h>
#  include <mach-o/nlist.h>
#  include <mach-o/reloc.h>
90
#if !defined(HAVE_DLFCN_H)
91
#  include <mach-o/dyld.h>
92
#endif
93 94 95
#if defined(powerpc_HOST_ARCH)
#  include <mach-o/ppc/reloc.h>
#endif
96 97 98
#if defined(x86_64_HOST_ARCH)
#  include <mach-o/x86_64/reloc.h>
#endif
99 100
#endif

101
/* Hash table mapping symbol names to Symbol */
102
static /*Str*/HashTable *symhash;
103

104 105 106
/* Hash table mapping symbol names to StgStablePtr */
static /*Str*/HashTable *stablehash;

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) || defined(x86_64_HOST_ARCH)
115
static int ocAllocateSymbolExtras_ELF ( ObjectCode* oc );
116
#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
static void *lookupSymbolInDLLs ( unsigned char *lbl );
static void zapTrailingAtSign   ( unsigned char *sym );
123 124 125 126
#elif defined(OBJFORMAT_MACHO)
static int ocVerifyImage_MachO    ( ObjectCode* oc );
static int ocGetNames_MachO       ( ObjectCode* oc );
static int ocResolve_MachO        ( ObjectCode* oc );
127

128
static int machoGetMisalignment( FILE * );
129 130 131
#if defined(powerpc_HOST_ARCH) || defined(x86_64_HOST_ARCH)
static int ocAllocateSymbolExtras_MachO ( ObjectCode* oc );
#endif
132
#ifdef powerpc_HOST_ARCH
133
static void machoInitSymbolsWithoutUnderscore( void );
134
#endif
135
#endif
136

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
/* 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
159 160 161 162 163 164 165 166 167 168 169 170
 *
 * Naming Scheme for Symbol Macros
 *
 * SymI_*: symbol is internal to the RTS. It resides in an object
 *         file/library that is statically.
 * SymE_*: symbol is external to the RTS library. It might be linked
 *         dynamically.
 *
 * Sym*_HasProto  : the symbol prototype is imported in an include file
 *                  or defined explicitly
 * Sym*_NeedsProto: the symbol is undefined and we add a dummy
 *                  default proto extern void sym(void);
171 172
 */
#define X86_64_ELF_NONPIC_HACK 1
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
/* Link objects into the lower 2Gb on x86_64.  GHC assumes the
 * small memory model on this architecture (see gcc docs,
 * -mcmodel=small).
 *
 * MAP_32BIT not available on OpenBSD/amd64
 */
#if defined(x86_64_HOST_ARCH) && defined(MAP_32BIT)
#define TRY_MAP_32BIT MAP_32BIT
#else
#define TRY_MAP_32BIT 0
#endif

/*
 * Due to the small memory model (see above), on x86_64 we have to map
 * all our non-PIC object files into the low 2Gb of the address space
 * (why 2Gb and not 4Gb?  Because all addresses must be reachable
 * using a 32-bit signed PC-relative offset). On Linux we can do this
 * using the MAP_32BIT flag to mmap(), however on other OSs
 * (e.g. *BSD, see #2063, and also on Linux inside Xen, see #2512), we
 * can't do this.  So on these systems, we have to pick a base address
 * in the low 2Gb of the address space and try to allocate memory from
 * there.
 *
 * We pick a default address based on the OS, but also make this
 * configurable via an RTS flag (+RTS -xm)
 */
#if defined(x86_64_HOST_ARCH)

#if defined(MAP_32BIT)
// Try to use MAP_32BIT
#define MMAP_32BIT_BASE_DEFAULT 0
#else
// A guess: 1Gb.
#define MMAP_32BIT_BASE_DEFAULT 0x40000000
#endif

Ian Lynagh's avatar
Ian Lynagh committed
210
static void *mmap_32bit_base = (void *)MMAP_32BIT_BASE_DEFAULT;
211 212 213 214 215 216 217
#endif

/* MAP_ANONYMOUS is MAP_ANON on some systems, e.g. OpenBSD */
#if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
#define MAP_ANONYMOUS MAP_ANON
#endif

218 219 220 221
/* -----------------------------------------------------------------------------
 * Built-in symbols from the RTS
 */

222 223 224 225 226
typedef struct _RtsSymbolVal {
    char   *lbl;
    void   *addr;
} RtsSymbolVal;

227 228 229 230
#define Maybe_Stable_Names      SymI_HasProto(stg_mkWeakzh)			\
      				SymI_HasProto(stg_mkWeakForeignEnvzh)		\
      				SymI_HasProto(stg_makeStableNamezh)		\
      				SymI_HasProto(stg_finalizzeWeakzh)
231

232
#if !defined (mingw32_HOST_OS)
233
#define RTS_POSIX_ONLY_SYMBOLS                  \
Simon Marlow's avatar
Simon Marlow committed
234 235
      SymI_HasProto(__hscore_get_saved_termios)	\
      SymI_HasProto(__hscore_set_saved_termios)	\
236
      SymI_HasProto(shutdownHaskellAndSignal)	\
Simon Marlow's avatar
Simon Marlow committed
237 238
      SymI_HasProto(lockFile)                   \
      SymI_HasProto(unlockFile)                 \
239 240 241
      SymI_HasProto(signal_handlers)		\
      SymI_HasProto(stg_sig_install)		\
      SymI_NeedsProto(nocldstop)
sof's avatar
sof committed
242
#endif
243

244
#if defined (cygwin32_HOST_OS)
sof's avatar
sof committed
245 246 247
#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
248
 * exports; sigh.
sof's avatar
sof committed
249
 */
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 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
#define RTS_CYGWIN_ONLY_SYMBOLS                          \
      SymI_HasProto(regfree)                             \
      SymI_HasProto(regexec)                             \
      SymI_HasProto(regerror)                            \
      SymI_HasProto(regcomp)                             \
      SymI_HasProto(__errno)                             \
      SymI_HasProto(access)                              \
      SymI_HasProto(chmod)                               \
      SymI_HasProto(chdir)                               \
      SymI_HasProto(close)                               \
      SymI_HasProto(creat)                               \
      SymI_HasProto(dup)                                 \
      SymI_HasProto(dup2)                                \
      SymI_HasProto(fstat)                               \
      SymI_HasProto(fcntl)                               \
      SymI_HasProto(getcwd)                              \
      SymI_HasProto(getenv)                              \
      SymI_HasProto(lseek)                               \
      SymI_HasProto(open)                                \
      SymI_HasProto(fpathconf)                           \
      SymI_HasProto(pathconf)                            \
      SymI_HasProto(stat)                                \
      SymI_HasProto(pow)                                 \
      SymI_HasProto(tanh)                                \
      SymI_HasProto(cosh)                                \
      SymI_HasProto(sinh)                                \
      SymI_HasProto(atan)                                \
      SymI_HasProto(acos)                                \
      SymI_HasProto(asin)                                \
      SymI_HasProto(tan)                                 \
      SymI_HasProto(cos)                                 \
      SymI_HasProto(sin)                                 \
      SymI_HasProto(exp)                                 \
      SymI_HasProto(log)                                 \
      SymI_HasProto(sqrt)                                \
      SymI_HasProto(localtime_r)                         \
      SymI_HasProto(gmtime_r)                            \
      SymI_HasProto(mktime)                              \
      SymI_NeedsProto(_imp___tzname)                     \
      SymI_HasProto(gettimeofday)                        \
      SymI_HasProto(timezone)                            \
      SymI_HasProto(tcgetattr)                           \
      SymI_HasProto(tcsetattr)                           \
      SymI_HasProto(memcpy)                              \
      SymI_HasProto(memmove)                             \
      SymI_HasProto(realloc)                             \
      SymI_HasProto(malloc)                              \
      SymI_HasProto(free)                                \
      SymI_HasProto(fork)                                \
      SymI_HasProto(lstat)                               \
      SymI_HasProto(isatty)                              \
      SymI_HasProto(mkdir)                               \
      SymI_HasProto(opendir)                             \
      SymI_HasProto(readdir)                             \
      SymI_HasProto(rewinddir)                           \
      SymI_HasProto(closedir)                            \
      SymI_HasProto(link)                                \
      SymI_HasProto(mkfifo)                              \
      SymI_HasProto(pipe)                                \
      SymI_HasProto(read)                                \
      SymI_HasProto(rename)                              \
      SymI_HasProto(rmdir)                               \
      SymI_HasProto(select)                              \
      SymI_HasProto(system)                              \
      SymI_HasProto(write)                               \
      SymI_HasProto(strcmp)                              \
      SymI_HasProto(strcpy)                              \
      SymI_HasProto(strncpy)                             \
      SymI_HasProto(strerror)                            \
      SymI_HasProto(sigaddset)                           \
      SymI_HasProto(sigemptyset)                         \
      SymI_HasProto(sigprocmask)                         \
      SymI_HasProto(umask)                               \
      SymI_HasProto(uname)                               \
      SymI_HasProto(unlink)                              \
      SymI_HasProto(utime)                               \
      SymI_HasProto(waitpid)
327

328
#elif !defined(mingw32_HOST_OS)
sof's avatar
sof committed
329 330
#define RTS_MINGW_ONLY_SYMBOLS /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
331
#else /* defined(mingw32_HOST_OS) */
sof's avatar
sof committed
332 333
#define RTS_POSIX_ONLY_SYMBOLS  /**/
#define RTS_CYGWIN_ONLY_SYMBOLS /**/
334

335 336 337
/* Extra syms gen'ed by mingw-2's gcc-3.2: */
#if __GNUC__>=3
#define RTS_MINGW_EXTRA_SYMS                    \
338 339
      SymI_NeedsProto(_imp____mb_cur_max)       \
      SymI_NeedsProto(_imp___pctype)
340 341 342 343
#else
#define RTS_MINGW_EXTRA_SYMS
#endif

344
#if HAVE_GETTIMEOFDAY
345
#define RTS_MINGW_GETTIMEOFDAY_SYM SymI_NeedsProto(gettimeofday)
346 347 348 349
#else
#define RTS_MINGW_GETTIMEOFDAY_SYM /**/
#endif

350 351 352 353 354 355
#if HAVE___MINGW_VFPRINTF
#define RTS___MINGW_VFPRINTF_SYM SymI_HasProto(__mingw_vfprintf)
#else
#define RTS___MINGW_VFPRINTF_SYM /**/
#endif

356 357
/* These are statically linked from the mingw libraries into the ghc
   executable, so we have to employ this hack. */
358
#define RTS_MINGW_ONLY_SYMBOLS                           \
359 360 361
      SymI_HasProto(stg_asyncReadzh)			 \
      SymI_HasProto(stg_asyncWritezh)			 \
      SymI_HasProto(stg_asyncDoProczh)			 \
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
      SymI_HasProto(memset)                              \
      SymI_HasProto(inet_ntoa)                           \
      SymI_HasProto(inet_addr)                           \
      SymI_HasProto(htonl)                               \
      SymI_HasProto(recvfrom)                            \
      SymI_HasProto(listen)                              \
      SymI_HasProto(bind)                                \
      SymI_HasProto(shutdown)                            \
      SymI_HasProto(connect)                             \
      SymI_HasProto(htons)                               \
      SymI_HasProto(ntohs)                               \
      SymI_HasProto(getservbyname)                       \
      SymI_HasProto(getservbyport)                       \
      SymI_HasProto(getprotobynumber)                    \
      SymI_HasProto(getprotobyname)                      \
      SymI_HasProto(gethostbyname)                       \
      SymI_HasProto(gethostbyaddr)                       \
      SymI_HasProto(gethostname)                         \
      SymI_HasProto(strcpy)                              \
      SymI_HasProto(strncpy)                             \
      SymI_HasProto(abort)                               \
      SymI_NeedsProto(_alloca)                           \
      SymI_NeedsProto(isxdigit)                          \
      SymI_NeedsProto(isupper)                           \
      SymI_NeedsProto(ispunct)                           \
      SymI_NeedsProto(islower)                           \
      SymI_NeedsProto(isspace)                           \
      SymI_NeedsProto(isprint)                           \
      SymI_NeedsProto(isdigit)                           \
      SymI_NeedsProto(iscntrl)                           \
      SymI_NeedsProto(isalpha)                           \
      SymI_NeedsProto(isalnum)                           \
394
      SymI_NeedsProto(isascii)                           \
395
      RTS___MINGW_VFPRINTF_SYM                           \
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 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
      SymI_HasProto(strcmp)                              \
      SymI_HasProto(memmove)                             \
      SymI_HasProto(realloc)                             \
      SymI_HasProto(malloc)                              \
      SymI_HasProto(pow)                                 \
      SymI_HasProto(tanh)                                \
      SymI_HasProto(cosh)                                \
      SymI_HasProto(sinh)                                \
      SymI_HasProto(atan)                                \
      SymI_HasProto(acos)                                \
      SymI_HasProto(asin)                                \
      SymI_HasProto(tan)                                 \
      SymI_HasProto(cos)                                 \
      SymI_HasProto(sin)                                 \
      SymI_HasProto(exp)                                 \
      SymI_HasProto(log)                                 \
      SymI_HasProto(sqrt)                                \
      SymI_HasProto(powf)                                \
      SymI_HasProto(tanhf)                               \
      SymI_HasProto(coshf)                               \
      SymI_HasProto(sinhf)                               \
      SymI_HasProto(atanf)                               \
      SymI_HasProto(acosf)                               \
      SymI_HasProto(asinf)                               \
      SymI_HasProto(tanf)                                \
      SymI_HasProto(cosf)                                \
      SymI_HasProto(sinf)                                \
      SymI_HasProto(expf)                                \
      SymI_HasProto(logf)                                \
      SymI_HasProto(sqrtf)                               \
      SymI_HasProto(memcpy)                              \
      SymI_HasProto(rts_InstallConsoleEvent)             \
      SymI_HasProto(rts_ConsoleHandlerDone)              \
      SymI_NeedsProto(mktime)                            \
      SymI_NeedsProto(_imp___timezone)                   \
      SymI_NeedsProto(_imp___tzname)                     \
      SymI_NeedsProto(_imp__tzname)                      \
      SymI_NeedsProto(_imp___iob)                        \
      SymI_NeedsProto(_imp___osver)                      \
      SymI_NeedsProto(localtime)                         \
      SymI_NeedsProto(gmtime)                            \
      SymI_NeedsProto(opendir)                           \
      SymI_NeedsProto(readdir)                           \
      SymI_NeedsProto(rewinddir)                         \
      RTS_MINGW_EXTRA_SYMS                               \
      RTS_MINGW_GETTIMEOFDAY_SYM		         \
      SymI_NeedsProto(closedir)
443
#endif
444

445
#if defined(darwin_TARGET_OS) && HAVE_PRINTF_LDBLSTUB
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
#define RTS_DARWIN_ONLY_SYMBOLS			            \
     SymI_NeedsProto(asprintf$LDBLStub)                     \
     SymI_NeedsProto(err$LDBLStub)                          \
     SymI_NeedsProto(errc$LDBLStub)                         \
     SymI_NeedsProto(errx$LDBLStub)                         \
     SymI_NeedsProto(fprintf$LDBLStub)                      \
     SymI_NeedsProto(fscanf$LDBLStub)                       \
     SymI_NeedsProto(fwprintf$LDBLStub)                     \
     SymI_NeedsProto(fwscanf$LDBLStub)                      \
     SymI_NeedsProto(printf$LDBLStub)                       \
     SymI_NeedsProto(scanf$LDBLStub)                        \
     SymI_NeedsProto(snprintf$LDBLStub)                     \
     SymI_NeedsProto(sprintf$LDBLStub)                      \
     SymI_NeedsProto(sscanf$LDBLStub)                       \
     SymI_NeedsProto(strtold$LDBLStub)                      \
     SymI_NeedsProto(swprintf$LDBLStub)                     \
     SymI_NeedsProto(swscanf$LDBLStub)                      \
     SymI_NeedsProto(syslog$LDBLStub)                       \
     SymI_NeedsProto(vasprintf$LDBLStub)                    \
     SymI_NeedsProto(verr$LDBLStub)                         \
     SymI_NeedsProto(verrc$LDBLStub)                        \
     SymI_NeedsProto(verrx$LDBLStub)                        \
     SymI_NeedsProto(vfprintf$LDBLStub)                     \
     SymI_NeedsProto(vfscanf$LDBLStub)                      \
     SymI_NeedsProto(vfwprintf$LDBLStub)                    \
     SymI_NeedsProto(vfwscanf$LDBLStub)                     \
     SymI_NeedsProto(vprintf$LDBLStub)                      \
     SymI_NeedsProto(vscanf$LDBLStub)                       \
     SymI_NeedsProto(vsnprintf$LDBLStub)                    \
     SymI_NeedsProto(vsprintf$LDBLStub)                     \
     SymI_NeedsProto(vsscanf$LDBLStub)                      \
     SymI_NeedsProto(vswprintf$LDBLStub)                    \
     SymI_NeedsProto(vswscanf$LDBLStub)                     \
     SymI_NeedsProto(vsyslog$LDBLStub)                      \
     SymI_NeedsProto(vwarn$LDBLStub)                        \
     SymI_NeedsProto(vwarnc$LDBLStub)                       \
     SymI_NeedsProto(vwarnx$LDBLStub)                       \
     SymI_NeedsProto(vwprintf$LDBLStub)                     \
     SymI_NeedsProto(vwscanf$LDBLStub)                      \
     SymI_NeedsProto(warn$LDBLStub)                         \
     SymI_NeedsProto(warnc$LDBLStub)                        \
     SymI_NeedsProto(warnx$LDBLStub)                        \
     SymI_NeedsProto(wcstold$LDBLStub)                      \
     SymI_NeedsProto(wprintf$LDBLStub)                      \
     SymI_NeedsProto(wscanf$LDBLStub)
491 492 493 494
#else
#define RTS_DARWIN_ONLY_SYMBOLS
#endif

sof's avatar
sof committed
495
#ifndef SMP
496
# define MAIN_CAP_SYM SymI_HasProto(MainCapability)
sof's avatar
sof committed
497 498 499
#else
# define MAIN_CAP_SYM
#endif
500

sof's avatar
sof committed
501 502
#if !defined(mingw32_HOST_OS)
#define RTS_USER_SIGNALS_SYMBOLS \
503
   SymI_HasProto(setIOManagerPipe) \
504 505
   SymI_HasProto(blockUserSignals) \
   SymI_HasProto(unblockUserSignals)
sof's avatar
sof committed
506
#else
507 508 509 510 511
#define RTS_USER_SIGNALS_SYMBOLS     \
   SymI_HasProto(sendIOManagerEvent) \
   SymI_HasProto(readIOManagerEvent) \
   SymI_HasProto(getIOManagerEvent)  \
   SymI_HasProto(console_handler)
sof's avatar
sof committed
512 513
#endif

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
#define RTS_LIBFFI_SYMBOLS                                  \
     SymE_NeedsProto(ffi_prep_cif)                          \
     SymE_NeedsProto(ffi_call)                              \
     SymE_NeedsProto(ffi_type_void)                         \
     SymE_NeedsProto(ffi_type_float)                        \
     SymE_NeedsProto(ffi_type_double)                       \
     SymE_NeedsProto(ffi_type_sint64)                       \
     SymE_NeedsProto(ffi_type_uint64)                       \
     SymE_NeedsProto(ffi_type_sint32)                       \
     SymE_NeedsProto(ffi_type_uint32)                       \
     SymE_NeedsProto(ffi_type_sint16)                       \
     SymE_NeedsProto(ffi_type_uint16)                       \
     SymE_NeedsProto(ffi_type_sint8)                        \
     SymE_NeedsProto(ffi_type_uint8)                        \
     SymE_NeedsProto(ffi_type_pointer)
529

530 531 532
#ifdef TABLES_NEXT_TO_CODE
#define RTS_RET_SYMBOLS /* nothing */
#else
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
#define RTS_RET_SYMBOLS 		                \
      SymI_HasProto(stg_enter_ret)			\
      SymI_HasProto(stg_gc_fun_ret)			\
      SymI_HasProto(stg_ap_v_ret)			\
      SymI_HasProto(stg_ap_f_ret)			\
      SymI_HasProto(stg_ap_d_ret)			\
      SymI_HasProto(stg_ap_l_ret)			\
      SymI_HasProto(stg_ap_n_ret)			\
      SymI_HasProto(stg_ap_p_ret)			\
      SymI_HasProto(stg_ap_pv_ret)			\
      SymI_HasProto(stg_ap_pp_ret)			\
      SymI_HasProto(stg_ap_ppv_ret)			\
      SymI_HasProto(stg_ap_ppp_ret)			\
      SymI_HasProto(stg_ap_pppv_ret)			\
      SymI_HasProto(stg_ap_pppp_ret)			\
      SymI_HasProto(stg_ap_ppppp_ret)			\
      SymI_HasProto(stg_ap_pppppp_ret)
550 551
#endif

552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
#define RTS_SYMBOLS				        \
      Maybe_Stable_Names			        \
      SymI_HasProto(StgReturn)				\
      SymI_HasProto(stg_enter_info)			\
      SymI_HasProto(stg_gc_void_info)			\
      SymI_HasProto(__stg_gc_enter_1)			\
      SymI_HasProto(stg_gc_noregs)			\
      SymI_HasProto(stg_gc_unpt_r1_info)		\
      SymI_HasProto(stg_gc_unpt_r1)			\
      SymI_HasProto(stg_gc_unbx_r1_info)		\
      SymI_HasProto(stg_gc_unbx_r1)			\
      SymI_HasProto(stg_gc_f1_info)			\
      SymI_HasProto(stg_gc_f1)				\
      SymI_HasProto(stg_gc_d1_info)			\
      SymI_HasProto(stg_gc_d1)				\
      SymI_HasProto(stg_gc_l1_info)			\
      SymI_HasProto(stg_gc_l1)				\
      SymI_HasProto(__stg_gc_fun)			\
      SymI_HasProto(stg_gc_fun_info)			\
      SymI_HasProto(stg_gc_gen)				\
      SymI_HasProto(stg_gc_gen_info)			\
      SymI_HasProto(stg_gc_gen_hp)			\
      SymI_HasProto(stg_gc_ut)				\
      SymI_HasProto(stg_gen_yield)			\
      SymI_HasProto(stg_yield_noregs)			\
      SymI_HasProto(stg_yield_to_interpreter)		\
      SymI_HasProto(stg_gen_block)			\
      SymI_HasProto(stg_block_noregs)			\
      SymI_HasProto(stg_block_1)			\
      SymI_HasProto(stg_block_takemvar)			\
      SymI_HasProto(stg_block_putmvar)			\
      MAIN_CAP_SYM                                      \
      SymI_HasProto(MallocFailHook)			\
      SymI_HasProto(OnExitHook)				\
      SymI_HasProto(OutOfHeapHook)			\
      SymI_HasProto(StackOverflowHook)			\
      SymI_HasProto(addDLL)               		\
      SymI_HasProto(__int_encodeDouble)			\
      SymI_HasProto(__word_encodeDouble)		\
      SymI_HasProto(__2Int_encodeDouble)		\
      SymI_HasProto(__int_encodeFloat)			\
      SymI_HasProto(__word_encodeFloat)			\
594
      SymI_HasProto(stg_atomicallyzh)			\
595 596 597
      SymI_HasProto(barf)				\
      SymI_HasProto(debugBelch)				\
      SymI_HasProto(errorBelch)				\
Simon Marlow's avatar
Simon Marlow committed
598
      SymI_HasProto(sysErrorBelch)                      \
599 600 601 602 603 604
      SymI_HasProto(stg_asyncExceptionsBlockedzh)	\
      SymI_HasProto(stg_blockAsyncExceptionszh)	        \
      SymI_HasProto(stg_catchzh)			\
      SymI_HasProto(stg_catchRetryzh)			\
      SymI_HasProto(stg_catchSTMzh)			\
      SymI_HasProto(stg_checkzh)                        \
605 606 607
      SymI_HasProto(closure_flags)                      \
      SymI_HasProto(cmp_thread)				\
      SymI_HasProto(createAdjustor)			\
608 609
      SymI_HasProto(stg_decodeDoublezu2Intzh)		\
      SymI_HasProto(stg_decodeFloatzuIntzh)		\
610
      SymI_HasProto(defaultsHook)			\
611 612 613
      SymI_HasProto(stg_delayzh)			\
      SymI_HasProto(stg_deRefWeakzh)			\
      SymI_HasProto(stg_deRefStablePtrzh)		\
614
      SymI_HasProto(dirty_MUT_VAR)			\
615 616
      SymI_HasProto(stg_forkzh)			        \
      SymI_HasProto(stg_forkOnzh)			\
617 618 619 620
      SymI_HasProto(forkProcess)			\
      SymI_HasProto(forkOS_createThread)		\
      SymI_HasProto(freeHaskellFunctionPtr)		\
      SymI_HasProto(getOrSetTypeableStore)		\
621
      SymI_HasProto(getOrSetSignalHandlerStore)		\
622 623 624 625 626 627 628 629 630 631 632 633 634
      SymI_HasProto(genSymZh)				\
      SymI_HasProto(genericRaise)			\
      SymI_HasProto(getProgArgv)			\
      SymI_HasProto(getFullProgArgv)			\
      SymI_HasProto(getStablePtr)			\
      SymI_HasProto(hs_init)				\
      SymI_HasProto(hs_exit)				\
      SymI_HasProto(hs_set_argv)			\
      SymI_HasProto(hs_add_root)			\
      SymI_HasProto(hs_perform_gc)			\
      SymI_HasProto(hs_free_stable_ptr)			\
      SymI_HasProto(hs_free_fun_ptr)			\
      SymI_HasProto(hs_hpc_rootModule)		        \
635
      SymI_HasProto(hs_hpc_module)		        \
636
      SymI_HasProto(initLinker)				\
637 638 639 640 641 642
      SymI_HasProto(stg_unpackClosurezh)                \
      SymI_HasProto(stg_getApStackValzh)                \
      SymI_HasProto(stg_getSparkzh)                     \
      SymI_HasProto(stg_isCurrentThreadBoundzh)	        \
      SymI_HasProto(stg_isEmptyMVarzh)			\
      SymI_HasProto(stg_killThreadzh)			\
643 644 645 646
      SymI_HasProto(loadObj)          			\
      SymI_HasProto(insertStableSymbol) 		\
      SymI_HasProto(insertSymbol)     			\
      SymI_HasProto(lookupSymbol)     			\
647 648 649 650 651 652 653
      SymI_HasProto(stg_makeStablePtrzh)		\
      SymI_HasProto(stg_mkApUpd0zh)			\
      SymI_HasProto(stg_myThreadIdzh)			\
      SymI_HasProto(stg_labelThreadzh)                  \
      SymI_HasProto(stg_newArrayzh)			\
      SymI_HasProto(stg_newBCOzh)			\
      SymI_HasProto(stg_newByteArrayzh)  		\
654
      SymI_HasProto_redirect(newCAF, newDynCAF)		\
655 656 657 658 659 660 661
      SymI_HasProto(stg_newMVarzh)			\
      SymI_HasProto(stg_newMutVarzh)			\
      SymI_HasProto(stg_newTVarzh)			\
      SymI_HasProto(stg_noDuplicatezh)			\
      SymI_HasProto(stg_atomicModifyMutVarzh)		\
      SymI_HasProto(stg_newPinnedByteArrayzh)		\
      SymI_HasProto(stg_newAlignedPinnedByteArrayzh)	\
662 663 664 665 666
      SymI_HasProto(newSpark)				\
      SymI_HasProto(performGC)				\
      SymI_HasProto(performMajorGC)			\
      SymI_HasProto(prog_argc)				\
      SymI_HasProto(prog_argv)				\
667 668 669 670 671
      SymI_HasProto(stg_putMVarzh)			\
      SymI_HasProto(stg_raisezh)			\
      SymI_HasProto(stg_raiseIOzh)			\
      SymI_HasProto(stg_readTVarzh)			\
      SymI_HasProto(stg_readTVarIOzh)			\
672 673
      SymI_HasProto(resumeThread)			\
      SymI_HasProto(resolveObjs)                        \
674
      SymI_HasProto(stg_retryzh)                        \
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
      SymI_HasProto(rts_apply)				\
      SymI_HasProto(rts_checkSchedStatus)		\
      SymI_HasProto(rts_eval)				\
      SymI_HasProto(rts_evalIO)				\
      SymI_HasProto(rts_evalLazyIO)			\
      SymI_HasProto(rts_evalStableIO)			\
      SymI_HasProto(rts_eval_)				\
      SymI_HasProto(rts_getBool)			\
      SymI_HasProto(rts_getChar)			\
      SymI_HasProto(rts_getDouble)			\
      SymI_HasProto(rts_getFloat)			\
      SymI_HasProto(rts_getInt)				\
      SymI_HasProto(rts_getInt8)			\
      SymI_HasProto(rts_getInt16)			\
      SymI_HasProto(rts_getInt32)			\
      SymI_HasProto(rts_getInt64)			\
      SymI_HasProto(rts_getPtr)				\
      SymI_HasProto(rts_getFunPtr)			\
      SymI_HasProto(rts_getStablePtr)			\
      SymI_HasProto(rts_getThreadId)			\
      SymI_HasProto(rts_getWord)			\
      SymI_HasProto(rts_getWord8)			\
      SymI_HasProto(rts_getWord16)			\
      SymI_HasProto(rts_getWord32)			\
      SymI_HasProto(rts_getWord64)			\
      SymI_HasProto(rts_lock)				\
      SymI_HasProto(rts_mkBool)				\
      SymI_HasProto(rts_mkChar)				\
      SymI_HasProto(rts_mkDouble)			\
      SymI_HasProto(rts_mkFloat)			\
      SymI_HasProto(rts_mkInt)				\
      SymI_HasProto(rts_mkInt8)				\
      SymI_HasProto(rts_mkInt16)			\
      SymI_HasProto(rts_mkInt32)			\
      SymI_HasProto(rts_mkInt64)			\
      SymI_HasProto(rts_mkPtr)				\
      SymI_HasProto(rts_mkFunPtr)			\
      SymI_HasProto(rts_mkStablePtr)			\
      SymI_HasProto(rts_mkString)			\
      SymI_HasProto(rts_mkWord)				\
      SymI_HasProto(rts_mkWord8)			\
      SymI_HasProto(rts_mkWord16)			\
      SymI_HasProto(rts_mkWord32)			\
      SymI_HasProto(rts_mkWord64)			\
      SymI_HasProto(rts_unlock)				\
720
      SymI_HasProto(rts_unsafeGetMyCapability)          \
721 722 723 724 725 726 727 728
      SymI_HasProto(rtsSupportsBoundThreads)		\
      SymI_HasProto(setProgArgv)			\
      SymI_HasProto(startupHaskell)			\
      SymI_HasProto(shutdownHaskell)			\
      SymI_HasProto(shutdownHaskellAndExit)		\
      SymI_HasProto(stable_ptr_table)			\
      SymI_HasProto(stackOverflow)			\
      SymI_HasProto(stg_CAF_BLACKHOLE_info)		\
729
      SymI_HasProto(__stg_EAGER_BLACKHOLE_info)		\
730 731 732 733 734 735
      SymI_HasProto(startTimer)                         \
      SymI_HasProto(stg_CHARLIKE_closure)		\
      SymI_HasProto(stg_MVAR_CLEAN_info)		\
      SymI_HasProto(stg_MVAR_DIRTY_info)		\
      SymI_HasProto(stg_IND_STATIC_info)		\
      SymI_HasProto(stg_INTLIKE_closure)		\
736
      SymI_HasProto(stg_ARR_WORDS_info)                 \
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
      SymI_HasProto(stg_MUT_ARR_PTRS_DIRTY_info)	\
      SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN_info)	\
      SymI_HasProto(stg_MUT_ARR_PTRS_FROZEN0_info)	\
      SymI_HasProto(stg_WEAK_info)                      \
      SymI_HasProto(stg_ap_v_info)			\
      SymI_HasProto(stg_ap_f_info)			\
      SymI_HasProto(stg_ap_d_info)			\
      SymI_HasProto(stg_ap_l_info)			\
      SymI_HasProto(stg_ap_n_info)			\
      SymI_HasProto(stg_ap_p_info)			\
      SymI_HasProto(stg_ap_pv_info)			\
      SymI_HasProto(stg_ap_pp_info)			\
      SymI_HasProto(stg_ap_ppv_info)			\
      SymI_HasProto(stg_ap_ppp_info)			\
      SymI_HasProto(stg_ap_pppv_info)			\
      SymI_HasProto(stg_ap_pppp_info)			\
      SymI_HasProto(stg_ap_ppppp_info)			\
      SymI_HasProto(stg_ap_pppppp_info)			\
      SymI_HasProto(stg_ap_0_fast)			\
      SymI_HasProto(stg_ap_v_fast)			\
      SymI_HasProto(stg_ap_f_fast)			\
      SymI_HasProto(stg_ap_d_fast)			\
      SymI_HasProto(stg_ap_l_fast)			\
      SymI_HasProto(stg_ap_n_fast)			\
      SymI_HasProto(stg_ap_p_fast)			\
      SymI_HasProto(stg_ap_pv_fast)			\
      SymI_HasProto(stg_ap_pp_fast)			\
      SymI_HasProto(stg_ap_ppv_fast)			\
      SymI_HasProto(stg_ap_ppp_fast)			\
      SymI_HasProto(stg_ap_pppv_fast)			\
      SymI_HasProto(stg_ap_pppp_fast)			\
      SymI_HasProto(stg_ap_ppppp_fast)			\
      SymI_HasProto(stg_ap_pppppp_fast)			\
      SymI_HasProto(stg_ap_1_upd_info)			\
      SymI_HasProto(stg_ap_2_upd_info)			\
      SymI_HasProto(stg_ap_3_upd_info)			\
      SymI_HasProto(stg_ap_4_upd_info)			\
      SymI_HasProto(stg_ap_5_upd_info)			\
      SymI_HasProto(stg_ap_6_upd_info)			\
      SymI_HasProto(stg_ap_7_upd_info)			\
      SymI_HasProto(stg_exit)				\
      SymI_HasProto(stg_sel_0_upd_info)			\
      SymI_HasProto(stg_sel_10_upd_info)		\
      SymI_HasProto(stg_sel_11_upd_info)		\
      SymI_HasProto(stg_sel_12_upd_info)		\
      SymI_HasProto(stg_sel_13_upd_info)		\
      SymI_HasProto(stg_sel_14_upd_info)		\
      SymI_HasProto(stg_sel_15_upd_info)		\
      SymI_HasProto(stg_sel_1_upd_info)			\
      SymI_HasProto(stg_sel_2_upd_info)			\
      SymI_HasProto(stg_sel_3_upd_info)			\
      SymI_HasProto(stg_sel_4_upd_info)			\
      SymI_HasProto(stg_sel_5_upd_info)			\
      SymI_HasProto(stg_sel_6_upd_info)			\
      SymI_HasProto(stg_sel_7_upd_info)			\
      SymI_HasProto(stg_sel_8_upd_info)			\
      SymI_HasProto(stg_sel_9_upd_info)			\
      SymI_HasProto(stg_upd_frame_info)			\
      SymI_HasProto(suspendThread)			\
796 797 798 799 800
      SymI_HasProto(stg_takeMVarzh)			\
      SymI_HasProto(stg_threadStatuszh)		        \
      SymI_HasProto(stg_tryPutMVarzh)			\
      SymI_HasProto(stg_tryTakeMVarzh)			\
      SymI_HasProto(stg_unblockAsyncExceptionszh)	\
801
      SymI_HasProto(unloadObj)                          \
802 803 804 805 806
      SymI_HasProto(stg_unsafeThawArrayzh)		\
      SymI_HasProto(stg_waitReadzh)			\
      SymI_HasProto(stg_waitWritezh)			\
      SymI_HasProto(stg_writeTVarzh)			\
      SymI_HasProto(stg_yieldzh)                        \
807
      SymI_NeedsProto(stg_interp_constr_entry)          \
808 809 810
      SymI_HasProto(alloc_blocks)                       \
      SymI_HasProto(alloc_blocks_lim)                   \
      SymI_HasProto(allocateLocal)                      \
811 812 813 814 815 816 817 818 819 820
      SymI_HasProto(allocateExec)	                \
      SymI_HasProto(freeExec)		                \
      SymI_HasProto(getAllocations)                     \
      SymI_HasProto(revertCAFs)                         \
      SymI_HasProto(RtsFlags)                           \
      SymI_NeedsProto(rts_breakpoint_io_action)		\
      SymI_NeedsProto(rts_stop_next_breakpoint)		\
      SymI_NeedsProto(rts_stop_on_exception)		\
      SymI_HasProto(stopTimer)				\
      SymI_HasProto(n_capabilities)			\
821
      SymI_HasProto(stg_traceCcszh)                     \
sof's avatar
sof committed
822
      RTS_USER_SIGNALS_SYMBOLS
823

824

825 826
// 64-bit support functions in libgcc.a
#if defined(__GNUC__) && SIZEOF_VOID_P <= 4
827 828 829 830 831 832 833 834 835 836
#define RTS_LIBGCC_SYMBOLS			       \
      SymI_NeedsProto(__divdi3)                        \
      SymI_NeedsProto(__udivdi3)                       \
      SymI_NeedsProto(__moddi3)                        \
      SymI_NeedsProto(__umoddi3)		       \
      SymI_NeedsProto(__muldi3)			       \
      SymI_NeedsProto(__ashldi3)		       \
      SymI_NeedsProto(__ashrdi3)		       \
      SymI_NeedsProto(__lshrdi3)		       \
      SymI_NeedsProto(__eprintf)
837 838 839 840
#else
#define RTS_LIBGCC_SYMBOLS
#endif

841
#if defined(darwin_HOST_OS) && defined(powerpc_HOST_ARCH)
842 843 844 845
      // 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		\
846 847
      SymI_NeedsProto(saveFP)				\
      SymI_NeedsProto(restFP)
848
#endif
849 850

/* entirely bogus claims about types of these symbols */
851
#define SymI_NeedsProto(vvv)  extern void vvv(void);
852
#if defined(__PIC__) && defined(mingw32_TARGET_OS)
853 854
#define SymE_HasProto(vvv)    SymE_HasProto(vvv);
#define SymE_NeedsProto(vvv)    extern void _imp__ ## vvv (void);
855
#else
856 857
#define SymE_NeedsProto(vvv)  SymI_NeedsProto(vvv);
#define SymE_HasProto(vvv)    SymI_HasProto(vvv)
858
#endif
859 860
#define SymI_HasProto(vvv) /**/
#define SymI_HasProto_redirect(vvv,xxx) /**/
861
RTS_SYMBOLS
862
RTS_RET_SYMBOLS
863
RTS_POSIX_ONLY_SYMBOLS
864
RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
865
RTS_CYGWIN_ONLY_SYMBOLS
866
RTS_DARWIN_ONLY_SYMBOLS
867
RTS_LIBGCC_SYMBOLS
868
RTS_LIBFFI_SYMBOLS
869 870 871 872 873
#undef SymI_NeedsProto
#undef SymI_HasProto
#undef SymI_HasProto_redirect
#undef SymE_HasProto
#undef SymE_NeedsProto
874 875 876 877 878 879 880

#ifdef LEADING_UNDERSCORE
#define MAYBE_LEADING_UNDERSCORE_STR(s) ("_" s)
#else
#define MAYBE_LEADING_UNDERSCORE_STR(s) (s)
#endif

881
#define SymI_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
882
                    (void*)(&(vvv)) },
883
#define SymE_HasProto(vvv) { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
884
	    (void*)DLL_IMPORT_DATA_REF(vvv) },
885

886 887 888 889
#define SymI_NeedsProto(vvv) SymI_HasProto(vvv)
#define SymE_NeedsProto(vvv) SymE_HasProto(vvv)

// SymI_HasProto_redirect allows us to redirect references to one symbol to
890
// another symbol.  See newCAF/newDynCAF for an example.
891
#define SymI_HasProto_redirect(vvv,xxx) \
892 893 894
    { MAYBE_LEADING_UNDERSCORE_STR(#vvv), \
      (void*)(&(xxx)) },

895
static RtsSymbolVal rtsSyms[] = {
896
      RTS_SYMBOLS
897
      RTS_RET_SYMBOLS
898
      RTS_POSIX_ONLY_SYMBOLS
899
      RTS_MINGW_ONLY_SYMBOLS
sof's avatar
sof committed
900
      RTS_CYGWIN_ONLY_SYMBOLS
901
      RTS_DARWIN_ONLY_SYMBOLS
902
      RTS_LIBGCC_SYMBOLS
903
      RTS_LIBFFI_SYMBOLS
904 905 906 907
#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.
908
      { "dyld_stub_binding_helper", (void*)0xDEADBEEF },
909
#endif
910 911 912
      { 0, 0 } /* sentinel */
};

913 914


915 916 917
/* -----------------------------------------------------------------------------
 * Insert symbols into hash tables, checking for duplicates.
 */
918

919 920
static void ghciInsertStrHashTable ( char* obj_name,
                                     HashTable *table,
921
                                     char* key,
922 923 924 925 926 927 928 929
                                     void *data
				   )
{
   if (lookupHashTable(table, (StgWord)key) == NULL)
   {
      insertStrHashTable(table, (StgWord)key, data);
      return;
   }
930
   debugBelch(
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
      "\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);
}
948 949 950
/* -----------------------------------------------------------------------------
 * initialize the object linker
 */
951 952 953 954


static int linker_init_done = 0 ;

955
#if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
956
static void *dl_prog_handle;
957
#endif
958 959 960 961

void
initLinker( void )
{
962
    RtsSymbolVal *sym;
963

964 965 966 967 968 969 970
    /* 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;
    }

971
    stablehash = allocStrHashTable();
972 973 974 975
    symhash = allocStrHashTable();

    /* populate the symbol table with stuff from the RTS */
    for (sym = rtsSyms; sym->lbl != NULL; sym++) {
976 977
	ghciInsertStrHashTable("(GHCi built-in symbols)",
                               symhash, sym->lbl, sym->addr);
978
    }
979
#   if defined(OBJFORMAT_MACHO) && defined(powerpc_HOST_ARCH)
980 981 982
    machoInitSymbolsWithoutUnderscore();
#   endif

983
#   if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
984
#   if defined(RTLD_DEFAULT)
985 986
    dl_prog_handle = RTLD_DEFAULT;
#   else
987
    dl_prog_handle = dlopen(NULL, RTLD_LAZY);
988
#   endif /* RTLD_DEFAULT */
989
#   endif
990 991 992 993 994 995 996

#if defined(x86_64_HOST_ARCH)
    if (RtsFlags.MiscFlags.linkerMemBase != 0) {
        // User-override for mmap_32bit_base
        mmap_32bit_base = (void*)RtsFlags.MiscFlags.linkerMemBase;
    }
#endif
997 998 999 1000 1001 1002 1003 1004 1005 1006

#if defined(mingw32_HOST_OS)
    /*
     * These two libraries cause problems when added to the static link,
     * but are necessary for resolving symbols in GHCi, hence we load
     * them manually here.
     */
    addDLL("msvcrt");
    addDLL("kernel32");
#endif
1007 1008
}

1009
/* -----------------------------------------------------------------------------
1010 1011 1012
 *                  Loading DLL or .so dynamic libraries
 * -----------------------------------------------------------------------------
 *
1013 1014 1015 1016
 * 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
1017 1018
 * dl-handle.  Returns NULL if success, otherwise ptr to an err msg.
 *
1019
 * In the PEi386 case, open the DLLs and put handles to them in a
1020
 * linked list.  When looking for a symbol, try all handles in the
1021 1022 1023 1024 1025
 * 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.
1026
 *
1027
 */
1028 1029 1030 1031 1032 1033

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

typedef
   struct _OpenedDLL {
1034
      char*              name;
1035 1036
      struct _OpenedDLL* next;
      HINSTANCE instance;
1037
   }
1038 1039 1040 1041 1042 1043
   OpenedDLL;

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

1044
const char *
1045
addDLL( char *dll_name )
1046
{
1047
#  if defined(OBJFORMAT_ELF) || defined(OBJFORMAT_MACHO)
1048
   /* ------------------- ELF DLL loader ------------------- */
1049
   void *hdl;
1050
   const char *errmsg;
1051

1052 1053
   initLinker();

1054 1055 1056
   // omitted: RTLD_NOW
   // see http://www.haskell.org/pipermail/cvs-ghc/2007-September/038570.html
   hdl= dlopen(dll_name, RTLD_LAZY | RTLD_GLOBAL);
dons's avatar
dons committed
1057

1058 1059 1060 1061 1062 1063 1064 1065
   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;
   }
1066 1067
   /*NOTREACHED*/

1068
#  elif defined(OBJFORMAT_PEi386)
1069
   /* ------------------- Win32 DLL loader ------------------- */
1070

1071
   char*      buf;
1072
   OpenedDLL* o_dll;
1073
   HINSTANCE  instance;
1074

1075 1076
   initLinker();

1077
   /* debugBelch("\naddDLL; dll_name = `%s'\n", dll_name); */
1078 1079 1080 1081 1082

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

1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
   /* 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. */

1095
   buf = stgMallocBytes(strlen(dll_name) + 10, "addDLL");
1096 1097 1098
   sprintf(buf, "%s.DLL", dll_name);
   instance = LoadLibrary(buf);
   if (instance == NULL) {
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
       if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
       // KAA: allow loading of drivers (like winspool.drv)
       sprintf(buf, "%s.DRV", dll_name);
       instance = LoadLibrary(buf);
       if (instance == NULL) {
           if (GetLastError() != ERROR_MOD_NOT_FOUND) goto error;
           // #1883: allow loading of unix-style libfoo.dll DLLs
           sprintf(buf, "lib%s.DLL", dll_name);
           instance = LoadLibrary(buf);
           if (instance == NULL) {
               goto error;
           }
       }
1112
   }
sof's avatar
sof committed
1113
   stgFree(buf);
1114

1115
   /* Add this DLL to the list of DLLs in which to search for symbols. */
1116
   o_dll = stgMallocBytes( sizeof(OpenedDLL), "addDLL" );
1117 1118
   o_dll->name     = stgMallocBytes(1+strlen(dll_name), "addDLL");
   strcpy(o_dll->name, dll_name);
1119
   o_dll->instance = instance;
1120 1121
   o_dll->next     = opened_dlls;
   opened_dlls     = o_dll;
1122 1123

   return NULL;
1124 1125 1126 1127

error:
   stgFree(buf);
   sysErrorBelch(dll_name);
Simon Marlow's avatar
Simon Marlow committed
1128

1129 1130
   /* LoadLibrary failed; return a ptr to the error msg. */
   return "addDLL: could not load DLL";
Simon Marlow's avatar
Simon Marlow committed
1131 1132 1133 1134

#  else
   barf("addDLL: not implemented on this platform");
#  endif
1135 1136
}

1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
/* -----------------------------------------------------------------------------
 * 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);
}

1157 1158
/* -----------------------------------------------------------------------------
 * lookup a symbol in the hash table
1159
 */
1160 1161 1162
void *
lookupSymbol( char *lbl )
{
1163
    void *val;
1164
    initLinker() ;
1165
    ASSERT(symhash != NULL);
1166 1167 1168
    val = lookupStrHashTable(symhash, lbl);

    if (val == NULL) {
1169
#       if defined(OBJFORMAT_ELF)
1170
	return dlsym(dl_prog_handle, lbl);
1171
#       elif defined(OBJFORMAT_MACHO)
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
#       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
1184 1185 1186 1187 1188 1189
	if(NSIsSymbolNameDefined(lbl)) {
	    NSSymbol symbol = NSLookupAndBindSymbol(lbl);
	    return NSAddressOfSymbol(symbol);
	} else {
	    return NULL;
	}
1190
#       endif /* HAVE_DLFCN_H */
1191
#       elif defined(OBJFORMAT_PEi386)
1192
        void* sym;
1193

1194 1195
        sym = lookupSymbolInDLLs(lbl);
        if (sym != NULL) { return sym; };
1196

1197 1198 1199 1200 1201
        // Also try looking up the symbol without the @N suffix.  Some
        // DLLs have the suffixes on their symbols, some don't.
        zapTrailingAtSign ( lbl );
        sym = lookupSymbolInDLLs(lbl);
        if (sym != NULL) { return sym; };
1202
        return NULL;
1203

ken's avatar
ken committed
1204 1205 1206
#       else
        ASSERT(2+2 == 5);
        return NULL;
1207
#       endif
1208
    } else {
1209
	return val;
1210 1211 1212
    }
}

1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
/* -----------------------------------------------------------------------------
 * Debugging aid: look in GHCi's object symbol tables for symbols
 * within DELTA bytes of the specified address, and show their names.
 */
#ifdef DEBUG
void ghci_enquire ( char* addr );

void ghci_enquire ( char* addr )
{
   int   i;
   char* sym;
   char* a;
   const int DELTA = 64;
   ObjectCode* oc;
1227 1228 1229

   initLinker();

1230 1231 1232 1233 1234
   for (oc = objects; oc; oc = oc->next) {
      for (i = 0; i < oc->n_symbols; i++) {
         sym = oc->symbols[i];
         if (sym == NULL) continue;
         a = NULL;
1235
         if (a == NULL) {
1236
            a = lookupStrHashTable(symhash, sym);
1237
	 }
1238
         if (a == NULL) {
1239
	     // debugBelch("ghci_enquire: can't find %s\n", sym);
1240
         }
1241
         else if (addr-DELTA <= a && a <= addr+DELTA) {
1242
            debugBelch("%p + %3d  ==  `%s'\n", addr, (int)(a - addr), sym);
1243 1244 1245 1246 1247 1248
         }
      }
   }
}
#endif

Simon Marlow's avatar
Simon Marlow committed
1249
#ifdef USE_MMAP
1250 1251
#define ROUND_UP(x,size) ((x + size - 1) & ~(size - 1))

1252 1253 1254 1255 1256
static void *
mmapForLinker (size_t bytes, nat flags, int fd)
{
   void *map_addr = NULL;
   void *result;
1257
   int pagesize, size;
1258
   static nat fixed = 0;
1259 1260 1261

   pagesize = getpagesize();
   size = ROUND_UP(bytes, pagesize);
1262

Simon Marlow's avatar
Simon Marlow committed
1263
#if defined(x86_64_HOST_ARCH)
1264 1265 1266 1267 1268 1269 1270
mmap_again:

   if (mmap_32bit_base != 0) {
       map_addr = mmap_32bit_base;
   }
#endif

1271
   result = mmap(map_addr, size, PROT_EXEC|PROT_READ|PROT_WRITE,
1272
		    MAP_PRIVATE|TRY_MAP_32BIT|fixed|flags, fd, 0);
1273 1274

   if (result == MAP_FAILED) {
1275 1276
       sysErrorBelch("mmap %lu bytes at %p",(lnat)size,map_addr);
       errorBelch("Try specifying an address with +RTS -xm<addr> -RTS");
1277 1278 1279 1280 1281 1282
       stg_exit(EXIT_FAILURE);
   }
   
#if defined(x86_64_HOST_ARCH)
   if (mmap_32bit_base != 0) {
       if (result == map_addr) {