ホーム › System.Threading › EnterSynchronizationBarrier

EnterSynchronizationBarrier

関数

同期バリアに到達し全スレッドの到達を待機する。

DLLKERNEL32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

BOOL EnterSynchronizationBarrier(
    SYNCHRONIZATION_BARRIER* lpBarrier,
    DWORD dwFlags
);

パラメーター

名前

型

方向

説明

lpBarrier

SYNCHRONIZATION_BARRIER*

inout

初期化済みの同期バリアへのポインターです。バリアの初期化には InitializeSynchronizationBarrier 関数を使用してください。SYNCHRONIZATION_BARRIER は不透明な構造体であり、アプリケーションが変更してはなりません。

dwFlags

DWORD

このバリアに入るスレッドの動作を制御するフラグです。このパラメーターには、次の値を 1 つ以上指定できます。

Value	Meaning
SYNCHRONIZATION_BARRIER_FLAGS_BLOCK_ONLY	バリアに入るスレッドが、最後のスレッドがバリアに入るまで直ちにブロックすることを指定します。詳細については、「解説」を参照してください。
SYNCHRONIZATION_BARRIER_FLAGS_SPIN_ONLY	バリアに入るスレッドが、最後のスレッドがバリアに入るまでスピンすることを指定します。これは、スピンしているスレッドがバリアの最大スピン回数を超えた場合でも続行されます。詳細については、「解説」を参照してください。
SYNCHRONIZATION_BARRIER_FLAGS_NO_DELETE	バリアを安全に削除できるようにするために必要な処理を、関数が省略できることを指定します。これによりパフォーマンスが向上する場合があります。このバリアに入るすべてのスレッドがこのフラグを指定する必要があります。そうでない場合、このフラグは無視されます。このフラグは、バリアを決して削除しない場合にのみ使用してください。

戻り値の型: BOOL

公式ドキュメント

呼び出し元スレッドを同期バリアで待機させ、最大数のスレッドがバリアに入るまでブロックします。

戻り値

バリアにシグナルを送る最後のスレッドに対しては TRUE を返します。最後のスレッドより前にバリアにシグナルを送ったスレッドは、戻り値として FALSE を受け取ります。

解説(Remarks)

同期バリアに入るスレッドの既定の動作は、バリアの最大スピン回数に達するまでスピンし、その後ブロックするというものです。これにより、最後のスレッドが比較的短時間でバリアに入った場合に、スレッドが速やかに再開できます。一方、最後のスレッドの到着に比較的時間がかかる場合は、すでにバリア内にあるスレッドはブロックされるため、待機中にプロセッサー時間を消費しなくなります。

スレッドは SYNCHRONIZATION_BARRIER_FLAGS_BLOCK_ONLY または SYNCHRONIZATION_BARRIER_FLAGS_SPIN_ONLY を指定することで、バリアの既定の動作をオーバーライドできます。ただし、これらのフラグの使用はパフォーマンスに影響を与える可能性があることに注意してください。無期限にスピンするとプロセッサーが他のスレッドを処理できなくなり、一方で早期にブロックするとスレッドをプロセッサーから退避させ、ブロック解除時にスレッドを起こし、再びプロセッサーに戻すというオーバーヘッドが発生します。一般的には、バリアにスレッドの管理を任せ、これらのフラグはパフォーマンステストによってアプリケーションに利点があると示された場合にのみ使用する方が適切です。

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

各言語での呼び出し定義

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

BOOL EnterSynchronizationBarrier(
    SYNCHRONIZATION_BARRIER* lpBarrier,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool EnterSynchronizationBarrier(
    IntPtr lpBarrier,   // SYNCHRONIZATION_BARRIER* in/out
    uint dwFlags   // DWORD
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function EnterSynchronizationBarrier(
    lpBarrier As IntPtr,   ' SYNCHRONIZATION_BARRIER* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

EnterSynchronizationBarrier = ctypes.windll.kernel32.EnterSynchronizationBarrier
EnterSynchronizationBarrier.restype = wintypes.BOOL
EnterSynchronizationBarrier.argtypes = [
    ctypes.c_void_p,  # lpBarrier : SYNCHRONIZATION_BARRIER* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
EnterSynchronizationBarrier = Fiddle::Function.new(
  lib['EnterSynchronizationBarrier'],
  [
    Fiddle::TYPE_VOIDP,  # lpBarrier : SYNCHRONIZATION_BARRIER* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool EnterSynchronizationBarrier(IntPtr lpBarrier, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EnterSynchronizationBarrier' -Namespace Win32 -PassThru
# $api::EnterSynchronizationBarrier(lpBarrier, dwFlags)

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

出力引数:

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