-
Notifications
You must be signed in to change notification settings - Fork 536
Expand file tree
/
Copy paththreads.cc
More file actions
984 lines (841 loc) · 42.1 KB
/
Copy paththreads.cc
File metadata and controls
984 lines (841 loc) · 42.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
#include <echion/state.h>
#include <echion/tasks.h>
#include <echion/threads.h>
#include <echion/echion_sampler.h>
#include "dd_wrapper/include/defer.hpp"
#include <algorithm>
#include <optional>
#include <random>
#include <string_view>
void
ThreadInfo::reset_cycle_state() noexcept
{
current_tasks.clear();
current_greenlets.clear();
}
void
ThreadInfo::unwind(EchionSampler& echion, PyThreadState* tstate, microsecond_t wall_time_us)
{
// This entry reset is a precondition for a new snapshot: never append to logical state from an earlier cycle.
reset_cycle_state();
unwind_python_stack(echion, tstate, python_stack);
if (asyncio_loop) {
// unwind_tasks returns a [[nodiscard]] Result<void>.
// We cast it to void to ignore failures.
(void)unwind_tasks(echion, tstate, wall_time_us);
} else {
// We make the assumption that gevent and asyncio are not mixed
// together to keep the logic here simple. We can always revisit this
// should there be a substantial demand for it.
unwind_greenlets(echion, tstate, native_id, wall_time_us);
}
}
// ----------------------------------------------------------------------------
size_t
ThreadInfo::find_upper_python_stack_size(EchionSampler& echion) const
{
// Defaults to the full Python stack size (and updated if we find the boundary frame)
size_t upper_python_stack_size = python_stack.size();
// Check if the Python stack contains the asyncio boundary frame.
// For regular asyncio, this is "Handle._run" from asyncio/events.py.
// For uvloop, this is "Runner.run" from asyncio/runners.py (uvloop uses asyncio.Runner internally).
// To avoid having to do string comparisons every time we unwind Tasks, we memoize the interned
// name and filename of the boundary Frame the first time we identify it. Those are already
// StringTable keys, so recognizing the boundary afterwards costs two integer comparisons.
//
// Do NOT memoize Frame::cache_key here: it mixes in the bytecode offset, so it would only match
// the boundary Frame while it sits on the instruction it happened to be on when we first saw it.
// A single sample taken while, say, Runner.run is still in its prologue would then hide the
// boundary for the rest of the process, and every Task stack would be rendered with the
// coroutine frames at the leaf and the whole thread stack appended below them.
// Note: We memoize asyncio and uvloop separately because switching between them
// (though unlikely at runtime) would cause incorrect boundary detection otherwise.
auto& asyncio_boundary_frame = echion.asyncio_boundary_frame();
auto& uvloop_boundary_frame = echion.uvloop_boundary_frame();
auto& boundary_frame = using_uvloop ? uvloop_boundary_frame : asyncio_boundary_frame;
for (size_t i = 0; i < python_stack.size(); i++) {
const auto& frame = python_stack[i];
bool is_boundary_frame = false;
if (boundary_frame) {
is_boundary_frame = frame.name == boundary_frame->name && frame.filename == boundary_frame->filename;
} else {
auto maybe_frame_name = echion.string_table().lookup(frame.name);
if (!maybe_frame_name) {
continue;
}
const auto& frame_name = maybe_frame_name->get();
if (using_uvloop) {
// For uvloop, the boundary frame depends on the Python version:
// - Python 3.11+: Runner.run from asyncio/runners.py (uvloop uses asyncio.Runner)
// - Python < 3.11: run from uvloop/__init__.py (uvloop has its own implementation)
#if PY_VERSION_HEX >= 0x030b0000
constexpr std::string_view runner_run = "Runner.run";
is_boundary_frame = frame_name == runner_run;
#else
constexpr std::string_view uvloop_init_py = "uvloop/__init__.py";
constexpr std::string_view run = "run";
auto maybe_filename = echion.string_table().lookup(frame.filename);
if (!maybe_filename) {
continue;
}
const auto& filename = maybe_filename->get();
auto is_uvloop = filename.rfind(uvloop_init_py) == filename.size() - uvloop_init_py.size();
is_boundary_frame = is_uvloop && (frame_name == run);
#endif
} else {
// For regular asyncio, the boundary frame is Handle._run from asyncio/events.py
#if PY_VERSION_HEX >= 0x030b0000
// After Python 3.11, function names in Frames are qualified with e.g. the class name, so we
// can use the qualified name to identify the "_run" Frame.
constexpr std::string_view _run = "Handle._run";
is_boundary_frame = frame_name == _run;
#else
// Before Python 3.11, function names in Frames are not qualified, so we
// can use the filename to identify the "_run" Frame.
constexpr std::string_view asyncio_events_py = "asyncio/events.py";
constexpr std::string_view _run = "_run";
auto maybe_filename = echion.string_table().lookup(frame.filename);
if (!maybe_filename) {
continue;
}
const auto& filename = maybe_filename->get();
auto is_asyncio = filename.size() >= asyncio_events_py.size() &&
filename.rfind(asyncio_events_py) == filename.size() - asyncio_events_py.size();
is_boundary_frame = is_asyncio && (frame_name.size() >= _run.size() &&
frame_name.rfind(_run) == frame_name.size() - _run.size());
#endif
}
if (is_boundary_frame) {
boundary_frame = BoundaryFrame{ frame.name, frame.filename };
}
}
if (is_boundary_frame) {
upper_python_stack_size = python_stack.size() - i;
break;
}
}
return upper_python_stack_size;
}
// ----------------------------------------------------------------------------
Result<void>
ThreadInfo::unwind_tasks(EchionSampler& echion, PyThreadState* tstate, microsecond_t wall_time_us)
{
// The size of the "pure Python" stack (before asyncio Frames).
const size_t upper_python_stack_size = find_upper_python_stack_size(echion);
std::vector<TaskInfo::Ref> leaf_tasks;
std::unordered_set<PyObject*> parent_tasks;
std::unordered_map<PyObject*, TaskInfo::Ref> waitee_map; // Indexed by task origin
std::unordered_map<PyObject*, TaskInfo::Ref> origin_map; // Indexed by task origin
auto maybe_all_tasks = get_all_tasks(echion, tstate);
if (!maybe_all_tasks) {
return ErrorKind::TaskInfoError;
}
auto all_tasks = std::move(*maybe_all_tasks);
echion.add_asyncio_task_count(all_tasks.size());
{
auto& previous_task_objects = echion.previous_task_objects();
std::lock_guard<std::mutex> lock(echion.task_link_map_lock());
auto& task_link_map = echion.task_link_map();
auto& weak_task_link_map = echion.weak_task_link_map();
// Clean up the task_link_map. Remove entries associated to tasks that
// no longer exist.
std::unordered_set<PyObject*> all_task_origins;
std::transform(all_tasks.cbegin(),
all_tasks.cend(),
std::inserter(all_task_origins, all_task_origins.begin()),
[](const TaskInfo::Ptr& task) { return task->origin; });
std::vector<PyObject*> to_remove;
for (auto kv : task_link_map) {
if (all_task_origins.find(kv.first) == all_task_origins.end())
to_remove.push_back(kv.first);
}
for (auto key : to_remove) {
// Only remove the link if the Child Task previously existed; otherwise it's a Task that
// has just been created and that wasn't in all_tasks when we took the snapshot.
if (auto it = previous_task_objects.find(key); it != previous_task_objects.end()) {
task_link_map.erase(key);
}
}
// Determine the parent tasks from the gather links.
std::transform(task_link_map.cbegin(),
task_link_map.cend(),
std::inserter(parent_tasks, parent_tasks.begin()),
[](const std::pair<PyObject*, PyObject*>& kv) { return kv.second; });
// Clean up the weak_task_link_map.
// Remove entries associated to tasks that no longer exist.
all_task_origins.clear();
std::transform(all_tasks.cbegin(),
all_tasks.cend(),
std::inserter(all_task_origins, all_task_origins.begin()),
[](const TaskInfo::Ptr& task) { return task->origin; });
to_remove.clear();
for (auto kv : weak_task_link_map) {
if (all_task_origins.find(kv.first) == all_task_origins.end())
to_remove.push_back(kv.first);
}
for (auto key : to_remove) {
weak_task_link_map.erase(key);
}
// Determine the parent tasks from the gather (strong) links.
for (auto& link : task_link_map) {
auto parent = link.second;
// Check if the parent is actually the child of another Task
auto is_child = weak_task_link_map.find(parent) != weak_task_link_map.end();
// Only insert if we do not know of a Task that created the current Task
if (!is_child) {
parent_tasks.insert(parent);
}
}
// Copy all Task object pointers into previous_task_objects
previous_task_objects.clear();
for (const auto& task : all_tasks) {
previous_task_objects.insert(task->origin);
}
}
for (auto& task : all_tasks) {
origin_map.emplace(task->origin, std::ref(*task));
if (task->waiter != nullptr)
waitee_map.emplace(task->waiter->origin, std::ref(*task));
else if (parent_tasks.find(task->origin) == parent_tasks.end()) {
leaf_tasks.push_back(std::ref(*task));
}
}
// Pre-compute per-task coroutine stacks so that each task's coroutine chain is walked exactly once.
// Without this, a parent task's coroutine chain would be walked once for each child task that
// references it in its task chain (e.g. 10 children from asyncio.gather = 10 redundant unwinds
// of the parent's coroutine chain).
std::unordered_map<PyObject*, FrameStack> task_coro_stacks;
for (auto& task : all_tasks) {
FrameStack task_stack;
task->unwind(echion, task_stack, using_uvloop);
task_coro_stacks.emplace(task->origin, std::move(task_stack));
}
// Swap the on-CPU task to slot 0 so it is always retained by reservoir sampling.
bool found_on_cpu = false;
for (size_t i = 0; i < leaf_tasks.size(); i++) {
if (leaf_tasks[i].get().is_on_cpu) {
if (i > 0) {
std::swap(leaf_tasks[i], leaf_tasks[0]);
}
found_on_cpu = true;
break;
}
}
// Algorithm R reservoir sampling
const size_t n_total = leaf_tasks.size();
const unsigned int max_tasks = echion.max_tasks_per_sample();
size_t n_selected = n_total;
if (max_tasks > 0 && n_total > static_cast<size_t>(max_tasks)) {
n_selected = max_tasks;
auto& rng = echion.rng();
for (size_t i = max_tasks; i < n_total; i++) {
std::uniform_int_distribution<size_t> dist(found_on_cpu ? 1 : 0, i);
const size_t j = dist(rng);
if (j < max_tasks) {
std::swap(leaf_tasks[j], leaf_tasks[i]);
}
}
leaf_tasks.erase(leaf_tasks.begin() + static_cast<std::ptrdiff_t>(n_selected), leaf_tasks.end());
}
// Per-task wall-time scaling. Slot 0 keeps the unscaled thread wall time and the remaining
// n_selected-1 slots each represent (n_total-1)/(n_selected-1) tasks, so the per-thread total is correct.
// XXX: Known limitation
// Slot 0 cannot be scaled, which is why the factor is spread over n_selected-1 slots
// rather than applied uniformly. StackRenderer::render_thread_begin has already committed
// push_walltime(thread_walltime) before we know n_total, and render_task_begin reuses that sample
// for the first task on the thread, taking the branch that never reads walltime_ns_override. So an
// override on slot 0 is silently dropped, and push_walltime accumulates rather than assigns, so it
// cannot be corrected after the fact either.
// Consequence: max_tasks == 1 under-reports task wall time by a factor of n_total, because slot 0
// is then the only slot and there is nothing left to carry the other n_total-1 tasks. Fixing that
// means deferring the walltime push out of render_thread_begin, which affects every non-task
// thread too. See test_task_reservoir_sampling_single_slot_under_reports for the characterization.
const int64_t thread_walltime_ns = static_cast<int64_t>(1000) * static_cast<int64_t>(wall_time_us);
int64_t scaled_walltime_ns = thread_walltime_ns;
if (n_selected > 1 && n_selected < n_total) {
scaled_walltime_ns =
thread_walltime_ns * static_cast<int64_t>(n_total - 1) / static_cast<int64_t>(n_selected - 1);
}
size_t leaf_task_idx = 0;
for (auto& leaf_task : leaf_tasks) {
// Must match _task.task_object_address() so lock and stack samples correlate.
auto task_id = reinterpret_cast<uintptr_t>(leaf_task.get().origin);
auto stack_info = std::make_unique<StackInfo>(leaf_task.get().name, leaf_task.get().is_on_cpu, task_id);
auto& stack = stack_info->stack;
if (leaf_task_idx > 0) {
stack_info->walltime_ns = scaled_walltime_ns;
}
++leaf_task_idx;
// Safety: prevent infinite loops from cycles in task chain maps
size_t task_chain_depth = 0;
for (auto current_task = leaf_task;;) {
if (++task_chain_depth > MAX_RECURSION_DEPTH) {
break;
}
auto& task = current_task.get();
// Look up the pre-computed coroutine stack for this task.
// FrameStack order is leaf-to-root. For on-CPU tasks, synchronous frames from
// python_stack must be appended before coroutine frames.
// Decide how many coroutine frames to keep before appending the on-CPU sync frames below.
// This preserves the previous max_frames truncation behavior while avoiding front insertion.
const FrameStack* task_stack = nullptr;
size_t task_stack_size = 0;
size_t task_frames_to_push = 0;
if (auto it = task_coro_stacks.find(task.origin); it != task_coro_stacks.end()) {
task_stack = &it->second;
task_stack_size = task_stack->size();
if (stack.size() < max_frames) {
task_frames_to_push = std::min(task_stack_size, max_frames - stack.size());
}
}
if (task.is_on_cpu) {
// Get the "bottom" part of the Python synchronous Stack, that is to say the
// synchronous functions and coroutines called by the Task's outermost coroutine
// The number of Frames to push is the total number of Frames in the Python stack, from which we
// subtract the number of Frames in the "upper Python stack" (asyncio machinery + sync entrypoint)
// This gives us [outermost coroutine, ... , innermost coroutine, outermost sync function, ... ,
// innermost sync function]
// TODO: This may be incorrect if the Task that we know is on CPU does not match the Task that
// actually was on CPU when the Python Thread Stack was captured. One way to work around this
// may be to look at every Task Stack and match it against the Thread Stack. This would be
// somewhat costly though, and so far I have not seen a single instance of this race condition.
size_t frames_to_push = (python_stack.size() > upper_python_stack_size + task_stack_size)
? python_stack.size() - upper_python_stack_size - task_stack_size
: 0;
// These frames should render before the coroutine frames. Append them first in leaf-to-root order.
for (size_t i = 0; i < frames_to_push; i++) {
const auto& python_frame = python_stack[i];
// Skip the uvloop wrapper frame if present in the Python stack
if (is_uvloop_wrapper_frame(echion, using_uvloop, python_frame)) {
continue;
}
stack.push_back(python_frame);
}
}
if (task_stack != nullptr) {
for (size_t i = 0; i < task_frames_to_push; i++) {
stack.push_back((*task_stack)[i]);
}
}
// Task labels are rendered separately from frames; do not add a synthetic
// frame for the task name here.
// Get the next task in the chain
PyObject* task_origin = task.origin;
if (auto maybe_waitee = waitee_map.find(task_origin); maybe_waitee != waitee_map.end()) {
current_task = maybe_waitee->second;
continue;
}
{
// Check for, e.g., gather links
std::lock_guard<std::mutex> lock(echion.task_link_map_lock());
auto& task_link_map = echion.task_link_map();
auto& weak_task_link_map = echion.weak_task_link_map();
if (auto maybe_parent = task_link_map.find(task_origin); maybe_parent != task_link_map.end()) {
if (auto maybe_origin = origin_map.find(maybe_parent->second); maybe_origin != origin_map.end()) {
current_task = maybe_origin->second;
continue;
}
}
// Check for weak links
if (weak_task_link_map.find(task_origin) != weak_task_link_map.end() &&
origin_map.find(weak_task_link_map[task_origin]) != origin_map.end()) {
current_task = origin_map.find(weak_task_link_map[task_origin])->second;
continue;
}
}
break;
}
// Finish off with the remaining thread stack
// If we have seen an on-CPU Task, then upper_python_stack_size will be set and will include the sync entry
// point and the asyncio machinery Frames. Otherwise, we are in `select` (idle) and we should push all the
// Frames.
// There could be a race condition where relevant partial Python Thread Stack ends up being different from the
// one we saw in TaskInfo::unwind. This is extremely unlikely, I believe, but failing to account for it would
// cause an underflow, so let's be conservative.
size_t start_index = 0;
if (python_stack.size() >= upper_python_stack_size) {
start_index = python_stack.size() - upper_python_stack_size;
}
for (size_t i = start_index; i < python_stack.size(); i++) {
const auto& python_frame = python_stack[i];
stack.push_back(python_frame);
}
current_tasks.push_back(std::move(stack_info));
}
return Result<void>::ok();
}
// ----------------------------------------------------------------------------
#if PY_VERSION_HEX >= 0x030e0000
Result<void>
ThreadInfo::get_tasks_from_thread_linked_list(EchionSampler& echion, std::vector<TaskInfo::Ptr>& tasks)
{
if (this->tstate_addr == 0 || this->asyncio_loop == 0) {
return ErrorKind::TaskInfoError;
}
// Calculate thread state's asyncio_tasks_head remote address
// Note: Since 3.13+, every PyThreadState is actually allocated as a _PyThreadStateImpl.
// We use PyThreadState* everywhere and cast to _PyThreadStateImpl* only when we need
// to access asyncio_tasks_head (which is only available in Python 3.14+).
// Since tstate_addr is a remote address, we calculate the offset and add it to the address.
// get_tasks_from_linked_list will handle copying the head node from remote memory internally.
constexpr size_t asyncio_tasks_head_offset = offsetof(_PyThreadStateImpl, asyncio_tasks_head);
uintptr_t head_addr = this->tstate_addr + asyncio_tasks_head_offset;
return get_tasks_from_linked_list(echion, head_addr, tasks);
}
Result<void>
ThreadInfo::get_tasks_from_interpreter_linked_list(EchionSampler& echion,
PyThreadState* tstate,
std::vector<TaskInfo::Ptr>& tasks)
{
if (tstate == nullptr || tstate->interp == nullptr || this->asyncio_loop == 0) {
return ErrorKind::TaskInfoError;
}
constexpr size_t asyncio_tasks_head_offset = offsetof(PyInterpreterState, asyncio_tasks_head);
uintptr_t head_addr = reinterpret_cast<uintptr_t>(tstate->interp) + asyncio_tasks_head_offset;
return get_tasks_from_linked_list(echion, head_addr, tasks);
}
Result<void>
ThreadInfo::get_tasks_from_linked_list(EchionSampler& echion, uintptr_t head_addr, std::vector<TaskInfo::Ptr>& tasks)
{
if (head_addr == 0 || this->asyncio_loop == 0) {
return ErrorKind::TaskInfoError;
}
// Copy head node struct from remote memory to local memory
struct llist_node head_node_local;
if (copy_type(reinterpret_cast<void*>(head_addr), head_node_local)) {
return ErrorKind::TaskInfoError;
}
// Check if list is empty (head points to itself in circular list)
uintptr_t head_addr_uint = head_addr;
uintptr_t next_as_uint = reinterpret_cast<uintptr_t>(head_node_local.next);
uintptr_t prev_as_uint = reinterpret_cast<uintptr_t>(head_node_local.prev);
if (next_as_uint == head_addr_uint && prev_as_uint == head_addr_uint) {
return Result<void>::ok();
}
struct llist_node current_node = head_node_local; // Start with head node
// Copied from CPython's _remote_debugging_module.c: MAX_ITERATIONS
const size_t MAX_ITERATIONS = 1 << 16;
size_t iteration_count = 0;
// Iterate over linked-list. The linked list is circular, so we stop
// when we're back at head.
while (reinterpret_cast<uintptr_t>(current_node.next) != head_addr_uint) {
// Safety: prevent infinite loops
if (++iteration_count > MAX_ITERATIONS) {
return ErrorKind::TaskInfoError;
}
if (current_node.next == nullptr) {
return ErrorKind::TaskInfoError; // nullptr pointer - invalid list
}
uintptr_t next_node_addr = reinterpret_cast<uintptr_t>(current_node.next);
// Calculate task_addr from current_node.next
size_t task_node_offset_val = offsetof(TaskObj, task_node);
uintptr_t task_addr_uint = next_node_addr - task_node_offset_val;
// Create TaskInfo for the task
auto maybe_task_info = TaskInfo::create(echion, reinterpret_cast<TaskObj*>(task_addr_uint));
if (maybe_task_info) {
auto& task_info = *maybe_task_info;
if (task_info->loop == reinterpret_cast<PyObject*>(this->asyncio_loop)) {
tasks.push_back(std::move(task_info));
}
}
// Read next node from current_node.next into current_node
if (copy_type(reinterpret_cast<void*>(next_node_addr), current_node)) {
return ErrorKind::TaskInfoError; // Failed to read next node
}
}
return Result<void>::ok();
}
Result<std::vector<TaskInfo::Ptr>>
ThreadInfo::get_all_tasks(EchionSampler& echion, PyThreadState* tstate)
{
std::vector<TaskInfo::Ptr> tasks;
if (this->asyncio_loop == 0)
return tasks;
// Python 3.14+: Native tasks are in linked-list per thread AND per interpreter
// CPython iterates over both:
// 1. Per-thread list: tstate->asyncio_tasks_head (active tasks)
// 2. Per-interpreter list: interp->asyncio_tasks_head (lingering tasks)
// First, get tasks from this thread's linked-list (if tstate_addr is set)
// Note: We continue processing even if one source fails to maximize partial results
if (tstate != nullptr && this->tstate_addr != 0) {
(void)get_tasks_from_thread_linked_list(echion, tasks);
// Second, get tasks from interpreter's linked-list (lingering tasks)
(void)get_tasks_from_interpreter_linked_list(echion, tstate, tasks);
}
// Handle third-party tasks from Python _scheduled_tasks WeakSet
// In Python 3.14+, _scheduled_tasks is a Python-level weakref.WeakSet() that only contains
// tasks that don't inherit from asyncio.Task. Native asyncio.Task instances are stored
// in linked-lists (handled above) and are NOT added to _scheduled_tasks.
// This is typically empty in practice, but we handle it for completeness.
auto asyncio_scheduled_tasks = echion.asyncio_scheduled_tasks();
if (asyncio_scheduled_tasks != nullptr) {
if (auto maybe_scheduled_tasks_set = MirrorSet::create(asyncio_scheduled_tasks)) {
auto scheduled_tasks_set = std::move(*maybe_scheduled_tasks_set);
if (auto maybe_scheduled_tasks = scheduled_tasks_set.as_unordered_set()) {
auto scheduled_tasks = std::move(*maybe_scheduled_tasks);
for (auto task_addr : scheduled_tasks) {
// In WeakSet.data (set), elements are the Task objects themselves
auto maybe_task_info = TaskInfo::create(echion, reinterpret_cast<TaskObj*>(task_addr));
if (maybe_task_info &&
(*maybe_task_info)->loop == reinterpret_cast<PyObject*>(this->asyncio_loop)) {
tasks.push_back(std::move(*maybe_task_info));
}
}
}
}
}
auto asyncio_eager_tasks = echion.asyncio_eager_tasks();
if (asyncio_eager_tasks != nullptr) {
auto maybe_eager_tasks_set = MirrorSet::create(asyncio_eager_tasks);
if (!maybe_eager_tasks_set) {
return ErrorKind::TaskInfoError;
}
auto eager_tasks_set = std::move(*maybe_eager_tasks_set);
auto maybe_eager_tasks = eager_tasks_set.as_unordered_set();
if (!maybe_eager_tasks) {
return ErrorKind::TaskInfoError;
}
auto eager_tasks = std::move(*maybe_eager_tasks);
for (auto task_addr : eager_tasks) {
auto maybe_task_info = TaskInfo::create(echion, reinterpret_cast<TaskObj*>(task_addr));
if (maybe_task_info) {
if ((*maybe_task_info)->loop == reinterpret_cast<PyObject*>(this->asyncio_loop)) {
tasks.push_back(std::move(*maybe_task_info));
}
}
}
}
return tasks;
}
#else
// Pre-Python 3.14: get_all_tasks uses WeakSet approach
Result<std::vector<TaskInfo::Ptr>>
ThreadInfo::get_all_tasks(EchionSampler& echion, PyThreadState*)
{
std::vector<TaskInfo::Ptr> tasks;
if (this->asyncio_loop == 0)
return tasks;
auto asyncio_scheduled_tasks = echion.asyncio_scheduled_tasks();
auto maybe_scheduled_tasks_set = MirrorSet::create(asyncio_scheduled_tasks);
if (!maybe_scheduled_tasks_set) {
return ErrorKind::TaskInfoError;
}
auto scheduled_tasks_set = std::move(*maybe_scheduled_tasks_set);
auto maybe_scheduled_tasks = scheduled_tasks_set.as_unordered_set();
if (!maybe_scheduled_tasks) {
return ErrorKind::TaskInfoError;
}
auto scheduled_tasks = std::move(*maybe_scheduled_tasks);
for (auto task_wr_addr : scheduled_tasks) {
PyWeakReference task_wr;
if (copy_type(task_wr_addr, task_wr))
continue;
auto maybe_task_info = TaskInfo::create(echion, reinterpret_cast<TaskObj*>(task_wr.wr_object));
if (maybe_task_info) {
if (reinterpret_cast<uintptr_t>((*maybe_task_info)->loop) == this->asyncio_loop) {
tasks.push_back(std::move(*maybe_task_info));
}
}
}
auto asyncio_eager_tasks = echion.asyncio_eager_tasks();
if (asyncio_eager_tasks != nullptr) {
auto maybe_eager_tasks_set = MirrorSet::create(asyncio_eager_tasks);
if (!maybe_eager_tasks_set) {
return ErrorKind::TaskInfoError;
}
auto eager_tasks_set = std::move(*maybe_eager_tasks_set);
auto maybe_eager_tasks = eager_tasks_set.as_unordered_set();
if (!maybe_eager_tasks) {
return ErrorKind::TaskInfoError;
}
auto eager_tasks = std::move(*maybe_eager_tasks);
for (auto task_addr : eager_tasks) {
auto maybe_task_info = TaskInfo::create(echion, reinterpret_cast<TaskObj*>(task_addr));
if (maybe_task_info) {
if (reinterpret_cast<uintptr_t>((*maybe_task_info)->loop) == this->asyncio_loop) {
tasks.push_back(std::move(*maybe_task_info));
}
}
}
}
return tasks;
}
#endif // PY_VERSION_HEX >= 0x030e0000
// ----------------------------------------------------------------------------
void
ThreadInfo::unwind_greenlets(EchionSampler& echion,
PyThreadState* tstate,
unsigned long cur_native_id,
microsecond_t wall_time_us)
{
std::vector<GreenletSnapshot> snapshots;
// Phase 1: Snapshot greenlet data under the lock.
// This minimises the time we hold greenlet_info_map_lock, which is also
// acquired by record_greenlet_switch() on every greenlet switch. Holding
// the lock during the expensive unwind (Phase 2) would block ALL greenlet
// switches and lead to resource exhaustion (e.g. DB connection pools).
{
const std::lock_guard<std::mutex> guard(echion.greenlet_info_map_lock());
auto& greenlet_info_map = echion.greenlet_info_map();
auto& greenlet_parent_map = echion.greenlet_parent_map();
auto& greenlet_thread_map = echion.greenlet_thread_map();
if (greenlet_thread_map.find(cur_native_id) == greenlet_thread_map.end())
return;
std::unordered_set<GreenletInfo::ID> parent_greenlets;
// Collect all parent greenlets
std::transform(greenlet_parent_map.cbegin(),
greenlet_parent_map.cend(),
std::inserter(parent_greenlets, parent_greenlets.begin()),
[](const std::pair<GreenletInfo::ID, GreenletInfo::ID>& kv) { return kv.second; });
// Snapshot the leaf greenlets and precompute their parent chains
for (auto& [gid, greenlet] : greenlet_info_map) {
if (parent_greenlets.contains(gid))
continue;
auto frame = greenlet->frame;
if (frame == FRAME_NOT_SET) {
// The greenlet has not been started yet or has finished
continue;
}
GreenletSnapshot snap{ gid, greenlet->name, frame, {} };
// Precompute parent chain while we still hold the lock
auto current_id = gid;
std::unordered_set<GreenletInfo::ID> visited;
// The limit here is arbitrary, but it should be more than enough for
// most use cases.
const size_t MAX_GREENLET_DEPTH = 512;
// Safety: prevent infinite loops from cycles or corrupted parent maps
for (size_t iteration_count = 0; iteration_count < MAX_GREENLET_DEPTH; ++iteration_count) {
// Check for cycles
if (visited.contains(current_id))
break;
visited.insert(current_id);
auto pit = greenlet_parent_map.find(current_id);
if (pit == greenlet_parent_map.end())
break;
auto parent_id = pit->second;
auto git = greenlet_info_map.find(parent_id);
if (git == greenlet_info_map.end())
break;
auto parent_frame = git->second->frame;
if (parent_frame == FRAME_NOT_SET || parent_frame == Py_None)
break;
snap.parent_chain.emplace_back(git->second->name, parent_frame);
// Move up the greenlet chain
current_id = parent_id;
}
snapshots.push_back(std::move(snap));
}
} // Lock released here
// Move the on-CPU greenlet to slot 0 before reservoir sampling, so the on-CPU entry is always present.
bool found_on_cpu = false;
for (size_t i = 0; i < snapshots.size(); i++) {
if (snapshots[i].frame == Py_None) {
if (i > 0) {
std::swap(snapshots[i], snapshots[0]);
}
found_on_cpu = true;
break;
}
}
// Algorithm R reservoir sampling on the greenlet snapshots
const size_t n_greenlets_total = snapshots.size();
const unsigned int max_tasks = echion.max_tasks_per_sample();
size_t n_selected_greenlets = n_greenlets_total;
if (max_tasks > 0 && n_greenlets_total > static_cast<size_t>(max_tasks)) {
n_selected_greenlets = max_tasks;
auto& rng = echion.rng();
for (size_t i = max_tasks; i < n_greenlets_total; i++) {
std::uniform_int_distribution<size_t> dist(found_on_cpu ? 1 : 0, i);
const size_t j = dist(rng);
if (j < max_tasks) {
std::swap(snapshots[j], snapshots[i]);
}
}
snapshots.erase(snapshots.begin() + static_cast<std::ptrdiff_t>(n_selected_greenlets), snapshots.end());
}
// Slot 0 keeps the unscaled thread wall time (the first entry on a thread reuses the sample created by
// render_thread_begin, with no way to override it).
const int64_t thread_walltime_ns_g = static_cast<int64_t>(1000) * static_cast<int64_t>(wall_time_us);
int64_t scaled_walltime_ns_g = thread_walltime_ns_g;
if (n_selected_greenlets > 1 && n_selected_greenlets < n_greenlets_total) {
scaled_walltime_ns_g = thread_walltime_ns_g * static_cast<int64_t>(n_greenlets_total - 1) /
static_cast<int64_t>(n_selected_greenlets - 1);
}
// Phase 2: Unwind outside the lock.
// The expensive process_vm_readv / copy_type calls happen here, without
// blocking greenlet switches. Snapshotted frame pointers may have become
// stale, but unwind_frame() handles invalid pointers gracefully via
// copy_type() which returns non-zero on failure.
size_t snap_idx = 0;
for (auto& snap : snapshots) {
bool on_cpu = snap.frame == Py_None;
auto stack_info = std::make_unique<StackInfo>(snap.name, on_cpu, snap.greenlet_id);
auto& stack = stack_info->stack;
if (snap_idx > 0) {
stack_info->walltime_ns = scaled_walltime_ns_g;
}
++snap_idx;
GreenletInfo temp(snap.greenlet_id, snap.frame, snap.name);
temp.unwind(echion, snap.frame, tstate, stack);
for (auto& [parent_name, parent_frame] : snap.parent_chain) {
GreenletInfo parent_temp(0, parent_frame, parent_name);
parent_temp.unwind(echion, parent_frame, tstate, stack);
}
current_greenlets.push_back(std::move(stack_info));
}
// Make sure the on-CPU greenlet is first. render_task_begin reuses the
// sample created by render_thread_begin for the first task it renders;
// that sample already received push_cputime via render_cpu_time. Tasks
// rendered after the first start a new sample and, if on_cpu is true,
// push thread_state.cpu_time_ns again, double-counting CPU time.
//
// unwind_tasks performs the analogous swap on leaf_tasks above. Note that
// the "on-CPU" signal differs: asyncio's is_on_cpu is derived from frame
// matching during unwind, while a greenlet's on_cpu is set from
// snap.frame == Py_None (see the loop above), which is the sentinel
// greenlet uses for its currently-running greenlet. If that sentinel
// changes, this swap silently no-ops and the over-count returns.
//
// If no greenlet is on CPU (e.g. all workers are sleeping while the Hub
// is running, which is filtered out as a parent), no entry triggers
// render_task_begin's push_cputime branch, so order does not matter and
// this loop falls through harmlessly. Empty current_greenlets is also
// safe (loop body never executes).
for (size_t i = 1; i < current_greenlets.size(); i++) {
if (current_greenlets[i]->on_cpu) {
std::swap(current_greenlets[i], current_greenlets[0]);
break;
}
}
}
// ----------------------------------------------------------------------------
void
ThreadInfo::render_unwound_stacks(EchionSampler& echion)
{
auto& renderer = echion.renderer();
// Render in this order of priority
// 1. asyncio Tasks stacks (if any)
// 2. Greenlets stacks (if any)
// 3. The normal thread stack (if no asyncio tasks or greenlets)
if (!current_tasks.empty()) {
for (auto& task_stack_info : current_tasks) {
task_stack_info->task_name.visit_string([&](std::string_view task_name) {
renderer.render_task_begin(
task_name, task_stack_info->on_cpu, task_stack_info->task_id, task_stack_info->walltime_ns);
});
task_stack_info->stack.render(echion);
renderer.render_stack_end();
}
} else if (!current_greenlets.empty()) {
for (auto& greenlet_stack : current_greenlets) {
greenlet_stack->task_name.visit_string([&](std::string_view task_name) {
renderer.render_task_begin(
task_name, greenlet_stack->on_cpu, greenlet_stack->task_id, greenlet_stack->walltime_ns);
});
auto& stack = greenlet_stack->stack;
stack.render(echion);
renderer.render_stack_end();
}
} else {
python_stack.render(echion);
renderer.render_stack_end();
}
}
// ----------------------------------------------------------------------------
Result<void>
ThreadInfo::sample(EchionSampler& echion, PyThreadState* tstate, microsecond_t delta)
{
auto& renderer = echion.renderer();
// This exit reset complements unwind's entry reset. It covers returns before unwind and exceptions after partial
// task or greenlet state has been populated, so no logical snapshot survives the cycle that created it.
defer
{
reset_cycle_state();
};
renderer.render_thread_begin(tstate, name, delta, thread_id, native_id);
microsecond_t previous_cpu_time = cpu_time;
auto update_cpu_time_success = update_cpu_time();
if (!update_cpu_time_success) {
return ErrorKind::CpuTimeError;
}
renderer.render_cpu_time(cpu_time - previous_cpu_time);
this->unwind(echion, tstate, delta);
this->render_unwound_stacks(echion);
return Result<void>::ok();
}
Result<void>
ThreadInfo::update_cpu_time()
{
#if defined PL_LINUX
struct timespec ts;
if (clock_gettime(cpu_clock_id, &ts)) {
// If the clock is invalid, we skip updating the CPU time.
// This can happen if we try to compute CPU time for a thread that has exited.
if (errno == EINVAL) {
return Result<void>::ok();
}
return ErrorKind::CpuTimeError;
}
this->cpu_time = TS_TO_MICROSECOND(ts);
#elif defined PL_DARWIN
thread_basic_info_data_t info;
mach_msg_type_number_t count = THREAD_BASIC_INFO_COUNT;
kern_return_t kr = thread_info(
static_cast<thread_act_t>(this->mach_port), THREAD_BASIC_INFO, reinterpret_cast<thread_info_t>(&info), &count);
if (kr != KERN_SUCCESS) {
// If the thread is invalid, we skip updating the CPU time.
// This can happen if we try to compute CPU time for a thread that has exited.
if (kr == KERN_INVALID_ARGUMENT) {
return Result<void>::ok();
}
return ErrorKind::CpuTimeError;
}
if (info.flags & TH_FLAGS_IDLE) {
return Result<void>::ok();
}
this->cpu_time = TV_TO_MICROSECOND(info.user_time) + TV_TO_MICROSECOND(info.system_time);
#endif
return Result<void>::ok();
}
void
for_each_thread(EchionSampler& echion, InterpreterInfo& interp, const PyThreadStateCallback& callback)
{
std::unordered_set<PyThreadState*> threads;
std::unordered_set<PyThreadState*> seen_threads;
// Start from the thread list head
threads.insert(static_cast<PyThreadState*>(interp.tstate_head));
while (!threads.empty()) {
// Pop the next thread
PyThreadState* tstate_addr = *threads.begin();
threads.erase(threads.begin());
// Mark the thread as seen
seen_threads.insert(tstate_addr);
// Since threads can be created and destroyed at any time, we make
// a copy of the structure before trying to read its fields.
PyThreadState tstate;
if (copy_type(tstate_addr, tstate))
// We failed to copy the thread so we skip it.
continue;
// Enqueue the unseen threads that we can reach from this thread.
if (tstate.next != NULL && seen_threads.find(tstate.next) == seen_threads.end())
threads.insert(tstate.next);
if (tstate.prev != NULL && seen_threads.find(tstate.prev) == seen_threads.end())
threads.insert(tstate.prev);
{
const std::lock_guard<std::mutex> guard(echion.thread_info_map_lock());
auto it = echion.thread_info_map().find(tstate.thread_id);
if (it == echion.thread_info_map().end()) {
// We failed to find ThreadInfo for thread_id, maybe there's a
// race condition between this call and `register_thread()`.
continue;
}
// Update the tstate_addr for thread info, so we can access
// asyncio_tasks_head field from `_PyThreadStateImpl` struct
// later when we unwind tasks.
auto thread_info = it->second.get();
thread_info->tstate_addr = reinterpret_cast<uintptr_t>(tstate_addr);
// Call back with the copied thread state
callback(&tstate, *thread_info);
}
}
}