ghc/rts/RtsFlags.c

   1
   2 /* -----------------------------------------------------------------------------
   3  *
   4  * (c) The AQUA Project, Glasgow University, 1994-1997
   5  * (c) The GHC Team, 1998-1999
   6  *
   7  * Functions for parsing the argument list.
   8  *
   9  * ---------------------------------------------------------------------------*/
  10
  11 //@menu
  12 //* Includes::
  13 //* Constants::
  14 //* Static function decls::
  15 //* Command-line option parsing routines::
  16 //* GranSim specific options::
  17 //* Aux fcts::
  18 //@end menu
  19 //*/
  20
  21 //@node Includes, Constants
  22 //@subsection Includes
  23
  24 #include "PosixSource.h"
  25 #include "Rts.h"
  26 #include "RtsFlags.h"
  27 #include "RtsUtils.h"
  28 #include "BlockAlloc.h"
  29 #include "Timer.h"              /* CS_MIN_MILLISECS */
  30 #include "Profiling.h"
  31
  32 #ifdef HAVE_CTYPE_H
  33 #include <ctype.h>
  34 #endif
  35
  36 #include <stdlib.h>
  37 #include <string.h>
  38
  39 // Flag Structure
  40 RTS_FLAGS RtsFlags;
  41
  42 /*
  43  * Split argument lists
  44  */
  45 int     prog_argc = 0;    /* an "int" so as to match normal "argc" */
  46 char  **prog_argv = NULL;
  47 char   *prog_name = NULL; /* 'basename' of prog_argv[0] */
  48 int     rts_argc = 0;  /* ditto */
  49 char   *rts_argv[MAX_RTS_ARGS];
  50
  51 //@node Constants, Static function decls, Includes
  52 //@subsection Constants
  53
  54 /*
  55  * constants, used later
  56  */
  57 #define RTS 1
  58 #define PGM 0
  59
  60 #if defined(GRAN)
  61
  62 static char *gran_debug_opts_strs[] = {
  63   "DEBUG (-bDe, -bD1): event_trace; printing event trace.\n",
  64   "DEBUG (-bDE, -bD2): event_stats; printing event statistics.\n",
  65   "DEBUG (-bDb, -bD4): bq; check blocking queues\n",
  66   "DEBUG (-bDG, -bD8): pack; routines for (un-)packing graph structures.\n",
  67   "DEBUG (-bDq, -bD16): checkSparkQ; check consistency of the spark queues.\n",
  68   "DEBUG (-bDf, -bD32): thunkStealing; print forwarding of fetches.\n",
  69   "DEBUG (-bDr, -bD64): randomSteal; stealing sparks/threads from random PEs.\n",
  70   "DEBUG (-bDF, -bD128): findWork; searching spark-pools (local & remote), thread queues for work.\n",
  71   "DEBUG (-bDu, -bD256): unused; currently unused flag.\n",
  72   "DEBUG (-bDS, -bD512): pri; priority sparking or scheduling.\n",
  73   "DEBUG (-bD:, -bD1024): checkLight; check GranSim-Light setup.\n",
  74   "DEBUG (-bDo, -bD2048): sortedQ; check whether spark/thread queues are sorted.\n",
  75   "DEBUG (-bDz, -bD4096): blockOnFetch; check for blocked on fetch.\n",
  76   "DEBUG (-bDP, -bD8192): packBuffer; routines handling pack buffer (GranSim internal!).\n",
  77   "DEBUG (-bDt, -bD16384): blockOnFetch_sanity; check for TSO asleep on fetch.\n",
  78 };
  79
  80 /* one character codes for the available debug options */
  81 static char gran_debug_opts_flags[] = {
  82   'e', 'E', 'b', 'G', 'q', 'f', 'r', 'F', 'u', 'S', ':', 'o', 'z', 'P', 't'
  83 };
  84
  85 #elif defined(PAR)
  86
  87 static char *par_debug_opts_strs[] = {
  88   "DEBUG (-qDv, -qD1): verbose; be generally verbose with parallel related stuff.\n",
  89   "DEBUG (-qDq, -qD2): bq; print blocking queues.\n",
  90   "DEBUG (-qDs, -qD4): schedule; scheduling of parallel threads.\n",
  91   "DEBUG (-qDe, -qD8): free; free messages.\n",
  92   "DEBUG (-qDr, -qD16): resume; resume messages.\n",
  93   "DEBUG (-qDw, -qD32): weight; print weights and distrib GC stuff.\n",
  94   "DEBUG (-qDF, -qD64): fetch; fetch messages.\n",
  95   // "DEBUG (-qDa, -qD128): ack; ack messages.\n",
  96   "DEBUG (-qDf, -qD128): fish; fish messages.\n",
  97   //"DEBUG (-qDo, -qD512): forward; forwarding messages to other PEs.\n",
  98   "DEBUG (-qDl, -qD256): tables; print internal LAGA etc tables.\n",
  99   "DEBUG (-qDo, -qD512): packet; packets and graph structures when packing.\n",
 100   "DEBUG (-qDp, -qD1024): pack; packing and unpacking graphs.\n",
 101   "DEBUG (-qDz, -qD2048): paranoia; ridiculously detailed output (excellent for filling a partition).\n"
 102 };
 103
 104 /* one character codes for the available debug options */
 105 static char par_debug_opts_flags[] = {
 106   'v', 'q', 's', 'e', 'r', 'w', 'F', 'f', 'l', 'o', 'p', 'z'
 107 };
 108
 109 #endif /* PAR */
 110
 111 //@node Static function decls, Command-line option parsing routines, Constants
 112 //@subsection Static function decls
 113
 114 /* -----------------------------------------------------------------------------
 115    Static function decls
 116    -------------------------------------------------------------------------- */
 117
 118 static int              /* return NULL on error */
 119 open_stats_file (
 120     I_ arg,
 121     int argc, char *argv[],
 122     int rts_argc, char *rts_argv[],
 123     const char *FILENAME_FMT,
 124     FILE **file_ret);
 125
 126 static I_ decode(const char *s);
 127 static void bad_option(const char *s);
 128
 129 #if defined(GRAN)
 130 static void enable_GranSimLight(void);
 131 static void process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
 132 static void set_GranSim_debug_options(nat n);
 133 static void help_GranSim_debug_options(nat n);
 134 #elif defined(PAR)
 135 static void process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error);
 136 static void set_par_debug_options(nat n);
 137 static void help_par_debug_options(nat n);
 138 #endif
 139
 140 //@node Command-line option parsing routines, GranSim specific options, Static function decls
 141 //@subsection Command-line option parsing routines
 142
 143 /* -----------------------------------------------------------------------------
 144  * Command-line option parsing routines.
 145  * ---------------------------------------------------------------------------*/
 146
 147 void initRtsFlagsDefaults(void)
 148 {
 149     RtsFlags.GcFlags.statsFile          = NULL;
 150     RtsFlags.GcFlags.giveStats          = NO_GC_STATS;
 151
 152     RtsFlags.GcFlags.maxStkSize         = (8 * 1024 * 1024) / sizeof(W_);
 153     RtsFlags.GcFlags.initialStkSize     = 1024 / sizeof(W_);
 154
 155     RtsFlags.GcFlags.minAllocAreaSize   = (256 * 1024)        / BLOCK_SIZE;
 156     RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
 157     RtsFlags.GcFlags.maxHeapSize        = 0;    /* off by default */
 158     RtsFlags.GcFlags.heapSizeSuggestion = 0;    /* none */
 159     RtsFlags.GcFlags.pcFreeHeap         = 3;    /* 3% */
 160     RtsFlags.GcFlags.oldGenFactor       = 2;
 161 #if defined(PAR)
 162     /* A hack currently needed for GUM -- HWL */
 163     RtsFlags.GcFlags.generations        = 1;
 164     RtsFlags.GcFlags.steps              = 2;
 165     RtsFlags.GcFlags.squeezeUpdFrames   = rtsFalse;
 166 #else
 167     RtsFlags.GcFlags.generations        = 2;
 168     RtsFlags.GcFlags.steps              = 2;
 169     RtsFlags.GcFlags.squeezeUpdFrames   = rtsTrue;
 170 #endif
 171     RtsFlags.GcFlags.compact            = rtsFalse;
 172     RtsFlags.GcFlags.compactThreshold   = 30.0;
 173 #ifdef RTS_GTK_FRONTPANEL
 174     RtsFlags.GcFlags.frontpanel         = rtsFalse;
 175 #endif
 176
 177 #ifdef DEBUG
 178     RtsFlags.DebugFlags.scheduler       = rtsFalse;
 179     RtsFlags.DebugFlags.interpreter     = rtsFalse;
 180     RtsFlags.DebugFlags.codegen         = rtsFalse;
 181     RtsFlags.DebugFlags.weak            = rtsFalse;
 182     RtsFlags.DebugFlags.gccafs          = rtsFalse;
 183     RtsFlags.DebugFlags.gc              = rtsFalse;
 184     RtsFlags.DebugFlags.block_alloc     = rtsFalse;
 185     RtsFlags.DebugFlags.sanity          = rtsFalse;
 186     RtsFlags.DebugFlags.stable          = rtsFalse;
 187     RtsFlags.DebugFlags.stm             = rtsFalse;
 188     RtsFlags.DebugFlags.prof            = rtsFalse;
 189     RtsFlags.DebugFlags.gran            = rtsFalse;
 190     RtsFlags.DebugFlags.par             = rtsFalse;
 191     RtsFlags.DebugFlags.linker          = rtsFalse;
 192 #endif
 193
 194 #if defined(PROFILING) || defined(PAR)
 195     RtsFlags.CcFlags.doCostCentres      = 0;
 196 #endif /* PROFILING or PAR */
 197
 198 #ifdef PROFILING
 199     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
 200     RtsFlags.ProfFlags.profileInterval    = 100;
 201     RtsFlags.ProfFlags.includeTSOs        = rtsFalse;
 202     RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
 203     RtsFlags.ProfFlags.maxRetainerSetSize = 8;
 204     RtsFlags.ProfFlags.modSelector        = NULL;
 205     RtsFlags.ProfFlags.descrSelector      = NULL;
 206     RtsFlags.ProfFlags.typeSelector       = NULL;
 207     RtsFlags.ProfFlags.ccSelector         = NULL;
 208     RtsFlags.ProfFlags.ccsSelector        = NULL;
 209     RtsFlags.ProfFlags.retainerSelector   = NULL;
 210     RtsFlags.ProfFlags.bioSelector        = NULL;
 211
 212 #elif defined(DEBUG)
 213     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
 214 #endif
 215
 216     RtsFlags.ConcFlags.ctxtSwitchTime   = CS_MIN_MILLISECS;  /* In milliseconds */
 217
 218 #ifdef SMP
 219     RtsFlags.ParFlags.nNodes            = 1;
 220 #endif
 221
 222 #ifdef PAR
 223     RtsFlags.ParFlags.ParStats.Full       = rtsFalse;
 224     RtsFlags.ParFlags.ParStats.Suppressed = rtsFalse;
 225     RtsFlags.ParFlags.ParStats.Binary     = rtsFalse;
 226     RtsFlags.ParFlags.ParStats.Sparks     = rtsFalse;
 227     RtsFlags.ParFlags.ParStats.Heap       = rtsFalse;
 228     RtsFlags.ParFlags.ParStats.NewLogfile = rtsFalse;
 229     RtsFlags.ParFlags.ParStats.Global     = rtsFalse;
 230
 231     RtsFlags.ParFlags.outputDisabled    = rtsFalse;
 232 #ifdef DIST
 233     RtsFlags.ParFlags.doFairScheduling  = rtsTrue;  /* fair sched by def */
 234 #else
 235     RtsFlags.ParFlags.doFairScheduling  = rtsFalse;  /* unfair sched by def */
 236 #endif
 237     RtsFlags.ParFlags.packBufferSize    = 1024;
 238     RtsFlags.ParFlags.thunksToPack      = 1; /* 0 ... infinity; */
 239     RtsFlags.ParFlags.globalising       = 1; /* 0 ... everything */
 240     RtsFlags.ParFlags.maxThreads        = 1024;
 241     RtsFlags.ParFlags.maxFishes        = MAX_FISHES;
 242     RtsFlags.ParFlags.fishDelay         = FISH_DELAY;
 243 #endif
 244
 245 #if defined(PAR) || defined(SMP)
 246     RtsFlags.ParFlags.maxLocalSparks    = 4096;
 247 #endif /* PAR || SMP */
 248
 249 #if defined(GRAN)
 250     /* ToDo: check defaults for GranSim and GUM */
 251     RtsFlags.GcFlags.maxStkSize         = (8 * 1024 * 1024) / sizeof(W_);
 252     RtsFlags.GcFlags.initialStkSize     = 1024 / sizeof(W_);
 253
 254     RtsFlags.GranFlags.maxThreads       = 65536; // refers to mandatory threads
 255     RtsFlags.GranFlags.GranSimStats.Full        = rtsFalse;
 256     RtsFlags.GranFlags.GranSimStats.Suppressed  = rtsFalse;
 257     RtsFlags.GranFlags.GranSimStats.Binary      = rtsFalse;
 258     RtsFlags.GranFlags.GranSimStats.Sparks      = rtsFalse;
 259     RtsFlags.GranFlags.GranSimStats.Heap        = rtsFalse;
 260     RtsFlags.GranFlags.GranSimStats.NewLogfile  = rtsFalse;
 261     RtsFlags.GranFlags.GranSimStats.Global      = rtsFalse;
 262
 263     RtsFlags.GranFlags.packBufferSize   = 1024;
 264     RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
 265
 266     RtsFlags.GranFlags.proc         = MAX_PROC;
 267     RtsFlags.GranFlags.Fishing      = rtsFalse;
 268     RtsFlags.GranFlags.maxFishes   = MAX_FISHES;
 269     RtsFlags.GranFlags.time_slice   = GRAN_TIME_SLICE;
 270     RtsFlags.GranFlags.Light        = rtsFalse;
 271
 272     RtsFlags.GranFlags.Costs.latency =             LATENCY;
 273     RtsFlags.GranFlags.Costs.additional_latency =  ADDITIONAL_LATENCY;
 274     RtsFlags.GranFlags.Costs.fetchtime =           FETCHTIME;
 275     RtsFlags.GranFlags.Costs.lunblocktime =        LOCALUNBLOCKTIME;
 276     RtsFlags.GranFlags.Costs.gunblocktime =        GLOBALUNBLOCKTIME;
 277     RtsFlags.GranFlags.Costs.mpacktime =           MSGPACKTIME;
 278     RtsFlags.GranFlags.Costs.munpacktime =         MSGUNPACKTIME;
 279     RtsFlags.GranFlags.Costs.mtidytime =           MSGTIDYTIME;
 280
 281     RtsFlags.GranFlags.Costs.threadcreatetime =         THREADCREATETIME;
 282     RtsFlags.GranFlags.Costs.threadqueuetime =          THREADQUEUETIME;
 283     RtsFlags.GranFlags.Costs.threaddescheduletime =     THREADDESCHEDULETIME;
 284     RtsFlags.GranFlags.Costs.threadscheduletime =       THREADSCHEDULETIME;
 285     RtsFlags.GranFlags.Costs.threadcontextswitchtime =  THREADCONTEXTSWITCHTIME;
 286
 287     RtsFlags.GranFlags.Costs.arith_cost =         ARITH_COST;
 288     RtsFlags.GranFlags.Costs.branch_cost =        BRANCH_COST;
 289     RtsFlags.GranFlags.Costs.load_cost =          LOAD_COST;
 290     RtsFlags.GranFlags.Costs.store_cost =         STORE_COST;
 291     RtsFlags.GranFlags.Costs.float_cost =         FLOAT_COST;
 292
 293     RtsFlags.GranFlags.Costs.heapalloc_cost =     HEAPALLOC_COST;
 294
 295     RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
 296     RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
 297
 298     RtsFlags.GranFlags.DoFairSchedule           = rtsFalse;
 299     RtsFlags.GranFlags.DoAsyncFetch             = rtsFalse;
 300     RtsFlags.GranFlags.DoStealThreadsFirst      = rtsFalse;
 301     RtsFlags.GranFlags.DoAlwaysCreateThreads    = rtsFalse;
 302     RtsFlags.GranFlags.DoBulkFetching           = rtsFalse;
 303     RtsFlags.GranFlags.DoThreadMigration        = rtsFalse;
 304     RtsFlags.GranFlags.FetchStrategy            = 2;
 305     RtsFlags.GranFlags.PreferSparksOfLocalNodes = rtsFalse;
 306     RtsFlags.GranFlags.DoPrioritySparking       = rtsFalse;
 307     RtsFlags.GranFlags.DoPriorityScheduling     = rtsFalse;
 308     RtsFlags.GranFlags.SparkPriority            = 0;
 309     RtsFlags.GranFlags.SparkPriority2           = 0;
 310     RtsFlags.GranFlags.RandomPriorities         = rtsFalse;
 311     RtsFlags.GranFlags.InversePriorities        = rtsFalse;
 312     RtsFlags.GranFlags.IgnorePriorities         = rtsFalse;
 313     RtsFlags.GranFlags.ThunksToPack             = 0;
 314     RtsFlags.GranFlags.RandomSteal              = rtsTrue;
 315 #endif
 316
 317 #ifdef TICKY_TICKY
 318     RtsFlags.TickyFlags.showTickyStats   = rtsFalse;
 319     RtsFlags.TickyFlags.tickyFile        = NULL;
 320 #endif
 321 }
 322
 323 static const char *
 324 usage_text[] = {
 325 "",
 326 "Usage: <prog> <args> [+RTS <rtsopts> | -RTS <args>] ... --RTS <args>",
 327 "",
 328 "   +RTS    Indicates run time system options follow",
 329 "   -RTS    Indicates program arguments follow",
 330 "  --RTS    Indicates that ALL subsequent arguments will be given to the",
 331 "           program (including any of these RTS flags)",
 332 "",
 333 "The following run time system options are available:",
 334 "",
 335 "  -?       Prints this message and exits; the program is not executed",
 336 "",
 337 "  -K<size> Sets the maximum stack size (default 8M)  Egs: -K32k   -K512k",
 338 "  -k<size> Sets the initial thread stack size (default 1k)  Egs: -k4k   -k2m",
 339 "",
 340 "  -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
 341 "  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
 342 "  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
 343 "  -m<n>    Minimum % of heap which must be available (default 3%)",
 344 "  -G<n>    Number of generations (default: 2)",
 345 "  -T<n>    Number of steps in younger generations (default: 2)",
 346 "  -c<n>    Auto-enable compaction of the oldest generation when live data is",
 347 "           at least <n>% of the maximum heap size set with -M (default: 30%)",
 348 "  -c       Enable compaction for all major collections",
 349 "",
 350 "  -t<file> One-line GC statistics  (default file: <program>.stat)",
 351 "  -s<file> Summary  GC statistics  (with -Sstderr going to stderr)",
 352 "  -S<file> Detailed GC statistics",
 353 #ifdef RTS_GTK_FRONTPANEL
 354 "  -f       Display front panel (requires X11 & GTK+)",
 355 #endif
 356 "",
 357 "",
 358 "  -Z       Don't squeeze out update frames on stack overflow",
 359 "  -B       Sound the bell at the start of each garbage collection",
 360 #if defined(PROFILING) || defined(PAR)
 361 "",
 362 "  -px      Time/allocation profile (XML)  (output file <program>.prof)",
 363 "  -p       Time/allocation profile        (output file <program>.prof)",
 364 "  -P       More detailed Time/Allocation profile",
 365 "  -Pa      Give information about *all* cost centres",
 366
 367 # if defined(PROFILING)
 368 "",
 369 "  -hx            Heap residency profile (XML)   (output file <program>.prof)",
 370 "  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
 371 "     break-down: c = cost centre stack (default)",
 372 "                 m = module",
 373 "                 d = closure description",
 374 "                 y = type description",
 375 "                 r = retainer",
 376 "                 b = biography (LAG,DRAG,VOID,USE)",
 377 "  A subset of closures may be selected thusly:",
 378 "    -hc<cc>,...  specific cost centre(s) (top of stack only)",
 379 "    -hC<cc>,...  specific cost centre(s) (anywhere in stack)",
 380 "    -hm<mod>...  all cost centres from the specified modules(s)",
 381 "    -hd<des>,... closures with specified closure descriptions",
 382 "    -hy<typ>...  closures with specified type descriptions",
 383 "    -hr<cc>...   closures with specified retainers",
 384 "    -hb<bio>...  closures with specified biographies (lag,drag,void,use)",
 385 "",
 386 "  -R<size>       Set the maximum retainer set size (default: 8)",
 387 "",
 388 "  -i<sec>        Time between heap samples (seconds, default: 0.1)",
 389 "",
 390 "  -xt            Include threads (TSOs) in a heap profile",
 391 "",
 392 "  -xc      Show current cost centre stack on raising an exception",
 393 # endif
 394 #endif /* PROFILING or PAR */
 395 #if !defined(PROFILING) && defined(DEBUG)
 396 "",
 397 "  -h<break-down> Debugging Heap residency profile",
 398 "                 (output file <program>.hp)",
 399 "     break-down: L = closure label (default)",
 400 "                 T = closure type (constructor, thunk etc.)",
 401 #endif
 402 "",
 403 #if defined(TICKY_TICKY)
 404 "  -r<file>  Produce reduction profiling statistics (with -rstderr for stderr)",
 405 "",
 406 #endif
 407 #if defined(PAR)
 408 "  -N<n>     Use <n> PVMish processors in parallel (default: 2)",
 409 /* NB: the -N<n> is implemented by the driver!! */
 410 #endif
 411 "  -C<secs>  Context-switch interval in seconds",
 412 "                (0 or no argument means switch as often as possible)",
 413 "                the default is .02 sec; resolution is .02 sec",
 414 "",
 415 #if defined(DEBUG)
 416 "  -Ds  DEBUG: scheduler",
 417 "  -Di  DEBUG: interpreter",
 418 "  -Dc  DEBUG: codegen",
 419 "  -Dw  DEBUG: weak",
 420 "  -DG  DEBUG: gccafs",
 421 "  -Dg  DEBUG: gc",
 422 "  -Db  DEBUG: block",
 423 "  -DS  DEBUG: sanity",
 424 "  -Dt  DEBUG: stable",
 425 "  -Dp  DEBUG: prof",
 426 "  -Dr  DEBUG: gran",
 427 "  -DP  DEBUG: par",
 428 "  -Dl  DEBUG: linker",
 429 "  -Dm  DEBUG: stm",
 430 "",
 431 #endif // DEBUG
 432 #if defined(SMP)
 433 "  -N<n>     Use <n> OS threads (default: 1)",
 434 #endif
 435 #if defined(SMP) || defined(PAR)
 436 "  -e<size>  Size of spark pools (default 100)",
 437 #endif
 438 #if defined(PAR)
 439 "  -t<num>   Set maximum number of advisory threads per PE (default 32)",
 440 "  -qP       Enable activity profile (output files in ~/<program>*.gr)",
 441 "  -qQ<size> Set pack-buffer size (default: 1024)",
 442 "  -qd       Turn on PVM-ish debugging",
 443 "  -qO       Disable output for performance measurement",
 444 #endif
 445 #if defined(SMP) || defined(PAR)
 446 "  -e<n>     Maximum number of outstanding local sparks (default: 4096)",
 447 #endif
 448 #if defined(PAR)
 449 "  -d        Turn on PVM-ish debugging",
 450 "  -O        Disable output for performance measurement",
 451 #endif /* PAR */
 452 #if defined(GRAN)  /* ToDo: fill in decent Docu here */
 453 "  -b...     All GranSim options start with -b; see GranSim User's Guide for details",
 454 #endif
 455 "",
 456 "RTS options may also be specified using the GHCRTS environment variable.",
 457 "",
 458 "Other RTS options may be available for programs compiled a different way.",
 459 "The GHC User's Guide has full details.",
 460 "",
 461 0
 462 };
 463
 464 STATIC_INLINE rtsBool
 465 strequal(const char *a, const char * b)
 466 {
 467     return(strcmp(a, b) == 0);
 468 }
 469
 470 static void
 471 splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
 472 {
 473     char *c1, *c2;
 474
 475     c1 = s;
 476     do {
 477         while (isspace(*c1)) { c1++; };
 478         c2 = c1;
 479         while (!isspace(*c2) && *c2 != '\0') { c2++; };
 480
 481         if (c1 == c2) { break; }
 482
 483         if (*rts_argc < MAX_RTS_ARGS-1) {
 484             s = stgMallocBytes(c2-c1+1, "RtsFlags.c:splitRtsFlags()");
 485             strncpy(s, c1, c2-c1);
 486             s[c2-c1] = '\0';
 487             rts_argv[(*rts_argc)++] = s;
 488         } else {
 489             barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 490         }
 491
 492         c1 = c2;
 493     } while (*c1 != '\0');
 494 }
 495
 496 void
 497 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
 498 {
 499     rtsBool error = rtsFalse;
 500     I_ mode;
 501     I_ arg, total_arg;
 502
 503     setProgName (argv);
 504     total_arg = *argc;
 505     arg = 1;
 506
 507     *argc = 1;
 508     *rts_argc = 0;
 509
 510     // process arguments from the ghc_rts_opts global variable first.
 511     // (arguments from the GHCRTS environment variable and the command
 512     // line override these).
 513     {
 514         if (ghc_rts_opts != NULL) {
 515             splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
 516         }
 517     }
 518
 519     // process arguments from the GHCRTS environment variable next
 520     // (arguments from the command line override these).
 521     {
 522         char *ghc_rts = getenv("GHCRTS");
 523
 524         if (ghc_rts != NULL) {
 525             splitRtsFlags(ghc_rts, rts_argc, rts_argv);
 526         }
 527     }
 528
 529     // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
 530     //   argv[0] must be PGM argument -- leave in argv
 531
 532     for (mode = PGM; arg < total_arg; arg++) {
 533         // The '--RTS' argument disables all future +RTS ... -RTS processing.
 534         if (strequal("--RTS", argv[arg])) {
 535             arg++;
 536             break;
 537         }
 538         // The '--' argument is passed through to the program, but
 539         // disables all further +RTS ... -RTS processing.
 540         else if (strequal("--", argv[arg])) {
 541             break;
 542         }
 543         else if (strequal("+RTS", argv[arg])) {
 544             mode = RTS;
 545         }
 546         else if (strequal("-RTS", argv[arg])) {
 547             mode = PGM;
 548         }
 549         else if (mode == RTS && *rts_argc < MAX_RTS_ARGS-1) {
 550             rts_argv[(*rts_argc)++] = argv[arg];
 551         }
 552         else if (mode == PGM) {
 553             argv[(*argc)++] = argv[arg];
 554         }
 555         else {
 556           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
 557         }
 558     }
 559     // process remaining program arguments
 560     for (; arg < total_arg; arg++) {
 561         argv[(*argc)++] = argv[arg];
 562     }
 563     argv[*argc] = (char *) 0;
 564     rts_argv[*rts_argc] = (char *) 0;
 565
 566     // Process RTS (rts_argv) part: mainly to determine statsfile
 567     for (arg = 0; arg < *rts_argc; arg++) {
 568         if (rts_argv[arg][0] != '-') {
 569             fflush(stdout);
 570             errorBelch("unexpected RTS argument: %s", rts_argv[arg]);
 571             error = rtsTrue;
 572
 573         } else {
 574             switch(rts_argv[arg][1]) {
 575
 576               /* process: general args, then PROFILING-only ones,
 577                  then CONCURRENT-only, PARallel-only, GRAN-only,
 578                  TICKY-only (same order as defined in RtsFlags.lh);
 579                  within those groups, mostly in case-insensitive
 580                  alphabetical order.
 581                  Final group is x*, which allows for more options.
 582               */
 583
 584 #ifdef TICKY_TICKY
 585 # define TICKY_BUILD_ONLY(x) x
 586 #else
 587 # define TICKY_BUILD_ONLY(x) \
 588 errorBelch("not built for: ticky-ticky stats"); \
 589 error = rtsTrue;
 590 #endif
 591
 592 #if defined(PROFILING)
 593 # define COST_CENTRE_USING_BUILD_ONLY(x) x
 594 #else
 595 # define COST_CENTRE_USING_BUILD_ONLY(x) \
 596 errorBelch("not built for: -prof or -parallel"); \
 597 error = rtsTrue;
 598 #endif
 599
 600 #ifdef PROFILING
 601 # define PROFILING_BUILD_ONLY(x)   x
 602 #else
 603 # define PROFILING_BUILD_ONLY(x) \
 604 errorBelch("not built for: -prof"); \
 605 error = rtsTrue;
 606 #endif
 607
 608 #ifdef SMP
 609 # define SMP_BUILD_ONLY(x)      x
 610 #else
 611 # define SMP_BUILD_ONLY(x) \
 612 errorBelch("not built for: -smp"); \
 613 error = rtsTrue;
 614 #endif
 615
 616 #ifdef PAR
 617 # define PAR_BUILD_ONLY(x)      x
 618 #else
 619 # define PAR_BUILD_ONLY(x) \
 620 errorBelch("not built for: -parallel"); \
 621 error = rtsTrue;
 622 #endif
 623
 624 #if defined(SMP) || defined(PAR)
 625 # define PAR_OR_SMP_BUILD_ONLY(x)      x
 626 #else
 627 # define PAR_OR_SMP_BUILD_ONLY(x) \
 628 errorBelch("not built for: -parallel or -smp"); \
 629 error = rtsTrue;
 630 #endif
 631
 632 #ifdef GRAN
 633 # define GRAN_BUILD_ONLY(x)     x
 634 #else
 635 # define GRAN_BUILD_ONLY(x) \
 636 errorBelch("not built for: -gransim"); \
 637 error = rtsTrue;
 638 #endif
 639
 640               /* =========== GENERAL ========================== */
 641               case '?':
 642                 error = rtsTrue;
 643                 break;
 644
 645               case 'A':
 646                 RtsFlags.GcFlags.minAllocAreaSize
 647                   = decode(rts_argv[arg]+2) / BLOCK_SIZE;
 648                 if (RtsFlags.GcFlags.minAllocAreaSize <= 0) {
 649                   bad_option(rts_argv[arg]);
 650                 }
 651                 break;
 652
 653               case 'B':
 654                 RtsFlags.GcFlags.ringBell = rtsTrue;
 655                 break;
 656
 657               case 'c':
 658                   if (rts_argv[arg][2] != '\0') {
 659                       RtsFlags.GcFlags.compactThreshold =
 660                           atof(rts_argv[arg]+2);
 661                   } else {
 662                       RtsFlags.GcFlags.compact = rtsTrue;
 663                   }
 664                   break;
 665
 666               case 'F':
 667                 RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
 668
 669                 if (RtsFlags.GcFlags.oldGenFactor < 0)
 670                   bad_option( rts_argv[arg] );
 671                 break;
 672
 673 #ifdef DEBUG
 674               case 'D':
 675               {
 676                   char *c;
 677
 678                   for (c  = rts_argv[arg] + 2; *c != '\0'; c++) {
 679                       switch (*c) {
 680                       case 's':
 681                           RtsFlags.DebugFlags.scheduler = rtsTrue;
 682                           break;
 683                       case 'i':
 684                           RtsFlags.DebugFlags.interpreter = rtsTrue;
 685                           break;
 686                       case 'c':
 687                           RtsFlags.DebugFlags.codegen = rtsTrue;
 688                           break;
 689                       case 'w':
 690                           RtsFlags.DebugFlags.weak = rtsTrue;
 691                           break;
 692                       case 'G':
 693                           RtsFlags.DebugFlags.gccafs = rtsTrue;
 694                           break;
 695                       case 'g':
 696                           RtsFlags.DebugFlags.gc = rtsTrue;
 697                           break;
 698                       case 'b':
 699                           RtsFlags.DebugFlags.block_alloc = rtsTrue;
 700                           break;
 701                       case 'S':
 702                           RtsFlags.DebugFlags.sanity = rtsTrue;
 703                           break;
 704                       case 't':
 705                           RtsFlags.DebugFlags.stable = rtsTrue;
 706                           break;
 707                       case 'p':
 708                           RtsFlags.DebugFlags.prof = rtsTrue;
 709                           break;
 710                       case 'r':
 711                           RtsFlags.DebugFlags.gran = rtsTrue;
 712                           break;
 713                       case 'P':
 714                           RtsFlags.DebugFlags.par = rtsTrue;
 715                           break;
 716                       case 'l':
 717                           RtsFlags.DebugFlags.linker = rtsTrue;
 718                           break;
 719                       case 'a':
 720                           RtsFlags.DebugFlags.apply = rtsTrue;
 721                           break;
 722                       case 'm':
 723                           RtsFlags.DebugFlags.stm = rtsTrue;
 724                           break;
 725                       default:
 726                           bad_option( rts_argv[arg] );
 727                       }
 728                   }
 729                   break;
 730               }
 731 #endif
 732
 733               case 'K':
 734                 RtsFlags.GcFlags.maxStkSize =
 735                   decode(rts_argv[arg]+2) / sizeof(W_);
 736
 737                 if (RtsFlags.GcFlags.maxStkSize == 0)
 738                   bad_option( rts_argv[arg] );
 739                 break;
 740
 741               case 'k':
 742                 RtsFlags.GcFlags.initialStkSize =
 743                   decode(rts_argv[arg]+2) / sizeof(W_);
 744
 745                 if (RtsFlags.GcFlags.initialStkSize == 0)
 746                   bad_option( rts_argv[arg] );
 747                 break;
 748
 749               case 'M':
 750                 RtsFlags.GcFlags.maxHeapSize =
 751                   decode(rts_argv[arg]+2) / BLOCK_SIZE;
 752                 /* user give size in *bytes* but "maxHeapSize" is in *blocks* */
 753
 754                 if (RtsFlags.GcFlags.maxHeapSize <= 0) {
 755                   bad_option(rts_argv[arg]);
 756                 }
 757                 break;
 758
 759               case 'm':
 760                 RtsFlags.GcFlags.pcFreeHeap = atof(rts_argv[arg]+2);
 761
 762                 if (RtsFlags.GcFlags.pcFreeHeap < 0 ||
 763                     RtsFlags.GcFlags.pcFreeHeap > 100)
 764                   bad_option( rts_argv[arg] );
 765                 break;
 766
 767               case 'G':
 768                 RtsFlags.GcFlags.generations = decode(rts_argv[arg]+2);
 769                 if (RtsFlags.GcFlags.generations < 1) {
 770                   bad_option(rts_argv[arg]);
 771                 }
 772                 break;
 773
 774               case 'T':
 775                 RtsFlags.GcFlags.steps = decode(rts_argv[arg]+2);
 776                 if (RtsFlags.GcFlags.steps < 1) {
 777                   bad_option(rts_argv[arg]);
 778                 }
 779                 break;
 780
 781               case 'H':
 782                 RtsFlags.GcFlags.heapSizeSuggestion =
 783                   decode(rts_argv[arg]+2) / BLOCK_SIZE;
 784
 785                 if (RtsFlags.GcFlags.heapSizeSuggestion <= 0) {
 786                   bad_option(rts_argv[arg]);
 787                 }
 788                 break;
 789
 790 #ifdef RTS_GTK_FRONTPANEL
 791               case 'f':
 792                   RtsFlags.GcFlags.frontpanel = rtsTrue;
 793                   break;
 794 #endif
 795
 796               case 'S':
 797                   RtsFlags.GcFlags.giveStats = VERBOSE_GC_STATS;
 798                   goto stats;
 799
 800               case 's':
 801                   RtsFlags.GcFlags.giveStats = SUMMARY_GC_STATS;
 802                   goto stats;
 803
 804               case 't':
 805                   RtsFlags.GcFlags.giveStats = ONELINE_GC_STATS;
 806                   goto stats;
 807
 808             stats:
 809 #ifdef PAR
 810                 /* Opening all those files would almost certainly fail... */
 811                 // RtsFlags.ParFlags.ParStats.Full = rtsTrue;
 812                 RtsFlags.GcFlags.statsFile = NULL; /* temporary; ToDo: rm */
 813 #else
 814                 {
 815                     int r;
 816                     r = open_stats_file(arg, *argc, argv,
 817                                         *rts_argc, rts_argv, STAT_FILENAME_FMT,
 818                                         &RtsFlags.GcFlags.statsFile);
 819                     if (r == -1) { error = rtsTrue; }
 820                 }
 821 #endif
 822                   break;
 823
 824               case 'Z':
 825                 RtsFlags.GcFlags.squeezeUpdFrames = rtsFalse;
 826                 break;
 827
 828               /* =========== PROFILING ========================== */
 829
 830               case 'P': /* detailed cost centre profiling (time/alloc) */
 831               case 'p': /* cost centre profiling (time/alloc) */
 832                 COST_CENTRE_USING_BUILD_ONLY(
 833                 switch (rts_argv[arg][2]) {
 834                   case 'x':
 835                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
 836                     break;
 837                   case 'a':
 838                     RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
 839                     break;
 840                   default:
 841                       if (rts_argv[arg][1] == 'P') {
 842                           RtsFlags.CcFlags.doCostCentres =
 843                               COST_CENTRES_VERBOSE;
 844                       } else {
 845                           RtsFlags.CcFlags.doCostCentres =
 846                               COST_CENTRES_SUMMARY;
 847                       }
 848                       break;
 849                 }
 850                 ) break;
 851
 852               case 'R':
 853                   PROFILING_BUILD_ONLY(
 854                       RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
 855                   ) break;
 856
 857               case 'h': /* serial heap profile */
 858 #if !defined(PROFILING) && defined(DEBUG)
 859                 switch (rts_argv[arg][2]) {
 860                   case '\0':
 861                   case 'L':
 862                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_INFOPTR;
 863                     break;
 864                   case 'T':
 865                     RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CLOSURE_TYPE;
 866                     break;
 867                   default:
 868                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 869                     error = rtsTrue;
 870                 }
 871 #else
 872                 PROFILING_BUILD_ONLY(
 873                 switch (rts_argv[arg][2]) {
 874                 case '\0':
 875                 case 'C':
 876                 case 'c':
 877                 case 'M':
 878                 case 'm':
 879                 case 'D':
 880                 case 'd':
 881                 case 'Y':
 882                 case 'y':
 883                 case 'R':
 884                 case 'r':
 885                 case 'B':
 886                 case 'b':
 887                     if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
 888                         {
 889                             char *left  = strchr(rts_argv[arg], '{');
 890                             char *right = strrchr(rts_argv[arg], '}');
 891
 892                             // curly braces are optional, for
 893                             // backwards compat.
 894                             if (left)
 895                                 left = left+1;
 896                             else
 897                                 left = rts_argv[arg] + 3;
 898
 899                             if (!right)
 900                                 right = rts_argv[arg] + strlen(rts_argv[arg]);
 901
 902                             *right = '\0';
 903
 904                             switch (rts_argv[arg][2]) {
 905                             case 'c': // cost centre label select
 906                                 RtsFlags.ProfFlags.ccSelector = left;
 907                                 break;
 908                             case 'C':
 909                                 RtsFlags.ProfFlags.ccsSelector = left;
 910                                 break;
 911                             case 'M':
 912                             case 'm': // cost centre module select
 913                                 RtsFlags.ProfFlags.modSelector = left;
 914                                 break;
 915                             case 'D':
 916                             case 'd': // closure descr select
 917                                 RtsFlags.ProfFlags.descrSelector = left;
 918                                 break;
 919                             case 'Y':
 920                             case 'y': // closure type select
 921                                 RtsFlags.ProfFlags.typeSelector = left;
 922                                 break;
 923                             case 'R':
 924                             case 'r': // retainer select
 925                                 RtsFlags.ProfFlags.retainerSelector = left;
 926                                 break;
 927                             case 'B':
 928                             case 'b': // biography select
 929                                 RtsFlags.ProfFlags.bioSelector = left;
 930                                 break;
 931                             }
 932                         }
 933                         break;
 934                     }
 935
 936                     if (RtsFlags.ProfFlags.doHeapProfile != 0) {
 937                         errorBelch("multiple heap profile options");
 938                         error = rtsTrue;
 939                         break;
 940                     }
 941
 942                     switch (rts_argv[arg][2]) {
 943                     case '\0':
 944                     case 'C':
 945                     case 'c':
 946                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
 947                         break;
 948                     case 'M':
 949                     case 'm':
 950                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
 951                           break;
 952                     case 'D':
 953                     case 'd':
 954                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
 955                           break;
 956                     case 'Y':
 957                     case 'y':
 958                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
 959                           break;
 960                     case 'R':
 961                     case 'r':
 962                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
 963                           break;
 964                     case 'B':
 965                     case 'b':
 966                           RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
 967                           break;
 968                     }
 969                     break;
 970
 971                 default:
 972                     errorBelch("invalid heap profile option: %s",rts_argv[arg]);
 973                     error = rtsTrue;
 974                 }
 975                 )
 976 #endif // PROFILING
 977                 break;
 978
 979 #if defined(PROFILING)
 980               case 'i': /* heap sample interval */
 981                 if (rts_argv[arg][2] == '\0') {
 982                   /* use default */
 983                 } else {
 984                     I_ cst; /* tmp */
 985
 986                     /* Convert to milliseconds */
 987                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
 988                     cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
 989                     if (cst != 0 && cst < CS_MIN_MILLISECS)
 990                         cst = CS_MIN_MILLISECS;
 991
 992                     RtsFlags.ProfFlags.profileInterval = cst;
 993                 }
 994                 break;
 995 #endif
 996
 997               /* =========== CONCURRENT ========================= */
 998               case 'C': /* context switch interval */
 999                 if (rts_argv[arg][2] == '\0')
1000                     RtsFlags.ConcFlags.ctxtSwitchTime = 0;
1001                 else {
1002                     I_ cst; /* tmp */
1003
1004                     /* Convert to milliseconds */
1005                     cst = (I_) ((atof(rts_argv[arg]+2) * 1000));
1006                     cst = (cst / CS_MIN_MILLISECS) * CS_MIN_MILLISECS;
1007                     if (cst != 0 && cst < CS_MIN_MILLISECS)
1008                         cst = CS_MIN_MILLISECS;
1009
1010                     RtsFlags.ConcFlags.ctxtSwitchTime = cst;
1011                 }
1012                 break;
1013
1014 #ifdef SMP
1015               case 'N':
1016                 SMP_BUILD_ONLY(
1017                 if (rts_argv[arg][2] != '\0') {
1018                     RtsFlags.ParFlags.nNodes
1019                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1020                     if (RtsFlags.ParFlags.nNodes <= 0) {
1021                       errorBelch("bad value for -N");
1022                       error = rtsTrue;
1023                     }
1024                 }
1025                 ) break;
1026 #endif
1027               /* =========== PARALLEL =========================== */
1028               case 'e':
1029                 PAR_OR_SMP_BUILD_ONLY(
1030                 if (rts_argv[arg][2] != '\0') {
1031                     RtsFlags.ParFlags.maxLocalSparks
1032                       = strtol(rts_argv[arg]+2, (char **) NULL, 10);
1033                     if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1034                       errorBelch("bad value for -e");
1035                       error = rtsTrue;
1036                     }
1037                 }
1038                 ) break;
1039
1040               case 'q':
1041                 PAR_BUILD_ONLY(
1042                   process_par_option(arg, rts_argc, rts_argv, &error);
1043                 ) break;
1044
1045               /* =========== GRAN =============================== */
1046
1047               case 'b':
1048                 GRAN_BUILD_ONLY(
1049                   process_gran_option(arg, rts_argc, rts_argv, &error);
1050                 ) break;
1051
1052               /* =========== TICKY ============================== */
1053
1054               case 'r': /* Basic profiling stats */
1055                 TICKY_BUILD_ONLY(
1056
1057                 RtsFlags.TickyFlags.showTickyStats = rtsTrue;
1058
1059                 {
1060                     int r;
1061                     r = open_stats_file(arg, *argc, argv,
1062                                         *rts_argc, rts_argv, TICKY_FILENAME_FMT,
1063                                         &RtsFlags.TickyFlags.tickyFile);
1064                     if (r == -1) { error = rtsTrue; }
1065                 }
1066                 ) break;
1067
1068               /* =========== EXTENDED OPTIONS =================== */
1069
1070               case 'x': /* Extend the argument space */
1071                 switch(rts_argv[arg][2]) {
1072                   case '\0':
1073                     errorBelch("incomplete RTS option: %s",rts_argv[arg]);
1074                     error = rtsTrue;
1075                     break;
1076
1077                   case 'c': /* Debugging tool: show current cost centre on an exception */
1078                     PROFILING_BUILD_ONLY(
1079                         RtsFlags.ProfFlags.showCCSOnException = rtsTrue;
1080                         );
1081                     break;
1082
1083                 case 't':  /* Include memory used by TSOs in a heap profile */
1084                     PROFILING_BUILD_ONLY(
1085                         RtsFlags.ProfFlags.includeTSOs = rtsTrue;
1086                         );
1087                     break;
1088
1089                   /* The option prefix '-xx' is reserved for future extension.  KSW 1999-11. */
1090
1091                   default:
1092                     errorBelch("unknown RTS option: %s",rts_argv[arg]);
1093                     error = rtsTrue;
1094                     break;
1095                 }
1096                 break;  /* defensive programming */
1097
1098               /* =========== OH DEAR ============================ */
1099               default:
1100                 errorBelch("unknown RTS option: %s",rts_argv[arg]);
1101                 error = rtsTrue;
1102                 break;
1103             }
1104         }
1105     }
1106     if (error) {
1107         const char **p;
1108
1109         fflush(stdout);
1110         for (p = usage_text; *p; p++)
1111             errorBelch("%s", *p);
1112         stg_exit(EXIT_FAILURE);
1113     }
1114 }
1115
1116 #if defined(GRAN)
1117
1118 //@node GranSim specific options, Aux fcts, Command-line option parsing routines
1119 //@subsection GranSim specific options
1120
1121 static void
1122 enable_GranSimLight(void) {
1123
1124     debugBelch("GrAnSim Light enabled (infinite number of processors;  0 communication costs)\n");
1125     RtsFlags.GranFlags.Light=rtsTrue;
1126     RtsFlags.GranFlags.Costs.latency =
1127         RtsFlags.GranFlags.Costs.fetchtime =
1128         RtsFlags.GranFlags.Costs.additional_latency =
1129         RtsFlags.GranFlags.Costs.gunblocktime =
1130         RtsFlags.GranFlags.Costs.lunblocktime =
1131         RtsFlags.GranFlags.Costs.threadcreatetime =
1132         RtsFlags.GranFlags.Costs.threadqueuetime =
1133         RtsFlags.GranFlags.Costs.threadscheduletime =
1134         RtsFlags.GranFlags.Costs.threaddescheduletime =
1135         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1136
1137     RtsFlags.GranFlags.Costs.mpacktime =
1138         RtsFlags.GranFlags.Costs.munpacktime = 0;
1139
1140     RtsFlags.GranFlags.DoFairSchedule = rtsTrue;
1141     RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1142     RtsFlags.GranFlags.DoAlwaysCreateThreads = rtsTrue;
1143     /* FetchStrategy is irrelevant in GrAnSim-Light */
1144
1145     /* GrAnSim Light often creates an abundance of parallel threads,
1146        each with its own stack etc. Therefore, it's in general a good
1147        idea to use small stack chunks (use the -o<size> option to
1148        increase it again).
1149     */
1150     // RtsFlags.ConcFlags.stkChunkSize = 100;
1151
1152     RtsFlags.GranFlags.proc = 1;
1153 }
1154
1155 static void
1156 process_gran_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1157 {
1158     if (rts_argv[arg][1] != 'b') /* All GranSim options start with -b */
1159       return;
1160
1161     /* or a ridiculously idealised simulator */
1162     if(strcmp((rts_argv[arg]+2),"oring")==0) {
1163       RtsFlags.GranFlags.Costs.latency =
1164         RtsFlags.GranFlags.Costs.fetchtime =
1165         RtsFlags.GranFlags.Costs.additional_latency =
1166         RtsFlags.GranFlags.Costs.gunblocktime =
1167         RtsFlags.GranFlags.Costs.lunblocktime =
1168         RtsFlags.GranFlags.Costs.threadcreatetime =
1169         RtsFlags.GranFlags.Costs.threadqueuetime =
1170         RtsFlags.GranFlags.Costs.threadscheduletime =
1171         RtsFlags.GranFlags.Costs.threaddescheduletime =
1172         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1173
1174       RtsFlags.GranFlags.Costs.mpacktime =
1175         RtsFlags.GranFlags.Costs.munpacktime = 0;
1176
1177       RtsFlags.GranFlags.Costs.arith_cost =
1178         RtsFlags.GranFlags.Costs.float_cost =
1179         RtsFlags.GranFlags.Costs.load_cost =
1180         RtsFlags.GranFlags.Costs.store_cost =
1181         RtsFlags.GranFlags.Costs.branch_cost = 0;
1182
1183       RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1184
1185       /* ++RtsFlags.GranFlags.DoFairSchedule; */
1186       RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue;        /* -bZ */
1187       RtsFlags.GranFlags.DoThreadMigration   = rtsTrue;        /* -bM */
1188       RtsFlags.GranFlags.GranSimStats.Full   = rtsTrue;        /* -bP */
1189       return;
1190     }
1191
1192       /* or a somewhat idealised simulator */
1193       if(strcmp((rts_argv[arg]+2),"onzo")==0) {
1194         RtsFlags.GranFlags.Costs.latency =
1195         RtsFlags.GranFlags.Costs.fetchtime =
1196         RtsFlags.GranFlags.Costs.additional_latency =
1197         RtsFlags.GranFlags.Costs.gunblocktime =
1198         RtsFlags.GranFlags.Costs.lunblocktime =
1199         RtsFlags.GranFlags.Costs.threadcreatetime =
1200         RtsFlags.GranFlags.Costs.threadqueuetime =
1201         RtsFlags.GranFlags.Costs.threadscheduletime =
1202         RtsFlags.GranFlags.Costs.threaddescheduletime =
1203         RtsFlags.GranFlags.Costs.threadcontextswitchtime = 0;
1204
1205         RtsFlags.GranFlags.Costs.mpacktime =
1206         RtsFlags.GranFlags.Costs.munpacktime = 0;
1207
1208         RtsFlags.GranFlags.Costs.heapalloc_cost = 1;
1209
1210         /* RtsFlags.GranFlags.DoFairSchedule  = rtsTrue; */       /* -b-R */
1211         /* RtsFlags.GranFlags.DoStealThreadsFirst = rtsTrue; */   /* -b-T */
1212         RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;         /* -bZ */
1213         RtsFlags.GranFlags.DoThreadMigration  = rtsTrue;          /* -bM */
1214         RtsFlags.GranFlags.GranSimStats.Full  = rtsTrue;          /* -bP */
1215 #  if defined(GRAN_CHECK) && defined(GRAN)
1216         RtsFlags.GranFlags.Debug.event_stats = rtsTrue; /* print event statistics   */
1217 #  endif
1218         return;
1219       }
1220
1221       /* Communication and task creation cost parameters */
1222       switch(rts_argv[arg][2]) {
1223         case '.':
1224           IgnoreYields = rtsTrue; // HWL HACK
1225           break;
1226
1227         case ':':
1228           enable_GranSimLight();       /* set flags for GrAnSim-Light mode */
1229           break;
1230
1231         case 'l':
1232           if (rts_argv[arg][3] != '\0')
1233             {
1234               RtsFlags.GranFlags.Costs.gunblocktime =
1235               RtsFlags.GranFlags.Costs.latency = decode(rts_argv[arg]+3);
1236               RtsFlags.GranFlags.Costs.fetchtime = 2*RtsFlags.GranFlags.Costs.latency;
1237             }
1238           else
1239             RtsFlags.GranFlags.Costs.latency = LATENCY;
1240           break;
1241
1242         case 'a':
1243           if (rts_argv[arg][3] != '\0')
1244             RtsFlags.GranFlags.Costs.additional_latency = decode(rts_argv[arg]+3);
1245           else
1246             RtsFlags.GranFlags.Costs.additional_latency = ADDITIONAL_LATENCY;
1247           break;
1248
1249         case 'm':
1250           if (rts_argv[arg][3] != '\0')
1251             RtsFlags.GranFlags.Costs.mpacktime = decode(rts_argv[arg]+3);
1252           else
1253             RtsFlags.GranFlags.Costs.mpacktime = MSGPACKTIME;
1254           break;
1255
1256         case 'x':
1257           if (rts_argv[arg][3] != '\0')
1258             RtsFlags.GranFlags.Costs.mtidytime = decode(rts_argv[arg]+3);
1259           else
1260             RtsFlags.GranFlags.Costs.mtidytime = 0;
1261           break;
1262
1263         case 'r':
1264           if (rts_argv[arg][3] != '\0')
1265             RtsFlags.GranFlags.Costs.munpacktime = decode(rts_argv[arg]+3);
1266           else
1267             RtsFlags.GranFlags.Costs.munpacktime = MSGUNPACKTIME;
1268           break;
1269
1270         case 'g':
1271           if (rts_argv[arg][3] != '\0')
1272             RtsFlags.GranFlags.Costs.fetchtime = decode(rts_argv[arg]+3);
1273           else
1274             RtsFlags.GranFlags.Costs.fetchtime = FETCHTIME;
1275           break;
1276
1277         case 'n':
1278           if (rts_argv[arg][3] != '\0')
1279             RtsFlags.GranFlags.Costs.gunblocktime = decode(rts_argv[arg]+3);
1280           else
1281             RtsFlags.GranFlags.Costs.gunblocktime = GLOBALUNBLOCKTIME;
1282           break;
1283
1284         case 'u':
1285           if (rts_argv[arg][3] != '\0')
1286             RtsFlags.GranFlags.Costs.lunblocktime = decode(rts_argv[arg]+3);
1287           else
1288             RtsFlags.GranFlags.Costs.lunblocktime = LOCALUNBLOCKTIME;
1289           break;
1290
1291         /* Thread-related metrics */
1292         case 't':
1293           if (rts_argv[arg][3] != '\0')
1294             RtsFlags.GranFlags.Costs.threadcreatetime = decode(rts_argv[arg]+3);
1295           else
1296             RtsFlags.GranFlags.Costs.threadcreatetime = THREADCREATETIME;
1297           break;
1298
1299         case 'q':
1300           if (rts_argv[arg][3] != '\0')
1301             RtsFlags.GranFlags.Costs.threadqueuetime = decode(rts_argv[arg]+3);
1302           else
1303             RtsFlags.GranFlags.Costs.threadqueuetime = THREADQUEUETIME;
1304           break;
1305
1306         case 'c':
1307           if (rts_argv[arg][3] != '\0')
1308             RtsFlags.GranFlags.Costs.threadscheduletime = decode(rts_argv[arg]+3);
1309           else
1310             RtsFlags.GranFlags.Costs.threadscheduletime = THREADSCHEDULETIME;
1311
1312           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1313             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1314           break;
1315
1316         case 'd':
1317           if (rts_argv[arg][3] != '\0')
1318             RtsFlags.GranFlags.Costs.threaddescheduletime = decode(rts_argv[arg]+3);
1319           else
1320             RtsFlags.GranFlags.Costs.threaddescheduletime = THREADDESCHEDULETIME;
1321
1322           RtsFlags.GranFlags.Costs.threadcontextswitchtime = RtsFlags.GranFlags.Costs.threadscheduletime
1323             + RtsFlags.GranFlags.Costs.threaddescheduletime;
1324           break;
1325
1326         /* Instruction Cost Metrics */
1327         case 'A':
1328           if (rts_argv[arg][3] != '\0')
1329             RtsFlags.GranFlags.Costs.arith_cost = decode(rts_argv[arg]+3);
1330           else
1331             RtsFlags.GranFlags.Costs.arith_cost = ARITH_COST;
1332           break;
1333
1334         case 'F':
1335           if (rts_argv[arg][3] != '\0')
1336             RtsFlags.GranFlags.Costs.float_cost = decode(rts_argv[arg]+3);
1337           else
1338             RtsFlags.GranFlags.Costs.float_cost = FLOAT_COST;
1339           break;
1340
1341         case 'B':
1342           if (rts_argv[arg][3] != '\0')
1343             RtsFlags.GranFlags.Costs.branch_cost = decode(rts_argv[arg]+3);
1344           else
1345             RtsFlags.GranFlags.Costs.branch_cost = BRANCH_COST;
1346           break;
1347
1348         case 'L':
1349           if (rts_argv[arg][3] != '\0')
1350             RtsFlags.GranFlags.Costs.load_cost = decode(rts_argv[arg]+3);
1351           else
1352             RtsFlags.GranFlags.Costs.load_cost = LOAD_COST;
1353           break;
1354
1355         case 'S':
1356           if (rts_argv[arg][3] != '\0')
1357             RtsFlags.GranFlags.Costs.store_cost = decode(rts_argv[arg]+3);
1358           else
1359             RtsFlags.GranFlags.Costs.store_cost = STORE_COST;
1360           break;
1361
1362         case 'H':
1363           if (rts_argv[arg][3] != '\0')
1364             RtsFlags.GranFlags.Costs.heapalloc_cost = decode(rts_argv[arg]+3);
1365           else
1366             RtsFlags.GranFlags.Costs.heapalloc_cost = 0;
1367           break;
1368
1369         case 'y':
1370           RtsFlags.GranFlags.DoAsyncFetch = rtsTrue;
1371           if (rts_argv[arg][3] != '\0')
1372             RtsFlags.GranFlags.FetchStrategy = decode(rts_argv[arg]+3);
1373           else
1374             RtsFlags.GranFlags.FetchStrategy = 2;
1375           if (RtsFlags.GranFlags.FetchStrategy == 0)
1376             RtsFlags.GranFlags.DoAsyncFetch = rtsFalse;
1377           break;
1378
1379         case 'K':   /* sort overhead (per elem in spark list) */
1380           if (rts_argv[arg][3] != '\0')
1381             RtsFlags.GranFlags.Costs.pri_spark_overhead = decode(rts_argv[arg]+3);
1382           else
1383             RtsFlags.GranFlags.Costs.pri_spark_overhead = PRI_SPARK_OVERHEAD;
1384           debugBelch("Overhead for pri spark: %d (per elem).\n",
1385                          RtsFlags.GranFlags.Costs.pri_spark_overhead);
1386           break;
1387
1388         case 'O':  /* sort overhead (per elem in spark list) */
1389           if (rts_argv[arg][3] != '\0')
1390             RtsFlags.GranFlags.Costs.pri_sched_overhead = decode(rts_argv[arg]+3);
1391           else
1392             RtsFlags.GranFlags.Costs.pri_sched_overhead = PRI_SCHED_OVERHEAD;
1393           debugBelch("Overhead for pri sched: %d (per elem).\n",
1394                        RtsFlags.GranFlags.Costs.pri_sched_overhead);
1395           break;
1396
1397         /* General Parameters */
1398         case 'p':
1399           if (rts_argv[arg][3] != '\0')
1400             {
1401               RtsFlags.GranFlags.proc = decode(rts_argv[arg]+3);
1402               if (RtsFlags.GranFlags.proc==0) {
1403                   enable_GranSimLight(); /* set flags for GrAnSim-Light mode */
1404               } else if (RtsFlags.GranFlags.proc > MAX_PROC ||
1405                          RtsFlags.GranFlags.proc < 1)
1406                 {
1407                   debugBelch("setupRtsFlags: no more than %u processors allowed\n",
1408                           MAX_PROC);
1409                   *error = rtsTrue;
1410                 }
1411             }
1412           else
1413             RtsFlags.GranFlags.proc = MAX_PROC;
1414           break;
1415
1416         case 'f':
1417           RtsFlags.GranFlags.Fishing = rtsTrue;
1418           if (rts_argv[arg][3] != '\0')
1419             RtsFlags.GranFlags.maxFishes = decode(rts_argv[arg]+3);
1420           else
1421             RtsFlags.GranFlags.maxFishes = MAX_FISHES;
1422           break;
1423
1424         case 'w':
1425           if (rts_argv[arg][3] != '\0')
1426             RtsFlags.GranFlags.time_slice = decode(rts_argv[arg]+3);
1427           else
1428             RtsFlags.GranFlags.time_slice = GRAN_TIME_SLICE;
1429           break;
1430
1431         case 'C':
1432           RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsTrue;
1433           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1434           break;
1435
1436         case 'G':
1437           debugBelch("Bulk fetching enabled.\n");
1438           RtsFlags.GranFlags.DoBulkFetching=rtsTrue;
1439           break;
1440
1441         case 'M':
1442           debugBelch("Thread migration enabled.\n");
1443           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1444           break;
1445
1446         case 'R':
1447           debugBelch("Fair Scheduling enabled.\n");
1448           RtsFlags.GranFlags.DoFairSchedule=rtsTrue;
1449           break;
1450
1451         case 'I':
1452           debugBelch("Priority Scheduling enabled.\n");
1453           RtsFlags.GranFlags.DoPriorityScheduling=rtsTrue;
1454           break;
1455
1456         case 'T':
1457           RtsFlags.GranFlags.DoStealThreadsFirst=rtsTrue;
1458           RtsFlags.GranFlags.DoThreadMigration=rtsTrue;
1459           break;
1460
1461         case 'Z':
1462           RtsFlags.GranFlags.DoAsyncFetch=rtsTrue;
1463           break;
1464
1465 /*          case 'z': */
1466 /*        RtsFlags.GranFlags.SimplifiedFetch=rtsTrue; */
1467 /*        break; */
1468
1469         case 'N':
1470           RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsTrue;
1471           break;
1472
1473         case 'b':
1474           RtsFlags.GranFlags.GranSimStats.Binary=rtsTrue;
1475           break;
1476
1477         case 'P':
1478           /* format is -bP<c> where <c> is one char describing kind of profile */
1479           RtsFlags.GranFlags.GranSimStats.Full = rtsTrue;
1480           switch(rts_argv[arg][3]) {
1481           case '\0': break; // nothing special, just an ordinary profile
1482           case '0': RtsFlags.GranFlags.GranSimStats.Suppressed = rtsTrue;
1483             break;
1484           case 'b': RtsFlags.GranFlags.GranSimStats.Binary = rtsTrue;
1485             break;
1486           case 's': RtsFlags.GranFlags.GranSimStats.Sparks = rtsTrue;
1487             break;
1488           case 'h': RtsFlags.GranFlags.GranSimStats.Heap = rtsTrue;
1489             break;
1490           case 'n': RtsFlags.GranFlags.GranSimStats.NewLogfile = rtsTrue;
1491             break;
1492           case 'g': RtsFlags.GranFlags.GranSimStats.Global = rtsTrue;
1493             break;
1494           default: barf("Unknown option -bP%c", rts_argv[arg][3]);
1495           }
1496           break;
1497
1498         case 's':
1499           RtsFlags.GranFlags.GranSimStats.Sparks=rtsTrue;
1500           break;
1501
1502         case 'h':
1503           RtsFlags.GranFlags.GranSimStats.Heap=rtsTrue;
1504           break;
1505
1506         case 'Y':   /* syntax: -bY<n>[,<n>]  n ... pos int */
1507           if (rts_argv[arg][3] != '\0') {
1508             char *arg0, *tmp;
1509
1510             arg0 = rts_argv[arg]+3;
1511             if ((tmp = strstr(arg0,","))==NULL) {
1512               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1513               debugBelch("SparkPriority: %u.\n",RtsFlags.GranFlags.SparkPriority);
1514             } else {
1515               *(tmp++) = '\0';
1516               RtsFlags.GranFlags.SparkPriority = decode(arg0);
1517               RtsFlags.GranFlags.SparkPriority2 = decode(tmp);
1518               debugBelch("SparkPriority: %u.\n",
1519                       RtsFlags.GranFlags.SparkPriority);
1520               debugBelch("SparkPriority2:%u.\n",
1521                       RtsFlags.GranFlags.SparkPriority2);
1522               if (RtsFlags.GranFlags.SparkPriority2 <
1523                   RtsFlags.GranFlags.SparkPriority) {
1524                 debugBelch("WARNING: 2nd pri < main pri (%u<%u); 2nd pri has no effect\n",
1525                         RtsFlags.GranFlags.SparkPriority2,
1526                         RtsFlags.GranFlags.SparkPriority);
1527               }
1528             }
1529           } else {
1530             /* plain pri spark is now invoked with -bX
1531                RtsFlags.GranFlags.DoPrioritySparking = 1;
1532                debugBelch("PrioritySparking.\n");
1533             */
1534           }
1535           break;
1536
1537         case 'Q':
1538           if (rts_argv[arg][3] != '\0') {
1539             RtsFlags.GranFlags.ThunksToPack = decode(rts_argv[arg]+3);
1540           } else {
1541             RtsFlags.GranFlags.ThunksToPack = 1;
1542           }
1543           debugBelch("Thunks To Pack in one packet: %u.\n",
1544                   RtsFlags.GranFlags.ThunksToPack);
1545           break;
1546
1547         case 'e':
1548           RtsFlags.GranFlags.RandomSteal = rtsFalse;
1549           debugBelch("Deterministic mode (no random stealing)\n");
1550                       break;
1551
1552           /* The following class of options contains eXperimental */
1553           /* features in connection with exploiting granularity */
1554           /* information. I.e. if -bY is chosen these options */
1555           /* tell the RTS what to do with the supplied info --HWL */
1556
1557         case 'W':
1558           if (rts_argv[arg][3] != '\0') {
1559             RtsFlags.GranFlags.packBufferSize_internal = decode(rts_argv[arg]+3);
1560           } else {
1561             RtsFlags.GranFlags.packBufferSize_internal = GRANSIM_DEFAULT_PACK_BUFFER_SIZE;
1562           }
1563           debugBelch("Size of GranSim internal pack buffer: %u.\n",
1564                   RtsFlags.GranFlags.packBufferSize_internal);
1565           break;
1566
1567         case 'X':
1568           switch(rts_argv[arg][3]) {
1569
1570             case '\0':
1571               RtsFlags.GranFlags.DoPrioritySparking = 1;
1572               debugBelch("Priority Sparking with Normal Priorities.\n");
1573               RtsFlags.GranFlags.InversePriorities = rtsFalse;
1574               RtsFlags.GranFlags.RandomPriorities = rtsFalse;
1575               RtsFlags.GranFlags.IgnorePriorities = rtsFalse;
1576               break;
1577
1578             case 'I':
1579               RtsFlags.GranFlags.DoPrioritySparking = 1;
1580               debugBelch("Priority Sparking with Inverse Priorities.\n");
1581               RtsFlags.GranFlags.InversePriorities++;
1582               break;
1583
1584             case 'R':
1585               RtsFlags.GranFlags.DoPrioritySparking = 1;
1586               debugBelch("Priority Sparking with Random Priorities.\n");
1587               RtsFlags.GranFlags.RandomPriorities++;
1588               break;
1589
1590             case 'N':
1591               RtsFlags.GranFlags.DoPrioritySparking = 1;
1592               debugBelch("Priority Sparking with No Priorities.\n");
1593               RtsFlags.GranFlags.IgnorePriorities++;
1594               break;
1595
1596             default:
1597               bad_option( rts_argv[arg] );
1598               break;
1599           }
1600           break;
1601
1602         case '-':
1603           switch(rts_argv[arg][3]) {
1604
1605             case 'C':
1606               RtsFlags.GranFlags.DoAlwaysCreateThreads=rtsFalse;
1607               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1608               break;
1609
1610             case 'G':
1611               RtsFlags.GranFlags.DoBulkFetching=rtsFalse;
1612               break;
1613
1614             case 'M':
1615               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1616               break;
1617
1618             case 'R':
1619               RtsFlags.GranFlags.DoFairSchedule=rtsFalse;
1620               break;
1621
1622             case 'T':
1623               RtsFlags.GranFlags.DoStealThreadsFirst=rtsFalse;
1624               RtsFlags.GranFlags.DoThreadMigration=rtsFalse;
1625               break;
1626
1627             case 'Z':
1628               RtsFlags.GranFlags.DoAsyncFetch=rtsFalse;
1629               break;
1630
1631             case 'N':
1632               RtsFlags.GranFlags.PreferSparksOfLocalNodes=rtsFalse;
1633                          break;
1634
1635             case 'P':
1636               RtsFlags.GranFlags.GranSimStats.Suppressed=rtsTrue;
1637               break;
1638
1639             case 's':
1640               RtsFlags.GranFlags.GranSimStats.Sparks=rtsFalse;
1641               break;
1642
1643             case 'h':
1644               RtsFlags.GranFlags.GranSimStats.Heap=rtsFalse;
1645               break;
1646
1647             case 'b':
1648               RtsFlags.GranFlags.GranSimStats.Binary=rtsFalse;
1649               break;
1650
1651             case 'X':
1652               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1653               break;
1654
1655             case 'Y':
1656               RtsFlags.GranFlags.DoPrioritySparking = rtsFalse;
1657               RtsFlags.GranFlags.SparkPriority = rtsFalse;
1658               break;
1659
1660             case 'I':
1661               RtsFlags.GranFlags.DoPriorityScheduling = rtsFalse;
1662               break;
1663
1664             case 'e':
1665               RtsFlags.GranFlags.RandomSteal = rtsFalse;
1666               break;
1667
1668             default:
1669               bad_option( rts_argv[arg] );
1670               break;
1671           }
1672           break;
1673
1674 #  if defined(GRAN_CHECK) && defined(GRAN)
1675         case 'D':
1676           switch(rts_argv[arg][3]) {
1677             case 'Q':    /* Set pack buffer size (same as 'Q' in GUM) */
1678               if (rts_argv[arg][4] != '\0') {
1679                 RtsFlags.GranFlags.packBufferSize = decode(rts_argv[arg]+4);
1680                 debugBelch("Pack buffer size: %d\n",
1681                         RtsFlags.GranFlags.packBufferSize);
1682               } else {
1683                 debugBelch("setupRtsFlags: missing size of PackBuffer (for -Q)\n");
1684                 *error = rtsTrue;
1685               }
1686               break;
1687
1688           default:
1689               if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
1690                 /* hack warning: interpret the flags as a binary number */
1691                 nat n = decode(rts_argv[arg]+3);
1692                 set_GranSim_debug_options(n);
1693               } else {
1694                 nat i;
1695                 for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1696                   if (rts_argv[arg][3] == gran_debug_opts_flags[i])
1697                     break;
1698
1699                 if (i==MAX_GRAN_DEBUG_OPTION+1) {
1700                   debugBelch("Valid GranSim debug options are:\n");
1701                   help_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1702                   bad_option( rts_argv[arg] );
1703                 } else { // flag found; now set it
1704                   set_GranSim_debug_options(GRAN_DEBUG_MASK(i));  // 2^i
1705                 }
1706               }
1707               break;
1708
1709 #if 0
1710             case 'e':       /* event trace; also -bD1 */
1711               debugBelch("DEBUG: event_trace; printing event trace.\n");
1712               RtsFlags.GranFlags.Debug.event_trace = rtsTrue;
1713               /* RtsFlags.GranFlags.event_trace=rtsTrue; */
1714               break;
1715
1716             case 'E':       /* event statistics; also -bD2 */
1717               debugBelch("DEBUG: event_stats; printing event statistics.\n");
1718               RtsFlags.GranFlags.Debug.event_stats = rtsTrue;
1719               /* RtsFlags.GranFlags.Debug |= 0x20; print event statistics   */
1720               break;
1721
1722             case 'f':       /* thunkStealing; also -bD4 */
1723               debugBelch("DEBUG: thunkStealing; printing forwarding of FETCHNODES.\n");
1724               RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;
1725               /* RtsFlags.GranFlags.Debug |= 0x2;  print fwd messages */
1726               break;
1727
1728             case 'z':       /* blockOnFetch; also -bD8 */
1729               debugBelch("DEBUG: blockOnFetch; check for blocked on fetch.\n");
1730               RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;
1731               /* RtsFlags.GranFlags.Debug |= 0x4; debug non-reschedule-on-fetch */
1732               break;
1733
1734             case 't':       /* blockOnFetch_sanity; also -bD16 */
1735               debugBelch("DEBUG: blockOnFetch_sanity; check for TSO asleep on fetch.\n");
1736               RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;
1737               /* RtsFlags.GranFlags.Debug |= 0x10; debug TSO asleep for fetch  */
1738               break;
1739
1740             case 'S':       /* priSpark; also -bD32 */
1741               debugBelch("DEBUG: priSpark; priority sparking.\n");
1742               RtsFlags.GranFlags.Debug.priSpark = rtsTrue;
1743               break;
1744
1745             case 's':       /* priSched; also -bD64 */
1746               debugBelch("DEBUG: priSched; priority scheduling.\n");
1747               RtsFlags.GranFlags.Debug.priSched = rtsTrue;
1748               break;
1749
1750             case 'F':       /* findWork; also -bD128 */
1751               debugBelch("DEBUG: findWork; searching spark-pools (local & remote), thread queues for work.\n");
1752               RtsFlags.GranFlags.Debug.findWork = rtsTrue;
1753               break;
1754
1755             case 'g':       /* globalBlock; also -bD256 */
1756               debugBelch("DEBUG: globalBlock; blocking on remote closures (FETCHMEs etc in GUM).\n");
1757               RtsFlags.GranFlags.Debug.globalBlock = rtsTrue;
1758               break;
1759
1760             case 'G':       /* pack; also -bD512 */
1761               debugBelch("DEBUG: pack; routines for (un-)packing graph structures.\n");
1762               RtsFlags.GranFlags.Debug.pack = rtsTrue;
1763               break;
1764
1765             case 'P':       /* packBuffer; also -bD1024 */
1766               debugBelch("DEBUG: packBuffer; routines handling pack buffer (GranSim internal!).\n");
1767               RtsFlags.GranFlags.Debug.packBuffer = rtsTrue;
1768               break;
1769
1770             case 'o':       /* sortedQ; also -bD2048 */
1771               debugBelch("DEBUG: sortedQ; check whether spark/thread queues are sorted.\n");
1772               RtsFlags.GranFlags.Debug.sortedQ = rtsTrue;
1773               break;
1774
1775             case 'r':       /* randomSteal; also -bD4096 */
1776               debugBelch("DEBUG: randomSteal; stealing sparks/threads from random PEs.\n");
1777               RtsFlags.GranFlags.Debug.randomSteal = rtsTrue;
1778               break;
1779
1780             case 'q':       /* checkSparkQ; also -bD8192 */
1781               debugBelch("DEBUG: checkSparkQ; check consistency of the spark queues.\n");
1782               RtsFlags.GranFlags.Debug.checkSparkQ = rtsTrue;
1783               break;
1784
1785             case ':':       /* checkLight; also -bD16384 */
1786               debugBelch("DEBUG: checkLight; check GranSim-Light setup.\n");
1787               RtsFlags.GranFlags.Debug.checkLight = rtsTrue;
1788               break;
1789
1790             case 'b':       /* bq; also -bD32768 */
1791               debugBelch("DEBUG: bq; check blocking queues\n");
1792               RtsFlags.GranFlags.Debug.bq = rtsTrue;
1793               break;
1794
1795             case 'd':       /* all options turned on */
1796               debugBelch("DEBUG: all options turned on.\n");
1797               set_GranSim_debug_options(MAX_GRAN_DEBUG_MASK);
1798               /* RtsFlags.GranFlags.Debug |= 0x40; */
1799               break;
1800
1801 /*          case '\0': */
1802 /*            RtsFlags.GranFlags.Debug = 1; */
1803 /*            break; */
1804 #endif
1805
1806           }
1807           break;
1808 #  endif  /* GRAN_CHECK */
1809       default:
1810         bad_option( rts_argv[arg] );
1811         break;
1812       }
1813 }
1814
1815 /*
1816   Interpret n as a binary number masking GranSim debug options and set the
1817   correxponding option. See gran_debug_opts_strs for explanations of the flags.
1818 */
1819 static void
1820 set_GranSim_debug_options(nat n) {
1821   nat i;
1822
1823   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1824     if ((n>>i)&1) {
1825       errorBelch(gran_debug_opts_strs[i]);
1826       switch (i) {
1827         case 0: RtsFlags.GranFlags.Debug.event_trace   = rtsTrue;  break;
1828         case 1: RtsFlags.GranFlags.Debug.event_stats   = rtsTrue;  break;
1829         case 2: RtsFlags.GranFlags.Debug.bq            = rtsTrue;  break;
1830         case 3: RtsFlags.GranFlags.Debug.pack          = rtsTrue;  break;
1831         case 4: RtsFlags.GranFlags.Debug.checkSparkQ   = rtsTrue;  break;
1832         case 5: RtsFlags.GranFlags.Debug.thunkStealing = rtsTrue;  break;
1833         case 6: RtsFlags.GranFlags.Debug.randomSteal   = rtsTrue;  break;
1834         case 7: RtsFlags.GranFlags.Debug.findWork      = rtsTrue;  break;
1835         case 8: RtsFlags.GranFlags.Debug.unused        = rtsTrue;  break;
1836         case 9: RtsFlags.GranFlags.Debug.pri           = rtsTrue;  break;
1837         case 10: RtsFlags.GranFlags.Debug.checkLight   = rtsTrue;  break;
1838         case 11: RtsFlags.GranFlags.Debug.sortedQ      = rtsTrue;  break;
1839         case 12: RtsFlags.GranFlags.Debug.blockOnFetch = rtsTrue;  break;
1840         case 13: RtsFlags.GranFlags.Debug.packBuffer   = rtsTrue;  break;
1841         case 14: RtsFlags.GranFlags.Debug.blockOnFetch_sanity = rtsTrue;  break;
1842         default: barf("set_GranSim_debug_options: only %d debug options expected");
1843       } /* switch */
1844     } /* if */
1845 }
1846
1847 /*
1848   Print one line explanation for each of the GranSim debug options specified
1849   in the bitmask n.
1850 */
1851 static void
1852 help_GranSim_debug_options(nat n) {
1853   nat i;
1854
1855   for (i=0; i<=MAX_GRAN_DEBUG_OPTION; i++)
1856     if ((n>>i)&1)
1857       debugBelch(gran_debug_opts_strs[i]);
1858 }
1859
1860 # elif defined(PAR)
1861
1862 static void
1863 process_par_option(int arg, int *rts_argc, char *rts_argv[], rtsBool *error)
1864 {
1865
1866   if (rts_argv[arg][1] != 'q') { /* All GUM options start with -q */
1867     errorBelch("Warning: GUM option does not start with -q: %s", rts_argv[arg]);
1868     return;
1869   }
1870
1871   /* Communication and task creation cost parameters */
1872   switch(rts_argv[arg][2]) {
1873   case 'e':  /* -qe<n>  ... allow <n> local sparks */
1874     if (rts_argv[arg][3] != '\0') { /* otherwise, stick w/ the default */
1875       RtsFlags.ParFlags.maxLocalSparks
1876         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1877
1878       if (RtsFlags.ParFlags.maxLocalSparks <= 0) {
1879         errorBelch("setupRtsFlags: bad value for -e\n");
1880         *error = rtsTrue;
1881       }
1882     }
1883     IF_PAR_DEBUG(verbose,
1884                  errorBelch("-qe<n>: max %d local sparks",
1885                        RtsFlags.ParFlags.maxLocalSparks));
1886     break;
1887
1888   case 't':
1889     if (rts_argv[arg][3] != '\0') {
1890       RtsFlags.ParFlags.maxThreads
1891         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1892     } else {
1893       errorBelch("missing size for -qt\n");
1894       *error = rtsTrue;
1895     }
1896     IF_PAR_DEBUG(verbose,
1897                  errorBelch("-qt<n>: max %d threads",
1898                        RtsFlags.ParFlags.maxThreads));
1899     break;
1900
1901   case 'f':
1902     if (rts_argv[arg][3] != '\0')
1903       RtsFlags.ParFlags.maxFishes = decode(rts_argv[arg]+3);
1904     else
1905       RtsFlags.ParFlags.maxFishes = MAX_FISHES;
1906     break;
1907     IF_PAR_DEBUG(verbose,
1908                  errorBelch("-qf<n>: max %d fishes sent out at one time",
1909                        RtsFlags.ParFlags.maxFishes));
1910     break;
1911
1912   case 'F':
1913     if (rts_argv[arg][3] != '\0') {
1914       RtsFlags.ParFlags.fishDelay
1915         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
1916     } else {
1917       errorBelch("missing fish delay time for -qF\n");
1918       *error = rtsTrue;
1919     }
1920     IF_PAR_DEBUG(verbose,
1921                  errorBelch("-qF<n>: fish delay time %d us",
1922                        RtsFlags.ParFlags.fishDelay));
1923     break;
1924
1925   case 'O':
1926     RtsFlags.ParFlags.outputDisabled = rtsTrue;
1927     IF_PAR_DEBUG(verbose,
1928                  errorBelch("-qO: output disabled"));
1929     break;
1930
1931   case 'g': /* -qg<n> ... globalisation scheme */
1932     if (rts_argv[arg][3] != '\0') {
1933       RtsFlags.ParFlags.globalising = decode(rts_argv[arg]+3);
1934     } else {
1935       errorBelch("missing identifier for globalisation scheme (for -qg)\n");
1936       *error = rtsTrue;
1937     }
1938     IF_PAR_DEBUG(verbose,
1939                  debugBelch("-qg<n>: globalisation scheme set to  %d",
1940                        RtsFlags.ParFlags.globalising));
1941     break;
1942
1943   case 'h': /* -qh<n> ... max number of thunks (except root) in packet */
1944     if (rts_argv[arg][3] != '\0') {
1945       RtsFlags.ParFlags.thunksToPack = decode(rts_argv[arg]+3);
1946     } else {
1947       errorBelch("missing number of thunks per packet (for -qh)\n");
1948       *error = rtsTrue;
1949     }
1950     IF_PAR_DEBUG(verbose,
1951                  debugBelch("-qh<n>: thunks per packet set to %d",
1952                        RtsFlags.ParFlags.thunksToPack));
1953     break;
1954
1955   case 'P': /* -qP for writing a log file */
1956     //RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1957     /* same encoding as in GranSim after -bP */
1958     switch(rts_argv[arg][3]) {
1959     case '\0': RtsFlags.ParFlags.ParStats.Full = rtsTrue;
1960       break; // nothing special, just an ordinary profile
1961     case '0': RtsFlags.ParFlags.ParStats.Suppressed = rtsTrue;
1962         RtsFlags.ParFlags.ParStats.Full = rtsFalse;
1963       break;
1964     case 'b': RtsFlags.ParFlags.ParStats.Binary = rtsTrue;
1965       break;
1966     case 's': RtsFlags.ParFlags.ParStats.Sparks = rtsTrue;
1967       break;
1968       //case 'h': RtsFlags.parFlags.ParStats.Heap = rtsTrue;
1969       //  break;
1970     case 'n': RtsFlags.ParFlags.ParStats.NewLogfile = rtsTrue;
1971       break;
1972     case 'g':
1973 # if defined(PAR_TICKY)
1974       RtsFlags.ParFlags.ParStats.Global = rtsTrue;
1975 # else
1976       errorBelch("-qPg is only possible for a PAR_TICKY RTS, which this is not");
1977       stg_exit(EXIT_FAILURE);
1978 # endif
1979       break;
1980     default: barf("Unknown option -qP%c", rts_argv[arg][2]);
1981     }
1982     IF_PAR_DEBUG(verbose,
1983                  debugBelch("(-qP) writing to log-file (RtsFlags.ParFlags.ParStats.Full=%s)",
1984                        (RtsFlags.ParFlags.ParStats.Full ? "rtsTrue" : "rtsFalse")));
1985     break;
1986
1987   case 'Q': /* -qQ<n> ... set pack buffer size to <n> */
1988     if (rts_argv[arg][3] != '\0') {
1989       RtsFlags.ParFlags.packBufferSize = decode(rts_argv[arg]+3);
1990     } else {
1991       errorBelch("missing size of PackBuffer (for -qQ)\n");
1992       *error = rtsTrue;
1993     }
1994     IF_PAR_DEBUG(verbose,
1995                  debugBelch("-qQ<n>: pack buffer size set to %d",
1996                        RtsFlags.ParFlags.packBufferSize));
1997     break;
1998
1999   case 'R':
2000     RtsFlags.ParFlags.doFairScheduling = rtsTrue;
2001     IF_PAR_DEBUG(verbose,
2002                  debugBelch("-qR: fair-ish scheduling"));
2003     break;
2004
2005 # if defined(DEBUG)
2006   case 'w':
2007     if (rts_argv[arg][3] != '\0') {
2008       RtsFlags.ParFlags.wait
2009         = strtol(rts_argv[arg]+3, (char **) NULL, 10);
2010     } else {
2011       RtsFlags.ParFlags.wait = 1000;
2012     }
2013     IF_PAR_DEBUG(verbose,
2014                  debugBelch("-qw<n>: length of wait loop after synchr before reduction: %d",
2015                        RtsFlags.ParFlags.wait));
2016     break;
2017
2018   case 'D':  /* -qD ... all the debugging options */
2019     if (isdigit(rts_argv[arg][3])) {/* Set all debugging options in one */
2020       /* hack warning: interpret the flags as a binary number */
2021       nat n = decode(rts_argv[arg]+3);
2022       set_par_debug_options(n);
2023     } else {
2024       nat i;
2025       for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2026         if (rts_argv[arg][3] == par_debug_opts_flags[i])
2027           break;
2028
2029       if (i==MAX_PAR_DEBUG_OPTION+1) {
2030         errorBelch("Valid GUM debug options are:\n");
2031         help_par_debug_options(MAX_PAR_DEBUG_MASK);
2032         bad_option( rts_argv[arg] );
2033       } else { // flag found; now set it
2034         set_par_debug_options(PAR_DEBUG_MASK(i));  // 2^i
2035       }
2036     }
2037     break;
2038 # endif
2039   default:
2040     errorBelch("Unknown option -q%c (%d opts in total)",
2041           rts_argv[arg][2], *rts_argc);
2042     break;
2043   } /* switch */
2044 }
2045
2046 /*
2047   Interpret n as a binary number masking Par debug options and set the
2048   correxponding option. See par_debug_opts_strs for explanations of the flags.
2049 */
2050 static void
2051 set_par_debug_options(nat n) {
2052   nat i;
2053
2054   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2055     if ((n>>i)&1) {
2056       debugBelch(par_debug_opts_strs[i]);
2057       switch (i) {
2058         case 0: RtsFlags.ParFlags.Debug.verbose       = rtsTrue;  break;
2059         case 1: RtsFlags.ParFlags.Debug.bq            = rtsTrue;  break;
2060         case 2: RtsFlags.ParFlags.Debug.schedule      = rtsTrue;  break;
2061         case 3: RtsFlags.ParFlags.Debug.free          = rtsTrue;  break;
2062         case 4: RtsFlags.ParFlags.Debug.resume        = rtsTrue;  break;
2063         case 5: RtsFlags.ParFlags.Debug.weight        = rtsTrue;  break;
2064         case 6: RtsFlags.ParFlags.Debug.fetch         = rtsTrue;  break;
2065           //case 7: RtsFlags.ParFlags.Debug.ack           = rtsTrue;  break;
2066         case 7: RtsFlags.ParFlags.Debug.fish          = rtsTrue;  break;
2067         case 8: RtsFlags.ParFlags.Debug.tables        = rtsTrue;  break;
2068         case 9: RtsFlags.ParFlags.Debug.packet        = rtsTrue;  break;
2069         case 10: RtsFlags.ParFlags.Debug.pack         = rtsTrue;  break;
2070         case 11: RtsFlags.ParFlags.Debug.paranoia     = rtsTrue;  break;
2071         default: barf("set_par_debug_options: only %d debug options expected",
2072                       MAX_PAR_DEBUG_OPTION);
2073       } /* switch */
2074     } /* if */
2075 }
2076
2077 /*
2078   Print one line explanation for each of the GranSim debug options specified
2079   in the bitmask n.
2080 */
2081 static void
2082 help_par_debug_options(nat n) {
2083   nat i;
2084
2085   for (i=0; i<=MAX_PAR_DEBUG_OPTION; i++)
2086     if ((n>>i)&1)
2087       debugBelch(par_debug_opts_strs[i]);
2088 }
2089
2090 #endif /* PAR */
2091
2092 //@node Aux fcts,  , GranSim specific options
2093 //@subsection Aux fcts
2094
2095 static void
2096 stats_fprintf(FILE *f, char *s, ...)
2097 {
2098     va_list ap;
2099     va_start(ap,s);
2100     if (f == NULL) {
2101         vdebugBelch(s, ap);
2102     } else {
2103         vfprintf(f, s, ap);
2104     }
2105     va_end(ap);
2106 }
2107
2108 static int              /* return -1 on error */
2109 open_stats_file (
2110     I_ arg,
2111     int argc, char *argv[],
2112     int rts_argc, char *rts_argv[],
2113     const char *FILENAME_FMT,
2114     FILE **file_ret)
2115 {
2116     FILE *f = NULL;
2117
2118     if (strequal(rts_argv[arg]+2, "stderr")) { /* use debugBelch */
2119         f = NULL; /* NULL means use debugBelch */
2120     } else {
2121         if (rts_argv[arg][2] != '\0') {  /* stats file specified */
2122             f = fopen(rts_argv[arg]+2,"w");
2123         } else {
2124             char stats_filename[STATS_FILENAME_MAXLEN]; /* default <program>.<ext> */
2125             sprintf(stats_filename, FILENAME_FMT, argv[0]);
2126             f = fopen(stats_filename,"w");
2127         }
2128         if (f == NULL) {
2129             errorBelch("Can't open stats file %s\n", rts_argv[arg]+2);
2130             return -1;
2131         }
2132     }
2133     *file_ret = f;
2134
2135     {
2136         /* Write argv and rtsv into start of stats file */
2137         int count;
2138         for(count = 0; count < argc; count++) {
2139             stats_fprintf(f, "%s ", argv[count]);
2140         }
2141         stats_fprintf(f, "+RTS ");
2142         for(count = 0; count < rts_argc; count++)
2143             stats_fprintf(f, "%s ", rts_argv[count]);
2144         stats_fprintf(f, "\n");
2145     }
2146     return 0;
2147 }
2148
2149
2150
2151 static I_
2152 decode(const char *s)
2153 {
2154     I_ c;
2155     StgDouble m;
2156
2157     if (!*s)
2158         return 0;
2159
2160     m = atof(s);
2161     c = s[strlen(s)-1];
2162
2163     if (c == 'g' || c == 'G')
2164         m *= 1000*1000*1000;    /* UNchecked! */
2165     else if (c == 'm' || c == 'M')
2166         m *= 1000*1000;                 /* We do not use powers of 2 (1024) */
2167     else if (c == 'k' || c == 'K')      /* to avoid possible bad effects on */
2168         m *= 1000;                      /* a direct-mapped cache.           */
2169     else if (c == 'w' || c == 'W')
2170         m *= sizeof(W_);
2171
2172     return (I_)m;
2173 }
2174
2175 static void
2176 bad_option(const char *s)
2177 {
2178   errorBelch("bad RTS option: %s", s);
2179   stg_exit(EXIT_FAILURE);
2180 }
2181
2182 /* -----------------------------------------------------------------------------
2183    Getting/Setting the program's arguments.
2184
2185    These are used by System.Environment, and parts of the RTS.
2186    -------------------------------------------------------------------------- */
2187
2188 void
2189 setProgName(char *argv[])
2190 {
2191     char *last_slash;
2192
2193     /* Remove directory from argv[0] -- default files in current directory */
2194     if ((last_slash = (char *) strrchr(argv[0],
2195 #if !defined(mingw32_HOST_OS)
2196                                        '/'
2197 #else
2198                                        '\\'
2199 #endif
2200                                        )) != NULL) {
2201         prog_name = last_slash+1;
2202    } else {
2203         prog_name = argv[0];
2204    }
2205 }
2206
2207 void
2208 getProgArgv(int *argc, char **argv[])
2209 {
2210     if (argc) { *argc = prog_argc; }
2211     if (argv) { *argv = prog_argv; }
2212 }
2213
2214 void
2215 setProgArgv(int argc, char *argv[])
2216 {
2217    /* Usually this is done by startupHaskell, so we don't need to call this.
2218       However, sometimes Hugs wants to change the arguments which Haskell
2219       getArgs >>= ... will be fed.  So you can do that by calling here
2220       _after_ calling startupHaskell.
2221    */
2222    prog_argc = argc;
2223    prog_argv = argv;
2224    setProgName(prog_argv);
2225 }