maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Adding Ocaml bindings for the bitreader as requested by Sarah 

Thompson. Usage should be something like this:

open Llvm
open Llvm_bitreader

match read_bitcode_file fn with
  | Bitreader_failure msg ->
      prerr_endline msg
  | Bitreader_success m -> 
      ...;
      dispose_module m

Compile with: ocamlc llvm.cma llvm_bitreader.cma
              ocamlopt llvm.cmxa llvm_bitreader.cmxa

llvm-svn: 44824
This commit is contained in:
Gordon Henriksen 2007-12-11 00:20:48 +00:00
parent f727faf2ed
commit 2b0eed278b
8 changed files with 217 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
llvm/bindings/ocaml/Makefile
View File

@ -8,6 +8,6 @@
##===----------------------------------------------------------------------===##
LEVEL := ../..
DIRS = llvm bitwriter analysis
DIRS = llvm bitreader bitwriter analysis
include $(LEVEL)/Makefile.common

20
llvm/bindings/ocaml/bitreader/Makefile Normal file
View File

@ -0,0 +1,20 @@
##===- bindings/ocaml/bitreader/Makefile -------------------*- Makefile -*-===##
#
# The LLVM Compiler Infrastructure
#
# This file was developed by Gordon Henriksen and is distributed under the
# University of Illinois Open Source License. See LICENSE.TXT for details.
#
##===----------------------------------------------------------------------===##
#
# This is the makefile for the Objective Caml Llvm_bitreader interface.
#
##===----------------------------------------------------------------------===##
LEVEL := ../../..
LIBRARYNAME := llvm_bitreader
DONT_BUILD_RELINKED := 1
UsedComponents := bitreader
UsedOcamlInterfaces := llvm
include ../Makefile.ocaml

46
llvm/bindings/ocaml/bitreader/bitreader_ocaml.c Normal file
View File

@ -0,0 +1,46 @@
/*===-- bitwriter_ocaml.c - LLVM Ocaml Glue ---------------------*- C++ -*-===*\
|* *|
|* The LLVM Compiler Infrastructure *|
|* *|
|* This file was developed by Gordon Henriksen and is distributed under the *|
|* University of Illinois Open Source License. See LICENSE.TXT for details. *|
|* *|
|*===----------------------------------------------------------------------===*|
|* *|
|* This file glues LLVM's ocaml interface to its C interface. These functions *|
|* are by and large transparent wrappers to the corresponding C functions. *|
|* *|
\*===----------------------------------------------------------------------===*/
#include "llvm-c/BitReader.h"
#include "caml/alloc.h"
#include "caml/mlvalues.h"
#include "caml/memory.h"
/*===-- Modules -----------------------------------------------------------===*/
/* string -> bitreader_result
type bitreader_result =
| Bitreader_success of Llvm.llmodule
| Bitreader_failure of string
*/
CAMLprim value llvm_read_bitcode_file(value Path) {
LLVMModuleRef M;
char *Message;
CAMLparam1(Path);
CAMLlocal2(Variant, MessageVal);
if (LLVMReadBitcodeFromFile(String_val(Path), &M, &Message)) {
MessageVal = copy_string(Message);
LLVMDisposeBitcodeReaderMessage(Message);
Variant = alloc(1, 1);
Field(Variant, 0) = MessageVal;
} else {
Variant = alloc(1, 0);
Field(Variant, 0) = Val_op(M);
}
CAMLreturn(Variant);
}

17
llvm/bindings/ocaml/bitreader/llvm_bitreader.ml Normal file
View File

@ -0,0 +1,17 @@
(*===-- llvm_bitreader.ml - LLVM Ocaml Interface ----------------*- C++ -*-===*
*
* The LLVM Compiler Infrastructure
*
* This file was developed by Gordon Henriksen and is distributed under the
* University of Illinois Open Source License. See LICENSE.TXT for details.
*
*===----------------------------------------------------------------------===*)
type bitreader_result =
| Bitreader_success of Llvm.llmodule
| Bitreader_failure of string
external read_bitcode_file : string -> bitreader_result
= "llvm_read_bitcode_file"

25
llvm/bindings/ocaml/bitreader/llvm_bitreader.mli Normal file
View File

