STATE_DB PBH_CAPABILITIES テーブル¶

概要¶

PBH_CAPABILITIES は STATE_DB 上に書かれる PBH (Policy Based Hashing) のフィールド更新可否能力テーブル¹。orchagent の PbhCapabilities クラスが起動時に ASIC_VENDOR 環境変数を参照してプラットフォームを判別し、各 PBH フィールドに対して ADD / UPDATE / REMOVE の組み合わせをカンマ区切り文字列で書き込む。CONFIG_DB の PBH_TABLE / PBH_RULE / PBH_HASH / PBH_HASH_FIELD テーブルとは別に、運用上のフィールド操作制約をランタイムに公開するための機構。

sonic-utilities の config pbh コマンドがこのテーブルを参照し、操作可否を事前検証する (pbhcap.cpp:288-289)。

key 構造¶

PBH_CAPABILITIES|table
PBH_CAPABILITIES|rule
PBH_CAPABILITIES|hash
PBH_CAPABILITIES|hash-field

4 サブキー固定。ワイルドカード展開なし。

フィールド¶

PBH_CAPABILITIES|table¶

フィールド	型	値	説明
`interface_list`	enum string	`"UPDATE"`	interface_list フィールドの対応操作。Generic・Mellanox 共通
`description`	enum string	`"UPDATE"`	description フィールドの対応操作

PBH_CAPABILITIES|rule¶

フィールド	型	Generic / Mellanox 値	説明
`priority`	enum string	`"UPDATE"`	priority フィールドの対応操作
`gre_key`	enum string	`"ADD,UPDATE,REMOVE"`	gre_key フィールドの対応操作
`ether_type`	enum string	`"ADD,UPDATE,REMOVE"`	ether_type フィールドの対応操作
`ip_protocol`	enum string	`"ADD,UPDATE,REMOVE"`	ip_protocol フィールドの対応操作
`ipv6_next_header`	enum string	`"ADD,UPDATE,REMOVE"`	ipv6_next_header フィールドの対応操作
`l4_dst_port`	enum string	`"ADD,UPDATE,REMOVE"`	l4_dst_port フィールドの対応操作
`inner_ether_type`	enum string	`"ADD,UPDATE,REMOVE"`	inner_ether_type フィールドの対応操作
`hash`	enum string	`"UPDATE"`	hash フィールドの対応操作
`packet_action`	enum string	`"ADD,UPDATE,REMOVE"`	packet_action フィールドの対応操作
`flow_counter`	enum string	`"ADD,UPDATE,REMOVE"`	flow_counter フィールドの対応操作

PBH_CAPABILITIES|hash¶

フィールド	型	値	説明
`hash_field_list`	enum string	`"UPDATE"`	hash_field_list フィールドの対応操作

PBH_CAPABILITIES|hash-field¶

フィールド	型	値	説明
`hash_field`	enum string	`""` (空)	いずれのプラットフォームでも未設定。UPDATE 禁止の意味
`ip_mask`	enum string	`""` (空)	同上
`sequence_id`	enum string	`""` (空)	同上

hash-field が空の理由

PBH_HASH_FIELD はコード上 UPDATE が禁止されている (updatePbhHashField() は常に return false)。能力テーブルに UPDATE/REMOVE フラグを持たせると config pbh hash-field update が誤って許可されるため、空文字列を書き込んでいる。config pbh hash-field update はこの値を見て「更新不可」と判断し拒否する (pbh.py:670-679)。

書き込みタイミング¶

PbhCapabilities コンストラクタは orchagent 起動時に呼ばれる。

parsePbhAsicVendor() — ASIC_VENDOR 環境変数を読んで Generic / Mellanox を判別。未設定時は Generic へ fallback。
initPbhVendorCapabilities() — ベンダー別 PbhVendorFieldCapabilities サブクラスを構築。
writePbhVendorCapabilitiesToDb() — 4 サブキーを Table::set() で一括書き込み (pbhcap.cpp:313-321)。

起動後は更新されない (read-once write)。

ベンダー差異¶

ベンダー	判別条件	hash-field の hashField 系
Generic	`ASIC_VENDOR != "mellanox"` / 未設定	`setPbhDefaults()` 未呼び出し → 全空
Mellanox	`ASIC_VENDOR = "mellanox"`	同上 → 全空

現状 Generic と Mellanox の差異は rule.priority・rule.hash の INSERT なし (UPDATE のみ) と、hash.hash_field_list の INSERT なし (UPDATE のみ) の点で完全に一致する。差異は pbhcap.cpp:94-109 を参照。

購読者¶

