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