PTY on Rust

Transcript

1. PTY on Rust 2015-07-12 Rust of Us - Chapter 2 @hibariya
2. やりたいこと • Rust で • PTY を使って • シェルの入出力を好きなようにする
3. こういうこと
4. こういうこと
5. 入出力を好きなようにできると嬉しい • 何か入出力があるたびに音を鳴らせる • 出力を記録してあとで再現したりできる • ターミナルの表示を遠方の人と共有できる
6. 方法 • パイプを使う • 親の端末につなぐ • システムコールを監視する • 新たな端末を割り付ける
7. 方法 • パイプを使う • 親の端末につなぐ • システムコールを監視する • 新たな端末を割り付ける
8. パイプを使う 端末 <> 親 <> パイプ <> 子
9. パイプを使う • うまくいかない • デフォルトの端末はカノニカルモード (入力は行 ごとに親プロセスへ送られる) なので、改行が来 るまで入力を子プロセスへ送ることができない • vi や nano が使えない • 端末に接続されていないのも都合が悪い
10. 方法 • パイプを使う • 親の端末につなぐ • システムコールを監視する • 新たな端末を割り付ける
11. 親の端末につなぐ 端末 <> 親 <> 子
12. 親の端末につなぐ • うまくいかない • 入力はすぐに子プロセスへ届くが... • 親が子の入出力を捕捉できない • (方法を知らないだけ?)
13. 方法 • パイプを使う • 親の端末につなぐ • システムコールを監視する • 新たな端末を割り付ける
14. システムコールを監視 自分 -> プロセス (write(2) を監視!)
15. システムコールを監視 github.com/hibariya/process_tail • ちょっと微妙 • 既に走っているプロセスにも使える • Linux と Mac OS X で実装が別 • 環境によって微妙に動きが違うのができた • ちょっと重い気がする
16. 方法 • パイプを使う • 親の端末につなぐ • システムコールを監視する • 新たな端末を割り付ける
17. 新たな端末を割り付ける 端末 <> 親 <> 端末 <> 子 (親の端末は raw モードに)
18. 新たな端末を割り付ける note.hibariya.org/articles/20150628/pty.html • うまくいく • 既に走っているプロセスには使えない • 端末を想定しているコマンドも動作する • Linux と Mac OS X でほぼ同じ実装 • 比較的シンプル
19. 色々試した結果 • パイプを使う • 親の端末につなぐ • システムコールを監視する • 新たな端末を割り付ける
20. PTY (Pseudo terminal) • 疑似端末 • 端末をソフトウェアでエミュレートしたもの • ターミナルエミュレータなどが使っている • /dev/pts/4 みたいな名前がついている
21. 新たな端末を割り付ける 端末 <> 親 <> 端末 <> 子 (親の端末は raw モードに)
22. Ruby で書くと1行 output, input, pid = PTY.spawn('bash')
23. Rust ではどうすれば • わからない • PTY.spawn は無かった • libc の API を使えばやれそう • PTY の使い方を調べるところから
24. 情報源 • script(1) のソース • Ruby の ext/pty/pty.c • APUE 第3版 18, 19章
25. PTY のしくみ • マスタとスレーブがある • 双方向パイプのように振る舞う • 親から子へ入力、子から親へ出力できる
26. PTY のしくみ マスタ <> スレーブ <> ラインディシプリン
27. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
28. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
29. 親でマスタ側を開いて fork • posix_openpt (3) • スレーブを開くために grantpt (3), unlockpt (3) も呼んでおく
30. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
31. 子を新しいセッションに入れる • setsid (2) • セッションひとつにつき端末ひとつまで
32. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
33. 子でスレーブ側を開く • ptsname (3) でスレーブの名前を得る • こっちは open(2) で開く
34. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
35. 子でスレーブを標準入出力にする • dup (2) • この時点で入出力が端末につながる
36. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
37. PTY.spawn(‘bash’) のようなこと 1. 親でマスタ側を開いて fork 2. 子を新しいセッションに入れる 3. 子でスレーブ側を開く 4. 子でスレーブを標準入出力にする 5. 子で (bash を) exec 6. 親でマスタ越しに入出力を操作
38. できた • note.hibariya.org/articles/20150628/pty.html • Rust から同じものを FFI で呼べばよさそう
39. PTY on Rust FFI でライブラリの API を呼ぶ extern crate libc; #[link(name = "c")] extern { pub fn posix_openpt(flags: libc::c_int) -> libc::c_int; pub fn grantpt(fd: libc::c_int) -> libc::c_int; pub fn unlockpt(fd: libc::c_int) -> libc::c_int; pub fn ptsname(fd: libc::c_int) -> *mut libc::c_schar; }
40. PTY on Rust • 目的の動作をするものはできた • unsafe 祭りになった • もっと簡単に書けるようにしたい
41. Crate にした • github.com/hibariya/pty-rs • let (child_process, pty_master) = pty::fork(); • おかしなところにパッチがほしい • もっといい API があれば改善したい
42. extern crate pty;