ghc/rts/RtsFlags.c

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