Win32 API 日本語リファレンス
ホームSystem.JobObjects › JOBOBJECT_CPU_RATE_CONTROL_INFORMATION

JOBOBJECT_CPU_RATE_CONTROL_INFORMATION

構造体
サイズx64: 16 バイト / x86: 8 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
ControlFlagsJOB_OBJECT_CPU_RATE_CONTROL4+0+0

CPU レート制御のスケジューリング ポリシーです。このメンバーには、次の値のいずれかを指定できます。

意味
JOB_OBJECT_CPU_RATE_CONTROL_ENABLE
0x1
このフラグを設定すると、重みまたはハード キャップに基づいてジョブの CPU レートを制御できるようになります。JOB_OBJECT_CPU_RATE_CONTROL_WEIGHT_BASEDJOB_OBJECT_CPU_RATE_CONTROL_HARD_CAP、または JOB_OBJECT_CPU_RATE_CONTROL_MIN_MAX_RATE を設定する場合は、この値も設定しなければなりません。
JOB_OBJECT_CPU_RATE_CONTROL_WEIGHT_BASED
0x2
ジョブの CPU レートは、他のジョブの重みに対する相対的な重みに基づいて計算されます。このフラグが設定されている場合、詳細情報は Weight メンバーに格納されます。このフラグがクリアされている場合、詳細情報は CpuRate メンバーに格納されます。

JOB_OBJECT_CPU_RATE_CONTROL_WEIGHT_BASED を設定した場合、JOB_OBJECT_CPU_RATE_CONTROL_MIN_MAX_RATE を同時に設定することはできません。

JOB_OBJECT_CPU_RATE_CONTROL_HARD_CAP
0x4
ジョブの CPU レートはハード リミットになります。ジョブが現在のスケジューリング間隔での CPU サイクル制限に達すると、次の間隔まで、そのジョブに関連付けられたスレッドは実行されません。

JOB_OBJECT_CPU_RATE_CONTROL_HARD_CAP を設定した場合、JOB_OBJECT_CPU_RATE_CONTROL_MIN_MAX_RATE を同時に設定することはできません。

JOB_OBJECT_CPU_RATE_CONTROL_NOTIFY
0x8
許容間隔中にジョブの CPU レートがジョブのレート制限を超えた場合に、メッセージを送信します。
JOB_OBJECT_ CPU_RATE_CONTROL_MIN_MAX_RATE
0x10
ジョブの CPU レートは、MinRate メンバーと MaxRate メンバーで指定する最小レートおよび最大レートによって制限されます。

JOB_OBJECT_CPU_RATE_CONTROL_MIN_MAX_RATE を設定した場合、JOB_OBJECT_CPU_RATE_CONTROL_WEIGHT_BASEDJOB_OBJECT_CPU_RATE_CONTROL_HARD_CAP はどちらも設定できません。

Anonymous_Anonymous_e__Union8/4+8+4制御方式に応じた値(CpuRate/Weight/最小最大率)を保持する無名共用体。

共用体: _Anonymous_e__Union x64 8B / x86 4B

フィールドサイズx64x86説明
CpuRateDWORD4+0+0

各スケジューリング間隔中にジョブ オブジェクト内のスレッドが使用できるプロセッサ サイクルの割合を、10,000 サイクルあたりのサイクル数として指定します。ControlFlags メンバーに JOB_OBJECT_CPU_RATE_WEIGHT_BASED または JOB_OBJECT_CPU_RATE_CONTROL_MIN_MAX_RATE が指定されている場合、このメンバーは使用されません。

CpuRate には、パーセンテージに 100 を掛けた値を設定します。たとえば、ジョブに CPU の 20% を使用させるには、CpuRate に 20 × 100、つまり 2,000 を設定します。

CpuRate に 0 を設定しないでください。CpuRate が 0 の場合、SetInformationJobObjectINVALID_ARGS を返します。

WeightDWORD4+0+0

ControlFlags メンバーに JOB_OBJECT_CPU_RATE_WEIGHT_BASED が指定されている場合、このメンバーはジョブ オブジェクトのスケジューリングの重みを指定します。この重みによって、プロセッサ上の他のワークロードとの比較で、そのジョブに与えられるプロセッサ時間の割り当てが決まります。

このメンバーには 1 から 9 までの値を指定できます。1 が最小の割り当て、9 が最大の割り当てです。既定値は 5 で、ほとんどのワークロードにはこの値を使用してください。

