Enable features in libwabt.js by default (#2109)

marcusb · web-flow · commit aefa094ea446 · 2022-12-27T07:57:42.000-08:00
This applies the same defaults for features in the JavaScript-compiled
version as the native tools. Without this change, enabling only the
"reference_types" feature did not work, as it got turned off due to
the dependency on "bulk_memory", which is counter-intuitive (see
Features::UpdateDependencies()).

Additionally, exposes all the features and their default setting in
JavaScript.
diff --git a/docs/demo/libwabt.js b/docs/demo/libwabt.js
diff --git a/docs/demo/wasm2wat/demo.js b/docs/demo/wasm2wat/demo.js
@@ -19,30 +19,15 @@ var features = getLocalStorageFeatures();
 
 function getLocalStorageFeatures() {
   try {
-    return JSON.parse(localStorage && localStorage.getItem("features")) || defaultFeatures;
+    return JSON.parse(localStorage && localStorage.getItem("features")) || {};
   } catch (e) {
     console.log(e);
-    return { mutable_globals: true };
+    return {};
   }
 }
 
 WabtModule().then(function(wabt) {
 
-// TODO: Share feature selection and other code with wat2wasm/demo.js
-var FEATURES = [
-  'exceptions',
-  'mutable_globals',
-  'sat_float_to_int',
-  'sign_extension',
-  'simd',
-  'threads',
-  'multi_value',
-  'tail_call',
-  'bulk_memory',
-  'reference_types',
-];
-
-var defaultFeatures = { mutable_globals: true };
 var editorEl = document.querySelector('.editor');
 var uploadEl = document.getElementById('upload');
 var selectEl = document.getElementById('select');
@@ -65,9 +50,9 @@ editorContainer.ondrop = function(e) {
   readAndCompileFile(file);
 }
 var fileBuffer = null;
-for (var feature of FEATURES) {
-  var featureEl = document.getElementById(feature);
-  featureEl.checked = !!features[feature];
+for (const [f, v] of Object.entries(wabt.FEATURES)) {
+  var featureEl = document.getElementById(f);
+  featureEl.checked = !!(features[f] !== undefined ? features[f] : v);
   featureEl.addEventListener('change', event => {
     var feature = event.target.id;
     features[feature] = event.target.checked;
diff --git a/docs/demo/wasm2wat/index.html b/docs/demo/wasm2wat/index.html
@@ -42,17 +42,25 @@ <h1>wasm2wat demo</h1>
     <div>Enabled features:</div>
     <div>
       <input type="checkbox" id="exceptions"><label for="exceptions">exceptions</label>
-      <input type="checkbox" id="mutable_globals" checked><label for="mutable_globals">mutable globals</label>
+      <input type="checkbox" id="mutable_globals"><label for="mutable_globals">mutable globals</label>
       <input type="checkbox" id="sat_float_to_int"><label for="sat_float_to_int">saturating float to int</label>
       <input type="checkbox" id="sign_extension"><label for="sign_extension">sign extension</label>
-    </div>
-    <div>
       <input type="checkbox" id="simd"><label for="simd">simd</label>
       <input type="checkbox" id="threads"><label for="threads">threads</label>
+      <input type="checkbox" id="function_references"><label for="function_references">function references</label>
       <input type="checkbox" id="multi_value"><label for="multi_value">multi value</label>
       <input type="checkbox" id="tail_call"><label for="tail_call">tail call</label>
+    </div>
+    <div>
       <input type="checkbox" id="bulk_memory"><label for="bulk_memory">bulk memory</label>
       <input type="checkbox" id="reference_types"><label for="reference_types">reference types</label>
+      <input type="checkbox" id="annotations"><label for="annotations">annotations</label>
+      <input type="checkbox" id="code_metadata"><label for="code_metadata">code metadata</label>
+      <input type="checkbox" id="gc"><label for="gc">gc</label>
+      <input type="checkbox" id="memory64"><label for="memory64">memory64</label>
+      <input type="checkbox" id="multi_memory"><label for="gc">multi memory</label>
+      <input type="checkbox" id="extended_const"><label for="extended_const">extended const</label>
+      <input type="checkbox" id="relaxed_simd"><label for="relaxed_simd">relaxed simd</label>
     </div>
   </header>
   <main>
diff --git a/docs/demo/wat2wasm/demo.js b/docs/demo/wat2wasm/demo.js
@@ -24,19 +24,6 @@ var features = {};
 
 WabtModule().then(function(wabt) {
 
-var FEATURES = [
-  'exceptions',
-  'mutable_globals',
-  'sat_float_to_int',
-  'sign_extension',
-  'simd',
-  'threads',
-  'multi_value',
-  'tail_call',
-  'bulk_memory',
-  'reference_types',
-];
-
 var kCompileMinMS = 100;
 var outputShowBase64 = false;
 var outputLog;
@@ -52,9 +39,9 @@ var base64El = document.getElementById('base64');
 var binaryBuffer = null;
 var binaryBlobUrl = null;
 
-for (var feature of FEATURES) {
-  var featureEl = document.getElementById(feature);
-  features[feature] = featureEl.checked;
+for (const [f, v] of Object.entries(wabt.FEATURES)) {
+  var featureEl = document.getElementById(f);
+  featureEl.checked = v;
   featureEl.addEventListener('change', event => {
     var feature = event.target.id;
     features[feature] = event.target.checked;
diff --git a/docs/demo/wat2wasm/index.html b/docs/demo/wat2wasm/index.html
@@ -39,17 +39,25 @@ <h1>wat2wasm demo</h1>
     <div>Enabled features:</div>
     <div>
       <input type="checkbox" id="exceptions"><label for="exceptions">exceptions</label>
-      <input type="checkbox" id="mutable_globals" checked><label for="mutable_globals">mutable globals</label>
+      <input type="checkbox" id="mutable_globals"><label for="mutable_globals">mutable globals</label>
       <input type="checkbox" id="sat_float_to_int"><label for="sat_float_to_int">saturating float to int</label>
       <input type="checkbox" id="sign_extension"><label for="sign_extension">sign extension</label>
-    </div>
-    <div>
       <input type="checkbox" id="simd"><label for="simd">simd</label>
       <input type="checkbox" id="threads"><label for="threads">threads</label>
-      <input type="checkbox" id="multi_value" checked><label for="multi_value">multi value</label>
+      <input type="checkbox" id="function_references"><label for="function_references">function references</label>
+      <input type="checkbox" id="multi_value"><label for="multi_value">multi value</label>
       <input type="checkbox" id="tail_call"><label for="tail_call">tail call</label>
+    </div>
+    <div>
       <input type="checkbox" id="bulk_memory"><label for="bulk_memory">bulk memory</label>
       <input type="checkbox" id="reference_types"><label for="reference_types">reference types</label>
+      <input type="checkbox" id="annotations"><label for="annotations">annotations</label>
+      <input type="checkbox" id="code_metadata"><label for="code_metadata">code metadata</label>
+      <input type="checkbox" id="gc"><label for="gc">gc</label>
+      <input type="checkbox" id="memory64"><label for="memory64">memory64</label>
+      <input type="checkbox" id="multi_memory"><label for="gc">multi memory</label>
+      <input type="checkbox" id="extended_const"><label for="extended_const">extended const</label>
+      <input type="checkbox" id="relaxed_simd"><label for="relaxed_simd">relaxed simd</label>
     </div>
   </header>
   <main>
diff --git a/src/emscripten-exports.txt b/src/emscripten-exports.txt
@@ -1,7 +1,9 @@
 _free
 _malloc
+_wabt_annotations_enabled
 _wabt_apply_names_module
 _wabt_bulk_memory_enabled
+_wabt_code_metadata_enabled
 _wabt_destroy_errors
 _wabt_destroy_features
 _wabt_destroy_module
@@ -11,9 +13,14 @@ _wabt_destroy_read_binary_result
 _wabt_destroy_wast_lexer
 _wabt_destroy_write_module_result
 _wabt_exceptions_enabled
+_wabt_extended_const_enabled
 _wabt_format_binary_errors
 _wabt_format_text_errors
+_wabt_function_references_enabled
+_wabt_gc_enabled
 _wabt_generate_names_module
+_wabt_memory64_enabled
+_wabt_multi_memory_enabled
 _wabt_multi_value_enabled
 _wabt_mutable_globals_enabled
 _wabt_new_errors
@@ -33,8 +40,15 @@ _wabt_read_binary_result_release_module
 _wabt_reference_types_enabled
 _wabt_relaxed_simd_enabled
 _wabt_sat_float_to_int_enabled
+_wabt_set_annotations_enabled
 _wabt_set_bulk_memory_enabled
+_wabt_set_code_metadata_enabled
 _wabt_set_exceptions_enabled
+_wabt_set_extended_const_enabled
+_wabt_set_function_references_enabled
+_wabt_set_gc_enabled
+_wabt_set_memory64_enabled
+_wabt_set_multi_memory_enabled
 _wabt_set_multi_value_enabled
 _wabt_set_mutable_globals_enabled
 _wabt_set_reference_types_enabled
diff --git a/src/wabt.post.js b/src/wabt.post.js
@@ -16,19 +16,28 @@
 
 var WABT_OK = 0;
 var WABT_ERROR = 1;
-var FEATURES = [
-  'exceptions',
-  'mutable_globals',
-  'sat_float_to_int',
-  'sign_extension',
-  'simd',
-  'threads',
-  'multi_value',
-  'tail_call',
-  'bulk_memory',
-  'reference_types',
-  'relaxed_simd',
-];
+
+/// features and default enabled state
+const FEATURES = Object.freeze({
+  'exceptions': false,
+  'mutable_globals': true,
+  'sat_float_to_int': true,
+  'sign_extension': true,
+  'simd': true,
+  'threads': false,
+  'function_references': false,
+  'multi_value': true,
+  'tail_call': false,
+  'bulk_memory': true,
+  'reference_types': true,
+  'annotations': false,
+  'code_metadata': false,
+  'gc': false,
+  'memory64': false,
+  'multi_memory': false,
+  'extended_const': false,
+  'relaxed_simd': false,
+});
 
 /// If value is not undefined, return it. Otherwise return default_.
 function maybeDefault(value, default_) {
@@ -86,9 +95,8 @@ function allocateCString(s) {
 /// Features
 function Features(obj) {
   this.addr = Module._wabt_new_features();
-  for (var i = 0; i < FEATURES.length; ++i) {
-    var feature = FEATURES[i];
-    this[feature] = obj[feature] | 0;
+  for ([f, v] of Object.entries(FEATURES)) {
+    this[f] = booleanOrDefault(obj[f], v);
   }
 }
 Features.prototype = Object.create(Object.prototype);
@@ -97,7 +105,7 @@ Features.prototype.destroy = function() {
   Module._wabt_destroy_features(this.addr);
 };
 
-FEATURES.forEach(function(feature) {
+Object.keys(FEATURES).forEach(function(feature) {
   Object.defineProperty(Features.prototype, feature, {
     enumerable: true,
     get: function() {
@@ -305,16 +313,16 @@ WasmModule.prototype.toText = function(options) {
   var writeModuleResult_addr =
       Module._wabt_write_text_module(this.module_addr, foldExprs, inlineExport);
 
-  var result = Module._wabt_write_module_result_get_result(
-      writeModuleResult_addr);
+  var result =
+      Module._wabt_write_module_result_get_result(writeModuleResult_addr);
 
   try {
     if (result !== WABT_OK) {
       throw new Error('toText failed.');
     }
 
-    var outputBuffer = new OutputBuffer(
-        Module._wabt_write_module_result_release_output_buffer(
+    var outputBuffer =
+        new OutputBuffer(Module._wabt_write_module_result_release_output_buffer(
             writeModuleResult_addr));
 
     return outputBuffer.toString();
@@ -376,3 +384,4 @@ WasmModule.prototype.destroy = function() {
 
 Module['parseWat'] = parseWat;
 Module['readWasm'] = readWasm;
+Module['FEATURES'] = FEATURES;
