/* -----------------------------------------------------------------------------
- * $Id: RtsStartup.c,v 1.44 2000/11/01 11:41:47 simonmar Exp $
+ * $Id: RtsStartup.c,v 1.73 2003/04/01 15:05:15 sof Exp $
*
- * (c) The GHC Team, 1998-2000
+ * (c) The GHC Team, 1998-2002
*
* Main function for a standalone Haskell program.
*
* ---------------------------------------------------------------------------*/
+#include "PosixSource.h"
#include "Rts.h"
#include "RtsAPI.h"
#include "RtsUtils.h"
#include "Schedule.h" /* initScheduler */
#include "Stats.h" /* initStats */
#include "Signals.h"
-#include "Itimer.h"
+#include "Timer.h" /* startTimer, stopTimer */
#include "Weak.h"
#include "Ticky.h"
#include "StgRun.h"
#include "StgStartup.h"
#include "Prelude.h" /* fixupRTStoPreludeRefs */
-
-#ifdef GHCI
#include "HsFFI.h"
#include "Linker.h"
-#endif
+#include "ThreadLabels.h"
#if defined(RTS_GTK_FRONTPANEL)
#include "FrontPanel.h"
#if defined(PROFILING) || defined(DEBUG)
# include "Profiling.h"
# include "ProfHeap.h"
+# include "RetainerProfile.h"
#endif
#if defined(GRAN)
-#include "GranSimRts.h"
-#include "ParallelRts.h"
+# include "GranSimRts.h"
#endif
-#if defined(PAR)
-#include "ParInit.h"
-#include "Parallel.h"
-#include "LLC.h"
+#if defined(GRAN) || defined(PAR)
+# include "ParallelRts.h"
#endif
-/*
- * Flag Structure
- */
-struct RTS_FLAGS RtsFlags;
-
-static int rts_has_started_up = 0;
#if defined(PAR)
-static ullong startTime = 0;
+# include "Parallel.h"
+# include "LLC.h"
#endif
-EXTFUN(__init_Prelude);
-static void initModules ( void * );
+#if defined(mingw32_TARGET_OS)
+#include "win32/AsyncIO.h"
+#endif
-void
-setProgArgv(int argc, char *argv[])
-{
- /* Usually this is done by startupHaskell, so we don't need to call this.
- However, sometimes Hugs wants to change the arguments which Haskell
- getArgs >>= ... will be fed. So you can do that by calling here
- _after_ calling startupHaskell.
- */
- prog_argc = argc;
- prog_argv = argv;
-}
+#include <stdlib.h>
-void
-getProgArgv(int *argc, char **argv[])
-{
- *argc = prog_argc;
- *argv = prog_argv;
-}
+// Flag Structure
+struct RTS_FLAGS RtsFlags;
+// Count of how many outstanding hs_init()s there have been.
+static int hs_init_count = 0;
+
+/* -----------------------------------------------------------------------------
+ Starting up the RTS
+ -------------------------------------------------------------------------- */
void
-startupHaskell(int argc, char *argv[], void *init_root)
+hs_init(int *argc, char **argv[])
{
- /* To avoid repeated initialisations of the RTS */
- if (rts_has_started_up)
- return;
- else
- rts_has_started_up=1;
+ hs_init_count++;
+ if (hs_init_count > 1) {
+ // second and subsequent inits are ignored
+ return;
+ }
/* The very first thing we do is grab the start time...just in case we're
* collecting timing statistics.
*/
- start_time();
+ stat_startInit();
#ifdef PAR
-/*
- * The parallel system needs to be initialised and synchronised before
- * the program is run.
- */
- fprintf(stderr, "startupHaskell: argv[0]=%s\n", argv[0]);
- if (*argv[0] == '-') { /* Look to see whether we're the Main Thread */
- IAmMainThread = rtsTrue;
- argv++; argc--; /* Strip off flag argument */
- // IF_PAR_DEBUG(verbose,
- fprintf(stderr, "[%x] I am Main Thread\n", mytid);
+ /*
+ * The parallel system needs to be initialised and synchronised before
+ * the program is run.
+ */
+ startupParallelSystem(argv);
+
+ if (*argv[0] == '-') { /* Strip off mainPE flag argument */
+ argv++;
+ argc--;
}
- /*
- * Grab the number of PEs out of the argument vector, and
- * eliminate it from further argument processing.
- */
- nPEs = atoi(argv[1]);
- argv[1] = argv[0];
+
+ argv[1] = argv[0]; /* ignore the nPEs argument */
argv++; argc--;
- initEachPEHook(); /* HWL: hook to be execed on each PE */
#endif
/* Set the RTS flags to default values. */
defaultsHook();
/* Parse the flags, separating the RTS flags from the programs args */
- setupRtsFlags(&argc, argv, &rts_argc, rts_argv);
- prog_argc = argc;
- prog_argv = argv;
+ if (argc != NULL && argv != NULL) {
+ setupRtsFlags(argc, *argv, &rts_argc, rts_argv);
+ prog_argc = *argc;
+ prog_argv = *argv;
+ }
#if defined(PAR)
/* NB: this really must be done after processing the RTS flags */
- fprintf(stderr, "Synchronising system (%d PEs)\n", nPEs);
- SynchroniseSystem(); // calls initParallelSystem etc
+ IF_PAR_DEBUG(verbose,
+ fprintf(stderr, "==== Synchronising system (%d PEs)\n", nPEs));
+ synchroniseSystem(); // calls initParallelSystem etc
#endif /* PAR */
/* initialise scheduler data structures (needs to be done before
/* initialize the storage manager */
initStorage();
- /* initialise the object linker, if necessary */
-#ifdef GHCI
- initLinker();
-#endif
-
/* initialise the stable pointer table */
initStablePtrTable();
-#if defined(PROFILING) || defined(DEBUG)
- initProfiling1();
-#endif
-
- /* run the per-module initialisation code */
-#if !defined(INTERPRETER)
- initModules(init_root);
-#endif
+ /* initialise thread label table (tso->char*) */
+ initThreadLabelTable();
#if defined(PROFILING) || defined(DEBUG)
- initProfiling2();
+ initProfiling1();
#endif
- /* start the ticker */
- install_vtalrm_handler();
- initialize_virtual_timer(TICK_MILLISECS);
-
- /* start our haskell execution tasks */
-#ifdef SMP
- startTasks();
-#endif
+ /* start the virtual timer 'subsystem'. */
+ startTimer(TICK_MILLISECS);
/* Initialise the stats department */
initStats();
-#if !defined(mingw32_TARGET_OS) && !defined(PAR)
+#if defined(RTS_USER_SIGNALS)
/* Initialise the user signal handler set */
initUserSignals();
/* Set up handler to run on SIGINT, etc. */
- init_default_handlers();
+ initDefaultHandlers();
#endif
-#if !defined(INTERPRETER)
- /* Initialise pointers from the RTS to the prelude.
- Only for compiled code -- the interpreter
- will call this itself later, so don't do so now.
- */
- fixupRTStoPreludeRefs(NULL);
+#if defined(mingw32_TARGET_OS)
+ startupAsyncIO();
#endif
#ifdef RTS_GTK_FRONTPANEL
#endif
/* Record initialization times */
- end_init();
+ stat_endInit();
+}
+
+// Compatibility interface
+void
+startupHaskell(int argc, char *argv[], void (*init_root)(void))
+{
+ hs_init(&argc, &argv);
+ hs_add_root(init_root);
+}
+
+
+/* -----------------------------------------------------------------------------
+ Getting/Setting the program's arguments.
+
+ These are used by System.Environment.
+ -------------------------------------------------------------------------- */
+
+void
+getProgArgv(int *argc, char **argv[])
+{
+ *argc = prog_argc;
+ *argv = prog_argv;
+}
+
+void
+setProgArgv(int argc, char *argv[])
+{
+ /* Usually this is done by startupHaskell, so we don't need to call this.
+ However, sometimes Hugs wants to change the arguments which Haskell
+ getArgs >>= ... will be fed. So you can do that by calling here
+ _after_ calling startupHaskell.
+ */
+ prog_argc = argc;
+ prog_argv = argv;
}
/* -----------------------------------------------------------------------------
- we supply a unique integer to each statically declared cost
centre and cost centre stack in the program.
- The code generator inserts a small function "__init_<module>" in each
- module and calls the registration functions in each of the modules
- it imports. So, if we call "__init_PrelMain", each reachable module in the
- program will be registered (because PrelMain.mainIO calls Main.main).
+ The code generator inserts a small function "__stginit_<module>" in each
+ module and calls the registration functions in each of the modules it
+ imports.
The init* functions are compiled in the same way as STG code,
i.e. without normal C call/return conventions. Hence we must use
/* The init functions use an explicit stack...
*/
-#define INIT_STACK_SIZE (BLOCK_SIZE * 4)
-F_ *init_stack = NULL;
-nat init_sp = 0;
+#define INIT_STACK_BLOCKS 4
+static F_ *init_stack = NULL;
-#ifndef INTERPRETER
-static void
-initModules ( void *init_root )
+void
+hs_add_root(void (*init_root)(void))
{
+ bdescr *bd;
#ifdef SMP
Capability cap;
#else
-#define cap MainRegTable
+#define cap MainCapability
#endif
+ nat init_sp;
+
+ if (hs_init_count <= 0) {
+ barf("hs_add_root() must be called after hs_init()");
+ }
init_sp = 0;
- init_stack = (F_ *)allocate(INIT_STACK_SIZE / sizeof(W_));
+ bd = allocGroup(INIT_STACK_BLOCKS);
+ init_stack = (F_ *)bd->start;
init_stack[init_sp++] = (F_)stg_init_ret;
- init_stack[init_sp++] = (F_)__init_Prelude;
if (init_root != NULL) {
init_stack[init_sp++] = (F_)init_root;
}
- cap.rSp = (P_)(init_stack + init_sp);
- StgRun((StgFunPtr)stg_init, &cap);
+ cap.r.rSp = (P_)(init_stack + init_sp);
+ StgRun((StgFunPtr)stg_init, &cap.r);
+
+ freeGroup(bd);
+
+#if defined(PROFILING) || defined(DEBUG)
+ // This must be done after module initialisation.
+ // ToDo: make this work in the presence of multiple hs_add_root()s.
+ initProfiling2();
+#endif
}
-#endif /* !INTERPRETER */
/* -----------------------------------------------------------------------------
- * Shutting down the RTS - two ways of doing this, one which
- * calls exit(), one that doesn't.
- *
- * (shutdownHaskellAndExit() is called by System.exitWith).
- * -----------------------------------------------------------------------------
- */
-void
-shutdownHaskellAndExit(int n)
-{
- OnExitHook();
- shutdownHaskell();
- stg_exit(n);
-}
+ Shutting down the RTS
+ -------------------------------------------------------------------------- */
void
-shutdownHaskell(void)
+hs_exit(void)
{
- if (!rts_has_started_up)
- return;
-
- /* start timing the shutdown */
- stat_startExit();
+ if (hs_init_count <= 0) {
+ barf("too many hs_exit()s");
+ }
+ hs_init_count--;
+ if (hs_init_count > 0) {
+ // ignore until it's the last one
+ return;
+ }
+ /* start timing the shutdown */
+ stat_startExit();
+
+ /* stop all running tasks */
+ exitScheduler();
+
#if !defined(GRAN)
- /* Finalize any remaining weak pointers */
- finalizeWeakPointersNow();
+ /* Finalize any remaining weak pointers */
+ finalizeWeakPointersNow();
#endif
-
+
#if defined(GRAN)
- /* end_gr_simulation prints global stats if requested -- HWL */
- if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
- end_gr_simulation();
+ /* end_gr_simulation prints global stats if requested -- HWL */
+ if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
+ end_gr_simulation();
#endif
-
- /* stop all running tasks */
- exitScheduler();
-
- /* stop the ticker */
- initialize_virtual_timer(0);
-
- /* reset the standard file descriptors to blocking mode */
- resetNonBlockingFd(0);
- resetNonBlockingFd(1);
- resetNonBlockingFd(2);
+
+ /* stop the ticker */
+ stopTimer();
+
+ /* reset the standard file descriptors to blocking mode */
+ resetNonBlockingFd(0);
+ resetNonBlockingFd(1);
+ resetNonBlockingFd(2);
#if defined(PAR)
- shutdownParallelSystem(0);
+ /* controlled exit; good thread! */
+ shutdownParallelSystem(0);
+
+ /* global statistics in parallel system */
+ PAR_TICKY_PAR_END();
#endif
- /* stop timing the shutdown, we're about to print stats */
- stat_endExit();
-
- /* clean up things from the storage manager's point of view.
- * also outputs the stats (+RTS -s) info.
- */
- exitStorage();
-
+ /* stop timing the shutdown, we're about to print stats */
+ stat_endExit();
+
+ /* clean up things from the storage manager's point of view.
+ * also outputs the stats (+RTS -s) info.
+ */
+ exitStorage();
+
#ifdef RTS_GTK_FRONTPANEL
if (RtsFlags.GcFlags.frontpanel) {
stopFrontPanel();
}
#endif
-#if defined(PROFILING) || defined(DEBUG)
- endProfiling();
+#if defined(PROFILING)
+ reportCCSProfiling();
#endif
-#if defined(PROFILING)
- report_ccs_profiling();
+#if defined(PROFILING) || defined(DEBUG)
+ endProfiling();
#endif
+#ifdef PROFILING
+ // Originally, this was in report_ccs_profiling(). Now, retainer
+ // profiling might tack some extra stuff on to the end of this file
+ // during endProfiling().
+ fclose(prof_file);
+#endif
+
#if defined(TICKY_TICKY)
- if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
+ if (RtsFlags.TickyFlags.showTickyStats) PrintTickyInfo();
#endif
- rts_has_started_up=0;
+#if defined(mingw32_TARGET_OS)
+ shutdownAsyncIO();
+#endif
+}
+// Compatibility interfaces
+void
+shutdownHaskell(void)
+{
+ hs_exit();
+}
+
+void
+shutdownHaskellAndExit(int n)
+{
+ if (hs_init_count == 1) {
+ OnExitHook();
+ hs_exit();
+#if defined(PAR)
+ /* really exit (stg_exit() would call shutdownParallelSystem() again) */
+ exit(n);
+#else
+ stg_exit(n);
+#endif
+ }
}
/*
* called from STG-land to exit the program
*/
+#ifdef PAR
+static int exit_started=rtsFalse;
+#endif
+
void
-stg_exit(I_ n)
-{
-#if 0 /* def PAR */
- par_exit(n);
-#else
- exit(n);
+stg_exit(int n)
+{
+#ifdef PAR
+ /* HACK: avoid a loop when exiting due to a stupid error */
+ if (exit_started)
+ return;
+ exit_started=rtsTrue;
+
+ IF_PAR_DEBUG(verbose, fprintf(stderr,"==-- stg_exit %d on [%x]...", n, mytid));
+ shutdownParallelSystem(n);
#endif
+ exit(n);
}