ホーム › System.Threading › InitializeCriticalSectionAndSpinCount

InitializeCriticalSectionAndSpinCount

関数

スピンカウント付きでクリティカルセクションを初期化する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL InitializeCriticalSectionAndSpinCount(
    CRITICAL_SECTION* lpCriticalSection,
    DWORD dwSpinCount
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

クリティカルセクションオブジェクトを初期化し、そのクリティカルセクションのスピンカウントを設定します。

戻り値

この関数は常に成功し、非ゼロ値を返します。

Windows Server 2003 および Windows XP: 関数が成功した場合、戻り値は非ゼロです。関数が失敗した場合、戻り値はゼロ 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。Windows Vista 以降、InitializeCriticalSectionAndSpinCount 関数は、メモリ不足の状況でも常に成功します。

解説(Remarks)

単一プロセス内のスレッドは、相互排他同期のためにクリティカルセクションオブジェクトを使用できます。スレッドがクリティカルセクションの所有権を取得する順序については保証されません。ただし、システムはすべてのスレッドに対して公平です。

クリティカルセクションオブジェクトが使用するメモリの割り当ては、プロセスの責任で行います。これは CRITICAL_SECTION 型の変数を宣言することで実現できます。クリティカルセクションを使用する前に、プロセスのいずれかのスレッドがオブジェクトを初期化する必要があります。その後、SetCriticalSectionSpinCount 関数を呼び出すことでスピンカウントを変更できます。

クリティカルセクションオブジェクトを初期化した後、プロセスのスレッドは、EnterCriticalSection、TryEnterCriticalSection、または LeaveCriticalSection 関数でオブジェクトを指定して、共有リソースへの相互排他的なアクセスを提供できます。異なるプロセスのスレッド間で同様の同期を行うには、ミューテックスオブジェクトを使用します。

クリティカルセクションオブジェクトは移動もコピーもできません。また、プロセスはオブジェクトを変更してはならず、論理的に不透明なものとして扱う必要があります。クリティカルセクションオブジェクトの管理には、クリティカルセクション関数のみを使用してください。クリティカルセクションの使用を終えたら、DeleteCriticalSection 関数を呼び出します。

クリティカルセクションオブジェクトは、再初期化する前に削除する必要があります。すでに初期化されているクリティカルセクションを初期化すると、未定義の動作になります。

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

短時間のクリティカルセクションに対して小さなスピンカウントを選択することで、パフォーマンスを大幅に向上させることができます。たとえば、ヒープマネージャーは、ヒープごとのクリティカルセクションに対しておよそ 4,000 のスピンカウントを使用します。

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

例

InitializeCriticalSectionAndSpinCount を使用する例については、クリティカルセクションオブジェクトの使用を参照してください。

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

各言語での呼び出し定義

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

BOOL InitializeCriticalSectionAndSpinCount(
    CRITICAL_SECTION* lpCriticalSection,
    DWORD dwSpinCount
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool InitializeCriticalSectionAndSpinCount(
    IntPtr lpCriticalSection,   // CRITICAL_SECTION* out
    uint dwSpinCount   // DWORD
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InitializeCriticalSectionAndSpinCount(
    lpCriticalSection As IntPtr,   ' CRITICAL_SECTION* out
    dwSpinCount As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpCriticalSection : CRITICAL_SECTION* out
' dwSpinCount : DWORD
Declare PtrSafe Function InitializeCriticalSectionAndSpinCount 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

InitializeCriticalSectionAndSpinCount = ctypes.windll.kernel32.InitializeCriticalSectionAndSpinCount
InitializeCriticalSectionAndSpinCount.restype = wintypes.BOOL
InitializeCriticalSectionAndSpinCount.argtypes = [
    ctypes.c_void_p,  # lpCriticalSection : CRITICAL_SECTION* out
    wintypes.DWORD,  # dwSpinCount : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

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

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool InitializeCriticalSectionAndSpinCount(IntPtr lpCriticalSection, uint dwSpinCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitializeCriticalSectionAndSpinCount' -Namespace Win32 -PassThru
# $api::InitializeCriticalSectionAndSpinCount(lpCriticalSection, dwSpinCount)

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

出力引数:

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