155 lines
6.3 KiB
OCaml
155 lines
6.3 KiB
OCaml
(**************************************************************************)
|
|
(* *)
|
|
(* OCaml *)
|
|
(* *)
|
|
(* Xavier Leroy, projet Gallium, INRIA Rocquencourt *)
|
|
(* Pierre Chambart, OCamlPro *)
|
|
(* Mark Shinwell and Leo White, Jane Street Europe *)
|
|
(* *)
|
|
(* Copyright 2010 Institut National de Recherche en Informatique et *)
|
|
(* en Automatique *)
|
|
(* Copyright 2013--2016 OCamlPro SAS *)
|
|
(* Copyright 2014--2016 Jane Street Group LLC *)
|
|
(* *)
|
|
(* All rights reserved. This file is distributed under the terms of *)
|
|
(* the GNU Lesser General Public License version 2.1, with the *)
|
|
(* special exception on linking described in the file LICENSE. *)
|
|
(* *)
|
|
(**************************************************************************)
|
|
|
|
(* Compilation environments for compilation units *)
|
|
|
|
open Cmx_format
|
|
|
|
(* CR-soon mshinwell: this is a bit ugly
|
|
mshinwell: deferred CR, this has been addressed in the export info
|
|
improvement feature.
|
|
*)
|
|
val imported_sets_of_closures_table
|
|
: Flambda.function_declarations Set_of_closures_id.Tbl.t
|
|
(* flambda-only *)
|
|
|
|
val reset: ?packname:string -> source_provenance:Timings.source_provenance ->
|
|
string -> unit
|
|
(* Reset the environment and record the name of the unit being
|
|
compiled (arg). Optional argument is [-for-pack] prefix. *)
|
|
|
|
val unit_id_from_name: string -> Ident.t
|
|
(* flambda-only *)
|
|
|
|
val current_unit_infos: unit -> unit_infos
|
|
(* Return the infos for the unit being compiled *)
|
|
|
|
val current_unit_name: unit -> string
|
|
(* Return the name of the unit being compiled
|
|
clambda-only *)
|
|
|
|
val current_unit_linkage_name: unit -> Linkage_name.t
|
|
(* Return the linkage_name of the unit being compiled.
|
|
flambda-only *)
|
|
|
|
val current_build: unit -> Timings.source_provenance
|
|
(* Return the kind of build source being compiled. If it is a
|
|
file compilation it also provides the filename. *)
|
|
|
|
val current_unit: unit -> Compilation_unit.t
|
|
(* flambda-only *)
|
|
|
|
val current_unit_symbol: unit -> Symbol.t
|
|
(* flambda-only *)
|
|
|
|
val make_symbol: ?unitname:string -> string option -> string
|
|
(* [make_symbol ~unitname:u None] returns the asm symbol that
|
|
corresponds to the compilation unit [u] (default: the current unit).
|
|
[make_symbol ~unitname:u (Some id)] returns the asm symbol that
|
|
corresponds to symbol [id] in the compilation unit [u]
|
|
(or the current unit). *)
|
|
|
|
val symbol_in_current_unit: string -> bool
|
|
(* Return true if the given asm symbol belongs to the
|
|
current compilation unit, false otherwise. *)
|
|
|
|
val is_predefined_exception: Symbol.t -> bool
|
|
(* flambda-only *)
|
|
|
|
val unit_for_global: Ident.t -> Compilation_unit.t
|
|
(* flambda-only *)
|
|
|
|
val symbol_for_global: Ident.t -> string
|
|
(* Return the asm symbol that refers to the given global identifier
|
|
flambda-only *)
|
|
val symbol_for_global': Ident.t -> Symbol.t
|
|
(* flambda-only *)
|
|
val global_approx: Ident.t -> Clambda.value_approximation
|
|
(* Return the approximation for the given global identifier
|
|
clambda-only *)
|
|
val set_global_approx: Clambda.value_approximation -> unit
|
|
(* Record the approximation of the unit being compiled
|
|
clambda-only *)
|
|
val record_global_approx_toplevel: unit -> unit
|
|
(* Record the current approximation for the current toplevel phrase
|
|
clambda-only *)
|
|
|
|
val set_export_info: Export_info.t -> unit
|
|
(* Record the informations of the unit being compiled
|
|
flambda-only *)
|
|
val approx_env: unit -> Export_info.t
|
|
(* Returns all the information loaded from extenal compilation units
|
|
flambda-only *)
|
|
val approx_for_global: Compilation_unit.t -> Export_info.t
|
|
(* Loads the exported information declaring the compilation_unit
|
|
flambda-only *)
|
|
|
|
val need_curry_fun: int -> unit
|
|
val need_apply_fun: int -> unit
|
|
val need_send_fun: int -> unit
|
|
(* Record the need of a currying (resp. application,
|
|
message sending) function with the given arity *)
|
|
|
|
val new_const_symbol : unit -> string
|
|
val closure_symbol : Closure_id.t -> Symbol.t
|
|
(* Symbol of a function if the function is
|
|
closed (statically allocated)
|
|
flambda-only *)
|
|
val function_label : Closure_id.t -> string
|
|
(* linkage name of the code of a function
|
|
flambda-only *)
|
|
|
|
val new_structured_constant:
|
|
Clambda.ustructured_constant ->
|
|
shared:bool -> (* can be shared with another structually equal constant *)
|
|
string
|
|
val structured_constants:
|
|
unit -> Clambda.preallocated_constant list
|
|
val clear_structured_constants: unit -> unit
|
|
val add_exported_constant: string -> unit
|
|
(* clambda-only *)
|
|
type structured_constants
|
|
(* clambda-only *)
|
|
val snapshot: unit -> structured_constants
|
|
(* clambda-only *)
|
|
val backtrack: structured_constants -> unit
|
|
(* clambda-only *)
|
|
|
|
val read_unit_info: string -> unit_infos * Digest.t
|
|
(* Read infos and MD5 from a [.cmx] file. *)
|
|
val write_unit_info: unit_infos -> string -> unit
|
|
(* Save the given infos in the given file *)
|
|
val save_unit_info: string -> unit
|
|
(* Save the infos for the current unit in the given file *)
|
|
val cache_unit_info: unit_infos -> unit
|
|
(* Enter the given infos in the cache. The infos will be
|
|
honored by [symbol_for_global] and [global_approx]
|
|
without looking at the corresponding .cmx file. *)
|
|
|
|
val read_library_info: string -> library_infos
|
|
|
|
type error =
|
|
Not_a_unit_info of string
|
|
| Corrupted_unit_info of string
|
|
| Illegal_renaming of string * string * string
|
|
|
|
exception Error of error
|
|
|
|
val report_error: Format.formatter -> error -> unit
|