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