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"
37 #if defined(RTS_GTK_FRONTPANEL)
38 #include "FrontPanel.h"
41 # include "Profiling.h"
43 #if defined(PROFILING)
44 # include "ProfHeap.h"
45 # include "RetainerProfile.h"
49 # include "GranSimRts.h"
52 #if defined(GRAN) || defined(PAR)
53 # include "ParallelRts.h"
57 # include "Parallel.h"
61 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
62 #include "win32/AsyncIO.h"
78 // Count of how many outstanding hs_init()s there have been.
79 static int hs_init_count = 0;
81 // Here we save the terminal settings on the standard file
82 // descriptors, if we need to change them (eg. to support NoBuffering
84 static void *saved_termios[3] = {NULL,NULL,NULL};
87 __hscore_get_saved_termios(int fd)
89 return (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) ?
90 saved_termios[fd] : NULL;
94 __hscore_set_saved_termios(int fd, void* ts)
96 if (0 <= fd && fd < (int)(sizeof(saved_termios) / sizeof(*saved_termios))) {
97 saved_termios[fd] = ts;
101 /* -----------------------------------------------------------------------------
102 Initialise floating point unit on x86 (currently disabled. why?)
103 (see comment in ghc/compiler/nativeGen/MachInstrs.lhs).
104 -------------------------------------------------------------------------- */
106 #define X86_INIT_FPU 0
110 x86_init_fpu ( void )
112 __volatile unsigned short int fpu_cw;
114 // Grab the control word
115 __asm __volatile ("fnstcw %0" : "=m" (fpu_cw));
118 printf("fpu_cw: %x\n", fpu_cw);
121 // Set bits 8-9 to 10 (64-bit precision).
122 fpu_cw = (fpu_cw & 0xfcff) | 0x0200;
124 // Store the new control word back
125 __asm __volatile ("fldcw %0" : : "m" (fpu_cw));
129 /* -----------------------------------------------------------------------------
131 -------------------------------------------------------------------------- */
134 hs_init(int *argc, char **argv[])
137 if (hs_init_count > 1) {
138 // second and subsequent inits are ignored
143 /* Start off by initialising the allocator debugging so we can
148 /* Next we do is grab the start time...just in case we're
149 * collecting timing statistics.
155 * The parallel system needs to be initialised and synchronised before
156 * the program is run.
158 startupParallelSystem(argv);
160 if (*argv[0] == '-') { /* Strip off mainPE flag argument */
165 argv[1] = argv[0]; /* ignore the nPEs argument */
169 /* Initialise the performance tracking library */
173 if ((ver = PAPI_library_init(PAPI_VER_CURRENT)) != PAPI_VER_CURRENT) {
175 errorBelch("PAPI_library_init: wrong version: %x", ver);
176 stg_exit(EXIT_FAILURE);
178 sysErrorBelch("PAPI_library_init");
179 stg_exit(EXIT_FAILURE);
186 if ((err = PAPI_thread_init(osThreadId)) < 0) {
187 barf("PAPI_thread_init: %d",err);
193 /* Set the RTS flags to default values. */
195 initRtsFlagsDefaults();
197 /* Call the user hook to reset defaults, if present */
200 /* Parse the flags, separating the RTS flags from the programs args */
201 if (argc != NULL && argv != NULL) {
202 setFullProgArgv(*argc,*argv);
203 setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
204 setProgArgv(*argc,*argv);
207 /* initTracing must be after setupRtsFlags() */
211 /* NB: this really must be done after processing the RTS flags */
212 IF_PAR_DEBUG(verbose,
213 debugBelch("==== Synchronising system (%d PEs)\n", nPEs));
214 synchroniseSystem(); // calls initParallelSystem etc
217 /* initialise scheduler data structures (needs to be done before
223 /* And start GranSim profiling if required: */
224 if (RtsFlags.GranFlags.GranSimStats.Full)
225 init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
227 /* And start GUM profiling if required: */
228 if (RtsFlags.ParFlags.ParStats.Full)
229 init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
230 #endif /* PAR || GRAN */
232 /* initialize the storage manager */
235 /* initialise the stable pointer table */
236 initStablePtrTable();
238 /* initialise the shared Typeable store */
242 /* initialise thread label table (tso->char*) */
243 initThreadLabelTable();
248 /* start the virtual timer 'subsystem'. */
252 /* Initialise the stats department */
255 #if defined(RTS_USER_SIGNALS)
256 if (RtsFlags.MiscFlags.install_signal_handlers) {
257 /* Initialise the user signal handler set */
259 /* Set up handler to run on SIGINT, etc. */
260 initDefaultHandlers();
264 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
268 #ifdef RTS_GTK_FRONTPANEL
269 if (RtsFlags.GcFlags.frontpanel) {
278 #if defined(THREADED_RTS)
282 /* Record initialization times */
286 // Compatibility interface
288 startupHaskell(int argc, char *argv[], void (*init_root)(void))
290 hs_init(&argc, &argv);
292 hs_add_root(init_root);
296 /* -----------------------------------------------------------------------------
297 Per-module initialisation
299 This process traverses all the compiled modules in the program
300 starting with "Main", and performing per-module initialisation for
303 So far, two things happen at initialisation time:
305 - we register stable names for each foreign-exported function
306 in that module. This prevents foreign-exported entities, and
307 things they depend on, from being garbage collected.
309 - we supply a unique integer to each statically declared cost
310 centre and cost centre stack in the program.
312 The code generator inserts a small function "__stginit_<module>" in each
313 module and calls the registration functions in each of the modules it
316 The init* functions are compiled in the same way as STG code,
317 i.e. without normal C call/return conventions. Hence we must use
318 StgRun to call this stuff.
319 -------------------------------------------------------------------------- */
321 /* The init functions use an explicit stack...
323 #define INIT_STACK_BLOCKS 4
324 static F_ *init_stack = NULL;
327 hs_add_root(void (*init_root)(void))
331 Capability *cap = &MainCapability;
333 if (hs_init_count <= 0) {
334 barf("hs_add_root() must be called after hs_init()");
337 /* The initialisation stack grows downward, with sp pointing
338 to the last occupied word */
339 init_sp = INIT_STACK_BLOCKS*BLOCK_SIZE_W;
340 bd = allocGroup_lock(INIT_STACK_BLOCKS);
341 init_stack = (F_ *)bd->start;
342 init_stack[--init_sp] = (F_)stg_init_finish;
343 if (init_root != NULL) {
344 init_stack[--init_sp] = (F_)init_root;
347 cap->r.rSp = (P_)(init_stack + init_sp);
348 StgRun((StgFunPtr)stg_init, &cap->r);
354 // This must be done after module initialisation.
355 // ToDo: make this work in the presence of multiple hs_add_root()s.
359 /* ----------------------------------------------------------------------------
360 * Shutting down the RTS
362 * The wait_foreign parameter means:
363 * True ==> wait for any threads doing foreign calls now.
364 * False ==> threads doing foreign calls may return in the
365 * future, but will immediately block on a mutex.
366 * (capability->lock).
368 * If this RTS is a DLL that we're about to unload, then you want
369 * safe=True, otherwise the thread might return to code that has been
370 * unloaded. If this is a standalone program that is about to exit,
371 * then you can get away with safe=False, which is better because we
372 * won't hang on exit if there is a blocked foreign call outstanding.
374 ------------------------------------------------------------------------- */
377 hs_exit_(rtsBool wait_foreign)
379 if (hs_init_count <= 0) {
380 errorBelch("warning: too many hs_exit()s");
384 if (hs_init_count > 0) {
385 // ignore until it's the last one
389 /* start timing the shutdown */
392 #if defined(RTS_USER_SIGNALS)
393 if (RtsFlags.MiscFlags.install_signal_handlers) {
394 freeSignalHandlers();
398 #if defined(THREADED_RTS)
402 /* stop all running tasks */
403 exitScheduler(wait_foreign);
406 /* end_gr_simulation prints global stats if requested -- HWL */
407 if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
411 /* stop the ticker */
415 /* reset the standard file descriptors to blocking mode */
416 resetNonBlockingFd(0);
417 resetNonBlockingFd(1);
418 resetNonBlockingFd(2);
421 // Reset the terminal settings on the standard file descriptors,
422 // if we changed them. See System.Posix.Internals.tcSetAttr for
423 // more details, including the reason we termporarily disable
427 sigset_t sigset, old_sigset;
428 sigemptyset(&sigset);
429 sigaddset(&sigset, SIGTTOU);
430 sigprocmask(SIG_BLOCK, &sigset, &old_sigset);
431 for (fd = 0; fd <= 2; fd++) {
432 struct termios* ts = (struct termios*)__hscore_get_saved_termios(fd);
434 tcsetattr(fd,TCSANOW,ts);
437 sigprocmask(SIG_SETMASK, &old_sigset, NULL);
442 /* controlled exit; good thread! */
443 shutdownParallelSystem(0);
445 /* global statistics in parallel system */
449 /* stop timing the shutdown, we're about to print stats */
452 /* shutdown the hpc support (if needed) */
455 // clean up things from the storage manager's point of view.
456 // also outputs the stats (+RTS -s) info.
462 /* free shared Typeable store */
465 /* free the stable pointer table */
466 exitStablePtrTable();
469 /* free the thread label table */
470 freeThreadLabelTable();
473 #ifdef RTS_GTK_FRONTPANEL
474 if (RtsFlags.GcFlags.frontpanel) {
479 #if defined(PROFILING)
480 reportCCSProfiling();
487 // Originally, this was in report_ccs_profiling(). Now, retainer
488 // profiling might tack some extra stuff on to the end of this file
489 // during endProfiling().
493 #if defined(TICKY_TICKY)
494 if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
497 #if defined(mingw32_HOST_OS) && !defined(THREADED_RTS)
498 shutdownAsyncIO(wait_foreign);
501 /* free hash table storage */
504 // Finally, free all our storage
508 /* and shut down the allocator debugging */
514 // The real hs_exit():
519 // be safe; this might be a DLL
522 // Compatibility interfaces
524 shutdownHaskell(void)
530 shutdownHaskellAndExit(int n)
532 if (hs_init_count == 1) {
535 // we're about to exit(), no need to wait for foreign calls to return.
537 /* really exit (stg_exit() would call shutdownParallelSystem() again) */
546 * called from STG-land to exit the program
550 static int exit_started=rtsFalse;
553 void (*exitFn)(int) = 0;
559 /* HACK: avoid a loop when exiting due to a stupid error */
562 exit_started=rtsTrue;
564 IF_PAR_DEBUG(verbose, debugBelch("==-- stg_exit %d on [%x]...", n, mytid));
565 shutdownParallelSystem(n);