1 /* -----------------------------------------------------------------------------
2 * $Id: RtsStartup.c,v 1.70 2003/01/30 10:19:07 simonmar Exp $
4 * (c) The GHC Team, 1998-2002
6 * Main function for a standalone Haskell program.
8 * ---------------------------------------------------------------------------*/
10 #include "PosixSource.h"
15 #include "Storage.h" /* initStorage, exitStorage */
16 #include "StablePriv.h" /* initStablePtrTable */
17 #include "Schedule.h" /* initScheduler */
18 #include "Stats.h" /* initStats */
24 #include "StgStartup.h"
25 #include "Prelude.h" /* fixupRTStoPreludeRefs */
28 #include "ThreadLabels.h"
30 #if defined(RTS_GTK_FRONTPANEL)
31 #include "FrontPanel.h"
34 #if defined(PROFILING) || defined(DEBUG)
35 # include "Profiling.h"
36 # include "ProfHeap.h"
37 # include "RetainerProfile.h"
41 # include "GranSimRts.h"
44 #if defined(GRAN) || defined(PAR)
45 # include "ParallelRts.h"
49 # include "Parallel.h"
56 struct RTS_FLAGS RtsFlags;
58 // Count of how many outstanding hs_init()s there have been.
59 static int hs_init_count = 0;
61 /* -----------------------------------------------------------------------------
63 -------------------------------------------------------------------------- */
66 hs_init(int *argc, char **argv[])
69 if (hs_init_count > 1) {
70 // second and subsequent inits are ignored
74 /* The very first thing we do is grab the start time...just in case we're
75 * collecting timing statistics.
81 * The parallel system needs to be initialised and synchronised before
84 startupParallelSystem(argv);
86 if (*argv[0] == '-') { /* Strip off mainPE flag argument */
91 argv[1] = argv[0]; /* ignore the nPEs argument */
95 /* Set the RTS flags to default values. */
96 initRtsFlagsDefaults();
98 /* Call the user hook to reset defaults, if present */
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);
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
115 /* initialise scheduler data structures (needs to be done before
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);
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 */
130 /* initialize the storage manager */
133 /* initialise the stable pointer table */
134 initStablePtrTable();
136 /* initialise thread label table (tso->char*) */
137 initThreadLabelTable();
139 #if defined(PROFILING) || defined(DEBUG)
143 /* start the virtual timer 'subsystem'. */
144 startVirtTimer(TICK_MILLISECS);
146 /* Initialise the stats department */
149 #if !defined(mingw32_TARGET_OS) && !defined(PAR)
150 /* Initialise the user signal handler set */
152 /* Set up handler to run on SIGINT, etc. */
153 initDefaultHandlers();
156 #ifdef RTS_GTK_FRONTPANEL
157 if (RtsFlags.GcFlags.frontpanel) {
162 /* Record initialization times */
166 // Compatibility interface
168 startupHaskell(int argc, char *argv[], void (*init_root)(void))
170 hs_init(&argc, &argv);
171 hs_add_root(init_root);
175 /* -----------------------------------------------------------------------------
176 Getting/Setting the program's arguments.
178 These are used by System.Environment.
179 -------------------------------------------------------------------------- */
182 getProgArgv(int *argc, char **argv[])
189 setProgArgv(int argc, char *argv[])
191 /* Usually this is done by startupHaskell, so we don't need to call this.
192 However, sometimes Hugs wants to change the arguments which Haskell
193 getArgs >>= ... will be fed. So you can do that by calling here
194 _after_ calling startupHaskell.
200 /* -----------------------------------------------------------------------------
201 Per-module initialisation
203 This process traverses all the compiled modules in the program
204 starting with "Main", and performing per-module initialisation for
207 So far, two things happen at initialisation time:
209 - we register stable names for each foreign-exported function
210 in that module. This prevents foreign-exported entities, and
211 things they depend on, from being garbage collected.
213 - we supply a unique integer to each statically declared cost
214 centre and cost centre stack in the program.
216 The code generator inserts a small function "__stginit_<module>" in each
217 module and calls the registration functions in each of the modules it
220 The init* functions are compiled in the same way as STG code,
221 i.e. without normal C call/return conventions. Hence we must use
222 StgRun to call this stuff.
223 -------------------------------------------------------------------------- */
225 /* The init functions use an explicit stack...
227 #define INIT_STACK_BLOCKS 4
228 static F_ *init_stack = NULL;
231 hs_add_root(void (*init_root)(void))
237 #define cap MainCapability
241 if (hs_init_count <= 0) {
242 barf("hs_add_root() must be called after hs_init()");
246 bd = allocGroup(INIT_STACK_BLOCKS);
247 init_stack = (F_ *)bd->start;
248 init_stack[init_sp++] = (F_)stg_init_ret;
249 if (init_root != NULL) {
250 init_stack[init_sp++] = (F_)init_root;
253 cap.r.rSp = (P_)(init_stack + init_sp);
254 StgRun((StgFunPtr)stg_init, &cap.r);
258 #if defined(PROFILING) || defined(DEBUG)
259 // This must be done after module initialisation.
260 // ToDo: make this work in the presence of multiple hs_add_root()s.
265 /* -----------------------------------------------------------------------------
266 Shutting down the RTS
267 -------------------------------------------------------------------------- */
272 if (hs_init_count <= 0) {
273 barf("too many hs_exit()s");
276 if (hs_init_count > 0) {
277 // ignore until it's the last one
281 /* start timing the shutdown */
284 /* stop all running tasks */
288 /* Finalize any remaining weak pointers */
289 finalizeWeakPointersNow();
293 /* end_gr_simulation prints global stats if requested -- HWL */
294 if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
298 /* stop the ticker */
301 /* reset the standard file descriptors to blocking mode */
302 resetNonBlockingFd(0);
303 resetNonBlockingFd(1);
304 resetNonBlockingFd(2);
307 /* controlled exit; good thread! */
308 shutdownParallelSystem(0);
310 /* global statistics in parallel system */
314 /* stop timing the shutdown, we're about to print stats */
317 /* clean up things from the storage manager's point of view.
318 * also outputs the stats (+RTS -s) info.
322 #ifdef RTS_GTK_FRONTPANEL
323 if (RtsFlags.GcFlags.frontpanel) {
328 #if defined(PROFILING)
329 reportCCSProfiling();
332 #if defined(PROFILING) || defined(DEBUG)
337 // Originally, this was in report_ccs_profiling(). Now, retainer
338 // profiling might tack some extra stuff on to the end of this file
339 // during endProfiling().
343 #if defined(TICKY_TICKY)
344 if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
348 // Compatibility interfaces
350 shutdownHaskell(void)
356 shutdownHaskellAndExit(int n)
358 if (hs_init_count == 1) {
362 /* really exit (stg_exit() would call shutdownParallelSystem() again) */
371 * called from STG-land to exit the program
375 static int exit_started=rtsFalse;
382 /* HACK: avoid a loop when exiting due to a stupid error */
385 exit_started=rtsTrue;
387 IF_PAR_DEBUG(verbose, fprintf(stderr,"==-- stg_exit %d on [%x]...", n, mytid));
388 shutdownParallelSystem(n);