ghc/rts/RtsFlags.c

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