ghc/rts/RtsFlags.c

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