moonpool/dev/ocaml/Config_boot/index.html
2023-12-22 18:21:55 +00:00

2 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Config_boot (ocaml.Config_boot)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../index.html">ocaml</a> &#x00BB; Config_boot</nav><header class="odoc-preamble"><h1>Module <code><span>Config_boot</span></code></h1><p>System configuration</p><p><b>Warning:</b> this module is unstable and part of <span class="xref-unresolved" title="Compiler_libs">compiler-libs</span>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-version"><a href="#val-version" class="anchor"></a><code><span><span class="keyword">val</span> version : string</span></code></div><div class="spec-doc"><p>The current version number of the system</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bindir"><a href="#val-bindir" class="anchor"></a><code><span><span class="keyword">val</span> bindir : string</span></code></div><div class="spec-doc"><p>The directory containing the binary programs</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-standard_library"><a href="#val-standard_library" class="anchor"></a><code><span><span class="keyword">val</span> standard_library : string</span></code></div><div class="spec-doc"><p>The directory containing the standard libraries</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ccomp_type"><a href="#val-ccomp_type" class="anchor"></a><code><span><span class="keyword">val</span> ccomp_type : string</span></code></div><div class="spec-doc"><p>The &quot;kind&quot; of the C compiler, assembler and linker used: one of &quot;cc&quot; (for Unix-style C compilers) &quot;msvc&quot; (for Microsoft Visual C++ and MASM)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-c_compiler"><a href="#val-c_compiler" class="anchor"></a><code><span><span class="keyword">val</span> c_compiler : string</span></code></div><div class="spec-doc"><p>The compiler to use for compiling C files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-c_output_obj"><a href="#val-c_output_obj" class="anchor"></a><code><span><span class="keyword">val</span> c_output_obj : string</span></code></div><div class="spec-doc"><p>Name of the option of the C compiler for specifying the output file</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-c_has_debug_prefix_map"><a href="#val-c_has_debug_prefix_map" class="anchor"></a><code><span><span class="keyword">val</span> c_has_debug_prefix_map : bool</span></code></div><div class="spec-doc"><p>Whether the C compiler supports -fdebug-prefix-map</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-as_has_debug_prefix_map"><a href="#val-as_has_debug_prefix_map" class="anchor"></a><code><span><span class="keyword">val</span> as_has_debug_prefix_map : bool</span></code></div><div class="spec-doc"><p>Whether the assembler supports --debug-prefix-map</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ocamlc_cflags"><a href="#val-ocamlc_cflags" class="anchor"></a><code><span><span class="keyword">val</span> ocamlc_cflags : string</span></code></div><div class="spec-doc"><p>The flags ocamlc should pass to the C compiler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ocamlc_cppflags"><a href="#val-ocamlc_cppflags" class="anchor"></a><code><span><span class="keyword">val</span> ocamlc_cppflags : string</span></code></div><div class="spec-doc"><p>The flags ocamlc should pass to the C preprocessor</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ocamlopt_cflags"><a href="#val-ocamlopt_cflags" class="anchor"></a><code><span><span class="keyword">val</span> ocamlopt_cflags : string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p><a href="#val-ocamlc_cflags"><code>ocamlc_cflags</code></a> should be used instead. The flags ocamlopt should pass to the C compiler</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ocamlopt_cppflags"><a href="#val-ocamlopt_cppflags" class="anchor"></a><code><span><span class="keyword">val</span> ocamlopt_cppflags : string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="deprecated"><span class="at-tag">deprecated</span> <p><a href="#val-ocamlc_cppflags"><code>ocamlc_cppflags</code></a> should be used instead. The flags ocamlopt should pass to the C preprocessor</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-bytecomp_c_libraries"><a href="#val-bytecomp_c_libraries" class="anchor"></a><code><span><span class="keyword">val</span> bytecomp_c_libraries : string</span></code></div><div class="spec-doc"><p>The C libraries to link with custom runtimes</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-native_c_libraries"><a href="#val-native_c_libraries" class="anchor"></a><code><span><span class="keyword">val</span> native_c_libraries : string</span></code></div><div class="spec-doc"><p>The C libraries to link with native-code programs</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-native_pack_linker"><a href="#val-native_pack_linker" class="anchor"></a><code><span><span class="keyword">val</span> native_pack_linker : string</span></code></div><div class="spec-doc"><p>The linker to use for packaging (ocamlopt -pack) and for partial links (ocamlopt -output-obj).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mkdll"><a href="#val-mkdll" class="anchor"></a><code><span><span class="keyword">val</span> mkdll : string</span></code></div><div class="spec-doc"><p>The linker command line to build dynamic libraries.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mkexe"><a href="#val-mkexe" class="anchor"></a><code><span><span class="keyword">val</span> mkexe : string</span></code></div><div class="spec-doc"><p>The linker command line to build executables.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mkmaindll"><a href="#val-mkmaindll" class="anchor"></a><code><span><span class="keyword">val</span> mkmaindll : string</span></code></div><div class="spec-doc"><p>The linker command line to build main programs as dlls.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_rpath"><a href="#val-default_rpath" class="anchor"></a><code><span><span class="keyword">val</span> default_rpath : string</span></code></div><div class="spec-doc"><p>Option to add a directory to be searched for libraries at runtime (used by ocamlmklib)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mksharedlibrpath"><a href="#val-mksharedlibrpath" class="anchor"></a><code><span><span class="keyword">val</span> mksharedlibrpath : string</span></code></div><div class="spec-doc"><p>Option to add a directory to be searched for shared libraries at runtime (used by ocamlmklib)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ar"><a href="#val-ar" class="anchor"></a><code><span><span class="keyword">val</span> ar : string</span></code></div><div class="spec-doc"><p>Name of the ar command, or &quot;&quot; if not needed (MSVC)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-interface_suffix"><a href="#val-interface_suffix" class="anchor"></a><code><span><span class="keyword">val</span> interface_suffix : <span>string <a href="../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Suffix for interface file names</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exec_magic_number"><a href="#val-exec_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> exec_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for bytecode executable files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cmi_magic_number"><a href="#val-cmi_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cmi_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for compiled interface files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cmo_magic_number"><a href="#val-cmo_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cmo_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for object bytecode files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cma_magic_number"><a href="#val-cma_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cma_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for archive files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cmx_magic_number"><a href="#val-cmx_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cmx_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for compilation unit descriptions</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cmxa_magic_number"><a href="#val-cmxa_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cmxa_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for libraries of compilation unit descriptions</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ast_intf_magic_number"><a href="#val-ast_intf_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> ast_intf_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for file holding an interface syntax tree</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ast_impl_magic_number"><a href="#val-ast_impl_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> ast_impl_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for file holding an implementation syntax tree</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cmxs_magic_number"><a href="#val-cmxs_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cmxs_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for dynamically-loadable plugins</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cmt_magic_number"><a href="#val-cmt_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> cmt_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for compiled interface files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-linear_magic_number"><a href="#val-linear_magic_number" class="anchor"></a><code><span><span class="keyword">val</span> linear_magic_number : string</span></code></div><div class="spec-doc"><p>Magic number for Linear internal representation files</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_tag"><a href="#val-max_tag" class="anchor"></a><code><span><span class="keyword">val</span> max_tag : int</span></code></div><div class="spec-doc"><p>Biggest tag that can be stored in the header of a regular block.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lazy_tag"><a href="#val-lazy_tag" class="anchor"></a><code><span><span class="keyword">val</span> lazy_tag : int</span></code></div><div class="spec-doc"><p>Normally the same as Obj.lazy_tag. Separate definition because of technical reasons for bootstrapping.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_young_wosize"><a href="#val-max_young_wosize" class="anchor"></a><code><span><span class="keyword">val</span> max_young_wosize : int</span></code></div><div class="spec-doc"><p>Maximal size of arrays that are directly allocated in the minor heap</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stack_threshold"><a href="#val-stack_threshold" class="anchor"></a><code><span><span class="keyword">val</span> stack_threshold : int</span></code></div><div class="spec-doc"><p>Size in words of safe area at bottom of VM stack, see runtime/caml/config.h</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stack_safety_margin"><a href="#val-stack_safety_margin" class="anchor"></a><code><span><span class="keyword">val</span> stack_safety_margin : int</span></code></div><div class="spec-doc"><p>Size in words of the safety margin between the bottom of the stack and the stack pointer. This margin can be used by intermediate computations of some instructions, or the event handler.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-architecture"><a href="#val-architecture" class="anchor"></a><code><span><span class="keyword">val</span> architecture : string</span></code></div><div class="spec-doc"><p>Name of processor type for the native-code compiler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-model"><a href="#val-model" class="anchor"></a><code><span><span class="keyword">val</span> model : string</span></code></div><div class="spec-doc"><p>Name of processor submodel for the native-code compiler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-system"><a href="#val-system" class="anchor"></a><code><span><span class="keyword">val</span> system : string</span></code></div><div class="spec-doc"><p>Name of operating system for the native-code compiler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-asm"><a href="#val-asm" class="anchor"></a><code><span><span class="keyword">val</span> asm : string</span></code></div><div class="spec-doc"><p>The assembler (and flags) to use for assembling ocamlopt-generated code.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-asm_cfi_supported"><a href="#val-asm_cfi_supported" class="anchor"></a><code><span><span class="keyword">val</span> asm_cfi_supported : bool</span></code></div><div class="spec-doc"><p>Whether assembler understands CFI directives</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_frame_pointers"><a href="#val-with_frame_pointers" class="anchor"></a><code><span><span class="keyword">val</span> with_frame_pointers : bool</span></code></div><div class="spec-doc"><p>Whether assembler should maintain frame pointers</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ext_obj"><a href="#val-ext_obj" class="anchor"></a><code><span><span class="keyword">val</span> ext_obj : string</span></code></div><div class="spec-doc"><p>Extension for object files, e.g. <code>.o</code> under Unix.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ext_asm"><a href="#val-ext_asm" class="anchor"></a><code><span><span class="keyword">val</span> ext_asm : string</span></code></div><div class="spec-doc"><p>Extension for assembler files, e.g. <code>.s</code> under Unix.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ext_lib"><a href="#val-ext_lib" class="anchor"></a><code><span><span class="keyword">val</span> ext_lib : string</span></code></div><div class="spec-doc"><p>Extension for library files, e.g. <code>.a</code> under Unix.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ext_dll"><a href="#val-ext_dll" class="anchor"></a><code><span><span class="keyword">val</span> ext_dll : string</span></code></div><div class="spec-doc"><p>Extension for dynamically-loaded libraries, e.g. <code>.so</code> under Unix.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ext_exe"><a href="#val-ext_exe" class="anchor"></a><code><span><span class="keyword">val</span> ext_exe : string</span></code></div><div class="spec-doc"><p>Extension for executable programs, e.g. <code>.exe</code> under Windows.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.12.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_executable_name"><a href="#val-default_executable_name" class="anchor"></a><code><span><span class="keyword">val</span> default_executable_name : string</span></code></div><div class="spec-doc"><p>Name of executable produced by linking if none is given with -o, e.g. <code>a.out</code> under Unix.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-systhread_supported"><a href="#val-systhread_supported" class="anchor"></a><code><span><span class="keyword">val</span> systhread_supported : bool</span></code></div><div class="spec-doc"><p>Whether the system thread library is implemented</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flexdll_dirs"><a href="#val-flexdll_dirs" class="anchor"></a><code><span><span class="keyword">val</span> flexdll_dirs : <span>string list</span></span></code></div><div class="spec-doc"><p>Directories needed for the FlexDLL objects</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-host"><a href="#val-host" class="anchor"></a><code><span><span class="keyword">val</span> host : string</span></code></div><div class="spec-doc"><p>Whether the compiler is a cross-compiler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-target"><a href="#val-target" class="anchor"></a><code><span><span class="keyword">val</span> target : string</span></code></div><div class="spec-doc"><p>Whether the compiler is a cross-compiler</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flambda"><a href="#val-flambda" class="anchor"></a><code><span><span class="keyword">val</span> flambda : bool</span></code></div><div class="spec-doc"><p>Whether the compiler was configured for flambda</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_flambda_invariants"><a href="#val-with_flambda_invariants" class="anchor"></a><code><span><span class="keyword">val</span> with_flambda_invariants : bool</span></code></div><div class="spec-doc"><p>Whether the invariants checks for flambda are enabled</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_cmm_invariants"><a href="#val-with_cmm_invariants" class="anchor"></a><code><span><span class="keyword">val</span> with_cmm_invariants : bool</span></code></div><div class="spec-doc"><p>Whether the invariants checks for Cmm are enabled</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-profinfo"><a href="#val-profinfo" class="anchor"></a><code><span><span class="keyword">val</span> profinfo : bool</span></code></div><div class="spec-doc"><p>Whether the compiler was configured for profiling</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-profinfo_width"><a href="#val-profinfo_width" class="anchor"></a><code><span><span class="keyword">val</span> profinfo_width : int</span></code></div><div class="spec-doc"><p>How many bits are to be used in values' headers for profiling information</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-flat_float_array"><a href="#val-flat_float_array" class="anchor"></a><code><span><span class="keyword">val</span> flat_float_array : bool</span></code></div><div class="spec-doc"><p>Whether the compiler and runtime automagically flatten float arrays</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-function_sections"><a href="#val-function_sections" class="anchor"></a><code><span><span class="keyword">val</span> function_sections : bool</span></code></div><div class="spec-doc"><p>Whether the compiler was configured to generate each function in a separate section</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-windows_unicode"><a href="#val-windows_unicode" class="anchor"></a><code><span><span class="keyword">val</span> windows_unicode : bool</span></code></div><div class="spec-doc"><p>Whether Windows Unicode runtime is enabled</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-naked_pointers"><a href="#val-naked_pointers" class="anchor"></a><code><span><span class="keyword">val</span> naked_pointers : bool</span></code></div><div class="spec-doc"><p>Whether the runtime supports naked pointers</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.14.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-supports_shared_libraries"><a href="#val-supports_shared_libraries" class="anchor"></a><code><span><span class="keyword">val</span> supports_shared_libraries : bool</span></code></div><div class="spec-doc"><p>Whether shared libraries are supported</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.08.0</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-afl_instrument"><a href="#val-afl_instrument" class="anchor"></a><code><span><span class="keyword">val</span> afl_instrument : bool</span></code></div><div class="spec-doc"><p>Whether afl-fuzz instrumentation is generated by default</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_config"><a href="#val-print_config" class="anchor"></a><code><span><span class="keyword">val</span> print_config : <span><a href="../Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Access to configuration values</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-config_var"><a href="#val-config_var" class="anchor"></a><code><span><span class="keyword">val</span> config_var : <span>string <span class="arrow">&#45;&gt;</span></span> <span>string option</span></span></code></div><div class="spec-doc"><p>the configuration value of a variable, if it exists</p></div></div></div></body></html>