import shutil, time, os, sys, json, tempfile, copy, shlex, atexit, subprocess, hashlib, cPickle, re, errno from subprocess import Popen, PIPE, STDOUT from tempfile import mkstemp from distutils.spawn import find_executable import jsrun, cache, tempfiles import response_file import logging, platform def listify(x): if type(x) is not list: return [x] return x # Temp file utilities from tempfiles import try_delete # On Windows python suffers from a particularly nasty bug if python is spawning new processes while python itself is spawned from some other non-console process. # Use a custom replacement for Popen on Windows to avoid the "WindowsError: [Error 6] The handle is invalid" errors when emcc is driven through cmake or mingw32-make. # See http://bugs.python.org/issue3905 class WindowsPopen: def __init__(self, args, bufsize=0, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=False, shell=False, cwd=None, env=None, universal_newlines=False, startupinfo=None, creationflags=0): self.stdin = stdin self.stdout = stdout self.stderr = stderr # (stdin, stdout, stderr) store what the caller originally wanted to be done with the streams. # (stdin_, stdout_, stderr_) will store the fixed set of streams that workaround the bug. self.stdin_ = stdin self.stdout_ = stdout self.stderr_ = stderr # If the caller wants one of these PIPEd, we must PIPE them all to avoid the 'handle is invalid' bug. if self.stdin_ == PIPE or self.stdout_ == PIPE or self.stderr_ == PIPE: if self.stdin_ == None: self.stdin_ = PIPE if self.stdout_ == None: self.stdout_ = PIPE if self.stderr_ == None: self.stderr_ = PIPE # emscripten.py supports reading args from a response file instead of cmdline. # Use .rsp to avoid cmdline length limitations on Windows. if len(args) >= 2 and args[1].endswith("emscripten.py"): response_filename = response_file.create_response_file(args[2:], TEMP_DIR) args = args[0:2] + ['@' + response_filename] try: # Call the process with fixed streams. self.process = subprocess.Popen(args, bufsize, executable, self.stdin_, self.stdout_, self.stderr_, preexec_fn, close_fds, shell, cwd, env, universal_newlines, startupinfo, creationflags) self.pid = self.process.pid except Exception, e: logging.error('\nsubprocess.Popen(args=%s) failed! Exception %s\n' % (' '.join(args), str(e))) raise e def communicate(self, input=None): output = self.process.communicate(input) self.returncode = self.process.returncode # If caller never wanted to PIPE stdout or stderr, route the output back to screen to avoid swallowing output. if self.stdout == None and self.stdout_ == PIPE and len(output[0].strip()) > 0: print >> sys.stdout, output[0] if self.stderr == None and self.stderr_ == PIPE and len(output[1].strip()) > 0: print >> sys.stderr, output[1] # Return a mock object to the caller. This works as long as all emscripten code immediately .communicate()s the result, and doesn't # leave the process object around for longer/more exotic uses. if self.stdout == None and self.stderr == None: return (None, None) if self.stdout == None: return (None, output[1]) if self.stderr == None: return (output[0], None) return (output[0], output[1]) def poll(self): return self.process.poll() def kill(self): return self.process.kill() __rootpath__ = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) def path_from_root(*pathelems): return os.path.join(__rootpath__, *pathelems) def add_coloring_to_emit_windows(fn): def _out_handle(self): import ctypes return ctypes.windll.kernel32.GetStdHandle(self.STD_OUTPUT_HANDLE) out_handle = property(_out_handle) def _set_color(self, code): import ctypes # Constants from the Windows API self.STD_OUTPUT_HANDLE = -11 hdl = ctypes.windll.kernel32.GetStdHandle(self.STD_OUTPUT_HANDLE) ctypes.windll.kernel32.SetConsoleTextAttribute(hdl, code) setattr(logging.StreamHandler, '_set_color', _set_color) def new(*args): FOREGROUND_BLUE = 0x0001 # text color contains blue. FOREGROUND_GREEN = 0x0002 # text color contains green. FOREGROUND_RED = 0x0004 # text color contains red. FOREGROUND_INTENSITY = 0x0008 # text color is intensified. FOREGROUND_WHITE = FOREGROUND_BLUE|FOREGROUND_GREEN |FOREGROUND_RED # winbase.h STD_INPUT_HANDLE = -10 STD_OUTPUT_HANDLE = -11 STD_ERROR_HANDLE = -12 # wincon.h FOREGROUND_BLACK = 0x0000 FOREGROUND_BLUE = 0x0001 FOREGROUND_GREEN = 0x0002 FOREGROUND_CYAN = 0x0003 FOREGROUND_RED = 0x0004 FOREGROUND_MAGENTA = 0x0005 FOREGROUND_YELLOW = 0x0006 FOREGROUND_GREY = 0x0007 FOREGROUND_INTENSITY = 0x0008 # foreground color is intensified. BACKGROUND_BLACK = 0x0000 BACKGROUND_BLUE = 0x0010 BACKGROUND_GREEN = 0x0020 BACKGROUND_CYAN = 0x0030 BACKGROUND_RED = 0x0040 BACKGROUND_MAGENTA = 0x0050 BACKGROUND_YELLOW = 0x0060 BACKGROUND_GREY = 0x0070 BACKGROUND_INTENSITY = 0x0080 # background color is intensified. levelno = args[1].levelno if(levelno >= 50): color = BACKGROUND_YELLOW | FOREGROUND_RED | FOREGROUND_INTENSITY | BACKGROUND_INTENSITY elif(levelno >= 40): color = FOREGROUND_RED | FOREGROUND_INTENSITY elif(levelno >= 30): color = FOREGROUND_YELLOW | FOREGROUND_INTENSITY elif(levelno >= 20): color = FOREGROUND_GREEN elif(levelno >= 10): color = FOREGROUND_MAGENTA else: color = FOREGROUND_WHITE args[0]._set_color(color) ret = fn(*args) args[0]._set_color( FOREGROUND_WHITE ) #print "after" return ret return new def add_coloring_to_emit_ansi(fn): # add methods we need to the class def new(*args): levelno = args[1].levelno if(levelno >= 50): color = '\x1b[31m' # red elif(levelno >= 40): color = '\x1b[31m' # red elif(levelno >= 30): color = '\x1b[33m' # yellow elif(levelno >= 20): color = '\x1b[32m' # green elif(levelno >= 10): color = '\x1b[35m' # pink else: color = '\x1b[0m' # normal args[1].msg = color + args[1].msg + '\x1b[0m' # normal #print "after" return fn(*args) return new WINDOWS = sys.platform.startswith('win') if WINDOWS: logging.StreamHandler.emit = add_coloring_to_emit_windows(logging.StreamHandler.emit) else: logging.StreamHandler.emit = add_coloring_to_emit_ansi(logging.StreamHandler.emit) # Emscripten configuration is done through the --em-config command line option or # the EM_CONFIG environment variable. If the specified string value contains newline # or semicolon-separated definitions, then these definitions will be used to configure # Emscripten. Otherwise, the string is understood to be a path to a settings # file that contains the required definitions. try: EM_CONFIG = sys.argv[sys.argv.index('--em-config')+1] # Emscripten compiler spawns other processes, which can reimport shared.py, so make sure that # those child processes get the same configuration file by setting it to the currently active environment. os.environ['EM_CONFIG'] = EM_CONFIG except: EM_CONFIG = os.environ.get('EM_CONFIG') if EM_CONFIG and not os.path.isfile(EM_CONFIG): if EM_CONFIG.startswith('-'): raise Exception('Passed --em-config without an argument. Usage: --em-config /path/to/.emscripten or --em-config EMSCRIPTEN_ROOT=/path/;LLVM_ROOT=/path;...') if not '=' in EM_CONFIG: raise Exception('File ' + EM_CONFIG + ' passed to --em-config does not exist!') else: EM_CONFIG = EM_CONFIG.replace(';', '\n') + '\n' if not EM_CONFIG: EM_CONFIG = '~/.emscripten' if '\n' in EM_CONFIG: CONFIG_FILE = None else: CONFIG_FILE = os.path.expanduser(EM_CONFIG) if not os.path.exists(CONFIG_FILE): # Note: repr is used to ensure the paths are escaped correctly on Windows. # The full string is replaced so that the template stays valid Python. config_file = open(path_from_root('tools', 'settings_template_readonly.py')).read().split('\n') config_file = config_file[1:] # remove "this file will be copied..." config_file = '\n'.join(config_file) # autodetect some default paths config_file = config_file.replace('\'{{{ EMSCRIPTEN_ROOT }}}\'', repr(__rootpath__)) llvm_root = os.path.dirname(find_executable('llvm-dis') or '/usr/bin/llvm-dis') config_file = config_file.replace('\'{{{ LLVM_ROOT }}}\'', repr(llvm_root)) node = find_executable('node') or find_executable('nodejs') or 'node' config_file = config_file.replace('\'{{{ NODE }}}\'', repr(node)) python = find_executable('python2') or find_executable('python') or \ sys.executable or 'python' config_file = config_file.replace('\'{{{ PYTHON }}}\'', repr(python)) if WINDOWS: tempdir = os.environ.get('TEMP') or os.environ.get('TMP') or 'c:\\temp' else: tempdir = '/tmp' config_file = config_file.replace('\'{{{ TEMP }}}\'', repr(tempdir)) # write open(CONFIG_FILE, 'w').write(config_file) print >> sys.stderr, ''' ============================================================================== Welcome to Emscripten! This is the first time any of the Emscripten tools has been run. A settings file has been copied to %s, at absolute path: %s It contains our best guesses for the important paths, which are: LLVM_ROOT = %s PYTHON = %s NODE_JS = %s EMSCRIPTEN_ROOT = %s Please edit the file if any of those are incorrect. This command will now exit. When you are done editing those paths, re-run it. ============================================================================== ''' % (EM_CONFIG, CONFIG_FILE, llvm_root, python, node, __rootpath__) sys.exit(0) try: config_text = open(CONFIG_FILE, 'r').read() if CONFIG_FILE else EM_CONFIG exec(config_text) except Exception, e: logging.error('Error in evaluating %s (at %s): %s, text: %s' % (EM_CONFIG, CONFIG_FILE, str(e), config_text)) sys.exit(1) try: EM_POPEN_WORKAROUND except: EM_POPEN_WORKAROUND = os.environ.get('EM_POPEN_WORKAROUND') # Install our replacement Popen handler if we are running on Windows to avoid python spawn process function. # nb. This is by default disabled since it has the adverse effect of buffering up all logging messages, which makes # builds look unresponsive (messages are printed only after the whole build finishes). Whether this workaround is needed # seems to depend on how the host application that invokes emcc has set up its stdout and stderr. if EM_POPEN_WORKAROUND and os.name == 'nt': logging.debug('Installing Popen workaround handler to avoid bug http://bugs.python.org/issue3905') Popen = WindowsPopen # Expectations EXPECTED_LLVM_VERSION = (3,2) def check_clang_version(): expected = 'clang version ' + '.'.join(map(str, EXPECTED_LLVM_VERSION)) actual = Popen([CLANG, '-v'], stderr=PIPE).communicate()[1].split('\n')[0] if expected in actual: return True logging.warning('LLVM version appears incorrect (seeing "%s", expected "%s")' % (actual, expected)) return False def check_llvm_version(): try: check_clang_version() except Exception, e: logging.warning('Could not verify LLVM version: %s' % str(e)) EXPECTED_NODE_VERSION = (0,8,0) def check_node_version(): try: node = listify(NODE_JS) actual = Popen(node + ['--version'], stdout=PIPE).communicate()[0].strip() version = tuple(map(int, actual.replace('v', '').replace('-pre', '').split('.'))) if version >= EXPECTED_NODE_VERSION: return True logging.warning('node version appears too old (seeing "%s", expected "%s")' % (actual, 'v' + ('.'.join(map(str, EXPECTED_NODE_VERSION))))) return False except Exception, e: logging.warning('cannot check node version: %s', e) return False # Finds the system temp directory without resorting to using the one configured in .emscripten def find_temp_directory(): if WINDOWS: if os.getenv('TEMP') and os.path.isdir(os.getenv('TEMP')): return os.getenv('TEMP') elif os.getenv('TMP') and os.path.isdir(os.getenv('TMP')): return os.getenv('TMP') elif os.path.isdir('C:\\temp'): return os.getenv('C:\\temp') else: return None # No luck! else: return '/tmp' # Check that basic stuff we need (a JS engine to compile, Node.js, and Clang and LLVM) # exists. # The test runner always does this check (through |force|). emcc does this less frequently, # only when ${EM_CONFIG}_sanity does not exist or is older than EM_CONFIG (so, # we re-check sanity when the settings are changed) # We also re-check sanity and clear the cache when the version changes EMSCRIPTEN_VERSION = '1.7.8' def generate_sanity(): return EMSCRIPTEN_VERSION + '|' + get_llvm_target() + '|' + LLVM_ROOT def check_sanity(force=False): try: reason = None if not CONFIG_FILE: return # config stored directly in EM_CONFIG => skip sanity checks else: settings_mtime = os.stat(CONFIG_FILE).st_mtime sanity_file = CONFIG_FILE + '_sanity' if os.path.exists(sanity_file): try: sanity_mtime = os.stat(sanity_file).st_mtime if sanity_mtime <= settings_mtime: reason = 'settings file has changed' else: sanity_data = open(sanity_file).read() if sanity_data != generate_sanity(): reason = 'system change: %s vs %s' % (generate_sanity(), sanity_data) else: if not force: return # all is well except Exception, e: reason = 'unknown: ' + str(e) if reason: logging.warning('(Emscripten: %s, clearing cache)' % reason) Cache.erase() force = False # the check actually failed, so definitely write out the sanity file, to avoid others later seeing failures too # some warning, not fatal checks - do them even if EM_IGNORE_SANITY is on check_llvm_version() check_node_version() if os.environ.get('EM_IGNORE_SANITY'): logging.info('EM_IGNORE_SANITY set, ignoring sanity checks') return logging.info('(Emscripten: Running sanity checks)') if not check_engine(COMPILER_ENGINE): logging.critical('The JavaScript shell used for compiling (%s) does not seem to work, check the paths in %s' % (COMPILER_ENGINE, EM_CONFIG)) sys.exit(1) if NODE_JS != COMPILER_ENGINE: if not check_engine(NODE_JS): logging.critical('Node.js (%s) does not seem to work, check the paths in %s' % (NODE_JS, EM_CONFIG)) sys.exit(1) for cmd in [CLANG, LINK_CMD[0], LLVM_AR, LLVM_OPT, LLVM_AS, LLVM_DIS, LLVM_NM, LLVM_INTERPRETER]: if not os.path.exists(cmd) and not os.path.exists(cmd + '.exe'): # .exe extension required for Windows logging.critical('Cannot find %s, check the paths in %s' % (cmd, EM_CONFIG)) sys.exit(1) try: subprocess.call([JAVA, '-version'], stdout=PIPE, stderr=PIPE) except: logging.warning('java does not seem to exist, required for closure compiler. -O2 and above will fail. You need to define JAVA in ~/.emscripten') if not os.path.exists(CLOSURE_COMPILER): logging.warning('Closure compiler (%s) does not exist, check the paths in %s. -O2 and above will fail' % (CLOSURE_COMPILER, EM_CONFIG)) # Sanity check passed! if not force: # Only create/update this file if the sanity check succeeded, i.e., we got here f = open(sanity_file, 'w') f.write(generate_sanity()) f.close() except Exception, e: # Any error here is not worth failing on print 'WARNING: sanity check failed to run', e # Tools/paths try: LLVM_ADD_VERSION except NameError: LLVM_ADD_VERSION = os.getenv('LLVM_ADD_VERSION') try: CLANG_ADD_VERSION except NameError: CLANG_ADD_VERSION = os.getenv('CLANG_ADD_VERSION') USING_PNACL_TOOLCHAIN = os.path.exists(os.path.join(LLVM_ROOT, 'pnacl-clang')) def modify_prefix(tool): if USING_PNACL_TOOLCHAIN: if tool.startswith('llvm-'): tool = tool[5:] tool = 'pnacl-' + tool if WINDOWS: tool += '.bat' return tool # Some distributions ship with multiple llvm versions so they add # the version to the binaries, cope with that def build_llvm_tool_path(tool): tool = modify_prefix(tool) if LLVM_ADD_VERSION: return os.path.join(LLVM_ROOT, tool + "-" + LLVM_ADD_VERSION) else: return os.path.join(LLVM_ROOT, tool) # Some distributions ship with multiple clang versions so they add # the version to the binaries, cope with that def build_clang_tool_path(tool): tool = modify_prefix(tool) if CLANG_ADD_VERSION: return os.path.join(LLVM_ROOT, tool + "-" + CLANG_ADD_VERSION) else: return os.path.join(LLVM_ROOT, tool) CLANG_CC=os.path.expanduser(build_clang_tool_path('clang')) CLANG_CPP=os.path.expanduser(build_clang_tool_path('clang++')) CLANG=CLANG_CPP if USING_PNACL_TOOLCHAIN: # The PNaCl toolchain doesn't have llvm-link, but we can fake it LINK_CMD = [build_llvm_tool_path('llvm-ld'), '-nostdlib', '-r'] else: LINK_CMD = [build_llvm_tool_path('llvm-link')] LLVM_AR=build_llvm_tool_path('llvm-ar') LLVM_OPT=os.path.expanduser(build_llvm_tool_path('opt')) LLVM_AS=os.path.expanduser(build_llvm_tool_path('llvm-as')) LLVM_DIS=os.path.expanduser(build_llvm_tool_path('llvm-dis')) LLVM_NM=os.path.expanduser(build_llvm_tool_path('llvm-nm')) LLVM_INTERPRETER=os.path.expanduser(build_llvm_tool_path('lli')) LLVM_COMPILER=os.path.expanduser(build_llvm_tool_path('llc')) EMSCRIPTEN = path_from_root('emscripten.py') DEMANGLER = path_from_root('third_party', 'demangler.py') NAMESPACER = path_from_root('tools', 'namespacer.py') EMCC = path_from_root('emcc') EMXX = path_from_root('em++') EMAR = path_from_root('emar') EMRANLIB = path_from_root('emranlib') EMCONFIG = path_from_root('em-config') EMLINK = path_from_root('emlink.py') EMMAKEN = path_from_root('tools', 'emmaken.py') AUTODEBUGGER = path_from_root('tools', 'autodebugger.py') BINDINGS_GENERATOR = path_from_root('tools', 'bindings_generator.py') EXEC_LLVM = path_from_root('tools', 'exec_llvm.py') FILE_PACKAGER = path_from_root('tools', 'file_packager.py') # Temp dir. Create a random one, unless EMCC_DEBUG is set, in which case use TEMP_DIR/emscripten_temp def safe_ensure_dirs(dirname): try: os.makedirs(dirname) except os.error, e: # Ignore error for already existing dirname if e.errno != errno.EEXIST: raise e # FIXME: Notice that this will result in a false positive, # should the dirname be a file! There seems to no way to # handle this atomically in Python 2.x. # There is an additional option for Python 3.x, though. class Configuration: def __init__(self, environ=os.environ): self.DEBUG = environ.get('EMCC_DEBUG') if self.DEBUG == "0": self.DEBUG = None self.DEBUG_CACHE = self.DEBUG and "cache" in self.DEBUG self.EMSCRIPTEN_TEMP_DIR = None try: self.TEMP_DIR = TEMP_DIR except NameError: self.TEMP_DIR = find_temp_directory() if self.TEMP_DIR == None: logging.critical('TEMP_DIR not defined in ' + os.path.expanduser('~\\.emscripten') + ", and could not detect a suitable directory! Please configure .emscripten to contain a variable TEMP_DIR='/path/to/temp/dir'.") logging.debug('TEMP_DIR not defined in ~/.emscripten, using ' + self.TEMP_DIR) if not os.path.isdir(self.TEMP_DIR): logging.critical("The temp directory TEMP_DIR='" + self.TEMP_DIR + "' doesn't seem to exist! Please make sure that the path is correct.") self.CANONICAL_TEMP_DIR = os.path.join(self.TEMP_DIR, 'emscripten_temp') if self.DEBUG: try: self.EMSCRIPTEN_TEMP_DIR = self.CANONICAL_TEMP_DIR safe_ensure_dirs(self.EMSCRIPTEN_TEMP_DIR) except Exception, e: logging.error(str(e) + 'Could not create canonical temp dir. Check definition of TEMP_DIR in ~/.emscripten') def get_temp_files(self): return tempfiles.TempFiles( tmp=self.TEMP_DIR if not self.DEBUG else self.EMSCRIPTEN_TEMP_DIR, save_debug_files=os.environ.get('EMCC_DEBUG_SAVE')) def apply_configuration(): global configuration, DEBUG, EMSCRIPTEN_TEMP_DIR, DEBUG_CACHE, CANONICAL_TEMP_DIR, TEMP_DIR configuration = Configuration() DEBUG = configuration.DEBUG EMSCRIPTEN_TEMP_DIR = configuration.EMSCRIPTEN_TEMP_DIR DEBUG_CACHE = configuration.DEBUG_CACHE CANONICAL_TEMP_DIR = configuration.CANONICAL_TEMP_DIR TEMP_DIR = configuration.TEMP_DIR apply_configuration() logging.basicConfig(format='%(levelname)-8s %(name)s: %(message)s') def set_logging(): logger = logging.getLogger() logger.setLevel(logging.DEBUG if os.environ.get('EMCC_DEBUG') else logging.INFO) set_logging() if not EMSCRIPTEN_TEMP_DIR: EMSCRIPTEN_TEMP_DIR = tempfile.mkdtemp(prefix='emscripten_temp_', dir=configuration.TEMP_DIR) def prepare_to_clean_temp(d): def clean_temp(): try_delete(d) atexit.register(clean_temp) prepare_to_clean_temp(EMSCRIPTEN_TEMP_DIR) # this global var might change later # EM_CONFIG stuff try: JS_ENGINES except: try: JS_ENGINES = [JS_ENGINE] except Exception, e: print 'ERROR: %s does not seem to have JS_ENGINES or JS_ENGINE set up' % EM_CONFIG raise try: CLOSURE_COMPILER except: CLOSURE_COMPILER = path_from_root('third_party', 'closure-compiler', 'compiler.jar') try: PYTHON except: logging.debug('PYTHON not defined in ~/.emscripten, using "python"') PYTHON = 'python' try: JAVA except: logging.debug('JAVA not defined in ~/.emscripten, using "java"') JAVA = 'java' # Additional compiler options # Target choice. Must be synced with src/settings.js (TARGET_*) def get_llvm_target(): return os.environ.get('EMCC_LLVM_TARGET') or 'le32-unknown-nacl' # 'i386-pc-linux-gnu' LLVM_TARGET = get_llvm_target() # COMPILER_OPTS: options passed to clang when generating bitcode for us try: COMPILER_OPTS # Can be set in EM_CONFIG, optionally except: COMPILER_OPTS = [] COMPILER_OPTS = COMPILER_OPTS + ['-m32', '-DEMSCRIPTEN', '-D__EMSCRIPTEN__', '-fno-math-errno', #'-fno-threadsafe-statics', # disabled due to issue 1289 '-target', LLVM_TARGET] if LLVM_TARGET == 'le32-unknown-nacl': COMPILER_OPTS = filter(lambda opt: opt != '-m32', COMPILER_OPTS) # le32 target is 32-bit anyhow, no need for -m32 COMPILER_OPTS += ['-U__native_client__', '-U__pnacl__', '-U__ELF__'] # The nacl target is originally used for Google Native Client. Emscripten is not NaCl, so remove the platform #define, when using their triple. # Remove various platform specific defines, and set little endian COMPILER_STANDARDIZATION_OPTS = ['-U__i386__', '-U__i386', '-Ui386', '-U__STRICT_ANSI__', '-D__IEEE_LITTLE_ENDIAN', '-U__SSE__', '-U__SSE_MATH__', '-U__SSE2__', '-U__SSE2_MATH__', '-U__MMX__', '-U__APPLE__', '-U__linux__'] USE_EMSDK = not os.environ.get('EMMAKEN_NO_SDK') if USE_EMSDK: # Disable system C and C++ include directories, and add our own (using -idirafter so they are last, like system dirs, which # allows projects to override them) EMSDK_OPTS = ['-nostdinc', '-Xclang', '-nobuiltininc', '-Xclang', '-nostdsysteminc', '-Xclang', '-isystem' + path_from_root('system', 'local', 'include'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'compat'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'libcxx'), '-Xclang', '-isystem' + path_from_root('system', 'include'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'emscripten'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'bsd'), # posix stuff '-Xclang', '-isystem' + path_from_root('system', 'include', 'libc'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'gfx'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'net'), '-Xclang', '-isystem' + path_from_root('system', 'include', 'SDL'), ] EMSDK_OPTS += COMPILER_STANDARDIZATION_OPTS if LLVM_TARGET != 'le32-unknown-nacl': EMSDK_CXX_OPTS = ['-nostdinc++'] # le32 target does not need -nostdinc++ else: EMSDK_CXX_OPTS = [] COMPILER_OPTS += EMSDK_OPTS else: EMSDK_OPTS = [] EMSDK_CXX_OPTS = [] COMPILER_OPTS += COMPILER_STANDARDIZATION_OPTS #print >> sys.stderr, 'SDK opts', ' '.join(EMSDK_OPTS) #print >> sys.stderr, 'Compiler opts', ' '.join(COMPILER_OPTS) # Engine tweaks try: if 'gcparam' not in str(SPIDERMONKEY_ENGINE): if type(SPIDERMONKEY_ENGINE) is str: SPIDERMONKEY_ENGINE = [SPIDERMONKEY_ENGINE] SPIDERMONKEY_ENGINE += ['-e', "gcparam('maxBytes', 1024*1024*1024);"] # Our very large files need lots of gc heap except NameError: pass # If we have 'env', we should use that to find python, because |python| may fail while |env python| may work # (For example, if system python is 3.x while we need 2.x, and env gives 2.x if told to do so.) ENV_PREFIX = [] if not WINDOWS: try: assert 'Python' in Popen(['env', 'python', '-V'], stdout=PIPE, stderr=STDOUT).communicate()[0] ENV_PREFIX = ['env'] except: pass # Utilities def check_engine(engine): # TODO: we call this several times, perhaps cache the results? try: if not CONFIG_FILE: return True # config stored directly in EM_CONFIG => skip engine check return 'hello, world!' in run_js(path_from_root('src', 'hello_world.js'), engine) except Exception, e: print 'Checking JS engine %s failed. Check %s. Details: %s' % (str(engine), EM_CONFIG, str(e)) return False def run_js(filename, engine=None, *args, **kw): if engine is None: engine = JS_ENGINES[0] return jsrun.run_js(filename, engine, *args, **kw) def to_cc(cxx): # By default, LLVM_GCC and CLANG are really the C++ versions. This gets an explicit C version return cxx.replace('clang++', 'clang').replace('g++', 'gcc') def line_splitter(data): """Silly little tool to split JSON arrays over many lines.""" out = '' counter = 0 for i in range(len(data)): out += data[i] if data[i] == ' ' and counter > 60: out += '\n' counter = 0 else: counter += 1 return out def limit_size(string, MAX=12000*20): if len(string) < MAX: return string return string[0:MAX/2] + '\n[..]\n' + string[-MAX/2:] def read_pgo_data(filename): ''' Reads the output of PGO and generates proper information for CORRECT_* == 2 's *_LINES options ''' signs_lines = [] overflows_lines = [] for line in open(filename, 'r'): try: if line.rstrip() == '': continue if '%0 failures' in line: continue left, right = line.split(' : ') signature = left.split('|')[1] if 'Sign' in left: signs_lines.append(signature) elif 'Overflow' in left: overflows_lines.append(signature) except: pass return { 'signs_lines': signs_lines, 'overflows_lines': overflows_lines } def unique_ordered(values): # return a list of unique values in an input list, without changing order (list(set(.)) would change order randomly) seen = set() def check(value): if value in seen: return False seen.add(value) return True return filter(check, values) def expand_response(data): if type(data) == str and data[0] == '@': return json.loads(open(data[1:]).read()) return data # Settings. A global singleton. Not pretty, but nicer than passing |, settings| everywhere class Settings2(type): class __impl: attrs = {} def __init__(self): self.reset() @classmethod def reset(self): self.attrs = { 'QUANTUM_SIZE': 4 } self.load() # Given some emcc-type args (-O3, -s X=Y, etc.), fill Settings with the right settings @classmethod def load(self, args=[]): # Load the JS defaults into python settings = open(path_from_root('src', 'settings.js')).read().replace('//', '#') settings = re.sub(r'var ([\w\d]+)', r'self.attrs["\1"]', settings) exec settings # Apply additional settings. First -O, then -s for i in range(len(args)): if args[i].startswith('-O'): level = eval(args[i][2]) self.apply_opt_level(level) for i in range(len(args)): if args[i] == '-s': declare = re.sub(r'([\w\d]+)\s*=\s*(.+)', r'self.attrs["\1"]=\2;', args[i+1]) exec declare # Transforms the Settings information into emcc-compatible args (-s X=Y, etc.). Basically # the reverse of load_settings, except for -Ox which is relevant there but not here @classmethod def serialize(self): ret = [] for key, value in self.attrs.iteritems(): if key == key.upper(): # this is a hack. all of our settings are ALL_CAPS, python internals are not jsoned = json.dumps(value, sort_keys=True) ret += ['-s', key + '=' + jsoned] return ret @classmethod def copy(self, values): self.attrs = values @classmethod def apply_opt_level(self, opt_level, noisy=False): if opt_level >= 1: self.attrs['ASM_JS'] = 1 self.attrs['ASSERTIONS'] = 0 self.attrs['DISABLE_EXCEPTION_CATCHING'] = 1 self.attrs['RELOOP'] = 1 self.attrs['ALIASING_FUNCTION_POINTERS'] = 1 if opt_level >= 3: # Aside from these, -O3 also runs closure compiler and llvm lto self.attrs['FORCE_ALIGNED_MEMORY'] = 1 self.attrs['DOUBLE_MODE'] = 0 self.attrs['PRECISE_I64_MATH'] = 0 if noisy: logging.warning('Applying some potentially unsafe optimizations! (Use -O2 if this fails.)') def __getattr__(self, attr): if attr in self.attrs: return self.attrs[attr] else: raise AttributeError def __setattr__(self, attr, value): self.attrs[attr] = value __instance = None @staticmethod def instance(): if Settings2.__instance is None: Settings2.__instance = Settings2.__impl() return Settings2.__instance def __getattr__(self, attr): return getattr(self.instance(), attr) def __setattr__(self, attr, value): return setattr(self.instance(), attr, value) class Settings(object): __metaclass__ = Settings2 # Building class Building: COMPILER = CLANG LLVM_OPTS = False COMPILER_TEST_OPTS = [] # For use of the test runner JS_ENGINE_OVERRIDE = None # Used to pass the JS engine override from runner.py -> test_benchmark.py @staticmethod def get_building_env(native=False): env = os.environ.copy() if native: env['CC'] = CLANG_CC env['CXX'] = CLANG_CPP env['LD'] = CLANG env['CFLAGS'] = '-O2 -fno-math-errno' return env env['CC'] = EMCC if not WINDOWS else 'python %r' % EMCC env['CXX'] = EMXX if not WINDOWS else 'python %r' % EMXX env['AR'] = EMAR if not WINDOWS else 'python %r' % EMAR env['LD'] = EMCC if not WINDOWS else 'python %r' % EMCC env['LDSHARED'] = EMCC if not WINDOWS else 'python %r' % EMCC env['RANLIB'] = EMRANLIB if not WINDOWS else 'python %r' % EMRANLIB env['EMMAKEN_COMPILER'] = Building.COMPILER env['EMSCRIPTEN_TOOLS'] = path_from_root('tools') env['CFLAGS'] = env['EMMAKEN_CFLAGS'] = ' '.join(Building.COMPILER_TEST_OPTS) env['HOST_CC'] = CLANG_CC env['HOST_CXX'] = CLANG_CPP env['HOST_CFLAGS'] = "-W" #if set to nothing, CFLAGS is used, which we don't want env['HOST_CXXFLAGS'] = "-W" #if set to nothing, CXXFLAGS is used, which we don't want env['PKG_CONFIG_LIBDIR'] = path_from_root('system', 'local', 'lib', 'pkgconfig') + os.path.pathsep + path_from_root('system', 'lib', 'pkgconfig') env['PKG_CONFIG_PATH'] = os.environ.get ('EM_PKG_CONFIG_PATH') or '' env['EMSCRIPTEN'] = path_from_root() return env # Finds the given executable 'program' in PATH. Operates like the Unix tool 'which'. @staticmethod def which(program): import os def is_exe(fpath): return os.path.isfile(fpath) and os.access(fpath, os.X_OK) fpath, fname = os.path.split(program) if fpath: if is_exe(program): return program else: for path in os.environ["PATH"].split(os.pathsep): path = path.strip('"') exe_file = os.path.join(path, program) if is_exe(exe_file): return exe_file if WINDOWS and not '.' in fname: if is_exe(exe_file + '.exe'): return exe_file + '.exe' if is_exe(exe_file + '.cmd'): return exe_file + '.cmd' if is_exe(exe_file + '.bat'): return exe_file + '.bat' return None @staticmethod def handle_CMake_toolchain(args, env): def has_substr(array, substr): for arg in array: if substr in arg: return True return False # Append the Emscripten toolchain file if the user didn't specify one. if not has_substr(args, '-DCMAKE_TOOLCHAIN_FILE'): args.append('-DCMAKE_TOOLCHAIN_FILE=' + path_from_root('cmake', 'Platform', 'Emscripten.cmake')) # On Windows specify MinGW Makefiles if we have MinGW and no other toolchain was specified, to avoid CMake # pulling in a native Visual Studio, or Unix Makefiles. if WINDOWS and not '-G' in args and Building.which('mingw32-make'): args += ['-G', 'MinGW Makefiles'] return args @staticmethod def configure(args, stdout=None, stderr=None, env=None): if not args: return if env is None: env = Building.get_building_env() env['EMMAKEN_JUST_CONFIGURE'] = '1' if 'cmake' in args[0]: args = Building.handle_CMake_toolchain(args, env) try: process = Popen(args, stdout=stdout, stderr=stderr, env=env) process.communicate() except Exception, e: logging.error('Exception thrown when invoking Popen in configure with args: "%s"!' % ' '.join(args)) raise del env['EMMAKEN_JUST_CONFIGURE'] if process.returncode is not 0: logging.error('Configure step failed with non-zero return code ' + str(process.returncode) + '! Command line: ' + str(args)) raise subprocess.CalledProcessError(cmd=args, returncode=process.returncode) @staticmethod def make(args, stdout=None, stderr=None, env=None): if env is None: env = Building.get_building_env() if not args: logging.error('Executable to run not specified.') sys.exit(1) #args += ['VERBOSE=1'] # On Windows prefer building with mingw32-make instead of make, if it exists. if WINDOWS and args[0] == 'make': mingw32_make = Building.which('mingw32-make') if mingw32_make: args[0] = mingw32_make try: process = Popen(args, stdout=stdout, stderr=stderr, env=env) process.communicate() except Exception, e: logging.error('Exception thrown when invoking Popen in make with args: "%s"!' % ' '.join(args)) raise if process.returncode is not 0: raise subprocess.CalledProcessError(cmd=args, returncode=process.returncode) @staticmethod def build_library(name, build_dir, output_dir, generated_libs, configure=['sh', './configure'], configure_args=[], make=['make'], make_args='help', cache=None, cache_name=None, copy_project=False, env_init={}, source_dir=None, native=False): ''' Build a library into a .bc file. We build the .bc file once and cache it for all our tests. (We cache in memory since the test directory is destroyed and recreated for each test. Note that we cache separately for different compilers). This cache is just during the test runner. There is a different concept of caching as well, see |Cache|. ''' if type(generated_libs) is not list: generated_libs = [generated_libs] if source_dir is None: source_dir = path_from_root('tests', name.replace('_native', '')) if make_args == 'help': make_args = ['-j', str(multiprocessing.cpu_count())] temp_dir = build_dir if copy_project: project_dir = os.path.join(temp_dir, name) if os.path.exists(project_dir): shutil.rmtree(project_dir) shutil.copytree(source_dir, project_dir) # Useful in debugging sometimes to comment this out, and two lines above else: project_dir = build_dir try: old_dir = os.getcwd() except: old_dir = None os.chdir(project_dir) generated_libs = map(lambda lib: os.path.join(project_dir, lib), generated_libs) #for lib in generated_libs: # try: # os.unlink(lib) # make sure compilation completed successfully # except: # pass env = Building.get_building_env(native) verbose_level = int(os.getenv('EM_BUILD_VERBOSE')) if os.getenv('EM_BUILD_VERBOSE') != None else 0 for k, v in env_init.iteritems(): env[k] = v if configure: # Useful in debugging sometimes to comment this out (and the lines below up to and including the |link| call) try: Building.configure(configure + configure_args, env=env, stdout=open(os.path.join(project_dir, 'configure_'), 'w') if verbose_level < 2 else None, stderr=open(os.path.join(project_dir, 'configure_err'), 'w') if verbose_level < 1 else None) except subprocess.CalledProcessError, e: pass # Ignore exit code != 0 def open_make_out(i, mode='r'): return open(os.path.join(project_dir, 'make_' + str(i)), mode) def open_make_err(i, mode='r'): return open(os.path.join(project_dir, 'make_err' + str(i)), mode) if verbose_level >= 3: make_args += ['VERBOSE=1'] for i in range(2): # FIXME: Sad workaround for some build systems that need to be run twice to succeed (e.g. poppler) with open_make_out(i, 'w') as make_out: with open_make_err(i, 'w') as make_err: try: Building.make(make + make_args, stdout=make_out if verbose_level < 2 else None, stderr=make_err if verbose_level < 1 else None, env=env) except subprocess.CalledProcessError, e: pass # Ignore exit code != 0 try: if cache is not None: cache[cache_name] = [] for f in generated_libs: basename = os.path.basename(f) cache[cache_name].append((basename, open(f, 'rb').read())) break except Exception, e: if i > 0: if verbose_level == 0: # Due to the ugly hack above our best guess is to output the first run with open_make_err(0) as ferr: for line in ferr: sys.stderr.write(line) raise Exception('could not build library ' + name + ' due to exception ' + str(e)) if old_dir: os.chdir(old_dir) return generated_libs @staticmethod def link(files, target, force_archive_contents=False): actual_files = [] # Tracking unresolveds is necessary for .a linking, see below. # Specify all possible entry points to seed the linking process. # For a simple application, this would just be "main". unresolved_symbols = set([func[1:] for func in Settings.EXPORTED_FUNCTIONS]) resolved_symbols = set() temp_dirs = [] files = map(os.path.abspath, files) has_ar = False for f in files: has_ar = has_ar or Building.is_ar(f) for f in files: if not Building.is_ar(f): if Building.is_bitcode(f): if has_ar: new_symbols = Building.llvm_nm(f) resolved_symbols = resolved_symbols.union(new_symbols.defs) unresolved_symbols = unresolved_symbols.union(new_symbols.undefs.difference(resolved_symbols)).difference(new_symbols.defs) actual_files.append(f) else: # Extract object files from ar archives, and link according to gnu ld semantics # (link in an entire .o from the archive if it supplies symbols still unresolved) cwd = os.getcwd() try: temp_dir = os.path.join(EMSCRIPTEN_TEMP_DIR, 'ar_output_' + str(os.getpid()) + '_' + str(len(temp_dirs))) temp_dirs.append(temp_dir) safe_ensure_dirs(temp_dir) os.chdir(temp_dir) contents = filter(lambda x: len(x) > 0, Popen([LLVM_AR, 't', f], stdout=PIPE).communicate()[0].split('\n')) #print >> sys.stderr, ' considering archive', f, ':', contents if len(contents) == 0: logging.debug('Archive %s appears to be empty (recommendation: link an .so instead of .a)' % f) else: for content in contents: # ar will silently fail if the directory for the file does not exist, so make all the necessary directories dirname = os.path.dirname(content) if dirname: safe_ensure_dirs(dirname) Popen([LLVM_AR, 'xo', f], stdout=PIPE).communicate() # if absolute paths, files will appear there. otherwise, in this directory contents = map(lambda content: os.path.join(temp_dir, content), contents) contents = filter(os.path.exists, map(os.path.abspath, contents)) added_contents = set() added = True #print >> sys.stderr, ' initial undef are now ', unresolved_symbols, '\n' while added: # recursively traverse until we have everything we need #print >> sys.stderr, ' running loop of archive including for', f added = False for content in contents: if content in added_contents: continue new_symbols = Building.llvm_nm(content) # Link in the .o if it provides symbols, *or* this is a singleton archive (which is apparently an exception in gcc ld) #print >> sys.stderr, 'need', content, '?', unresolved_symbols, 'and we can supply', new_symbols.defs #print >> sys.stderr, content, 'DEF', new_symbols.defs, '\n' if new_symbols.defs.intersection(unresolved_symbols) or len(files) == 1 or force_archive_contents: if Building.is_bitcode(content): #print >> sys.stderr, ' adding object', content, '\n' resolved_symbols = resolved_symbols.union(new_symbols.defs) unresolved_symbols = unresolved_symbols.union(new_symbols.undefs.difference(resolved_symbols)).difference(new_symbols.defs) #print >> sys.stderr, ' undef are now ', unresolved_symbols, '\n' actual_files.append(content) added_contents.add(content) added = True #print >> sys.stderr, ' done running loop of archive including for', f finally: os.chdir(cwd) try_delete(target) # Finish link actual_files = unique_ordered(actual_files) # tolerate people trying to link a.so a.so etc. logging.debug('emcc: llvm-linking: %s to %s', actual_files, target) # check for too-long command line link_cmd = LINK_CMD + actual_files + ['-o', target] # 8k is a bit of an arbitrary limit, but a reasonable one # for max command line size before we use a respose file response_file = None if WINDOWS and len(' '.join(link_cmd)) > 8192: logging.debug('using response file for llvm-link') [response_fd, response_file] = mkstemp(suffix='.response', dir=TEMP_DIR) link_cmd = LINK_CMD + ["@" + response_file] response_fh = os.fdopen(response_fd, 'w') for arg in actual_files: # we can't put things with spaces in the response file if " " in arg: link_cmd.append(arg) else: response_fh.write(arg + "\n") response_fh.close() link_cmd.append("-o") link_cmd.append(target) if len(' '.join(link_cmd)) > 8192: logging.warning('emcc: link command line is very long, even with response file -- use paths with no spaces') output = Popen(link_cmd, stdout=PIPE).communicate()[0] if response_file: os.unlink(response_file) assert os.path.exists(target) and (output is None or 'Could not open input file' not in output), 'Linking error: ' + output for temp_dir in temp_dirs: try_delete(temp_dir) # Emscripten optimizations that we run on the .ll file @staticmethod def ll_opts(filename): ## Remove target info. This helps LLVM opts, if we run them later #cleaned = filter(lambda line: not line.startswith('target datalayout = ') and not line.startswith('target triple = '), # open(filename + '.o.ll', 'r').readlines()) #os.unlink(filename + '.o.ll') #open(filename + '.o.ll.orig', 'w').write(''.join(cleaned)) pass # LLVM optimizations # @param opt Either an integer, in which case it is the optimization level (-O1, -O2, etc.), or a list of raw # optimization passes passed to llvm opt @staticmethod def llvm_opt(filename, opts, out=None): if type(opts) is int: opts = Building.pick_llvm_opts(opts) #opts += ['-debug-pass=Arguments'] logging.debug('emcc: LLVM opts: ' + str(opts)) target = out or (filename + '.opt.bc') output = Popen([LLVM_OPT, filename] + opts + ['-o', target], stdout=PIPE).communicate()[0] assert os.path.exists(target), 'Failed to run llvm optimizations: ' + output if not out: shutil.move(filename + '.opt.bc', filename) @staticmethod def llvm_opts(filename): # deprecated version, only for test runner. TODO: remove if Building.LLVM_OPTS: shutil.move(filename + '.o', filename + '.o.pre') output = Popen([LLVM_OPT, filename + '.o.pre'] + Building.LLVM_OPT_OPTS + ['-o', filename + '.o'], stdout=PIPE).communicate()[0] assert os.path.exists(filename + '.o'), 'Failed to run llvm optimizations: ' + output @staticmethod def llvm_dis(input_filename, output_filename=None): # LLVM binary ==> LLVM assembly if output_filename is None: # use test runner conventions output_filename = input_filename + '.o.ll' input_filename = input_filename + '.o' try_delete(output_filename) output = Popen([LLVM_DIS, input_filename, '-o', output_filename], stdout=PIPE).communicate()[0] assert os.path.exists(output_filename), 'Could not create .ll file: ' + output return output_filename @staticmethod def llvm_as(input_filename, output_filename=None): # LLVM assembly ==> LLVM binary if output_filename is None: # use test runner conventions output_filename = input_filename + '.o' input_filename = input_filename + '.o.ll' try_delete(output_filename) output = Popen([LLVM_AS, input_filename, '-o', output_filename], stdout=PIPE).communicate()[0] assert os.path.exists(output_filename), 'Could not create bc file: ' + output return output_filename nm_cache = {} # cache results of nm - it can be slow to run @staticmethod def llvm_nm(filename, stdout=PIPE, stderr=None): if filename in Building.nm_cache: #logging.debug('loading nm results for %s from cache' % filename) return Building.nm_cache[filename] # LLVM binary ==> list of symbols output = Popen([LLVM_NM, filename], stdout=stdout, stderr=stderr).communicate()[0] class ret: defs = [] undefs = [] commons = [] for line in output.split('\n'): if len(line) == 0: continue parts = filter(lambda seg: len(seg) > 0, line.split(' ')) # pnacl-nm will print zero offsets for bitcode if len(parts) == 3 and parts[0] == "00000000": parts.pop(0) if len(parts) == 2: # ignore lines with absolute offsets, these are not bitcode anyhow (e.g. |00000630 t d_source_name|) status, symbol = parts if status == 'U': ret.undefs.append(symbol) elif status != 'C': ret.defs.append(symbol) else: ret.commons.append(symbol) ret.defs = set(ret.defs) ret.undefs = set(ret.undefs) ret.commons = set(ret.commons) Building.nm_cache[filename] = ret return ret @staticmethod def emcc(filename, args=[], output_filename=None, stdout=None, stderr=None, env=None): if output_filename is None: output_filename = filename + '.o' try_delete(output_filename) Popen([PYTHON, EMCC, filename] + args + ['-o', output_filename], stdout=stdout, stderr=stderr, env=env).communicate() assert os.path.exists(output_filename), 'emcc could not create output file: ' + output_filename @staticmethod def emar(action, output_filename, filenames, stdout=None, stderr=None, env=None): try_delete(output_filename) Popen([PYTHON, EMAR, action, output_filename] + filenames, stdout=stdout, stderr=stderr, env=env).communicate() if 'c' in action: assert os.path.exists(output_filename), 'emar could not create output file: ' + output_filename @staticmethod def emscripten(filename, append_ext=True, extra_args=[]): # Allow usage of emscripten.py without warning os.environ['EMSCRIPTEN_SUPPRESS_USAGE_WARNING'] = '1' # Run Emscripten Settings.RELOOPER = Cache.get_path('relooper.js') settings = Settings.serialize() args = settings + extra_args if WINDOWS: args = ['@' + response_file.create_response_file(args, TEMP_DIR)] cmdline = [PYTHON, EMSCRIPTEN, filename + ('.o.ll' if append_ext else ''), '-o', filename + '.o.js'] + args if jsrun.TRACK_PROCESS_SPAWNS: logging.info('Executing emscripten.py compiler with cmdline "' + ' '.join(cmdline) + '"') compiler_output = jsrun.timeout_run(Popen(cmdline, stdout=PIPE), None, 'Compiling') #print compiler_output # Detect compilation crashes and errors if compiler_output is not None and 'Traceback' in compiler_output and 'in test_' in compiler_output: print compiler_output; assert 0 assert os.path.exists(filename + '.o.js') and len(open(filename + '.o.js', 'r').read()) > 0, 'Emscripten failed to generate .js: ' + str(compiler_output) return filename + '.o.js' @staticmethod def can_build_standalone(): return not Settings.BUILD_AS_SHARED_LIB and not Settings.LINKABLE and not Settings.EXPORT_ALL @staticmethod def can_use_unsafe_opts(): return Settings.USE_TYPED_ARRAYS == 2 @staticmethod def can_inline(): return Settings.INLINING_LIMIT == 0 @staticmethod def get_safe_internalize(): if not Building.can_build_standalone(): return [] # do not internalize anything exps = expand_response(Settings.EXPORTED_FUNCTIONS) exports = ','.join(map(lambda exp: exp[1:], exps)) # internalize carefully, llvm 3.2 will remove even main if not told not to return ['-internalize', '-internalize-public-api-list=' + exports] @staticmethod def pick_llvm_opts(optimization_level): ''' It may be safe to use nonportable optimizations (like -OX) if we remove the platform info from the .ll (which we do in do_ll_opts) - but even there we have issues (even in TA2) with instruction combining into i64s. In any case, the handpicked ones here should be safe and portable. They are also tuned for things that look useful. An easy way to see LLVM's standard list of passes is llvm-as < /dev/null | opt -std-compile-opts -disable-output -debug-pass=Arguments ''' assert 0 <= optimization_level <= 3 unsafe = Building.can_use_unsafe_opts() opts = [] if optimization_level > 0: if unsafe: if not Building.can_inline(): opts.append('-disable-inlining') if not Building.can_build_standalone(): # -O1 does not have -gobaldce, which removes stuff that is needed for libraries and linkables optimization_level = min(1, optimization_level) opts.append('-O%d' % optimization_level) #print '[unsafe: %s]' % ','.join(opts) else: allow_nonportable = False optimize_size = True use_aa = False # PassManagerBuilder::populateModulePassManager if allow_nonportable and use_aa: # ammo.js results indicate this can be nonportable opts.append('-tbaa') opts.append('-basicaa') # makes fannkuch slow but primes fast if Building.can_build_standalone(): opts += Building.get_safe_internalize() opts.append('-globalopt') opts.append('-ipsccp') opts.append('-deadargelim') if allow_nonportable: opts.append('-instcombine') opts.append('-simplifycfg') opts.append('-prune-eh') if Building.can_inline(): opts.append('-inline') opts.append('-functionattrs') if optimization_level > 2: opts.append('-argpromotion') # XXX Danger: Can turn a memcpy into something that violates the # load-store consistency hypothesis. See hashnum() in Lua. # Note: this opt is of great importance for raytrace... if allow_nonportable: opts.append('-scalarrepl') if allow_nonportable: opts.append('-early-cse') # ? opts.append('-simplify-libcalls') opts.append('-jump-threading') if allow_nonportable: opts.append('-correlated-propagation') # ? opts.append('-simplifycfg') if allow_nonportable: opts.append('-instcombine') opts.append('-tailcallelim') opts.append('-simplifycfg') opts.append('-reassociate') opts.append('-loop-rotate') opts.append('-licm') opts.append('-loop-unswitch') # XXX should depend on optimize_size if allow_nonportable: opts.append('-instcombine') if Settings.QUANTUM_SIZE == 4: opts.append('-indvars') # XXX this infinite-loops raytrace on q1 (loop in |new node_t[count]| has 68 hardcoded ¬ fixed) if allow_nonportable: opts.append('-loop-idiom') # ? opts.append('-loop-deletion') opts.append('-loop-unroll') ##### not in llvm-3.0. but have | #addExtensionsToPM(EP_LoopOptimizerEnd, MPM);| if allow_nonportable: opts.append('-instcombine') # XXX Danger: Messes up Lua output for unknown reasons # Note: this opt is of minor importance for raytrace... if optimization_level > 1 and allow_nonportable: opts.append('-gvn') opts.append('-memcpyopt') # Danger? opts.append('-sccp') if allow_nonportable: opts.append('-instcombine') opts.append('-jump-threading') opts.append('-correlated-propagation') opts.append('-dse') #addExtensionsToPM(EP_ScalarOptimizerLate, MPM) opts.append('-adce') opts.append('-simplifycfg') if allow_nonportable: opts.append('-instcombine') opts.append('-strip-dead-prototypes') if Building.can_build_standalone(): opts.append('-globaldce') if optimization_level > 1: opts.append('-constmerge') Building.LLVM_OPT_OPTS = opts return opts @staticmethod def js_optimizer(filename, passes, jcache=False, debug=False, extra_info=None): return js_optimizer.run(filename, passes, listify(NODE_JS), jcache, debug, extra_info) @staticmethod def closure_compiler(filename, pretty=True): if not os.path.exists(CLOSURE_COMPILER): raise Exception('Closure compiler appears to be missing, looked at: ' + str(CLOSURE_COMPILER)) # Something like this (adjust memory as needed): # java -Xmx1024m -jar CLOSURE_COMPILER --compilation_level ADVANCED_OPTIMIZATIONS --variable_map_output_file src.cpp.o.js.vars --js src.cpp.o.js --js_output_file src.cpp.o.cc.js args = [JAVA, '-Xmx' + (os.environ.get('JAVA_HEAP_SIZE') or '1024m'), # if you need a larger Java heap, use this environment variable '-jar', CLOSURE_COMPILER, '--compilation_level', 'ADVANCED_OPTIMIZATIONS', '--language_in', 'ECMASCRIPT5', #'--variable_map_output_file', filename + '.vars', '--js', filename, '--js_output_file', filename + '.cc.js'] if pretty: args += ['--formatting', 'PRETTY_PRINT'] if os.environ.get('EMCC_CLOSURE_ARGS'): args += shlex.split(os.environ.get('EMCC_CLOSURE_ARGS')) process = Popen(args, stdout=PIPE, stderr=STDOUT) cc_output = process.communicate()[0] if process.returncode != 0 or not os.path.exists(filename + '.cc.js'): raise Exception('closure compiler error: ' + cc_output + ' (rc: %d)' % process.returncode) return filename + '.cc.js' _is_ar_cache = {} @staticmethod def is_ar(filename): try: if Building._is_ar_cache.get(filename): return Building._is_ar_cache[filename] b = open(filename, 'r').read(8) sigcheck = b[0] == '!' and b[1] == '<' and \ b[2] == 'a' and b[3] == 'r' and \ b[4] == 'c' and b[5] == 'h' and \ b[6] == '>' and ord(b[7]) == 10 Building._is_ar_cache[filename] = sigcheck return sigcheck except Exception, e: logging.debug('Building.is_ar failed to test whether file \'%s\' is a llvm archive file! Failed on exception: %s' % (filename, e)) return False @staticmethod def is_bitcode(filename): # look for magic signature b = open(filename, 'r').read(4) if b[0] == 'B' and b[1] == 'C': return True # look for ar signature elif Building.is_ar(filename): return True # on OS X, there is a 20-byte prefix elif ord(b[0]) == 222 and ord(b[1]) == 192 and ord(b[2]) == 23 and ord(b[3]) == 11: b = open(filename, 'r').read(24) return b[20] == 'B' and b[21] == 'C' return False # Make sure the relooper exists. If it does not, check out the relooper code and bootstrap it @staticmethod def ensure_relooper(relooper): if os.path.exists(relooper): return if os.environ.get('EMCC_FAST_COMPILER'): logging.debug('not building relooper to js, using it in c++ backend') return Cache.ensure() curr = os.getcwd() try: ok = False logging.info('=======================================') logging.info('bootstrapping relooper...') os.chdir(path_from_root('src')) emcc_debug = os.environ.get('EMCC_DEBUG') if emcc_debug: del os.environ['EMCC_DEBUG'] emcc_leave_inputs_raw = os.environ.get('EMCC_LEAVE_INPUTS_RAW') if emcc_leave_inputs_raw: del os.environ['EMCC_LEAVE_INPUTS_RAW'] def make(opt_level, reloop): raw = relooper + '.raw.js' Building.emcc(os.path.join('relooper', 'Relooper.cpp'), ['-I' + os.path.join('relooper'), '--post-js', os.path.join('relooper', 'emscripten', 'glue.js'), '--memory-init-file', '0', '-s', 'RELOOP=%d' % reloop, '-s', 'EXPORTED_FUNCTIONS=["_rl_set_output_buffer","_rl_make_output_buffer","_rl_new_block","_rl_delete_block","_rl_block_add_branch_to","_rl_new_relooper","_rl_delete_relooper","_rl_relooper_add_block","_rl_relooper_calculate","_rl_relooper_render", "_rl_set_asm_js_mode"]', '-s', 'DEFAULT_LIBRARY_FUNCS_TO_INCLUDE=["memcpy", "memset", "malloc", "free", "puts"]', '-s', 'RELOOPER="' + relooper + '"', '-O' + str(opt_level), '--closure', '0'], raw) f = open(relooper, 'w') f.write("// Relooper, (C) 2012 Alon Zakai, MIT license, https://github.com/kripken/Relooper\n") f.write("var Relooper = (function(Module) {\n") f.write(open(raw).read()) f.write('\n return Module.Relooper;\n') f.write('})(RelooperModule);\n') f.close() # bootstrap phase 1: generate unrelooped relooper, for which we do not need a relooper (so we cannot recurse infinitely in this function) logging.info(' bootstrap phase 1') make(2, 0) # bootstrap phase 2: generate relooped relooper, using the unrelooped relooper (we see relooper.js exists so we cannot recurse infinitely in this function) logging.info(' bootstrap phase 2') make(2, 1) logging.info('bootstrapping relooper succeeded') logging.info('=======================================') ok = True finally: os.chdir(curr) if emcc_debug: os.environ['EMCC_DEBUG'] = emcc_debug if emcc_leave_inputs_raw: os.environ['EMCC_LEAVE_INPUTS_RAW'] = emcc_leave_inputs_raw if not ok: logging.error('bootstrapping relooper failed. You may need to manually create relooper.js by compiling it, see src/relooper/emscripten') try_delete(relooper) # do not leave a phase-1 version if phase 2 broke 1/0 @staticmethod def ensure_struct_info(info_path): if os.path.exists(info_path): return Cache.ensure() import gen_struct_info gen_struct_info.main(['-qo', info_path, path_from_root('src/struct_info.json')]) @staticmethod def preprocess(infile, outfile): ''' Preprocess source C/C++ in some special ways that emscripten needs. Returns a filename (potentially the same one if nothing was changed). Currently this only does emscripten_jcache_printf(..) rewriting. ''' src = open(infile).read() # stack warning on jcacheprintf! in docs # add jcache printf test separatrely, for content of printf if 'emscripten_jcache_printf' not in src: return infile def fix(m): text = m.groups(0)[0] assert text.count('(') == 1 and text.count(')') == 1, 'must have simple expressions in emscripten_jcache_printf calls, no parens' assert text.count('"') == 2, 'must have simple expressions in emscripten_jcache_printf calls, no strings as varargs parameters' start = text.index('(') end = text.rindex(')') args = text[start+1:end].split(',') args = map(lambda x: x.strip(), args) if args[0][0] == '"': # flatten out args = map(lambda x: str(ord(x)), args[0][1:len(args[0])-1]) + ['0'] + args[1:] return 'emscripten_jcache_printf_(' + ','.join(args) + ')' src = re.sub(r'(emscripten_jcache_printf\([^)]+\))', lambda m: fix(m), src) open(outfile, 'w').write(src) return outfile # compatibility with existing emcc, etc. scripts Cache = cache.Cache(debug=DEBUG_CACHE) JCache = cache.JCache(Cache) chunkify = cache.chunkify class JS: memory_initializer_pattern = '/\* memory initializer \*/ allocate\(([\d,\.concat\(\)\[\]\\n ]+)"i8", ALLOC_NONE, ([\dRuntime\.GLOBAL_BASEH+]+)\)' no_memory_initializer_pattern = '/\* no memory initializer \*/' memory_staticbump_pattern = 'STATICTOP = STATIC_BASE \+ (\d+);' global_initializers_pattern = '/\* global initializers \*/ __ATINIT__.push\((.+)\);' @staticmethod def to_nice_ident(ident): # limited version of the JS function toNiceIdent return ident.replace('%', '$').replace('@', '_').replace('.', '_') @staticmethod def make_initializer(sig, settings=None): settings = settings or Settings if sig == 'i': return '0' elif sig == 'f' and settings.get('PRECISE_F32'): return 'Math_fround(0)' else: return '+0' @staticmethod def make_coercion(value, sig, settings=None): settings = settings or Settings if sig == 'i': return value + '|0' elif sig == 'f' and settings.get('PRECISE_F32'): return 'Math_fround(' + value + ')' elif sig == 'd' or sig == 'f': return '+' + value else: return value @staticmethod def make_extcall(sig, named=True): args = ','.join(['a' + str(i) for i in range(1, len(sig))]) args = 'index' + (',' if args else '') + args # C++ exceptions are numbers, and longjmp is a string 'longjmp' ret = '''function%s(%s) { %sModule["dynCall_%s"](%s); }''' % ((' extCall_' + sig) if named else '', args, 'return ' if sig[0] != 'v' else '', sig, args) if Settings.DLOPEN_SUPPORT and Settings.ASSERTIONS: # guard against cross-module stack leaks ret = ret.replace(') {\n', ''') { try { var preStack = asm.stackSave(); ''').replace(';\n}', '''; } finally { assert(asm.stackSave() == preStack); } }''') return ret @staticmethod def make_invoke(sig, named=True): args = ','.join(['a' + str(i) for i in range(1, len(sig))]) args = 'index' + (',' if args else '') + args # C++ exceptions are numbers, and longjmp is a string 'longjmp' ret = '''function%s(%s) { try { %sModule["dynCall_%s"](%s); } catch(e) { if (typeof e !== 'number' && e !== 'longjmp') throw e; asm["setThrew"](1, 0); } }''' % ((' invoke_' + sig) if named else '', args, 'return ' if sig[0] != 'v' else '', sig, args) if Settings.DLOPEN_SUPPORT and Settings.ASSERTIONS: # guard against cross-module stack leaks ret = ret.replace(' try {', ''' var preStack = asm.stackSave(); try { ''').replace(' }\n}', ''' } finally { assert(asm.stackSave() == preStack); } }''') return ret @staticmethod def align(x, by): while x % by != 0: x += 1 return x # Compression of code and data for smaller downloads class Compression: on = False @staticmethod def compressed_name(filename): return filename + '.compress' @staticmethod def compress(filename): execute(Compression.encoder, stdin=open(filename, 'rb'), stdout=open(Compression.compressed_name(filename), 'wb')) @staticmethod def worth_it(original, compressed): return compressed < original - 1500 # save at least one TCP packet or so def execute(cmd, *args, **kw): try: return Popen(cmd, *args, **kw).communicate() # let compiler frontend print directly, so colors are saved (PIPE kills that) except: if not isinstance(cmd, str): cmd = ' '.join(cmd) logging.error('Invoking Process failed: <<< ' + cmd + ' >>>') raise def check_execute(cmd, *args, **kw): # TODO: use in more places. execute doesn't actually check that return values # are nonzero try: kw['stderr'] = STDOUT subprocess.check_output(cmd, *args, **kw) logging.debug("Successfuly executed %s" % " ".join(cmd)) except subprocess.CalledProcessError as e: logging.error("'%s' failed with output:\n%s" % (" ".join(e.cmd), e.output)) raise def suffix(name): parts = name.split('.') if len(parts) > 1: return parts[-1] else: return None def unsuffixed(name): return '.'.join(name.split('.')[:-1]) def unsuffixed_basename(name): return os.path.basename(unsuffixed(name)) import js_optimizer