ホーム › Storage.FileSystem › BuildIoRingRegisterBuffers

BuildIoRingRegisterBuffers

関数

I/Oリングにバッファ群を事前登録する操作を構築する。

DLLapi-ms-win-core-ioring-l1-1-0.dll呼出規約winapi

シグネチャ

// api-ms-win-core-ioring-l1-1-0.dll
#include <windows.h>

HRESULT BuildIoRingRegisterBuffers(
    HIORING ioRing,
    DWORD count,
    const IORING_BUFFER_INFO* buffers,
    UINT_PTR userData
);

パラメーター

名前	型	方向	説明
ioRing	HIORING	in	バッファを登録する I/O リングへのハンドルを表す HIORING。
count	DWORD	in	buffers パラメーターで指定するバッファの数を表す UINT32。
buffers	IORING_BUFFER_INFO*	in	登録するバッファを表す IORING_BUFFER_INFO 構造体の配列。
userData	UINT_PTR	in	登録操作を識別する UINT_PTR 値。BuildIoRingCancelRequest を呼び出して操作をキャンセルするときに、この値を指定します。アプリが操作のキャンセル動作を実装する場合、userData 値は一意である必要があります。それ以外の場合、この値はシステムからは不透明な値として扱われ、0 を含む任意の値を指定できます。

戻り値の型: HRESULT

公式ドキュメント

今後の I/O リング操作で使用するバッファの配列をシステムに登録します。

戻り値

次を含む (ただしこれらに限定されない) HRESULT を返します:

値	説明
S_OK	成功
IORING_E_SUBMISSION_QUEUE_FULL	送信キューが満杯であり、構築できる追加のエントリがありません。アプリケーションは、既存のエントリを送信し、それらの一部が完了するのを待ってから、キューに操作を追加する必要があります。
IORING_E_UNKNOWN_REQUIRED_FLAG	アプリケーションが、実装に認識されない必須フラグを指定しました。ライブラリコードは、GetIoRingInfo の呼び出しから取得した IORING_INFO の IoRingVersion フィールドを確認して、I/O リングの API バージョンを判別する必要があります。このバージョンによって、サポートされる操作とフラグが決まります。アプリケーションは、I/O リングの作成に使用したバージョンを把握しているはずであり、したがって実行時にサポートされていないフラグを指定すべきではありません。

解説(Remarks)

この関数を使用すると、カーネル実装は検証と内部マッピングを 1 回だけ実行できるため、各 I/O 操作でのオーバーヘッドを回避できます。送信キュー内の後続のエントリは、配列への整数インデックスを使用して、この関数で登録されたバッファを参照できます。以前の登録が存在する場合、この呼び出しはその以前の登録を完全に置き換えます。配列内のエントリで Address が NULL かつ Length が 0 のものはスパースエントリであり、使用されません。これにより、以前に登録したバッファの 1 つ以上を解放できます。

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

各言語での呼び出し定義

// api-ms-win-core-ioring-l1-1-0.dll
#include <windows.h>

HRESULT BuildIoRingRegisterBuffers(
    HIORING ioRing,
    DWORD count,
    const IORING_BUFFER_INFO* buffers,
    UINT_PTR userData
);

[DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling = true)]
static extern int BuildIoRingRegisterBuffers(
    IntPtr ioRing,   // HIORING
    uint count,   // DWORD
    IntPtr buffers,   // IORING_BUFFER_INFO*
    UIntPtr userData   // UINT_PTR
);

<DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function BuildIoRingRegisterBuffers(
    ioRing As IntPtr,   ' HIORING
    count As UInteger,   ' DWORD
    buffers As IntPtr,   ' IORING_BUFFER_INFO*
    userData As UIntPtr   ' UINT_PTR
) As Integer
End Function

' ioRing : HIORING
' count : DWORD
' buffers : IORING_BUFFER_INFO*
' userData : UINT_PTR
Declare PtrSafe Function BuildIoRingRegisterBuffers Lib "api-ms-win-core-ioring-l1-1-0" ( _
    ByVal ioRing As LongPtr, _
    ByVal count As Long, _
    ByVal buffers As LongPtr, _
    ByVal userData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BuildIoRingRegisterBuffers = ctypes.windll.LoadLibrary("api-ms-win-core-ioring-l1-1-0.dll").BuildIoRingRegisterBuffers
BuildIoRingRegisterBuffers.restype = ctypes.c_int
BuildIoRingRegisterBuffers.argtypes = [
    wintypes.HANDLE,  # ioRing : HIORING
    wintypes.DWORD,  # count : DWORD
    ctypes.c_void_p,  # buffers : IORING_BUFFER_INFO*
    ctypes.c_size_t,  # userData : UINT_PTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-ioring-l1-1-0.dll')
BuildIoRingRegisterBuffers = Fiddle::Function.new(
  lib['BuildIoRingRegisterBuffers'],
  [
    Fiddle::TYPE_VOIDP,  # ioRing : HIORING
    -Fiddle::TYPE_INT,  # count : DWORD
    Fiddle::TYPE_VOIDP,  # buffers : IORING_BUFFER_INFO*
    Fiddle::TYPE_UINTPTR_T,  # userData : UINT_PTR
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-core-ioring-l1-1-0")]
extern "system" {
    fn BuildIoRingRegisterBuffers(
        ioRing: *mut core::ffi::c_void,  // HIORING
        count: u32,  // DWORD
        buffers: *const IORING_BUFFER_INFO,  // IORING_BUFFER_INFO*
        userData: usize  // UINT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("api-ms-win-core-ioring-l1-1-0.dll")]
public static extern int BuildIoRingRegisterBuffers(IntPtr ioRing, uint count, IntPtr buffers, UIntPtr userData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-ioring-l1-1-0_BuildIoRingRegisterBuffers' -Namespace Win32 -PassThru
# $api::BuildIoRingRegisterBuffers(ioRing, count, buffers, userData)

#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#func global BuildIoRingRegisterBuffers "BuildIoRingRegisterBuffers" sptr, sptr, sptr, sptr
; BuildIoRingRegisterBuffers ioRing, count, varptr(buffers), userData   ; 戻り値は stat
; ioRing : HIORING -> "sptr"
; count : DWORD -> "sptr"
; buffers : IORING_BUFFER_INFO* -> "sptr"
; userData : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global BuildIoRingRegisterBuffers "BuildIoRingRegisterBuffers" sptr, int, var, sptr
; res = BuildIoRingRegisterBuffers(ioRing, count, buffers, userData)
; ioRing : HIORING -> "sptr"
; count : DWORD -> "int"
; buffers : IORING_BUFFER_INFO* -> "var"
; userData : UINT_PTR -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global BuildIoRingRegisterBuffers "BuildIoRingRegisterBuffers" sptr, int, sptr, sptr
; res = BuildIoRingRegisterBuffers(ioRing, count, varptr(buffers), userData)
; ioRing : HIORING -> "sptr"
; count : DWORD -> "int"
; buffers : IORING_BUFFER_INFO* -> "sptr"
; userData : UINT_PTR -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。