Use a python class in tools/extract_metadata.py. NFC (emscripten-core#18007)

sbc100 · web-flow · commit b21196e31aea · 2022-10-06T18:28:04.000-07:00
diff --git a/emcc.py b/emcc.py
@@ -724,7 +724,7 @@ def process_dynamic_libs(dylibs, lib_dirs):
     imports = [i.field for i in imports if i.kind in (webassembly.ExternType.FUNC, webassembly.ExternType.GLOBAL, webassembly.ExternType.TAG)]
     # For now we ignore `invoke_` functions imported by side modules and rely
     # on the dynamic linker to create them on the fly.
-    # TODO(sbc): Integrate with metadata['invokeFuncs'] that comes from the
+    # TODO(sbc): Integrate with metadata.invokeFuncs that comes from the
     # main module to avoid creating new invoke functions at runtime.
     imports = set(i for i in imports if not i.startswith('invoke_'))
     weak_imports = imports.intersection(exports)
diff --git a/emscripten.py b/emscripten.py
@@ -120,27 +120,27 @@ def get_weak_imports(main_wasm):
 
 
 def update_settings_glue(wasm_file, metadata):
-  optimize_syscalls(metadata['declares'])
+  optimize_syscalls(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 + [to_nice_ident(d) for d in metadata['declares']]
-    syms = set(syms).difference(metadata['exports'])
-    syms.update(metadata['globalImports'])
+    syms = settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE + [to_nice_ident(d) for d in metadata.imports]
+    syms = set(syms).difference(metadata.exports)
+    syms.update(metadata.globalImports)
     settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE = sorted(syms)
     if settings.MAIN_MODULE:
       get_weak_imports(wasm_file)
 
-  settings.WASM_EXPORTS = metadata['exports'] + list(metadata['namedGlobals'].keys())
+  settings.WASM_EXPORTS = metadata.exports + list(metadata.namedGlobals.keys())
   # Store function exports so that Closure and metadce can track these even in
   # -sDECLARE_ASM_MODULE_EXPORTS=0 builds.
-  settings.WASM_FUNCTION_EXPORTS = metadata['exports']
+  settings.WASM_FUNCTION_EXPORTS = metadata.exports
 
   # start with the MVP features, and add any detected features.
-  settings.BINARYEN_FEATURES = ['--mvp-features'] + metadata['features']
+  settings.BINARYEN_FEATURES = ['--mvp-features'] + metadata.features
   if settings.ASYNCIFY == 2:
     settings.BINARYEN_FEATURES += ['--enable-reference-types']
 
@@ -156,15 +156,15 @@ def update_settings_glue(wasm_file, metadata):
 
   # When using dynamic linking the main function might be in a side module.
   # To be safe assume they do take input parametes.
-  settings.MAIN_READS_PARAMS = metadata['mainReadsParams'] or bool(settings.MAIN_MODULE)
+  settings.MAIN_READS_PARAMS = metadata.mainReadsParams 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 += ['$allocateUTF8OnStack']
 
   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['exports']
+    assert 'emscripten_stack_get_end' in metadata.exports
 
 
 def apply_static_code_hooks(forwarded_json, code):
@@ -279,7 +279,7 @@ def trim_asm_const_body(body):
 
 def create_named_globals(metadata):
   named_globals = []
-  for k, v in metadata['namedGlobals'].items():
+  for k, v in metadata.namedGlobals.items():
     v = int(v)
     if settings.RELOCATABLE:
       v += settings.GLOBAL_BASE
@@ -308,19 +308,19 @@ def emscript(in_wasm, out_wasm, outfile_js, memfile):
   metadata = finalize_wasm(in_wasm, out_wasm, memfile)
 
   if settings.RELOCATABLE and settings.MEMORY64 == 2:
-    metadata['globalImports'] += ['__memory_base32']
+    metadata.globalImports += ['__memory_base32']
 
   update_settings_glue(out_wasm, metadata)
 
-  if not settings.WASM_BIGINT and metadata['emJsFuncs']:
+  if not settings.WASM_BIGINT and metadata.emJsFuncs:
     import_map = {}
 
     with webassembly.Module(in_wasm) as module:
       types = module.get_types()
       for imp in module.get_imports():
         import_map[imp.field] = imp
 
-    for em_js_func, raw in metadata.get('emJsFuncs', {}).items():
+    for em_js_func, raw in metadata.emJsFuncs.items():
       c_sig = raw.split('<::>')[0].strip('()')
       if not c_sig or c_sig == 'void':
         c_sig = []
@@ -334,9 +334,9 @@ def emscript(in_wasm, out_wasm, outfile_js, memfile):
           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)
 
   if settings.SIDE_MODULE:
-    if metadata['asmConsts']:
+    if metadata.asmConsts:
       exit_with_error('EM_ASM is not supported in side modules')
-    if metadata['emJsFuncs']:
+    if metadata.emJsFuncs:
       exit_with_error('EM_JS is not supported in side modules')
     logger.debug('emscript: skipping remaining js glue generation')
     return
@@ -360,9 +360,9 @@ def emscript(in_wasm, out_wasm, outfile_js, memfile):
       settings.INITIAL_TABLE = dylink_sec.table_size + 1
 
     if settings.ASYNCIFY:
-      metadata['globalImports'] += ['__asyncify_state', '__asyncify_data']
+      metadata.globalImports += ['__asyncify_state', '__asyncify_data']
 
-  invoke_funcs = metadata['invokeFuncs']
+  invoke_funcs = metadata.invokeFuncs
   if invoke_funcs:
     settings.DEFAULT_LIBRARY_FUNCS_TO_INCLUDE += ['$getWasmTableEntry']
 
@@ -385,7 +385,7 @@ def emscript(in_wasm, out_wasm, outfile_js, memfile):
         pre += f"  ignoredModuleProp('{sym}');\n"
     pre += "}\n"
 
-  exports = metadata['exports']
+  exports = metadata.exports
 
   if settings.ASYNCIFY:
     exports += ['asyncify_start_unwind', 'asyncify_stop_unwind', 'asyncify_start_rewind', 'asyncify_stop_rewind']
@@ -452,7 +452,7 @@ def get_metadata(infile, outfile, modify_wasm, args):
     # re-read parts of the metadata post-finalize
     extract_metadata.update_metadata(outfile, metadata)
   if DEBUG:
-    logger.debug("Metadata: " + pprint.pformat(metadata))
+    logger.debug("Metadata: " + pprint.pformat(metadata.__dict__))
   return metadata
 
 
@@ -542,7 +542,7 @@ def finalize_wasm(infile, outfile, memfile):
   # Calculate the subset of exports that were explicitly marked with 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['exports'] if treat_as_user_function(e)]
+  unexpected_exports = [e for e in metadata.exports if treat_as_user_function(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]
   building.user_requested_exports.update(unexpected_exports)
@@ -553,7 +553,7 @@ def finalize_wasm(infile, outfile, memfile):
 
 def create_asm_consts(metadata):
   asm_consts = {}
-  for addr, const in metadata['asmConsts'].items():
+  for addr, const in metadata.asmConsts.items():
     body = trim_asm_const_body(const)
     args = []
     max_arity = 16
@@ -595,7 +595,7 @@ def func_type_to_sig(type):
 def create_em_js(metadata):
   em_js_funcs = []
   separator = '<::>'
-  for name, raw in metadata.get('emJsFuncs', {}).items():
+  for name, raw in metadata.emJsFuncs.items():
     assert separator in raw
     args, body = raw.split(separator, 1)
     args = args[1:-1]
@@ -606,8 +606,8 @@ def create_em_js(metadata):
     arg_names = [arg.split()[-1].replace("*", "") for arg in args if arg]
     args = ','.join(arg_names)
     func = f'function {name}({args}) {body}'
-    if settings.ASYNCIFY == 2 and name in metadata['emJsFuncTypes']:
-      sig = func_type_to_sig(metadata['emJsFuncTypes'][name])
+    if settings.ASYNCIFY == 2 and name in metadata.emJsFuncTypes:
+      sig = func_type_to_sig(metadata.emJsFuncTypes[name])
       func = func + f'\n{name}.sig = \'{sig}\';'
     em_js_funcs.append(func)
 
@@ -677,13 +677,13 @@ def add_send_items(name, mangled_name, ignore_dups=False):
       assert name not in send_items_map, 'duplicate symbol in exports: %s' % name
     send_items_map[name] = mangled_name
 
-  for name in metadata['emJsFuncs']:
+  for name in metadata.emJsFuncs:
     add_send_items(name, name)
   for name in invoke_funcs:
     add_send_items(name, name)
-  for name in metadata['declares']:
+  for name in metadata.imports:
     add_send_items(name, asmjs_mangle(name))
-  for name in metadata['globalImports']:
+  for name in metadata.globalImports:
     # globalImports can currently overlap with declares, in the case of dynamic linking
     add_send_items(name, asmjs_mangle(name), ignore_dups=settings.RELOCATABLE)
 
@@ -848,7 +848,7 @@ def create_wasm64_wrappers(metadata):
 
   sigs_seen = set()
   wrap_functions = []
-  for exp in metadata['exports']:
+  for exp in metadata.exports:
     sig = mapping.get(exp)
     if sig:
       if sig not in sigs_seen:
diff --git a/tools/extract_metadata.py b/tools/extract_metadata.py
@@ -235,21 +235,21 @@ def get_named_globals(module, exports):
 
 
 def update_metadata(filename, metadata):
-  declares = []
+  imports = []
   invoke_funcs = []
-  em_js_funcs = set(metadata['emJsFuncs'])
+  em_js_funcs = set(metadata.emJsFuncs)
   with webassembly.Module(filename) as module:
     for i in module.get_imports():
       if i.kind == webassembly.ExternType.FUNC:
         if i.field.startswith('invoke_'):
           invoke_funcs.append(i.field)
         elif i.field not in em_js_funcs:
-          declares.append(i.field)
+          imports.append(i.field)
 
     exports = [e.name for e in module.get_exports() if e.kind in [webassembly.ExternType.FUNC, webassembly.ExternType.TAG]]
-  metadata['declares'] = declares
-  metadata['exports'] = exports
-  metadata['invokeFuncs'] = invoke_funcs
+  metadata.imports = imports
+  metadata.exports = exports
+  metadata.invokeFuncs = invoke_funcs
 
 
 def get_string_at(module, address):
@@ -259,9 +259,25 @@ def get_string_at(module, address):
   return data_to_string(data[offset:str_end])
 
 
+class Metadata:
+  imports: []
+  export: []
+  asmConsts: []
+  emJsFuncs: {}
+  emJsFuncTypes: []
+  features: []
+  globalImports: []
+  invokeFuncs: []
+  mainReadsParams: bool
+  namedGlobals: []
+
+  def __init__(self):
+    pass
+
+
 def extract_metadata(filename):
   export_names = []
-  declares = []
+  import_names = []
   invoke_funcs = []
   global_imports = []
   em_js_funcs = {}
@@ -291,7 +307,7 @@ def extract_metadata(filename):
           types = module.get_types()
           em_js_func_types[i.field] = types[i.type]
         else:
-          declares.append(i.field)
+          import_names.append(i.field)
 
     export_names = [e.name for e in exports if e.kind in [webassembly.ExternType.FUNC, webassembly.ExternType.TAG]]
 
@@ -303,16 +319,17 @@ def extract_metadata(filename):
 
     # If main does not read its parameters, it will just be a stub that
     # calls __original_main (which has no parameters).
-    metadata = {}
-    metadata['asmConsts'] = get_asm_strings(module, export_map)
-    metadata['declares'] = declares
-    metadata['emJsFuncs'] = em_js_funcs
-    metadata['emJsFuncTypes'] = em_js_func_types
-    metadata['exports'] = export_names
-    metadata['features'] = features
-    metadata['globalImports'] = global_imports
-    metadata['invokeFuncs'] = invoke_funcs
-    metadata['mainReadsParams'] = get_main_reads_params(module, export_map)
-    metadata['namedGlobals'] = get_named_globals(module, exports)
+    metadata = Metadata()
+    metadata.imports = import_names
+    metadata.exports = export_names
+    metadata.asmConsts = get_asm_strings(module, export_map)
+    metadata.emJsFuncs = em_js_funcs
+    metadata.emJsFuncTypes = em_js_func_types
+    metadata.features = features
+    metadata.globalImports = global_imports
+    metadata.invokeFuncs = invoke_funcs
+    metadata.mainReadsParams = get_main_reads_params(module, export_map)
+    metadata.namedGlobals = get_named_globals(module, exports)
+
     # print("Metadata parsed: " + pprint.pformat(metadata))
     return metadata
