Rio-vtとlibrio: Rioのターミナルエンジンが組み込み可能に
Rio-vt and librio: Rio's terminal engine, now embeddable (rioterm.com)
要約
Rioターミナルのコアエンジンがレンダリング部分から分離され、rio-vt(Rustクレート)とlibrio(C ABI)の2つのレイヤーとして提供されるようになりました。これにより、VT状態マシン、グリッド、スクロールバック、選択、検索、画像プロトコルなどのコア機能が、任意のレンダラーと組み合わせて利用可能になります。librioはC ABI経由で他の言語からも利用でき、クロスプラットフォームで動作します。パフォーマンスベンチマークでは、多くのワークロードで他のパーサーと比較して高速であることが示されています。
全文翻訳
rio-vtとlibrio: Rioのターミナルエンジンが埋め込み可能に
皆さん、こんにちは!
しばらくの間、Rioのターミナルコアはレンダラー、設定、そしてそれを囲むアプリケーションと絡み合っていました。そのため、何年もかけて正しく作り上げた部分(VT状態マシン、グリッド、スクロールバック、選択、検索、画像プロトコルなど)を、私自身も含め、誰かが再利用するのが困難でした。
Rio 0.5で状況が変わります。エンジンはクリーンで埋め込み可能なレイヤーに分割され、それらを説明したいと思います:rio-vtとlibrioです。
2つのレイヤー
アイデアはシンプルです。ターミナルを必要とするほとんどのプロジェクトは、完全なターミナルアプリを求めているのではなく、エンジンを求めています。そのため、エンジンは選択可能な2つのレイヤーとして提供されます:
rio-vtは安全なRustクレートです。VT状態マシン、ANSI/エスケープパーサー、スクロールバック付きグリッド、選択、検索、PTYドライバー、およびSixel / Kitty / iTerm2画像プロトコルが含まれます。レンダリング、GPU、フォントシェーピングはありません。Rustで書いている場合、これに直接依存します。モダンなalacritty_terminalの代替と考えてください。librioは、libghosttyの精神に則り、C ABIの背後にある同じコアです。Swift、C、Go、Python、またはCを話すものであれば、これをリンクします。プリビルドされた静的ライブラリとして提供され、Rustツールチェーンは不要です。すべてのunsafeコードはここにあり、rio-vt自体は安全なRustのままです。
どちらもデフォルトで軽量です。rio-vtをフィーチャーなしでビルドしても、レンダラー、GPU、フォントシェーピングの依存関係は一切含まれず、ターミナル機能のみとなります。
rio-vtの実践
コアは実際のターミナルと同じように駆動されます:バイトをフィードし、グリッド状態をプルアウトします。以下は、PTY、レンダラー、スレッドなしの完全なループです:
use rio_vt::ansi::CursorShape;
use rio_vt::crosswords::grid::Dimensions;
use rio_vt::crosswords::pos::Column;
use rio_vt::crosswords::{Crosswords, CrosswordsSize};
use rio_vt::event::{VoidListener, WindowId};
use rio_vt::performer::handler::Processor;
// 10k行のスクロールバックを持つ80x24ターミナル。
let size = CrosswordsSize::new(80, 24);
let cols = size.columns();
let mut term = Crosswords::new(
size,
CursorShape::Block,
VoidListener,
WindowId::from(0),
0,
10_000,
);
// 生のPTYバイトをフィード:SGR赤 "hello"、リセット、その後 " world"。
let mut parser = Processor::default();
parser.advance(&mut term, b"\x1b[31mhello\x1b[0m world");
// 表示されているグリッドをプルし、最初の行を読み取る。
let rows = term.visible_rows();
let line: String = (0..cols).map(|x| rows[0][Column(x)].c()).collect();
assert!(line.starts_with("hello world"));
rio-vtは何も描画しないため、グリッドをどう扱うかはあなたが決定します:任意のレンダラーとペアにするか、あるいは全くペアにしないかです。
選択と検索は無料で提供
use rio_vt::crosswords::pos::{Column, Line, Pos, Side};
use rio_vt::selection::{Selection, SelectionType};
let mut selection = Selection::new(
SelectionType::Simple,
Pos::new(Line(0), Column(0)),
Side::Left,
);
selection.update(Pos::new(Line(0), Column(4)), Side::Right);
term.selection = Some(selection);
assert_eq!(term.selection_to_string().as_deref(), Some("hello")); // 列 0..=4
画像も同様
Sixel、Kitty、iTerm2の画像送信はコアによってデコードされ、イベントとして表面化されるため、フロントエンドは他のものと同じように記録できます。以下は、ヘッドレスでキャプチャされたKittyグラフィックスプロトコル送信です:
impl EventListener for ImageSink {
fn event(&self) -> (Option<RioEvent>, bool) { (None, false) }
fn send_event(&self, event: RioEvent, _: WindowId) {
if let RioEvent::UpdateGraphics { queues, .. } = event {
for (id, g) in &queues.pending_images {
// id, g.width, g.height, g.pixels (RGBA) ...
}
}
}
}
// f=32 RGBA, 2x2 px, a=T 送信+表示、base64ピクセル:
parser.advance(&mut term, b"\x1b_Gf=32,s=2,v=2,a=T;/wAA//8AAP//AAD//wAA/w==\x1b\");
// -> kitty画像: id=..., 2x2px, 16 RGBAバイト
librio: どの言語からでも同じコアを
librioは、そのエンジンを小さなC ABIでラップします:エンジンを作成し、サーフェス(内部でPTYを起動します)を作成し、それに書き込み、レンダリング状態をプルして、どの行が変更され、各セルに何が含まれているかを通知します。
#include "librio.h"
rio_engine_t *engine = rio_engine_new(&config);
rio_surface_t *surface = rio_surface_new(engine, &desc);
// シェルにインプットを送信。
rio_surface_text(surface, "ls -la\n", 7);
// 変更された行のみをプルして描画。
rio_render_state_t *state = rio_render_state_new(surface);
rio_render_state_update(state);
for (uint16_t line = 0; line < rio_render_state_lines(state); line++) {
if (!rio_render_state_row_dirty(state, line)) continue;
for (uint16_t col = 0; col < rio_render_state_columns(state); col++) {
rio_cell_s cell = rio_render_state_cell(state, line, col);
// `cell` を独自のレンダラーに渡す...
}
}
rio_render_state_reset_dirty(state);
これは、ネイティブのSwiftまたはCフロントエンドがセル単位で消費する正確なサーフェスです。ダーティ行のレンダリング状態により、CPUレンダリングが実用的になります:コンシューマーは、ターミナルが変更されたと通知したセルのみを再ペイントし、エスケープシーケンスを一切再実装する必要がありません。
そしてクロスプラットフォームです:同じC ABIはmacOS、Linux、Windowsでビルドおよび実行され、プラットフォームのPTY(WindowsではConPTY)を通じて実際のシェルを起動します。
すでに本番環境で使用中
これはサイエンスプロジェクトではありません。rio-vtはすでにLovableのような企業で本番環境で使用されており、実際のターミナルワークロードを支えています。コアを独自のクレートに抽出したのは、単なるクリーンアップではなく、他の製品がRioが出荷しているのと同じエンジンを構築できるようにするためでした。
パフォーマンス
数値の前に注意点があります:ベンチマークはトリッキーであり、このスイートが測定しない多くの領域でrio-vtのパフォーマンスが悪いことは確かです。ワークロードは、ユーザーが私に持ち込んだ実際のプロダクションケースに基づいており、すべてのコードパスを網羅する合成ツアーではありません。例えば、libghosttyは、より大きなスクロールバック(約8〜10k行以上)やリサイズでもrio-vtを上回ると予想されますが、このスイートをRustクレートに集中させると決めてからベンチマークしていません。最終的にはlibrioとlibghosttyの適切なベンチマークを行う予定です。
スタンドアロンのベンチマーク、rio-vt-benchmarkを維持しており、同じワークロードでrio-vtをvt100(doyによる優れたパーサー)およびalacritty_terminalと比較しています:バイトストリームの解析、埋められた画面のシリアライズ、および1つのリサイズ、すべて固定80x24で行います。以下の数値は、Apple Silicon Mac上でのCriterionの中央値です(rio-vt 0.5、vt100 0.15、alacritty_terminal 0.26)。これらはCPUと入力に依存するため、ご自身で実行してください。
バイトストリームを画面に解析する(スループット、高いほど良い):
| ワークロード | rio-vt | vt100 | alacritty | 勝者 |
|---|---|---|---|---|
| mixed | 302 MiB/s | 221 MiB/s | 254 MiB/s | rio-vt |
| ascii_plain | 835 MiB/s | 196 MiB/s | 279 MiB/s | rio-vt 3.0× |
| sgr_churn | 235 MiB/s | 349 MiB/s | 332 MiB/s | vt100 |
| scroll_storm | 274 MiB/s | 101 MiB/s | 266 MiB/s | rio-vt |
| alt_screen_redraw | 588 MiB/s | 231 MiB/s | 282 MiB/s | rio-vt 2.1× |
| unicode_wide | 248 MiB/s | 203 MiB/s | 337 MiB/s | alacritty |
埋められた画面を再度シリアライズする(低いほど良い;rio-vtとvt100のみが画面ダンプを公開):
| 操作 | rio-vt | vt100 | 勝者 |
|---|---|---|---|
| contents_formatted (ANSI) | 4.3 µs | 18.6 µs | rio-vt 4.3× |
| contents_plain (text) | 3.8 µs | 13.9 µs | rio-vt 3.7× |
80x24から100x40へのリサイズとその逆(低いほど良い):
| 操作 | rio-vt | vt100 | alacritty | 勝者 |
|---|---|---|---|---|
| resize | 5.0 µs | 7.5 µs | 227 µs | rio-vt |
rio-vtはほとんどの形状でより速く解析し、特にプレーンなグリフ(ascii_plain)やフルスクリーンの再描画(alt_screen_redraw)で作業が集中する場合、その差は大きいです。画面のシリアライズは数倍速く、リサイズはどちらよりもはるかに高速ですが、それでも折り返し行を再フローします(vt100は再フローをスキップするため、縮小時にコンテンツがクリップされます。alacrittyは再フローしますが、この点では2桁遅いです)。
クリーンな勝利ではありません:vt100はsgr_churn(rio-vtのセルごとのスタイルインターニングがプレーンなセルごとのスタイルよりもコストがかかる場合)を取り、alacrittyはunicode_wideを取ります。異なるエンジン、異なるトレードオフであり、ベンチマークが公開されているまさにその理由です。
今後の展開
rio-vtはcrates.ioにあり、Rio(0.5)と同じバージョンで提供されているため、任意のRustプロジェクトが今日から依存できます。librioはインストールするクレートではありません:各GitHubリリースには、Swift用のRioKit.xcframeworkと、C用のプレーンなlibrio.a+librio.hが含まれているため、macOSのSwift/CパスはRustツールチェーンなしでドロップインできます。LinuxとWindowsでは、cargo build -p librioでソースからビルドします。- WebAssemblyサポート。
Rustアプリ、ネイティブmacOSアプリ、またはC ABIの背後にある何かで、実際のターミナルを埋め込みたいと思ったことがあるなら、これはあなたのためです。そして、それに基づいて何かを構築したなら、ぜひ聞かせてください。
それでは。
Rioをフォローし、使用していただきありがとうございます!
敬具、
Raphael。