xref: /petsc/config/BuildSystem/script.py (revision 34e9cff27d07519c2d99d1c0a9fe31a7bc1659d3) !
1import sys
2if not hasattr(sys, 'version_info'):
3  print '*** Python version 1 is not supported. Please get the latest version from www.python.org ***'
4  sys.exit(4)
5
6import cPickle
7
8try:
9  import subprocess
10  USE_SUBPROCESS = 1
11except ImportError:
12  USE_SUBPROCESS = 0
13
14# Some features related to detecting login failures cannot be easily
15# implemented with the 'subprocess' module. Disable it for now ...
16USE_SUBPROCESS = 0
17# In Python 2.6 and above, the 'popen2' module is deprecated
18if sys.version_info[:2] >= (2, 6) and not USE_SUBPROCESS:
19  import warnings
20  warnings.filterwarnings('ignore', category=DeprecationWarning, module=__name__)
21
22import nargs
23useThreads = nargs.Arg.findArgument('useThreads', sys.argv[1:])
24if useThreads is None:
25  useThreads = 0 # workaround issue with parallel configure
26elif useThreads == 'no' or useThreads == '0':
27  useThreads = 0
28elif useThreads == 'yes' or useThreads == '1':
29  useThreads = 1
30else:
31  raise RuntimeError('Unknown option value for --useThreads ',useThreads)
32
33useSelect = nargs.Arg.findArgument('useSelect', sys.argv[1:])
34if useSelect is None:
35  useSelect = 1
36elif useSelect == 'no' or useSelect == '0':
37  useSelect = 0
38elif useSelect == 'yes' or useSelect == '1':
39  useSelect = 1
40else:
41  raise RuntimeError('Unknown option value for --useSelect ',useSelect)
42
43import logger
44
45class Script(logger.Logger):
46  def __init__(self, clArgs = None, argDB = None, log = None):
47    self.checkPython()
48    logger.Logger.__init__(self, clArgs, argDB, log)
49    self.shell = '/bin/sh'
50    self.showHelp = 1
51    return
52
53  def hasHelpFlag(self):
54    '''Decide whether to display the help message and exit'''
55    import nargs
56
57    if not self.showHelp:
58      return 0
59    if nargs.Arg.findArgument('help', self.clArgs) is None and nargs.Arg.findArgument('h', self.clArgs) is None:
60      return 0
61    return 1
62
63  def hasListFlag(self):
64    '''Decide whether to display the list of download files and exit'''
65    import nargs
66
67    if not self.showHelp:
68      return 0
69    if nargs.Arg.findArgument('with-packages-dir', self.clArgs) is None:
70      return 0
71    return 1
72
73  def setupArguments(self, argDB):
74    '''This method now also creates the help and action logs'''
75    import help
76
77    argDB = logger.Logger.setupArguments(self, argDB)
78
79    self.help = help.Help(argDB)
80    self.help.title = 'Script Help'
81
82    self.actions = help.Info(argDB)
83    self.actions.title = 'Script Actions'
84
85    self.setupHelp(self.help)
86    return argDB
87
88  def setupHelp(self, help):
89    '''This method should be overidden to provide help for arguments'''
90    import nargs
91
92    help.addArgument('Script', '-help', nargs.ArgBool(None, 0, 'Print this help message', isTemporary = 1), ignoreDuplicates = 1)
93    help.addArgument('Script', '-with-packages-dir', nargs.ArgDir(None,None, 'Directory to store downloaded external package tarballs', isTemporary = 1), ignoreDuplicates = 1)
94    help.addArgument('Script', '-h',    nargs.ArgBool(None, 0, 'Print this help message', isTemporary = 1), ignoreDuplicates = 1)
95    return help
96
97  def setup(self):
98    ''' This method checks to see whether help was requested'''
99    if hasattr(self, '_setup'):
100      return
101    logger.Logger.setup(self)
102    self._setup = 1
103    if self.hasHelpFlag():
104      self.argDB.readonly = True
105      if self.argDB.target == ['default']:
106        sections = None
107      else:
108        sections = self.argDB.target
109      self.help.output(sections = sections)
110      sys.exit()
111    if self.hasListFlag():
112      self.help.outputDownload()
113    return
114
115  def cleanup(self):
116    '''This method outputs the action log'''
117    self.actions.output(self.log)
118    return
119
120  def checkPython(self):
121    if not hasattr(sys, 'version_info') or float(sys.version_info[0]) != 2 or float(sys.version_info[1]) < 6:
122      raise RuntimeError('BuildSystem requires Python2 version 2.6 or higher. Get Python at http://www.python.org')
123    return
124
125  def getModule(root, name):
126    '''Retrieve a specific module from the directory root, bypassing the usual paths'''
127    import imp
128
129    (fp, pathname, description) = imp.find_module(name, [root])
130    try:
131      return imp.load_module(name, fp, pathname, description)
132    finally:
133      if fp: fp.close()
134    return
135  getModule = staticmethod(getModule)
136
137  def importModule(moduleName):
138    '''Import the named module, and return the module object
139       - Works properly for fully qualified names'''
140    module     = __import__(moduleName)
141    components = moduleName.split('.')
142    for comp in components[1:]:
143      module = getattr(module, comp)
144    return module
145  importModule = staticmethod(importModule)
146
147  if USE_SUBPROCESS:
148
149    def runShellCommand(command, log=None, cwd=None):
150      Popen = subprocess.Popen
151      PIPE  = subprocess.PIPE
152      if log: log.write('Executing: %s\n' % (command,))
153      pipe = Popen(command, cwd=cwd, stdin=None, stdout=PIPE, stderr=PIPE,
154                   bufsize=-1, shell=True, universal_newlines=True)
155      (out, err) = pipe.communicate()
156      ret = pipe.returncode
157      return (out, err, ret)
158
159  else:
160
161    def openPipe(command):
162      '''We need to use the asynchronous version here since we want to avoid blocking reads'''
163      import popen2
164
165      pipe = None
166      if hasattr(popen2, 'Popen3'):
167        pipe   = popen2.Popen3(command, 1)
168        input  = pipe.tochild
169        output = pipe.fromchild
170        err    = pipe.childerr
171      else:
172        import os
173        (input, output, err) = os.popen3(command)
174      return (input, output, err, pipe)
175    openPipe = staticmethod(openPipe)
176
177    def runShellCommand(command, log = None, cwd = None):
178      import select, os
179
180      ret        = None
181      out        = ''
182      err        = ''
183      loginError = 0
184      if cwd is not None:
185        oldpath = os.getcwd()
186        os.chdir(cwd)
187      if log: log.write('Executing: %s\n' % (command,))
188      (input, output, error, pipe) = Script.openPipe(command)
189      if cwd is not None:
190        os.chdir(oldpath)
191      input.close()
192      if useSelect:
193        outputClosed = 0
194        errorClosed  = 0
195        lst = [output, error]
196        while 1:
197          try:
198            ready = select.select(lst, [], [])
199          except Exception, e:
200            if log: log.write('** Error calling select() : '+str(e)+'\n')
201            continue
202          if len(ready[0]):
203            if error in ready[0]:
204              msg = error.readline()
205              if msg:
206                err += msg
207              else:
208                errorClosed = 1
209                lst.remove(error)
210            if output in ready[0]:
211              msg = output.readline()
212              if msg:
213                out += msg
214              else:
215                outputClosed = 1
216                lst.remove(output)
217            if msg and msg.find('password:') >= 0:
218              loginError = 1
219              break
220          if outputClosed and errorClosed:
221            break
222      else:
223        out = output.read()
224        err = error.read()
225      output.close()
226      error.close()
227      if pipe:
228        # We would like the NOHANG argument here
229        ret = pipe.wait()
230      if loginError:
231        raise RuntimeError('Could not login to site')
232      return (out, err, ret)
233
234  runShellCommand = staticmethod(runShellCommand)
235
236  def defaultCheckCommand(command, status, output, error):
237    '''Raise an error if the exit status is nonzero'''
238    if status: raise RuntimeError('Could not execute "%s":\n%s' % (command,output+error))
239  defaultCheckCommand = staticmethod(defaultCheckCommand)
240
241  def executeShellCommand(command, checkCommand = None, timeout = 600.0, log = None, lineLimit = 0, cwd=None):
242    '''Execute a shell command returning the output, and optionally provide a custom error checker
243       - This returns a tuple of the (output, error, statuscode)'''
244    if not checkCommand:
245      checkCommand = Script.defaultCheckCommand
246    if log is None:
247      log = logger.Logger.defaultLog
248    def logOutput(log, output):
249      import re
250      # get rid of multiple blank lines
251      output = re.sub('\n+','\n', output).strip()
252      if output:
253        if lineLimit:
254          output = '\n'.join(output.split('\n')[:lineLimit])
255        if '\n' in output:      # multi-line output
256          log.write('stdout:\n'+output+'\n')
257        else:
258          log.write('stdout: '+output+'\n')
259      return output
260    def runInShell(command, log, cwd):
261      if useThreads:
262        import threading
263        class InShell(threading.Thread):
264          def __init__(self):
265            threading.Thread.__init__(self)
266            self.name = 'Shell Command'
267            self.setDaemon(1)
268          def run(self):
269            (self.output, self.error, self.status) = ('', '', -1) # So these fields exist even if command fails with no output
270            (self.output, self.error, self.status) = Script.runShellCommand(command, log, cwd)
271        thread = InShell()
272        thread.start()
273        thread.join(timeout)
274        if thread.isAlive():
275          error = 'Runaway process exceeded time limit of '+str(timeout)+'s\n'
276          log.write(error)
277          return ('', error, -1)
278        else:
279          return (thread.output, thread.error, thread.status)
280      else:
281        return Script.runShellCommand(command, log, cwd)
282
283    (output, error, status) = runInShell(command, log, cwd)
284    output = logOutput(log, output)
285    checkCommand(command, status, output, error)
286    return (output, error, status)
287  executeShellCommand = staticmethod(executeShellCommand)
288
289  def loadConfigure(self, argDB = None):
290    if argDB is None:
291      argDB = self.argDB
292    if not 'configureCache' in argDB:
293      self.logPrint('No cached configure in RDict at '+str(argDB.saveFilename))
294      return None
295    try:
296      cache = argDB['configureCache']
297      framework = cPickle.loads(cache)
298      framework.framework = framework
299      framework.argDB = argDB
300      self.logPrint('Loaded configure to cache: size '+str(len(cache)))
301    except cPickle.UnpicklingError, e:
302      framework = None
303      self.logPrint('Invalid cached configure: '+str(e))
304    return framework
305
306import args
307
308class LanguageProcessor(args.ArgumentProcessor):
309  def __init__(self, clArgs = None, argDB = None, framework = None, versionControl = None):
310    self.languageModule      = {}
311    self.preprocessorObject  = {}
312    self.compilerObject      = {}
313    self.linkerObject        = {}
314    self.sharedLinkerObject  = {}
315    self.dynamicLinkerObject = {}
316    self.framework           = framework
317    self.versionControl      = versionControl
318    args.ArgumentProcessor.__init__(self, clArgs, argDB)
319    self.outputFiles         = {}
320    self.modulePath          = 'config.compile'
321    return
322
323  def getCompilers(self):
324    if self.framework is None:
325      return
326    return self.framework.require('config.compilers', None)
327  compilers = property(getCompilers, doc = 'The config.compilers configure object')
328  def getLibraries(self):
329    if self.framework is None:
330      return
331    return self.framework.require('config.libraries', None)
332  libraries = property(getLibraries, doc = 'The config.libraries configure object')
333
334  def __getstate__(self, d = None):
335    '''We only want to pickle the language module names and output files. The other objects are set by configure.'''
336    if d is None:
337      d = args.ArgumentProcessor.__getstate__(self)
338    if 'languageModule' in d:
339      d['languageModule'] = dict([(lang,mod._loadName) for lang,mod in d['languageModule'].items()])
340    for member in ['preprocessorObject', 'compilerObject', 'linkerObject', 'sharedLinkerObject', 'dynamicLinkerObject', 'framework']:
341      if member in d:
342        del d[member]
343    return d
344
345  def __setstate__(self, d):
346    '''We must create the language modules'''
347    args.ArgumentProcessor.__setstate__(self, d)
348    self.__dict__.update(d)
349    [self.getLanguageModule(language, moduleName) for language,moduleName in self.languageModule.items()]
350    self.preprocessorObject  = {}
351    self.compilerObject      = {}
352    self.linkerObject        = {}
353    self.sharedLinkerObject  = {}
354    self.dynamicLinkerObject = {}
355    return
356
357  def setArgDB(self, argDB):
358    args.ArgumentProcessor.setArgDB(self, argDB)
359    for obj in self.preprocessorObject.values():
360      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
361        obj.argDB = argDB
362    for obj in self.compilerObject.values():
363      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
364        obj.argDB = argDB
365    for obj in self.linkerObject.values():
366      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
367        obj.argDB = argDB
368    for obj in self.sharedLinkerObject.values():
369      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
370        obj.argDB = argDB
371    for obj in self.dynamicLinkerObject.values():
372      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
373        obj.argDB = argDB
374    if not self.compilers is None:
375      self.compilers.argDB = argDB
376      for obj in self.preprocessorObject.values():
377        if hasattr(obj, 'configCompilers'):
378          obj.configCompilers.argDB = argDB
379      for obj in self.compilerObject.values():
380        if hasattr(obj, 'configCompilers'):
381          obj.configCompilers.argDB = argDB
382      for obj in self.linkerObject.values():
383        if hasattr(obj, 'configCompilers'):
384          obj.configCompilers.argDB = argDB
385      for obj in self.sharedLinkerObject.values():
386        if hasattr(obj, 'configCompilers'):
387          obj.configCompilers.argDB = argDB
388      for obj in self.dynamicLinkerObject.values():
389        if hasattr(obj, 'configCompilers'):
390          obj.configCompilers.argDB = argDB
391    if not self.libraries is None:
392      self.libraries.argDB = argDB
393      for obj in self.linkerObject.values():
394        if hasattr(obj, 'configLibraries'):
395          obj.configLibraries.argDB = argDB
396      for obj in self.sharedLinkerObject.values():
397        if hasattr(obj, 'configLibraries'):
398          obj.configLibraries.argDB = argDB
399      for obj in self.dynamicLinkerObject.values():
400        if hasattr(obj, 'configLibraries'):
401          obj.configLibraries.argDB = argDB
402    return
403  argDB = property(args.ArgumentProcessor.getArgDB, setArgDB, doc = 'The RDict argument database')
404
405  def getLanguageModule(self, language, moduleName = None):
406    '''Return the module associated with operations for a given language
407       - Giving a moduleName explicitly forces a reimport'''
408    if not language in self.languageModule or not moduleName is None:
409      try:
410        if moduleName is None:
411          moduleName = self.modulePath+'.'+language
412        module     = __import__(moduleName)
413      except ImportError, e:
414        if not moduleName is None:
415          self.logPrint('Failure to find language module: '+str(e))
416        try:
417          moduleName = self.modulePath+'.'+language
418          module     = __import__(moduleName)
419        except ImportError, e:
420          self.logPrint('Failure to find language module: '+str(e))
421          moduleName = 'config.compile.'+language
422          module     = __import__(moduleName)
423      components = moduleName.split('.')
424      for component in components[1:]:
425        module   = getattr(module, component)
426      module._loadName = moduleName
427      self.languageModule[language] = module
428    return self.languageModule[language]
429
430  def getPreprocessorObject(self, language):
431    if not language in self.preprocessorObject:
432      self.preprocessorObject[language] = self.getLanguageModule(language).Preprocessor(self.argDB)
433      self.preprocessorObject[language].setup()
434    if not self.compilers is None:
435      self.preprocessorObject[language].configCompilers = self.compilers
436    if not self.versionControl is None:
437      self.preprocessorObject[language].versionControl  = self.versionControl
438    return self.preprocessorObject[language]
439
440  def setPreprocessorObject(self, language, preprocessor):
441    self.preprocessorObject[language] = preprocessor
442    return self.getPreprocessorObject(language)
443
444  def getCompilerObject(self, language):
445    if not language in self.compilerObject:
446      self.compilerObject[language] = self.getLanguageModule(language).Compiler(self.argDB)
447      self.compilerObject[language].setup()
448    if not self.compilers is None:
449      self.compilerObject[language].configCompilers = self.compilers
450    if not self.versionControl is None:
451      self.compilerObject[language].versionControl  = self.versionControl
452    return self.compilerObject[language]
453
454  def setCompilerObject(self, language, compiler):
455    self.compilerObject[language] = compiler
456    return self.getCompilerObject(language)
457
458  def getLinkerObject(self, language):
459    if not language in self.linkerObject:
460      self.linkerObject[language] = self.getLanguageModule(language).Linker(self.argDB)
461      self.linkerObject[language].setup()
462    if not self.compilers is None:
463      self.linkerObject[language].configCompilers = self.compilers
464    if not self.libraries is None:
465      self.linkerObject[language].configLibraries = self.libraries
466    if not self.versionControl is None:
467      self.linkerObject[language].versionControl  = self.versionControl
468    return self.linkerObject[language]
469
470  def setLinkerObject(self, language, linker):
471    self.linkerObject[language] = linker
472    return self.getLinkerObject(language)
473
474  def getSharedLinkerObject(self, language):
475    if not language in self.sharedLinkerObject:
476      self.sharedLinkerObject[language] = self.getLanguageModule(language).SharedLinker(self.argDB)
477      self.sharedLinkerObject[language].setup()
478    if not self.compilers is None:
479      self.sharedLinkerObject[language].configCompilers = self.compilers
480    if not self.libraries is None:
481      self.sharedLinkerObject[language].configLibraries = self.libraries
482    if not self.versionControl is None:
483      self.sharedLinkerObject[language].versionControl  = self.versionControl
484    return self.sharedLinkerObject[language]
485
486  def setSharedLinkerObject(self, language, linker):
487    self.sharedLinkerObject[language] = linker
488    return self.getSharedLinkerObject(language)
489
490  def getDynamicLinkerObject(self, language):
491    if not language in self.dynamicLinkerObject:
492      self.dynamicLinkerObject[language] = self.getLanguageModule(language).DynamicLinker(self.argDB)
493      self.dynamicLinkerObject[language].setup()
494    if not self.compilers is None:
495      self.dynamicLinkerObject[language].configCompilers = self.compilers
496    if not self.libraries is None:
497      self.dynamicLinkerObject[language].configLibraries = self.libraries
498    if not self.versionControl is None:
499      self.dynamicLinkerObject[language].versionControl  = self.versionControl
500    return self.dynamicLinkerObject[language]
501
502  def setDynamicLinkerObject(self, language, linker):
503    self.dynamicLinkerObject[language] = linker
504    return self.getDynamicLinkerObject(language)
505