Vyacheslav Egorov
a52f2b9617
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>
136 lines
4.4 KiB
Dart
136 lines
4.4 KiB
Dart
// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
|
|
// for details. All rights reserved. Use of this source code is governed by a
|
|
// BSD-style license that can be found in the LICENSE file.
|
|
|
|
// VMOptions=--verbose_debug
|
|
|
|
import 'dart:developer';
|
|
|
|
import 'package:test/test.dart';
|
|
import 'package:vm_service/vm_service.dart';
|
|
|
|
import 'common/service_test_common.dart';
|
|
import 'common/test_helper.dart';
|
|
|
|
const LINE_A = 36;
|
|
const LINE_B = 38;
|
|
|
|
const LINE_0 = 35;
|
|
const LINE_1 = 37;
|
|
|
|
Future<void> testMain() async {
|
|
await func1();
|
|
}
|
|
|
|
Future func1() async => await func2();
|
|
Future func2() async => await func3();
|
|
Future func3() async => await func4();
|
|
Future func4() async => await func5();
|
|
Future func5() async => await func6();
|
|
Future func6() async => await func7();
|
|
Future func7() async => await func8();
|
|
Future func8() async => await func9();
|
|
Future func9() async => await func10();
|
|
Future func10() async {
|
|
debugger(); // LINE_0.
|
|
await 0; // LINE_A
|
|
debugger(); // LINE_1.
|
|
print("Hello, world!"); // LINE_B.
|
|
}
|
|
|
|
void expectFrame(
|
|
final frame, final kindExpectation, final codeNameExpectation) {
|
|
expect(frame.kind, kindExpectation);
|
|
expect(frame.code?.name, codeNameExpectation);
|
|
}
|
|
|
|
void expectFrames(final frames, final expectKindAndCodeName) {
|
|
for (int i = 0; i < expectKindAndCodeName.length; i++) {
|
|
expectFrame(
|
|
frames[i], expectKindAndCodeName[i][0], expectKindAndCodeName[i][1]);
|
|
}
|
|
}
|
|
|
|
final tests = <IsolateTest>[
|
|
// Before the first await.
|
|
hasStoppedAtBreakpoint,
|
|
stoppedAtLine(LINE_0),
|
|
stepOver,
|
|
hasStoppedAtBreakpoint,
|
|
stoppedAtLine(LINE_A),
|
|
// At LINE_A we're still running sync. so no asyncCausalFrames.
|
|
(VmService service, IsolateRef isolateRef) async {
|
|
final result = await service.getStack(isolateRef.id!);
|
|
|
|
expect(result.frames, hasLength(16));
|
|
expect(result.asyncCausalFrames, isNull);
|
|
|
|
expectFrames(result.frames, [
|
|
[equals('Regular'), endsWith(' func10')],
|
|
[equals('Regular'), endsWith(' func9')],
|
|
[equals('Regular'), endsWith(' func8')],
|
|
[equals('Regular'), endsWith(' func7')],
|
|
[equals('Regular'), endsWith(' func6')],
|
|
[equals('Regular'), endsWith(' func5')],
|
|
[equals('Regular'), endsWith(' func4')],
|
|
[equals('Regular'), endsWith(' func3')],
|
|
[equals('Regular'), endsWith(' func2')],
|
|
[equals('Regular'), endsWith(' func1')],
|
|
[equals('Regular'), endsWith(' testMain')],
|
|
]);
|
|
},
|
|
resumeIsolate,
|
|
hasStoppedAtBreakpoint,
|
|
stoppedAtLine(LINE_1),
|
|
stepOver,
|
|
hasStoppedAtBreakpoint,
|
|
stoppedAtLine(LINE_B),
|
|
// After resuming the continuation - i.e. running async.
|
|
(VmService service, IsolateRef isolateRef) async {
|
|
final result = await service.getStack(isolateRef.id!);
|
|
|
|
expect(result.frames, hasLength(5));
|
|
expect(result.asyncCausalFrames, hasLength(26));
|
|
|
|
expectFrames(result.frames!, [
|
|
[equals('Regular'), endsWith(' func10')],
|
|
[equals('Regular'), anything], // Internal mech. ..
|
|
[equals('Regular'), anything],
|
|
[equals('Regular'), anything],
|
|
[equals('Regular'), endsWith(' _RawReceivePort._handleMessage')],
|
|
]);
|
|
|
|
expectFrames(result.asyncCausalFrames, [
|
|
[equals('Regular'), endsWith(' func10')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func9')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func8')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func7')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func6')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func5')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func4')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func3')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func2')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' func1')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
[equals('AsyncCausal'), endsWith(' testMain')],
|
|
[equals('AsyncSuspensionMarker'), isNull],
|
|
]);
|
|
},
|
|
];
|
|
|
|
main([args = const <String>[]]) => runIsolateTests(
|
|
args,
|
|
tests,
|
|
'get_stack_test.dart',
|
|
testeeConcurrent: testMain,
|
|
);
|