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 # Optional flags when building DLL's (only applicable to win32 and cygwin
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
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.)
47 # This makefile provides the following (phony) targets:
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
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:
62 # Similarly, the install rule might look like
64 # install: install-lib
66 # plus any additional things you want to install. Et cetera.
68 # Got that? Look at src/interfaces/libpq/Makefile for an example.
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.
77 COMPILER = $(CC) $(CFLAGS)
78 LINK.static = $(AR) $(AROPT)
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)
89 # Testing the soname variable is a reliable way to determine whether a
90 # linkable library is being built.
91 soname = $(shlib_major)
93 # Naming convention for dynamically loadable modules
94 ifeq ($(enable_shared), yes)
95 shlib = $(NAME)$(DLSUFFIX)
101 # additional flags for backend modules
102 SHLIB_LINK += $(BE_DLLLIBS)
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.
110 # Try to keep the sections in some kind of order, folks...
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)
118 ifeq ($(PORTNAME), aix)
119 ifdef SO_MAJOR_VERSION
120 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
123 exports_file = lib$(NAME).exp
126 ifeq ($(PORTNAME), darwin)
130 ifneq ($(SO_MAJOR_VERSION), 0)
131 version_link = -compatibility_version $(SO_MAJOR_VERSION) -current_version $(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
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)
139 LINK.shared = $(COMPILER) -bundle -multiply_defined suppress
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)
148 ifeq ($(PORTNAME), openbsd)
150 LINK.shared = $(COMPILER) -shared
152 LINK.shared += -Wl,-x,-soname,$(soname)
156 LINK.shared = $(LD) -x -Bshareable -Bforcearchive
160 ifeq ($(PORTNAME), bsdi)
161 ifeq ($(DLSUFFIX), .so)
162 LINK.shared = $(COMPILER) -shared
164 LINK.shared += -Wl,-x,-soname,$(soname)
168 ifeq ($(DLSUFFIX), .o)
169 LINK.shared = shlicc -O $(LDREL)
173 ifeq ($(PORTNAME), freebsd)
175 ifdef SO_MAJOR_VERSION
176 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
178 LINK.shared = $(COMPILER) -shared
180 LINK.shared += -Wl,-x,-soname,$(soname)
183 ifdef SO_MAJOR_VERSION
184 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
186 LINK.shared = $(LD) -x -Bshareable -Bforcearchive
190 ifeq ($(PORTNAME), netbsd)
192 LINK.shared = $(COMPILER) -shared
194 LINK.shared += -Wl,-x,-soname,$(soname)
197 LINK.shared = $(LD) -x -Bshareable -Bforcearchive
201 ifeq ($(PORTNAME), hpux)
202 ifdef SO_MAJOR_VERSION
203 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
205 ifeq ($(with_gnu_ld), yes)
206 LINK.shared = $(CC) -shared
208 LINK.shared += -Wl,-h -Wl,$(soname)
211 LINK.shared = $(LD) -b
213 LINK.shared += +h $(soname)
215 # can't use the CC-syntax rpath pattern here, so instead:
217 ifeq ($(enable_rpath), yes)
218 LINK.shared += +b '$(rpathdir)'
220 # On HPUX platforms, gcc is usually configured to search for libraries
221 # in /usr/local/lib, but ld won't do so. Add an explicit -L switch so
222 # ld can find the same libraries gcc does. Make sure it goes after any
223 # -L switches provided explicitly.
225 SHLIB_LINK += -L/usr/local/lib
228 # And we need to link with libgcc, too
230 SHLIB_LINK += `$(CC) $(LDFLAGS) -print-libgcc-file-name`
234 ifeq ($(PORTNAME), irix)
235 ifdef SO_MAJOR_VERSION
236 shlib = lib$(NAME)$(DLSUFFIX).$(SO_MAJOR_VERSION)
238 LINK.shared = $(COMPILER) -shared
240 LINK.shared += -Wl,-set_version,sgi$(SO_MAJOR_VERSION).$(SO_MINOR_VERSION)
244 ifeq ($(PORTNAME), linux)
245 LINK.shared = $(COMPILER) -shared
247 LINK.shared += -Wl,-soname,$(soname)
249 BUILD.exports = ( echo '{ global:'; $(AWK) '/^[^\#]/ {printf "%s;\n",$$1}' $<; echo ' local: *; };' ) >$@
250 exports_file = $(SHLIB_EXPORTS:%.txt=%.list)
251 ifneq (,$(exports_file))
252 LINK.shared += -Wl,--version-script=$(exports_file)
256 ifeq ($(PORTNAME), solaris)
258 LINK.shared = $(COMPILER) -shared
260 LINK.shared = $(COMPILER) -G
263 ifeq ($(with_gnu_ld), yes)
264 LINK.shared += -Wl,-soname,$(soname)
266 LINK.shared += -h $(soname)
271 ifeq ($(PORTNAME), sunos4)
272 LINK.shared = $(LD) -assert pure-text -Bdynamic
275 ifeq ($(PORTNAME), osf)
276 LINK.shared = $(LD) -shared -expect_unresolved '*'
279 ifeq ($(PORTNAME), sco)
281 LINK.shared = $(CC) -shared
283 LINK.shared = $(CC) -G
285 LINK.shared += -Wl,-z,text
287 LINK.shared += -Wl,-h,$(soname)
291 ifeq ($(PORTNAME), svr4)
292 LINK.shared = $(LD) -G
295 ifeq ($(PORTNAME), univel)
296 LINK.shared = $(LD) -G -z text
299 ifeq ($(PORTNAME), unixware)
301 LINK.shared = $(CC) -shared
303 LINK.shared = $(CC) -G
305 LINK.shared += -Wl,-z,text
307 LINK.shared += -Wl,-h,$(soname)
311 ifeq ($(PORTNAME), cygwin)
312 ifdef SO_MAJOR_VERSION
313 shlib = cyg$(NAME)$(DLSUFFIX)
318 ifeq ($(PORTNAME), win32)
319 ifdef SO_MAJOR_VERSION
320 shlib = lib$(NAME)$(DLSUFFIX)
331 .PHONY: all-lib all-static-lib all-shared-lib
333 all-lib: all-shared-lib
335 # no static library when building a dynamically loadable module
336 all-lib: all-static-lib
339 all-static-lib: $(stlib)
341 all-shared-lib: $(shlib)
344 $(stlib): $(OBJS) | $(SHLIB_PREREQS)
349 ifeq ($(enable_shared), yes)
351 ifeq (,$(filter cygwin win32,$(PORTNAME)))
352 ifneq ($(PORTNAME), aix)
355 $(shlib): $(OBJS) | $(SHLIB_PREREQS)
356 $(LINK.shared) -o $@ $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
358 # If we're using major and minor versions, then make a symlink to major-version-only.
359 ifneq ($(shlib), $(shlib_major))
361 $(LN_S) $(shlib) $(shlib_major)
363 # Make sure we have a link to a name without any version numbers
364 ifneq ($(shlib), $(shlib_bare))
366 $(LN_S) $(shlib) $(shlib_bare)
370 # Where possible, restrict the symbols exported by the library to just the
371 # official list, so as to avoid unintentional ABI changes. On recent Darwin
372 # this also quiets multiply-defined-symbol warnings in programs that use
373 # libpgport along with libpq.
374 ifneq (,$(SHLIB_EXPORTS))
376 $(shlib): $(SHLIB_EXPORTS:%.txt=%.list)
378 $(SHLIB_EXPORTS:%.txt=%.list): %.list: %.txt
383 else # PORTNAME == aix
386 $(shlib) $(stlib): $(OBJS) | $(SHLIB_PREREQS)
387 $(LINK.static) $(stlib) $^
389 $(MKLDEXPORT) $(stlib) >$(exports_file)
390 $(COMPILER) -o $(shlib) $(stlib) -Wl,-bE:$(exports_file) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
392 $(AR) $(AROPT) $(stlib) $(shlib)
394 endif # PORTNAME == aix
396 else # PORTNAME == cygwin || PORTNAME == win32
398 # Cygwin or Win32 case
400 # If SHLIB_EXPORTS is set, the rules below will build a .def file from
401 # that. Else we build a temporary one here.
402 ifeq (,$(SHLIB_EXPORTS))
403 DLL_DEFFILE = lib$(NAME)dll.def
404 exports_file = $(DLL_DEFFILE)
406 $(exports_file): $(OBJS)
407 $(DLLTOOL) --export-all $(DLLTOOL_DEFFLAGS) --output-def $@ $^
409 DLL_DEFFILE = lib$(NAME)dll.def
412 $(shlib): $(OBJS) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
413 $(DLLWRAP) -o $@ --dllname $(shlib) $(DLLWRAP_FLAGS) --def $(DLL_DEFFILE) $(OBJS) $(LDFLAGS) $(LDFLAGS_SL) $(SHLIB_LINK)
415 $(stlib): $(shlib) $(DLL_DEFFILE) | $(SHLIB_PREREQS)
416 $(DLLTOOL) --dllname $(shlib) $(DLLTOOL_LIBFLAGS) --def $(DLL_DEFFILE) --output-lib $@
418 endif # PORTNAME == cygwin || PORTNAME == win32
420 endif # enable_shared
423 # We need several not-quite-identical variants of .DEF files to build
424 # DLLs for Windows. These are made from the single source file
425 # exports.txt. Since we can't assume that Windows boxes will have
426 # sed, the .DEF files are always built and included in distribution
429 ifneq (,$(SHLIB_EXPORTS))
430 distprep: lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def
432 UC_NAME = $(shell echo $(NAME) | tr 'abcdefghijklmnopqrstuvwxyz' 'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
434 lib$(NAME)dll.def: $(SHLIB_EXPORTS)
435 echo '; DEF file for MS VC++' >$@
436 echo 'LIBRARY LIB$(UC_NAME)' >>$@
438 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ \1@ \2/' $< >>$@
440 lib$(NAME)ddll.def: $(SHLIB_EXPORTS)
441 echo '; DEF file for MS VC++' >$@
442 echo 'LIBRARY LIB$(UC_NAME)D' >>$@
444 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ \1@ \2/' $< >>$@
446 blib$(NAME)dll.def: $(SHLIB_EXPORTS)
447 echo '; DEF file for Borland C++ Builder' >$@
448 echo 'LIBRARY BLIB$(UC_NAME)' >>$@
450 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ _\1@ \2/' $< >>$@
452 echo '; Aliases for MS compatible names' >> $@
453 sed -e '/^#/d' -e 's/^\(.*[ ]\)\([0-9][0-9]*\)/ \1= _\1/' $< | sed 's/ *$$//' >>$@
454 endif # SHLIB_EXPORTS
461 .PHONY: install-lib install-lib-static install-lib-shared installdirs-lib
462 install-lib: install-lib-shared
464 install-lib: install-lib-static
467 install-lib-static: $(stlib) installdirs-lib
468 $(INSTALL_STLIB) $< '$(DESTDIR)$(libdir)/$(stlib)'
469 ifeq ($(PORTNAME), darwin)
470 cd '$(DESTDIR)$(libdir)' && \
474 ifeq ($(enable_shared), yes)
475 install-lib-shared: $(shlib) installdirs-lib
477 # we don't install $(shlib) on AIX
478 # (see http://archives.postgresql.org/message-id/52EF20B2E3209443BC37736D00C3C1380A6E79FE@EXADV1.host.magwien.gv.at)
479 ifneq ($(PORTNAME), aix)
480 $(INSTALL_SHLIB) $< '$(DESTDIR)$(libdir)/$(shlib)'
481 ifneq ($(PORTNAME), cygwin)
482 ifneq ($(PORTNAME), win32)
483 ifneq ($(shlib), $(shlib_major))
484 cd '$(DESTDIR)$(libdir)' && \
485 rm -f $(shlib_major) && \
486 $(LN_S) $(shlib) $(shlib_major)
488 ifneq ($(shlib), $(shlib_bare))
489 cd '$(DESTDIR)$(libdir)' && \
490 rm -f $(shlib_bare) && \
491 $(LN_S) $(shlib) $(shlib_bare)
497 $(INSTALL_SHLIB) $< '$(DESTDIR)$(pkglibdir)/$(shlib)'
499 else # not enable_shared
503 echo "* Module $(NAME) was not installed due to lack of shared library support."; \
506 endif # enable_shared
511 $(MKDIR_P) '$(DESTDIR)$(libdir)'
513 $(MKDIR_P) '$(DESTDIR)$(pkglibdir)'
521 .PHONY: uninstall-lib
524 rm -f '$(DESTDIR)$(libdir)/$(stlib)'
525 ifeq ($(enable_shared), yes)
526 rm -f '$(DESTDIR)$(libdir)/$(shlib_bare)' \
527 '$(DESTDIR)$(libdir)/$(shlib_major)' \
528 '$(DESTDIR)$(libdir)/$(shlib)'
529 endif # enable_shared
531 rm -f '$(DESTDIR)$(pkglibdir)/$(shlib)'
541 rm -f $(shlib) $(shlib_bare) $(shlib_major) $(stlib) $(exports_file)
543 ifneq (,$(SHLIB_EXPORTS))
544 maintainer-clean-lib:
545 rm -f lib$(NAME)dll.def lib$(NAME)ddll.def blib$(NAME)dll.def