gcc/jit/Make-lang.in

   1 # Top level -*- makefile -*- fragment for libgccjit.so.
   2 #   Copyright (C) 2013-2020 Free Software Foundation, Inc.
   3
   4 #This file is part of GCC.
   5
   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)
   9 #any later version.
  10
  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.
  15
  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/>.
  19
  20 # This file provides the language dependent support in the main Makefile.
  21 # Each language makefile fragment must provide the following targets:
  22 #
  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
  28 #
  29 # where `foo' is the name of the language.
  30 #
  31 # It should also provide rules for:
  32 #
  33 # - making any compiler driver (eg: g++)
  34 # - the compiler proper (eg: cc1plus)
  35 # - define the names for selecting the language in LANGUAGES.
  36
  37 #\f
  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.
  42
  43 ifneq (,$(findstring mingw,$(target)))
  44 LIBGCCJIT_FILENAME = libgccjit.dll
  45
  46 jit: $(LIBGCCJIT_FILENAME) \
  47         $(FULL_DRIVER_NAME)
  48
  49 else
  50
  51 LIBGCCJIT_LINKER_NAME = libgccjit.so
  52 LIBGCCJIT_VERSION_NUM = 0
  53 LIBGCCJIT_MINOR_NUM = 0
  54 LIBGCCJIT_RELEASE_NUM = 1
  55
  56 LIBGCCJIT_SONAME = $(LIBGCCJIT_LINKER_NAME).$(LIBGCCJIT_VERSION_NUM)
  57 LIBGCCJIT_FILENAME = \
  58   $(LIBGCCJIT_SONAME).$(LIBGCCJIT_MINOR_NUM).$(LIBGCCJIT_RELEASE_NUM)
  59
  60 LIBGCCJIT_LINKER_NAME_SYMLINK = $(LIBGCCJIT_LINKER_NAME)
  61 LIBGCCJIT_SONAME_SYMLINK = $(LIBGCCJIT_SONAME)
  62
  63 # Conditionalize the use of the LD_VERSION_SCRIPT_OPTION and
  64 # LD_SONAME_OPTION depending if configure found them, using $(if)
  65 # We have to define a COMMA here, otherwise the commas in the "true"
  66 # result are treated as separators by the $(if).
  67 COMMA := ,
  68 LIBGCCJIT_VERSION_SCRIPT_OPTION = \
  69         $(if $(LD_VERSION_SCRIPT_OPTION),\
  70           -Wl$(COMMA)$(LD_VERSION_SCRIPT_OPTION)$(COMMA)$(srcdir)/jit/libgccjit.map)
  71
  72 LIBGCCJIT_SONAME_OPTION = \
  73         $(if $(LD_SONAME_OPTION), \
  74              -Wl$(COMMA)$(LD_SONAME_OPTION)$(COMMA)$(LIBGCCJIT_SONAME))
  75
  76 jit: $(LIBGCCJIT_FILENAME) \
  77         $(LIBGCCJIT_SYMLINK) \
  78         $(LIBGCCJIT_LINKER_NAME_SYMLINK) \
  79         $(FULL_DRIVER_NAME)
  80 endif
  81
  82 # Tell GNU make to ignore these if they exist.
  83 .PHONY: jit
  84
  85 jit_OBJS = attribs.o \
  86         jit/dummy-frontend.o \
  87         jit/libgccjit.o \
  88         jit/jit-logging.o \
  89         jit/jit-recording.o \
  90         jit/jit-playback.o \
  91         jit/jit-result.o \
  92         jit/jit-tempdir.o \
  93         jit/jit-builtins.o \
  94         jit/jit-spec.o \
  95         gcc.o
  96
  97 ifneq (,$(findstring mingw,$(target)))
  98 jit_OBJS += jit/jit-w32.o
  99 endif
 100
 101 # Use strict warnings for this front end.
 102 jit-warn = $(STRICT_WARN)
 103
 104 ifneq (,$(findstring mingw,$(target)))
 105 # Create import library libgccjit.dll.a
 106 LIBGCCJIT_EXTRA_OPTS = -Wl,--out-implib,$(LIBGCCJIT_FILENAME).a
 107 else
 108 LIBGCCJIT_EXTRA_OPTS = $(LIBGCCJIT_VERSION_SCRIPT_OPTION) \
 109         $(LIBGCCJIT_SONAME_OPTION)
 110 endif
 111
 112 # We avoid using $(BACKEND) from Makefile.in in order to avoid pulling
 113 # in main.o
 114 $(LIBGCCJIT_FILENAME): $(jit_OBJS) \
 115         libbackend.a libcommon-target.a libcommon.a \
 116         $(CPPLIB) $(LIBDECNUMBER) \
 117         $(LIBDEPS) $(srcdir)/jit/libgccjit.map \
 118         $(EXTRA_GCC_OBJS)
 119         +$(LLINKER) $(ALL_LINKERFLAGS) $(LDFLAGS) -o $@ -shared \
 120              $(jit_OBJS) libbackend.a libcommon-target.a libcommon.a \
 121              $(CPPLIB) $(LIBDECNUMBER) $(EXTRA_GCC_LIBS) $(LIBS) $(BACKENDLIBS) \
 122              $(EXTRA_GCC_OBJS) \
 123              $(LIBGCCJIT_EXTRA_OPTS)
 124
 125 # Create symlinks when not building for Windows
 126 ifeq (,$(findstring mingw,$(target)))
 127 $(LIBGCCJIT_SONAME_SYMLINK): $(LIBGCCJIT_FILENAME)
 128         ln -sf $(LIBGCCJIT_FILENAME) $(LIBGCCJIT_SONAME_SYMLINK)
 129
 130 $(LIBGCCJIT_LINKER_NAME_SYMLINK): $(LIBGCCJIT_SONAME_SYMLINK)
 131         ln -sf $(LIBGCCJIT_SONAME_SYMLINK) $(LIBGCCJIT_LINKER_NAME_SYMLINK)
 132 endif
 133
 134 #\f
 135 # Build hooks:
 136
 137 jit.all.cross:
 138 jit.start.encap:
 139 jit.rest.encap:
 140
 141 # Documentation build hooks.
 142 #
 143 # The documentation can be built using the texinfo toolchain, or
 144 # the sphinx toolchain
 145 #
 146 # The jit documentation is authored using Sphinx, which has numerous
 147 # advantages over Texinfo, including:
 148 #
 149 #   * much faster
 150 #
 151 #   * use of CSS and JS to provide less of a 1990s feel in the generated
 152 #     HTML.
 153 #
 154 #   * sane, stable HTML page and anchor names
 155 #
 156 #   * sane HTML navigation: ability to move forward and back in the HTML
 157 #     at every node to read the HTML like a book
 158 #
 159 #   * syntax-coloring of examples
 160 #
 161 #   * the ability to "include" fragments of code inline.  This is used
 162 #     heavily by the jit docs, so that the example code is shared by both
 163 #     the test suite and the documentation to ensure that the examples
 164 #     appearing in the docs actually compile and work
 165 #
 166 # Sphinx is not a "blessed" dependency, and so a prebuilt libgccjit.texinfo
 167 # file built by Sphinx is checked into the source tree to avoid requiring
 168 # everyone to have Sphinx installed.
 169 #
 170 # This prebuilt libgccjit.texinfo has the "include" fragments "baked in",
 171 # and so contains the content from the sphinx toolchain, but lacks the
 172 # syntax-coloring, and the generated HTML is (IMHO) greatly inferior to
 173 # that generated by Sphinx.
 174
 175 # These targets redirect HTML creation and installation to either
 176 # jit.sphinx.(install-)html or jit.texinfo.(install-)html.
 177 jit.html: jit.$(doc_build_sys).html
 178 jit.install-html: jit.$(doc_build_sys).install-html
 179
 180 # For now, use texinfo for pdf, since the sphinx latex toolchain currently
 181 # fails for me deep inside pdflatex (see notes below)
 182 jit.pdf: jit.texinfo.pdf
 183 jit.install-pdf: jit.texinfo.install-pdf
 184
 185 # Hooks for building docs using texinfo
 186 JIT_TEXI_FILES = $(srcdir)/jit/docs/_build/texinfo/libgccjit.texi
 187
 188 jit.info: doc/libgccjit.info
 189 doc/libgccjit.info: $(JIT_TEXI_FILES)
 190         if test "x$(BUILD_INFO)" = xinfo; then \
 191           rm -f doc/libgccjit.info*; \
 192           $(MAKEINFO) $(MAKEINFOFLAGS) -I $(gcc_docdir) \
 193                 -I $(gcc_docdir)/include -o $@ $<; \
 194         else true; fi
 195
 196 jit.install-info: $(DESTDIR)$(infodir)/libgccjit.info
 197
 198 jit.dvi: doc/libgccjit.dvi
 199 doc/libgccjit.dvi: $(JIT_TEXI_FILES)
 200         $(TEXI2DVI) -I $(abs_docdir) -I $(abs_docdir)/include -o $@ $<
 201
 202 jit.texinfo.html: $(build_htmldir)/jit/index.html
 203
 204 $(build_htmldir)/jit/index.html: $(srcdir)/jit/docs/_build/texinfo/libgccjit.texi
 205         $(mkinstalldirs) $(@D)
 206         rm -f $(@D)/*
 207         $(TEXI2HTML) -I $(gcc_docdir)/include -I $(srcdir)/jit -o $(@D) $<
 208
 209 jit.texinfo.install-html: jit.texinfo.html
 210         @$(NORMAL_INSTALL)
 211         test -z "$(htmldir)" || $(mkinstalldirs) "$(DESTDIR)$(htmldir)"
 212         @for p in $(build_htmldir)/jit; do \
 213           if test -f "$$p" || test -d "$$p"; then d=""; else d="$(srcdir)/"; fi; \
 214           f=$(html__strip_dir) \
 215           if test -d "$$d$$p"; then \
 216             echo " $(mkinstalldirs) '$(DESTDIR)$(htmldir)/$$f'"; \
 217             $(mkinstalldirs) "$(DESTDIR)$(htmldir)/$$f" || exit 1; \
 218             echo " $(INSTALL_DATA) '$$d$$p'/* '$(DESTDIR)$(htmldir)/$$f'"; \
 219             $(INSTALL_DATA) "$$d$$p"/* "$(DESTDIR)$(htmldir)/$$f"; \
 220           else \
 221             echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(htmldir)/$$f'"; \
 222             $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(htmldir)/$$f"; \
 223           fi; \
 224         done
 225
 226 jit.texinfo.pdf: doc/libgccjit.pdf
 227
 228 doc/libgccjit.pdf: $(JIT_TEXI_FILES)
 229         $(TEXI2PDF) -I $(abs_docdir) -I $(abs_docdir)/include -o $@ $<
 230
 231 jit.texinfo.install-pdf: doc/libgccjit.pdf
 232         @$(NORMAL_INSTALL)
 233         test -z "$(pdfdir)" || $(mkinstalldirs) "$(DESTDIR)$(pdfdir)/gcc"
 234         @for p in doc/libgccjit.pdf; do \
 235           if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
 236           f=$(pdf__strip_dir) \
 237           echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/gcc/$$f'"; \
 238           $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/gcc/$$f"; \
 239         done
 240
 241 # Hooks for building docs using the Sphinx toolchain:
 242
 243 SPHINX_BUILD_DIR=jit/sphinx-build
 244
 245 jit.sphinx.html:
 246         mkdir -p $(SPHINX_BUILD_DIR)
 247         (cd $(srcdir)/jit/docs && \
 248           make html BUILDDIR=$(PWD)/$(SPHINX_BUILD_DIR) )
 249
 250 jit_htmldir=$(htmldir)/jit
 251
 252 jit.sphinx.install-html: jit.sphinx.html
 253         @$(NORMAL_INSTALL)
 254         test -z "$(jit_htmldir)" || $(mkinstalldirs) "$(DESTDIR)$(jit_htmldir)"
 255         @for f in $(shell cd $(SPHINX_BUILD_DIR)/html && find) ; do \
 256           if test -f $(SPHINX_BUILD_DIR)/html/"$$f"; then \
 257              $(INSTALL_DATA) $(SPHINX_BUILD_DIR)/html/"$$f" $(DESTDIR)$(jit_htmldir)/"$$f"; \
 258           else \
 259              mkdir $(DESTDIR)$(jit_htmldir)/"$$f"; \
 260           fi; \
 261         done
 262
 263 # (This one is currently failing deep inside pdflatex for me;
 264 # see https://bugzilla.redhat.com/show_bug.cgi?id=1148845 )
 265 jit.sphinx.pdf: $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf
 266 $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf:
 267         mkdir -p $(SPHINX_BUILD_DIR)
 268         (cd $(srcdir)/jit/docs && \
 269           make latexpdf BUILDDIR=$(PWD)/$(SPHINX_BUILD_DIR) )
 270
 271 jit.sphinx.install-pdf: $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf
 272         @$(NORMAL_INSTALL)
 273         test -z "$(pdfdir)" || $(mkinstalldirs) "$(DESTDIR)$(pdfdir)/gcc"
 274         @for p in $(SPHINX_BUILD_DIR)/latex/libgccjit.pdf; do \
 275           if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
 276           f=$(pdf__strip_dir) \
 277           echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/gcc/$$f'"; \
 278           $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/gcc/$$f"; \
 279         done
 280
 281 jit.srcinfo:
 282 jit.srcextra:
 283
 284 jit.tags:
 285
 286 jit.man:
 287
 288 jit.srcman:
 289
 290 lang_checks += check-jit
 291 lang_checks_parallelized += check-jit
 292 # This number is somewhat arbitrary.  Two tests are much slower
 293 # than all the others (test-combination.c and test-threads.c) so
 294 # we want them to be placed in different "buckets".
 295 check_jit_parallelize = 10
 296
 297 # No jit-specific selftests
 298 selftest-jit:
 299
 300 #\f
 301 # Install hooks:
 302 jit.install-headers:
 303         $(INSTALL_DATA) $(srcdir)/jit/libgccjit.h \
 304           $(DESTDIR)$(includedir)/libgccjit.h
 305         $(INSTALL_DATA) $(srcdir)/jit/libgccjit++.h \
 306           $(DESTDIR)$(includedir)/libgccjit++.h
 307
 308 ifneq (,$(findstring mingw,$(target)))
 309 jit.install-common: installdirs jit.install-headers
 310 # Install import library
 311         $(INSTALL_PROGRAM) $(LIBGCCJIT_FILENAME).a \
 312           $(DESTDIR)$(libdir)/$(LIBGCCJIT_FILENAME).a
 313 # Install DLL file
 314         $(INSTALL_PROGRAM) $(LIBGCCJIT_FILENAME) \
 315           $(DESTDIR)$(bindir)/$(LIBGCCJIT_FILENAME)
 316 else
 317 jit.install-common: installdirs jit.install-headers
 318         $(INSTALL_PROGRAM) $(LIBGCCJIT_FILENAME) \
 319           $(DESTDIR)$(libdir)/$(LIBGCCJIT_FILENAME)
 320         ln -sf \
 321           $(LIBGCCJIT_FILENAME) \
 322           $(DESTDIR)$(libdir)/$(LIBGCCJIT_SONAME_SYMLINK)
 323         ln -sf \
 324           $(LIBGCCJIT_SONAME_SYMLINK)\
 325           $(DESTDIR)$(libdir)/$(LIBGCCJIT_LINKER_NAME_SYMLINK)
 326 endif
 327
 328 jit.install-man:
 329
 330 jit.install-plugin:
 331
 332 jit.uninstall:
 333
 334 #\f
 335 # Clean hooks:
 336 # A lot of the ancillary files are deleted by the main makefile.
 337 # We just have to delete files specific to us.
 338
 339 jit.mostlyclean:
 340         -rm -f $(LIBGCCJIT_FILENAME) $(LIBGCCJIT_SYMLINK)
 341         -rm -f $(LIBGCCJIT_LINKER_NAME_SYMLINK) $(FULL_DRIVER_NAME)
 342         -rm -f $(LIBGCCJIT_SONAME)
 343         -rm -f $(jit_OBJS)
 344
 345 jit.clean:
 346
 347 jit.distclean:
 348
 349 jit.maintainer-clean:
 350
 351 #\f
 352 # Stage hooks:
 353 # The main makefile has already created stage?/jit.
 354
 355 jit.stage1: stage1-start
 356         -mv jit/*$(objext) stage1/jit
 357 jit.stage2: stage2-start
 358         -mv jit/*$(objext) stage2/jit
 359 jit.stage3: stage3-start
 360         -mv jit/*$(objext) stage3/jit
 361 jit.stage4: stage4-start
 362         -mv jit/*$(objext) stage4/jit
 363 jit.stageprofile: stageprofile-start
 364         -mv jit/*$(objext) stageprofile/jit
 365 jit.stagefeedback: stagefeedback-start
 366         -mv jit/*$(objext) stagefeedback/jit