公式サンプルが コンパイルできない 〜tracing::info! のエラーから Rust のマクロを読む〜

Transcript

1. 公式サンプルが コンパイルできない tracing::info! のエラーから Rust のマクロを読む @Retasusan / Kyoto.rs #2
2. ⾃⼰紹介 @Retasusan 普段 普段は⼤学3回⽣やってます 最近研究室に配属されました 後最近、⻭が⽋けました 最近の散財 Xで⾒つけたプロンプトで⽣成した右の⼦を 気に⼊ってしまって、この⼦の前掛けを 作ってしまった
3. 散財紹介 シャツも作っちゃった…
4. 直前までLTのネタが決まらない とりあえず何かのコードを読もう 最近、気になっていたOpenTelemetryのRust実装を読むことにする 調査の出発点
5. 読み⽅がわからない‧読んでも分からない 読めない理由の仮説 • ユースケースが良くわかっていない状態で読もうとしているか ら • Rustにあまり詳しくないから 調査の出発点
6. 読み⽅がわからない‧読んでも分からない 読めない理由の仮説 • ユースケースが良くわかっていない状態で読もうとしているか ら ←まだ攻めやすそう • Rustにあまり詳しくないから ←時間的に厳しい 調査の出発点
7. まず隗より始めよ • 物事を⾏うときはまず⾝近なところから始めよという意味 まず、 Getting Started を動かし呼び出しから逆に実装を追う 調査の出発点
8. Getting Started で全体をつかむ サイコロを振る HTTP サンプル 結構⻑いので、⼀度実⾏してから読むことにする ミクロではなく、 まずはマクロの視点で全体を把握しようという試み 実⾏はみんな⼤好き(？) $ cargo run OpenTelemetry Rust Getting Started https://opentelemetry.io/docs/languages/rust/getting-started/ main.rsのコード
9. Getting Started実⾏結果 Rust コンパイラが出したエラー
10. Getting Started おや？ Rust コンパイラが出したエラー
11. Getting Started Rust コンパイラが出したエラー
12. Getting Started 「全体像をつかむには、まずマクロな視点が⼤事」 Rust コンパイラが出したエラー
13. Getting Started 「全体像をつかむには、まずマクロな視点が⼤事」 Rust コンパイラが出したエラー
14. Getting Started 「全体像をつかむには、まずマクロな視点が⼤事」 マクロ発⾒ Rust コンパイラが出したエラー
15. このマクロを調査してみた件についてのLTです マクロ発⾒ Rust コンパイラが出したエラー
16. エラーの原因箇所 公式サンプルの呼び出し 公式サンプル：https://opentelemetry.io/docs/languages/rust/getting-started/
17. そもそもtracing traitって何者？ tracing is a framework for instrumenting Rust programs to collect structured, event-based diagnostic information. tracingは、構造化されたイベントベースの診断情報を収集するために、 Rustプログラムを計測す るためのフレームワークです。 docs.rs/tracingより docs.rs/tracing：https://docs.rs/tracing/latest/tracing/
18. そもそもtracing traitって何者？ tracing is a framework for instrumenting Rust programs to collect structured, event-based diagnostic information. tracingは、構造化されたイベントベースの診断情報を収集するために、 Rustプログラムを計測す るためのフレームワークです。 docs.rs/tracingより わかったような分からないような？ docs.rs/tracing：https://docs.rs/tracing/latest/tracing/
19. tracing crate docs.rs/tracing：https://docs.rs/tracing/latest/tracing/
20. マクロは⼊⼒からコードを作る 例 呼び出しと展開のイメージ show!(score) ↓ score = 80 マクロはコードを受け取る。 渡したコードを⾒て”score”という⽂字も作れる `!` が呼び出しの⽬印。照合と展開はコンパイル中。
21. info! もマクロとして⼊⼒を読む 呼び出しに渡す⼊⼒ マクロがすること ⼊⼒を左から読み、 ルールに照合する。 合うルールが決まれば、そのルールのコードを展開する。 今回は照合中に `.` の扱いで迷い、展開まで進めなかった。 Rust Reference: Macros by Example
22. info! の定義 いっぱいある この中から一致するもので解釈される Rust Reference: Macros by Example：https://docs.rs/tracing/latest/tracing/macro.info.html
23. 問題の⼊⼒は roll.value ここでの `.` `roll.value` は フィールド名。 右辺は記録する値。 error: local ambiguity when calling macro `info` `local ambiguity`: この `.` をどの部分が読むか決められない。 OpenTelemetry Rust Getting Started
24. info! の定義の要点だけ抜く (name: $name:expr, $($k:ident).+ $($field:tt)*) $name:expr $($k:ident).+ $($field:tt)* Event 名の値 roll と value を ピリオドでつなぐ 残りのトークン。 ピリオドも含められる 同じピリオドを左側の区切りにも、右側の⼊⼒にもできる。 出典: docs.rs/tracing/latest/src/tracing/macros.rs.html
25. ピリオドで2通りに分かれる roll . value = random_number 解釈 A: k = roll.value / field =「= random_number, ...」 解釈 B: k = roll / field =「. value = random_number, ...」 候補A: 名前を続ける 候補B: 残りを始める roll.value のピリオドを 名前の区切りとして読む roll で名前を終え、 ピリオドから残りを読む Rust は次の `value` を⾒て選び直さない → local ambiguity Rust Reference: macro_rules! は局所的な曖昧さを先読みで解消しない
26. 修正案 元の書き⽅ 修正案 波括弧でフィールドの範囲を明⽰すると、読み⽅が確定する { ... } がフィールド。 ⽂字列が本⽂。
27. 修正案 修正案 波括弧でフィールドの範囲を明⽰すると、読み⽅が確定する {}をつけると{}の中で、fieldset!を呼び出す $($k:ident).+ = $val:expr, $($rest:tt)*
28. issue を投げた 報告した内容 1. `cargo run` での再現⼿順 2. コンパイラのエラー 3. 波括弧を使う修正案 github.com/open-telemetry/opentelemetry.io/issues/11823
29. ご清聴いただきありがとうございました