ocaml-base-compiler

API

Library bigarray

• Bigarray Large, multi-dimensional, numerical arrays.

Library dynlink

• Dynlink Dynamic loading of .cmo, .cma and .cmxs files.

Library ocamlbytecomp

• Bytegen
• Bytelibrarian
• Bytelink
• Bytepackager
• Compile Bytecode compilation for .ml and .mli files.
• Emitcode
• Errors
• Instruct
• Printinstr

Library ocamlcommon

• Annot
• Arg_helper Decipher command line arguments of the form <value> | <key>=<value>,...
• Ast_helper Helpers to produce Parsetree fragments
• Ast_invariants Check AST invariants
• Ast_iterator iterator enables AST inspection using open recursion. A typical mapper would be based on default_iterator, a trivial iterator, and will fall back on it for handling the syntax it does not modify.
• Ast_mapper The interface of a -ppx rewriter
• Asttypes Auxiliary AST types used by parsetree and typedtree.
• Attr_helper Helpers for attributes
• Btype
• Build_path_prefix_map Rewrite paths for reproducible builds
• Builtin_attributes Support for some of the builtin attributes
• Bytesections Recording sections written to a bytecode executable file
• CamlinternalMenhirLib
• Ccomp Compiling C files and building C libraries
• Clflags Command line flags
• Cmi_format
• Cmo_format
• Cmt_format cmt and cmti files format.
• Cmxs_format
• Compenv
• Compile_common Common compilation pipeline between bytecode and native.
• Compmisc
• Config System configuration
• Consistbl Consistency tables: for checking consistency of module CRCs
• Ctype
• Datarepr
• Debuginfo
• Depend Module dependencies.
• Dll
• Docstrings Documentation comments
• Domainstate
• Env
• Envaux
• Expunge
• Ident
• Identifiable Uniform interface for common data structures over various things.
• Includeclass
• Includecore
• Includemod
• Int_replace_polymorphic_compare
• Lambda
• Lexer The lexical analyzer
• Load_path Management of include directories.
• Location
• Longident Long identifiers, used in parsetree.
• Main_args
• Makedepend
• Matching
• Meta
• Misc Miscellaneous useful types and functions
• Mtype
• Numbers Modules about numbers, some of which satisfy Identifiable.S.
• Opcodes
• Oprint
• Outcometree
• Parmatch Detection of partial matches and unused match cases.
• Parse Entry points in the parser
• Parser
• Parsetree Abstract syntax tree produced by parsing
• Path
• Persistent_env
• Pparse Driver for the parser and external preprocessors.
• Pprintast Pretty-printers for Parsetree
• Predef
• Primitive
• Printast Raw printer for Parsetree
• Printlambda
• Printpat
• Printtyp
• Printtyped
• Profile Compiler performance recording
• Rec_check
• Runtimedef
• Simplif Lambda simplification.
• Strongly_connected_components Kosaraju's algorithm for strongly connected components.
• Stypes
• Subst
• Switch
• Symtable
• Syntaxerr Auxiliary type for reporting syntax errors
• Targetint Target processor-native integers.
• Tast_iterator Allows the implementation of typed tree inspection using open recursion
• Tast_mapper
• Terminfo Basic interface to the terminfo database
• Translattribute
• Translclass
• Translcore
• Translmod
• Translobj
• Translprim
• Type_immediacy Immediacy status of a type
• Typeclass
• Typecore
• Typedecl
• Typedecl_immediacy
• Typedecl_properties
• Typedecl_unboxed
• Typedecl_variance
• Typedtree Abstract syntax tree after typing
• Typemod Type-checking of the module language and typed ast hooks
• Typeopt
• Types
• Typetexp
• Untypeast
• Warnings Warning definitions

Library ocamlmiddleend

