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