[DAP] "Sentinel kind: Expired" when looking at large maps #54897

paulcardno · 2024-02-12T21:55:59Z

When running Flutter I came across this error, while looking at a data structure that was large. This happened while I was debugging and had put a breakpoint on as was wanting to investigate a large variable and its map values.

Steps to reproduce(in flutter, if you need I can provide the code here)

I have recreated the problem. you can find the code here. https://github.com/QCIPaulCardno/SentinelKindExpiredIssue2024.git. just the main.dart is all you need.
To reproduce. put a breakpoint on line 99. Run the app. Press the plus button
When it stops. Goto the variables (run and debug). Expand out globals. expand out complexObject. Expand out dicByDayOfFloorIDs, expand "0", expand values. and then you will see the message "[Sentinel kind: Expired, valueAsString: ] from invoke()"
If you reduce the size of this class by changing count from 10000 to 1000 line 113 in the for loop. and then run again it all works as expected.

Running on a mac
Apple M1 Max
64 GB
Macintosh HD
14.2.1 (23C71)
macOS (desktop) • macos • darwin-arm64 • macOS 14.2.1 23C71 darwin-arm64

building for MacOS

here is flutter doctor -v
[✓] Flutter (Channel beta, 3.19.0-0.4.pre, on macOS 14.2.1 23C71 darwin-arm64, locale en-NZ)
• Flutter version 3.19.0-0.4.pre on channel beta at /Users/xxx
• Upstream repository https://github.com/xxx
• Framework revision flutter/flutter@b7e7d46 (10 days ago), 2024-02-02 08:21:06 -0600
• Engine revision 98820f0a77
• Dart version 3.3.0 (build 3.3.0-279.3.beta)
• DevTools version 2.31.0

Let me know if you need any more information?

The text was updated successfully, but these errors were encountered:

mraleph · 2024-02-13T11:54:27Z

/cc @bkonyi

bkonyi · 2024-02-13T15:59:50Z

Unfortunately, this is probably working as intended. The VM service uses a ring buffer to allocate IDs to objects it sends over the service protocol but the ring buffer currently only has the capacity for 8192 objects. If the ring buffer wraps around, older object IDs are overwritten and will give an Expired sentinel response when accessed.

We can work around this by requesting subsets of large collections to avoid causing the object ID buffer to immediately wrap around. This is something we do in the DevTools debugger, but I'm not sure we do in the Dart-Code VSCode plugin (cc @DanTup to confirm).

We may end up increasing the size of the object ID ring buffer at some point. However, that would have implications on memory usage and possibly GC performance, and still wouldn't completely solve the problem for very large collections.

DanTup · 2024-02-13T17:30:57Z

I think there are a few issues here.

It looks like our paging of variables only works for Lists and not Maps. Lists look like this:
By default we call toString() on items for the debugger view, so if there are 10000 items in the map, we're going to generate 10000 strings.
An error invoking toString() for one item in the map should not be causing the entire set to error - I would expect the successful requests to still show their results (in fact, if we're lucky they might all show it, because the strings being evicted we already have from the initial response).

I'll look at 1+3. 2 can be disabled with the following VS Code setting:

"dart.evaluateToStringInDebugViews": false

This results in less-useful labels, but prevents the error:

DanTup · 2024-04-29T15:26:45Z

Smaller repro for the issue without Flutter:

import 'dart:developer';

void main() {
  final c = <String, A>{
    for (int i = 0; i < 10000; i++) '$i': A(i),
  };

  debugger();
  print(c);
}

class A {
  final int i;

  A(this.i);
}

DanTup · 2024-04-29T18:42:12Z

I have a change at https://dart-review.googlesource.com/c/sdk/+/364860 that improves this slightly, by not failing the entire request just because we couldn't fetch the strings:

However, we should also support paging here and limiting the calls we make so that we're not blowing the buffer that results in sentinels like this.

…error to clients getObject and invoke would `throw` if the response was a sentinel and that wasn't handled correctly, which meant sometimes an entire variables request would fail instead of only the individual values (eg. in a map/list) being shown as erroring. This improves #54897 (you'll no longer see the entire request fail), but it still needs paging adding too. Change-Id: Ic3ed3bee7c1dd647ebae843007bd30b0e1fda590 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/364860 Reviewed-by: Helin Shiah <helinx@google.com> Commit-Queue: Ben Konyi <bkonyi@google.com> Reviewed-by: Ben Konyi <bkonyi@google.com>

DanTup · 2025-04-07T15:18:47Z

Unfortunately it turns out that VS Code does not support paging for maps ("named variables") only for lists ("indexed variables"):

microsoft/vscode#13878

So since the other parts of this are addressed above, I'm going to close this as done. If it turns out large maps are a problem, we can try to resurrect the VS Code issue.

lrhn added the area-vm Use area-vm for VM related issues, including code coverage, and the AOT and JIT backends. label Feb 12, 2024

DanTup self-assigned this Feb 13, 2024

DanTup changed the title ~~Flutter in vs code error : "Sentinel kind: Expired" when looking at large object structure~~ [DAP] "Sentinel kind: Expired" when looking at large maps Feb 13, 2024

a-siva added area-tools A meta category for issues that should be addressed by tooling (prefer more concrete areas). and removed area-vm Use area-vm for VM related issues, including code coverage, and the AOT and JIT backends. labels Feb 14, 2024

DanTup closed this as completed Apr 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DAP] "Sentinel kind: Expired" when looking at large maps #54897

[DAP] "Sentinel kind: Expired" when looking at large maps #54897

[DAP] "Sentinel kind: Expired" when looking at large maps #54897

[DAP] "Sentinel kind: Expired" when looking at large maps #54897

Comments