ghc/rts/RtsFlags.c

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