xref: /petsc/config/PETSc/Configure.py (revision a29dfd43bb0c77e2653d3bfa2c953f902720a6d2)
1import config.base
2
3import os
4import sys
5import re
6import pickle
7
8class Configure(config.base.Configure):
9  def __init__(self, framework):
10    config.base.Configure.__init__(self, framework)
11    self.headerPrefix = 'PETSC'
12    self.substPrefix  = 'PETSC'
13    self.installed    = 0 # 1 indicates that Configure itself has already compiled and installed PETSc
14    self.found        = 1
15    return
16
17  def __str2__(self):
18    import logger
19
20    desc = ['  Using GNU make: ' + self.make.make]
21    if self.defines.get('USE_COVERAGE'):
22      desc.extend([
23        '  Code coverage: yes',
24        '  Using code coverage executable: {}'.format(self.getMakeMacro('PETSC_COVERAGE_EXEC'))
25      ])
26    banner_ends   = 'xxx'
27    banner_middle = '=' * (logger.get_global_divider_length() - 2 * len(banner_ends))
28    banner_line   = banner_middle.join((banner_ends, banner_ends))
29    desc.append(banner_line)
30    if not self.installed:
31      desc.append(' Configure stage complete. Now build PETSc libraries with:')
32      desc.append('   %s PETSC_DIR=%s PETSC_ARCH=%s all' % (self.make.make_user, self.petscdir.dir, self.arch.arch))
33    else:
34      desc.append(' Installation complete. You do not need to run make to compile or install the software')
35    desc.extend([banner_line, ''])
36    return '\n'.join(desc)
37
38  def setupHelp(self, help):
39    import nargs
40    help.addArgument('PETSc',  '-prefix=<dir>',                              nargs.Arg(None, '', 'Specifiy location to install PETSc (eg. /usr/local)'))
41    help.addArgument('PETSc',  '-with-prefetch=<bool>',                      nargs.ArgBool(None, 1,'Enable checking for prefetch instructions'))
42    help.addArgument('Windows','-with-windows-graphics=<bool>',              nargs.ArgBool(None, 1,'Enable check for Windows Graphics'))
43    help.addArgument('PETSc', '-with-default-arch=<bool>',                   nargs.ArgBool(None, 1, 'Allow using the last configured arch without setting PETSC_ARCH'))
44    help.addArgument('PETSc','-with-single-library=<bool>',                  nargs.ArgBool(None, 1,'Put all PETSc code into the single -lpetsc library'))
45    help.addArgument('PETSc','-with-fortran-bindings=<bool>',                nargs.ArgBool(None, 1,'Build PETSc fortran bindings in the library and corresponding module files'))
46    help.addArgument('PETSc', '-with-ios=<bool>',                            nargs.ArgBool(None, 0, 'Build an iPhone/iPad version of PETSc library'))
47    help.addArgument('PETSc', '-with-display=<x11display>',                  nargs.Arg(None, '', 'Specifiy DISPLAY environmental variable for use with MATLAB test)'))
48    help.addArgument('PETSc', '-with-package-scripts=<pyscripts>',           nargs.ArgFileList(None,None,'Specify configure package scripts for user provided packages'))
49    help.addArgument('PETSc', '-with-coverage=<bool>',                       nargs.ArgFuzzyBool(None, value=0, help='Enable or disable code-coverage collection'))
50    help.addArgument('PETSc', '-with-coverage-exec=<executable>',            nargs.ArgExecutable(None, value='default-auto', mustExist=0, help='Name of executable to use for post-processing coverage data, e.g. \'gcov\' or \'llvm-cov\'. Pass \'auto\' to let configure infer from compiler'))
51    help.addArgument('PETSc', '-with-tau-perfstubs=<bool>',                  nargs.ArgBool(None, 1,'Enable TAU profiler stubs'))
52    help.addArgument('PETSc', '-with-strict-petscerrorcode=<bool>',          nargs.ArgFuzzyBool(None, value=0, help='Enable strict PetscErrorCode mode, which enables additional compile-time checking for misuse of PetscErrorCode and error handling'))
53    return
54
55  def registerPythonFile(self,filename,directory):
56    ''' Add a python file to the framework and registers its headerprefix, ... externalpackagedir
57        directory is the directory where the file relative to the BuildSystem or config path in python notation with . '''
58    (utilityName, ext) = os.path.splitext(filename)
59    if not utilityName.startswith('.') and not utilityName.startswith('#') and ext == '.py' and not utilityName == '__init__':
60      if directory: directory = directory+'.'
61      utilityObj                             = self.framework.require(directory+utilityName, self)
62      utilityObj.headerPrefix                = self.headerPrefix
63      utilityObj.archProvider                = self.arch
64      utilityObj.languageProvider            = self.languages
65      utilityObj.installDirProvider          = self.installdir
66      utilityObj.externalPackagesDirProvider = self.externalpackagesdir
67      utilityObj.precisionProvider           = self.scalartypes
68      utilityObj.indexProvider               = self.indexTypes
69      setattr(self, utilityName.lower(), utilityObj)
70      return utilityObj
71    return None
72
73  def setupDependencies(self, framework):
74    config.base.Configure.setupDependencies(self, framework)
75    self.programs      = framework.require('config.programs',           self)
76    self.setCompilers  = framework.require('config.setCompilers',       self)
77    self.compilerFlags = framework.require('config.compilerFlags',      self)
78    self.compilers     = framework.require('config.compilers',          self)
79    self.arch          = framework.require('PETSc.options.arch',        self.setCompilers)
80    self.petscdir      = framework.require('PETSc.options.petscdir',    self.arch)
81    self.installdir    = framework.require('PETSc.options.installDir',  self)
82    self.dataFilesPath = framework.require('PETSc.options.dataFilesPath',self)
83    self.scalartypes   = framework.require('PETSc.options.scalarTypes', self)
84    self.indexTypes    = framework.require('PETSc.options.indexTypes',  self)
85    self.languages     = framework.require('PETSc.options.languages',   self.setCompilers)
86    self.indexTypes    = framework.require('PETSc.options.indexTypes',  self.compilers)
87    self.types         = framework.require('config.types',              self)
88    self.headers       = framework.require('config.headers',            self)
89    self.functions     = framework.require('config.functions',          self)
90    self.libraries     = framework.require('config.libraries',          self)
91    self.atomics       = framework.require('config.atomics',            self)
92    self.make          = framework.require('config.packages.make',      self)
93    self.blasLapack    = framework.require('config.packages.BlasLapack',self)
94    self.mpi           = framework.require('config.packages.MPI',       self)
95    self.fortran       = framework.require('config.compilersFortran',   self)
96    self.ftncmdline    = framework.require('config.utilities.fortranCommandLine',self)
97    self.externalpackagesdir = framework.require('PETSc.options.externalpackagesdir',self)
98
99    for utility in sorted(os.listdir(os.path.join('config','PETSc','options'))):
100      self.registerPythonFile(utility,'PETSc.options')
101
102    for utility in sorted(os.listdir(os.path.join('config','BuildSystem','config','utilities'))):
103      self.registerPythonFile(utility,'config.utilities')
104
105    for package in sorted(os.listdir(os.path.join('config', 'BuildSystem', 'config', 'packages'))):
106      obj = self.registerPythonFile(package,'config.packages')
107      if obj:
108        obj.archProvider                = self.framework.requireModule(obj.archProvider, obj)
109        obj.languageProvider            = self.framework.requireModule(obj.languageProvider, obj)
110        obj.installDirProvider          = self.framework.requireModule(obj.installDirProvider, obj)
111        obj.externalPackagesDirProvider = self.framework.requireModule(obj.externalPackagesDirProvider, obj)
112        obj.precisionProvider           = self.framework.requireModule(obj.precisionProvider, obj)
113        obj.indexProvider               = self.framework.requireModule(obj.indexProvider, obj)
114
115    # Force blaslapack and opencl to depend on scalarType so precision is set before BlasLapack is built
116    framework.require('PETSc.options.scalarTypes', self.f2cblaslapack)
117    framework.require('PETSc.options.scalarTypes', self.fblaslapack)
118    framework.require('PETSc.options.scalarTypes', self.blaslapack)
119    framework.require('PETSc.options.scalarTypes', self.opencl)
120
121    self.programs.headerPrefix     = self.headerPrefix
122    self.setCompilers.headerPrefix = self.headerPrefix
123    self.compilers.headerPrefix    = self.headerPrefix
124    self.fortran.headerPrefix      = self.headerPrefix
125    self.types.headerPrefix        = self.headerPrefix
126    self.headers.headerPrefix      = self.headerPrefix
127    self.functions.headerPrefix    = self.headerPrefix
128    self.libraries.headerPrefix    = self.headerPrefix
129
130    # Register user provided package scripts
131    if 'with-package-scripts' in self.framework.argDB:
132      for script in self.framework.argDB['with-package-scripts']:
133        if os.path.splitext(script)[1] != '.py':
134          raise RuntimeError('Only python scripts compatible with configure package script format should be specified! Invalid option -with-package-scripts='+script)
135        self.framework.logPrint('User is registering a new package script: '+script)
136        dname,fname = os.path.split(script)
137        if dname: sys.path.append(dname)
138        self.registerPythonFile(fname,'')
139
140    # test for a variety of basic headers and functions
141    headersC = map(lambda name: name+'.h',['setjmp','dos','fcntl','float','io','malloc','pwd','strings',
142                                            'unistd','machine/endian','sys/param','sys/procfs','sys/resource',
143                                            'sys/systeminfo','sys/times','sys/utsname',
144                                            'sys/socket','sys/wait','netinet/in','netdb','direct','time','Ws2tcpip','sys/types',
145                                            'WindowsX','float','ieeefp','stdint','inttypes','immintrin'])
146    functions = ['access','_access','clock','drand48','getcwd','_getcwd','getdomainname','gethostname',
147                 'posix_memalign','popen','PXFGETARG','rand','getpagesize',
148                 'readlink','realpath','usleep','sleep','_sleep',
149                 'uname','snprintf','_snprintf','lseek','_lseek','time','fork','stricmp',
150                 'strcasecmp','bzero','dlopen','dlsym','dlclose','dlerror',
151                 '_set_output_format','_mkdir','socket','gethostbyname','fpresetsticky',
152                 'fpsetsticky','__gcov_dump']
153    libraries = [(['fpe'],'handle_sigfpes')]
154    librariessock = [(['socket','nsl'],'socket')]
155    self.headers.headers.extend(headersC)
156    self.functions.functions.extend(functions)
157    self.libraries.libraries.extend(libraries)
158    if not hasattr(self,'socket'):
159      self.libraries.libraries.extend(librariessock)
160    return
161
162  def DumpPkgconfig(self, petsc_pc):
163    ''' Create a pkg-config file '''
164    if not os.path.exists(os.path.join(self.petscdir.dir,self.arch.arch,'lib','pkgconfig')):
165      os.makedirs(os.path.join(self.petscdir.dir,self.arch.arch,'lib','pkgconfig'))
166    with open(os.path.join(self.petscdir.dir,self.arch.arch,'lib','pkgconfig',petsc_pc),'w') as fd:
167      cflags_inc = ['-I${includedir}']
168      if self.framework.argDB['prefix']:
169        fd.write('prefix='+self.installdir.dir+'\n')
170      else:
171        fd.write('prefix='+os.path.join(self.petscdir.dir, self.arch.arch)+'\n')
172        cflags_inc.append('-I' + os.path.join(self.petscdir.dir, 'include'))
173      fd.write('exec_prefix=${prefix}\n')
174      fd.write('includedir=${prefix}/include\n')
175      fd.write('libdir=${prefix}/lib\n')
176
177      with self.setCompilers.Language('C'):
178        fd.write('ccompiler='+self.setCompilers.getCompiler()+'\n')
179        fd.write('cflags_extra='+self.setCompilers.getCompilerFlags().strip()+'\n')
180        fd.write('cflags_dep='+self.compilers.dependenciesGenerationFlag.get('C','')+'\n')
181        fd.write('ldflag_rpath='+self.setCompilers.CSharedLinkerFlag+'\n')
182      if hasattr(self.compilers, 'CXX'):
183        with self.setCompilers.Language('C++'):
184          fd.write('cxxcompiler='+self.setCompilers.getCompiler()+'\n')
185          fd.write('cxxflags_extra='+self.setCompilers.getCompilerFlags().strip()+'\n')
186      if hasattr(self.compilers, 'FC'):
187        with self.setCompilers.Language('FC'):
188          fd.write('fcompiler='+self.setCompilers.getCompiler()+'\n')
189          fd.write('fflags_extra='+self.setCompilers.getCompilerFlags().strip()+'\n')
190      if hasattr(self.compilers, 'CUDAC'):
191        with self.setCompilers.Language('CUDA'):
192          fd.write('cudacompiler='+self.setCompilers.getCompiler()+'\n')
193          fd.write('cudaflags_extra='+self.setCompilers.getCompilerFlags().strip()+'\n')
194          p = self.framework.require('config.packages.cuda')
195          fd.write('cudalib='+self.libraries.toStringNoDupes(p.lib)+'\n')
196          fd.write('cudainclude='+self.headers.toStringNoDupes(p.include)+'\n')
197          if hasattr(self.setCompilers,'CUDA_CXX'):
198            fd.write('cuda_cxx='+self.setCompilers.CUDA_CXX+'\n')
199            fd.write('cuda_cxxflags='+self.setCompilers.CUDA_CXXFLAGS+'\n')
200
201      fd.write('\n')
202      fd.write('Name: PETSc\n')
203      fd.write('Description: Library to solve ODEs and algebraic equations\n')
204      fd.write('Version: %s\n' % self.petscdir.version)
205      fd.write('Cflags: ' + ' '.join([self.setCompilers.CPPFLAGS] + cflags_inc) + '\n')
206      fd.write('Libs: '+self.libraries.toStringNoDupes(['-L${libdir}', self.petsclib], with_rpath=False)+'\n')
207      # Remove RPATH flags from library list.  User can add them using
208      # pkg-config --variable=ldflag_rpath and pkg-config --libs-only-L
209      fd.write('Libs.private: '+self.libraries.toStringNoDupes([f for f in self.packagelibs+self.complibs if not f.startswith(self.setCompilers.CSharedLinkerFlag)], with_rpath=False)+'\n')
210    return
211
212  def DumpModule(self):
213    ''' Create a module file '''
214    if not os.path.exists(os.path.join(self.petscdir.dir,self.arch.arch,'lib','petsc','conf','modules')):
215      os.makedirs(os.path.join(self.petscdir.dir,self.arch.arch,'lib','petsc','conf','modules'))
216    if not os.path.exists(os.path.join(self.petscdir.dir,self.arch.arch,'lib','petsc','conf','modules','petsc')):
217      os.makedirs(os.path.join(self.petscdir.dir,self.arch.arch,'lib','petsc','conf','modules','petsc'))
218    if self.framework.argDB['prefix']:
219      installdir  = self.installdir.dir
220      installarch = ''
221      installpath = os.path.join(installdir,'bin')
222    else:
223      installdir  = self.petscdir.dir
224      installarch = self.arch.arch
225      installpath = os.path.join(installdir,installarch,'bin')+':'+os.path.join(installdir,'bin')
226    fd = open(os.path.join(self.petscdir.dir,self.arch.arch,'lib','petsc','conf','modules','petsc',self.petscdir.version),'w')
227    fd.write('''\
228#%%Module
229
230proc ModulesHelp { } {
231    puts stderr "This module sets the path and environment variables for petsc-%s"
232    puts stderr "     see https://petsc.org/ for more information      "
233    puts stderr ""
234}
235module-whatis "PETSc - Portable, Extensible Toolkit for Scientific Computation"
236
237set petsc_dir   "%s"
238set petsc_arch  "%s"
239
240setenv PETSC_ARCH "$petsc_arch"
241setenv PETSC_DIR "$petsc_dir"
242prepend-path PATH "%s"
243''' % (self.petscdir.version, installdir, installarch, installpath))
244    fd.close()
245    return
246
247  def Dump(self):
248    ''' Actually put the values into the configuration files '''
249    # eventually everything between -- should be gone
250    if self.mpi.usingMPIUni:
251      #
252      # Remove any MPI/MPICH include files that may have been put here by previous runs of ./configure
253      self.executeShellCommand('rm -rf  '+os.path.join(self.petscdir.dir,self.arch.arch,'include','mpi*')+' '+os.path.join(self.petscdir.dir,self.arch.arch,'include','opa*'), log = self.log)
254
255    self.logPrintDivider()
256    # Test for compiler-specific macros that need to be defined.
257    if self.setCompilers.isCrayVector('CC', self.log):
258      self.addDefine('HAVE_CRAY_VECTOR','1')
259
260    if self.functions.haveFunction('gethostbyname') and self.functions.haveFunction('socket') and self.headers.haveHeader('netinet/in.h'):
261      self.addDefine('USE_SOCKET_VIEWER','1')
262      if self.checkCompile('#include <sys/socket.h>','setsockopt(0,SOL_SOCKET,SO_REUSEADDR,0,0)'):
263        self.addDefine('HAVE_SO_REUSEADDR','1')
264
265    self.logPrintDivider()
266    self.setCompilers.pushLanguage('C')
267    compiler = self.setCompilers.getCompiler()
268    if [s for s in ['mpicc','mpiicc'] if os.path.basename(compiler).find(s)>=0]:
269      try:
270        output   = self.executeShellCommand(compiler + ' -show', log = self.log)[0]
271        compiler = output.split(' ')[0]
272        self.addDefine('MPICC_SHOW','"'+output.strip().replace('\n','\\\\n').replace('"','')+'"')
273      except:
274        self.addDefine('MPICC_SHOW','"Unavailable"')
275    else:
276      self.addDefine('MPICC_SHOW','"Unavailable"')
277    self.setCompilers.popLanguage()
278#-----------------------------------------------------------------------------------------------------
279
280    # Sometimes we need C compiler, even if built with C++
281    self.setCompilers.pushLanguage('C')
282    # do not use getCompilerFlags() because that automatically includes the CPPFLAGS so one ends up with duplication flags in makefile usage
283    self.addMakeMacro('CC_FLAGS',self.setCompilers.CFLAGS)
284    self.setCompilers.popLanguage()
285
286    # And sometimes we need a C++ compiler even when PETSc is built with C
287    if hasattr(self.compilers, 'CXX'):
288      self.setCompilers.pushLanguage('Cxx')
289      self.addDefine('HAVE_CXX','1')
290      self.addMakeMacro('CXXPP_FLAGS',self.setCompilers.CXXPPFLAGS)
291      # do not use getCompilerFlags() because that automatically includes the CXXPPFLAGS so one ends up with duplication flags in makefile usage
292      self.addMakeMacro('CXX_FLAGS',self.setCompilers.CXXFLAGS+' '+self.setCompilers.CXX_CXXFLAGS)
293      cxx_linker = self.setCompilers.getLinker()
294      self.addMakeMacro('CXX_LINKER',cxx_linker)
295      self.addMakeMacro('CXX_LINKER_FLAGS',self.setCompilers.getLinkerFlags())
296      self.setCompilers.popLanguage()
297    else:
298      self.addMakeMacro('CXX','')
299
300    # C preprocessor values
301    self.addMakeMacro('CPP_FLAGS',self.setCompilers.CPPFLAGS)
302
303    # compiler values
304    self.setCompilers.pushLanguage(self.languages.clanguage)
305    self.addMakeMacro('PCC',self.setCompilers.getCompiler())
306    # do not use getCompilerFlags() because that automatically includes the preprocessor flags so one ends up with duplication flags in makefile usage
307    if self.languages.clanguage == 'C':
308      self.addMakeMacro('PCC_FLAGS','$(CC_FLAGS)')
309    else:
310      self.addMakeMacro('PCC_FLAGS','$(CXX_FLAGS)')
311    self.setCompilers.popLanguage()
312    # .o or .obj
313    self.addMakeMacro('CC_SUFFIX','o')
314
315    # executable linker values
316    self.setCompilers.pushLanguage(self.languages.clanguage)
317    pcc_linker = self.setCompilers.getLinker()
318    self.addMakeMacro('PCC_LINKER',pcc_linker)
319    # We need to add sycl flags when linking petsc. See more in sycl.py.
320    if hasattr(self.compilers, 'SYCLC'):
321      self.addMakeMacro('PCC_LINKER_FLAGS',self.setCompilers.getLinkerFlags()+' '+self.setCompilers.SYCLFLAGS+' '+self.setCompilers.SYCLC_LINKER_FLAGS)
322    else:
323      self.addMakeMacro('PCC_LINKER_FLAGS',self.setCompilers.getLinkerFlags())
324    self.setCompilers.popLanguage()
325    # '' for Unix, .exe for Windows
326    self.addMakeMacro('CC_LINKER_SUFFIX','')
327
328    if hasattr(self.compilers, 'FC'):
329      if self.framework.argDB['with-fortran-bindings']:
330        if not self.fortran.fortranIsF90:
331          raise RuntimeError('Error! Fortran compiler "'+self.compilers.FC+'" does not support F90! PETSc fortran bindings require a F90 compiler')
332        self.addDefine('USE_FORTRAN_BINDINGS','1')
333        if not self.ftncmdline.have_command_argument:
334          raise RuntimeError('Error! Fortran compiler "'+self.compilers.FC+'" does not support F2003 GET_COMMAND_ARGUMENT()!')
335      self.setCompilers.pushLanguage('FC')
336      # need FPPFLAGS in config/setCompilers
337      self.addMakeMacro('FPP_FLAGS',self.setCompilers.FPPFLAGS)
338
339      # compiler values
340      self.addMakeMacro('FC_FLAGS',self.setCompilers.getCompilerFlags())
341      self.setCompilers.popLanguage()
342      # .o or .obj
343      self.addMakeMacro('FC_SUFFIX','o')
344
345      # executable linker values
346      self.setCompilers.pushLanguage('FC')
347      self.addMakeMacro('FC_LINKER',self.setCompilers.getLinker())
348      self.addMakeMacro('FC_LINKER_FLAGS',self.setCompilers.getLinkerFlags())
349      self.setCompilers.popLanguage()
350
351      # F90 Modules
352      if self.setCompilers.fortranModuleIncludeFlag:
353        self.addMakeMacro('FC_MODULE_FLAG', self.setCompilers.fortranModuleIncludeFlag)
354      else: # for non-f90 compilers like g77
355        self.addMakeMacro('FC_MODULE_FLAG', '-I')
356      if self.setCompilers.fortranModuleIncludeFlag:
357        self.addMakeMacro('FC_MODULE_OUTPUT_FLAG', self.setCompilers.fortranModuleOutputFlag)
358    else:
359      self.addMakeMacro('FC','')
360
361    if hasattr(self.compilers, 'CUDAC'):
362      self.setCompilers.pushLanguage('CUDA')
363      self.addMakeMacro('CUDAC_FLAGS',self.setCompilers.getCompilerFlags())
364      self.addMakeMacro('CUDAPP_FLAGS',self.setCompilers.CUDAPPFLAGS)
365      self.setCompilers.popLanguage()
366
367    if hasattr(self.compilers, 'HIPC'):
368      self.setCompilers.pushLanguage('HIP')
369      self.addMakeMacro('HIPC_FLAGS',self.setCompilers.getCompilerFlags())
370      self.addMakeMacro('HIPPP_FLAGS',self.setCompilers.HIPPPFLAGS)
371      self.setCompilers.popLanguage()
372
373    if hasattr(self.compilers, 'SYCLC'):
374      self.setCompilers.pushLanguage('SYCL')
375      self.addMakeMacro('SYCLC_FLAGS',self.setCompilers.getCompilerFlags())
376      self.addMakeMacro('SYCLC_LINKER_FLAGS',self.setCompilers.getLinkerFlags())
377      self.addMakeMacro('SYCLPP_FLAGS',self.setCompilers.SYCLPPFLAGS)
378      self.setCompilers.popLanguage()
379
380    # shared library linker values
381    self.setCompilers.pushLanguage(self.languages.clanguage)
382    # need to fix BuildSystem to collect these separately
383    self.addMakeMacro('SL_LINKER',self.setCompilers.getLinker())
384    self.addMakeMacro('SL_LINKER_FLAGS','${PCC_LINKER_FLAGS}')
385    self.setCompilers.popLanguage()
386    # One of 'a', 'so', 'lib', 'dll', 'dylib' (perhaps others also?) depending on the library generator and architecture
387    # Note: . is not included in this macro, consistent with AR_LIB_SUFFIX
388    if self.setCompilers.sharedLibraryExt == self.setCompilers.AR_LIB_SUFFIX:
389      self.addMakeMacro('SL_LINKER_SUFFIX', '')
390      self.addDefine('SLSUFFIX','""')
391    else:
392      self.addMakeMacro('SL_LINKER_SUFFIX', self.setCompilers.sharedLibraryExt)
393      self.addDefine('SLSUFFIX','"'+self.setCompilers.sharedLibraryExt+'"')
394
395    self.addMakeMacro('SL_LINKER_LIBS','${PETSC_EXTERNAL_LIB_BASIC}')
396
397#-----------------------------------------------------------------------------------------------------
398
399    # CONLY or CPP. We should change the PETSc makefiles to do this better
400    if self.languages.clanguage == 'C': lang = 'CONLY'
401    else: lang = 'CXXONLY'
402    self.addMakeMacro('PETSC_LANGUAGE',lang)
403
404    # real or complex
405    self.addMakeMacro('PETSC_SCALAR',self.scalartypes.scalartype)
406    # double or float
407    self.addMakeMacro('PETSC_PRECISION',self.scalartypes.precision)
408
409    if self.framework.argDB['with-batch']:
410      self.addMakeMacro('PETSC_WITH_BATCH','1')
411
412#-----------------------------------------------------------------------------------------------------
413    # print include and lib for makefiles
414    self.logPrintDivider()
415    self.framework.packages.reverse()
416    petscincludes = [os.path.join(self.petscdir.dir,'include'),os.path.join(self.petscdir.dir,self.arch.arch,'include')]
417    petscincludes_install = [os.path.join(self.installdir.dir, 'include')] if self.framework.argDB['prefix'] else petscincludes
418    includes = []
419    self.packagelibs = []
420    for i in self.framework.packages:
421      if not i.required:
422        if i.devicePackage:
423          self.addDefine('HAVE_DEVICE',1)
424        self.addDefine('HAVE_'+i.PACKAGE.replace('-','_'), 1)  # ONLY list package if it is used directly by PETSc (and not only by another package)
425      if not isinstance(i.lib, list):
426        i.lib = [i.lib]
427      if i.linkedbypetsc: self.packagelibs.extend(i.lib)
428      self.addMakeMacro(i.PACKAGE.replace('-','_')+'_LIB', self.libraries.toStringNoDupes(i.lib))
429      if hasattr(i,'include'):
430        if not isinstance(i.include,list):
431          i.include = [i.include]
432        includes.extend(i.include)
433        self.addMakeMacro(i.PACKAGE.replace('-','_')+'_INCLUDE',self.headers.toStringNoDupes(i.include))
434
435    self.complibs = self.compilers.flibs+self.compilers.cxxlibs+self.compilers.LIBS.split()
436    self.PETSC_EXTERNAL_LIB_BASIC = self.libraries.toStringNoDupes(self.packagelibs+self.complibs)
437
438    self.addMakeMacro('PETSC_EXTERNAL_LIB_BASIC',self.PETSC_EXTERNAL_LIB_BASIC)
439    allincludes = petscincludes + includes
440    allincludes_install = petscincludes_install + includes
441    self.PETSC_CC_INCLUDES = self.headers.toStringNoDupes(allincludes)
442    self.PETSC_CC_INCLUDES_INSTALL = self.headers.toStringNoDupes(allincludes_install)
443    self.addMakeMacro('PETSC_CC_INCLUDES',self.PETSC_CC_INCLUDES)
444    self.addMakeMacro('PETSC_CC_INCLUDES_INSTALL', self.PETSC_CC_INCLUDES_INSTALL)
445    if hasattr(self.compilers, 'FC'):
446      def modinc(includes):
447        return includes if self.fortran.fortranIsF90 else []
448      self.addMakeMacro('PETSC_FC_INCLUDES',self.headers.toStringNoDupes(allincludes,modinc(allincludes)))
449      self.addMakeMacro('PETSC_FC_INCLUDES_INSTALL',self.headers.toStringNoDupes(allincludes_install,modinc(allincludes_install)))
450
451    LIB_DIR = os.path.join(self.installdir.dir,'lib')
452    self.addDefine('LIB_DIR','"'+LIB_DIR+'"')
453
454    if self.framework.argDB['with-single-library']:
455      self.petsclib = '-lpetsc'
456      self.addDefine('USE_SINGLE_LIBRARY', '1')
457      self.addMakeMacro('LIBNAME','${INSTALL_LIB_DIR}/libpetsc.${AR_LIB_SUFFIX}')
458      self.addMakeMacro('SHLIBS','libpetsc')
459      self.addMakeMacro('PETSC_WITH_EXTERNAL_LIB',self.libraries.toStringNoDupes(['-L'+LIB_DIR, '-lpetsc']+self.packagelibs+self.complibs))
460      self.addMakeMacro('PETSC_SYS_LIB','${PETSC_WITH_EXTERNAL_LIB}')
461      self.addMakeMacro('PETSC_VEC_LIB','${PETSC_WITH_EXTERNAL_LIB}')
462      self.addMakeMacro('PETSC_MAT_LIB','${PETSC_WITH_EXTERNAL_LIB}')
463      self.addMakeMacro('PETSC_DM_LIB','${PETSC_WITH_EXTERNAL_LIB}')
464      self.addMakeMacro('PETSC_KSP_LIB','${PETSC_WITH_EXTERNAL_LIB}')
465      self.addMakeMacro('PETSC_SNES_LIB','${PETSC_WITH_EXTERNAL_LIB}')
466      self.addMakeMacro('PETSC_TS_LIB','${PETSC_WITH_EXTERNAL_LIB}')
467      self.addMakeMacro('PETSC_TAO_LIB','${PETSC_WITH_EXTERNAL_LIB}')
468    else:
469      self.petsclib = '-lpetsctao -lpetscts -lpetscsnes -lpetscksp -lpetscdm -lpetscmat -lpetscvec -lpetscsys'
470      self.addMakeMacro('PETSC_SYS_LIB', self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscsys']+self.packagelibs+self.complibs))
471      self.addMakeMacro('PETSC_VEC_LIB', self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
472      self.addMakeMacro('PETSC_MAT_LIB', self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscmat','-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
473      self.addMakeMacro('PETSC_DM_LIB',  self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscdm','-lpetscmat','-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
474      self.addMakeMacro('PETSC_KSP_LIB', self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscksp','-lpetscdm','-lpetscmat','-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
475      self.addMakeMacro('PETSC_SNES_LIB',self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscsnes','-lpetscksp','-lpetscdm','-lpetscmat','-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
476      self.addMakeMacro('PETSC_TS_LIB',  self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetscts','-lpetscsnes','-lpetscksp','-lpetscdm','-lpetscmat','-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
477      self.addMakeMacro('PETSC_TAO_LIB', self.libraries.toStringNoDupes(['-L'+LIB_DIR,'-lpetsctao','-lpetscts','-lpetscsnes','-lpetscksp','-lpetscdm','-lpetscmat','-lpetscvec','-lpetscsys']+self.packagelibs+self.complibs))
478    self.addMakeMacro('PETSC_LIB','${PETSC_TAO_LIB}')
479    self.addMakeMacro('PETSC_LIB_BASIC',self.petsclib)
480
481    if not os.path.exists(os.path.join(self.petscdir.dir,self.arch.arch,'lib')):
482      os.makedirs(os.path.join(self.petscdir.dir,self.arch.arch,'lib'))
483
484# add a makefile endtry for display
485    if self.framework.argDB['with-display']:
486      self.addMakeMacro('DISPLAY',self.framework.argDB['with-display'])
487
488    # add a makefile entry for configure options
489    self.addMakeMacro('CONFIGURE_OPTIONS', self.framework.getOptionsString(['configModules', 'optionsModule']).replace('\"','\\"'))
490
491    if self.framework.argDB['with-tau-perfstubs']:
492      self.addDefine('HAVE_TAU_PERFSTUBS',1)
493    return
494
495  def dumpConfigInfo(self):
496    import time
497    fd = open(os.path.join(self.arch.arch,'include','petscconfiginfo.h'),'w')
498    fd.write('static const char *petscconfigureoptions = "'+self.framework.getOptionsString(['configModules', 'optionsModule']).replace('\"','\\"').replace('\\ ','\\\\ ')+'";\n')
499    fd.close()
500    return
501
502  def dumpMachineInfo(self):
503    import platform
504    import datetime
505    import time
506    import script
507    def escape(s):
508      return s.replace('"',r'\"').replace(r'\ ',r'\\ ') # novermin
509    fd = open(os.path.join(self.arch.arch,'include','petscmachineinfo.h'),'w')
510    fd.write('static const char *petscmachineinfo = \"\\n\"\n')
511    fd.write('\"-----------------------------------------\\n\"\n')
512    buildhost = platform.node()
513    if os.environ.get('SOURCE_DATE_EPOCH'):
514      buildhost = "reproducible"
515    buildtime = datetime.datetime.utcfromtimestamp(int(os.environ.get('SOURCE_DATE_EPOCH', time.time())))
516    fd.write('\"Libraries compiled on %s on %s \\n\"\n' % (buildtime, buildhost))
517    fd.write('\"Machine characteristics: %s\\n\"\n' % (platform.platform()))
518    fd.write('\"Using PETSc directory: %s\\n\"\n' % (escape(self.installdir.petscDir)))
519    fd.write('\"Using PETSc arch: %s\\n\"\n' % (escape(self.installdir.petscArch)))
520    fd.write('\"-----------------------------------------\\n\";\n')
521    fd.write('static const char *petsccompilerinfo = \"\\n\"\n')
522    self.setCompilers.pushLanguage(self.languages.clanguage)
523    fd.write('\"Using C compiler: %s %s \\n\"\n' % (escape(self.setCompilers.getCompiler()), escape(self.setCompilers.getCompilerFlags())))
524    self.setCompilers.popLanguage()
525    if hasattr(self.compilers, 'FC'):
526      self.setCompilers.pushLanguage('FC')
527      fd.write('\"Using Fortran compiler: %s %s  %s\\n\"\n' % (escape(self.setCompilers.getCompiler()), escape(self.setCompilers.getCompilerFlags()), escape(self.setCompilers.CPPFLAGS)))
528      self.setCompilers.popLanguage()
529    fd.write('\"-----------------------------------------\\n\";\n')
530    fd.write('static const char *petsccompilerflagsinfo = \"\\n\"\n')
531    fd.write('\"Using include paths: %s\\n\"\n' % (escape(self.PETSC_CC_INCLUDES_INSTALL.replace('${PETSC_DIR}', self.installdir.petscDir))))
532    fd.write('\"-----------------------------------------\\n\";\n')
533    fd.write('static const char *petsclinkerinfo = \"\\n\"\n')
534    self.setCompilers.pushLanguage(self.languages.clanguage)
535    fd.write('\"Using C linker: %s\\n\"\n' % (escape(self.setCompilers.getLinker())))
536    self.setCompilers.popLanguage()
537    if hasattr(self.compilers, 'FC'):
538      self.setCompilers.pushLanguage('FC')
539      fd.write('\"Using Fortran linker: %s\\n\"\n' % (escape(self.setCompilers.getLinker())))
540      self.setCompilers.popLanguage()
541    fd.write('\"Using libraries: %s%s -L%s %s %s\\n\"\n' % (escape(self.setCompilers.CSharedLinkerFlag), escape(os.path.join(self.installdir.petscDir, self.installdir.petscArch, 'lib')), escape(os.path.join(self.installdir.petscDir, self.installdir.petscArch, 'lib')), escape(self.petsclib), escape(self.PETSC_EXTERNAL_LIB_BASIC)))
542    fd.write('\"-----------------------------------------\\n\";\n')
543    fd.close()
544    return
545
546  def configurePrefetch(self):
547    '''Sees if there are any prefetch functions supported'''
548    if config.setCompilers.Configure.isSolaris(self.log) or self.framework.argDB['with-ios'] or not self.framework.argDB['with-prefetch']:
549      self.addDefine('Prefetch(a,b,c)', ' ')
550      return
551    self.pushLanguage(self.languages.clanguage)
552    if self.checkLink('#include <xmmintrin.h>', 'void *v = 0;_mm_prefetch((const char*)v,_MM_HINT_NTA);\n'):
553      # The Intel Intrinsics manual [1] specifies the prototype
554      #
555      #   void _mm_prefetch(char const *a, int sel);
556      #
557      # but other vendors seem to insist on using subtly different
558      # prototypes, including void* for the pointer, and an enum for
559      # sel.  These are both reasonable changes, but negatively impact
560      # portability.
561      #
562      # [1] https://software.intel.com/file/6373
563      self.addDefine('HAVE_XMMINTRIN_H', 1)
564      self.addDefine('Prefetch(a,b,c)', '_mm_prefetch((const char*)(a),(c))')
565      self.addDefine('PREFETCH_HINT_NTA', '_MM_HINT_NTA')
566      self.addDefine('PREFETCH_HINT_T0',  '_MM_HINT_T0')
567      self.addDefine('PREFETCH_HINT_T1',  '_MM_HINT_T1')
568      self.addDefine('PREFETCH_HINT_T2',  '_MM_HINT_T2')
569    elif self.checkLink('#include <xmmintrin.h>', 'void *v = 0;_mm_prefetch(v,_MM_HINT_NTA);\n'):
570      self.addDefine('HAVE_XMMINTRIN_H', 1)
571      self.addDefine('Prefetch(a,b,c)', '_mm_prefetch((const void*)(a),(c))')
572      self.addDefine('PREFETCH_HINT_NTA', '_MM_HINT_NTA')
573      self.addDefine('PREFETCH_HINT_T0',  '_MM_HINT_T0')
574      self.addDefine('PREFETCH_HINT_T1',  '_MM_HINT_T1')
575      self.addDefine('PREFETCH_HINT_T2',  '_MM_HINT_T2')
576    elif self.checkLink('', 'void *v = 0;__builtin_prefetch(v,0,0);\n'):
577      # From GCC docs: void __builtin_prefetch(const void *addr,int rw,int locality)
578      #
579      #   The value of rw is a compile-time constant one or zero; one
580      #   means that the prefetch is preparing for a write to the memory
581      #   address and zero, the default, means that the prefetch is
582      #   preparing for a read. The value locality must be a compile-time
583      #   constant integer between zero and three. A value of zero means
584      #   that the data has no temporal locality, so it need not be left
585      #   in the cache after the access. A value of three means that the
586      #   data has a high degree of temporal locality and should be left
587      #   in all levels of cache possible. Values of one and two mean,
588      #   respectively, a low or moderate degree of temporal locality.
589      #
590      # Here we adopt Intel's x86/x86-64 naming scheme for the locality
591      # hints.  Using macros for these values in necessary since some
592      # compilers require an enum.
593      self.addDefine('Prefetch(a,b,c)', '__builtin_prefetch((a),(b),(c))')
594      self.addDefine('PREFETCH_HINT_NTA', '0')
595      self.addDefine('PREFETCH_HINT_T0',  '3')
596      self.addDefine('PREFETCH_HINT_T1',  '2')
597      self.addDefine('PREFETCH_HINT_T2',  '1')
598    else:
599      self.addDefine('Prefetch(a,b,c)', ' ')
600    self.popLanguage()
601
602  def delGenFiles(self):
603    '''Delete generated files'''
604    delfile = os.path.join(self.arch.arch,'lib','petsc','conf','files')
605    try:
606      os.unlink(delfile)
607    except: pass
608
609  def configureAtoll(self):
610    '''Checks if atoll exists'''
611    if self.checkLink('#define _POSIX_C_SOURCE 200112L\n#include <stdlib.h>','long v = atoll("25");\n(void)v') or self.checkLink ('#include <stdlib.h>','long v = atoll("25");\n(void)v'):
612       self.addDefine('HAVE_ATOLL', '1')
613
614  def configureSanitize(self):
615    '''Checks if fsanitize is supported'''
616    if self.checkLink('#if defined(__has_feature)\n#if !__has_feature(address_sanitizer)\nGarbage\n#endif\n#else\nGarbage\n#endif\n'):
617      self.addDefine('HAVE_SANITIZER', '1')
618
619  def configureUnused(self):
620    '''Sees if __attribute((unused)) is supported'''
621    if self.framework.argDB['with-ios']:
622      self.addDefine('UNUSED', ' ')
623      return
624    self.pushLanguage(self.languages.clanguage)
625    if self.checkLink('__attribute((unused)) static int myfunc(__attribute((unused)) void *name){ return 1;}', 'int i = 0;\nint j = myfunc(&i);\n(void)j;\ntypedef void* atype;\n__attribute((unused))  atype a'):
626      self.addDefine('UNUSED', '__attribute((unused))')
627    else:
628      self.addDefine('UNUSED', ' ')
629    self.popLanguage()
630
631  def configureIsatty(self):
632    '''Check if the Unix C function isatty() works correctly
633       Actually just assumes it does not work correctly on batch systems'''
634    if not self.framework.argDB['with-batch']:
635      self.addDefine('USE_ISATTY',1)
636
637  def configureDeprecated(self):
638    '''Check if __attribute((deprecated)) is supported'''
639    def checkDeprecated(macro_base, src, is_intel):
640      '''
641      run through the various attribute deprecated combinations and define MACRO_BAS(why) to the result
642      it if it compiles.
643
644      If none of the combos work, defines MACRO_BASE(why) as empty
645      '''
646      full_macro_name = macro_base + '(string_literal_why)'
647      for prefix in ('__attribute__', '__attribute','__declspec'):
648        if prefix == '__declspec':
649          # declspec does not have an extra set of brackets around the arguments
650          attr_bodies = ('deprecated(string_literal_why)', 'deprecated')
651        else:
652          attr_bodies = ('(deprecated(string_literal_why))', '(deprecated)')
653
654        for attr_body in attr_bodies:
655          attr_def = '{}({})'.format(prefix, attr_body)
656          test_src = '\n'.join((
657            '#define {} {}'.format(full_macro_name, attr_def),
658            src.format(macro_base + '("asdasdadsasd")')
659          ))
660          if self.checkCompile(test_src, ''):
661            self.logPrint('configureDeprecated: \'{}\' appears to work'.format(attr_def))
662            if is_intel and '(why)' in attr_body:
663              self.logPrint('configureDeprecated: Intel has conspired to make a supremely environment-sensitive compiler. The Intel compiler looks at the gcc executable in the environment to determine the language compatibility that it should attempt to emulate. Some important Cray installations have built PETSc using the Intel compiler, but with a newer gcc module loaded (e.g. 4.7). Thus at PETSc configure time, the Intel compiler decides to support the string argument, but the gcc found in the default user environment is older and does not support the argument.\n'.format(attr_def))
664              self.logPrint('*** WE WILL THEREFORE REJECT \'{}\' AND CONTINUE TESTING ***'.format(attr_def))
665              continue
666            self.addDefine(full_macro_name, attr_def)
667            return
668
669      self.addDefine(full_macro_name, ' ')
670      return
671
672    lang = self.languages.clanguage
673    with self.Language(lang):
674      is_intel = self.setCompilers.isIntel(self.getCompiler(lang=lang), self.log)
675      checkDeprecated('DEPRECATED_FUNCTION_BASE', '{} int myfunc(void) {{ return 1; }}', is_intel)
676      checkDeprecated('DEPRECATED_TYPEDEF_BASE', 'typedef int my_int {};', is_intel)
677      checkDeprecated('DEPRECATED_ENUM_BASE', 'enum E {{ oldval {}, newval }};', is_intel)
678      checkDeprecated('DEPRECATED_OBJECT_BASE', '{} int x;', is_intel)
679      # I was unable to make a CPP macro that takes the old and new values as separate
680      # arguments and builds the message needed by _Pragma hence the deprecation message is
681      # handled as it is
682      if self.checkCompile('#define TEST _Pragma("GCC warning \"Testing _Pragma\"") value'):
683        self.addDefine('DEPRECATED_MACRO_BASE_(why)', '_Pragma(#why)')
684        self.addDefine('DEPRECATED_MACRO_BASE(string_literal_why)', self.substPrefix + '_DEPRECATED_MACRO_BASE_(GCC warning string_literal_why)')
685      else:
686        self.addDefine('DEPRECATED_MACRO_BASE(why)', ' ')
687
688  def configureAlign(self):
689    '''Check if __attribute(aligned) is supported'''
690    code = '''\
691struct mystruct {int myint;} __attribute((aligned(16)));
692char assert_aligned[(sizeof(struct mystruct)==16)*2-1];
693'''
694    self.pushLanguage(self.languages.clanguage)
695    if self.checkCompile(code):
696      self.addDefine('ATTRIBUTEALIGNED(size)', '__attribute((aligned(size)))')
697      self.addDefine('HAVE_ATTRIBUTEALIGNED', 1)
698    else:
699      self.framework.logPrint('Incorrect attribute(aligned)')
700      self.addDefine('ATTRIBUTEALIGNED(size)', ' ')
701    self.popLanguage()
702    return
703
704  def configureExpect(self):
705    '''Sees if the __builtin_expect directive is supported'''
706    self.pushLanguage(self.languages.clanguage)
707    if self.checkLink('', 'if (__builtin_expect(0,1)) return 1;'):
708      self.addDefine('HAVE_BUILTIN_EXPECT', 1)
709    self.popLanguage()
710
711  def configureFunctionName(self):
712    '''Sees if the compiler supports __func__ or a variant.'''
713    def getFunctionName(lang):
714      name = '"unknown"'
715      self.pushLanguage(lang)
716      for fname in ['__func__','__FUNCTION__','__extension__ __func__']:
717        code = "if ("+fname+"[0] != 'm') return 1;"
718        if self.checkCompile('',code) and self.checkLink('',code):
719          name = fname
720          break
721      self.popLanguage()
722      return name
723    langs = []
724
725    self.addDefine('FUNCTION_NAME_C', getFunctionName('C'))
726    if hasattr(self.compilers, 'CXX'):
727      self.addDefine('FUNCTION_NAME_CXX', getFunctionName('Cxx'))
728
729  def configureIntptrt(self):
730    '''Determine what to use for uintptr_t and intptr_t'''
731    def staticAssertSizeMatchesVoidStar(inc,typename):
732      # The declaration is an error if either array size is negative.
733      # It should be okay to use an int that is too large, but it would be very unlikely for this to be the case
734      return self.checkCompile(inc, ('#define STATIC_ASSERT(cond) char negative_length_if_false[2*(!!(cond))-1]\n'
735                                     + 'STATIC_ASSERT(sizeof(void*) == sizeof(%s));'%typename))
736
737    def generate_uintptr_guesses():
738      for suff in ('max', '64', '32', '16'):
739        yield '#include <stdint.h>', 'uint{}_t'.format(suff), 'PRIx{}'.format(suff.upper())
740      yield '#include <stdlib.h>\n#include <string.h>', 'size_t', 'zx'
741      yield '', 'unsigned long long', 'llx'
742      yield '', 'unsigned long', 'lx'
743      yield '', 'unsigned', 'x'
744
745    def generate_intptr_guesses():
746      for suff in ('max', '64', '32', '16'):
747        yield '#include <stdint.h>', 'int{}_t'.format(suff), 'PRIx{}'.format(suff.upper())
748      yield '', 'long long', 'llx'
749      yield '', 'long', 'lx'
750      yield '', 'int', 'x'
751
752    def check(default_typename, generator):
753      macro_name = default_typename.upper()
754      with self.Language(self.languages.clanguage):
755        if self.checkCompile(
756            '#include <stdint.h>',
757            'int x; {type_name} i = ({type_name})&x; (void)i'.format(type_name=default_typename)
758        ):
759          typename     = default_typename
760          print_format = 'PRIxPTR'
761        else:
762          for include, typename, print_format in generator():
763            if staticAssertSizeMatchesVoidStar(include, typename):
764              break
765          else:
766            raise RuntimeError('Could not find any {} type matching void*'.format(macro_name))
767      self.addDefine(macro_name         , typename)
768      self.addDefine(macro_name + '_FMT', '\"#\" ' + print_format)
769      return
770
771    check('uintptr_t', generate_uintptr_guesses)
772    check('intptr_t', generate_intptr_guesses)
773    return
774
775  def configureRTLDDefault(self):
776    '''Check for dynamic library feature'''
777    if self.checkCompile('#include <dlfcn.h>\n void *ptr =  RTLD_DEFAULT;'):
778      self.addDefine('HAVE_RTLD_DEFAULT','1')
779    return
780
781  def configureSolaris(self):
782    '''Solaris specific stuff'''
783    if os.path.isdir(os.path.join('/usr','ucblib')):
784      try:
785        flag = getattr(self.setCompilers, self.language[-1]+'SharedLinkerFlag')
786      except AttributeError:
787        flag = None
788      if flag is None:
789        self.compilers.LIBS += ' -L/usr/ucblib'
790      else:
791        self.compilers.LIBS += ' '+flag+'/usr/ucblib'
792    return
793
794  def configureDarwin(self):
795    '''Log brew configuration for Apple systems'''
796    try:
797      self.executeShellCommand(['brew', 'config'], log = self.log)
798      self.executeShellCommand(['brew', 'info', 'gcc'], log = self.log)
799    except:
800      pass
801    return
802
803  def configureLinux(self):
804    '''Linux specific stuff'''
805    # TODO: Test for this by mallocing an odd number of floats and checking the address
806    self.addDefine('HAVE_DOUBLE_ALIGN_MALLOC', 1)
807    return
808
809  def configureWin32(self):
810    '''Win32 non-cygwin specific stuff'''
811    kernel32=0
812    if self.libraries.add('Kernel32.lib','GetComputerName',prototype='#include <windows.h>', call='GetComputerName(NULL,NULL);'):
813      self.addDefine('HAVE_WINDOWS_H',1)
814      self.addDefine('HAVE_GETCOMPUTERNAME',1)
815      kernel32=1
816    elif self.libraries.add('kernel32','GetComputerName',prototype='#include <windows.h>', call='GetComputerName(NULL,NULL);'):
817      self.addDefine('HAVE_WINDOWS_H',1)
818      self.addDefine('HAVE_GETCOMPUTERNAME',1)
819      kernel32=1
820    if kernel32:
821      if self.framework.argDB['with-windows-graphics']:
822        self.addDefine('USE_WINDOWS_GRAPHICS',1)
823      if self.checkLink('#include <windows.h>','LoadLibrary(0)'):
824        self.addDefine('HAVE_LOADLIBRARY',1)
825      if self.checkLink('#include <windows.h>','GetProcAddress(0,0)'):
826        self.addDefine('HAVE_GETPROCADDRESS',1)
827      if self.checkLink('#include <windows.h>','FreeLibrary(0)'):
828        self.addDefine('HAVE_FREELIBRARY',1)
829      if self.checkLink('#include <windows.h>','GetLastError()'):
830        self.addDefine('HAVE_GETLASTERROR',1)
831      if self.checkLink('#include <windows.h>','SetLastError(0)'):
832        self.addDefine('HAVE_SETLASTERROR',1)
833      if self.checkLink('#include <windows.h>\n','QueryPerformanceCounter(0);\n'):
834        self.addDefine('USE_MICROSOFT_TIME',1)
835    if self.libraries.add('Advapi32.lib','GetUserName',prototype='#include <windows.h>', call='GetUserName(NULL,NULL);'):
836      self.addDefine('HAVE_GET_USER_NAME',1)
837    elif self.libraries.add('advapi32','GetUserName',prototype='#include <windows.h>', call='GetUserName(NULL,NULL);'):
838      self.addDefine('HAVE_GET_USER_NAME',1)
839
840    if not self.libraries.add('User32.lib','GetDC',prototype='#include <windows.h>',call='GetDC(0);'):
841      self.libraries.add('user32','GetDC',prototype='#include <windows.h>',call='GetDC(0);')
842    if not self.libraries.add('Gdi32.lib','CreateCompatibleDC',prototype='#include <windows.h>',call='CreateCompatibleDC(0);'):
843      self.libraries.add('gdi32','CreateCompatibleDC',prototype='#include <windows.h>',call='CreateCompatibleDC(0);')
844
845    if not self.checkCompile('#include <sys/types.h>\n','uid_t u;\n(void)u'):
846      self.addTypedef('int', 'uid_t')
847      self.addTypedef('int', 'gid_t')
848    if not self.checkLink('#if defined(PETSC_HAVE_UNISTD_H)\n#include <unistd.h>\n#endif\n','int a=R_OK;\n(void)a'):
849      self.framework.addDefine('R_OK', '04')
850      self.framework.addDefine('W_OK', '02')
851      self.framework.addDefine('X_OK', '01')
852    if not self.checkLink('#include <sys/stat.h>\n','int a=0;\nif (S_ISDIR(a)){}\n'):
853      self.framework.addDefine('S_ISREG(a)', '(((a)&_S_IFMT) == _S_IFREG)')
854      self.framework.addDefine('S_ISDIR(a)', '(((a)&_S_IFMT) == _S_IFDIR)')
855    if self.checkCompile('#include <windows.h>\n','LARGE_INTEGER a;\nDWORD b=a.u.HighPart;\n'):
856      self.addDefine('HAVE_LARGE_INTEGER_U',1)
857
858    # Windows requires a Binary file creation flag when creating/opening binary files.  Is a better test in order?
859    if self.checkCompile('#include <windows.h>\n#include <fcntl.h>\n', 'int flags = O_BINARY;'):
860      self.addDefine('HAVE_O_BINARY',1)
861
862    if self.compilers.CC.find('win32fe') >= 0:
863      self.addDefine('HAVE_WINDOWS_COMPILERS',1)
864      self.addDefine('DIR_SEPARATOR','\'\\\\\'')
865      self.addDefine('REPLACE_DIR_SEPARATOR','\'/\'')
866      self.addDefine('CANNOT_START_DEBUGGER',1)
867      (petscdir,error,status) = self.executeShellCommand('cygpath -w '+self.installdir.petscDir, log = self.log)
868      self.addDefine('DIR','"'+petscdir.replace('\\','\\\\')+'"')
869      (petscdir,error,status) = self.executeShellCommand('cygpath -m '+self.installdir.petscDir, log = self.log)
870      self.addMakeMacro('wPETSC_DIR',petscdir)
871      if self.dataFilesPath.datafilespath:
872        (datafilespath,error,status) = self.executeShellCommand('cygpath -m '+self.dataFilesPath.datafilespath, log = self.log)
873        self.addMakeMacro('DATAFILESPATH',datafilespath)
874
875    else:
876      self.addDefine('REPLACE_DIR_SEPARATOR','\'\\\\\'')
877      self.addDefine('DIR_SEPARATOR','\'/\'')
878      self.addDefine('DIR','"'+self.installdir.petscDir+'"')
879      self.addMakeMacro('wPETSC_DIR',self.installdir.petscDir)
880      if self.dataFilesPath.datafilespath:
881        self.addMakeMacro('DATAFILESPATH',self.dataFilesPath.datafilespath)
882    self.addDefine('ARCH','"'+self.installdir.petscArch+'"')
883    return
884
885  def configureCoverageForLang(self, log_printer_cls, lang, extra_coverage_flags=None, extra_debug_flags=None):
886    """
887    Check that a compiler accepts code-coverage flags. If the compiler does accept code-coverage flags
888    try to set debugging flags equivalent to -Og.
889
890    Arguments:
891    - lang: the language to check the coverage flag for
892    - extra_coverage_flags: a list of extra flags to use when checking the coverage flags
893    - extra_debug_flags: a list of extra flags to try when setting debug flags
894
895    On success:
896    - defines PETSC_USE_COVERAGE to 1
897    """
898    log_print = log_printer_cls(self)
899
900    def quoted(string):
901      return string.join(("'", "'"))
902
903    def make_flag_list(default, extra):
904      ret = [default]
905      if extra is not None:
906        assert isinstance(extra, list)
907        ret.extend(extra)
908      return ret
909
910    log_print('Checking coverage flag for language {}'.format(lang))
911
912    compiler = self.getCompiler(lang=lang)
913    if self.setCompilers.isGNU(compiler, self.log):
914      is_gnuish = True
915    elif self.setCompilers.isClang(compiler, self.log):
916      is_gnuish = True
917    else:
918      is_gnuish = False
919
920    # if not gnuish and we don't have a set of extra flags, bail
921    if not is_gnuish and extra_coverage_flags is None:
922      log_print('Don\'t know how to add coverage for compiler {}. Only know how to add coverage for gnu-like compilers (either gcc or clang). Skipping it!'.format(quoted(compiler)))
923      return
924
925    coverage_flags = make_flag_list('--coverage', extra_coverage_flags)
926    log_print('Checking set of coverage flags: {}'.format(coverage_flags))
927
928    found = None
929    with self.Language(lang):
930      with self.setCompilers.Language(lang):
931        for flag in coverage_flags:
932          # the linker also needs to see the coverage flag
933          with self.setCompilers.extraCompilerFlags([flag], compilerOnly=False) as skip_flags:
934            if not skip_flags and self.checkRun():
935              # flag was accepted
936              found = flag
937              break
938
939          log_print(
940            'Compiler {} did not accept coverage flag {}'.format(quoted(compiler), quoted(flag))
941          )
942
943        if found is None:
944          log_print(
945            'Compiler {} did not accept ANY coverage flags: {}, bailing!'.format(
946              quoted(compiler), coverage_flags
947            )
948          )
949          return
950
951        # must do this exactly here since:
952        #
953        # 1. setCompilers.extraCompilerFlags() will reset the compiler flags on __exit__()
954        #    (so cannot do it in the loop)
955        # 2. we need to set the compiler flag while setCompilers.Language() is still in
956        #    effect (so cannot do it outside the with statements)
957        self.setCompilers.insertCompilerFlag(flag, False)
958
959    if not self.functions.haveFunction('__gcov_dump'):
960      self.functions.checkClassify(['__gcov_dump'])
961
962    # now check if we can override the optimization level. It is only kosher to do so if
963    # the user did not explicitly set the optimization flags (via CFLAGS, CXXFLAGS,
964    # CXXOPTFLAGS, etc). If they have done so, we sternly warn them about their lapse in
965    # judgement
966    with self.Language(lang):
967      compiler_flags = self.getCompilerFlags()
968
969    user_set          = 0
970    allowed_opt_flags = re.compile(r'|'.join((r'-O[01g]', r'-g[1-9]*')))
971    for flagsname in [self.getCompilerFlagsName(lang), self.compilerFlags.getOptionalFlagsName(lang)]:
972      if flagsname in self.argDB:
973        opt_flags = [
974          f for f in self.compilerFlags.findOptFlags(compiler_flags) if not allowed_opt_flags.match(f)
975        ]
976        if opt_flags:
977          self.logPrintWarning('Coverage requested, but optimization flag(s) {} found in {}. Coverage collection will work, but may be less accurate. Suggest removing the flag and/or using -Og (or equivalent) instead'.format(', '.join(map(quoted, opt_flags)), quoted(flagsname)))
978          user_set = 1
979          break
980
981    # disable this for now, the warning should be sufficient. If the user still chooses to
982    # ignore it, then that's on them
983    if 0 and not user_set:
984      debug_flags = make_flag_list('-Og', extra_debug_flags)
985      with self.setCompilers.Language(lang):
986        for flag in debug_flags:
987          try:
988            self.setCompilers.addCompilerFlag(flag)
989          except RuntimeError:
990            continue
991          break
992
993    self.addDefine('USE_COVERAGE', 1)
994    return
995
996  def configureCoverage(self):
997    """
998    Configure coverage for all available languages.
999
1000    If user did not request coverage, this function does nothing and returns immediatel.
1001    Therefore the following only apply to the case where the user requested coverage.
1002
1003    On success:
1004    - defines PETSC_USE_COVERAGE to 1
1005
1006    On failure:
1007    - If no compilers supported the coverage flag, throws RuntimeError
1008    -
1009    """
1010    class LogPrinter:
1011      def __init__(self, cfg):
1012        self.cfg = cfg
1013        try:
1014          import inspect
1015
1016          calling_func_stack = inspect.stack()[1]
1017          if sys.version_info >= (3, 5):
1018            func_name = calling_func_stack.function
1019          else:
1020            func_name = calling_func_stack[3]
1021        except:
1022          func_name = 'Unknown'
1023        self.fmt_str = func_name + '(): {}'
1024
1025      def __call__(self, msg, *args, **kwargs):
1026        return self.cfg.logPrint(self.fmt_str.format(msg), *args, **kwargs)
1027
1028    argdb_flag = 'with-coverage'
1029    log_print  = LogPrinter(self)
1030    if not self.argDB[argdb_flag]:
1031      log_print('coverage was disabled from command line or default')
1032      return
1033
1034    tested_langs = []
1035    for LANG in ['C', 'Cxx', 'CUDA', 'HIP', 'SYCL', 'FC']:
1036      compilerName = LANG.upper() if LANG in {'Cxx', 'FC'} else LANG + 'C'
1037      if hasattr(self.setCompilers, compilerName):
1038        kwargs = {}
1039        if LANG in {'CUDA'}:
1040          # nvcc preprocesses the base file into a bunch of intermediate files, which are
1041          # then compiled by the host compiler. Why is this a problem?  Because the
1042          # generated coverage data is based on these preprocessed source files! So gcov
1043          # tries to read it later, but since its in the tmp directory it cannot. Thus we
1044          # need to keep them around (in a place we know about).
1045          nvcc_tmp_dir = os.path.join(self.petscdir.dir, self.arch.arch, 'nvcc_tmp')
1046          try:
1047            os.mkdir(nvcc_tmp_dir)
1048          except FileExistsError:
1049            pass
1050          kwargs['extra_coverage_flags'] = [
1051            '-Xcompiler --coverage -Xcompiler -fPIC --keep --keep-dir={}'.format(nvcc_tmp_dir)
1052          ]
1053          if self.kokkos.found:
1054            # yet again the kokkos nvcc_wrapper goes out of its way to be as useless as
1055            # possible. Its default arch (sm_35) is actually too low to compile kokkos,
1056            # for whatever reason this works if you dont use the --keep and --keep-dir
1057            # flags above.
1058            kwargs['extra_coverage_flags'].append('-arch=native')
1059            kwargs['extra_debug_flags'] = ['-Xcompiler -Og']
1060        tested_langs.append(LANG)
1061        self.executeTest(self.configureCoverageForLang, args=[LogPrinter, LANG], kargs=kwargs)
1062
1063    if not self.defines.get('USE_COVERAGE'):
1064      # coverage was requested but no compilers accepted it, this is an error
1065      raise RuntimeError(
1066        'Coverage was requested (--{}={}) but none of the compilers supported it:\n{}\n'.format(
1067          argdb_flag, self.argDB[argdb_flag],
1068          '\n'.join(['  - {} ({})'.format(self.getCompiler(lang=lang), lang) for lang in tested_langs])
1069        )
1070      )
1071
1072    return
1073    # Disabled for now, since this does not really work. It solves the problem of
1074    # "undefined reference to __gcov_flush()" but if we add -lgcov we get:
1075    #
1076    # duplicate symbol '___gcov_reset' in:
1077    #     /Library/.../libclang_rt.profile_osx.a(GCDAProfiling.c.o)
1078    #     /opt/.../libgcov.a(_gcov_reset.o)
1079    # duplicate symbol '___gcov_dump' in:
1080    #     /opt/.../libgcov.a(_gcov_dump.o)
1081    #     /Library/.../libclang_rt.profile_osx.a(GCDAProfiling.c.o)
1082    # duplicate symbol '___gcov_fork' in:
1083    #     /opt/.../libgcov.a(_gcov_fork.o)
1084    #     /Library/.../libclang_rt.profile_osx.a(GCDAProfiling.c.o)
1085    #
1086    # I don't know how to solve this.
1087
1088    log_print('Checking if compilers can cross-link disparate coverage libraries')
1089    # At least one of the compilers has coverage enabled. Now need to make sure multiple
1090    # code coverage impls work together, specifically when using clang C/C++ compiler with
1091    # gfortran.
1092    if not hasattr(self.setCompilers, 'FC'):
1093      log_print('No fortran compiler detected. No need to check cross-linking!')
1094      return
1095
1096    c_lang = self.languages.clanguage
1097    if not self.setCompilers.isClang(self.getCompiler(lang=c_lang), self.log):
1098      # must be GCC
1099      log_print('C-language ({}) compiler is not clang, assuming it is GCC, so cross-linking with FC ({}) assumed to be OK'.format(c_lang, self.getCompiler(lang='FC')))
1100      return
1101
1102    # If we are here we:
1103    #   1. Have both C/C++ compiler and fortran compiler
1104    #   2. The C/C++ compiler is *not* the same as the fortran compiler (unless we start
1105    #      using flang)
1106    #
1107    # Now we check if we can cross-link
1108    def can_cross_link(**kwargs):
1109      f_body = "      subroutine foo()\n      print*,'testing'\n      return\n      end\n"
1110      c_body = "int main() { }"
1111
1112      return self.compilers.checkCrossLink(
1113        f_body, c_body, language1='FC', language2=c_lang, extralibs=self.compilers.flibs, **kwargs
1114      )
1115
1116    log_print('Trying to cross-link WITHOUT extra libs')
1117    if can_cross_link():
1118      log_print('Successfully cross-linked WITHOUT extra libs')
1119      # success, we already can cross-link
1120      return
1121
1122    extra_libs = ['-lgcov']
1123    log_print('Trying to cross-link with extra libs: {}'.format(extra_libs))
1124    if can_cross_link(extraObjs=extra_libs):
1125      log_print(
1126        'Successfully cross-linked using extra libs: {}, adding them to LIBS'.format(extra_libs)
1127      )
1128      self.setCompilers.LIBS += ' ' + ' '.join(extra_libs)
1129    else:
1130      # maybe should be an error?
1131      self.logPrintWarning("Could not successfully cross-link covered code between {} and FC. Sometimes this is a false positive. Assuming this does eventually end up working when the full link-line is assembled when building PETSc. If you later encounter linker errors about missing __gcov_exit(), __gcov_init(), __llvm_cov_flush() etc. this is why!".format(c_lang))
1132    return
1133
1134  def configureCoverageExecutable(self):
1135    """
1136    Check that a code-coverage collecting tool exists and is on PATH.
1137
1138    On success:
1139    - Adds PETSC_COVERAGE_EXEC make macro containing the full path to the coverage tool executable.
1140
1141    Raises RuntimeError if:
1142    - User explicitly requests auto-detection of the coverage tool from command line, and this
1143      routine fails to guess the suitable tool name.
1144    - The routine fails to find the tool, and --with-coverage is true
1145    """
1146    def log_print(msg, *args, **kwargs):
1147      self.logPrint('checkCoverage: '+str(msg), *args, **kwargs)
1148      return
1149
1150    def quoted(string):
1151      return string.join(("'", "'"))
1152
1153    required         = bool(self.argDB['with-coverage'])
1154    arg_opt          = self.argDB['with-coverage-exec']
1155    use_default_path = True
1156    search_path      = ''
1157
1158    log_print('{} to find an executable'.format('REQUIRED' if required else 'NOT required'))
1159    if arg_opt in {'auto', 'default-auto', '1'}:
1160      # detect it based on the C language compiler, hopefully this does not clash!
1161      lang     = self.setCompilers.languages.clanguage
1162      compiler = self.getCompiler(lang=lang)
1163      log_print('User did not explicitly set coverage exec (got {}), trying to auto-detect based on compiler {}'.format(quoted(arg_opt), quoted(compiler)))
1164      if self.setCompilers.isGNU(compiler, self.log):
1165        compiler_version_re = re.compile(r'[gG][cC\+\-]+[0-9]* \(.+\) (\d+)\.(\d+)\.(\d+)')
1166        exec_names          = ['gcov']
1167      elif self.setCompilers.isClang(compiler, self.log):
1168        compiler_version_re = re.compile(r'clang version (\d+)\.(\d+)\.(\d+)')
1169        exec_names          = ['llvm-cov']
1170        if self.setCompilers.isDarwin(self.log):
1171          # macOS masquerades llvm-cov as just 'gcov', so we add this to the list in case
1172          # bare llvm-cov does not work
1173          exec_names.append('gcov')
1174      elif arg_opt == 'default-auto' and not required:
1175        # default-auto implies the user did not set it via command line!
1176        log_print('Could not auto-detect coverage tool for {}, not a gnuish compiler. Bailing since user did not explicitly set exec on the commandline'.format(quoted(compiler)))
1177        return
1178      else:
1179        # implies 'auto' explicitly set by user, or we were required to find
1180        # something. either way we should error
1181        raise RuntimeError('Could not auto-detect coverage tool for {}, please set coverage tool name explicitly'.format(quoted(compiler)))
1182
1183      try:
1184        compiler_version_str = self.compilerFlags.version[lang]
1185      except KeyError:
1186        compiler_version_str = 'Unknown'
1187
1188      log_print('Searching version string {} (for compiler {}) using pattern {}'.format(quoted(compiler_version_str), quoted(compiler), quoted(compiler_version_re.pattern)))
1189      compiler_version = compiler_version_re.search(compiler_version_str)
1190      if compiler_version is not None:
1191        log_print('Found major = {}, minor = {}, patch = {}'.format(compiler_version.group(1), compiler_version.group(2), compiler_version.group(3)))
1192        # form [llvm-cov-14, llvm-cov-14.0, llvm-cov, etc.]
1193        cov_exec_name = exec_names[0]
1194        exec_names    = [
1195          # llvm-cov-14
1196          '{}-{}'.format(cov_exec_name, compiler_version.group(1)),
1197           # llvm-cov-14.0
1198          '{}-{}.{}'.format(cov_exec_name, compiler_version.group(1), compiler_version.group(2))
1199        ] + exec_names
1200    else:
1201      log_print('User explicitly set coverage exec as {}'.format(quoted(arg_opt)))
1202      par_dir = os.path.dirname(arg_opt)
1203      if os.path.exists(par_dir):
1204        # arg_opt is path-like, we should only search the provided directory when we go
1205        # looking for the tool
1206        use_default_path = False
1207        search_path      = par_dir
1208      exec_names = [arg_opt]
1209
1210    make_macro_name = 'PETSC_COVERAGE_EXEC'
1211    log_print('Checking for coverage tool(s):\n{}'.format('\n'.join('- '+t for t in exec_names)))
1212    found_exec = self.getExecutables(
1213      exec_names,
1214      path=search_path, getFullPath=True, useDefaultPath=use_default_path, resultName=make_macro_name
1215    )
1216
1217    if found_exec is None:
1218      # didn't find the coverage tool
1219      if required:
1220        raise RuntimeError('Coverage tool(s) {} could not be found. Please provide explicit path to coverage tool'.format(exec_names))
1221      return
1222
1223    found_exec_name = os.path.basename(found_exec)
1224    if 'llvm-cov' in found_exec_name and 'gcov' not in found_exec_name:
1225      # llvm-cov needs to be called as 'llvm-cov gcov' to work
1226      self.addMakeMacro(make_macro_name, found_exec + ' gcov')
1227    return
1228
1229  def configureStrictPetscErrorCode(self):
1230    """
1231    Enables or disables strict PetscErrorCode checking.
1232
1233    If --with-strict-petscerrorcode = 1:
1234    - defines PETSC_USE_STRICT_PETSCERRORCODE to 1
1235
1236    Else:
1237    - deletes any prior PETSC_USE_STRICT_PETSCERRORCODE definitions (if they exist)
1238    """
1239    define_name = 'USE_STRICT_PETSCERRORCODE'
1240    if self.argDB['with-strict-petscerrorcode']:
1241      self.addDefine(define_name, 1)
1242    else:
1243      # in case it was somehow added previously
1244      self.delDefine(define_name)
1245    return
1246
1247#-----------------------------------------------------------------------------------------------------
1248  def configureCygwinBrokenPipe(self):
1249    '''Cygwin version <= 1.7.18 had issues with pipes and long commands invoked from gnu-make
1250    http://cygwin.com/ml/cygwin/2013-05/msg00340.html '''
1251    if config.setCompilers.Configure.isCygwin(self.log):
1252      import platform
1253      import re
1254      r=re.compile("([0-9]+).([0-9]+).([0-9]+)")
1255      m=r.match(platform.release())
1256      major=int(m.group(1))
1257      minor=int(m.group(2))
1258      subminor=int(m.group(3))
1259      if ((major < 1) or (major == 1 and minor < 7) or (major == 1 and minor == 7 and subminor <= 18)):
1260        self.addMakeMacro('PETSC_CYGWIN_BROKEN_PIPE','1')
1261    return
1262
1263#-----------------------------------------------------------------------------------------------------
1264  def configureDefaultArch(self):
1265    conffile = os.path.join('lib','petsc','conf', 'petscvariables')
1266    if self.framework.argDB['with-default-arch']:
1267      fd = open(conffile, 'w')
1268      fd.write('PETSC_ARCH='+self.arch.arch+'\n')
1269      fd.write('PETSC_DIR='+self.petscdir.dir+'\n')
1270      fd.write('include '+os.path.join('$(PETSC_DIR)','$(PETSC_ARCH)','lib','petsc','conf','petscvariables')+'\n')
1271      fd.close()
1272      self.framework.actions.addArgument('PETSc', 'Build', 'Set default architecture to '+self.arch.arch+' in '+conffile)
1273    elif os.path.isfile(conffile):
1274      try:
1275        os.unlink(conffile)
1276      except:
1277        raise RuntimeError('Unable to remove file '+conffile+'. Did a different user create it?')
1278    return
1279
1280#-----------------------------------------------------------------------------------------------------
1281  def configureScript(self):
1282    '''Output a script in the conf directory which will reproduce the configuration'''
1283    import nargs
1284    import sys
1285    scriptName = os.path.join(self.arch.arch,'lib','petsc','conf', 'reconfigure-'+self.arch.arch+'.py')
1286    args = dict([(nargs.Arg.parseArgument(arg)[0], arg) for arg in self.framework.clArgs])
1287    if 'with-clean' in args:
1288      del args['with-clean']
1289    if 'force' in args:
1290      del args['force']
1291    if 'configModules' in args:
1292      if nargs.Arg.parseArgument(args['configModules'])[1] == 'PETSc.Configure':
1293        del args['configModules']
1294    if 'optionsModule' in args:
1295      if nargs.Arg.parseArgument(args['optionsModule'])[1] == 'config.compilerOptions':
1296        del args['optionsModule']
1297    if not 'PETSC_ARCH' in args:
1298      args['PETSC_ARCH'] = 'PETSC_ARCH='+str(self.arch.arch)
1299    f = open(scriptName, 'w')
1300    f.write('#!'+sys.executable+'\n')
1301    f.write('if __name__ == \'__main__\':\n')
1302    f.write('  import sys\n')
1303    f.write('  import os\n')
1304    f.write('  sys.path.insert(0, os.path.abspath(\'config\'))\n')
1305    f.write('  import configure\n')
1306    # pretty print repr(args.values())
1307    f.write('  configure_options = [\n')
1308    for itm in sorted(args.values()):
1309      f.write('    \''+str(itm)+'\',\n')
1310    f.write('  ]\n')
1311    f.write('  configure.petsc_configure(configure_options)\n')
1312    f.close()
1313    try:
1314      os.chmod(scriptName, 0o775)
1315    except OSError as e:
1316      self.framework.logPrint('Unable to make reconfigure script executable:\n'+str(e))
1317    self.framework.actions.addArgument('PETSc', 'File creation', 'Created '+scriptName+' for automatic reconfiguration')
1318    return
1319
1320  def configureInstall(self):
1321    '''Setup the directories for installation'''
1322    if self.framework.argDB['prefix']:
1323      self.addMakeRule('print_mesg_after_build','',
1324       ['-@echo "========================================="',
1325        '-@echo "Now to install the libraries do:"',
1326        '-@echo "%s${MAKE_USER} PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} install"' % self.installdir.installSudo,
1327        '-@echo "========================================="'])
1328    else:
1329      self.addMakeRule('print_mesg_after_build','',
1330       ['-@echo "========================================="',
1331        '-@echo "Now to check if the libraries are working do:"',
1332        '-@echo "${MAKE_USER} PETSC_DIR=${PETSC_DIR} PETSC_ARCH=${PETSC_ARCH} check"',
1333        '-@echo "========================================="'])
1334      return
1335
1336  def postProcessPackages(self):
1337    postPackages=[]
1338    for i in self.framework.packages:
1339      if hasattr(i,'postProcess'): postPackages.append(i)
1340    if postPackages:
1341      # ctetgen needs petsc conf files. so attempt to create them early
1342      self.framework.dumpConfFiles()
1343      # tacky fix for dependency of Aluimia on Pflotran; requested via petsc-dev Matt provide a correct fix
1344      for i in postPackages:
1345        if i.name.upper() in ['PFLOTRAN']:
1346          i.postProcess()
1347          postPackages.remove(i)
1348      for i in postPackages: i.postProcess()
1349      for i in postPackages:
1350        if i.installedpetsc:
1351          self.installed = 1
1352          break
1353    return
1354
1355  def configure(self):
1356    if 'package-prefix-hash' in self.argDB:
1357      # turn off prefix if it was only used to for installing external packages.
1358      self.framework.argDB['prefix'] = ''
1359      self.dir = os.path.abspath(os.path.join(self.petscdir.dir, self.arch.arch))
1360      self.installdir.dir = self.dir
1361      self.installdir.petscDir = self.petscdir.dir
1362      self.petscDir = self.petscdir.dir
1363      self.petscArch = self.arch.arch
1364      self.addMakeMacro('PREFIXDIR',self.dir)
1365      self.confDir = os.path.abspath(os.path.join(self.petscdir.dir, self.arch.arch))
1366
1367    if not os.path.samefile(self.petscdir.dir, os.getcwd()):
1368      raise RuntimeError('Wrong PETSC_DIR option specified: '+str(self.petscdir.dir) + '\n  Configure invoked in: '+os.path.realpath(os.getcwd()))
1369    if self.framework.argDB['prefix'] and os.path.isdir(self.framework.argDB['prefix']) and os.path.samefile(self.framework.argDB['prefix'],self.petscdir.dir):
1370      raise RuntimeError('Incorrect option --prefix='+self.framework.argDB['prefix']+' specified. It cannot be same as PETSC_DIR!')
1371    if self.framework.argDB['prefix'] and self.framework.argDB['prefix'].find(' ') > -1:
1372      raise RuntimeError('Your --prefix '+self.framework.argDB['prefix']+' has spaces in it; this is not allowed.\n Use a --prefix that does not have spaces in it')
1373    if self.framework.argDB['prefix'] and os.path.isdir(self.framework.argDB['prefix']) and os.path.samefile(self.framework.argDB['prefix'],os.path.join(self.petscdir.dir,self.arch.arch)):
1374      raise RuntimeError('Incorrect option --prefix='+self.framework.argDB['prefix']+' specified. It cannot be same as PETSC_DIR/PETSC_ARCH!')
1375    self.framework.header          = os.path.join(self.arch.arch,'include','petscconf.h')
1376    self.framework.cHeader         = os.path.join(self.arch.arch,'include','petscfix.h')
1377    self.framework.poisonheader    = os.path.join(self.arch.arch,'include','petscconf_poison.h')
1378    self.framework.pkgheader       = os.path.join(self.arch.arch,'include','petscpkg_version.h')
1379    self.framework.makeMacroHeader = os.path.join(self.arch.arch,'lib','petsc','conf','petscvariables')
1380    self.framework.makeRuleHeader  = os.path.join(self.arch.arch,'lib','petsc','conf','petscrules')
1381    if self.libraries.math is None:
1382      raise RuntimeError('PETSc requires a functional math library. Please send configure.log to petsc-maint@mcs.anl.gov.')
1383    if self.languages.clanguage == 'Cxx' and not hasattr(self.compilers, 'CXX'):
1384      raise RuntimeError('Cannot set C language to C++ without a functional C++ compiler.')
1385    self.executeTest(self.configureRTLDDefault)
1386    self.executeTest(self.configurePrefetch)
1387    self.executeTest(self.configureUnused)
1388    self.executeTest(self.configureDeprecated)
1389    self.executeTest(self.configureIsatty)
1390    self.executeTest(self.configureExpect)
1391    self.executeTest(self.configureAlign)
1392    self.executeTest(self.configureFunctionName)
1393    self.executeTest(self.configureIntptrt)
1394    self.executeTest(self.configureSolaris)
1395    self.executeTest(self.configureLinux)
1396    self.executeTest(self.configureDarwin)
1397    self.executeTest(self.configureWin32)
1398    self.executeTest(self.configureCygwinBrokenPipe)
1399    self.executeTest(self.configureDefaultArch)
1400    self.executeTest(self.configureScript)
1401    self.executeTest(self.configureInstall)
1402    self.executeTest(self.configureAtoll)
1403    self.executeTest(self.configureCoverage)
1404    self.executeTest(self.configureCoverageExecutable)
1405    self.executeTest(self.configureStrictPetscErrorCode)
1406    self.executeTest(self.configureSanitize)
1407
1408    self.Dump()
1409    self.dumpConfigInfo()
1410    self.dumpMachineInfo()
1411    self.delGenFiles()
1412    # need to save the current state of BuildSystem so that postProcess() packages can read it in and perhaps run make install
1413    self.framework.storeSubstitutions(self.framework.argDB)
1414    self.framework.argDB['configureCache'] = pickle.dumps(self.framework)
1415    self.framework.argDB.save(force = True)
1416    self.DumpPkgconfig('PETSc.pc')
1417    self.DumpPkgconfig('petsc.pc')
1418    self.DumpModule()
1419    self.postProcessPackages()
1420    self.framework.log.write('================================================================================\n')
1421    self.logClear()
1422    return
1423