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 Deprecated.
83 Config.ocamlc_cflags should be used instead. The flags ocamlopt should
85 pass to the C compiler
86 val ocamlopt_cppflags : string
90 Deprecated.
92 Config.ocamlc_cppflags should be used instead. The flags ocamlopt
94 should pass to the C preprocessor
95 val bytecomp_c_libraries : string
99 The C libraries to link with custom runtimes
101 val native_c_libraries : string
105 The C libraries to link with native-code programs
107 val native_pack_linker : string
111 The linker to use for packaging (ocamlopt -pack) and for partial links
113 (ocamlopt -output-obj).
114 val mkdll : string
118 The linker command line to build dynamic libraries.
120 val mkexe : string
124 The linker command line to build executables.
126 val mkmaindll : string
130 The linker command line to build main programs as dlls.
132 val ranlib : string
136 Command to randomize a library, or "" if not needed
138 val ar : string
142 Name of the ar command, or "" if not needed (MSVC)
144 val interface_suffix : string ref
148 Suffix for interface file names
150 val exec_magic_number : string
154 Magic number for bytecode executable files
156 val cmi_magic_number : string
160 Magic number for compiled interface files
162 val cmo_magic_number : string
166 Magic number for object bytecode files
168 val cma_magic_number : string
172 Magic number for archive files
174 val cmx_magic_number : string
178 Magic number for compilation unit descriptions
180 val cmxa_magic_number : string
184 Magic number for libraries of compilation unit descriptions
186 val ast_intf_magic_number : string
190 Magic number for file holding an interface syntax tree
192 val ast_impl_magic_number : string
196 Magic number for file holding an implementation syntax tree
198 val cmxs_magic_number : string
202 Magic number for dynamically-loadable plugins
204 val cmt_magic_number : string
208 Magic number for compiled interface files
210 val max_tag : int
214 Biggest tag that can be stored in the header of a regular block.
216 val lazy_tag : int
220 Normally the same as Obj.lazy_tag. Separate definition because of
222 technical reasons for bootstrapping.
223 val max_young_wosize : int
227 Maximal size of arrays that are directly allocated in the minor heap
229 val stack_threshold : int
233 Size in words of safe area at bottom of VM stack, see runtime/caml/con‐
235 fig.h
236 val stack_safety_margin : int
240 Size in words of the safety margin between the bottom of the stack and
242 the stack pointer. This margin can be used by intermediate computations
243 of some instructions, or the event handler.
244 val architecture : string
248 Name of processor type for the native-code compiler
250 val model : string
254 Name of processor submodel for the native-code compiler
256 val system : string
260 Name of operating system for the native-code compiler
262 val asm : string
266 The assembler (and flags) to use for assembling ocamlopt-generated
268 code.
269 val asm_cfi_supported : bool
273 Whether assembler understands CFI directives
275 val with_frame_pointers : bool
279 Whether assembler should maintain frame pointers
281 val ext_obj : string
285 Extension for object files, e.g. .o under Unix.
287 val ext_asm : string
291 Extension for assembler files, e.g. .s under Unix.
293 val ext_lib : string
297 Extension for library files, e.g. .a under Unix.
299 val ext_dll : string
303 Extension for dynamically-loaded libraries, e.g. .so under Unix.
305 val default_executable_name : string
309 Name of executable produced by linking if none is given with -o, e.g.
311 a.out under Unix.
312 val systhread_supported : bool
316 Whether the system thread library is implemented
318 val flexdll_dirs : string list
322 Directories needed for the FlexDLL objects
324 val host : string
328 Whether the compiler is a cross-compiler
330 val target : string
334 Whether the compiler is a cross-compiler
336 val flambda : bool
340 Whether the compiler was configured for flambda
342 val with_flambda_invariants : bool
346 Whether the invariants checks for flambda are enabled
348 val spacetime : bool
352 Whether the compiler was configured for Spacetime profiling
354 val enable_call_counts : bool
358 Whether call counts are to be available when Spacetime profiling
360 val profinfo : bool
364 Whether the compiler was configured for profiling
366 val profinfo_width : int
370 How many bits are to be used in values' headers for profiling informa‐
372 tion
373 val libunwind_available : bool
377 Whether the libunwind library is available on the target
379 val libunwind_link_flags : string
383 Linker flags to use libunwind
385 val safe_string : bool
389 Whether the compiler was configured with -force-safe-string; in that
391 case, the -unsafe-string compile-time option is unavailable
392 Since 4.05.0
395 val default_safe_string : bool
399 Whether the compiler was configured to use the -safe-string or -un‐
401 safe-string compile-time option by default.
402 Since 4.06.0
405 val flat_float_array : bool
409 Whether the compiler and runtime automagically flatten float arrays
411 val function_sections : bool
415 Whether the compiler was configured to generate each function in a sep‐
417 arate section
418 val windows_unicode : bool
422 Whether Windows Unicode runtime is enabled
424 val supports_shared_libraries : bool
428 Whether shared libraries are supported
430 Since 4.08.0
433 val afl_instrument : bool
437 Whether afl-fuzz instrumentation is generated by default
439 val print_config : out_channel -> unit
443 Access to configuration values
445 val config_var : string -> string option
449 the configuration value of a variable, if it exists
451OCamldoc 2021-01-26 Config(3)