1Config(3) OCaml library Config(3)
2
6 Config - System configuration
7
9 Module Config
10
12 Module Config
13 : sig end
14 System configuration
17 Warning: this module is unstable and part of Compiler_libs .
19 val version : string
26 The current version number of the system
28 val bindir : string
32 The directory containing the binary programs
34 val standard_library : string
38 The directory containing the standard libraries
40 val ccomp_type : string
44 The "kind" of the C compiler, assembler and linker used: one of "cc"
46 (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)
47 val c_compiler : string
51 The compiler to use for compiling C files
53 val c_output_obj : string
57 Name of the option of the C compiler for specifying the output file
59 val c_has_debug_prefix_map : bool
63 Whether the C compiler supports -fdebug-prefix-map
65 val as_has_debug_prefix_map : bool
69 Whether the assembler supports --debug-prefix-map
71 val ocamlc_cflags : string
75 The flags ocamlc should pass to the C compiler
77 val ocamlc_cppflags : string
81 The flags ocamlc should pass to the C preprocessor
83 val ocamlopt_cflags : string
87 Deprecated.
89 Config.ocamlc_cflags should be used instead. The flags ocamlopt should
91 pass to the C compiler
92 val ocamlopt_cppflags : string
96 Deprecated.
98 Config.ocamlc_cppflags should be used instead. The flags ocamlopt
100 should pass to the C preprocessor
101 val bytecomp_c_libraries : string
105 The C libraries to link with custom runtimes
107 val native_c_libraries : string
111 The C libraries to link with native-code programs
113 val native_pack_linker : string
117 The linker to use for packaging (ocamlopt -pack) and for partial links
119 (ocamlopt -output-obj).
120 val mkdll : string
124 The linker command line to build dynamic libraries.
126 val mkexe : string
130 The linker command line to build executables.
132 val mkmaindll : string
136 The linker command line to build main programs as dlls.
138 val ranlib : string
142 Command to randomize a library, or "" if not needed
144 val default_rpath : string
148 Option to add a directory to be searched for libraries at runtime (used
150 by ocamlmklib)
151 val mksharedlibrpath : string
155 Option to add a directory to be searched for shared libraries at run‐
157 time (used by ocamlmklib)
158 val ar : string
162 Name of the ar command, or "" if not needed (MSVC)
164 val interface_suffix : string ref
168 Suffix for interface file names
170 val exec_magic_number : string
174 Magic number for bytecode executable files
176 val cmi_magic_number : string
180 Magic number for compiled interface files
182 val cmo_magic_number : string
186 Magic number for object bytecode files
188 val cma_magic_number : string
192 Magic number for archive files
194 val cmx_magic_number : string
198 Magic number for compilation unit descriptions
200 val cmxa_magic_number : string
204 Magic number for libraries of compilation unit descriptions
206 val ast_intf_magic_number : string
210 Magic number for file holding an interface syntax tree
212 val ast_impl_magic_number : string
216 Magic number for file holding an implementation syntax tree
218 val cmxs_magic_number : string
222 Magic number for dynamically-loadable plugins
224 val cmt_magic_number : string
228 Magic number for compiled interface files
230 val linear_magic_number : string
234 Magic number for Linear internal representation files
236 val max_tag : int
240 Biggest tag that can be stored in the header of a regular block.
242 val lazy_tag : int
246 Normally the same as Obj.lazy_tag. Separate definition because of
248 technical reasons for bootstrapping.
249 val max_young_wosize : int
253 Maximal size of arrays that are directly allocated in the minor heap
255 val stack_threshold : int
259 Size in words of safe area at bottom of VM stack, see runtime/caml/con‐
261 fig.h
262 val stack_safety_margin : int
266 Size in words of the safety margin between the bottom of the stack and
268 the stack pointer. This margin can be used by intermediate computations
269 of some instructions, or the event handler.
270 val architecture : string
274 Name of processor type for the native-code compiler
276 val model : string
280 Name of processor submodel for the native-code compiler
282 val system : string
286 Name of operating system for the native-code compiler
288 val asm : string
292 The assembler (and flags) to use for assembling ocamlopt-generated
294 code.
295 val asm_cfi_supported : bool
299 Whether assembler understands CFI directives
301 val with_frame_pointers : bool
305 Whether assembler should maintain frame pointers
307 val ext_obj : string
311 Extension for object files, e.g. .o under Unix.
313 val ext_asm : string
317 Extension for assembler files, e.g. .s under Unix.
319 val ext_lib : string
323 Extension for library files, e.g. .a under Unix.
325 val ext_dll : string
329 Extension for dynamically-loaded libraries, e.g. .so under Unix.
331 val ext_exe : string
335 Extension for executable programs, e.g. .exe under Windows.
337 Since 4.12.0
340 val default_executable_name : string
344 Name of executable produced by linking if none is given with -o, e.g.
346 a.out under Unix.
347 val systhread_supported : bool
351 Whether the system thread library is implemented
353 val flexdll_dirs : string list
357 Directories needed for the FlexDLL objects
359 val host : string
363 Whether the compiler is a cross-compiler
365 val target : string
369 Whether the compiler is a cross-compiler
371 val flambda : bool
375 Whether the compiler was configured for flambda
377 val with_flambda_invariants : bool
381 Whether the invariants checks for flambda are enabled
383 val with_cmm_invariants : bool
387 Whether the invariants checks for Cmm are enabled
389 val profinfo : bool
393 Whether the compiler was configured for profiling
395 val profinfo_width : int
399 How many bits are to be used in values' headers for profiling informa‐
401 tion
402 val safe_string : bool
406 Whether the compiler was configured with -force-safe-string; in that
408 case, the -unsafe-string compile-time option is unavailable
409 Since 4.05.0
412 val default_safe_string : bool
416 Whether the compiler was configured to use the -safe-string or -un‐
418 safe-string compile-time option by default.
419 Since 4.06.0
422 val flat_float_array : bool
426 Whether the compiler and runtime automagically flatten float arrays
428 val function_sections : bool
432 Whether the compiler was configured to generate each function in a sep‐
434 arate section
435 val windows_unicode : bool
439 Whether Windows Unicode runtime is enabled
441 val naked_pointers : bool
445 Whether the runtime supports naked pointers
447 Since 4.14.0
450 val supports_shared_libraries : bool
454 Whether shared libraries are supported
456 Since 4.08.0
459 val afl_instrument : bool
463 Whether afl-fuzz instrumentation is generated by default
465 val print_config : out_channel -> unit
469 Access to configuration values
471 val config_var : string -> string option
475 the configuration value of a variable, if it exists
477OCamldoc 2022-07-22 Config(3)