xref: /petsc/config/PETSc/Configure.py (revision ee1cef2c4f92b4b45b8aa3ceac59cb944062fab9)
1import config.base
2
3import os
4import re
5
6class Configure(config.base.Configure):
7  def __init__(self, framework):
8    config.base.Configure.__init__(self, framework)
9    self.headerPrefix = 'PETSC'
10    self.substPrefix  = 'PETSC'
11    self.defineAutoconfMacros()
12    return
13
14  def __str__(self):
15    return ''
16
17  def setupHelp(self, help):
18    import nargs
19    help.addArgument('PETSc',  '-prefix=<path>',                  nargs.Arg(None, '', 'Specifiy location to install PETSc (eg. /usr/local)'))
20    help.addArgument('Windows','-with-windows-graphics=<bool>',   nargs.ArgBool(None, 1,'Enable check for Windows Graphics'))
21    help.addArgument('PETSc','-with-single-library=<bool>',       nargs.ArgBool(None, 0,'Put all PETSc code into the single -lpetsc library'))
22
23    return
24
25  def setupDependencies(self, framework):
26    config.base.Configure.setupDependencies(self, framework)
27    self.setCompilers  = framework.require('config.setCompilers',      self)
28    self.arch          = framework.require('PETSc.utilities.arch',     self.setCompilers)
29    self.petscdir      = framework.require('PETSc.utilities.petscdir', self.setCompilers)
30    self.languages     = framework.require('PETSc.utilities.languages',self.setCompilers)
31    self.debugging     = framework.require('PETSc.utilities.debugging',self.setCompilers)
32    self.debugging     = framework.require('PETSc.utilities.Make',     self)
33    self.compilers     = framework.require('config.compilers',         self)
34    self.types         = framework.require('config.types',             self)
35    self.headers       = framework.require('config.headers',           self)
36    self.functions     = framework.require('config.functions',         self)
37    self.libraries     = framework.require('config.libraries',         self)
38    if os.path.isdir(os.path.join('config', 'PETSc')):
39      for d in ['utilities', 'packages']:
40        for utility in os.listdir(os.path.join('config', 'PETSc', d)):
41          (utilityName, ext) = os.path.splitext(utility)
42          if not utilityName.startswith('.') and not utilityName.startswith('#') and ext == '.py' and not utilityName == '__init__':
43            utilityObj              = self.framework.require('PETSc.'+d+'.'+utilityName, self)
44            utilityObj.headerPrefix = self.headerPrefix
45            ##utilityObj.languageProvider = self.languages
46            setattr(self, utilityName.lower(), utilityObj)
47    self.blaslapack    = framework.require('config.packages.BlasLapack', self)
48    self.blaslapack.archProvider      = self.arch
49    self.blaslapack.precisionProvider = self.scalartypes
50    self.blaslapack.installDirProvider= self.petscdir
51    self.mpi           = framework.require('config.packages.MPI',        self)
52    self.mpi.archProvider             = self.arch
53    self.mpi.languageProvider         = self.languages
54    self.mpi.installDirProvider       = self.petscdir
55    self.umfpack       = framework.require('config.packages.UMFPACK',    self)
56    self.umfpack.archProvider         = self.arch
57    self.umfpack.languageProvider     = self.languages
58    self.umfpack.installDirProvider   = self.petscdir
59    self.Boost         = framework.require('config.packages.Boost',      self)
60    self.Boost.archProvider           = self.arch
61    self.Boost.languageProvider       = self.languages
62    self.Boost.installDirProvider     = self.petscdir
63    self.Fiat          = framework.require('config.packages.Fiat',       self)
64    self.Fiat.archProvider            = self.arch
65    self.Fiat.languageProvider        = self.languages
66    self.Fiat.installDirProvider      = self.petscdir
67
68    self.compilers.headerPrefix = self.headerPrefix
69    self.types.headerPrefix     = self.headerPrefix
70    self.headers.headerPrefix   = self.headerPrefix
71    self.functions.headerPrefix = self.headerPrefix
72    self.libraries.headerPrefix = self.headerPrefix
73    self.blaslapack.headerPrefix = self.headerPrefix
74    self.mpi.headerPrefix        = self.headerPrefix
75    headersC = map(lambda name: name+'.h', ['dos', 'endian', 'fcntl', 'float', 'io', 'limits', 'malloc', 'pwd', 'search', 'strings',
76                                            'unistd', 'machine/endian', 'sys/param', 'sys/procfs', 'sys/resource',
77                                            'sys/systeminfo', 'sys/times', 'sys/utsname','string', 'stdlib','memory',
78                                            'sys/socket','sys/wait','netinet/in','netdb','Direct','time','Ws2tcpip','sys/types',
79                                            'WindowsX', 'cxxabi','float.h','ieeefp'])
80    functions = ['access', '_access', 'clock', 'drand48', 'getcwd', '_getcwd', 'getdomainname', 'gethostname', 'getpwuid',
81                 'gettimeofday', 'getwd', 'memalign', 'memmove', 'mkstemp', 'popen', 'PXFGETARG', 'rand', 'getpagesize',
82                 'readlink', 'realpath',  'sigaction', 'signal', 'sigset', 'sleep', '_sleep', 'socket', 'times', 'gethostbyname',
83                 'uname','snprintf','_snprintf','_fullpath','lseek','_lseek','time','fork','stricmp','strcasecmp','bzero',
84                 'dlopen', 'dlsym', 'dlclose', 'dlerror',
85                 '_intel_fast_memcpy','_intel_fast_memset','isinf','isnan','_finite','_isnan']
86    libraries1 = [(['socket', 'nsl'], 'socket'), (['fpe'], 'handle_sigfpes')]
87    self.headers.headers.extend(headersC)
88    self.functions.functions.extend(functions)
89    self.libraries.libraries.extend(libraries1)
90    return
91
92  def defineAutoconfMacros(self):
93    self.hostMacro = 'dnl Version: 2.13\ndnl Variable: host_cpu\ndnl Variable: host_vendor\ndnl Variable: host_os\nAC_CANONICAL_HOST'
94    return
95
96  def Dump(self):
97    ''' Actually put the values into the configuration files '''
98    # eventually everything between -- should be gone
99#-----------------------------------------------------------------------------------------------------
100
101    # Sometimes we need C compiler, even if built with C++
102    self.setCompilers.pushLanguage('C')
103    self.addMakeMacro('CC_FLAGS',self.setCompilers.getCompilerFlags())
104    self.setCompilers.popLanguage()
105
106    # C preprocessor values
107    self.addMakeMacro('CPP_FLAGS',self.setCompilers.CPPFLAGS)
108
109    # compiler values
110    self.setCompilers.pushLanguage(self.languages.clanguage)
111    self.addMakeMacro('PCC',self.setCompilers.getCompiler())
112    self.addMakeMacro('PCC_FLAGS',self.setCompilers.getCompilerFlags())
113    self.setCompilers.popLanguage()
114    # .o or .obj
115    self.addMakeMacro('CC_SUFFIX','o')
116
117    # executable linker values
118    self.setCompilers.pushLanguage(self.languages.clanguage)
119    pcc_linker = self.setCompilers.getLinker()
120    self.addMakeMacro('PCC_LINKER',pcc_linker)
121    self.addMakeMacro('PCC_LINKER_FLAGS',self.setCompilers.getLinkerFlags())
122    self.setCompilers.popLanguage()
123    # '' for Unix, .exe for Windows
124    self.addMakeMacro('CC_LINKER_SUFFIX','')
125    self.addMakeMacro('PCC_LINKER_LIBS',self.libraries.toStringNoDupes(self.compilers.flibs+self.compilers.cxxlibs+self.compilers.LIBS.split(' ')))
126
127    if hasattr(self.compilers, 'FC'):
128      self.setCompilers.pushLanguage('FC')
129      # need FPPFLAGS in config/setCompilers
130      self.addDefine('HAVE_FORTRAN','1')
131      self.addMakeMacro('FPP_FLAGS',self.setCompilers.CPPFLAGS)
132
133      # compiler values
134      self.addMakeMacro('FC_FLAGS',self.setCompilers.getCompilerFlags())
135      self.setCompilers.popLanguage()
136      # .o or .obj
137      self.addMakeMacro('FC_SUFFIX','o')
138
139      # executable linker values
140      self.setCompilers.pushLanguage('FC')
141      # Cannot have NAG f90 as the linker - so use pcc_linker as fc_linker
142      fc_linker = self.setCompilers.getLinker()
143      if config.setCompilers.Configure.isNAG(fc_linker):
144        self.addMakeMacro('FC_LINKER',pcc_linker)
145      else:
146        self.addMakeMacro('FC_LINKER',fc_linker)
147      self.addMakeMacro('FC_LINKER_FLAGS',self.setCompilers.getLinkerFlags())
148      # apple requires this shared library linker flag on SOME versions of the os
149      if self.setCompilers.getLinkerFlags().find('-Wl,-commons,use_dylibs') > -1:
150        self.addMakeMacro('DARWIN_COMMONS_USE_DYLIBS',' -Wl,-commons,use_dylibs ')
151      self.setCompilers.popLanguage()
152    else:
153      self.addMakeMacro('FC','')
154
155    # shared library linker values
156    self.setCompilers.pushLanguage(self.languages.clanguage)
157    # need to fix BuildSystem to collect these separately
158    self.addMakeMacro('SL_LINKER',self.setCompilers.getLinker())
159    self.addMakeMacro('SL_LINKER_FLAGS','${PCC_LINKER_FLAGS}')
160    self.setCompilers.popLanguage()
161    # One of 'a', 'so', 'lib', 'dll', 'dylib' (perhaps others also?) depending on the library generator and architecture
162    # Note: . is not included in this macro, consistent with AR_LIB_SUFFIX
163    if self.setCompilers.sharedLibraryExt == self.setCompilers.AR_LIB_SUFFIX:
164      self.addMakeMacro('SL_LINKER_SUFFIX', '')
165    else:
166      self.addMakeMacro('SL_LINKER_SUFFIX', self.setCompilers.sharedLibraryExt)
167
168    #SL_LINKER_LIBS is currently same as PCC_LINKER_LIBS - so simplify
169    self.addMakeMacro('SL_LINKER_LIBS','${PCC_LINKER_LIBS}')
170    #self.addMakeMacro('SL_LINKER_LIBS',self.libraries.toStringNoDupes(self.compilers.flibs+self.compilers.cxxlibs+self.compilers.LIBS.split(' ')))
171
172#-----------------------------------------------------------------------------------------------------
173
174    # CONLY or CPP. We should change the PETSc makefiles to do this better
175    if self.languages.clanguage == 'C': lang = 'CONLY'
176    else: lang = 'CXXONLY'
177    self.addMakeMacro('PETSC_LANGUAGE',lang)
178
179    # real or complex
180    self.addMakeMacro('PETSC_SCALAR',self.scalartypes.scalartype)
181    # double or float
182    self.addMakeMacro('PETSC_PRECISION',self.scalartypes.precision)
183
184    if self.framework.argDB['with-batch']:
185      self.addMakeMacro('PETSC_WITH_BATCH','1')
186
187    # Test for compiler-specific macros that need to be defined.
188    if self.setCompilers.isCray('CC'):
189      self.addDefine('HAVE_CRAYC','1')
190
191#-----------------------------------------------------------------------------------------------------
192    if self.functions.haveFunction('gethostbyname') and self.functions.haveFunction('socket'):
193      self.addDefine('USE_SOCKET_VIEWER','1')
194
195#-----------------------------------------------------------------------------------------------------
196    # print include and lib for external packages
197    self.framework.packages.reverse()
198    includes = []
199    libs = []
200    for i in self.framework.packages:
201      self.addDefine('HAVE_'+i.PACKAGE, 1)
202      if not isinstance(i.lib, list):
203        i.lib = [i.lib]
204      libs.extend(i.lib)
205      self.addMakeMacro(i.PACKAGE+'_LIB', self.libraries.toStringNoDupes(i.lib))
206      if hasattr(i,'include'):
207        if not isinstance(i.include,list):
208          i.include = [i.include]
209        includes.extend(i.include)
210        self.addMakeMacro(i.PACKAGE+'_INCLUDE',self.headers.toStringNoDupes(i.include))
211    self.addMakeMacro('PACKAGES_LIBS',self.libraries.toStringNoDupes(libs+self.libraries.math))
212    self.addMakeMacro('PACKAGES_INCLUDES',self.headers.toStringNoDupes(includes))
213
214    self.addMakeMacro('INSTALL_DIR',self.installdir)
215
216    if self.framework.argDB['with-single-library']:
217      # overrides the values set in conf/variables
218      self.addMakeMacro('LIBNAME','${INSTALL_LIB_DIR}/libpetsc.${AR_LIB_SUFFIX}')
219      self.addMakeMacro('PETSC_SYS_LIB_BASIC','-lpetsc')
220      self.addMakeMacro('PETSC_VEC_LIB_BASIC','-lpetsc')
221      self.addMakeMacro('PETSC_MAT_LIB_BASIC','-lpetsc')
222      self.addMakeMacro('PETSC_DM_LIB_BASIC','-lpetsc')
223      self.addMakeMacro('PETSC_KSP_LIB_BASIC','-lpetsc')
224      self.addMakeMacro('PETSC_SNES_LIB_BASIC','-lpetsc')
225      self.addMakeMacro('PETSC_TS_LIB_BASIC','-lpetsc')
226      self.addMakeMacro('PETSC_LIB_BASIC','-lpetsc')
227      self.addMakeMacro('PETSC_CONTRIB_BASIC','-lpetsc')
228      self.addDefine('USE_SINGLE_LIBRARY', '1')
229
230    if not os.path.exists(os.path.join(self.petscdir.dir,self.arch.arch,'lib')):
231      os.makedirs(os.path.join(self.petscdir.dir,self.arch.arch,'lib'))
232
233    # add a makefile entry for configure options
234    self.addMakeMacro('CONFIGURE_OPTIONS', self.framework.getOptionsString(['configModules', 'optionsModule']).replace('\"','\\"'))
235    return
236
237  def dumpConfigInfo(self):
238    import time
239    fd = file(os.path.join(self.arch.arch,'include','petscconfiginfo.h'),'w')
240    fd.write('static const char *petscconfigureruntime = "'+time.ctime(time.time())+'";\n')
241    fd.write('static const char *petscconfigureoptions = "'+self.framework.getOptionsString(['configModules', 'optionsModule']).replace('\"','\\"')+'";\n')
242    fd.close()
243    return
244
245  def configureInline(self):
246    '''Get a generic inline keyword, depending on the language'''
247    if self.languages.clanguage == 'C':
248      self.addDefine('STATIC_INLINE', self.compilers.cStaticInlineKeyword)
249      self.addDefine('RESTRICT', self.compilers.cRestrict)
250    elif self.languages.clanguage == 'Cxx':
251      self.addDefine('STATIC_INLINE', self.compilers.cxxStaticInlineKeyword)
252      self.addDefine('RESTRICT', self.compilers.cxxRestrict)
253    return
254
255  def configureSolaris(self):
256    '''Solaris specific stuff'''
257    if self.arch.hostOsBase.startswith('solaris'):
258      if os.path.isdir(os.path.join('/usr','ucblib')):
259        try:
260          flag = getattr(self.setCompilers, self.language[-1]+'SharedLinkerFlag')
261        except AttributeError:
262          flag = None
263        if flag is None:
264          self.compilers.LIBS += ' -L/usr/ucblib'
265        else:
266          self.compilers.LIBS += ' '+flag+'/usr/ucblib'
267    return
268
269  def configureLinux(self):
270    '''Linux specific stuff'''
271    if self.arch.hostOsBase == 'linux':
272      self.addDefine('HAVE_DOUBLE_ALIGN_MALLOC', 1)
273    return
274
275  def configureWin32(self):
276    '''Win32 non-cygwin specific stuff'''
277    kernel32=0
278    if self.libraries.add('Kernel32.lib','GetComputerName',prototype='#include <Windows.h>', call='GetComputerName(NULL,NULL);'):
279      self.addDefine('HAVE_WINDOWS_H',1)
280      self.addDefine('HAVE_GETCOMPUTERNAME',1)
281      kernel32=1
282    elif self.libraries.add('kernel32','GetComputerName',prototype='#include <Windows.h>', call='GetComputerName(NULL,NULL);'):
283      self.addDefine('HAVE_WINDOWS_H',1)
284      self.addDefine('HAVE_GETCOMPUTERNAME',1)
285      kernel32=1
286    if kernel32:
287      if self.framework.argDB['with-windows-graphics']:
288        self.addDefine('USE_WINDOWS_GRAPHICS',1)
289      if self.checkLink('#include <Windows.h>','LoadLibrary(0)'):
290        self.addDefine('HAVE_LOADLIBRARY',1)
291      if self.checkLink('#include <Windows.h>','GetProcAddress(0,0)'):
292        self.addDefine('HAVE_GETPROCADDRESS',1)
293      if self.checkLink('#include <Windows.h>','FreeLibrary(0)'):
294        self.addDefine('HAVE_FREELIBRARY',1)
295      if self.checkLink('#include <Windows.h>','GetLastError()'):
296        self.addDefine('HAVE_GETLASTERROR',1)
297      if self.checkLink('#include <Windows.h>','SetLastError(0)'):
298        self.addDefine('HAVE_SETLASTERROR',1)
299      if self.checkLink('#include <Windows.h>\n','QueryPerformanceCounter(0);\n'):
300        self.addDefine('USE_NT_TIME',1)
301    if self.libraries.add('Advapi32.lib','GetUserName',prototype='#include <Windows.h>', call='GetUserName(NULL,NULL);'):
302      self.addDefine('HAVE_GET_USER_NAME',1)
303    elif self.libraries.add('advapi32','GetUserName',prototype='#include <Windows.h>', call='GetUserName(NULL,NULL);'):
304      self.addDefine('HAVE_GET_USER_NAME',1)
305
306    if not self.libraries.add('User32.lib','GetDC',prototype='#include <Windows.h>',call='GetDC(0);'):
307      self.libraries.add('user32','GetDC',prototype='#include <Windows.h>',call='GetDC(0);')
308    if not self.libraries.add('Gdi32.lib','CreateCompatibleDC',prototype='#include <Windows.h>',call='CreateCompatibleDC(0);'):
309      self.libraries.add('gdi32','CreateCompatibleDC',prototype='#include <Windows.h>',call='CreateCompatibleDC(0);')
310
311    self.types.check('int32_t', 'int')
312    if not self.checkCompile('#include <sys/types.h>\n','uid_t u;\n'):
313      self.addTypedef('int', 'uid_t')
314      self.addTypedef('int', 'gid_t')
315    if not self.checkLink('#if defined(PETSC_HAVE_UNISTD_H)\n#include <unistd.h>\n#endif\n','int a=R_OK;\n'):
316      self.framework.addDefine('R_OK', '04')
317      self.framework.addDefine('W_OK', '02')
318      self.framework.addDefine('X_OK', '01')
319    if not self.checkLink('#include <sys/stat.h>\n','int a=0;\nif (S_ISDIR(a)){}\n'):
320      self.framework.addDefine('S_ISREG(a)', '(((a)&_S_IFMT) == _S_IFREG)')
321      self.framework.addDefine('S_ISDIR(a)', '(((a)&_S_IFMT) == _S_IFDIR)')
322    if self.checkCompile('#include <Windows.h>\n','LARGE_INTEGER a;\nDWORD b=a.u.HighPart;\n'):
323      self.addDefine('HAVE_LARGE_INTEGER_U',1)
324
325    # Windows requires a Binary file creation flag when creating/opening binary files.  Is a better test in order?
326    if self.checkCompile('#include <Windows.h>\n',''):
327      self.addDefine('HAVE_O_BINARY',1)
328
329    if self.compilers.CC.find('win32fe') >= 0:
330      self.addDefine('PATH_SEPARATOR','\';\'')
331      self.addDefine('DIR_SEPARATOR','\'\\\\\'')
332      self.addDefine('REPLACE_DIR_SEPARATOR','\'/\'')
333      self.addDefine('CANNOT_START_DEBUGGER',1)
334    else:
335      self.addDefine('PATH_SEPARATOR','\':\'')
336      self.addDefine('REPLACE_DIR_SEPARATOR','\'\\\\\'')
337      self.addDefine('DIR_SEPARATOR','\'/\'')
338    return
339
340#-----------------------------------------------------------------------------------------------------
341  def configureScript(self):
342    '''Output a script in the conf directory which will reproduce the configuration'''
343    import nargs
344    import sys
345    scriptName = os.path.join(self.arch.arch,'conf', 'reconfigure-'+self.arch.arch+'.py')
346    args = dict([(nargs.Arg.parseArgument(arg)[0], arg) for arg in self.framework.clArgs])
347    if 'configModules' in args:
348      if nargs.Arg.parseArgument(args['configModules'])[1] == ['PETSc.Configure']:
349        del args['configModules']
350    if 'optionsModule' in args:
351      if nargs.Arg.parseArgument(args['optionsModule'])[1] == 'PETSc.compilerOptions':
352        del args['optionsModule']
353    if not 'PETSC_ARCH' in args:
354      args['PETSC_ARCH'] = '-PETSC_ARCH='+str(self.arch.arch)
355    f = file(scriptName, 'w')
356    f.write('#!'+sys.executable+'\n')
357    f.write('if __name__ == \'__main__\':\n')
358    f.write('  import sys\n')
359    f.write('  sys.path.insert(0, '+repr(os.path.join(self.petscdir.dir, 'config'))+')\n')
360    f.write('  import configure\n')
361    f.write('  configure_options = '+repr(args.values())+'\n')
362    f.write('  configure.petsc_configure(configure_options)\n')
363    f.close()
364    try:
365      os.chmod(scriptName, 0775)
366    except OSError, e:
367      self.framework.logPrint('Unable to make reconfigure script executable:\n'+str(e))
368    self.framework.actions.addArgument('PETSc', 'File creation', 'Created '+scriptName+' for automatic reconfiguration')
369    return
370
371  def configureInstall(self):
372    '''Setup the directories for installation'''
373    if self.framework.argDB['prefix']:
374      self.installdir = self.framework.argDB['prefix']
375      self.addMakeRule('shared_nomesg_noinstall','')
376      self.addMakeRule('shared_install','',['-@echo "Now to install the libraries do: make install"',\
377                                              '-@echo "========================================="'])
378    else:
379      self.installdir = os.path.join(self.petscdir.dir,self.arch.arch)
380      self.addMakeRule('shared_nomesg_noinstall','shared_nomesg')
381      self.addMakeRule('shared_install','',['-@echo "Now to check if the libraries are working do: make test"',\
382                                              '-@echo "========================================="'])
383      return
384
385  def configureGCOV(self):
386    if self.framework.argDB['with-gcov']:
387      self.addDefine('USE_GCOV','1')
388    return
389
390  def configureFortranFlush(self):
391    if hasattr(self.compilers, 'FC'):
392      for baseName in ['flush','flush_']:
393        if self.libraries.check('', baseName, otherLibs = self.compilers.flibs, fortranMangle = 1):
394          self.addDefine('HAVE_'+baseName.upper(), 1)
395          return
396
397
398  def configure(self):
399    if not os.path.samefile(self.petscdir.dir, os.getcwd()):
400      raise RuntimeError('Wrong PETSC_DIR option specified: '+str(self.petscdir.dir) + '\n  Configure invoked in: '+os.path.realpath(os.getcwd()))
401    self.framework.header          = self.arch.arch+'/include/petscconf.h'
402    self.framework.cHeader         = self.arch.arch+'/include/petscfix.h'
403    self.framework.makeMacroHeader = self.arch.arch+'/conf/petscvariables'
404    self.framework.makeRuleHeader  = self.arch.arch+'/conf/petscrules'
405    if self.libraries.math is None:
406      raise RuntimeError('PETSc requires a functional math library. Please send configure.log to petsc-maint@mcs.anl.gov.')
407    if self.languages.clanguage == 'Cxx' and not hasattr(self.compilers, 'CXX'):
408      raise RuntimeError('Cannot set C language to C++ without a functional C++ compiler.')
409    self.executeTest(self.configureInline)
410    self.executeTest(self.configureSolaris)
411    self.executeTest(self.configureLinux)
412    self.executeTest(self.configureWin32)
413    self.executeTest(self.configureScript)
414    self.executeTest(self.configureInstall)
415    self.executeTest(self.configureGCOV)
416    self.executeTest(self.configureFortranFlush)
417    # dummy rules, always needed except for remote builds
418    self.addMakeRule('remote','')
419    self.addMakeRule('remoteclean','')
420
421    self.Dump()
422    self.dumpConfigInfo()
423    self.framework.log.write('================================================================================\n')
424    self.logClear()
425    return
426