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