ghc/rts/RtsFlags.c

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