dart-sdk/runtime/lib
Vyacheslav Egorov a52f2b9617 [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>
2023-06-30 14:03:03 +00:00
..
array.cc Spelling pkg dev compiler 2023-01-26 09:12:41 +00:00
async.cc [vm] Remove old async_debugger flag. 2023-06-27 07:18:50 +00:00
async_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
bool.cc [vm] Make naming more consistent when converting between handles, tagged and untagged pointers. 2021-01-15 23:32:02 +00:00
convert_sources.gni Fix sources to source_set 2019-05-21 17:01:48 +00:00
core_sources.gni [vm] Remove dead runtime entries for WeakProperty 2022-01-18 19:15:25 +00:00
date.cc [vm] Remove dead _localTimeZoneAdjustmentInSeconds. 2022-07-19 17:29:04 +00:00
developer.cc [sdk] Add NativeRuntime.buildId to dart:developer. 2023-06-22 11:11:11 +00:00
developer_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
double.cc [vm] Update to constexpr in runtime/platform and lib. 2023-04-11 17:43:58 +00:00
errors.cc [vm] Update NULL to nullptr in runtime/lib. 2023-03-30 19:28:28 +00:00
ffi.cc [vm] Async FFI callbacks 2023-06-28 01:00:18 +00:00
ffi_dynamic_library.cc [vm/ffi] Add DynamicLibrary.close() 2023-06-15 17:19:37 +00:00
ffi_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
function.cc [vm] Fix equality of uninstantiated generic closures 2023-03-08 21:44:56 +00:00
growable_array.cc Revert part of "[vm] Allow sharing of deeply immutable lists across isolates" 2023-02-10 20:25:59 +00:00
identical.cc [vm] Make naming more consistent when converting between handles, tagged and untagged pointers. 2021-01-15 23:32:02 +00:00
integers.cc [vm] Update NULL to nullptr in runtime/lib. 2023-03-30 19:28:28 +00:00
integers.h [vm] Better implementation of hashCode function. 2022-10-20 20:31:20 +00:00
invocation_mirror.h
isolate.cc [vm, gc] Avoid duplicate pointer visiting functions when compressed pointers are disabled. 2023-04-11 17:36:33 +00:00
isolate_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
libgen_in.cc [vm] Update NULL to nullptr in runtime/lib. 2023-03-30 19:28:28 +00:00
math.cc [vm] Update NULL to nullptr in runtime/lib. 2023-03-30 19:28:28 +00:00
math_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
mirrors.cc [vm] Cleanup [PatchClass] in the VM 2023-06-29 15:03:37 +00:00
mirrors.h [VM] Implement isExtensionMember in MethodMirror and VariableMirror 2019-10-09 00:27:30 +00:00
mirrors_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
object.cc Reland "Reland "[vm] Unify hash codes in type objects"" 2023-05-26 20:13:17 +00:00
profiler.cc [ VM / Service ] Add UserTag support to C-API and send UserTagChanged 2021-06-23 00:58:47 +00:00
profiler_sources.gni Fix sources to source_set 2019-05-21 17:01:48 +00:00
regexp.cc [vm/regexp] Name generated Regexp function with actual expression. 2023-03-09 03:49:58 +00:00
simd128.cc [vm/sim/simd] Fix vmin/vmax implementation on simulator. 2022-05-11 16:59:24 +00:00
stacktrace.cc [vm] Rework awaiter stack unwinding. 2023-06-30 14:03:03 +00:00
stacktrace.h Reland "[ Service / dart:isolate ] Added getPorts RPC and 'debugName' optional" 2020-10-29 02:52:03 +00:00
stopwatch.cc [vm] refactor native entry and native entry type arguments 2018-12-13 19:29:26 +00:00
string.cc [vm] Update to constexpr in runtime/platform and lib. 2023-04-11 17:43:58 +00:00
timeline.cc [VM/Timeline] Store an array of flow IDs in each dart::TimelineEvent 2023-05-26 13:08:27 +00:00
typed_data.cc [build] Default to -O2 instead of -O3. 2023-01-24 00:54:29 +00:00
typed_data_sources.gni [NNBD/VM] Restructure VM patch files for the NNBD dart sdk split 2019-09-19 03:57:30 +00:00
uri.cc [vm] Reland: Prefix HOST_OS_* and TARGET_OS_* with DART_ 2021-07-02 19:06:45 +00:00
vmservice.cc [vm] Update NULL to nullptr in runtime/lib. 2023-03-30 19:28:28 +00:00
vmservice_sources.gni Fix sources to source_set 2019-05-21 17:01:48 +00:00