ホーム › System.Diagnostics.Debug › GetThreadWaitChain

GetThreadWaitChain

関数

指定スレッドの待機チェーンを取得しデッドロックを分析する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

BOOL GetThreadWaitChain(
    void* WctHandle,
    UINT_PTR Context,   // optional
    WAIT_CHAIN_THREAD_OPTIONS Flags,
    DWORD ThreadId,
    DWORD* NodeCount,
    WAITCHAIN_NODE_INFO* NodeInfoArray,
    BOOL* IsCycle
);

パラメーター

名前

型

方向

説明

WctHandle

void*

OpenThreadWaitChainSession 関数で作成された WCT セッションへのハンドルです。

Context

UINT_PTR

inoptional

非同期セッションのコールバック関数に渡される、アプリケーション定義のコンテキスト構造体へのポインターです。

Flags

WAIT_CHAIN_THREAD_OPTIONS

待機チェーンの取得オプションです。このパラメーターには、次の値を 1 つ以上指定できます。

値	意味
WCT_OUT_OF_PROC_COM_FLAG	プロセス外 MTA COM サーバーのすべてのスレッドを列挙し、正しいスレッド識別子を見つけます。
WCT_OUT_OF_PROC_CS_FLAG	他のプロセスからクリティカルセクションの情報を取得します。
WCT_OUT_OF_PROC_FLAG	待機チェーンを他のプロセスまで追跡します。指定しない場合、関数は別プロセス内の最初のスレッドのみを報告し、追加情報は取得しません。

ThreadId

DWORD

スレッドの識別子です。

NodeCount

DWORD*

inout

入力時には、待機チェーン内のノード数を指定する 1 から WCT_MAX_NODE_COUNT までの数値です。戻り時には、取得されたノード数になります。配列が待機チェーンのすべてのノードを格納できない場合、関数は失敗し、GetLastError は ERROR_MORE_DATA を返します。このとき、このパラメーターにはすべてのノードを格納するために必要な配列要素数が設定されます。

非同期セッションの場合は、コールバック関数に渡される値を確認してください。コールバック関数が戻るまで、変数を解放しないでください。

NodeInfoArray

WAITCHAIN_NODE_INFO*

out

待機チェーンを受け取る WAITCHAIN_NODE_INFO 構造体の配列です。

非同期セッションの場合は、コールバック関数に渡される値を確認してください。コールバック関数が戻るまで、配列を解放しないでください。

IsCycle

BOOL*

out

関数がデッドロックを検出した場合、この変数は TRUE に設定されます。それ以外の場合は FALSE に設定されます。

非同期セッションの場合は、コールバック関数に渡される値を確認してください。コールバック関数が戻るまで、変数を解放しないでください。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドの待機チェーンを取得します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

戻り値	説明
ERROR_ACCESS_DENIED	呼び出し元に、対象スレッドを開くための十分な特権がありませんでした。
ERROR_INVALID_PARAMETER	入力パラメーターのいずれかが無効です。
ERROR_IO_PENDING	WCT セッションが非同期モードで開かれました。結果は WaitChainCallback コールバック関数を通じて返されます。
ERROR_MORE_DATA	NodeInfoArray バッファーが、待機チェーン内のすべてのノードを格納するには不十分です。NodeCount パラメーターにはチェーン内のノード数が格納されます。返された待機チェーンは引き続き有効です。
ERROR_NOT_SUPPORTED	オペレーティングシステムがこのサービスを提供していません。
ERROR_OBJECT_NOT_FOUND	指定されたスレッドが見つかりませんでした。
ERROR_TOO_MANY_THREADS	ノード数が WCT_MAX_NODE_COUNT を超えています。返された待機チェーンは引き続き有効です。

解説(Remarks)

セッションが非同期の場合、関数は FALSE を返し、GetLastError は ERROR_IO_PENDING を返します。結果を取得するには、WaitChainCallback コールバック関数を参照してください。

指定されたスレッドがブロックされていない場合、またはサポートされていない同期要素でブロックされている場合、関数は NodeInfoArray に 1 つの項目を返します。

呼び出し元は SE_DEBUG_NAME 特権を持っている必要があります。呼び出し元の特権が不十分な場合、最初のスレッドにアクセスできなければ関数は失敗します。それ以外の場合、配列内の最後のノードの ObjectStatus メンバーが WctStatusNoAcces に設定されます。

配列内のノードのいずれかの部分集合がサイクルを形成している場合、関数は IsCycle パラメーターを TRUE に設定します。

待機チェーン情報は動的です。関数が呼び出された時点では正しい情報ですが、呼び出し元が確認する時点では古くなっている可能性があります。

例

例については、 Using WCT を参照してください。

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

