ghc/rts/RtsFlags.c

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