ControlFlags メンバーに JOB_OBJECT_CPU_RATE_CONTROL_MIN_MAX_RATE が指定されている場合、このメンバーは使用されません。

Anonymous_Anonymous_e__Struct8/4+0+0制御方式に応じた値(CpuRate/Weight/最小最大率)を保持する無名共用体。

公式ドキュメント

ジョブ オブジェクトの CPU レート制御情報を格納します。この構造体は、SetInformationJobObject 関数および QueryInformationJobObject 関数で、JobObjectCpuRateControlInformation 情報クラスと共に使用されます。

解説(Remarks)

ネストされたジョブの階層内にある複数のジョブに対して、CPU レート制御を設定できます。ジョブ オブジェクトに CPU レート制御を設定すると、その設定は階層内のそのジョブとその子ジョブに適用されます。ネストされた階層内のジョブに CPU レート制御を設定すると、システムは、そのジョブの直接の親ジョブの CPU レート制御を基準として、対応するクォータを計算します。つまり、ジョブに設定されたレートは、親ジョブに割り当てられた CPU レートのうち、そのジョブが占める割合を表します。ジョブ オブジェクトの親ジョブの連鎖の中に CPU レート制御が有効になっている親が存在しない場合、そのジョブのレート制御はシステム全体の CPU に対する割合を表します。

Dynamic Fair Share Scheduling (DFSS) が有効になっている場合、リモート デスクトップ サービス(旧称 Terminal Services)で実行されているアプリケーションのジョブ オブジェクトでは、CPU レート制御を使用できません。

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

各言語での定義

#include <windows.h>

// JOBOBJECT_CPU_RATE_CONTROL_INFORMATION  (x64 16 / x86 8 バイト)
typedef struct JOBOBJECT_CPU_RATE_CONTROL_INFORMATION {
    JOB_OBJECT_CPU_RATE_CONTROL ControlFlags;
    _Anonymous_e__Union Anonymous;
} JOBOBJECT_CPU_RATE_CONTROL_INFORMATION;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct JOBOBJECT_CPU_RATE_CONTROL_INFORMATION
{
    public uint ControlFlags;
    public _Anonymous_e__Union Anonymous;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure JOBOBJECT_CPU_RATE_CONTROL_INFORMATION
    Public ControlFlags As UInteger
    Public Anonymous As _Anonymous_e__Union
End Structure
import ctypes
from ctypes import wintypes

class JOBOBJECT_CPU_RATE_CONTROL_INFORMATION(ctypes.Structure):
    _fields_ = [
        ("ControlFlags", wintypes.DWORD),
        ("Anonymous", _Anonymous_e__Union),
    ]
#[repr(C)]
pub struct JOBOBJECT_CPU_RATE_CONTROL_INFORMATION {
    pub ControlFlags: u32,
    pub Anonymous: _Anonymous_e__Union,
}
import "golang.org/x/sys/windows"

type JOBOBJECT_CPU_RATE_CONTROL_INFORMATION struct {
	ControlFlags uint32
	Anonymous _Anonymous_e__Union
}
type
  JOBOBJECT_CPU_RATE_CONTROL_INFORMATION = record
    ControlFlags: DWORD;
    Anonymous: _Anonymous_e__Union;
  end;
const JOBOBJECT_CPU_RATE_CONTROL_INFORMATION = extern struct {
    ControlFlags: u32,
    Anonymous: _Anonymous_e__Union,
};
type
  JOBOBJECT_CPU_RATE_CONTROL_INFORMATION {.bycopy.} = object
    ControlFlags: uint32
    Anonymous: _Anonymous_e__Union
struct JOBOBJECT_CPU_RATE_CONTROL_INFORMATION
{
    uint ControlFlags;
    _Anonymous_e__Union Anonymous;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; JOBOBJECT_CPU_RATE_CONTROL_INFORMATION サイズ: 8 バイト(x86)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; ControlFlags : JOB_OBJECT_CPU_RATE_CONTROL (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+4, 4byte)  varptr(st)+4 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; JOBOBJECT_CPU_RATE_CONTROL_INFORMATION サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; ControlFlags : JOB_OBJECT_CPU_RATE_CONTROL (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global JOBOBJECT_CPU_RATE_CONTROL_INFORMATION
    #field int ControlFlags
    #field byte Anonymous 8
#endstruct

stdim st, JOBOBJECT_CPU_RATE_CONTROL_INFORMATION        ; NSTRUCT 変数を確保
st->ControlFlags = 100
mes "ControlFlags=" + st->ControlFlags
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。