ghc/rts/RtsStartup.c

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