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