1 /* -----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2002
5 * Main function for a standalone Haskell program.
7 * ---------------------------------------------------------------------------*/
9 // PAPI uses caddr_t, which is not POSIX
10 // #include "PosixSource.h"
16 #include "OSThreads.h"
17 #include "Schedule.h" /* initScheduler */
18 #include "Stats.h" /* initStats */
19 #include "STM.h" /* initSTM */
21 #include "RtsSignals.h"
22 #include "ThrIOManager.h"
23 #include "Timer.h" /* startTimer, stopTimer */
27 #include "Prelude.h" /* fixupRTStoPreludeRefs */
30 #include "ThreadLabels.h"
31 #include "BlockAlloc.h"
33 #include "RtsTypeable.h"
38 #if defined(RTS_GTK_FRONTPANEL)
39 #include "FrontPanel.h"
42 # include "Profiling.h"
44 #if defined(PROFILING)
45 # include "ProfHeap.h"
46 # include "RetainerProfile.h"
50 # include "GranSimRts.h"
53 #if defined(GRAN) || defined(PAR)
54 # include "ParallelRts.h"
58 # include "Parallel.h"
62 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
63 #include "win32/AsyncIO.h"
82 // Count of how many outstanding hs_init()s there have been.
83 static int hs_init_count = 0;
85 // Here we save the terminal settings on the standard file
86 // descriptors, if we need to change them (eg. to support NoBuffering
88 static void *saved_termios[3] = {NULL,NULL,NULL};
91 __hscore_get_saved_termios(int fd)
93 return (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) ?
94 saved_termios[fd] : NULL;
98 __hscore_set_saved_termios(int fd, void* ts)
100 if (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) {
101 saved_termios[fd] = ts;
105 /* -----------------------------------------------------------------------------
106 Initialise floating point unit on x86 (currently disabled. why?)
107 (see comment in ghc/compiler/nativeGen/MachInstrs.lhs).
108 -------------------------------------------------------------------------- */
110 #define X86_INIT_FPU 0
114 x86_init_fpu ( void )
116 __volatile unsigned short int fpu_cw;
118 // Grab the control word
119 __asm __volatile ("fnstcw %0" : "=m" (fpu_cw));
122 printf("fpu_cw: %x\n", fpu_cw);
125 // Set bits 8-9 to 10 (64-bit precision).
126 fpu_cw = (fpu_cw & 0xfcff) | 0x0200;
128 // Store the new control word back
129 __asm __volatile ("fldcw %0" : : "m" (fpu_cw));
133 /* -----------------------------------------------------------------------------
135 -------------------------------------------------------------------------- */
138 hs_init(int *argc, char **argv[])
141 if (hs_init_count > 1) {
142 // second and subsequent inits are ignored
146 /* Initialise the stats department, phase 0 */
149 /* Next we do is grab the start time...just in case we're
150 * collecting timing statistics.
155 /* Start off by initialising the allocator debugging so we can
162 * The parallel system needs to be initialised and synchronised before
163 * the program is run.
165 startupParallelSystem(argv);
167 if (*argv[0] == '-') { /* Strip off mainPE flag argument */
172 argv[1] = argv[0]; /* ignore the nPEs argument */
176 /* Set the RTS flags to default values. */
178 initRtsFlagsDefaults();
180 /* Call the user hook to reset defaults, if present */
183 /* Parse the flags, separating the RTS flags from the programs args */
184 if (argc != NULL && argv != NULL) {
185 setFullProgArgv(*argc,*argv);
186 setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
187 setProgArgv(*argc,*argv);
190 /* Initialise the stats department, phase 1 */
197 /* initTracing must be after setupRtsFlags() */
201 /* NB: this really must be done after processing the RTS flags */
202 IF_PAR_DEBUG(verbose,
203 debugBelch("==== Synchronising system (%d PEs)\n", nPEs));
204 synchroniseSystem(); // calls initParallelSystem etc
207 /* initialise scheduler data structures (needs to be done before
213 /* And start GranSim profiling if required: */
214 if (RtsFlags.GranFlags.GranSimStats.Full)
215 init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
217 /* And start GUM profiling if required: */
218 if (RtsFlags.ParFlags.ParStats.Full)
219 init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
220 #endif /* PAR || GRAN */
222 /* initialize the storage manager */
225 /* initialise the stable pointer table */
226 initStablePtrTable();
228 /* Add some GC roots for things in the base package that the RTS
229 * knows about. We don't know whether these turn out to be CAFs
230 * or refer to CAFs, but we have to assume that they might.
232 getStablePtr((StgPtr)base_GHCziTopHandler_runIO_closure);
233 getStablePtr((StgPtr)base_GHCziTopHandler_runNonIO_closure);
234 getStablePtr((StgPtr)stackOverflow_closure);
235 getStablePtr((StgPtr)heapOverflow_closure);
236 getStablePtr((StgPtr)runFinalizerBatch_closure);
237 getStablePtr((StgPtr)unpackCString_closure);
238 getStablePtr((StgPtr)blockedOnDeadMVar_closure);
239 getStablePtr((StgPtr)nonTermination_closure);
240 getStablePtr((StgPtr)blockedIndefinitely_closure);
242 /* initialise the shared Typeable store */
245 /* initialise file locking, if necessary */
246 #if !defined(mingw32_HOST_OS)
251 /* initialise thread label table (tso->char*) */
252 initThreadLabelTable();
257 /* start the virtual timer 'subsystem'. */
261 #if defined(RTS_USER_SIGNALS)
262 if (RtsFlags.MiscFlags.install_signal_handlers) {
263 /* Initialise the user signal handler set */
265 /* Set up handler to run on SIGINT, etc. */
266 initDefaultHandlers();
270 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
274 #ifdef RTS_GTK_FRONTPANEL
275 if (RtsFlags.GcFlags.frontpanel) {
284 /* Record initialization times */
288 // Compatibility interface
290 startupHaskell(int argc, char *argv[], void (*init_root)(void))
292 hs_init(&argc, &argv);
294 hs_add_root(init_root);
298 /* -----------------------------------------------------------------------------
299 Per-module initialisation
301 This process traverses all the compiled modules in the program
302 starting with "Main", and performing per-module initialisation for
305 So far, two things happen at initialisation time:
307 - we register stable names for each foreign-exported function
308 in that module. This prevents foreign-exported entities, and
309 things they depend on, from being garbage collected.
311 - we supply a unique integer to each statically declared cost
312 centre and cost centre stack in the program.
314 The code generator inserts a small function "__stginit_<module>" in each
315 module and calls the registration functions in each of the modules it
318 The init* functions are compiled in the same way as STG code,
319 i.e. without normal C call/return conventions. Hence we must use
320 StgRun to call this stuff.
321 -------------------------------------------------------------------------- */
323 /* The init functions use an explicit stack...
325 #define INIT_STACK_BLOCKS 4
326 static F_ *init_stack = NULL;
329 hs_add_root(void (*init_root)(void))
337 if (hs_init_count <= 0) {
338 barf("hs_add_root() must be called after hs_init()");
341 /* The initialisation stack grows downward, with sp pointing
342 to the last occupied word */
343 init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
344 bd = allocGroup_lock(INIT_STACK_BLOCKS);
345 init_stack = (F_ *)bd->start;
346 init_stack[--init_sp] = (F_)stg_init_finish;
347 if (init_root != NULL) {
348 init_stack[--init_sp] = (F_)init_root;
351 cap->r.rSp = (P_)(init_stack + init_sp);
352 StgRun((StgFunPtr)stg_init, &cap->r);
358 // This must be done after module initialisation.
359 // ToDo: make this work in the presence of multiple hs_add_root()s.
365 #if defined(THREADED_RTS)
370 /* ----------------------------------------------------------------------------
371 * Shutting down the RTS
373 * The wait_foreign parameter means:
374 * True ==> wait for any threads doing foreign calls now.
375 * False ==> threads doing foreign calls may return in the
376 * future, but will immediately block on a mutex.
377 * (capability->lock).
379 * If this RTS is a DLL that we're about to unload, then you want
380 * safe=True, otherwise the thread might return to code that has been
381 * unloaded. If this is a standalone program that is about to exit,
382 * then you can get away with safe=False, which is better because we
383 * won't hang on exit if there is a blocked foreign call outstanding.
385 ------------------------------------------------------------------------- */
388 hs_exit_(rtsBool wait_foreign)
390 if (hs_init_count <= 0) {
391 errorBelch("warning: too many hs_exit()s");
395 if (hs_init_count > 0) {
396 // ignore until it's the last one
400 /* start timing the shutdown */
405 #if defined(RTS_USER_SIGNALS)
406 if (RtsFlags.MiscFlags.install_signal_handlers) {
407 freeSignalHandlers();
411 #if defined(THREADED_RTS)
415 /* stop all running tasks */
416 exitScheduler(wait_foreign);
419 /* end_gr_simulation prints global stats if requested -- HWL */
420 if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
424 /* stop the ticker */
428 /* reset the standard file descriptors to blocking mode */
429 resetNonBlockingFd(0);
430 resetNonBlockingFd(1);
431 resetNonBlockingFd(2);
434 // Reset the terminal settings on the standard file descriptors,
435 // if we changed them. See System.Posix.Internals.tcSetAttr for
436 // more details, including the reason we termporarily disable
440 sigset_t sigset, old_sigset;
441 sigemptyset(&sigset);
442 sigaddset(&sigset, SIGTTOU);
443 sigprocmask(SIG_BLOCK, &sigset, &old_sigset);
444 for (fd = 0; fd <= 2; fd++) {
445 struct termios* ts = (struct termios*)__hscore_get_saved_termios(fd);
447 tcsetattr(fd,TCSANOW,ts);
450 sigprocmask(SIG_SETMASK, &old_sigset, NULL);
455 /* controlled exit; good thread! */
456 shutdownParallelSystem(0);
458 /* global statistics in parallel system */
462 // uninstall signal handlers
463 resetDefaultHandlers();
465 /* stop timing the shutdown, we're about to print stats */
468 /* shutdown the hpc support (if needed) */
471 // clean up things from the storage manager's point of view.
472 // also outputs the stats (+RTS -s) info.
478 /* free shared Typeable store */
481 /* free file locking tables, if necessary */
482 #if !defined(mingw32_HOST_OS)
486 /* free the stable pointer table */
487 exitStablePtrTable();
490 /* free the thread label table */
491 freeThreadLabelTable();
494 #ifdef RTS_GTK_FRONTPANEL
495 if (RtsFlags.GcFlags.frontpanel) {
500 #if defined(PROFILING)
501 reportCCSProfiling();
508 // Originally, this was in report_ccs_profiling(). Now, retainer
509 // profiling might tack some extra stuff on to the end of this file
510 // during endProfiling().
511 if (prof_file != NULL) fclose(prof_file);
514 #if defined(TICKY_TICKY)
515 if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
518 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
519 shutdownAsyncIO(wait_foreign);
522 /* free hash table storage */
525 // Finally, free all our storage
529 /* and shut down the allocator debugging */
535 // The real hs_exit():
540 // be safe; this might be a DLL
543 // Compatibility interfaces
545 shutdownHaskell(void)
551 shutdownHaskellAndExit(int n)
553 // we're about to exit(), no need to wait for foreign calls to return.
556 if (hs_init_count == 0) {
558 /* really exit (stg_exit() would call shutdownParallelSystem() again) */
566 #ifndef mingw32_HOST_OS
568 shutdownHaskellAndSignal(int sig)
576 * called from STG-land to exit the program
580 static int exit_started=rtsFalse;
583 void (*exitFn)(int) = 0;
589 /* HACK: avoid a loop when exiting due to a stupid error */
592 exit_started=rtsTrue;
594 IF_PAR_DEBUG(verbose, debugBelch("==-- stg_exit %d on [%x]...", n, mytid));
595 shutdownParallelSystem(n);