WIP

Author: davmason

src/coreclr/scripts/genUserEvents.py

@@ -70,6 +70,7 @@ def generateMethodSignatureWrite(eventName, template, extern, runtimeFlavor):
     sig_pieces.append("%s RelatedActivityId" % (getEventPipeDataTypeMapping(runtimeFlavor)["LPCGUID"]))
     sig_pieces.append(")")
     return ''.join(sig_pieces)
+
 def formatGuid(providerGuid):
     providerGuid = providerGuid[1:-1]
     guidParts = providerGuid.split('-')
@@ -84,6 +85,30 @@ def formatGuid(providerGuid):
     guidParts[0] = "0x" + guidParts[0]
     return ", 0x".join(guidParts)
 
+def generateClrUserEventWriteEventsHeader(providerNode, providerPrettyName, providerName, eventNodes, allTemplates, extern, target_cpp, runtimeFlavor, inclusionList, exclusionList):
+    WriteEventHeader = []
+    for eventNode in eventNodes:
+        eventName = eventNode.getAttribute('symbol')
+        templateName = eventNode.getAttribute('template')
+        eventLevel = eventNode.getAttribute('level')
+        eventKeywords = eventNode.getAttribute('keywords')
+        eventKeywordsMask = generateEventKeywords(eventKeywords)
+
+
+        if not includeEvent(inclusionList, providerName, eventName):
+            continue
+
+        eventIsEnabledFunc = "TraceLoggingProviderEnabled"
+
+        # generate UserEventEnabled function
+        eventEnabledSig = generateMethodSignatureEnabled(eventName, runtimeFlavor, providerName, eventLevel, eventKeywords) + ";\n\n"
+        WriteEventHeader.append(eventEnabledSig)
+
+        eventWriteSig = eventWritegenerateMethodSignatureWrite(eventName, template, extern, runtimeFlavor) + ";\n\n"
+        WriteEventHeader.append(eventWriteSig)
+
+        return ''.join(WriteEventHeader)
+
 def generateClrUserEventWriteEventsImpl(providerNode, providerPrettyName, providerName, eventNodes, allTemplates, extern, target_cpp, runtimeFlavor, inclusionList, exclusionList):
     WriteEventImpl = []
     # User Event Provider Declaration
@@ -211,56 +236,52 @@ def getAotUserEventHelperFileImplPrefix():
 def getAotUserEventHelperFileImplSuffix():
     return ""
 
-def generateUserEventHelperFile(etwmanifest, userevent_directory, target_cpp, runtimeFlavor, extern, dryRun):
+def generateUserEventHelperFile(etwmanifest, userevent_directory, target_cpp, runtimeFlavor, extern):
     usereventhelpersPath = os.path.join(userevent_directory, "usereventhelpers" + (".cpp" if target_cpp else ".c"))
