granicus.if.org Git - postgresql/blob - src/Makefile.shlib

   1 #-------------------------------------------------------------------------
   2 #
   3 # Makefile.shlib
   4 #    Common rules for building shared libraries
   5 #
   6 # Copyright (c) 1998, Regents of the University of California
   7 #
   8 # IDENTIFICATION
   9 #    src/Makefile.shlib
  10 #
  11 #-------------------------------------------------------------------------
  12
  13 # This file should be included by any Postgres module Makefile that
  14 # wants to build a shared library (if possible for the current
  15 # platform). A static library is also built from the same object
  16 # files. Only one library can be built per makefile.
  17 #
  18 # Before including this file, the module Makefile must define these
  19 # variables:
  20 #
  21 # NAME                  Name of library to build (no suffix nor "lib" prefix)
  22 # OBJS                  List of object files to include in library
  23 # SHLIB_LINK            If shared library relies on other libraries,
  24 #                       additional stuff to put in its link command
  25 # SHLIB_PREREQS         Order-only prerequisites for library build target
  26 # SHLIB_EXPORTS         (optional) Name of file containing list of symbols to
  27 #                       export, in the format "function_name  number"
  28 #
  29 # When building a shared library, the following version information
  30 # must also be set.  It should be omitted when building a dynamically
  31 # loadable module.
  32 #
  33 # SO_MAJOR_VERSION      Major version number to use for shared library
  34 # SO_MINOR_VERSION      Minor version number to use for shared library
  35 # (If you want a patchlevel, include it in SO_MINOR_VERSION, e.g., "6.2".)
  36 #
  37 # The module Makefile must also include
  38 # $(top_builddir)/src/Makefile.global before including this file.
  39 # (Makefile.global sets PORTNAME and other needed symbols.)
  40 #
  41 # This makefile provides the following (phony) targets:
  42 #
  43 # all-lib               build the static and shared (if applicable) libraries
  44 # install-lib           install the libraries into $(libdir)
  45 # installdirs-lib       create installation directory $(libdir)
  46 # uninstall-lib         remove the libraries from $(libdir)
  47 # clean-lib             delete the static and shared libraries from the build dir
  48 # maintainer-clean-lib  delete .def files built for win32
  49 #
  50 # Typically you would add `all-lib' to the `all' target so that `make all'
  51 # builds the libraries.  In the most simple case it would look like this:
  52 #
  53 #     all: all-lib
  54 #
  55 # Similarly, the install rule might look like
  56 #
  57 #     install: install-lib
  58 #
  59 # plus any additional things you want to install. Et cetera.
  60 #
  61 # Got that?  Look at src/interfaces/libpq/Makefile for an example.
  62 #
  63 # While the linker allows creation of most shared libraries,
  64 # -Bsymbolic requires resolution of all symbols, making the
  65 # compiler a better choice for shared library creation on ELF platforms.
  66 # With the linker, -Bsymbolic requires the crt1.o startup object file.
  67 # bjm 2001-02-10
  68
  69
  70 COMPILER = $(CC) $(CFLAGS)
  71 LINK.static = $(AR) $(AROPT)
  72
  73
  74
  75 ifdef SO_MAJOR_VERSION
  76 # Default library naming convention used by the majority of platforms
  77 shlib           = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
  78 shlib_major     = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
  79 shlib_bare      = lib$(NAME)$(DLSUFFIX)
  80 # Testing the soname variable is a reliable way to determine whether a
  81 # linkable library is being built.
  82 soname          = $(shlib_major)
  83 pkgconfigdir = $(libdir)/pkgconfig
  84 else
  85 # Naming convention for dynamically loadable modules
  86 shlib           = $(NAME)$(DLSUFFIX)
  87 endif
  88 stlib           = lib$(NAME).a
  89
  90 ifndef soname
  91 # additional flags for backend modules
  92 SHLIB_LINK += $(BE_DLLLIBS)
  93 endif
  94
  95 # For each platform we support shared libraries on, set shlib to the
  96 # name of the library (if default above is not right), set
  97 # LINK.shared to the command to link the library,
  98 # and adjust SHLIB_LINK if necessary.
  99
 100 # Try to keep the sections in some kind of order, folks...
 101
 102 override CFLAGS += $(CFLAGS_SL)
 103 ifdef SO_MAJOR_VERSION
 104 # libraries ought to use this to refer to versioned gettext domain names
 105 override CPPFLAGS += -DSO_MAJOR_VERSION=$(SO_MAJOR_VERSION)
 106 endif
 107
 108 ifeq ($(PORTNAME), aix)
 109   ifdef SO_MAJOR_VERSION
 110     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 111   endif
 112   haslibarule   = yes
 113   # $(exports_file) is also usable as an import file
 114   exports_file          = lib$(NAME).exp
 115 endif
 116
 117 ifeq ($(PORTNAME), darwin)
 118   ifdef soname
 119     # linkable library
 120     DLSUFFIX            = .dylib
 121     ifneq ($(SO_MAJOR_VERSION), 0)
 122       version_link      = -compatibility_version $(SO_MAJOR_VERSION) -current_version $(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 123     endif
 124     LINK.shared         = $(COMPILER) -dynamiclib -install_name '$(libdir)/lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)' $(version_link) $(exported_symbols_list) -multiply_defined suppress
 125     shlib               = lib$(NAME).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)$(DLSUFFIX)
 126     shlib_major         = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
 127   else
 128     # loadable module
 129     DLSUFFIX            = .so
 130     LINK.shared         = $(COMPILER) -bundle -multiply_defined suppress
 131   endif
 132   BUILD.exports         = $(AWK) '/^[^\#]/ {printf "_%s\n",$$1}' $< >$@
 133   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 134   ifneq (,$(exports_file))
 135     exported_symbols_list = -exported_symbols_list $(exports_file)
 136   endif
 137 endif
 138
 139 ifeq ($(PORTNAME), openbsd)
 140   ifdef ELF_SYSTEM
 141     LINK.shared         = $(COMPILER) -shared
 142     ifdef soname
 143       LINK.shared       += -Wl,-x,-soname,$(soname)
 144     endif
 145     SHLIB_LINK          += -lc
 146   else
 147     LINK.shared         = $(LD) -x -Bshareable -Bforcearchive
 148   endif
 149 endif
 150
 151 ifeq ($(PORTNAME), freebsd)
 152   ifdef ELF_SYSTEM
 153     ifdef SO_MAJOR_VERSION
 154       shlib             = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 155     endif
 156     LINK.shared         = $(COMPILER) -shared
 157     ifdef soname
 158       LINK.shared       += -Wl,-x,-soname,$(soname)
 159     endif
 160   else
 161     ifdef SO_MAJOR_VERSION
 162       shlib             = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 163     endif
 164     LINK.shared         = $(LD) -x -Bshareable -Bforcearchive
 165   endif
 166 endif
 167
 168 ifeq ($(PORTNAME), netbsd)
 169   ifdef ELF_SYSTEM
 170     LINK.shared         = $(COMPILER) -shared
 171     ifdef soname
 172       LINK.shared       += -Wl,-x,-soname,$(soname)
 173     endif
 174   else
 175     LINK.shared         = $(LD) -x -Bshareable -Bforcearchive
 176   endif
 177 endif
 178
 179 ifeq ($(PORTNAME), hpux)
 180   ifdef SO_MAJOR_VERSION
 181     shlib                       = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 182   endif
 183   ifeq ($(with_gnu_ld), yes)
 184     LINK.shared         = $(CC) -shared
 185     ifdef soname
 186       LINK.shared       += -Wl,-h -Wl,$(soname)
 187     endif
 188   else
 189     LINK.shared         = $(LD) -b
 190     ifdef soname
 191       LINK.shared       += +h $(soname)
 192     endif
 193     # can't use the CC-syntax rpath pattern here, so instead:
 194     rpath =
 195     ifeq ($(enable_rpath), yes)
 196       LINK.shared       += +s +b '$(rpathdir)'
 197     endif
 198     # On HPUX platforms, gcc is usually configured to search for libraries
 199     # in /usr/local/lib, but ld won't do so.  Add an explicit -L switch so
 200     # ld can find the same libraries gcc does.  Make sure it goes after any
 201     # -L switches provided explicitly.
 202     ifeq ($(GCC), yes)
 203       SHLIB_LINK        += -L/usr/local/lib
 204     endif
 205   endif
 206   # And we need to link with libgcc, too
 207   ifeq ($(GCC), yes)
 208     SHLIB_LINK          += `$(CC) $(LDFLAGS) -print-libgcc-file-name`
 209   endif
 210 endif
 211
 212 ifeq ($(PORTNAME), linux)
 213   LINK.shared           = $(COMPILER) -shared
 214   ifdef soname
 215     LINK.shared         += -Wl,-soname,$(soname)
 216   endif
 217   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 218   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 219   ifneq (,$(exports_file))
 220     LINK.shared         += -Wl,--version-script=$(exports_file)
 221   endif
 222 endif
 223
 224 ifeq ($(PORTNAME), solaris)
 225   ifeq ($(GCC), yes)
 226     LINK.shared         = $(COMPILER) -shared
 227   else
 228     LINK.shared         = $(COMPILER) -G
 229   endif
 230   ifdef soname
 231     ifeq ($(with_gnu_ld), yes)
 232       LINK.shared       += -Wl,-soname,$(soname)
 233     else
 234       LINK.shared       += -h $(soname)
 235     endif
 236   endif
 237 endif
 238
 239 ifeq ($(PORTNAME), cygwin)
 240   LINK.shared           = $(CC) -shared
 241   ifdef SO_MAJOR_VERSION
 242     shlib               = cyg$(NAME)$(DLSUFFIX)
 243   endif
 244   haslibarule   = yes
 245 endif
 246
 247 ifeq ($(PORTNAME), win32)
 248   ifdef SO_MAJOR_VERSION
 249     shlib               = lib$(NAME)$(DLSUFFIX)
 250   endif
 251   haslibarule   = yes
 252 endif
 253
 254
 255
 256 ##
 257 ## BUILD
 258 ##
 259
 260 .PHONY: all-lib all-static-lib all-shared-lib
 261
 262 all-lib: all-shared-lib
 263 ifdef soname
 264 # no static library when building a dynamically loadable module
 265 all-lib: all-static-lib
 266 all-lib: lib$(NAME).pc
 267 endif
 268
 269 all-static-lib: $(stlib)
 270
 271 all-shared-lib: $(shlib)
 272
 273 ifndef haslibarule
 274 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 275         rm -f $@
 276         $(LINK.static) $@ $^
 277         $(RANLIB) $@
 278 endif #haslibarule
 279
 280
 281 ifeq (,$(filter cygwin win32,$(PORTNAME)))
 282 ifneq ($(PORTNAME), aix)
 283
 284 # Normal case
 285 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 286         $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 287 ifdef shlib_major
 288 # If we're using major and minor versions, then make a symlink to major-version-only.
 289 ifneq ($(shlib), $(shlib_major))
 290         rm -f $(shlib_major)
 291         $(LN_S) $(shlib) $(shlib_major)
 292 endif
 293 # Make sure we have a link to a name without any version numbers
 294 ifneq ($(shlib), $(shlib_bare))
 295         rm -f $(shlib_bare)
 296         $(LN_S) $(shlib) $(shlib_bare)
 297 endif
 298 endif # shlib_major
 299
 300 # Where possible, restrict the symbols exported by the library to just the
 301 # official list, so as to avoid unintentional ABI changes.  On recent macOS
 302 # this also quiets multiply-defined-symbol warnings in programs that use
 303 # libpgport along with libpq.
 304 ifneq (,$(SHLIB_EXPORTS))
 305 ifdef BUILD.exports
 306 $(shlib): $(SHLIB_EXPORTS:%.txt=%.list)
 307
 308 $(SHLIB_EXPORTS:%.txt=%.list): %.list: %.txt
 309         $(BUILD.exports)
 310 endif
 311 endif
 312
 313 else # PORTNAME == aix
 314
 315 # AIX case
 316
 317 # There is no correct way to write a rule that generates two files.
 318 # Rules with two targets don't have that meaning, they are merely
 319 # shorthand for two otherwise separate rules.  To be safe for parallel
 320 # make, we must chain the dependencies like this.  The semicolon is
 321 # important, otherwise make will choose some built-in rule.
 322
 323 $(stlib): $(shlib) ;
 324
 325 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 326         rm -f $(stlib)
 327         $(LINK.static) $(stlib) $^
 328         $(RANLIB) $(stlib)
 329         $(MKLDEXPORT) $(stlib) $(shlib) >$(exports_file)
 330         $(COMPILER) -o $(shlib) $(stlib) -Wl,-bE:$(exports_file) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 331         rm -f $(stlib)
 332         $(AR) $(AROPT) $(stlib) $(shlib)
 333
 334 endif # PORTNAME == aix
 335
 336 else # PORTNAME == cygwin || PORTNAME == win32
 337
 338 ifeq ($(PORTNAME), cygwin)
 339
 340 # Cygwin case
 341
 342 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 343         $(CC) $(CFLAGS)  -shared -o $@  $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) $(LDAP_LIBS_BE)
 344
 345 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 346         rm -f $@
 347         $(LINK.static) $@ $^
 348         $(RANLIB) $@
 349
 350 else
 351
 352 # Win32 case
 353
 354 # There is no correct way to write a rule that generates two files.
 355 # Rules with two targets don't have that meaning, they are merely
 356 # shorthand for two otherwise separate rules.  To be safe for parallel
 357 # make, we must chain the dependencies like this.  The semicolon is
 358 # important, otherwise make will choose some built-in rule.
 359
 360 $(stlib): $(shlib) ;
 361
 362 # XXX A backend that loads a module linked with libgcc_s_dw2-1.dll will exit
 363 # uncleanly, hence -static-libgcc.  (Last verified with MinGW-w64 compilers
 364 # from i686-4.9.1-release-win32-dwarf-rt_v3-rev1.)  Shared libgcc has better
 365 # support for C++/Java exceptions; while core PostgreSQL does not use them, it
 366 # would be nice to support shared libgcc for the benefit of extensions.
 367 #
 368 # If SHLIB_EXPORTS is set, the rules below will build a .def file from that.
 369 # Else we just use --export-all-symbols.
 370 ifeq (,$(SHLIB_EXPORTS))
 371 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 372         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--export-all-symbols -Wl,--out-implib=$(stlib)
 373 else
 374 DLL_DEFFILE = lib$(NAME)dll.def
 375
 376 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
 377         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(DLL_DEFFILE) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--out-implib=$(stlib)
 378 endif
 379
 380 endif # PORTNAME == cgywin
 381 endif # PORTNAME == cygwin || PORTNAME == win32
 382
 383
 384 %.pc: $(MAKEFILE_LIST)
 385         echo 'Name: lib$(NAME)' >$@
 386         echo 'Description: PostgreSQL lib$(NAME) library' >>$@
 387         echo 'Url: http://www.postgresql.org/' >>$@
 388         echo 'Version: $(VERSION)' >>$@
 389         echo 'Requires: ' >>$@
 390         echo 'Requires.private: $(PKG_CONFIG_REQUIRES_PRIVATE)' >>$@
 391         echo 'Cflags: -I$(includedir)' >>$@
 392         echo 'Libs: -L$(libdir) -l$(NAME)' >>$@
 393 # Record -L flags that the user might have passed in to the PostgreSQL
 394 # build to locate third-party libraries (e.g., ldap, ssl).  Filter out
 395 # those that point inside the build or source tree.  Use sort to
 396 # remove duplicates.  Also record the -l flags necessary for static
 397 # linking, but not those already covered by Requires.private.
 398         echo 'Libs.private: $(sort $(filter-out -L.% -L$(top_srcdir)/%,$(filter -L%,$(LDFLAGS) $(SHLIB_LINK)))) $(filter-out $(PKG_CONFIG_REQUIRES_PRIVATE:lib%=-l%),$(filter -l%,$(SHLIB_LINK)))' >>$@
 399
 400
 401 # We need several not-quite-identical variants of .DEF files to build
 402 # DLLs for Windows.  These are made from the single source file
 403 # exports.txt.  Since we can't assume that Windows boxes will have
 404 # sed, the .DEF files are always built and included in distribution
 405 # tarballs.
 406
 407 ifneq (,$(SHLIB_EXPORTS))
 408 distprep: lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
 409
 410 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 411
 412 lib$(NAME)dll.def: $(SHLIB_EXPORTS)
 413         echo '; DEF file for win32.mak release build and for Makefile.shlib (MinGW)' >$@
 414         echo 'LIBRARY LIB$(UC_NAME).dll' >>$@
 415         echo 'EXPORTS' >>$@
 416         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 417
 418 lib$(NAME)ddll.def: $(SHLIB_EXPORTS)
 419         echo '; DEF file for win32.mak debug build' >$@
 420         echo 'LIBRARY LIB$(UC_NAME)D.dll' >>$@
 421         echo 'EXPORTS' >>$@
 422         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 423
 424 blib$(NAME)dll.def: $(SHLIB_EXPORTS)
 425         echo '; DEF file for bcc32.mak (Borland C++ Builder)' >$@
 426         echo 'LIBRARY BLIB$(UC_NAME)' >>$@
 427         echo 'EXPORTS' >>$@
 428         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    _\1@ \2/' $< >>$@
 429         echo >>$@
 430         echo '; Aliases for MS compatible names' >> $@
 431         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1= _\1/' $< | sed 's/ *$$//' >>$@
 432 endif # SHLIB_EXPORTS
 433
 434
 435 ##
 436 ## INSTALL
 437 ##
 438
 439 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
 440 install-lib: install-lib-shared
 441 ifdef soname
 442 install-lib: install-lib-static
 443 install-lib: install-lib-pc
 444 endif
 445
 446 install-lib-pc: lib$(NAME).pc installdirs-lib
 447         $(INSTALL_DATA) $< '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 448
 449 install-lib-static: $(stlib) installdirs-lib
 450         $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
 451 ifeq ($(PORTNAME), darwin)
 452         cd '$(DESTDIR)$(libdir)' && \
 453         ranlib $(stlib)
 454 endif
 455
 456 install-lib-shared: $(shlib) installdirs-lib
 457 ifdef soname
 458 # we don't install $(shlib) on AIX
 459 # (see http://archives.postgresql.org/message-id/52EF20B2E3209443BC37736D00C3C1380A6E79FE@EXADV1.host.magwien.gv.at)
 460 ifneq ($(PORTNAME), aix)
 461         $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
 462 ifneq ($(PORTNAME), cygwin)
 463 ifneq ($(PORTNAME), win32)
 464 ifneq ($(shlib), $(shlib_major))
 465         cd '$(DESTDIR)$(libdir)' && \
 466         rm -f $(shlib_major) && \
 467         $(LN_S) $(shlib) $(shlib_major)
 468 endif
 469 ifneq ($(shlib), $(shlib_bare))
 470         cd '$(DESTDIR)$(libdir)' && \
 471         rm -f $(shlib_bare) && \
 472         $(LN_S) $(shlib) $(shlib_bare)
 473 endif
 474 endif # not win32
 475 endif # not cygwin
 476 endif # not aix
 477 ifneq (,$(findstring $(PORTNAME),win32 cygwin))
 478         $(INSTALL_SHLIB) $< '$(DESTDIR)$(bindir)/$(shlib)'
 479 endif
 480 else # no soname
 481         $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
 482 endif
 483
 484
 485 installdirs-lib:
 486 ifdef soname
 487         $(MKDIR_P) '$(DESTDIR)$(libdir)' '$(DESTDIR)$(pkgconfigdir)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)')
 488 else
 489         $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
 490 endif
 491
 492
 493 ##
 494 ## UNINSTALL
 495 ##
 496
 497 .PHONY: uninstall-lib
 498 uninstall-lib:
 499 ifdef soname
 500         rm -f '$(DESTDIR)$(libdir)/$(stlib)'
 501         rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
 502           '$(DESTDIR)$(libdir)/$(shlib_major)' \
 503           '$(DESTDIR)$(libdir)/$(shlib)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)/$(shlib)') \
 504           '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 505 else # no soname
 506         rm -f '$(DESTDIR)$(pkglibdir)/$(shlib)'
 507 endif # no soname
 508
 509
 510 ##
 511 ## CLEAN
 512 ##
 513
 514 .PHONY: clean-lib
 515 clean-lib:
 516         rm -f $(shlib) $(shlib_bare) $(shlib_major) $(stlib) $(exports_file) lib$(NAME).pc
 517
 518 ifneq (,$(SHLIB_EXPORTS))
 519 maintainer-clean-lib:
 520         rm -f lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
 521 endif