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 default_rpath : string
142 Option to add a directory to be searched for libraries at runtime (used
144 by ocamlmklib)
145 val mksharedlibrpath : string
149 Option to add a directory to be searched for shared libraries at run‐
151 time (used by ocamlmklib)
152 val ar : string
156 Name of the ar command, or "" if not needed (MSVC)
158 val interface_suffix : string ref
162 Suffix for interface file names
164 val exec_magic_number : string
168 Magic number for bytecode executable files
170 val cmi_magic_number : string
174 Magic number for compiled interface files
176 val cmo_magic_number : string
180 Magic number for object bytecode files
182 val cma_magic_number : string
186 Magic number for archive files
188 val cmx_magic_number : string
192 Magic number for compilation unit descriptions
194 val cmxa_magic_number : string
198 Magic number for libraries of compilation unit descriptions
200 val ast_intf_magic_number : string
204 Magic number for file holding an interface syntax tree
206 val ast_impl_magic_number : string
210 Magic number for file holding an implementation syntax tree
212 val cmxs_magic_number : string
216 Magic number for dynamically-loadable plugins
218 val cmt_magic_number : string
222 Magic number for compiled interface files
224 val linear_magic_number : string
228 Magic number for Linear internal representation files
230 val max_tag : int
234 Biggest tag that can be stored in the header of a regular block.
236 val lazy_tag : int
240 Normally the same as Obj.lazy_tag. Separate definition because of
242 technical reasons for bootstrapping.
243 val max_young_wosize : int
247 Maximal size of arrays that are directly allocated in the minor heap
249 val stack_threshold : int
253 Size in words of safe area at bottom of VM stack, see runtime/caml/con‐
255 fig.h
256 val stack_safety_margin : int
260 Size in words of the safety margin between the bottom of the stack and
262 the stack pointer. This margin can be used by intermediate computations
263 of some instructions, or the event handler.
264 val architecture : string
268 Name of processor type for the native-code compiler
270 val model : string
274 Name of processor submodel for the native-code compiler
276 val system : string
280 Name of operating system for the native-code compiler
282 val asm : string
286 The assembler (and flags) to use for assembling ocamlopt-generated
288 code.
289 val asm_cfi_supported : bool
293 Whether assembler understands CFI directives
295 val with_frame_pointers : bool
299 Whether assembler should maintain frame pointers
301 val ext_obj : string
305 Extension for object files, e.g. .o under Unix.
307 val ext_asm : string
311 Extension for assembler files, e.g. .s under Unix.
313 val ext_lib : string
317 Extension for library files, e.g. .a under Unix.
319 val ext_dll : string
323 Extension for dynamically-loaded libraries, e.g. .so under Unix.
325 val ext_exe : string
329 Extension for executable programs, e.g. .exe under Windows.
331 Since 4.12.0
334 val default_executable_name : string
338 Name of executable produced by linking if none is given with -o, e.g.
340 a.out under Unix.
341 val systhread_supported : bool
345 Whether the system thread library is implemented
347 val flexdll_dirs : string list
351 Directories needed for the FlexDLL objects
353 val host : string
357 Whether the compiler is a cross-compiler
359 val target : string
363 Whether the compiler is a cross-compiler
365 val flambda : bool
369 Whether the compiler was configured for flambda
371 val with_flambda_invariants : bool
375 Whether the invariants checks for flambda are enabled
377 val with_cmm_invariants : bool
381 Whether the invariants checks for Cmm are enabled
383 val profinfo : bool
387 Whether the compiler was configured for profiling
389 val profinfo_width : int
393 How many bits are to be used in values' headers for profiling informa‐
395 tion
396 val safe_string : bool
400 Whether the compiler was configured with -force-safe-string; in that
402 case, the -unsafe-string compile-time option is unavailable
403 Since 4.05.0
406 val default_safe_string : bool
410 Whether the compiler was configured to use the -safe-string or -un‐
412 safe-string compile-time option by default.
413 Since 4.06.0
416 val flat_float_array : bool
420 Whether the compiler and runtime automagically flatten float arrays
422 val function_sections : bool
426 Whether the compiler was configured to generate each function in a sep‐
428 arate section
429 val windows_unicode : bool
433 Whether Windows Unicode runtime is enabled
435 val naked_pointers : bool
439 Whether the runtime supports naked pointers
441 Since 4.14.0
444 val supports_shared_libraries : bool
448 Whether shared libraries are supported
450 Since 4.08.0
453 val afl_instrument : bool
457 Whether afl-fuzz instrumentation is generated by default
459 val print_config : out_channel -> unit
463 Access to configuration values
465 val config_var : string -> string option
469 the configuration value of a variable, if it exists
471OCamldoc 2023-01-23 Config(3)