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