Add support for events collection through EventPipe

Author: Gregory LEOCADIE

src/perfcollect/perfcollect

@@ -642,6 +642,10 @@ usePerf=1
 # Use LTTng
 useLTTng=1
 
+# Use EventPipe to collect CLR events
+useEventPipe=0
+sdkAndToolDir="/tmp/dotnet_sdk_tool"
+
 # LTTng Installed
 lttngInstalled=0
 
@@ -1332,6 +1336,7 @@ ProcessArguments()
             if [ "-events" != "$arg" ]
             then
                 # Convert the value to lower case.
+                rawvalue=$value
                 value=`echo $value | tr '[:upper:]' '[:lower:]'`
             fi
         fi
@@ -1377,18 +1382,33 @@ ProcessArguments()
         elif [ "-nolttng" == "$arg" ]
         then
             useLTTng=0
+        elif [ "-eventpipe" == "$arg" ]
+        then
+            useEventPipe=1
+            useLTTng=0
+        elif [ "-providers" == "$arg" ]
+        then
+            providers=$rawvalue
+            i=$i+1
+        elif [ "-sdk-path" == "$arg" ]
+        then
+            sdkAndToolDir=$value
+            i=$i+1
         elif [ "-noperf" == "$arg" ]
         then 
             usePerf=0
         elif [ "-gccollectonly" == "$arg" ]
         then
             gcCollectOnly=1
+            usePerf=0
         elif [ "-gconly" == "$arg" ]
         then
             gcOnly=1
+            usePerf=0
         elif [ "-gcwithheap" == "$arg" ]
         then
             gcWithHeap=1
+            usePerf=0
         elif [ "-events" == "$arg" ]
         then
             events=$value
@@ -1438,21 +1458,18 @@ SetupLTTngSession()
         RunSilent "$lttngcmd enable-event --userspace --tracepoint DotNETRuntime:EventSource"
     elif [ "$gcCollectOnly" == "1" ]
     then
-        usePerf=0
         EnableLTTngEvents ${DotNETRuntime_GCKeyword_GCCollectOnly[@]}
         EnableLTTngEvents ${DotNETRuntimePrivate_GCPrivateKeyword_GCCollectOnly[@]}
         EnableLTTngEvents ${DotNETRuntime_ExceptionKeyword[@]}
     elif [ "$gcOnly" == "1" ]
     then
-        usePerf=0
         EnableLTTngEvents ${DotNETRuntime_GCKeyword[@]}
         EnableLTTngEvents ${DotNETRuntimePrivate_GCPrivateKeyword[@]}
         EnableLTTngEvents ${DotNETRuntime_JitKeyword[@]}
         EnableLTTngEvents ${DotNETRuntime_LoaderKeyword[@]}
         EnableLTTngEvents ${DotNETRuntime_ExceptionKeyword[@]}
     elif [ "$gcWithHeap" == "1" ]
     then
-        usePerf=0
         EnableLTTngEvents ${DotNETRuntime_GCKeyword[@]}
         EnableLTTngEvents ${DotNETRuntime_GCHeapSurvivalAndMovementKeyword[@]}
     else
@@ -1559,6 +1576,13 @@ ProcessCollectedData()
         fi
     fi
 
+    if [ "$useEventPipe" == "1" ]
+    then
+        LogAppend "Saving EventPipe trace file."
+        cp $eventPipeOutputFile .
+        cp $eventPipeLogFile . 
+    fi
+
     if [ "$usePerf" == 1 ]
     then
         # Get any perf-$pid.map files that were used by the
@@ -1832,6 +1856,11 @@ EndCollect()
         StopLTTngCollection
     fi
 
+    if [ "$useEventPipe" == "1" ]
+    then
+        StopEventPipeCollection
+    fi
+
     # Update the user.
     WriteStatus
     WriteStatus "...STOPPED."
@@ -1954,10 +1983,89 @@ BuildPerfRecordArgs()
         durationString="sleep ${duration}"
     fi
 
-    # Add the events onto the collection command line args.    
+    # Add the events onto the collection command line args.
     collectionArgs="$collectionArgs -e $eventString $durationString"
 }
 
