Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Etw › ENABLE_TRACE_PARAMETERS_V1

ENABLE_TRACE_PARAMETERS_V1

構造体
サイズx64: 40 バイト / x86: 32 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
VersionDWORD4+0+0ENABLE_TRACE_PARAMETERS_VERSION (1) を設定します。
EnablePropertyDWORD4+4+4

イベントの書き込み時に ETW が含めることができる省略可能な情報です。データはイベントの extended data item セクションに書き込まれます。省略可能な情報を含めるには、次のフラグを 1 つ以上指定します。含めない場合は 0 を設定します。

  • EVENT_ENABLE_PROPERTY_SID

    拡張データにユーザーのセキュリティ識別子 (SID) を含めます。

  • EVENT_ENABLE_PROPERTY_TS_ID

    拡張データにターミナル セッション識別子を含めます。

  • EVENT_ENABLE_PROPERTY_STACK_TRACE

    EventWrite を使用して書き込まれたイベントの拡張データに、呼び出し履歴 (コール スタック) のトレースを追加します。

    メモ

    イベント全体のサイズが 64K を超えると、ETW はそのイベントを破棄します。プロバイダーが 64K の上限に近いサイズのイベントをログに記録している場合、スタックのキャプチャを有効にするとイベントが失われる可能性があります。

    スタックがフレームの最大数 (192) を超える場合、フレームはスタックの末尾から切り捨てられます。

    コンシューマーにとっては、イベントに EVENT_EXTENDED_ITEM_STACK_TRACE32 または EVENT_EXTENDED_ITEM_STACK_TRACE64 拡張項目が含まれます。32 ビットのコンシューマーが 64 ビット プロセスから 64 ビットのスタック トレースを受け取る場合があることに注意してください。

ControlFlagsDWORD4+8+8予約済みです。0 を設定します。
SourceIdGUID16+12+12プロバイダーを有効または無効にする呼び出し元を一意に識別する GUID です。プロバイダーが EnableCallback を実装していない場合、この GUID は使用されません。
EnableFilterDescEVENT_FILTER_DESCRIPTOR*8/4+32+28

フィルター データを指す EVENT_FILTER_DESCRIPTOR 構造体です。プロバイダーはフィルター データを使用して、フィルター条件に一致するイベントがセッションに書き込まれないようにします。データのレイアウトと、そのフィルターをイベントのデータにどのように適用するかは、プロバイダーが決定します。1 つのセッションがプロバイダーに渡せるフィルターは 1 つだけです。

セッションは TdhEnumerateProviderFilters 関数を呼び出すことで、プロバイダーに渡すことができるスキーマ化されたフィルターを確認できます。

公式ドキュメント

ENABLE_TRACE_PARAMETERS_V1 構造体は、EnableTraceEx2 でプロバイダーを有効にするために使用される情報を格納します。この構造体は廃止されています。代わりに ENABLE_TRACE_PARAMETERS を使用してください。

解説(Remarks)

ENABLE_TRACE_PARAMETERS_V1 は廃止されています。ENABLE_TRACE_PARAMETERS 構造体はバージョン 2 の構造体であり、ENABLE_TRACE_PARAMETERS_V1 構造体を置き換えるものです。

通常、64 ビット コンピューターでは、ページ フォールトが許可されない特定のコンテキストにおいてカーネル スタックをキャプチャできません。x64 でカーネル スタックのウォークを有効にするには、メモリ管理のレジストリ値 DisablePagingExecutive を 1 に設定します。DisablePagingExecutive レジストリ値は、次のレジストリ キーの下にあります: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Memory Management。これはシステムのメモリ使用量を増加させるため、一時的な診断の目的でのみ行ってください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// ENABLE_TRACE_PARAMETERS_V1  (x64 40 / x86 32 バイト)
typedef struct ENABLE_TRACE_PARAMETERS_V1 {
    DWORD Version;
    DWORD EnableProperty;
    DWORD ControlFlags;
    GUID SourceId;
    EVENT_FILTER_DESCRIPTOR* EnableFilterDesc;
} ENABLE_TRACE_PARAMETERS_V1;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct ENABLE_TRACE_PARAMETERS_V1
{
    public uint Version;
    public uint EnableProperty;
    public uint ControlFlags;
    public Guid SourceId;
    public IntPtr EnableFilterDesc;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure ENABLE_TRACE_PARAMETERS_V1
    Public Version As UInteger
    Public EnableProperty As UInteger
    Public ControlFlags As UInteger
    Public SourceId As Guid
    Public EnableFilterDesc As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class ENABLE_TRACE_PARAMETERS_V1(ctypes.Structure):
    _fields_ = [
        ("Version", wintypes.DWORD),
        ("EnableProperty", wintypes.DWORD),
        ("ControlFlags", wintypes.DWORD),
        ("SourceId", GUID),
        ("EnableFilterDesc", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct ENABLE_TRACE_PARAMETERS_V1 {
    pub Version: u32,
    pub EnableProperty: u32,
    pub ControlFlags: u32,
    pub SourceId: GUID,
    pub EnableFilterDesc: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type ENABLE_TRACE_PARAMETERS_V1 struct {
	Version uint32
	EnableProperty uint32
	ControlFlags uint32
	SourceId windows.GUID
	EnableFilterDesc uintptr
}
type
  ENABLE_TRACE_PARAMETERS_V1 = record
    Version: DWORD;
    EnableProperty: DWORD;
    ControlFlags: DWORD;
    SourceId: TGUID;
    EnableFilterDesc: Pointer;
  end;
const ENABLE_TRACE_PARAMETERS_V1 = extern struct {
    Version: u32,
    EnableProperty: u32,
    ControlFlags: u32,
    SourceId: GUID,
    EnableFilterDesc: ?*anyopaque,
};
type
  ENABLE_TRACE_PARAMETERS_V1 {.bycopy.} = object
    Version: uint32
    EnableProperty: uint32
    ControlFlags: uint32
    SourceId: GUID
    EnableFilterDesc: pointer
struct ENABLE_TRACE_PARAMETERS_V1
{
    uint Version;
    uint EnableProperty;
    uint ControlFlags;
    GUID SourceId;
    void* EnableFilterDesc;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; ENABLE_TRACE_PARAMETERS_V1 サイズ: 32 バイト(x86)
dim st, 8    ; 4byte整数×8(構造体サイズ 32 / 4 切り上げ)
; Version : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; EnableProperty : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ControlFlags : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; SourceId : GUID (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; EnableFilterDesc : EVENT_FILTER_DESCRIPTOR* (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; ENABLE_TRACE_PARAMETERS_V1 サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; Version : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; EnableProperty : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ControlFlags : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; SourceId : GUID (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; EnableFilterDesc : EVENT_FILTER_DESCRIPTOR* (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global ENABLE_TRACE_PARAMETERS_V1
    #field int Version
    #field int EnableProperty
    #field int ControlFlags
    #field GUID SourceId
    #field intptr EnableFilterDesc
#endstruct

stdim st, ENABLE_TRACE_PARAMETERS_V1        ; NSTRUCT 変数を確保
st->Version = 100
mes "Version=" + st->Version