xref: /petsc/config/configure.py (revision efa12513287cff49a2b9648ae83199dcbfaad71a)
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    if name.find('download-petsc4py') >= 0:
152      sys.argv[l] = name.replace('download-petsc4py','with-petsc4py')
153
154    name = name.replace('with-openmpi','with-mpi')
155    name = name.replace('with-mpich','with-mpi')
156    name = name.replace('with-blas-lapack','with-blaslapack')
157
158    if name.find('with-debug=') >= 0 or name.endswith('with-debug'):
159      if name.find('=') == -1:
160        name = name.replace('with-debug','with-debugging')+'=1'
161      else:
162        head, tail = name.split('=', 1)
163        name = head.replace('with-debug','with-debugging')+'='+tail
164
165    if name.find('with-shared=') >= 0 or name.endswith('with-shared'):
166      if name.find('=') == -1:
167        name = name.replace('with-shared','with-shared-libraries')+'=1'
168      else:
169        head, tail = name.split('=', 1)
170        name = head.replace('with-shared','with-shared-libraries')+'='+tail
171
172    if name.find('with-index-size=') >=0:
173      head,tail = name.split('=',1)
174      if int(tail)==32:
175        name = '--with-64-bit-indices=0'
176      elif int(tail)==64:
177        name = '--with-64-bit-indices=1'
178      else:
179        raise RuntimeError('--with-index-size= must be 32 or 64')
180
181    if name.find('with-precision=') >=0:
182      head,tail = name.split('=',1)
183      if tail.find('quad')>=0:
184        name='--with-precision=__float128'
185
186    for i,j in simplereplacements.items():
187      if name.find(i+'=') >= 0:
188        name = name.replace(i+'=',j+'=')
189      elif name.find('with-'+i.lower()+'=') >= 0:
190        name = name.replace(i.lower()+'=',j.lower()+'=')
191
192    # restore 'sys.argv[l]' from the intermediate var 'name'
193    sys.argv[l] = name
194
195def chkwincompilerusinglink():
196  for arg in sys.argv:
197    if (arg.find('win32fe') >= 0 and (arg.find('f90') >=0 or arg.find('ifort') >=0 or arg.find('icl') >=0)):
198      return 1
199  return 0
200
201def chkdosfiles():
202  # cygwin - but not a hg clone - so check one of files in bin dir
203  if b"\r\n" in open(os.path.join('lib','petsc','bin','petscmpiexec'),"rb").read():
204    print('===============================================================================')
205    print(' *** Scripts are in DOS mode. Was winzip used to extract petsc sources?    ****')
206    print(' *** Please restart with a fresh tarball and use "tar -xzf petsc.tar.gz"   ****')
207    print('===============================================================================')
208    sys.exit(3)
209  return
210
211def chkcygwinlink():
212  if os.path.exists('/usr/bin/cygcheck.exe') and os.path.exists('/usr/bin/link.exe') and chkwincompilerusinglink():
213      if '--ignore-cygwin-link' in sys.argv: return 0
214      print('===============================================================================')
215      print(' *** Cygwin /usr/bin/link detected! Compiles with Intel icl/ifort can break!  **')
216      print(' *** To workarround do: "mv /usr/bin/link.exe /usr/bin/link-cygwin.exe"     **')
217      print(' *** Or to ignore this check, use configure option: --ignore-cygwin-link. But compiles can fail. **')
218      print('===============================================================================')
219      sys.exit(3)
220  return 0
221
222def chkbrokencygwin():
223  if os.path.exists('/usr/bin/cygcheck.exe'):
224    buf = os.popen('/usr/bin/cygcheck.exe -c cygwin').read()
225    if buf.find('1.5.11-1') > -1:
226      print('===============================================================================')
227      print(' *** cygwin-1.5.11-1 detected. ./configure fails with this version ***')
228      print(' *** Please upgrade to cygwin-1.5.12-1 or newer version. This can  ***')
229      print(' *** be done by running cygwin-setup, selecting "next" all the way.***')
230      print('===============================================================================')
231      sys.exit(3)
232  return 0
233
234def chkusingwindowspython():
235  if sys.platform == 'win32':
236    print('===============================================================================')
237    print(' *** Windows python detected. Please rerun ./configure with cygwin-python. ***')
238    print('===============================================================================')
239    sys.exit(3)
240  return 0
241
242def chkcygwinpython():
243  if sys.platform == 'cygwin' :
244    import platform
245    import re
246    r=re.compile("([0-9]+).([0-9]+).([0-9]+)")
247    m=r.match(platform.release())
248    major=int(m.group(1))
249    minor=int(m.group(2))
250    subminor=int(m.group(3))
251    if ((major < 1) or (major == 1 and minor < 7) or (major == 1 and minor == 7 and subminor < 34)):
252      sys.argv.append('--useThreads=0')
253      extraLogs.append('''\
254===============================================================================
255** Cygwin version is older than 1.7.34. Python threads do not work correctly. ***
256** Disabling thread usage for this run of ./configure *******
257===============================================================================''')
258  return 0
259
260def chkcygwinwindowscompilers():
261  '''Adds win32fe for Microsoft/Intel compilers'''
262  if os.path.exists('/usr/bin/cygcheck.exe'):
263    for l in range(1,len(sys.argv)):
264      option = sys.argv[l]
265      for i in ['cl','icl','ifort']:
266        if option.startswith(i):
267          sys.argv[l] = 'win32fe '+option
268          break
269  return 0
270
271def chkrhl9():
272  if os.path.exists('/etc/redhat-release'):
273    try:
274      file = open('/etc/redhat-release','r')
275      buf = file.read()
276      file.close()
277    except:
278      # can't read file - assume dangerous RHL9
279      buf = 'Shrike'
280    if buf.find('Shrike') > -1:
281      sys.argv.append('--useThreads=0')
282      extraLogs.append('''\
283==============================================================================
284   *** RHL9 detected. Threads do not work correctly with this distribution ***
285   ****** Disabling thread usage for this run of ./configure *********
286===============================================================================''')
287  return 0
288
289def chktmpnoexec():
290  if not hasattr(os,'ST_NOEXEC'): return # novermin
291  if 'TMPDIR' in os.environ: tmpDir = os.environ['TMPDIR']
292  else: tmpDir = '/tmp'
293  if os.statvfs(tmpDir).f_flag & os.ST_NOEXEC: # novermin
294    if os.statvfs(os.path.abspath('.')).f_flag & os.ST_NOEXEC: # novermin
295      print('************************************************************************')
296      print('* TMPDIR '+tmpDir+' has noexec attribute. Same with '+os.path.abspath('.')+' where petsc is built.')
297      print('* Suggest building PETSc in a location without this restriction!')
298      print('* Alternatively, set env variable TMPDIR to a location that is not restricted to run binaries.')
299      print('************************************************************************')
300      sys.exit(4)
301    else:
302      newTmp = os.path.abspath('tmp-petsc')
303      print('************************************************************************')
304      print('* TMPDIR '+tmpDir+' has noexec attribute. Using '+newTmp+' instead.')
305      print('************************************************************************')
306      if not os.path.isdir(newTmp): os.mkdir(os.path.abspath(newTmp))
307      os.environ['TMPDIR'] = newTmp
308  return
309
310def check_cray_modules():
311  import script
312  '''For Cray systems check if the cc, CC, ftn compiler suite modules have been set'''
313  cray = os.getenv('CRAY_SITE_LIST_DIR')
314  if not cray: return
315  cray = os.getenv('CRAYPE_DIR')
316  if not cray:
317   print('************************************************************************')
318   print('* You are on a Cray system but no programming environments have been loaded')
319   print('* Perhaps you need:')
320   print('*       module load intel ; module load PrgEnv-intel')
321   print('*   or  module load PrgEnv-cray')
322   print('*   or  module load PrgEnv-gnu')
323   print('* See https://www.mcs.anl.gov/petsc/documentation/installation.html#doemachines')
324   print('************************************************************************')
325   sys.exit(4)
326
327def check_broken_configure_log_links():
328  '''Sometime symlinks can get broken if the original files are deleted. Delete such broken links'''
329  import os
330  for logfile in ['configure.log','configure.log.bkp']:
331    if os.path.islink(logfile) and not os.path.isfile(logfile): os.remove(logfile)
332  return
333
334def move_configure_log(framework):
335  '''Move configure.log to PETSC_ARCH/lib/petsc/conf - and update configure.log.bkp in both locations appropriately'''
336  global petsc_arch
337
338  if hasattr(framework,'arch'): petsc_arch = framework.arch
339  if hasattr(framework,'logName'): curr_file = framework.logName
340  else: curr_file = 'configure.log'
341
342  if petsc_arch:
343    import shutil
344    import os
345
346    # Just in case - confdir is not created
347    lib_dir = os.path.join(petsc_arch,'lib')
348    petsc_dir = os.path.join(petsc_arch,'lib','petsc')
349    conf_dir = os.path.join(petsc_arch,'lib','petsc','conf')
350    if not os.path.isdir(petsc_arch): os.mkdir(petsc_arch)
351    if not os.path.isdir(lib_dir): os.mkdir(lib_dir)
352    if not os.path.isdir(petsc_dir): os.mkdir(petsc_dir)
353    if not os.path.isdir(conf_dir): os.mkdir(conf_dir)
354
355    curr_bkp  = curr_file + '.bkp'
356    new_file  = os.path.join(conf_dir,curr_file)
357    new_bkp   = new_file + '.bkp'
358
359    # Keep backup in $PETSC_ARCH/lib/petsc/conf location
360    if os.path.isfile(new_bkp): os.remove(new_bkp)
361    if os.path.isfile(new_file): os.rename(new_file,new_bkp)
362    if os.path.isfile(curr_file):
363      shutil.copyfile(curr_file,new_file)
364      os.remove(curr_file)
365    if os.path.isfile(new_file): os.symlink(new_file,curr_file)
366    # If the old bkp is using the same PETSC_ARCH/lib/petsc/conf - then update bkp link
367    if os.path.realpath(curr_bkp) == os.path.realpath(new_file):
368      if os.path.isfile(curr_bkp): os.remove(curr_bkp)
369      if os.path.isfile(new_bkp): os.symlink(new_bkp,curr_bkp)
370  return
371
372def print_final_timestamp(framework):
373  import time
374  framework.log.write(('='*80)+'\n')
375  framework.log.write('Finishing configure run at '+time.strftime('%a, %d %b %Y %H:%M:%S %z')+'\n')
376  framework.log.write(('='*80)+'\n')
377  return
378
379def petsc_configure(configure_options):
380  if 'PETSC_DIR' in os.environ:
381    petscdir = os.environ['PETSC_DIR']
382    if petscdir.find(' ') > -1:
383      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')
384    try:
385      sys.path.append(os.path.join(petscdir,'lib','petsc','bin'))
386      import petscnagupgrade
387      file     = os.path.join(petscdir,'.nagged')
388      if not petscnagupgrade.naggedtoday(file):
389        petscnagupgrade.currentversion(petscdir)
390    except:
391      pass
392  print('===============================================================================')
393  print('             Configuring PETSc to compile on your system                       ')
394  print('===============================================================================')
395
396  try:
397    # Command line arguments take precedence (but don't destroy argv[0])
398    sys.argv = sys.argv[:1] + configure_options + sys.argv[1:]
399    check_for_option_mistakes(sys.argv)
400    check_for_option_changed(sys.argv)
401  except (TypeError, ValueError) as e:
402    emsg = str(e)
403    if not emsg.endswith('\n'): emsg = emsg+'\n'
404    msg ='*******************************************************************************\n'\
405    +'                ERROR in COMMAND LINE ARGUMENT to ./configure \n' \
406    +'-------------------------------------------------------------------------------\n'  \
407    +emsg+'*******************************************************************************\n'
408    sys.exit(msg)
409  # check PETSC_ARCH
410  check_for_unsupported_combinations(sys.argv)
411  check_petsc_arch(sys.argv)
412  check_broken_configure_log_links()
413
414  #rename '--enable-' to '--with-'
415  chkenable()
416  # support a few standard configure option types
417  chksynonyms()
418  # Check for broken cygwin
419  chkbrokencygwin()
420  # Disable threads on RHL9
421  chkrhl9()
422  # Make sure cygwin-python is used on windows
423  chkusingwindowspython()
424  # Threads don't work for cygwin & python...
425  chkcygwinpython()
426  chkcygwinlink()
427  chkdosfiles()
428  chkcygwinwindowscompilers()
429  chktmpnoexec()
430
431  for l in range(1,len(sys.argv)):
432    if sys.argv[l].startswith('--with-fc=') and sys.argv[l].endswith('nagfor'):
433      # need a way to save this value and later CC so that petscnagfor may use them
434      name = sys.argv[l].split('=')[1]
435      sys.argv[l] = '--with-fc='+os.path.join(os.path.abspath('.'),'lib','petsc','bin','petscnagfor')
436      break
437
438
439  # Should be run from the toplevel
440  configDir = os.path.abspath('config')
441  bsDir     = os.path.join(configDir, 'BuildSystem')
442  if not os.path.isdir(configDir):
443    raise RuntimeError('Run configure from $PETSC_DIR, not '+os.path.abspath('.'))
444  sys.path.insert(0, bsDir)
445  sys.path.insert(0, configDir)
446  import config.base
447  import config.framework
448  import pickle
449  import traceback
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.logPrint('\n'.join(extraLogs))
460    framework.configure(out = sys.stdout)
461    framework.storeSubstitutions(framework.argDB)
462    framework.argDB['configureCache'] = pickle.dumps(framework)
463    framework.printSummary()
464    framework.argDB.save(force = True)
465    framework.logClear()
466    print_final_timestamp(framework)
467    framework.closeLog()
468    try:
469      move_configure_log(framework)
470    except:
471      # perhaps print an error about unable to shuffle logs?
472      pass
473    return 0
474  except (RuntimeError, config.base.ConfigureSetupError) as e:
475    tbo = sys.exc_info()[2]
476    emsg = str(e)
477    if not emsg.endswith('\n'): emsg = emsg+'\n'
478    msg ='*******************************************************************************\n'\
479    +'         UNABLE to CONFIGURE with GIVEN OPTIONS    (see configure.log for details):\n' \
480    +'-------------------------------------------------------------------------------\n'  \
481    +emsg+'*******************************************************************************\n'
482    se = ''
483  except (TypeError, ValueError) as e:
484    # this exception is automatically deleted by Python so we need to save it to print below
485    tbo = sys.exc_info()[2]
486    emsg = str(e)
487    if not emsg.endswith('\n'): emsg = emsg+'\n'
488    msg ='*******************************************************************************\n'\
489    +'    TypeError or ValueError possibly related to ERROR in COMMAND LINE ARGUMENT while running ./configure \n' \
490    +'-------------------------------------------------------------------------------\n'  \
491    +emsg+'*******************************************************************************\n'
492    se = ''
493  except ImportError as e :
494    # this exception is automatically deleted by Python so we need to save it to print below
495    tbo = sys.exc_info()[2]
496    emsg = str(e)
497    if not emsg.endswith('\n'): emsg = emsg+'\n'
498    msg ='*******************************************************************************\n'\
499    +'                     ImportError while runing ./configure \n' \
500    +'-------------------------------------------------------------------------------\n'  \
501    +emsg+'*******************************************************************************\n'
502    se = ''
503  except OSError as e :
504    tbo = sys.exc_info()[2]
505    emsg = str(e)
506    if not emsg.endswith('\n'): emsg = emsg+'\n'
507    msg ='*******************************************************************************\n'\
508    +'                    OSError while running ./configure \n' \
509    +'-------------------------------------------------------------------------------\n'  \
510    +emsg+'*******************************************************************************\n'
511    se = ''
512  except SystemExit as e:
513    tbo = sys.exc_info()[2]
514    if e.code is None or e.code == 0:
515      return
516    if e.code == 10:
517      sys.exit(10)
518    msg ='*******************************************************************************\n'\
519    +'         CONFIGURATION FAILURE  (Please send configure.log to petsc-maint@mcs.anl.gov)\n' \
520    +'*******************************************************************************\n'
521    se  = str(e)
522  except Exception as e:
523    tbo = sys.exc_info()[2]
524    msg ='*******************************************************************************\n'\
525    +'        CONFIGURATION CRASH  (Please send configure.log to petsc-maint@mcs.anl.gov)\n' \
526    +'*******************************************************************************\n'
527    se  = str(e)
528
529  print(msg)
530  if not framework is None:
531    framework.logClear()
532    if hasattr(framework, 'log'):
533      try:
534        if hasattr(framework,'compilerDefines'):
535          framework.log.write('**** Configure header '+framework.compilerDefines+' ****\n')
536          framework.outputHeader(framework.log)
537        if hasattr(framework,'compilerFixes'):
538          framework.log.write('**** C specific Configure header '+framework.compilerFixes+' ****\n')
539          framework.outputCHeader(framework.log)
540      except Exception as e:
541        framework.log.write('Problem writing headers to log: '+str(e))
542      try:
543        framework.log.write(msg+se)
544        traceback.print_tb(tbo, file = framework.log)
545        print_final_timestamp(framework)
546        if hasattr(framework,'log'): framework.log.close()
547        move_configure_log(framework)
548      except Exception as e:
549        print('Error printing error message from exception or printing the traceback:'+str(e))
550        traceback.print_tb(sys.exc_info()[2])
551      sys.exit(1)
552    else:
553      print(se)
554      traceback.print_tb(tbo)
555  else:
556    print(se)
557    traceback.print_tb(tbo)
558  if hasattr(framework,'log'): framework.log.close()
559
560if __name__ == '__main__':
561  petsc_configure([])
562
563