config pbh table add/update/del (config/plugins/pbh.py:1351) — pbh_capabilities_query(db, "table") で interface_list・description の操作可否チェック
config pbh rule add/update/del (config/plugins/pbh.py:1090,1218) — pbh_capabilities_query(db, "rule") で各 match field の操作可否チェック
config pbh hash add/update/del (config/plugins/pbh.py:781) — pbh_capabilities_query(db, "hash") で hash_field_list の操作可否チェック
config pbh hash-field add/update/del (config/plugins/pbh.py:670) — pbh_capabilities_query(db, "hash-field") で各フィールドの操作可否チェック

フィールドデフォルト (Phase A — コード由来)¶

STATE_DB PBH_CAPABILITIES に対応する YANG schema は存在しない。フィールドとその値はすべて pbhcap.cpp のコードレベルで定義される。

PBH_CAPABILITIES|table フィールド別デフォルト¶

フィールド	STATE_DB 書き込み値	コード由来	備考
`interface_list`	`"UPDATE"`	`this->table.interface_list.insert(PbhFieldCapability::UPDATE)` — `pbhcap.cpp:94`	ADD/REMOVE なし: table 自体は CREATE/DELETE できるが interface_list は後から UPDATE のみ可
`description`	`"UPDATE"`	`this->table.description.insert(PbhFieldCapability::UPDATE)` — `pbhcap.cpp:95`	同上

PBH_CAPABILITIES|rule フィールド別デフォルト¶

フィールド	STATE_DB 書き込み値	コード由来	備考
`priority`	`"UPDATE"`	`this->rule.priority.insert(UPDATE)` — `pbhcap.cpp:97`	priority は rule 作成後の UPDATE のみ許可
`gre_key`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(this->rule.gre_key)` — `pbhcap.cpp:98`	match field は ADD/UPDATE/REMOVE すべて許可 (optional field)
`ether_type`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:99`	同上
`ip_protocol`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:100`	同上
`ipv6_next_header`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:101`	同上
`l4_dst_port`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:102`	同上
`inner_ether_type`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:103`	同上
`hash`	`"UPDATE"`	`this->rule.hash.insert(UPDATE)` — `pbhcap.cpp:104`	hash 参照先は rule 作成後 UPDATE のみ可
`packet_action`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:105`	ADD/UPDATE/REMOVE すべて許可
`flow_counter`	`"ADD,UPDATE,REMOVE"`	`setPbhDefaults(...)` — `pbhcap.cpp:106`	ADD/UPDATE/REMOVE すべて許可

PBH_CAPABILITIES|hash フィールド別デフォルト¶

フィールド	STATE_DB 書き込み値	コード由来	備考
`hash_field_list`	`"UPDATE"`	`this->hash.hash_field_list.insert(UPDATE)` — `pbhcap.cpp:108`	hash_field_list は後から UPDATE のみ可

PBH_CAPABILITIES|hash-field フィールド別デフォルト¶

フィールド	STATE_DB 書き込み値	コード由来	備考
`hash_field`	`""` (空)	どちらの実装も `hashField.hash_field` に INSERT なし — `toStr()` が空 set → `""`	UPDATE 禁止を示す。`updatePbhHashField()` は常に `return false`
`ip_mask`	`""` (空)	同上	同上
`sequence_id`	`""` (空)	同上	同上

テスト fixture 確認値¶

sonic-utilities/tests/pbh_input/state_db.json の実際の値と一致することを確認済み。 Generic platform での期待値:

{
    "PBH_CAPABILITIES|table": {"interface_list": "UPDATE", "description": "UPDATE"},
    "PBH_CAPABILITIES|rule": {
        "priority": "UPDATE", "ether_type": "ADD,UPDATE,REMOVE",
        "ip_protocol": "ADD,UPDATE,REMOVE", "ipv6_next_header": "ADD,UPDATE,REMOVE",
        "l4_dst_port": "ADD,UPDATE,REMOVE", "gre_key": "ADD,UPDATE,REMOVE",
        "inner_ether_type": "ADD,UPDATE,REMOVE", "hash": "UPDATE",
        "packet_action": "ADD,UPDATE,REMOVE", "flow_counter": "ADD,UPDATE,REMOVE"
    },
    "PBH_CAPABILITIES|hash": {"hash_field_list": "UPDATE"},
    "PBH_CAPABILITIES|hash-field": {"hash_field": "", "ip_mask": "", "sequence_id": ""}
}

引用元¶

sonic-swss/orchagent/pbh/pbhcap.cpp — PbhCapabilities コンストラクタ・writePbhVendorCapabilitiesToDb() (L288-321). https://github.com/sonic-net/sonic-swss/blob/master/orchagent/pbh/pbhcap.cpp ↩