Chapter 11 Native-code compilation (ocamlopt)
This chapter describes the OCaml high-performance
native-code compiler ocamlopt, which compiles OCaml source files to
native code object files and link these object files to produce
The native-code compiler is only available on certain platforms.
It produces code that runs faster than the bytecode produced by
ocamlc, at the cost of increased compilation time and executable code
size. Compatibility with the bytecode compiler is extremely high: the
same source code should run identically when compiled with ocamlc and
It is not possible to mix native-code object files produced by ocamlopt
with bytecode object files produced by ocamlc: a program must be
compiled entirely with ocamlopt or entirely with ocamlc. Native-code
object files produced by ocamlopt cannot be loaded in the toplevel
11.1 Overview of the compiler
The ocamlopt command has a command-line interface very close to that
of ocamlc. It accepts the same types of arguments, and processes them
sequentially, after all options have been processed:
The output of the linking phase is a regular Unix or Windows
executable file. It does not need ocamlrun to run.
The following command-line options are recognized by ocamlopt.
The options -pack, -a, -shared, -c and -output-obj are mutually
Build a library(.cmxa and .a/.lib files)
with the object files (.cmx and .o/.obj files)
given on the command line, instead of linking them into an executable file.
The name of the library must be set with the -o option.
If -cclib or -ccopt options are passed on the command
line, these options are stored in the resulting .cmxalibrary. Then,
linking with this library automatically adds back the
-cclib and -ccopt options as if they had been provided on the
command line, unless the -noautolink option is given.
Force error messages to show absolute paths for file names.
Dump detailed information about the compilation (types, bindings,
tail-calls, etc). The information for file src.ml
is put into file src.annot. In case of a type error, dump
all the information inferred by the type-checker before the error.
The src.annot file can be used with the emacs commands given in
emacs/caml-types.el to display types and other annotations
- -args filename
Read additional newline-terminated command line arguments from filename.
- -args0 filename
Read additional null character terminated command line arguments from filename.
Dump detailed information about the compilation (types, bindings,
tail-calls, etc) in binary format. The information for file src.ml
is put into file src.cmt. In case of a type error, dump
all the information inferred by the type-checker before the error.
The *.cmt files produced by -bin-annot contain more information
and are much more compact than the files produced by -annot.
Compile only. Suppress the linking phase of the
compilation. Source code files are turned into compiled files, but no
executable file is produced. This option is useful to
compile modules separately.
- -cc ccomp
Use ccomp as the C linker called to build the final executable
and as the C compiler for compiling .c source files.
- -cclib -llibname
Pass the -llibname option to the linker
This causes the given C library to be linked with the program.
- -ccopt option
Pass the given option to the C compiler and linker.
For instance,-ccopt -Ldir causes the C linker to search for C libraries in
- -color mode
Enable or disable colors in compiler messages (especially warnings and errors).
The following modes are supported:
The default setting is ’auto’, and the current heuristic
checks that the TERM environment variable exists and is
not empty or dumb, and that ’isatty(stderr)’ holds.
- use heuristics to enable colors only if the output supports them (an ANSI-compatible tty terminal);
- enable colors unconditionally;
- disable color output.
The environment variable OCAML_COLOR is considered if -color is not
provided. Its values are auto/always/never as above.
Optimize the produced code for space rather than for time. This
results in slightly smaller but slightly slower programs. The default is to
optimize for speed.
Print the version number of ocamlopt and a detailed
summary of its configuration, then exit.
- -for-pack module-path
Generate an object file (.cmx and .o/.obj files)
that can later be included
as a sub-module (with the given access path) of a compilation unit
constructed with -pack. For instance,
ocamlopt -for-pack P -c A.ml
will generate a..cmx and a.o files that can
later be used with ocamlopt -pack -o P.cmx a.cmx.
Note: you can still pack a module that was compiled without
-for-pack but in this case exceptions will be printed with the wrong
Add debugging information while compiling and linking. This option is
required in order to produce stack backtraces when
the program terminates on an uncaught exception (see
Cause the compiler to print all defined names (with their inferred
types or their definitions) when compiling an implementation (.ml
file). No compiled files (.cmo and .cmi files) are produced.
This can be useful to check the types inferred by the
compiler. Also, since the output follows the syntax of interfaces, it
can help in writing an explicit interface (.mli file) for a file:
just redirect the standard output of the compiler to a .mli file,
and edit that file to remove all declarations of unexported names.
- -I directory
Add the given directory to the list of directories searched for
compiled interface files (.cmi), compiled object code files (.cmx),
and libraries (.cmxa).
By default, the current directory is searched first, then the standard
library directory. Directories added with -I are searched after the
current directory, in the order in which they were given on the command line,
but before the standard library directory. See also option -nostdlib.
If the given directory starts with +, it is taken relative to the
standard library directory. For instance, -I +labltk adds the
subdirectory labltk of the standard library to the search path.
- -impl filename
Compile the file filename as an implementation file, even if its
extension is not .ml.
- -inline n
Set aggressiveness of inlining to n, where n is a positive
integer. Specifying -inline 0 prevents all functions from being
inlined, except those whose body is smaller than the call site. Thus,
inlining causes no expansion in code size. The default aggressiveness,
-inline 1, allows slightly larger functions to be inlined, resulting
in a slight expansion in code size. Higher values for the -inline
option cause larger and larger functions to become candidate for
inlining, but can result in a serious increase in code size.
- -intf filename
Compile the file filename as an interface file, even if its
extension is not .mli.
- -intf-suffix string
Recognize file names ending with string as interface files
(instead of the default .mli).
Labels are not ignored in types, labels may be used in applications,
and labelled parameters can be given in any order. This is the default.
Force all modules contained in libraries to be linked in. If this
flag is not given, unreferenced modules are not linked in. When
building a library (option -a), setting the -linkall option forces all
subsequent links of programs involving that library to link all the
modules contained in the library. When compiling a module (option
-c), setting the -linkall option ensures that this module will
always be linked if it is put in a library and this library is linked.
Do not record dependencies for module aliases. See
section 7.13 for more information.
Deactivates the applicative behaviour of functors. With this option,
each functor application generates new types in its result and
applying the same functor twice to the same argument yields two
Do not compile assertion checks. Note that the special form
assert false is always compiled because it is typed specially.
This flag has no effect when linking already-compiled files.
When linking .cmxalibraries, ignore -cclib and -ccopt
options potentially contained in the libraries (if these options were
given when building the libraries). This can be useful if a library
contains incorrect specifications of C libraries or C options; in this
case, during linking, set -noautolink and pass the correct C
libraries and options on the command line.
Allow the compiler to use some optimizations that are valid only for code
that is never dynlinked.
Ignore non-optional labels in types. Labels cannot be used in
applications, and parameter order becomes strict.
Do not automatically add the standard library directory the list of
directories searched for compiled interface files (.cmi), compiled
object code files (.cmx), and libraries (.cmxa). See also option
- -o exec-file
Specify the name of the output file produced by the
default output name is a.out under Unix and camlprog.exe under
Windows. If the -a option is given, specify the name of the library
produced. If the -pack option is given, specify the name of the
packed object file produced. If the -output-obj option is given,
specify the name of the output file produced.
If the -shared option is given, specify the name of plugin
When the native compiler compiles an implementation, by default it
produces a .cmx file containing information for cross-module
optimization. It also expects .cmx files to be present for the
dependencies of the currently compiled source, and uses them for
optimization. Since OCaml 4.03, the compiler will emit a warning if it
is unable to locate the .cmx file of one of those dependencies.
The -opaque option, available since 4.04, disables cross-module
optimization information for the currently compiled unit. When
compiling .mli interface, using -opaque marks the compiled .cmi
interface so that subsequent compilations of modules that depend on it
will not rely on the corresponding .cmx file, nor warn if it is
absent. When the native compiler compiles a .ml implementation,
using -opaque generates a .cmx that does not contain any
cross-module optimization information.
Using this option may degrade the quality of generated code, but it
reduces compilation time, both on clean and incremental
builds. Indeed, with the native compiler, when the implementation of
a compilation unit changes, all the units that depend on it may need
to be recompiled – because the cross-module information may have
changed. If the compilation unit whose implementation changed was
compiled with -opaque, no such recompilation needs to occur. This
option can thus be used, for example, to get faster edit-compile-test
- -open Module
Opens the given module before processing the interface or
implementation files. If several -open options are given,
they are processed in order, just as if
the statements open! Module1;; ... open! ModuleN;;
were added at the top of each file.
Cause the linker to produce a C object file instead of
an executable file.
This is useful to wrap OCaml code as a C library,
callable from any C program. See chapter 19,
section 19.7.5. The name of the output object file
must be set with the -o option.
This option can also be used to produce a compiled shared/dynamic library (.so extension, .dll under Windows).
Generate extra code to write profile information when the program is
executed. The profile information can then be examined with the
analysis program gprof. (See chapter 17 for more
information on profiling.) The -p option must be given both at
compile-time and at link-time. Linking object files not compiled with
-p is possible, but results in less precise profiling.
Unix: See the Unix manual page for gprof(1) for more
information about the profiles.
Full support for gprof is only available for certain platforms
(currently: Intel x86 32 and 64 bits under Linux, BSD and MacOS X).
On other platforms, the -p option will result in a less precise
profile (no call graph information, only a time profile).
The -p option does not work under Windows.
Build an object file (.cmx and .o/.obj files) and its associated compiled
interface (.cmi) that combines the .cmx object
files given on the command line, making them appear as sub-modules of
the output .cmx file. The name of the output .cmx file must be
given with the -o option. For instance,
ocamlopt -pack -o P.cmx A.cmx B.cmx C.cmx
generates compiled files P.cmx, P.o and P.cmi describing a
compilation unit having three sub-modules A, B and C,
corresponding to the contents of the object files A.cmx, B.cmx and
C.cmx. These contents can be referenced as P.A, P.B and P.C
in the remainder of the program.
The .cmx object files being combined must have been compiled with
the appropriate -for-pack option. In the example above,
A.cmx, B.cmx and C.cmx must have been compiled with
ocamlopt -for-pack P.
Multiple levels of packing can be achieved by combining -pack with
-for-pack. Consider the following example:
ocamlopt -for-pack P.Q -c A.ml
ocamlopt -pack -o Q.cmx -for-pack P A.cmx
ocamlopt -for-pack P -c B.ml
ocamlopt -pack -o P.cmx Q.cmx B.cmx
The resulting P.cmx object file has sub-modules P.Q, P.Q.A
- -plugin plugin
Dynamically load the code of the given plugin
(a .cmo, .cma or .cmxs file) in the compiler. plugin must exist in
the same kind of code as the compiler (ocamlopt.byte must load bytecode
plugins, while ocamlopt.opt must load native code plugins), and
extension adaptation is done automatically for .cma files (to .cmxs files
if the compiler is compiled in native code).
- -pp command
Cause the compiler to call the given command as a preprocessor
for each source file. The output of command is redirected to
an intermediate file, which is compiled. If there are no compilation
errors, the intermediate file is deleted afterwards.
- -ppx command
After parsing, pipe the abstract syntax tree through the preprocessor
command. The module Ast_mapper, described in
chapter 25: Ast_mapper
implements the external interface of a preprocessor.
Check information path during type-checking, to make sure that all
types are derived in a principal way. When using labelled arguments
and/or polymorphic methods, this flag is required to ensure future
versions of the compiler will be able to infer types correctly, even
if internal algorithms change.
All programs accepted in -principal mode are also accepted in the
default mode with equivalent types, but different binary signatures,
and this may slow down type checking; yet it is a good idea to
use it once before publishing source code.
Allow arbitrary recursive types during type-checking. By default,
only recursive types where the recursion goes through an object type
are supported.Note that once you have created an interface using this
flag, you must use it again for all dependencies.
- -runtime-variant suffix
Add the suffix string to the name of the runtime library used by
the program. Currently, only one such suffix is supported: d, and
only if the OCaml compiler was configured with option
-with-debug-runtime. This suffix gives the debug version of the
runtime, which is useful for debugging pointer problems in low-level
code such as C stubs.
Keep the assembly code produced during the compilation. The assembly
code for the source file x.ml is saved in the file x.s.
Build a plugin (usually .cmxs) that can be dynamically loaded with
the Dynlink module. The name of the plugin must be
set with the -o option. A plugin can include a number of OCaml
modules and libraries, and extra native objects (.o, .obj, .a,
.lib files). Building native plugins is only supported for some
operating system. Under some systems (currently,
only Linux AMD 64), all the OCaml code linked in a plugin must have
been compiled without the -nodynlink flag. Some constraints might also
apply to the way the extra native objects have been compiled (under
Linux AMD 64, they must contain only position-independent code).
Enforce the separation between types string and bytes,
thereby making strings read-only. This will become the default in
a future version of OCaml.
When a type is visible under several module-paths, use the shortest
one when printing the type’s name in inferred interfaces and error and
warning messages. Identifier names starting with an underscore _ or
containing double underscores __ incur a penalty of +10 when computing
Force the left-hand part of each sequence to have type unit.
Reject invalid formats that were accepted in legacy format
implementations. You should use this flag to detect and fix such
invalid formats, as they will be rejected by future OCaml versions.
Compile or link multithreaded programs, in combination with the
system threads library described in chapter 29.
When a type is unboxable (i.e. a record with a single argument or a
concrete datatype with a single constructor of one argument) it will
be unboxed unless annotated with [@@ocaml.boxed].
When a type is unboxable it will be boxed unless annotated with
[@@ocaml.unboxed]. This is the default.
Turn bound checking off for array and string accesses (the v.(i) and
s.[i] constructs). Programs compiled with -unsafe are therefore
faster, but unsafe: anything can happen if the program
accesses an array or string outside of its bounds.
Additionally, turn off the check for zero divisor in integer division
and modulus operations. With -unsafe, an integer division
(or modulus) by zero can halt the program or continue with an
unspecified result instead of raising a Division_by_zero exception.
Identify the types string and bytes,
thereby making strings writable. For reasons of backward compatibility,
this is the default setting for the moment, but this will change in a future
version of OCaml.
Print the version number of the compiler and the location of the
standard library directory, then exit.
Print all external commands before they are executed,
in particular invocations of the assembler, C compiler, and linker.
Useful to debug C library problems.
- -version or -vnum
Print the version number of the compiler in short form (e.g. 3.11.0),
- -w warning-list
Enable, disable, or mark as fatal the warnings specified by the argument
Each warning can be enabled or disabled, and each warning
can be fatal or non-fatal.
If a warning is disabled, it isn’t displayed and doesn’t affect
compilation in any way (even if it is fatal). If a warning is
enabled, it is displayed normally by the compiler whenever the source
code triggers it. If it is enabled and fatal, the compiler will also
stop with an error after displaying it.
The warning-list argument is a sequence of warning specifiers,
with no separators between them. A warning specifier is one of the
- Enable warning number num.
- Disable warning number num.
- Enable and mark as fatal warning number num.
- Enable warnings in the given range.
- Disable warnings in the given range.
- Enable and mark as fatal warnings in
the given range.
- Enable the set of warnings corresponding to
letter. The letter may be uppercase or lowercase.
- Disable the set of warnings corresponding to
letter. The letter may be uppercase or lowercase.
- Enable and mark as fatal the set of warnings
corresponding to letter. The letter may be uppercase or
- Enable the set of warnings corresponding
- Disable the set of warnings corresponding
Warning numbers and letters which are out of the range of warnings
that are currently defined are ignored. The warnings are as follows.
- Suspicious-looking start-of-comment mark.
- Suspicious-looking end-of-comment mark.
- Deprecated feature.
- Fragile pattern matching: matching that will remain complete even
if additional constructors are added to one of the variant types
- Partially applied function: expression whose result has function
type and is ignored.
- Label omitted in function application.
- Method overridden.
- Partial match: missing cases in pattern-matching.
- Missing fields in a record pattern.
- Expression on the left-hand side of a sequence that doesn’t have type
unit (and that is not a function, see warning number 5).
- Redundant case in a pattern matching (unused match case).
- Redundant sub-pattern in a pattern-matching.
- Instance variable overridden.
- Illegal backslash escape in a string constant.
- Private method made public implicitly.
- Unerasable optional argument.
- Undeclared virtual method.
- Non-principal type.
- Type without principality.
- Unused function argument.
- Non-returning statement.
- Preprocessor warning.
- Useless record with clause.
- Bad module name: the source file name is not a valid OCaml module name.
- Suspicious unused variable: unused variable that is bound
with let or as, and doesn’t start with an underscore (_)
- Innocuous unused variable: unused variable that is not bound with
let nor as, and doesn’t start with an underscore (_)
- Wildcard pattern given as argument to a constant constructor.
- Unescaped end-of-line in a string constant (non-portable code).
- Two labels or constructors of the same name are defined in two
mutually recursive types.
- A module is linked twice in the same executable.
- Unused value declaration.
- Unused open statement.
- Unused type declaration.
- Unused for-loop index.
- Unused ancestor variable.
- Unused constructor.
- Unused extension constructor.
- Unused rec flag.
- Constructor or label name used out of scope.
- Ambiguous constructor or label name.
- Disambiguated constructor or label name (compatibility warning).
- Nonoptional label applied as optional.
- Open statement shadows an already defined identifier.
- Open statement shadows an already defined label or constructor.
- Error in environment variable.
- Illegal attribute payload.
- Implicit elimination of optional arguments.
- Absent cmi file when looking up module alias.
- Unexpected documentation comment.
- Warning on non-tail calls if @tailcall present.
- 52 (see 8.5.1)
- Fragile constant pattern.
- Attribute cannot appear in this context
- Attribute used more than once on an expression
- Inlining impossible
- Unreachable case in a pattern-matching (based on type information).
- 57 (see 8.5.2)
- Ambiguous or-pattern variables under guard
- Missing cmx file
- Assignment to non-mutable value
- Unused module declaration
- all warnings
- warnings 1, 2.
- Alias for warning 3.
- Alias for warning 4.
- Alias for warning 5.
- warnings 32, 33, 34, 35, 36, 37, 38, 39.
- Alias for warning 6.
- Alias for warning 7.
- Alias for warning 8.
- Alias for warning 9.
- Alias for warning 10.
- warnings 11, 12.
- Alias for warning 13.
- warnings 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 30.
- Alias for warning 26.
- Alias for warning 27.
The default setting is -w +a-4-6-7-9-27-29-32..39-41..42-44-45-48-50.
It is displayed by ocamlopt -help.
Note that warnings 5 and 10 are not always triggered, depending on
the internals of the type checker.
- -warn-error warning-list
Mark as fatal the warnings specified in the argument warning-list.
The compiler will stop with an error when one of these warnings is
emitted. The warning-list has the same meaning as for
the -w option: a + sign (or an uppercase letter) marks the
corresponding warnings as fatal, a -
sign (or a lowercase letter) turns them back into non-fatal warnings,
and a @ sign both enables and marks as fatal the corresponding
Note: it is not recommended to use warning sets (i.e. letters) as
arguments to -warn-error
in production code, because this can break your build when future versions
of OCaml add some new warnings.
The default setting is -warn-error -a+31 (only warning 31 is fatal).
Show the description of all available warning numbers.
Print the location of the standard library, then exit.
- - file
Process file as a file name, even if it starts with a dash (-)
- -help or --help
Display a short usage summary and exit.
Options for the IA32 architecture
The IA32 code generator (Intel Pentium, AMD Athlon) supports the
following additional option:
- Use the IA32 instructions to compute
trigonometric and exponential functions, instead of calling the
corresponding library routines. The functions affected are:
atan, atan2, cos, log, log10, sin, sqrt and tan.
The resulting code runs faster, but the range of supported arguments
and the precision of the result can be reduced. In particular,
trigonometric operations cos, sin, tan have their range reduced to
Options for the AMD64 architecture
The AMD64 code generator (64-bit versions of Intel Pentium and AMD
Athlon) supports the following additional options:
- Generate position-independent machine code. This is
- Generate position-dependent machine code.
Options for the Sparc architecture
The Sparc code generator supports the following additional options:
- Generate SPARC version 8 code.
- Generate SPARC version 9 code.
The default is to generate code for SPARC version 7, which runs on all
Contextual control of command-line options
The compiler command line can be modified “from the outside”
with the following mechanisms. These are experimental
and subject to change. They should be used only for experimental and
development work, not in released packages.
OCAMLPARAM (environment variable)
Arguments that will be inserted before or after the arguments from the
- ocaml_compiler_internal_params (file in the stdlib directory)
A mapping of file names to lists of arguments that
will be added to the command line (and OCAMLPARAM) arguments.
- OCAML_FLEXLINK (environment variable)
Alternative executable to use on native
Windows for flexlink instead of the
configured value. Primarily used for bootstrapping.
11.3 Common errors
The error messages are almost identical to those of ocamlc.
See section 8.4.
11.4 Running executables produced by ocamlopt
Executables generated by ocamlopt are native, stand-alone executable
files that can be invoked directly. They do
not depend on the ocamlrun bytecode runtime system nor on
dynamically-loaded C/OCaml stub libraries.
During execution of an ocamlopt-generated executable,
the following environment variables are also consulted:
- Same usage as in ocamlrun
(see section 10.2), except that option l
is ignored (the operating system’s stack size limit
is used instead).
- If OCAMLRUNPARAM is not found in the
environment, then CAMLRUNPARAM will be used instead. If
CAMLRUNPARAM is not found, then the default values will be used.
11.5 Compatibility with the bytecode compiler
This section lists the known incompatibilities between the bytecode
compiler and the native-code compiler. Except on those points, the two
compilers should generate code that behave identically.
- Signals are detected only when the program performs an
allocation in the heap. That is, if a signal is delivered while in a
piece of code that does not allocate, its handler will not be called
until the next heap allocation.
- Stack overflow, typically caused by excessively deep recursion,
is handled in one of the following ways, depending on the
By raising a Stack_overflow exception, like the bytecode
compiler does. (IA32/Linux, AMD64/Linux, PowerPC/MacOSX, MS Windows
- By aborting the program on a “segmentation fault” signal.
(All other Unix systems.)
- By terminating the program silently.
(MS Windows 64 bits).
- On IA32 processors only (Intel and AMD x86 processors in 32-bit
mode), some intermediate results in floating-point computations are
kept in extended precision rather than being rounded to double
precision like the bytecode compiler always does. Floating-point
results can therefore differ slightly between bytecode and native code.