• Alias_analysis
• Allocated_const Constants that are always allocated (possibly statically). Blocks are not included here since they are always encoded using Prim (Pmakeblock, ...).
• Augment_specialised_args Helper module for adding specialised arguments to sets of closures.
• Backend_var Variables used in the backend, optionally equipped with "provenance" information, used for the emission of debugging information.
• Build_export_info Construct export information, for emission into .cmx files, from an Flambda program.
• Clambda
• Clambda_primitives
• Closure
• Closure_conversion
• Closure_conversion_aux Environments and auxiliary structures used during closure conversion.
• Closure_element
• Closure_id CR-someday lwhite: "Closure_id" is quite a generic name. I wonder whether something like "Closure_label" would better capture that it is the label of a projection.
• Closure_middle_end
• Closure_offsets Assign numerical offsets, within closure blocks, for code pointers and environment entries.
• Closure_origin
• Compilation_unit
• Compilenv
• Convert_primitives
• Effect_analysis Simple side effect analysis.
• Export_id
• Export_info Exported information (that is to say, information written into a .cmx file) about a compilation unit.
• Export_info_for_pack Transformations on export information that are only used for the building of packs.
• Extract_projections Identify projections from variables used in function bodies (free variables or specialised args, for example, according to which_variables below). Projections from variables that are also used boxed are not returned.
• Find_recursive_functions "Recursive functions" are those functions f that might call either:
• Flambda Intermediate language used for tree-based analysis and optimization.
• Flambda_invariants
• Flambda_iterators
• Flambda_middle_end Translate Lambda code to Flambda code, optimize it, and produce Clambda.
• Flambda_to_clambda
• Flambda_utils Utility functions for the Flambda intermediate language.
• Freshening Freshening of various identifiers.
• Id_types
• Import_approx Create simple value approximations from the export information in .cmx files.
• Inconstant_idents
• Initialize_symbol_to_let_symbol
• Inline_and_simplify
• Inline_and_simplify_aux Environments and result structures used during inlining and simplification. (See inline_and_simplify.ml.)
• Inlining_cost Measurement of the cost (including cost in space) of Flambda terms in the context of inlining.
• Inlining_decision See the Flambda manual chapter for an explanation in prose of the inlining decision procedure.
• Inlining_stats
• Inlining_stats_types
• Inlining_transforms Source code transformations used during inlining.
• Internal_variable_names
• Invariant_params
• Lift_code
• Lift_constants The aim of this pass is to assign symbols to values known to be constant (in other words, whose values we know at compile time), with appropriate sharing of constants, and replace the occurrences of the constants with their corresponding symbols.
• Lift_let_to_initialize_symbol
• Linkage_name
• Mutable_variable
• Parameter Parameter.t carries a unique Variable.t used as function parameter. It can also carry annotations about the usage of the variable.
• Pass_wrapper
• Printclambda
• Printclambda_primitives
• Projection Representation of projections from closures and blocks.
• Ref_to_variables Transform let-bound references into variables.
• Remove_free_vars_equal_to_args Replace free variables in closures known to be equal to specialised arguments of such closures with those specialised arguments.
• Remove_unused_arguments
• Remove_unused_closure_vars
• Remove_unused_program_constructs
• Semantics_of_primitives Description of the semantics of primitives, to be used for optimization purposes.
• Set_of_closures_id An identifier, unique across the whole program, that identifies a set of closures (viz. Set_of_closures).
• Set_of_closures_origin
• Share_constants Share lifted constants that are eligible for sharing (e.g. not strings) and have equal definitions.
• Simple_value_approx Simple approximations to the runtime results of computations. This pass is designed for speed rather than accuracy; the performance is important since it is used heavily during inlining.
• Simplify_boxed_integer_ops
• Simplify_common const_*_expr expr v annot, where the expression expr is known to evaluate to the value v, attempt to produce a more simple expression together with its approximation and the benefit gained by replacing expr with this new expression. This simplification is only performed if expr is known to have no side effects. Otherwise, expr itself is returned, with an appropriate approximation but zero benefit.
• Simplify_primitives
• Static_exception An identifier that is used to label static exceptions. Its uniqueness properties are unspecified.
• Symbol A symbol identifies a constant provided by either:
• Tag Tags on runtime boxed values.
• Traverse_for_exported_symbols
• Un_anf
• Unbox_closures Turn free variables of closures into specialised arguments. The aim is to cause the closure to become closed.
• Unbox_free_vars_of_closures When approximations of free variables of closures indicate that they are closures or blocks, rewrite projections from such blocks to new variables (which become free in the closures), with the defining expressions of the projections lifted out of the corresponding sets of closures.
• Unbox_specialised_args When approximations of specialised arguments indicate that they are closures or blocks, add more specialised arguments corresponding to the projections from such blocks (with definitions of such projections lifted out), such that the original specialised arguments may later be eliminated.
• Var_within_closure An identifier, unique across the whole program, that identifies a particular variable within a particular closure. Only Project_var, and not Var, nodes are tagged with these identifiers.
• Variable Variable.t is the equivalent of a non-persistent Ident.t in the Flambda tree. It wraps an Ident.t together with its source compilation_unit. As such, it is unique within a whole program, not just one compilation unit.