-    if dryRun:
-        print(usereventhelpersPath)
-    else:
-        with open_for_update(usereventhelpersPath) as helper:
-            helper.write(stdprolog_cpp)
-            if runtimeFlavor.coreclr:
-                helper.write(getCoreCLRUserEventHelperFileImplPrefix())
-            elif runtimeFlavor.mono:
-                helper.write(getMonoUserEventHelperFileImplPrefix())
-            elif runtimeFlavor.nativeaot:
-                helper.write(getAotUserEventHelperFileImplPrefix())
-
-            tree = DOM.parse(etwmanifest)
-
-            for providerNode in tree.getElementsByTagName('provider'):
-                providerName = providerNode.getAttribute('name')
-                if includeProvider(providerName, runtimeFlavor):
-                    providerPrettyName = providerName.replace("Windows-", '')
-                    providerPrettyName = providerPrettyName.replace("Microsoft-", '')
-                    providerPrettyName = providerPrettyName.replace('-', '_')
-                    if extern: helper.write(
-                        'extern "C" '
-                    )
-                    helper.write(
-                        "void Init" +
-                        providerPrettyName +
-                        "(void);\n\n")
-
-            if extern: helper.write(
-                'extern "C" '
-            )
-            helper.write("void InitProvidersAndEvents(void);\n\n")
-            helper.write("void InitProvidersAndEvents(void)\n{\n")
-            for providerNode in tree.getElementsByTagName('provider'):
-                providerName = providerNode.getAttribute('name')
-                if includeProvider(providerName, runtimeFlavor):
-                    providerPrettyName = providerName.replace("Windows-", '')
-                    providerPrettyName = providerPrettyName.replace("Microsoft-", '')
-                    providerPrettyName = providerPrettyName.replace('-', '_')
-                    helper.write("    Init" + providerPrettyName + "();\n")
-            helper.write("}\n")
-
-            if (runtimeFlavor.coreclr or runtimeFlavor.nativeaot):
-                helper.write(getCoreCLRUserEventHelperFileImplSuffix())
-            elif runtimeFlavor.mono:
-                helper.write(getMonoUserEventHelperFileImplSuffix())
-
-        helper.close()
+    with open_for_update(usereventhelpersPath) as helper:
+        helper.write(stdprolog_cpp)
+        if runtimeFlavor.coreclr:
+            helper.write(getCoreCLRUserEventHelperFileImplPrefix())
+        elif runtimeFlavor.mono:
+            helper.write(getMonoUserEventHelperFileImplPrefix())
+        elif runtimeFlavor.nativeaot:
+            helper.write(getAotUserEventHelperFileImplPrefix())
+
+        tree = DOM.parse(etwmanifest)
+
+        for providerNode in tree.getElementsByTagName('provider'):
+            providerName = providerNode.getAttribute('name')
+            if includeProvider(providerName, runtimeFlavor):
+                providerPrettyName = providerName.replace("Windows-", '')
+                providerPrettyName = providerPrettyName.replace("Microsoft-", '')
+                providerPrettyName = providerPrettyName.replace('-', '_')
+                if extern: helper.write(
+                    'extern "C" '
+                )
+                helper.write(
+                    "void Init" +
+                    providerPrettyName +
+                    "(void);\n\n")
+
+        if extern: helper.write(
+            'extern "C" '
+        )
+        helper.write("void InitProvidersAndEvents(void);\n\n")
+        helper.write("void InitProvidersAndEvents(void)\n{\n")
+        for providerNode in tree.getElementsByTagName('provider'):
+            providerName = providerNode.getAttribute('name')
+            if includeProvider(providerName, runtimeFlavor):
+                providerPrettyName = providerName.replace("Windows-", '')
+                providerPrettyName = providerPrettyName.replace("Microsoft-", '')
+                providerPrettyName = providerPrettyName.replace('-', '_')
+                helper.write("    Init" + providerPrettyName + "();\n")
+        helper.write("}\n")
+
+        if (runtimeFlavor.coreclr or runtimeFlavor.nativeaot):
+            helper.write(getCoreCLRUserEventHelperFileImplSuffix())
+        elif runtimeFlavor.mono:
+            helper.write(getMonoUserEventHelperFileImplSuffix())
+
 def getCoreCLRUserEventImplFilePrefix():
     return """#include "common.h" //FIXME<>
 #include <stdint.h>
@@ -283,7 +304,7 @@ def getAotUserEventImplFileSuffix():
     return ""
 
 def generateUserEventImplFiles(
-        etwmanifest, userevent_directory, extern, target_cpp, runtimeFlavor, inclusionList, exclusionList, dryRun):
+        etwmanifest, userevent_directory, extern, target_cpp, runtimeFlavor, inclusionList, exclusionList):
     tree = DOM.parse(etwmanifest)
 
     # Find the src directory starting with the assumption that
@@ -296,29 +317,32 @@ def generateUserEventImplFiles(
         if os.path.basename(src_dirname) == "":
             raise IOError("Could not find the Core CLR 'src' directory")
 
-    for providerNode in tree.getElementsByTagName('provider'):
-        providerName = providerNode.getAttribute('name')
-        if not includeProvider(providerName, runtimeFlavor):
-            continue
+    commonHeaderFile = os.path.join(userevent_directory, "user_events_providers.h")
+    with open_for_update(commonHeaderFile) as commonheader:
+        for providerNode in tree.getElementsByTagName('provider'):
+            providerName = providerNode.getAttribute('name')
+            if not includeProvider(providerName, runtimeFlavor):
+                continue
 
-        providerPrettyName = providerName.replace("Windows-", '')
-        providerPrettyName = providerPrettyName.replace("Microsoft-", '')
+            providerPrettyName = providerName.replace("Windows-", '')
+            providerPrettyName = providerPrettyName.replace("Microsoft-", '')
 
-        providerName_File = providerPrettyName.replace('-', '')
-        if target_cpp:
-            providerName_File = providerName_File + ".cpp"
-        else:
-            providerName_File = providerName_File + ".c"
+            providerName_File = providerPrettyName.replace('-', '')
+            providerName_Header = providerName_File + ".h"
+            commonheader.write("#include \"%s\"" % (providerName_Header))
 
-        providerName_File = providerName_File.lower()
+            if target_cpp:
+                providerName_File = providerName_File + ".cpp"
+            else:
+                providerName_File = providerName_File + ".c"
 
-        usereventfile = os.path.join(userevent_directory, providerName_File)
+            providerName_File = providerName_File.lower()
+            providerName_Header = providerName_Header.lower()
 
-        providerPrettyName = providerPrettyName.replace('-', '_')
+            usereventfile = os.path.join(userevent_directory, providerName_File)
+
+            providerPrettyName = providerPrettyName.replace('-', '_')
 
-        if dryRun:
-            print(usereventfile)
-        else:
             with open_for_update(usereventfile) as usereventImpl:
                 usereventImpl.write(stdprolog_cpp)
                 header = ""
@@ -354,8 +378,23 @@ def generateUserEventImplFiles(
                 elif runtimeFlavor.nativeaot and providerName=="Microsoft-Windows-DotNETRuntime":
                     usereventImpl.write(getAotUserEventImplFileSuffix())
 
+            usereventHeaderFile = os.path.join(userevent_directory, providerName_Header)
+            with open_for_update(usereventHeaderFile) as usereventheader:
+                usereventheader.write(
+                    generateClrUserEventWriteEventsHeader(
+                        providerNode,
+                        providerPrettyName,
+                        providerName,
+                        eventNodes,
+                        allTemplates,
+                        extern,
+                        target_cpp,
+                        runtimeFlavor,
+                        inclusionList,
+                        exclusionList) + "\n")
+
 def generateUserEventFiles(
-        etwmanifest, intermediate, extern, target_cpp, runtimeFlavor, inclusionList, exclusionList, dryRun):
+        etwmanifest, intermediate, extern, target_cpp, runtimeFlavor, inclusionList, exclusionList):
     if runtimeFlavor.nativeaot or runtimeFlavor.mono:
         raise Exception("genUserEvents.py only supports coreclr currently.")
 
@@ -366,7 +405,7 @@ def generateUserEventFiles(
         os.makedirs(userevent_directory)
 
     # generate helper file
-    generateUserEventHelperFile(etwmanifest, userevent_directory, target_cpp, runtimeFlavor, extern, dryRun)
+    generateUserEventHelperFile(etwmanifest, userevent_directory, target_cpp, runtimeFlavor, extern)
 
     # generate all keywords
     for keywordNode in tree.getElementsByTagName('keyword'):
@@ -382,15 +421,13 @@ def generateUserEventFiles(
         target_cpp,
         runtimeFlavor,
         inclusionList,
-        exclusionList,
-        dryRun
+        exclusionList
     )
 
 import argparse
 import sys
 
 def main(argv):
-
     # parse the command line
     parser = argparse.ArgumentParser(
         description="Generates the Code required to instrument userevent logging mechanism")
@@ -408,8 +445,6 @@ def main(argv):
                           help='runtime flavor')
     required.add_argument('--nonextern', action='store_true',
                           help='if specified, will generate files to be compiled into the CLR rather than extern' )
-    required.add_argument('--dry-run', action='store_true',
-                                    help='if specified, will output the names of the generated files instead of generating the files' )
     args, unknown = parser.parse_known_args(argv)
     if unknown:
         print('Unknown argument(s): ', ', '.join(unknown))
@@ -421,8 +456,7 @@ def main(argv):
     intermediate = args.intermediate
     runtimeFlavor = RuntimeFlavor(args.runtimeflavor)
     extern = not args.nonextern
-    dryRun = args.dry_run
-
+    
     target_cpp = True
     if runtimeFlavor.mono:
         extern = False
@@ -431,7 +465,7 @@ def main(argv):
     inclusion_list = parseInclusionList(inclusion_filename)
     exclusion_list = parseExclusionList(exclusion_filename)
 
-    generateUserEventFiles(sClrEtwAllMan, intermediate, extern, target_cpp, runtimeFlavor, inclusion_list, exclusion_list, dryRun)
+    generateUserEventFiles(sClrEtwAllMan, intermediate, extern, target_cpp, runtimeFlavor, inclusion_list, exclusion_list)
 
 if __name__ == '__main__':
     return_code = main(sys.argv[1:])