man/mprof-report.1

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