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