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