1 # Top level -*- makefile -*- fragment for libgccjit.so.
2 # Copyright (C) 2013-2014 Free Software Foundation, Inc.
4 #This file is part of GCC.
6 #GCC is free software; you can redistribute it and/or modify
7 #it under the terms of the GNU General Public License as published by
8 #the Free Software Foundation; either version 3, or (at your option)
11 #GCC is distributed in the hope that it will be useful,
12 #but WITHOUT ANY WARRANTY; without even the implied warranty of
13 #MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 #GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with GCC; see the file COPYING3. If not see
18 # <http://www.gnu.org/licenses/>.
20 # This file provides the language dependent support in the main Makefile.
21 # Each language makefile fragment must provide the following targets:
23 # foo.all.cross, foo.start.encap, foo.rest.encap,
24 # foo.install-common, foo.install-man, foo.install-info, foo.install-pdf,
25 # foo.install-html, foo.info, foo.dvi, foo.pdf, foo.html, foo.uninstall,
26 # foo.mostlyclean, foo.clean, foo.distclean,
27 # foo.maintainer-clean, foo.stage1, foo.stage2, foo.stage3, foo.stage4
29 # where `foo' is the name of the language.
31 # It should also provide rules for:
33 # - making any compiler driver (eg: g++)
34 # - the compiler proper (eg: cc1plus)
35 # - define the names for selecting the language in LANGUAGES.
38 # Define the names for selecting jit in LANGUAGES.
39 # Note that it would be nice to move the dependency on g++
40 # into the jit rule, but that needs a little bit of work
41 # to do the right thing within all.cross.
43 LIBGCCJIT_LINKER_NAME = libgccjit.so
44 LIBGCCJIT_VERSION_NUM = 0
45 LIBGCCJIT_MINOR_NUM = 0
46 LIBGCCJIT_RELEASE_NUM = 1
47 LIBGCCJIT_SONAME = $(LIBGCCJIT_LINKER_NAME).$(LIBGCCJIT_VERSION_NUM)
48 LIBGCCJIT_FILENAME = \
49 $(LIBGCCJIT_SONAME).$(LIBGCCJIT_MINOR_NUM).$(LIBGCCJIT_RELEASE_NUM)
51 LIBGCCJIT_LINKER_NAME_SYMLINK = $(LIBGCCJIT_LINKER_NAME)
52 LIBGCCJIT_SONAME_SYMLINK = $(LIBGCCJIT_SONAME)
54 jit: $(LIBGCCJIT_FILENAME) \
55 $(LIBGCCJIT_SYMLINK) \
56 $(LIBGCCJIT_LINKER_NAME_SYMLINK) \
59 # Tell GNU make to ignore these if they exist.
62 jit_OBJS = attribs.o \
63 jit/dummy-frontend.o \
71 # Use strict warnings for this front end.
72 jit-warn = $(STRICT_WARN)
74 # We avoid using $(BACKEND) from Makefile.in in order to avoid pulling
76 $(LIBGCCJIT_FILENAME): $(jit_OBJS) \
77 libbackend.a libcommon-target.a libcommon.a \
78 $(CPPLIB) $(LIBDECNUMBER) \
79 $(LIBDEPS) $(srcdir)/jit/libgccjit.map
80 +$(LLINKER) $(ALL_LINKERFLAGS) $(LDFLAGS) -o $@ -shared \
81 $(jit_OBJS) libbackend.a libcommon-target.a libcommon.a \
82 $(CPPLIB) $(LIBDECNUMBER) $(LIBS) $(BACKENDLIBS) \
83 -Wl,--version-script=$(srcdir)/jit/libgccjit.map \
84 -Wl,-soname,$(LIBGCCJIT_SONAME)
86 $(LIBGCCJIT_SONAME_SYMLINK): $(LIBGCCJIT_FILENAME)
87 ln -sf $(LIBGCCJIT_FILENAME) $(LIBGCCJIT_SONAME_SYMLINK)
89 $(LIBGCCJIT_LINKER_NAME_SYMLINK): $(LIBGCCJIT_SONAME_SYMLINK)
90 ln -sf $(LIBGCCJIT_SONAME_SYMLINK) $(LIBGCCJIT_LINKER_NAME_SYMLINK)
99 # Documentation build hooks.
101 # The documentation can be built using the texinfo toolchain, or
102 # the sphinx toolchain
104 # The jit documentation is authored using Sphinx, which has numerous
105 # advantages over Texinfo, including:
109 # * use of CSS and JS to provide less of a 1990s feel in the generated
112 # * sane, stable HTML page and anchor names
114 # * sane HTML navigation: ability to move forward and back in the HTML
115 # at every node to read the HTML like a book
117 # * syntax-coloring of examples
119 # * the ability to "include" fragments of code inline. This is used
120 # heavily by the jit docs, so that the example code is shared by both
121 # the test suite and the documentation to ensure that the examples
122 # appearing in the docs actually compile and work
124 # Sphinx is not a "blessed" dependency, and so a prebuilt libgccjit.texinfo
125 # file built by Sphinx is checked into the source tree to avoid requiring
126 # everyone to have Sphinx installed.
128 # This prebuilt libgccjit.texinfo has the "include" fragments "baked in",
129 # and so contains the content from the sphinx toolchain, but lacks the
130 # syntax-coloring, and the generated HTML is (IMHO) greatly inferior to
131 # that generated by Sphinx.
133 # These targets redirect HTML creation and installation to either
134 # jit.sphinx.(install-)html or jit.texinfo.(install-)html.
135 jit.html: jit.$(doc_build_sys).html
136 jit.install-html: jit.$(doc_build_sys).install-html
138 # For now, use texinfo for pdf, since the sphinx latex toolchain currently
139 # fails for me deep inside pdflatex (see notes below)
140 jit.pdf: jit.texinfo.pdf
141 jit.install-pdf: jit.texinfo.install-pdf
143 # Hooks for building docs using texinfo
144 JIT_TEXI_FILES = $(srcdir)/jit/docs/_build/texinfo/libgccjit.texi
146 jit.info: doc/libgccjit.info
147 doc/libgccjit.info: $(JIT_TEXI_FILES)
148 if test "x$(BUILD_INFO)" = xinfo; then \
149 rm -f doc/libgccjit.info*; \
150 $(MAKEINFO) $(MAKEINFOFLAGS) -I $(gcc_docdir) \
151 -I $(gcc_docdir)/include -o $@ $<; \
154 jit.install-info: $(DESTDIR)$(infodir)/libgccjit.info
156 jit.dvi: doc/libgccjit.dvi
157 doc/libgccjit.dvi: $(JIT_TEXI_FILES)
158 $(TEXI2DVI) -I $(abs_docdir) -I $(abs_docdir)/include -o $@ $<
160 jit.texinfo.html: $(build_htmldir)/jit/index.html
162 $(build_htmldir)/jit/index.html: $(srcdir)/jit/docs/_build/texinfo/libgccjit.texi
163 $(mkinstalldirs) $(@D)
165 $(TEXI2HTML) -I $(gcc_docdir)/include -I $(srcdir)/jit -o $(@D) $<
167 jit.texinfo.install-html: jit.texinfo.html
169 test -z "$(htmldir)" || $(mkinstalldirs) "$(DESTDIR)$(htmldir)"
170 @for p in $(build_htmldir)/jit; do \
171 if test -f "$$p" || test -d "$$p"; then d=""; else d="$(srcdir)/"; fi; \
172 f=$(html__strip_dir) \
173 if test -d "$$d$$p"; then \
174 echo " $(mkinstalldirs) '$(DESTDIR)$(htmldir)/$$f'"; \
175 $(mkinstalldirs) "$(DESTDIR)$(htmldir)/$$f" || exit 1; \
176 echo " $(INSTALL_DATA) '$$d$$p'/* '$(DESTDIR)$(htmldir)/$$f'"; \
177 $(INSTALL_DATA) "$$d$$p"/* "$(DESTDIR)$(htmldir)/$$f"; \
179 echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(htmldir)/$$f'"; \
180 $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(htmldir)/$$f"; \
184 jit.texinfo.pdf: doc/libgccjit.pdf
186 doc/libgccjit.pdf: $(JIT_TEXI_FILES)
187 $(TEXI2PDF) -I $(abs_docdir) -I $(abs_docdir)/include -o $@ $<
189 jit.texinfo.install-pdf: doc/libgccjit.pdf
191 test -z "$(pdfdir)" || $(mkinstalldirs) "$(DESTDIR)$(pdfdir)/gcc"
192 @for p in doc/libgccjit.pdf; do \
193 if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
194 f=$(pdf__strip_dir) \
195 echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/gcc/$$f'"; \
196 $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/gcc/$$f"; \
199 # Hooks for building docs using the Sphinx toolchain:
201 SPHINX_BUILD_DIR=jit/sphinx-build
204 mkdir -p $(SPHINX_BUILD_DIR)
205 (cd $(srcdir)/jit/docs && \
206 make html BUILDDIR=$(PWD)/$(SPHINX_BUILD_DIR) )
208 jit_htmldir=$(htmldir)/jit
210 jit.sphinx.install-html: jit.sphinx.html
212 test -z "$(jit_htmldir)" || $(mkinstalldirs) "$(DESTDIR)$(jit_htmldir)"
213 @for f in $(shell cd $(SPHINX_BUILD_DIR)/html && find) ; do \
214 if test -f $(SPHINX_BUILD_DIR)/html/"$$f"; then \
215 $(INSTALL_DATA) $(SPHINX_BUILD_DIR)/html/"$$f" $(DESTDIR)$(jit_htmldir)/"$$f"; \
217 mkdir $(DESTDIR)$(jit_htmldir)/"$$f"; \
221 # (This one is currently failing deep inside pdflatex for me;
222 # see https://bugzilla.redhat.com/show_bug.cgi?id=1148845 )
223 jit.sphinx.pdf: $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf
224 $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf:
225 mkdir -p $(SPHINX_BUILD_DIR)
226 (cd $(srcdir)/jit/docs && \
227 make latexpdf BUILDDIR=$(PWD)/$(SPHINX_BUILD_DIR) )
229 jit.sphinx.install-pdf: $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf
231 test -z "$(pdfdir)" || $(mkinstalldirs) "$(DESTDIR)$(pdfdir)/gcc"
232 @for p in $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf; do \
233 if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
234 f=$(pdf__strip_dir) \
235 echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/gcc/$$f'"; \
236 $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/gcc/$$f"; \
248 lang_checks += check-jit
252 jit.install-common: installdirs
253 $(INSTALL_PROGRAM) $(LIBGCCJIT_FILENAME) \
254 $(DESTDIR)/$(libdir)/$(LIBGCCJIT_FILENAME)
256 $(LIBGCCJIT_FILENAME) \
257 $(DESTDIR)/$(libdir)/$(LIBGCCJIT_SONAME_SYMLINK)
259 $(LIBGCCJIT_SONAME_SYMLINK)\
260 $(DESTDIR)/$(libdir)/$(LIBGCCJIT_LINKER_NAME_SYMLINK)
261 $(INSTALL_PROGRAM) $(srcdir)/jit/libgccjit.h \
262 $(DESTDIR)/$(includedir)/libgccjit.h
263 $(INSTALL_PROGRAM) $(srcdir)/jit/libgccjit++.h \
264 $(DESTDIR)/$(includedir)/libgccjit++.h
274 # A lot of the ancillary files are deleted by the main makefile.
275 # We just have to delete files specific to us.
283 jit.maintainer-clean:
287 # The main makefile has already created stage?/jit.
289 jit.stage1: stage1-start
290 -mv jit/*$(objext) stage1/jit
291 jit.stage2: stage2-start
292 -mv jit/*$(objext) stage2/jit
293 jit.stage3: stage3-start
294 -mv jit/*$(objext) stage3/jit
295 jit.stage4: stage4-start
296 -mv jit/*$(objext) stage4/jit
297 jit.stageprofile: stageprofile-start
298 -mv jit/*$(objext) stageprofile/jit
299 jit.stagefeedback: stagefeedback-start
300 -mv jit/*$(objext) stagefeedback/jit