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