xref: /petsc/config/configure.py (revision 58256f306a3b839fcaddd686dc61d2820e658499)
1#!/usr/bin/env python3
2from __future__ import print_function
3import os
4import sys
5import pickle
6import traceback
7
8banner_length = 93
9extraLogs     = []
10petsc_arch    = ''
11
12# Use en_US as language so that BuildSystem parses compiler messages in english
13def fixLang(lang):
14  if lang in os.environ and os.environ[lang] != '':
15    lv = os.environ[lang]
16    enc = ''
17    try: lv,enc = lv.split('.')
18    except: pass
19    if lv not in ['en_US','C']: lv = 'en_US'
20    if enc: lv = lv+'.'+enc
21    os.environ[lang] = lv
22
23fixLang('LC_LOCAL')
24fixLang('LANG')
25
26def check_for_option_mistakes(opts):
27  for opt in opts[1:]:
28    name = opt.split('=')[0]
29    if name.find(' ') >= 0:
30      raise ValueError('The option "'+name+'" has a space character in the name - this is likely incorrect usage.');
31    if name.find('_') >= 0:
32      exception = False
33      for exc in ['mkl_sparse', 'mkl_sparse_optimize', 'mkl_cpardiso', 'mkl_pardiso', 'superlu_dist', 'PETSC_ARCH', 'PETSC_DIR', 'CXX_CXXFLAGS', 'LD_SHARED', 'CC_LINKER_FLAGS', 'CXX_LINKER_FLAGS', 'FC_LINKER_FLAGS', 'AR_FLAGS', 'C_VERSION', 'CXX_VERSION', 'FC_VERSION', 'size_t', 'MPI_Comm','MPI_Fint','int64_t','scikit_build_core', 'fenics_ffcx']:
34        if name.find(exc) >= 0:
35          exception = True
36      if not exception:
37        raise ValueError('The option '+name+' should probably be '+name.replace('_', '-'));
38    if opt.find('=') >=0:
39      optval = opt.split('=')[1]
40      if optval == 'ifneeded':
41        raise ValueError('The option '+opt+' should probably be '+opt.replace('ifneeded', '1'));
42    for exc in ['mkl_sparse', 'mkl_sparse_optimize', 'mkl_cpardiso', 'mkl_pardiso', 'superlu_dist']:
43      if name.find(exc.replace('_','-')) > -1:
44        raise ValueError('The option '+opt+' should be '+opt.replace(exc.replace('_','-'),exc));
45  return
46
47def check_for_unsupported_combinations(opts):
48  if '--with-precision=single' in opts and '--with-clanguage=cxx' in opts and '--with-scalar-type=complex' in opts:
49    raise ValueError('PETSc does not support single precision complex with C++ clanguage, run with --with-clanguage=c')
50
51def check_for_option_changed(opts):
52# Document changes in command line options here. (matlab-engine is deprecated, no longer needed but still allowed)
53  optMap = [('with-64bit-indices','with-64-bit-indices'),
54            ('with-mpi-exec','with-mpiexec'),
55            ('c-blas-lapack','f2cblaslapack'),
56            ('cholmod','suitesparse'),
57            ('umfpack','suitesparse'),
58            ('matlabengine','matlab-engine'),
59            ('sundials','sundials2'),
60            ('f-blas-lapack','fblaslapack'),
61            ('with-packages-dir','with-packages-download-dir'),
62            ('with-external-packages-dir','with-packages-build-dir'),
63            ('package-dirs','with-packages-search-path'),
64            ('download-petsc4py-python','with-python-exec'),
65            ('search-dirs','with-executables-search-path')]
66  for opt in opts[1:]:
67    optname = opt.split('=')[0].strip('-')
68    for oldname,newname in optMap:
69      if optname.find(oldname) >=0 and not optname.find(newname) >=0:
70        raise ValueError('The option '+opt+' should probably be '+opt.replace(oldname,newname))
71  return
72
73def check_petsc_arch(opts):
74  # If PETSC_ARCH not specified - use script name (if not configure.py)
75  global petsc_arch
76  found = 0
77  for name in opts:
78    if name.find('PETSC_ARCH=') >= 0:
79      petsc_arch=name.split('=')[1]
80      found = 1
81      break
82  # If not yet specified - use the filename of script
83  if not found:
84      filename = os.path.basename(sys.argv[0])
85      if not filename.startswith('configure') and not filename.startswith('reconfigure') and not filename.startswith('setup'):
86        petsc_arch=os.path.splitext(os.path.basename(sys.argv[0]))[0]
87        useName = 'PETSC_ARCH='+petsc_arch
88        opts.append(useName)
89  return 0
90
91def chkenable():
92  #Replace all 'enable-'/'disable-' with 'with-'=0/1/tail
93  #enable-fortran is a special case, the resulting --with-fortran is ambiguous.
94  #Would it mean --with-fc=
95  en_dash = u'\N{EN DASH}'
96  no_break_space = u'\N{NO-BREAK SPACE}'
97  for l in range(0,len(sys.argv)):
98    name = sys.argv[l]
99    if name.find(no_break_space) >= 0:
100      raise ValueError('Unicode NO-BREAK SPACE char found in arguments! Please rerun configure using regular space chars: %s' % [name])
101    name = name.replace(en_dash,'-')
102    if hasattr(name,'isprintable') and not name.isprintable():
103      raise ValueError('Non-printable characters or control characters found in arguments! Please rerun configure using only printable character arguments: %s' % [name])
104    if name.lstrip('-').startswith('enable-cxx'):
105      if name.find('=') == -1:
106        name = name.replace('enable-cxx','with-clanguage=C++',1)
107      else:
108        head, tail = name.split('=', 1)
109        if tail=='0':
110          name = head.replace('enable-cxx','with-clanguage=C',1)
111        else:
112          name = head.replace('enable-cxx','with-clanguage=C++',1)
113      sys.argv[l] = name
114      continue
115    if name.lstrip('-').startswith('disable-cxx'):
116      if name.find('=') == -1:
117        name = name.replace('disable-cxx','with-clanguage=C',1)
118      else:
119        head, tail = name.split('=', 1)
120        if tail == '0':
121          name = head.replace('disable-cxx','with-clanguage=C++',1)
122        else:
123          name = head.replace('disable-cxx','with-clanguage=C',1)
124      sys.argv[l] = name
125      continue
126
127    if name.lstrip('-').startswith('enable-'):
128      if name.find('=') == -1:
129        name = name.replace('enable-','with-',1)+'=1'
130      else:
131        head, tail = name.split('=', 1)
132        name = head.replace('enable-','with-',1)+'='+tail
133    if name.lstrip('-').startswith('disable-'):
134      if name.find('=') == -1:
135        name = name.replace('disable-','with-',1)+'=0'
136      else:
137        head, tail = name.split('=', 1)
138        if tail == '1': tail = '0'
139        name = head.replace('disable-','with-',1)+'='+tail
140    if name.lstrip('-').startswith('without-'):
141      if name.find('=') == -1:
142        name = name.replace('without-','with-',1)+'=0'
143      else:
144        head, tail = name.split('=', 1)
145        if tail == '1': tail = '0'
146        name = head.replace('without-','with-',1)+'='+tail
147    sys.argv[l] = name
148
149def chksynonyms():
150  #replace common configure options with ones that PETSc BuildSystem recognizes
151  simplereplacements = {'F77' : 'FC', 'F90' : 'FC'}
152  for l in range(0,len(sys.argv)):
153    name = sys.argv[l]
154
155    name = name.replace('download-petsc4py','with-petsc4py')
156    name = name.replace('download-slepc4py','with-slepc4py')
157    name = name.replace('with-openmpi','with-mpi')
158    name = name.replace('with-mpich','with-mpi')
159    name = name.replace('with-blas-lapack','with-blaslapack')
160    name = name.replace('with-cuda-gencodearch','with-cuda-arch')
161    name = name.replace('download-hdf5-fortran-bindings','with-hdf5-fortran-bindings')
162
163    if name.find('with-debug=') >= 0 or name.endswith('with-debug'):
164      if name.find('=') == -1:
165        name = name.replace('with-debug','with-debugging')+'=1'
166      else:
167        head, tail = name.split('=', 1)
168        name = head.replace('with-debug','with-debugging')+'='+tail
169
170    if name.find('with-shared=') >= 0 or name.endswith('with-shared'):
171      if name.find('=') == -1:
172        name = name.replace('with-shared','with-shared-libraries')+'=1'
173      else:
174        head, tail = name.split('=', 1)
175        name = head.replace('with-shared','with-shared-libraries')+'='+tail
176
177    if name.find('with-index-size=') >=0:
178      head,tail = name.split('=',1)
179      if int(tail)==32:
180        name = '--with-64-bit-indices=0'
181      elif int(tail)==64:
182        name = '--with-64-bit-indices=1'
183      else:
184        raise ValueError('--with-index-size= must be 32 or 64')
185
186    if name.find('with-precision=') >=0:
187      head,tail = name.split('=',1)
188      if tail.find('quad')>=0:
189        name='--with-precision=__float128'
190
191    for i,j in simplereplacements.items():
192      if name.find(i+'=') >= 0:
193        name = name.replace(i+'=',j+'=')
194      elif name.find('with-'+i.lower()+'=') >= 0:
195        name = name.replace(i.lower()+'=',j.lower()+'=')
196
197    # restore 'sys.argv[l]' from the intermediate var 'name'
198    sys.argv[l] = name
199
200def chkwincompilerusinglink():
201  for arg in sys.argv:
202    if (arg.find('win32fe') >= 0 and (arg.find('ifort') >=0 or arg.find('icl') >=0)):
203      return 1
204  return 0
205
206def chkdosfiles():
207  # cygwin - but not a hg clone - so check one of files in bin dir
208  if b"\r\n" in open(os.path.join('lib','petsc','bin','petscmpiexec'),"rb").read():
209    print('===============================================================================')
210    print(' *** Scripts are in DOS mode. Was winzip used to extract PETSc sources?    ****')
211    print(' *** Please restart with a fresh tarball and use "tar -xzf petsc.tar.gz"   ****')
212    print('===============================================================================')
213    sys.exit(3)
214  return
215
216def chkcygwinlink():
217  if os.path.exists('/usr/bin/cygcheck.exe') and os.path.exists('/usr/bin/link.exe') and chkwincompilerusinglink():
218      if '--ignore-cygwin-link' in sys.argv: return 0
219      print('===============================================================================')
220      print(' *** Cygwin /usr/bin/link detected! Compiles with Intel icl/ifort can break!  **')
221      print(' *** To workaround do: "mv /usr/bin/link.exe /usr/bin/link-cygwin.exe"     **')
222      print(' *** Or to ignore this check, use configure option: --ignore-cygwin-link. But compiles can fail. **')
223      print('===============================================================================')
224      sys.exit(3)
225  return 0
226
227def chkbrokencygwin():
228  if os.path.exists('/usr/bin/cygcheck.exe'):
229    buf = os.popen('/usr/bin/cygcheck.exe -c cygwin').read()
230    if buf.find('1.5.11-1') > -1:
231      print('===============================================================================')
232      print(' *** cygwin-1.5.11-1 detected. ./configure fails with this version ***')
233      print(' *** Please upgrade to cygwin-1.5.12-1 or newer version. This can  ***')
234      print(' *** be done by running cygwin-setup, selecting "next" all the way.***')
235      print('===============================================================================')
236      sys.exit(3)
237  return 0
238
239def chkusingwindowspython():
240  if sys.platform == 'win32':
241    print('===============================================================================')
242    print(' *** Windows python detected. Please rerun ./configure with cygwin-python. ***')
243    print('===============================================================================')
244    sys.exit(3)
245  return 0
246
247def chkcygwinpython():
248  if sys.platform == 'cygwin' :
249    import platform
250    import re
251    r=re.compile("([0-9]+).([0-9]+).([0-9]+)")
252    m=r.match(platform.release())
253    major=int(m.group(1))
254    minor=int(m.group(2))
255    subminor=int(m.group(3))
256    if ((major < 1) or (major == 1 and minor < 7) or (major == 1 and minor == 7 and subminor < 34)):
257      sys.argv.append('--useThreads=0')
258      extraLogs.append('''\
259===============================================================================
260** Cygwin version is older than 1.7.34. Python threads do not work correctly. ***
261** Disabling thread usage for this run of ./configure *******
262===============================================================================''')
263  return 0
264
265def chkcygwinwindowscompilers():
266  ''' Converts Microsoft and Intel Windows compilers to PETSc script using win32fe'''
267  if os.path.exists('/usr/bin/cygcheck.exe'):
268    path = os.path.join(os.getcwd(),'lib','petsc','bin','win32fe')
269    for l in range(1,len(sys.argv)):
270      option = sys.argv[l]
271      for i in ['cl','icl','ifort','icx','ifx','lib','nvcc']:
272        if option.endswith('="win32fe '+i+'"'):
273          sys.argv[l] = option[:option.find('=')+1]+os.path.join(path,'win32fe_'+i)
274          print('===============================================================================')
275          print(' *** Arguments of the form XXX="win32fe '+i+'" are deprecated              ****')
276          print(' *** Use XXX='+i+'                                                         ****')
277          print('===============================================================================')
278
279          break
280        if option.endswith('='+i):
281          sys.argv[l] = option[:option.find('=')+1]+os.path.join(path,'win32fe_'+i)
282          break
283  return 0
284
285def chkrhl9():
286  if os.path.exists('/etc/redhat-release'):
287    try:
288      file = open('/etc/redhat-release','r')
289      buf = file.read()
290      file.close()
291    except:
292      # can't read file - assume dangerous RHL9
293      buf = 'Shrike'
294    if buf.find('Shrike') > -1:
295      sys.argv.append('--useThreads=0')
296      extraLogs.append('''\
297==============================================================================
298   *** RHL9 detected. Threads do not work correctly with this distribution ***
299   ****** Disabling thread usage for this run of ./configure *********
300===============================================================================''')
301  return 0
302
303def chktmpnoexec():
304  if not hasattr(os,'ST_NOEXEC'): return # novermin
305  if 'TMPDIR' in os.environ: tmpDir = os.environ['TMPDIR']
306  else: tmpDir = '/tmp'
307  if os.statvfs(tmpDir).f_flag & os.ST_NOEXEC: # novermin
308    if os.statvfs(os.path.abspath('.')).f_flag & os.ST_NOEXEC: # novermin
309      print('************************************************************************')
310      print('* TMPDIR '+tmpDir+' has noexec attribute. Same with '+os.path.abspath('.')+' where PETSc is built.')
311      print('* Suggest building PETSc in a location without this restriction!')
312      print('* Alternatively, set env variable TMPDIR to a location that is not restricted to run binaries.')
313      print('************************************************************************')
314      sys.exit(4)
315    else:
316      newTmp = os.path.abspath('tmp-petsc')
317      print('************************************************************************')
318      print('* TMPDIR '+tmpDir+' has noexec attribute. Using '+newTmp+' instead.')
319      print('************************************************************************')
320      if not os.path.isdir(newTmp): os.mkdir(os.path.abspath(newTmp))
321      os.environ['TMPDIR'] = newTmp
322  return
323
324def check_cray_modules():
325  import script
326  '''For Cray systems check if the cc, CC, ftn compiler suite modules have been set'''
327  cray = os.getenv('CRAY_SITE_LIST_DIR')
328  if not cray: return
329  cray = os.getenv('CRAYPE_DIR')
330  if not cray:
331   print('************************************************************************')
332   print('* You are on a Cray system but no programming environments have been loaded')
333   print('* Perhaps you need:')
334   print('*       module load intel ; module load PrgEnv-intel')
335   print('*   or  module load PrgEnv-cray')
336   print('*   or  module load PrgEnv-gnu')
337   print('* See https://petsc.org/release/install/install/#installing-on-large-scale-doe-systems')
338   print('************************************************************************')
339   sys.exit(4)
340
341def check_broken_configure_log_links():
342  '''Sometime symlinks can get broken if the original files are deleted. Delete such broken links'''
343  import os
344  for logfile in ['configure.log','configure.log.bkp']:
345    if os.path.islink(logfile) and not os.path.isfile(logfile): os.remove(logfile)
346  return
347
348def move_configure_log(framework):
349  '''Move configure.log to PETSC_ARCH/lib/petsc/conf - and update configure.log.bkp in both locations appropriately'''
350  global petsc_arch
351
352  if hasattr(framework,'arch'): petsc_arch = framework.arch
353  if hasattr(framework,'logName'): curr_file = framework.logName
354  else: curr_file = 'configure.log'
355
356  if petsc_arch:
357    import shutil
358    import os
359
360    # Just in case - confdir is not created
361    lib_dir = os.path.join(petsc_arch,'lib')
362    petsc_dir = os.path.join(petsc_arch,'lib','petsc')
363    conf_dir = os.path.join(petsc_arch,'lib','petsc','conf')
364    if not os.path.isdir(petsc_arch): os.mkdir(petsc_arch)
365    if not os.path.isdir(lib_dir): os.mkdir(lib_dir)
366    if not os.path.isdir(petsc_dir): os.mkdir(petsc_dir)
367    if not os.path.isdir(conf_dir): os.mkdir(conf_dir)
368
369    curr_bkp  = curr_file + '.bkp'
370    new_file  = os.path.join(conf_dir,curr_file)
371    new_bkp   = new_file + '.bkp'
372
373    # Keep backup in $PETSC_ARCH/lib/petsc/conf location
374    if os.path.isfile(new_bkp): os.remove(new_bkp)
375    if os.path.isfile(new_file): os.rename(new_file,new_bkp)
376    if os.path.isfile(curr_file):
377      shutil.copyfile(curr_file,new_file)
378      os.remove(curr_file)
379    if os.path.isfile(new_file): os.symlink(new_file,curr_file)
380    # If the old bkp is using the same PETSC_ARCH/lib/petsc/conf - then update bkp link
381    if os.path.realpath(curr_bkp) == os.path.realpath(new_file):
382      if os.path.isfile(curr_bkp): os.remove(curr_bkp)
383      if os.path.isfile(new_bkp): os.symlink(new_bkp,curr_bkp)
384  return
385
386def print_final_timestamp(framework):
387  import time
388  framework.log.write(('='*80)+'\n')
389  framework.log.write('Finishing configure run at '+time.strftime('%a, %d %b %Y %H:%M:%S %z')+'\n')
390  framework.log.write(('='*80)+'\n')
391  return
392
393def petsc_configure(configure_options):
394  petscdir = os.getcwd()
395  try:
396    sys.path.append(os.path.join(petscdir,'lib','petsc','bin'))
397    import petscnagupgrade
398    file     = os.path.join(petscdir,'.nagged')
399    if not petscnagupgrade.naggedtoday(file):
400      petscnagupgrade.currentversion(petscdir)
401  except:
402    pass
403
404  # Should be run from the toplevel
405  configDir = os.path.abspath('config')
406  bsDir     = os.path.join(configDir, 'BuildSystem')
407  if not os.path.isdir(configDir):
408    raise RuntimeError('Run configure from $PETSC_DIR, not '+os.path.abspath('.'))
409  sys.path.insert(0, bsDir)
410  sys.path.insert(0, configDir)
411  import logger
412  import config.base
413  import config.framework
414
415  try:
416    # Command line arguments take precedence (but don't destroy argv[0])
417    sys.argv = sys.argv[:1] + configure_options + sys.argv[1:]
418    check_for_option_mistakes(sys.argv)
419    check_for_option_changed(sys.argv)
420    check_for_unsupported_combinations(sys.argv)
421
422    check_petsc_arch(sys.argv)
423    check_broken_configure_log_links()
424
425    #rename '--enable-' to '--with-'
426    chkenable()
427    # support a few standard configure option types
428    chksynonyms()
429  except (TypeError, ValueError) as e:
430    msg = logger.build_multiline_error_message('ERROR in COMMAND LINE ARGUMENT to ./configure', str(e))
431    sys.exit(msg)
432  chkbrokencygwin()
433  # Disable threads on RHL9
434  chkrhl9()
435  # Make sure cygwin-python is used on windows
436  chkusingwindowspython()
437  # Threads don't work for cygwin & python...
438  chkcygwinpython()
439  chkcygwinlink()
440  chkdosfiles()
441  chkcygwinwindowscompilers()
442  chktmpnoexec()
443
444  for l in range(1,len(sys.argv)):
445    if sys.argv[l].startswith('--with-fc=') and sys.argv[l].endswith('nagfor'):
446      # need a way to save this value and later CC so that petscnagfor may use them
447      name = sys.argv[l].split('=')[1]
448      sys.argv[l] = '--with-fc='+os.path.join(os.path.abspath('.'),'lib','petsc','bin','petscnagfor')
449      break
450
451  # Check Cray without modules
452  check_cray_modules()
453
454  tbo = None
455  framework = None
456  try:
457    framework = config.framework.Framework(['--configModules=PETSc.Configure','--optionsModule=config.compilerOptions']+sys.argv[1:], loadArgDB = 0)
458    framework.setup()
459    framework.logPrintBox('Configuring PETSc to compile on your system')
460    framework.logPrint('\n'.join(extraLogs))
461    framework.configure(out = sys.stdout)
462    framework.storeSubstitutions(framework.argDB)
463    framework.argDB['configureCache'] = pickle.dumps(framework)
464    framework.printSummary()
465    framework.argDB.save(force = True)
466    framework.logClear()
467    print_final_timestamp(framework)
468    framework.closeLog()
469    try:
470      move_configure_log(framework)
471    except:
472      # perhaps print an error about unable to shuffle logs?
473      pass
474    return 0
475  except (RuntimeError, config.base.ConfigureSetupError) as e:
476    tbo = sys.exc_info()[2]
477    msg = logger.build_multiline_error_message('UNABLE to CONFIGURE with GIVEN OPTIONS (see configure.log for details):', str(e))
478    se = ''
479  except (TypeError, ValueError) as e:
480    # this exception is automatically deleted by Python so we need to save it to print below
481    tbo = sys.exc_info()[2]
482    msg = logger.build_multiline_error_message('TypeError or ValueError possibly related to ERROR in COMMAND LINE ARGUMENT while running ./configure', str(e))
483    se = ''
484  except ImportError as e :
485    # this exception is automatically deleted by Python so we need to save it to print below
486    tbo = sys.exc_info()[2]
487    msg = logger.build_multiline_error_message('ImportError while running ./configure', str(e))
488    se = ''
489  except OSError as e :
490    tbo = sys.exc_info()[2]
491    msg = logger.build_multiline_error_message('OSError while running ./configure', str(e))
492    se = ''
493  except SystemExit as e:
494    tbo = sys.exc_info()[2]
495    if e.code is None or e.code == 0:
496      return
497    if e.code == 10:
498      sys.exit(10)
499    msg = logger.build_multiline_error_message('CONFIGURATION FAILURE (Please send configure.log to petsc-maint@mcs.anl.gov)', str(e))
500    se  = str(e)
501  except Exception as e:
502    tbo = sys.exc_info()[2]
503    msg = logger.build_multiline_error_message('CONFIGURATION CRASH (Please send configure.log to petsc-maint@mcs.anl.gov)', str(e))
504    se  = str(e)
505
506  print('\n'+msg)
507  if not framework is None:
508    framework.logClear()
509    if hasattr(framework, 'log'):
510      try:
511        if hasattr(framework,'compilerDefines'):
512          framework.log.write('**** Configure header '+framework.compilerDefines+' ****\n')
513          framework.outputHeader(framework.log)
514        if hasattr(framework,'compilerFixes'):
515          framework.log.write('**** C specific Configure header '+framework.compilerFixes+' ****\n')
516          framework.outputCHeader(framework.log)
517      except Exception as e:
518        framework.log.write('Problem writing headers to log: '+str(e))
519      try:
520        if hasattr(framework,'additional_error_message'): se += logger.build_multiline_message('',framework.additional_error_message)+'\n\n'
521        framework.log.write(msg+se)
522        traceback.print_tb(tbo, file = framework.log)
523        print_final_timestamp(framework)
524        if hasattr(framework,'log'): framework.log.close()
525        move_configure_log(framework)
526      except Exception as e:
527        print('Error printing error message from exception or printing the traceback:'+str(e))
528        traceback.print_tb(sys.exc_info()[2])
529      sys.exit(1)
530    else:
531      print(se)
532      traceback.print_tb(tbo)
533  else:
534    print(se)
535    traceback.print_tb(tbo)
536  if hasattr(framework,'log'): framework.log.close()
537
538if __name__ == '__main__':
539  petsc_configure([])
540