-
Notifications
You must be signed in to change notification settings - Fork 4.8k
/
Copy pathgenEventing.py
1179 lines (983 loc) · 46.8 KB
/
genEventing.py
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
#
## Licensed to the .NET Foundation under one or more agreements.
## The .NET Foundation licenses this file to you under the MIT license.
#
#
#USAGE:
#Add Events: modify <root>src/vm/ClrEtwAll.man
#Look at the Code in <root>/src/scripts/genLttngProvider.py for using subroutines in this file
#
# Python 2 compatibility
from __future__ import print_function
import os
import sys
import xml.dom.minidom as DOM
from utilities import open_for_update, parseInclusionList
class RuntimeFlavor:
def __init__(self, runtime):
if runtime.lower() == "coreclr":
self.coreclr = True
self.mono = False
self.nativeaot = False
elif runtime.lower() == "mono":
self.coreclr = False
self.mono = True
self.nativeaot = False
elif runtime.lower() == "nativeaot":
self.coreclr = False
self.mono = False
self.nativeaot = True
else:
self.coreclr = True
self.mono = False
self.nativeaot = False
stdprolog="""
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
/******************************************************************
DO NOT MODIFY. AUTOGENERATED FILE.
This file is generated using the logic from <root>/src/scripts/genEventing.py
******************************************************************/
"""
lindent = " "
coreCLRPalDataTypeMapping={
#constructed types
"win:null" :" ",
"win:Int64" :"const int64_t",
"win:ULong" :"const ULONG",
"win:count" :"*",
"win:Struct" :"const void",
#actual spec
"win:GUID" :"const GUID",
"win:AnsiString" :"LPCSTR",
"win:UnicodeString" :"PCWSTR",
"win:Double" :"const double",
"win:Int32" :"const signed int",
"win:Boolean" :"const BOOL",
"win:UInt64" :"const uint64_t",
"win:UInt32" :"const unsigned int",
"win:UInt16" :"const unsigned short",
"win:UInt8" :"const unsigned char",
"win:Pointer" :"const void*",
"win:Binary" :"const BYTE",
}
coreCLREventPipeDataTypeMapping={
"BOOL" : "BOOL",
"LPCGUID" : "LPCGUID",
"UCHAR" : "UCHAR",
"ULONG" : "ULONG",
"ULONGLONG" : "ULONGLONG",
"WCHAR" : "WCHAR",
"BYTE" : "BYTE",
}
coreCLRUserEventDataTypeMapping={
"win:UInt8" : "TraceLoggingUInt8",
"win:UInt16" : "TraceLoggingUInt16",
"win:Int32" : "TraceLoggingInt32",
"win:UInt32" : "TraceLoggingUInt32",
"win:HexInt32" : "TraceLoggingHexInt32",
"win:UInt64" : "TraceLoggingUInt64",
"win:Int64" : "TraceLoggingInt64",
"win:HexInt64" : "TraceLoggingHexInt64",
"win:Pointer" : "TraceLoggingPointer",
"win:Boolean" : "TraceLoggingBoolean",
"win:UnicodeString" : "TraceLoggingString16",
"win:GUID" : "TraceLoggingGuid",
"win:Binary" : "TraceLoggingBinary",
"win:Double" : "TraceLoggingFloat64",
"win:AnsiString" : "TraceLoggingString",
}
coreCLRUserEventLogLevelMapping={
"win:LogAlways" : "0",
"win:Critical" : "1",
"win:Error" : "2",
"win:Warning" : "3",
"win:Informational" : "4",
"win:Verbose" : "5",
}
coreCLRUserEventArrayTypeMapping={
"win:UInt32" : "TraceLoggingUInt32Array",
"win:Binary" : "TraceLoggingUInt8Array",
"win:UInt64" : "TraceLoggingUInt64Array",
}
monoPalDataTypeMapping={
#constructed types
"win:null" :" ",
"win:Int64" :"const int64_t",
"win:ULong" :"const uint32_t",
"win:count" :"*",
"win:Struct" :"const void",
#actual spec
"win:GUID" :"const uint8_t",
"win:AnsiString" :"const char*",
"win:UnicodeString" :"const ep_char8_t*",
"win:Double" :"const double",
"win:Int32" :"const int32_t",
"win:Boolean" :"const bool",
"win:UInt64" :"const uint64_t",
"win:UInt32" :"const uint32_t",
"win:UInt16" :"const uint16_t",
"win:UInt8" :"const uint8_t",
"win:Pointer" :"const void*",
"win:Binary" :"const uint8_t",
}
monoEventPipeDataTypeMapping={
"BOOL" : "bool",
"LPCGUID" : "const uint8_t*",
"UCHAR" : "uint8_t",
"ULONG" : "uint32_t",
"ULONGLONG" : "uint64_t",
"WCHAR" : "wchar_t",
"BYTE" : "uint8_t",
}
aotPalDataTypeMapping={
#constructed types
"win:null" :" ",
"win:Int64" :"const int64_t",
"win:ULong" :"const ULONG",
"win:count" :"*",
"win:Struct" :"const void",
#actual spec
"win:GUID" :"const GUID",
"win:AnsiString" :"LPCSTR",
"win:UnicodeString" :"const WCHAR*",
"win:Double" :"const double",
"win:Int32" :"const signed int",
"win:Boolean" :"const BOOL",
"win:UInt64" :"const uint64_t",
"win:UInt32" :"const unsigned int",
"win:UInt16" :"const unsigned short",
"win:UInt8" :"const unsigned char",
"win:Pointer" :"const void*",
"win:Binary" :"const BYTE",
}
aotEventPipeDataTypeMapping={
"BOOL" : "BOOL",
"LPCGUID" : "const GUID *",
"UCHAR" : "UCHAR",
"ULONG" : "ULONG",
"ULONGLONG" : "ULONGLONG",
"WCHAR" : "WCHAR",
"BYTE" : "BYTE",
}
def getUserEventDataTypeMapping(runtimeFlavor):
if runtimeFlavor.coreclr:
return coreCLRUserEventDataTypeMapping
# elif runtimeFlavor.mono:
# return monoUserEventDataTypeMapping
# elif runtimeFlavor.nativeaot:
# return aotUserEventDataTypeMapping
def getUserEventLogLevelMapping(runtimeFlavor):
if runtimeFlavor.coreclr:
return coreCLRUserEventLogLevelMapping
# elif runtimeFlavor.mono:
# return monoUserEventLogLevelMapping
# elif runtimeFlavor.nativeaot:
# return aotUserEventLogLevelMapping
def getArrayDataTypeMapping(runtimeFlavor):
if runtimeFlavor.coreclr:
return coreCLRUserEventArrayTypeMapping
# elif runtimeFlavor.mono:
# return monoUserEventArrayTypeMapping
# elif runtimeFlavor.nativeaot:
# return aotUserEventArrayTypeMapping
def getEventPipeDataTypeMapping(runtimeFlavor):
if runtimeFlavor.coreclr:
return coreCLREventPipeDataTypeMapping
elif runtimeFlavor.mono:
return monoEventPipeDataTypeMapping
elif runtimeFlavor.nativeaot:
return aotEventPipeDataTypeMapping
def getPalDataTypeMapping(runtimeFlavor):
if runtimeFlavor.coreclr:
return coreCLRPalDataTypeMapping
elif runtimeFlavor.mono:
return monoPalDataTypeMapping
elif runtimeFlavor.nativeaot:
return aotPalDataTypeMapping
def includeProvider(providerName, runtimeFlavor):
if (runtimeFlavor.coreclr or runtimeFlavor.nativeaot) and providerName == "Microsoft-DotNETRuntimeMonoProfiler":
return False
elif runtimeFlavor.nativeaot and (providerName == "Microsoft-Windows-DotNETRuntimeRundown" or providerName == "Microsoft-Windows-DotNETRuntimeStress"):
return False
else:
return True
def includeEvent(inclusionList, providerName, eventName):
if len(inclusionList) == 0:
return True
if providerName in inclusionList and eventName in inclusionList[providerName]:
return True
elif providerName in inclusionList and "*" in inclusionList[providerName]:
return True
elif "*" in inclusionList and eventName in inclusionList["*"]:
return True
elif "*" in inclusionList and "*" in inclusionList["*"]:
return True
else:
return False
def getCoreCLRMonoNativeAotTypeAdaptionDefines():
return """
#ifndef W
#define W(str) L##str
#endif
#ifndef SL
#define SL(str) str
#endif
#ifndef ERROR_SUCCESS
#define ERROR_SUCCESS 0L
#endif
#ifndef ERROR_WRITE_FAULT
#define ERROR_WRITE_FAULT 29L
#endif
"""
# A Template represents an ETW template can contain 1 or more AbstractTemplates
# The AbstractTemplate contains FunctionSignature
# FunctionSignature consist of FunctionParameter representing each parameter in it's signature
def getParamSequenceSize(paramSequence, estimate):
total = 0
pointers = 0
for param in paramSequence:
if param == "win:Int64":
total += 8
elif param == "win:ULong":
total += 4
elif param == "GUID":
total += 16
elif param == "win:Double":
total += 8
elif param == "win:Int32":
total += 4
elif param == "win:Boolean":
total += 4
elif param == "win:UInt64":
total += 8
elif param == "win:UInt32":
total += 4
elif param == "win:UInt16":
total += 2
elif param == "win:UInt8":
total += 1
elif param == "win:Pointer":
if estimate:
total += 8
else:
pointers += 1
elif param == "win:Binary":
total += 1
elif estimate:
if param == "win:AnsiString":
total += 32
elif param == "win:UnicodeString":
total += 64
elif param == "win:Struct":
total += 32
else:
raise Exception("Don't know size for " + param)
if estimate:
return total
return total, pointers
class Template:
def __repr__(self):
return "<Template " + self.name + ">"
def __init__(self, templateName, fnPrototypes, dependencies, structSizes, arrays):
self.name = templateName
self.signature = FunctionSignature()
self.structs = structSizes
self.arrays = arrays
for variable in fnPrototypes.paramlist:
for dependency in dependencies[variable]:
if not self.signature.getParam(dependency):
self.signature.append(dependency, fnPrototypes.getParam(dependency))
def getFnParam(self, name):
return self.signature.getParam(name)
@property
def num_params(self):
return len(self.signature.paramlist)
@property
def estimated_size(self):
total = getParamSequenceSize((self.getFnParam(paramName).winType for paramName in self.signature.paramlist), True)
if total < 32:
total = 32
elif total > 1024:
total = 1024
return total
class FunctionSignature:
def __repr__(self):
return ", ".join(self.paramlist)
def __init__(self):
self.LUT = {} # dictionary of FunctionParameter
self.paramlist = [] # list of parameters to maintain their order in signature
def append(self,variable,fnparam):
self.LUT[variable] = fnparam
self.paramlist.append(variable)
def getParam(self,variable):
return self.LUT.get(variable)
def getLength(self):
return len(self.paramlist)
class FunctionParameter:
def __repr__(self):
return self.name
def __init__(self,winType,name,count,prop):
self.winType = winType #ETW type as given in the manifest
self.name = name #parameter name as given in the manifest
self.prop = prop #any special property as determined by the manifest and developer
#self.count #indicates if the parameter is a pointer
if count == "win:null":
self.count = "win:null"
elif count or winType == "win:GUID" or count == "win:count":
#special case for GUIDS, consider them as structs
self.count = "win:count"
else:
self.count = "win:null"
def getTopLevelElementsByTagName(node,tag):
dataNodes = []
for element in node.getElementsByTagName(tag):
if element.parentNode == node:
dataNodes.append(element)
return dataNodes
ignoredXmlTemplateAttribes = frozenset(["map","outType"])
usedXmlTemplateAttribes = frozenset(["name","inType","count", "length"])
def parseTemplateNodes(templateNodes):
#return values
allTemplates = {}
for templateNode in templateNodes:
structCounts = {}
arrays = {}
templateName = templateNode.getAttribute('tid')
var_Dependencies = {}
fnPrototypes = FunctionSignature()
dataNodes = getTopLevelElementsByTagName(templateNode,'data')
# Validate that no new attributes has been added to manifest
for dataNode in dataNodes:
nodeMap = dataNode.attributes
for attrib in nodeMap.values():
attrib_name = attrib.name
if attrib_name not in ignoredXmlTemplateAttribes and attrib_name not in usedXmlTemplateAttribes:
raise ValueError('unknown attribute: '+ attrib_name + ' in template:'+ templateName)
for dataNode in dataNodes:
variable = dataNode.getAttribute('name')
wintype = dataNode.getAttribute('inType')
#count and length are the same
wincount = dataNode.getAttribute('count')
winlength = dataNode.getAttribute('length');
var_Props = None
var_dependency = [variable]
if winlength:
if wincount:
raise Exception("both count and length property found on: " + variable + "in template: " + templateName)
wincount = winlength
if (wincount.isdigit() and int(wincount) ==1):
wincount = ''
if wincount:
if (wincount.isdigit()):
var_Props = wincount
elif fnPrototypes.getParam(wincount):
var_Props = wincount
var_dependency.insert(0, wincount)
arrays[variable] = wincount
#construct the function signature
if wintype == "win:GUID":
var_Props = "sizeof(GUID)/sizeof(int)"
var_Dependencies[variable] = var_dependency
fnparam = FunctionParameter(wintype,variable,wincount,var_Props)
fnPrototypes.append(variable,fnparam)
structNodes = getTopLevelElementsByTagName(templateNode,'struct')
for structToBeMarshalled in structNodes:
structName = structToBeMarshalled.getAttribute('name')
countVarName = structToBeMarshalled.getAttribute('count')
assert(countVarName == "Count")
assert(countVarName in fnPrototypes.paramlist)
if not countVarName:
raise ValueError("Struct '%s' in template '%s' does not have an attribute count." % (structName, templateName))
names = [x.attributes['name'].value for x in structToBeMarshalled.getElementsByTagName("data")]
types = [x.attributes['inType'].value for x in structToBeMarshalled.getElementsByTagName("data")]
structCounts[structName] = countVarName
var_Dependencies[structName] = [countVarName, structName]
fnparam_pointer = FunctionParameter("win:Struct", structName, "win:count", countVarName)
fnPrototypes.append(structName, fnparam_pointer)
allTemplates[templateName] = Template(templateName, fnPrototypes, var_Dependencies, structCounts, arrays)
return allTemplates
def generateClrallEvents(eventNodes, allTemplates, target_cpp, runtimeFlavor, write_xplatheader, providerName, inclusionList, generatedFileType, user_events):
clrallEvents = []
for eventNode in eventNodes:
eventName = eventNode.getAttribute('symbol')
if not includeEvent(inclusionList, providerName, eventName):
continue
templateName = eventNode.getAttribute('template')
#generate EventEnabled
if includeProvider (providerName, runtimeFlavor):
if not target_cpp:
clrallEvents.append("static ")
if generatedFileType == "header-impl":
clrallEvents.append("inline ")
clrallEvents.append("%s EventEnabled" % (getEventPipeDataTypeMapping(runtimeFlavor)["BOOL"]))
clrallEvents.append(eventName)
clrallEvents.append("(void)")
if generatedFileType == "header":
clrallEvents.append(";\n")
elif generatedFileType == "source-impl-noop":
clrallEvents.append(" { return 0; }\n")
else:
clrallEvents.append(" {return ")
clrallEvents.append("EventPipeEventEnabled" + eventName + "()")
if runtimeFlavor.coreclr or write_xplatheader or runtimeFlavor.nativeaot:
if os.name == 'posix':
if user_events and runtimeFlavor.coreclr:
clrallEvents.append(" || UserEventsEventEnabled" + eventName + "()")
# native AOT does not support non-windows eventing other than via event pipe
if not runtimeFlavor.nativeaot:
clrallEvents.append(" || (XplatEventLogger" +
("::" if target_cpp else "_") +
"IsEventLoggingEnabled() && EventXplatEnabled" +
eventName + "());}\n\n")
else:
clrallEvents.append(";}\n\n")
else:
clrallEvents.append(" || EventXplatEnabled" + eventName + "();}\n\n")
else:
clrallEvents.append(";}\n\n")
#generate FireEtw functions
fnptype = []
fnbody = []
if not target_cpp:
clrallEvents.append("static ")
if not runtimeFlavor.nativeaot:
fnptype.append("inline ")
fnptype.append("%s FireEtw" % (getEventPipeDataTypeMapping(runtimeFlavor)["ULONG"]))
fnptype.append(eventName)
fnptype.append("(\n")
line = []
fnptypeline = []
if templateName:
template = allTemplates[templateName]
fnSig = template.signature
for params in fnSig.paramlist:
fnparam = fnSig.getParam(params)
wintypeName = fnparam.winType
typewName = getPalDataTypeMapping(runtimeFlavor)[wintypeName]
winCount = fnparam.count
countw = getPalDataTypeMapping(runtimeFlavor)[winCount]
if params in template.structs:
fnptypeline.append("%sint %s_ElementSize,\n" % (lindent, params))
fnptypeline.append(lindent)
fnptypeline.append(typewName)
fnptypeline.append(countw)
fnptypeline.append(" ")
fnptypeline.append(fnparam.name)
fnptypeline.append(",\n")
#fnsignature
for params in fnSig.paramlist:
fnparam = fnSig.getParam(params)
if params in template.structs:
line.append(fnparam.name + "_ElementSize")
line.append(", ")
line.append(fnparam.name)
line.append(",")
#remove trailing commas
if len(line) > 0:
del line[-1]
#add activity IDs
fnptypeline.append(lindent)
# source file can't have the parameter initializer
fnptypeline.append("%s ActivityId%s\n" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"], " = nullptr," if (target_cpp and (generatedFileType == "header" or generatedFileType == "header-impl")) else ","))
fnptypeline.append(lindent)
fnptypeline.append("%s RelatedActivityId" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"]))
if (target_cpp and (generatedFileType == "header" or generatedFileType == "header-impl")):
fnptypeline.append(" = nullptr")
else:
fnptypeline.append("")
fnptype.extend(fnptypeline)
fnptype.append("\n)")
if generatedFileType == "header":
fnptype.append(";\n")
fnptype.append("\n")
elif generatedFileType == "source-impl-noop":
fnptype.append("\n{ return ERROR_SUCCESS; }\n\n")
else: # source-impl
fnptype.append("\n{\n")
fnbody.append(lindent)
fnbody.append("%s status = EventPipeWriteEvent" % (getEventPipeDataTypeMapping(runtimeFlavor)["ULONG"]) + eventName + "(" + ''.join(line))
if len(line) > 0:
fnbody.append(",")
fnbody.append("ActivityId,RelatedActivityId);\n")
if user_events and runtimeFlavor.coreclr:
fnbody.append(lindent)
fnbody.append("status &= UserEventsWriteEvent" + eventName + "(" + ''.join(line))
if len(line) > 0:
fnbody.append(",")
fnbody.append("ActivityId,RelatedActivityId);\n")
if runtimeFlavor.coreclr or write_xplatheader:
fnbody.append(lindent)
fnbody.append("status &= FireEtXplat" + eventName + "(" + ''.join(line) + ");\n")
if runtimeFlavor.nativeaot:
if providerName == "Microsoft-Windows-DotNETRuntime" or providerName == "Microsoft-Windows-DotNETRuntimePrivate":
fnbody.append("#ifndef TARGET_UNIX\n")
fnbody.append(lindent)
fnbody.append("status &= ")
else:
fnbody.append("return ")
fnbody.append("FireEtXplat" + eventName + "(" + ''.join(line) + ");\n")
if providerName == "Microsoft-Windows-DotNETRuntime" or providerName == "Microsoft-Windows-DotNETRuntimePrivate":
fnbody.append("#endif\n")
fnbody.append(lindent)
fnbody.append("return status;\n")
fnbody.append("}\n\n")
clrallEvents.extend(fnptype)
if not (runtimeFlavor.nativeaot and (generatedFileType == "header" or generatedFileType == "source-impl-noop")):
clrallEvents.extend(fnbody)
return ''.join(clrallEvents)
def generateClrXplatEvents(eventNodes, allTemplates, extern, runtimeFlavor):
clrallEvents = []
for eventNode in eventNodes:
eventName = eventNode.getAttribute('symbol')
templateName = eventNode.getAttribute('template')
#generate EventEnabled
if extern: clrallEvents.append('extern "C" ')
clrallEvents.append("%s EventXplatEnabled" % (getEventPipeDataTypeMapping(runtimeFlavor)["BOOL"]))
clrallEvents.append(eventName)
clrallEvents.append("();\n")
#generate FireEtw functions
fnptype = []
fnptypeline = []
if extern: fnptype.append('extern "C" ')
fnptype.append("%s FireEtXplat" % (getEventPipeDataTypeMapping(runtimeFlavor)["ULONG"]))
fnptype.append(eventName)
fnptype.append("(\n")
if templateName:
template = allTemplates[templateName]
fnSig = template.signature
for params in fnSig.paramlist:
fnparam = fnSig.getParam(params)
wintypeName = fnparam.winType
typewName = getPalDataTypeMapping(runtimeFlavor)[wintypeName]
winCount = fnparam.count
countw = getPalDataTypeMapping(runtimeFlavor)[winCount]
if params in template.structs:
fnptypeline.append("%sint %s_ElementSize,\n" % (lindent, params))
fnptypeline.append(lindent)
fnptypeline.append(typewName)
fnptypeline.append(countw)
fnptypeline.append(" ")
fnptypeline.append(fnparam.name)
fnptypeline.append(",\n")
#remove trailing commas
if len(fnptypeline) > 0:
del fnptypeline[-1]
fnptype.extend(fnptypeline)
fnptype.append("\n);\n")
clrallEvents.extend(fnptype)
return ''.join(clrallEvents)
def generateClrEventPipeWriteEvents(eventNodes, allTemplates, extern, target_cpp, runtimeFlavor, providerName, inclusion_list):
clrallEvents = []
for eventNode in eventNodes:
eventName = eventNode.getAttribute('symbol')
if not includeEvent(inclusion_list, providerName, eventName):
continue
templateName = eventNode.getAttribute('template')
#generate EventPipeEventEnabled and EventPipeWriteEvent functions
eventenabled = []
writeevent = []
fnptypeline = []
if extern:eventenabled.append('extern "C" ')
eventenabled.append("%s EventPipeEventEnabled" % (getEventPipeDataTypeMapping(runtimeFlavor)["BOOL"]))
eventenabled.append(eventName)
eventenabled.append("(void);\n")
if extern: writeevent.append('extern "C" ')
writeevent.append("%s EventPipeWriteEvent" % (getEventPipeDataTypeMapping(runtimeFlavor)["ULONG"]))
writeevent.append(eventName)
writeevent.append("(\n")
if templateName:
template = allTemplates[templateName]
fnSig = template.signature
for params in fnSig.paramlist:
fnparam = fnSig.getParam(params)
wintypeName = fnparam.winType
typewName = getPalDataTypeMapping(runtimeFlavor)[wintypeName]
winCount = fnparam.count
countw = getPalDataTypeMapping(runtimeFlavor)[winCount]
if params in template.structs:
fnptypeline.append("%sint %s_ElementSize,\n" % (lindent, params))
fnptypeline.append(lindent)
fnptypeline.append(typewName)
fnptypeline.append(countw)
fnptypeline.append(" ")
fnptypeline.append(fnparam.name)
fnptypeline.append(",\n")
fnptypeline.append(lindent)
fnptypeline.append("%s ActivityId%s\n" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"], " = nullptr," if target_cpp else ","))
fnptypeline.append(lindent)
fnptypeline.append("%s RelatedActivityId%s" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"], " = nullptr" if target_cpp else ""))
writeevent.extend(fnptypeline)
writeevent.append("\n);\n")
clrallEvents.extend(eventenabled)
clrallEvents.extend(writeevent)
return ''.join(clrallEvents)
def generateClrUserEventsWriteEvents(eventNodes, allTemplates, extern, target_cpp, runtimeFlavor, providerName, inclusion_list):
clrallEvents = []
for eventNode in eventNodes:
eventName = eventNode.getAttribute('symbol')
if not includeEvent(inclusion_list, providerName, eventName):
continue
templateName = eventNode.getAttribute('template')
#generate UserEventsEventEnabled and UserEventsWriteEvent functions
eventenabled = []
writeevent = []
fnptypeline = []
if extern:eventenabled.append('extern "C" ')
eventenabled.append("%s UserEventsEventEnabled" % (getEventPipeDataTypeMapping(runtimeFlavor)["BOOL"]))
eventenabled.append(eventName)
eventenabled.append("(void);\n")
if extern: writeevent.append('extern "C" ')
writeevent.append("%s UserEventsWriteEvent" % (getEventPipeDataTypeMapping(runtimeFlavor)["ULONG"]))
writeevent.append(eventName)
writeevent.append("(\n")
if templateName:
template = allTemplates[templateName]
fnSig = template.signature
for params in fnSig.paramlist:
fnparam = fnSig.getParam(params)
wintypeName = fnparam.winType
typewName = getPalDataTypeMapping(runtimeFlavor)[wintypeName]
winCount = fnparam.count
countw = getPalDataTypeMapping(runtimeFlavor)[winCount]
if params in template.structs:
fnptypeline.append("%sint %s_ElementSize,\n" % (lindent, params))
fnptypeline.append(lindent)
fnptypeline.append(typewName)
fnptypeline.append(countw)
fnptypeline.append(" ")
fnptypeline.append(fnparam.name)
fnptypeline.append(",\n")
fnptypeline.append(lindent)
fnptypeline.append("%s ActivityId%s\n" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"], " = nullptr," if target_cpp else ","))
fnptypeline.append(lindent)
fnptypeline.append("%s RelatedActivityId%s" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"], " = nullptr" if target_cpp else ""))
writeevent.extend(fnptypeline)
writeevent.append("\n);\n")
clrallEvents.extend(eventenabled)
clrallEvents.extend(writeevent)
return ''.join(clrallEvents)
#generates the dummy header file which is used by the VM as entry point to the logging Functions
def generateclrEtwDummy(eventNodes,allTemplates):
clretmEvents = []
for eventNode in eventNodes:
eventName = eventNode.getAttribute('symbol')
templateName = eventNode.getAttribute('template')
fnptype = []
#generate FireEtw functions
fnptype.append("#define FireEtw")
fnptype.append(eventName)
fnptype.append("(");
line = []
if templateName:
template = allTemplates[templateName]
fnSig = template.signature
for params in fnSig.paramlist:
fnparam = fnSig.getParam(params)
if params in template.structs:
line.append(fnparam.name + "_ElementSize")
line.append(", ")
line.append(fnparam.name)
line.append(", ")
#remove trailing commas
if len(line) > 0:
del line[-1]
fnptype.extend(line)
fnptype.append(") 0\n")
clretmEvents.extend(fnptype)
return ''.join(clretmEvents)
def generateEtmDummyHeader(sClrEtwAllMan,clretwdummy):
if not clretwdummy:
return
tree = DOM.parse(sClrEtwAllMan)
incDir = os.path.dirname(os.path.realpath(clretwdummy))
if not os.path.exists(incDir):
os.makedirs(incDir)
with open_for_update(clretwdummy) as Clretwdummy:
Clretwdummy.write(stdprolog + "\n")
for providerNode in tree.getElementsByTagName('provider'):
templateNodes = providerNode.getElementsByTagName('template')
allTemplates = parseTemplateNodes(templateNodes)
eventNodes = providerNode.getElementsByTagName('event')
#pal: create etmdummy.h
Clretwdummy.write(generateclrEtwDummy(eventNodes, allTemplates) + "\n")
def convertToLevelId(level):
if level == "win:LogAlways":
return 0
if level == "win:Critical":
return 1
if level == "win:Error":
return 2
if level == "win:Warning":
return 3
if level == "win:Informational":
return 4
if level == "win:Verbose":
return 5
raise Exception("unknown level " + level)
def getKeywordsMaskCombined(keywords, keywordsToMask):
mask = 0
for keyword in keywords.split(" "):
if keyword == "":
continue
mask |= keywordsToMask[keyword]
return mask
def updateclreventsfile(write_xplatheader, target_cpp, runtimeFlavor, eventpipe_trace_context_typedef, dotnet_trace_context_typedef_windows, user_events_trace_context_typedef, tree, clrallevents, inclusion_list, generatedFileType, user_events):
is_windows = os.name == 'nt'
with open_for_update(clrallevents) as Clrallevents:
Clrallevents.write(stdprolog)
if generatedFileType=="header-impl":
if runtimeFlavor.mono:
Clrallevents.write(getCoreCLRMonoNativeAotTypeAdaptionDefines() + "\n")
if runtimeFlavor.coreclr or write_xplatheader:
Clrallevents.write('#include "clrxplatevents.h"\n')
Clrallevents.write('#include "clreventpipewriteevents.h"\n')
if user_events and runtimeFlavor.coreclr:
Clrallevents.write('#include "clrusereventswriteevents.h"\n')
elif generatedFileType == "header":
Clrallevents.write('#ifndef CLR_ETW_ALL_MAIN_H\n')
Clrallevents.write('#define CLR_ETW_ALL_MAIN_H\n\n')
elif generatedFileType == "source-impl":
Clrallevents.write('#include <common.h>\n')
Clrallevents.write('#include <PalRedhawk.h>\n')
Clrallevents.write('#include "clretwallmain.h"\n')
Clrallevents.write('#include "clreventpipewriteevents.h"\n')
if user_events and runtimeFlavor.coreclr:
Clrallevents.write('#include "clrusereventswriteevents.h"\n')
Clrallevents.write('#ifdef FEATURE_ETW\n')
Clrallevents.write('#include "ClrEtwAll.h"\n')
Clrallevents.write('#endif\n')
Clrallevents.write('\n')
elif generatedFileType == "source-impl-noop":
Clrallevents.write('#include <CommonTypes.h>\n')
Clrallevents.write('#include <CommonMacros.h>\n\n')
Clrallevents.write('#include <PalRedhawk.h>\n\n')
Clrallevents.write('#ifndef ERROR_SUCCESS\n')
Clrallevents.write('#define ERROR_SUCCESS 0L\n')
Clrallevents.write('#endif\n\n')
# define DOTNET_TRACE_CONTEXT depending on the platform
if is_windows and not runtimeFlavor.nativeaot:
Clrallevents.write(eventpipe_trace_context_typedef) # define EVENTPIPE_TRACE_CONTEXT
if runtimeFlavor.coreclr or write_xplatheader:
Clrallevents.write(dotnet_trace_context_typedef_windows + "\n")
else:
Clrallevents.write("\n")
if not is_windows and runtimeFlavor.coreclr:
Clrallevents.write(user_events_trace_context_typedef)
if not is_windows and not write_xplatheader and not runtimeFlavor.nativeaot:
Clrallevents.write(eventpipe_trace_context_typedef) # define EVENTPIPE_TRACE_CONTEXT
Clrallevents.write("\n")
# Hack to write etw specific information to nativeaot
for providerNode in tree.getElementsByTagName('provider'):
providerName = providerNode.getAttribute('name')
templateNodes = providerNode.getElementsByTagName('template')
allTemplates = parseTemplateNodes(templateNodes)
eventNodes = providerNode.getElementsByTagName('event')
#vm header:
Clrallevents.write(generateClrallEvents(eventNodes, allTemplates, target_cpp, runtimeFlavor, write_xplatheader, providerName, inclusion_list, generatedFileType, user_events))
providerName = providerNode.getAttribute('name')
providerSymbol = providerNode.getAttribute('symbol')
eventpipeProviderCtxName = providerSymbol + "_EVENTPIPE_Context"
if is_windows and not (write_xplatheader or runtimeFlavor.nativeaot):
Clrallevents.write(('constexpr ' if target_cpp else 'static const ') + 'EVENTPIPE_TRACE_CONTEXT ' + eventpipeProviderCtxName + ' = { W("' + providerName + '"), 0, false, 0 };\n')
if not is_windows and not write_xplatheader and not runtimeFlavor.nativeaot:
Clrallevents.write('__attribute__((weak)) EVENTPIPE_TRACE_CONTEXT ' + eventpipeProviderCtxName + ' = { W("' + providerName + '"), 0, false, 0 };\n')
if generatedFileType == "header":
Clrallevents.write("#endif // __CLR_ETW_ALL_MAIN_H__\n")
def generatePlatformIndependentFiles(sClrEtwAllMan, incDir, etmDummyFile, extern, write_xplatheader, target_cpp, runtimeFlavor, inclusion_list, user_events):
generateEtmDummyHeader(sClrEtwAllMan,etmDummyFile)
tree = DOM.parse(sClrEtwAllMan)
if not incDir:
return
if not os.path.exists(incDir):
os.makedirs(incDir)
eventpipe_trace_context_typedef = """
#if !defined(EVENTPIPE_TRACE_CONTEXT_DEF)
#define EVENTPIPE_TRACE_CONTEXT_DEF
typedef struct _EVENTPIPE_TRACE_CONTEXT
{
const %s * Name;
%s Level;
bool IsEnabled;
%s EnabledKeywordsBitmask;
} EVENTPIPE_TRACE_CONTEXT, *PEVENTPIPE_TRACE_CONTEXT;
#endif // EVENTPIPE_TRACE_CONTEXT_DEF
""" % (getEventPipeDataTypeMapping(runtimeFlavor)["WCHAR"], getEventPipeDataTypeMapping(runtimeFlavor)["UCHAR"], getEventPipeDataTypeMapping(runtimeFlavor)["ULONGLONG"])
user_events_trace_context_typedef = """
#if !defined(USER_EVENTS_TRACE_CONTEXT_DEF)
#define USER_EVENTS_TRACE_CONTEXT_DEF
typedef struct _USER_EVENTS_TRACE_CONTEXT
{
UCHAR id;
} USER_EVENTS_TRACE_CONTEXT, *PUSER_EVENTS_TRACE_CONTEXT;
#endif // USER_EVENTS_TRACE_CONTEXT_DEF
"""
lttng_trace_context_typedef = """
#if !defined(LTTNG_TRACE_CONTEXT_DEF)
#define LTTNG_TRACE_CONTEXT_DEF
typedef struct _LTTNG_TRACE_CONTEXT
{
WCHAR const * Name;
UCHAR Level;
bool IsEnabled;
ULONGLONG EnabledKeywordsBitmask;
} LTTNG_TRACE_CONTEXT, *PLTTNG_TRACE_CONTEXT;
#endif // LTTNG_TRACE_CONTEXT_DEF
"""
dotnet_trace_context_typedef_windows = """
#if !defined(DOTNET_TRACE_CONTEXT_DEF)
#define DOTNET_TRACE_CONTEXT_DEF
typedef struct _DOTNET_TRACE_CONTEXT
{
PMCGEN_TRACE_CONTEXT EtwProvider;
EVENTPIPE_TRACE_CONTEXT EventPipeProvider;