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 # Since `all-lib' is the first rule in this file you probably want to
  51 # have the `all' target before including this file. In the most simple
  52 # case it would look like this:
  53 #
  54 #     all: all-lib
  55 #
  56 # Similarly, the install rule might look like
  57 #
  58 #     install: install-lib
  59 #
  60 # plus any additional things you want to install. Et cetera.
  61 #
  62 # Got that?  Look at src/interfaces/libpq/Makefile for an example.
  63 #
  64 # While the linker allows creation of most shared libraries,
  65 # -Bsymbolic requires resolution of all symbols, making the
  66 # compiler a better choice for shared library creation on ELF platforms.
  67 # With the linker, -Bsymbolic requires the crt1.o startup object file.
  68 # bjm 2001-02-10
  69
  70
  71 COMPILER = $(CC) $(CFLAGS)
  72 LINK.static = $(AR) $(AROPT)
  73
  74
  75
  76 ifdef SO_MAJOR_VERSION
  77 # Default library naming convention used by the majority of platforms
  78 shlib           = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
  79 shlib_major     = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
  80 shlib_bare      = lib$(NAME)$(DLSUFFIX)
  81 # Testing the soname variable is a reliable way to determine whether a
  82 # linkable library is being built.
  83 soname          = $(shlib_major)
  84 pkgconfigdir = $(libdir)/pkgconfig
  85 else
  86 # Naming convention for dynamically loadable modules
  87 shlib           = $(NAME)$(DLSUFFIX)
  88 endif
  89 stlib           = lib$(NAME).a
  90
  91 ifndef soname
  92 # additional flags for backend modules
  93 SHLIB_LINK += $(BE_DLLLIBS)
  94 endif
  95
  96 # For each platform we support shared libraries on, set shlib to the
  97 # name of the library (if default above is not right), set
  98 # LINK.shared to the command to link the library,
  99 # and adjust SHLIB_LINK if necessary.
 100
 101 # Try to keep the sections in some kind of order, folks...
 102
 103 override CFLAGS += $(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   ifdef SO_MAJOR_VERSION
 111     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 112   endif
 113   haslibarule   = yes
 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       += +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), sco)
 240   ifeq ($(GCC), yes)
 241     LINK.shared         = $(CC) -shared
 242   else
 243     LINK.shared         = $(CC) -G
 244     endif
 245   LINK.shared           += -Wl,-z,text
 246   ifdef soname
 247     LINK.shared         += -Wl,-h,$(soname)
 248   endif
 249 endif
 250
 251 ifeq ($(PORTNAME), unixware)
 252   ifeq ($(GCC), yes)
 253     LINK.shared         = $(CC) -shared
 254   else
 255     LINK.shared         = $(CC) -G
 256   endif
 257   LINK.shared           += -Wl,-z,text
 258   ifdef soname
 259     LINK.shared         += -Wl,-h,$(soname)
 260   endif
 261 endif
 262
 263 ifeq ($(PORTNAME), cygwin)
 264   LINK.shared           = $(CC) -shared
 265   ifdef SO_MAJOR_VERSION
 266     shlib               = cyg$(NAME)$(DLSUFFIX)
 267   endif
 268   haslibarule   = yes
 269 endif
 270
 271 ifeq ($(PORTNAME), win32)
 272   ifdef SO_MAJOR_VERSION
 273     shlib               = lib$(NAME)$(DLSUFFIX)
 274   endif
 275   haslibarule   = yes
 276 endif
 277
 278
 279
 280 ##
 281 ## BUILD
 282 ##
 283
 284 .PHONY: all-lib all-static-lib all-shared-lib
 285
 286 all-lib: all-shared-lib
 287 ifdef soname
 288 # no static library when building a dynamically loadable module
 289 all-lib: all-static-lib
 290 all-lib: lib$(NAME).pc
 291 endif
 292
 293 all-static-lib: $(stlib)
 294
 295 all-shared-lib: $(shlib)
 296
 297 ifndef haslibarule
 298 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 299         $(LINK.static) $@ $^
 300         $(RANLIB) $@
 301 endif #haslibarule
 302
 303
 304 ifeq (,$(filter cygwin win32,$(PORTNAME)))
 305 ifneq ($(PORTNAME), aix)
 306
 307 # Normal case
 308 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 309         $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 310 ifdef shlib_major
 311 # If we're using major and minor versions, then make a symlink to major-version-only.
 312 ifneq ($(shlib), $(shlib_major))
 313         rm -f $(shlib_major)
 314         $(LN_S) $(shlib) $(shlib_major)
 315 endif
 316 # Make sure we have a link to a name without any version numbers
 317 ifneq ($(shlib), $(shlib_bare))
 318         rm -f $(shlib_bare)
 319         $(LN_S) $(shlib) $(shlib_bare)
 320 endif
 321 endif # shlib_major
 322
 323 # Where possible, restrict the symbols exported by the library to just the
 324 # official list, so as to avoid unintentional ABI changes.  On recent Darwin
 325 # this also quiets multiply-defined-symbol warnings in programs that use
 326 # libpgport along with libpq.
 327 ifneq (,$(SHLIB_EXPORTS))
 328 ifdef BUILD.exports
 329 $(shlib): $(SHLIB_EXPORTS:%.txt=%.list)
 330
 331 $(SHLIB_EXPORTS:%.txt=%.list): %.list: %.txt
 332         $(BUILD.exports)
 333 endif
 334 endif
 335
 336 else # PORTNAME == aix
 337
 338 # AIX case
 339 $(shlib) $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 340         $(LINK.static) $(stlib) $^
 341         $(RANLIB) $(stlib)
 342         $(MKLDEXPORT) $(stlib) >$(exports_file)
 343         $(COMPILER) -o $(shlib) $(stlib) -Wl,-bE:$(exports_file) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 344         rm -f $(stlib)
 345         $(AR) $(AROPT) $(stlib) $(shlib)
 346
 347 endif # PORTNAME == aix
 348
 349 else # PORTNAME == cygwin || PORTNAME == win32
 350
 351 ifeq ($(PORTNAME), cygwin)
 352
 353 # Cygwin case
 354
 355 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 356         $(CC) $(CFLAGS)  -shared -o $@  $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) $(LDAP_LIBS_BE)
 357
 358 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 359         $(LINK.static) $@ $^
 360         $(RANLIB) $@
 361
 362 else
 363
 364 # Win32 case
 365
 366 # There is no correct way to write a rule that generates two files.
 367 # Rules with two targets don't have that meaning, they are merely
 368 # shorthand for two otherwise separate rules.  To be safe for parallel
 369 # make, we must chain the dependencies like this.  The semicolon is
 370 # important, otherwise make will choose some built-in rule.
 371
 372 $(stlib): $(shlib) ;
 373
 374 # XXX A backend that loads a module linked with libgcc_s_dw2-1.dll will exit
 375 # uncleanly, hence -static-libgcc.  (Last verified with MinGW-w64 compilers
 376 # from i686-4.9.1-release-win32-dwarf-rt_v3-rev1.)  Shared libgcc has better
 377 # support for C++/Java exceptions; while core PostgreSQL does not use them, it
 378 # would be nice to support shared libgcc for the benefit of extensions.
 379 #
 380 # If SHLIB_EXPORTS is set, the rules below will build a .def file from that.
 381 # Else we just use --export-all-symbols.
 382 ifeq (,$(SHLIB_EXPORTS))
 383 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 384         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--export-all-symbols -Wl,--out-implib=$(stlib)
 385 else
 386 DLL_DEFFILE = lib$(NAME)dll.def
 387
 388 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
 389         $(CC) $(CFLAGS)  -shared -static-libgcc -o $@  $(OBJS) $(DLL_DEFFILE) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--out-implib=$(stlib)
 390 endif
 391
 392 endif # PORTNAME == cgywin
 393 endif # PORTNAME == cygwin || PORTNAME == win32
 394
 395
 396 %.pc: $(MAKEFILE_LIST)
 397         echo 'Name: lib$(NAME)' >$@
 398         echo 'Description: PostgreSQL lib$(NAME) library' >>$@
 399         echo 'Url: http://www.postgresql.org/' >>$@
 400         echo 'Version: $(VERSION)' >>$@
 401         echo 'Requires: ' >>$@
 402         echo 'Requires.private: $(PKG_CONFIG_REQUIRES_PRIVATE)' >>$@
 403         echo 'Cflags: -I$(includedir)' >>$@
 404         echo 'Libs: -L$(libdir) -l$(NAME)' >>$@
 405 # Record -L flags that the user might have passed in to the PostgreSQL
 406 # build to locate third-party libraries (e.g., ldap, ssl).  Filter out
 407 # those that point inside the build or source tree.  Use sort to
 408 # remove duplicates.  Also record the -l flags necessary for static
 409 # linking, but not those already covered by Requires.private.
 410         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)))' >>$@
 411
 412
 413 # We need several not-quite-identical variants of .DEF files to build
 414 # DLLs for Windows.  These are made from the single source file
 415 # exports.txt.  Since we can't assume that Windows boxes will have
 416 # sed, the .DEF files are always built and included in distribution
 417 # tarballs.
 418
 419 ifneq (,$(SHLIB_EXPORTS))
 420 distprep: lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
 421
 422 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 423
 424 lib$(NAME)dll.def: $(SHLIB_EXPORTS)
 425         echo '; DEF file for MS VC++' >$@
 426         echo 'LIBRARY LIB$(UC_NAME)' >>$@
 427         echo 'EXPORTS' >>$@
 428         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 429
 430 lib$(NAME)ddll.def: $(SHLIB_EXPORTS)
 431         echo '; DEF file for MS VC++' >$@
 432         echo 'LIBRARY LIB$(UC_NAME)D' >>$@
 433         echo 'EXPORTS' >>$@
 434         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 435
 436 blib$(NAME)dll.def: $(SHLIB_EXPORTS)
 437         echo '; DEF file for Borland C++ Builder' >$@
 438         echo 'LIBRARY BLIB$(UC_NAME)' >>$@
 439         echo 'EXPORTS' >>$@
 440         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    _\1@ \2/' $< >>$@
 441         echo >>$@
 442         echo '; Aliases for MS compatible names' >> $@
 443         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1= _\1/' $< | sed 's/ *$$//' >>$@
 444 endif # SHLIB_EXPORTS
 445
 446
 447 ##
 448 ## INSTALL
 449 ##
 450
 451 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
 452 install-lib: install-lib-shared
 453 ifdef soname
 454 install-lib: install-lib-static
 455 install-lib: install-lib-pc
 456 endif
 457
 458 install-lib-pc: lib$(NAME).pc installdirs-lib
 459         $(INSTALL_DATA) $< '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 460
 461 install-lib-static: $(stlib) installdirs-lib
 462         $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
 463 ifeq ($(PORTNAME), darwin)
 464         cd '$(DESTDIR)$(libdir)' && \
 465         ranlib $(stlib)
 466 endif
 467
 468 install-lib-shared: $(shlib) installdirs-lib
 469 ifdef soname
 470 # we don't install $(shlib) on AIX
 471 # (see http://archives.postgresql.org/message-id/52EF20B2E3209443BC37736D00C3C1380A6E79FE@EXADV1.host.magwien.gv.at)
 472 ifneq ($(PORTNAME), aix)
 473         $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
 474 ifneq ($(PORTNAME), cygwin)
 475 ifneq ($(PORTNAME), win32)
 476 ifneq ($(shlib), $(shlib_major))
 477         cd '$(DESTDIR)$(libdir)' && \
 478         rm -f $(shlib_major) && \
 479         $(LN_S) $(shlib) $(shlib_major)
 480 endif
 481 ifneq ($(shlib), $(shlib_bare))
 482         cd '$(DESTDIR)$(libdir)' && \
 483         rm -f $(shlib_bare) && \
 484         $(LN_S) $(shlib) $(shlib_bare)
 485 endif
 486 endif # not win32
 487 endif # not cygwin
 488 endif # not aix
 489 else # no soname
 490         $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
 491 endif
 492
 493
 494 installdirs-lib:
 495 ifdef soname
 496         $(MKDIR_P) '$(DESTDIR)$(libdir)' '$(DESTDIR)$(pkgconfigdir)'
 497 else
 498         $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
 499 endif
 500
 501
 502 ##
 503 ## UNINSTALL
 504 ##
 505
 506 .PHONY: uninstall-lib
 507 uninstall-lib:
 508 ifdef soname
 509         rm -f '$(DESTDIR)$(libdir)/$(stlib)'
 510         rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
 511           '$(DESTDIR)$(libdir)/$(shlib_major)' \
 512           '$(DESTDIR)$(libdir)/$(shlib)' \
 513           '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
 514 else # no soname
 515         rm -f '$(DESTDIR)$(pkglibdir)/$(shlib)'
 516 endif # no soname
 517
 518
 519 ##
 520 ## CLEAN
 521 ##
 522
 523 .PHONY: clean-lib
 524 clean-lib:
 525         rm -f $(shlib) $(shlib_bare) $(shlib_major) $(stlib) $(exports_file) lib$(NAME).pc
 526
 527 ifneq (,$(SHLIB_EXPORTS))
 528 maintainer-clean-lib:
 529         rm -f lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
 530 endif