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