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 # Optional flags when building DLL's (only applicable to win32 and cygwin
  38 # platforms).
  39 # DLLTOOL_DEFFLAGS      Additional flags when creating the dll .def file
  40 # DLLTOOL_LIBFLAGS      Additional flags when creating the lib<module>.a file
  41 # DLLWRAP_FLAGS         Additional flags to dllwrap
  42 #
  43 # The module Makefile must also include
  44 # $(top_builddir)/src/Makefile.global before including this file.
  45 # (Makefile.global sets PORTNAME and other needed symbols.)
  46 #
  47 # This makefile provides the following (phony) targets:
  48 #
  49 # all-lib               build the static and shared (if applicable) libraries
  50 # install-lib           install the libraries into $(libdir)
  51 # installdirs-lib       create installation directory $(libdir)
  52 # uninstall-lib         remove the libraries from $(libdir)
  53 # clean-lib             delete the static and shared libraries from the build dir
  54 # maintainer-clean-lib  delete .def files built for win32
  55 #
  56 # Since `all-lib' is the first rule in this file you probably want to
  57 # have the `all' target before including this file. In the most simple
  58 # case it would look like this:
  59 #
  60 #     all: all-lib
  61 #
  62 # Similarly, the install rule might look like
  63 #
  64 #     install: install-lib
  65 #
  66 # plus any additional things you want to install. Et cetera.
  67 #
  68 # Got that?  Look at src/interfaces/libpq/Makefile for an example.
  69 #
  70 # While the linker allows creation of most shared libraries,
  71 # -Bsymbolic requires resolution of all symbols, making the
  72 # compiler a better choice for shared library creation on ELF platforms.
  73 # With the linker, -Bsymbolic requires the crt1.o startup object file.
  74 # bjm 2001-02-10
  75
  76
  77 COMPILER = $(CC) $(CFLAGS)
  78 LINK.static = $(AR) $(AROPT)
  79
  80
  81
  82 ifdef SO_MAJOR_VERSION
  83 # Default library naming convention used by the majority of platforms
  84 ifeq ($(enable_shared), yes)
  85 shlib           = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
  86 shlib_major     = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
  87 shlib_bare      = lib$(NAME)$(DLSUFFIX)
  88 endif
  89 # Testing the soname variable is a reliable way to determine whether a
  90 # linkable library is being built.
  91 soname          = $(shlib_major)
  92 else
  93 # Naming convention for dynamically loadable modules
  94 ifeq ($(enable_shared), yes)
  95 shlib           = $(NAME)$(DLSUFFIX)
  96 endif
  97 endif
  98 stlib           = lib$(NAME).a
  99
 100 ifndef soname
 101 # additional flags for backend modules
 102 SHLIB_LINK += $(BE_DLLLIBS)
 103 endif
 104
 105 # For each platform we support shared libraries on, set shlib to the
 106 # name of the library (if default above is not right), set
 107 # LINK.shared to the command to link the library,
 108 # and adjust SHLIB_LINK if necessary.
 109
 110 # Try to keep the sections in some kind of order, folks...
 111
 112 override CFLAGS += $(CFLAGS_SL)
 113 ifdef SO_MAJOR_VERSION
 114 # libraries ought to use this to refer to versioned gettext domain names
 115 override CPPFLAGS += -DSO_MAJOR_VERSION=$(SO_MAJOR_VERSION)
 116 endif
 117
 118 ifeq ($(PORTNAME), aix)
 119   ifdef SO_MAJOR_VERSION
 120     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 121   endif
 122   haslibarule   = yes
 123   exports_file          = lib$(NAME).exp
 124 endif
 125
 126 ifeq ($(PORTNAME), darwin)
 127   ifdef soname
 128     # linkable library
 129     DLSUFFIX            = .dylib
 130     ifneq ($(SO_MAJOR_VERSION), 0)
 131       version_link      = -compatibility_version $(SO_MAJOR_VERSION) -current_version $(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 132     endif
 133     LINK.shared         = $(COMPILER) -dynamiclib -install_name '$(libdir)/lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)' $(version_link) $(exported_symbols_list) -multiply_defined suppress
 134     shlib               = lib$(NAME).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)$(DLSUFFIX)
 135     shlib_major         = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
 136   else
 137     # loadable module
 138     DLSUFFIX            = .so
 139     LINK.shared         = $(COMPILER) -bundle -multiply_defined suppress
 140   endif
 141   BUILD.exports         = $(AWK) '/^[^\#]/ {printf "_%s\n",$$1}' $< >$@
 142   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 143   ifneq (,$(exports_file))
 144     exported_symbols_list = -exported_symbols_list $(exports_file)
 145   endif
 146 endif
 147
 148 ifeq ($(PORTNAME), openbsd)
 149   ifdef ELF_SYSTEM
 150     LINK.shared         = $(COMPILER) -shared
 151     ifdef soname
 152       LINK.shared       += -Wl,-x,-soname,$(soname)
 153     endif
 154     SHLIB_LINK          += -lc
 155   else
 156     LINK.shared         = $(LD) -x -Bshareable -Bforcearchive
 157   endif
 158 endif
 159
 160 ifeq ($(PORTNAME), freebsd)
 161   ifdef ELF_SYSTEM
 162     ifdef SO_MAJOR_VERSION
 163       shlib             = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 164     endif
 165     LINK.shared         = $(COMPILER) -shared
 166     ifdef soname
 167       LINK.shared       += -Wl,-x,-soname,$(soname)
 168     endif
 169   else
 170     ifdef SO_MAJOR_VERSION
 171       shlib             = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 172     endif
 173     LINK.shared         = $(LD) -x -Bshareable -Bforcearchive
 174   endif
 175 endif
 176
 177 ifeq ($(PORTNAME), netbsd)
 178   ifdef ELF_SYSTEM
 179     LINK.shared         = $(COMPILER) -shared
 180     ifdef soname
 181       LINK.shared       += -Wl,-x,-soname,$(soname)
 182     endif
 183   else
 184     LINK.shared         = $(LD) -x -Bshareable -Bforcearchive
 185   endif
 186 endif
 187
 188 ifeq ($(PORTNAME), hpux)
 189   ifdef SO_MAJOR_VERSION
 190     shlib                       = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 191   endif
 192   ifeq ($(with_gnu_ld), yes)
 193     LINK.shared         = $(CC) -shared
 194     ifdef soname
 195       LINK.shared       += -Wl,-h -Wl,$(soname)
 196     endif
 197   else
 198     LINK.shared         = $(LD) -b
 199     ifdef soname
 200       LINK.shared       += +h $(soname)
 201     endif
 202     # can't use the CC-syntax rpath pattern here, so instead:
 203     rpath =
 204     ifeq ($(enable_rpath), yes)
 205       LINK.shared       += +b '$(rpathdir)'
 206     endif
 207     # On HPUX platforms, gcc is usually configured to search for libraries
 208     # in /usr/local/lib, but ld won't do so.  Add an explicit -L switch so
 209     # ld can find the same libraries gcc does.  Make sure it goes after any
 210     # -L switches provided explicitly.
 211     ifeq ($(GCC), yes)
 212       SHLIB_LINK        += -L/usr/local/lib
 213     endif
 214   endif
 215   # And we need to link with libgcc, too
 216   ifeq ($(GCC), yes)
 217     SHLIB_LINK          += `$(CC) $(LDFLAGS) -print-libgcc-file-name`
 218   endif
 219 endif
 220
 221 ifeq ($(PORTNAME), irix)
 222   ifdef SO_MAJOR_VERSION
 223     shlib               = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
 224   endif
 225   LINK.shared           = $(COMPILER) -shared
 226   ifdef soname
 227     LINK.shared         += -Wl,-set_version,sgi$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
 228   endif
 229 endif
 230
 231 ifeq ($(PORTNAME), linux)
 232   LINK.shared           = $(COMPILER) -shared
 233   ifdef soname
 234     LINK.shared         += -Wl,-soname,$(soname)
 235   endif
 236   BUILD.exports         = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
 237   exports_file          = $(SHLIB_EXPORTS:%.txt=%.list)
 238   ifneq (,$(exports_file))
 239     LINK.shared         += -Wl,--version-script=$(exports_file)
 240   endif
 241 endif
 242
 243 ifeq ($(PORTNAME), solaris)
 244   ifeq ($(GCC), yes)
 245     LINK.shared         = $(COMPILER) -shared
 246   else
 247     LINK.shared         = $(COMPILER) -G
 248   endif
 249   ifdef soname
 250     ifeq ($(with_gnu_ld), yes)
 251       LINK.shared       += -Wl,-soname,$(soname)
 252     else
 253       LINK.shared       += -h $(soname)
 254     endif
 255   endif
 256 endif
 257
 258 ifeq ($(PORTNAME), osf)
 259   LINK.shared           = $(LD) -shared -expect_unresolved '*'
 260 endif
 261
 262 ifeq ($(PORTNAME), sco)
 263   ifeq ($(GCC), yes)
 264     LINK.shared         = $(CC) -shared
 265   else
 266     LINK.shared         = $(CC) -G
 267     endif
 268   LINK.shared           += -Wl,-z,text
 269   ifdef soname
 270     LINK.shared         += -Wl,-h,$(soname)
 271   endif
 272 endif
 273
 274 ifeq ($(PORTNAME), unixware)
 275   ifeq ($(GCC), yes)
 276     LINK.shared         = $(CC) -shared
 277   else
 278     LINK.shared         = $(CC) -G
 279   endif
 280   LINK.shared           += -Wl,-z,text
 281   ifdef soname
 282     LINK.shared         += -Wl,-h,$(soname)
 283   endif
 284 endif
 285
 286 ifeq ($(PORTNAME), cygwin)
 287   ifdef SO_MAJOR_VERSION
 288     shlib               = cyg$(NAME)$(DLSUFFIX)
 289   endif
 290   haslibarule   = yes
 291 endif
 292
 293 ifeq ($(PORTNAME), win32)
 294   ifdef SO_MAJOR_VERSION
 295     shlib               = lib$(NAME)$(DLSUFFIX)
 296   endif
 297   haslibarule   = yes
 298 endif
 299
 300
 301
 302 ##
 303 ## BUILD
 304 ##
 305
 306 .PHONY: all-lib all-static-lib all-shared-lib
 307
 308 all-lib: all-shared-lib
 309 ifdef soname
 310 # no static library when building a dynamically loadable module
 311 all-lib: all-static-lib
 312 endif
 313
 314 all-static-lib: $(stlib)
 315
 316 all-shared-lib: $(shlib)
 317
 318 ifndef haslibarule
 319 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 320         $(LINK.static) $@ $^
 321         $(RANLIB) $@
 322 endif #haslibarule
 323
 324 ifeq ($(enable_shared), yes)
 325
 326 ifeq (,$(filter cygwin win32,$(PORTNAME)))
 327 ifneq ($(PORTNAME), aix)
 328
 329 # Normal case
 330 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
 331         $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 332 ifdef shlib_major
 333 # If we're using major and minor versions, then make a symlink to major-version-only.
 334 ifneq ($(shlib), $(shlib_major))
 335         rm -f $(shlib_major)
 336         $(LN_S) $(shlib) $(shlib_major)
 337 endif
 338 # Make sure we have a link to a name without any version numbers
 339 ifneq ($(shlib), $(shlib_bare))
 340         rm -f $(shlib_bare)
 341         $(LN_S) $(shlib) $(shlib_bare)
 342 endif
 343 endif # shlib_major
 344
 345 # Where possible, restrict the symbols exported by the library to just the
 346 # official list, so as to avoid unintentional ABI changes.  On recent Darwin
 347 # this also quiets multiply-defined-symbol warnings in programs that use
 348 # libpgport along with libpq.
 349 ifneq (,$(SHLIB_EXPORTS))
 350 ifdef BUILD.exports
 351 $(shlib): $(SHLIB_EXPORTS:%.txt=%.list)
 352
 353 $(SHLIB_EXPORTS:%.txt=%.list): %.list: %.txt
 354         $(BUILD.exports)
 355 endif
 356 endif
 357
 358 else # PORTNAME == aix
 359
 360 # AIX case
 361 $(shlib) $(stlib): $(OBJS) | $(SHLIB_PREREQS)
 362         $(LINK.static) $(stlib) $^
 363         $(RANLIB) $(stlib)
 364         $(MKLDEXPORT) $(stlib) >$(exports_file)
 365         $(COMPILER) -o $(shlib) $(stlib) -Wl,-bE:$(exports_file) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 366         rm -f $(stlib)
 367         $(AR) $(AROPT) $(stlib) $(shlib)
 368
 369 endif # PORTNAME == aix
 370
 371 else # PORTNAME == cygwin || PORTNAME == win32
 372
 373 # Cygwin or Win32 case
 374
 375 # If SHLIB_EXPORTS is set, the rules below will build a .def file from
 376 # that.  Else we build a temporary one here.
 377 ifeq (,$(SHLIB_EXPORTS))
 378 DLL_DEFFILE = lib$(NAME)dll.def
 379 exports_file = $(DLL_DEFFILE)
 380
 381 $(exports_file): $(OBJS)
 382         $(DLLTOOL) --export-all $(DLLTOOL_DEFFLAGS) --output-def $@ $^
 383 else
 384 DLL_DEFFILE = lib$(NAME)dll.def
 385 endif
 386
 387 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
 388         $(DLLWRAP) -o $@ --dllname $(shlib) $(DLLWRAP_FLAGS) --def $(DLL_DEFFILE) $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
 389
 390 $(stlib): $(shlib) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
 391         $(DLLTOOL) --dllname $(shlib) $(DLLTOOL_LIBFLAGS) --def $(DLL_DEFFILE) --output-lib $@
 392
 393 endif # PORTNAME == cygwin || PORTNAME == win32
 394
 395 endif # enable_shared
 396
 397
 398 # We need several not-quite-identical variants of .DEF files to build
 399 # DLLs for Windows.  These are made from the single source file
 400 # exports.txt.  Since we can't assume that Windows boxes will have
 401 # sed, the .DEF files are always built and included in distribution
 402 # tarballs.
 403
 404 ifneq (,$(SHLIB_EXPORTS))
 405 distprep: lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
 406
 407 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 408
 409 lib$(NAME)dll.def: $(SHLIB_EXPORTS)
 410         echo '; DEF file for MS VC++' >$@
 411         echo 'LIBRARY LIB$(UC_NAME)' >>$@
 412         echo 'EXPORTS' >>$@
 413         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 414
 415 lib$(NAME)ddll.def: $(SHLIB_EXPORTS)
 416         echo '; DEF file for MS VC++' >$@
 417         echo 'LIBRARY LIB$(UC_NAME)D' >>$@
 418         echo 'EXPORTS' >>$@
 419         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1@ \2/' $< >>$@
 420
 421 blib$(NAME)dll.def: $(SHLIB_EXPORTS)
 422         echo '; DEF file for Borland C++ Builder' >$@
 423         echo 'LIBRARY BLIB$(UC_NAME)' >>$@
 424         echo 'EXPORTS' >>$@
 425         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    _\1@ \2/' $< >>$@
 426         echo >>$@
 427         echo '; Aliases for MS compatible names' >> $@
 428         sed -e '/^#/d' -e 's/^\(.*[     ]\)\([0-9][0-9]*\)/    \1= _\1/' $< | sed 's/ *$$//' >>$@
 429 endif # SHLIB_EXPORTS
 430
 431
 432 ##
 433 ## INSTALL
 434 ##
 435
 436 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
 437 install-lib: install-lib-shared
 438 ifdef soname
 439 install-lib: install-lib-static
 440 endif
 441
 442 install-lib-static: $(stlib) installdirs-lib
 443         $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
 444 ifeq ($(PORTNAME), darwin)
 445         cd '$(DESTDIR)$(libdir)' && \
 446         ranlib $(stlib)
 447 endif
 448
 449 ifeq ($(enable_shared), yes)
 450 install-lib-shared: $(shlib) installdirs-lib
 451 ifdef soname
 452 # we don't install $(shlib) on AIX
 453 # (see http://archives.postgresql.org/message-id/52EF20B2E3209443BC37736D00C3C1380A6E79FE@EXADV1.host.magwien.gv.at)
 454 ifneq ($(PORTNAME), aix)
 455         $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
 456 ifneq ($(PORTNAME), cygwin)
 457 ifneq ($(PORTNAME), win32)
 458 ifneq ($(shlib), $(shlib_major))
 459         cd '$(DESTDIR)$(libdir)' && \
 460         rm -f $(shlib_major) && \
 461         $(LN_S) $(shlib) $(shlib_major)
 462 endif
 463 ifneq ($(shlib), $(shlib_bare))
 464         cd '$(DESTDIR)$(libdir)' && \
 465         rm -f $(shlib_bare) && \
 466         $(LN_S) $(shlib) $(shlib_bare)
 467 endif
 468 endif # not win32
 469 endif # not cygwin
 470 endif # not aix
 471 else # no soname
 472         $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
 473 endif
 474 else # not enable_shared
 475 ifndef soname
 476 install-lib-shared:
 477         @echo "*****"; \
 478          echo "* Module $(NAME) was not installed due to lack of shared library support."; \
 479          echo "*****"
 480 endif
 481 endif # enable_shared
 482
 483
 484 installdirs-lib:
 485 ifdef soname
 486         $(MKDIR_P) '$(DESTDIR)$(libdir)'
 487 else
 488         $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
 489 endif
 490
 491
 492 ##
 493 ## UNINSTALL
 494 ##
 495
 496 .PHONY: uninstall-lib
 497 uninstall-lib:
 498 ifdef soname
 499         rm -f '$(DESTDIR)$(libdir)/$(stlib)'
 500 ifeq ($(enable_shared), yes)
 501         rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
 502           '$(DESTDIR)$(libdir)/$(shlib_major)' \
 503           '$(DESTDIR)$(libdir)/$(shlib)'
 504 endif # enable_shared
 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)
 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