ocaml/bytecomp/cmo_format.mli

63 lines
3.0 KiB
OCaml

(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 2006 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* 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. *)
(* *)
(**************************************************************************)
(* Symbol table information for .cmo and .cma files *)
(* Relocation information *)
type reloc_info =
Reloc_literal of Lambda.structured_constant (* structured constant *)
| Reloc_getglobal of Ident.t (* reference to a global *)
| Reloc_setglobal of Ident.t (* definition of a global *)
| Reloc_primitive of string (* C primitive number *)
(* Descriptor for compilation units *)
type compilation_unit =
{ cu_name: string; (* Name of compilation unit *)
mutable cu_pos: int; (* Absolute position in file *)
cu_codesize: int; (* Size of code block *)
cu_reloc: (reloc_info * int) list; (* Relocation information *)
cu_imports:
(string * Digest.t option) list; (* Names and CRC of intfs imported *)
cu_primitives: string list; (* Primitives declared inside *)
mutable cu_force_link: bool; (* Must be linked even if unref'ed *)
mutable cu_debug: int; (* Position of debugging info, or 0 *)
cu_debugsize: int } (* Length of debugging info *)
(* Format of a .cmo file:
magic number (Config.cmo_magic_number)
absolute offset of compilation unit descriptor
block of relocatable bytecode
debugging information if any
compilation unit descriptor *)
(* Descriptor for libraries *)
type library =
{ lib_units: compilation_unit list; (* List of compilation units *)
lib_custom: bool; (* Requires custom mode linking? *)
lib_ccobjs: string list; (* C object files needed for -custom *)
lib_ccopts: string list; (* Extra opts to C compiler *)
lib_dllibs: string list } (* DLLs needed *)
(* Format of a .cma file:
magic number (Config.cma_magic_number)
absolute offset of library descriptor
object code for first library member
...
object code for last library member
library descriptor *)