ホーム › System.Threading › InitializeCriticalSectionEx

InitializeCriticalSectionEx

関数

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

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

シグネチャ

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

BOOL InitializeCriticalSectionEx(
    CRITICAL_SECTION* lpCriticalSection,
    DWORD dwSpinCount,
    DWORD Flags
);

パラメーター

名前

型

方向

説明

lpCriticalSection

CRITICAL_SECTION*

out

クリティカルセクションオブジェクトへのポインターです。

dwSpinCount

DWORD

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

Flags

DWORD

このパラメーターには 0、または次の値を指定できます。

値	意味
CRITICAL_SECTION_NO_DEBUG_INFO	クリティカルセクションがデバッグ情報なしで作成されます。

戻り値の型: BOOL

公式ドキュメント

スピンカウントと省略可能なフラグを指定して、クリティカルセクションオブジェクトを初期化します。

戻り値

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

関数が失敗すると、戻り値は 0 (ゼロ) になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

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

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

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

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

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

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

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

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

各言語での呼び出し定義

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

BOOL InitializeCriticalSectionEx(
    CRITICAL_SECTION* lpCriticalSection,
    DWORD dwSpinCount,
    DWORD Flags
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "kernel32")]
extern "system" {
    fn InitializeCriticalSectionEx(
        lpCriticalSection: *mut CRITICAL_SECTION,  // CRITICAL_SECTION* out
        dwSpinCount: u32,  // DWORD
        Flags: 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 InitializeCriticalSectionEx(IntPtr lpCriticalSection, uint dwSpinCount, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_InitializeCriticalSectionEx' -Namespace Win32 -PassThru
# $api::InitializeCriticalSectionEx(lpCriticalSection, dwSpinCount, Flags)

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

出力引数:

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