[project @ 2001-11-26 16:54:21 by simonmar]
[ghc-hetmet.git] / ghc / rts / RtsFlags.c
index 1c84093..54511ed 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
- * $Id: RtsFlags.c,v 1.40 2001/07/23 10:42:37 simonmar Exp $
+ * $Id: RtsFlags.c,v 1.53 2001/11/26 16:54:21 simonmar Exp $
  *
  * (c) The AQUA Project, Glasgow University, 1994-1997
  * (c) The GHC Team, 1998-1999
@@ -21,6 +21,7 @@
 //@node Includes, Constants
 //@subsection Includes
 
+#include "PosixSource.h"
 #include "Rts.h"
 #include "RtsFlags.h"
 #include "RtsUtils.h"
@@ -223,7 +224,7 @@ void initRtsFlagsDefaults(void)
 
     RtsFlags.GcFlags.minAllocAreaSize   = (256 * 1024)        / BLOCK_SIZE;
     RtsFlags.GcFlags.minOldGenSize      = (1024 * 1024)       / BLOCK_SIZE;
-    RtsFlags.GcFlags.maxHeapSize       = (64  * 1024 * 1024) / BLOCK_SIZE;
+    RtsFlags.GcFlags.maxHeapSize       = 0;    /* off by default */
     RtsFlags.GcFlags.heapSizeSuggestion        = 0;    /* none */
     RtsFlags.GcFlags.pcFreeHeap                = 3;    /* 3% */
     RtsFlags.GcFlags.oldGenFactor       = 2;
@@ -237,6 +238,8 @@ void initRtsFlagsDefaults(void)
     RtsFlags.GcFlags.steps              = 2;
     RtsFlags.GcFlags.squeezeUpdFrames  = rtsTrue;
 #endif
+    RtsFlags.GcFlags.compact            = rtsFalse;
+    RtsFlags.GcFlags.compactThreshold   = 30.0;
 #ifdef RTS_GTK_FRONTPANEL
     RtsFlags.GcFlags.frontpanel         = rtsFalse;
 #endif
@@ -247,12 +250,16 @@ void initRtsFlagsDefaults(void)
 
 #ifdef PROFILING
     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
-    RtsFlags.ProfFlags.profileFrequency   = 20;
+    RtsFlags.ProfFlags.profileInterval    = 20;
     RtsFlags.ProfFlags.showCCSOnException = rtsFalse;
+    RtsFlags.ProfFlags.maxRetainerSetSize = 8;
     RtsFlags.ProfFlags.modSelector        = NULL;
     RtsFlags.ProfFlags.descrSelector      = NULL;
     RtsFlags.ProfFlags.typeSelector       = NULL;
     RtsFlags.ProfFlags.ccSelector         = NULL;
+    RtsFlags.ProfFlags.retainerSelector   = NULL;
+    RtsFlags.ProfFlags.bioSelector        = NULL;
+
 #elif defined(DEBUG)
     RtsFlags.ProfFlags.doHeapProfile      = rtsFalse;
 #endif