Library ocamloptcomp

• Afl_instrument Instrumentation for afl-fuzz.
• Alias_analysis
• Allocated_const Constants that are always allocated (possibly statically). Blocks are not included here since they are always encoded using Prim (Pmakeblock, ...).
• Arch
• Asmgen From Lambda to assembly code
• Asmlibrarian
• Asmlink
• Asmpackager
• Augment_specialised_args Helper module for adding specialised arguments to sets of closures.
• Available_regs Available registers analysis used to determine which variables may be shown in the debugger.
• Backend_intf Knowledge that the middle end needs about the backend.
• Backend_var Variables used in the backend, optionally equipped with "provenance" information, used for the emission of debugging information.
• Branch_relaxation
• Branch_relaxation_intf
• Build_export_info Construct export information, for emission into .cmx files, from an Flambda program.
• CSE
• CSEgen
• Clambda
• Clambda_primitives
• Closure
• Closure_conversion
• Closure_conversion_aux Environments and auxiliary structures used during closure conversion.
• Closure_element
• Closure_id CR-someday lwhite: "Closure_id" is quite a generic name. I wonder whether something like "Closure_label" would better capture that it is the label of a projection.
• Closure_middle_end
• Closure_offsets Assign numerical offsets, within closure blocks, for code pointers and environment entries.
• Closure_origin
• Cmm
• Cmm_helpers
• Cmmgen
• Cmmgen_state Mutable state used by Cmmgen.
• Cmx_format
• Coloring
• Comballoc
• Compilation_unit
• Compilenv
• Compute_ranges Coalescing of per-instruction information into possibly-discontiguous regions of code delimited by labels. This is used for collating register availability and lexical block scoping information into a concise form.
• Compute_ranges_intf This file defines types that are used to specify the interface of Compute_ranges. The description of Compute_ranges is:
• Convert_primitives
• Deadcode
• Effect_analysis Simple side effect analysis.
• Emit
• Emitaux
• Export_id
• Export_info Exported information (that is to say, information written into a .cmx file) about a compilation unit.
• Export_info_for_pack Transformations on export information that are only used for the building of packs.
• Extract_projections Identify projections from variables used in function bodies (free variables or specialised args, for example, according to which_variables below). Projections from variables that are also used boxed are not returned.
• Find_recursive_functions "Recursive functions" are those functions f that might call either:
• Flambda Intermediate language used for tree-based analysis and optimization.
• Flambda_invariants
• Flambda_iterators
• Flambda_middle_end Translate Lambda code to Flambda code, optimize it, and produce Clambda.
• Flambda_to_clambda
• Flambda_utils Utility functions for the Flambda intermediate language.
• Freshening Freshening of various identifiers.
• Id_types
• Import_approx Create simple value approximations from the export information in .cmx files.
• Inconstant_idents
• Initialize_symbol_to_let_symbol
• Inline_and_simplify
• Inline_and_simplify_aux Environments and result structures used during inlining and simplification. (See inline_and_simplify.ml.)
• Inlining_cost Measurement of the cost (including cost in space) of Flambda terms in the context of inlining.
• Inlining_decision See the Flambda manual chapter for an explanation in prose of the inlining decision procedure.
• Inlining_decision_intf
• Inlining_stats
• Inlining_stats_types
• Inlining_transforms Source code transformations used during inlining.
• Interf
• Internal_variable_names
• Interval
• Invariant_params
• Lift_code
• Lift_constants The aim of this pass is to assign symbols to values known to be constant (in other words, whose values we know at compile time), with appropriate sharing of constants, and replace the occurrences of the constants with their corresponding symbols.
• Lift_let_to_initialize_symbol
• Linear
• Linearize
• Linkage_name
• Linscan
• Liveness
• Mach
• Mutable_variable
• Optcompile Native compilation for .ml and .mli files.
• Opterrors
• Parameter Parameter.t carries a unique Variable.t used as function parameter. It can also carry annotations about the usage of the variable.
• Pass_wrapper
• Printclambda
• Printclambda_primitives
• Printcmm
• Printlinear
• Printmach
• Proc
• Projection Representation of projections from closures and blocks.
• Ref_to_variables Transform let-bound references into variables.
• Reg
• Reg_availability_set Register availability sets.
• Reg_with_debug_info Registers equipped with information used for generating debugging information.
• Reload
• Reloadgen
• Remove_free_vars_equal_to_args Replace free variables in closures known to be equal to specialised arguments of such closures with those specialised arguments.
• Remove_unused_arguments
• Remove_unused_closure_vars
• Remove_unused_program_constructs
• Schedgen
• Scheduling
• Selectgen
• Selection
• Semantics_of_primitives Description of the semantics of primitives, to be used for optimization purposes.
• Set_of_closures_id An identifier, unique across the whole program, that identifies a set of closures (viz. Set_of_closures).
• Set_of_closures_origin
• Share_constants Share lifted constants that are eligible for sharing (e.g. not strings) and have equal definitions.
• Simple_value_approx Simple approximations to the runtime results of computations. This pass is designed for speed rather than accuracy; the performance is important since it is used heavily during inlining.
• Simplify_boxed_integer_ops
• Simplify_boxed_integer_ops_intf
• Simplify_common const_*_expr expr v annot, where the expression expr is known to evaluate to the value v, attempt to produce a more simple expression together with its approximation and the benefit gained by replacing expr with this new expression. This simplification is only performed if expr is known to have no side effects. Otherwise, expr itself is returned, with an appropriate approximation but zero benefit.
• Simplify_primitives
• Spacetime_profiling Insertion of instrumentation code for Spacetime profiling.
• Spill
• Split
• Static_exception An identifier that is used to label static exceptions. Its uniqueness properties are unspecified.
• Strmatch
• Symbol A symbol identifies a constant provided by either:
• Tag Tags on runtime boxed values.
• Traverse_for_exported_symbols
• Un_anf
• Unbox_closures Turn free variables of closures into specialised arguments. The aim is to cause the closure to become closed.
• Unbox_free_vars_of_closures When approximations of free variables of closures indicate that they are closures or blocks, rewrite projections from such blocks to new variables (which become free in the closures), with the defining expressions of the projections lifted out of the corresponding sets of closures.
• Unbox_specialised_args When approximations of specialised arguments indicate that they are closures or blocks, add more specialised arguments corresponding to the projections from such blocks (with definitions of such projections lifted out), such that the original specialised arguments may later be eliminated.
• Var_within_closure An identifier, unique across the whole program, that identifies a particular variable within a particular closure. Only Project_var, and not Var, nodes are tagged with these identifiers.
• Variable Variable.t is the equivalent of a non-persistent Ident.t in the Flambda tree. It wraps an Ident.t together with its source compilation_unit. As such, it is unique within a whole program, not just one compilation unit.
• X86_ast Structured representation of Intel assembly language (32 and 64 bit).
• X86_dsl Helpers for Intel code generators
• X86_gas Emit assembly instructions for gas.
• X86_masm Emit assembly instructions for MASM (Intel syntax).
• X86_proc Definitions shared between the 32 and 64 bit Intel backends.

