xref: /petsc/config/configure.py (revision 61b0a1dcfd94ba54ec426853381306413f848552)
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 argsStartswith(value):
132  # if the args have an argument that starts with a given value
133  for i in sys.argv:
134    if i.startswith(value): return 1
135  return 0
136
137def chksynonyms():
138  #replace common configure options with ones that PETSc BuildSystem recognizes
139  downloadxsdk = 0
140  downloadideas = 0
141  for l in range(0,len(sys.argv)):
142    name = sys.argv[l]
143
144    if name.startswith('--download-xsdk'):
145      downloadxsdk = 1
146
147    if name.startswith('--download-ideas'):
148      downloadideas = 1
149
150    if name.find('with-debug=') >= 0 or name.endswith('with-debug'):
151      if name.find('=') == -1:
152        sys.argv[l] = name.replace('with-debug','with-debugging')+'=1'
153      else:
154        head, tail = name.split('=', 1)
155        sys.argv[l] = head.replace('with-debug','with-debugging')+'='+tail
156
157    if name.find('with-shared=') >= 0 or name.endswith('with-shared'):
158      if name.find('=') == -1:
159        sys.argv[l] = name.replace('with-shared','with-shared-libraries')+'=1'
160      else:
161        head, tail = name.split('=', 1)
162        sys.argv[l] = head.replace('with-shared','with-shared-libraries')+'='+tail
163
164    if name.find('with-index-size=') >=0:
165      head,tail = name.split('=',1)
166      if int(tail)==32:
167        sys.argv[l] = '--with-64-bit-indices=0'
168      elif int(tail)==64:
169        sys.argv[l] = '--with-64-bit-indices=1'
170      else:
171        raise RuntimeError('--with-index-size= must be 32 or 64')
172
173    if name.find('with-precision=') >=0:
174      head,tail = name.split('=',1)
175      if tail.find('quad')>=0:
176        sys.argv[l]='--with-precision=__float128'
177
178  if downloadideas:
179    downloadxsdk = 1 # mstk currently cannot build a shared library
180    sys.argv.extend(['--download-pflotran','--download-alquimia','--download-mstk','--download-mstk-shared=0'])
181
182  if downloadxsdk:
183    # Common external libraries
184    if not argsStartswith('--with-hdf5'): sys.argv.extend(['--download-hdf5'])
185    if not argsStartswith('--with-netcdf'): sys.argv.extend(['--download-netcdf'])
186    if not argsStartswith('--with-exodusii'): sys.argv.extend(['--download-exodusii'])
187    sys.argv.extend(['--download-metis'])
188
189    sys.argv.extend(['--download-parmetis','--download-superlu_dist'])
190    sys.argv.extend(['--download-hypre'])
191
192    sys.argv.extend(['--with-cxx-dialect=C++11'])
193    if not argsStartswith('--with-boost'): sys.argv.extend(['--download-boost'])
194    sys.argv.extend(['--download-trilinos'])
195
196
197def chkwinf90():
198  for arg in sys.argv:
199    if (arg.find('win32fe') >= 0 and (arg.find('f90') >=0 or arg.find('ifort') >=0)):
200      return 1
201  return 0
202
203def chkdosfiles():
204  # cygwin - but not a hg clone - so check one of files in bin dir
205  if "\r\n" in open(os.path.join('bin','petscmpiexec'),"rb").read():
206    print '==============================================================================='
207    print ' *** Scripts are in DOS mode. Was winzip used to extract petsc sources?    ****'
208    print ' *** Please restart with a fresh tarball and use "tar -xzf petsc.tar.gz"   ****'
209    print '==============================================================================='
210    sys.exit(3)
211  return
212
213def chkcygwinlink():
214  if os.path.exists('/usr/bin/cygcheck.exe') and os.path.exists('/usr/bin/link.exe') and chkwinf90():
215      if '--ignore-cygwin-link' in sys.argv: return 0
216      print '==============================================================================='
217      print ' *** Cygwin /usr/bin/link detected! Compiles with CVF/Intel f90 can break!  **'
218      print ' *** To workarround do: "mv /usr/bin/link.exe /usr/bin/link-cygwin.exe"     **'
219      print ' *** Or to ignore this check, use configure option: --ignore-cygwin-link    **'
220      print '==============================================================================='
221      sys.exit(3)
222  return 0
223
224def chkbrokencygwin():
225  if os.path.exists('/usr/bin/cygcheck.exe'):
226    buf = os.popen('/usr/bin/cygcheck.exe -c cygwin').read()
227    if buf.find('1.5.11-1') > -1:
228      print '==============================================================================='
229      print ' *** cygwin-1.5.11-1 detected. ./configure fails with this version ***'
230      print ' *** Please upgrade to cygwin-1.5.12-1 or newer version. This can  ***'
231      print ' *** be done by running cygwin-setup, selecting "next" all the way.***'
232      print '==============================================================================='
233      sys.exit(3)
234  return 0
235
236def chkusingwindowspython():
237  if sys.platform == 'win32':
238    print '==============================================================================='
239    print ' *** Windows python detected. Please rerun ./configure with cygwin-python. ***'
240    print '==============================================================================='
241    sys.exit(3)
242  return 0
243
244def chkcygwinpython():
245  if sys.platform == 'cygwin' :
246    import platform
247    import re
248    r=re.compile("([0-9]+).([0-9]+).([0-9]+)")
249    m=r.match(platform.release())
250    major=int(m.group(1))
251    minor=int(m.group(2))
252    subminor=int(m.group(3))
253    if ((major < 1) or (major == 1 and minor < 7) or (major == 1 and minor == 7 and subminor < 34)):
254      sys.argv.append('--useThreads=0')
255      extraLogs.append('''\
256===============================================================================
257** Cygwin version is older than 1.7.34. Python threads do not work correctly. ***
258** Disabling thread usage for this run of ./configure *******
259===============================================================================''')
260  return 0
261
262def chkrhl9():
263  if os.path.exists('/etc/redhat-release'):
264    try:
265      file = open('/etc/redhat-release','r')
266      buf = file.read()
267      file.close()
268    except:
269      # can't read file - assume dangerous RHL9
270      buf = 'Shrike'
271    if buf.find('Shrike') > -1:
272      sys.argv.append('--useThreads=0')
273      extraLogs.append('''\
274==============================================================================
275   *** RHL9 detected. Threads do not work correctly with this distribution ***
276   ****** Disabling thread usage for this run of ./configure *********
277===============================================================================''')
278  return 0
279
280def check_broken_configure_log_links():
281  '''Sometime symlinks can get broken if the original files are deleted. Delete such broken links'''
282  import os
283  for logfile in ['configure.log','configure.log.bkp']:
284    if os.path.islink(logfile) and not os.path.isfile(logfile): os.remove(logfile)
285  return
286
287def move_configure_log(framework):
288  '''Move configure.log to PETSC_ARCH/lib/petsc/conf - and update configure.log.bkp in both locations appropriately'''
289  global petsc_arch
290
291  if hasattr(framework,'arch'): petsc_arch = framework.arch
292  if hasattr(framework,'logName'): curr_file = framework.logName
293  else: curr_file = 'configure.log'
294
295  if petsc_arch:
296    import shutil
297    import os
298
299    # Just in case - confdir is not created
300    lib_dir = os.path.join(petsc_arch,'lib')
301    conf_dir = os.path.join(petsc_arch,'lib','petsc','conf')
302    if not os.path.isdir(petsc_arch): os.mkdir(petsc_arch)
303    if not os.path.isdir(lib_dir): os.mkdir(lib_dir)
304    if not os.path.isdir(conf_dir): os.mkdir(conf_dir)
305
306    curr_bkp  = curr_file + '.bkp'
307    new_file  = os.path.join(conf_dir,curr_file)
308    new_bkp   = new_file + '.bkp'
309
310    # Keep backup in $PETSC_ARCH/lib/petsc/conf location
311    if os.path.isfile(new_bkp): os.remove(new_bkp)
312    if os.path.isfile(new_file): os.rename(new_file,new_bkp)
313    if os.path.isfile(curr_file):
314      shutil.copyfile(curr_file,new_file)
315      os.remove(curr_file)
316    if os.path.isfile(new_file): os.symlink(new_file,curr_file)
317    # If the old bkp is using the same PETSC_ARCH/lib/petsc/conf - then update bkp link
318    if os.path.realpath(curr_bkp) == os.path.realpath(new_file):
319      if os.path.isfile(curr_bkp): os.remove(curr_bkp)
320      if os.path.isfile(new_bkp): os.symlink(new_bkp,curr_bkp)
321  return
322
323def print_final_timestamp(framework):
324  import time
325  framework.log.write(('='*80)+'\n')
326  framework.log.write('Finishing Configure Run at '+time.ctime(time.time())+'\n')
327  framework.log.write(('='*80)+'\n')
328  return
329
330def petsc_configure(configure_options):
331  try:
332    petscdir = os.environ['PETSC_DIR']
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    msg ='*******************************************************************************\n'\
443    +'         CONFIGURATION FAILURE  (Please send configure.log to petsc-maint@mcs.anl.gov)\n' \
444    +'*******************************************************************************\n'
445    se  = str(e)
446  except Exception, e:
447    msg ='*******************************************************************************\n'\
448    +'        CONFIGURATION CRASH  (Please send configure.log to petsc-maint@mcs.anl.gov)\n' \
449    +'*******************************************************************************\n'
450    se  = str(e)
451
452  print msg
453  if not framework is None:
454    framework.logClear()
455    if hasattr(framework, 'log'):
456      try:
457        if hasattr(framework,'compilerDefines'):
458          framework.log.write('**** Configure header '+framework.compilerDefines+' ****\n')
459          framework.outputHeader(framework.log)
460        if hasattr(framework,'compilerFixes'):
461          framework.log.write('**** C specific Configure header '+framework.compilerFixes+' ****\n')
462          framework.outputCHeader(framework.log)
463      except Exception, e:
464        framework.log.write('Problem writing headers to log: '+str(e))
465      import traceback
466      try:
467        framework.log.write(msg+se)
468        traceback.print_tb(sys.exc_info()[2], file = framework.log)
469        print_final_timestamp(framework)
470        if hasattr(framework,'log'): framework.log.close()
471        move_configure_log(framework)
472      except:
473        pass
474      sys.exit(1)
475  else:
476    print se
477    import traceback
478    traceback.print_tb(sys.exc_info()[2])
479  if hasattr(framework,'log'): framework.log.close()
480
481if __name__ == '__main__':
482  petsc_configure([])
483
484