forked from OSchip/llvm-project
27 lines
1.2 KiB
OCaml
27 lines
1.2 KiB
OCaml
(*===-- llvm_bitreader.mli - LLVM OCaml Interface -------------*- OCaml -*-===*
|
|
*
|
|
* Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
* See https://llvm.org/LICENSE.txt for license information.
|
|
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
*
|
|
*===----------------------------------------------------------------------===*)
|
|
|
|
(** Bitcode reader.
|
|
|
|
This interface provides an OCaml API for the LLVM bitcode reader, the
|
|
classes in the Bitreader library. *)
|
|
|
|
exception Error of string
|
|
|
|
(** [get_module context mb] reads the bitcode for a new module [m] from the
|
|
memory buffer [mb] in the context [context]. Returns [m] if successful, or
|
|
raises [Error msg] otherwise, where [msg] is a description of the error
|
|
encountered. See the function [llvm::getBitcodeModule]. *)
|
|
val get_module : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule
|
|
|
|
(** [parse_bitcode context mb] parses the bitcode for a new module [m] from the
|
|
memory buffer [mb] in the context [context]. Returns [m] if successful, or
|
|
raises [Error msg] otherwise, where [msg] is a description of the error
|
|
encountered. See the function [llvm::ParseBitcodeFile]. *)
|
|
val parse_bitcode : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule
|