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