xref: /petsc/config/PETSc/options/sharedLibraries.py (revision 030f984af8d8bb4c203755d35bded3c05b3d83ce)
1#!/usr/bin/env python
2from __future__ import generators
3import config.base
4
5class Configure(config.base.Configure):
6  def __init__(self, framework):
7    config.base.Configure.__init__(self, framework)
8    self.headerPrefix = ''
9    self.substPrefix  = ''
10    self.useShared    = 0
11    return
12
13  def __str1__(self):
14    txt =  '  Single library: %s\n' % ('yes' if self.framework.argDB['with-single-library'] else 'no')
15    txt += '  Shared libraries: %s\n' % ('yes' if self.useShared else 'no')
16    return txt
17
18  def setupHelp(self, help):
19    import nargs
20    help.addArgument('PETSc', '-with-shared-libraries=<bool>', nargs.ArgBool(None, 1, 'Make PETSc libraries shared -- libpetsc.so (Unix/Linux) or libpetsc.dylib (Mac)'))
21    help.addArgument('PETSc', '-with-serialize-functions=<bool>', nargs.ArgBool(None, 0, 'Allows function pointers to be serialized to binary files with string representations'))
22    return
23
24  def setupDependencies(self, framework):
25    config.base.Configure.setupDependencies(self, framework)
26    self.arch         = framework.require('PETSc.options.arch', self)
27    self.debuggers    = framework.require('config.utilities.debuggers', self)
28    self.setCompilers = framework.require('config.setCompilers', self)
29    self.headers      = framework.require('config.headers', self)
30    self.functions    = framework.require('config.functions', self)
31    self.ftm          = framework.require('config.utilities.featureTestMacros', self)
32    return
33
34  def checkSharedDynamicPicOptions(self):
35    # uf user specified 'with-shared' or 'with-dynamic' - flag an error
36    if 'with-shared' in self.framework.argDB:
37      raise RuntimeError('Option "--with-shared" no longer exists. Use "--with-shared-libraries".')
38    if 'with-dynamic' in self.framework.argDB or 'with-dynamic-loading' in self.framework.argDB:
39      raise RuntimeError('Option "--with-dynamic" and "--with-dynamic-loading" no longer exist.')
40    if self.framework.argDB['with-shared-libraries'] and not self.framework.argDB['with-pic'] and 'with-pic' in self.framework.clArgDB:
41      raise RuntimeError('If you use --with-shared-libraries you cannot disable --with-pic')
42
43    # default with-shared-libraries=1 => --with-pic=1
44    # Note: there is code in setCompilers.py that uses this as default.
45    if self.framework.argDB['with-shared-libraries'] and not self.framework.argDB['with-pic']: self.framework.argDB['with-pic'] = 1
46    return
47
48
49  def configureSharedLibraries(self):
50    '''Checks whether shared libraries should be used, for which you must
51      - Specify --with-shared-libraries
52      - Have found a working shared linker
53    Defines PETSC_USE_SHARED_LIBRARIES if they are used'''
54    import sys
55
56    self.useShared = self.framework.argDB['with-shared-libraries'] and not self.setCompilers.staticLibraries
57
58    if self.useShared:
59      #if config.setCompilers.Configure.isSolaris(self.log) and config.setCompilers.Configure.isGNU(self.framework.getCompiler(),self.log):
60      #  self.addMakeRule('shared_arch','shared_'+self.arch.hostOsBase+'gnu')
61      #elif '-qmkshrobj' in self.setCompilers.sharedLibraryFlags:
62      #  self.addMakeRule('shared_arch','shared_linux_ibm')
63      #else:
64      #  self.addMakeRule('shared_arch','shared_'+self.arch.hostOsBase)
65
66      # Linux is the default
67      if self.setCompilers.isDarwin(self.log):
68        self.addMakeRule('shared_arch','shared_darwin')
69        self.addMakeMacro('SONAME_FUNCTION', '$(1).$(2).dylib')
70        self.addMakeMacro('SL_LINKER_FUNCTION', '-dynamiclib -install_name $(call SONAME_FUNCTION,$(1),$(2)) -compatibility_version $(2) -current_version $(3) -single_module -multiply_defined suppress -undefined dynamic_lookup')
71      elif self.setCompilers.CC.find('win32fe') >=0:
72        self.addMakeMacro('SONAME_FUNCTION', '$(1).dll')
73        self.addMakeMacro('SL_LINKER_FUNCTION', '-LD')
74        self.addMakeMacro('PETSC_DLL_EXPORTS', '1')
75      else:
76        # TODO: check that -Wl,-soname,${LIBNAME}.${SL_LINKER_SUFFIX} can be passed (might fail on Intel)
77        # TODO: check whether to use -qmkshrobj or -shared (maybe we can just use self.setCompilers.sharedLibraryFlags)
78        # TODO: check whether we need to specify dependent libraries on the link line (long test)
79        self.addMakeRule('shared_arch','shared_linux')
80        self.addMakeMacro('SONAME_FUNCTION', '$(1).so.$(2)')
81        self.addMakeMacro('SL_LINKER_FUNCTION', '-shared -Wl,-soname,$(call SONAME_FUNCTION,$(notdir $(1)),$(2))')
82        if config.setCompilers.Configure.isMINGW(self.framework.getCompiler(),self.log):
83          self.addMakeMacro('PETSC_DLL_EXPORTS', '1')
84      self.addMakeMacro('BUILDSHAREDLIB','yes')
85    else:
86      self.addMakeRule('shared_arch','')
87      self.addMakeMacro('BUILDSHAREDLIB','no')
88    if self.useShared:
89      self.addDefine('USE_SHARED_LIBRARIES', 1)
90    else:
91      self.logPrint('Shared libraries - disabled')
92    return
93
94  def configureDynamicLibraries(self):
95    '''Checks whether dynamic loading is available (with dlfcn.h and libdl)'''
96    if self.setCompilers.dynamicLibraries:
97      self.addDefine('HAVE_DYNAMIC_LIBRARIES', 1)
98    return
99
100  def configureSerializedFunctions(self):
101    '''
102    Defines PETSC_SERIALIZE_FUNCTIONS if they are used
103    Requires shared libraries'''
104    import sys
105
106    if self.framework.argDB['with-serialize-functions'] and self.setCompilers.dynamicLibraries:
107      self.addDefine('SERIALIZE_FUNCTIONS', 1)
108
109  def checkSymbolResolution(self):
110    '''Checks that dladdr() works'''
111    if self.headers.haveHeader('dlfcn.h') and self.functions.haveFunction('dlerror'):
112      ftm = ''
113      if self.ftm.defines.get('_GNU_SOURCE'): ftm = '#define _GNU_SOURCE\n'
114      if self.checkCompile('%s#include<stdlib.h>\n#include <dlfcn.h>\n' % ftm, 'Dl_info info;\n\nif (dladdr(exit, &info));\n'):
115        self.addDefine('HAVE_DLADDR', 1)
116        self.headers.check('cxxabi.h')
117
118  def configure(self):
119    self.executeTest(self.checkSharedDynamicPicOptions)
120    self.executeTest(self.configureSharedLibraries)
121    self.executeTest(self.configureDynamicLibraries)
122    self.executeTest(self.configureSerializedFunctions)
123    self.executeTest(self.checkSymbolResolution)
124    return
125