[vm] Rework awaiter stack unwinding.
The main contribution of this CL is unification of disparate
handling of various functions like `Future.timeout`,
`Future.wait`, `_SuspendState.createAsyncCallbacks` and
`_SuspendState._createAsyncStarCallback` into a single
`@pragma('vm:awaiter-link')` which allows Dart developers
to specify where awaiter unwinder should look for the next
awaiter.
For example this allows unwinding to succeed for the code like this:
Future<int> outer(Future<int> inner) {
@pragma('vm:awaiter-link')
final completer = Completer<int>();
inner.then((v) => completer.complete(v));
return completer.future;
}
This refactoring also ensures that we preserve information
(including Function & Code objects) required for awaiter
unwinding across all modes (JIT, AOT and AOT with DWARF stack
traces). This guarantees users will get the same information
no matter which mode they are running in. Previously
we have been disabling awaiter_stacks tests in some AOT
modes - which led to regressions in the quality of produced
stacks.
This CL also cleans up relationship between debugger and awaiter
stack returned by StackTrace.current - which makes stack trace
displayed by debugger (used for stepping out and determinining
whether exception is caught or not) and `StackTrace.current`
consistent.
Finally we make one user visible change to the stack trace:
awaiter stack will no always include intermediate listeners
created through `Future.then`. Previously we would sometimes
include these listeners at the tail of the stack trace,
which was inconsistent.
Ultimately this means that code like this:
Future<int> inner() async {
await null; // asynchronous gap
print(StackTrace.current); // (*)
return 0;
}
Future<int> outer() async {
int process(int v) {
return v + 1;
}
return await inner().then(process);
}
void main() async {
await outer();
}
Produces stack trace like this:
inner
<asynchronous suspension>
outer.process
<asynchronous suspension>
outer
<asynchronous suspension>
main
<asynchronous suspension>
And when stepping out of `inner` execution will stop at `outer.process`
first and the next step out will bring execution to `outer` next.
Fixes https://github.com/dart-lang/sdk/issues/52797
Fixes https://github.com/dart-lang/sdk/issues/52203
Issue https://github.com/dart-lang/sdk/issues/47985
TEST=ci
Bug: b/279929839
CoreLibraryReviewExempt: CL just adds @pragma to facilitate unwinding
Cq-Include-Trybots: luci.dart.try:vm-aot-linux-product-x64-try,vm-aot-linux-debug-x64-try,vm-aot-linux-release-x64-try,vm-aot-obfuscate-linux-release-x64-try,vm-aot-dwarf-linux-product-x64-try
Change-Id: If377d5329d6a11c86effb9369dc603a7ae616fe7
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/311680
Reviewed-by: Alexander Markov <alexmarkov@google.com>
Commit-Queue: Slava Egorov <vegorov@google.com>
This commit is contained in:
committed by
Commit Queue
parent
8828fee865
commit
a52f2b9617
+18
-6
@@ -292,7 +292,12 @@ class ActivationFrame : public ZoneAllocated {
|
||||
const Array& deopt_frame,
|
||||
intptr_t deopt_frame_offset);
|
||||
|
||||
ActivationFrame(uword pc, const Code& code);
|
||||
// Create a |kAsyncAwaiter| frame representing asynchronous awaiter
|
||||
// waiting for the completion of a |Future|.
|
||||
//
|
||||
// |closure| is the listener which will be invoked when awaited
|
||||
// computation completes.
|
||||
ActivationFrame(uword pc, const Code& code, const Closure& closure);
|
||||
|
||||
explicit ActivationFrame(Kind kind);
|
||||
|
||||
@@ -304,6 +309,10 @@ class ActivationFrame : public ZoneAllocated {
|
||||
|
||||
uword GetCallerSp() const { return fp() + (kCallerSpSlotFromFp * kWordSize); }
|
||||
|
||||
// For |kAsyncAwaiter| frames this is the listener which will be invoked
|
||||
// when the frame below (callee) completes.
|
||||
const Closure& closure() const { return closure_; }
|
||||
|
||||
const Function& function() const {
|
||||
return function_;
|
||||
}
|
||||
@@ -374,11 +383,11 @@ class ActivationFrame : public ZoneAllocated {
|
||||
|
||||
void PrintToJSONObject(JSONObject* jsobj);
|
||||
|
||||
// Get Closure that await'ed this async frame.
|
||||
ObjectPtr GetAsyncAwaiter(CallerClosureFinder* caller_closure_finder);
|
||||
|
||||
bool HandlesException(const Instance& exc_obj);
|
||||
|
||||
bool has_catch_error() const { return has_catch_error_; }
|
||||
void set_has_catch_error(bool value) { has_catch_error_ = value; }
|
||||
|
||||
private:
|
||||
void PrintToJSONObjectRegular(JSONObject* jsobj);
|
||||
void PrintToJSONObjectAsyncAwaiter(JSONObject* jsobj);
|
||||
@@ -423,6 +432,7 @@ class ActivationFrame : public ZoneAllocated {
|
||||
Context& ctx_ = Context::ZoneHandle();
|
||||
const Code& code_;
|
||||
const Function& function_;
|
||||
const Closure& closure_;
|
||||
|
||||
bool token_pos_initialized_ = false;
|
||||
TokenPosition token_pos_ = TokenPosition::kNoSource;
|
||||
@@ -444,6 +454,8 @@ class ActivationFrame : public ZoneAllocated {
|
||||
ZoneGrowableArray<intptr_t> desc_indices_;
|
||||
PcDescriptors& pc_desc_ = PcDescriptors::ZoneHandle();
|
||||
|
||||
bool has_catch_error_ = false;
|
||||
|
||||
friend class Debugger;
|
||||
friend class DebuggerStackTrace;
|
||||
DISALLOW_COPY_AND_ASSIGN(ActivationFrame);
|
||||
@@ -471,8 +483,8 @@ class DebuggerStackTrace : public ZoneAllocated {
|
||||
|
||||
private:
|
||||
void AddActivation(ActivationFrame* frame);
|
||||
void AddAsyncSuspension();
|
||||
void AddAsyncAwaiterFrame(uword pc, const Code& code);
|
||||
void AddAsyncSuspension(bool has_catch_error);
|
||||
void AddAsyncAwaiterFrame(uword pc, const Code& code, const Closure& closure);
|
||||
|
||||
void AppendCodeFrames(StackFrame* frame, const Code& code);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user