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