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