summaryrefslogtreecommitdiff
path: root/src/vm/eventpipeprotocolhelper.cpp
blob: 24eb2b0ef55ca9d79dd0213a332be654497710bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#include "common.h"
#include "eventpipeprotocolhelper.h"
#include "diagnosticsipc.h"
#include "diagnosticsprotocol.h"

#ifdef FEATURE_PERFTRACING

bool EventPipeProtocolHelper::TryParseProviderConfiguration(uint8_t *&bufferCursor, uint32_t &bufferLen, CQuickArray<EventPipeProviderConfiguration> &result)
{
    // Picking an arbitrary upper bound,
    // This should be larger than any reasonable client request.
    const uint32_t MaxCountConfigs = 1000; // TODO: This might be too large.

    uint32_t countConfigs = 0;
    if (!TryParse(bufferCursor, bufferLen, countConfigs))
        return false;
    if (countConfigs > MaxCountConfigs)
        return false;
    EventPipeProviderConfiguration *pConfigs = result.AllocNoThrow(countConfigs);
    if (pConfigs == nullptr)
        return false;

    for (uint32_t i = 0; i < countConfigs; i++)
    {
        uint64_t keywords = 0;
        if (!TryParse(bufferCursor, bufferLen, keywords))
            return false;

        uint32_t logLevel = 0;
        if (!TryParse(bufferCursor, bufferLen, logLevel))
            return false;
        if (logLevel > 5) // (logLevel > EventPipeEventLevel::Verbose)
            return false;

        LPCWSTR pProviderName = nullptr;
        if (!TryParseString(bufferCursor, bufferLen, pProviderName))
            return false;
        if (wcslen(pProviderName) == 0)
            return false; // TODO: Should we ignore these input?

        LPCWSTR pFilterData = nullptr; // This parameter is optional.
        TryParseString(bufferCursor, bufferLen, pFilterData);

        pConfigs[i] = EventPipeProviderConfiguration(pProviderName, keywords, logLevel, pFilterData);
    }
    return true;
}

void EventPipeProtocolHelper::EnableFileTracingEventHandler(IpcStream *pStream)
{
    CONTRACTL
    {
        THROWS;
        GC_TRIGGERS;
        MODE_ANY;
        PRECONDITION(pStream != nullptr);
    }
    CONTRACTL_END;

    // TODO: Read within a loop.
    uint8_t buffer[IpcStreamReadBufferSize]{};
    uint32_t nNumberOfBytesRead = 0;
    bool fSuccess = pStream->Read(buffer, sizeof(buffer), nNumberOfBytesRead);
    if (!fSuccess)
    {
        // TODO: Add error handling.
        delete pStream;
        return;
    }

    // The protocol buffer is defined as:
    // X, Y, Z means encode bytes for X followed by bytes for Y followed by bytes for Z
    // message = uint circularBufferMB, string outputPath, array<provider_config> providers
    // uint = 4 little endian bytes
    // ulong = 8 little endian bytes
    // wchar = 2 little endian bytes, UTF16 encoding
    // array<T> = uint length, length # of Ts
    // string = (array<char> where the last char must = 0) or (length = 0)
    // provider_config = ulong keywords, uint logLevel, string provider_name, string filter_data

    LPCWSTR strOutputPath;
    uint32_t circularBufferSizeInMB = EventPipeProtocolHelper::DefaultCircularBufferMB;
    CQuickArray<EventPipeProviderConfiguration> providerConfigs;

    uint8_t *pBufferCursor = buffer;
    uint32_t bufferLen = nNumberOfBytesRead;
    if (!TryParse(pBufferCursor, bufferLen, circularBufferSizeInMB) ||
        !TryParseString(pBufferCursor, bufferLen, strOutputPath) ||
        !TryParseProviderConfiguration(pBufferCursor, bufferLen, providerConfigs))
    {
        // TODO: error handling
        delete pStream;
        return;
    }

    EventPipeSessionID sessionId = (EventPipeSessionID) nullptr;
    if (providerConfigs.Size() > 0)
    {
        sessionId = EventPipe::Enable(
            strOutputPath,                                  // outputFile
            circularBufferSizeInMB,                         // circularBufferSizeInMB
            DefaultProfilerSamplingRateInNanoseconds,       // ProfilerSamplingRateInNanoseconds
            providerConfigs.Ptr(),                          // pConfigs
            static_cast<uint32_t>(providerConfigs.Size())); // numConfigs
    }

    uint32_t nBytesWritten = 0;
    fSuccess = pStream->Write(&sessionId, sizeof(sessionId), nBytesWritten);
    if (!fSuccess)
    {
        // TODO: Add error handling.
        delete pStream;
        return;
    }

    fSuccess = pStream->Flush();
    if (!fSuccess)
    {
        // TODO: Add error handling.
    }
    delete pStream;
}

