reivew: add getAbiVersion().

Signed-off-by: Piotr Sikora <[email protected]>

Author: PiotrSikora

include/proxy-wasm/null_vm.h

@@ -36,6 +36,7 @@ struct NullVm : public WasmVm {
   Cloneable cloneable() override { return Cloneable::InstantiatedModule; };
   std::unique_ptr<WasmVm> clone() override;
   bool load(const std::string &code, bool allow_precompiled) override;
+  AbiVersion getAbiVersion() override;
   bool link(std::string_view debug_name) override;
   uint64_t getMemorySize() override;
   std::optional<std::string_view> getMemory(uint64_t pointer, uint64_t size) override;

include/proxy-wasm/wasm.h

@@ -122,6 +122,8 @@ class WasmBase : public std::enable_shared_from_this<WasmBase> {
   virtual void error(std::string_view message) { std::cerr << message << "\n"; }
   virtual void unimplemented() { error("unimplemented proxy-wasm API"); }
 
+  AbiVersion abiVersion() { return abi_version_; }
+
   bool getEmscriptenVersion(uint32_t *emscripten_metadata_major_version,
                             uint32_t *emscripten_metadata_minor_version,
                             uint32_t *emscripten_abi_major_version,
@@ -184,9 +186,6 @@ class WasmBase : public std::enable_shared_from_this<WasmBase> {
   std::unique_ptr<ShutdownHandle> shutdown_handle_;
   std::unordered_set<ContextBase *> pending_done_; // Root contexts not done during shutdown.
 
-  WasmCallVoid<0> abi_version_0_1_0_;
-  WasmCallVoid<0> abi_version_0_2_0_;
-
   WasmCallVoid<0> _start_; /* Emscripten v1.39.0+ */
   WasmCallVoid<0> __wasm_call_ctors_;
 
@@ -241,6 +240,9 @@ class WasmBase : public std::enable_shared_from_this<WasmBase> {
   bool allow_precompiled_ = false;
   FailState failed_ = FailState::Ok; // Wasm VM fatal error.
 
+  // ABI version.
+  AbiVersion abi_version_ = AbiVersion::Unknown;
+
   bool is_emscripten_ = false;
   uint32_t emscripten_metadata_major_version_ = 0;
   uint32_t emscripten_metadata_minor_version_ = 0;

include/proxy-wasm/wasm_vm.h

@@ -101,6 +101,8 @@ enum class Cloneable {
   InstantiatedModule // VMs can be cloned from an instantiated module.
 };
 
+enum class AbiVersion { ProxyWasm_0_1_0, ProxyWasm_0_2_0, Unknown };
+
 class NullPlugin;
 
 // Integrator specific WasmVm operations.
@@ -185,6 +187,12 @@ class WasmVm {
    */
   virtual bool link(std::string_view debug_name) = 0;
 
+  /**
+   * Get ABI version of the module.
+   * @return the ABI version.
+   */
+  virtual AbiVersion getAbiVersion() = 0;
+
   /**
    * Get size of the currently allocated memory in the VM.
    * @return the size of memory in bytes.

src/null/null_vm.cc

@@ -57,6 +57,8 @@ bool NullVm::load(const std::string &name, bool /* allow_precompiled */) {
   return true;
 }
 
+AbiVersion NullVm::getAbiVersion() { return AbiVersion::ProxyWasm_0_2_0; }
+
 bool NullVm::link(std::string_view /* name */) { return true; }
 
 uint64_t NullVm::getMemorySize() { return std::numeric_limits<uint64_t>::max(); }

src/v8/v8.cc

@@ -54,6 +54,7 @@ class V8 : public WasmVm {
   std::string_view runtime() override { return "v8"; }
 
   bool load(const std::string &code, bool allow_precompiled) override;
+  AbiVersion getAbiVersion() override;
   std::string_view getCustomSection(std::string_view name) override;
   std::string_view getPrecompiledSectionName() override;
   bool link(std::string_view debug_name) override;
@@ -366,6 +367,24 @@ std::string_view V8::getPrecompiledSectionName() {
   return name;
 }
 
+AbiVersion V8::getAbiVersion() {
+  assert(module_ != nullptr);
+
+  const auto export_types = module_.get()->exports();
+  for (size_t i = 0; i < export_types.size(); i++) {
+    if (export_types[i]->type()->kind() == wasm::EXTERN_FUNC) {
+      std::string_view name(export_types[i]->name().get(), export_types[i]->name().size());
+      if (name == "proxy_abi_version_0_1_0") {
+        return AbiVersion::ProxyWasm_0_1_0;
+      } else if (name == "proxy_abi_version_0_2_0") {
+        return AbiVersion::ProxyWasm_0_2_0;
+      }
+    }
+  }
+
+  return AbiVersion::Unknown;
+}
+
 bool V8::link(std::string_view debug_name) {
   assert(module_ != nullptr);
 

src/wasm.cc

@@ -143,18 +143,12 @@ void WasmBase::registerCallbacks() {
   _REGISTER_PROXY(log);
   _REGISTER_PROXY(get_log_level);
 
-  _REGISTER_PROXY(get_configuration);
   _REGISTER_PROXY(get_status);
 
   _REGISTER_PROXY(set_property);
   _REGISTER_PROXY(get_property);
 
-  _REGISTER_PROXY(continue_request);
-  _REGISTER_PROXY(continue_response);
-  _REGISTER_PROXY(continue_stream);
-  _REGISTER_PROXY(close_stream);
   _REGISTER_PROXY(send_local_response);
-  _REGISTER_PROXY(clear_route_cache);
 
   _REGISTER_PROXY(get_shared_data);
   _REGISTER_PROXY(set_shared_data);
@@ -195,6 +189,16 @@ void WasmBase::registerCallbacks() {
   _REGISTER_PROXY(set_effective_context);
   _REGISTER_PROXY(done);
   _REGISTER_PROXY(call_foreign_function);
+
+  if (abiVersion() == AbiVersion::ProxyWasm_0_1_0) {
+    _REGISTER_PROXY(get_configuration);
+    _REGISTER_PROXY(continue_request);
+    _REGISTER_PROXY(continue_response);
+    _REGISTER_PROXY(clear_route_cache);
+  } else if (abiVersion() == AbiVersion::ProxyWasm_0_2_0) {
+    _REGISTER_PROXY(continue_stream);
+    _REGISTER_PROXY(close_stream);
+  }
 #undef _REGISTER_PROXY
 }
 
@@ -211,21 +215,10 @@ void WasmBase::getFunctions() {
 
 #define _GET_PROXY(_fn) wasm_vm_->getFunction("proxy_" #_fn, &_fn##_);
 #define _GET_PROXY_ABI(_fn, _abi) wasm_vm_->getFunction("proxy_" #_fn, &_fn##_abi##_);
-  _GET_PROXY(abi_version_0_1_0);
-  _GET_PROXY(abi_version_0_2_0);
-  if (!abi_version_0_1_0_ && !abi_version_0_2_0_) {
-    fail(FailState::MissingFunction,
-         "Wasm module is missing the Proxy-Wasm ABI version or requires an unsupported version.");
-  } else if (abi_version_0_1_0_ && abi_version_0_2_0_) {
-    fail(FailState::MissingFunction,
-         "Wasm multiple versions of the Proxy-Wasm ABI are declared by the module.");
-  }
-
   _GET_PROXY(validate_configuration);
   _GET_PROXY(on_vm_start);
   _GET_PROXY(on_configure);
   _GET_PROXY(on_tick);
-  _GET_PROXY(on_foreign_function);
 
   _GET_PROXY(on_context_create);
 
@@ -235,13 +228,6 @@ void WasmBase::getFunctions() {
   _GET_PROXY(on_downstream_connection_close);
   _GET_PROXY(on_upstream_connection_close);
 
-  if (abi_version_0_1_0_) {
-    _GET_PROXY_ABI(on_request_headers, _abi_01);
-    _GET_PROXY_ABI(on_response_headers, _abi_01);
-  } else if (abi_version_0_2_0_) {
-    _GET_PROXY_ABI(on_request_headers, _abi_02);
-    _GET_PROXY_ABI(on_response_headers, _abi_02);
-  }
   _GET_PROXY(on_request_body);
   _GET_PROXY(on_request_trailers);
   _GET_PROXY(on_request_metadata);
@@ -257,6 +243,15 @@ void WasmBase::getFunctions() {
   _GET_PROXY(on_done);
   _GET_PROXY(on_log);
   _GET_PROXY(on_delete);
+
+  if (abiVersion() == AbiVersion::ProxyWasm_0_1_0) {
+    _GET_PROXY_ABI(on_request_headers, _abi_01);
+    _GET_PROXY_ABI(on_response_headers, _abi_01);
+  } else if (abiVersion() == AbiVersion::ProxyWasm_0_2_0) {
+    _GET_PROXY_ABI(on_request_headers, _abi_02);
+    _GET_PROXY_ABI(on_response_headers, _abi_02);
+    _GET_PROXY(on_foreign_function);
+  }
 #undef _GET_PROXY_ABI
 #undef _GET_PROXY
 }
@@ -335,6 +330,11 @@ bool WasmBase::initialize(const std::string &code, bool allow_precompiled) {
     allow_precompiled_ = allow_precompiled;
   }
 
+  abi_version_ = wasm_vm_->getAbiVersion();
+  if (abi_version_ == AbiVersion::Unknown) {
+    return false;
+  }
+
   if (started_from_ != Cloneable::InstantiatedModule) {
     registerCallbacks();
     wasm_vm_->link(vm_id_);

src/wavm/wavm.cc

@@ -272,6 +272,8 @@ bool Wavm::load(const std::string &code, bool allow_precompiled) {
   return true;
 }
 
+AbiVersion Wavm::getAbiVersion() { return AbiVersion::Unknown; }
+
 void Wavm::link(std::string_view debug_name) {
   RootResolver rootResolver(compartment_);
   for (auto &p : intrinsic_modules_) {