コンテンツにスキップ

STATE_DB カウンタ能力テーブル

概要

orchagent は起動時に SAI へカウンタ能力を問い合わせ、その結果を STATE_DB の 3 つのテーブルに書き込む1。これらのテーブルは 読み取り専用 の能力情報であり、ユーザーが CONFIG_DB から書き込む設定テーブルではない。

STATE_DB テーブル 書き込み元 参照先
PORT_COUNTER_CAPABILITIES portsorch (initCounterCapabilities) portstat.py、portstat CLI
QUEUE_COUNTER_CAPABILITIES portsorch (initCounterCapabilities) queuestat CLI
DEBUG_COUNTER_CAPABILITIES debugcounterorch (publishDropCounterCapabilities) show debug-counter capabilities

データフロー (自動生成)

flowchart LR
  SAI["SAI / ASIC<br/>sai_query_stats_capability<br/>sai_query_attribute_enum_values_capability"]
  ORC["orchagent<br/>portsorch / debugcounterorch"]
  STATEDB[("STATE_DB<br/>PORT_COUNTER_CAPABILITIES<br/>QUEUE_COUNTER_CAPABILITIES<br/>DEBUG_COUNTER_CAPABILITIES")]
  CLI["portstat / show debug-counter<br/>(sonic-utilities)"]
  SAI --> ORC
  ORC --> STATEDB
  STATEDB --> CLI

凡例

これらのテーブルは CONFIG_DB を経由しない。orchagent が SAI から直接能力を読み取り STATE_DB に書き込む。portstat などのツールが COUNTERS_DB ポーリング前にここを参照し、プラットフォームがサポートしないカウンタを事前に除外する。

PORT_COUNTER_CAPABILITIES テーブル

key 構造

STATE_DB / PORT_COUNTER_CAPABILITIES | <counter_group_name>   (Hash)
  field: isSupported   value: "true" | "false"

フィールド一覧

key (counter_group_name) isSupported 条件 対応 SAI 統計
WRED_ECN_PORT_WRED_GREEN_DROP_COUNTER SAI_PORT_STAT_GREEN_WRED_DROPPED_PACKETS がプラットフォームでサポートされている SAI_PORT_STAT_GREEN_WRED_DROPPED_PACKETS
WRED_ECN_PORT_WRED_YELLOW_DROP_COUNTER SAI_PORT_STAT_YELLOW_WRED_DROPPED_PACKETS がサポートされている SAI_PORT_STAT_YELLOW_WRED_DROPPED_PACKETS
WRED_ECN_PORT_WRED_RED_DROP_COUNTER SAI_PORT_STAT_RED_WRED_DROPPED_PACKETS がサポートされている SAI_PORT_STAT_RED_WRED_DROPPED_PACKETS
WRED_ECN_PORT_WRED_TOTAL_DROP_COUNTER SAI_PORT_STAT_WRED_DROPPED_PACKETS がサポートされている SAI_PORT_STAT_WRED_DROPPED_PACKETS

書き込みタイミング

  1. 起動直後: portsorch コンストラクタが initCounterCapabilities() を呼ぶ。まず全フィールドを isSupported="false" で書き込む2
  2. SAI 問い合わせ後: sai_query_stats_capability(SAI_OBJECT_TYPE_PORT, ...) でプラットフォームのポート統計能力を取得し、サポートされる統計 enum ごとに isSupported="true" に更新3
  3. SAI 失敗時: 問い合わせが失敗すると全フィールドが "false" のままになる。SWSS_LOG_NOTICE を出力するのみで orchagent はエラー終了しない

QUEUE_COUNTER_CAPABILITIES テーブル

key 構造

STATE_DB / QUEUE_COUNTER_CAPABILITIES | <counter_group_name>   (Hash)
  field: isSupported   value: "true" | "false"

フィールド一覧

key (counter_group_name) isSupported 条件 対応 SAI 統計
WRED_ECN_QUEUE_ECN_MARKED_PKT_COUNTER SAI_QUEUE_STAT_WRED_ECN_MARKED_PACKETS がサポートされている SAI_QUEUE_STAT_WRED_ECN_MARKED_PACKETS
WRED_ECN_QUEUE_ECN_MARKED_BYTE_COUNTER SAI_QUEUE_STAT_WRED_ECN_MARKED_BYTES がサポートされている SAI_QUEUE_STAT_WRED_ECN_MARKED_BYTES
WRED_ECN_QUEUE_WRED_DROPPED_PKT_COUNTER SAI_QUEUE_STAT_WRED_DROPPED_PACKETS がサポートされている SAI_QUEUE_STAT_WRED_DROPPED_PACKETS
WRED_ECN_QUEUE_WRED_DROPPED_BYTE_COUNTER SAI_QUEUE_STAT_WRED_DROPPED_BYTES がサポートされている SAI_QUEUE_STAT_WRED_DROPPED_BYTES