@@ -382,11 +389,14 @@ usage_text[] = {
 "  -k<size> Sets the initial thread stack size (default 1k)  Egs: -K4k   -K2m",
 "",
 "  -A<size> Sets the minimum allocation area size (default 256k) Egs: -A1m -A10k",
-"  -M<size> Sets the maximum heap size (default 64M)  Egs: -M256k -M1G",
+"  -M<size> Sets the maximum heap size (default unlimited)  Egs: -M256k -M1G",
 "  -H<size> Sets the minimum heap size (default 0M)   Egs: -H24m  -H1G",
-"  -m<n>%   Minimum % of heap which must be available (default 3%)",
+"  -m<n>    Minimum % of heap which must be available (default 3%)",
 "  -G<n>    Number of generations (default: 2)",
 "  -T<n>    Number of steps in younger generations (default: 2)",
+"  -c<n>    Auto-enable compaction of the oldest generation when live data is",
+"           at least <n>% of the maximum heap size set with -M (default: 30%)",
+"  -c       Enable compaction for all major collections",
 "",
 "  -t<file> One-line GC statistics  (default file: <program>.stat)",
 "  -s<file> Summary  GC statistics  (with -Sstderr going to stderr)",
@@ -401,21 +411,29 @@ usage_text[] = {
 #if defined(PROFILING) || defined(PAR)
 "",
 "  -px      Time/allocation profile (XML)  (output file <program>.prof)",
-"  -p<sort> Time/allocation profile        (output file <program>.prof)",
-"             sort: T = time (default), A = alloc, C = cost centre label",
-"  -P<sort> More detailed Time/Allocation profile",
+"  -p       Time/allocation profile        (output file <program>.prof)",
+"  -P       More detailed Time/Allocation profile",
+"  -Pa      Give information about *all* cost centres",
 
 # if defined(PROFILING)
 "",
-"  -hx            Heap residency profile (XML)  (output file <program>.prof)",
-"  -h<break-down> Heap residency profile (text) (output file <program>.prof)",
-"     break-down: C = cost centre stack (default), M = module",
-"                 D = closure description, Y = type description",
+"  -hx            Heap residency profile (XML)   (output file <program>.prof)",
+"  -h<break-down> Heap residency profile (hp2ps) (output file <program>.hp)",
+"     break-down: c = cost centre stack (default)",
+"                 m = module",
+"                 d = closure description",
+"                 y = type description",
+"                 r = retainer",
+"                 b = biography (LAG,DRAG,VOID,USE)",
 "  A subset of closures may be selected thusly:",
-"    -hc{cc, cc ...} specific cost centre(s) (NOT STACKS!)",
+"    -hc{cc,cc ...}  specific cost centre(s) (NOT STACKS!)",
 "    -hm{mod,mod...} all cost centres from the specified modules(s)",
 "    -hd{des,des...} closures with specified closure descriptions",
 "    -hy{typ,typ...} closures with specified type descriptions",
+"    -hr{cc,cc...}   closures with specified retainers",
+"    -hb{bio,bio...} closures with specified biographies (lag,drag,void,use)",
+"",
+"  -R<size>       Set the maximum retainer set size (default: 8)",
 "",
 "  -i<msec>       Time between heap samples (msec, default: 20)",
 "",
@@ -465,6 +483,8 @@ usage_text[] = {
 "  -b...     All GranSim options start with -b; see GranSim User's Guide for details",
 #endif
 "",
+"RTS options may also be specified using the GHCRTS environment variable.",
+"",
 "Other RTS options may be available for programs compiled a different way.",
 "The GHC User's Guide has full details.",
 "",
@@ -477,6 +497,32 @@ strequal(const char *a, const char * b)
     return(strcmp(a, b) == 0);
 }
 
+static void
+splitRtsFlags(char *s, int *rts_argc, char *rts_argv[])
+{
+    char *c1, *c2;
+
+    c1 = s;
+    do {
+       while (isspace(*c1)) { c1++; };
+       c2 = c1;
+       while (!isspace(*c2) && *c2 != '\0') { c2++; };
+       
+       if (c1 == c2) { break; }
+       
+       if (*rts_argc < MAX_RTS_ARGS-1) {
+           s = malloc(c2-c1+1);
+           strncpy(s, c1, c2-c1);
+           s[c2-c1] = '\0';
+           rts_argv[(*rts_argc)++] = s;
+       } else {
+           barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
+       }
+       
+       c1 = c2;
+    } while (*c1 != '\0');
+}
+    
 void
 setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
 {
@@ -490,17 +536,46 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
     if ((last_slash = (char *) strrchr(argv[0], '/')) != NULL)
        strcpy(argv[0], last_slash+1);
 
-    /* Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts */
-    /*   argv[0] must be PGM argument -- leave in argv                 */
-
     total_arg = *argc;
     arg = 1;
 
     *argc = 1;
     *rts_argc = 0;
 
-    for (mode = PGM; arg < total_arg && ! strequal("--RTS", argv[arg]); arg++) {
-       if (strequal("+RTS", argv[arg])) {
+    // process arguments from the ghc_rts_opts global variable first.
+    // (arguments from the GHCRTS environment variable and the command
+    // line override these).
+    {
+       if (ghc_rts_opts != NULL) {
+           splitRtsFlags(ghc_rts_opts, rts_argc, rts_argv);
+       }
+    }
+
+    // process arguments from the GHCRTS environment variable first
+    // (arguments from the command line override these).
+    {
+       char *ghc_rts = getenv("GHCRTS");
+
+       if (ghc_rts != NULL) {
+           splitRtsFlags(ghc_rts, rts_argc, rts_argv);
+       }
+    }
+
+    // Split arguments (argv) into PGM (argv) and RTS (rts_argv) parts
+    //   argv[0] must be PGM argument -- leave in argv
+
+    for (mode = PGM; arg < total_arg; arg++) {
+       // The '--RTS' argument disables all future +RTS ... -RTS processing.
+       if (strequal("--RTS", argv[arg])) {
+           arg++;
+           break;
+       }
+       // The '--' argument is passed through to the program, but
+       // disables all further +RTS ... -RTS processing.
+       else if (strequal("--", argv[arg])) {
+           break;
+       }
+       else if (strequal("+RTS", argv[arg])) {
            mode = RTS;
        }
        else if (strequal("-RTS", argv[arg])) {
@@ -516,17 +591,14 @@ setupRtsFlags(int *argc, char *argv[], int *rts_argc, char *rts_argv[])
          barf("too many RTS arguments (max %d)", MAX_RTS_ARGS-1);
        }
     }
-    if (arg < total_arg) {
-       /* arg must be --RTS; process remaining program arguments */
-       while (++arg < total_arg) {
-           argv[(*argc)++] = argv[arg];
-       }
+    // process remaining program arguments
+    for (; arg < total_arg; arg++) {
+       argv[(*argc)++] = argv[arg];
     }
     argv[*argc] = (char *) 0;
     rts_argv[*rts_argc] = (char *) 0;
 
-    /* Process RTS (rts_argv) part: mainly to determine statsfile */
-
+    // Process RTS (rts_argv) part: mainly to determine statsfile
     for (arg = 0; arg < *rts_argc; arg++) {
        if (rts_argv[arg][0] != '-') {
            fflush(stdout);
@@ -617,6 +689,15 @@ error = rtsTrue;
                RtsFlags.GcFlags.ringBell = rtsTrue;
                break;
 
+             case 'c':
+                 if (rts_argv[arg][2] != '\0') {
+                     RtsFlags.GcFlags.compactThreshold =
+                         atof(rts_argv[arg]+2);
+                 } else {
+                     RtsFlags.GcFlags.compact = rtsTrue;
+                 }
+                 break;
+
              case 'F':
                RtsFlags.GcFlags.oldGenFactor = atof(rts_argv[arg]+2);
              
@@ -730,21 +811,36 @@ error = rtsTrue;
              /* =========== PROFILING ========================== */
 
              case 'P': /* detailed cost centre profiling (time/alloc) */
-               COST_CENTRE_USING_BUILD_ONLY(
-               RtsFlags.CcFlags.doCostCentres = COST_CENTRES_VERBOSE;
-               )
              case 'p': /* cost centre profiling (time/alloc) */
                COST_CENTRE_USING_BUILD_ONLY(
                switch (rts_argv[arg][2]) {
                  case 'x':
                    RtsFlags.CcFlags.doCostCentres = COST_CENTRES_XML;
                    break;
-                 default:
-                   RtsFlags.CcFlags.doCostCentres = COST_CENTRES_SUMMARY;
+                 case 'a':
+                   RtsFlags.CcFlags.doCostCentres = COST_CENTRES_ALL;
                    break;
+                 default:
+                     if (rts_argv[arg][1] == 'P') {
+                         RtsFlags.CcFlags.doCostCentres =
+                             COST_CENTRES_VERBOSE;
+                     } else {
+                         RtsFlags.CcFlags.doCostCentres =
+                             COST_CENTRES_SUMMARY;
+                     }
+                     break;
                }
                ) break;
 
+             case 'R':
+                 PROFILING_BUILD_ONLY(
+                     RtsFlags.ProfFlags.maxRetainerSetSize = atof(rts_argv[arg]+2);
+                     
+                     if (RtsFlags.ProfFlags.maxRetainerSetSize < 0)
+                        bad_option( rts_argv[arg] );
+                     break;
+                 ) break;
+
              case 'h': /* serial heap profile */
 #if !defined(PROFILING) && defined(DEBUG)
                switch (rts_argv[arg][2]) {
@@ -762,58 +858,104 @@ error = rtsTrue;
 #else
                PROFILING_BUILD_ONLY(
                switch (rts_argv[arg][2]) {
-                 case '\0':
-                 case CCchar:
-                   RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
-                   break;
-                 case MODchar:
-                   RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
-                   break;
-                 case DESCRchar:
-                   RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
-                   break;
-                 case TYPEchar:
-                   RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
+               case '\0':
+               case 'C':
+               case 'c':
+               case 'M':
+               case 'm':
+               case 'D':
+               case 'd':
+               case 'Y':
+               case 'y':
+               case 'R':
+               case 'r':
+               case 'B':
+               case 'b':
+                   if (rts_argv[arg][2] != '\0' && rts_argv[arg][3] != '\0') {
+                       {
+                           char *left  = strchr(rts_argv[arg], '{');
+                           char *right = strrchr(rts_argv[arg], '}');
+                           if (! left || ! right ||
+                               strrchr(rts_argv[arg], '{') != left ||
+                               strchr(rts_argv[arg], '}') != right) {
+                               prog_belch(
+                                   "Invalid heap profiling selection bracketing\n   %s\n", 
+                                   rts_argv[arg]);
+                               error = rtsTrue;
+                           } else {
+                               *right = '\0';
+                               switch (rts_argv[arg][2]) {
+                               case 'C':
+                               case 'c': // cost centre label select
+                                   RtsFlags.ProfFlags.ccSelector = left + 1;
+                                   break;
+                               case 'M':
+                               case 'm': // cost centre module select
+                                   RtsFlags.ProfFlags.modSelector = left + 1;
+                                   break;
+                               case 'D':
+                               case 'd': // closure descr select 
+                                   RtsFlags.ProfFlags.descrSelector = left + 1;
+                                   break;
+                               case 'Y':
+                               case 'y': // closure type select
+                                   RtsFlags.ProfFlags.typeSelector = left + 1;
+                                   break;
+                               case 'R':
+                               case 'r': // retainer select
+                                   RtsFlags.ProfFlags.retainerSelector = left + 1;
+                                   break;
+                               case 'B':
+                               case 'b': // biography select
+                                   RtsFlags.ProfFlags.bioSelector = left + 1;
+                                   break;
+                               }
+                           }
+                       }
+                       break;
+                   }
+                   
+                   if (RtsFlags.ProfFlags.doHeapProfile != 0) {
+                       prog_belch("multiple heap profile options");
+                       error = rtsTrue;
+                       break;
+                   }
+
+                   switch (rts_argv[arg][2]) {
+                   case '\0':
+                   case 'C':
+                   case 'c':
+                       RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_CCS;
+                       break;
+                   case 'M':
+                   case 'm':
+                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_MOD;
+                         break;
+                   case 'D':
+                   case 'd':
+                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_DESCR;
+                         break;
+                   case 'Y':
+                   case 'y':
+                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_TYPE;
+                         break;
+                   case 'R':
+                   case 'r':
+                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_RETAINER;
+                         break;
+                   case 'B':
+                   case 'b':
+                         RtsFlags.ProfFlags.doHeapProfile = HEAP_BY_LDV;
+                         break;
+                   }
                    break;
-                  case 'c': /* cost centre label select */
-                  case 'm': /* cost centre module select */
-                  case 'd': /* closure descr select */
-                  case 'y': /* closure type select */
-                    {char *left  = strchr(rts_argv[arg], '{');
-                     char *right = strrchr(rts_argv[arg], '}');
-                     if (! left || ! right ||
-                          strrchr(rts_argv[arg], '{') != left ||
-                           strchr(rts_argv[arg], '}') != right) {
-                        prog_belch(
-                           "Invalid heap profiling selection bracketing\n   %s\n", 
-                           rts_argv[arg]);
-                        error = rtsTrue;
-                     } else {
-                        *right = '\0';
-                        switch (rts_argv[arg][2]) {
-                          case 'c': /* cost centre label select */
-                            RtsFlags.ProfFlags.ccSelector = left + 1;
-                            break;
-                          case 'm': /* cost centre module select */
-                            RtsFlags.ProfFlags.modSelector = left + 1;
-                            break;
-                          case 'd': /* closure descr select */
-                            RtsFlags.ProfFlags.descrSelector = left + 1;
-                            break;
-                          case 'y': /* closure type select */
-                            RtsFlags.ProfFlags.typeSelector = left + 1;
-                            break;
-                        }
-                     }
-                    }
-                    break;
-                 default:
+                     
+               default:
                    prog_belch("invalid heap profile option: %s",rts_argv[arg]);
                    error = rtsTrue;
                }
                ) 
-
-#endif
+#endif // PROFILING
                break;
 
 #if defined(PROFILING) 
@@ -829,11 +971,9 @@ error = rtsTrue;
                    if (cst != 0 && cst < CS_MIN_MILLISECS)
                        cst = CS_MIN_MILLISECS;
 
-                   RtsFlags.ProfFlags.profileFrequency = cst;
+                   RtsFlags.ProfFlags.profileInterval = cst;
                }
-               
                break;
-
 #endif
 
              /* =========== CONCURRENT ========================= */
@@ -1943,6 +2083,7 @@ set_debug_options(nat n) {
         case 9: RtsFlags.DebugFlags.prof        = rtsTrue; break;
         case 10:  RtsFlags.DebugFlags.gran       = rtsTrue; break;
         case 11:  RtsFlags.DebugFlags.par        = rtsTrue; break;
+        case 12:  RtsFlags.DebugFlags.linker     = rtsTrue; break;
         default: barf("set_debug_options: only %d debug options expected",
                      MAX_DEBUG_OPTION);
       } /* switch */