blob: bdb7d040845ab6381e4a55c9d35bcb820d7c2813 [file] [log] [blame]
Peter Zotov578267f2013-11-06 09:21:25 +00001(*===-- llvm_irreader.mli - LLVM OCaml Interface --------------*- OCaml -*-===*
2 *
Chandler Carruth2946cd72019-01-19 08:50:56 +00003 * Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 * See https://llvm.org/LICENSE.txt for license information.
5 * SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Peter Zotov578267f2013-11-06 09:21:25 +00006 *
7 *===----------------------------------------------------------------------===*)
8
9(** IR reader.
10
11 This interface provides an OCaml API for the LLVM assembly reader, the
12 classes in the IRReader library. *)
13
14exception Error of string
15
16(** [parse_ir context mb] parses the IR for a new module [m] from the
17 memory buffer [mb] in the context [context]. Returns [m] if successful, or
18 raises [Error msg] otherwise, where [msg] is a description of the error
19 encountered. See the function [llvm::ParseIR]. *)
20val parse_ir : Llvm.llcontext -> Llvm.llmemorybuffer -> Llvm.llmodule