BOOL GetThreadWaitChain(
    void* WctHandle,
    UINT_PTR Context,   // optional
    WAIT_CHAIN_THREAD_OPTIONS Flags,
    DWORD ThreadId,
    DWORD* NodeCount,
    WAITCHAIN_NODE_INFO* NodeInfoArray,
    BOOL* IsCycle
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetThreadWaitChain(
    IntPtr WctHandle,   // void*
    UIntPtr Context,   // UINT_PTR optional
    uint Flags,   // WAIT_CHAIN_THREAD_OPTIONS
    uint ThreadId,   // DWORD
    ref uint NodeCount,   // DWORD* in/out
    IntPtr NodeInfoArray,   // WAITCHAIN_NODE_INFO* out
    out bool IsCycle   // BOOL* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetThreadWaitChain(
    WctHandle As IntPtr,   ' void*
    Context As UIntPtr,   ' UINT_PTR optional
    Flags As UInteger,   ' WAIT_CHAIN_THREAD_OPTIONS
    ThreadId As UInteger,   ' DWORD
    ByRef NodeCount As UInteger,   ' DWORD* in/out
    NodeInfoArray As IntPtr,   ' WAITCHAIN_NODE_INFO* out
    <Out> ByRef IsCycle As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' WctHandle : void*
' Context : UINT_PTR optional
' Flags : WAIT_CHAIN_THREAD_OPTIONS
' ThreadId : DWORD
' NodeCount : DWORD* in/out
' NodeInfoArray : WAITCHAIN_NODE_INFO* out
' IsCycle : BOOL* out
Declare PtrSafe Function GetThreadWaitChain Lib "advapi32" ( _
    ByVal WctHandle As LongPtr, _
    ByVal Context As LongPtr, _
    ByVal Flags As Long, _
    ByVal ThreadId As Long, _
    ByRef NodeCount As Long, _
    ByVal NodeInfoArray As LongPtr, _
    ByRef IsCycle As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetThreadWaitChain = ctypes.windll.advapi32.GetThreadWaitChain
GetThreadWaitChain.restype = wintypes.BOOL
GetThreadWaitChain.argtypes = [
    ctypes.POINTER(None),  # WctHandle : void*
    ctypes.c_size_t,  # Context : UINT_PTR optional
    wintypes.DWORD,  # Flags : WAIT_CHAIN_THREAD_OPTIONS
    wintypes.DWORD,  # ThreadId : DWORD
    ctypes.POINTER(wintypes.DWORD),  # NodeCount : DWORD* in/out
    ctypes.c_void_p,  # NodeInfoArray : WAITCHAIN_NODE_INFO* out
    ctypes.c_void_p,  # IsCycle : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetThreadWaitChain = Fiddle::Function.new(
  lib['GetThreadWaitChain'],
  [
    Fiddle::TYPE_VOIDP,  # WctHandle : void*
    Fiddle::TYPE_UINTPTR_T,  # Context : UINT_PTR optional
    -Fiddle::TYPE_INT,  # Flags : WAIT_CHAIN_THREAD_OPTIONS
    -Fiddle::TYPE_INT,  # ThreadId : DWORD
    Fiddle::TYPE_VOIDP,  # NodeCount : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # NodeInfoArray : WAITCHAIN_NODE_INFO* out
    Fiddle::TYPE_VOIDP,  # IsCycle : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetThreadWaitChain(
        WctHandle: *mut (),  // void*
        Context: usize,  // UINT_PTR optional
        Flags: u32,  // WAIT_CHAIN_THREAD_OPTIONS
        ThreadId: u32,  // DWORD
        NodeCount: *mut u32,  // DWORD* in/out
        NodeInfoArray: *mut WAITCHAIN_NODE_INFO,  // WAITCHAIN_NODE_INFO* out
        IsCycle: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool GetThreadWaitChain(IntPtr WctHandle, UIntPtr Context, uint Flags, uint ThreadId, ref uint NodeCount, IntPtr NodeInfoArray, out bool IsCycle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetThreadWaitChain' -Namespace Win32 -PassThru
# $api::GetThreadWaitChain(WctHandle, Context, Flags, ThreadId, NodeCount, NodeInfoArray, IsCycle)

#uselib "ADVAPI32.dll"
#func global GetThreadWaitChain "GetThreadWaitChain" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; GetThreadWaitChain WctHandle, Context, Flags, ThreadId, varptr(NodeCount), varptr(NodeInfoArray), varptr(IsCycle)   ; 戻り値は stat
; WctHandle : void* -> "sptr"
; Context : UINT_PTR optional -> "sptr"
; Flags : WAIT_CHAIN_THREAD_OPTIONS -> "sptr"
; ThreadId : DWORD -> "sptr"
; NodeCount : DWORD* in/out -> "sptr"
; NodeInfoArray : WAITCHAIN_NODE_INFO* out -> "sptr"
; IsCycle : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetThreadWaitChain "GetThreadWaitChain" sptr, sptr, int, int, var, var, var
; res = GetThreadWaitChain(WctHandle, Context, Flags, ThreadId, NodeCount, NodeInfoArray, IsCycle)
; WctHandle : void* -> "sptr"
; Context : UINT_PTR optional -> "sptr"
; Flags : WAIT_CHAIN_THREAD_OPTIONS -> "int"
; ThreadId : DWORD -> "int"
; NodeCount : DWORD* in/out -> "var"
; NodeInfoArray : WAITCHAIN_NODE_INFO* out -> "var"
; IsCycle : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetThreadWaitChain "GetThreadWaitChain" sptr, sptr, int, int, sptr, sptr, sptr
; res = GetThreadWaitChain(WctHandle, Context, Flags, ThreadId, varptr(NodeCount), varptr(NodeInfoArray), varptr(IsCycle))
; WctHandle : void* -> "sptr"
; Context : UINT_PTR optional -> "sptr"
; Flags : WAIT_CHAIN_THREAD_OPTIONS -> "int"
; ThreadId : DWORD -> "int"
; NodeCount : DWORD* in/out -> "sptr"
; NodeInfoArray : WAITCHAIN_NODE_INFO* out -> "sptr"
; IsCycle : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。