Work on event tracing continues

This commit is contained in:
Simon Rozman 2016-05-19 08:40:11 +02:00
parent 5f2429db15
commit f91507801b
4 changed files with 133 additions and 45 deletions

View File

@ -73,6 +73,7 @@
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>
<ClCompile Include="..\src\Base64.cpp" /> <ClCompile Include="..\src\Base64.cpp" />
<ClCompile Include="..\src\ETW.cpp" />
<ClCompile Include="..\src\StdAfx.cpp"> <ClCompile Include="..\src\StdAfx.cpp">
<PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader> <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Create</PrecompiledHeader>
<PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">Create</PrecompiledHeader> <PrecompiledHeader Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">Create</PrecompiledHeader>

View File

@ -17,6 +17,9 @@
<ClCompile Include="..\src\Base64.cpp"> <ClCompile Include="..\src\Base64.cpp">
<Filter>Source Files</Filter> <Filter>Source Files</Filter>
</ClCompile> </ClCompile>
<ClCompile Include="..\src\ETW.cpp">
<Filter>Source Files</Filter>
</ClCompile>
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<ClInclude Include="..\src\StdAfx.h"> <ClInclude Include="..\src\StdAfx.h">

View File

@ -25,10 +25,12 @@
#include <stdarg.h> #include <stdarg.h>
#include <string> #include <string>
#include <vector>
namespace winstd namespace winstd
{ {
class event_provider; class WINSTD_API event_data;
class WINSTD_API event_provider;
} }
#pragma once #pragma once
@ -43,10 +45,80 @@ namespace winstd
/// @{ /// @{
///
/// EVENT_DATA_DESCRIPTOR wrapper
///
class WINSTD_API event_data : public EVENT_DATA_DESCRIPTOR
{
public:
///
/// Construct empty class.
///
inline event_data()
{
Ptr = 0;
Size = 0;
Reserved = 0;
}
///
/// Template to construct class with generic data.
///
/// \note This class is saves a reference to the data only. Therefore, data must be kept available.
///
template<class T>
inline event_data(_In_ const T &data)
{
EventDataDescCreate(this, &data, (ULONG)(sizeof(T)));
}
///
/// Construct class with string.
///
/// \note This class is saves a reference to the data only. Therefore, data must be kept available.
///
inline event_data(_In_ const char *data)
{
EventDataDescCreate(this, data, (ULONG)((strlen(data) + 1) * sizeof(*data)));
}
///
/// Construct class with wide string.
///
/// \note This class is saves a reference to the data only. Therefore, data must be kept available.
///
inline event_data(_In_ const wchar_t *data)
{
EventDataDescCreate(this, data, (ULONG)((wcslen(data) + 1) * sizeof(*data)));
}
///
/// Template to construct class with string.
///
/// \note This class is saves a reference to the data only. Therefore, data must be kept available.
///
template<class _Elem, class _Traits, class _Ax>
inline event_data(_In_ const std::basic_string<_Elem, _Traits, _Ax> &data)
{
EventDataDescCreate(this, data.c_str(), (ULONG)((data.length() + 1) * sizeof(_Elem)));
}
///
/// Blank event data used as terminator.
///
static const event_data blank;
};
/// ///
/// ETW event provider /// ETW event provider
/// ///
class event_provider : public handle<REGHANDLE> class WINSTD_API event_provider : public handle<REGHANDLE>
{ {
public: public:
/// ///
@ -80,22 +152,6 @@ namespace winstd
} }
///
/// Writes an event.
///
/// \return
/// - `ERROR_SUCCESS` when write succeeds;
/// - error code otherwise.
///
/// \sa [EventWrite function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363752.aspx)
///
inline ULONG write(_In_ PCEVENT_DESCRIPTOR EventDescriptor, _In_ ULONG UserDataCount = 0, _In_opt_count_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData = NULL)
{
assert(m_h);
return EventWrite(m_h, EventDescriptor, UserDataCount, UserData);
}
/// ///
/// Writes an event with no parameters. /// Writes an event with no parameters.
/// ///
@ -113,7 +169,7 @@ namespace winstd
/// ///
/// Writes an event with one parameter. /// Writes an event with parameters stored in array.
/// ///
/// \return /// \return
/// - `ERROR_SUCCESS` when write succeeds; /// - `ERROR_SUCCESS` when write succeeds;
@ -121,18 +177,15 @@ namespace winstd
/// ///
/// \sa [EventWrite function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363752.aspx) /// \sa [EventWrite function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363752.aspx)
/// ///
template <class T1> inline ULONG write(_In_ PCEVENT_DESCRIPTOR EventDescriptor, _In_ ULONG UserDataCount = 0, _In_opt_count_(UserDataCount) PEVENT_DATA_DESCRIPTOR UserData = NULL)
inline ULONG write(_In_ PCEVENT_DESCRIPTOR EventDescriptor, _In_ const T1 param1)
{ {
assert(m_h); assert(m_h);
EVENT_DATA_DESCRIPTOR edd; return EventWrite(m_h, EventDescriptor, UserDataCount, UserData);
EventDataDescCreate(&edd, &param1, (ULONG)(sizeof(T1)));
return EventWrite(m_h, EventDescriptor, 1, &edd);
} }
/// ///
/// Writes an event with one string as parameter. /// Writes an event with one or more parameter.
/// ///
/// \return /// \return
/// - `ERROR_SUCCESS` when write succeeds; /// - `ERROR_SUCCESS` when write succeeds;
@ -140,30 +193,33 @@ namespace winstd
/// ///
/// \sa [EventWrite function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363752.aspx) /// \sa [EventWrite function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363752.aspx)
/// ///
inline ULONG write(_In_ PCEVENT_DESCRIPTOR EventDescriptor, _In_ const char *param1) inline ULONG write(_In_ PCEVENT_DESCRIPTOR EventDescriptor, _In_ const EVENT_DATA_DESCRIPTOR &param1, ...)
{ {
assert(m_h); assert(m_h);
EVENT_DATA_DESCRIPTOR edd;
EventDataDescCreate(&edd, param1, (ULONG)(strlen(param1) + 1)*sizeof(*param1)); va_list arg;
return EventWrite(m_h, EventDescriptor, 1, &edd); std::vector<EVENT_DATA_DESCRIPTOR> params;
ULONG param_count;
// Preallocate array.
va_start(arg, param1);
for (param_count = 1;; param_count++) {
EVENT_DATA_DESCRIPTOR &p = va_arg(arg, EVENT_DATA_DESCRIPTOR);
if (!p.Ptr) break;
} }
va_end(arg);
params.reserve(param_count);
// Copy parameters to array.
va_start(arg, param1);
for (params.push_back(param1);;) {
EVENT_DATA_DESCRIPTOR &p = va_arg(arg, EVENT_DATA_DESCRIPTOR);
if (!p.Ptr) break;
params.push_back(p);
}
va_end(arg);
/// return EventWrite(m_h, EventDescriptor, param_count, params.data());
/// Writes an event with one wide string as parameter.
///
/// \return
/// - `ERROR_SUCCESS` when write succeeds;
/// - error code otherwise.
///
/// \sa [EventWrite function](https://msdn.microsoft.com/en-us/library/windows/desktop/aa363752.aspx)
///
inline ULONG write(_In_ PCEVENT_DESCRIPTOR EventDescriptor, _In_ const wchar_t *param1)
{
assert(m_h);
EVENT_DATA_DESCRIPTOR edd;
EventDataDescCreate(&edd, param1, (ULONG)(wcslen(param1) + 1)*sizeof(*param1));
return EventWrite(m_h, EventDescriptor, 1, &edd);
} }

28
src/ETW.cpp Normal file
View File

@ -0,0 +1,28 @@
/*
Copyright 1991-2016 Amebis
Copyright 2016 GÉANT
This file is part of WinStd.
Setup is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Setup is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Setup. If not, see <http://www.gnu.org/licenses/>.
*/
#include "StdAfx.h"
//////////////////////////////////////////////////////////////////////
// winstd::event_data
//////////////////////////////////////////////////////////////////////
const winstd::event_data winstd::event_data::blank;