man/mprof-report.1

   1 .de Sp
   2 .if t .sp .5v
   3 .if n .sp
   4 ..
   5 .TH mprof-report 1 ""
   6 .SH The Mono log profiler
   7 .PP
   8 The Mono \f[I]log\f[] profiler can be used to collect a lot of
   9 information about a program running in the Mono runtime.
  10 This data can be used (both while the process is running and later)
  11 to do analyses of the program behaviour, determine resource usage,
  12 performance issues or even look for particular execution patterns.
  13 .PP
  14 This is accomplished by logging the events provided by the Mono
  15 runtime through the profiling interface and periodically writing
  16 them to a file which can be later inspected with the command line
  17 \f[I]mprof-report\f[] program or with a GUI (not developed yet).
  18 .PP
  19 The events collected include (among others):
  20 .IP \[bu] 2
  21 method enter and leave
  22 .IP \[bu] 2
  23 object allocation
  24 .IP \[bu] 2
  25 garbage collection
  26 .IP \[bu] 2
  27 JIT compilation
  28 .IP \[bu] 2
  29 metadata loading
  30 .IP \[bu] 2
  31 lock contention
  32 .IP \[bu] 2
  33 exceptions
  34 .PP
  35 In addition, the profiler can periodically collect info about all
  36 the objects present in the heap at the end of a garbage collection
  37 (this is called heap shot and currently implemented only for the
  38 sgen garbage collector).
  39 Another available profiler mode is the \f[I]sampling\f[] or
  40 \f[I]statistical\f[] mode: periodically the program is sampled and
  41 the information about what the program was busy with is saved.
  42 This allows to get information about the program behaviour without
  43 degrading its performance too much (usually less than 10%).
  44 .SS Basic profiler usage
  45 .PP
  46 The simpler way to use the profiler is the following:
  47 .PP
  48 \f[B]mono\ --profile=log\ program.exe\f[]
  49 .PP
  50 At the end of the execution the file \f[I]output.mlpd\f[] will be
  51 found in the current directory.
  52 A summary report of the data can be printed by running:
  53 .PP
  54 \f[B]mprof-report\ output.mlpd\f[]
  55 .PP
  56 With this invocation a huge amount of data is collected about the
  57 program execution and collecting and saving this data can
  58 significantly slow down program execution.
  59 If saving the profiling data is not needed, a report can be
  60 generated directly with:
  61 .PP
  62 \f[B]mono\ --profile=log:report\ program.exe\f[]
  63 .PP
  64 If the information about allocations is not of interest, it can be
  65 excluded:
  66 .PP
  67 \f[B]mono\ --profile=log:noalloc\ program.exe\f[]
  68 .PP
  69 On the other hand, if method call timing is not important, while
  70 allocations are, the needed info can be gathered with:
  71 .PP
  72 \f[B]mono\ --profile=log:nocalls\ program.exe\f[]
  73 .PP
  74 You will still be able to inspect information about the sequence of
  75 calls that lead to each allocation because at each object
  76 allocation a stack trace is collected if full enter/leave
  77 information is not available.
  78 .PP
  79 To periodically collect heap shots (and exclude method and
  80 allocation events) use the following options (making sure you run
  81 with the sgen garbage collector):
  82 .PP
  83 \f[B]mono\ --gc=sgen\ --profile=log:heapshot\ program.exe\f[]
  84 .PP
  85 To perform a sampling profiler run, use the \f[I]sample\f[] option:
  86 .PP
  87 \f[B]mono\ --profile=log:sample\ program.exe\f[]
  88 .SS Profiler option documentation
  89 .PP
  90 By default the \f[I]log\f[] profiler will gather all the events
  91 provided by the Mono runtime and write them to a file named
  92 \f[I]output.mlpd\f[].
  93 When no option is specified, it is equivalent to using:
  94 .PP
  95 \f[B]--profile=log:calls,alloc,output=output.mlpd,maxframes=32,calldepth=100\f[]
  96 .PP
  97 The following options can be used to modify this default behaviour.
  98 Each option is separated from the next by a \f[B],\f[] character,
  99 with no spaces and all the options are included after the
 100 \f[I]log:\f[] profile module specifier.
 101 .IP \[bu] 2
 102 \f[I]help\f[]: display concise help info about each available
 103 option
 104 .IP \[bu] 2
 105 \f[I][no]alloc\f[]: \f[I]noalloc\f[] disables collecting object
 106 allocation info, \f[I]alloc\f[] enables it if it was disabled by
 107 another option like \f[I]heapshot\f[].
 108 .IP \[bu] 2
 109 \f[I][no]calls\f[]: \f[I]nocalls\f[] disables collecting method
 110 enter and leave events.
 111 When this option is used at each object allocation and at some
 112 other events (like lock contentions and exception throws) a stack
 113 trace is collected by default.
 114 See the \f[I]maxframes\f[] option to control this behaviour.
 115 \f[I]calls\f[] enables method enter/leave events if they were
 116 disabled by another option like \f[I]heapshot\f[].
 117 .IP \[bu] 2
 118 \f[I]heapshot[=MODE]\f[]: collect heap shot data at each major
 119 collection.
 120 The frequency of the heap shots can be changed with the
 121 \f[I]MODE\f[] parameter.
 122 When this option is used allocation events and method enter/leave
 123 events are not recorded by default: if they are needed, they need
 124 to be enabled explicitly.
 125 The optional parameter \f[I]MODE\f[] can modify the default heap
 126 shot frequency.
 127 heapshot can be used multiple times with different modes: in that
 128 case a heap shot is taken if either of the conditions are met.
 129 MODE can be one of:
 130 .RS 2
 131 .IP \[bu] 2
 132 \f[I]NUM\f[]ms: perform a heap shot if at least \f[I]NUM\f[]
 133 milliseconds passed since the last one.
 134 .IP \[bu] 2
 135 \f[I]NUM\f[]gc: perform a heap shot every \f[I]NUM\f[] major
 136 garbage collections
 137 .IP \[bu] 2
 138 \f[I]ondemand\f[]: perform a heap shot when such a command is sent
 139 to the control port
 140 .RE
 141 .IP \[bu] 2
 142 \f[I]sample[=TYPE[/FREQ]]\f[]: collect statistical samples of the
 143 program behaviour.
 144 The default is to collect a 100 times per second (100 Hz) the
 145 instruction pointer.
 146 This is equivalent to the value \[lq]cycles/100\[rq].
 147 A value of zero for \f[I]FREQ\f[] effectively disables sampling.
 148 On some systems, like with recent Linux kernels, it is possible to
 149 cause the sampling to happen for other events provided by the
 150 performance counters of the cpu.
 151 In this case, \f[I]TYPE\f[] can be one of:
 152 .RS 2
 153 .IP \[bu] 2
 154 \f[I]cycles\f[]: processor cycles
 155 .IP \[bu] 2
 156 \f[I]instr\f[]: executed instructions
 157 .IP \[bu] 2
 158 \f[I]cacherefs\f[]: cache references
 159 .IP \[bu] 2
 160 \f[I]cachemiss\f[]: cache misses
 161 .IP \[bu] 2
 162 \f[I]branches\f[]: executed branches
 163 .IP \[bu] 2
 164 \f[I]branchmiss\f[]: mispredicted branches
 165 .RE
 166 .IP \[bu] 2
 167 \f[I]maxframes=NUM\f[]: when a stack trace needs to be performed,
 168 collect \f[I]NUM\f[] frames at the most.
 169 The default is 32.
 170 .IP \[bu] 2
 171 \f[I]maxsamples=NUM\f[]: stop allocating reusable sample events
 172 once \f[I]NUM\f[] events have been allocated (a value of zero for
 173 all intents and purposes means unlimited). By default, the value
 174 of this setting is the number of CPU cores multiplied by 1000. This
 175 is usually a good enough value for typical desktop and mobile apps.
 176 If you're losing too many samples due to this default (which is
 177 possible in apps with an unusually high amount of threads), you
 178 may want to tinker with this value to find a good balance between
 179 sample hit rate and performance impact on the app. The way it works
 180 is that sample events are enqueued for reuse after they're flushed
 181 to the output file; if a thread gets a sampling signal but there are
 182 no sample events in the reuse queue and the profiler has reached the
 183 maximum number of sample allocations, the sample gets dropped. So a
 184 higher number for this setting will increase the chance that a
 185 thread is able to collect a sample, but also necessarily means that
 186 there will be more work done by the profiler. You can run Mono with
 187 the \f[I]--stats\f[] option to see statistics about sample events.
 188 .IP \[bu] 2
 189 \f[I]calldepth=NUM\f[]: ignore method enter/leave events when the
 190 call chain depth is bigger than NUM.
 191 .IP \[bu] 2
 192 \f[I]zip\f[]: automatically compress the output data in gzip
 193 format.
 194 .IP \[bu] 2
 195 \f[I]output=OUTSPEC\f[]: instead of writing the profiling data to
 196 the output.mlpd file, substitute \f[I]%p\f[] in \f[I]OUTSPEC\f[]
 197 with the current process id and \f[I]%t\f[] with the current date
 198 and time, then do according to \f[I]OUTSPEC\f[]:
 199 .RS 2
 200 .IP \[bu] 2
 201 if \f[I]OUTSPEC\f[] begins with a \f[I]|\f[] character, execute the
 202 rest as a program and feed the data to its standard input
 203 .IP \[bu] 2
 204 if \f[I]OUTSPEC\f[] begins with a \f[I]-\f[] character, use the
 205 rest of OUTSPEC as the filename, but force overwrite any existing
 206 file by that name
 207 .IP \[bu] 2
 208 otherwise write the data the the named file: note that is a file by
 209 that name already exists, a warning is issued and profiling is
 210 disabled.
 211 .RE
 212 .IP \[bu] 2
 213 \f[I]report\f[]: the profiling data is sent to mprof-report, which
 214 will print a summary report.
 215 This is equivalent to the option: \f[B]output=mprof-report\ -\f[].
 216 If the \f[I]output\f[] option is specified as well, the report will
 217 be written to the output file instead of the console.
 218 .IP \[bu] 2
 219 \f[I]port=PORT\f[]: specify the tcp/ip port to use for the
 220 listening command server.
 221 Currently not available for windows.
 222 This server is started for example when heapshot=ondemand is used:
 223 it will read commands line by line.
 224 The following commands are available:
 225 .RS 2
 226 .IP \[bu] 2
 227 \f[I]heapshot\f[]: perform a heapshot as soon as possible
 228 .RE
 229 .IP \[bu] 2
 230 \f[I]counters\f[]: sample counters values every 1 second. This allow
 231 a really lightweight way to have insight in some of the runtime key
 232 metrics. Counters displayed in non verbose mode are : Methods from AOT,
 233 Methods JITted using mono JIT, Methods JITted using LLVM, Total time
 234 spent JITting (sec), User Time, System Time, Total Time, Working Set,
 235 Private Bytes, Virtual Bytes, Page Faults and CPU Load Average (1min,
 236 5min and 15min).
 237 .IP \[bu] 2
 238 \f[I]coverage\f[]: collect code coverage data. This implies enabling
 239 the \f[I]calls\f[] option.
 240 .IP \[bu] 2
 241 \f[I]onlycoverage\f[]: can only be used with \f[I]coverage\f[]. This
 242 disables most other events so that the profiler mostly only collects
 243 coverage data.
 244 .RE
 245 .SS Analyzing the profile data
 246 .PP
 247 Currently there is a command line program (\f[I]mprof-report\f[])
 248 to analyze the data produced by the profiler.
 249 This is ran automatically when the \f[I]report\f[] profiler option
 250 is used.
 251 Simply run:
 252 .PP
 253 \f[B]mprof-report\ output.mlpd\f[]
 254 .PP
 255 to see a summary report of the data included in the file.
 256 .SS Trace information for events
 257 .PP
 258 Often it is important for some events, like allocations, lock
 259 contention and exception throws to know where they happened.
 260 Or we may want to see what sequence of calls leads to a particular
 261 method invocation.
 262 To see this info invoke mprof-report as follows:
 263 .PP
 264 \f[B]mprof-report\ --traces\ output.mlpd\f[]
 265 .PP
 266 The maximum number of methods in each stack trace can be specified
 267 with the \f[I]--maxframes=NUM\f[] option:
 268 .PP
 269 \f[B]mprof-report\ --traces\ --maxframes=4\ output.mlpd\f[]
 270 .PP
 271 The stack trace info will be available if method enter/leave events
 272 have been recorded or if stack trace collection wasn't explicitly
 273 disabled with the \f[I]maxframes=0\f[] profiler option.
 274 .PP
 275 The \f[I]--traces\f[] option also controls the reverse reference
 276 feature in the heapshot report: for each class it reports how many
 277 references to objects of that class come from other classes.
 278 .SS Sort order for methods and allocations
 279 .PP
 280 When a list of methods is printed the default sort order is based
 281 on the total time spent in the method.
 282 This time is wall clock time (that is, it includes the time spent,
 283 for example, in a sleep call, even if actual cpu time would be
 284 basically 0).
 285 Also, if the method has been ran on different threads, the time
 286 will be a sum of the time used in each thread.
 287 .PP
 288 To change the sort order, use the option:
 289 .PP
 290 \f[B]--method-sort=MODE\f[]
 291 .PP
 292 where \f[I]MODE\f[] can be:
 293 .IP \[bu] 2
 294 \f[I]self\f[]: amount of time spent in the method itself and not in
 295 its callees
 296 .IP \[bu] 2
 297 \f[I]calls\f[]: the number of method invocations
 298 .IP \[bu] 2
 299 \f[I]total\f[]: the total time spent in the method.
 300 .PP
 301 Object allocation lists are sorted by default depending on the
 302 total amount of bytes used by each type.
 303 .PP
 304 To change the sort order of object allocations, use the option:
 305 .PP
 306 \f[B]--alloc-sort=MODE\f[]
 307 .PP
 308 where \f[I]MODE\f[] can be:
 309 .IP \[bu] 2
 310 \f[I]count\f[]: the number of allocated objects of the given type
 311 .IP \[bu] 2
 312 \f[I]bytes\f[]: the total number of bytes used by objects of the
 313 given type
 314 .PP
 315 To change the sort order of counters, use the option:
 316 .PP
 317 \f[B]--counters-sort=MODE\f[]
 318 .PP
 319 where \f[I]MODE\f[] can be:
 320 .IP \[bu] 2
 321 \f[I]time\f[]: sort values by time then category
 322 .IP \[bu] 2
 323 \f[I]category\f[]: sort values by category then time
 324 .SS Selecting what data to report
 325 .PP
 326 The profiler by default collects data about many runtime subsystems
 327 and mprof-report prints a summary of all the subsystems that are
 328 found in the data file.
 329 It is possible to tell mprof-report to only show information about
 330 some of them with the following option:
 331 .PP
 332 \f[B]--reports=R1[,R2...]\f[]
 333 .PP
 334 where the report names R1, R2 etc.
 335 can be:
 336 .IP \[bu] 2
 337 \f[I]header\f[]: information about program startup and profiler
 338 version
 339 .IP \[bu] 2
 340 \f[I]jit\f[]: JIT compiler information
 341 .IP \[bu] 2
 342 \f[I]sample\f[]: statistical sampling information
 343 .IP \[bu] 2
 344 \f[I]gc\f[]: garbage collection information
 345 .IP \[bu] 2
 346 \f[I]alloc\f[]: object allocation information
 347 .IP \[bu] 2
 348 \f[I]call\f[]: method profiling information
 349 .IP \[bu] 2
 350 \f[I]metadata\f[]: metadata events like image loads
 351 .IP \[bu] 2
 352 \f[I]exception\f[]: exception throw and handling information
 353 .IP \[bu] 2
 354 \f[I]monitor\f[]: lock contention information
 355 .IP \[bu] 2
 356 \f[I]thread\f[]: thread information
 357 .IP \[bu] 2
 358 \f[I]domain\f[]: app domain information
 359 .IP \[bu] 2
 360 \f[I]context\f[]: remoting context information
 361 .IP \[bu] 2
 362 \f[I]heapshot\f[]: live heap usage at heap shots
 363 .IP \[bu] 2
 364 \f[I]counters\f[]: counters samples
 365 .IP \[bu] 2
 366 \f[I]coverage\f[]: code coverage data
 367 .IP \[bu] 2
 368 \f[I]stats\f[]: event statistics
 369 .PP
 370 It is possible to limit some of the data displayed to a timeframe
 371 of the program execution with the option:
 372 .PP
 373 \f[B]--time=FROM-TO\f[]
 374 .PP
 375 where \f[I]FROM\f[] and \f[I]TO\f[] are seconds since application
 376 startup (they can be floating point numbers).
 377 .PP
 378 Another interesting option is to consider only events happening on
 379 a particular thread with the following option:
 380 .PP
 381 \f[B]--thread=THREADID\f[]
 382 .PP
 383 where \f[I]THREADID\f[] is one of the numbers listed in the thread
 384 summary report (or a thread name when present).
 385 .PP
 386 By default long lists of methods or other information like object
 387 allocations are limited to the most important data.
 388 To increase the amount of information printed you can use the
 389 option:
 390 .PP
 391 \f[B]--verbose\f[]
 392 .SS Track individual objects
 393 .PP
 394 Instead of printing the usual reports from the profiler data, it is
 395 possible to track some interesting information about some specific
 396 object addresses.
 397 The objects are selected based on their address with the
 398 \f[I]--track\f[] option as follows:
 399 .PP
 400 \f[B]--track=0xaddr1[,0xaddr2,...]\f[]
 401 .PP
 402 The reported info (if available in the data file), will be class
 403 name, size, creation time, stack trace of creation (with the
 404 \f[I]--traces\f[] option), etc.
 405 If heapshot data is available it will be possible to also track
 406 what other objects reference one of the listed addresses.
 407 .PP
 408 The object addresses can be gathered either from the profiler
 409 report in some cases (like in the monitor lock report), from the
 410 live application or they can be selected with the
 411 \f[I]--find=FINDSPEC\f[] option.
 412 FINDSPEC can be one of the following:
 413 .IP \[bu] 2
 414 \f[I]S:SIZE\f[]: where the object is selected if its size is at
 415 least \f[I]SIZE\f[]
 416 .IP \[bu] 2
 417 \f[I]T:NAME\f[]: where the object is selected if \f[I]NAME\f[]
 418 partially matches its class name
 419 .PP
 420 This option can be specified multiple times with one of the
 421 different kinds of FINDSPEC.
 422 For example, the following:
 423 .PP
 424 \f[B]--find=S:10000\ --find=T:Byte[]\f[]
 425 .PP
 426 will find all the byte arrays that are at least 10000 bytes in
 427 size.
 428 .PP
 429 Note that with a moving garbage collector the object address can
 430 change, so you may need to track the changed address manually.
 431 It can also happen that multiple objects are allocated at the same
 432 address, so the output from this option can become large.
 433 .SS Saving a profiler report
 434 .PP
 435 By default mprof-report will print the summary data to the console.
 436 To print it to a file, instead, use the option:
 437 .PP
 438 \f[B]--out=FILENAME\f[]
 439 .SS Processing code coverage data
 440 .PP
 441 If you ran the profiler with the \f[I]coverage\f[] option, you can
 442 process the collected coverage data into an XML file by running
 443 mprof-report like this:
 444 .PP
 445 \f[B]mprof-report --coverage-out=coverage.xml output.mlpd\f[]
 446 .SS Dealing with profiler slowness
 447 .PP
 448 If the profiler needs to collect lots of data, the execution of the
 449 program will slow down significantly, usually 10 to 20 times
 450 slower.
 451 There are several ways to reduce the impact of the profiler on the
 452 program execution.
 453 .IP "\f[I]Use the statistical sampling mode\f[]" 4
 454 .Sp
 455 Statistical sampling allows executing a program under the profiler
 456 with minimal performance overhead (usually less than 10%).
 457 This mode allows checking where the program is spending most of
 458 its execution time without significantly perturbing its behaviour.
 459 .IP "\f[I]Collect less data\f[]" 4
 460 .Sp
 461 Collecting method enter/leave events can be very expensive,
 462 especially in programs that perform many millions of tiny calls.
 463 The profiler option \f[I]nocalls\f[] can be used to avoid
 464 collecting this data or it can be limited to only a few call levels
 465 with the \f[I]calldepth\f[] option.
 466 .Sp
 467 Object allocation information is expensive as well, though much
 468 less than method enter/leave events.
 469 If it's not needed, it can be skipped with the \f[I]noalloc\f[]
 470 profiler option.
 471 Note that when method enter/leave events are discarded, by default
 472 stack traces are collected at each allocation and this can be
 473 expensive as well.
 474 The impact of stack trace information can be reduced by setting a
 475 low value with the \f[I]maxframes\f[] option or by eliminating them
 476 completely, by setting it to 0.
 477 .Sp
 478 The other major source of data is the \f[I]heapshot\f[] profiler
 479 option: especially if the managed heap is big, since every object
 480 needs to be inspected.
 481 The \f[I]MODE\f[] parameter of the \f[I]heapshot\f[] option can be
 482 used to reduce the frequency of the heap shots.
 483 .SS Dealing with the size of the data files
 484 .PP
 485 When collecting a lot of information about a profiled program, huge
 486 data files can be generated.
 487 There are a few ways to minimize the amount of data, for example by
 488 not collecting some of the more space-consuming information or by
 489 compressing the information on the fly or by just generating a
 490 summary report.
 491 .IP "\f[I]Reducing the amount of data\f[]" 4
 492 .Sp
 493 Method enter/leave events can be excluded completely with the
 494 \f[I]nocalls\f[] option or they can be limited to just a few levels
 495 of calls with the \f[I]calldepth\f[] option.
 496 For example, the option:
 497 .Sp
 498 \f[B]calldepth=10\f[]
 499 .Sp
 500 will ignore the method events when there are more than 10 managed
 501 stack frames.
 502 This is very useful for programs that have deep recursion or for
 503 programs that perform many millions of tiny calls deep enough in
 504 the call stack.
 505 The optimal number for the calldepth option depends on the program
 506 and it needs to be balanced between providing enough profiling
 507 information and allowing fast execution speed.
 508 .Sp
 509 Note that by default, if method events are not recorded at all, the
 510 profiler will collect stack trace information at events like
 511 allocations.
 512 To avoid gathering this data, use the \f[I]maxframes=0\f[] profiler
 513 option.
 514 .Sp
 515 Allocation events can be eliminated with the \f[I]noalloc\f[]
 516 option.
 517 .Sp
 518 Heap shot data can also be huge: by default it is collected at each
 519 major collection.
 520 To reduce the frequency, you can specify a heapshot mode: for
 521 example to collect every 5 collections (including major and minor):
 522 .Sp
 523 \f[B]heapshot=5gc\f[]
 524 .Sp
 525 or when at least 5 seconds passed since the last heap shot:
 526 .Sp
 527 \f[B]heapshot=5000ms\f[]
 528 .IP "\f[I]Compressing the data\f[]" 4
 529 .Sp
 530 To reduce the amout of disk space used by the data, the data can be
 531 compressed either after it has been generated with the gzip
 532 command:
 533 .Sp
 534 \f[B]gzip\ -9\ output.mlpd\f[]
 535 .Sp
 536 or it can be compressed automatically by using the \f[I]zip\f[]
 537 profiler option.
 538 Note that in this case there could be a significant slowdown of the
 539 profiled program.
 540 .Sp
 541 The mprof-report program will tranparently deal with either
 542 compressed or uncompressed data files.
 543 .IP "\f[I]Generating only a summary report\f[]" 4
 544 .Sp
 545 Often it's enough to look at the profiler summary report to
 546 diagnose an issue and in this case it's possible to avoid saving
 547 the profiler data file to disk.
 548 This can be accomplished with the \f[I]report\f[] profiler option,
 549 which will basically send the data to the mprof-report program for
 550 display.
 551 .Sp
 552 To have more control of what summary information is reported (or to
 553 use a completely different program to decode the profiler data),
 554 the \f[I]output\f[] profiler option can be used, with \f[B]|\f[] as
 555 the first character: the rest of the output name will be executed
 556 as a program with the data fed in on the standard input.
 557 .Sp
 558 For example, to print only the Monitor summary with stack trace
 559 information, you could use it like this:
 560 .Sp
 561 \f[B]output=|mprof-report\ --reports=monitor\ --traces\ -\f[]
 562 .SH WEB SITE
 563 http://www.mono-project.com/docs/debug+profile/profile/profiler/
 564 .SH SEE ALSO
 565 .PP
 566 mono(1)
 567 .SH AUTHORS
 568 Paolo Molaro, Alex Rønne Petersen