ghc/rts/RtsFlags.c

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