第 5 章 — 規範を書く
この章では、第 4 章で書いた契約に、SoS-DSL 拡張のライフサイクルと監視ルールを加えます(約 15 分)。演習では、状態や監視ルールを足し、2 つの契約を共存させます。
5.1 学ぶこと
手順で:
- 契約インスタンスが取りうる 7 つのライフサイクル状態。
- 遷移に期限を付け、期限切れのときにインスタンスをどの状態へ移すかを指定する
deadline+on_violationの書き方。 - その時点のアクターの状態を一定の間隔で読み、条件式を評価する
monitorの書き方。
演習で:
- 構造的な契約に、インスタンスごとの
lifecycle:を追加できる。 - 述語とサンプリング指定を持つ宣言的
monitors:を追加できる。 cadl sim-irの JSON 出力を読み、自分が追加した部分を特定できる。
5.2 背景
第 4 章で書いた契約は、合意の種類(クラス)を記述したものです。実際の SoS では、配送要求 1 件につき 1 つ、同じ合意のインスタンスが同時に複数存在します。各インスタンスはそれぞれの状態を持ち、時間とともに状態を移っていきます。
どの配送要求のインスタンスも同じライフサイクルに従い、違うのはデータ(どのロボット、どの顧客か)だけです。
クラスとインスタンス
契約の記述が表すのは、結ぶ合意の種類です。個々の配送はその合意の インスタンス で、次のように状態を移ります。
この状態の移り方は、次の 2 つのキーで書きます。
lifecycle::状態、初期状態と終端状態の指定、deadlineとon_violationを付けた遷移を書くmonitors::一定の間隔で、またはイベントのたびに評価する監視ルールを書く。ruleが成り立つと、違反を記録する(on_match.violation)、契約インスタンスを指定した状態(on_match.transition、例:Violated)へ移す、またはその両方を行う
5.3 手順
まず my_delivery.cadl の先頭付近で、このファイルが SoS-DSL 拡張を使うことを宣言します。Appendix E はこの宣言を求めており(SHOULD)、同梱の例にも入っています。
sos:
name: "MyDelivery"
type: Acknowledged # 中央権威 + 自律エージェント
version: "0.1.0"
extensions: # ← 追加: SoS-DSL 拡張を使うことの宣言
- sos-dsl: 0.1
続いて、DELIVERY_SLA 契約に、以下の「新ブロック 1」と「新ブロック 2」を追加します。YAML なので、インデントを正確にそろえてください。
contracts:
- id: DELIVERY_SLA
parties: [DISPATCHER, "ROBOT[*]", "CUSTOMER[*]"]
assume:
- "ROBOT[i].battery > 20"
guarantee:
- "delivery_time <= 300s"
incentives:
type: task_completion
lambda: 0.5
rules:
- "reward(ROBOT[i], 10) when on_time_delivery"
# ╔═══════════════════════════════════════════════════════════════╗
# ║ 新ブロック 1: インスタンスごとのライフサイクル ║
# ╚═══════════════════════════════════════════════════════════════╝
lifecycle:
states:
- Proposed
- Assigned
- Accepted
- Delivering
- Completed
- Violated
- Terminated
initial: Proposed
terminal: [Completed, Violated, Terminated]
transitions:
- id: assign
from: Proposed
to: Assigned
on: "DISPATCHER -> ROBOT[i] : route_assignment"
- id: accept
from: Assigned
to: Accepted
on: "ROBOT[i] -> DISPATCHER : ack(accepted)"
deadline: 5s # ⏱ 5 秒以内に来なければ
on_violation: # → Violated に飛ばす
transition: Violated
severity: Major
- id: start_delivery
from: Accepted
to: Delivering
on: "ROBOT[i].status == InTransit"
- id: complete
from: Delivering
to: Completed
on: "ROBOT[i].status == Delivered"
# ╔═══════════════════════════════════════════════════════════════╗
# ║ 新ブロック 2: 宣言的モニター ║
# ╚═══════════════════════════════════════════════════════════════╝
monitors:
- id: battery_guard
observe: "ROBOT[i].battery"
sampling: periodic(500ms) # 評価周期
rule: "ROBOT[i].battery < 20 AND state == Assigned"
on_match:
transition: Violated
severity: Major
もう一度 cadl check で検査します。
cadl check my_delivery.cadl
5.4 期待される出力
$ cadl check my_delivery.cadl
Type check passed: my_delivery.cadl
IR に変換して、追加した項目が入ったことを確認します。
cadl sim-ir my_delivery.cadl --format json \
| python3 -c "
import json, sys
d = json.load(sys.stdin)
c = d['institution']['contracts'][0]
print(f'lifecycle.initial : {c[\"lifecycle\"][\"initial\"]}')
print(f'lifecycle.states : {c[\"lifecycle\"][\"states\"]}')
print(f'monitors[0].id : {c[\"monitors\"][0][\"id\"]}')
print(f' rule : {c[\"monitors\"][0][\"rule\"]}')
"
lifecycle.initial : Proposed
lifecycle.states : ['Proposed', 'Assigned', 'Accepted', 'Delivering', 'Completed', 'Violated', 'Terminated']
monitors[0].id : battery_guard
rule : ROBOT[i].battery < 20 AND state == Assigned
5.5 チェック
- 第 4 章のファイルとの違いは、
extensions:の宣言と新ブロック 2 つだけである。アクターは変えていない。 - IR の
"lifecycle": nullがオブジェクトになり、"monitors": []が要素 1 のリストになった。
5.6 よくある間違い
| 症状 | 原因 |
|---|---|
cadl check は通るが、IR が "lifecycle": null になり、第 6 章で状態が表示されない | lifecycle: ブロックのインデントが違い、契約の一部として読まれていない。lifecycle: は assume: / guarantee: と同じレベルに置き、states: はその 1 段下に書く。チェッカはインデントの誤りそのものは報告しない。モニターがライフサイクルの状態を参照しているときに限り、契約にライフサイクルがないことが M-3 のエラーとして間接的に報告される。 |
on: がブール値として解釈されてしまう | YAML 1.1 では on がブール値として読まれるため。CADL のパーサは内部に _yaml_on_key の回避策を持っているので同梱の例は正しく動く。自分でパーサを書くときは注意。 |
monitor.rule が常に false | state == Assigned の右辺は引用符なしの識別子でよい(CADL の書き方)。二重引用符で \"Assigned\" と書いても意味は同じ。単引用符('Assigned')はルールの文法にないので、cadl check が「is not a valid rule (Appendix E.3) and is kept as text」と警告し、モニターは発火しない。 |
5.7 おさらい
同じファイルで構造(第 4 章)と規範(第 5 章)の両方を記述しました。IR には構造に加えて規範が入り、ランタイムを動かすのに必要な情報がそろいました。
この章の監視ルールは SoS-DSL 拡張のものです。仕様書の規範拡張(付録 F)では、契約の規範を義務、許可、禁止、権能として書きます。規範の条件には、アクターの集合に対する限量子や集約も使えます(F.5 節)。cadl norms-eval は記録したトレースについて規範を判定し、cadl norms-check はシステムを動かす前に 1 つの契約の規範をモデル検査器 PRISM で検査します。たとえば、2 つの規範が衝突するかどうかを検査できます(F.12 節)。本書では規範拡張は使いません。
5.8 演習
演習 5.1 (★) — 基本的なライフサイクルを追加
目的: my_delivery_v1.cadl を my_delivery_v2.cadl として保存し、DELIVERY_SLA に 5.3 節の 7 状態を持つ lifecycle: ブロックを追加。
手順:
v1→v2をコピー。lifecycle.states、lifecycle.initial、lifecycle.terminalと 4 つの遷移(assign、accept、start_delivery、complete)を追加。acceptにdeadline: 5sとon_violation.transition: Violatedを設定(値は移動先の状態名)。あわせて、5.3 節と同じくsos:の下にextensions: [sos-dsl: 0.1]を宣言し、5.3 節のmonitors:ブロック(battery_guard)も写す。第 7 章はこの演習の v2 を動かし、このモニターがある前提で結果を説明する。cadl check my_delivery_v2.cadlを実行し、続けてcadl sim-ir my_delivery_v2.cadl --format json | grep -n -A3 '"lifecycle"'を実行("lifecycle"キーは IR のかなり後ろにある。5.3 節のファイルでは 90 行目、第 4 章でアクターや契約を追加していればさらに後ろになるので、headでは途中で切れて見えない)。- 出力で
"lifecycle"がnullでなくなったことを確認:行が"lifecycle": {になり、続いて"states": [と最初の状態名が並ぶ。演習 4.2 でMAINTENANCE_SLAを追加している場合、grepはその契約の分も出力し、そちらは"lifecycle": nullのままになる。lifecycle を持つのはDELIVERY_SLAだけなので、これで正しい。
演習 5.2 (★★) — 過速度モニターを追加
目的: 配送中に 1.5 m/s を超えて走るロボットを検出し、severity Critical で Violated へ強制遷移させる。
手順: monitors: の下に追加:
- id: over_speed
observe: "ROBOT[i].speed"
sampling: periodic(200ms)
rule: "ROBOT[i].speed > 1.5 AND state == Delivering"
on_match:
transition: Violated
severity: Critical
振り返り: ロボットの制御コード(Unity 側の Pilot_CSoS.cs)を 1 行も変えずに、新しい規範の規則を追加しました。このことから、制御コードと規範の仕様を分けて書く利点について何が言えますか?([Maier 1998] の条件 (4)「創発的振る舞い」と比べてみてください。ここでは、構成要素を設計し直さずに、規範が創発的振る舞いを制約しています)
演習 5.3 (★★) — Cancelled 状態を追加
目的: ロボットがまだ Assigned の段階で顧客が配送をキャンセルできるようにし、新しい終端状態 Cancelled へ移す。
手順:
lifecycle.statesとlifecycle.terminalにCancelledを追加。AssignedからCancelledへの遷移customer_cancelを追加し、on:に"CUSTOMER[i] -> DISPATCHER : cancel_order"を書く。Cancelledを違反として扱うべきかを判断する。CADL では、終端状態はそれだけでは違反を意味せず、インスタンスが終わったことを表す。
振り返り: Cancelled を追加したとき、既存のシミュレーションは壊れましたか? なぜですか? (状態を追加しても既存の動作は変わらないが、deadline を追加すると変わる。)
演習 5.4 (★★★) — 2 つの契約を共存させる
目的: DELIVERY_SLA とは別に FLEET_SAFETY 契約を新しく書く。この契約のライフサイクルは個々の配送とは独立で、ロボットが稼働している間ずっと有効である。
手順:
- 3 状態のライフサイクルを定義:
Operational → Degraded → OutOfService。 - バッテリが 10% を下回ったら
Degradedへ移すモニターを追加(配送の状態には関係なく評価する)。 cadl checkを実行。DELIVERY_SLAのルールと衝突しますか?
振り返り: 同じロボットが両方の契約の当事者になることがあります。一方の契約では進んでよく、もう一方の契約では停止すべきとき、どのような意味論(どちらを優先するか)にしたいですか?
授業で使う場合
授業の前に。
- 第 4 章の
my_delivery_v1.cadl - 事前読書 30 分:本書の 3.7〜3.9 節(さらに詳しくは仕様書の 付録 E)。
まとめと宿題。
次の授業(第 6 章)に持参:
my_delivery_v2.cadl(最低限 演習 5.1〜5.3 を完了)- IR JSON スナップショット
my_delivery_v2.ir.json(cadl sim-ir … --format json > my_delivery_v2.ir.json) - (任意)演習 5.4 に取り組んだなら
my_delivery_v2_with_safety.cadl