rts/RtsFlags.c

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