ホーム › System.Threading › SetCriticalSectionSpinCount

SetCriticalSectionSpinCount

関数

クリティカルセクションのスピンカウントを設定する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD SetCriticalSectionSpinCount(
    CRITICAL_SECTION* lpCriticalSection,
    DWORD dwSpinCount
);

パラメーター

名前	型	方向	説明
lpCriticalSection	CRITICAL_SECTION*	inout	クリティカルセクションオブジェクトへのポインターです。
dwSpinCount	DWORD	in	クリティカルセクションオブジェクトのスピンカウントです。シングルプロセッサシステムでは、スピンカウントは無視され、クリティカルセクションのスピンカウントはゼロ (0) に設定されます。マルチプロセッサシステムでは、クリティカルセクションが利用できない場合、呼び出し元のスレッドは、そのクリティカルセクションに関連付けられたセマフォに対して待機操作を実行する前に、dwSpinCount 回スピンします。スピン操作中にクリティカルセクションが解放された場合、呼び出し元のスレッドは待機操作を回避します。

戻り値の型: DWORD

公式ドキュメント

指定したクリティカルセクションのスピンカウントを設定します。

戻り値

この関数は、クリティカルセクションの以前のスピンカウントを返します。

解説(Remarks)

単一プロセスのスレッドは、相互排他同期のためにクリティカルセクションオブジェクトを使用できます。クリティカルセクションオブジェクトが使用するメモリの割り当てはプロセスが行う必要があり、これは CRITICAL_SECTION 型の変数を宣言することで行えます。クリティカルセクションを使用する前に、プロセスのいずれかのスレッドが InitializeCriticalSection 関数または InitializeCriticalSectionAndSpinCount 関数を呼び出して、オブジェクトを初期化する必要があります。その後、SetCriticalSectionSpinCount 関数を呼び出すことで、スピンカウントを変更できます。

スピンカウントは、競合が激しくなる可能性のある短時間のクリティカルセクションに役立ちます。最悪のケースとして、SMP システム上のアプリケーションで 2 つまたは 3 つのスレッドが、ヒープからのメモリの割り当てと解放を絶え間なく行うシナリオを考えてみます。このアプリケーションはクリティカルセクションでヒープをシリアル化します。最悪のケースでは、クリティカルセクションに対する競合が常に発生し、各スレッドは処理負荷の高い WaitForSingleObject 関数の呼び出しを行います。しかし、スピンカウントが適切に設定されていれば、競合が発生したときに呼び出し元のスレッドはすぐに WaitForSingleObject を呼び出すことはありません。代わりに、スピン操作中にクリティカルセクションが解放されれば、呼び出し元のスレッドはその所有権を取得できます。

短時間のクリティカルセクションに対して小さいスピンカウントを選択することで、パフォーマンスを大幅に向上させることができます。ヒープマネージャーは、ヒープごとのクリティカルセクションに対しておよそ 4000 のスピンカウントを使用します。これにより、ほぼすべての最悪のケースのシナリオで優れたパフォーマンスとスケーラビリティが得られます。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0403 以降として定義します。詳細については、「Using the Windows Headers」を参照してください。

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

各言語での呼び出し定義

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

DWORD SetCriticalSectionSpinCount(
    CRITICAL_SECTION* lpCriticalSection,
    DWORD dwSpinCount
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint SetCriticalSectionSpinCount(
    IntPtr lpCriticalSection,   // CRITICAL_SECTION* in/out
    uint dwSpinCount   // DWORD
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function SetCriticalSectionSpinCount(
    lpCriticalSection As IntPtr,   ' CRITICAL_SECTION* in/out
    dwSpinCount As UInteger   ' DWORD
) As UInteger
End Function

' lpCriticalSection : CRITICAL_SECTION* in/out
' dwSpinCount : DWORD
Declare PtrSafe Function SetCriticalSectionSpinCount Lib "kernel32" ( _
    ByVal lpCriticalSection As LongPtr, _
    ByVal dwSpinCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetCriticalSectionSpinCount = ctypes.windll.kernel32.SetCriticalSectionSpinCount
SetCriticalSectionSpinCount.restype = wintypes.DWORD
SetCriticalSectionSpinCount.argtypes = [
    ctypes.c_void_p,  # lpCriticalSection : CRITICAL_SECTION* in/out
    wintypes.DWORD,  # dwSpinCount : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetCriticalSectionSpinCount = Fiddle::Function.new(
  lib['SetCriticalSectionSpinCount'],
  [
    Fiddle::TYPE_VOIDP,  # lpCriticalSection : CRITICAL_SECTION* in/out
    -Fiddle::TYPE_INT,  # dwSpinCount : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn SetCriticalSectionSpinCount(
        lpCriticalSection: *mut CRITICAL_SECTION,  // CRITICAL_SECTION* in/out
        dwSpinCount: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint SetCriticalSectionSpinCount(IntPtr lpCriticalSection, uint dwSpinCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetCriticalSectionSpinCount' -Namespace Win32 -PassThru
# $api::SetCriticalSectionSpinCount(lpCriticalSection, dwSpinCount)

#uselib "KERNEL32.dll"
#func global SetCriticalSectionSpinCount "SetCriticalSectionSpinCount" sptr, sptr
; SetCriticalSectionSpinCount varptr(lpCriticalSection), dwSpinCount   ; 戻り値は stat
; lpCriticalSection : CRITICAL_SECTION* in/out -> "sptr"
; dwSpinCount : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global SetCriticalSectionSpinCount "SetCriticalSectionSpinCount" var, int
; res = SetCriticalSectionSpinCount(lpCriticalSection, dwSpinCount)
; lpCriticalSection : CRITICAL_SECTION* in/out -> "var"
; dwSpinCount : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global SetCriticalSectionSpinCount "SetCriticalSectionSpinCount" sptr, int
; res = SetCriticalSectionSpinCount(varptr(lpCriticalSection), dwSpinCount)
; lpCriticalSection : CRITICAL_SECTION* in/out -> "sptr"
; dwSpinCount : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。