mono/profiler/arg-parsing.c

   1 #include <config.h>
   2
   3 #include "mono-profiler-log.h"
   4
   5 #ifdef HAVE_UNISTD_H
   6 #include <unistd.h>
   7 #endif
   8
   9 #ifdef HAVE_SCHED_GETAFFINITY
  10 #include <sched.h>
  11
  12 #  ifndef GLIBC_HAS_CPU_COUNT
  13 static int
  14 CPU_COUNT(cpu_set_t *set)
  15 {
  16         int i, count = 0;
  17
  18         for (int i = 0; i < CPU_SETSIZE; i++)
  19                 if (CPU_ISSET(i, set))
  20                         count++;
  21         return count;
  22 }
  23 #  endif
  24 #endif
  25
  26 typedef struct {
  27         const char *event_name;
  28         const int mask;
  29 } NameAndMask;
  30
  31 static NameAndMask event_list[] = {
  32         { "domain", PROFLOG_DOMAIN_EVENTS },
  33         { "assembly", PROFLOG_ASSEMBLY_EVENTS },
  34         { "module", PROFLOG_MODULE_EVENTS },
  35         { "class", PROFLOG_CLASS_EVENTS },
  36         { "jit", PROFLOG_JIT_COMPILATION_EVENTS },
  37         { "exception", PROFLOG_EXCEPTION_EVENTS },
  38         { "gcalloc", PROFLOG_ALLOCATION_EVENTS },
  39         { "gc", PROFLOG_GC_EVENTS },
  40         { "thread", PROFLOG_THREAD_EVENTS },
  41         { "calls", PROFLOG_CALL_EVENTS },
  42         //{ "inscov", PROFLOG_INS_COVERAGE_EVENTS }, //this is a profiler API event, but there's no actual event for us to emit here
  43         //{ "sampling", PROFLOG_SAMPLING_EVENTS }, //it makes no sense to enable/disable this event by itself
  44         { "monitor", PROFLOG_MONITOR_EVENTS },
  45         { "gcmove", PROFLOG_GC_MOVES_EVENTS },
  46         { "gcroot", PROFLOG_GC_ROOT_EVENTS },
  47         { "context", PROFLOG_CONTEXT_EVENTS },
  48         { "finalization", PROFLOG_FINALIZATION_EVENTS },
  49         { "counter", PROFLOG_COUNTER_EVENTS },
  50         { "gchandle", PROFLOG_GC_HANDLE_EVENTS },
  51
  52         { "typesystem", PROFLOG_TYPELOADING_ALIAS },
  53         { "coverage", PROFLOG_CODECOV_ALIAS },
  54         //{ "sample", PROFLOG_PERF_SAMPLING_ALIAS }, //takes args, explicitly handles
  55         { "alloc", PROFLOG_GC_ALLOC_ALIAS },
  56         //{ "heapshot", PROFLOG_HEAPSHOT_ALIAS }, //takes args, explicitly handled
  57         { "legacy", PROFLOG_LEGACY_ALIAS },
  58 };
  59
  60 static void usage (void);
  61 static void set_hsmode (ProfilerConfig *config, const char* val);
  62 static void set_sample_freq (ProfilerConfig *config, const char *val);
  63 static int mono_cpu_count (void);
  64
  65
  66 static gboolean
  67 match_option (const char *arg, const char *opt_name, const char **rval)
  68 {
  69         if (rval) {
  70                 const char *end = strchr (arg, '=');
  71
  72                 *rval = NULL;
  73                 if (!end)
  74                         return !strcmp (arg, opt_name);
  75
  76                 if (strncmp (arg, opt_name, strlen (opt_name)) || (end - arg) > strlen (opt_name) + 1)
  77                         return FALSE;
  78                 *rval = end + 1;
  79                 return TRUE;
  80         } else {
  81                 //FIXME how should we handle passing a value to an arg that doesn't expect it?
  82                 return !strcmp (arg, opt_name);
  83         }
  84 }
  85
  86 static void
  87 parse_arg (const char *arg, ProfilerConfig *config)
  88 {
  89         const char *val;
  90
  91         if (match_option (arg, "help", NULL)) {
  92                 usage ();
  93         } else if (match_option (arg, "report", NULL)) {
  94                 config->do_report = TRUE;
  95         } else if (match_option (arg, "debug", NULL)) {
  96                 config->do_debug = TRUE;
  97         } else if (match_option (arg, "debug-coverage", NULL)) {
  98                 config->debug_coverage = TRUE;
  99         } else if (match_option (arg, "sampling-real", NULL)) {
 100                 config->sampling_mode = MONO_PROFILER_STAT_MODE_REAL;
 101         } else if (match_option (arg, "sampling-process", NULL)) {
 102                 config->sampling_mode = MONO_PROFILER_STAT_MODE_PROCESS;
 103         } else if (match_option (arg, "heapshot", &val)) {
 104                 config->enable_mask |= PROFLOG_HEAPSHOT_ALIAS;
 105                 set_hsmode (config, val);
 106         } else if (match_option (arg, "sample", &val)) {
 107                 config->enable_mask |= PROFLOG_PERF_SAMPLING_ALIAS;
 108                 set_sample_freq (config, val);
 109         } else if (match_option (arg, "zip", NULL)) {
 110                 config->use_zip = TRUE;
 111         } else if (match_option (arg, "output", &val)) {
 112                 config->output_filename = g_strdup (val);
 113         } else if (match_option (arg, "port", &val)) {
 114                 char *end;
 115                 config->command_port = strtoul (val, &end, 10);
 116         } else if (match_option (arg, "maxframes", &val)) {
 117                 char *end;
 118                 int num_frames = strtoul (val, &end, 10);
 119                 if (num_frames > MAX_FRAMES)
 120                         num_frames = MAX_FRAMES;
 121                 config->notraces = num_frames == 0;
 122                 config->num_frames = num_frames;
 123         } else if (match_option (arg, "maxsamples", &val)) {
 124                 char *end;
 125                 int max_samples = strtoul (val, &end, 10);
 126                 if (max_samples)
 127                         config->max_allocated_sample_hits = max_samples;
 128         } else if (match_option (arg, "calldepth", &val)) {
 129                 char *end;
 130                 config->max_call_depth = strtoul (val, &end, 10);
 131         } else if (match_option (arg, "covfilter-file", &val)) {
 132                 if (config->cov_filter_files == NULL)
 133                         config->cov_filter_files = g_ptr_array_new ();
 134                 g_ptr_array_add (config->cov_filter_files, g_strdup (val));
 135         } else if (match_option (arg, "onlycoverage", NULL)) {
 136                 config->only_coverage = TRUE;
 137         } else {
 138                 int i;
 139
 140                 for (i = 0; i < G_N_ELEMENTS (event_list); ++i){
 141                         if (!strcmp (arg, event_list [i].event_name)) {
 142                                 config->enable_mask |= event_list [i].mask;
 143                                 break;
 144                         } else if (arg [0] == 'n' && arg [1] == 'o' && !strcmp (arg + 2, event_list [i].event_name)) {
 145                                 config->disable_mask |= event_list [i].mask;
 146                         }
 147                 }
 148                 if (i == G_N_ELEMENTS (event_list)) {
 149                         printf ("Could not parse argument %s\n", arg);
 150                 }
 151         }
 152 }
 153
 154 static void
 155 load_args_from_env_or_default (ProfilerConfig *config)
 156 {
 157         //XXX change this to header constants
 158
 159         config->max_allocated_sample_hits = mono_cpu_count () * 1000;
 160         config->sample_freq = 100;
 161         config->max_call_depth = 100;
 162         config->num_frames = MAX_FRAMES;
 163         config->debug_coverage |= g_hasenv ("MONO_PROFILER_DEBUG_COVERAGE");
 164 }
 165
 166
 167 void
 168 proflog_parse_args (ProfilerConfig *config, const char *desc)
 169 {
 170         const char *p;
 171         gboolean in_quotes = FALSE;
 172         char quote_char = '\0';
 173         char *buffer = malloc (strlen (desc));
 174         int buffer_pos = 0;
 175
 176         load_args_from_env_or_default (config);
 177
 178         for (p = desc; *p; p++){
 179                 switch (*p){
 180                 case ',':
 181                         if (!in_quotes) {
 182                                 if (buffer_pos != 0){
 183                                         buffer [buffer_pos] = 0;
 184                                         parse_arg (buffer, config);
 185                                         buffer_pos = 0;
 186                                 }
 187                         } else {
 188                                 buffer [buffer_pos++] = *p;
 189                         }
 190                         break;
 191
 192                 case '\\':
 193                         if (p [1]) {
 194                                 buffer [buffer_pos++] = p[1];
 195                                 p++;
 196                         }
 197                         break;
 198                 case '\'':
 199                 case '"':
 200                         if (in_quotes) {
 201                                 if (quote_char == *p)
 202                                         in_quotes = FALSE;
 203                                 else
 204                                         buffer [buffer_pos++] = *p;
 205                         } else {
 206                                 in_quotes = TRUE;
 207                                 quote_char = *p;
 208                         }
 209                         break;
 210                 default:
 211                         buffer [buffer_pos++] = *p;
 212                         break;
 213                 }
 214         }
 215
 216         if (buffer_pos != 0) {
 217                 buffer [buffer_pos] = 0;
 218                 parse_arg (buffer, config);
 219         }
 220
 221         //Compure config effective mask
 222         config->effective_mask = config->enable_mask & ~config->disable_mask;
 223 }
 224
 225 static void
 226 set_hsmode (ProfilerConfig *config, const char* val)
 227 {
 228         char *end;
 229         unsigned int count;
 230         if (!val)
 231                 return;
 232         if (strcmp (val, "ondemand") == 0) {
 233                 config->hs_mode_ondemand = TRUE;
 234                 return;
 235         }
 236
 237         count = strtoul (val, &end, 10);
 238         if (val == end) {
 239                 usage ();
 240                 return;
 241         }
 242
 243         if (strcmp (end, "ms") == 0)
 244                 config->hs_mode_ms = count;
 245         else if (strcmp (end, "gc") == 0)
 246                 config->hs_mode_gc = count;
 247         else
 248                 usage ();
 249 }
 250
 251 static void
 252 set_sample_freq (ProfilerConfig *config, const char *val)
 253 {
 254         if (!val)
 255                 return;
 256
 257         const char *p = val;
 258
 259         // Is it only the frequency (new option style)?
 260         if (isdigit (*p))
 261                 goto parse;
 262
 263         // Skip the sample type for backwards compatibility.
 264         while (isalpha (*p))
 265                 p++;
 266
 267         // Skip the forward slash only if we got a sample type.
 268         if (p != val && *p == '/') {
 269                 p++;
 270
 271                 char *end;
 272
 273         parse:
 274                 config->sample_freq = strtoul (p, &end, 10);
 275
 276                 if (p == end) {
 277                         usage ();
 278                         return;
 279                 }
 280
 281                 p = end;
 282         }
 283
 284         if (*p)
 285                 usage ();
 286 }
 287
 288 static void
 289 usage (void)
 290 {
 291         printf ("Log profiler version %d.%d (format: %d)\n", LOG_VERSION_MAJOR, LOG_VERSION_MINOR, LOG_DATA_VERSION);
 292         printf ("Usage: mono --profile=log[:OPTION1[,OPTION2...]] program.exe\n");
 293         printf ("Options:\n");
 294         printf ("\thelp                 show this usage info\n");
 295         printf ("\t[no]'event'          enable/disable a profiling event. Valid values: domain, assembly, module, class, jit, exception, gcalloc, gc, thread, monitor, gcmove, gcroot, context, finalization, counter, gchandle\n");
 296         printf ("\t[no]typesystem       enable/disable typesystem related events such as class and assembly loading\n");
 297         printf ("\t[no]alloc            enable/disable recording allocation info\n");
 298         printf ("\t[no]calls            enable/disable recording enter/leave method events\n");
 299         printf ("\t[no]legacy           enable/disable pre mono 5.4 default profiler events\n");
 300         printf ("\tsample[=TYPE]        enable/disable statistical sampling of threads (by default cycles/100)\n");
 301         printf ("\t                     TYPE: cycles,instr,cacherefs,cachemiss,branches,branchmiss\n");
 302         printf ("\t                     TYPE can be followed by /FREQUENCY\n");
 303         printf ("\t[heapshot[=MODE]     record heap shot info (by default at each major collection)\n");
 304         printf ("\t                     MODE: every XXms milliseconds, every YYgc collections, ondemand\n");
 305         printf ("\t[no]coverage         enable collection of code coverage data\n");
 306         printf ("\tcovfilter=ASSEMBLY   add an assembly to the code coverage filters\n");
 307         printf ("\t                     add a + to include the assembly or a - to exclude it\n");
 308         printf ("\t                     filter=-mscorlib\n");
 309         printf ("\tcovfilter-file=FILE  use FILE to generate the list of assemblies to be filtered\n");
 310         printf ("\tmaxframes=NUM        collect up to NUM stack frames\n");
 311         printf ("\tcalldepth=NUM        ignore method events for call chain depth bigger than NUM\n");
 312         printf ("\toutput=FILENAME      write the data to file FILENAME (-FILENAME to overwrite)\n");
 313         printf ("\toutput=|PROGRAM      write the data to the stdin of PROGRAM\n");
 314         printf ("\t                     %%t is subtituted with date and time, %%p with the pid\n");
 315         printf ("\treport               create a report instead of writing the raw data to a file\n");
 316         printf ("\tzip                  compress the output data\n");
 317         printf ("\tport=PORTNUM         use PORTNUM for the listening command server\n");
 318 }
 319
 320 static int
 321 mono_cpu_count (void)
 322 {
 323 #ifdef PLATFORM_ANDROID
 324         /* Android tries really hard to save power by powering off CPUs on SMP phones which
 325          * means the normal way to query cpu count returns a wrong value with userspace API.
 326          * Instead we use /sys entries to query the actual hardware CPU count.
 327          */
 328         int count = 0;
 329         char buffer[8] = {'\0'};
 330         int present = open ("/sys/devices/system/cpu/present", O_RDONLY);
 331         /* Format of the /sys entry is a cpulist of indexes which in the case
 332          * of present is always of the form "0-(n-1)" when there is more than
 333          * 1 core, n being the number of CPU cores in the system. Otherwise
 334          * the value is simply 0
 335          */
 336         if (present != -1 && read (present, (char*)buffer, sizeof (buffer)) > 3)
 337                 count = strtol (((char*)buffer) + 2, NULL, 10);
 338         if (present != -1)
 339                 close (present);
 340         if (count > 0)
 341                 return count + 1;
 342 #endif
 343
 344 #if defined(HOST_ARM) || defined (HOST_ARM64)
 345
 346         /* ARM platforms tries really hard to save power by powering off CPUs on SMP phones which
 347          * means the normal way to query cpu count returns a wrong value with userspace API. */
 348
 349 #ifdef _SC_NPROCESSORS_CONF
 350         {
 351                 int count = sysconf (_SC_NPROCESSORS_CONF);
 352                 if (count > 0)
 353                         return count;
 354         }
 355 #endif
 356
 357 #else
 358
 359 #ifdef HAVE_SCHED_GETAFFINITY
 360         {
 361                 cpu_set_t set;
 362                 if (sched_getaffinity (getpid (), sizeof (set), &set) == 0)
 363                         return CPU_COUNT (&set);
 364         }
 365 #endif
 366 #ifdef _SC_NPROCESSORS_ONLN
 367         {
 368                 int count = sysconf (_SC_NPROCESSORS_ONLN);
 369                 if (count > 0)
 370                         return count;
 371         }
 372 #endif
 373
 374 #endif /* defined(HOST_ARM) || defined (HOST_ARM64) */
 375
 376 #ifdef USE_SYSCTL
 377         {
 378                 int count;
 379                 int mib [2];
 380                 size_t len = sizeof (int);
 381                 mib [0] = CTL_HW;
 382                 mib [1] = HW_NCPU;
 383                 if (sysctl (mib, 2, &count, &len, NULL, 0) == 0)
 384                         return count;
 385         }
 386 #endif
 387 #ifdef HOST_WIN32
 388         {
 389                 SYSTEM_INFO info;
 390                 GetSystemInfo (&info);
 391                 return info.dwNumberOfProcessors;
 392         }
 393 #endif
 394
 395         static gboolean warned;
 396
 397         if (!warned) {
 398                 g_warning ("Don't know how to determine CPU count on this platform; assuming 1");
 399                 warned = TRUE;
 400         }
 401
 402         return 1;
 403 }