PORT_COUNTER_CAPABILITIES と同様に全フィールドが起動時 "false" で初期化され、sai_query_stats_capability(SAI_OBJECT_TYPE_QUEUE, ...) の結果に基づいて "true" に更新される4。

DEBUG_COUNTER_CAPABILITIES テーブル

key 構造

STATE_DB / DEBUG_COUNTER_CAPABILITIES | <counter_type>   (Hash)
  field: count     value: "<整数文字列>"   — 利用可能な debug counter 数
  field: reasons   value: '["<drop_reason>",...]'   — サポートされる drop reason 一覧

counter_type キー

counter_type 説明
PORT_INGRESS_DROPS ポート単位の ingress drop カウンタ
PORT_EGRESS_DROPS ポート単位の egress drop カウンタ
SWITCH_INGRESS_DROPS スイッチ全体の ingress drop カウンタ
SWITCH_EGRESS_DROPS スイッチ全体の egress drop カウンタ

書き込みロジック

DebugCounterOrch::publishDropCounterCapabilities() が起動時に呼ばれ、以下の順で STATE_DB を更新する5。

  1. SAI drop reason 能力を取得: getSupportedDropReasons(SAI_DEBUG_COUNTER_ATTR_IN_DROP_REASON_LIST) および ..._OUT_DROP_REASON_LIST
  2. サポートされる counter_type を取得: getSupportedCounterTypes() が sai_query_attribute_enum_values_capability() を呼ぶ
  3. 条件が揃ったエントリのみ書き込み:
  4. count = "0" の counter_type は書き込まない
  5. reasons が空文字列の counter_type は書き込まない

エントリ不存在の意味

DEBUG_COUNTER_CAPABILITIES にキーが存在しない counter_type はプラットフォームが SAI debug counter query をサポートしないことを示す。show debug-counter capabilities の出力が空の場合も同様。

暗黙デフォルト・コード由来挙動 (Phase A)

起動時 false 初期化と更新競合ウィンドウ

種類 詳細
コード由来デフォルト 全フィールドが "false" で先書きされる (portsorch.cpp:1868-1879)。SAI 問い合わせ完了まで数ミリ秒間、portstat.py が参照すると WRED カウンタが N/A と表示される
SAI 失敗時残存 sai_query_stats_capability() 失敗時は全フィールドが "false" のまま。SWSS_LOG_NOTICE のみで silent 継続 (portsorch.cpp:1965-1968)

portstat.py の WRED silent skip

portstat.py:297-329 で isSupported が "true" でない場合、対応する SAI カウンタを counter_bucket_dict から削除する。COUNTERS_DB のポーリング対象から外れ、エラーなく N/A となる6。

条件 挙動
isSupported = "true" COUNTERS_DB から SAI_PORT_STAT_GREEN_WRED_DROPPED_PACKETS をポーリング
isSupported = "false" または キーなし ポーリング対象から除外。portstat 表示は N/A

DEBUG_COUNTER_CAPABILITIES の選択的書き込み

条件 挙動
プラットフォームが SAI debug counter を未サポート getSupportedDropReasons() が空集合返却 → テーブルエントリ書き込みなし
count=0 の counter_type publishDropCounterCapabilities() が書き込みをスキップ (debugcounterorch.cpp:348-354)
SAI query 失敗 getSupportedCounterTypes() が空集合返却。全 counter_type がスキップされテーブル自体が空

関連リファレンス

  1. schema.h:438,528,529 で定数定義。STATE_PORT_COUNTER_CAPABILITIES_NAME = "PORT_COUNTER_CAPABILITIES"、STATE_QUEUE_COUNTER_CAPABILITIES_NAME = "QUEUE_COUNTER_CAPABILITIES"、STATE_DEBUG_COUNTER_CAPABILITIES_NAME = "DEBUG_COUNTER_CAPABILITIES" ↩

  2. portsorch.cpp:1868-1879。fieldValuesFalse に ("isSupported","false") を格納し全 4 フィールドに書き込む ↩

  3. portsorch.cpp:1936-1964。SAI_STATUS_SUCCESS の場合のみ更新。失敗時は SWSS_LOG_NOTICE で通知 ↩

  4. portsorch.cpp:1881-1918。SAI_STATUS_SUCCESS の場合のみ更新 ↩

  5. debugcounterorch.cpp:315-363。publishDropCounterCapabilities() はコンストラクタで呼ばれる (debugcounterorch.cpp:37) ↩

  6. portstat.py:314-329。is_wred_stats_reqd が False または isSupported != "true" の場合に除外 ↩