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