void EventPipeProtocolHelper::DisableFileTracingEventHandler(IpcStream *pStream)
{
    CONTRACTL
    {
        THROWS;
        GC_TRIGGERS;
        MODE_ANY;
        PRECONDITION(pStream != nullptr);
    }
    CONTRACTL_END;

    uint32_t nNumberOfBytesRead = 0;
    EventPipeSessionID sessionId = (EventPipeSessionID) nullptr;
    bool fSuccess = pStream->Read(&sessionId, sizeof(sessionId), nNumberOfBytesRead);
    if (!fSuccess || nNumberOfBytesRead != sizeof(sessionId))
    {
        // TODO: Add error handling.
        delete pStream;
        return;
    }

    EventPipe::Disable(sessionId);
    uint32_t nBytesWritten = 0;
    fSuccess = pStream->Write(&sessionId, sizeof(sessionId), nBytesWritten);
    if (!fSuccess)
    {
        // TODO: Add error handling.
        delete pStream;
        return;
    }

    fSuccess = pStream->Flush();
    if (!fSuccess)
    {
        // TODO: Add error handling.
    }
    delete pStream;
}

void EventPipeProtocolHelper::AttachTracingEventHandler(IpcStream *pStream)
{
    CONTRACTL
    {
        THROWS;
        GC_TRIGGERS;
        MODE_ANY;
        PRECONDITION(pStream != nullptr);
    }
    CONTRACTL_END;

    // TODO: Read within a loop.
    uint8_t buffer[IpcStreamReadBufferSize]{};
    uint32_t nNumberOfBytesRead = 0;
    bool fSuccess = pStream->Read(buffer, sizeof(buffer), nNumberOfBytesRead);
    if (!fSuccess)
    {
        // TODO: Add error handling.
        delete pStream;
        return;
    }

    // The protocol buffer is defined as:
    // X, Y, Z means encode bytes for X followed by bytes for Y followed by bytes for Z
    // message = uint circularBufferMB, string outputPath, array<provider_config> providers
    // uint = 4 little endian bytes
    // wchar = 2 little endian bytes, UTF16 encoding
    // array<T> = uint length, length # of Ts
    // string = (array<char> where the last char must = 0) or (length = 0)
    // provider_config = ulong keywords, uint logLevel, string provider_name, string filter_data

    LPCWSTR strOutputPath;
    uint32_t circularBufferSizeInMB = EventPipeProtocolHelper::DefaultCircularBufferMB;
    CQuickArray<EventPipeProviderConfiguration> providerConfigs;

    uint8_t *pBufferCursor = buffer;
    uint32_t bufferLen = nNumberOfBytesRead;
    if (!TryParse(pBufferCursor, bufferLen, circularBufferSizeInMB) ||
        !TryParseString(pBufferCursor, bufferLen, strOutputPath) ||
        !TryParseProviderConfiguration(pBufferCursor, bufferLen, providerConfigs))
    {
        // TODO: error handling
        delete pStream;
        return;
    }

    if (providerConfigs.Size() > 0)
    {
        EventPipe::Enable(
            pStream,                                        // IPC stream
            circularBufferSizeInMB,                         // circularBufferSizeInMB
            DefaultProfilerSamplingRateInNanoseconds,       // ProfilerSamplingRateInNanoseconds
            providerConfigs.Ptr(),                          // pConfigs
            static_cast<uint32_t>(providerConfigs.Size())); // numConfigs
    }
}

#endif // FEATURE_PERFTRACING