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