RtsStartup.c 13.3 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2
 *
3
 * (c) The GHC Team, 1998-2002
4 5 6 7 8
 *
 * Main function for a standalone Haskell program.
 *
 * ---------------------------------------------------------------------------*/

mrchebas@gmail.com's avatar
mrchebas@gmail.com committed
9 10 11
// PAPI uses caddr_t, which is not POSIX
// #include "PosixSource.h"

12 13 14 15
#include "Rts.h"
#include "RtsAPI.h"
#include "RtsUtils.h"
#include "RtsFlags.h"  
16
#include "OSThreads.h"
17 18
#include "Schedule.h"   /* initScheduler */
#include "Stats.h"      /* initStats */
19
#include "STM.h"        /* initSTM */
20
#include "Signals.h"
21
#include "RtsSignals.h"
22
#include "ThrIOManager.h"
sof's avatar
sof committed
23
#include "Timer.h"      /* startTimer, stopTimer */
24
#include "Weak.h"
25
#include "Ticky.h"
26
#include "StgRun.h"
27
#include "Prelude.h"		/* fixupRTStoPreludeRefs */
28 29
#include "HsFFI.h"
#include "Linker.h"
30
#include "ThreadLabels.h"
31
#include "BlockAlloc.h"
Simon Marlow's avatar
Simon Marlow committed
32
#include "Trace.h"
ei@vuokko.info's avatar
ei@vuokko.info committed
33
#include "RtsTypeable.h"
34
#include "Stable.h"
35
#include "Hpc.h"
36
#include "FileLock.h"
37

38 39 40 41
#if defined(RTS_GTK_FRONTPANEL)
#include "FrontPanel.h"
#endif

42
# include "Profiling.h"
43 44

#if defined(PROFILING)
45
# include "ProfHeap.h"
46
# include "RetainerProfile.h"
47 48
#endif

49
#if defined(GRAN)
50 51 52 53 54
# include "GranSimRts.h"
#endif

#if defined(GRAN) || defined(PAR)
# include "ParallelRts.h"
55 56 57
#endif

#if defined(PAR)
58 59
# include "Parallel.h"
# include "LLC.h"
60 61
#endif

62
#if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
sof's avatar
sof committed
63 64 65
#include "win32/AsyncIO.h"
#endif

66 67
#include <stdlib.h>

68 69 70 71 72 73 74
#ifdef HAVE_TERMIOS_H
#include <termios.h>
#endif
#ifdef HAVE_SIGNAL_H
#include <signal.h>
#endif

mrchebas@gmail.com's avatar
mrchebas@gmail.com committed
75 76 77 78
#if USE_PAPI
#include "Papi.h"
#endif

79 80
// Count of how many outstanding hs_init()s there have been.
static int hs_init_count = 0;
81

82 83 84
// Here we save the terminal settings on the standard file
// descriptors, if we need to change them (eg. to support NoBuffering
// input).
85 86 87 88 89
static void *saved_termios[3] = {NULL,NULL,NULL};

void*
__hscore_get_saved_termios(int fd)
{
90
  return (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) ?
91 92 93 94 95 96
    saved_termios[fd] : NULL;
}

void
__hscore_set_saved_termios(int fd, void* ts)
{
97
  if (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) {
98 99 100
    saved_termios[fd] = ts;
  }
}
101

102 103
/* -----------------------------------------------------------------------------
   Initialise floating point unit on x86 (currently disabled. why?)
104
   (see comment in ghc/compiler/nativeGen/MachInstrs.lhs).
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
   -------------------------------------------------------------------------- */

#define X86_INIT_FPU 0

#if X86_INIT_FPU
static void
x86_init_fpu ( void )
{
  __volatile unsigned short int fpu_cw;

  // Grab the control word
  __asm __volatile ("fnstcw %0" : "=m" (fpu_cw));

#if 0
  printf("fpu_cw: %x\n", fpu_cw);
#endif

  // Set bits 8-9 to 10 (64-bit precision).
  fpu_cw = (fpu_cw & 0xfcff) | 0x0200;

  // Store the new control word back
  __asm __volatile ("fldcw %0" : : "m" (fpu_cw));
}
128 129
#endif

130 131 132
/* -----------------------------------------------------------------------------
   Starting up the RTS
   -------------------------------------------------------------------------- */
133