+BuildEventPipeArgs()
+{
+    if [ "$collectionPid" == "" ]
+    then
+        FatalError "You must specify a .Net process id (-pid) to collect CLR events through EventPipe"
+    fi
+    eventPipeCollectionArgs="collect -p $collectionPid "
+
+    activated_providers=()
+    if [ "$gcCollectOnly" == "1" ]
+    then
+        ## GC & Exception
+        activated_providers+=("Microsoft-Windows-DotNETRuntime:0x0000000000008001:4")
+        ## Private GC
+        activated_providers+=("Microsoft-Windows-DotNETRuntimePrivate:0x0000000000000001:4")
+    elif [ "$gcOnly" == "1" ]
+    then
+        ## GC & Jit & Loader & Exception
+        activated_providers+=("Microsoft-Windows-DotNETRuntime:0x0000000000080019:5")
+        ## Private GC
+        activated_providers+=("Microsoft-Windows-DotNETRuntimePrivate:0x0000000000000001:5")
+    elif [ "$gcWithHeap" == "1" ]
+    then
+        ## GC & GCHeapSurvivalAndMovement
+        activated_providers+=("Microsoft-Windows-DotNETRuntime:0x0000000000400001:5")
+    else
+        if [ "$providers" == "" ]
+        then
+            # Enable the default set of events.
+
+            #  DotNETRuntime with keywords: Exception, Contention, Jit/NGen, Loader, GC, Compilation
+            #  Threading, ThreadTransfer & Jit
+            activated_providers+=("Microsoft-Windows-DotNETRuntime:0x000000108001C039:5")
+
+            #  DotNETRuntimeRundown with keyword(s): Compilation
+            activated_providers+=("Microsoft-Windows-DotNETRuntimeRundown:0x0000001000000000:4")
+
+            # DotNETRuntimePrivate with keywords: GC, Binding, MulticoreJitPrivate
+            activated_providers+=("Microsoft-Windows-DotNETRuntimePrivate:0x0000000000020003:4")
+
+        elif [ "$providers" == "threading" ]
+        then
+            activated_providers+=("Microsoft-Windows-DotNETRuntime:0x0000000000010000:5")
+        else
+            # Enable other keywords
+            providers=(${providers//","/" "})
+            for provider in ${providers[@]}
+            do
+               activated_providers+=($provider)
+            done
+        fi
+    fi
+    if (( ${#activated_providers[@]} ))
+    then
+        joined_providers=$( IFS=","; echo "${activated_providers[*]}" )
+        eventPipeCollectionArgs="$eventPipeCollectionArgs --providers $joined_providers"
+    fi
+    eventPipeOutputFile="$sdkAndToolDir/trace.nettrace"
+    eventPipeLogFile="$sdkAndToolDir/eventpipe.log"
+    eventPipeCollectionArgs="$eventPipeCollectionArgs -o $eventPipeOutputFile"
+}
+
+StartEventPipeCollection()
+{
+    pushd $sdkAndToolDir > /dev/null
+    eval "./dotnet trace $eventPipeCollectionArgs < /dev/null > $eventPipeLogFile 2>&1 &"
+    eventPipeCollectionPid=$!
+    popd > /dev/null
+}
+
+StopEventPipeCollection()
+{
+    RunSilent "kill -15 $eventPipeCollectionPid"
+    while [ "$eventPipeCollectionPid" != "" ] && [ -e /proc/$eventPipeCollectionPid ]
+    do
+        sleep .6
+    done
+}
+
 DoCollect()
 {
     # Ensure the script is run as root.
@@ -1983,6 +2091,12 @@ DoCollect()
         StartLTTngCollection
     fi
 
+    if [ "$useEventPipe" == "1" ]
+    then
+        BuildEventPipeArgs
+        StartEventPipeCollection
+    fi
+
     # Tell the user that collection has started and how to exit.
     if [ "$duration" != "" ]
     then
@@ -2001,7 +2115,7 @@ DoCollect()
         # Pass trace directory and session name to the stop process.
         popd > /dev/null
         usePerf=0
-        declare -p | grep -e lttngTraceDir -e lttngSessionName -e tempDir -e usePerf -e useLttng -e logFile > $collectInfoFile
+        declare -p | grep -e lttngTraceDir -e lttngSessionName -e tempDir -e usePerf -e useLttng -e logFile -e eventPipeCollectionPid -e eventPipeOutputFile -e eventPipeLogFile > $collectInfoFile
     else
         if [ "$usePerf" == "1" ]
         then
@@ -2115,6 +2229,51 @@ DoView()
     rm -rf $tempDir
 }
 
+IsTraceToolInstalled()
+{
+   # check global
+   local installed=0
+
+   if $($sdkAndToolDir/dotnet tool list -g | grep -q "dotnet-trace")
+   then
+      installed=1
+   elif $($sdkAndToolDir/dotnet tool list --local | grep -q "dotnet-trace")
+   then
+      installed=1
+   fi
+
+   echo $installed
+}
+
+EnsureDotNetTraceToolIsInstalled()
+{
+   if [ ! -d "$sdkAndToolDir" ]
+   then
+       WriteStatus "Installing dotnet sdk in $sdkAndToolDir"
+       ResetText
+       RunSilent "mkdir $sdkAndToolDir"
+       RunSilent "curl -OL https://dot.net/v1/dotnet-install.sh"
+       RunSilent "bash ./dotnet-install.sh --install-dir $sdkAndToolDir"
+   fi
+
+   pushd $sdkAndToolDir > /dev/null
+   if [ "$(IsTraceToolInstalled)" != "1" ]
+   then
+       # create a tool-manifest. If there is one, it won't be overwritten.
+       WriteStatus "Installing dotnet trace"
+       RunSilent "./dotnet new tool-manifest"
+       RunSilent "./dotnet tool install dotnet-trace --local"
+   fi
+
+   ./dotnet trace --version > /dev/null 2>&1
+   if [ "$?" != 0 ]
+   then
+      FatalError "dotnet-trace tool was installed correctly."
+   fi
+   LogAppend 'dotnet-trace version:' `$sdkAndToolDir/dotnet trace --version`
+   popd > /dev/null
+}
+
 #####################################
 ## Main Script Start
 #####################################
@@ -2153,6 +2312,11 @@ ProcessArguments $@
 # Ensure prerequisites are installed.
 EnsurePrereqsInstalled
 
+if [ "$useEventPipe" == "1" ]  && [ "$1" != "stop" ]
+then
+    EnsureDotNetTraceToolIsInstalled
+fi
+
 # Take the appropriate action.
 if [ "$action" == "collect" ] || [ "$action" == "start" ]
 then