Features C/JS API (#2049)

Add feature handling to the C/JS APIs. No features are enabled by
default, so all used features will have to be explicitly enabled in
order for modules to validate.

Author: tlively

CHANGELOG.md

@@ -15,6 +15,8 @@ full changeset diff at the end of each section.
 Current Trunk
 -------------
 
+- Add feature handling to the C/JS API with no feature enabled by default.
+
 v84
 ---
 

build-js.sh

@@ -230,6 +230,15 @@ export_function "_BinaryenExternalTable"
 export_function "_BinaryenExternalMemory"
 export_function "_BinaryenExternalGlobal"
 
+# Features
+export_function "_BinaryenFeatureAtomics"
+export_function "_BinaryenFeatureBulkMemory"
+export_function "_BinaryenFeatureMutableGlobals"
+export_function "_BinaryenFeatureNontrappingFPToInt"
+export_function "_BinaryenFeatureSignExt"
+export_function "_BinaryenFeatureSIMD128"
+export_function "_BinaryenFeatureExceptionHandling"
+
 # Literals
 export_function "_BinaryenLiteralInt32"
 export_function "_BinaryenLiteralInt64"
@@ -758,6 +767,8 @@ export_function "_BinaryenRemoveExport"
 export_function "_BinaryenSetFunctionTable"
 export_function "_BinaryenSetMemory"
 export_function "_BinaryenSetStart"
+export_function "_BinaryenGetFeatures"
+export_function "_BinaryenSetFeatures"
 export_function "_BinaryenModuleParse"
 export_function "_BinaryenModulePrint"
 export_function "_BinaryenModulePrintAsmjs"

src/binaryen-c.cpp

@@ -367,6 +367,30 @@ BinaryenExternalKind BinaryenExternalGlobal(void) {
   return static_cast<BinaryenExternalKind>(ExternalKind::Global);
 }
 
+// Features
+
+BinaryenFeatures BinaryenFeatureAtomics(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::Atomics);
+}
+BinaryenFeatures BinaryenFeatureBulkMemory(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::BulkMemory);
+}
+BinaryenFeatures BinaryenFeatureMutableGlobals(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::MutableGlobals);
+}
+BinaryenFeatures BinaryenFeatureNontrappingFPToInt(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::TruncSat);
+}
+BinaryenFeatures BinaryenFeatureSignExt(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::SignExt);
+}
+BinaryenFeatures BinaryenFeatureSIMD128(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::SIMD);
+}
+BinaryenFeatures BinaryenFeatureExceptionHandling(void) {
+  return static_cast<BinaryenFeatures>(FeatureSet::Feature::ExceptionHandling);
+}
+
 // Modules
 
 BinaryenModuleRef BinaryenModuleCreate(void) {
@@ -3053,6 +3077,24 @@ void BinaryenSetStart(BinaryenModuleRef module, BinaryenFunctionRef start) {
   wasm->addStart(((Function*)start)->name);
 }
 
+// Features
+
+BinaryenFeatures BinaryenGetFeatures(BinaryenModuleRef module) {
+  if (tracing) {
+    std::cout << "  BinaryenGetFeatures(the_module);\n";
+  }
+  auto* wasm = static_cast<Module*>(module);
+  return wasm->features.features;
+}
+
+void BinaryenSetFeatures(BinaryenModuleRef module, BinaryenFeatures features) {
+  if (tracing) {
+    std::cout << "  BinaryenSetFeatures(the_module, " << features << ");\n";
+  }
+  auto* wasm = static_cast<Module*>(module);
+  wasm->features.features = features;
+}
+
 //
 // ========== Module Operations ==========
 //
@@ -3106,8 +3148,6 @@ int BinaryenModuleValidate(BinaryenModuleRef module) {
   }
 
   Module* wasm = (Module*)module;
-  // TODO(tlively): Add C API for managing features
-  wasm->features = FeatureSet::All;
   return WasmValidator().validate(*wasm) ? 1 : 0;
 }
 

src/binaryen-c.h

@@ -137,6 +137,19 @@ BinaryenExternalKind BinaryenExternalTable(void);
 BinaryenExternalKind BinaryenExternalMemory(void);
 BinaryenExternalKind BinaryenExternalGlobal(void);
 