@ -0,0 +1,25 @@
(*===-- llvm_bitreader.mli - LLVM Ocaml Interface ---------------*- C++ -*-===*
*
* The LLVM Compiler Infrastructure
*
* This file was developed by Gordon Henriksen and is distributed under the
* University of Illinois Open Source License. See LICENSE.TXT for details.
*
*===----------------------------------------------------------------------===
*
* This interface provides an ocaml API for the LLVM bitcode reader, the
* classes in the Bitreader library.
*
*===----------------------------------------------------------------------===*)
type bitreader_result =
| Bitreader_success of Llvm.llmodule
| Bitreader_failure of string
(** [read_bitcode_file path] reads the bitcode for module [m] from the file at
[path]. Returns [Reader_success m] if successful, and [Reader_failure msg]
otherwise, where [msg] is a description of the error encountered. **)
external read_bitcode_file : string -> bitreader_result
= "llvm_read_bitcode_file"

43
llvm/include/llvm-c/BitReader.h Normal file
View File

@ -0,0 +1,43 @@
/*===-- llvm-c/BitReader.h - BitReader Library C Interface ------*- C++ -*-===*\
|* *|
|* The LLVM Compiler Infrastructure *|
|* *|
|* This file was developed by Gordon Henriksen and is distributed under the *|
|* University of Illinois Open Source License. See LICENSE.TXT for details. *|
|* *|
|*===----------------------------------------------------------------------===*|
|* *|
|* This header declares the C interface to libLLVMBitReader.a, which *|
|* implements input of the LLVM bitcode format. *|
|* *|
|* Many exotic languages can interoperate with C code but have a harder time *|
|* with C++ due to name mangling. So in addition to C, this interface enables *|
|* tools written in such languages. *|
|* *|
\*===----------------------------------------------------------------------===*/
#ifndef LLVM_C_BITCODEREADER_H
#define LLVM_C_BITCODEREADER_H
#include "llvm-c/Core.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Reads a module from the specified path, returning a reference to the module
via the OutModule parameter. Returns 0 on success. Optionally returns a
human-readable error message. */
int LLVMReadBitcodeFromFile(const char *Path, LLVMModuleRef *OutModule,
char **OutMessage);
/* Disposes of the message allocated by the bitcode reader, if any. */
void LLVMDisposeBitcodeReaderMessage(char *Message);
#ifdef __cplusplus
}
#endif
#endif

42
llvm/lib/Bitcode/Reader/BitReader.cpp Normal file
View File

@ -0,0 +1,42 @@
//===-- BitReader.cpp -----------------------------------------------------===//
//
// The LLVM Compiler Infrastructure
//
// This file was developed by Gordon Henriksen and is distributed under the
// University of Illinois Open Source License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "llvm-c/BitReader.h"
#include "llvm/Bitcode/ReaderWriter.h"
#include "llvm/Support/MemoryBuffer.h"
#include <string>
using namespace llvm;
int LLVMReadBitcodeFromFile(const char *Path, LLVMModuleRef *OutModule,
char **OutMessage) {
std::string Message;
MemoryBuffer *buf = MemoryBuffer::getFile(Path, strlen(Path), &Message);
if (!buf) {
if (!OutMessage)
*OutMessage = strdup(Message.c_str());
return 1;
}
*OutModule = wrap(ParseBitcodeFile(buf, &Message));
if (!*OutModule) {
if (OutMessage)
*OutMessage = strdup(Message.c_str());
return 1;
}
return 0;
}
void LLVMDisposeBitcodeReaderMessage(char *Message) {
if (Message)
free(Message);
}

23
llvm/test/Bindings/Ocaml/bitreader.ml Normal file
View File

@ -0,0 +1,23 @@
(* RUN: %ocamlc llvm.cma llvm_bitreader.cma llvm_bitwriter.cma %s -o %t
* RUN: ./%t %t.bc
* RUN: llvm-dis < %t.bc | grep caml_int_ty
*)
(* Note that this takes a moment to link, so it's best to keep the number of
individual tests low. *)
let test x = if not x then exit 1 else ()
let _ =
let fn = Sys.argv.(1) in
let m = Llvm.create_module "ocaml_test_module" in
ignore (Llvm.define_type_name "caml_int_ty" Llvm.i32_type m);
test (Llvm_bitwriter.write_bitcode_file m fn);
Llvm.dispose_module m;
test (match Llvm_bitreader.read_bitcode_file fn with
| Llvm_bitreader.Bitreader_success m -> Llvm.dispose_module m; true
| Llvm_bitreader.Bitreader_failure _ -> false)