[OCaml] implement Llvm_passmgr_builder, bindings for PassManagerBuilder

llvm-svn: 193968

llvm/bindings/ocaml/llvm/META.llvm.in

@@ -62,6 +62,14 @@ package "vectorize" (
     archive(native) = "llvm_vectorize.cmxa"
 )
 
+package "passmgr_builder" (
+    requires = "llvm"
+    version = "@PACKAGE_VERSION@"
+    description = "Pass Manager Builder for LLVM"
+    archive(byte) = "llvm_passmgr_builder.cma"
+    archive(native) = "llvm_passmgr_builder.cmxa"
+)
+
 package "target" (
     requires = "llvm"
     version  = "@PACKAGE_VERSION@"

llvm/bindings/ocaml/transforms/Makefile

@@ -8,7 +8,7 @@
 ##===----------------------------------------------------------------------===##
 
 LEVEL := ../../..
-DIRS = scalar ipo vectorize
+DIRS = scalar ipo vectorize passmgr_builder
 
 ocamldoc:
 	$(Verb) for i in $(DIRS) ; do \

llvm/bindings/ocaml/transforms/passmgr_builder/Makefile

@@ -0,0 +1,19 @@
+##===- bindings/ocaml/transforms/passmgr_builder/Makefile --*- Makefile -*-===##
+#
+#                     The LLVM Compiler Infrastructure
+#
+# This file is distributed under the University of Illinois Open Source
+# License. See LICENSE.TXT for details.
+#
+##===----------------------------------------------------------------------===##
+#
+# This is the makefile for the Objective Caml Llvm_passmgr_builder interface.
+#
+##===----------------------------------------------------------------------===##
+
+LEVEL := ../../../..
+LIBRARYNAME := llvm_passmgr_builder
+UsedComponents := ipo
+UsedOcamlInterfaces := llvm
+
+include ../../Makefile.ocaml

llvm/bindings/ocaml/transforms/passmgr_builder/llvm_passmgr_builder.ml

@@ -0,0 +1,32 @@
+(*===-- llvm_passmgr_builder.ml - LLVM OCaml Interface --------*- OCaml -*-===*
+ *
+ *                     The LLVM Compiler Infrastructure
+ *
+ * This file is distributed under the University of Illinois Open Source
+ * License. See LICENSE.TXT for details.
+ *
+ *===----------------------------------------------------------------------===*)
+
+type t
+
+external create : unit -> t
+  = "llvm_pmbuilder_create"
+external set_opt_level : int -> t -> unit
+  = "llvm_pmbuilder_set_opt_level"
+external set_size_level : int -> t -> unit
+  = "llvm_pmbuilder_set_size_level"
+external set_disable_unit_at_a_time : bool -> t -> unit
+  = "llvm_pmbuilder_set_disable_unit_at_a_time"
+external set_disable_unroll_loops : bool -> t -> unit
+  = "llvm_pmbuilder_set_disable_unroll_loops"
+external use_inliner_with_threshold : int -> t -> unit
+  = "llvm_pmbuilder_use_inliner_with_threshold"
+external populate_function_pass_manager
+  : [ `Function ] Llvm.PassManager.t -> t -> unit
+  = "llvm_pmbuilder_populate_function_pass_manager"
+external populate_module_pass_manager
+  : [ `Module ] Llvm.PassManager.t -> t -> unit
+  = "llvm_pmbuilder_populate_module_pass_manager"
+external populate_lto_pass_manager
+  : [ `Module ] Llvm.PassManager.t -> internalize:bool -> run_inliner:bool -> t -> unit
+  = "llvm_pmbuilder_populate_lto_pass_manager"

llvm/bindings/ocaml/transforms/passmgr_builder/llvm_passmgr_builder.mli

@@ -0,0 +1,54 @@
+(*===-- llvm_passmgr_builder.mli - LLVM OCaml Interface -------*- OCaml -*-===*
+ *
+ *                     The LLVM Compiler Infrastructure
+ *
+ * This file is distributed under the University of Illinois Open Source
+ * License. See LICENSE.TXT for details.
+ *
+ *===----------------------------------------------------------------------===*)
+
+(** Pass Manager Builder.
+
+    This interface provides an OCaml API for LLVM pass manager builder
+    from the [LLVMCore] library. *)
+
+type t
+
+(** See [llvm::PassManagerBuilder]. *)
+external create : unit -> t
+  = "llvm_pmbuilder_create"
+
+(** See [llvm::PassManagerBuilder::OptLevel]. *)
+external set_opt_level : int -> t -> unit
+  = "llvm_pmbuilder_set_opt_level"
+
+(** See [llvm::PassManagerBuilder::SizeLevel]. *)
+external set_size_level : int -> t -> unit
+  = "llvm_pmbuilder_set_size_level"
+
+(** See [llvm::PassManagerBuilder::DisableUnitAtATime]. *)
+external set_disable_unit_at_a_time : bool -> t -> unit
+  = "llvm_pmbuilder_set_disable_unit_at_a_time"
+
+(** See [llvm::PassManagerBuilder::DisableUnrollLoops]. *)
+external set_disable_unroll_loops : bool -> t -> unit
+  = "llvm_pmbuilder_set_disable_unroll_loops"
+
+(** See [llvm::PassManagerBuilder::Inliner]. *)
+external use_inliner_with_threshold : int -> t -> unit
+  = "llvm_pmbuilder_use_inliner_with_threshold"
+
+(** See [llvm::PassManagerBuilder::populateFunctionPassManager]. *)
+external populate_function_pass_manager
+  : [ `Function ] Llvm.PassManager.t -> t -> unit
+  = "llvm_pmbuilder_populate_function_pass_manager"
+
+(** See [llvm::PassManagerBuilder::populateModulePassManager]. *)
+external populate_module_pass_manager
+  : [ `Module ] Llvm.PassManager.t -> t -> unit
+  = "llvm_pmbuilder_populate_module_pass_manager"
+
+(** See [llvm::PassManagerBuilder::populateLTOPassManager]. *)
+external populate_lto_pass_manager
+  : [ `Module ] Llvm.PassManager.t -> internalize:bool -> run_inliner:bool -> t -> unit
+  = "llvm_pmbuilder_populate_lto_pass_manager"

llvm/bindings/ocaml/transforms/passmgr_builder/passmgr_builder_ocaml.c

@@ -0,0 +1,113 @@
+/*===-- passmgr_builder_ocaml.c - LLVM OCaml Glue ---------------*- C++ -*-===*\
+|*                                                                            *|
+|*                     The LLVM Compiler Infrastructure                       *|
+|*                                                                            *|
+|* This file 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.    *|
+|*                                                                            *|
+|* Note that these functions intentionally take liberties with the CAMLparamX *|
+|* macros, since most of the parameters are not GC heap objects.              *|
+|*                                                                            *|
+\*===----------------------------------------------------------------------===*/
+
+#include "llvm-c/Transforms/PassManagerBuilder.h"
+#include "caml/mlvalues.h"
+#include "caml/custom.h"
+#include "caml/misc.h"
+
+#define PMBuilder_val(v)  (*(LLVMPassManagerBuilderRef *)(Data_custom_val(v)))
+
+static void llvm_finalize_pmbuilder(value PMB) {
+  LLVMPassManagerBuilderDispose(PMBuilder_val(PMB));
+}
+
+static struct custom_operations pmbuilder_ops = {
+  (char *) "LLVMPassManagerBuilder",
+  llvm_finalize_pmbuilder,
+  custom_compare_default,
+  custom_hash_default,
+  custom_serialize_default,
+  custom_deserialize_default
+#ifdef custom_compare_ext_default
+  , custom_compare_ext_default
+#endif
+};
+
+static value alloc_pmbuilder(LLVMPassManagerBuilderRef Ref) {
+  value Val = alloc_custom(&pmbuilder_ops,
+                           sizeof(LLVMPassManagerBuilderRef), 0, 1);
+  PMBuilder_val(Val) = Ref;
+  return Val;
+}
+
+/* t -> unit */
+CAMLprim value llvm_pmbuilder_create(value Unit) {
+  return alloc_pmbuilder(LLVMPassManagerBuilderCreate());
+}
+
+/* int -> t -> unit */
+CAMLprim value llvm_pmbuilder_set_opt_level(value OptLevel, value PMB) {
+  LLVMPassManagerBuilderSetOptLevel(PMBuilder_val(PMB), Int_val(OptLevel));
+  return Val_unit;
+}
+
+/* int -> t -> unit */
+CAMLprim value llvm_pmbuilder_set_size_level(value SizeLevel, value PMB) {
+  LLVMPassManagerBuilderSetSizeLevel(PMBuilder_val(PMB), Int_val(SizeLevel));
+  return Val_unit;
+}
+
+/* int -> t -> unit */
+CAMLprim value llvm_pmbuilder_use_inliner_with_threshold(
+                      value Threshold, value PMB) {
+  LLVMPassManagerBuilderSetOptLevel(PMBuilder_val(PMB), Int_val(Threshold));
+  return Val_unit;
+}
+
+/* bool -> t -> unit */
+CAMLprim value llvm_pmbuilder_set_disable_unit_at_a_time(
+                      value DisableUnitAtATime, value PMB) {
+  LLVMPassManagerBuilderSetDisableUnitAtATime(
+                      PMBuilder_val(PMB), Bool_val(DisableUnitAtATime));
+  return Val_unit;
+}
+
+/* bool -> t -> unit */
+CAMLprim value llvm_pmbuilder_set_disable_unroll_loops(
+                      value DisableUnroll, value PMB) {
+  LLVMPassManagerBuilderSetDisableUnrollLoops(
+                      PMBuilder_val(PMB), Bool_val(DisableUnroll));
+  return Val_unit;
+}
+
+/* [ `Function ] Llvm.PassManager.t -> t -> unit */
+CAMLprim value llvm_pmbuilder_populate_function_pass_manager(
+                      LLVMPassManagerRef PM, value PMB) {
+  LLVMPassManagerBuilderPopulateFunctionPassManager(
+                      PMBuilder_val(PMB), PM);
+  return Val_unit;
+}
+
+/* [ `Module ] Llvm.PassManager.t -> t -> unit */
+CAMLprim value llvm_pmbuilder_populate_module_pass_manager(
+                      LLVMPassManagerRef PM, value PMB) {
+  LLVMPassManagerBuilderPopulateModulePassManager(
+                      PMBuilder_val(PMB), PM);
+  return Val_unit;
+}
+
+/* [ `Module ] Llvm.PassManager.t ->
+   internalize:bool -> run_inliner:bool -> t -> unit */
+CAMLprim value llvm_pmbuilder_populate_lto_pass_manager(
+                      LLVMPassManagerRef PM, value Internalize, value RunInliner,
+                      value PMB) {
+  LLVMPassManagerBuilderPopulateLTOPassManager(
+                      PMBuilder_val(PMB), PM,
+                      Bool_val(Internalize), Bool_val(RunInliner));
+  return Val_unit;
+}

llvm/test/Bindings/Ocaml/passmgr_builder.ml

@@ -0,0 +1,64 @@
+(* RUN: rm -rf %t.builddir
+ * RUN: mkdir -p %t.builddir
+ * RUN: cp %s %t.builddir
+ * RUN: %ocamlopt -warn-error A llvm.cmxa llvm_passmgr_builder.cmxa %t.builddir/passmgr_builder.ml -o %t
+ * RUN: %t %t.bc
+ * XFAIL: vg_leak
+ *)
+
+(* Note: It takes several seconds for ocamlopt to link an executable with
+         libLLVMCore.a, so it's better to write a big test than a bunch of
+         little ones. *)
+
+open Llvm
+open Llvm_passmgr_builder
+
+let context = global_context ()
+let void_type = Llvm.void_type context
+
+(* Tiny unit test framework - really just to help find which line is busted *)
+let print_checkpoints = false
+
+let suite name f =
+  if print_checkpoints then
+    prerr_endline (name ^ ":");
+  f ()
+
+
+(*===-- Fixture -----------------------------------------------------------===*)
+
+let filename = Sys.argv.(1)
+let m = create_module context filename
+
+
+(*===-- Pass Manager Builder ----------------------------------------------===*)
+
+let test_pmbuilder () =
+  let (++) x f = ignore (f x); x in
+
+  let module_passmgr = PassManager.create () in
+  let func_passmgr   = PassManager.create_function m in
+  let lto_passmgr    = PassManager.create () in
+
+  ignore (Llvm_passmgr_builder.create ()
+           ++ set_opt_level 3
+           ++ set_size_level 1
+           ++ set_disable_unit_at_a_time false
+           ++ set_disable_unroll_loops false
+           ++ use_inliner_with_threshold 10
+           ++ populate_function_pass_manager func_passmgr
+           ++ populate_module_pass_manager module_passmgr
+           ++ populate_lto_pass_manager lto_passmgr
+                  ~internalize:false ~run_inliner:false);
+  Gc.compact ();
+
+  PassManager.dispose module_passmgr;
+  PassManager.dispose func_passmgr;
+  PassManager.dispose lto_passmgr
+
+
+(*===-- Driver ------------------------------------------------------------===*)
+
+let _ =
+  suite "pass manager builder" test_pmbuilder;
+  dispose_module m