Merge pull request microsoft#196 from microsoft/dev/willxie/d2m

Merge develop to master for 1.0.31 release

Author: willxie-eng

CHANGELOG.md

@@ -7,6 +7,11 @@ Please format the changes as follows:
 + BugFixes:
 + Updates:
 
+# 1.0.31
++ BugFixes:
+  + Avoid deadlock within ProxyLogging when terminating logging.
+  + Fixed CLRIE to correctly emit ldloca instead of ldloc.
+
 # 1.0.30
 + New:
   + Add configuration for InstrumentationMethod loglevels

build/Version.props

@@ -12,7 +12,7 @@
     -->
     <SemanticVersionMajor>1</SemanticVersionMajor>
     <SemanticVersionMinor>0</SemanticVersionMinor>
-    <SemanticVersionPatch>30</SemanticVersionPatch>
+    <SemanticVersionPatch>31</SemanticVersionPatch>
 
     <FileVersionMajor>15</FileVersionMajor>
     <FileVersionMinor>1</FileVersionMinor>
@@ -30,15 +30,15 @@
      -->
     <ProxyFileVersionMajor>$(SemanticVersionMajor)</ProxyFileVersionMajor>
     <ProxyFileVersionMinor>0</ProxyFileVersionMinor>
-    <ProxyFileVersionPatch>1</ProxyFileVersionPatch>
+    <ProxyFileVersionPatch>2</ProxyFileVersionPatch>
     <ProxyFileVersion>$(ProxyFileVersionMajor).$(ProxyFileVersionMinor).$(ProxyFileVersionPatch)</ProxyFileVersion>
 
     <!--
       Date when Semantic Version was changed.
       Update for every public release.
       Format is YYYY-MM-DD
     -->
-    <SemanticVersionDate>2019-11-13</SemanticVersionDate>
+    <SemanticVersionDate>2020-01-08</SemanticVersionDate>
 
     <!--
       Build version is used to distinguish internally built NuGet packages.

src/Common.Lib/EventLoggingBase.cpp

@@ -141,7 +141,7 @@ HRESULT CEventLoggingBase::TerminateEventSource()
     // Allow thread to drain the queue
     if (m_hEventQueueThread)
     {
-        WaitForSingleObject(m_hEventQueueThread, INFINITE);
+        WaitForSingleObject(m_hEventQueueThread, 15 * 1000 /* 15 second timeout */);
     }
 
     // Block scope used to release critical section before end of method.

src/InstrumentationEngine.ProfilerProxy.Lib/EventLogger.cpp

@@ -9,6 +9,7 @@ using namespace ProfilerProxy;
 CEventLogger::CEventLogger() :
     m_initEventSource([=]() { return InitializeEventSource(_T("Instrumentation Engine Profiler Proxy")); })
 {
+    Initialize();
 }
 
 CEventLogger::~CEventLogger()
@@ -32,6 +33,36 @@ void CEventLogger::FormatAndAppendToQueue(_In_ WORD wType, _In_ LPCWSTR wszMessa
     AppendToQueue(wType, wszLogEntry);
 }
 
+void CEventLogger::LogMessage(_In_ const WCHAR* wszMessage, ...)
+{
+    IfNotInitRet(m_initEventSource);
+
+    va_list argptr;
+    va_start(argptr, wszMessage);
+    LogMessage(wszMessage, argptr);
+    va_end(argptr);
+}
+
+void CEventLogger::LogWarning(_In_ const WCHAR* wszMessage, ...)
+{
+    IfNotInitRet(m_initEventSource);
+
+    va_list argptr;
+    va_start(argptr, wszMessage);
+    LogWarning(wszMessage, argptr);
+    va_end(argptr);
+}
+
+void CEventLogger::LogError(_In_ const WCHAR* wszError, ...)
+{
+    IfNotInitRet(m_initEventSource);
+
+    va_list argptr;
+    va_start(argptr, wszError);
+    LogError(wszError, argptr);
+    va_end(argptr);
+}
+
 void CEventLogger::LogMessage(_In_ LPCWSTR wszMessage, _In_ va_list argptr)
 {
     FormatAndAppendToQueue(EVENTLOG_INFORMATION_TYPE, wszMessage, argptr);
@@ -61,8 +92,12 @@ void CEventLogger::LogError(_In_ LPCWSTR wszError, _In_ va_list argptr)
 
 HRESULT CEventLogger::Shutdown()
 {
-    HRESULT hr = TerminateEventSource();
-    m_initEventSource.Reset();
+    HRESULT hr = S_OK;
+    if (m_initEventSource.IsSuccessful())
+    {
+        hr = TerminateEventSource();
+        m_initEventSource.Reset();
+    }
 
     return hr;
 }

src/InstrumentationEngine.ProfilerProxy.Lib/EventLogger.h

@@ -24,6 +24,10 @@ namespace ProfilerProxy
 
         HRESULT Initialize();
 
+        void LogMessage(_In_ const WCHAR* szMessage, ...);
+        void LogWarning(_In_ const WCHAR* szMessage, ...);
+        void LogError(_In_ const WCHAR* szError, ...);
+
         void LogMessage(_In_ LPCWSTR wszMessage, _In_ va_list argptr);
         void LogWarning(_In_ LPCWSTR wszWarning, _In_ va_list argptr);
         void LogError(_In_ LPCWSTR wszError, _In_ va_list argptr);

src/InstrumentationEngine.ProfilerProxy.Lib/stdafx.h

@@ -5,7 +5,7 @@
 
 #ifndef IfFailRet_Proxy
 #define IfFailRet_Proxy(EXPR) \
-    do { if (FAILED(hr = (EXPR))) { CProxyLogging::LogError(_T("IfFailRet(") _T(#EXPR) _T(") failed in function ") __FUNCTIONT__); return hr; } } while (false)
+    do { if (FAILED(hr = (EXPR))) { eventLogger.LogError(_T("IfFailRet(") _T(#EXPR) _T(") failed in function ") __FUNCTIONT__); return hr; } } while (false)
 #endif
 
 #ifndef IfFailRetErrno_Proxy

src/InstrumentationEngine.ProfilerProxy/InstrumentationEngine.ProfilerProxy.vcxproj

@@ -111,13 +111,11 @@
   </ItemDefinitionGroup>
   <ItemGroup>
     <ClCompile Include="dllmain.cpp" />
-    <ClCompile Include="ProxyLogging.cpp" />
     <ClCompile Include="stdafx.cpp">
       <PrecompiledHeader>Create</PrecompiledHeader>
     </ClCompile>
   </ItemGroup>
   <ItemGroup>
-    <ClInclude Include="ProxyLogging.h" />
     <ClInclude Include="stdafx.h" />
   </ItemGroup>
   <ItemGroup>