1 #-------------------------------------------------------------------------
4 # Common rules for building shared libraries
6 # Copyright (c) 1998, Regents of the University of California
11 #-------------------------------------------------------------------------
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.
18 # Before including this file, the module Makefile must define these
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"
29 # When building a shared library, the following version information
30 # must also be set. It should be omitted when building a dynamically
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".)
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.)
41 # This makefile provides the following (phony) targets:
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
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:
56 # Similarly, the install rule might look like
58 # install: install-lib
60 # plus any additional things you want to install. Et cetera.
62 # Got that? Look at src/interfaces/libpq/Makefile for an example.
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.
71 COMPILER = $(CC) $(CFLAGS)
72 LINK.static = $(AR) $(AROPT)
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
86 # Naming convention for dynamically loadable modules
87 shlib = $(NAME)$(DLSUFFIX)
92 # additional flags for backend modules
93 SHLIB_LINK += $(BE_DLLLIBS)
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.
101 # Try to keep the sections in some kind of order, folks...
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)
109 ifeq ($(PORTNAME), aix)
110 ifdef SO_MAJOR_VERSION
111 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
114 # $(exports_file) is also usable as an import file
115 exports_file = lib$(NAME).exp
118 ifeq ($(PORTNAME), darwin)
122 ifneq ($(SO_MAJOR_VERSION), 0)
123 version_link = -compatibility_version $(SO_MAJOR_VERSION) -current_version $(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
125 LINK.shared = $(COMPILER) -dynamiclib -install_name '$(libdir)/lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)' $(version_link) $(exported_symbols_list) -multiply_defined suppress
126 shlib = lib$(NAME).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)$(DLSUFFIX)
127 shlib_major = lib$(NAME).$(SO_MAJOR_VERSION)$(DLSUFFIX)
131 LINK.shared = $(COMPILER) -bundle -multiply_defined suppress -Wl,-undefined,dynamic_lookup
133 BUILD.exports = $(AWK) '/^[^\#]/ {printf "_%s\n",$$1}' $< >$@
134 exports_file = $(SHLIB_EXPORTS:%.txt=%.list)
135 ifneq (,$(exports_file))
136 exported_symbols_list = -exported_symbols_list $(exports_file)
140 ifeq ($(PORTNAME), openbsd)
142 LINK.shared = $(COMPILER) -shared
144 LINK.shared += -Wl,-x,-soname,$(soname)
148 LINK.shared = $(LD) -x -Bshareable -Bforcearchive
152 ifeq ($(PORTNAME), freebsd)
154 ifdef SO_MAJOR_VERSION
155 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
157 LINK.shared = $(COMPILER) -shared
159 LINK.shared += -Wl,-x,-soname,$(soname)
162 ifdef SO_MAJOR_VERSION
163 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
165 LINK.shared = $(LD) -x -Bshareable -Bforcearchive
169 ifeq ($(PORTNAME), netbsd)
171 LINK.shared = $(COMPILER) -shared
173 LINK.shared += -Wl,-x,-soname,$(soname)
176 LINK.shared = $(LD) -x -Bshareable -Bforcearchive
180 ifeq ($(PORTNAME), hpux)
181 ifdef SO_MAJOR_VERSION
182 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
184 ifeq ($(with_gnu_ld), yes)
185 LINK.shared = $(CC) -shared
187 LINK.shared += -Wl,-h -Wl,$(soname)
190 LINK.shared = $(LD) -b
192 LINK.shared += +h $(soname)
194 # can't use the CC-syntax rpath pattern here, so instead:
196 ifeq ($(enable_rpath), yes)
197 LINK.shared += +b '$(rpathdir)'
199 # On HPUX platforms, gcc is usually configured to search for libraries
200 # in /usr/local/lib, but ld won't do so. Add an explicit -L switch so
201 # ld can find the same libraries gcc does. Make sure it goes after any
202 # -L switches provided explicitly.
204 SHLIB_LINK += -L/usr/local/lib
207 # And we need to link with libgcc, too
209 SHLIB_LINK += `$(CC) $(LDFLAGS) -print-libgcc-file-name`
213 ifeq ($(PORTNAME), linux)
214 LINK.shared = $(COMPILER) -shared
216 LINK.shared += -Wl,-soname,$(soname)
218 BUILD.exports = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
219 exports_file = $(SHLIB_EXPORTS:%.txt=%.list)
220 ifneq (,$(exports_file))
221 LINK.shared += -Wl,--version-script=$(exports_file)
225 ifeq ($(PORTNAME), solaris)
227 LINK.shared = $(COMPILER) -shared
229 LINK.shared = $(COMPILER) -G
232 ifeq ($(with_gnu_ld), yes)
233 LINK.shared += -Wl,-soname,$(soname)
235 LINK.shared += -h $(soname)
240 ifeq ($(PORTNAME), sco)
242 LINK.shared = $(CC) -shared
244 LINK.shared = $(CC) -G
246 LINK.shared += -Wl,-z,text
248 LINK.shared += -Wl,-h,$(soname)
252 ifeq ($(PORTNAME), unixware)
254 LINK.shared = $(CC) -shared
256 LINK.shared = $(CC) -G
258 LINK.shared += -Wl,-z,text
260 LINK.shared += -Wl,-h,$(soname)
264 ifeq ($(PORTNAME), cygwin)
265 LINK.shared = $(CC) -shared
266 ifdef SO_MAJOR_VERSION
267 shlib = cyg$(NAME)$(DLSUFFIX)
272 ifeq ($(PORTNAME), win32)
273 ifdef SO_MAJOR_VERSION
274 shlib = lib$(NAME)$(DLSUFFIX)
285 .PHONY: all-lib all-static-lib all-shared-lib
287 all-lib: all-shared-lib
289 # no static library when building a dynamically loadable module
290 all-lib: all-static-lib
291 all-lib: lib$(NAME).pc
294 all-static-lib: $(stlib)
296 all-shared-lib: $(shlib)
299 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
306 ifeq (,$(filter cygwin win32,$(PORTNAME)))
307 ifneq ($(PORTNAME), aix)
310 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
311 $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
313 # If we're using major and minor versions, then make a symlink to major-version-only.
314 ifneq ($(shlib), $(shlib_major))
316 $(LN_S) $(shlib) $(shlib_major)
318 # Make sure we have a link to a name without any version numbers
319 ifneq ($(shlib), $(shlib_bare))
321 $(LN_S) $(shlib) $(shlib_bare)
325 # Where possible, restrict the symbols exported by the library to just the
326 # official list, so as to avoid unintentional ABI changes. On recent Darwin
327 # this also quiets multiply-defined-symbol warnings in programs that use
328 # libpgport along with libpq.
329 ifneq (,$(SHLIB_EXPORTS))
331 $(shlib): $(SHLIB_EXPORTS:%.txt=%.list)
333 $(SHLIB_EXPORTS:%.txt=%.list): %.list: %.txt
338 else # PORTNAME == aix
342 # There is no correct way to write a rule that generates two files.
343 # Rules with two targets don't have that meaning, they are merely
344 # shorthand for two otherwise separate rules. To be safe for parallel
345 # make, we must chain the dependencies like this. The semicolon is
346 # important, otherwise make will choose some built-in rule.
350 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
352 $(LINK.static) $(stlib) $^
354 $(MKLDEXPORT) $(stlib) $(shlib) >$(exports_file)
355 $(COMPILER) -o $(shlib) $(stlib) -Wl,-bE:$(exports_file) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
357 $(AR) $(AROPT) $(stlib) $(shlib)
359 endif # PORTNAME == aix
361 else # PORTNAME == cygwin || PORTNAME == win32
363 ifeq ($(PORTNAME), cygwin)
367 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
368 $(CC) $(CFLAGS) -shared -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) $(LDAP_LIBS_BE)
370 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
379 # There is no correct way to write a rule that generates two files.
380 # Rules with two targets don't have that meaning, they are merely
381 # shorthand for two otherwise separate rules. To be safe for parallel
382 # make, we must chain the dependencies like this. The semicolon is
383 # important, otherwise make will choose some built-in rule.
387 # XXX A backend that loads a module linked with libgcc_s_dw2-1.dll will exit
388 # uncleanly, hence -static-libgcc. (Last verified with MinGW-w64 compilers
389 # from i686-4.9.1-release-win32-dwarf-rt_v3-rev1.) Shared libgcc has better
390 # support for C++/Java exceptions; while core PostgreSQL does not use them, it
391 # would be nice to support shared libgcc for the benefit of extensions.
393 # If SHLIB_EXPORTS is set, the rules below will build a .def file from that.
394 # Else we just use --export-all-symbols.
395 ifeq (,$(SHLIB_EXPORTS))
396 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
397 $(CC) $(CFLAGS) -shared -static-libgcc -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--export-all-symbols -Wl,--out-implib=$(stlib)
399 DLL_DEFFILE = lib$(NAME)dll.def
401 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
402 $(CC) $(CFLAGS) -shared -static-libgcc -o $@ $(OBJS) $(DLL_DEFFILE) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK) $(LIBS) -Wl,--out-implib=$(stlib)
405 endif # PORTNAME == cgywin
406 endif # PORTNAME == cygwin || PORTNAME == win32
409 %.pc: $(MAKEFILE_LIST)
410 echo 'Name: lib$(NAME)' >$@
411 echo 'Description: PostgreSQL lib$(NAME) library' >>$@
412 echo 'Url: http://www.postgresql.org/' >>$@
413 echo 'Version: $(VERSION)' >>$@
414 echo 'Requires: ' >>$@
415 echo 'Requires.private: $(PKG_CONFIG_REQUIRES_PRIVATE)' >>$@
416 echo 'Cflags: -I$(includedir)' >>$@
417 echo 'Libs: -L$(libdir) -l$(NAME)' >>$@
418 # Record -L flags that the user might have passed in to the PostgreSQL
419 # build to locate third-party libraries (e.g., ldap, ssl). Filter out
420 # those that point inside the build or source tree. Use sort to
421 # remove duplicates. Also record the -l flags necessary for static
422 # linking, but not those already covered by Requires.private.
423 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)))' >>$@
426 # We need several not-quite-identical variants of .DEF files to build
427 # DLLs for Windows. These are made from the single source file
428 # exports.txt. Since we can't assume that Windows boxes will have
429 # sed, the .DEF files are always built and included in distribution
432 ifneq (,$(SHLIB_EXPORTS))
433 distprep: lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
435 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
437 lib$(NAME)dll.def: $(SHLIB_EXPORTS)
438 echo '; DEF file for win32.mak release build and for Makefile.shlib (MinGW)' >$@
439 echo 'LIBRARY LIB$(UC_NAME).dll' >>$@
441 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ \1@ \2/' $< >>$@
443 lib$(NAME)ddll.def: $(SHLIB_EXPORTS)
444 echo '; DEF file for win32.mak debug build' >$@
445 echo 'LIBRARY LIB$(UC_NAME)D.dll' >>$@
447 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ \1@ \2/' $< >>$@
449 blib$(NAME)dll.def: $(SHLIB_EXPORTS)
450 echo '; DEF file for bcc32.mak (Borland C++ Builder)' >$@
451 echo 'LIBRARY BLIB$(UC_NAME)' >>$@
453 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ _\1@ \2/' $< >>$@
455 echo '; Aliases for MS compatible names' >> $@
456 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ \1= _\1/' $< | sed 's/ *$$//' >>$@
457 endif # SHLIB_EXPORTS
464 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
465 install-lib: install-lib-shared
467 install-lib: install-lib-static
468 install-lib: install-lib-pc
471 install-lib-pc: lib$(NAME).pc installdirs-lib
472 $(INSTALL_DATA) $< '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
474 install-lib-static: $(stlib) installdirs-lib
475 $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
476 ifeq ($(PORTNAME), darwin)
477 cd '$(DESTDIR)$(libdir)' && \
481 install-lib-shared: $(shlib) installdirs-lib
483 # we don't install $(shlib) on AIX
484 # (see http://archives.postgresql.org/message-id/52EF20B2E3209443BC37736D00C3C1380A6E79FE@EXADV1.host.magwien.gv.at)
485 ifneq ($(PORTNAME), aix)
486 $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
487 ifneq ($(PORTNAME), cygwin)
488 ifneq ($(PORTNAME), win32)
489 ifneq ($(shlib), $(shlib_major))
490 cd '$(DESTDIR)$(libdir)' && \
491 rm -f $(shlib_major) && \
492 $(LN_S) $(shlib) $(shlib_major)
494 ifneq ($(shlib), $(shlib_bare))
495 cd '$(DESTDIR)$(libdir)' && \
496 rm -f $(shlib_bare) && \
497 $(LN_S) $(shlib) $(shlib_bare)
502 ifneq (,$(findstring $(PORTNAME),win32 cygwin))
503 $(INSTALL_SHLIB) $< '$(DESTDIR)$(bindir)/$(shlib)'
506 $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
512 $(MKDIR_P) '$(DESTDIR)$(libdir)' '$(DESTDIR)$(pkgconfigdir)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)')
514 $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
522 .PHONY: uninstall-lib
525 rm -f '$(DESTDIR)$(libdir)/$(stlib)'
526 rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
527 '$(DESTDIR)$(libdir)/$(shlib_major)' \
528 '$(DESTDIR)$(libdir)/$(shlib)' $(if $(findstring $(PORTNAME),win32 cygwin),'$(DESTDIR)$(bindir)/$(shlib)') \
529 '$(DESTDIR)$(pkgconfigdir)/lib$(NAME).pc'
531 rm -f '$(DESTDIR)$(pkglibdir)/$(shlib)'
541 rm -f $(shlib) $(shlib_bare) $(shlib_major) $(stlib) $(exports_file) lib$(NAME).pc
543 ifneq (,$(SHLIB_EXPORTS))
544 maintainer-clean-lib:
545 rm -f lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def