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), darwin)
 110   ifdef soname
 111     # linkable library
 112     ifneq ($(SO_MAJOR_VERSION), 0)
 113       version_link      = -compatibility_version $(SO_MAJOR_VERSION) -current_version $(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 114     endif
 115     LINK.shared         = $(COMPILER) -dynamiclib -install_name '$(libdir)/lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)' $(version_link) $(exported_symbols_list)
 116     shlib               = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
 117     shlib_major         = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
 118   else
 119     # loadable module
 120     LINK.shared         = $(COMPILER) -bundle
 121   endif
 122   BUILD.exports         = $(AWK) '/^[^\#]/ {printf "_%s\n",$$1}' $< >$@
 123   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 124   ifneq (,$(exports_file))
 125     exported_symbols_list = -exported_symbols_list $(exports_file)
 126   endif
 127 endif
 128
 129 ifeq ($(PORTNAME), openbsd)
 130   LINK.shared           = $(COMPILER) -shared
 131   ifdef soname
 132     LINK.shared         += -Wl,-x,-soname,$(soname)
 133   endif
 134   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 135   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 136   ifneq (,$(exports_file))
 137     LINK.shared         += -Wl,--version-script=$(exports_file)
 138   endif
 139   SHLIB_LINK            += -lc
 140 endif
 141
 142 ifeq ($(PORTNAME), freebsd)
 143   ifdef SO_MAJOR_VERSION
 144     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 145   endif
 146   LINK.shared           = $(COMPILER) -shared
 147   ifdef soname
 148     LINK.shared         += -Wl,-x,-soname,$(soname)
 149   endif
 150   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 151   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 152   ifneq (,$(exports_file))
 153     LINK.shared         += -Wl,--version-script=$(exports_file)
 154   endif
 155 endif
 156
 157 ifeq ($(PORTNAME), netbsd)
 158   LINK.shared           = $(COMPILER) -shared
 159   ifdef soname
 160     LINK.shared         += -Wl,-x,-soname,$(soname)
 161   endif
 162   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 163   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 164   ifneq (,$(exports_file))
 165     LINK.shared         += -Wl,--version-script=$(exports_file)
 166   endif
 167 endif
 168
 169 ifeq ($(PORTNAME), linux)
 170   LINK.shared           = $(COMPILER) -shared
 171   ifdef soname
 172     ifneq (,$(findstring linux-android,$(host_os)))
 173       # Android uses unversioned shared libraries
 174       shlib             = $(shlib_bare)
 175       soname            = $(shlib_bare)
 176     endif
 177     LINK.shared         += -Wl,-soname,$(soname)
 178   endif
 179   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 180   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 181   ifneq (,$(exports_file))
 182     LINK.shared         += -Wl,--version-script=$(exports_file)
 183   endif
 184 endif
 185
 186 ifeq ($(PORTNAME), solaris)
 187   LINK.shared           = $(COMPILER) -shared
 188   ifdef soname
 189     LINK.shared += -Wl,-soname,$(soname)
 190   endif
 191   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 192   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 193   ifneq (,$(exports_file))
 194     LINK.shared         += -Wl,-M$(exports_file)
 195   endif
 196 endif
 197
 198 ifeq ($(PORTNAME), cygwin)
 199   LINK.shared           = $(CC) -shared
 200   ifdef SO_MAJOR_VERSION
 201     shlib               = cyg$(NAME)$(DLSUFFIX)
 202   endif
 203   haslibarule   = yes
 204 endif
 205
 206 ifeq ($(PORTNAME), win32)
 207   ifdef SO_MAJOR_VERSION
 208     shlib               = lib$(NAME)$(DLSUFFIX)
 209   endif
 210   haslibarule   = yes
 211 endif
 212
 213
 214 # If the shared library doesn't have an export file, mark all symbols not
 215 # explicitly exported using PGDLLEXPORT as hidden. We can't pass these flags
 216 # when building a library with explicit exports, as the symbols would be
 217 # hidden before the linker script / exported symbol list takes effect.
 218 #
 219 # This is duplicated in pgxs.mk for MODULES style libraries.
 220 ifeq ($(SHLIB_EXPORTS),)
 221   # LDFLAGS_SL addition not strictly needed, CFLAGS used everywhere, but ...
 222   override LDFLAGS_SL += $(CFLAGS_SL_MODULE)
 223   override CFLAGS += $(CFLAGS_SL_MODULE)
 224   override CXXFLAGS += $(CXXFLAGS_SL_MODULE)
 225 endif
 226
 227
 228 ##
 229 ## BUILD
 230 ##
 231
 232 .PHONY: all-lib all-static-lib all-shared-lib
 233
 234 all-lib: all-shared-lib
 235 ifdef soname
 236 # no static library when building a dynamically loadable module
 237 all-lib: all-static-lib
 238 all-lib: lib$(NAME).pc
 239 endif
 240
 241 all-static-lib: $(stlib)
 242
 243 all-shared-lib: $(shlib)
 244
 245 # In this rule, "touch $@" works around a problem on some platforms wherein
 246 # ar updates the library file's mod time with a value calculated to
 247 # seconds precision.  If the filesystem has sub-second timestamps, this can
 248 # cause the library file to appear older than its input files, triggering
 249 # parallel-make problems.
 250 ifndef haslibarule
 251 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 252         rm -f $@
 253         $(LINK.static) $@ $^
 254         touch $@
 255 endif #haslibarule
 256
 257 ifeq (,$(filter cygwin win32,$(PORTNAME)))
 258
 259 # Normal case
 260 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 261         $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 262 ifdef shlib_major
 263 # If we're using major and minor versions, then make a symlink to major-version-only.
 264 ifneq ($(shlib), $(shlib_major))
 265         rm -f $(shlib_major)
 266         $(LN_S) $(shlib) $(shlib_major)
 267 endif
 268 # Make sure we have a link to a name without any version numbers
 269 ifneq ($(shlib), $(shlib_bare))
 270         rm -f $(shlib_bare)
 271         $(LN_S) $(shlib) $(shlib_bare)
 272 endif # shlib_bare
 273 endif # shlib_major
 274
 275 # Where possible, restrict the symbols exported by the library to just the
 276 # official list, so as to avoid unintentional ABI changes.  On recent macOS
 277 # this also quiets multiply-defined-symbol warnings in programs that use
 278 # libpgport along with libpq.
 279 ifneq (,$(SHLIB_EXPORTS))
 280 ifdef BUILD.exports
 281 $(shlib): $(exports_file)
 282
 283 $(exports_file): $(SHLIB_EXPORTS)
 284         $(BUILD.exports)
 285 endif
 286 endif
 287
 288 else # PORTNAME == cygwin || PORTNAME == win32
 289
 290 ifeq ($(PORTNAME), cygwin)
 291
 292 # Cygwin case
 293
 294 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 295         $(CC) $(CFLAGS)  -shared -o $@ -Wl,--out-implib=$(stlib) $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) $(LDAP_LIBS_BE)
 296
 297 # see notes in src/backend/parser/Makefile  about use of this type of rule
 298 $(stlib): $(shlib)
 299         touch $@
 300
 301 else
 302
 303 # Win32 case
 304
 305 # See notes in src/backend/parser/Makefile about the following two rules
 306 $(stlib): $(shlib)
 307         touch $@
 308
 309 # XXX A backend that loads a module linked with libgcc_s_dw2-1.dll will exit
 310 # uncleanly, hence -static-libgcc.  (Last verified with MinGW-w64 compilers
 311 # from i686-4.9.1-release-win32-dwarf-rt_v3-rev1.)  Shared libgcc has better
 312 # support for C++/Java exceptions; while core PostgreSQL does not use them, it
 313 # would be nice to support shared libgcc for the benefit of extensions.
 314 #
 315 # If SHLIB_EXPORTS is set, the rules below will build a .def file from that.
 316 # Else we just use --export-all-symbols.
 317 ifeq (,$(SHLIB_EXPORTS))
 318 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 319         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--export-all-symbols -Wl,--out-implib=$(stlib)
 320 else
 321 DLL_DEFFILE = lib$(NAME)dll.def
 322
 323 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
 324         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(DLL_DEFFILE) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--out-implib=$(stlib)
 325
 326 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 327
 328 $(DLL_DEFFILE): $(SHLIB_EXPORTS)
 329         echo 'LIBRARY LIB$(UC_NAME).dll' >$@
 330         echo 'EXPORTS' >>$@
 331         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 332 endif
 333
 334 endif # PORTNAME == cygwin
 335 endif # PORTNAME == cygwin || PORTNAME == win32
 336
 337
 338 %.pc: $(MAKEFILE_LIST)
 339         echo 'prefix=$(prefix)' >$@
 340         echo 'exec_prefix=$(patsubst $(prefix),$${prefix},$(exec_prefix))' >>$@
 341         echo 'libdir=$(patsubst $(exec_prefix)/%,$${exec_prefix}/%,$(libdir))' >>$@
 342         echo 'includedir=$(patsubst $(prefix)/%,$${prefix}/%,$(includedir))' >>$@
 343         echo >>$@
 344         echo 'Name: lib$(NAME)' >>$@
 345         echo 'Description: PostgreSQL lib$(NAME) library' >>$@
 346         echo 'URL: $(PACKAGE_URL)' >>$@
 347         echo 'Version: $(VERSION)' >>$@
 348         echo 'Requires: ' >>$@
 349         echo 'Requires.private: $(PKG_CONFIG_REQUIRES_PRIVATE)' >>$@
 350         echo 'Cflags: -I$${includedir}' >>$@
 351         echo 'Libs: -L$${libdir} -l$(NAME)' >>$@
 352 # Record -L flags that the user might have passed in to the PostgreSQL
 353 # build to locate third-party libraries (e.g., ldap, ssl).  Filter out
 354 # those that point inside the build or source tree.  Use sort to
 355 # remove duplicates.  Also record the -l flags necessary for static
 356 # linking, but not those already covered by Requires.private.
 357         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)))' >>$@
 358
 359
 360 ##
 361 ## INSTALL
 362 ##
 363
 364 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
 365 install-lib: install-lib-shared
 366 ifdef soname
 367 install-lib: install-lib-static
 368 install-lib: install-lib-pc
 369 endif
 370
 371 install-lib-pc: lib$(NAME).pc installdirs-lib
 372         $(INSTALL_DATA) $< '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 373
 374 install-lib-static: $(stlib) installdirs-lib
 375         $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
 376
 377 install-lib-shared: $(shlib) installdirs-lib
 378 ifdef soname
 379         $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
 380 ifneq ($(PORTNAME), cygwin)
 381 ifneq ($(PORTNAME), win32)
 382 ifneq ($(shlib), $(shlib_major))
 383         cd '$(DESTDIR)$(libdir)' && \
 384         rm -f $(shlib_major) && \
 385         $(LN_S) $(shlib) $(shlib_major)
 386 endif
 387 ifneq ($(shlib), $(shlib_bare))
 388         cd '$(DESTDIR)$(libdir)' && \
 389         rm -f $(shlib_bare) && \
 390         $(LN_S) $(shlib) $(shlib_bare)
 391 endif
 392 endif # not win32
 393 endif # not cygwin
 394 ifneq (,$(findstring $(PORTNAME),win32 cygwin))
 395         $(INSTALL_SHLIB) $< '$(DESTDIR)$(bindir)/$(shlib)'
 396 endif
 397 else # no soname
 398         $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
 399 endif
 400
 401
 402 installdirs-lib:
 403 ifdef soname
 404         $(MKDIR_P) '$(DESTDIR)$(libdir)' '$(DESTDIR)$(pkgconfigdir)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)')
 405 else
 406         $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
 407 endif
 408
 409
 410 ##
 411 ## UNINSTALL
 412 ##
 413
 414 .PHONY: uninstall-lib
 415 uninstall-lib:
 416 ifdef soname
 417         rm -f '$(DESTDIR)$(libdir)/$(stlib)'
 418         rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
 419           '$(DESTDIR)$(libdir)/$(shlib_major)' \
 420           '$(DESTDIR)$(libdir)/$(shlib)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)/$(shlib)') \
 421           '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 422 else # no soname
 423         rm -f '$(DESTDIR)$(pkglibdir)/$(shlib)'
 424 endif # no soname
 425
 426
 427 ##
 428 ## CLEAN
 429 ##
 430
 431 .PHONY: clean-lib
 432 clean-lib:
 433         rm -f $(shlib) $(shlib_bare) $(shlib_major) $(stlib) $(exports_file) lib$(NAME).pc
 434 ifneq (,$(DLL_DEFFILE))
 435         rm -f $(DLL_DEFFILE)
 436 endif