[promisehook] Implement PromiseHook

src/builtins/builtins-promise.cc

 // Copyright 2016 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/builtins/builtins-utils.h"
 #include "src/builtins/builtins.h"
 #include "src/code-factory.h"
 #include "src/code-stub-assembler.h"
 #include "src/promise-utils.h"
 
 namespace v8 {
 namespace internal {
 
 // ES#sec-promise-reject-functions
 // Promise Reject Functions
 BUILTIN(PromiseRejectClosure) {
   HandleScope scope(isolate);
 
   Handle<Context> context(isolate->context(), isolate);
 
   if (PromiseUtils::HasAlreadyVisited(context)) {
     return isolate->heap()->undefined_value();
   }
 
   PromiseUtils::SetAlreadyVisited(context);
   Handle<Object> value = args.atOrUndefined(isolate, 1);
-  Handle<JSObject> promise = handle(PromiseUtils::GetPromise(context), isolate);
+  Handle<JSPromise> promise =
+      handle(PromiseUtils::GetPromise(context), isolate);
   Handle<Object> debug_event =
       handle(PromiseUtils::GetDebugEvent(context), isolate);
   MaybeHandle<Object> maybe_result;
   Handle<Object> argv[] = {promise, value, debug_event};
+
   RETURN_FAILURE_ON_EXCEPTION(
       isolate, Execution::Call(isolate, isolate->promise_internal_reject(),
                                isolate->factory()->undefined_value(),
                                arraysize(argv), argv));
   return isolate->heap()->undefined_value();
 }
 
 // ES#sec-createresolvingfunctions
 // CreateResolvingFunctions ( promise )
 BUILTIN(CreateResolvingFunctions) {
@@ skipping 49 matching lines @@
            &if_targetismodified);
 
   Variable var_result(&a, MachineRepresentation::kTagged),
       var_reject_call(&a, MachineRepresentation::kTagged),
       var_reason(&a, MachineRepresentation::kTagged);
 
   a.Bind(&if_targetisnotmodified);
   {
     Node* const instance = a.AllocateJSPromise(context);
     var_result.Bind(instance);
+    a.GotoUnless(a.IsPromiseHookEnabled(), &init);
+    a.CallRuntime(Runtime::kPromiseHookInit, context, instance,
+                  a.UndefinedConstant());
     a.Goto(&init);
   }
 
   a.Bind(&if_targetismodified);
   {
     Callable fast_new_object_stub = CodeFactory::FastNewObject(isolate);
     Node* const instance =
         a.CallStub(fast_new_object_stub, context, promise_fun, new_target);
 
     var_result.Bind(instance);
@@ skipping 63 matching lines @@
     Node* const message_id =
         a.SmiConstant(MessageTemplate::kResolverNotAFunction);
     a.CallRuntime(Runtime::kThrowTypeError, context, message_id, executor);
     a.Return(a.UndefinedConstant());  // Never reached.
   }
 }
 
 void Builtins::Generate_PromiseInternalConstructor(
     compiler::CodeAssemblerState* state) {
   typedef compiler::Node Node;
+  typedef CodeStubAssembler::Label Label;
   CodeStubAssembler a(state);
 
-  Node* const context = a.Parameter(3);
+  Node* const parent = a.Parameter(1);
+  Node* const context = a.Parameter(4);
   Node* const instance = a.AllocateJSPromise(context);
   a.PromiseInit(instance);
+
+  Label out(&a);
+  a.GotoUnless(a.IsPromiseHookEnabled(), &out);
+  a.CallRuntime(Runtime::kPromiseHookInit, context, instance, parent);
+  a.Goto(&out);
+  a.Bind(&out);
   a.Return(instance);
 }
 
 void Builtins::Generate_PromiseCreateAndSet(
     compiler::CodeAssemblerState* state) {
   typedef compiler::Node Node;
+  typedef CodeStubAssembler::Label Label;
   CodeStubAssembler a(state);
 
   Node* const status = a.Parameter(1);
   Node* const result = a.Parameter(2);
   Node* const context = a.Parameter(5);
 
   Node* const instance = a.AllocateJSPromise(context);
   a.PromiseSet(instance, status, result);
+
+  Label out(&a);
+  a.GotoUnless(a.IsPromiseHookEnabled(), &out);
+  a.CallRuntime(Runtime::kPromiseHookInit, context, instance,
+                a.UndefinedConstant());
+  a.Goto(&out);
+  a.Bind(&out);
   a.Return(instance);
 }
 
 namespace {
 
 compiler::Node* ThrowIfNotJSReceiver(CodeStubAssembler* a, Isolate* isolate,
                                      compiler::Node* context,
                                      compiler::Node* value,
                                      MessageTemplate::Template msg_template) {
   typedef compiler::Node Node;
@@ skipping 384 matching lines @@
 
   // TODO(gsathya): Remove deferred object and move
   // NewPromiseCapbability functions to TF.
   a.Bind(&fast_promise_capability);
   {
     // TODO(gsathya): Move this to TF.
     Node* const promise_internal_capability = a.LoadContextElement(
         native_context, Context::INTERNAL_PROMISE_CAPABILITY_INDEX);
     Node* const capability =
         a.CallJS(call_callable, context, promise_internal_capability,
-                 a.UndefinedConstant());
+                 a.UndefinedConstant(), promise);
     var_deferred.Bind(capability);
     a.Goto(&perform_promise_then);
   }
 
   a.Bind(&promise_capability);
   {
     // TODO(gsathya): Move this to TF.
     Node* const new_promise_capability = a.LoadContextElement(
         native_context, Context::NEW_PROMISE_CAPABILITY_INDEX);
     Node* const capability =
@@ skipping 52 matching lines @@
   typedef compiler::Node Node;
 
   Isolate* isolate = a->isolate();
 
   Variable var_reason(a, MachineRepresentation::kTagged),
       var_then(a, MachineRepresentation::kTagged);
 
   Label do_enqueue(a), fulfill(a), if_cycle(a, Label::kDeferred),
       if_rejectpromise(a, Label::kDeferred);
 
+  Label cycle_check(a);
+  a->GotoUnless(a->IsPromiseHookEnabled(), &cycle_check);
+  a->CallRuntime(Runtime::kPromiseHookResolve, context, promise);
+  a->Goto(&cycle_check);
+
+  a->Bind(&cycle_check);
   // 6. If SameValue(resolution, promise) is true, then
   a->GotoIf(a->SameValue(promise, result, context), &if_cycle);
 
   // 7. If Type(resolution) is not Object, then
   a->GotoIf(a->TaggedIsSmi(result), &fulfill);
   a->GotoUnless(a->IsJSReceiver(result), &fulfill);
 
   Label if_nativepromise(a), if_notnativepromise(a, Label::kDeferred);
   BranchIfFastPath(a, context, result, &if_nativepromise, &if_notnativepromise);
 
@@ skipping 212 matching lines @@
     a.Return(a.UndefinedConstant());
   }
 }
 
 void Builtins::Generate_PromiseHandle(compiler::CodeAssemblerState* state) {
   CodeStubAssembler a(state);
   typedef compiler::Node Node;
   typedef CodeStubAssembler::Label Label;
   typedef CodeStubAssembler::Variable Variable;
 
+  Node* const promise = a.Parameter(1);
   Node* const value = a.Parameter(2);
   Node* const handler = a.Parameter(3);
   Node* const deferred = a.Parameter(4);
   Node* const context = a.Parameter(7);
   Isolate* isolate = a.isolate();
 
   // Get promise from deferred
   // TODO(gsathya): Remove this lookup by getting rid of the deferred object.
   Callable getproperty_callable = CodeFactory::GetProperty(isolate);
   Node* const key = a.HeapConstant(isolate->factory()->promise_string());
   Node* const deferred_promise =
       a.CallStub(getproperty_callable, context, deferred, key);
 
   Variable var_reason(&a, MachineRepresentation::kTagged);
 
   Node* const is_debug_active = a.IsDebugActive();
   Label run_handler(&a), if_rejectpromise(&a), debug_push(&a, Label::kDeferred),
-      debug_pop(&a, Label::kDeferred);
-  a.Branch(is_debug_active, &debug_push, &run_handler);
+      debug_pop(&a), promisehook_after(&a);
+
+  a.GotoUnless(a.IsPromiseHookEnabled(), &debug_push);
+  a.CallRuntime(Runtime::kPromiseHookBefore, context, promise);
+  a.Goto(&debug_push);

[Dan Ehrenberg, 2016/12/15 22:21:48]

Nit: It would feel a little cleaner to me if the before/after hooks were nested
either inside or outside of the the debug push/pop. In this version, we have a
sequence of

PromiseHookBefore
DebugPushPromise
PromiseHookAfter
DebugPopPromise

However, I can't think of any negative consequences that could happen as a
result. I would be fine with promisehooks either on the inside or the outside.

[gsathya, 2016/12/16 00:55:16]

Done.

 
   a.Bind(&debug_push);
   {
+    a.GotoUnless(is_debug_active, &run_handler);
     a.CallRuntime(Runtime::kDebugPushPromise, context, deferred_promise);
     a.Goto(&run_handler);
   }
 
   a.Bind(&run_handler);
   {
     Callable call_callable = CodeFactory::Call(isolate);
 
     Node* const result =
         a.CallJS(call_callable, context, handler, a.UndefinedConstant(), value);
 
     a.GotoIfException(result, &if_rejectpromise, &var_reason);
 
     // TODO(gsathya): Remove this lookup by getting rid of the deferred object.
     Node* const key = a.HeapConstant(isolate->factory()->resolve_string());
     Node* const on_resolve =
         a.CallStub(getproperty_callable, context, deferred, key);
 
     Label if_internalhandler(&a), if_customhandler(&a, Label::kDeferred);
     a.Branch(a.IsUndefined(on_resolve), &if_internalhandler, &if_customhandler);
 
     a.Bind(&if_internalhandler);
-    InternalResolvePromise(&a, context, deferred_promise, result, &debug_pop);
+    InternalResolvePromise(&a, context, deferred_promise, result,
+                           &promisehook_after);
 
     a.Bind(&if_customhandler);
     {
       Node* const maybe_exception = a.CallJS(call_callable, context, on_resolve,
                                              a.UndefinedConstant(), result);
       a.GotoIfException(maybe_exception, &if_rejectpromise, &var_reason);
-      a.Goto(&debug_pop);
+      a.Goto(&promisehook_after);
     }
   }
 
   a.Bind(&if_rejectpromise);
   {
     // TODO(gsathya): Remove this lookup by getting rid of the deferred object.
     Node* const key = a.HeapConstant(isolate->factory()->reject_string());
     Node* const on_reject =
         a.CallStub(getproperty_callable, context, deferred, key);
 
     Callable promise_handle_reject = CodeFactory::PromiseHandleReject(isolate);
     a.CallStub(promise_handle_reject, context, deferred_promise, on_reject,
                var_reason.value());
+    a.Goto(&promisehook_after);
+  }
+
+  a.Bind(&promisehook_after);
+  {
+    a.GotoUnless(a.IsPromiseHookEnabled(), &debug_pop);
+    a.CallRuntime(Runtime::kPromiseHookAfter, context, promise);
     a.Goto(&debug_pop);
   }
 
   a.Bind(&debug_pop);
   {
     Label out(&a);
-
     a.GotoUnless(is_debug_active, &out);
     a.CallRuntime(Runtime::kDebugPopPromise, context);
     a.Goto(&out);
 
     a.Bind(&out);
     a.Return(a.UndefinedConstant());
   }
 }
 
 }  // namespace internal
 }  // namespace v8