ocaml-base-compiler 5.2.0

Libraries

This package provides the following libraries (via ocamlobjinfo):

unix

Documentation:

• Unix Interface to the Unix system.
• UnixLabels Interface to the Unix system.

threads

Documentation:

• Thread Lightweight threads for Posix 1003.1c and Win32.
• Event First-class synchronous communication.

str

Documentation:

• Str Regular expressions and high-level string processing

runtime_events

Documentation:

• Runtime_events Runtime events - ring buffer-based runtime tracing

dynlink

Documentation:

• Dynlink_compilerlibs
• Dynlink_types
• Dynlink_platform_intf
• Dynlink_common
• Dynlink Dynamic loading of .cmo, .cma and .cmxs files.

compiler-libs.common

Documentation:

• Config System configuration
• Build_path_prefix_map Rewrite paths for reproducible builds
• Misc Miscellaneous useful types and functions
• Identifiable Uniform interface for common data structures over various things.
• Numbers Modules about numbers, some of which satisfy Identifiable.S.
• Arg_helper Decipher command line arguments of the form <value> | <key>=<value>,...
• Local_store This module provides some facilities for creating references (and hash tables) which can easily be snapshoted and restored to an arbitrary version.
• Load_path Management of include directories.
• Clflags Command line flags
• Profile Compiler performance recording
• Terminfo Basic interface to the terminfo database
• Ccomp Compiling C files and building C libraries
• Warnings Warning definitions
• Consistbl Consistency tables: for checking consistency of module CRCs
• Strongly_connected_components Kosaraju's algorithm for strongly connected components.
• Targetint Target processor-native integers.
• Int_replace_polymorphic_compare
• Domainstate
• Binutils
• Lazy_backtrack
• Diffing Parametric diffing
• Diffing_with_keys When diffing lists where each element has a distinct key, we can refine the diffing patch by introducing two composite edit moves: swaps and moves.
• Compression
• Location Source code locations (ranges of positions), used in parsetree.
• Unit_info This module centralize the handling of compilation files and their metadata.
• Longident Long identifiers, used in parsetree.
• Docstrings Documentation comments
• Syntaxerr Auxiliary type for reporting syntax errors
• Ast_helper Helpers to produce Parsetree fragments
• Ast_iterator Ast_iterator.iterator enables AST inspection using open recursion. A typical mapper would be based on Ast_iterator.default_iterator, a trivial iterator, and will fall back on it for handling the syntax it does not modify.
• Builtin_attributes Support for the builtin attributes:
• CamlinternalMenhirLib
• Parser
• Lexer The lexical analyzer
• Pprintast Pretty-printers for Parsetree
• Parse Entry points in the parser
• Printast Raw printer for Parsetree
• Ast_mapper The interface of a -ppx rewriter
• Attr_helper Helpers for attributes
• Ast_invariants Check AST invariants
• Depend Module dependencies.
• Ident
• Path
• Primitive
• Type_immediacy Immediacy status of a type
• Shape Shapes are an abstract representation of modules' implementations which allow the tracking of definitions through functor applications and other module-level operations.
• Types
• Btype
• Oprint
• Subst
• Predef
• Datarepr
• Cmi_format
• Persistent_env
• Env
• Errortrace
• Typedtree Abstract syntax tree after typing
• Signature_group Iterate on signature by syntactic group of items
• Printtyped
• Ctype
• Printtyp
• Includeclass
• Mtype
• Envaux
• Includecore
• Tast_iterator Allows the implementation of typed tree inspection using open recursion
• Tast_mapper
• Stypes
• Shape_reduce
• Cmt_format cmt and cmti files format.
• Cmt2annot
• Untypeast
• Includemod
• Includemod_errorprinter
• Typetexp
• Printpat
• Patterns
• Parmatch Detection of partial matches and unused match cases.
• Typedecl_properties
• Typedecl_variance
• Typedecl_unboxed
• Typedecl_immediacy
• Typedecl_separability The OCaml runtime assumes for type-directed optimizations that all types are "separable". A type is "separable" if either all its inhabitants (the values of this type) are floating-point numbers, or none of them are.
• Typeopt
• Typedecl
• Value_rec_check
• Typecore
• Typeclass
• Typemod Type-checking of the module language and typed ast hooks
• Debuginfo
• Lambda
• Printlambda
• Switch
• Matching
• Value_rec_compiler
• Translobj
• Translattribute
• Translprim
• Translcore
• Translclass
• Translmod
• Tmc Tail-modulo-cons optimization.
• Simplif Lambda simplification.
• Runtimedef
• Meta
• Opcodes
• Bytesections
• Dll
• Symtable
• Pparse Driver for the parser and external preprocessors.
• Compenv
• Main_args
• Compmisc
• Makedepend
• Compile_common Common compilation pipeline between bytecode and native.

compiler-libs.bytecomp

Documentation:

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

compiler-libs.optcomp

Documentation:

