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            Stuff to append to library's link command
  24 #                       (typically, -L and -l switches for external libraries)
  25 # SHLIB_LINK_INTERNAL   -L and -l switches for Postgres-supplied libraries
  26 # SHLIB_PREREQS         Order-only prerequisites for library build target
  27 # SHLIB_EXPORTS         (optional) Name of file containing list of symbols to
  28 #                       export, in the format "function_name  number"
  29 #
  30 # Don't use SHLIB_LINK for references to files in the build tree, or the
  31 # wrong things will happen --- use SHLIB_LINK_INTERNAL for those!
  32 #
  33 # When building a shared library, the following version information
  34 # must also be set.  It should be omitted when building a dynamically
  35 # loadable module.
  36 #
  37 # SO_MAJOR_VERSION      Major version number to use for shared library
  38 # SO_MINOR_VERSION      Minor version number to use for shared library
  39 # (If you want a patchlevel, include it in SO_MINOR_VERSION, e.g., "6.2".)
  40 #
  41 # The module Makefile must also include
  42 # $(top_builddir)/src/Makefile.global before including this file.
  43 # (Makefile.global sets PORTNAME and other needed symbols.)
  44 #
  45 # This makefile provides the following (phony) targets:
  46 #
  47 # all-lib               build the static and shared (if applicable) libraries
  48 # install-lib           install the libraries into $(libdir)
  49 # installdirs-lib       create installation directory $(libdir)
  50 # uninstall-lib         remove the libraries from $(libdir)
  51 # clean-lib             delete the static and shared libraries from the build dir
  52 #
  53 # Typically you would add `all-lib' to the `all' target so that `make all'
  54 # builds the libraries.  In the most simple case it would look like this:
  55 #
  56 #     all: all-lib
  57 #
  58 # Similarly, the install rule might look like
  59 #
  60 #     install: install-lib
  61 #
  62 # plus any additional things you want to install. Et cetera.
  63 #
  64 # Got that?  Look at src/interfaces/libpq/Makefile for an example.
  65 #
  66
  67
  68 COMPILER = $(CC) $(CFLAGS)
  69 LINK.static = $(AR) $(AROPT)
  70
  71 LDFLAGS_INTERNAL += $(SHLIB_LINK_INTERNAL)
  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 override CXXFLAGS += $(CFLAGS_SL)
 104 ifdef SO_MAJOR_VERSION
 105 # libraries ought to use this to refer to versioned gettext domain names
 106 override CPPFLAGS += -DSO_MAJOR_VERSION=$(SO_MAJOR_VERSION)
 107 endif
 108
 109 ifeq ($(PORTNAME), aix)
 110   LINK.shared           = $(COMPILER)
 111   ifdef SO_MAJOR_VERSION
 112     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 113   endif
 114   haslibarule   = yes
 115   # $(exports_file) is also usable as an import file
 116   exports_file          = lib$(NAME).exp
 117   BUILD.exports         = ( echo '\#! $(shlib)'; $(AWK) '/^[^\#]/ {printf "%s\n",$$1}' $< ) > $@
 118   ifneq (,$(SHLIB_EXPORTS))
 119     LINK.shared         += -Wl,-bE:$(exports_file)
 120   endif
 121 endif
 122
 123 ifeq ($(PORTNAME), darwin)
 124   ifdef soname
 125     # linkable library
 126     ifneq ($(SO_MAJOR_VERSION), 0)
 127       version_link      = -compatibility_version $(SO_MAJOR_VERSION) -current_version $(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 128     endif
 129     LINK.shared         = $(COMPILER) -dynamiclib -install_name '$(libdir)/lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)' $(version_link) $(exported_symbols_list)
 130     shlib               = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
 131     shlib_major         = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
 132   else
 133     # loadable module
 134     LINK.shared         = $(COMPILER) -bundle
 135   endif
 136   BUILD.exports         = $(AWK) '/^[^\#]/ {printf "_%s\n",$$1}' $< >$@
 137   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 138   ifneq (,$(exports_file))
 139     exported_symbols_list = -exported_symbols_list $(exports_file)
 140   endif
 141 endif
 142
 143 ifeq ($(PORTNAME), openbsd)
 144   LINK.shared           = $(COMPILER) -shared
 145   ifdef soname
 146     LINK.shared         += -Wl,-x,-soname,$(soname)
 147   endif
 148   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 149   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 150   ifneq (,$(exports_file))
 151     LINK.shared         += -Wl,--version-script=$(exports_file)
 152   endif
 153   SHLIB_LINK            += -lc
 154 endif
 155
 156 ifeq ($(PORTNAME), freebsd)
 157   ifdef SO_MAJOR_VERSION
 158     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 159   endif
 160   LINK.shared           = $(COMPILER) -shared
 161   ifdef soname
 162     LINK.shared         += -Wl,-x,-soname,$(soname)
 163   endif
 164   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 165   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 166   ifneq (,$(exports_file))
 167     LINK.shared         += -Wl,--version-script=$(exports_file)
 168   endif
 169 endif
 170
 171 ifeq ($(PORTNAME), netbsd)
 172   LINK.shared           = $(COMPILER) -shared
 173   ifdef soname
 174     LINK.shared         += -Wl,-x,-soname,$(soname)
 175   endif
 176   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 177   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 178   ifneq (,$(exports_file))
 179     LINK.shared         += -Wl,--version-script=$(exports_file)
 180   endif
 181 endif
 182
 183 ifeq ($(PORTNAME), linux)
 184   LINK.shared           = $(COMPILER) -shared
 185   ifdef soname
 186     LINK.shared         += -Wl,-soname,$(soname)
 187   endif
 188   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 189   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 190   ifneq (,$(exports_file))
 191     LINK.shared         += -Wl,--version-script=$(exports_file)
 192   endif
 193 endif
 194
 195 ifeq ($(PORTNAME), solaris)
 196   LINK.shared           = $(COMPILER) -shared
 197   ifdef soname
 198     LINK.shared += -Wl,-soname,$(soname)
 199   endif
 200   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 201   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 202   ifneq (,$(exports_file))
 203     LINK.shared         += -Wl,-M$(exports_file)
 204   endif
 205 endif
 206
 207 ifeq ($(PORTNAME), cygwin)
 208   LINK.shared           = $(CC) -shared
 209   ifdef SO_MAJOR_VERSION
 210     shlib               = cyg$(NAME)$(DLSUFFIX)
 211   endif
 212   haslibarule   = yes
 213 endif
 214
 215 ifeq ($(PORTNAME), win32)
 216   ifdef SO_MAJOR_VERSION
 217     shlib               = lib$(NAME)$(DLSUFFIX)
 218   endif
 219   haslibarule   = yes
 220 endif
 221
 222
 223 # If the shared library doesn't have an export file, mark all symbols not
 224 # explicitly exported using PGDLLEXPORT as hidden. We can't pass these flags
 225 # when building a library with explicit exports, as the symbols would be
 226 # hidden before the linker script / exported symbol list takes effect.
 227 #
 228 # This is duplicated in pgxs.mk for MODULES style libraries.
 229 ifeq ($(SHLIB_EXPORTS),)
 230   # LDFLAGS_SL addition not strictly needed, CFLAGS used everywhere, but ...
 231   override LDFLAGS_SL += $(CFLAGS_SL_MODULE)
 232   override CFLAGS += $(CFLAGS_SL_MODULE)
 233   override CXXFLAGS += $(CXXFLAGS_SL_MODULE)
 234 endif
 235
 236
 237 ##
 238 ## BUILD
 239 ##
 240
 241 .PHONY: all-lib all-static-lib all-shared-lib
 242
 243 all-lib: all-shared-lib
 244 ifdef soname
 245 # no static library when building a dynamically loadable module
 246 all-lib: all-static-lib
 247 all-lib: lib$(NAME).pc
 248 endif
 249
 250 all-static-lib: $(stlib)
 251
 252 all-shared-lib: $(shlib)
 253
 254 # In this rule, "touch $@" works around a problem on some platforms wherein
 255 # ar updates the library file's mod time with a value calculated to
 256 # seconds precision.  If the filesystem has sub-second timestamps, this can
 257 # cause the library file to appear older than its input files, triggering
 258 # parallel-make problems.
 259 ifndef haslibarule
 260 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 261         rm -f $@
 262         $(LINK.static) $@ $^
 263         touch $@
 264 endif #haslibarule
 265
 266 # AIX wraps shared libraries inside a static library, can be used both
 267 # for static and shared linking
 268 ifeq ($(PORTNAME), aix)
 269 $(stlib): $(shlib)
 270         rm -f $(stlib)
 271         $(AR) $(AROPT) $(stlib) $(shlib)
 272 endif # aix
 273
 274 ifeq (,$(filter cygwin win32,$(PORTNAME)))
 275
 276 # Normal case
 277 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 278         $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 279 ifdef shlib_major
 280 # If we're using major and minor versions, then make a symlink to major-version-only.
 281 ifneq ($(shlib), $(shlib_major))
 282         rm -f $(shlib_major)
 283         $(LN_S) $(shlib) $(shlib_major)
 284 endif
 285 # Make sure we have a link to a name without any version numbers
 286 ifneq ($(shlib), $(shlib_bare))
 287 # except on AIX, where that's not a thing
 288 ifneq ($(PORTNAME), aix)
 289         rm -f $(shlib_bare)
 290         $(LN_S) $(shlib) $(shlib_bare)
 291 endif # aix
 292 endif # shlib_bare
 293 endif # shlib_major
 294
 295 # Where possible, restrict the symbols exported by the library to just the
 296 # official list, so as to avoid unintentional ABI changes.  On recent macOS
 297 # this also quiets multiply-defined-symbol warnings in programs that use
 298 # libpgport along with libpq.
 299 ifneq (,$(SHLIB_EXPORTS))
 300 ifdef BUILD.exports
 301 $(shlib): $(exports_file)
 302
 303 $(exports_file): $(SHLIB_EXPORTS)
 304         $(BUILD.exports)
 305 endif
 306 endif
 307
 308 else # PORTNAME == cygwin || PORTNAME == win32
 309
 310 ifeq ($(PORTNAME), cygwin)
 311
 312 # Cygwin case
 313
 314 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 315         $(CC) $(CFLAGS)  -shared -o $@ -Wl,--out-implib=$(stlib) $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) $(LDAP_LIBS_BE)
 316
 317 # see notes in src/backend/parser/Makefile  about use of this type of rule
 318 $(stlib): $(shlib)
 319         touch $@
 320
 321 else
 322
 323 # Win32 case
 324
 325 # See notes in src/backend/parser/Makefile about the following two rules
 326 $(stlib): $(shlib)
 327         touch $@
 328
 329 # XXX A backend that loads a module linked with libgcc_s_dw2-1.dll will exit
 330 # uncleanly, hence -static-libgcc.  (Last verified with MinGW-w64 compilers
 331 # from i686-4.9.1-release-win32-dwarf-rt_v3-rev1.)  Shared libgcc has better
 332 # support for C++/Java exceptions; while core PostgreSQL does not use them, it
 333 # would be nice to support shared libgcc for the benefit of extensions.
 334 #
 335 # If SHLIB_EXPORTS is set, the rules below will build a .def file from that.
 336 # Else we just use --export-all-symbols.
 337 ifeq (,$(SHLIB_EXPORTS))
 338 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 339         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--export-all-symbols -Wl,--out-implib=$(stlib)
 340 else
 341 DLL_DEFFILE = lib$(NAME)dll.def
 342
 343 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
 344         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(DLL_DEFFILE) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--out-implib=$(stlib)
 345
 346 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 347
 348 $(DLL_DEFFILE): $(SHLIB_EXPORTS)
 349         echo 'LIBRARY LIB$(UC_NAME).dll' >$@
 350         echo 'EXPORTS' >>$@
 351         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 352 endif
 353
 354 endif # PORTNAME == cygwin
 355 endif # PORTNAME == cygwin || PORTNAME == win32
 356
 357
 358 %.pc: $(MAKEFILE_LIST)
 359         echo 'prefix=$(prefix)' >$@
 360         echo 'exec_prefix=$(patsubst $(prefix),$${prefix},$(exec_prefix))' >>$@
 361         echo 'libdir=$(patsubst $(exec_prefix)/%,$${exec_prefix}/%,$(libdir))' >>$@
 362         echo 'includedir=$(patsubst $(prefix)/%,$${prefix}/%,$(includedir))' >>$@
 363         echo >>$@
 364         echo 'Name: lib$(NAME)' >>$@
 365         echo 'Description: PostgreSQL lib$(NAME) library' >>$@
 366         echo 'URL: $(PACKAGE_URL)' >>$@
 367         echo 'Version: $(VERSION)' >>$@
 368         echo 'Requires: ' >>$@
 369         echo 'Requires.private: $(PKG_CONFIG_REQUIRES_PRIVATE)' >>$@
 370         echo 'Cflags: -I$${includedir}' >>$@
 371         echo 'Libs: -L$${libdir} -l$(NAME)' >>$@
 372 # Record -L flags that the user might have passed in to the PostgreSQL
 373 # build to locate third-party libraries (e.g., ldap, ssl).  Filter out
 374 # those that point inside the build or source tree.  Use sort to
 375 # remove duplicates.  Also record the -l flags necessary for static
 376 # linking, but not those already covered by Requires.private.
 377         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_INTERNAL:%_shlib=%) $(SHLIB_LINK)))' >>$@
 378
 379
 380 ##
 381 ## INSTALL
 382 ##
 383
 384 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
 385 install-lib: install-lib-shared
 386 ifdef soname
 387 install-lib: install-lib-static
 388 install-lib: install-lib-pc
 389 endif
 390
 391 install-lib-pc: lib$(NAME).pc installdirs-lib
 392         $(INSTALL_DATA) $< '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 393
 394 install-lib-static: $(stlib) installdirs-lib
 395         $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
 396
 397 install-lib-shared: $(shlib) installdirs-lib
 398 ifdef soname
 399 # we don't install $(shlib) on AIX
 400 # (see http://archives.postgresql.org/message-id/52EF20B2E3209443BC37736D00C3C1380A6E79FE@EXADV1.host.magwien.gv.at)
 401 ifneq ($(PORTNAME), aix)
 402         $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
 403 ifneq ($(PORTNAME), cygwin)
 404 ifneq ($(PORTNAME), win32)
 405 ifneq ($(shlib), $(shlib_major))
 406         cd '$(DESTDIR)$(libdir)' && \
 407         rm -f $(shlib_major) && \
 408         $(LN_S) $(shlib) $(shlib_major)
 409 endif
 410 ifneq ($(shlib), $(shlib_bare))
 411         cd '$(DESTDIR)$(libdir)' && \
 412         rm -f $(shlib_bare) && \
 413         $(LN_S) $(shlib) $(shlib_bare)
 414 endif
 415 endif # not win32
 416 endif # not cygwin
 417 endif # not aix
 418 ifneq (,$(findstring $(PORTNAME),win32 cygwin))
 419         $(INSTALL_SHLIB) $< '$(DESTDIR)$(bindir)/$(shlib)'
 420 endif
 421 else # no soname
 422         $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
 423 endif
 424
 425
 426 installdirs-lib:
 427 ifdef soname
 428         $(MKDIR_P) '$(DESTDIR)$(libdir)' '$(DESTDIR)$(pkgconfigdir)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)')
 429 else
 430         $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
 431 endif
 432
 433
 434 ##
 435 ## UNINSTALL
 436 ##
 437
 438 .PHONY: uninstall-lib
 439 uninstall-lib:
 440 ifdef soname
 441         rm -f '$(DESTDIR)$(libdir)/$(stlib)'
 442         rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
 443           '$(DESTDIR)$(libdir)/$(shlib_major)' \
 444           '$(DESTDIR)$(libdir)/$(shlib)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)/$(shlib)') \
 445           '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 446 else # no soname
 447         rm -f '$(DESTDIR)$(pkglibdir)/$(shlib)'
 448 endif # no soname
 449
 450
 451 ##
 452 ## CLEAN
 453 ##
 454
 455 .PHONY: clean-lib
 456 clean-lib:
 457         rm -f $(shlib) $(shlib_bare) $(shlib_major) $(stlib) $(exports_file) lib$(NAME).pc
 458 ifneq (,$(DLL_DEFFILE))
 459         rm -f $(DLL_DEFFILE)
 460 endif