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 standard_library : string
32 The directory containing the standard libraries
34 val ccomp_type : string
38 The "kind" of the C compiler, assembler and linker used: one of "cc"
40 (for Unix-style C compilers) "msvc" (for Microsoft Visual C++ and MASM)
41 val c_compiler : string
45 The compiler to use for compiling C files
47 val c_output_obj : string
51 Name of the option of the C compiler for specifying the output file
53 val c_has_debug_prefix_map : bool
57 Whether the C compiler supports -fdebug-prefix-map
59 val as_has_debug_prefix_map : bool
63 Whether the assembler supports --debug-prefix-map
65 val ocamlc_cflags : string
69 The flags ocamlc should pass to the C compiler
71 val ocamlc_cppflags : string
75 The flags ocamlc should pass to the C preprocessor
77 val ocamlopt_cflags : string
81 The flags ocamlopt should pass to the C compiler
83 val ocamlopt_cppflags : string
87 The flags ocamlopt should pass to the C preprocessor
89 val bytecomp_c_libraries : string
93 The C libraries to link with custom runtimes
95 val native_c_libraries : string
99 The C libraries to link with native-code programs
101 val native_pack_linker : string
105 The linker to use for packaging (ocamlopt -pack) and for partial links
107 (ocamlopt -output-obj).
108 val mkdll : string
112 The linker command line to build dynamic libraries.
114 val mkexe : string
118 The linker command line to build executables.
120 val mkmaindll : string
124 The linker command line to build main programs as dlls.
126 val ranlib : string
130 Command to randomize a library, or "" if not needed
132 val ar : string
136 Name of the ar command, or "" if not needed (MSVC)
138 val interface_suffix : string ref
142 Suffix for interface file names
144 val exec_magic_number : string
148 Magic number for bytecode executable files
150 val cmi_magic_number : string
154 Magic number for compiled interface files
156 val cmo_magic_number : string
160 Magic number for object bytecode files
162 val cma_magic_number : string
166 Magic number for archive files
168 val cmx_magic_number : string
172 Magic number for compilation unit descriptions
174 val cmxa_magic_number : string
178 Magic number for libraries of compilation unit descriptions
180 val ast_intf_magic_number : string
184 Magic number for file holding an interface syntax tree
186 val ast_impl_magic_number : string
190 Magic number for file holding an implementation syntax tree
192 val cmxs_magic_number : string
196 Magic number for dynamically-loadable plugins
198 val cmt_magic_number : string
202 Magic number for compiled interface files
204 val max_tag : int
208 Biggest tag that can be stored in the header of a regular block.
210 val lazy_tag : int
214 Normally the same as Obj.lazy_tag. Separate definition because of
216 technical reasons for bootstrapping.
217 val max_young_wosize : int
221 Maximal size of arrays that are directly allocated in the minor heap
223 val stack_threshold : int
227 Size in words of safe area at bottom of VM stack, see runtime/caml/con‐
229 fig.h
230 val stack_safety_margin : int
234 Size in words of the safety margin between the bottom of the stack and
236 the stack pointer. This margin can be used by intermediate computations
237 of some instructions, or the event handler.
238 val architecture : string
242 Name of processor type for the native-code compiler
244 val model : string
248 Name of processor submodel for the native-code compiler
250 val system : string
254 Name of operating system for the native-code compiler
256 val asm : string
260 The assembler (and flags) to use for assembling ocamlopt-generated
262 code.
263 val asm_cfi_supported : bool
267 Whether assembler understands CFI directives
269 val with_frame_pointers : bool
273 Whether assembler should maintain frame pointers
275 val ext_obj : string
279 Extension for object files, e.g. .o under Unix.
281 val ext_asm : string
285 Extension for assembler files, e.g. .s under Unix.
287 val ext_lib : string
291 Extension for library files, e.g. .a under Unix.
293 val ext_dll : string
297 Extension for dynamically-loaded libraries, e.g. .so under Unix.
299 val default_executable_name : string
303 Name of executable produced by linking if none is given with -o, e.g.
305 a.out under Unix.
306 val systhread_supported : bool
310 Whether the system thread library is implemented
312 val flexdll_dirs : string list
316 Directories needed for the FlexDLL objects
318 val host : string
322 Whether the compiler is a cross-compiler
324 val target : string
328 Whether the compiler is a cross-compiler
330 val flambda : bool
334 Whether the compiler was configured for flambda
336 val with_flambda_invariants : bool
340 Whether the invariants checks for flambda are enabled
342 val spacetime : bool
346 Whether the compiler was configured for Spacetime profiling
348 val enable_call_counts : bool
352 Whether call counts are to be available when Spacetime profiling
354 val profinfo : bool
358 Whether the compiler was configured for profiling
360 val profinfo_width : int
364 How many bits are to be used in values' headers for profiling informa‐
366 tion
367 val libunwind_available : bool
371 Whether the libunwind library is available on the target
373 val libunwind_link_flags : string
377 Linker flags to use libunwind
379 val safe_string : bool
383 Whether the compiler was configured with -force-safe-string; in that
385 case, the -unsafe-string compile-time option is unavailable
386 Since 4.05.0
389 val default_safe_string : bool
393 Whether the compiler was configured to use the -safe-string or
395 -unsafe-string compile-time option by default.
396 Since 4.06.0
399 val flat_float_array : bool
403 Whether the compiler and runtime automagically flatten float arrays
405 val function_sections : bool
409 Whether the compiler was configured to generate each function in a sep‐
411 arate section
412 val windows_unicode : bool
416 Whether Windows Unicode runtime is enabled
418 val supports_shared_libraries : bool
422 Whether shared libraries are supported
424 Since 4.08.0
427 val afl_instrument : bool
431 Whether afl-fuzz instrumentation is generated by default
433 val print_config : out_channel -> unit
437 Access to configuration values
439 val config_var : string -> string option
443 the configuration value of a variable, if it exists
445OCamldoc 2020-02-27 Config(3)