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     /* Add some GC roots (using stable pointers): these are needed by
 229      * all foreign export stubs, so they have to be treated as
 230      */
 231     getStablePtr((StgPtr)base_GHCziTopHandler_runIO_closure);
 232     getStablePtr((StgPtr)base_GHCziTopHandler_runNonIO_closure);
 233
 234     /* initialise the shared Typeable store */
 235     initTypeableStore();
 236
 237     /* initialise file locking, if necessary */
 238 #if !defined(mingw32_HOST_OS)
 239     initFileLocking();
 240 #endif
 241
 242 #if defined(DEBUG)
 243     /* initialise thread label table (tso->char*) */
 244     initThreadLabelTable();
 245 #endif
 246
 247     initProfiling1();
 248
 249     /* start the virtual timer 'subsystem'. */
 250     initTimer();
 251     startTimer();
 252
 253 #if defined(RTS_USER_SIGNALS)
 254     if (RtsFlags.MiscFlags.install_signal_handlers) {
 255         /* Initialise the user signal handler set */
 256         initUserSignals();
 257         /* Set up handler to run on SIGINT, etc. */
 258         initDefaultHandlers();
 259     }
 260 #endif
 261
 262 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 263     startupAsyncIO();
 264 #endif
 265
 266 #ifdef RTS_GTK_FRONTPANEL
 267     if (RtsFlags.GcFlags.frontpanel) {
 268         initFrontPanel();
 269     }
 270 #endif
 271
 272 #if X86_INIT_FPU
 273     x86_init_fpu();
 274 #endif
 275
 276     /* Record initialization times */
 277     stat_endInit();
 278 }
 279
 280 // Compatibility interface
 281 void
 282 startupHaskell(int argc, char *argv[], void (*init_root)(void))
 283 {
 284     hs_init(&argc, &argv);
 285     if(init_root)
 286         hs_add_root(init_root);
 287 }
 288
 289
 290 /* -----------------------------------------------------------------------------
 291    Per-module initialisation
 292
 293    This process traverses all the compiled modules in the program
 294    starting with "Main", and performing per-module initialisation for
 295    each one.
 296
 297    So far, two things happen at initialisation time:
 298
 299       - we register stable names for each foreign-exported function
 300         in that module.  This prevents foreign-exported entities, and
 301         things they depend on, from being garbage collected.
 302
 303       - we supply a unique integer to each statically declared cost
 304         centre and cost centre stack in the program.
 305
 306    The code generator inserts a small function "__stginit_<module>" in each
 307    module and calls the registration functions in each of the modules it
 308    imports.
 309
 310    The init* functions are compiled in the same way as STG code,
 311    i.e. without normal C call/return conventions.  Hence we must use
 312    StgRun to call this stuff.
 313    -------------------------------------------------------------------------- */
 314
 315 /* The init functions use an explicit stack...
 316  */
 317 #define INIT_STACK_BLOCKS  4
 318 static F_ *init_stack = NULL;
 319
 320 void
 321 hs_add_root(void (*init_root)(void))
 322 {
 323     bdescr *bd;
 324     nat init_sp;
 325     Capability *cap;
 326
 327     cap = rts_lock();
 328
 329     if (hs_init_count <= 0) {
 330         barf("hs_add_root() must be called after hs_init()");
 331     }
 332
 333     /* The initialisation stack grows downward, with sp pointing
 334        to the last occupied word */
 335     init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
 336     bd = allocGroup_lock(INIT_STACK_BLOCKS);
 337     init_stack = (F_ *)bd->start;
 338     init_stack[--init_sp] = (F_)stg_init_finish;
 339     if (init_root != NULL) {
 340         init_stack[--init_sp] = (F_)init_root;
 341     }
 342
 343     cap->r.rSp = (P_)(init_stack + init_sp);
 344     StgRun((StgFunPtr)stg_init, &cap->r);
 345
 346     freeGroup_lock(bd);
 347
 348     startupHpc();
 349
 350     // This must be done after module initialisation.
 351     // ToDo: make this work in the presence of multiple hs_add_root()s.
 352     initProfiling2();
 353
 354     rts_unlock(cap);
 355
 356     // ditto.
 357 #if defined(THREADED_RTS)
 358     ioManagerStart();
 359 #endif
 360 }
 361
 362 /* ----------------------------------------------------------------------------
 363  * Shutting down the RTS
 364  *
 365  * The wait_foreign parameter means:
 366  *       True  ==> wait for any threads doing foreign calls now.
 367  *       False ==> threads doing foreign calls may return in the
 368  *                 future, but will immediately block on a mutex.
 369  *                 (capability->lock).
 370  *
 371  * If this RTS is a DLL that we're about to unload, then you want
 372  * safe=True, otherwise the thread might return to code that has been
 373  * unloaded.  If this is a standalone program that is about to exit,
 374  * then you can get away with safe=False, which is better because we
 375  * won't hang on exit if there is a blocked foreign call outstanding.
 376  *
 377  ------------------------------------------------------------------------- */
 378
 379 static void
 380 hs_exit_(rtsBool wait_foreign)
 381 {
 382     if (hs_init_count <= 0) {
 383         errorBelch("warning: too many hs_exit()s");
 384         return;
 385     }
 386     hs_init_count--;
 387     if (hs_init_count > 0) {
 388         // ignore until it's the last one
 389         return;
 390     }
 391
 392     /* start timing the shutdown */
 393     stat_startExit();
 394
 395     OnExitHook();
 396
 397 #if defined(RTS_USER_SIGNALS)
 398     if (RtsFlags.MiscFlags.install_signal_handlers) {
 399         freeSignalHandlers();
 400     }
 401 #endif
 402
 403 #if defined(THREADED_RTS)
 404     ioManagerDie();
 405 #endif
 406
 407     /* stop all running tasks */
 408     exitScheduler(wait_foreign);
 409
 410 #if defined(GRAN)
 411     /* end_gr_simulation prints global stats if requested -- HWL */
 412     if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
 413         end_gr_simulation();
 414 #endif
 415
 416     /* stop the ticker */
 417     stopTimer();
 418     exitTimer();
 419
 420     /* reset the standard file descriptors to blocking mode */
 421     resetNonBlockingFd(0);
 422     resetNonBlockingFd(1);
 423     resetNonBlockingFd(2);
 424
 425 #if HAVE_TERMIOS_H
 426     // Reset the terminal settings on the standard file descriptors,
 427     // if we changed them.  See System.Posix.Internals.tcSetAttr for
 428     // more details, including the reason we termporarily disable
 429     // SIGTTOU here.
 430     {
 431         int fd;
 432         sigset_t sigset, old_sigset;
 433         sigemptyset(&sigset);
 434         sigaddset(&sigset, SIGTTOU);
 435         sigprocmask(SIG_BLOCK, &sigset, &old_sigset);
 436         for (fd = 0; fd <= 2; fd++) {
 437             struct termios* ts = (struct termios*)__hscore_get_saved_termios(fd);
 438             if (ts != NULL) {
 439                 tcsetattr(fd,TCSANOW,ts);
 440             }
 441         }
 442         sigprocmask(SIG_SETMASK, &old_sigset, NULL);
 443     }
 444 #endif
 445
 446 #if defined(PAR)
 447     /* controlled exit; good thread! */
 448     shutdownParallelSystem(0);
 449
 450     /* global statistics in parallel system */
 451     PAR_TICKY_PAR_END();
 452 #endif
 453
 454     // uninstall signal handlers
 455     resetDefaultHandlers();
 456
 457     /* stop timing the shutdown, we're about to print stats */
 458     stat_endExit();
 459
 460     /* shutdown the hpc support (if needed) */
 461     exitHpc();
 462
 463     // clean up things from the storage manager's point of view.
 464     // also outputs the stats (+RTS -s) info.
 465     exitStorage();
 466
 467     /* free the tasks */
 468     freeScheduler();
 469
 470     /* free shared Typeable store */
 471     exitTypeableStore();
 472
 473     /* free file locking tables, if necessary */
 474 #if !defined(mingw32_HOST_OS)
 475     freeFileLocking();
 476 #endif
 477
 478     /* free the stable pointer table */
 479     exitStablePtrTable();
 480
 481 #if defined(DEBUG)
 482     /* free the thread label table */
 483     freeThreadLabelTable();
 484 #endif
 485
 486 #ifdef RTS_GTK_FRONTPANEL
 487     if (RtsFlags.GcFlags.frontpanel) {
 488         stopFrontPanel();
 489     }
 490 #endif
 491
 492 #if defined(PROFILING)
 493     reportCCSProfiling();
 494 #endif
 495
 496     endProfiling();
 497     freeProfiling1();
 498
 499 #ifdef PROFILING
 500     // Originally, this was in report_ccs_profiling().  Now, retainer
 501     // profiling might tack some extra stuff on to the end of this file
 502     // during endProfiling().
 503     if (prof_file != NULL) fclose(prof_file);
 504 #endif
 505
 506 #if defined(TICKY_TICKY)
 507     if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
 508 #endif
 509
 510 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 511     shutdownAsyncIO(wait_foreign);
 512 #endif
 513
 514     /* free hash table storage */
 515     exitHashTable();
 516
 517     // Finally, free all our storage
 518     freeStorage();
 519
 520 #if defined(DEBUG)
 521     /* and shut down the allocator debugging */
 522     shutdownAllocator();
 523 #endif
 524
 525 }
 526
 527 // The real hs_exit():
 528 void
 529 hs_exit(void)
 530 {
 531     hs_exit_(rtsTrue);
 532     // be safe; this might be a DLL
 533 }
 534
 535 // Compatibility interfaces
 536 void
 537 shutdownHaskell(void)
 538 {
 539     hs_exit();
 540 }
 541
 542 void
 543 shutdownHaskellAndExit(int n)
 544 {
 545     // we're about to exit(), no need to wait for foreign calls to return.
 546     hs_exit_(rtsFalse);
 547
 548     if (hs_init_count == 0) {
 549 #if defined(PAR)
 550         /* really exit (stg_exit() would call shutdownParallelSystem() again) */
 551         exit(n);
 552 #else
 553         stg_exit(n);
 554 #endif
 555     }
 556 }
 557
 558 #ifndef mingw32_HOST_OS
 559 void
 560 shutdownHaskellAndSignal(int sig)
 561 {
 562     hs_exit_(rtsFalse);
 563     kill(getpid(),sig);
 564 }
 565 #endif
 566
 567 /*
 568  * called from STG-land to exit the program
 569  */
 570
 571 #ifdef PAR
 572 static int exit_started=rtsFalse;
 573 #endif
 574
 575 void (*exitFn)(int) = 0;
 576
 577 void
 578 stg_exit(int n)
 579 {
 580 #ifdef PAR
 581   /* HACK: avoid a loop when exiting due to a stupid error */
 582   if (exit_started)
 583     return;
 584   exit_started=rtsTrue;
 585
 586   IF_PAR_DEBUG(verbose, debugBelch("==-- stg_exit %d on [%x]...", n, mytid));
 587   shutdownParallelSystem(n);
 588 #endif
 589   if (exitFn)
 590     (*exitFn)(n);
 591   exit(n);
 592 }