Win32 API 日本語リファレンス
ホームSystem.Performance.HardwareCounterProfiling › EnableThreadProfiling

EnableThreadProfiling

関数
指定スレッドのハードウェアカウンタプロファイリングを有効化する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

DWORD EnableThreadProfiling(
    HANDLE ThreadHandle,
    DWORD Flags,
    ULONGLONG HardwareCounters,
    HANDLE* PerformanceDataHandle
);

パラメーター

名前方向説明
ThreadHandleHANDLEinプロファイリングを有効化する対象スレッドのハンドル。
FlagsDWORDinプロファイリング動作を指定するフラグ。THREAD_PROFILING_FLAG_DISPATCH等を指定する。
HardwareCountersULONGLONGin計測するハードウェアカウンターのビットマスク。0で未使用。
PerformanceDataHandleHANDLE*out以後の計測に使うパフォーマンスデータハンドルを受け取る出力。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD EnableThreadProfiling(
    HANDLE ThreadHandle,
    DWORD Flags,
    ULONGLONG HardwareCounters,
    HANDLE* PerformanceDataHandle
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint EnableThreadProfiling(
    IntPtr ThreadHandle,   // HANDLE
    uint Flags,   // DWORD
    ulong HardwareCounters,   // ULONGLONG
    IntPtr PerformanceDataHandle   // HANDLE* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function EnableThreadProfiling(
    ThreadHandle As IntPtr,   ' HANDLE
    Flags As UInteger,   ' DWORD
    HardwareCounters As ULong,   ' ULONGLONG
    PerformanceDataHandle As IntPtr   ' HANDLE* out
) As UInteger
End Function
' ThreadHandle : HANDLE
' Flags : DWORD
' HardwareCounters : ULONGLONG
' PerformanceDataHandle : HANDLE* out
Declare PtrSafe Function EnableThreadProfiling Lib "kernel32" ( _
    ByVal ThreadHandle As LongPtr, _
    ByVal Flags As Long, _
    ByVal HardwareCounters As LongLong, _
    ByVal PerformanceDataHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EnableThreadProfiling = ctypes.windll.kernel32.EnableThreadProfiling
EnableThreadProfiling.restype = wintypes.DWORD
EnableThreadProfiling.argtypes = [
    wintypes.HANDLE,  # ThreadHandle : HANDLE
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_ulonglong,  # HardwareCounters : ULONGLONG
    ctypes.c_void_p,  # PerformanceDataHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EnableThreadProfiling = Fiddle::Function.new(
  lib['EnableThreadProfiling'],
  [
    Fiddle::TYPE_VOIDP,  # ThreadHandle : HANDLE
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_LONG_LONG,  # HardwareCounters : ULONGLONG
    Fiddle::TYPE_VOIDP,  # PerformanceDataHandle : HANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn EnableThreadProfiling(
        ThreadHandle: *mut core::ffi::c_void,  // HANDLE
        Flags: u32,  // DWORD
        HardwareCounters: u64,  // ULONGLONG
        PerformanceDataHandle: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint EnableThreadProfiling(IntPtr ThreadHandle, uint Flags, ulong HardwareCounters, IntPtr PerformanceDataHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnableThreadProfiling' -Namespace Win32 -PassThru
# $api::EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
#uselib "KERNEL32.dll"
#func global EnableThreadProfiling "EnableThreadProfiling" sptr, sptr, sptr, sptr
; EnableThreadProfiling ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle   ; 戻り値は stat
; ThreadHandle : HANDLE -> "sptr"
; Flags : DWORD -> "sptr"
; HardwareCounters : ULONGLONG -> "sptr"
; PerformanceDataHandle : HANDLE* out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global EnableThreadProfiling "EnableThreadProfiling" sptr, int, int64, sptr
; res = EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
; ThreadHandle : HANDLE -> "sptr"
; Flags : DWORD -> "int"
; HardwareCounters : ULONGLONG -> "int64"
; PerformanceDataHandle : HANDLE* out -> "sptr"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; DWORD EnableThreadProfiling(HANDLE ThreadHandle, DWORD Flags, ULONGLONG HardwareCounters, HANDLE* PerformanceDataHandle)
#uselib "KERNEL32.dll"
#cfunc global EnableThreadProfiling "EnableThreadProfiling" intptr, int, int64, intptr
; res = EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
; ThreadHandle : HANDLE -> "intptr"
; Flags : DWORD -> "int"
; HardwareCounters : ULONGLONG -> "int64"
; PerformanceDataHandle : HANDLE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procEnableThreadProfiling = kernel32.NewProc("EnableThreadProfiling")
)

// ThreadHandle (HANDLE), Flags (DWORD), HardwareCounters (ULONGLONG), PerformanceDataHandle (HANDLE* out)
r1, _, err := procEnableThreadProfiling.Call(
	uintptr(ThreadHandle),
	uintptr(Flags),
	uintptr(HardwareCounters),
	uintptr(PerformanceDataHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function EnableThreadProfiling(
  ThreadHandle: THandle;   // HANDLE
  Flags: DWORD;   // DWORD
  HardwareCounters: UInt64;   // ULONGLONG
  PerformanceDataHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'EnableThreadProfiling';
result := DllCall("KERNEL32\EnableThreadProfiling"
    , "Ptr", ThreadHandle   ; HANDLE
    , "UInt", Flags   ; DWORD
    , "Int64", HardwareCounters   ; ULONGLONG
    , "Ptr", PerformanceDataHandle   ; HANDLE* out
    , "UInt")   ; return: DWORD
●EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle) = DLL("KERNEL32.dll", "dword EnableThreadProfiling(void*, dword, qword, void*)")
# 呼び出し: EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
# ThreadHandle : HANDLE -> "void*"
# Flags : DWORD -> "dword"
# HardwareCounters : ULONGLONG -> "qword"
# PerformanceDataHandle : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn EnableThreadProfiling(
    ThreadHandle: ?*anyopaque, // HANDLE
    Flags: u32, // DWORD
    HardwareCounters: u64, // ULONGLONG
    PerformanceDataHandle: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc EnableThreadProfiling(
    ThreadHandle: pointer,  # HANDLE
    Flags: uint32,  # DWORD
    HardwareCounters: uint64,  # ULONGLONG
    PerformanceDataHandle: pointer  # HANDLE* out
): uint32 {.importc: "EnableThreadProfiling", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint EnableThreadProfiling(
    void* ThreadHandle,   // HANDLE
    uint Flags,   // DWORD
    ulong HardwareCounters,   // ULONGLONG
    void* PerformanceDataHandle   // HANDLE* out
);
ccall((:EnableThreadProfiling, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, UInt64, Ptr{Cvoid}),
      ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
# ThreadHandle : HANDLE -> Ptr{Cvoid}
# Flags : DWORD -> UInt32
# HardwareCounters : ULONGLONG -> UInt64
# PerformanceDataHandle : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t EnableThreadProfiling(
    void* ThreadHandle,
    uint32_t Flags,
    uint64_t HardwareCounters,
    void* PerformanceDataHandle);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
-- ThreadHandle : HANDLE
-- Flags : DWORD
-- HardwareCounters : ULONGLONG
-- PerformanceDataHandle : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EnableThreadProfiling = lib.func('__stdcall', 'EnableThreadProfiling', 'uint32_t', ['void *', 'uint32_t', 'uint64_t', 'void *']);
// EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
// ThreadHandle : HANDLE -> 'void *'
// Flags : DWORD -> 'uint32_t'
// HardwareCounters : ULONGLONG -> 'uint64_t'
// PerformanceDataHandle : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  EnableThreadProfiling: { parameters: ["pointer", "u32", "u64", "pointer"], result: "u32" },
});
// lib.symbols.EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle)
// ThreadHandle : HANDLE -> "pointer"
// Flags : DWORD -> "u32"
// HardwareCounters : ULONGLONG -> "u64"
// PerformanceDataHandle : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t EnableThreadProfiling(
    void* ThreadHandle,
    uint32_t Flags,
    uint64_t HardwareCounters,
    void* PerformanceDataHandle);
C, "KERNEL32.dll");
// $ffi->EnableThreadProfiling(ThreadHandle, Flags, HardwareCounters, PerformanceDataHandle);
// ThreadHandle : HANDLE
// Flags : DWORD
// HardwareCounters : ULONGLONG
// PerformanceDataHandle : HANDLE* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int EnableThreadProfiling(
        Pointer ThreadHandle,   // HANDLE
        int Flags,   // DWORD
        long HardwareCounters,   // ULONGLONG
        Pointer PerformanceDataHandle   // HANDLE* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun EnableThreadProfiling = EnableThreadProfiling(
    ThreadHandle : Void*,   # HANDLE
    Flags : UInt32,   # DWORD
    HardwareCounters : UInt64,   # ULONGLONG
    PerformanceDataHandle : Void*   # HANDLE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef EnableThreadProfilingNative = Uint32 Function(Pointer<Void>, Uint32, Uint64, Pointer<Void>);
typedef EnableThreadProfilingDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final EnableThreadProfiling = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<EnableThreadProfilingNative, EnableThreadProfilingDart>('EnableThreadProfiling');
// ThreadHandle : HANDLE -> Pointer<Void>
// Flags : DWORD -> Uint32
// HardwareCounters : ULONGLONG -> Uint64
// PerformanceDataHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnableThreadProfiling(
  ThreadHandle: THandle;   // HANDLE
  Flags: DWORD;   // DWORD
  HardwareCounters: UInt64;   // ULONGLONG
  PerformanceDataHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'EnableThreadProfiling';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnableThreadProfiling"
  c_EnableThreadProfiling :: Ptr () -> Word32 -> Word64 -> Ptr () -> IO Word32
-- ThreadHandle : HANDLE -> Ptr ()
-- Flags : DWORD -> Word32
-- HardwareCounters : ULONGLONG -> Word64
-- PerformanceDataHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enablethreadprofiling =
  foreign "EnableThreadProfiling"
    ((ptr void) @-> uint32_t @-> uint64_t @-> (ptr void) @-> returning uint32_t)
(* ThreadHandle : HANDLE -> (ptr void) *)
(* Flags : DWORD -> uint32_t *)
(* HardwareCounters : ULONGLONG -> uint64_t *)
(* PerformanceDataHandle : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("EnableThreadProfiling" enable-thread-profiling :convention :stdcall) :uint32
  (thread-handle :pointer)   ; HANDLE
  (flags :uint32)   ; DWORD
  (hardware-counters :uint64)   ; ULONGLONG
  (performance-data-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnableThreadProfiling = Win32::API::More->new('KERNEL32',
    'DWORD EnableThreadProfiling(HANDLE ThreadHandle, DWORD Flags, UINT64 HardwareCounters, HANDLE PerformanceDataHandle)');
# my $ret = $EnableThreadProfiling->Call($ThreadHandle, $Flags, $HardwareCounters, $PerformanceDataHandle);
# ThreadHandle : HANDLE -> HANDLE
# Flags : DWORD -> DWORD
# HardwareCounters : ULONGLONG -> UINT64
# PerformanceDataHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。