This repository was archived by the owner on Jan 31, 2025. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathProducerEventProcessor.cpp
More file actions
812 lines (723 loc) · 37.3 KB
/
Copy pathProducerEventProcessor.cpp
File metadata and controls
812 lines (723 loc) · 37.3 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
// Copyright (c) 2021 The Orbit Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ProducerEventProcessor/ProducerEventProcessor.h"
#include <absl/container/flat_hash_map.h>
#include <absl/hash/hash.h>
#include <absl/meta/type_traits.h>
#include <absl/synchronization/mutex.h>
#include <google/protobuf/stubs/port.h>
#include <string>
#include <utility>
#include <vector>
#include "GrpcProtos/capture.pb.h"
#include "GrpcProtos/tracepoint.pb.h"
#include "OrbitBase/Logging.h"
#include "ProducerEventProcessor/ClientCaptureEventCollector.h"
using orbit_grpc_protos::AddressInfo;
using orbit_grpc_protos::ApiScopeStart;
using orbit_grpc_protos::ApiScopeStartAsync;
using orbit_grpc_protos::ApiScopeStop;
using orbit_grpc_protos::ApiScopeStopAsync;
using orbit_grpc_protos::ApiStringEvent;
using orbit_grpc_protos::ApiTrackDouble;
using orbit_grpc_protos::ApiTrackFloat;
using orbit_grpc_protos::ApiTrackInt;
using orbit_grpc_protos::ApiTrackInt64;
using orbit_grpc_protos::ApiTrackUint;
using orbit_grpc_protos::ApiTrackUint64;
using orbit_grpc_protos::Callstack;
using orbit_grpc_protos::CallstackSample;
using orbit_grpc_protos::CaptureFinished;
using orbit_grpc_protos::CaptureStarted;
using orbit_grpc_protos::ClientCaptureEvent;
using orbit_grpc_protos::ClockResolutionEvent;
using orbit_grpc_protos::ErrorEnablingOrbitApiEvent;
using orbit_grpc_protos::ErrorEnablingUserSpaceInstrumentationEvent;
using orbit_grpc_protos::ErrorsWithPerfEventOpenEvent;
using orbit_grpc_protos::FullAddressInfo;
using orbit_grpc_protos::FullCallstackSample;
using orbit_grpc_protos::FullGpuJob;
using orbit_grpc_protos::FullTracepointEvent;
using orbit_grpc_protos::FunctionCall;
using orbit_grpc_protos::GpuDebugMarker;
using orbit_grpc_protos::GpuJob;
using orbit_grpc_protos::GpuQueueSubmission;
using orbit_grpc_protos::InternedCallstack;
using orbit_grpc_protos::InternedString;
using orbit_grpc_protos::InternedTracepointInfo;
using orbit_grpc_protos::LostPerfRecordsEvent;
using orbit_grpc_protos::MemoryUsageEvent;
using orbit_grpc_protos::ModulesSnapshot;
using orbit_grpc_protos::ModuleUpdateEvent;
using orbit_grpc_protos::OutOfOrderEventsDiscardedEvent;
using orbit_grpc_protos::PresentEvent;
using orbit_grpc_protos::ProducerCaptureEvent;
using orbit_grpc_protos::SchedulingSlice;
using orbit_grpc_protos::ThreadName;
using orbit_grpc_protos::ThreadNamesSnapshot;
using orbit_grpc_protos::ThreadStateSlice;
using orbit_grpc_protos::ThreadStateSliceCallstack;
using orbit_grpc_protos::TracepointEvent;
using orbit_grpc_protos::WarningEvent;
using orbit_grpc_protos::WarningInstrumentingWithUprobesEvent;
using orbit_grpc_protos::WarningInstrumentingWithUserSpaceInstrumentationEvent;
namespace orbit_producer_event_processor {
namespace {
template <typename T>
class InternPool final {
public:
InternPool() = default;
// Return pair of <id, assigned>, where assigned is true if the entry was assigned a new id
// and false if returning id for already existing entry.
std::pair<uint64_t, bool> GetOrAssignId(const T& entry) {
absl::MutexLock lock(&entry_to_id_mutex_);
auto it = entry_to_id_.find(entry);
if (it != entry_to_id_.end()) {
return std::make_pair(it->second, false);
}
uint64_t new_id = id_counter_++;
auto [unused_it, inserted] = entry_to_id_.insert_or_assign(entry, new_id);
ORBIT_CHECK(inserted);
return std::make_pair(new_id, true);
}
private:
uint64_t id_counter_ = 1; // 0 is reserved for invalid_id
absl::flat_hash_map<T, uint64_t> entry_to_id_;
absl::Mutex entry_to_id_mutex_;
};
class ProducerEventProcessorImpl : public ProducerEventProcessor {
public:
ProducerEventProcessorImpl() = delete;
explicit ProducerEventProcessorImpl(ClientCaptureEventCollector* client_capture_event_collector)
: client_capture_event_collector_{client_capture_event_collector} {}
void ProcessEvent(uint64_t producer_id, ProducerCaptureEvent&& event) override;
private:
// Please keep the declarations here and the definitions below of these Process... methods
// alphabetically ordered as in the definition of the ProducerCaptureEvent message.
void ProcessApiScopeStartAndTransferOwnership(ApiScopeStart* api_scope_start);
void ProcessApiScopeStartAsyncAndTransferOwnership(ApiScopeStartAsync* api_scope_start_async);
void ProcessApiScopeStopAndTransferOwnership(ApiScopeStop* api_scope_stop);
void ProcessApiScopeStopAsyncAndTransferOwnership(ApiScopeStopAsync* api_scope_stop_async);
void ProcessApiStringEventAndTransferOwnership(ApiStringEvent* api_string_event);
void ProcessApiTrackDoubleAndTransferOwnership(ApiTrackDouble* api_track_double);
void ProcessApiTrackFloatAndTransferOwnership(ApiTrackFloat* api_track_float);
void ProcessApiTrackIntAndTransferOwnership(ApiTrackInt* api_track_int);
void ProcessApiTrackInt64AndTransferOwnership(ApiTrackInt64* api_track_int64);
void ProcessApiTrackUintAndTransferOwnership(ApiTrackUint* api_track_uint);
void ProcessApiTrackUint64AndTransferOwnership(ApiTrackUint64* api_track_uint64);
void ProcessCallstackSampleAndTransferOwnership(uint64_t producer_id,
CallstackSample* callstack_sample);
void ProcessCaptureFinishedAndTransferOwnership(CaptureFinished* capture_finished);
void ProcessCaptureStartedAndTransferOwnership(CaptureStarted* capture_started);
void ProcessClockResolutionEventAndTransferOwnership(
ClockResolutionEvent* clock_resolution_event);
void ProcessErrorEnablingOrbitApiEventAndTransferOwnership(
ErrorEnablingOrbitApiEvent* error_enabling_orbit_api_event);
void ProcessErrorEnablingUserSpaceInstrumentationEventAndTransferOwnership(
ErrorEnablingUserSpaceInstrumentationEvent* error_event);
void ProcessErrorsWithPerfEventOpenEventAndTransferOwnership(
ErrorsWithPerfEventOpenEvent* errors_with_perf_event_open_event);
void ProcessFullCallstackSample(FullCallstackSample* full_callstack_sample);
void ProcessFullAddressInfo(FullAddressInfo* full_address_info);
void ProcessFullGpuJob(FullGpuJob* full_gpu_job_event);
void ProcessFullTracepointEvent(FullTracepointEvent* full_tracepoint_event);
void ProcessFunctionCallAndTransferOwnership(FunctionCall* function_call);
void ProcessGpuQueueSubmissionAndTransferOwnership(uint64_t producer_id,
GpuQueueSubmission* gpu_queue_submission);
// ProcessInterned* functions remap producer intern_ids to the id space used in the client.
// They keep track of these mappings in producer_interned_callstack_id_to_client_callstack_id_
// and producer_interned_string_id_to_client_string_id_.
void ProcessInternedCallstack(uint64_t producer_id, InternedCallstack* interned_callstack);
void ProcessInternedString(uint64_t producer_id, InternedString* interned_string);
void ProcessLostPerfRecordsEventAndTransferOwnership(
LostPerfRecordsEvent* lost_perf_records_event);
void ProcessMemoryUsageEventAndTransferOwnership(MemoryUsageEvent* memory_usage_event);
void ProcessModulesSnapshotAndTransferOwnership(ModulesSnapshot* modules_snapshot);
void ProcessModuleUpdateEventAndTransferOwnership(ModuleUpdateEvent* module_update_event);
void ProcessOutOfOrderEventsDiscardedEventAndTransferOwnership(
OutOfOrderEventsDiscardedEvent* out_of_order_events_discarded_event);
void ProcessPresentEventAndTransferOwnership(PresentEvent* present_event);
void ProcessSchedulingSliceAndTransferOwnership(SchedulingSlice* scheduling_slice);
void ProcessThreadNameAndTransferOwnership(ThreadName* thread_name);
void ProcessThreadNamesSnapshotAndTransferOwnership(ThreadNamesSnapshot* thread_names_snapshot);
void ProcessThreadStateSliceAndTransferOwnership(ThreadStateSlice* thread_state_slice);
void ProcessThreadStateSliceCallstack(ThreadStateSliceCallstack* thread_state_slice_callstack);
void ProcessWarningEventAndTransferOwnership(WarningEvent* warning_event);
void ProcessWarningInstrumentingWithUprobesEventAndTransferOwnership(
WarningInstrumentingWithUprobesEvent* warning_event);
void ProcessWarningInstrumentingWithUserSpaceInstrumentationEventAndTransferOwnership(
WarningInstrumentingWithUserSpaceInstrumentationEvent* warning_event);
void SendInternedStringEvent(uint64_t key, std::string value);
void MergeThreadStateSliceWithCallstackAndTransferOwnership(ThreadStateSlice* thread_state_slice);
ClientCaptureEventCollector* client_capture_event_collector_;
InternPool<std::pair<std::vector<uint64_t>, Callstack::CallstackType>> callstack_pool_;
InternPool<std::string> string_pool_;
InternPool<std::pair<std::string, std::string>> tracepoint_pool_;
// These are mapping InternStrings and InternedCallstacks from producer ids
// to client ids:
// <producer_id, producer_callstack_id> -> client_callstack_id
absl::flat_hash_map<std::pair<uint64_t, uint64_t>, uint64_t>
producer_interned_callstack_id_to_client_callstack_id_;
// <producer_id, producer_string_id> -> client_string_id
absl::flat_hash_map<std::pair<uint64_t, uint64_t>, uint64_t>
producer_interned_string_id_to_client_string_id_;
// Needed to allow merging of thread state slices and their callstacks, see:
// http://go/stadia-orbit-tracepoint-callstack.
// NOTE: A thread state slice always gets constructed using two tracepoint events. It is always
// the begin tracepoint event that results in the ThreadStateSliceCallstack, so we will always
// see the ThreadStateSliceCallstack before we see the matching ThreadStateSlice. Thus, we do not
// need to save the thread state slices to be merged with a callstack later.
absl::flat_hash_map<std::pair<uint32_t, uint64_t>, uint64_t>
thread_state_slice_tid_and_begin_timestamp_to_callstack_id_;
};
void ProducerEventProcessorImpl::MergeThreadStateSliceWithCallstackAndTransferOwnership(
ThreadStateSlice* thread_state_slice) {
uint64_t begin_timestamp =
thread_state_slice->end_timestamp_ns() - thread_state_slice->duration_ns();
// Callstacks on thread state slices always origin from the tracepoint that corresponds to the
// slice's begin. Thus, if we see a thread state slice waiting for the callstack to be added,
// we know that we have already seen the corresponding callstack.
// Also, even if we were missing the end tracepoint, we are not leaking memory in our callstack
// map. The SwitchesStatesNamesVisitor will eventually create a thread state slice for that begin
// tracepoint--worst case at the end of profiling--, such that we can erase the mapping.
auto thread_state_slice_callstack_it =
thread_state_slice_tid_and_begin_timestamp_to_callstack_id_.find(
{thread_state_slice->tid(), begin_timestamp});
// There are rare situations where we do not have a callstack even though the thread state slice
// is waiting for it. This happens when unwinding failed completely.
// Let's "fail" gracefully here, by not assigning a callstack.
if (thread_state_slice_callstack_it ==
thread_state_slice_tid_and_begin_timestamp_to_callstack_id_.end()) {
ORBIT_ERROR("Missing callstack for thread state slice waiting for it");
thread_state_slice->set_switch_out_or_wakeup_callstack_status(ThreadStateSlice::kNoCallstack);
thread_state_slice->set_switch_out_or_wakeup_callstack_id(0);
ClientCaptureEvent event;
event.set_allocated_thread_state_slice(thread_state_slice);
client_capture_event_collector_->AddEvent(std::move(event));
return;
}
thread_state_slice->set_switch_out_or_wakeup_callstack_status(ThreadStateSlice::kCallstackSet);
thread_state_slice->set_switch_out_or_wakeup_callstack_id(
thread_state_slice_callstack_it->second);
thread_state_slice_tid_and_begin_timestamp_to_callstack_id_.erase(
thread_state_slice_callstack_it);
ClientCaptureEvent event;
event.set_allocated_thread_state_slice(thread_state_slice);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiScopeStartAndTransferOwnership(
ApiScopeStart* api_scope_start) {
ClientCaptureEvent event;
event.set_allocated_api_scope_start(api_scope_start);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiScopeStartAsyncAndTransferOwnership(
ApiScopeStartAsync* api_scope_start_async) {
ClientCaptureEvent event;
event.set_allocated_api_scope_start_async(api_scope_start_async);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiScopeStopAndTransferOwnership(
ApiScopeStop* api_scope_stop) {
ClientCaptureEvent event;
event.set_allocated_api_scope_stop(api_scope_stop);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiScopeStopAsyncAndTransferOwnership(
ApiScopeStopAsync* api_scope_stop_async) {
ClientCaptureEvent event;
event.set_allocated_api_scope_stop_async(api_scope_stop_async);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiStringEventAndTransferOwnership(
ApiStringEvent* api_string_event) {
ClientCaptureEvent event;
event.set_allocated_api_string_event(api_string_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiTrackDoubleAndTransferOwnership(
ApiTrackDouble* api_track_double) {
ClientCaptureEvent event;
event.set_allocated_api_track_double(api_track_double);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiTrackFloatAndTransferOwnership(
ApiTrackFloat* api_track_float) {
ClientCaptureEvent event;
event.set_allocated_api_track_float(api_track_float);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiTrackIntAndTransferOwnership(
ApiTrackInt* api_track_int) {
ClientCaptureEvent event;
event.set_allocated_api_track_int(api_track_int);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiTrackInt64AndTransferOwnership(
ApiTrackInt64* api_track_int64) {
ClientCaptureEvent event;
event.set_allocated_api_track_int64(api_track_int64);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiTrackUintAndTransferOwnership(
ApiTrackUint* api_track_uint) {
ClientCaptureEvent event;
event.set_allocated_api_track_uint(api_track_uint);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessApiTrackUint64AndTransferOwnership(
ApiTrackUint64* api_track_uint64) {
ClientCaptureEvent event;
event.set_allocated_api_track_uint64(api_track_uint64);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessCallstackSampleAndTransferOwnership(
uint64_t producer_id, CallstackSample* callstack_sample) {
// translate producer id to client id
auto it = producer_interned_callstack_id_to_client_callstack_id_.find(
{producer_id, callstack_sample->callstack_id()});
// TODO(b/180235290): replace with error message
ORBIT_CHECK(it != producer_interned_callstack_id_to_client_callstack_id_.end());
callstack_sample->set_callstack_id(it->second);
ClientCaptureEvent event;
event.set_allocated_callstack_sample(callstack_sample);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessCaptureFinishedAndTransferOwnership(
CaptureFinished* capture_finished) {
if (!thread_state_slice_tid_and_begin_timestamp_to_callstack_id_.empty()) {
// We don't expect this to happen because SwitchesNamesStateVisitor always produces a slice from
// the remaining begin tracepoints at the end of the capture.
ORBIT_ERROR(
"Some saved callstacks for thread state slices are left not merged to any slice after the "
"capture finished.");
}
ClientCaptureEvent event;
event.set_allocated_capture_finished(capture_finished);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessCaptureStartedAndTransferOwnership(
CaptureStarted* capture_started) {
ClientCaptureEvent event;
event.set_allocated_capture_started(capture_started);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessClockResolutionEventAndTransferOwnership(
ClockResolutionEvent* clock_resolution_event) {
ClientCaptureEvent event;
event.set_allocated_clock_resolution_event(clock_resolution_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessErrorEnablingOrbitApiEventAndTransferOwnership(
ErrorEnablingOrbitApiEvent* error_enabling_orbit_api_event) {
ClientCaptureEvent event;
event.set_allocated_error_enabling_orbit_api_event(error_enabling_orbit_api_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::
ProcessErrorEnablingUserSpaceInstrumentationEventAndTransferOwnership(
ErrorEnablingUserSpaceInstrumentationEvent* error_event) {
ClientCaptureEvent event;
event.set_allocated_error_enabling_user_space_instrumentation_event(error_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessErrorsWithPerfEventOpenEventAndTransferOwnership(
ErrorsWithPerfEventOpenEvent* errors_with_perf_event_open_event) {
ClientCaptureEvent event;
event.set_allocated_errors_with_perf_event_open_event(errors_with_perf_event_open_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessFullCallstackSample(
FullCallstackSample* full_callstack_sample) {
const Callstack& callstack = full_callstack_sample->callstack();
std::pair<std::vector<uint64_t>, Callstack::CallstackType> callstack_data{
{callstack.pcs().begin(), callstack.pcs().end()}, callstack.type()};
auto [callstack_id, assigned] = callstack_pool_.GetOrAssignId(callstack_data);
if (assigned) {
ClientCaptureEvent interned_callstack_event;
interned_callstack_event.mutable_interned_callstack()->set_key(callstack_id);
interned_callstack_event.mutable_interned_callstack()->set_allocated_intern(
full_callstack_sample->release_callstack());
client_capture_event_collector_->AddEvent(std::move(interned_callstack_event));
}
ClientCaptureEvent callstack_sample_event;
CallstackSample* callstack_sample = callstack_sample_event.mutable_callstack_sample();
callstack_sample->set_pid(full_callstack_sample->pid());
callstack_sample->set_tid(full_callstack_sample->tid());
callstack_sample->set_timestamp_ns(full_callstack_sample->timestamp_ns());
callstack_sample->set_callstack_id(callstack_id);
client_capture_event_collector_->AddEvent(std::move(callstack_sample_event));
}
void ProducerEventProcessorImpl::ProcessFullAddressInfo(FullAddressInfo* full_address_info) {
auto [function_name_key, function_key_assigned] =
string_pool_.GetOrAssignId(full_address_info->function_name());
if (function_key_assigned) {
SendInternedStringEvent(function_name_key, full_address_info->function_name());
}
auto [module_name_key, module_key_assigned] =
string_pool_.GetOrAssignId(full_address_info->module_name());
if (module_key_assigned) {
SendInternedStringEvent(module_name_key, full_address_info->module_name());
}
ClientCaptureEvent event;
AddressInfo* interned_address_info = event.mutable_address_info();
interned_address_info->set_absolute_address(full_address_info->absolute_address());
interned_address_info->set_offset_in_function(full_address_info->offset_in_function());
interned_address_info->set_function_name_key(function_name_key);
interned_address_info->set_module_name_key(module_name_key);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessFullGpuJob(FullGpuJob* full_gpu_job_event) {
auto [timeline_key, assigned] = string_pool_.GetOrAssignId(full_gpu_job_event->timeline());
if (assigned) {
SendInternedStringEvent(timeline_key, full_gpu_job_event->timeline());
}
ClientCaptureEvent event;
GpuJob* gpu_job_event = event.mutable_gpu_job();
gpu_job_event->set_pid(full_gpu_job_event->pid());
gpu_job_event->set_tid(full_gpu_job_event->tid());
gpu_job_event->set_context(full_gpu_job_event->context());
gpu_job_event->set_seqno(full_gpu_job_event->seqno());
gpu_job_event->set_depth(full_gpu_job_event->depth());
gpu_job_event->set_amdgpu_cs_ioctl_time_ns(full_gpu_job_event->amdgpu_cs_ioctl_time_ns());
gpu_job_event->set_amdgpu_sched_run_job_time_ns(
full_gpu_job_event->amdgpu_sched_run_job_time_ns());
gpu_job_event->set_gpu_hardware_start_time_ns(full_gpu_job_event->gpu_hardware_start_time_ns());
gpu_job_event->set_dma_fence_signaled_time_ns(full_gpu_job_event->dma_fence_signaled_time_ns());
gpu_job_event->set_timeline_key(timeline_key);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessFullTracepointEvent(
FullTracepointEvent* full_tracepoint_event) {
auto [tracepoint_key, assigned] =
tracepoint_pool_.GetOrAssignId({full_tracepoint_event->tracepoint_info().category(),
full_tracepoint_event->tracepoint_info().name()});
if (assigned) {
ClientCaptureEvent event;
InternedTracepointInfo* interned_tracepoint_info = event.mutable_interned_tracepoint_info();
interned_tracepoint_info->set_key(tracepoint_key);
interned_tracepoint_info->set_allocated_intern(
full_tracepoint_event->release_tracepoint_info());
client_capture_event_collector_->AddEvent(std::move(event));
}
ClientCaptureEvent event;
TracepointEvent* tracepoint_event = event.mutable_tracepoint_event();
tracepoint_event->set_pid(full_tracepoint_event->pid());
tracepoint_event->set_tid(full_tracepoint_event->tid());
tracepoint_event->set_timestamp_ns(full_tracepoint_event->timestamp_ns());
tracepoint_event->set_cpu(full_tracepoint_event->cpu());
tracepoint_event->set_tracepoint_info_key(tracepoint_key);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessFunctionCallAndTransferOwnership(
FunctionCall* function_call) {
ClientCaptureEvent event;
event.set_allocated_function_call(function_call);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessGpuQueueSubmissionAndTransferOwnership(
uint64_t producer_id, GpuQueueSubmission* gpu_queue_submission) {
// Translate debug marker keys
for (GpuDebugMarker& mutable_marker : *gpu_queue_submission->mutable_completed_markers()) {
auto it = producer_interned_string_id_to_client_string_id_.find(
{producer_id, mutable_marker.text_key()});
ORBIT_CHECK(it != producer_interned_string_id_to_client_string_id_.end());
mutable_marker.set_text_key(it->second);
}
ClientCaptureEvent event;
event.set_allocated_gpu_queue_submission(gpu_queue_submission);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessInternedCallstack(uint64_t producer_id,
InternedCallstack* interned_callstack) {
// TODO(b/180235290): replace with error message
ORBIT_CHECK(!producer_interned_callstack_id_to_client_callstack_id_.contains(
{producer_id, interned_callstack->key()}));
std::pair<std::vector<uint64_t>, Callstack::CallstackType> callstack_data{
{interned_callstack->intern().pcs().begin(), interned_callstack->intern().pcs().end()},
interned_callstack->intern().type()};
auto [interned_callstack_id, assigned] = callstack_pool_.GetOrAssignId(callstack_data);
producer_interned_callstack_id_to_client_callstack_id_.insert_or_assign(
{producer_id, interned_callstack->key()}, interned_callstack_id);
if (!assigned) {
return;
}
// If this is first time we see it -> send it over with client_id
interned_callstack->set_key(interned_callstack_id);
ClientCaptureEvent event;
*event.mutable_interned_callstack() = std::move(*interned_callstack);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessInternedString(uint64_t producer_id,
InternedString* interned_string) {
// TODO(b/180235290): replace with error message
ORBIT_CHECK(!producer_interned_string_id_to_client_string_id_.contains(
{producer_id, interned_string->key()}));
auto [client_string_id, assigned] = string_pool_.GetOrAssignId(interned_string->intern());
producer_interned_string_id_to_client_string_id_.insert_or_assign(
{producer_id, interned_string->key()}, client_string_id);
if (!assigned) {
return;
}
interned_string->set_key(client_string_id);
ClientCaptureEvent event;
*event.mutable_interned_string() = std::move(*interned_string);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessLostPerfRecordsEventAndTransferOwnership(
LostPerfRecordsEvent* lost_perf_records_event) {
ClientCaptureEvent event;
event.set_allocated_lost_perf_records_event(lost_perf_records_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessMemoryUsageEventAndTransferOwnership(
MemoryUsageEvent* memory_usage_event) {
ClientCaptureEvent event;
event.set_allocated_memory_usage_event(memory_usage_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessModulesSnapshotAndTransferOwnership(
ModulesSnapshot* modules_snapshot) {
ClientCaptureEvent event;
event.set_allocated_modules_snapshot(modules_snapshot);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessModuleUpdateEventAndTransferOwnership(
orbit_grpc_protos::ModuleUpdateEvent* module_update_event) {
ClientCaptureEvent event;
event.set_allocated_module_update_event(module_update_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessOutOfOrderEventsDiscardedEventAndTransferOwnership(
OutOfOrderEventsDiscardedEvent* out_of_order_events_discarded_event) {
ClientCaptureEvent event;
event.set_allocated_out_of_order_events_discarded_event(out_of_order_events_discarded_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessPresentEventAndTransferOwnership(
PresentEvent* present_event) {
ClientCaptureEvent event;
event.set_allocated_present_event(present_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessSchedulingSliceAndTransferOwnership(
SchedulingSlice* scheduling_slice) {
ClientCaptureEvent event;
event.set_allocated_scheduling_slice(scheduling_slice);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessThreadNameAndTransferOwnership(ThreadName* thread_name) {
ClientCaptureEvent event;
event.set_allocated_thread_name(thread_name);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessThreadNamesSnapshotAndTransferOwnership(
ThreadNamesSnapshot* thread_names_snapshot) {
ClientCaptureEvent event;
event.set_allocated_thread_names_snapshot(thread_names_snapshot);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessThreadStateSliceAndTransferOwnership(
ThreadStateSlice* thread_state_slice) {
ORBIT_CHECK(thread_state_slice->switch_out_or_wakeup_callstack_status() !=
ThreadStateSlice::kCallstackSet);
if (thread_state_slice->switch_out_or_wakeup_callstack_status() ==
ThreadStateSlice::kNoCallstack) {
ClientCaptureEvent event;
event.set_allocated_thread_state_slice(thread_state_slice);
client_capture_event_collector_->AddEvent(std::move(event));
return;
}
MergeThreadStateSliceWithCallstackAndTransferOwnership(thread_state_slice);
}
void ProducerEventProcessorImpl::ProcessWarningEventAndTransferOwnership(
WarningEvent* warning_event) {
ClientCaptureEvent event;
event.set_allocated_warning_event(warning_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessWarningInstrumentingWithUprobesEventAndTransferOwnership(
WarningInstrumentingWithUprobesEvent* warning_event) {
ClientCaptureEvent event;
event.set_allocated_warning_instrumenting_with_uprobes_event(warning_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessThreadStateSliceCallstack(
ThreadStateSliceCallstack* thread_state_slice_callstack) {
const Callstack& callstack = thread_state_slice_callstack->callstack();
std::pair<std::vector<uint64_t>, Callstack::CallstackType> callstack_data{
{callstack.pcs().begin(), callstack.pcs().end()}, callstack.type()};
auto [callstack_id, assigned] = callstack_pool_.GetOrAssignId(callstack_data);
if (assigned) {
ClientCaptureEvent interned_callstack_event;
interned_callstack_event.mutable_interned_callstack()->set_key(callstack_id);
interned_callstack_event.mutable_interned_callstack()->set_allocated_intern(
thread_state_slice_callstack->release_callstack());
client_capture_event_collector_->AddEvent(std::move(interned_callstack_event));
}
// We are sending the callstack right away (if necessary) and only keep the callstack id to attach
// it to the matching thread state slice.
thread_state_slice_tid_and_begin_timestamp_to_callstack_id_[{
thread_state_slice_callstack->thread_state_slice_tid(),
thread_state_slice_callstack->timestamp_ns()}] = callstack_id;
}
void ProducerEventProcessorImpl::
ProcessWarningInstrumentingWithUserSpaceInstrumentationEventAndTransferOwnership(
WarningInstrumentingWithUserSpaceInstrumentationEvent* warning_event) {
ClientCaptureEvent event;
event.set_allocated_warning_instrumenting_with_user_space_instrumentation_event(warning_event);
client_capture_event_collector_->AddEvent(std::move(event));
}
void ProducerEventProcessorImpl::ProcessEvent(uint64_t producer_id, ProducerCaptureEvent&& event) {
// Please keep the cases alphabetically ordered, as in the definition of the ProducerCaptureEvent
// message.
switch (event.event_case()) {
case ProducerCaptureEvent::kApiScopeStart:
ProcessApiScopeStartAndTransferOwnership(event.release_api_scope_start());
break;
case ProducerCaptureEvent::kApiScopeStartAsync:
ProcessApiScopeStartAsyncAndTransferOwnership(event.release_api_scope_start_async());
break;
case ProducerCaptureEvent::kApiScopeStop:
ProcessApiScopeStopAndTransferOwnership(event.release_api_scope_stop());
break;
case ProducerCaptureEvent::kApiScopeStopAsync:
ProcessApiScopeStopAsyncAndTransferOwnership(event.release_api_scope_stop_async());
break;
case ProducerCaptureEvent::kApiStringEvent:
ProcessApiStringEventAndTransferOwnership(event.release_api_string_event());
break;
case ProducerCaptureEvent::kApiTrackDouble:
ProcessApiTrackDoubleAndTransferOwnership(event.release_api_track_double());
break;
case ProducerCaptureEvent::kApiTrackFloat:
ProcessApiTrackFloatAndTransferOwnership(event.release_api_track_float());
break;
case ProducerCaptureEvent::kApiTrackInt:
ProcessApiTrackIntAndTransferOwnership(event.release_api_track_int());
break;
case ProducerCaptureEvent::kApiTrackInt64:
ProcessApiTrackInt64AndTransferOwnership(event.release_api_track_int64());
break;
case ProducerCaptureEvent::kApiTrackUint:
ProcessApiTrackUintAndTransferOwnership(event.release_api_track_uint());
break;
case ProducerCaptureEvent::kApiTrackUint64:
ProcessApiTrackUint64AndTransferOwnership(event.release_api_track_uint64());
break;
case ProducerCaptureEvent::kCallstackSample:
ProcessCallstackSampleAndTransferOwnership(producer_id, event.release_callstack_sample());
break;
case ProducerCaptureEvent::kCaptureFinished:
ProcessCaptureFinishedAndTransferOwnership(event.release_capture_finished());
break;
case ProducerCaptureEvent::kCaptureStarted:
ProcessCaptureStartedAndTransferOwnership(event.release_capture_started());
break;
case ProducerCaptureEvent::kClockResolutionEvent:
ProcessClockResolutionEventAndTransferOwnership(event.release_clock_resolution_event());
break;
case ProducerCaptureEvent::kErrorEnablingOrbitApiEvent:
ProcessErrorEnablingOrbitApiEventAndTransferOwnership(
event.release_error_enabling_orbit_api_event());
break;
case ProducerCaptureEvent::kErrorEnablingUserSpaceInstrumentationEvent:
ProcessErrorEnablingUserSpaceInstrumentationEventAndTransferOwnership(
event.release_error_enabling_user_space_instrumentation_event());
break;
case ProducerCaptureEvent::kErrorsWithPerfEventOpenEvent:
ProcessErrorsWithPerfEventOpenEventAndTransferOwnership(
event.release_errors_with_perf_event_open_event());
break;
case ProducerCaptureEvent::kFullCallstackSample:
ProcessFullCallstackSample(event.mutable_full_callstack_sample());
break;
case ProducerCaptureEvent::kFullAddressInfo:
ProcessFullAddressInfo(event.mutable_full_address_info());
break;
case ProducerCaptureEvent::kFullGpuJob:
ProcessFullGpuJob(event.mutable_full_gpu_job());
break;
case ProducerCaptureEvent::kFullTracepointEvent:
ProcessFullTracepointEvent(event.mutable_full_tracepoint_event());
break;
case ProducerCaptureEvent::kFunctionCall:
ProcessFunctionCallAndTransferOwnership(event.release_function_call());
break;
case ProducerCaptureEvent::kFunctionEntry:
ORBIT_UNREACHABLE();
case ProducerCaptureEvent::kFunctionExit:
ORBIT_UNREACHABLE();
case ProducerCaptureEvent::kGpuQueueSubmission:
ProcessGpuQueueSubmissionAndTransferOwnership(producer_id,
event.release_gpu_queue_submission());
break;
case ProducerCaptureEvent::kInternedCallstack:
ProcessInternedCallstack(producer_id, event.mutable_interned_callstack());
break;
case ProducerCaptureEvent::kInternedString:
ProcessInternedString(producer_id, event.mutable_interned_string());
break;
case ProducerCaptureEvent::kLostPerfRecordsEvent:
ProcessLostPerfRecordsEventAndTransferOwnership(event.release_lost_perf_records_event());
break;
case ProducerCaptureEvent::kMemoryUsageEvent:
ProcessMemoryUsageEventAndTransferOwnership(event.release_memory_usage_event());
break;
case ProducerCaptureEvent::kModulesSnapshot:
ProcessModulesSnapshotAndTransferOwnership(event.release_modules_snapshot());
break;
case ProducerCaptureEvent::kModuleUpdateEvent:
ProcessModuleUpdateEventAndTransferOwnership(event.release_module_update_event());
break;
case ProducerCaptureEvent::kOutOfOrderEventsDiscardedEvent:
ProcessOutOfOrderEventsDiscardedEventAndTransferOwnership(
event.release_out_of_order_events_discarded_event());
break;
case ProducerCaptureEvent::kPresentEvent:
ProcessPresentEventAndTransferOwnership(event.release_present_event());
break;
case ProducerCaptureEvent::kSchedulingSlice:
ProcessSchedulingSliceAndTransferOwnership(event.release_scheduling_slice());
break;
case ProducerCaptureEvent::kThreadName:
ProcessThreadNameAndTransferOwnership(event.release_thread_name());
break;
case ProducerCaptureEvent::kThreadNamesSnapshot:
ProcessThreadNamesSnapshotAndTransferOwnership(event.release_thread_names_snapshot());
break;
case ProducerCaptureEvent::kThreadStateSlice:
ProcessThreadStateSliceAndTransferOwnership(event.release_thread_state_slice());
break;
case ProducerCaptureEvent::kThreadStateSliceCallstack:
ProcessThreadStateSliceCallstack(event.mutable_thread_state_slice_callstack());
break;
case ProducerCaptureEvent::kWarningEvent:
ProcessWarningEventAndTransferOwnership(event.release_warning_event());
break;
case ProducerCaptureEvent::kWarningInstrumentingWithUprobesEvent:
ProcessWarningInstrumentingWithUprobesEventAndTransferOwnership(
event.release_warning_instrumenting_with_uprobes_event());
break;
case ProducerCaptureEvent::kWarningInstrumentingWithUserSpaceInstrumentationEvent:
ProcessWarningInstrumentingWithUserSpaceInstrumentationEventAndTransferOwnership(
event.release_warning_instrumenting_with_user_space_instrumentation_event());
break;
case ProducerCaptureEvent::EVENT_NOT_SET:
ORBIT_UNREACHABLE();
}
}
void ProducerEventProcessorImpl::SendInternedStringEvent(uint64_t key, std::string value) {
ClientCaptureEvent event;
InternedString* interned_string = event.mutable_interned_string();
interned_string->set_key(key);
interned_string->set_intern(std::move(value));
client_capture_event_collector_->AddEvent(std::move(event));
}
} // namespace
std::unique_ptr<ProducerEventProcessor> ProducerEventProcessor::Create(
ClientCaptureEventCollector* client_capture_event_collector) {
return std::make_unique<ProducerEventProcessorImpl>(client_capture_event_collector);
}
} // namespace orbit_producer_event_processor