-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
ep.c
1723 lines (1393 loc) · 47 KB
/
ep.c
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
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "ep-rt-config.h"
#ifdef ENABLE_PERFTRACING
#if !defined(EP_INCLUDE_SOURCE_FILES) || defined(EP_FORCE_INCLUDE_SOURCE_FILES)
#define EP_IMPL_EP_GETTER_SETTER
#include "ep.h"
#include "ep-config.h"
#include "ep-config-internals.h"
#include "ep-event.h"
#include "ep-event-payload.h"
#include "ep-event-source.h"
#include "ep-provider.h"
#include "ep-provider-internals.h"
#include "ep-session.h"
#include "ep-sample-profiler.h"
//! This is CoreCLR specific keywords for native ETW events (ending up in event pipe).
//! The keywords below seems to correspond to:
//! GCKeyword (0x00000001)
//! LoaderKeyword (0x00000008)
//! JitKeyword (0x00000010)
//! NgenKeyword (0x00000020)
//! unused_keyword (0x00000100)
//! JittedMethodILToNativeMapKeyword (0x00020000)
//! ThreadTransferKeyword (0x80000000)
uint64_t ep_default_rundown_keyword = 0x80020139;
static bool _ep_can_start_threads = false;
static dn_vector_t *_ep_deferred_enable_session_ids = NULL;
static dn_vector_t *_ep_deferred_disable_session_ids = NULL;
static EventPipeIpcStreamFactorySuspendedPortsCallback _ep_ipc_stream_factory_suspended_ports_callback = NULL;
static dn_vector_ptr_t *_ep_rundown_execution_checkpoints = NULL;
/*
* Forward declares of all static functions.
*/
// _Requires_lock_held (ep)
static
bool
enabled (void);
// _Requires_lock_held (ep)
static
uint32_t
generate_session_index (void);
// _Requires_lock_held (ep)
static
bool
is_session_id_in_collection (EventPipeSessionID id);
// _Requires_lock_held (ep)
static
EventPipeSessionID
enable (
const EventPipeSessionOptions *options,
EventPipeProviderCallbackDataQueue *provider_callback_data_queue);
static
void
log_process_info_event (EventPipeEventSource *event_source);
// _Requires_lock_held (ep)
static
void
disable_holding_lock (
EventPipeSessionID id,
EventPipeProviderCallbackDataQueue *provider_callback_data_queue);
static
void
disable_helper (EventPipeSessionID id);
static
void
write_event (
EventPipeEvent *ep_event,
EventPipeEventPayload *payload,
const uint8_t *activity_id,
const uint8_t *related_activity_id);
static
void
write_event_2 (
ep_rt_thread_handle_t thread,
EventPipeEvent *ep_event,
EventPipeEventPayload *payload,
const uint8_t *activity_id,
const uint8_t *related_activity_id,
ep_rt_thread_handle_t event_thread,
EventPipeStackContents *stack);
static
const ep_char8_t *
get_next_config_value (const ep_char8_t *data, const ep_char8_t **start, const ep_char8_t **end);
static
ep_char8_t *
get_next_config_value_as_utf8_string (const ep_char8_t **data);
static
uint64_t
get_next_config_value_as_uint64_t (const ep_char8_t **data);
static
uint32_t
get_next_config_value_as_uint32_t (const ep_char8_t **data);
static
void
enable_default_session_via_env_variables (void);
static
bool
session_requested_sampling (EventPipeSession *session);
static
bool
ipc_stream_factory_any_suspended_ports (void);
static
bool
check_options_valid (const EventPipeSessionOptions *options);
/*
* Global volatile variables, only to be accessed through inlined volatile access functions.
*/
volatile EventPipeState _ep_state = EP_STATE_NOT_INITIALIZED;
volatile uint32_t _ep_number_of_sessions = 0;
volatile EventPipeSession *_ep_sessions [EP_MAX_NUMBER_OF_SESSIONS] = { 0 };
volatile uint64_t _ep_allow_write = 0;
/*
* EventFilterDescriptor.
*/
EventFilterDescriptor *
ep_event_filter_desc_alloc (
uint64_t ptr,
uint32_t size,
uint32_t type)
{
EventFilterDescriptor *instance = ep_rt_object_alloc (EventFilterDescriptor);
ep_raise_error_if_nok (instance != NULL);
ep_raise_error_if_nok (ep_event_filter_desc_init (instance, ptr, size, type) != NULL);
ep_on_exit:
return instance;
ep_on_error:
ep_event_filter_desc_free (instance);
instance = NULL;
ep_exit_error_handler ();
}
EventFilterDescriptor *
ep_event_filter_desc_init (
EventFilterDescriptor *event_filter_desc,
uint64_t ptr,
uint32_t size,
uint32_t type)
{
EP_ASSERT (event_filter_desc != NULL);
event_filter_desc->ptr = ptr;
event_filter_desc->size = size;
event_filter_desc->type = type;
return event_filter_desc;
}
void
ep_event_filter_desc_fini (EventFilterDescriptor * filter_desc)
{
;
}
void
ep_event_filter_desc_free (EventFilterDescriptor * filter_desc)
{
ep_return_void_if_nok (filter_desc != NULL);
ep_event_filter_desc_fini (filter_desc);
ep_rt_object_free (filter_desc);
}
/*
* EventPipeProviderCallbackDataQueue.
*/
EventPipeProviderCallbackDataQueue *
ep_provider_callback_data_queue_init (EventPipeProviderCallbackDataQueue *provider_callback_data_queue)
{
EP_ASSERT (provider_callback_data_queue != NULL);
provider_callback_data_queue->queue = dn_queue_alloc ();
return provider_callback_data_queue->queue ? provider_callback_data_queue : NULL;
}
void
ep_provider_callback_data_queue_fini (EventPipeProviderCallbackDataQueue *provider_callback_data_queue)
{
ep_return_void_if_nok (provider_callback_data_queue != NULL);
dn_queue_free (provider_callback_data_queue->queue);
provider_callback_data_queue->queue = NULL;
}
/*
* EventPipeProviderCallbackData.
*/
EventPipeProviderCallbackData *
ep_provider_callback_data_alloc (
const ep_char8_t *filter_data,
EventPipeCallback callback_function,
void *callback_data,
int64_t keywords,
EventPipeEventLevel provider_level,
bool enabled,
EventPipeSessionID session_id)
{
EventPipeProviderCallbackData *instance = ep_rt_object_alloc (EventPipeProviderCallbackData);
ep_raise_error_if_nok (instance != NULL);
ep_raise_error_if_nok (ep_provider_callback_data_init (
instance,
filter_data,
callback_function,
callback_data,
keywords,
provider_level,
enabled,
session_id) != NULL);
ep_on_exit:
return instance;
ep_on_error:
ep_provider_callback_data_free (instance);
instance = NULL;
ep_exit_error_handler ();
}
EventPipeProviderCallbackData *
ep_provider_callback_data_alloc_copy (EventPipeProviderCallbackData *provider_callback_data_src)
{
EventPipeProviderCallbackData *instance = ep_rt_object_alloc (EventPipeProviderCallbackData);
ep_raise_error_if_nok (instance != NULL);
if (provider_callback_data_src) {
*instance = *provider_callback_data_src;
instance->filter_data = ep_rt_utf8_string_dup (provider_callback_data_src->filter_data);
}
ep_on_exit:
return instance;
ep_on_error:
ep_provider_callback_data_free (instance);
instance = NULL;
ep_exit_error_handler ();
}
EventPipeProviderCallbackData *
ep_provider_callback_data_alloc_move (EventPipeProviderCallbackData *provider_callback_data_src)
{
EventPipeProviderCallbackData *instance = ep_rt_object_alloc (EventPipeProviderCallbackData);
ep_raise_error_if_nok (instance != NULL);
if (provider_callback_data_src) {
*instance = *provider_callback_data_src;
memset (provider_callback_data_src, 0, sizeof (*provider_callback_data_src));
}
ep_on_exit:
return instance;
ep_on_error:
ep_provider_callback_data_free (instance);
instance = NULL;
ep_exit_error_handler ();
}
EventPipeProviderCallbackData *
ep_provider_callback_data_init (
EventPipeProviderCallbackData *provider_callback_data,
const ep_char8_t *filter_data,
EventPipeCallback callback_function,
void *callback_data,
int64_t keywords,
EventPipeEventLevel provider_level,
bool enabled,
EventPipeSessionID session_id)
{
EP_ASSERT (provider_callback_data != NULL);
provider_callback_data->filter_data = ep_rt_utf8_string_dup (filter_data);
provider_callback_data->callback_function = callback_function;
provider_callback_data->callback_data = callback_data;
provider_callback_data->keywords = keywords;
provider_callback_data->provider_level = provider_level;
provider_callback_data->enabled = enabled;
provider_callback_data->session_id = session_id;
return provider_callback_data;
}
EventPipeProviderCallbackData *
ep_provider_callback_data_init_copy (
EventPipeProviderCallbackData *provider_callback_data_dst,
EventPipeProviderCallbackData *provider_callback_data_src)
{
EP_ASSERT (provider_callback_data_dst != NULL);
EP_ASSERT (provider_callback_data_src != NULL);
*provider_callback_data_dst = *provider_callback_data_src;
provider_callback_data_dst->filter_data = ep_rt_utf8_string_dup (provider_callback_data_src->filter_data);
return provider_callback_data_dst;
}
EventPipeProviderCallbackData *
ep_provider_callback_data_init_move (
EventPipeProviderCallbackData *provider_callback_data_dst,
EventPipeProviderCallbackData *provider_callback_data_src)
{
EP_ASSERT (provider_callback_data_dst != NULL);
EP_ASSERT (provider_callback_data_src != NULL);
*provider_callback_data_dst = *provider_callback_data_src;
memset (provider_callback_data_src, 0, sizeof (*provider_callback_data_src));
return provider_callback_data_dst;
}
void
ep_provider_callback_data_fini (EventPipeProviderCallbackData *provider_callback_data)
{
ep_return_void_if_nok (provider_callback_data != NULL);
ep_rt_utf8_string_free (provider_callback_data->filter_data);
}
void
ep_provider_callback_data_free (EventPipeProviderCallbackData *provider_callback_data)
{
ep_return_void_if_nok (provider_callback_data != NULL);
ep_provider_callback_data_fini (provider_callback_data);
ep_rt_object_free (provider_callback_data);
}
/*
* EventPipeProviderConfiguration.
*/
EventPipeProviderConfiguration *
ep_provider_config_init (
EventPipeProviderConfiguration *provider_config,
const ep_char8_t *provider_name,
uint64_t keywords,
EventPipeEventLevel logging_level,
const ep_char8_t *filter_data)
{
EP_ASSERT (provider_config != NULL);
EP_ASSERT (provider_name != NULL);
provider_config->provider_name = provider_name;
provider_config->keywords = keywords;
provider_config->logging_level = logging_level;
provider_config->filter_data = filter_data;
// Runtime specific rundown provider configuration.
ep_rt_provider_config_init (provider_config);
return provider_config;
}
void
ep_provider_config_fini (EventPipeProviderConfiguration *provider_config)
{
;
}
/*
* EventPipeExecutionCheckpoint.
*/
EventPipeExecutionCheckpoint *
ep_execution_checkpoint_alloc (
const ep_char8_t *name,
ep_timestamp_t timestamp)
{
EventPipeExecutionCheckpoint *instance = ep_rt_object_alloc (EventPipeExecutionCheckpoint);
ep_raise_error_if_nok (instance != NULL);
instance->name = name ? ep_rt_utf8_string_dup (name) : NULL;
instance->timestamp = timestamp;
ep_on_exit:
return instance;
ep_on_error:
ep_execution_checkpoint_free (instance);
instance = NULL;
ep_exit_error_handler ();
}
void
ep_execution_checkpoint_free (EventPipeExecutionCheckpoint *execution_checkpoint)
{
ep_return_void_if_nok (execution_checkpoint != NULL);
ep_rt_object_free (execution_checkpoint);
}
/*
* EventPipe.
*/
static
bool
enabled (void)
{
ep_requires_lock_held ();
return (ep_volatile_load_eventpipe_state_without_barrier () >= EP_STATE_INITIALIZED &&
ep_volatile_load_number_of_sessions_without_barrier () > 0);
}
static
uint32_t
generate_session_index (void)
{
ep_requires_lock_held ();
for (uint32_t i = 0; i < EP_MAX_NUMBER_OF_SESSIONS; ++i)
if (ep_volatile_load_session_without_barrier (i) == NULL)
return i;
return EP_MAX_NUMBER_OF_SESSIONS;
}
static
bool
is_session_id_in_collection (EventPipeSessionID session_id)
{
EP_ASSERT (session_id != 0);
ep_requires_lock_held ();
const EventPipeSession *const session = (EventPipeSession *)(uintptr_t)session_id;
for (uint32_t i = 0; i < EP_MAX_NUMBER_OF_SESSIONS; ++i) {
if (ep_volatile_load_session (i) == session) {
EP_ASSERT (i == ep_session_get_index (session));
return true;
}
}
return false;
}
static bool check_options_valid (const EventPipeSessionOptions *options)
{
if (options->format >= EP_SERIALIZATION_FORMAT_COUNT)
return false;
if (options->circular_buffer_size_in_mb <= 0 && options->session_type != EP_SESSION_TYPE_SYNCHRONOUS)
return false;
if (options->providers == NULL || options->providers_len <= 0)
return false;
if ((options->session_type == EP_SESSION_TYPE_FILE || options->session_type == EP_SESSION_TYPE_FILESTREAM) && options->output_path == NULL)
return false;
if (options->session_type == EP_SESSION_TYPE_IPCSTREAM && options->stream == NULL)
return false;
return true;
}
static
EventPipeSessionID
enable (
const EventPipeSessionOptions *options,
EventPipeProviderCallbackDataQueue *provider_callback_data_queue)
{
ep_requires_lock_held ();
EP_ASSERT (options != NULL);
EP_ASSERT (options->format < EP_SERIALIZATION_FORMAT_COUNT);
EP_ASSERT (options->session_type == EP_SESSION_TYPE_SYNCHRONOUS || options->circular_buffer_size_in_mb > 0);
EP_ASSERT (options->providers_len > 0 && options->providers != NULL);
EventPipeSession *session = NULL;
EventPipeSessionID session_id = 0;
uint32_t session_index = 0;
ep_raise_error_if_nok (ep_volatile_load_eventpipe_state () == EP_STATE_INITIALIZED);
session_index = generate_session_index ();
ep_raise_error_if_nok (session_index < EP_MAX_NUMBER_OF_SESSIONS);
session = ep_session_alloc (
session_index,
options->output_path,
options->stream,
options->session_type,
options->format,
options->rundown_keyword,
options->stackwalk_requested,
options->circular_buffer_size_in_mb,
options->providers,
options->providers_len,
options->sync_callback,
options->callback_additional_data);
ep_raise_error_if_nok (session != NULL && ep_session_is_valid (session));
session_id = (EventPipeSessionID)session;
// Return if the index is invalid.
if (ep_session_get_index (session) >= EP_MAX_NUMBER_OF_SESSIONS) {
EP_ASSERT (!"Session index was out of range.");
ep_raise_error ();
}
if (ep_volatile_load_number_of_sessions () >= EP_MAX_NUMBER_OF_SESSIONS) {
EP_ASSERT (!"max number of sessions reached.");
ep_raise_error ();
}
// Register the SampleProfiler the very first time (if supported).
ep_sample_profiler_init (provider_callback_data_queue);
// Enable the EventPipe EventSource.
ep_raise_error_if_nok (ep_event_source_enable (ep_event_source_get (), session));
// Save the session.
if (ep_volatile_load_session_without_barrier (ep_session_get_index (session)) != NULL) {
EP_ASSERT (!"Attempting to override an existing session.");
ep_raise_error ();
}
ep_volatile_store_session (ep_session_get_index (session), session);
ep_volatile_store_allow_write (ep_volatile_load_allow_write () | ep_session_get_mask (session));
ep_volatile_store_number_of_sessions (ep_volatile_load_number_of_sessions () + 1);
// Enable tracing.
config_enable_disable (ep_config_get (), session, provider_callback_data_queue, true);
if (session_requested_sampling (session))
ep_sample_profiler_enable ();
ep_on_exit:
ep_requires_lock_held ();
return session_id;
ep_on_error:
ep_session_free (session);
session_id = 0;
ep_exit_error_handler ();
}
static
void
log_process_info_event (EventPipeEventSource *event_source)
{
// Get the managed command line.
const ep_char8_t *cmd_line = ep_rt_diagnostics_command_line_get ();
// Log the process information event.
ep_event_source_send_process_info (event_source, cmd_line);
}
static
void
disable_holding_lock (
EventPipeSessionID id,
EventPipeProviderCallbackDataQueue *provider_callback_data_queue)
{
EP_ASSERT (id != 0);
EP_ASSERT (ep_volatile_load_number_of_sessions () > 0);
ep_requires_lock_held ();
if (is_session_id_in_collection (id)) {
EventPipeSession *const session = (EventPipeSession *)(uintptr_t)id;
if (session_requested_sampling (session)) {
// Disable the profiler.
ep_sample_profiler_disable ();
}
// Log the process information event.
log_process_info_event (ep_event_source_get ());
// Disable session tracing.
config_enable_disable (ep_config_get (), session, provider_callback_data_queue, false);
ep_session_disable (session); // WriteAllBuffersToFile, and remove providers.
// Do rundown before fully stopping the session unless rundown wasn't requested
if ((ep_session_get_rundown_keyword (session) != 0) && _ep_can_start_threads) {
ep_session_enable_rundown (session); // Set Rundown provider.
EventPipeThread *const thread = ep_thread_get_or_create ();
if (thread != NULL) {
ep_thread_set_as_rundown_thread (thread, session);
{
config_enable_disable (ep_config_get (), session, provider_callback_data_queue, true);
{
ep_session_execute_rundown (session, _ep_rundown_execution_checkpoints);
}
config_enable_disable(ep_config_get (), session, provider_callback_data_queue, false);
}
ep_thread_set_as_rundown_thread (thread, NULL);
} else {
EP_ASSERT (!"Failed to get or create the EventPipeThread for rundown events.");
}
}
ep_volatile_store_allow_write (ep_volatile_load_allow_write () & ~(ep_session_get_mask (session)));
// Remove the session from the array before calling ep_session_suspend_write_event. This way
// we can guarantee that either the event write got the pointer and will complete
// the write successfully, or it gets NULL and will bail.
EP_ASSERT (ep_volatile_load_session (ep_session_get_index (session)) == session);
ep_volatile_store_session (ep_session_get_index (session), NULL);
ep_session_suspend_write_event (session);
bool ignored;
ep_session_write_all_buffers_to_file (session, &ignored); // Flush the buffers to the stream/file
ep_volatile_store_number_of_sessions (ep_volatile_load_number_of_sessions () - 1);
// Write a final sequence point to the file now that all events have
// been emitted.
ep_session_write_sequence_point_unbuffered (session);
ep_session_free (session);
// Providers can't be deleted during tracing because they may be needed when serializing the file.
config_delete_deferred_providers(ep_config_get ());
}
ep_requires_lock_held ();
return;
}
static
void
disable_helper (EventPipeSessionID id)
{
ep_requires_lock_not_held ();
if (_ep_can_start_threads)
ep_rt_thread_setup ();
if (id == 0)
return;
// Don't block GC during clean-up.
EP_GCX_PREEMP_ENTER
EventPipeProviderCallbackDataQueue callback_data_queue;
EventPipeProviderCallbackData provider_callback_data;
EventPipeProviderCallbackDataQueue *provider_callback_data_queue = ep_provider_callback_data_queue_init (&callback_data_queue);
EP_LOCK_ENTER (section1)
if (ep_volatile_load_number_of_sessions () > 0)
disable_holding_lock (id, provider_callback_data_queue);
EP_LOCK_EXIT (section1)
while (ep_provider_callback_data_queue_try_dequeue (provider_callback_data_queue, &provider_callback_data)) {
ep_rt_prepare_provider_invoke_callback (&provider_callback_data);
provider_invoke_callback (&provider_callback_data);
ep_provider_callback_data_fini (&provider_callback_data);
}
ep_provider_callback_data_queue_fini (provider_callback_data_queue);
#ifdef EP_CHECKED_BUILD
if (ep_volatile_load_number_of_sessions () == 0 && ep_volatile_load_eventpipe_state () != EP_STATE_SHUTTING_DOWN)
EP_ASSERT (ep_rt_providers_validate_all_disabled ());
#endif
EP_GCX_PREEMP_EXIT
ep_on_exit:
ep_requires_lock_not_held ();
return;
ep_on_error:
ep_exit_error_handler ();
}
static
void
write_event (
EventPipeEvent *ep_event,
EventPipeEventPayload *payload,
const uint8_t *activity_id,
const uint8_t *related_activity_id)
{
EP_ASSERT (ep_event != NULL);
EP_ASSERT (payload != NULL);
// We can't proceed if tracing is not initialized.
ep_return_void_if_nok (ep_volatile_load_eventpipe_state () >= EP_STATE_INITIALIZED);
// Exit early if the event is not enabled.
ep_return_void_if_nok (ep_event_is_enabled (ep_event));
// Get current thread.
ep_rt_thread_handle_t thread = ep_rt_thread_get_handle ();
// If the activity id isn't specified AND we are in a eventpipe thread, pull it from the current thread.
// If pThread is NULL (we aren't in writing from a managed thread) then activity_id can be NULL
if (activity_id == NULL && thread != NULL)
activity_id = ep_thread_get_activity_id_cref (ep_thread_get_activity_id_handle ());
write_event_2 (
thread,
ep_event,
payload,
activity_id,
related_activity_id,
NULL,
NULL);
}
static
void
write_event_2 (
ep_rt_thread_handle_t thread,
EventPipeEvent *ep_event,
EventPipeEventPayload *payload,
const uint8_t *activity_id,
const uint8_t *related_activity_id,
ep_rt_thread_handle_t event_thread,
EventPipeStackContents *stack)
{
EP_ASSERT (ep_event != NULL);
EP_ASSERT (payload != NULL);
// We can't proceed if tracing is not initialized.
ep_return_void_if_nok (ep_volatile_load_eventpipe_state () >= EP_STATE_INITIALIZED);
EventPipeThread *const current_thread = ep_thread_get_or_create ();
if (!current_thread) {
EP_ASSERT (!"Failed to get or create an EventPipeThread.");
return;
}
if (ep_thread_is_rundown_thread (current_thread)) {
EventPipeSession *const rundown_session = ep_thread_get_rundown_session (current_thread);
EP_ASSERT (rundown_session != NULL);
EP_ASSERT (thread != NULL);
uint8_t *data = ep_event_payload_get_flat_data (payload);
if (thread != NULL && rundown_session != NULL && data != NULL) {
ep_session_write_event (
rundown_session,
thread,
ep_event,
payload,
activity_id,
related_activity_id,
event_thread,
stack);
}
} else {
for (uint32_t i = 0; i < EP_MAX_NUMBER_OF_SESSIONS; ++i) {
if ((ep_volatile_load_allow_write () & ((uint64_t)1 << i)) == 0)
continue;
// Now that we know this session is probably live we pay the perf cost of the memory barriers
// Setting this flag lets a thread trying to do a concurrent disable that it is not safe to delete
// session ID i. The if check above also ensures that once the session is unpublished this thread
// will eventually stop ever storing ID i into the WriteInProgress flag. This is important to
// guarantee termination of the YIELD_WHILE loop in SuspendWriteEvents.
ep_thread_set_session_write_in_progress (current_thread, i);
{
EventPipeSession *const session = ep_volatile_load_session (i);
// Disable is allowed to set s_pSessions[i] = NULL at any time and that may have occurred in between
// the check and the load
if (session != NULL) {
ep_session_write_event (
session,
thread,
ep_event,
payload,
activity_id,
related_activity_id,
event_thread,
stack);
}
}
// Do not reference session past this point, we are signaling Disable() that it is safe to
// delete it
ep_thread_set_session_write_in_progress (current_thread, UINT32_MAX);
}
}
}
static
const ep_char8_t *
get_next_config_value (const ep_char8_t *data, const ep_char8_t **start, const ep_char8_t **end)
{
EP_ASSERT (data != NULL);
EP_ASSERT (start != NULL);
EP_ASSERT (end != NULL);
*start = data;
while (*data != '\0' && *data != ',' && *data != ':')
data++;
*end = data;
if (*data == '\0')
return NULL;
else if (*data == ',')
return data;
else
return ++data;
}
static
ep_char8_t *
get_next_config_value_as_utf8_string (const ep_char8_t **data)
{
EP_ASSERT (data != NULL);
ep_char8_t *buffer = NULL;
const ep_char8_t *start = NULL;
const ep_char8_t *end = NULL;
*data = get_next_config_value (*data, &start, &end);
ptrdiff_t byte_len = end - start;
if (byte_len != 0)
buffer = ep_rt_utf8_string_dup_range(start, end);
return buffer;
}
static
uint64_t
get_next_config_value_as_uint64_t (const ep_char8_t **data)
{
EP_ASSERT (data != NULL);
ep_char8_t *value_as_utf8 = get_next_config_value_as_utf8_string (data);
uint64_t value = UINT64_MAX;
if (value_as_utf8) {
value = (uint64_t)strtoull (value_as_utf8, NULL, 16);
ep_rt_utf8_string_free (value_as_utf8);
}
return value;
}
static
uint32_t
get_next_config_value_as_uint32_t (const ep_char8_t **data)
{
EP_ASSERT (data != NULL);
ep_char8_t *value_as_utf8 = get_next_config_value_as_utf8_string (data);
uint32_t value = UINT32_MAX;
if (value_as_utf8) {
value = (uint32_t)strtoul (value_as_utf8, NULL, 10);
ep_rt_utf8_string_free (value_as_utf8);
}
return value;
}
//
// If EventPipe environment variables are specified, parse them and start a session.
//
static
void
enable_default_session_via_env_variables (void)
{
ep_char8_t *ep_config = NULL;
ep_char8_t *ep_config_output_path = NULL;
uint32_t ep_circular_mb = 0;
const ep_char8_t *output_path = NULL;
if (ep_rt_config_value_get_enable ()) {
ep_config = ep_rt_config_value_get_config ();
ep_config_output_path = ep_rt_config_value_get_output_path ();
ep_char8_t pidStr[24];
ep_rt_utf8_string_snprintf(pidStr, ARRAY_SIZE (pidStr), "%u", (unsigned)ep_rt_current_process_get_id());
while (true)
{
if (ep_rt_utf8_string_replace(&ep_config_output_path, "{pid}", pidStr))
{
// In case there is a second use of {pid} in the output path
continue;
}
// No more instances of {pid} in the OutputPath
break;
}
ep_circular_mb = ep_rt_config_value_get_circular_mb ();
output_path = NULL;
output_path = ep_config_output_path ? ep_config_output_path : "trace.nettrace";
ep_circular_mb = ep_circular_mb > 0 ? ep_circular_mb : 1;
uint64_t session_id = ep_enable_2 (
output_path,
ep_circular_mb,
ep_config,
ep_rt_config_value_get_output_streaming () ? EP_SESSION_TYPE_FILESTREAM : EP_SESSION_TYPE_FILE,
EP_SERIALIZATION_FORMAT_NETTRACE_V4,
ep_default_rundown_keyword,
NULL,
NULL,
NULL);
if (session_id)
ep_start_streaming (session_id);
}
ep_rt_utf8_string_free (ep_config_output_path);
ep_rt_utf8_string_free (ep_config);
return;
}
static
bool
session_requested_sampling (EventPipeSession *session)
{
EP_ASSERT (session != NULL);
return ep_session_provider_list_find_by_name (ep_session_provider_list_get_providers (ep_session_get_providers (session)), ep_config_get_sample_profiler_provider_name_utf8 ());
}
static
bool
ipc_stream_factory_any_suspended_ports (void)
{
return _ep_ipc_stream_factory_suspended_ports_callback ? _ep_ipc_stream_factory_suspended_ports_callback () : false;
}
#ifdef EP_CHECKED_BUILD
void
ep_requires_lock_held (void)
{
ep_rt_config_requires_lock_held ();
}
void
ep_requires_lock_not_held (void)
{
ep_rt_config_requires_lock_not_held ();
}
#endif
EventPipeSessionID
ep_enable (
const ep_char8_t *output_path,
uint32_t circular_buffer_size_in_mb,
const EventPipeProviderConfiguration *providers,
uint32_t providers_len,
EventPipeSessionType session_type,
EventPipeSerializationFormat format,
uint64_t rundown_keyword,
IpcStream *stream,
EventPipeSessionSynchronousCallback sync_callback,
void *callback_additional_data)
{
EventPipeSessionID sessionId = 0;
EventPipeSessionOptions options;
ep_session_options_init(
&options,
output_path,
circular_buffer_size_in_mb,
providers,
providers_len,
session_type,
format,
rundown_keyword,
true, // stackwalk_requested
stream,
sync_callback,
callback_additional_data);
sessionId = ep_enable_3(&options);
ep_session_options_fini(&options);
return sessionId;
}