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