Implement lightweight nursery verification.
[mono.git] / man / mono.1
1 .\" 
2 .\" mono manual page.
3 .\" Copyright 2003 Ximian, Inc. 
4 .\" Copyright 2004-2011 Novell, Inc. 
5 .\" Author:
6 .\"   Miguel de Icaza (miguel@gnu.org)
7 .\"
8 .TH Mono "Mono 2.11"
9 .SH NAME
10 mono \- Mono's ECMA-CLI native code generator (Just-in-Time and Ahead-of-Time)
11 .SH SYNOPSIS
12 .PP
13 .B mono [options] file [arguments...]
14 .PP
15 .B mono-sgen [options] file [arguments...]
16 .SH DESCRIPTION
17 \fImono\fP is a runtime implementation of the ECMA Common Language
18 Infrastructure.  This can be used to run ECMA and .NET applications.
19 .PP
20 The runtime contains a native code generator that transforms the
21 Common Intermediate Language into native code.
22 .PP
23 The code generator can operate in two modes: just in time compilation
24 (JIT) or ahead of time compilation (AOT).  Since code can be
25 dynamically loaded, the runtime environment and the JIT are always
26 present, even if code is compiled ahead of time.
27 .PP
28 The runtime loads the specified
29 .I file
30 and optionally passes
31 the
32 .I arguments
33 to it.  The 
34 .I file
35 is an ECMA assembly.  They typically have a .exe or .dll extension.
36 .PP
37 The runtime provides a number of configuration options for running
38 applications, for developing and debugging, and for testing and
39 debugging the runtime itself.
40 .PP
41 The \fImono\fP command uses the Boehm conservative garbage collector
42 while the \fImono-sgen\fP command uses a moving and generational
43 garbage collector.
44 .SH PORTABILITY
45 On Unix-based systems, Mono provides a mechanism to emulate the 
46 Windows-style file access, this includes providing a case insensitive
47 view of the file system, directory separator mapping (from \\ to /) and
48 stripping the drive letters.
49 .PP
50 This functionality is enabled by setting the 
51 .B MONO_IOMAP 
52 environment variable to one of 
53 .B all, drive
54 and 
55 .B case.
56 .PP
57 See the description for 
58 .B MONO_IOMAP
59 in the environment variables section for more details.
60 .SH RUNTIME OPTIONS
61 The following options are available:
62 .TP
63 \fB--aot\fR, \fB--aot[=options]\fR
64 This option is used to precompile the CIL code in the specified
65 assembly to native code.  The generated code is stored in a file with
66 the extension .so.  This file will be automatically picked up by the
67 runtime when the assembly is executed.  
68 .Sp 
69 Ahead-of-Time compilation is most useful if you use it in combination
70 with the -O=all,-shared flag which enables all of the optimizations in
71 the code generator to be performed.  Some of those optimizations are
72 not practical for Just-in-Time compilation since they might be very
73 time consuming.
74 .Sp
75 Unlike the .NET Framework, Ahead-of-Time compilation will not generate
76 domain independent code: it generates the same code that the
77 Just-in-Time compiler would produce.   Since most applications use a
78 single domain, this is fine.   If you want to optimize the generated
79 code for use in multi-domain applications, consider using the
80 -O=shared flag.
81 .Sp
82 This pre-compiles the methods, but the original assembly is still
83 required to execute as this one contains the metadata and exception
84 information which is not available on the generated file.  When
85 precompiling code, you might want to compile with all optimizations
86 (-O=all).  Pre-compiled code is position independent code.
87 .Sp
88 Pre compilation is just a mechanism to reduce startup time, increase
89 code sharing across multiple mono processes and avoid just-in-time
90 compilation program startup costs.  The original assembly must still
91 be present, as the metadata is contained there.
92 .Sp
93 AOT code typically can not be moved from one computer to another
94 (CPU-specific optimizations that are detected at runtime) so you
95 should not try to move the pre-generated assemblies or package the
96 pre-generated assemblies for deployment.    
97 .Sp
98 A few options are available as a parameter to the 
99 .B --aot 
100 command line option.   The options are separated by commas, and more
101 than one can be specified:
102 .RS
103 .ne 8
104 .TP
105 .I bind-to-runtime-version
106 .Sp
107 If specified, forces the generated AOT files to be bound to the
108 runtime version of the compiling Mono.   This will prevent the AOT
109 files from being consumed by a different Mono runtime.
110 .I full
111 This is currently an experimental feature as it is not complete.
112 This instructs Mono to precompile code that has historically not been
113 precompiled with AOT.   
114 .TP
115 .I outfile=[filename]
116 Instructs the AOT compiler to save the output to the specified file.
117 .TP
118 .I write-symbols
119 Instructs the AOT compiler to emit debug symbol information.
120 .TP
121 .I save-temps,keep-temps
122 Instructs the AOT compiler to keep temporary files.
123 .TP
124 .I threads=[number]
125 This is an experimental option for the AOT compiler to use multiple threads
126 when compiling the methods.
127 .TP
128 .I nodebug
129 Instructs the AOT compiler to not output any debugging information.
130 .TP
131 .I ntrampolines=[number]
132 When compiling in full aot mode, the method trampolines must be precreated
133 in the AOT image.  You can add additional method trampolines with this argument.
134 Defaults to 1024.
135 .TP
136 .I nrgctx-trampolines=[number]
137 When compiling in full aot mode, the generic sharing trampolines must be precreated
138 in the AOT image.  You can add additional method trampolines with this argument.
139 Defaults to 1024.
140 .TP
141 .I nimt-trampolines=[number]
142 When compiling in full aot mode, the IMT trampolines must be precreated
143 in the AOT image.  You can add additional method trampolines with this argument.
144 Defaults to 128.
145 .TP
146 .I print-skipped-methods
147 If the AOT compiler cannot compile a method for any reason, enabling this flag
148 will output the skipped methods to the console.
149 .TP
150 .I autoreg
151 The AOT compiler will emit a (ELF only) library initializer to automatically
152 register the aot compiled module with the runtime.  This is only useful in static
153 mode
154 .TP
155 .I asmonly
156 Instructs the AOT compiler to output assembly code instead of an object file.
157 .TP
158 .I soft-debug
159 This instructs the compiler to generate sequence point checks that
160 allow Mono's soft debugger to debug applications even on systems where
161 it is not possible to set breakpoints or to single step (certain
162 hardware configurations like the cell phones and video gaming
163 consoles). 
164 .TP
165 .I static
166 Create an ELF object file (.o) or .s file which can be statically linked into an
167 executable when embedding the mono runtime. When this option is used, the object file
168 needs to be registered with the embedded runtime using the mono_aot_register_module
169 function which takes as its argument the mono_aot_module_<ASSEMBLY NAME>_info global
170 symbol from the object file:
171
172 .nf
173 extern void *mono_aot_module_hello_info;
174
175 mono_aot_register_module (mono_aot_module_hello_info);
176 .fi
177 .ne
178 .TP
179 .I mtriple=<TRIPLE>
180 Use the GNU style target triple <TRIPLE> to determine some code generation options, i.e.
181 --mtriple=armv7-linux-gnueabi will generate code that targets ARMv7. This is currently
182 only supported by the ARM backend. In LLVM mode, this triple is passed on to the LLVM
183 llc compiler.
184 .TP
185 .I tool-prefix=<PREFIX>
186 Prepends <PREFIX> to the name of tools ran by the AOT compiler, i.e. 'as'/'ld'. For
187 example, --tool=prefix=arm-linux-gnueabi- will make the AOT compiler run
188 'arm-linux-gnueabi-as' instead of 'as'.
189 .TP
190 .I llvm-path=<PREFIX>
191 Same for the llvm tools 'opt' and 'llc'.
192 .TP
193 .I stats
194 Print various stats collected during AOT compilation.
195 .TP
196 .I readonly-value=namespace.typename.fieldname=type/value
197 Override the value of a static readonly field. Usually, during JIT
198 compilation, the static constructor is ran eagerly, so the value of
199 a static readonly field is known at compilation time and the compiler
200 can do a number of optimizations based on it. During AOT, instead, the static
201 constructor can't be ran, so this option can be used to set the value of such
202 a field and enable the same set of optimizations.
203 Type can be any of i1, i2, i4 for integers of the respective sizes (in bytes).
204 Note that signed/unsigned numbers do not matter here, just the storage size.
205 This option can be specified multiple times and it doesn't prevent the static
206 constructor for the type defining the field to execute with the usual rules
207 at runtime (hence possibly computing a different value for the field).
208
209 .PP
210 For more information about AOT, see: http://www.mono-project.com/AOT
211 .RE
212 .TP
213 \fB--attach=[options]\fR
214 Currently the only option supported by this command line argument is
215 \fBdisable\fR which disables the attach functionality.
216 .TP
217 \fB--config filename\fR
218 Load the specified configuration file instead of the default one(s).
219 The default files are /etc/mono/config and ~/.mono/config or the file
220 specified in the MONO_CONFIG environment variable, if set.  See the
221 mono-config(5) man page for details on the format of this file.
222 .TP
223 \fB--debugger-agent=[options]\fR 
224 This instructs the Mono runtime to
225 start a debugging agent inside the Mono runtime and connect it to a
226 client user interface will control the Mono process.
227 This option is typically used by IDEs, like the MonoDevelop IDE.
228 .PP
229 The
230 configuration is specified using one of more of the following options:
231 .RS
232 .ne 8
233 .TP
234 .I transport=transport_name
235 .Sp
236 This is used to specify the transport that the debugger will use to
237 communicate.   It must be specified and currently requires this to
238 be 'dt_socket'. 
239 .TP
240 .I address=host:port
241 .Sp
242 Use this option to specify the IP address where your debugger client is
243 listening to.
244 .TP
245 .I loglevel=LEVEL
246 .Sp
247 Specifies the diagnostics log level for 
248 .TP
249 .I logfile=filename
250 .Sp
251 Used to specify the file where the log will be stored, it defaults to
252 standard output.
253 .TP
254 .I server=[y/n]
255 Defaults to no, with the default option Mono will actively connect to the
256 host/port configured with the \fBaddress\fR option.  If you set it to 'y', it 
257 instructs the Mono runtime to start debugging in server mode, where Mono
258 actively waits for the debugger front end to connect to the Mono process.  
259 Mono will print out to stdout the IP address and port where it is listening.
260 .TP
261 .I suspend=[y/n]
262 Defaults to yes, with the default option Mono will suspend the vm on startup 
263 until it connects successfully to a debugger front end.  If you set it to 'n', in 
264 conjunction with \fBserver=y\fR, it instructs the Mono runtime to run as normal, 
265 while caching metadata to send to the debugger front end on connection.
266 .ne
267 .RE
268 .TP
269 \fB--desktop\fR
270 Configures the virtual machine to be better suited for desktop
271 applications.  Currently this sets the GC system to avoid expanding
272 the heap as much as possible at the expense of slowing down garbage
273 collection a bit.
274 .TP
275 \fB--full-aot\fR
276 This is an experimental flag that instructs the Mono runtime to not
277 generate any code at runtime and depend exclusively on the code
278 generated from using mono --aot=full previously.   This is useful for
279 platforms that do not permit dynamic code generation.
280 .Sp
281 Notice that this feature will abort execution at runtime if a codepath
282 in your program, or Mono's class libraries attempts to generate code
283 dynamically.  You should test your software upfront and make sure that
284 you do not use any dynamic features.
285 .TP
286 \fB--gc=boehm\fR, \fB--gc=sgen\fR
287 Selects the Garbage Collector engine for Mono to use, Boehm or SGen.
288 Currently this merely ensures that you are running either the
289 \fImono\fR or \fImono-sgen\fR commands.    This flag can be set in the
290 \fBMONO_ENV_OPTIONS\fR environment variable to force all of your child
291 processes to use one particular kind of GC with the Mono runtime.
292 .TP
293 \fB--help\fR, \fB-h\fR
294 Displays usage instructions.
295 .TP
296 \fB--llvm\fR
297 If the Mono runtime has been compiled with LLVM support (not available
298 in all configurations), Mono will use the LLVM optimization and code
299 generation engine to JIT or AOT compile.     
300 .Sp
301 For more information, consult: http://www.mono-project.com/Mono_LLVM
302 .TP
303 \fB--nollvm\fR
304 When using a Mono that has been compiled with LLVM support, it forces
305 Mono to fallback to its JIT engine and not use the LLVM backend.
306 .TP
307 \fB--optimize=MODE\fR, \fB-O=MODE\fR
308 MODE is a comma separated list of optimizations.  They also allow
309 optimizations to be turned off by prefixing the optimization name with
310 a minus sign.
311 .Sp
312 In general, Mono has been tuned to use the default set of flags,
313 before using these flags for a deployment setting, you might want to
314 actually measure the benefits of using them.    
315 .Sp
316 The following optimizations are implemented:
317 .nf
318              all        Turn on all optimizations
319              peephole   Peephole postpass
320              branch     Branch optimizations
321              inline     Inline method calls
322              cfold      Constant folding
323              consprop   Constant propagation
324              copyprop   Copy propagation
325              deadce     Dead code elimination
326              linears    Linear scan global reg allocation
327              cmov       Conditional moves [arch-dependency]
328              shared     Emit per-domain code
329              sched      Instruction scheduling
330              intrins    Intrinsic method implementations
331              tailc      Tail recursion and tail calls
332              loop       Loop related optimizations
333              fcmov      Fast x86 FP compares [arch-dependency]
334              leaf       Leaf procedures optimizations
335              aot        Usage of Ahead Of Time compiled code
336              precomp    Precompile all methods before executing Main
337              abcrem     Array bound checks removal
338              ssapre     SSA based Partial Redundancy Elimination
339              sse2       SSE2 instructions on x86 [arch-dependency]
340              gshared    Enable generic code sharing.
341 .fi
342 .Sp
343 For example, to enable all the optimization but dead code
344 elimination and inlining, you can use:
345 .nf
346         -O=all,-deadce,-inline
347 .fi
348 .Sp
349 The flags that are flagged with [arch-dependency] indicate that the
350 given option if used in combination with Ahead of Time compilation
351 (--aot flag) would produce pre-compiled code that will depend on the
352 current CPU and might not be safely moved to another computer. 
353 .TP
354 \fB--runtime=VERSION\fR
355 Mono supports different runtime versions. The version used depends on the program
356 that is being run or on its configuration file (named program.exe.config). This option
357 can be used to override such autodetection, by forcing a different runtime version
358 to be used. Note that this should only be used to select a later compatible runtime
359 version than the one the program was compiled against. A typical usage is for
360 running a 1.1 program on a 2.0 version:
361 .nf
362          mono --runtime=v2.0.50727 program.exe
363 .fi
364 .TP
365 \fB--security\fR, \fB--security=mode\fR
366 Activate the security manager, a currently experimental feature in
367 Mono and it is OFF by default. The new code verifier can be enabled
368 with this option as well.
369 .RS
370 .ne 8
371 .PP
372 Using security without parameters is equivalent as calling it with the
373 "cas" parameter.  
374 .PP
375 The following modes are supported:
376 .TP
377 .I cas
378 This allows mono to support declarative security attributes,
379 e.g. execution of Code Access Security (CAS) or non-CAS demands.
380 .TP 
381 .I core-clr
382 Enables the core-clr security system, typically used for
383 Moonlight/Silverlight applications.  It provides a much simpler
384 security system than CAS, see http://www.mono-project.com/Moonlight
385 for more details and links to the descriptions of this new system. 
386 .TP
387 .I validil
388 Enables the new verifier and performs basic verification for code
389 validity.  In this mode, unsafe code and P/Invoke are allowed. This
390 mode provides a better safety guarantee but it is still possible
391 for managed code to crash Mono. 
392 .TP
393 .I verifiable
394 Enables the new verifier and performs full verification of the code
395 being executed.  It only allows verifiable code to be executed.
396 Unsafe code is not allowed but P/Invoke is.  This mode should
397 not allow managed code to crash mono.  The verification is not as
398 strict as ECMA 335 standard in order to stay compatible with the MS
399 runtime.
400 .PP
401 The security system acts on user code: code contained in mscorlib or
402 the global assembly cache is always trusted.
403 .ne
404 .RE
405 .TP
406 \fB--server\fR
407 Configures the virtual machine to be better suited for server
408 operations (currently, a no-op).
409 .TP
410 \fB--verify-all\fR 
411 Verifies mscorlib and assemblies in the global
412 assembly cache for valid IL, and all user code for IL
413 verifiability. 
414
415 This is different from \fB--security\fR's verifiable
416 or validil in that these options only check user code and skip
417 mscorlib and assemblies located on the global assembly cache.
418 .TP
419 \fB-V\fR, \fB--version\fR
420 Prints JIT version information (system configuration, release number
421 and branch names if available). 
422
423
424 .SH DEVELOPMENT OPTIONS
425 The following options are used to help when developing a JITed application.
426 .TP
427 \fB--debug\fR, \fB--debug=OPTIONS\fR
428 Turns on the debugging mode in the runtime.  If an assembly was
429 compiled with debugging information, it will produce line number
430 information for stack traces. 
431 .RS
432 .ne 8
433 .PP
434 The optional OPTIONS argument is a comma separated list of debugging
435 options.  These options are turned off by default since they generate
436 much larger and slower code at runtime.
437 .TP
438 The following options are supported:
439 .TP
440 .I casts
441 Produces a detailed error when throwing a InvalidCastException.   This
442 option needs to be enabled as this generates more verbose code at
443 execution time. 
444 .TP
445 .I mdb-optimizations
446 Disable some JIT optimizations which are usually only disabled when
447 running inside the debugger.  This can be helpful if you want to attach
448 to the running process with mdb.
449 .TP
450 .I gdb
451 Generate and register debugging information with gdb. This is only supported on some
452 platforms, and only when using gdb 7.0 or later.
453 .ne
454 .RE
455 .TP
456 \fB--profile[=profiler[:profiler_args]]\fR
457 Turns on profiling.  For more information about profiling applications
458 and code coverage see the sections "PROFILING" and "CODE COVERAGE"
459 below. 
460 .TP
461 This option can be used multiple times, each time will load an
462 additional profiler.   This allows developers to use modules that
463 extend the JIT through the Mono profiling interface.
464 .TP
465 \fB--trace[=expression]\fR
466 Shows method names as they are invoked.  By default all methods are
467 traced. 
468 .Sp
469 The trace can be customized to include or exclude methods, classes or
470 assemblies.  A trace expression is a comma separated list of targets,
471 each target can be prefixed with a minus sign to turn off a particular
472 target.  The words `program', `all' and `disabled' have special
473 meaning.  `program' refers to the main program being executed, and
474 `all' means all the method calls.
475 .Sp
476 The `disabled' option is used to start up with tracing disabled.  It
477 can be enabled at a later point in time in the program by sending the
478 SIGUSR2 signal to the runtime.
479 .Sp
480 Assemblies are specified by their name, for example, to trace all
481 calls in the System assembly, use:
482 .nf
483
484         mono --trace=System app.exe
485
486 .fi
487 Classes are specified with the T: prefix.  For example, to trace all
488 calls to the System.String class, use:
489 .nf
490
491         mono --trace=T:System.String app.exe
492
493 .fi
494 And individual methods are referenced with the M: prefix, and the
495 standard method notation:
496 .nf
497
498         mono --trace=M:System.Console:WriteLine app.exe
499
500 .fi
501 Exceptions can also be traced, it will cause a stack trace to be
502 printed every time an exception of the specified type is thrown.
503 The exception type can be specified with or without the namespace,
504 and to trace all exceptions, specify 'all' as the type name.
505 .nf
506
507         mono --trace=E:System.Exception app.exe
508
509 .fi
510 As previously noted, various rules can be specified at once:
511 .nf
512
513         mono --trace=T:System.String,T:System.Random app.exe
514
515 .fi
516 You can exclude pieces, the next example traces calls to
517 System.String except for the System.String:Concat method.
518 .nf
519
520         mono --trace=T:System.String,-M:System.String:Concat
521
522 .fi
523 Finally, namespaces can be specified using the N: prefix:
524 .nf
525
526         mono --trace=N:System.Xml
527
528 .fi
529 .TP
530 \fB--no-x86-stack-align\fR
531 Don't align stack frames on the x86 architecture.  By default, Mono
532 aligns stack frames to 16 bytes on x86, so that local floating point
533 and SIMD variables can be properly aligned.  This option turns off the
534 alignment, which usually saves one intruction per call, but might
535 result in significantly lower floating point and SIMD performance.
536 .TP
537 \fB--jitmap\fR
538 Generate a JIT method map in a /tmp/perf-PID.map file. This file is then
539 used, for example, by the perf tool included in recent Linux kernels.
540 Each line in the file has:
541 .nf
542
543         HEXADDR HEXSIZE methodname
544
545 .fi
546 Currently this option is only supported on Linux.
547 .SH JIT MAINTAINER OPTIONS
548 The maintainer options are only used by those developing the runtime
549 itself, and not typically of interest to runtime users or developers.
550 .TP
551 \fB--break method\fR
552 Inserts a breakpoint before the method whose name is `method'
553 (namespace.class:methodname).  Use `Main' as method name to insert a
554 breakpoint on the application's main method.
555 .TP
556 \fB--breakonex\fR
557 Inserts a breakpoint on exceptions.  This allows you to debug your
558 application with a native debugger when an exception is thrown.
559 .TP
560 \fB--compile name\fR
561 This compiles a method (namespace.name:methodname), this is used for
562 testing the compiler performance or to examine the output of the code
563 generator. 
564 .TP
565 \fB--compileall\fR
566 Compiles all the methods in an assembly.  This is used to test the
567 compiler performance or to examine the output of the code generator
568 .TP 
569 \fB--graph=TYPE METHOD\fR
570 This generates a postscript file with a graph with the details about
571 the specified method (namespace.name:methodname).  This requires `dot'
572 and ghostview to be installed (it expects Ghostview to be called
573 "gv"). 
574 .Sp
575 The following graphs are available:
576 .nf
577           cfg        Control Flow Graph (CFG)
578           dtree      Dominator Tree
579           code       CFG showing code
580           ssa        CFG showing code after SSA translation
581           optcode    CFG showing code after IR optimizations
582 .fi
583 .Sp
584 Some graphs will only be available if certain optimizations are turned
585 on.
586 .TP
587 \fB--ncompile\fR
588 Instruct the runtime on the number of times that the method specified
589 by --compile (or all the methods if --compileall is used) to be
590 compiled.  This is used for testing the code generator performance. 
591 .TP 
592 \fB--stats\fR
593 Displays information about the work done by the runtime during the
594 execution of an application. 
595 .TP
596 \fB--wapi=hps|semdel\fR
597 Perform maintenance of the process shared data.
598 .Sp
599 semdel will delete the global semaphore.
600 .Sp
601 hps will list the currently used handles.
602 .TP
603 \fB-v\fR, \fB--verbose\fR
604 Increases the verbosity level, each time it is listed, increases the
605 verbosity level to include more information (including, for example, 
606 a disassembly of the native code produced, code selector info etc.).
607 .SH ATTACH SUPPORT
608 The Mono runtime allows external processes to attach to a running
609 process and load assemblies into the running program.   To attach to
610 the process, a special protocol is implemented in the Mono.Management
611 assembly. 
612 .PP
613 With this support it is possible to load assemblies that have an entry
614 point (they are created with -target:exe or -target:winexe) to be
615 loaded and executed in the Mono process.
616 .PP
617 The code is loaded into the root domain, and it starts execution on
618 the special runtime attach thread.    The attached program should
619 create its own threads and return after invocation.
620 .PP
621 This support allows for example debugging applications by having the
622 csharp shell attach to running processes.
623 .SH PROFILING
624 The mono runtime includes a profiler that can be used to explore
625 various performance related problems in your application.  The
626 profiler is activated by passing the --profile command line argument
627 to the Mono runtime, the format is:
628 .nf
629
630         --profile[=profiler[:profiler_args]]
631
632 .fi
633 Mono has a built-in profiler called 'default' (and is also the default
634 if no arguments are specified), but developers can write custom
635 profilers, see the section "CUSTOM PROFILERS" for more details.
636 .PP
637 If a 
638 .I profiler 
639 is not specified, the default profiler is used.
640 .Sp
641 The 
642 .I profiler_args 
643 is a profiler-specific string of options for the profiler itself.
644 .Sp
645 The default profiler accepts the following options 'alloc' to profile
646 memory consumption by the application; 'time' to profile the time
647 spent on each routine; 'jit' to collect time spent JIT-compiling methods
648 and 'stat' to perform sample statistical profiling.
649 If no options are provided the default is 'alloc,time,jit'. 
650 .PP
651 By default the
652 profile data is printed to stdout: to change this, use the 'file=filename'
653 option to output the data to filename.
654 .Sp
655 For example:
656 .nf
657
658         mono --profile program.exe
659
660 .fi
661 .Sp
662 That will run the program with the default profiler and will do time
663 and allocation profiling.
664 .Sp
665 .nf
666
667         mono --profile=default:stat,alloc,file=prof.out program.exe
668
669 .fi
670 Will do  sample statistical profiling and allocation profiling on
671 program.exe. The profile data is put in prof.out.
672 .Sp
673 Note that the statistical profiler has a very low overhead and should
674 be the preferred profiler to use (for better output use the full path
675 to the mono binary when running and make sure you have installed the
676 addr2line utility that comes from the binutils package).
677 .SH LOG PROFILER
678 This is the most advanced profiler.   
679 .PP
680 The Mono \f[I]log\f[] profiler can be used to collect a lot of
681 information about a program running in the Mono runtime.
682 This data can be used (both while the process is running and later)
683 to do analyses of the program behaviour, determine resource usage,
684 performance issues or even look for particular execution patterns.
685 .PP
686 This is accomplished by logging the events provided by the Mono
687 runtime through the profiling interface and periodically writing
688 them to a file which can be later inspected with the mprof-report(1)
689 tool. 
690 .PP
691 More information about how to use the log profiler is available on the
692 mprof-report(1) page. 
693 .SH CUSTOM PROFILERS
694 Mono provides a mechanism for loading other profiling modules which in
695 the form of shared libraries.  These profiling modules can hook up to
696 various parts of the Mono runtime to gather information about the code
697 being executed.
698 .PP
699 To use a third party profiler you must pass the name of the profiler
700 to Mono, like this:
701 .nf
702
703         mono --profile=custom program.exe
704
705 .fi
706 .PP
707 In the above sample Mono will load the user defined profiler from the
708 shared library `mono-profiler-custom.so'.  This profiler module must
709 be on your dynamic linker library path.
710 .PP 
711 A list of other third party profilers is available from Mono's web
712 site (www.mono-project.com/Performance_Tips)
713 .PP
714 Custom profiles are written as shared libraries.  The shared library
715 must be called `mono-profiler-NAME.so' where `NAME' is the name of
716 your profiler.
717 .PP
718 For a sample of how to write your own custom profiler look in the
719 Mono source tree for in the samples/profiler.c.
720 .SH CODE COVERAGE
721 Mono ships with a code coverage module.  This module is activated by
722 using the Mono --profile=cov option.  The format is:
723 \fB--profile=cov[:assembly-name[/namespace]] test-suite.exe\fR
724 .PP
725 By default code coverage will default to all the assemblies loaded,
726 you can limit this by specifying the assembly name, for example to
727 perform code coverage in the routines of your program use, for example
728 the following command line limits the code coverage to routines in the
729 "demo" assembly:
730 .nf
731
732         mono --profile=cov:demo demo.exe
733
734 .fi
735 .PP
736 Notice that the 
737 .I assembly-name
738 does not include the extension.
739 .PP
740 You can further restrict the code coverage output by specifying a
741 namespace:
742 .nf
743
744         mono --profile=cov:demo/My.Utilities demo.exe
745
746 .fi
747 .PP
748 Which will only perform code coverage in the given assembly and
749 namespace.  
750 .PP
751 Typical output looks like this:
752 .nf
753
754         Not covered: Class:.ctor ()
755         Not covered: Class:A ()
756         Not covered: Driver:.ctor ()
757         Not covered: Driver:method ()
758         Partial coverage: Driver:Main ()
759                 offset 0x000a
760
761 .fi
762 .PP
763 The offsets displayed are IL offsets.
764 .PP
765 A more powerful coverage tool is available in the module `monocov'.
766 See the monocov(1) man page for details.
767 .SH DEBUGGING AIDS
768 To debug managed applications, you can use the 
769 .B mdb
770 command, a command line debugger.  
771 .PP
772 It is possible to obtain a stack trace of all the active threads in
773 Mono by sending the QUIT signal to Mono, you can do this from the
774 command line, like this:
775 .nf
776
777         kill -QUIT pid
778
779 .fi
780 Where pid is the Process ID of the Mono process you want to examine.
781 The process will continue running afterwards, but its state is not
782 guaranteed.
783 .PP
784 .B Important:
785 this is a last-resort mechanism for debugging applications and should
786 not be used to monitor or probe a production application.  The
787 integrity of the runtime after sending this signal is not guaranteed
788 and the application might crash or terminate at any given point
789 afterwards.   
790 .PP
791 The \fB--debug=casts\fR option can be used to get more detailed
792 information for Invalid Cast operations, it will provide information
793 about the types involved.   
794 .PP
795 You can use the MONO_LOG_LEVEL and MONO_LOG_MASK environment variables
796 to get verbose debugging output about the execution of your
797 application within Mono.
798 .PP
799 The 
800 .I MONO_LOG_LEVEL
801 environment variable if set, the logging level is changed to the set
802 value. Possible values are "error", "critical", "warning", "message",
803 "info", "debug". The default value is "error". Messages with a logging
804 level greater then or equal to the log level will be printed to
805 stdout/stderr.
806 .PP
807 Use "info" to track the dynamic loading of assemblies.
808 .PP
809 .PP
810 Use the 
811 .I MONO_LOG_MASK
812 environment variable to limit the extent of the messages you get: 
813 If set, the log mask is changed to the set value. Possible values are
814 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
815 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
816 "security" (e.g. Moonlight CoreCLR support) and "all". 
817 The default value is "all". Changing the mask value allows you to display only 
818 messages for a certain component. You can use multiple masks by comma 
819 separating them. For example to see config file messages and assembly loader
820 messages set you mask to "asm,cfg".
821 .PP
822 The following is a common use to track down problems with P/Invoke:
823 .nf
824
825         $ MONO_LOG_LEVEL="debug" MONO_LOG_MASK="dll" mono glue.exe
826
827 .fi
828 .PP
829 .SH SERIALIZATION
830 Mono's XML serialization engine by default will use a reflection-based
831 approach to serialize which might be slow for continuous processing
832 (web service applications).  The serialization engine will determine
833 when a class must use a hand-tuned serializer based on a few
834 parameters and if needed it will produce a customized C# serializer
835 for your types at runtime.  This customized serializer then gets
836 dynamically loaded into your application.
837 .PP
838 You can control this with the MONO_XMLSERIALIZER_THS environment
839 variable.
840 .PP
841 The possible values are 
842 .B `no' 
843 to disable the use of a C# customized
844 serializer, or an integer that is the minimum number of uses before
845 the runtime will produce a custom serializer (0 will produce a
846 custom serializer on the first access, 50 will produce a serializer on
847 the 50th use). Mono will fallback to an interpreted serializer if the
848 serializer generation somehow fails. This behavior can be disabled
849 by setting the option
850 .B `nofallback'
851 (for example: MONO_XMLSERIALIZER_THS=0,nofallback).
852 .SH ENVIRONMENT VARIABLES
853 .TP
854 \fBGC_DONT_GC\fR
855 Turns off the garbage collection in Mono.  This should be only used
856 for debugging purposes
857 .TP
858 \fBLVM_COUNT\fR
859 When Mono is compiled with LLVM support, this instructs the runtime to
860 stop using LLVM after the specified number of methods are JITed.
861 This is a tool used in diagnostics to help isolate problems in the
862 code generation backend.   For example \fBLLVM_COUNT=10\fR would only
863 compile 10 methods with LLVM and then switch to the Mono JIT engine.
864 \fBLLVM_COUNT=0\fR would disable the LLVM engine altogether.
865 .TP
866 \fBMONO_AOT_CACHE\fR
867 If set, this variable will instruct Mono to ahead-of-time compile new
868 assemblies on demand and store the result into a cache in
869 ~/.mono/aot-cache. 
870 .TP
871 \fBMONO_ASPNET_INHIBIT_SETTINGSMAP\fR
872 Mono contains a feature which allows modifying settings in the .config files shipped
873 with Mono by using config section mappers. The mappers and the mapping rules are
874 defined in the $prefix/etc/mono/2.0/settings.map file and, optionally, in the
875 settings.map file found in the top-level directory of your ASP.NET application.
876 Both files are read by System.Web on application startup, if they are found at the
877 above locations. If you don't want the mapping to be performed you can set this
878 variable in your environment before starting the application and no action will
879 be taken.
880 .TP
881 \fBMONO_CFG_DIR\fR
882 If set, this variable overrides the default system configuration directory
883 ($PREFIX/etc). It's used to locate machine.config file.
884 .TP
885 \fBMONO_COM\fR
886 Sets the style of COM interop.  If the value of this variable is "MS"
887 Mono will use string marhsalling routines from the liboleaut32 for the
888 BSTR type library, any other values will use the mono-builtin BSTR
889 string marshalling.
890 .TP
891 \fBMONO_CONFIG\fR
892 If set, this variable overrides the default runtime configuration file
893 ($PREFIX/etc/mono/config). The --config command line options overrides the
894 environment variable.
895 .TP
896 \fBMONO_CPU_ARCH\fR
897 Override the automatic cpu detection mechanism. Currently used only on arm.
898 The format of the value is as follows:
899 .nf
900
901         "armvV [thumb]"
902
903 .fi
904 where V is the architecture number 4, 5, 6, 7 and the options can be currently be
905 "thunb". Example:
906 .nf
907
908         MONO_CPU_ARCH="armv4 thumb" mono ...
909
910 .fi
911 .TP
912 \fBMONO_DISABLE_AIO\fR
913 If set, tells mono NOT to attempt using native asynchronous I/O services. In
914 that case, a default select/poll implementation is used. Currently only epoll()
915 is supported.
916 .TP
917 \fBMONO_DISABLE_MANAGED_COLLATION\fR
918 If this environment variable is `yes', the runtime uses unmanaged
919 collation (which actually means no culture-sensitive collation). It
920 internally disables managed collation functionality invoked via the
921 members of System.Globalization.CompareInfo class. Collation is
922 enabled by default.
923 .TP
924 \fBMONO_DISABLE_SHM\fR
925 Unix only: If set, disables the shared memory files used for
926 cross-process handles: process have only private handles.  This means
927 that process and thread handles are not available to other processes,
928 and named mutexes, named events and named semaphores are not visible
929 between processes.
930 .Sp
931 This is can also be enabled by default by passing the
932 "--disable-shared-handles" option to configure.
933 .Sp
934 This is the default from mono 2.8 onwards.
935 .TP
936 \fBMONO_DNS\fR
937 When set, enables the use of a fully managed DNS resolver instead of the
938 regular libc functions. This resolver performs much better when multiple
939 queries are run in parallel.
940
941 Note that /etc/nsswitch.conf will be ignored.
942 .TP
943 \fBMONO_EGD_SOCKET\fR
944 For platforms that do not otherwise have a way of obtaining random bytes
945 this can be set to the name of a file system socket on which an egd or
946 prngd daemon is listening.
947 .TP
948 \fBMONO_ENABLE_SHM\fR
949 Unix only: Enable support for cross-process handles.  Cross-process
950 handles are used to expose process handles, thread handles, named
951 mutexes, named events and named semaphores across Unix processes.
952 .TP
953 \fBMONO_ENV_OPTIONS\fR
954 This environment variable allows you to pass command line arguments to
955 a Mono process through the environment.   This is useful for example
956 to force all of your Mono processes to use LLVM or SGEN without having
957 to modify any launch scripts.
958 .TP
959 \fBMONO_EVENTLOG_TYPE\fR
960 Sets the type of event log provider to use (for System.Diagnostics.EventLog).
961 .Sp
962 Possible values are:
963 .RS
964 .TP
965 .I "local[:path]"
966 .Sp
967 Persists event logs and entries to the local file system.
968 .Sp
969 The directory in which to persist the event logs, event sources and entries
970 can be specified as part of the value.
971 .Sp
972 If the path is not explicitly set, it defaults to "/var/lib/mono/eventlog"
973 on unix and "%APPDATA%\mono\eventlog" on Windows.
974 .TP
975 .I "win32"
976 .Sp
977 .B 
978 Uses the native win32 API to write events and registers event logs and
979 event sources in the registry.   This is only available on Windows. 
980 .Sp
981 On Unix, the directory permission for individual event log and event source
982 directories is set to 777 (with +t bit) allowing everyone to read and write
983 event log entries while only allowing entries to be deleted by the user(s)
984 that created them.
985 .TP
986 .I "null"
987 .Sp
988 Silently discards any events.
989 .ne
990 .PP
991 The default is "null" on Unix (and versions of Windows before NT), and 
992 "win32" on Windows NT (and higher).
993 .RE
994 .TP
995 \fBMONO_EXTERNAL_ENCODINGS\fR
996 If set, contains a colon-separated list of text encodings to try when
997 turning externally-generated text (e.g. command-line arguments or
998 filenames) into Unicode.  The encoding names come from the list
999 provided by iconv, and the special case "default_locale" which refers
1000 to the current locale's default encoding.
1001 .IP
1002 When reading externally-generated text strings UTF-8 is tried first,
1003 and then this list is tried in order with the first successful
1004 conversion ending the search.  When writing external text (e.g. new
1005 filenames or arguments to new processes) the first item in this list
1006 is used, or UTF-8 if the environment variable is not set.
1007 .IP
1008 The problem with using MONO_EXTERNAL_ENCODINGS to process your
1009 files is that it results in a problem: although its possible to get
1010 the right file name it is not necessarily possible to open the file.
1011 In general if you have problems with encodings in your filenames you
1012 should use the "convmv" program.
1013 .TP
1014 \fBMONO_GC_PARAMS\fR
1015 When using Mono with the SGen garbage collector this variable controls
1016 several parameters of the collector.  The variable's value is a comma
1017 separated list of words.
1018 .RS
1019 .ne 8
1020 .TP
1021 \fBnursery-size=\fIsize\fR
1022 Sets the size of the nursery.  The size is specified in bytes and must
1023 be a power of two.  The suffixes `k', `m' and `g' can be used to
1024 specify kilo-, mega- and gigabytes, respectively.  The nursery is the
1025 first generation (of two).  A larger nursery will usually speed up the
1026 program but will obviously use more memory.  The default nursery size
1027 4 MB.
1028 .TP
1029 \fBmajor=\fIcollector\fR
1030 Specifies which major collector to use.  Options are `marksweep' for
1031 the Mark&Sweep collector, `marksweep-par' for parallel Mark&Sweep,
1032 `marksweep-fixed' for Mark&Sweep with a fixed heap,
1033 `marksweep-fixed-par' for parallel Mark&Sweep with a fixed heap and
1034 `copying' for the copying collector. The Mark&Sweep collector is the
1035 default.
1036 .TP
1037 \fBmajor-heap-size=\fIsize\fR
1038 Sets the size of the major heap (not including the large object space)
1039 for the fixed-heap Mark&Sweep collector (i.e. `marksweep-fixed' and
1040 `marksweep-fixed-par').  The size is in bytes, with optional suffixes
1041 `k', `m' and `g' to specify kilo-, mega- and gigabytes, respectively.
1042 The default is 512 megabytes.
1043 .TP
1044 \fBsoft-heap-limit=\fIsize\fR
1045 Once the heap size gets larger than this size, ignore what the default
1046 major collection trigger metric says and only allow four nursery size's
1047 of major heap growth between major collections.
1048 .TP
1049 \fBwbarrier=\fIwbarrier\fR
1050 Specifies which write barrier to use.  Options are `cardtable' and
1051 `remset'.  The card table barrier is faster but less precise, and only
1052 supported for the Mark&Sweep major collector on 32 bit platforms.  The
1053 default is `cardtable' if it is supported, otherwise `remset'. The cardtable
1054 write barrier is faster and has a more stable and usually smaller
1055 memory footprint. If the program causes too much pinning during
1056 thread scan, it might be faster to enable remset.
1057 .TP
1058 \fBevacuation-threshold=\fIthreshold\fR
1059 Sets the evacuation threshold in percent.  This option is only available
1060 on the Mark&Sweep major collectors.  The value must be an
1061 integer in the range 0 to 100.  The default is 66.  If the sweep phase of
1062 the collection finds that the occupancy of a specific heap block type is
1063 less than this percentage, it will do a copying collection for that block
1064 type in the next major collection, thereby restoring occupancy to close
1065 to 100 percent.  A value of 0 turns evacuation off.
1066 .TP
1067 \fB(no-)concurrent-sweep\fR
1068 Enables or disables concurrent sweep for the Mark&Sweep collector.  If
1069 enabled, the sweep phase of the garbage collection is done in a thread
1070 concurrently with the application.  Concurrent sweep is disabled by
1071 default.
1072 .TP
1073 \fBstack-mark=\fImark-mode\fR
1074 Specifies how application threads should be scanned. Options are
1075 `precise` and `conservative`. Precise marking allow the collector
1076 to know what values on stack are references and what are not.
1077 Conservative marking threats all values as potentially references
1078 and leave them untouched. Precise marking reduces floating garbage
1079 and can speed up nursery collection and allocation rate, it has
1080 the downside of requiring a significant extra memory per compiled
1081 method. The right option, unfortunately, requires experimentation.
1082 .ne
1083 .RE
1084 .TP
1085 \fBMONO_GC_DEBUG\fR
1086 When using Mono with the SGen garbage collector this environment
1087 variable can be used to turn on various debugging features of the
1088 collector.  The value of this variable is a comma separated list of
1089 words.  Do not use these options in production.
1090 .RS
1091 .ne 8
1092 .TP
1093 \fInumber\fR
1094 Sets the debug level to the specified number.
1095 .TP
1096 \fBprint-allowance\fR
1097 After each major collection prints memory consumption for before and
1098 after the collection and the allowance for the minor collector, i.e. how
1099 much the heap is allowed to grow from minor collections before the next
1100 major collection is triggered.
1101 .TP
1102 \fBprint-pinning\fR
1103 Gathers statistics on the classes whose objects are pinned in the
1104 nursery and for which global remset entries are added.  Prints those
1105 statistics when shutting down.
1106 .TP
1107 \fBcollect-before-allocs\fR
1108 .TP
1109 \fBcheck-at-minor-collections\fR
1110 This performs a consistency check on minor collections and also clears
1111 the nursery at collection time, instead of the default, when buffers
1112 are allocated (clear-at-gc).   The consistency check ensures that
1113 there are no major to minor references that are not on the remembered
1114 sets. 
1115 .TP
1116 \fBxdomain-checks\fR
1117 Performs a check to make sure that no references are left to an
1118 unloaded AppDomain.
1119 .TP
1120 \fBclear-at-gc\fR
1121 This clears the nursery at GC time instead of doing it when the thread
1122 local allocation buffer (TLAB) is created.  The default is to clear
1123 the nursery at TLAB creation time.
1124 .TP
1125 \fBdisable-minor\fR
1126 Don't do minor collections.  If the nursery is full, a major collection
1127 is triggered instead, unless it, too, is disabled.
1128 .TP
1129 \fBdisable-major\fR
1130 Don't do major collections.
1131 .TP
1132 \fBconservative-stack-mark\fR
1133 Forces the GC to scan the stack conservatively, even if precise
1134 scanning is available.
1135 .TP
1136 \fBcheck-scan-starts\fR
1137 If set, does a plausibility check on the scan_starts before and after each collection
1138 .TP
1139 \fBverify-nursery-at-minor-gc\fR
1140 If set, does a complete object walk of the nursery at the start of each minor collection.
1141 .TP
1142 \fBdump-nursery-at-minor-gc\fR
1143 If set, dumps the contents of the nursery at the start of each minor collection. Requires 
1144 verify-nursery-at-minor-gc to be set.
1145 .TP
1146 \fBheap-dump=\fIfile\fR
1147 Dumps the heap contents to the specified file.   To visualize the
1148 information, use the mono-heapviz tool.
1149 .TP
1150 \fBbinary-protocol=\fIfile\fR
1151 Outputs the debugging output to the specified file.   For this to
1152 work, Mono needs to be compiled with the BINARY_PROTOCOL define on
1153 sgen-gc.c.   You can then use this command to explore the output
1154 .nf
1155                 sgen-grep-binprot 0x1234 0x5678 < file
1156 .fi
1157 .ne
1158 .RE
1159 .TP
1160 \fBMONO_GAC_PREFIX\fR
1161 Provides a prefix the runtime uses to look for Global Assembly Caches.
1162 Directories are separated by the platform path separator (colons on
1163 unix). MONO_GAC_PREFIX should point to the top directory of a prefixed
1164 install. Or to the directory provided in the gacutil /gacdir command. Example:
1165 .B /home/username/.mono:/usr/local/mono/
1166 .TP
1167 \fBMONO_IOMAP\fR
1168 Enables some filename rewriting support to assist badly-written
1169 applications that hard-code Windows paths.  Set to a colon-separated
1170 list of "drive" to strip drive letters, or "case" to do
1171 case-insensitive file matching in every directory in a path.  "all"
1172 enables all rewriting methods.  (Backslashes are always mapped to
1173 slashes if this variable is set to a valid option).
1174 .fi
1175 .Sp
1176 For example, this would work from the shell:
1177 .nf
1178
1179         MONO_IOMAP=drive:case
1180         export MONO_IOMAP
1181
1182 .fi
1183 If you are using mod_mono to host your web applications, you can use
1184 the 
1185 .B MonoIOMAP
1186 directive instead, like this:
1187 .nf
1188
1189         MonoIOMAP <appalias> all
1190
1191 .fi
1192 See mod_mono(8) for more details.
1193
1194 Additionally. Mono includes a profiler module which allows one to track what
1195 adjustements to file paths IOMAP code needs to do. The tracking code reports
1196 the managed location (full stack trace) from which the IOMAP-ed call was made and,
1197 on process exit, the locations where all the IOMAP-ed strings were created in
1198 managed code. The latter report is only approximate as it is not always possible
1199 to estimate the actual location where the string was created. The code uses simple
1200 heuristics - it analyzes stack trace leading back to the string allocation location
1201 and ignores all the managed code which lives in assemblies installed in GAC as well as in the
1202 class libraries shipped with Mono (since they are assumed to be free of case-sensitivity
1203 issues). It then reports the first location in the user's code - in most cases this will be
1204 the place where the string is allocated or very close to the location. The reporting code
1205 is implemented as a custom profiler module (see the "PROFILING" section) and can be loaded
1206 in the following way:
1207 .fi
1208 .Sp
1209 .nf
1210
1211         mono --profile=iomap yourapplication.exe
1212
1213 .fi
1214 Note, however, that Mono currently supports only one profiler module
1215 at a time.
1216 .TP
1217 \fBMONO_LLVM\fR
1218 When Mono is using the LLVM code generation backend you can use this
1219 environment variable to pass code generation options to the LLVM
1220 compiler.   
1221 .TP
1222 \fBMONO_MANAGED_WATCHER\fR
1223 If set to "disabled", System.IO.FileSystemWatcher will use a file watcher 
1224 implementation which silently ignores all the watching requests.
1225 If set to any other value, System.IO.FileSystemWatcher will use the default
1226 managed implementation (slow). If unset, mono will try to use inotify, FAM, 
1227 Gamin, kevent under Unix systems and native API calls on Windows, falling 
1228 back to the managed implementation on error.
1229 .TP
1230 \fBMONO_MESSAGING_PROVIDER\fR
1231 Mono supports a plugin model for its implementation of System.Messaging making
1232 it possible to support a variety of messaging implementations (e.g. AMQP, ActiveMQ).
1233 To specify which messaging implementation is to be used the evironement variable
1234 needs to be set to the full class name for the provider.  E.g. to use the RabbitMQ based
1235 AMQP implementation the variable should be set to:
1236
1237 .nf
1238 Mono.Messaging.RabbitMQ.RabbitMQMessagingProvider,Mono.Messaging.RabbitMQ
1239 .TP
1240 \fBMONO_NO_SMP\fR
1241 If set causes the mono process to be bound to a single processor. This may be
1242 useful when debugging or working around race conditions.
1243 .TP
1244 \fBMONO_NO_TLS\fR
1245 Disable inlining of thread local accesses. Try setting this if you get a segfault
1246 early on in the execution of mono.
1247 .TP
1248 \fBMONO_PATH\fR
1249 Provides a search path to the runtime where to look for library
1250 files.   This is a tool convenient for debugging applications, but
1251 should not be used by deployed applications as it breaks the assembly
1252 loader in subtle ways. 
1253 .Sp
1254 Directories are separated by the platform path separator (colons on unix). Example:
1255 .B /home/username/lib:/usr/local/mono/lib
1256 .Sp
1257 Alternative solutions to MONO_PATH include: installing libraries into
1258 the Global Assembly Cache (see gacutil(1)) or having the dependent
1259 libraries side-by-side with the main executable.
1260 .Sp
1261 For a complete description of recommended practices for application
1262 deployment, see
1263 http://www.mono-project.com/Guidelines:Application_Deployment
1264 .TP
1265 \fBMONO_RTC\fR
1266 Experimental RTC support in the statistical profiler: if the user has
1267 the permission, more accurate statistics are gathered.  The MONO_RTC
1268 value must be restricted to what the Linux rtc allows: power of two
1269 from 64 to 8192 Hz. To enable higher frequencies like 4096 Hz, run as root:
1270 .nf
1271
1272         echo 4096 > /proc/sys/dev/rtc/max-user-freq
1273
1274 .fi
1275 .Sp
1276 For example:
1277 .nf
1278
1279         MONO_RTC=4096 mono --profiler=default:stat program.exe
1280
1281 .fi
1282 .TP 
1283 \fBMONO_SHARED_DIR\fR
1284 If set its the directory where the ".wapi" handle state is stored.
1285 This is the directory where the Windows I/O Emulation layer stores its
1286 shared state data (files, events, mutexes, pipes).  By default Mono
1287 will store the ".wapi" directory in the users's home directory.
1288 .TP 
1289 \fBMONO_SHARED_HOSTNAME\fR
1290 Uses the string value of this variable as a replacement for the host name when
1291 creating file names in the ".wapi" directory. This helps if the host name of
1292 your machine is likely to be changed when a mono application is running or if
1293 you have a .wapi directory shared among several different computers.
1294 .Sp
1295 Mono typically uses the hostname to create the files that are used to
1296 share state across multiple Mono processes.  This is done to support
1297 home directories that might be shared over the network.
1298 .TP
1299 \fBMONO_STRICT_IO_EMULATION\fR
1300 If set, extra checks are made during IO operations.  Currently, this
1301 includes only advisory locks around file writes.
1302 .TP
1303 \fBMONO_THEME\fR
1304 The name of the theme to be used by Windows.Forms.   Available themes today
1305 include "clearlooks", "nice" and "win32".
1306 .Sp
1307 The default is "win32".  
1308 .TP
1309 \fBMONO_TLS_SESSION_CACHE_TIMEOUT\fR
1310 The time, in seconds, that the SSL/TLS session cache will keep it's entry to
1311 avoid a new negotiation between the client and a server. Negotiation are very
1312 CPU intensive so an application-specific custom value may prove useful for 
1313 small embedded systems.
1314 .Sp
1315 The default is 180 seconds.
1316 .TP
1317 \fBMONO_THREADS_PER_CPU\fR
1318 The maximum number of threads in the general threadpool will be
1319 20 + (MONO_THREADS_PER_CPU * number of CPUs). The default value for this
1320 variable is 10.
1321 .TP
1322 \fBMONO_XMLSERIALIZER_THS\fR
1323 Controls the threshold for the XmlSerializer to produce a custom
1324 serializer for a given class instead of using the Reflection-based
1325 interpreter.  The possible values are `no' to disable the use of a
1326 custom serializer or a number to indicate when the XmlSerializer
1327 should start serializing.   The default value is 50, which means that
1328 the a custom serializer will be produced on the 50th use.
1329 .TP
1330 \fBMONO_X509_REVOCATION_MODE\fR
1331 Sets the revocation mode used when validating a X509 certificate chain (https,
1332 ftps, smtps...).  The default is 'nocheck', which performs no revocation check
1333 at all. The other possible values are 'offline', which performs CRL check (not
1334 implemented yet) and 'online' which uses OCSP and CRL to verify the revocation
1335 status (not implemented yet).
1336 .SH ENVIRONMENT VARIABLES FOR DEBUGGING
1337 .TP
1338 \fBMONO_ASPNET_NODELETE\fR
1339 If set to any value, temporary source files generated by ASP.NET support
1340 classes will not be removed. They will be kept in the user's temporary
1341 directory.
1342 .TP
1343 \fBMONO_DEBUG\fR
1344 If set, enables some features of the runtime useful for debugging.
1345 This variable should contain a comma separated list of debugging options.
1346 Currently, the following options are supported:
1347 .RS
1348 .ne 8
1349 .TP
1350 \fBbreak-on-unverified\fR
1351 If this variable is set, when the Mono VM runs into a verification
1352 problem, instead of throwing an exception it will break into the
1353 debugger.  This is useful when debugging verifier problems
1354 .TP
1355 \fBcasts\fR
1356 This option can be used to get more detailed information from
1357 InvalidCast exceptions, it will provide information about the types
1358 involved.     
1359 .TP
1360 \fBcollect-pagefault-stats\fR
1361 Collects information about pagefaults.   This is used internally to
1362 track the number of page faults produced to load metadata.  To display
1363 this information you must use this option with "--stats" command line
1364 option.
1365 .TP
1366 \fBdont-free-domains\fR
1367 This is an Optimization for multi-AppDomain applications (most
1368 commonly ASP.NET applications).  Due to internal limitations Mono,
1369 Mono by default does not use typed allocations on multi-appDomain
1370 applications as they could leak memory when a domain is unloaded. 
1371 .Sp
1372 Although this is a fine default, for applications that use more than
1373 on AppDomain heavily (for example, ASP.NET applications) it is worth
1374 trading off the small leaks for the increased performance
1375 (additionally, since ASP.NET applications are not likely going to
1376 unload the application domains on production systems, it is worth
1377 using this feature). 
1378 .TP
1379 \fBdyn-runtime-invoke\fR
1380 Instructs the runtime to try to use a generic runtime-invoke wrapper
1381 instead of creating one invoke wrapper.
1382 .TP
1383 \fBgdb\fR 
1384 Equivalent to setting the \fBMONO_XDEBUG\fR variable, this emits
1385 symbols into a shared library as the code is JITed that can be loaded
1386 into GDB to inspect symbols.
1387 .TP
1388 \fBgen-seq-points\fR 
1389 Automatically generates sequence points where the
1390 IL stack is empty.  These are places where the debugger can set a
1391 breakpoint.
1392 .TP
1393 \fBexplicit-null-checks\fR
1394 Makes the JIT generate an explicit NULL check on variable dereferences
1395 instead of depending on the operating system to raise a SIGSEGV or
1396 another form of trap event when an invalid memory location is
1397 accessed. 
1398 .TP
1399 \fBhandle-sigint\fR
1400 Captures the interrupt signal (Control-C) and displays a stack trace
1401 when pressed.  Useful to find out where the program is executing at a
1402 given point.  This only displays the stack trace of a single thread. 
1403 .TP
1404 \fBinit-stacks\FR 
1405 Instructs the runtime to initialize the stack with
1406 some known values (0x2a on x86-64) at the start of a method to assist
1407 in debuggin the JIT engine.
1408 .TP
1409 \fBkeep-delegates\fR
1410 This option will leak delegate trampolines that are no longer
1411 referenced as to present the user with more information about a
1412 delegate misuse.  Basically a delegate instance might be created,
1413 passed to unmanaged code, and no references kept in managed code,
1414 which will garbage collect the code.  With this option it is possible
1415 to track down the source of the problems. 
1416 .TP
1417 \fBreverse-pinvoke-exceptions
1418 This option will cause mono to abort with a descriptive message when
1419 during stack unwinding after an exception it reaches a native stack
1420 frame. This happens when a managed delegate is passed to native code,
1421 and the managed delegate throws an exception. Mono will normally try
1422 to unwind the stack to the first (managed) exception handler, and it
1423 will skip any native stack frames in the process. This leads to 
1424 undefined behaviour (since mono doesn't know how to process native
1425 frames), leaks, and possibly crashes too.
1426 .TP
1427 \fBno-gdb-backtrace\fR
1428 This option will disable the GDB backtrace emitted by the runtime
1429 after a SIGSEGV or SIGABRT in unmanaged code.
1430 .TP
1431 \fBsuspend-on-sigsegv\fR
1432 This option will suspend the program when a native SIGSEGV is received.
1433 This is useful for debugging crashes which do not happen under gdb,
1434 since a live process contains more information than a core file.
1435 .ne
1436 .RE
1437 .TP
1438 \fBMONO_LOG_LEVEL\fR
1439 The logging level, possible values are `error', `critical', `warning',
1440 `message', `info' and `debug'.  See the DEBUGGING section for more
1441 details.
1442 .TP
1443 \fBMONO_LOG_MASK\fR
1444 Controls the domain of the Mono runtime that logging will apply to. 
1445 If set, the log mask is changed to the set value. Possible values are
1446 "asm" (assembly loader), "type", "dll" (native library loader), "gc"
1447 (garbage collector), "cfg" (config file loader), "aot" (precompiler),
1448 "security" (e.g. Moonlight CoreCLR support) and "all". 
1449 The default value is "all". Changing the mask value allows you to display only 
1450 messages for a certain component. You can use multiple masks by comma 
1451 separating them. For example to see config file messages and assembly loader
1452 messages set you mask to "asm,cfg".
1453 .TP
1454 \fBMONO_TRACE\fR
1455 Used for runtime tracing of method calls. The format of the comma separated
1456 trace options is:
1457 .nf
1458
1459         [-]M:method name
1460         [-]N:namespace
1461         [-]T:class name
1462         [-]all
1463         [-]program
1464         disabled                Trace output off upon start.
1465
1466 .fi
1467 You can toggle trace output on/off sending a SIGUSR2 signal to the program.
1468 .TP
1469 \fBMONO_TRACE_LISTENER\fR
1470 If set, enables the System.Diagnostics.DefaultTraceListener, which will 
1471 print the output of the System.Diagnostics Trace and Debug classes.  
1472 It can be set to a filename, and to Console.Out or Console.Error to display
1473 output to standard output or standard error, respectively. If it's set to
1474 Console.Out or Console.Error you can append an optional prefix that will
1475 be used when writing messages like this: Console.Error:MyProgramName.
1476 See the System.Diagnostics.DefaultTraceListener documentation for more
1477 information.
1478 .TP
1479 \fBMONO_WCF_TRACE\fR
1480 This eases WCF diagnostics functionality by simply outputs all log messages from WCF engine to "stdout", "stderr" or any file passed to this environment variable. The log format is the same as usual diagnostic output.
1481 .TP
1482 \fBMONO_XEXCEPTIONS\fR
1483 This throws an exception when a X11 error is encountered; by default a
1484 message is displayed but execution continues
1485 .TP
1486 \fBMONO_XMLSERIALIZER_DEBUG\fR
1487 Set this value to 1 to prevent the serializer from removing the
1488 temporary files that are created for fast serialization;  This might
1489 be useful when debugging.
1490 .TP
1491 \fBMONO_XSYNC\fR
1492 This is used in the System.Windows.Forms implementation when running
1493 with the X11 backend.  This is used to debug problems in Windows.Forms
1494 as it forces all of the commands send to X11 server to be done
1495 synchronously.   The default mode of operation is asynchronous which
1496 makes it hard to isolate the root of certain problems.
1497 .TP
1498 \fBMONO_GENERIC_SHARING\fR
1499 This environment variable controls the kind of generic sharing used.
1500 This variable is used by internal JIT developers and should not be
1501 changed in production.  Do not use it.
1502 .Sp
1503 The variable controls which classes will have generic code sharing
1504 enabled.
1505 .Sp
1506 Permissible values are:
1507 .RS
1508 .TP 
1509 .I "all" 
1510 All generated code can be shared. 
1511 .TP
1512 .I "collections" 
1513 Only the classes in System.Collections.Generic will have its code
1514 shared (this is the default value).
1515 .TP
1516 .I "corlib"
1517 Only code in corlib will have its code shared.
1518 .TP
1519 .I "none"
1520 No generic code sharing will be performed.
1521 .RE
1522 .Sp
1523 Generic code sharing by default only applies to collections.   The
1524 Mono JIT by default turns this on.
1525 .TP
1526 \fBMONO_XDEBUG\fR
1527 When the the MONO_XDEBUG env var is set, debugging info for JITted
1528 code is emitted into a shared library, loadable into gdb. This enables,
1529 for example, to see managed frame names on gdb backtraces.   
1530 .TP
1531 \fBMONO_VERBOSE_METHOD\fR
1532 Enables the maximum JIT verbosity for the specified method. This is
1533 very helpfull to diagnose a miscompilation problems of a specific
1534 method.
1535 .SH VALGRIND
1536 If you want to use Valgrind, you will find the file `mono.supp'
1537 useful, it contains the suppressions for the GC which trigger
1538 incorrect warnings.  Use it like this:
1539 .nf
1540     valgrind --suppressions=mono.supp mono ...
1541 .fi
1542 .SH DTRACE
1543 On some platforms, Mono can expose a set of DTrace probes (also known
1544 as user-land statically defined, USDT Probes).
1545 .TP
1546 They are defined in the file `mono.d'.
1547 .TP
1548 .B ves-init-begin, ves-init-end
1549 .Sp
1550 Begin and end of runtime initialization.
1551 .TP
1552 .B method-compile-begin, method-compile-end
1553 .Sp
1554 Begin and end of method compilation.
1555 The probe arguments are class name, method name and signature,
1556 and in case of method-compile-end success or failure of compilation.
1557 .TP
1558 .B gc-begin, gc-end
1559 .Sp
1560 Begin and end of Garbage Collection.
1561 .TP
1562 To verify the availability of the probes, run:
1563 .nf
1564     dtrace -P mono'$target' -l -c mono
1565 .fi
1566 .SH PERMISSIONS
1567 Mono's Ping implementation for detecting network reachability can
1568 create the ICMP packets itself without requiring the system ping
1569 command to do the work.  If you want to enable this on Linux for
1570 non-root users, you need to give the Mono binary special permissions.
1571 .PP
1572 As root, run this command:
1573 .nf
1574    # setcap cap_net_raw=+ep /usr/bin/mono
1575 .fi
1576 .SH FILES
1577 On Unix assemblies are loaded from the installation lib directory.  If you set
1578 `prefix' to /usr, the assemblies will be located in /usr/lib.  On
1579 Windows, the assemblies are loaded from the directory where mono and
1580 mint live.
1581 .TP
1582 .B ~/.mono/aot-cache
1583 .Sp
1584 The directory for the ahead-of-time compiler demand creation
1585 assemblies are located. 
1586 .TP
1587 .B /etc/mono/config, ~/.mono/config
1588 .Sp
1589 Mono runtime configuration file.  See the mono-config(5) manual page
1590 for more information.
1591 .TP
1592 .B ~/.config/.mono/certs, /usr/share/.mono/certs
1593 .Sp
1594 Contains Mono certificate stores for users / machine. See the certmgr(1) 
1595 manual page for more information on managing certificate stores and
1596 the mozroots(1) page for information on how to import the Mozilla root
1597 certificates into the Mono certificate store. 
1598 .TP
1599 .B ~/.mono/assemblies/ASSEMBLY/ASSEMBLY.config
1600 .Sp
1601 Files in this directory allow a user to customize the configuration
1602 for a given system assembly, the format is the one described in the
1603 mono-config(5) page. 
1604 .TP
1605 .B ~/.config/.mono/keypairs, /usr/share/.mono/keypairs
1606 .Sp
1607 Contains Mono cryptographic keypairs for users / machine. They can be 
1608 accessed by using a CspParameters object with DSACryptoServiceProvider
1609 and RSACryptoServiceProvider classes.
1610 .TP
1611 .B ~/.config/.isolatedstorage, ~/.local/share/.isolatedstorage, /usr/share/.isolatedstorage
1612 .Sp
1613 Contains Mono isolated storage for non-roaming users, roaming users and 
1614 local machine. Isolated storage can be accessed using the classes from 
1615 the System.IO.IsolatedStorage namespace.
1616 .TP
1617 .B <assembly>.config
1618 .Sp
1619 Configuration information for individual assemblies is loaded by the
1620 runtime from side-by-side files with the .config files, see the
1621 http://www.mono-project.com/Config for more information.
1622 .TP
1623 .B Web.config, web.config
1624 .Sp
1625 ASP.NET applications are configured through these files, the
1626 configuration is done on a per-directory basis.  For more information
1627 on this subject see the http://www.mono-project.com/Config_system.web
1628 page. 
1629 .SH MAILING LISTS
1630 Mailing lists are listed at the
1631 http://www.mono-project.com/Mailing_Lists
1632 .SH WEB SITE
1633 http://www.mono-project.com
1634 .SH SEE ALSO
1635 .PP
1636 certmgr(1), csharp(1), mcs(1), mdb(1), monocov(1), monodis(1),
1637 mono-config(5), mozroots(1), mprof-report(1), pdb2mdb(1), xsp(1), mod_mono(8).
1638 .PP
1639 For more information on AOT:
1640 http://www.mono-project.com/AOT
1641 .PP
1642 For ASP.NET-related documentation, see the xsp(1) manual page