1 /* -----------------------------------------------------------------------------
2 * $Id: RtsStartup.c,v 1.78 2003/09/26 12:12:35 panne 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 */
20 #include "Timer.h" /* startTimer, stopTimer */
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"
53 #if defined(mingw32_TARGET_OS)
54 #include "win32/AsyncIO.h"
71 struct RTS_FLAGS RtsFlags;
73 // Count of how many outstanding hs_init()s there have been.
74 static int hs_init_count = 0;
76 // Here we save the terminal settings on the standard file
77 // descriptors, if we need to change them (eg. to support NoBuffering
79 static void *saved_termios[3] = {NULL,NULL,NULL};
82 __hscore_get_saved_termios(int fd)
84 return (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) ?
85 saved_termios[fd] : NULL;
89 __hscore_set_saved_termios(int fd, void* ts)
91 if (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) {
92 saved_termios[fd] = ts;
96 /* -----------------------------------------------------------------------------
98 -------------------------------------------------------------------------- */
101 hs_init(int *argc, char **argv[])
104 if (hs_init_count > 1) {
105 // second and subsequent inits are ignored
109 /* The very first thing we do is grab the start time...just in case we're
110 * collecting timing statistics.
116 * The parallel system needs to be initialised and synchronised before
117 * the program is run.
119 startupParallelSystem(argv);
121 if (*argv[0] == '-') { /* Strip off mainPE flag argument */
126 argv[1] = argv[0]; /* ignore the nPEs argument */
130 /* Set the RTS flags to default values. */
131 initRtsFlagsDefaults();
133 /* Call the user hook to reset defaults, if present */
136 /* Parse the flags, separating the RTS flags from the programs args */
137 if (argc != NULL && argv != NULL) {
138 setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
144 /* NB: this really must be done after processing the RTS flags */
145 IF_PAR_DEBUG(verbose,
146 fprintf(stderr, "==== Synchronising system (%d PEs)\n", nPEs));
147 synchroniseSystem(); // calls initParallelSystem etc
150 /* initialise scheduler data structures (needs to be done before
156 /* And start GranSim profiling if required: */
157 if (RtsFlags.GranFlags.GranSimStats.Full)
158 init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
160 /* And start GUM profiling if required: */
161 if (RtsFlags.ParFlags.ParStats.Full)
162 init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
163 #endif /* PAR || GRAN */
165 /* initialize the storage manager */
168 /* initialise the stable pointer table */
169 initStablePtrTable();
171 /* initialise thread label table (tso->char*) */
172 initThreadLabelTable();
174 #if defined(PROFILING) || defined(DEBUG)
178 /* start the virtual timer 'subsystem'. */
179 startTimer(TICK_MILLISECS);
181 /* Initialise the stats department */
184 #if defined(RTS_USER_SIGNALS)
185 /* Initialise the user signal handler set */
187 /* Set up handler to run on SIGINT, etc. */
188 initDefaultHandlers();
191 #if defined(mingw32_TARGET_OS)
195 #ifdef RTS_GTK_FRONTPANEL
196 if (RtsFlags.GcFlags.frontpanel) {
202 setlocale(LC_ALL,"");
205 /* Record initialization times */
209 // Compatibility interface
211 startupHaskell(int argc, char *argv[], void (*init_root)(void))
213 hs_init(&argc, &argv);
214 hs_add_root(init_root);
218 /* -----------------------------------------------------------------------------
219 Getting/Setting the program's arguments.
221 These are used by System.Environment.
222 -------------------------------------------------------------------------- */
225 getProgArgv(int *argc, char **argv[])
227 if (argc) { *argc = prog_argc; }
228 if (argv) { *argv = prog_argv; }
232 setProgArgv(int argc, char *argv[])
234 /* Usually this is done by startupHaskell, so we don't need to call this.
235 However, sometimes Hugs wants to change the arguments which Haskell
236 getArgs >>= ... will be fed. So you can do that by calling here
237 _after_ calling startupHaskell.
243 /* -----------------------------------------------------------------------------
244 Per-module initialisation
246 This process traverses all the compiled modules in the program
247 starting with "Main", and performing per-module initialisation for
250 So far, two things happen at initialisation time:
252 - we register stable names for each foreign-exported function
253 in that module. This prevents foreign-exported entities, and
254 things they depend on, from being garbage collected.
256 - we supply a unique integer to each statically declared cost
257 centre and cost centre stack in the program.
259 The code generator inserts a small function "__stginit_<module>" in each
260 module and calls the registration functions in each of the modules it
263 The init* functions are compiled in the same way as STG code,
264 i.e. without normal C call/return conventions. Hence we must use
265 StgRun to call this stuff.
266 -------------------------------------------------------------------------- */
268 /* The init functions use an explicit stack...
270 #define INIT_STACK_BLOCKS 4
271 static F_ *init_stack = NULL;
274 hs_add_root(void (*init_root)(void))
280 #define cap MainCapability
284 if (hs_init_count <= 0) {
285 barf("hs_add_root() must be called after hs_init()");
289 bd = allocGroup(INIT_STACK_BLOCKS);
290 init_stack = (F_ *)bd->start;
291 init_stack[init_sp++] = (F_)stg_init_ret;
292 if (init_root != NULL) {
293 init_stack[init_sp++] = (F_)init_root;
296 cap.r.rSp = (P_)(init_stack + init_sp);
297 StgRun((StgFunPtr)stg_init, &cap.r);
301 #if defined(PROFILING) || defined(DEBUG)
302 // This must be done after module initialisation.
303 // ToDo: make this work in the presence of multiple hs_add_root()s.
308 /* -----------------------------------------------------------------------------
309 Shutting down the RTS
310 -------------------------------------------------------------------------- */
315 if (hs_init_count <= 0) {
316 barf("too many hs_exit()s");
319 if (hs_init_count > 0) {
320 // ignore until it's the last one
324 /* start timing the shutdown */
327 /* stop all running tasks */
331 /* Finalize any remaining weak pointers */
332 finalizeWeakPointersNow();
336 /* end_gr_simulation prints global stats if requested -- HWL */
337 if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
341 /* stop the ticker */
344 /* reset the standard file descriptors to blocking mode */
345 resetNonBlockingFd(0);
346 resetNonBlockingFd(1);
347 resetNonBlockingFd(2);
350 // Reset the terminal settings on the standard file descriptors,
351 // if we changed them. See System.Posix.Internals.tcSetAttr for
352 // more details, including the reason we termporarily disable
356 sigset_t sigset, old_sigset;
357 sigemptyset(&sigset);
358 sigaddset(&sigset, SIGTTOU);
359 sigprocmask(SIG_BLOCK, &sigset, &old_sigset);
360 for (fd = 0; fd <= 2; fd++) {
361 struct termios* ts = (struct termios*)__hscore_get_saved_termios(fd);
363 tcsetattr(fd,TCSANOW,ts);
366 sigprocmask(SIG_SETMASK, &old_sigset, NULL);
371 /* controlled exit; good thread! */
372 shutdownParallelSystem(0);
374 /* global statistics in parallel system */
378 /* stop timing the shutdown, we're about to print stats */
381 /* clean up things from the storage manager's point of view.
382 * also outputs the stats (+RTS -s) info.
386 #ifdef RTS_GTK_FRONTPANEL
387 if (RtsFlags.GcFlags.frontpanel) {
392 #if defined(PROFILING)
393 reportCCSProfiling();
396 #if defined(PROFILING) || defined(DEBUG)
401 // Originally, this was in report_ccs_profiling(). Now, retainer
402 // profiling might tack some extra stuff on to the end of this file
403 // during endProfiling().
407 #if defined(TICKY_TICKY)
408 if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
411 #if defined(mingw32_TARGET_OS)
416 // Compatibility interfaces
418 shutdownHaskell(void)
424 shutdownHaskellAndExit(int n)
426 if (hs_init_count == 1) {
430 /* really exit (stg_exit() would call shutdownParallelSystem() again) */
439 * called from STG-land to exit the program
443 static int exit_started=rtsFalse;
450 /* HACK: avoid a loop when exiting due to a stupid error */
453 exit_started=rtsTrue;
455 IF_PAR_DEBUG(verbose, fprintf(stderr,"==-- stg_exit %d on [%x]...", n, mytid));
456 shutdownParallelSystem(n);