Automating Event Logging Infrastructure: With this change the infrastructure required for Event Logging

will be generated as part of build

Author: ramarag

.gitignore

@@ -273,3 +273,6 @@ Makefile
 
 # Cross compilation
 cross/rootfs/*
+
+#python import files
+*.pyc

Documentation/README.md

@@ -38,6 +38,7 @@ Coding Guidelines
 - [CLR Coding Guide](coding-guidelines/clr-code-guide.md)
 - [CLR JIT Coding Conventions](coding-guidelines/clr-jit-coding-conventions.md)
 - [Cross Platform Performance and Eventing Design](coding-guidelines/cross-platform-performance-and-eventing.md)
+- [Adding New Events to the VM](coding-guidelines/EventLogging.md)
 
 Build CoreCLR from Source
 =========================

Documentation/building/windows-instructions.md

@@ -31,6 +31,12 @@ The CoreCLR build relies on CMake for the build. We are currently using CMake 3.
 - Install [CMake](http://www.cmake.org/download) for Windows.
 - Add it to the PATH environment variable.
 
+Python
+---------
+Python is used in the build system. We are currently using python 2.7.9.
+- Install [Python](https://www.python.org/downloads/) for Windows.
+- Add it to the PATH environment variable.
+
 Git Setup
 ---------
 

Documentation/coding-guidelines/EventLogging.md

@@ -0,0 +1,19 @@
+# CoreClr Event Logging Design
+
+##Introduction
+
+Event Logging is a mechanism by which CoreClr can provide a variety of information on it's state. This Logging works by inserting explicit logging calls by the developer within the VM . The Event Logging mechanism is largely based on [ETW- Event Tracing For Windows](https://msdn.microsoft.com/en-us/library/windows/desktop/bb968803(v=vs.85).aspx)
+
+# Adding Events to the Runtime
+
+- Edit the [Event manifest](../../src/vm/ClrEtwAll.man) to add a new event. For guidelines on adding new events, take a  look at the existing events in the manifest and this guide for [ETW Manifests](https://msdn.microsoft.com/en-us/library/dd996930%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396).
+- The build system should automatically generate the required artifacts for the added events. 
+- Add entries in the [exclusion list](../../src/vm/ClrEtwAllMeta) if necessary
+- The Event Logging Mechanism provides the following two functions, which can be used within the VM:
+	- **FireEtw**EventName, this is used to trigger the event
+	- **EventEnabled**EventName, this is used to see if any consumer has subscribed to this event
+
+
+# Adding New Logging System 
+
+Though the the Event logging system was designed for ETW, the build system provides a mechanism, basically an [adapter script- genXplatEventing.py](../../src/scripts/genXplatEventing.py) so that other Logging System can be added and used by CoreClr. An Example of such an extension for [LTTng logging system](https://lttng.org/) can be found in [genXplatLttng.py](../../src/scripts/genXplatLttng.py )

build.cmd

@@ -1,4 +1,4 @@
-@echo off
+echo off
 setlocal EnableDelayedExpansion
 
 :: Set the default arguments for build
@@ -65,6 +65,7 @@ set "__IntermediatesDir=%__RootBinDir%\obj\%__BuildOS%.%__BuildArch%.%__BuildTyp
 set "__PackagesBinDir=%__BinDir%\.nuget"
 set "__TestBinDir=%__RootBinDir%\tests\%__BuildOS%.%__BuildArch%.%__BuildType%"
 set "__TestIntermediatesDir=%__RootBinDir%\tests\obj\%__BuildOS%.%__BuildArch%.%__BuildType%"
+set "__GeneratedIntermediatesDir=%__IntermediatesDir%\Generated"
 
 :: Generate path to be set for CMAKE_INSTALL_PREFIX to contain forward slash
 set "__CMakeBinDir=%__BinDir%"
@@ -197,6 +198,27 @@ exit /b 1
 
 REM Build CoreCLR
 :BuildCoreCLR
+:: Run Steps to Generate ETW specific infrastructure the 
+if exist "%__GeneratedIntermediatesDir%" rd /s /q "%__GeneratedIntermediatesDir%" ::Ensure there are no stale files in the Generated Directory
+md "%__GeneratedIntermediatesDir%"
+md "%__GeneratedIntermediatesDir%\inc"
+set "genetw=%__SourceDir%\scripts\genWinEtw.py"
+
+mc -h "%__GeneratedIntermediatesDir%\inc" -r "%__GeneratedIntermediatesDir%" -b -co -um -p FireEtw "%__SourceDir%\VM\ClrEtwAll.man"
+IF ERRORLEVEL 1 goto FailedToGenEtwMetadata 
+
+echo generating clretwallmain.h and etmdummy.h
+"%PythonPath%"  "%genetw%" --man "%__SourceDir%\VM\ClrEtwAll.man" --exc "%__SourceDir%\VM\ClrEtwAllMeta.lst" --eventheader "%__GeneratedIntermediatesDir%\inc\ClrEtwAll.h" --macroheader "%__GeneratedIntermediatesDir%\inc\clretwallmain.h" --dummy "%__GeneratedIntermediatesDir%\inc\etmdummy.h" 
+IF  ERRORLEVEL 1 goto FailedToGenEtwMetadata 
+
+goto BuildVM
+
+:FailedToGenEtwMetadata
+echo Failed to generate ETW specific files.
+exit /b %ERRORLEVEL%
+
+:BuildVM
+
 set "__CoreCLRBuildLog=%__LogsDir%\CoreCLR_%__BuildOS%__%__BuildArch%__%__BuildType%.log"
 if /i "%__BuildArch%" == "arm64" (  
   REM TODO, remove once we have msbuild support for this platform.

build.sh

@@ -27,6 +27,11 @@ setup_dirs()
     mkdir -p "$__BinDir"
     mkdir -p "$__LogsDir"
     mkdir -p "$__IntermediatesDir"
+
+    # Ensure there are no stale generated files
+    rm -rf "$__IntermediatesDir"
+    mkdir -p "$__GeneratedIntermediatesDir"
+    mkdir -p "$__GeneratedIntermediatesDir/inc"
 }
 
 # Performs "clean build" type actions (deleting and remaking directories)
@@ -67,6 +72,19 @@ build_coreclr()
     # All set to commence the build
 
     echo "Commencing build of native components for $__BuildOS.$__BuildArch.$__BuildType"
+    
+    echo "Laying out dynamically generated files consumed by the build system "
+    python "$__ProjectRoot/src/scripts/genXplatEventing.py" --man "$__ProjectRoot/src/vm/ClrEtwAll.man" --exc "$__ProjectRoot/src/vm/ClrEtwAllMeta.lst" --inc "$__GeneratedIntermediatesDir/inc" --dummy "$__GeneratedIntermediatesDir/inc/etmdummy.h" --testdir "$__GeneratedIntermediatesDir/eventprovider_tests"
+    
+    #determine the logging system
+    case $__BuildOS in
+        Linux)
+            python "$__ProjectRoot/src/scripts/genXplatLttng.py" --man "$__ProjectRoot/src/vm/ClrEtwAll.man" --intermediate "$__GeneratedIntermediatesDir/"
+            ;;
+        *)
+            ;;
+    esac
+
     cd "$__IntermediatesDir"
 
     generator=""
@@ -352,6 +370,7 @@ __ToolsDir="$__RootBinDir/tools"
 __TestWorkingDir="$__RootBinDir/tests/$__BuildOS.$__BuildArch.$__BuildType"
 __IntermediatesDir="$__RootBinDir/obj/$__BuildOS.$__BuildArch.$__BuildType"
 __TestIntermediatesDir="$__RootBinDir/tests/obj/$__BuildOS.$__BuildArch.$__BuildType"
+export __GeneratedIntermediatesDir="$__IntermediatesDir/Generated"
 
 # Specify path to be set for CMAKE_INSTALL_PREFIX.
 # This is where all built CoreClr libraries will copied to.

src/CMakeLists.txt

@@ -1,3 +1,4 @@
+include_directories($ENV{__GeneratedIntermediatesDir}/inc)
 include_directories("inc")
 include_directories("strongname/inc")
 include_directories("inc/winrt")

src/dlls/clretwrc/CMakeLists.txt

@@ -1,4 +1,5 @@
 include_directories(${CMAKE_CURRENT_BINARY_DIR})
+include_directories($ENV{__GeneratedIntermediatesDir})
 
 if(WIN32)
     # remove /ltcg from resource-only libraries
@@ -15,15 +16,6 @@ add_library(clretwrc SHARED
   clretwrc.rc
 )
 
-#Compile clretwall.man file to create clretwall.rc resource file
-add_custom_command(
-  TARGET clretwrc 
-  PRE_BUILD
-  COMMAND mc -h ${CMAKE_CURRENT_BINARY_DIR} -r ${CMAKE_CURRENT_BINARY_DIR} -b -co -um -p FireEtw ${VM_DIR}/ClrEtwAll.man
-  DEPENDS ${VM_DIR}/ClrEtwAll.man
-  COMMENT "MessageCompile ${VM_DIR}/ClrEtwAll.man"
-)
-
 # add the install targets
 install (TARGETS clretwrc DESTINATION .)
 

src/inc/eventtracebase.h

@@ -294,15 +294,10 @@ extern "C" {
         EtwCallout(RegHandle, Descriptor, NumberOfArguments, EventData)
 #endif //!DONOT_DEFINE_ETW_CALLBACK && !DACCESS_COMPILE
 
-#include <clretwallmain.h>
-
-#elif defined(__LINUX__)
-
-#include "clrallevents.h"
-#else
-#error "A tracing System has not been enabled for this Platform"
 #endif //!FEATURE_PAL
 
+#include "clretwallmain.h"
+
 // The bulk type event is too complex for MC.exe to auto-generate proper code.
 // Use code:BulkTypeEventLogger instead.
 #ifdef FireEtwBulkType