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