Skip to content

Commit cfc3ce9

Browse files
authored
Rename metadata member names. NFC (#21784)
These names are a legacy holdover from the days when we used wasm-emscripten-finalize to emit the metadata.
1 parent ffb52c9 commit cfc3ce9

File tree

3 files changed

+42
-42
lines changed

3 files changed

+42
-42
lines changed

tools/emscripten.py

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,8 @@ def update_settings_glue(wasm_file, metadata):
143143
settings.WEAK_IMPORTS += webassembly.get_weak_imports(wasm_file)
144144

145145
settings.WASM_EXPORTS = metadata.all_exports
146-
settings.WASM_GLOBAL_EXPORTS = list(metadata.namedGlobals.keys())
147-
settings.HAVE_EM_ASM = bool(settings.MAIN_MODULE or len(metadata.asmConsts) != 0)
146+
settings.WASM_GLOBAL_EXPORTS = list(metadata.global_exports.keys())
147+
settings.HAVE_EM_ASM = bool(settings.MAIN_MODULE or len(metadata.em_asm_consts) != 0)
148148

149149
# start with the MVP features, and add any detected features.
150150
settings.BINARYEN_FEATURES = ['--mvp-features'] + metadata.features
@@ -163,7 +163,7 @@ def update_settings_glue(wasm_file, metadata):
163163

164164
# When using dynamic linking the main function might be in a side module.
165165
# To be safe assume they do take input parameters.
166-
settings.MAIN_READS_PARAMS = metadata.mainReadsParams or bool(settings.MAIN_MODULE)
166+
settings.MAIN_READS_PARAMS = metadata.main_reads_params or bool(settings.MAIN_MODULE)
167167
if settings.MAIN_READS_PARAMS and not settings.STANDALONE_WASM:
168168
# callMain depends on this library function
169169
settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$stringToUTF8OnStack']
@@ -173,7 +173,7 @@ def update_settings_glue(wasm_file, metadata):
173173
# exported. In theory it should always be present since its defined in compiler-rt.
174174
assert 'emscripten_stack_get_end' in metadata.function_exports
175175

176-
for deps in metadata.jsDeps:
176+
for deps in metadata.js_deps:
177177
settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE.extend(deps.split(','))
178178

179179

@@ -290,19 +290,19 @@ def trim_asm_const_body(body):
290290
return body
291291

292292

293-
def create_named_globals(metadata):
294-
named_globals = []
295-
for k, v in metadata.namedGlobals.items():
293+
def create_global_exports(metadata):
294+
global_exports = []
295+
for k, v in metadata.global_exports.items():
296296
v = int(v)
297297
if settings.RELOCATABLE:
298298
v += settings.GLOBAL_BASE
299299
mangled = asmjs_mangle(k)
300300
if settings.MINIMAL_RUNTIME:
301-
named_globals.append("var %s = %s;" % (mangled, v))
301+
global_exports.append("var %s = %s;" % (mangled, v))
302302
else:
303-
named_globals.append("var %s = Module['%s'] = %s;" % (mangled, mangled, v))
303+
global_exports.append("var %s = Module['%s'] = %s;" % (mangled, mangled, v))
304304

305-
return '\n'.join(named_globals)
305+
return '\n'.join(global_exports)
306306

307307

308308
def emscript(in_wasm, out_wasm, outfile_js, js_syms, finalize=True):
@@ -340,7 +340,7 @@ def emscript(in_wasm, out_wasm, outfile_js, js_syms, finalize=True):
340340
if finalize:
341341
update_settings_glue(out_wasm, metadata)
342342

343-
if not settings.WASM_BIGINT and metadata.emJsFuncs:
343+
if not settings.WASM_BIGINT and metadata.em_js_funcs:
344344
import_map = {}
345345

346346
with webassembly.Module(in_wasm) as module:
@@ -349,7 +349,7 @@ def emscript(in_wasm, out_wasm, outfile_js, js_syms, finalize=True):
349349
if imp.module not in ('GOT.mem', 'GOT.func'):
350350
import_map[imp.field] = imp
351351

352-
for em_js_func, raw in metadata.emJsFuncs.items():
352+
for em_js_func, raw in metadata.em_js_funcs.items():
353353
c_sig = raw.split('<::>')[0].strip('()')
354354
if not c_sig or c_sig == 'void':
355355
c_sig = []
@@ -405,7 +405,7 @@ def emscript(in_wasm, out_wasm, outfile_js, js_syms, finalize=True):
405405
if settings.ASYNCIFY == 1:
406406
metadata.imports += ['__asyncify_state', '__asyncify_data']
407407

408-
if metadata.invokeFuncs:
408+
if metadata.invoke_funcs:
409409
settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$getWasmTableEntry']
410410

411411
glue, forwarded_data = compile_javascript()
@@ -674,7 +674,7 @@ def create_tsd(metadata, embind_tsd):
674674

675675
def create_asm_consts(metadata):
676676
asm_consts = {}
677-
for addr, const in metadata.asmConsts.items():
677+
for addr, const in metadata.em_asm_consts.items():
678678
body = trim_asm_const_body(const)
679679
args = []
680680
max_arity = 16
@@ -735,7 +735,7 @@ def func_type_to_sig(type):
735735
def create_em_js(metadata):
736736
em_js_funcs = []
737737
separator = '<::>'
738-
for name, raw in metadata.emJsFuncs.items():
738+
for name, raw in metadata.em_js_funcs.items():
739739
assert separator in raw
740740
args, body = raw.split(separator, 1)
741741
args = args[1:-1]
@@ -746,8 +746,8 @@ def create_em_js(metadata):
746746
arg_names = [arg.split()[-1].replace('*', '') for arg in args if arg]
747747
args = ','.join(arg_names)
748748
func = f'function {name}({args}) {body}'
749-
if (settings.MAIN_MODULE or settings.ASYNCIFY == 2) and name in metadata.emJsFuncTypes:
750-
sig = func_type_to_sig(metadata.emJsFuncTypes[name])
749+
if (settings.MAIN_MODULE or settings.ASYNCIFY == 2) and name in metadata.em_js_func_types:
750+
sig = func_type_to_sig(metadata.em_js_func_types[name])
751751
func = func + f'\n{name}.sig = \'{sig}\';'
752752
em_js_funcs.append(func)
753753

@@ -816,10 +816,10 @@ def create_sending(metadata, library_symbols):
816816
# Map of wasm imports to mangled/external/JS names
817817
send_items_map = {}
818818

819-
for name in metadata.invokeFuncs:
819+
for name in metadata.invoke_funcs:
820820
send_items_map[name] = name
821821
for name in metadata.imports:
822-
if name in metadata.emJsFuncs:
822+
if name in metadata.em_js_funcs:
823823
send_items_map[name] = name
824824
else:
825825
send_items_map[name] = asmjs_mangle(name)
@@ -951,7 +951,7 @@ def create_receiving(function_exports):
951951

952952

953953
def create_module(receiving, metadata, library_symbols):
954-
receiving += create_named_globals(metadata)
954+
receiving += create_global_exports(metadata)
955955
module = []
956956

957957
sending = create_sending(metadata, library_symbols)
@@ -973,7 +973,7 @@ def create_module(receiving, metadata, library_symbols):
973973
if settings.SUPPORT_LONGJMP == 'emscripten' or not settings.DISABLE_EXCEPTION_CATCHING:
974974
module.append(create_invoke_wrappers(metadata))
975975
else:
976-
assert not metadata.invokeFuncs, "invoke_ functions exported but exceptions and longjmp are both disabled"
976+
assert not metadata.invoke_funcs, "invoke_ functions exported but exceptions and longjmp are both disabled"
977977
if settings.MEMORY64 or settings.CAN_ADDRESS_2GB:
978978
module.append(create_pointer_conversion_wrappers(metadata))
979979
return module
@@ -982,7 +982,7 @@ def create_module(receiving, metadata, library_symbols):
982982
def create_invoke_wrappers(metadata):
983983
"""Asm.js-style exception handling: invoke wrapper generation."""
984984
invoke_wrappers = ''
985-
for invoke in metadata.invokeFuncs:
985+
for invoke in metadata.invoke_funcs:
986986
sig = removeprefix(invoke, 'invoke_')
987987
invoke_wrappers += '\n' + js_manipulation.make_invoke(sig) + '\n'
988988
return invoke_wrappers

tools/extract_metadata.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,8 @@ def get_main_reads_params(module, export_map):
239239
return True
240240

241241

242-
def get_named_globals(module, exports):
243-
named_globals = {}
242+
def get_global_exports(module, exports):
243+
global_exports = {}
244244
internal_start_stop_symbols = set(['__start_em_asm', '__stop_em_asm',
245245
'__start_em_lib_deps', '__stop_em_lib_deps',
246246
'__em_lib_deps'])
@@ -250,8 +250,8 @@ def get_named_globals(module, exports):
250250
if export.name in internal_start_stop_symbols or any(export.name.startswith(p) for p in internal_prefixes):
251251
continue
252252
g = module.get_global(export.index)
253-
named_globals[export.name] = str(get_global_value(g))
254-
return named_globals
253+
global_exports[export.name] = str(get_global_value(g))
254+
return global_exports
255255

256256

257257
def get_function_exports(module):
@@ -279,7 +279,7 @@ def update_metadata(filename, metadata):
279279
metadata.all_exports = [utils.removeprefix(e.name, '__em_js__') for e in module.get_exports()]
280280

281281
metadata.imports = imports
282-
metadata.invokeFuncs = invoke_funcs
282+
metadata.invoke_funcs = invoke_funcs
283283

284284

285285
def get_string_at(module, address):
@@ -292,14 +292,14 @@ def get_string_at(module, address):
292292
class Metadata:
293293
imports: List[str]
294294
export: List[str]
295-
asmConsts: Dict[int, str]
296-
jsDeps: List[str]
297-
emJsFuncs: Dict[str, str]
298-
emJsFuncTypes: Dict[str, str]
295+
em_asm_consts: Dict[int, str]
296+
js_deps: List[str]
297+
em_js_funcs: Dict[str, str]
298+
em_js_func_types: Dict[str, str]
299299
features: List[str]
300-
invokeFuncs: List[str]
301-
mainReadsParams: bool
302-
namedGlobals: List[str]
300+
invoke_funcs: List[str]
301+
main_reads_params: bool
302+
global_exports: List[str]
303303

304304
def __init__(self):
305305
pass
@@ -347,14 +347,14 @@ def extract_metadata(filename):
347347
metadata.imports = import_names
348348
metadata.function_exports = get_function_exports(module)
349349
metadata.all_exports = [utils.removeprefix(e.name, '__em_js__') for e in exports]
350-
metadata.asmConsts = get_section_strings(module, export_map, 'em_asm')
351-
metadata.jsDeps = [d for d in get_section_strings(module, export_map, 'em_lib_deps').values() if d]
352-
metadata.emJsFuncs = em_js_funcs
353-
metadata.emJsFuncTypes = em_js_func_types
350+
metadata.em_asm_consts = get_section_strings(module, export_map, 'em_asm')
351+
metadata.js_deps = [d for d in get_section_strings(module, export_map, 'em_lib_deps').values() if d]
352+
metadata.em_js_funcs = em_js_funcs
353+
metadata.em_js_func_types = em_js_func_types
354354
metadata.features = features
355-
metadata.invokeFuncs = invoke_funcs
356-
metadata.mainReadsParams = get_main_reads_params(module, export_map)
357-
metadata.namedGlobals = get_named_globals(module, exports)
355+
metadata.invoke_funcs = invoke_funcs
356+
metadata.main_reads_params = get_main_reads_params(module, export_map)
357+
metadata.global_exports = get_global_exports(module, exports)
358358

359359
# print("Metadata parsed: " + pprint.pformat(metadata))
360360
return metadata

tools/link.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2793,7 +2793,7 @@ def process_dynamic_libs(dylibs, lib_dirs):
27932793
imports = [i.field for i in imports if i.kind in (webassembly.ExternType.FUNC, webassembly.ExternType.GLOBAL, webassembly.ExternType.TAG)]
27942794
# For now we ignore `invoke_` functions imported by side modules and rely
27952795
# on the dynamic linker to create them on the fly.
2796-
# TODO(sbc): Integrate with metadata.invokeFuncs that comes from the
2796+
# TODO(sbc): Integrate with metadata.invoke_funcs that comes from the
27972797
# main module to avoid creating new invoke functions at runtime.
27982798
imports = set(imports)
27992799
imports = set(i for i in imports if not i.startswith('invoke_'))

0 commit comments

Comments
 (0)