Library ocamltoplevel

• Genprintval
• Topdirs
• Toploop
• Topmain
• Trace

Library odoc_info

• Odoc_info Interface to the information collected in source files.

Library raw_spacetime_lib

• Raw_spacetime_lib Access to the information recorded by the Spacetime module. (It is intended that this module will be used by post-processors rather than users wishing to understand their programs.) For 64-bit targets only. This module may be used from any program, not just one compiled with a compiler configured for Spacetime.

Library stdlib

• CamlinternalFormat
• CamlinternalFormatBasics
• CamlinternalLazy Run-time support for lazy values. All functions in this module are for system use only, not for the casual user.
• CamlinternalMod Run-time support for recursive modules. All functions in this module are for system use only, not for the casual user.
• CamlinternalOO Run-time support for objects and classes. All functions in this module are for system use only, not for the casual user.
• Stdlib The OCaml Standard library.
• Topdirs

Library str

• Str Regular expressions and high-level string processing

Library threads

• Condition Condition variables to synchronize between threads.
• Event First-class synchronous communication.
• Mutex Locks for mutual exclusion.
• Thread Lightweight threads for Posix 1003.1c and Win32.
• ThreadUnix Thread-compatible system calls.

Library unix

• Unix Interface to the Unix system.
• UnixLabels Interface to the Unix system. To use as replacement to default Unix module, add module Unix = UnixLabels in your implementation.