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