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