ghc/rts/RtsFlags.c

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