mono/profiler/log-args.c

   1 #include <config.h>
   2
   3 #include "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 }
 164
 165
 166 void
 167 proflog_parse_args (ProfilerConfig *config, const char *desc)
 168 {
 169         const char *p;
 170         gboolean in_quotes = FALSE;
 171         char quote_char = '\0';
 172         char *buffer = malloc (strlen (desc));
 173         int buffer_pos = 0;
 174
 175         load_args_from_env_or_default (config);
 176
 177         for (p = desc; *p; p++){
 178                 switch (*p){
 179                 case ',':
 180                         if (!in_quotes) {
 181                                 if (buffer_pos != 0){
 182                                         buffer [buffer_pos] = 0;
 183                                         parse_arg (buffer, config);
 184                                         buffer_pos = 0;
 185                                 }
 186                         } else {
 187                                 buffer [buffer_pos++] = *p;
 188                         }
 189                         break;
 190
 191                 case '\\':
 192                         if (p [1]) {
 193                                 buffer [buffer_pos++] = p[1];
 194                                 p++;
 195                         }
 196                         break;
 197                 case '\'':
 198                 case '"':
 199                         if (in_quotes) {
 200                                 if (quote_char == *p)
 201                                         in_quotes = FALSE;
 202                                 else
 203                                         buffer [buffer_pos++] = *p;
 204                         } else {
 205                                 in_quotes = TRUE;
 206                                 quote_char = *p;
 207                         }
 208                         break;
 209                 default:
 210                         buffer [buffer_pos++] = *p;
 211                         break;
 212                 }
 213         }
 214
 215         if (buffer_pos != 0) {
 216                 buffer [buffer_pos] = 0;
 217                 parse_arg (buffer, config);
 218         }
 219
 220         g_free (buffer);
 221
 222         //Compure config effective mask
 223         config->effective_mask = config->enable_mask & ~config->disable_mask;
 224 }
 225
 226 static void
 227 set_hsmode (ProfilerConfig *config, const char* val)
 228 {
 229         char *end;
 230         unsigned int count;
 231         if (!val)
 232                 return;
 233         if (strcmp (val, "ondemand") == 0) {
 234                 config->hs_mode_ondemand = TRUE;
 235                 return;
 236         }
 237
 238         count = strtoul (val, &end, 10);
 239         if (val == end) {
 240                 usage ();
 241                 return;
 242         }
 243
 244         if (strcmp (end, "ms") == 0)
 245                 config->hs_mode_ms = count;
 246         else if (strcmp (end, "gc") == 0)
 247                 config->hs_mode_gc = count;
 248         else
 249                 usage ();
 250 }
 251
 252 /*
 253 Sampling frequency allows for one undocumented, hidden and ignored argument. The sampling kind.
 254 Back in the day when this was done using perf, we could specify one of: cycles,instr,cacherefs,cachemiss,branches,branchmiss
 255 With us moving ot userland sampling, those options are now meaningless.
 256 */
 257 static void
 258 set_sample_freq (ProfilerConfig *config, const char *val)
 259 {
 260         if (!val)
 261                 return;
 262
 263         const char *p = val;
 264
 265         // Is it only the frequency (new option style)?
 266         if (isdigit (*p))
 267                 goto parse;
 268
 269         // Skip the sample type for backwards compatibility.
 270         while (isalpha (*p))
 271                 p++;
 272
 273         // Skip the forward slash only if we got a sample type.
 274         if (p != val && *p == '/') {
 275                 p++;
 276
 277                 char *end;
 278
 279         parse:
 280                 config->sample_freq = strtoul (p, &end, 10);
 281
 282                 if (p == end) {
 283                         usage ();
 284                         return;
 285                 }
 286
 287                 p = end;
 288         }
 289
 290         if (*p)
 291                 usage ();
 292 }
 293
 294 static void
 295 usage (void)
 296 {
 297         printf ("Log profiler version %d.%d (format: %d)\n", LOG_VERSION_MAJOR, LOG_VERSION_MINOR, LOG_DATA_VERSION);
 298         printf ("Usage: mono --profile=log[:OPTION1[,OPTION2...]] program.exe\n");
 299         printf ("Options:\n");
 300         printf ("\thelp                 show this usage info\n");
 301         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");
 302         printf ("\t[no]typesystem       enable/disable typesystem related events such as class and assembly loading\n");
 303         printf ("\t[no]alloc            enable/disable recording allocation info\n");
 304         printf ("\t[no]calls            enable/disable recording enter/leave method events\n");
 305         printf ("\t[no]legacy           enable/disable pre mono 5.4 default profiler events\n");
 306         printf ("\tsample[=frequency]   enable/disable statistical sampling of threads (frequency in Hz, 100 by default)\n");
 307         printf ("\theapshot[=MODE]      record heap shot info (by default at each major collection)\n");
 308         printf ("\t                     MODE: every XXms milliseconds, every YYgc collections, ondemand\n");
 309         printf ("\t[no]coverage         enable collection of code coverage data\n");
 310         printf ("\tcovfilter=ASSEMBLY   add an assembly to the code coverage filters\n");
 311         printf ("\t                     add a + to include the assembly or a - to exclude it\n");
 312         printf ("\t                     covfilter=-mscorlib\n");
 313         printf ("\tcovfilter-file=FILE  use FILE to generate the list of assemblies to be filtered\n");
 314         printf ("\tmaxframes=NUM        collect up to NUM stack frames\n");
 315         printf ("\tcalldepth=NUM        ignore method events for call chain depth bigger than NUM\n");
 316         printf ("\toutput=FILENAME      write the data to file FILENAME (The file is always overwriten)\n");
 317         printf ("\toutput=+FILENAME     write the data to file FILENAME.pid (The file is always overwriten)\n");
 318         printf ("\toutput=|PROGRAM      write the data to the stdin of PROGRAM\n");
 319         printf ("\t                     %%t is subtituted with date and time, %%p with the pid\n");
 320         printf ("\treport               create a report instead of writing the raw data to a file\n");
 321         printf ("\tzip                  compress the output data\n");
 322         printf ("\tport=PORTNUM         use PORTNUM for the listening command server\n");
 323 }
 324
 325 static int
 326 mono_cpu_count (void)
 327 {
 328 #ifdef PLATFORM_ANDROID
 329         /* Android tries really hard to save power by powering off CPUs on SMP phones which
 330          * means the normal way to query cpu count returns a wrong value with userspace API.
 331          * Instead we use /sys entries to query the actual hardware CPU count.
 332          */
 333         int count = 0;
 334         char buffer[8] = {'\0'};
 335         int present = open ("/sys/devices/system/cpu/present", O_RDONLY);
 336         /* Format of the /sys entry is a cpulist of indexes which in the case
 337          * of present is always of the form "0-(n-1)" when there is more than
 338          * 1 core, n being the number of CPU cores in the system. Otherwise
 339          * the value is simply 0
 340          */
 341         if (present != -1 && read (present, (char*)buffer, sizeof (buffer)) > 3)
 342                 count = strtol (((char*)buffer) + 2, NULL, 10);
 343         if (present != -1)
 344                 close (present);
 345         if (count > 0)
 346                 return count + 1;
 347 #endif
 348
 349 #if defined(HOST_ARM) || defined (HOST_ARM64)
 350
 351         /* ARM platforms tries really hard to save power by powering off CPUs on SMP phones which
 352          * means the normal way to query cpu count returns a wrong value with userspace API. */
 353
 354 #ifdef _SC_NPROCESSORS_CONF
 355         {
 356                 int count = sysconf (_SC_NPROCESSORS_CONF);
 357                 if (count > 0)
 358                         return count;
 359         }
 360 #endif
 361
 362 #else
 363
 364 #ifdef HAVE_SCHED_GETAFFINITY
 365         {
 366                 cpu_set_t set;
 367                 if (sched_getaffinity (getpid (), sizeof (set), &set) == 0)
 368                         return CPU_COUNT (&set);
 369         }
 370 #endif
 371 #ifdef _SC_NPROCESSORS_ONLN
 372         {
 373                 int count = sysconf (_SC_NPROCESSORS_ONLN);
 374                 if (count > 0)
 375                         return count;
 376         }
 377 #endif
 378
 379 #endif /* defined(HOST_ARM) || defined (HOST_ARM64) */
 380
 381 #ifdef USE_SYSCTL
 382         {
 383                 int count;
 384                 int mib [2];
 385                 size_t len = sizeof (int);
 386                 mib [0] = CTL_HW;
 387                 mib [1] = HW_NCPU;
 388                 if (sysctl (mib, 2, &count, &len, NULL, 0) == 0)
 389                         return count;
 390         }
 391 #endif
 392 #ifdef HOST_WIN32
 393         {
 394                 SYSTEM_INFO info;
 395                 GetSystemInfo (&info);
 396                 return info.dwNumberOfProcessors;
 397         }
 398 #endif
 399
 400         static gboolean warned;
 401
 402         if (!warned) {
 403                 g_warning ("Don't know how to determine CPU count on this platform; assuming 1");
 404                 warned = TRUE;
 405         }
 406
 407         return 1;
 408 }