• Internal_variable_names
• Linkage_name
• Compilation_unit
• 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.
• 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.
• Symbol A symbol identifies a constant provided by either:
• Backend_var Variables used in the backend, optionally equipped with "provenance" information, used for the emission of debugging information.
• Clambda_primitives
• Printclambda_primitives
• Clambda
• Printclambda
• Semantics_of_primitives Description of the semantics of primitives, to be used for optimization purposes.
• Convert_primitives
• Id_types
• Export_id
• Tag Tags on runtime boxed values.
• Mutable_variable
• 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
• Closure_origin
• 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.
• Static_exception An identifier that is used to label static exceptions. Its uniqueness properties are unspecified.
• Pass_wrapper
• Allocated_const Constants that are always allocated (possibly statically). Blocks are not included here since they are always encoded using Prim (Pmakeblock, ...).
• Parameter Parameter.t carries a unique Variable.t used as function parameter. It can also carry annotations about the usage of the variable.
• Projection Representation of projections from closures and blocks.
• Flambda Intermediate language used for tree-based analysis and optimization.
• Flambda_iterators
• Flambda_utils Utility functions for the Flambda intermediate language.
• Freshening Freshening of various identifiers.
• Effect_analysis Simple side effect analysis.
• Inlining_cost Measurement of the cost (including cost in space) of Flambda terms in the context of inlining.
• 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.
• 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.
• Compilenv
• Closure
• Closure_middle_end
• Import_approx Create simple value approximations from the export information in .cmx files.
• Lift_code
• Closure_conversion_aux Environments and auxiliary structures used during closure conversion.
• Closure_conversion
• Initialize_symbol_to_let_symbol
• Lift_let_to_initialize_symbol
• Find_recursive_functions "Recursive functions" are those functions f that might call either:
• Invariant_params
• Inconstant_idents
• Alias_analysis
• 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.
• Share_constants Share lifted constants that are eligible for sharing (e.g. not strings) and have equal definitions.
• 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.
• Remove_unused_arguments
• Remove_unused_closure_vars
• Remove_unused_program_constructs
• Simplify_boxed_integer_ops
• Simplify_primitives
• Inlining_stats_types
• Inlining_stats
• Inline_and_simplify_aux Environments and result structures used during inlining and simplification. (See inline_and_simplify.ml.)
• 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.
• 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.
• Augment_specialised_args Helper module for adding specialised arguments to sets of closures.
• 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.
• Unbox_closures Turn free variables of closures into specialised arguments. The aim is to cause the closure to become closed.
• Inlining_transforms Source code transformations used during inlining.
• Inlining_decision See the Flambda manual chapter for an explanation in prose of the inlining decision procedure.
• Inline_and_simplify
• Ref_to_variables Transform let-bound references into variables.
• Flambda_invariants
• Traverse_for_exported_symbols
• Build_export_info Construct export information, for emission into .cmx files, from an Flambda program.
• Closure_offsets Assign numerical offsets, within closure blocks, for code pointers and environment entries.
• Un_anf
• Flambda_to_clambda
• Flambda_middle_end Translate Lambda code to Flambda code, optimize it, and produce Clambda.
• X86_proc Definitions shared between the 32 and 64 bit Intel backends.
• X86_dsl Helpers for Intel code generators
• X86_gas Emit assembly instructions for gas.
• X86_masm Emit assembly instructions for MASM (Intel syntax).
• Arch
• Cmm
• Printcmm
• Reg
• Mach
• Proc
• Strmatch
• Cmmgen_state Mutable state used by Cmmgen.
• Cmm_helpers
• Afl_instrument Instrumentation for afl-fuzz.
• Thread_sanitizer Instrumentation of memory accesses to use ThreadSanitizer (TSan) for data race detection. This module contains an instrumentation pass on Cmm, where most of the instrumentation happens.
• Cmmgen
• Cmm_invariants Check a number of continuation-related invariants
• Interval
• Printmach
• Dataflow
• Polling Analyses related to the insertion of Ipoll operations.
• Selectgen
• Selection
• Comballoc
• CSEgen
• CSE Common interface to all architecture-specific CSE modules
• Liveness
• Spill
• Split
• Interf
• Coloring
• Linscan
• Reloadgen
• Reload
• Deadcode
• Stackframegen
• Stackframe
• Linear
• Printlinear
• Linearize
• Linear_format
• Schedgen
• Scheduling
• Branch_relaxation
• Emitaux
• Emit
• Asmgen From Lambda to assembly code
• Asmlink
• Asmlibrarian
• Asmpackager
• Opterrors
• Optcompile Native compilation for .ml and .mli files.
• Optmaindriver

compiler-libs.toplevel

Documentation:

• Genprintval
• Topcommon This module provides common implementations for internals of Toploop, for bytecode and native code (see Topeval for the diverging parts of the implementation).
• Topeval This module provides two alternative implementations for internals of Toploop, for bytecode and native code.
• Trace
• Toploop
• Topprinters
• Topdirs
• Topmain