# Copyright 2010 The Emscripten Authors. All rights reserved. # Emscripten is available under two separate licenses, the MIT license and the # University of Illinois/NCSA Open Source License. Both these licenses can be # found in the LICENSE file. """A small wrapper script around the core JS compiler. This calls that compiler with the settings given to it. It can also read data from C/C++ header files (so that the JS compiler can see the constants in those headers, for the libc implementation in JS). """ import glob import hashlib import json import logging import os import pprint import shutil import subprocess import sys import textwrap from tools import ( building, cache, config, diagnostics, extract_metadata, filelock, js_manipulation, shared, utils, webassembly, ) from tools.settings import settings, user_settings from tools.shared import DEBUG, asmjs_mangle, in_temp from tools.toolchain_profiler import ToolchainProfiler from tools.utils import exit_with_error, path_from_root sys.path.append(path_from_root('third_party')) import leb128 logger = logging.getLogger('emscripten') # helper functions for JS to call into C to do memory operations. these # let us sanitize memory access from the JS side, by calling into C where # it has been instrumented. ASAN_C_HELPERS = ['__asan_loadN', '__asan_storeN'] def maybe_disable_filesystem(imports): """Disables filesystem if only a limited subset of syscalls is used. Our syscalls are static, and so if we see a very limited set of them - in particular, no open() syscall and just simple writing - then we don't need full filesystem support. If FORCE_FILESYSTEM is set, we can't do this. We also don't do it if INCLUDE_FULL_LIBRARY, since not including the filesystem would mean not including the full JS libraries, and the same for MAIN_MODULE=1 since a side module might need the filesystem. """ if any(settings[s] for s in ('FORCE_FILESYSTEM', 'INCLUDE_FULL_LIBRARY')): return if settings.MAIN_MODULE == 1: return if settings.FILESYSTEM == 0: # without filesystem support, it doesn't matter what syscalls need settings.SYSCALLS_REQUIRE_FILESYSTEM = 0 else: # TODO(sbc): Find a better way to identify wasi syscalls syscall_prefixes = ('__syscall_', 'fd_') side_module_imports = [shared.demangle_c_symbol_name(s) for s in settings.SIDE_MODULE_IMPORTS] all_imports = set(imports).union(side_module_imports) syscalls = {d for d in all_imports if d.startswith(syscall_prefixes) or d == 'path_open'} # check if the only filesystem syscalls are in: close, ioctl, llseek, write # (without open, etc.. nothing substantial can be done, so we can disable # extra filesystem support in that case) if syscalls.issubset({ '__syscall_ioctl', 'fd_seek', 'fd_write', 'fd_close', 'fd_fdstat_get', }): if DEBUG: logger.debug('very limited syscalls (%s) so disabling full filesystem support', ', '.join(str(s) for s in syscalls)) settings.SYSCALLS_REQUIRE_FILESYSTEM = 0 def is_int(x): try: int(x) return True except ValueError: return False def align_memory(addr): return (addr + 15) & -16 def update_settings_glue(wasm_file, metadata, base_metadata): maybe_disable_filesystem(metadata.imports) # Integrate info from backend if settings.SIDE_MODULE: # we don't need any JS library contents in side modules settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE = [] else: syms = settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE + metadata.imports syms = set(syms).difference(metadata.all_exports) settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE = sorted(syms) if settings.MAIN_MODULE: settings.WEAK_IMPORTS += webassembly.get_weak_imports(wasm_file) if base_metadata: settings.WASM_EXPORTS = base_metadata.all_exports else: settings.WASM_EXPORTS = metadata.all_exports settings.HAVE_EM_ASM = bool(settings.MAIN_MODULE or len(metadata.em_asm_consts) != 0) if settings.MAIN_MODULE and settings.ASYNCIFY == 1: # These will be exported from Wasm, but only once we run the asyncify pass. settings.WASM_EXPORTS += ['__asyncify_state', '__asyncify_data'] # start with the MVP features, and add any detected features. building.binaryen_features = ['--mvp-features'] + metadata.features if settings.ASYNCIFY == 2: building.binaryen_features += ['--enable-reference-types'] if settings.PTHREADS: assert '--enable-threads' in building.binaryen_features if settings.MEMORY64: assert '--enable-memory64' in building.binaryen_features settings.HAS_MAIN = bool(settings.MAIN_MODULE) or settings.PROXY_TO_PTHREAD or settings.STANDALONE_WASM or 'main' in settings.WASM_EXPORTS or '__main_argc_argv' in settings.WASM_EXPORTS if settings.HAS_MAIN and not settings.MINIMAL_RUNTIME: # Dependencies of `callMain` settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$exitJS', '$handleException'] # When using dynamic linking the main function might be in a side module. # To be safe assume they do take input parameters. settings.MAIN_READS_PARAMS = metadata.main_reads_params or bool(settings.MAIN_MODULE) if settings.MAIN_READS_PARAMS and not settings.STANDALONE_WASM: # callMain depends on this library function settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$stringToUTF8OnStack'] if settings.STACK_OVERFLOW_CHECK and not settings.SIDE_MODULE: # writeStackCookie and checkStackCookie both rely on emscripten_stack_get_end being # exported. In theory it should always be present since its defined in compiler-rt. assert 'emscripten_stack_get_end' in metadata.function_exports for deps in metadata.js_deps: settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE.extend(deps.split(',')) def apply_static_code_hooks(forwarded_json, code): def inject_code_hooks(name): nonlocal code hook_code = forwarded_json[name] if hook_code: hook_code = f'// Begin {name} hooks\n {hook_code}\n // End {name} hooks' else: hook_code = f'// No {name} hooks' code = code.replace(f'<<< {name} >>>', hook_code) inject_code_hooks('ATMODULES') inject_code_hooks('ATPRERUNS') inject_code_hooks('ATINITS') inject_code_hooks('ATPOSTCTORS') if settings.HAS_MAIN: inject_code_hooks('ATMAINS') if not settings.MINIMAL_RUNTIME or settings.HAS_MAIN: inject_code_hooks('ATPOSTRUNS') if settings.EXIT_RUNTIME: inject_code_hooks('ATEXITS') return code @ToolchainProfiler.profile() def generate_js_compiler_input_hash(symbols_only=False): # We define a cache hit as when all the settings and all the `--js-library` # contents are identical. # Ignore certain settings that can are no relevant to library deps. Here we # skip PRE_JS_FILES/POST_JS_FILES which don't affect the library symbol list # and can contain full paths to temporary files. skip_settings = {'PRE_JS_FILES', 'POST_JS_FILES'} file_contents = [json.dumps(settings.external_dict(skip_keys=skip_settings), sort_keys=True, indent=2)] files = glob.glob(utils.path_from_root('src/lib') + '/lib*.js') # Also, include the js compiler code itself, in case it gets locally modified. files += glob.glob(utils.path_from_root('src/*.mjs')) files += settings.JS_LIBRARIES if not symbols_only: files += settings.PRE_JS_FILES files += settings.POST_JS_FILES # Also include other .js files that could be included in the output. files += glob.glob(utils.path_from_root('src/*.js')) for file in sorted(files): file_contents.append(utils.read_file(file)) content = '\n'.join(file_contents) content_hash = hashlib.sha1(content.encode('utf-8')).hexdigest() return content_hash @ToolchainProfiler.profile() def compile_javascript(symbols_only=False): stderr_file = os.environ.get('EMCC_STDERR_FILE') if stderr_file: stderr_file = os.path.abspath(stderr_file) logger.info('logging stderr in js compiler phase into %s' % stderr_file) stderr_file = open(stderr_file, 'w') # Save settings to a file to work around v8 issue 1579 settings_json = json.dumps(settings.external_dict(), sort_keys=True, indent=2) building.write_intermediate(settings_json, 'settings.json') # Call js compiler. Passing `-` here mean read the settings from stdin. args = ['-'] if symbols_only: args += ['--symbols-only'] return shared.run_js_tool(path_from_root('tools/compiler.mjs'), args, input=settings_json, stdout=subprocess.PIPE, stderr=stderr_file) def set_memory(static_bump): stack_low = align_memory(settings.GLOBAL_BASE + static_bump) stack_high = align_memory(stack_low + settings.STACK_SIZE) settings.STACK_HIGH = stack_high settings.STACK_LOW = stack_low settings.HEAP_BASE = align_memory(stack_high) def report_missing_exports_wasm_only(metadata): if diagnostics.is_enabled('undefined'): defined_symbols = {asmjs_mangle(e) for e in metadata.all_exports} missing = set(settings.USER_EXPORTS) - defined_symbols for symbol in sorted(missing): diagnostics.warning('undefined', f'undefined exported symbol: "{symbol}"') def report_missing_exports(js_symbols): if diagnostics.is_enabled('undefined'): # Report any symbol that was explicitly exported but is present neither # as a native function nor as a JS library function. defined_symbols = {asmjs_mangle(e) for e in settings.WASM_EXPORTS}.union(js_symbols) missing = set(settings.USER_EXPORTS) - defined_symbols for symbol in sorted(missing): diagnostics.warning('undefined', f'undefined exported symbol: "{symbol}"') # Special handling for the `_main` symbol if settings.STANDALONE_WASM: # standalone mode doesn't use main, and it always reports missing entry point at link time. # In this mode we never expect _main in the export list. return if settings.IGNORE_MISSING_MAIN: # The default mode for emscripten is to ignore the missing main function allowing # maximum compatibility. return if settings.EXPECT_MAIN: all_exports = settings.WASM_EXPORTS + settings.SIDE_MODULE_EXPORTS if 'main' not in all_exports and '__main_argc_argv' not in all_exports: # For compatibility with the output of wasm-ld we use the same wording here in our # error message as if wasm-ld had failed. exit_with_error('entry symbol not defined (pass --no-entry to suppress): main') # Test if the parentheses at body[openIdx] and body[closeIdx] are a match to # each other. def parentheses_match(body, openIdx, closeIdx): if closeIdx < 0: closeIdx += len(body) count = 1 for i in range(openIdx + 1, closeIdx + 1): if body[i] == body[openIdx]: count += 1 elif body[i] == body[closeIdx]: count -= 1 if count <= 0: return i == closeIdx return False def trim_asm_const_body(body): body = body.strip() orig = None while orig != body: orig = body if len(body) > 1 and body[0] == '"' and body[-1] == '"': body = body[1:-1].replace('\\"', '"').strip() if len(body) > 1 and body[0] == '{' and body[-1] == '}' and parentheses_match(body, 0, -1): body = body[1:-1].strip() if len(body) > 1 and body[0] == '(' and body[-1] == ')' and parentheses_match(body, 0, -1): body = body[1:-1].strip() return body def get_cached_file(filetype, filename, generator, cache_limit): """This function implements a file cache which lives inside the main emscripten cache directory but uses a per-file lock rather than a cache-wide lock. The cache is pruned (by removing the oldest files) if it grows above a certain number of files. """ root = cache.get_path(filetype) utils.safe_ensure_dirs(root) cache_file = os.path.join(root, filename) with filelock.FileLock(cache_file + '.lock'): if os.path.exists(cache_file): # Cache hit, read the file file_content = utils.read_file(cache_file) else: # Cache miss, generate the symbol list and write the file file_content = generator() utils.write_file(cache_file, file_content) if len([f for f in os.listdir(root) if not f.endswith('.lock')]) > cache_limit: with filelock.FileLock(cache.get_path(f'{filetype}.lock')): files = [] for f in os.listdir(root): if not f.endswith('.lock'): f = os.path.join(root, f) files.append((f, os.path.getmtime(f))) files.sort(key=lambda x: x[1]) # Delete all but the newest N files for f, _ in files[:-cache_limit]: with filelock.FileLock(f + '.lock'): utils.delete_file(f) return file_content @ToolchainProfiler.profile() def compile_javascript_cached(): # Avoiding using the cache when generating struct info since # this step is performed while the cache is locked. # Sadly we have to skip the caching whenever we have user JS libraries. This is because # these libraries can import arbirary other JS files (either vis node's `import` or via #include) if DEBUG or settings.BOOTSTRAPPING_STRUCT_INFO or config.FROZEN_CACHE or settings.JS_LIBRARIES: return compile_javascript() content_hash = generate_js_compiler_input_hash() # Limit of the overall size of the cache. # This code will get test coverage since a full test run of `other` or `core` # generates ~1000 unique outputs. return get_cached_file('js_output', f'{content_hash}.js', compile_javascript, cache_limit=500) def emscript(in_wasm, out_wasm, outfile_js, js_syms, finalize=True, base_metadata=None): # Overview: # * Run wasm-emscripten-finalize to extract metadata and modify the binary # to use emscripten's wasm<->JS ABI # * Use the metadata to generate the JS glue that goes with the wasm # set file locations, so that JS glue can find what it needs settings.WASM_BINARY_FILE = js_manipulation.escape_for_js_string(os.path.basename(out_wasm)) if finalize: metadata = finalize_wasm(in_wasm, out_wasm, js_syms) else: # Skip finalize and only extract the metadata. if in_wasm != out_wasm: shutil.copy(in_wasm, out_wasm) metadata = get_metadata(in_wasm, out_wasm, False, []) if settings.RELOCATABLE and settings.MEMORY64 == 2: metadata.imports += ['__memory_base32'] # If the binary has already been finalized the settings have already been # updated and we can skip updating them. if finalize: update_settings_glue(out_wasm, metadata, base_metadata) if not settings.WASM_BIGINT and metadata.em_js_funcs: for em_js_func, raw in metadata.em_js_funcs.items(): c_sig = raw.split('<::>')[0].strip('()') if not c_sig or c_sig == 'void': c_sig = [] else: c_sig = c_sig.split(',') signature = metadata.em_js_func_types.get(em_js_func) if signature and len(signature.params) != len(c_sig): diagnostics.warning('em-js-i64', 'using 64-bit arguments in EM_JS function without WASM_BIGINT is not yet fully supported: `%s` (%s, %s)', em_js_func, c_sig, signature.params) asm_consts = create_asm_consts(metadata) em_js_funcs = create_em_js(metadata) if settings.SIDE_MODULE: # When building side modules, valid the EM_ASM and EM_JS string by running # them through node. Without this step, syntax errors are not surfaced # until runtime. # We use subprocess directly here rather than shared.check_call since # check_call doesn't support the `input` argument. if asm_consts: validate = '\n'.join([f'var tmp = {f};' for _, f in asm_consts]) proc = subprocess.run(config.NODE_JS + ['--check', '-'], input=validate.encode('utf-8')) if proc.returncode: exit_with_error(f'EM_ASM function validation failed (node returned {proc.returncode})') if em_js_funcs: validate = '\n'.join(em_js_funcs) proc = subprocess.run(config.NODE_JS + ['--check', '-'], input=validate.encode('utf-8')) if proc.returncode: exit_with_error(f'EM_JS function validation failed (node returned {proc.returncode})') if not outfile_js: report_missing_exports_wasm_only(metadata) logger.debug('emscript: skipping js glue generation') return for e in settings.EXPORTED_FUNCTIONS: if not js_manipulation.isidentifier(e): diagnostics.warning('js-compiler', f'export name is not a valid JS symbol: "{e}". Use `Module` or `wasmExports` to access this symbol') # memory and global initializers if settings.RELOCATABLE: dylink_sec = webassembly.parse_dylink_section(in_wasm) static_bump = align_memory(dylink_sec.mem_size) set_memory(static_bump) logger.debug('stack_low: %d, stack_high: %d, heap_base: %d', settings.STACK_LOW, settings.STACK_HIGH, settings.HEAP_BASE) # When building relocatable output (e.g. MAIN_MODULE) the reported table # size does not include the reserved slot at zero for the null pointer. # So we need to offset the elements by 1. if settings.INITIAL_TABLE == -1: settings.INITIAL_TABLE = dylink_sec.table_size + 1 if metadata.invoke_funcs: settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$getWasmTableEntry'] out = compile_javascript_cached() assert '//FORWARDED_DATA:' in out, 'Did not receive forwarded data in pre output - process failed?' glue, forwarded_data = out.split('//FORWARDED_DATA:', 1) forwarded_json = json.loads(forwarded_data) if forwarded_json['warnings']: diagnostics.warning('js-compiler', 'warnings in JS library compilation') pre, post = glue.split('// EMSCRIPTEN_END_FUNCS') if settings.ASSERTIONS: pre += "function checkIncomingModuleAPI() {\n" for sym in settings.ALL_INCOMING_MODULE_JS_API: if sym not in settings.INCOMING_MODULE_JS_API: pre += f" ignoredModuleProp('{sym}');\n" pre += "}\n" report_missing_exports(forwarded_json['librarySymbols']) asm_const_pairs = ['%s: %s' % (key, value) for key, value in asm_consts] if asm_const_pairs or settings.MAIN_MODULE: pre += 'var ASM_CONSTS = {\n ' + ', \n '.join(asm_const_pairs) + '\n};\n' if em_js_funcs: pre += '\n'.join(em_js_funcs) + '\n' if base_metadata: function_exports = base_metadata.function_exports other_exports = base_metadata.other_exports else: function_exports = metadata.function_exports other_exports = metadata.other_exports other_exports = [e for e in other_exports if not shared.is_internal_global(e[0].name)] if settings.ASYNCIFY == 1: function_exports['asyncify_start_unwind'] = webassembly.FuncType([webassembly.Type.I32], []) function_exports['asyncify_stop_unwind'] = webassembly.FuncType([], []) function_exports['asyncify_start_rewind'] = webassembly.FuncType([webassembly.Type.I32], []) function_exports['asyncify_stop_rewind'] = webassembly.FuncType([], []) parts = [pre] parts += create_module(metadata, function_exports, other_exports, forwarded_json['librarySymbols'], forwarded_json['nativeAliases']) parts.append(post) settings.ALIASES = list(forwarded_json['nativeAliases'].keys()) full_js_module = ''.join(parts) full_js_module = apply_static_code_hooks(forwarded_json, full_js_module) utils.write_file(outfile_js, full_js_module) metadata.library_definitions = forwarded_json['libraryDefinitions'] return metadata @ToolchainProfiler.profile() def get_metadata(infile, outfile, modify_wasm, args): metadata = extract_metadata.extract_metadata(infile) if modify_wasm: # In some cases we still need to modify the wasm file # using wasm-emscripten-finalize. building.run_binaryen_command('wasm-emscripten-finalize', infile=infile, outfile=outfile, args=args) # When we do this we can generate new imports, so # re-read parts of the metadata post-finalize extract_metadata.update_metadata(outfile, metadata) if DEBUG: logger.debug("Metadata: " + pprint.pformat(metadata.__dict__)) return metadata def finalize_wasm(infile, outfile, js_syms): building.save_intermediate(infile, 'base.wasm') args = [] # if we don't need to modify the wasm, don't tell finalize to emit a wasm file modify_wasm = False need_name_section = False if settings.WASM2JS: # wasm2js requires full legalization (and will do extra wasm binary # later processing later anyhow) modify_wasm = True if settings.DEBUG_LEVEL >= 2 or settings.ASYNCIFY_ADD or settings.ASYNCIFY_ADVISE or settings.ASYNCIFY_ONLY or settings.ASYNCIFY_REMOVE or settings.EMIT_SYMBOL_MAP or settings.EMIT_NAME_SECTION: need_name_section = True args.append('-g') if settings.WASM_BIGINT: args.append('--bigint') if settings.DYNCALLS: # we need to add all dyncalls to the wasm modify_wasm = True else: if settings.WASM_BIGINT: args.append('--no-dyncalls') else: args.append('--dyncalls-i64') # we need to add some dyncalls to the wasm modify_wasm = True if settings.AUTODEBUG: # In AUTODEBUG mode we want to delay all legalization until later. This is hack # to force wasm-emscripten-finalize not to do any legalization at all. args.append('--bigint') else: if settings.LEGALIZE_JS_FFI: # When we dynamically link our JS loader adds functions from wasm modules to # the table. It must add the original versions of them, not legalized ones, # so that indirect calls have the right type, so export those. args += building.js_legalization_pass_flags() modify_wasm = True else: args.append('--no-legalize-javascript-ffi') if settings.SIDE_MODULE: args.append('--side-module') if settings.STACK_OVERFLOW_CHECK >= 2: args.append('--check-stack-overflow') modify_wasm = True if settings.STANDALONE_WASM: args.append('--standalone-wasm') if settings.DEBUG_LEVEL >= 3: args.append('--dwarf') if infile != outfile: shutil.copy(infile, outfile) if settings.GENERATE_SOURCE_MAP: building.emit_wasm_source_map(infile, outfile + '.map', outfile) building.save_intermediate(outfile + '.map', 'base_wasm.map') base_url = settings.SOURCE_MAP_BASE + os.path.basename(outfile) + '.map' if modify_wasm: # If we are already modifying, just let Binaryen add the sourcemap URL args += ['--output-source-map-url=' + base_url] else: # Otherwise use objcopy. This avoids re-encoding the file (thus # preserving DWARF) and is faster. # Create a file with the contents of the sourceMappingURL section with shared.get_temp_files().get_file('.bin') as url_file: utils.write_binary(url_file, leb128.u.encode(len(base_url)) + base_url.encode('utf-8')) cmd = [shared.LLVM_OBJCOPY, '--add-section', 'sourceMappingURL=' + url_file, infile] shared.check_call(cmd) # For sections we no longer need, strip now to speed subsequent passes. # If Binaryen is not needed, this is also our last chance to strip. strip_sections = [] if not settings.EMIT_PRODUCERS_SECTION: strip_sections += ['producers'] if not need_name_section: strip_sections += ['name'] if strip_sections or not settings.GENERATE_DWARF: building.save_intermediate(outfile, 'strip.wasm') building.strip(infile, outfile, debug=not settings.GENERATE_DWARF, sections=strip_sections) metadata = get_metadata(outfile, outfile, modify_wasm, args) if settings.GENERATE_SOURCE_MAP: building.save_intermediate(outfile + '.map', 'post_finalize.map') expected_exports = set(settings.EXPORTED_FUNCTIONS) expected_exports.update(asmjs_mangle(s) for s in settings.REQUIRED_EXPORTS) expected_exports.update(asmjs_mangle(s) for s in settings.EXPORT_IF_DEFINED) # Assume that when JS symbol dependencies are exported it is because they # are needed by by a JS symbol and are not being explicitly exported due # to EMSCRIPTEN_KEEPALIVE (llvm.used). for deps in js_syms.values(): expected_exports.update(asmjs_mangle(s) for s in deps) # Calculate the subset of exports that were explicitly marked as # EMSCRIPTEN_KEEPALIVE (llvm.used). # These are any exports that were not requested on the command line and are # not known auto-generated system functions. unexpected_exports = [e for e in metadata.all_exports if shared.is_user_export(e)] unexpected_exports = [asmjs_mangle(e) for e in unexpected_exports] unexpected_exports = [e for e in unexpected_exports if e not in expected_exports] if not settings.STANDALONE_WASM and 'main' in metadata.all_exports or '__main_argc_argv' in metadata.all_exports: if 'EXPORTED_FUNCTIONS' in user_settings and '_main' not in settings.USER_EXPORTS: # If `_main` was unexpectedly exported we assume it was added to # EXPORT_IF_DEFINED by `phase_linker_setup` in order that we can detect # it and report this warning. After reporting the warning we explicitly # ignore the export and run as if there was no main function since that # is defined is behaviour for programs that don't include `_main` in # EXPORTED_FUNCTIONS. diagnostics.warning('unused-main', '`main` is defined in the input files, but `_main` is not in `EXPORTED_FUNCTIONS`. Add it to this list if you want `main` to run.') if 'main' in metadata.all_exports: metadata.all_exports.remove('main') else: metadata.all_exports.remove('__main_argc_argv') else: unexpected_exports.append('_main') building.user_requested_exports.update(unexpected_exports) settings.EXPORTED_FUNCTIONS.extend(unexpected_exports) return metadata def create_tsd_exported_runtime_methods(metadata): # Use the TypeScript compiler to generate definitions for all of the runtime # exports. The JS from the library any JS docs are included in the file used # for generation. js_doc = 'var RuntimeExports = {};\n' for name in settings.EXPORTED_RUNTIME_METHODS: docs = '/** @type {{any}} */' snippet = '' if name in metadata.library_definitions: definition = metadata.library_definitions[name] if definition['snippet']: snippet = ' = ' + definition['snippet'] # Clear the doc so the type is either computed from the snippet or # defined by the definition below. docs = '' if definition['docs']: docs = definition['docs'] # TSC does not generate the correct type if there are jsdocs and nothing # is assigned to the property. if not snippet: snippet = ' = null' js_doc += f'{docs}\nRuntimeExports[\'{name}\']{snippet};\n' js_doc_file = in_temp('jsdoc.js') tsc_output_file = in_temp('jsdoc.d.ts') utils.write_file(js_doc_file, js_doc) tsc = shared.get_npm_cmd('tsc', missing_ok=True) # Prefer the npm install'd version of tsc since we know that one is compatible # with emscripten output. if not tsc: # Fall back to tsc in the user's PATH. tsc = shutil.which('tsc') if not tsc: exit_with_error('tsc executable not found in node_modules or in $PATH') # Use the full path from the which command so windows can find tsc. tsc = [tsc] cmd = tsc + ['--outFile', tsc_output_file, '--skipLibCheck', # Avoid checking any of the user's types e.g. node_modules/@types. '--declaration', '--emitDeclarationOnly', '--allowJs', js_doc_file] shared.check_call(cmd, cwd=path_from_root()) return utils.read_file(tsc_output_file) def create_tsd(metadata, embind_tsd): out = '// TypeScript bindings for emscripten-generated code. Automatically generated at compile time.\n' if settings.EXPORTED_RUNTIME_METHODS: out += create_tsd_exported_runtime_methods(metadata) # Manually generate definitions for any Wasm function exports. out += 'interface WasmModule {\n' for name, functype in metadata.function_exports.items(): mangled = asmjs_mangle(name) should_export = settings.EXPORT_KEEPALIVE and mangled in settings.EXPORTED_FUNCTIONS if not should_export: continue arguments = [] for index, type in enumerate(functype.params): arguments.append(f"_{index}: {type_to_ts_type(type)}") out += f' {mangled}({", ".join(arguments)}): ' assert len(functype.returns) <= 1, 'One return type only supported' if functype.returns: out += f'{type_to_ts_type(functype.returns[0])}' else: out += 'void' out += ';\n' out += '}\n' out += f'\n{embind_tsd}' # Combine all the various exports. export_interfaces = 'WasmModule' if settings.EXPORTED_RUNTIME_METHODS: export_interfaces += ' & typeof RuntimeExports' # Add in embind definitions. if embind_tsd: export_interfaces += ' & EmbindModule' out += f'export type MainModule = {export_interfaces};\n' if settings.MODULARIZE: return_type = 'MainModule' if settings.WASM_ASYNC_COMPILATION: return_type = f'Promise<{return_type}>' out += f'export default function MainModuleFactory (options?: unknown): {return_type};\n' return out def create_asm_consts(metadata): asm_consts = {} for addr, const in metadata.em_asm_consts.items(): body = trim_asm_const_body(const) max_arity = 16 arity = 0 for i in range(max_arity): if f'${i}' in const: arity = i + 1 args = ', '.join(f'${i}' for i in range(arity)) if 'arguments' in body: # arrow functions don't bind `arguments` so we have to use # the old function syntax in this case func = f'function({args}) {{ {body} }}' else: func = f'({args}) => {{ {body} }}' if settings.RELOCATABLE: addr += settings.GLOBAL_BASE asm_consts[addr] = func asm_consts = sorted(asm_consts.items()) return asm_consts def type_to_sig(type): # These should match the conversion in $sigToWasmTypes. return { webassembly.Type.I32: 'i', webassembly.Type.I64: 'j', webassembly.Type.F32: 'f', webassembly.Type.F64: 'd', webassembly.Type.EXTERNREF: 'e', webassembly.Type.VOID: 'v', }[type] def type_to_ts_type(type): return { webassembly.Type.I32: 'number', webassembly.Type.I64: 'BigInt', webassembly.Type.F32: 'number', webassembly.Type.F64: 'number', webassembly.Type.EXTERNREF: 'any', webassembly.Type.VOID: 'void', }[type] def func_type_to_sig(type): parameters = [type_to_sig(param) for param in type.params] if type.returns: assert len(type.returns) == 1, "One return type expected." ret = type.returns[0] else: ret = webassembly.Type.VOID return type_to_sig(ret) + ''.join(parameters) def create_em_js(metadata): em_js_funcs = [] separator = '<::>' for name, raw in metadata.em_js_funcs.items(): assert separator in raw args, body = raw.split(separator, 1) args = args[1:-1] if args == 'void': args = [] else: args = args.split(',') arg_names = [arg.split()[-1].replace('*', '') for arg in args if arg] args = ','.join(arg_names) func = f'function {name}({args}) {body}' if settings.WASM_ESM_INTEGRATION: # Like JS library function EM_JS functions are exported at the point of # declaration in WASM_ESM_INTEGRATION node. func = f'export {func}' em_js_funcs.append(func) if (settings.MAIN_MODULE or settings.ASYNCIFY == 2) and name in metadata.em_js_func_types: sig = func_type_to_sig(metadata.em_js_func_types[name]) sig = f'{name}.sig = \'{sig}\';' em_js_funcs.append(sig) return em_js_funcs def add_standard_wasm_imports(send_items_map): extra_sent_items = [] if settings.SAFE_HEAP: extra_sent_items.append('segfault') extra_sent_items.append('alignfault') # Special case for importing memory and table # TODO(sbc): can we make these into normal library symbols? if settings.IMPORTED_MEMORY: send_items_map['memory'] = 'wasmMemory' if settings.RELOCATABLE: send_items_map['__indirect_function_table'] = 'wasmTable' if settings.MEMORY64: send_items_map['__table_base32'] = '___table_base32' if settings.AUTODEBUG: extra_sent_items += [ 'log_execution', 'get_i32', 'get_i64', 'get_f32', 'get_f64', 'get_funcref', 'get_externref', 'get_anyref', 'get_exnref', 'set_i32', 'set_i64', 'set_f32', 'set_f64', 'set_funcref', 'set_externref', 'set_anyref', 'set_exnref', 'load_ptr', 'load_val_i32', 'load_val_i64', 'load_val_f32', 'load_val_f64', 'store_ptr', 'store_val_i32', 'store_val_i64', 'store_val_f32', 'store_val_f64', 'memory_grow_pre', 'memory_grow_post', ] if settings.SPLIT_MODULE and settings.ASYNCIFY == 2: # Calls to this function are generated by binaryen so it must be manually # imported. extra_sent_items.append('__load_secondary_module') for s in extra_sent_items: send_items_map[s] = s def create_sending(metadata, library_symbols): # Map of wasm imports to mangled/external/JS names send_items_map = {name: name for name in metadata.invoke_funcs} for name in metadata.imports: if name in metadata.em_js_funcs: # EM_JS functions are exported directly at the declaration site in # WASM_ESM_INTEGRATION mode. if not settings.WASM_ESM_INTEGRATION: send_items_map[name] = name else: send_items_map[name] = asmjs_mangle(name) add_standard_wasm_imports(send_items_map) if settings.MAIN_MODULE: # When including dynamic linking support, also add any JS library functions # that are part of EXPORTED_FUNCTIONS (or in the case of MAIN_MODULE=1 add # all JS library functions). This allows `dlsym(RTLD_DEFAULT)` to lookup JS # library functions, since `wasmImports` acts as the global symbol table. wasm_exports = set(metadata.function_exports) library_symbols = set(library_symbols) if settings.MAIN_MODULE == 1: for f in library_symbols: if shared.is_c_symbol(f): demangled = shared.demangle_c_symbol_name(f) if demangled in wasm_exports: continue send_items_map[demangled] = f else: for f in settings.EXPORTED_FUNCTIONS + settings.SIDE_MODULE_IMPORTS: if f in library_symbols and shared.is_c_symbol(f): demangled = shared.demangle_c_symbol_name(f) if demangled in wasm_exports: continue send_items_map[demangled] = f sorted_items = sorted(send_items_map.items()) if settings.WASM_ESM_INTEGRATION: elems = [] for k, v in sorted_items: elems.append(f'{v} as {k}') elems = ',\n '.join(elems) exports = '// Export JS functions to the wasm module with demangled names.\n' exports += f"export {{\n {elems}\n}};" return exports prefix = '' if settings.MAYBE_CLOSURE_COMPILER: # This prevents closure compiler from minifying the field names in this # object. prefix = '/** @export */\n ' elems = [] for k, v in sorted_items: if k == v: elems.append(f'{prefix}{k}') else: elems.append(f'{prefix}{k}: {v}') return '{\n ' + ',\n '.join(elems) + '\n}' def create_reexports(metadata): assert settings.WASM_ESM_INTEGRATION exports = '// Re-export imported wasm functions to the JS entry point. These are user-facing and underscore mangled.\n' wasm_exports = [] for exp in building.user_requested_exports: if shared.is_c_symbol(exp): demangled = shared.demangle_c_symbol_name(exp) if demangled in metadata.em_js_funcs: wasm_exports.append(f'{demangled} as {exp}') elif demangled in settings.WASM_EXPORTS: wasm_exports.append(exp) elif demangled == 'main' and '__main_argc_argv' in settings.WASM_EXPORTS: wasm_exports.append('_main') exports += f"export {{ {', '.join(wasm_exports)} }};" return exports def install_debug_wrapper(sym): if settings.MINIMAL_RUNTIME or not settings.ASSERTIONS: return False # The emscripten stack functions are called very early (by writeStackCookie) before # the runtime is initialized so we can't create these wrappers that check for # runtimeInitialized. if sym.startswith(('__asan_', 'emscripten_stack_', '_emscripten_stack_')): return False # `__trap` can occur before the runtime is initialized since it is used in abort. # `emscripten_get_sbrk_ptr` can be called prior to runtime initialzaion by # the dynamic linking code. return sym not in ['__trap', 'emscripten_get_sbrk_ptr'] def should_export(sym): return settings.EXPORT_ALL or (settings.EXPORT_KEEPALIVE and sym in settings.EXPORTED_FUNCTIONS) def create_receiving(function_exports, other_exports, library_symbols, aliases): generate_dyncall_assignment = 'dynCalls' in library_symbols receiving = ['\n// Imports from the Wasm binary.'] if settings.WASM_ESM_INTEGRATION: exported_symbols = [e[0].name for e in other_exports] + list(function_exports.keys()) exports = [] for sym in exported_symbols: mangled = asmjs_mangle(sym) if mangled != sym: exports.append(f'{sym} as {mangled}') else: exports.append(sym) for alias, target in aliases.items(): exports.append(f'{target} as {alias}') receiving.append('import {') receiving.append(' ' + ',\n '.join(exports)) receiving.append(f"}} from './{settings.WASM_BINARY_FILE}';") if generate_dyncall_assignment: receiving.append('\nfunction assignDynCalls() {') receiving.append(' // Construct dynCalls mapping') for sym in function_exports: if sym.startswith('dynCall_'): sig_str = sym.removeprefix('dynCall_') receiving.append(f" dynCalls['{sig_str}'] = {sym};") receiving.append('}') return '\n'.join(receiving) # When not declaring asm exports `assignWasmExports` is instead defined as a simple # library function. if not settings.DECLARE_ASM_MODULE_EXPORTS: return '' # Exports are assigned inside a function to variables # existing in top level JS scope, i.e. # var _main; # function assignWasmExports(wasmExport) { # _main = wasmExports["_main"]; exports = {name: sig for name, sig in function_exports.items() if name != building.WASM_CALL_CTORS} for export, info in other_exports: exports[export.name] = (export, info) mangled = [asmjs_mangle(s) for s in exports] + list(aliases.keys()) if settings.ASSERTIONS: # In debug builds we generate trapping functions in case # folks try to call/use a reference that was taken before the # wasm module is available. for sym in mangled: module_export = (settings.MODULARIZE or not settings.MINIMAL_RUNTIME) and should_export(sym) and settings.MODULARIZE != 'instance' if not js_manipulation.isidentifier(sym) and not module_export: continue assignment = f'var {sym}' if module_export: if js_manipulation.isidentifier(sym): assignment += f" = Module['{sym}']" else: assignment = f"Module['{sym}']" receiving.append(f"{assignment} = makeInvalidEarlyAccess('{sym}');") else: # Declare all exports in a single var statement sep = ',\n ' receiving.append(f'var {sep.join(mangled)};\n') if settings.MODULARIZE == 'instance': esm_exports = [e for e in mangled if should_export(e)] if esm_exports: esm_exports = ', '.join(esm_exports) receiving.append(f'export {{ {esm_exports} }};') alias_inverse_map = {} logger.debug(json.dumps(aliases)) for sym, alias in aliases.items(): assert alias in exports, f'expected alias target ({alias}) to be exported' alias_inverse_map.setdefault(alias, []).append(sym) do_module_exports = (settings.MODULARIZE or not settings.MINIMAL_RUNTIME) and settings.MODULARIZE != 'instance' receiving.append('\nfunction assignWasmExports(wasmExports) {') if settings.ASSERTIONS: for sym in exports: if settings.EMBIND_GEN_MODE and sym.startswith('asyncify_'): # EMBIND_GEN_MODE is run before binaryen so the asyncify exports that # are created by binaryen will be missing. continue receiving.append(f" assert(typeof wasmExports['{sym}'] != 'undefined', 'missing Wasm export: {sym}');") for sym, info in exports.items(): is_function = type(info) == webassembly.FuncType mangled = asmjs_mangle(sym) assignment = mangled if generate_dyncall_assignment and is_function and sym.startswith('dynCall_'): sig_str = sym.removeprefix('dynCall_') assignment += f" = dynCalls['{sig_str}']" if do_module_exports and should_export(mangled): if js_manipulation.isidentifier(mangled): assignment += f" = Module['{mangled}']" else: assignment = f"Module['{mangled}']" elif not js_manipulation.isidentifier(mangled): # Symbol is not a valid JS identify and also not exported. In this case we # have nothing to do here. continue if sym in alias_inverse_map: for target in alias_inverse_map[sym]: assignment += f" = {target}" if do_module_exports and target in settings.EXPORTED_RUNTIME_METHODS: assignment += f" = Module['{target}']" if is_function and install_debug_wrapper(sym): nargs = len(info.params) receiving.append(f" {assignment} = createExportWrapper('{sym}', {nargs});") elif not is_function and info[0].kind == webassembly.ExternType.GLOBAL and not info[1].mutable: if settings.LEGACY_VM_SUPPORT: value = f"typeof wasmExports['{sym}'] == 'object' ? wasmExports['{sym}'].value : wasmExports['{sym}']" else: value = f"wasmExports['{sym}'].value" if settings.MEMORY64: value = f'Number({value})' elif settings.CAN_ADDRESS_2GB: value = f'({value}) >>> 0' receiving.append(f" {assignment} = {value};") else: receiving.append(f" {assignment} = wasmExports['{sym}'];") receiving.append('}') return '\n'.join(receiving) def create_module(metadata, function_exports, other_exports, library_symbols, aliases): module = [] module.append(create_receiving(function_exports, other_exports, library_symbols, aliases)) sending = create_sending(metadata, library_symbols) if settings.WASM_ESM_INTEGRATION: module.append(sending) else: if settings.PTHREADS or settings.WASM_WORKERS or (settings.IMPORTED_MEMORY and settings.MODULARIZE == 'instance'): sending = textwrap.indent(sending, ' ').strip() module.append('''\ var wasmImports; function assignWasmImports() { wasmImports = %s; }''' % sending) else: module.append('var wasmImports = %s;' % sending) if settings.SUPPORT_LONGJMP == 'emscripten' or not settings.DISABLE_EXCEPTION_CATCHING: module += create_invoke_wrappers(metadata) else: assert not metadata.invoke_funcs, "invoke_ functions exported but exceptions and longjmp are both disabled" if settings.MEMORY64 or settings.CAN_ADDRESS_2GB: module.append(create_pointer_conversion_wrappers(metadata)) if settings.WASM_ESM_INTEGRATION: module.append(create_reexports(metadata)) module = [chunk for chunk in module if chunk] return '\n\n'.join(module) + '\n' def create_invoke_wrappers(metadata): """Asm.js-style exception handling: invoke wrapper generation.""" invoke_wrappers = [] for invoke in metadata.invoke_funcs: sig = invoke.removeprefix('invoke_') invoke_wrappers.append(js_manipulation.make_invoke(sig)) return invoke_wrappers def create_pointer_conversion_wrappers(metadata): # TODO(sbc): Move this into somewhere less static. Maybe it can become # part of library.js file, even though this metadata relates specifically # to native (non-JS) functions. # # The signature format here is similar to the one used for JS libraries # but with the following as the only valid char: # '_' - non-pointer argument (pass through unchanged) # 'p' - pointer/int53 argument (convert to/from BigInt) # 'P' - same as above but allow `undefined` too (requires extra check) mapping = { 'sbrk': 'pP', '_emscripten_stack_alloc': 'pp', 'emscripten_get_sbrk_ptr': 'p', 'emscripten_builtin_malloc': 'pp', 'emscripten_builtin_calloc': 'ppp', 'wasmfs_create_node_backend': 'pp', 'malloc': 'pp', 'realloc': 'ppp', 'calloc': 'ppp', 'webidl_malloc': 'pp', 'memalign': 'ppp', 'memcmp': '_ppp', 'memcpy': 'pppp', '__getTypeName': 'pp', 'setThrew': '_p', 'free': '_p', 'webidl_free': '_p', '_emscripten_stack_restore': '_p', 'fflush': '_p', 'emscripten_stack_get_end': 'p', 'emscripten_stack_get_base': 'p', 'pthread_self': 'p', 'emscripten_stack_get_current': 'p', '__errno_location': 'p', 'emscripten_builtin_memalign': 'ppp', 'emscripten_builtin_free': 'vp', 'main': '__PP', '__main_argc_argv': '__PP', 'emscripten_stack_set_limits': '_pp', '__set_stack_limits': '_pp', '__set_thread_state': '_p___', '__cxa_can_catch': '_ppp', '__cxa_increment_exception_refcount': '_p', '__cxa_decrement_exception_refcount': '_p', '__cxa_get_exception_ptr': 'pp', '_wasmfs_write_file': '_ppp', '_wasmfs_mknod': '_p__', '_wasmfs_symlink': '_pp', '_wasmfs_chmod': '_p_', '_wasmfs_lchmod': '_p_', '_wasmfs_get_cwd': 'p_', '_wasmfs_identify': '_p', '_wasmfs_read_file': '_ppp', '_wasmfs_node_record_dirent': '_pp_', '__dl_seterr': '_pp', '_emscripten_run_js_on_main_thread': '__p_p_', '_emscripten_thread_exit': '_p', '_emscripten_thread_init': '_p_____', '_emscripten_thread_free_data': '_p', '_emscripten_dlsync_self_async': '_p', '_emscripten_proxy_dlsync_async': '_pp', '_emscripten_wasm_worker_initialize': '_p_', '_wasmfs_rename': '_pp', '_wasmfs_readlink': '_pp', '_wasmfs_truncate': '_p_', '_wasmfs_mmap': 'pp____', '_wasmfs_munmap': '_pp', '_wasmfs_msync': '_pp_', '_wasmfs_read': '__pp', '_wasmfs_pread': '__pp_', '_wasmfs_utime': '_p__', '_wasmfs_rmdir': '_p', '_wasmfs_unlink': '_p', '_wasmfs_mkdir': '_p_', '_wasmfs_open': '_p__', '_wasmfs_mount': '_pp', '_wasmfs_chdir': '_p', 'asyncify_start_rewind': '_p', 'asyncify_start_unwind': '_p', '__get_exception_message': '_ppp', 'stbi_image_free': 'vp', 'stbi_load': 'ppppp_', 'stbi_load_from_memory': 'pp_ppp_', 'strerror': 'p_', 'emscripten_proxy_finish': '_p', 'emscripten_proxy_execute_queue': '_p', '_emval_coro_resume': '_pp', '_emval_coro_reject': '_pp', 'emscripten_main_runtime_thread_id': 'p', '_emscripten_set_offscreencanvas_size_on_thread': '_pp__', 'fileno': '_p', '_emscripten_run_callback_on_thread': '_pp_ppp', '_emscripten_find_dylib': 'ppppp', } for function in settings.SIGNATURE_CONVERSIONS: sym, sig = function.split(':') mapping[sym] = sig for f in ASAN_C_HELPERS: mapping[f] = '_pp' wrappers = ''' // Argument name here must shadow the `wasmExports` global so // that it is recognised by metadce and minify-import-export-names // passes. function applySignatureConversions(wasmExports) { // First, make a copy of the incoming exports object wasmExports = Object.assign({}, wasmExports); ''' sigs_seen = set() wrap_functions = [] for symbol, functype in metadata.function_exports.items(): # dynCall_ functions are generated by binaryen. They all take a # function pointer as their first argument. # The second part of this check can be removed once the table64 # llvm changs lands. if symbol.startswith('dynCall_') and functype.params[0] == webassembly.Type.I64: sig = symbol.split('_')[-1] sig = ['p' if t == 'p' else '_' for t in sig] sig.insert(1, 'p') sig = ''.join(sig) mapping[symbol] = sig sig = mapping.get(symbol) if sig: if settings.MEMORY64: if sig not in sigs_seen: wrappers += js_manipulation.make_wasm64_wrapper(sig) sigs_seen.add(sig) wrap_functions.append(symbol) elif sig[0] == 'p': if sig not in sigs_seen: wrappers += js_manipulation.make_unsign_pointer_wrapper(sig) sigs_seen.add(sig) wrap_functions.append(symbol) for f in wrap_functions: sig = mapping[f] wrappers += f"\n wasmExports['{f}'] = makeWrapper_{sig}(wasmExports['{f}']);" wrappers += '\n return wasmExports;\n}' return wrappers