/* -----------------------------------------------------------------------------
- * $Id: RtsStartup.c,v 1.2 1998/12/02 13:28:41 simonm Exp $
+ * $Id: RtsStartup.c,v 1.73 2003/04/01 15:05:15 sof Exp $
+ *
+ * (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 "RtsFlags.h"
#include "Storage.h" /* initStorage, exitStorage */
-#include "StablePtr.h" /* initStablePtrTable */
+#include "StablePriv.h" /* initStablePtrTable */
#include "Schedule.h" /* initScheduler */
#include "Stats.h" /* initStats */
+#include "Signals.h"
+#include "Timer.h" /* startTimer, stopTimer */
#include "Weak.h"
+#include "Ticky.h"
+#include "StgRun.h"
+#include "StgStartup.h"
+#include "Prelude.h" /* fixupRTStoPreludeRefs */
+#include "HsFFI.h"
+#include "Linker.h"
+#include "ThreadLabels.h"
-#if defined(PROFILING)
-# include "ProfRTS.h"
-#elif defined(DEBUG)
-# include "DebugProf.h"
+#if defined(RTS_GTK_FRONTPANEL)
+#include "FrontPanel.h"
#endif
-#ifdef PAR
-#include "ParInit.h"
-#include "Parallel.h"
-#include "LLC.h"
+#if defined(PROFILING) || defined(DEBUG)
+# include "Profiling.h"
+# include "ProfHeap.h"
+# include "RetainerProfile.h"
#endif
-/*
- * Flag Structure
- */
-struct RTS_FLAGS RtsFlags;
+#if defined(GRAN)
+# include "GranSimRts.h"
+#endif
+
+#if defined(GRAN) || defined(PAR)
+# include "ParallelRts.h"
+#endif
-extern void startupHaskell(int argc, char *argv[])
-{
#if defined(PAR)
- int nPEs = 0; /* Number of PEs */
+# include "Parallel.h"
+# include "LLC.h"
+#endif
+
+#if defined(mingw32_TARGET_OS)
+#include "win32/AsyncIO.h"
#endif
+#include <stdlib.h>
+
+// 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
+hs_init(int *argc, char **argv[])
+{
+ 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.
- */
- if (*argv[0] == '-') { /* Look to see whether we're the Main Thread */
- IAmMainThread = rtsTrue;
- argv++; argc--; /* Strip off flag argument */
-/* fprintf(stderr, "I am Main Thread\n"); */
+ /*
+ * 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 */
- SynchroniseSystem();
#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)
- /* Initialise the parallel system -- before initHeap! */
- initParallelSystem();
- /* And start GranSim profiling if required: omitted for now
- *if (Rtsflags.ParFlags.granSimStats)
- *init_gr_profiling(rts_argc, rts_argv, prog_argc, prog_argv);
- */
+ /* NB: this really must be done after processing the RTS flags */
+ 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
+ * initStorage()).
+ */
+ initScheduler();
+
+#if defined(GRAN)
+ /* And start GranSim profiling if required: */
+ if (RtsFlags.GranFlags.GranSimStats.Full)
+ init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
+#elif defined(PAR)
+ /* And start GUM profiling if required: */
+ if (RtsFlags.ParFlags.ParStats.Full)
+ init_gr_simulation(rts_argc, rts_argv, prog_argc, prog_argv);
+#endif /* PAR || GRAN */
+
/* initialize the storage manager */
initStorage();
/* initialise the stable pointer table */
initStablePtrTable();
+ /* initialise thread label table (tso->char*) */
+ initThreadLabelTable();
+
#if defined(PROFILING) || defined(DEBUG)
- initProfiling();
+ initProfiling1();
#endif
- /* Initialise the scheduler */
- initScheduler();
+ /* start the virtual timer 'subsystem'. */
+ startTimer(TICK_MILLISECS);
/* Initialise the stats department */
initStats();
-#if 0
+#if defined(RTS_USER_SIGNALS)
+ /* Initialise the user signal handler set */
initUserSignals();
+ /* Set up handler to run on SIGINT, etc. */
+ initDefaultHandlers();
+#endif
+
+#if defined(mingw32_TARGET_OS)
+ startupAsyncIO();
+#endif
+
+#ifdef RTS_GTK_FRONTPANEL
+ if (RtsFlags.GcFlags.frontpanel) {
+ initFrontPanel();
+ }
#endif
/* Record initialization times */
- end_init();
+ stat_endInit();
}
+// Compatibility interface
void
-shutdownHaskell(void)
+startupHaskell(int argc, char *argv[], void (*init_root)(void))
{
- /* Finalise any remaining weak pointers */
- finaliseWeakPointersNow();
+ hs_init(&argc, &argv);
+ hs_add_root(init_root);
+}
-#if defined(GRAN)
- #error FixMe.
- if (!RTSflags.GranFlags.granSimStats_suppressed)
- end_gr_simulation();
+
+/* -----------------------------------------------------------------------------
+ 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;
+}
+
+/* -----------------------------------------------------------------------------
+ Per-module initialisation
+
+ This process traverses all the compiled modules in the program
+ starting with "Main", and performing per-module initialisation for
+ each one.
+
+ So far, two things happen at initialisation time:
+
+ - we register stable names for each foreign-exported function
+ in that module. This prevents foreign-exported entities, and
+ things they depend on, from being garbage collected.
+
+ - 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 "__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
+ StgRun to call this stuff.
+ -------------------------------------------------------------------------- */
+
+/* The init functions use an explicit stack...
+ */
+#define INIT_STACK_BLOCKS 4
+static F_ *init_stack = NULL;
+
+void
+hs_add_root(void (*init_root)(void))
+{
+ bdescr *bd;
+#ifdef SMP
+ Capability cap;
+#else
+#define cap MainCapability
#endif
+ nat init_sp;
+
+ if (hs_init_count <= 0) {
+ barf("hs_add_root() must be called after hs_init()");
+ }
- /* clean up things from the storage manager's point of view */
- exitStorage();
+ init_sp = 0;
+ bd = allocGroup(INIT_STACK_BLOCKS);
+ init_stack = (F_ *)bd->start;
+ init_stack[init_sp++] = (F_)stg_init_ret;
+ if (init_root != NULL) {
+ init_stack[init_sp++] = (F_)init_root;
+ }
+
+ cap.r.rSp = (P_)(init_stack + init_sp);
+ StgRun((StgFunPtr)stg_init, &cap.r);
+
+ freeGroup(bd);
#if defined(PROFILING) || defined(DEBUG)
- endProfiling();
+ // This must be done after module initialisation.
+ // ToDo: make this work in the presence of multiple hs_add_root()s.
+ initProfiling2();
#endif
+}
-#if defined(PROFILING)
- report_ccs_profiling( );
+/* -----------------------------------------------------------------------------
+ Shutting down the RTS
+ -------------------------------------------------------------------------- */
+
+void
+hs_exit(void)
+{
+ 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();
+#endif
+
+#if defined(GRAN)
+ /* end_gr_simulation prints global stats if requested -- HWL */
+ if (!RtsFlags.GranFlags.GranSimStats.Suppressed)
+ end_gr_simulation();
#endif
+
+ /* stop the ticker */
+ stopTimer();
+
+ /* reset the standard file descriptors to blocking mode */
+ resetNonBlockingFd(0);
+ resetNonBlockingFd(1);
+ resetNonBlockingFd(2);
-#if defined(TICKY_TICKY)
- #error FixMe.
- if (RTSflags.TickyFlags.showTickyStats) PrintTickyInfo();
+#if defined(PAR)
+ /* controlled exit; good thread! */
+ shutdownParallelSystem(0);
+
+ /* global statistics in parallel system */
+ PAR_TICKY_PAR_END();
#endif
- /*
- This fflush is important, because: if "main" just returns,
- then we will end up in pre-supplied exit code that will close
- streams and flush buffers. In particular we have seen: it
- will close fd 0 (stdin), then flush fd 1 (stdout), then <who
- cares>...
+ /* stop timing the shutdown, we're about to print stats */
+ stat_endExit();
- But if you're playing with sockets, that "close fd 0" might
- suggest to the daemon that all is over, only to be presented
- with more stuff on "fd 1" at the flush.
+ /* clean up things from the storage manager's point of view.
+ * also outputs the stats (+RTS -s) info.
+ */
+ exitStorage();
- The fflush avoids this sad possibility.
- */
- fflush(stdout);
+#ifdef RTS_GTK_FRONTPANEL
+ if (RtsFlags.GcFlags.frontpanel) {
+ stopFrontPanel();
+ }
+#endif
+
+#if defined(PROFILING)
+ reportCCSProfiling();
+#endif
+
+#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();
+#endif
+
+#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 cleanly
+ * called from STG-land to exit the program
*/
+#ifdef PAR
+static int exit_started=rtsFalse;
+#endif
+
void
-stg_exit(I_ n)
-{
+stg_exit(int n)
+{
#ifdef PAR
- par_exit(n);
-#else
- OnExitHook();
- exit(n);
+ /* 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);
}
+