rts/RtsStartup.c

   1 /* -----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2002
   4  *
   5  * Main function for a standalone Haskell program.
   6  *
   7  * ---------------------------------------------------------------------------*/
   8
   9 // PAPI uses caddr_t, which is not POSIX
  10 // #include "PosixSource.h"
  11
  12 #include "Rts.h"
  13 #include "RtsAPI.h"
  14 #include "RtsUtils.h"
  15 #include "RtsFlags.h"
  16 #include "OSThreads.h"
  17 #include "Schedule.h"   /* initScheduler */
  18 #include "Stats.h"      /* initStats */
  19 #include "STM.h"        /* initSTM */
  20 #include "Signals.h"
  21 #include "RtsSignals.h"
  22 #include "ThrIOManager.h"
  23 #include "Timer.h"      /* startTimer, stopTimer */
  24 #include "Weak.h"
  25 #include "Ticky.h"
  26 #include "StgRun.h"
  27 #include "Prelude.h"            /* fixupRTStoPreludeRefs */
  28 #include "HsFFI.h"
  29 #include "Linker.h"
  30 #include "ThreadLabels.h"
  31 #include "BlockAlloc.h"
  32 #include "Trace.h"
  33 #include "RtsTypeable.h"
  34 #include "Stable.h"
  35 #include "Hpc.h"
  36 #include "FileLock.h"
  37
  38 #if defined(RTS_GTK_FRONTPANEL)
  39 #include "FrontPanel.h"
  40 #endif
  41
  42 # include "Profiling.h"
  43
  44 #if defined(PROFILING)
  45 # include "ProfHeap.h"
  46 # include "RetainerProfile.h"
  47 #endif
  48
  49 #if defined(GRAN)
  50 # include "GranSimRts.h"
  51 #endif
  52
  53 #if defined(GRAN) || defined(PAR)
  54 # include "ParallelRts.h"
  55 #endif
  56
  57 #if defined(PAR)
  58 # include "Parallel.h"
  59 # include "LLC.h"
  60 #endif
  61
  62 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
  63 #include "win32/AsyncIO.h"
  64 #endif
  65
  66 #include <stdlib.h>
  67
  68 #ifdef HAVE_TERMIOS_H
  69 #include <termios.h>
  70 #endif
  71 #ifdef HAVE_SIGNAL_H
  72 #include <signal.h>
  73 #endif
  74 #ifdef HAVE_UNISTD_H
  75 #include <unistd.h>
  76 #endif
  77
  78 #if USE_PAPI
  79 #include "Papi.h"
  80 #endif
  81
  82 // Count of how many outstanding hs_init()s there have been.
  83 static int hs_init_count = 0;
  84
  85 // Here we save the terminal settings on the standard file
  86 // descriptors, if we need to change them (eg. to support NoBuffering
  87 // input).
  88 static void *saved_termios[3] = {NULL,NULL,NULL};
  89
  90 void*
  91 __hscore_get_saved_termios(int fd)
  92 {
  93   return (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) ?
  94     saved_termios[fd] : NULL;
  95 }
  96
  97 void
  98 __hscore_set_saved_termios(int fd, void* ts)
  99 {
 100   if (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) {
 101     saved_termios[fd] = ts;
 102   }
 103 }
 104
 105 /* -----------------------------------------------------------------------------
 106    Initialise floating point unit on x86 (currently disabled. why?)
 107    (see comment in ghc/compiler/nativeGen/MachInstrs.lhs).
 108    -------------------------------------------------------------------------- */
 109
 110 #define X86_INIT_FPU 0
 111
 112 #if X86_INIT_FPU
 113 static void
 114 x86_init_fpu ( void )
 115 {
 116   __volatile unsigned short int fpu_cw;
 117
 118   // Grab the control word
 119   __asm __volatile ("fnstcw %0" : "=m" (fpu_cw));
 120
 121 #if 0
 122   printf("fpu_cw: %x\n", fpu_cw);
 123 #endif
 124
 125   // Set bits 8-9 to 10 (64-bit precision).
 126   fpu_cw = (fpu_cw & 0xfcff) | 0x0200;
 127
 128   // Store the new control word back
 129   __asm __volatile ("fldcw %0" : : "m" (fpu_cw));
 130 }
 131 #endif
 132
 133 /* -----------------------------------------------------------------------------
 134    Starting up the RTS
 135    -------------------------------------------------------------------------- */
 136
 137 void
 138 hs_init(int *argc, char **argv[])
 139 {
 140     hs_init_count++;
 141     if (hs_init_count > 1) {
 142         // second and subsequent inits are ignored
 143         return;
 144     }
 145
 146     /* Initialise the stats department, phase 0 */
 147     initStats0();
 148
 149     /* Next we do is grab the start time...just in case we're
 150      * collecting timing statistics.
 151      */
 152     stat_startInit();
 153
 154 #if defined(DEBUG)
 155     /* Start off by initialising the allocator debugging so we can
 156      * use it anywhere */
 157     initAllocator();
 158 #endif
 159
 160 #ifdef PAR
 161     /*
 162      * The parallel system needs to be initialised and synchronised before
 163      * the program is run.
 164      */
 165     startupParallelSystem(argv);
 166
 167     if (*argv[0] == '-') { /* Strip off mainPE flag argument */
 168       argv++;
 169       argc--;
 170     }
 171
 172     argv[1] = argv[0];   /* ignore the nPEs argument */
 173     argv++; argc--;
 174 #endif
 175
 176     /* Set the RTS flags to default values. */
 177
 178     initRtsFlagsDefaults();
 179
 180     /* Call the user hook to reset defaults, if present */
 181     defaultsHook();
 182
 183     /* Parse the flags, separating the RTS flags from the programs args */
 184     if (argc != NULL && argv != NULL) {
 185         setFullProgArgv(*argc,*argv);
 186         setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
 187         setProgArgv(*argc,*argv);
 188     }
 189
 190     /* Initialise the stats department, phase 1 */
 191     initStats1();
 192
 193 #ifdef USE_PAPI
 194     papi_init();
 195 #endif
 196
 197     /* initTracing must be after setupRtsFlags() */
 198     initTracing();
 199
 200 #if defined(PAR)
 201     /* NB: this really must be done after processing the RTS flags */
 202     IF_PAR_DEBUG(verbose,
 203                  debugBelch("==== Synchronising system (%d PEs)\n", nPEs));
 204     synchroniseSystem();             // calls initParallelSystem etc
 205 #endif  /* PAR */
 206
 207     /* initialise scheduler data structures (needs to be done before
 208      * initStorage()).
 209      */
 210     initScheduler();
 211
 212 #if defined(GRAN)
 213     /* And start GranSim profiling if required: */
 214     if (RtsFlags.GranFlags.GranSimStats.Full)
 215       init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
 216 #elif defined(PAR)
 217     /* And start GUM profiling if required: */
 218     if (RtsFlags.ParFlags.ParStats.Full)
 219       init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
 220 #endif  /* PAR || GRAN */
 221
 222     /* initialize the storage manager */
 223     initStorage();
 224
 225     /* initialise the stable pointer table */
 226     initStablePtrTable();
 227
 228     /* initialise the shared Typeable store */
 229     initTypeableStore();
 230
 231     /* initialise file locking, if necessary */
 232 #if !defined(mingw32_HOST_OS)
 233     initFileLocking();
 234 #endif
 235
 236 #if defined(DEBUG)
 237     /* initialise thread label table (tso->char*) */
 238     initThreadLabelTable();
 239 #endif
 240
 241     initProfiling1();
 242
 243     /* start the virtual timer 'subsystem'. */
 244     initTimer();
 245     startTimer();
 246
 247 #if defined(RTS_USER_SIGNALS)
 248     if (RtsFlags.MiscFlags.install_signal_handlers) {
 249         /* Initialise the user signal handler set */
 250         initUserSignals();
 251         /* Set up handler to run on SIGINT, etc. */
 252         initDefaultHandlers();
 253     }
 254 #endif
 255
 256 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 257     startupAsyncIO();
 258 #endif
 259
 260 #ifdef RTS_GTK_FRONTPANEL
 261     if (RtsFlags.GcFlags.frontpanel) {
 262         initFrontPanel();
 263     }
 264 #endif
 265
 266 #if X86_INIT_FPU
 267     x86_init_fpu();
 268 #endif
 269
 270     /* Record initialization times */
 271     stat_endInit();
 272 }
 273
 274 // Compatibility interface
 275 void
 276 startupHaskell(int argc, char *argv[], void (*init_root)(void))
 277 {
 278     hs_init(&argc, &argv);
 279     if(init_root)
 280         hs_add_root(init_root);
 281 }
 282
 283
 284 /* -----------------------------------------------------------------------------
 285    Per-module initialisation
 286
 287    This process traverses all the compiled modules in the program
 288    starting with "Main", and performing per-module initialisation for
 289    each one.
 290
 291    So far, two things happen at initialisation time:
 292
 293       - we register stable names for each foreign-exported function
 294         in that module.  This prevents foreign-exported entities, and
 295         things they depend on, from being garbage collected.
 296
 297       - we supply a unique integer to each statically declared cost
 298         centre and cost centre stack in the program.
 299
 300    The code generator inserts a small function "__stginit_<module>" in each
 301    module and calls the registration functions in each of the modules it
 302    imports.
 303
 304    The init* functions are compiled in the same way as STG code,
 305    i.e. without normal C call/return conventions.  Hence we must use
 306    StgRun to call this stuff.
 307    -------------------------------------------------------------------------- */
 308
 309 /* The init functions use an explicit stack...
 310  */
 311 #define INIT_STACK_BLOCKS  4
 312 static F_ *init_stack = NULL;
 313
 314 void
 315 hs_add_root(void (*init_root)(void))
 316 {
 317     bdescr *bd;
 318     nat init_sp;
 319     Capability *cap;
 320
 321     cap = rts_lock();
 322
 323     if (hs_init_count <= 0) {
 324         barf("hs_add_root() must be called after hs_init()");
 325     }
 326
 327     /* The initialisation stack grows downward, with sp pointing
 328        to the last occupied word */
 329     init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
 330     bd = allocGroup_lock(INIT_STACK_BLOCKS);
 331     init_stack = (F_ *)bd->start;
 332     init_stack[--init_sp] = (F_)stg_init_finish;
 333     if (init_root != NULL) {
 334         init_stack[--init_sp] = (F_)init_root;
 335     }
 336
 337     cap->r.rSp = (P_)(init_stack + init_sp);
 338     StgRun((StgFunPtr)stg_init, &cap->r);
 339
 340     freeGroup_lock(bd);
 341
 342     startupHpc();
 343
 344     // This must be done after module initialisation.
 345     // ToDo: make this work in the presence of multiple hs_add_root()s.
 346     initProfiling2();
 347
 348     rts_unlock(cap);
 349
 350     // ditto.
 351 #if defined(THREADED_RTS)
 352     ioManagerStart();
 353 #endif
 354 }
 355
 356 /* ----------------------------------------------------------------------------
 357  * Shutting down the RTS
 358  *
 359  * The wait_foreign parameter means:
 360  *       True  ==> wait for any threads doing foreign calls now.
 361  *       False ==> threads doing foreign calls may return in the
 362  *                 future, but will immediately block on a mutex.
 363  *                 (capability->lock).
 364  *
 365  * If this RTS is a DLL that we're about to unload, then you want
 366  * safe=True, otherwise the thread might return to code that has been
 367  * unloaded.  If this is a standalone program that is about to exit,
 368  * then you can get away with safe=False, which is better because we
 369  * won't hang on exit if there is a blocked foreign call outstanding.
 370  *
 371  ------------------------------------------------------------------------- */
 372
 373 static void
 374 hs_exit_(rtsBool wait_foreign)
 375 {
 376     if (hs_init_count <= 0) {
 377         errorBelch("warning: too many hs_exit()s");
 378         return;
 379     }
 380     hs_init_count--;
 381     if (hs_init_count > 0) {
 382         // ignore until it's the last one
 383         return;
 384     }
 385
 386     /* start timing the shutdown */
 387     stat_startExit();
 388
 389     OnExitHook();
 390
 391 #if defined(RTS_USER_SIGNALS)
 392     if (RtsFlags.MiscFlags.install_signal_handlers) {
 393         freeSignalHandlers();
 394     }
 395 #endif
 396
 397 #if defined(THREADED_RTS)
 398     ioManagerDie();
 399 #endif
 400
 401     /* stop all running tasks */
 402     exitScheduler(wait_foreign);
 403
 404 #if defined(GRAN)
 405     /* end_gr_simulation prints global stats if requested -- HWL */
 406     if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
 407         end_gr_simulation();
 408 #endif
 409
 410     /* stop the ticker */
 411     stopTimer();
 412     exitTimer();
 413
 414     /* reset the standard file descriptors to blocking mode */
 415     resetNonBlockingFd(0);
 416     resetNonBlockingFd(1);
 417     resetNonBlockingFd(2);
 418
 419 #if HAVE_TERMIOS_H
 420     // Reset the terminal settings on the standard file descriptors,
 421     // if we changed them.  See System.Posix.Internals.tcSetAttr for
 422     // more details, including the reason we termporarily disable
 423     // SIGTTOU here.
 424     {
 425         int fd;
 426         sigset_t sigset, old_sigset;
 427         sigemptyset(&sigset);
 428         sigaddset(&sigset, SIGTTOU);
 429         sigprocmask(SIG_BLOCK, &sigset, &old_sigset);
 430         for (fd = 0; fd <= 2; fd++) {
 431             struct termios* ts = (struct termios*)__hscore_get_saved_termios(fd);
 432             if (ts != NULL) {
 433                 tcsetattr(fd,TCSANOW,ts);
 434             }
 435         }
 436         sigprocmask(SIG_SETMASK, &old_sigset, NULL);
 437     }
 438 #endif
 439
 440 #if defined(PAR)
 441     /* controlled exit; good thread! */
 442     shutdownParallelSystem(0);
 443
 444     /* global statistics in parallel system */
 445     PAR_TICKY_PAR_END();
 446 #endif
 447
 448     // uninstall signal handlers
 449     resetDefaultHandlers();
 450
 451     /* stop timing the shutdown, we're about to print stats */
 452     stat_endExit();
 453
 454     /* shutdown the hpc support (if needed) */
 455     exitHpc();
 456
 457     // clean up things from the storage manager's point of view.
 458     // also outputs the stats (+RTS -s) info.
 459     exitStorage();
 460
 461     /* free the tasks */
 462     freeScheduler();
 463
 464     /* free shared Typeable store */
 465     exitTypeableStore();
 466
 467     /* free file locking tables, if necessary */
 468 #if !defined(mingw32_HOST_OS)
 469     freeFileLocking();
 470 #endif
 471
 472     /* free the stable pointer table */
 473     exitStablePtrTable();
 474
 475 #if defined(DEBUG)
 476     /* free the thread label table */
 477     freeThreadLabelTable();
 478 #endif
 479
 480 #ifdef RTS_GTK_FRONTPANEL
 481     if (RtsFlags.GcFlags.frontpanel) {
 482         stopFrontPanel();
 483     }
 484 #endif
 485
 486 #if defined(PROFILING)
 487     reportCCSProfiling();
 488 #endif
 489
 490     endProfiling();
 491     freeProfiling1();
 492
 493 #ifdef PROFILING
 494     // Originally, this was in report_ccs_profiling().  Now, retainer
 495     // profiling might tack some extra stuff on to the end of this file
 496     // during endProfiling().
 497     if (prof_file != NULL) fclose(prof_file);
 498 #endif
 499
 500 #if defined(TICKY_TICKY)
 501     if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
 502 #endif
 503
 504 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 505     shutdownAsyncIO(wait_foreign);
 506 #endif
 507
 508     /* free hash table storage */
 509     exitHashTable();
 510
 511     // Finally, free all our storage
 512     freeStorage();
 513
 514 #if defined(DEBUG)
 515     /* and shut down the allocator debugging */
 516     shutdownAllocator();
 517 #endif
 518
 519 }
 520
 521 // The real hs_exit():
 522 void
 523 hs_exit(void)
 524 {
 525     hs_exit_(rtsTrue);
 526     // be safe; this might be a DLL
 527 }
 528
 529 // Compatibility interfaces
 530 void
 531 shutdownHaskell(void)
 532 {
 533     hs_exit();
 534 }
 535
 536 void
 537 shutdownHaskellAndExit(int n)
 538 {
 539     // we're about to exit(), no need to wait for foreign calls to return.
 540     hs_exit_(rtsFalse);
 541
 542     if (hs_init_count == 0) {
 543 #if defined(PAR)
 544         /* really exit (stg_exit() would call shutdownParallelSystem() again) */
 545         exit(n);
 546 #else
 547         stg_exit(n);
 548 #endif
 549     }
 550 }
 551
 552 #ifndef mingw32_HOST_OS
 553 void
 554 shutdownHaskellAndSignal(int sig)
 555 {
 556     hs_exit_(rtsFalse);
 557     kill(getpid(),sig);
 558 }
 559 #endif
 560
 561 /*
 562  * called from STG-land to exit the program
 563  */
 564
 565 #ifdef PAR
 566 static int exit_started=rtsFalse;
 567 #endif
 568
 569 void (*exitFn)(int) = 0;
 570
 571 void
 572 stg_exit(int n)
 573 {
 574 #ifdef PAR
 575   /* HACK: avoid a loop when exiting due to a stupid error */
 576   if (exit_started)
 577     return;
 578   exit_started=rtsTrue;
 579
 580   IF_PAR_DEBUG(verbose, debugBelch("==-- stg_exit %d on [%x]...", n, mytid));
 581   shutdownParallelSystem(n);
 582 #endif
 583   if (exitFn)
 584     (*exitFn)(n);
 585   exit(n);
 586 }