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 #ifndef USE_PAPI
  11 #include "PosixSource.h"
  12 #endif
  13
  14 #include "Rts.h"
  15 #include "RtsAPI.h"
  16 #include "HsFFI.h"
  17
  18 #include "sm/Storage.h"
  19 #include "RtsUtils.h"
  20 #include "Prelude.h"
  21 #include "Schedule.h"   /* initScheduler */
  22 #include "Stats.h"      /* initStats */
  23 #include "STM.h"        /* initSTM */
  24 #include "RtsSignals.h"
  25 #include "Weak.h"
  26 #include "Ticky.h"
  27 #include "StgRun.h"
  28 #include "Prelude.h"            /* fixupRTStoPreludeRefs */
  29 #include "ThreadLabels.h"
  30 #include "sm/BlockAlloc.h"
  31 #include "Trace.h"
  32 #include "Stable.h"
  33 #include "Hash.h"
  34 #include "Profiling.h"
  35 #include "Timer.h"
  36 #include "Globals.h"
  37 void exitLinker( void );        // there is no Linker.h file to include
  38
  39 #if defined(RTS_GTK_FRONTPANEL)
  40 #include "FrontPanel.h"
  41 #endif
  42
  43 #if defined(PROFILING)
  44 # include "ProfHeap.h"
  45 # include "RetainerProfile.h"
  46 #endif
  47
  48 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
  49 #include "win32/AsyncIO.h"
  50 #endif
  51
  52 #if !defined(mingw32_HOST_OS)
  53 #include "posix/TTY.h"
  54 #include "posix/FileLock.h"
  55 #endif
  56
  57 #ifdef HAVE_UNISTD_H
  58 #include <unistd.h>
  59 #endif
  60 #ifdef HAVE_LOCALE_H
  61 #include <locale.h>
  62 #endif
  63
  64 #if USE_PAPI
  65 #include "Papi.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 /* -----------------------------------------------------------------------------
  72    Initialise floating point unit on x86 (currently disabled. why?)
  73    (see comment in ghc/compiler/nativeGen/MachInstrs.lhs).
  74    -------------------------------------------------------------------------- */
  75
  76 #define X86_INIT_FPU 0
  77
  78 #if X86_INIT_FPU
  79 static void
  80 x86_init_fpu ( void )
  81 {
  82   __volatile unsigned short int fpu_cw;
  83
  84   // Grab the control word
  85   __asm __volatile ("fnstcw %0" : "=m" (fpu_cw));
  86
  87 #if 0
  88   printf("fpu_cw: %x\n", fpu_cw);
  89 #endif
  90
  91   // Set bits 8-9 to 10 (64-bit precision).
  92   fpu_cw = (fpu_cw & 0xfcff) | 0x0200;
  93
  94   // Store the new control word back
  95   __asm __volatile ("fldcw %0" : : "m" (fpu_cw));
  96 }
  97 #endif
  98
  99 /* -----------------------------------------------------------------------------
 100    Starting up the RTS
 101    -------------------------------------------------------------------------- */
 102
 103 void
 104 hs_init(int *argc, char **argv[])
 105 {
 106     hs_init_count++;
 107     if (hs_init_count > 1) {
 108         // second and subsequent inits are ignored
 109         return;
 110     }
 111
 112     setlocale(LC_CTYPE,"");
 113
 114     /* Initialise the stats department, phase 0 */
 115     initStats0();
 116
 117     /* Next we do is grab the start time...just in case we're
 118      * collecting timing statistics.
 119      */
 120     stat_startInit();
 121
 122 #if defined(DEBUG)
 123     /* Start off by initialising the allocator debugging so we can
 124      * use it anywhere */
 125     initAllocator();
 126 #endif
 127
 128     /* Set the RTS flags to default values. */
 129
 130     initRtsFlagsDefaults();
 131
 132     /* Call the user hook to reset defaults, if present */
 133     defaultsHook();
 134
 135     /* Parse the flags, separating the RTS flags from the programs args */
 136     if (argc != NULL && argv != NULL) {
 137         setFullProgArgv(*argc,*argv);
 138         setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
 139         setProgArgv(*argc,*argv);
 140     }
 141
 142     /* Initialise the stats department, phase 1 */
 143     initStats1();
 144
 145 #ifdef USE_PAPI
 146     papi_init();
 147 #endif
 148
 149     /* initTracing must be after setupRtsFlags() */
 150 #ifdef TRACING
 151     initTracing();
 152 #endif
 153     /* Dtrace events are always enabled
 154      */
 155     dtraceEventStartup();
 156
 157     /* initialise scheduler data structures (needs to be done before
 158      * initStorage()).
 159      */
 160     initScheduler();
 161
 162     /* initialize the storage manager */
 163     initStorage();
 164
 165     /* initialise the stable pointer table */
 166     initStablePtrTable();
 167
 168     /* Add some GC roots for things in the base package that the RTS
 169      * knows about.  We don't know whether these turn out to be CAFs
 170      * or refer to CAFs, but we have to assume that they might.
 171      */
 172     getStablePtr((StgPtr)runIO_closure);
 173     getStablePtr((StgPtr)runNonIO_closure);
 174
 175     getStablePtr((StgPtr)runFinalizerBatch_closure);
 176
 177     getStablePtr((StgPtr)stackOverflow_closure);
 178     getStablePtr((StgPtr)heapOverflow_closure);
 179     getStablePtr((StgPtr)unpackCString_closure);
 180     getStablePtr((StgPtr)blockedIndefinitelyOnMVar_closure);
 181     getStablePtr((StgPtr)nonTermination_closure);
 182     getStablePtr((StgPtr)blockedIndefinitelyOnSTM_closure);
 183     getStablePtr((StgPtr)nestedAtomically_closure);
 184
 185     getStablePtr((StgPtr)runSparks_closure);
 186     getStablePtr((StgPtr)ensureIOManagerIsRunning_closure);
 187     getStablePtr((StgPtr)runHandlers_closure);
 188
 189     /* initialise the shared Typeable store */
 190     initGlobalStore();
 191
 192     /* initialise file locking, if necessary */
 193 #if !defined(mingw32_HOST_OS)
 194     initFileLocking();
 195 #endif
 196
 197 #if defined(DEBUG)
 198     /* initialise thread label table (tso->char*) */
 199     initThreadLabelTable();
 200 #endif
 201
 202     initProfiling1();
 203
 204     /* start the virtual timer 'subsystem'. */
 205     initTimer();
 206     startTimer();
 207
 208 #if defined(RTS_USER_SIGNALS)
 209     if (RtsFlags.MiscFlags.install_signal_handlers) {
 210         /* Initialise the user signal handler set */
 211         initUserSignals();
 212         /* Set up handler to run on SIGINT, etc. */
 213         initDefaultHandlers();
 214     }
 215 #endif
 216
 217 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 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 StgFunPtr *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;
 281
 282     cap = rts_lock();
 283
 284     if (hs_init_count <= 0) {
 285         barf("hs_add_root() must be called after hs_init()");
 286     }
 287
 288     /* The initialisation stack grows downward, with sp pointing
 289        to the last occupied word */
 290     init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
 291     bd = allocGroup_lock(INIT_STACK_BLOCKS);
 292     init_stack = (StgFunPtr *)bd->start;
 293     init_stack[--init_sp] = (StgFunPtr)stg_init_finish;
 294     if (init_root != NULL) {
 295         init_stack[--init_sp] = (StgFunPtr)init_root;
 296     }
 297
 298     cap->r.rSp = (P_)(init_stack + init_sp);
 299     StgRun((StgFunPtr)stg_init, &cap->r);
 300
 301     freeGroup_lock(bd);
 302
 303     startupHpc();
 304
 305     // This must be done after module initialisation.
 306     // ToDo: make this work in the presence of multiple hs_add_root()s.
 307     initProfiling2();
 308
 309     rts_unlock(cap);
 310
 311     // ditto.
 312 #if defined(THREADED_RTS)
 313     ioManagerStart();
 314 #endif
 315 }
 316
 317 /* ----------------------------------------------------------------------------
 318  * Shutting down the RTS
 319  *
 320  * The wait_foreign parameter means:
 321  *       True  ==> wait for any threads doing foreign calls now.
 322  *       False ==> threads doing foreign calls may return in the
 323  *                 future, but will immediately block on a mutex.
 324  *                 (capability->lock).
 325  *
 326  * If this RTS is a DLL that we're about to unload, then you want
 327  * safe=True, otherwise the thread might return to code that has been
 328  * unloaded.  If this is a standalone program that is about to exit,
 329  * then you can get away with safe=False, which is better because we
 330  * won't hang on exit if there is a blocked foreign call outstanding.
 331  *
 332  ------------------------------------------------------------------------- */
 333
 334 static void
 335 hs_exit_(rtsBool wait_foreign)
 336 {
 337     if (hs_init_count <= 0) {
 338         errorBelch("warning: too many hs_exit()s");
 339         return;
 340     }
 341     hs_init_count--;
 342     if (hs_init_count > 0) {
 343         // ignore until it's the last one
 344         return;
 345     }
 346
 347     /* start timing the shutdown */
 348     stat_startExit();
 349
 350     OnExitHook();
 351
 352     // Free the full argv storage
 353     freeFullProgArgv();
 354
 355 #if defined(THREADED_RTS)
 356     ioManagerDie();
 357 #endif
 358
 359     /* stop all running tasks */
 360     exitScheduler(wait_foreign);
 361
 362     /* run C finalizers for all active weak pointers */
 363     runAllCFinalizers(weak_ptr_list);
 364
 365 #if defined(RTS_USER_SIGNALS)
 366     if (RtsFlags.MiscFlags.install_signal_handlers) {
 367         freeSignalHandlers();
 368     }
 369 #endif
 370
 371     /* stop the ticker */
 372     stopTimer();
 373     exitTimer();
 374
 375     // set the terminal settings back to what they were
 376 #if !defined(mingw32_HOST_OS)
 377     resetTerminalSettings();
 378 #endif
 379
 380     // uninstall signal handlers
 381     resetDefaultHandlers();
 382
 383     /* stop timing the shutdown, we're about to print stats */
 384     stat_endExit();
 385
 386     /* shutdown the hpc support (if needed) */
 387     exitHpc();
 388
 389     // clean up things from the storage manager's point of view.
 390     // also outputs the stats (+RTS -s) info.
 391     exitStorage();
 392
 393     /* free the tasks */
 394     freeScheduler();
 395
 396     /* free shared Typeable store */
 397     exitGlobalStore();
 398
 399     /* free linker data */
 400     exitLinker();
 401
 402     /* free file locking tables, if necessary */
 403 #if !defined(mingw32_HOST_OS)
 404     freeFileLocking();
 405 #endif
 406
 407     /* free the stable pointer table */
 408     exitStablePtrTable();
 409
 410 #if defined(DEBUG)
 411     /* free the thread label table */
 412     freeThreadLabelTable();
 413 #endif
 414
 415 #ifdef RTS_GTK_FRONTPANEL
 416     if (RtsFlags.GcFlags.frontpanel) {
 417         stopFrontPanel();
 418     }
 419 #endif
 420
 421 #if defined(PROFILING)
 422     reportCCSProfiling();
 423 #endif
 424
 425     endProfiling();
 426     freeProfiling1();
 427
 428 #ifdef PROFILING
 429     // Originally, this was in report_ccs_profiling().  Now, retainer
 430     // profiling might tack some extra stuff on to the end of this file
 431     // during endProfiling().
 432     if (prof_file != NULL) fclose(prof_file);
 433 #endif
 434
 435 #ifdef TRACING
 436     endTracing();
 437     freeTracing();
 438 #endif
 439
 440 #if defined(TICKY_TICKY)
 441     if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
 442 #endif
 443
 444 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 445     shutdownAsyncIO(wait_foreign);
 446 #endif
 447
 448     /* free hash table storage */
 449     exitHashTable();
 450
 451     // Finally, free all our storage
 452     freeStorage();
 453
 454 #if defined(DEBUG)
 455     /* and shut down the allocator debugging */
 456     shutdownAllocator();
 457 #endif
 458
 459 }
 460
 461 // The real hs_exit():
 462 void
 463 hs_exit(void)
 464 {
 465     hs_exit_(rtsTrue);
 466     // be safe; this might be a DLL
 467 }
 468
 469 // Compatibility interfaces
 470 void
 471 shutdownHaskell(void)
 472 {
 473     hs_exit();
 474 }
 475
 476 void
 477 shutdownHaskellAndExit(int n)
 478 {
 479     // we're about to exit(), no need to wait for foreign calls to return.
 480     hs_exit_(rtsFalse);
 481
 482     if (hs_init_count == 0) {
 483         stg_exit(n);
 484     }
 485 }
 486
 487 #ifndef mingw32_HOST_OS
 488 void
 489 shutdownHaskellAndSignal(int sig)
 490 {
 491     hs_exit_(rtsFalse);
 492     kill(getpid(),sig);
 493 }
 494 #endif
 495
 496 /*
 497  * called from STG-land to exit the program
 498  */
 499
 500 void (*exitFn)(int) = 0;
 501
 502 void
 503 stg_exit(int n)
 504 {
 505   if (exitFn)
 506     (*exitFn)(n);
 507   exit(n);
 508 }