[wasm] instantiate expressed in terms of compile

src/wasm/wasm-js.cc

 // Copyright 2015 the V8 project authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "src/api-natives.h"
 #include "src/api.h"
 #include "src/asmjs/asm-js.h"
 #include "src/asmjs/asm-typer.h"
 #include "src/asmjs/asm-wasm-builder.h"
 #include "src/assert-scope.h"
@@ skipping 14 matching lines @@
 #include "src/wasm/wasm-result.h"
 
 typedef uint8_t byte;
 
 using v8::internal::wasm::ErrorThrower;
 
 namespace v8 {
 
 namespace {
 
+#define ASSIGN(type, var, expr)      \

[adamk, 2017/04/17 23:46:19]

The name we use for this inside the API is ASSIGN_RETURN_ON_EXCEPTION, and it
also includes a DCHECK that an exception is pending. I'd rather this be more
similar to what we use inside.

[Mircea Trofin, 2017/04/18 01:03:54]

Done.

+  Local<type> var;                   \
+  do {                               \
+    if (!expr.ToLocal(&var)) return; \
+  } while (false)
+
+#define DO_BOOL(expr)                 \
+  do {                                \
+    bool ok;                          \
+    if (!expr.To(&ok) || !ok) return; \
+  } while (false)
+
 // TODO(wasm): move brand check to the respective types, and don't throw
 // in it, rather, use a provided ErrorThrower, or let caller handle it.
 static bool HasBrand(i::Handle<i::Object> value, i::Handle<i::Symbol> sym) {
   if (!value->IsJSObject()) return false;
   i::Handle<i::JSObject> object = i::Handle<i::JSObject>::cast(value);
   Maybe<bool> has_brand = i::JSObject::HasOwnProperty(object, sym);
   return has_brand.FromMaybe(false);
 }
 
 static bool BrandCheck(i::Handle<i::Object> value, i::Handle<i::Symbol> sym,
@@ skipping 65 matching lines @@
   }
   if (length > i::wasm::kV8MaxWasmModuleSize) {
     thrower->RangeError("buffer source exceeds maximum size of %zu (is %zu)",
                         i::wasm::kV8MaxWasmModuleSize, length);
   }
   if (thrower->error()) return i::wasm::ModuleWireBytes(nullptr, nullptr);
   // TODO(titzer): use the handle as well?
   return i::wasm::ModuleWireBytes(start, start + length);
 }
 
-i::MaybeHandle<i::JSReceiver> GetSecondArgumentAsImports(
-    const v8::FunctionCallbackInfo<v8::Value>& args, ErrorThrower* thrower) {
-  if (args.Length() < 2) return {};
-  if (args[1]->IsUndefined()) return {};
+i::MaybeHandle<i::JSReceiver> GetValueAsImports(const Local<Value>& arg,
+                                                ErrorThrower* thrower) {
+  if (arg->IsUndefined()) return {};
 
-  if (!args[1]->IsObject()) {
+  if (!arg->IsObject()) {
     thrower->TypeError("Argument 1 must be an object");
     return {};
   }
-  Local<Object> obj = Local<Object>::Cast(args[1]);
+  Local<Object> obj = Local<Object>::Cast(arg);
   return i::Handle<i::JSReceiver>::cast(v8::Utils::OpenHandle(*obj));
 }
 
 // WebAssembly.compile(bytes) -> Promise
 void WebAssemblyCompile(const v8::FunctionCallbackInfo<v8::Value>& args) {
   v8::Isolate* isolate = args.GetIsolate();
   i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
+  MicrotasksScope runs_microtasks(isolate, MicrotasksScope::kRunMicrotasks);
   if (i_isolate->wasm_compile_callback()(args)) return;
 
   HandleScope scope(isolate);
   ErrorThrower thrower(i_isolate, "WebAssembly.compile()");
 
   Local<Context> context = isolate->GetCurrentContext();
-  v8::Local<v8::Promise::Resolver> resolver;
-  if (!v8::Promise::Resolver::New(context).ToLocal(&resolver)) return;
+  ASSIGN(Promise::Resolver, resolver, Promise::Resolver::New(context));
   v8::ReturnValue<v8::Value> return_value = args.GetReturnValue();
   return_value.Set(resolver->GetPromise());
 
   auto bytes = GetFirstArgumentAsBytes(args, &thrower);
   if (thrower.error()) {
     auto maybe = resolver->Reject(context, Utils::ToLocal(thrower.Reify()));
     CHECK_IMPLIES(!maybe.FromMaybe(false),
                   i_isolate->has_scheduled_exception());
     return;
   }
@@ skipping 91 matching lines @@
     return;
   }
 
   auto custom_sections =
       i::wasm::GetCustomSections(i_isolate, maybe_module.ToHandleChecked(),
                                  i::Handle<i::String>::cast(name), &thrower);
   if (thrower.error()) return;
   args.GetReturnValue().Set(Utils::ToLocal(custom_sections));
 }
 
+// Entered as internal implementation detail of sync and async instantiate.
+// args[0] *must* be a WebAssembly.Module.
+void WebAssemblyInstantiateImpl(
+    const v8::FunctionCallbackInfo<v8::Value>& args) {
+  DCHECK_GE(args.Length(), 1);
+  v8::Isolate* isolate = args.GetIsolate();
+  i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
+  MicrotasksScope does_not_run_microtasks(isolate,
+                                          MicrotasksScope::kDoNotRunMicrotasks);
+
+  HandleScope scope(args.GetIsolate());
+  Local<Value> module = args[0];
+  Local<Value> ffi = args.Data();
+
+  ErrorThrower thrower(i_isolate, "WebAssembly Instantiation");
+  i::MaybeHandle<i::JSReceiver> maybe_imports =
+      GetValueAsImports(ffi, &thrower);
+  if (thrower.error()) return;
+
+  i::Handle<i::WasmModuleObject> module_obj =
+      i::Handle<i::WasmModuleObject>::cast(
+          Utils::OpenHandle(Object::Cast(*module)));
+  i::MaybeHandle<i::Object> instance_object =
+      i::wasm::SyncInstantiate(i_isolate, &thrower, module_obj, maybe_imports,
+                               i::MaybeHandle<i::JSArrayBuffer>());
+
+  if (instance_object.is_null()) {
+    // TODO(wasm): this *should* mean there's an error to throw, but
+    // we exit sometimes the instantiation pipeline without throwing.
+    // v8:6232.
+    return;
+  }
+  args.GetReturnValue().Set(Utils::ToLocal(instance_object.ToHandleChecked()));
+}
+
+void WebAssemblyInstantiateToPair(
+    const v8::FunctionCallbackInfo<v8::Value>& args) {
+  DCHECK_GE(args.Length(), 1);
+  Isolate* isolate = args.GetIsolate();
+  MicrotasksScope does_not_run_microtasks(isolate,
+                                          MicrotasksScope::kDoNotRunMicrotasks);
+
+  HandleScope scope(args.GetIsolate());
+
+  Local<Context> context = isolate->GetCurrentContext();
+  Local<Value> module = args[0];
+
+  const uint8_t* instance_str = reinterpret_cast<const uint8_t*>("instance");
+  const uint8_t* module_str = reinterpret_cast<const uint8_t*>("module");
+  ASSIGN(Function, vanilla_instantiate,
+         Function::New(context, WebAssemblyInstantiateImpl, args.Data()));
+
+  ASSIGN(Value, instance,
+         vanilla_instantiate->Call(context, args.Holder(), 1, &module));

[adamk, 2017/04/17 23:46:19]

I really feel like it's weird to create a v8::Function around a C++ function
just to immediately call it.

I would prefer there to be a slightly more fine-grained factoring here, where
there's WebAssemblyInstiantiateImpl(), which takes isolate, module and ffi
arguments, and a WebAssemblyInsantiateImplCallback, which is used for the one
case where the v8::Function is actually passed to .then (down in
WebAssemblyInstantiate()). I think that might even be less code overall. WDYT?

[Mircea Trofin, 2017/04/18 01:03:53]

Done.

+  Local<Object> ret = Object::New(isolate);
+  ASSIGN(String, instance_name,
+         String::NewFromOneByte(isolate, instance_str,
+                                NewStringType::kInternalized));
+  ASSIGN(String, module_name,

[adamk, 2017/04/17 23:46:19]

This and the above can't meaningfully fail (the API says that they'd only fail
if their length was huge). I'd rather see them use

Local<String> module_name = 
    String::NewFromOneByte(...).ToLocalChecked();

[Mircea Trofin, 2017/04/18 01:03:53]

Done.

+         String::NewFromOneByte(isolate, module_str,
+                                NewStringType::kInternalized));
+
+  DO_BOOL(ret->CreateDataProperty(context, instance_name, instance));
+  DO_BOOL(ret->CreateDataProperty(context, module_name, module));

[adamk, 2017/04/17 23:46:19]

I don't believe that either of these could possibly throw. Can you wrap them in
CHECK() instead of your DO_BOOL macro? Like,

CHECK(ret->CreateDataProperty(...).FromJust());

[Mircea Trofin, 2017/04/18 01:03:53]

Done.

+  args.GetReturnValue().Set(ret);
+}
+
 // new WebAssembly.Instance(module, imports) -> WebAssembly.Instance
 void WebAssemblyInstance(const v8::FunctionCallbackInfo<v8::Value>& args) {
+  Isolate* isolate = args.GetIsolate();
+  MicrotasksScope does_not_run_microtasks(isolate,
+                                          MicrotasksScope::kDoNotRunMicrotasks);
+
   HandleScope scope(args.GetIsolate());
-  v8::Isolate* isolate = args.GetIsolate();
+  Local<Context> context = isolate->GetCurrentContext();
   i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
   if (i_isolate->wasm_instance_callback()(args)) return;
 
   ErrorThrower thrower(i_isolate, "WebAssembly.Instance()");
 
   auto maybe_module = GetFirstArgumentAsModule(args, &thrower);
   if (thrower.error()) return;
 
-  auto maybe_imports = GetSecondArgumentAsImports(args, &thrower);
-  if (thrower.error()) return;
+  // If args.Length < 2, this will be undefined - see FunctionCallbackInfo.
+  // We'll check for that in WebAssemblyInstantiateImpl.
+  Local<Value> data = args[1];
 
-  i::MaybeHandle<i::Object> instance_object = i::wasm::SyncInstantiate(
-      i_isolate, &thrower, maybe_module.ToHandleChecked(), maybe_imports,
-      i::MaybeHandle<i::JSArrayBuffer>());
-  if (instance_object.is_null()) return;
-  args.GetReturnValue().Set(Utils::ToLocal(instance_object.ToHandleChecked()));
+  ASSIGN(Function, impl,
+         Function::New(context, WebAssemblyInstantiateImpl, data));
+  Local<Value> first_param = args[0];
+  ASSIGN(Value, ret, impl->Call(context, args.Holder(), 1, &first_param));
+  args.GetReturnValue().Set(ret);
 }
 
 // WebAssembly.instantiate(module, imports) -> WebAssembly.Instance
 // WebAssembly.instantiate(bytes, imports) ->
 //     {module: WebAssembly.Module, instance: WebAssembly.Instance}
 void WebAssemblyInstantiate(const v8::FunctionCallbackInfo<v8::Value>& args) {
   v8::Isolate* isolate = args.GetIsolate();
   i::Isolate* i_isolate = reinterpret_cast<i::Isolate*>(isolate);
+  MicrotasksScope runs_microtasks(isolate, MicrotasksScope::kRunMicrotasks);
   if (i_isolate->wasm_instantiate_callback()(args)) return;
 
   ErrorThrower thrower(i_isolate, "WebAssembly.instantiate()");
 
   HandleScope scope(isolate);
 
   Local<Context> context = isolate->GetCurrentContext();
   i::Handle<i::Context> i_context = Utils::OpenHandle(*context);
 
-  v8::Local<v8::Promise::Resolver> resolver;
-  if (!v8::Promise::Resolver::New(context).ToLocal(&resolver)) return;
-  v8::ReturnValue<v8::Value> return_value = args.GetReturnValue();
-  return_value.Set(resolver->GetPromise());
+  ASSIGN(Promise::Resolver, resolver, Promise::Resolver::New(context));
+  Local<Promise> module_promise = resolver->GetPromise();
+  args.GetReturnValue().Set(module_promise);
 
   if (args.Length() < 1) {
     thrower.TypeError(
         "Argument 0 must be provided and must be either a buffer source or a "
         "WebAssembly.Module object");
     auto maybe = resolver->Reject(context, Utils::ToLocal(thrower.Reify()));
     CHECK_IMPLIES(!maybe.FromMaybe(false),
                   i_isolate->has_scheduled_exception());
     return;
   }
 
-  i::Handle<i::Object> first_arg = Utils::OpenHandle(*args[0]);
+  Local<Value> first_arg_value = args[0];
+  i::Handle<i::Object> first_arg = Utils::OpenHandle(*first_arg_value);
   if (!first_arg->IsJSObject()) {
     thrower.TypeError(
         "Argument 0 must be a buffer source or a WebAssembly.Module object");
     auto maybe = resolver->Reject(context, Utils::ToLocal(thrower.Reify()));
     CHECK_IMPLIES(!maybe.FromMaybe(false),
                   i_isolate->has_scheduled_exception());
     return;
   }
 
-  auto maybe_imports = GetSecondArgumentAsImports(args, &thrower);
-  if (thrower.error()) {
-    auto maybe = resolver->Reject(context, Utils::ToLocal(thrower.Reify()));
-    CHECK_IMPLIES(!maybe.FromMaybe(false),
-                  i_isolate->has_scheduled_exception());
-    return;
+  FunctionCallback instantiator = nullptr;
+  if (HasBrand(first_arg, i::Handle<i::Symbol>(i_context->wasm_module_sym()))) {
+    module_promise = resolver->GetPromise();
+    DO_BOOL(resolver->Resolve(context, first_arg_value));

[adamk, 2017/04/17 23:46:19]

This would be the last use of DO_BOOL; given that, I think I'd rather see:

if (!resolver->Resolve(...).IsJust()) return;

[Mircea Trofin, 2017/04/18 01:03:54]

Done.

+    instantiator = WebAssemblyInstantiateImpl;
+  } else {
+    ASSIGN(Function, async_compile, Function::New(context, WebAssemblyCompile));
+    ASSIGN(Value, async_compile_retval,
+           async_compile->Call(context, args.Holder(), 1, &first_arg_value));
+    module_promise = Local<Promise>::Cast(async_compile_retval);
+    instantiator = WebAssemblyInstantiateToPair;
   }
-  i::Handle<i::JSPromise> promise = Utils::OpenHandle(*resolver->GetPromise());
-  if (HasBrand(first_arg, i::Handle<i::Symbol>(i_context->wasm_module_sym()))) {
-    // WebAssembly.instantiate(module, imports) -> WebAssembly.Instance
-    auto module_object = GetFirstArgumentAsModule(args, &thrower);
-    i::wasm::AsyncInstantiate(i_isolate, promise,
-                              module_object.ToHandleChecked(), maybe_imports);
-  } else {
-    // WebAssembly.instantiate(bytes, imports) -> {module, instance}
-    auto bytes = GetFirstArgumentAsBytes(args, &thrower);
-    if (thrower.error()) {
-      auto maybe = resolver->Reject(context, Utils::ToLocal(thrower.Reify()));
-      CHECK_IMPLIES(!maybe.FromMaybe(false),
-                    i_isolate->has_scheduled_exception());
-      return;
-    }
-    i::wasm::AsyncCompileAndInstantiate(i_isolate, promise, bytes,
-                                        maybe_imports);
-  }
+  DCHECK(!module_promise.IsEmpty());
+  DCHECK_NOT_NULL(instantiator);
+  // If args.Length < 2, this will be undefined - see FunctionCallbackInfo.
+  // We'll check for that in WebAssemblyInstantiateImpl.
+  Local<Value> data = args[1];
+  ASSIGN(Function, instantiate_impl,
+         Function::New(context, instantiator, data));

[adamk, 2017/04/17 23:46:19]

It's a little wasteful to create a new function each time this is called, but I
guess performance here is not a big concern?

[Mircea Trofin, 2017/04/18 01:03:53]

That, but also, we need a closure to hold on to the ffi until the promise is
resolved.

+  ASSIGN(Promise, result, module_promise->Then(context, instantiate_impl));
+  args.GetReturnValue().Set(result);
 }
 
 bool GetIntegerProperty(v8::Isolate* isolate, ErrorThrower* thrower,
                         Local<Context> context, Local<v8::Object> object,
                         Local<String> property, int* result,
                         int64_t lower_bound, uint64_t upper_bound) {
   v8::MaybeLocal<v8::Value> maybe = object->Get(context, property);
   v8::Local<v8::Value> value;
   if (maybe.ToLocal(&value)) {
     int64_t number;
@@ skipping 531 matching lines @@
   i::Handle<i::Symbol> symbol(isolate->context()->wasm_memory_sym(), isolate);
   return HasBrand(value, symbol);
 }
 
 bool WasmJs::IsWasmTableObject(Isolate* isolate, Handle<Object> value) {
   i::Handle<i::Symbol> symbol(isolate->context()->wasm_table_sym(), isolate);
   return HasBrand(value, symbol);
 }
 }  // namespace internal
 }  // namespace v8