sof's avatar
sof committed
134
void
135
hs_init(int *argc, char **argv[])
136
{
137 138 139 140
    hs_init_count++;
    if (hs_init_count > 1) {
	// second and subsequent inits are ignored
	return;
sof's avatar
sof committed
141
    }
sof's avatar
sof committed
142

143 144
    /* Initialise the stats department, phase 0 */
    initStats0();
145 146

    /* Next we do is grab the start time...just in case we're
147 148
     * collecting timing statistics.
     */
149
    stat_startInit();
150

151 152 153 154 155 156
#if defined(DEBUG)
    /* Start off by initialising the allocator debugging so we can
     * use it anywhere */
    initAllocator();
#endif

157
#ifdef PAR
158 159 160 161 162 163 164 165 166
    /*
     * The parallel system needs to be initialised and synchronised before
     * the program is run.  
     */ 
    startupParallelSystem(argv);
     
    if (*argv[0] == '-') { /* Strip off mainPE flag argument */
      argv++; 
      argc--;			
167
    }
168 169

    argv[1] = argv[0];   /* ignore the nPEs argument */
170 171 172 173
    argv++; argc--;
#endif

    /* Set the RTS flags to default values. */
mrchebas@gmail.com's avatar
mrchebas@gmail.com committed
174

175 176 177 178 179 180
    initRtsFlagsDefaults();

    /* Call the user hook to reset defaults, if present */
    defaultsHook();

    /* Parse the flags, separating the RTS flags from the programs args */
181
    if (argc != NULL && argv != NULL) {
182
	setFullProgArgv(*argc,*argv);
183
	setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
184
	setProgArgv(*argc,*argv);
185
    }
186

187 188 189
    /* Initialise the stats department, phase 1 */
    initStats1();

190 191 192 193
#ifdef USE_PAPI
    papi_init();
#endif

Simon Marlow's avatar
Simon Marlow committed
194 195 196
    /* initTracing must be after setupRtsFlags() */
    initTracing();

197 198
#if defined(PAR)
    /* NB: this really must be done after processing the RTS flags */
199
    IF_PAR_DEBUG(verbose,
200
                 debugBelch("==== Synchronising system (%d PEs)\n", nPEs));
201
    synchroniseSystem();             // calls initParallelSystem etc
202 203
#endif	/* PAR */

204 205 206 207 208
    /* initialise scheduler data structures (needs to be done before
     * initStorage()).
     */
    initScheduler();

209 210 211 212 213 214 215 216 217 218
#if defined(GRAN)
    /* And start GranSim profiling if required: */
    if (RtsFlags.GranFlags.GranSimStats.Full)
      init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
#elif defined(PAR)
    /* And start GUM profiling if required: */
    if (RtsFlags.ParFlags.ParStats.Full)
      init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
#endif	/* PAR || GRAN */

219 220 221 222 223 224
    /* initialize the storage manager */
    initStorage();

    /* initialise the stable pointer table */
    initStablePtrTable();

ei@vuokko.info's avatar
ei@vuokko.info committed
225 226 227
    /* initialise the shared Typeable store */
    initTypeableStore();

228 229 230 231 232
    /* initialise file locking, if necessary */
#if !defined(mingw32_HOST_OS)    
    initFileLocking();
#endif

sof's avatar
sof committed
233
#if defined(DEBUG)
234 235
    /* initialise thread label table (tso->char*) */
    initThreadLabelTable();
sof's avatar
sof committed
236
#endif
237

238 239
    initProfiling1();

sof's avatar
sof committed
240
    /* start the virtual timer 'subsystem'. */
241
    initTimer();
242
    startTimer();
243

sof's avatar
sof committed
244
#if defined(RTS_USER_SIGNALS)
245 246 247 248 249 250
    if (RtsFlags.MiscFlags.install_signal_handlers) {
        /* Initialise the user signal handler set */
        initUserSignals();
        /* Set up handler to run on SIGINT, etc. */
        initDefaultHandlers();
    }
sof's avatar
sof committed
251
#endif
sof's avatar
sof committed
252
 
253
#if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
sof's avatar
sof committed
254 255 256
    startupAsyncIO();
#endif

257 258 259 260 261 262
#ifdef RTS_GTK_FRONTPANEL
    if (RtsFlags.GcFlags.frontpanel) {
	initFrontPanel();
    }
#endif

263 264
#if X86_INIT_FPU
    x86_init_fpu();
265 266
#endif

267
    /* Record initialization times */
268
    stat_endInit();
269 270
}

271 272 273 274 275
// Compatibility interface
void
startupHaskell(int argc, char *argv[], void (*init_root)(void))
{
    hs_init(&argc, &argv);
276 277
    if(init_root)
        hs_add_root(init_root);
278 279 280
}


