[EventPipe] Adding an IPC server to handle out of process communication. (#23106)

This is the first commit to enable a "diagnostic port" using IPC (Named Pipe on Windows and Unix Domain Socket on other platforms). This change currently enable EventPipe to be enabled/disabled without the use of a file drop.
- Split the DiagnosticsIpc into (DiagnosticsIpc/IpcStream)
  - DiagnosticsIpc (IPC listener) is meant to be used by the Diagnostic server.
  - IpcStream (IPC channel) is meant to be use to communicate with the connected client.
- Change the FastSerializer dependency from `CFileStream` to `StreamWriter`
  This abstraction is meant decouple the writing of objects in order to extend its usability.
  The main objective is to reuse FastSerializer to stream data through the open IPC channel.
- Moved the EventPipeSessionProvider* classes to their own file.
- Added a more streamlined parsing achievable by defining a simpler binary protocol (by noahfalk).
  1. Only one allocation is needed for the EventPipeProviderConfiguration array, no allocations or copies are needed for strings because we can refer to them directly out of the incoming command buffer
  2. No change to the EventPipe API for enable is required. EventPipeProviderConfiguration retains its current behavior of not deleting the string pointers it holds.
  3. No leaks happen because the command buffer owns the string memory and ensures that it stays alive for the duration of the Enable() call.

1 files changed, 6 insertions, 220 deletions

diff --git a/src/vm/eventpipesession.cpp b/src/vm/eventpipesession.cpp
index 7388472c7d..03bc6c681a 100644
--- a/src/vm/eventpipesession.cpp
+++ b/src/vm/eventpipesession.cpp
@@ -6,30 +6,30 @@
 #include "eventpipe.h"
 #include "eventpipeprovider.h"
 #include "eventpipesession.h"
+#include "eventpipesessionprovider.h"
 
 #ifdef FEATURE_PERFTRACING
 
 EventPipeSession::EventPipeSession(
     EventPipeSessionType sessionType,
     unsigned int circularBufferSizeInMB,
-    EventPipeProviderConfiguration *pProviders,
-    unsigned int numProviders,
-    UINT64 multiFileTraceLengthInSeconds)
+    const EventPipeProviderConfiguration *pProviders,
+    uint32_t numProviders,
+    uint64_t multiFileTraceLengthInSeconds)
 {
     CONTRACTL
     {
         THROWS;
         GC_NOTRIGGER;
         MODE_ANY;
+        PRECONDITION((numProviders == 0) || (numProviders > 0 && pProviders != nullptr));
     }
     CONTRACTL_END;
 
     m_sessionType = sessionType;
     m_circularBufferSizeInBytes = circularBufferSizeInMB * 1024 * 1024; // 1MB;
     m_rundownEnabled = false;
-    m_pProviderList = new EventPipeSessionProviderList(
-        pProviders,
-        numProviders);
+    m_pProviderList = new EventPipeSessionProviderList(pProviders, numProviders);
     m_multiFileTraceLengthInSeconds = multiFileTraceLengthInSeconds;
     GetSystemTimeAsFileTime(&m_sessionStartTime);
     QueryPerformanceCounter(&m_sessionStartTimeStamp);
@@ -90,218 +90,4 @@ EventPipeSessionProvider* EventPipeSession::GetSessionProvider(EventPipeProvider
     return m_pProviderList->GetSessionProvider(pProvider);
 }
 
-EventPipeSessionProviderList::EventPipeSessionProviderList(
-    EventPipeProviderConfiguration *pConfigs,
-    unsigned int numConfigs)
-{
-    CONTRACTL
-    {
-        THROWS;
-        GC_NOTRIGGER;
-        MODE_ANY;
-    }
-    CONTRACTL_END;
-
-    m_pProviders = new SList<SListElem<EventPipeSessionProvider*>>();
-    m_pCatchAllProvider = NULL;
-    for(unsigned int i=0; i<numConfigs; i++)
-    {
-        EventPipeProviderConfiguration *pConfig = &pConfigs[i];
-
-        // Enable all events if the provider name == '*', all keywords are on and the requested level == verbose.
-        if((wcscmp(W("*"), pConfig->GetProviderName()) == 0) && (pConfig->GetKeywords() == 0xFFFFFFFFFFFFFFFF) && ((EventPipeEventLevel)pConfig->GetLevel() == EventPipeEventLevel::Verbose) && (m_pCatchAllProvider == NULL))
-        {
-            m_pCatchAllProvider = new EventPipeSessionProvider(NULL, 0xFFFFFFFFFFFFFFFF, EventPipeEventLevel::Verbose, NULL);
-        }
-        else
-        {
-            EventPipeSessionProvider *pProvider = new EventPipeSessionProvider(
-                pConfig->GetProviderName(),
-                pConfig->GetKeywords(),
-                (EventPipeEventLevel)pConfig->GetLevel(),
-                pConfig->GetFilterData());
-
-            m_pProviders->InsertTail(new SListElem<EventPipeSessionProvider*>(pProvider));
-        }
-    }
-}
-
-EventPipeSessionProviderList::~EventPipeSessionProviderList()
-{
-    CONTRACTL
-    {
-        NOTHROW;
-        GC_NOTRIGGER;
-        MODE_ANY;
-    }
-    CONTRACTL_END;
-
-    if(m_pProviders != NULL)
-    {
-        SListElem<EventPipeSessionProvider*> *pElem = m_pProviders->GetHead();
-        while(pElem != NULL)
-        {
-            EventPipeSessionProvider *pProvider = pElem->GetValue();
-            delete pProvider;
-
-            SListElem<EventPipeSessionProvider*> *pCurElem = pElem;
-            pElem = m_pProviders->GetNext(pElem);
-            delete pCurElem;
-        }
-
-        delete m_pProviders;
-        m_pProviders = NULL;
-    }
-    if(m_pCatchAllProvider != NULL)
-    {
-        delete(m_pCatchAllProvider);
-        m_pCatchAllProvider = NULL;
-    }
-}
-
-void EventPipeSessionProviderList::AddSessionProvider(EventPipeSessionProvider *pProvider)
-{
-    CONTRACTL
-    {
-        THROWS;
-        GC_NOTRIGGER;
-        MODE_ANY;
-    }
-    CONTRACTL_END;
-
-    if(pProvider != NULL)
-    {
-        m_pProviders->InsertTail(new SListElem<EventPipeSessionProvider*>(pProvider));
-    }
-}
-
-EventPipeSessionProvider* EventPipeSessionProviderList::GetSessionProvider(
-    EventPipeProvider *pProvider)
-{
-    CONTRACTL
-    {
-        THROWS;
-        GC_NOTRIGGER;
-        MODE_ANY;
-    }
-    CONTRACTL_END;
-
-    // Exists when tracing was enabled at start-up and all events were requested. This is a diagnostic config.
-    if(m_pCatchAllProvider != NULL)
-    {
-        return m_pCatchAllProvider;
-    }
-
-    if(m_pProviders == NULL)
-    {
-        return NULL;
-    }
-
-    SString providerNameStr = pProvider->GetProviderName();
-    LPCWSTR providerName = providerNameStr.GetUnicode();
-
-    EventPipeSessionProvider *pSessionProvider = NULL;
-    SListElem<EventPipeSessionProvider*> *pElem = m_pProviders->GetHead();
-    while(pElem != NULL)
-    {
-        EventPipeSessionProvider *pCandidate = pElem->GetValue();
-        if(wcscmp(providerName, pCandidate->GetProviderName()) == 0)
-        {
-            pSessionProvider = pCandidate;
-            break;
-        }
-        pElem = m_pProviders->GetNext(pElem);
-    }
-
-    return pSessionProvider;
-}
-
-bool EventPipeSessionProviderList::IsEmpty() const
-{
-    LIMITED_METHOD_CONTRACT;
-
-    return (m_pProviders->IsEmpty() && m_pCatchAllProvider == NULL);
-}
-
-EventPipeSessionProvider::EventPipeSessionProvider(
-    LPCWSTR providerName,
-    UINT64 keywords,
-    EventPipeEventLevel loggingLevel,
-    LPCWSTR filterData)
-{
-    CONTRACTL
-    {
-        THROWS;
-        GC_NOTRIGGER;
-        MODE_ANY;
-    }
-    CONTRACTL_END;
-
-    if(providerName != NULL)
-    {
-        size_t bufSize = wcslen(providerName) + 1;
-        m_pProviderName = new WCHAR[bufSize];
-        wcscpy_s(m_pProviderName, bufSize, providerName);
-    }
-    else
-    {
-        m_pProviderName = NULL;
-    }
-    m_keywords = keywords;
-    m_loggingLevel = loggingLevel;
-
-    if(filterData != NULL)
-    {
-        size_t bufSize = wcslen(filterData) + 1;
-        m_pFilterData = new WCHAR[bufSize];
-        wcscpy_s(m_pFilterData, bufSize, filterData);
-    }
-    else
-    {
-        m_pFilterData = NULL;
-    }
-}
-
-EventPipeSessionProvider::~EventPipeSessionProvider()
-{
-    CONTRACTL
-    {
-        NOTHROW;
-        GC_NOTRIGGER;
-        MODE_ANY;
-    }
-    CONTRACTL_END;
-
-    // C++ standard, $5.3.5/2: Deleting a NULL pointer is safe.
-    delete[] m_pProviderName;
-    m_pProviderName = NULL;
-
-    delete[] m_pFilterData;
-    m_pFilterData = NULL;
-}
-
-LPCWSTR EventPipeSessionProvider::GetProviderName() const
-{
-    LIMITED_METHOD_CONTRACT;
-    return m_pProviderName;
-}
-
-UINT64 EventPipeSessionProvider::GetKeywords() const
-{
-    LIMITED_METHOD_CONTRACT;
-    return m_keywords;
-}
-
-EventPipeEventLevel EventPipeSessionProvider::GetLevel() const
-{
-    LIMITED_METHOD_CONTRACT;
-    return m_loggingLevel;
-}
-
-LPCWSTR EventPipeSessionProvider::GetFilterData() const
-{
-    LIMITED_METHOD_CONTRACT;
-    return m_pFilterData;
-}
-
 #endif // FEATURE_PERFTRACING