ghc/rts/RtsStartup.c

   1 /* -----------------------------------------------------------------------------
   2  * $Id: RtsStartup.c,v 1.69 2003/01/29 09:54:33 simonmar Exp $
   3  *
   4  * (c) The GHC Team, 1998-2002
   5  *
   6  * Main function for a standalone Haskell program.
   7  *
   8  * ---------------------------------------------------------------------------*/
   9
  10 #include "PosixSource.h"
  11 #include "Rts.h"
  12 #include "RtsAPI.h"
  13 #include "RtsUtils.h"
  14 #include "RtsFlags.h"
  15 #include "Storage.h"    /* initStorage, exitStorage */
  16 #include "StablePriv.h" /* initStablePtrTable */
  17 #include "Schedule.h"   /* initScheduler */
  18 #include "Stats.h"      /* initStats */
  19 #include "Signals.h"
  20 #include "Itimer.h"
  21 #include "Weak.h"
  22 #include "Ticky.h"
  23 #include "StgRun.h"
  24 #include "StgStartup.h"
  25 #include "Prelude.h"            /* fixupRTStoPreludeRefs */
  26 #include "HsFFI.h"
  27 #include "Linker.h"
  28 #include "ThreadLabels.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 #include <stdlib.h>
  54
  55 // Flag Structure
  56 struct RTS_FLAGS RtsFlags;
  57
  58 // Count of how many outstanding hs_init()s there have been.
  59 static int hs_init_count = 0;
  60
  61 /* -----------------------------------------------------------------------------
  62    Starting up the RTS
  63    -------------------------------------------------------------------------- */
  64
  65 void
  66 hs_init(int *argc, char **argv[])
  67 {
  68     hs_init_count++;
  69     if (hs_init_count > 1) {
  70         // second and subsequent inits are ignored
  71         return;
  72     }
  73
  74     /* The very first thing we do is grab the start time...just in case we're
  75      * collecting timing statistics.
  76      */
  77     stat_startInit();
  78
  79 #ifdef PAR
  80     /*
  81      * The parallel system needs to be initialised and synchronised before
  82      * the program is run.
  83      */
  84     startupParallelSystem(argv);
  85
  86     if (*argv[0] == '-') { /* Strip off mainPE flag argument */
  87       argv++;
  88       argc--;
  89     }
  90
  91     argv[1] = argv[0];   /* ignore the nPEs argument */
  92     argv++; argc--;
  93 #endif
  94
  95     /* Set the RTS flags to default values. */
  96     initRtsFlagsDefaults();
  97
  98     /* Call the user hook to reset defaults, if present */
  99     defaultsHook();
 100
 101     /* Parse the flags, separating the RTS flags from the programs args */
 102     if (argc != NULL && argv != NULL) {
 103         setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
 104         prog_argc = *argc;
 105         prog_argv = *argv;
 106     }
 107
 108 #if defined(PAR)
 109     /* NB: this really must be done after processing the RTS flags */
 110     IF_PAR_DEBUG(verbose,
 111                  fprintf(stderr, "==== Synchronising system (%d PEs)\n", nPEs));
 112     synchroniseSystem();             // calls initParallelSystem etc
 113 #endif  /* PAR */
 114
 115     /* initialise scheduler data structures (needs to be done before
 116      * initStorage()).
 117      */
 118     initScheduler();
 119
 120 #if defined(GRAN)
 121     /* And start GranSim profiling if required: */
 122     if (RtsFlags.GranFlags.GranSimStats.Full)
 123       init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
 124 #elif defined(PAR)
 125     /* And start GUM profiling if required: */
 126     if (RtsFlags.ParFlags.ParStats.Full)
 127       init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
 128 #endif  /* PAR || GRAN */
 129
 130     /* initialize the storage manager */
 131     initStorage();
 132
 133     /* initialise the stable pointer table */
 134     initStablePtrTable();
 135
 136     /* initialise thread label table (tso->char*) */
 137     initThreadLabelTable();
 138
 139 #if defined(PROFILING) || defined(DEBUG)
 140     initProfiling1();
 141 #endif
 142
 143 #if defined(PROFILING) || defined(DEBUG)
 144     initProfiling2();
 145 #endif
 146
 147     /* start the virtual timer 'subsystem'. */
 148     startVirtTimer(TICK_MILLISECS);
 149
 150     /* Initialise the stats department */
 151     initStats();
 152
 153 #if !defined(mingw32_TARGET_OS) && !defined(PAR)
 154     /* Initialise the user signal handler set */
 155     initUserSignals();
 156     /* Set up handler to run on SIGINT, etc. */
 157     initDefaultHandlers();
 158 #endif
 159
 160 #ifdef RTS_GTK_FRONTPANEL
 161     if (RtsFlags.GcFlags.frontpanel) {
 162         initFrontPanel();
 163     }
 164 #endif
 165
 166     /* Record initialization times */
 167     stat_endInit();
 168 }
 169
 170 // Compatibility interface
 171 void
 172 startupHaskell(int argc, char *argv[], void (*init_root)(void))
 173 {
 174     hs_init(&argc, &argv);
 175     hs_add_root(init_root);
 176 }
 177
 178
 179 /* -----------------------------------------------------------------------------
 180    Getting/Setting the program's arguments.
 181
 182    These are used by System.Environment.
 183    -------------------------------------------------------------------------- */
 184
 185 void
 186 getProgArgv(int *argc, char **argv[])
 187 {
 188     *argc = prog_argc;
 189     *argv = prog_argv;
 190 }
 191
 192 void
 193 setProgArgv(int argc, char *argv[])
 194 {
 195    /* Usually this is done by startupHaskell, so we don't need to call this.
 196       However, sometimes Hugs wants to change the arguments which Haskell
 197       getArgs >>= ... will be fed.  So you can do that by calling here
 198       _after_ calling startupHaskell.
 199    */
 200    prog_argc = argc;
 201    prog_argv = argv;
 202 }
 203
 204 /* -----------------------------------------------------------------------------
 205    Per-module initialisation
 206
 207    This process traverses all the compiled modules in the program
 208    starting with "Main", and performing per-module initialisation for
 209    each one.
 210
 211    So far, two things happen at initialisation time:
 212
 213       - we register stable names for each foreign-exported function
 214         in that module.  This prevents foreign-exported entities, and
 215         things they depend on, from being garbage collected.
 216
 217       - we supply a unique integer to each statically declared cost
 218         centre and cost centre stack in the program.
 219
 220    The code generator inserts a small function "__stginit_<module>" in each
 221    module and calls the registration functions in each of the modules it
 222    imports.
 223
 224    The init* functions are compiled in the same way as STG code,
 225    i.e. without normal C call/return conventions.  Hence we must use
 226    StgRun to call this stuff.
 227    -------------------------------------------------------------------------- */
 228
 229 /* The init functions use an explicit stack...
 230  */
 231 #define INIT_STACK_BLOCKS  4
 232 static F_ *init_stack = NULL;
 233
 234 void
 235 hs_add_root(void (*init_root)(void))
 236 {
 237     bdescr *bd;
 238 #ifdef SMP
 239     Capability cap;
 240 #else
 241 #define cap MainCapability
 242 #endif
 243     nat init_sp;
 244
 245     if (hs_init_count <= 0) {
 246         barf("hs_add_root() must be called after hs_init()");
 247     }
 248
 249     init_sp = 0;
 250     bd = allocGroup(INIT_STACK_BLOCKS);
 251     init_stack = (F_ *)bd->start;
 252     init_stack[init_sp++] = (F_)stg_init_ret;
 253     if (init_root != NULL) {
 254         init_stack[init_sp++] = (F_)init_root;
 255     }
 256
 257     cap.r.rSp = (P_)(init_stack + init_sp);
 258     StgRun((StgFunPtr)stg_init, &cap.r);
 259
 260     freeGroup(bd);
 261 }
 262
 263 /* -----------------------------------------------------------------------------
 264    Shutting down the RTS
 265    -------------------------------------------------------------------------- */
 266
 267 void
 268 hs_exit(void)
 269 {
 270     if (hs_init_count <= 0) {
 271         barf("too many hs_exit()s");
 272     }
 273     hs_init_count--;
 274     if (hs_init_count > 0) {
 275         // ignore until it's the last one
 276         return;
 277     }
 278
 279     /* start timing the shutdown */
 280     stat_startExit();
 281
 282     /* stop all running tasks */
 283     exitScheduler();
 284
 285 #if !defined(GRAN)
 286     /* Finalize any remaining weak pointers */
 287     finalizeWeakPointersNow();
 288 #endif
 289
 290 #if defined(GRAN)
 291     /* end_gr_simulation prints global stats if requested -- HWL */
 292     if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
 293         end_gr_simulation();
 294 #endif
 295
 296     /* stop the ticker */
 297     stopVirtTimer();
 298
 299     /* reset the standard file descriptors to blocking mode */
 300     resetNonBlockingFd(0);
 301     resetNonBlockingFd(1);
 302     resetNonBlockingFd(2);
 303
 304 #if defined(PAR)
 305     /* controlled exit; good thread! */
 306     shutdownParallelSystem(0);
 307
 308     /* global statistics in parallel system */
 309     PAR_TICKY_PAR_END();
 310 #endif
 311
 312     /* stop timing the shutdown, we're about to print stats */
 313     stat_endExit();
 314
 315     /* clean up things from the storage manager's point of view.
 316      * also outputs the stats (+RTS -s) info.
 317      */
 318     exitStorage();
 319
 320 #ifdef RTS_GTK_FRONTPANEL
 321     if (RtsFlags.GcFlags.frontpanel) {
 322         stopFrontPanel();
 323     }
 324 #endif
 325
 326 #if defined(PROFILING)
 327     reportCCSProfiling();
 328 #endif
 329
 330 #if defined(PROFILING) || defined(DEBUG)
 331     endProfiling();
 332 #endif
 333
 334 #ifdef PROFILING
 335     // Originally, this was in report_ccs_profiling().  Now, retainer
 336     // profiling might tack some extra stuff on to the end of this file
 337     // during endProfiling().
 338     fclose(prof_file);
 339 #endif
 340
 341 #if defined(TICKY_TICKY)
 342     if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
 343 #endif
 344 }
 345
 346 // Compatibility interfaces
 347 void
 348 shutdownHaskell(void)
 349 {
 350     hs_exit();
 351 }
 352
 353 void
 354 shutdownHaskellAndExit(int n)
 355 {
 356     if (hs_init_count == 1) {
 357         OnExitHook();
 358         hs_exit();
 359 #if defined(PAR)
 360         /* really exit (stg_exit() would call shutdownParallelSystem() again) */
 361         exit(n);
 362 #else
 363         stg_exit(n);
 364 #endif
 365     }
 366 }
 367
 368 /*
 369  * called from STG-land to exit the program
 370  */
 371
 372 #ifdef PAR
 373 static int exit_started=rtsFalse;
 374 #endif
 375
 376 void
 377 stg_exit(int n)
 378 {
 379 #ifdef PAR
 380   /* HACK: avoid a loop when exiting due to a stupid error */
 381   if (exit_started)
 382     return;
 383   exit_started=rtsTrue;
 384
 385   IF_PAR_DEBUG(verbose, fprintf(stderr,"==-- stg_exit %d on [%x]...", n, mytid));
 386   shutdownParallelSystem(n);
 387 #endif
 388   exit(n);
 389 }
 390