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