281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
/* -----------------------------------------------------------------------------
   Per-module initialisation

   This process traverses all the compiled modules in the program
   starting with "Main", and performing per-module initialisation for
   each one.

   So far, two things happen at initialisation time:

      - we register stable names for each foreign-exported function
        in that module.  This prevents foreign-exported entities, and
	things they depend on, from being garbage collected.

      - we supply a unique integer to each statically declared cost
        centre and cost centre stack in the program.

ken's avatar
ken committed
297 298
   The code generator inserts a small function "__stginit_<module>" in each
   module and calls the registration functions in each of the modules it
299
   imports.
300 301 302 303 304 305 306 307

   The init* functions are compiled in the same way as STG code,
   i.e. without normal C call/return conventions.  Hence we must use
   StgRun to call this stuff.
   -------------------------------------------------------------------------- */

/* The init functions use an explicit stack... 
 */
308
#define INIT_STACK_BLOCKS  4
309
static F_ *init_stack = NULL;
310

311 312
void
hs_add_root(void (*init_root)(void))
313
{
314
    bdescr *bd;
315
    nat init_sp;
316 317 318
    Capability *cap;

    cap = rts_lock();
319

320 321 322 323
    if (hs_init_count <= 0) {
	barf("hs_add_root() must be called after hs_init()");
    }

324 325 326
    /* The initialisation stack grows downward, with sp pointing 
       to the last occupied word */
    init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
327
    bd = allocGroup_lock(INIT_STACK_BLOCKS);
328
    init_stack = (F_ *)bd->start;
329
    init_stack[--init_sp] = (F_)stg_init_finish;
330
    if (init_root != NULL) {
331
	init_stack[--init_sp] = (F_)init_root;
332 333
    }
    
334 335
    cap->r.rSp = (P_)(init_stack + init_sp);
    StgRun((StgFunPtr)stg_init, &cap->r);
336

337
    freeGroup_lock(bd);
338

andy@galois.com's avatar
andy@galois.com committed
339 340
    startupHpc();

341 342 343
    // This must be done after module initialisation.
    // ToDo: make this work in the presence of multiple hs_add_root()s.
    initProfiling2();
Simon Marlow's avatar
Simon Marlow committed
344

345 346
    rts_unlock(cap);

Simon Marlow's avatar
Simon Marlow committed
347 348 349 350
    // ditto.
#if defined(THREADED_RTS)
    ioManagerStart();
#endif
351
}
352

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
/* ----------------------------------------------------------------------------
 * Shutting down the RTS
 *
 * The wait_foreign parameter means:
 *       True  ==> wait for any threads doing foreign calls now.
 *       False ==> threads doing foreign calls may return in the
 *                 future, but will immediately block on a mutex.
 *                 (capability->lock).
 * 
 * If this RTS is a DLL that we're about to unload, then you want
 * safe=True, otherwise the thread might return to code that has been
 * unloaded.  If this is a standalone program that is about to exit,
 * then you can get away with safe=False, which is better because we
 * won't hang on exit if there is a blocked foreign call outstanding.
 *
 ------------------------------------------------------------------------- */
sof's avatar
sof committed
369

