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