1 ##===- bindings/ocaml/Makefile.ocaml -----------------------*- Makefile -*-===##
3 # The LLVM Compiler Infrastructure
5 # This file is distributed under the University of Illinois Open Source
6 # License. See LICENSE.TXT for details.
8 ##===----------------------------------------------------------------------===##
10 # An OCaml library is a unique project type in the context of LLVM, so rules are
11 # here rather than in Makefile.rules.
13 # Reference materials on installing OCaml libraries:
15 # https://fedoraproject.org/wiki/Packaging/OCaml
16 # http://pkg-ocaml-maint.alioth.debian.org/ocaml_packaging_policy.txt
18 ##===----------------------------------------------------------------------===##
20 include $(LEVEL)/Makefile.config
22 # We have our own rules for building static libraries.
25 # CFLAGS needs to be set before Makefile.rules is included.
26 CXX.Flags += -I"$(shell $(OCAMLFIND) c -where)"
27 C.Flags += -I"$(shell $(OCAMLFIND) c -where)"
29 ifeq ($(ENABLE_SHARED),1)
30 LINK_COMPONENTS := all
33 include $(LEVEL)/Makefile.common
35 # Used in out-of-tree builds of OCaml bindings only.
36 ifdef SYSTEM_LLVM_CONFIG
37 LLVM_CONFIG = $(SYSTEM_LLVM_CONFIG)
38 LLVMLibsOptions += $(shell $(LLVM_CONFIG) --ldflags)
41 # Intentionally ignore PROJ_prefix here. We want the ocaml stdlib. However, the
42 # user can override this with OCAML_LIBDIR or configure --with-ocaml-libdir=.
43 PROJ_libocamldir := $(DESTDIR)$(OCAML_LIBDIR)
44 OcamlDir := $(LibDir)/ocaml
46 # Info from llvm-config and similar
47 ifndef IS_CLEANING_TARGET
49 UsedLibs = $(shell $(LLVM_CONFIG) --libs --system-libs $(UsedComponents))
50 UsedLibNames = $(shell $(LLVM_CONFIG) --libnames $(UsedComponents))
54 # How do we link OCaml executables with LLVM?
55 # 1) If this is a --enable-shared build, build stub libraries. This also allows
56 # to use LLVM from toplevels.
57 # 2) If this is a --disable-shared build, embed ocamlc options for building
58 # a custom runtime and a static executable. It is not possible to use LLVM
61 ifeq ($(ENABLE_SHARED),1)
63 OCAMLSTUBFLAGS := $(patsubst %,-cclib %, $(LLVMLibsOptions) -l$(LIBRARYNAME))
67 # Avoid the need for LD_LIBRARY_PATH
68 ifneq ($(HOST_OS), $(filter $(HOST_OS), Cygwin MingW))
69 ifneq ($(HOST_OS),Darwin)
70 OCAMLRPATH := $(RPATH) -Wl,'$$ORIGIN/../../lib'
74 # See http://caml.inria.fr/mantis/view.php?id=6642
75 OCAMLORIGIN := -ccopt -L'$$CAMLORIGIN/..' \
76 -ccopt $(RPATH) -ccopt -Wl,'$$CAMLORIGIN/..'
79 OCAMLCFLAGS += -I $(OcamlDir) $(addprefix -package ,$(FindlibPackages))
81 ifndef IS_CLEANING_TARGET
83 OCAMLAFLAGS += $(patsubst %,-cclib %, \
84 $(filter-out -L$(LibDir),-l$(LIBRARYNAME) \
85 $(shell $(LLVM_CONFIG) --ldflags)) \
86 $(UsedLibs) $(ExtraLibs))
88 OCAMLAFLAGS += $(patsubst %,-cclib %, \
89 $(filter-out -L$(LibDir),$(shell $(LLVM_CONFIG) --ldflags)) \
90 $(UsedLibs) $(ExtraLibs))
94 ifneq ($(DEBUG_SYMBOLS),1)
98 Compile.CMI := $(strip $(OCAMLFIND) c -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
99 Compile.CMO := $(strip $(OCAMLFIND) c -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
100 Compile.CMX := $(strip $(OCAMLFIND) opt -c $(OCAMLCFLAGS) $(OCAMLDEBUGFLAG) -o)
103 # -dllib is engaged with ocamlc builds, $(OCAMLSTUBFLAGS) in ocamlc -custom builds.
104 Archive.CMA := $(strip $(OCAMLFIND) c -a -dllib -l$(LIBRARYNAME) $(OCAMLSTUBFLAGS) \
105 $(OCAMLDEBUGFLAG) $(OCAMLORIGIN) -o)
107 Archive.CMA := $(strip $(OCAMLFIND) c -a -custom $(OCAMLAFLAGS) $(OCAMLDEBUGFLAG) \
112 Archive.CMXA := $(strip $(OCAMLFIND) opt -a $(OCAMLSTUBFLAGS) $(OCAMLDEBUGFLAG) \
115 Archive.CMXA := $(strip $(OCAMLFIND) opt -a $(OCAMLAFLAGS) $(OCAMLDEBUGFLAG) \
121 OcamlSources1 := $(sort $(wildcard $(PROJ_SRC_DIR)/*.ml))
125 OcamlHeaders1 := $(sort $(wildcard $(PROJ_SRC_DIR)/*.mli))
128 OcamlSources2 := $(filter-out $(ExcludeSources),$(OcamlSources1))
129 OcamlHeaders2 := $(filter-out $(ExcludeHeaders),$(OcamlHeaders1))
131 OcamlSources := $(OcamlSources2:$(PROJ_SRC_DIR)/%=$(ObjDir)/%)
132 OcamlHeaders := $(OcamlHeaders2:$(PROJ_SRC_DIR)/%=$(ObjDir)/%)
135 ObjectsCMI := $(OcamlSources:%.ml=%.cmi)
136 ObjectsCMO := $(OcamlSources:%.ml=%.cmo)
137 ObjectsCMX := $(OcamlSources:%.ml=%.cmx)
140 LibraryCMA := $(ObjDir)/$(LIBRARYNAME).cma
141 LibraryCMXA := $(ObjDir)/$(LIBRARYNAME).cmxa
145 ToolEXE := $(ObjDir)/$(TOOLNAME)$(EXEEXT)
149 # The .cmo files are the only intermediates; all others are to be installed.
150 OutputsCMI := $(ObjectsCMI:$(ObjDir)/%.cmi=$(OcamlDir)/%.cmi)
151 OutputsCMX := $(ObjectsCMX:$(ObjDir)/%.cmx=$(OcamlDir)/%.cmx)
152 OutputLibs := $(UsedLibNames:%=$(OcamlDir)/%)
155 LibraryA := $(OcamlDir)/lib$(LIBRARYNAME).a
156 OutputCMA := $(LibraryCMA:$(ObjDir)/%.cma=$(OcamlDir)/%.cma)
157 OutputCMXA := $(LibraryCMXA:$(ObjDir)/%.cmxa=$(OcamlDir)/%.cmxa)
161 SharedLib := $(OcamlDir)/dll$(LIBRARYNAME)$(SHLIBEXT)
166 OutputEXE := $(ExmplDir)/$(strip $(TOOLNAME))$(EXEEXT)
168 OutputEXE := $(ToolDir)/$(strip $(TOOLNAME))$(EXEEXT)
172 # Installation targets
173 DestLibs := $(UsedLibNames:%=$(PROJ_libocamldir)/%)
176 DestA := $(PROJ_libocamldir)/lib$(LIBRARYNAME).a
177 DestCMA := $(PROJ_libocamldir)/$(LIBRARYNAME).cma
178 DestCMXA := $(PROJ_libocamldir)/$(LIBRARYNAME).cmxa
182 DestSharedLib := $(PROJ_libocamldir)/dll$(LIBRARYNAME)$(SHLIBEXT)
185 ##===- Dependencies -------------------------------------------------------===##
186 # Copy the sources into the intermediate directory because older ocamlc doesn't
187 # support -o except when linking (outputs are placed next to inputs).
189 $(ObjDir)/%.mli: $(PROJ_SRC_DIR)/%.mli $(ObjDir)/.dir
190 $(Verb) $(CP) -f $< $@
192 $(ObjDir)/%.ml: $(PROJ_SRC_DIR)/%.ml $(ObjDir)/.dir
193 $(Verb) $(CP) -f $< $@
195 $(ObjectsCMI): $(UsedOcamlInterfaces:%=$(OcamlDir)/%.cmi)
198 $(ObjDir)/$(LIBRARYNAME).ocamldep: $(OcamlSources) $(OcamlHeaders) \
199 $(OcamlDir)/.dir $(ObjDir)/.dir
200 $(Verb) $(OCAMLFIND) dep $(OCAMLCFLAGS) $(OcamlSources) $(OcamlHeaders) > $@
202 -include $(ObjDir)/$(LIBRARYNAME).ocamldep
206 $(ObjDir)/$(TOOLNAME).ocamldep: $(OcamlSources) $(OcamlHeaders) \
207 $(OcamlDir)/.dir $(ObjDir)/.dir
208 $(Verb) $(OCAMLFIND) dep $(OCAMLCFLAGS) $(OcamlSources) $(OcamlHeaders) > $@
210 -include $(ObjDir)/$(TOOLNAME).ocamldep
213 ##===- Build static library from C sources --------------------------------===##
216 all-local:: $(LibraryA)
217 clean-local:: clean-a
218 install-local:: install-a
219 uninstall-local:: uninstall-a
221 $(LibraryA): $(ObjectsO) $(OcamlDir)/.dir
222 $(Echo) "Building $(BuildMode) $(notdir $@)"
224 $(Verb) $(Archive) $@ $(ObjectsO)
228 -$(Verb) $(RM) -f $(LibraryA)
230 install-a:: $(LibraryA)
231 $(Echo) "Installing $(BuildMode) $(DestA)"
232 $(Verb) $(MKDIR) $(PROJ_libocamldir)
233 $(Verb) $(INSTALL) $(LibraryA) $(DestA)
237 $(Echo) "Uninstalling $(DestA)"
238 -$(Verb) $(RM) -f $(DestA)
242 ##===- Build stub library from C sources ----------------------------------===##
245 all-local:: $(SharedLib)
246 clean-local:: clean-shared
247 install-local:: install-shared
248 uninstall-local:: uninstall-shared
250 $(SharedLib): $(ObjectsO) $(OcamlDir)/.dir
251 $(Echo) "Building $(BuildMode) $(notdir $@)"
252 $(Verb) $(Link) $(SharedLinkOptions) $(OCAMLRPATH) -o $@ $(ObjectsO) \
256 -$(Verb) $(RM) -f $(SharedLib)
258 install-shared:: $(SharedLib)
259 $(Echo) "Installing $(BuildMode) $(DestSharedLib)"
260 $(Verb) $(MKDIR) $(PROJ_libocamldir)
261 $(Verb) $(INSTALL) $(SharedLib) $(DestSharedLib)
265 $(Echo) "Uninstalling $(DestSharedLib)"
266 -$(Verb) $(RM) -f $(DestSharedLib)
270 ##===- Deposit dependent libraries adjacent to OCaml libs -----------------===##
272 ifndef SYSTEM_LLVM_CONFIG
273 all-local:: build-deplibs
274 clean-local:: clean-deplibs
275 install-local:: install-deplibs
276 uninstall-local:: uninstall-deplibs
278 build-deplibs: $(OutputLibs)
280 $(OcamlDir)/%.a: $(LibDir)/%.a
283 $(OcamlDir)/%.o: $(LibDir)/%.o
287 $(Verb) $(RM) -f $(OutputLibs)
290 $(Verb) $(MKDIR) $(PROJ_libocamldir)
291 $(Verb) for i in $(DestLibs:$(PROJ_libocamldir)/%=%); do \
292 ln -sf "$(PROJ_libdir)/$$i" "$(PROJ_libocamldir)/$$i"; \
296 $(Verb) $(RM) -f $(DestLibs)
299 ##===- Build ocaml interfaces (.mli's -> .cmi's) --------------------------===##
301 ifneq ($(OcamlHeaders),)
302 all-local:: build-cmis
303 clean-local:: clean-cmis
304 install-local:: install-cmis
305 uninstall-local:: uninstall-cmis
307 build-cmis: $(OutputsCMI)
309 $(OcamlDir)/%.cmi: $(ObjDir)/%.cmi $(OcamlDir)/.dir
310 $(Verb) $(CP) -f $< $@
312 $(ObjDir)/%.cmi: $(ObjDir)/%.mli $(ObjDir)/.dir
313 $(Echo) "Compiling $(notdir $<) for $(BuildMode) build"
314 $(Verb) $(Compile.CMI) $@ $<
317 -$(Verb) $(RM) -f $(OutputsCMI)
319 # Also install the .mli's (headers) as documentation.
320 install-cmis: $(OutputsCMI) $(OcamlHeaders)
321 $(Verb) $(MKDIR) $(PROJ_libocamldir)
322 $(Verb) for i in $(OcamlHeaders:$(ObjDir)/%=%); do \
323 $(EchoCmd) "Installing $(BuildMode) $(PROJ_libocamldir)/$$i"; \
324 $(DataInstall) $(ObjDir)/$$i "$(PROJ_libocamldir)/$$i"; \
326 $(Verb) for i in $(OutputsCMI:$(OcamlDir)/%=%); do \
327 $(EchoCmd) "Installing $(BuildMode) $(PROJ_libocamldir)/$$i"; \
328 $(DataInstall) $(OcamlDir)/$$i "$(PROJ_libocamldir)/$$i"; \
332 $(Verb) for i in $(OutputsCMI:$(OcamlDir)/%=%); do \
333 $(EchoCmd) "Uninstalling $(PROJ_libocamldir)/$$i"; \
334 $(RM) -f "$(PROJ_libocamldir)/$$i"; \
336 $(Verb) for i in $(OcamlHeaders:$(ObjDir)/%=%); do \
337 $(EchoCmd) "Uninstalling $(PROJ_libocamldir)/$$i"; \
338 $(RM) -f "$(PROJ_libocamldir)/$$i"; \
343 ##===- Build ocaml bytecode archive (.ml's -> .cmo's -> .cma) -------------===##
345 $(ObjDir)/%.cmo: $(ObjDir)/%.ml
346 $(Echo) "Compiling $(notdir $<) for $(BuildMode) build"
347 $(Verb) $(Compile.CMO) $@ $<
350 all-local:: $(OutputCMA)
351 clean-local:: clean-cma
352 install-local:: install-cma
353 uninstall-local:: uninstall-cma
355 $(OutputCMA): $(LibraryCMA) $(OcamlDir)/.dir
356 $(Verb) $(CP) -f $< $@
358 $(LibraryCMA): $(ObjectsCMO) $(OcamlDir)/.dir
359 $(Echo) "Archiving $(notdir $@) for $(BuildMode) build"
360 $(Verb) $(Archive.CMA) $@ $(ObjectsCMO)
363 $(Verb) $(RM) -f $(OutputCMA) $(UsedLibNames:%=$(OcamlDir)/%)
365 install-cma:: $(OutputCMA)
366 $(Echo) "Installing $(BuildMode) $(DestCMA)"
367 $(Verb) $(MKDIR) $(PROJ_libocamldir)
368 $(Verb) $(DataInstall) $(OutputCMA) "$(DestCMA)"
371 $(Echo) "Uninstalling $(DestCMA)"
372 -$(Verb) $(RM) -f $(DestCMA)
375 ##===- Build optimized ocaml archive (.ml's -> .cmx's -> .cmxa, .a) -------===##
377 # The ocamlopt compiler is supported on a set of targets disjoint from LLVM's.
378 # If unavailable, 'configure' will set HAVE_OCAMLOPT to 0 in Makefile.config.
379 ifeq ($(HAVE_OCAMLOPT),1)
381 $(OcamlDir)/%.cmx: $(ObjDir)/%.cmx
382 $(Verb) $(CP) -f $< $@
384 $(ObjDir)/%.cmx: $(ObjDir)/%.ml
385 $(Echo) "Compiling optimized $(notdir $<) for $(BuildMode) build"
386 $(Verb) $(Compile.CMX) $@ $<
389 all-local:: $(OutputCMXA) $(OutputsCMX)
390 clean-local:: clean-cmxa
391 install-local:: install-cmxa
392 uninstall-local:: uninstall-cmxa
394 $(OutputCMXA): $(LibraryCMXA)
395 $(Verb) $(CP) -f $< $@
396 $(Verb) $(CP) -f $(<:.cmxa=.a) $(@:.cmxa=.a)
398 $(LibraryCMXA): $(ObjectsCMX)
399 $(Echo) "Archiving $(notdir $@) for $(BuildMode) build"
400 $(Verb) $(Archive.CMXA) $@ $(ObjectsCMX)
401 $(Verb) $(RM) -f $(@:.cmxa=.o)
404 $(Verb) $(RM) -f $(OutputCMXA) $(OutputCMXA:.cmxa=.a) $(OutputsCMX)
406 install-cmxa:: $(OutputCMXA) $(OutputsCMX)
407 $(Verb) $(MKDIR) $(PROJ_libocamldir)
408 $(Echo) "Installing $(BuildMode) $(DestCMXA)"
409 $(Verb) $(DataInstall) $(OutputCMXA) $(DestCMXA)
410 $(Echo) "Installing $(BuildMode) $(DestCMXA:.cmxa=.a)"
411 $(Verb) $(DataInstall) $(OutputCMXA:.cmxa=.a) $(DestCMXA:.cmxa=.a)
412 $(Verb) for i in $(OutputsCMX:$(OcamlDir)/%=%); do \
413 $(EchoCmd) "Installing $(BuildMode) $(PROJ_libocamldir)/$$i"; \
414 $(DataInstall) $(OcamlDir)/$$i "$(PROJ_libocamldir)/$$i"; \
418 $(Echo) "Uninstalling $(DestCMXA)"
419 $(Verb) $(RM) -f $(DestCMXA)
420 $(Echo) "Uninstalling $(DestCMXA:.cmxa=.a)"
421 $(Verb) $(RM) -f $(DestCMXA:.cmxa=.a)
422 $(Verb) for i in $(OutputsCMX:$(OcamlDir)/%=%); do \
423 $(EchoCmd) "Uninstalling $(PROJ_libocamldir)/$$i"; \
424 $(RM) -f $(PROJ_libocamldir)/$$i; \
429 ##===- Generate documentation ---------------------------------------------===##
431 $(ObjDir)/$(LIBRARYNAME).odoc: $(ObjectsCMI)
432 $(Echo) "Documenting $(notdir $@)"
433 $(Verb) $(OCAMLFIND) doc -I $(ObjDir) -I $(OcamlDir) -dump $@ $(OcamlHeaders)
435 ocamldoc: $(ObjDir)/$(LIBRARYNAME).odoc
437 ##===- Debugging gunk -----------------------------------------------------===##
438 printvars:: printcamlvars
441 $(Echo) "LLVM_CONFIG : " '$(LLVM_CONFIG)'
442 $(Echo) "OCAMLCFLAGS : " '$(OCAMLCFLAGS)'
443 $(Echo) "OCAMLAFLAGS : " '$(OCAMLAFLAGS)'
444 $(Echo) "OCAMLRPATH : " '$(OCAMLRPATH)'
445 $(Echo) "OCAMLSTUBS : " '$(OCAMLSTUBS)'
446 $(Echo) "OCAMLSTUBFLAGS : " '$(OCAMLSTUBFLAGS)'
447 $(Echo) "OCAMLFIND : " '$(OCAMLFIND)'
448 $(Echo) "Compile.CMI : " '$(Compile.CMI)'
449 $(Echo) "Compile.CMO : " '$(Compile.CMO)'
450 $(Echo) "Archive.CMA : " '$(Archive.CMA)'
451 $(Echo) "Compile.CMX : " '$(Compile.CMX)'
452 $(Echo) "Archive.CMXA : " '$(Archive.CMXA)'
453 $(Echo) "CAML_LIBDIR : " '$(CAML_LIBDIR)'
454 $(Echo) "LibraryA : " '$(LibraryA)'
455 $(Echo) "LibraryCMA : " '$(LibraryCMA)'
456 $(Echo) "LibraryCMXA : " '$(LibraryCMXA)'
457 $(Echo) "SharedLib : " '$(SharedLib)'
458 $(Echo) "OcamlSources1: " '$(OcamlSources1)'
459 $(Echo) "OcamlSources2: " '$(OcamlSources2)'
460 $(Echo) "OcamlSources : " '$(OcamlSources)'
461 $(Echo) "OcamlHeaders1: " '$(OcamlHeaders1)'
462 $(Echo) "OcamlHeaders2: " '$(OcamlHeaders2)'
463 $(Echo) "OcamlHeaders : " '$(OcamlHeaders)'
464 $(Echo) "ObjectsCMI : " '$(ObjectsCMI)'
465 $(Echo) "ObjectsCMO : " '$(ObjectsCMO)'
466 $(Echo) "ObjectsCMX : " '$(ObjectsCMX)'
467 $(Echo) "OCAML_LIBDIR : " '$(OCAML_LIBDIR)'
468 $(Echo) "DestA : " '$(DestA)'
469 $(Echo) "DestCMA : " '$(DestCMA)'
470 $(Echo) "DestCMXA : " '$(DestCMXA)'
471 $(Echo) "DestSharedLib: " '$(DestSharedLib)'
472 $(Echo) "UsedLibs : " '$(UsedLibs)'
473 $(Echo) "UsedLibNames : " '$(UsedLibNames)'
474 $(Echo) "ExtraLibs : " '$(ExtraLibs)'
476 .PHONY: printcamlvars build-cmis \
477 clean-a clean-cmis clean-cma clean-cmxa \
478 install-a install-cmis install-cma install-cmxa \
480 uninstall-a uninstall-cmis uninstall-cma uninstall-cmxa \