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