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