summaryrefslogtreecommitdiff
path: root/src/vm/eventpipeeventinstance.cpp
blob: 5b214a13b3c702257e6441d44befeab68e165f67 (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
// 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 "eventpipeconfiguration.h"
#include "eventpipeeventinstance.h"
#include "eventpipejsonfile.h"
#include "fastserializer.h"
#include "sampleprofiler.h"

#ifdef FEATURE_PERFTRACING

EventPipeEventInstance::EventPipeEventInstance(
    EventPipeEvent &event,
    unsigned int procNumber,
    ULONGLONG threadId,
    BYTE *pData,
    unsigned int length,
    LPCGUID pActivityId,
    LPCGUID pRelatedActivityId)
{
    CONTRACTL
    {
        NOTHROW;
        GC_NOTRIGGER;
        MODE_ANY;
    }
    CONTRACTL_END;

#ifdef _DEBUG
    m_debugEventStart = 0xDEADBEEF;
    m_debugEventEnd = 0xCAFEBABE;
#endif // _DEBUG
    m_pEvent = &event;
    m_procNumber = procNumber;
    m_threadId = threadId;
    if (pActivityId != NULL)
    {
        m_activityId = *pActivityId;
    }
    else
    {
        m_activityId = {0};
    }
    if (pRelatedActivityId != NULL)
    {
        m_relatedActivityId = *pRelatedActivityId;
    }
    else
    {
        m_relatedActivityId = {0};
    }

    m_pData = pData;
    m_dataLength = length;
    QueryPerformanceCounter(&m_timeStamp);
    _ASSERTE(m_timeStamp.QuadPart > 0);
#ifdef _DEBUG
    EnsureConsistency();
#endif // _DEBUG
}

void EventPipeEventInstance::EnsureStack(const EventPipeSession &session)
{
    if (m_pEvent->NeedStack() && !session.RundownEnabled())
    {
        EventPipe::WalkManagedStackForCurrentThread(m_stackContents);
    }
}

unsigned int EventPipeEventInstance::GetAlignedTotalSize(EventPipeSerializationFormat format) const
{
    CONTRACT(unsigned int)
    {
        NOTHROW;
        GC_NOTRIGGER;
        MODE_ANY;
        POSTCONDITION(RETVAL % ALIGNMENT_SIZE == 0);
    }
    CONTRACT_END;

    // Calculate the size of the total payload so that it can be written to the file.
    unsigned int payloadLength = 0;

    if (format == EventPipeSerializationFormat::NetPerfV3)
    {
        payloadLength =
            sizeof(m_metadataId) +          // Metadata ID
            sizeof(DWORD) +                 // Thread ID
            sizeof(m_timeStamp) +           // TimeStamp
            sizeof(m_activityId) +          // Activity ID
            sizeof(m_relatedActivityId) +   // Related Activity ID
            sizeof(m_dataLength) +          // Data payload length
            m_dataLength +                  // Event payload data
            sizeof(unsigned int) +          // Prepended stack payload size in bytes
            m_stackContents.GetSize();      // Stack payload size
    }
    else if (format == EventPipeSerializationFormat::NetTraceV4)
    {
        payloadLength =
            sizeof(m_metadataId) +          // Metadata ID
            sizeof(unsigned int) +          // Sequence number (implied by the buffer containing the event instance)
            sizeof(m_threadId) +            // Thread ID
            sizeof(ULONGLONG) +             // Capture Thread ID (implied by the buffer containing the event instance)
            sizeof(m_procNumber) +          // ProcNumber
            sizeof(unsigned int) +          // Stack intern table id
            sizeof(m_timeStamp) +           // TimeStamp
            sizeof(m_activityId) +          // Activity ID
            sizeof(m_relatedActivityId) +   // Related Activity ID
            sizeof(m_dataLength) +          // Data payload length
            m_dataLength;                   // Event payload data
    }
    else
    {
        _ASSERTE(!"Unrecognized format");
    }


    // round up to ALIGNMENT_SIZE bytes
    if (payloadLength % ALIGNMENT_SIZE != 0)
    {
        payloadLength += ALIGNMENT_SIZE - (payloadLength % ALIGNMENT_SIZE);
    }

    RETURN payloadLength;
}

#ifdef _DEBUG
void EventPipeEventInstance::SerializeToJsonFile(EventPipeJsonFile *pFile)
{
    CONTRACTL
    {
        NOTHROW;
        GC_NOTRIGGER;
        MODE_ANY;
    }
    CONTRACTL_END;

    if(pFile == NULL)
    {
        return;
    }

    EX_TRY
    {
        StackScratchBuffer scratch;
        SString providerName = m_pEvent->GetProvider()->GetProviderName();

        SString message;
        message.Printf("Provider=%s/EventID=%d/Version=%d", providerName.GetANSI(scratch), m_pEvent->GetEventID(), m_pEvent->GetEventVersion());
        pFile->WriteEvent(m_timeStamp, (DWORD)m_threadId, message, m_stackContents);
    }
    EX_CATCH{} EX_END_CATCH(SwallowAllExceptions);
}
#endif

void EventPipeEventInstance::SetTimeStamp(LARGE_INTEGER timeStamp)
{
    LIMITED_METHOD_CONTRACT;

    m_timeStamp = timeStamp;
}

#ifdef _DEBUG
bool EventPipeEventInstance::EnsureConsistency()
{
    CONTRACTL
    {
        NOTHROW;
        GC_NOTRIGGER;
        MODE_ANY;
    }
    CONTRACTL_END;

    // Validate event start.
    _ASSERTE(m_debugEventStart == 0xDEADBEEF);

    // Validate event end.
    _ASSERTE(m_debugEventEnd == 0xCAFEBABE);

    return true;
}
#endif // _DEBUG

EventPipeSequencePoint::EventPipeSequencePoint()
{
    LIMITED_METHOD_CONTRACT;
    TimeStamp.QuadPart = 0;
}

EventPipeSequencePoint::~EventPipeSequencePoint()
{
    // Each entry in the map owns a ref-count on the corresponding thread
    for (ThreadSequenceNumberMap::Iterator pCur = ThreadSequenceNumbers.Begin();
        pCur != ThreadSequenceNumbers.End();
        pCur++)
    {
        pCur->Key()->GetThread()->Release();
    }
}

#endif // FEATURE_PERFTRACING