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     getStablePtr((StgPtr)stackOverflow_closure);
 175     getStablePtr((StgPtr)heapOverflow_closure);
 176     getStablePtr((StgPtr)runFinalizerBatch_closure);
 177     getStablePtr((StgPtr)unpackCString_closure);
 178     getStablePtr((StgPtr)blockedIndefinitelyOnMVar_closure);
 179     getStablePtr((StgPtr)nonTermination_closure);
 180     getStablePtr((StgPtr)blockedIndefinitelyOnSTM_closure);
 181
 182     /* initialise the shared Typeable store */
 183     initGlobalStore();
 184
 185     /* initialise file locking, if necessary */
 186 #if !defined(mingw32_HOST_OS)
 187     initFileLocking();
 188 #endif
 189
 190 #if defined(DEBUG)
 191     /* initialise thread label table (tso->char*) */
 192     initThreadLabelTable();
 193 #endif
 194
 195     initProfiling1();
 196
 197     /* start the virtual timer 'subsystem'. */
 198     initTimer();
 199     startTimer();
 200
 201 #if defined(RTS_USER_SIGNALS)
 202     if (RtsFlags.MiscFlags.install_signal_handlers) {
 203         /* Initialise the user signal handler set */
 204         initUserSignals();
 205         /* Set up handler to run on SIGINT, etc. */
 206         initDefaultHandlers();
 207     }
 208 #endif
 209
 210 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 211     startupAsyncIO();
 212 #endif
 213
 214 #ifdef RTS_GTK_FRONTPANEL
 215     if (RtsFlags.GcFlags.frontpanel) {
 216         initFrontPanel();
 217     }
 218 #endif
 219
 220 #if X86_INIT_FPU
 221     x86_init_fpu();
 222 #endif
 223
 224     /* Record initialization times */
 225     stat_endInit();
 226 }
 227
 228 // Compatibility interface
 229 void
 230 startupHaskell(int argc, char *argv[], void (*init_root)(void))
 231 {
 232     hs_init(&argc, &argv);
 233     if(init_root)
 234         hs_add_root(init_root);
 235 }
 236
 237
 238 /* -----------------------------------------------------------------------------
 239    Per-module initialisation
 240
 241    This process traverses all the compiled modules in the program
 242    starting with "Main", and performing per-module initialisation for
 243    each one.
 244
 245    So far, two things happen at initialisation time:
 246
 247       - we register stable names for each foreign-exported function
 248         in that module.  This prevents foreign-exported entities, and
 249         things they depend on, from being garbage collected.
 250
 251       - we supply a unique integer to each statically declared cost
 252         centre and cost centre stack in the program.
 253
 254    The code generator inserts a small function "__stginit_<module>" in each
 255    module and calls the registration functions in each of the modules it
 256    imports.
 257
 258    The init* functions are compiled in the same way as STG code,
 259    i.e. without normal C call/return conventions.  Hence we must use
 260    StgRun to call this stuff.
 261    -------------------------------------------------------------------------- */
 262
 263 /* The init functions use an explicit stack...
 264  */
 265 #define INIT_STACK_BLOCKS  4
 266 static StgFunPtr *init_stack = NULL;
 267
 268 void
 269 hs_add_root(void (*init_root)(void))
 270 {
 271     bdescr *bd;
 272     nat init_sp;
 273     Capability *cap;
 274
 275     cap = rts_lock();
 276
 277     if (hs_init_count <= 0) {
 278         barf("hs_add_root() must be called after hs_init()");
 279     }
 280
 281     /* The initialisation stack grows downward, with sp pointing
 282        to the last occupied word */
 283     init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
 284     bd = allocGroup_lock(INIT_STACK_BLOCKS);
 285     init_stack = (StgFunPtr *)bd->start;
 286     init_stack[--init_sp] = (StgFunPtr)stg_init_finish;
 287     if (init_root != NULL) {
 288         init_stack[--init_sp] = (StgFunPtr)init_root;
 289     }
 290
 291     cap->r.rSp = (P_)(init_stack + init_sp);
 292     StgRun((StgFunPtr)stg_init, &cap->r);
 293
 294     freeGroup_lock(bd);
 295
 296     startupHpc();
 297
 298     // This must be done after module initialisation.
 299     // ToDo: make this work in the presence of multiple hs_add_root()s.
 300     initProfiling2();
 301
 302     rts_unlock(cap);
 303
 304     // ditto.
 305 #if defined(THREADED_RTS)
 306     ioManagerStart();
 307 #endif
 308 }
 309
 310 /* ----------------------------------------------------------------------------
 311  * Shutting down the RTS
 312  *
 313  * The wait_foreign parameter means:
 314  *       True  ==> wait for any threads doing foreign calls now.
 315  *       False ==> threads doing foreign calls may return in the
 316  *                 future, but will immediately block on a mutex.
 317  *                 (capability->lock).
 318  *
 319  * If this RTS is a DLL that we're about to unload, then you want
 320  * safe=True, otherwise the thread might return to code that has been
 321  * unloaded.  If this is a standalone program that is about to exit,
 322  * then you can get away with safe=False, which is better because we
 323  * won't hang on exit if there is a blocked foreign call outstanding.
 324  *
 325  ------------------------------------------------------------------------- */
 326
 327 static void
 328 hs_exit_(rtsBool wait_foreign)
 329 {
 330     if (hs_init_count <= 0) {
 331         errorBelch("warning: too many hs_exit()s");
 332         return;
 333     }
 334     hs_init_count--;
 335     if (hs_init_count > 0) {
 336         // ignore until it's the last one
 337         return;
 338     }
 339
 340     /* start timing the shutdown */
 341     stat_startExit();
 342
 343     OnExitHook();
 344
 345     // Free the full argv storage
 346     freeFullProgArgv();
 347
 348 #if defined(THREADED_RTS)
 349     ioManagerDie();
 350 #endif
 351
 352     /* stop all running tasks */
 353     exitScheduler(wait_foreign);
 354
 355     /* run C finalizers for all active weak pointers */
 356     runAllCFinalizers(weak_ptr_list);
 357
 358 #if defined(RTS_USER_SIGNALS)
 359     if (RtsFlags.MiscFlags.install_signal_handlers) {
 360         freeSignalHandlers();
 361     }
 362 #endif
 363
 364     /* stop the ticker */
 365     stopTimer();
 366     exitTimer();
 367
 368     // set the terminal settings back to what they were
 369 #if !defined(mingw32_HOST_OS)
 370     resetTerminalSettings();
 371 #endif
 372
 373     // uninstall signal handlers
 374     resetDefaultHandlers();
 375
 376     /* stop timing the shutdown, we're about to print stats */
 377     stat_endExit();
 378
 379     /* shutdown the hpc support (if needed) */
 380     exitHpc();
 381
 382     // clean up things from the storage manager's point of view.
 383     // also outputs the stats (+RTS -s) info.
 384     exitStorage();
 385
 386     /* free the tasks */
 387     freeScheduler();
 388
 389     /* free shared Typeable store */
 390     exitGlobalStore();
 391
 392     /* free linker data */
 393     exitLinker();
 394
 395     /* free file locking tables, if necessary */
 396 #if !defined(mingw32_HOST_OS)
 397     freeFileLocking();
 398 #endif
 399
 400     /* free the stable pointer table */
 401     exitStablePtrTable();
 402
 403 #if defined(DEBUG)
 404     /* free the thread label table */
 405     freeThreadLabelTable();
 406 #endif
 407
 408 #ifdef RTS_GTK_FRONTPANEL
 409     if (RtsFlags.GcFlags.frontpanel) {
 410         stopFrontPanel();
 411     }
 412 #endif
 413
 414 #if defined(PROFILING)
 415     reportCCSProfiling();
 416 #endif
 417
 418     endProfiling();
 419     freeProfiling1();
 420
 421 #ifdef PROFILING
 422     // Originally, this was in report_ccs_profiling().  Now, retainer
 423     // profiling might tack some extra stuff on to the end of this file
 424     // during endProfiling().
 425     if (prof_file != NULL) fclose(prof_file);
 426 #endif
 427
 428 #ifdef TRACING
 429     endTracing();
 430     freeTracing();
 431 #endif
 432
 433 #if defined(TICKY_TICKY)
 434     if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
 435 #endif
 436
 437 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
 438     shutdownAsyncIO(wait_foreign);
 439 #endif
 440
 441     /* free hash table storage */
 442     exitHashTable();
 443
 444     // Finally, free all our storage
 445     freeStorage();
 446
 447 #if defined(DEBUG)
 448     /* and shut down the allocator debugging */
 449     shutdownAllocator();
 450 #endif
 451
 452 }
 453
 454 // The real hs_exit():
 455 void
 456 hs_exit(void)
 457 {
 458     hs_exit_(rtsTrue);
 459     // be safe; this might be a DLL
 460 }
 461
 462 // Compatibility interfaces
 463 void
 464 shutdownHaskell(void)
 465 {
 466     hs_exit();
 467 }
 468
 469 void
 470 shutdownHaskellAndExit(int n)
 471 {
 472     // we're about to exit(), no need to wait for foreign calls to return.
 473     hs_exit_(rtsFalse);
 474
 475     if (hs_init_count == 0) {
 476         stg_exit(n);
 477     }
 478 }
 479
 480 #ifndef mingw32_HOST_OS
 481 void
 482 shutdownHaskellAndSignal(int sig)
 483 {
 484     hs_exit_(rtsFalse);
 485     kill(getpid(),sig);
 486 }
 487 #endif
 488
 489 /*
 490  * called from STG-land to exit the program
 491  */
 492
 493 void (*exitFn)(int) = 0;
 494
 495 void
 496 stg_exit(int n)
 497 {
 498   if (exitFn)
 499     (*exitFn)(n);
 500   exit(n);
 501 }