370 371
static void
hs_exit_(rtsBool wait_foreign)
372
{
373
    if (hs_init_count <= 0) {
374 375
	errorBelch("warning: too many hs_exit()s");
	return;
376 377 378 379 380 381
    }
    hs_init_count--;
    if (hs_init_count > 0) {
	// ignore until it's the last one
	return;
    }
sof's avatar
sof committed
382

383 384 385
    /* start timing the shutdown */
    stat_startExit();
    
Ian Lynagh's avatar
Ian Lynagh committed
386
#if defined(RTS_USER_SIGNALS)
387 388 389
    if (RtsFlags.MiscFlags.install_signal_handlers) {
        freeSignalHandlers();
    }
Ian Lynagh's avatar
Ian Lynagh committed
390 391
#endif

392
#if defined(THREADED_RTS)
393 394 395
    ioManagerDie();
#endif

396
    /* stop all running tasks */
397
    exitScheduler(wait_foreign);
398
    
399
#if defined(GRAN)
400 401 402
    /* end_gr_simulation prints global stats if requested -- HWL */
    if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
	end_gr_simulation();
403
#endif
404 405
    
    /* stop the ticker */
sof's avatar
sof committed
406
    stopTimer();
407
    exitTimer();
408

409 410 411 412
    /* reset the standard file descriptors to blocking mode */
    resetNonBlockingFd(0);
    resetNonBlockingFd(1);
    resetNonBlockingFd(2);
413

414 415 416 417 418 419 420 421 422 423 424 425
#if HAVE_TERMIOS_H
    // Reset the terminal settings on the standard file descriptors,
    // if we changed them.  See System.Posix.Internals.tcSetAttr for
    // more details, including the reason we termporarily disable
    // SIGTTOU here.
    { 
	int fd;
	sigset_t sigset, old_sigset;
	sigemptyset(&sigset);
	sigaddset(&sigset, SIGTTOU);
	sigprocmask(SIG_BLOCK, &sigset, &old_sigset);
	for (fd = 0; fd <= 2; fd++) {
426 427 428
	    struct termios* ts = (struct termios*)__hscore_get_saved_termios(fd);
	    if (ts != NULL) {
		tcsetattr(fd,TCSANOW,ts);
429 430 431 432 433 434
	    }
	}
	sigprocmask(SIG_SETMASK, &old_sigset, NULL);
    }
#endif

435
#if defined(PAR)
436 437 438 439 440
    /* controlled exit; good thread! */
    shutdownParallelSystem(0);
    
    /* global statistics in parallel system */
    PAR_TICKY_PAR_END();
441 442
#endif

443 444 445
    /* stop timing the shutdown, we're about to print stats */
    stat_endExit();
    
andy@galois.com's avatar
andy@galois.com committed
446 447 448
    /* shutdown the hpc support (if needed) */
    exitHpc();

Simon Marlow's avatar
Simon Marlow committed
449 450
    // clean up things from the storage manager's point of view.
    // also outputs the stats (+RTS -s) info.
451 452
    exitStorage();
    
453 454 455
    /* free the tasks */
    freeScheduler();

ei@vuokko.info's avatar
ei@vuokko.info committed
456 457 458
    /* free shared Typeable store */
    exitTypeableStore();

459 460 461 462 463
    /* free file locking tables, if necessary */
#if !defined(mingw32_HOST_OS)    
    freeFileLocking();
#endif

Ian Lynagh's avatar
Ian Lynagh committed
464
    /* free the stable pointer table */
465 466
    exitStablePtrTable();

Ian Lynagh's avatar
Ian Lynagh committed
467 468 469 470 471
#if defined(DEBUG)
    /* free the thread label table */
    freeThreadLabelTable();
#endif

472 473 474 475 476 477
#ifdef RTS_GTK_FRONTPANEL
    if (RtsFlags.GcFlags.frontpanel) {
	stopFrontPanel();
    }
#endif

478
#if defined(PROFILING) 
479
    reportCCSProfiling();
480 481
#endif

482
    endProfiling();
483
    freeProfiling1();
484

485
#ifdef PROFILING
486 487 488
    // Originally, this was in report_ccs_profiling().  Now, retainer
    // profiling might tack some extra stuff on to the end of this file
    // during endProfiling().
489
    if (prof_file != NULL) fclose(prof_file);
490
#endif
Simon Marlow's avatar
Simon Marlow committed
491

492
#if defined(TICKY_TICKY)
493 494
    if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
#endif
sof's avatar
sof committed
495

496
#if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
Simon Marlow's avatar
Simon Marlow committed
497
    shutdownAsyncIO(wait_foreign);
sof's avatar
sof committed
498
#endif
Simon Marlow's avatar
Simon Marlow committed
499

500 501 502
    /* free hash table storage */
    exitHashTable();

503
    // Finally, free all our storage
Simon Marlow's avatar
Simon Marlow committed
504
    freeStorage();
505 506 507 508 509 510

#if defined(DEBUG)
    /* and shut down the allocator debugging */
    shutdownAllocator();
#endif

511 512
}

513 514 515 516 517 518 519 520
// The real hs_exit():
void
hs_exit(void)
{
    hs_exit_(rtsTrue);
    // be safe; this might be a DLL
}

521 522 523 524 525 526 527 528 529 530 531 532
// Compatibility interfaces
void
shutdownHaskell(void)
{
    hs_exit();
}

void
shutdownHaskellAndExit(int n)
{
    if (hs_init_count == 1) {
	OnExitHook();
533 534
	hs_exit_(rtsFalse);
        // we're about to exit(), no need to wait for foreign calls to return.
535 536 537 538 539
#if defined(PAR)
	/* really exit (stg_exit() would call shutdownParallelSystem() again) */
	exit(n);
#else
	stg_exit(n);
540
#endif
541
    }
542
}
543 544

/* 
545
 * called from STG-land to exit the program
546 547
 */

548 549 550 551
#ifdef PAR
static int exit_started=rtsFalse;
#endif

552 553
void (*exitFn)(int) = 0;

554
void  
555
stg_exit(int n)
556 557 558 559 560 561 562
{ 
#ifdef PAR
  /* HACK: avoid a loop when exiting due to a stupid error */
  if (exit_started) 
    return;
  exit_started=rtsTrue;

563
  IF_PAR_DEBUG(verbose, debugBelch("==-- stg_exit %d on [%x]...", n, mytid));
564
  shutdownParallelSystem(n);
565
#endif
566 567
  if (exitFn)
    (*exitFn)(n);
568
  exit(n);
569
}