xref: /petsc/config/BuildSystem/script.py (revision 35140aeb567897a66e33daa0f5abf95e5851983e)
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 https://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)
153        (out, err) = pipe.communicate()
154        if sys.version_info >= (3,0):
155          out = out.decode(encoding='UTF-8',errors='replace')
156          err = err.decode(encoding='UTF-8',errors='replace')
157        ret = pipe.returncode
158      except Exception as e:
159        return ('', e.message, e.errno)
160      output += out
161      error += err
162      if ret:
163        break
164    return (output, error, ret)
165
166  def defaultCheckCommand(command, status, output, error):
167    '''Raise an error if the exit status is nonzero'''
168    if status: raise RuntimeError('Could not execute "%s":\n%s' % (command,output+error))
169  defaultCheckCommand = staticmethod(defaultCheckCommand)
170
171  @staticmethod
172  def executeShellCommand(command, checkCommand = None, timeout = 600.0, log = None, lineLimit = 0, cwd=None, logOutputflg = True):
173    '''Execute a shell command returning the output, and optionally provide a custom error checker
174       - This returns a tuple of the (output, error, statuscode)'''
175    return Script.executeShellCommandSeq([command], checkCommand=checkCommand, timeout=timeout, log=log, lineLimit=lineLimit, cwd=cwd,logOutputflg = logOutputflg)
176
177  @staticmethod
178  def executeShellCommandSeq(commandseq, checkCommand = None, timeout = 600.0, log = None, lineLimit = 0, cwd=None, logOutputflg = True):
179    '''Execute a sequence of shell commands (an && chain) returning the output, and optionally provide a custom error checker
180       - This returns a tuple of the (output, error, statuscode)'''
181    if not checkCommand:
182      checkCommand = Script.defaultCheckCommand
183    if log is None:
184      log = logger.Logger.defaultLog
185    def logOutput(log, output, logOutputflg):
186      import re
187      if not logOutputflg: return output
188      # get rid of multiple blank lines
189      output = re.sub('\n+','\n', output).strip()
190      if output:
191        if lineLimit:
192          output = '\n'.join(output.split('\n')[:lineLimit])
193        if '\n' in output:      # multi-line output
194          log.write('stdout:\n'+output+'\n')
195        else:
196          log.write('stdout: '+output+'\n')
197      return output
198    def runInShell(commandseq, log, cwd):
199      if useThreads:
200        import threading
201        class InShell(threading.Thread):
202          def __init__(self):
203            threading.Thread.__init__(self)
204            self.name = 'Shell Command'
205            self.setDaemon(1)
206          def run(self):
207            (self.output, self.error, self.status) = ('', '', -1) # So these fields exist even if command fails with no output
208            (self.output, self.error, self.status) = Script.runShellCommandSeq(commandseq, log, cwd)
209        thread = InShell()
210        thread.start()
211        thread.join(timeout)
212        if thread.isAlive():
213          error = 'Runaway process exceeded time limit of '+str(timeout)+'s\n'
214          log.write(error)
215          return ('', error, -1)
216        else:
217          return (thread.output, thread.error, thread.status)
218      else:
219        return Script.runShellCommandSeq(commandseq, log, cwd)
220
221    (output, error, status) = runInShell(commandseq, log, cwd)
222    output = logOutput(log, output,logOutputflg)
223    checkCommand(commandseq, status, output, error)
224    return (output, error, status)
225
226  def loadConfigure(self, argDB = None):
227    if argDB is None:
228      argDB = self.argDB
229    if not 'configureCache' in argDB:
230      self.logPrint('No cached configure in RDict at '+str(argDB.saveFilename))
231      return None
232    try:
233      cache = argDB['configureCache']
234      framework = pickle.loads(cache)
235      framework.framework = framework
236      framework.argDB = argDB
237      self.logPrint('Loaded configure to cache: size '+str(len(cache)))
238    except pickle.UnpicklingError as e:
239      framework = None
240      self.logPrint('Invalid cached configure: '+str(e))
241    return framework
242
243import args
244
245class LanguageProcessor(args.ArgumentProcessor):
246  def __init__(self, clArgs = None, argDB = None, framework = None, versionControl = None):
247    self.languageModule      = {}
248    self.preprocessorObject  = {}
249    self.compilerObject      = {}
250    self.linkerObject        = {}
251    self.sharedLinkerObject  = {}
252    self.dynamicLinkerObject = {}
253    self.framework           = framework
254    self.versionControl      = versionControl
255    args.ArgumentProcessor.__init__(self, clArgs, argDB)
256    self.outputFiles         = {}
257    self.modulePath          = 'config.compile'
258    return
259
260  def getCompilers(self):
261    if self.framework is None:
262      return
263    return self.framework.require('config.compilers', None)
264  compilers = property(getCompilers, doc = 'The config.compilers configure object')
265  def getLibraries(self):
266    if self.framework is None:
267      return
268    return self.framework.require('config.libraries', None)
269  libraries = property(getLibraries, doc = 'The config.libraries configure object')
270
271  def __getstate__(self, d = None):
272    '''We only want to pickle the language module names and output files. The other objects are set by configure.'''
273    if d is None:
274      d = args.ArgumentProcessor.__getstate__(self)
275    if 'languageModule' in d:
276      d['languageModule'] = dict([(lang,mod._loadName) for lang,mod in d['languageModule'].items()])
277    for member in ['preprocessorObject', 'compilerObject', 'linkerObject', 'sharedLinkerObject', 'dynamicLinkerObject', 'framework']:
278      if member in d:
279        del d[member]
280    return d
281
282  def __setstate__(self, d):
283    '''We must create the language modules'''
284    args.ArgumentProcessor.__setstate__(self, d)
285    self.__dict__.update(d)
286    [self.getLanguageModule(language, moduleName) for language,moduleName in self.languageModule.items()]
287    self.preprocessorObject  = {}
288    self.compilerObject      = {}
289    self.linkerObject        = {}
290    self.sharedLinkerObject  = {}
291    self.dynamicLinkerObject = {}
292    return
293
294  def setArgDB(self, argDB):
295    args.ArgumentProcessor.setArgDB(self, argDB)
296    for obj in self.preprocessorObject.values():
297      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
298        obj.argDB = argDB
299    for obj in self.compilerObject.values():
300      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
301        obj.argDB = argDB
302    for obj in self.linkerObject.values():
303      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
304        obj.argDB = argDB
305    for obj in self.sharedLinkerObject.values():
306      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
307        obj.argDB = argDB
308    for obj in self.dynamicLinkerObject.values():
309      if not hasattr(obj, 'argDB') or not obj.argDB == argDB:
310        obj.argDB = argDB
311    if not self.compilers is None:
312      self.compilers.argDB = argDB
313      for obj in self.preprocessorObject.values():
314        if hasattr(obj, 'configCompilers'):
315          obj.configCompilers.argDB = argDB
316      for obj in self.compilerObject.values():
317        if hasattr(obj, 'configCompilers'):
318          obj.configCompilers.argDB = argDB
319      for obj in self.linkerObject.values():
320        if hasattr(obj, 'configCompilers'):
321          obj.configCompilers.argDB = argDB
322      for obj in self.sharedLinkerObject.values():
323        if hasattr(obj, 'configCompilers'):
324          obj.configCompilers.argDB = argDB
325      for obj in self.dynamicLinkerObject.values():
326        if hasattr(obj, 'configCompilers'):
327          obj.configCompilers.argDB = argDB
328    if not self.libraries is None:
329      self.libraries.argDB = argDB
330      for obj in self.linkerObject.values():
331        if hasattr(obj, 'configLibraries'):
332          obj.configLibraries.argDB = argDB
333      for obj in self.sharedLinkerObject.values():
334        if hasattr(obj, 'configLibraries'):
335          obj.configLibraries.argDB = argDB
336      for obj in self.dynamicLinkerObject.values():
337        if hasattr(obj, 'configLibraries'):
338          obj.configLibraries.argDB = argDB
339    return
340  argDB = property(args.ArgumentProcessor.getArgDB, setArgDB, doc = 'The RDict argument database')
341
342  def getLanguageModule(self, language, moduleName = None):
343    '''Return the module associated with operations for a given language
344       - Giving a moduleName explicitly forces a reimport'''
345    if not language in self.languageModule or not moduleName is None:
346      try:
347        if moduleName is None:
348          moduleName = self.modulePath+'.'+language
349        module     = __import__(moduleName)
350      except ImportError as e:
351        if not moduleName is None:
352          self.logPrint('Failure to find language module: '+str(e))
353        try:
354          moduleName = self.modulePath+'.'+language
355          module     = __import__(moduleName)
356        except ImportError as e:
357          self.logPrint('Failure to find language module: '+str(e))
358          moduleName = 'config.compile.'+language
359          module     = __import__(moduleName)
360      components = moduleName.split('.')
361      for component in components[1:]:
362        module   = getattr(module, component)
363      module._loadName = moduleName
364      self.languageModule[language] = module
365    return self.languageModule[language]
366
367  def getPreprocessorObject(self, language):
368    if not language in self.preprocessorObject:
369      self.preprocessorObject[language] = self.getLanguageModule(language).Preprocessor(self.argDB)
370      self.preprocessorObject[language].setup()
371    if not self.compilers is None:
372      self.preprocessorObject[language].configCompilers = self.compilers
373    if not self.versionControl is None:
374      self.preprocessorObject[language].versionControl  = self.versionControl
375    return self.preprocessorObject[language]
376
377  def setPreprocessorObject(self, language, preprocessor):
378    self.preprocessorObject[language] = preprocessor
379    return self.getPreprocessorObject(language)
380
381  def getCompilerObject(self, language):
382    if not language in self.compilerObject:
383      self.compilerObject[language] = self.getLanguageModule(language).Compiler(self.argDB)
384      self.compilerObject[language].setup()
385    if not self.compilers is None:
386      self.compilerObject[language].configCompilers = self.compilers
387    if not self.versionControl is None:
388      self.compilerObject[language].versionControl  = self.versionControl
389    return self.compilerObject[language]
390
391  def setCompilerObject(self, language, compiler):
392    self.compilerObject[language] = compiler
393    return self.getCompilerObject(language)
394
395  def getLinkerObject(self, language):
396    if not language in self.linkerObject:
397      self.linkerObject[language] = self.getLanguageModule(language).Linker(self.argDB)
398      self.linkerObject[language].setup()
399    if not self.compilers is None:
400      self.linkerObject[language].configCompilers = self.compilers
401    if not self.libraries is None:
402      self.linkerObject[language].configLibraries = self.libraries
403    if not self.versionControl is None:
404      self.linkerObject[language].versionControl  = self.versionControl
405    return self.linkerObject[language]
406
407  def setLinkerObject(self, language, linker):
408    self.linkerObject[language] = linker
409    return self.getLinkerObject(language)
410
411  def getSharedLinkerObject(self, language):
412    if not language in self.sharedLinkerObject:
413      self.sharedLinkerObject[language] = self.getLanguageModule(language).SharedLinker(self.argDB)
414      self.sharedLinkerObject[language].setup()
415    if not self.compilers is None:
416      self.sharedLinkerObject[language].configCompilers = self.compilers
417    if not self.libraries is None:
418      self.sharedLinkerObject[language].configLibraries = self.libraries
419    if not self.versionControl is None:
420      self.sharedLinkerObject[language].versionControl  = self.versionControl
421    return self.sharedLinkerObject[language]
422
423  def setSharedLinkerObject(self, language, linker):
424    self.sharedLinkerObject[language] = linker
425    return self.getSharedLinkerObject(language)
426
427  def getDynamicLinkerObject(self, language):
428    if not language in self.dynamicLinkerObject:
429      self.dynamicLinkerObject[language] = self.getLanguageModule(language).DynamicLinker(self.argDB)
430      self.dynamicLinkerObject[language].setup()
431    if not self.compilers is None:
432      self.dynamicLinkerObject[language].configCompilers = self.compilers
433    if not self.libraries is None:
434      self.dynamicLinkerObject[language].configLibraries = self.libraries
435    if not self.versionControl is None:
436      self.dynamicLinkerObject[language].versionControl  = self.versionControl
437    return self.dynamicLinkerObject[language]
438
439  def setDynamicLinkerObject(self, language, linker):
440    self.dynamicLinkerObject[language] = linker
441    return self.getDynamicLinkerObject(language)
442