+// Features. Call to get the value of each; you can cache them. Use bitwise
+// operators to combine and test particular features.
+
+typedef uint32_t BinaryenFeatures;
+
+BinaryenFeatures BinaryenFeatureAtomics(void);
+BinaryenFeatures BinaryenFeatureBulkMemory(void);
+BinaryenFeatures BinaryenFeatureMutableGlobals(void);
+BinaryenFeatures BinaryenFeatureNontrappingFPToInt(void);
+BinaryenFeatures BinaryenFeatureSignExt(void);
+BinaryenFeatures BinaryenFeatureSIMD128(void);
+BinaryenFeatures BinaryenFeatureExceptionHandling(void);
+
 // Modules
 //
 // Modules contain lists of functions, imports, exports, function types. The
@@ -929,6 +942,12 @@ void BinaryenSetMemory(BinaryenModuleRef module,
 
 void BinaryenSetStart(BinaryenModuleRef module, BinaryenFunctionRef start);
 
+// Features
+
+// These control what features are allowed when validation and in passes.
+BinaryenFeatures BinaryenGetFeatures(BinaryenModuleRef module);
+void BinaryenSetFeatures(BinaryenModuleRef module, BinaryenFeatures features);
+
 //
 // ========== Module Operations ==========
 //

src/js/binaryen.js-post.js

@@ -85,6 +85,17 @@ Module['ExternalTable'] = Module['_BinaryenExternalTable']();
 Module['ExternalMemory'] = Module['_BinaryenExternalMemory']();
 Module['ExternalGlobal'] = Module['_BinaryenExternalGlobal']();
 
+// Features
+Module['Features'] = {
+  'Atomics': Module['_BinaryenFeatureAtomics'](),
+  'BulkMemory': Module['_BinaryenFeatureBulkMemory'](),
+  'MutableGlobals': Module['_BinaryenFeatureMutableGlobals'](),
+  'NontrappingFPToInt': Module['_BinaryenFeatureNontrappingFPToInt'](),
+  'SignExt': Module['_BinaryenFeatureSignExt'](),
+  'SIMD128': Module['_BinaryenFeatureSIMD128'](),
+  'ExceptionHandling': Module['_BinaryenFeatureExceptionHandling'](),
+};
+
 // Operations
 Module['ClzInt32'] = Module['_BinaryenClzInt32']();
 Module['CtzInt32'] = Module['_BinaryenCtzInt32']();
@@ -1866,6 +1877,12 @@ function wrapModule(module, self) {
   self['setStart'] = function(start) {
     return Module['_BinaryenSetStart'](module, start);
   };
+  self['getFeatures'] = function() {
+    return Module['_BinaryenGetFeatures'](module);
+  };
+  self['setFeatures'] = function(features) {
+    Module['_BinaryenSetFeatures'](module, features);
+  };
   self['emitText'] = function() {
     var old = out;
     var ret = '';

src/wasm-features.h

@@ -128,7 +128,6 @@ struct FeatureSet {
     return *this;
   }
 
-private:
   uint32_t features;
 };
 

test/binaryen.js/atomics.js

@@ -59,5 +59,6 @@ module.addFunction("main", signature, [], module.block("", [
   )
 ]));
 
+module.setFeatures(Binaryen.Features.Atomics);
 module.validate();
 console.log(module.emitText());

test/binaryen.js/kitchen-sink.js

@@ -62,6 +62,16 @@ function test_types() {
   console.log("BinaryenTypeAuto: " + Binaryen.auto);
 }
 
+function test_features() {
+  console.log("Binaryen.Features.Atomics: " + Binaryen.Features.Atomics);
+  console.log("Binaryen.Features.BulkMemory: " + Binaryen.Features.BulkMemory);
+  console.log("Binaryen.Features.MutableGlobals: " + Binaryen.Features.MutableGlobals);
+  console.log("Binaryen.Features.NontrappingFPToInt: " + Binaryen.Features.NontrappingFPToInt);
+  console.log("Binaryen.Features.SignExt: " + Binaryen.Features.SignExt);
+  console.log("Binaryen.Features.SIMD128: " + Binaryen.Features.SIMD128);
+  console.log("Binaryen.Features.ExceptionHandling: " + Binaryen.Features.ExceptionHandling);
+}
+
 function test_ids() {
   console.log("BinaryenInvalidId: " + Binaryen.InvalidId);
   console.log("BinaryenBlockId: " + Binaryen.BlockId);
@@ -454,6 +464,16 @@ function test_core() {
   // A bunch of our code needs drop, auto-add it
   module.autoDrop();
 
+  var features =
+      Binaryen.Features.Atomics |
+      Binaryen.Features.BulkMemory |
+      Binaryen.Features.NontrappingFPToInt |
+      Binaryen.Features.SignExt |
+      Binaryen.Features.SIMD128;
+
+  module.setFeatures(features);
+  assert(module.getFeatures() == features);
+
   // Verify it validates
   assert(module.validate());
 
@@ -766,6 +786,7 @@ function test_internals() {
 
 function main() {
   test_types();
+  test_features();
   test_ids();
   test_core();
   test_relooper();

test/binaryen.js/kitchen-sink.js.txt

@@ -7,6 +7,13 @@ BinaryenTypeVec128: 5
 BinaryenTypeExceptRef: 6
 BinaryenTypeUnreachable: 7
 BinaryenTypeAuto: -1
+Binaryen.Features.Atomics: 1
+Binaryen.Features.BulkMemory: 16
+Binaryen.Features.MutableGlobals: 2
+Binaryen.Features.NontrappingFPToInt: 4
+Binaryen.Features.SignExt: 32
+Binaryen.Features.SIMD128: 8
+Binaryen.Features.ExceptionHandling: 64
 BinaryenInvalidId: 0
 BinaryenBlockId: 1
 BinaryenIfId: 2
@@ -3383,6 +3390,8 @@ getExpressionInfo(f64.const)={"id":14,"type":4,"value":9.5}
     functionTypes[3] = BinaryenAddFunctionType(the_module, NULL, 0, paramTypes, 0);
   }
   BinaryenModuleAutoDrop(the_module);
+  BinaryenSetFeatures(the_module, 61);
+  BinaryenGetFeatures(the_module);
   BinaryenModuleValidate(the_module);
   BinaryenModulePrint(the_module);
 (module

test/example/c-api-kitchen-sink.c

@@ -160,6 +160,16 @@ void test_types() {
   printf("BinaryenTypeAuto: %d\n", BinaryenTypeAuto());
 }
 
+void test_features() {
+  printf("BinaryenFeatureAtomics: %d\n", BinaryenFeatureAtomics());
+  printf("BinaryenFeatureBulkMemory: %d\n", BinaryenFeatureBulkMemory());
+  printf("BinaryenFeatureMutableGlobals: %d\n", BinaryenFeatureMutableGlobals());
+  printf("BinaryenFeatureNontrappingFPToInt: %d\n", BinaryenFeatureNontrappingFPToInt());
+  printf("BinaryenFeatureSignExt: %d\n", BinaryenFeatureSignExt());
+  printf("BinaryenFeatureSIMD128: %d\n", BinaryenFeatureSIMD128());
+  printf("BinaryenFeatureExceptionHandling: %d\n", BinaryenFeatureExceptionHandling());
+}
+
 void test_core() {
 
   // Module creation
@@ -511,6 +521,16 @@ void test_core() {
   // A bunch of our code needs drop(), auto-add it
   BinaryenModuleAutoDrop(module);
 
+  BinaryenFeatures features =
+      BinaryenFeatureAtomics() |
+      BinaryenFeatureBulkMemory() |
+      BinaryenFeatureNontrappingFPToInt() |
+      BinaryenFeatureSignExt() |
+      BinaryenFeatureSIMD128();
+
+  BinaryenSetFeatures(module, features);
+  assert(BinaryenGetFeatures(module) == features);
+
   // Verify it validates
   assert(BinaryenModuleValidate(module));
 
@@ -830,6 +850,7 @@ void test_color_status() {
 
 int main() {
   test_types();
+  test_features();
   test_core();
   test_unreachable();
   test_relooper();