本記事の構成および論理分析にはAI(人工知能)を使用しています。情報の正確性は、システム管理者(UNIXユーザー)による手動検証済みです。
【低レイヤ入門】C言語で作る自作VMのshellとeditorを分ける | UNIX Cafe

この連載では、C言語で小さなVM(仮想マシン)を作っています。メモリ、レジスタ、PC(次に実行する命令の位置)を持つ機械をCで書き、その上で独自のアセンブリ言語で書いたプログラムを動かしています。今回は第25回(開発手順ではDay 45)です。
前回は、runコマンドで別のプログラム(子)を起動し、子が終わったら元のプログラム(親)へ戻る仕組みを作りました。親が編集していた内容は、子の実行後もそのまま残ります。今回はこの仕組みを使って、コマンドを受け付けるshellと、1行のテキストを編集するeditorを、別々のプログラムに分けます。
この記事では、VMを動かしているC側のプログラムを「host」と呼びます。VM上のプログラムがhostに処理を頼むときはSYSCALL命令を使い、SYSCALL 8のように番号で頼む内容を選びます。
まず実際に動かして、editでeditorに入り、quitでshellに戻る様子を見ます。そのあとで、次の3つを順に追っていきます。
- 編集した内容は、どのプログラムのメモリにあるのか
- editorを終了すると、何が失われるのか
- 保存した内容を、どうやって読み戻すのか
動かしてみる:editで入り、quitで戻る
Makefileがあるリポジトリのルートで、次のコマンドを実行します。shellとeditorをアセンブルしてから、shellを起動します。必要なのはCコンパイラ、make、既存のアセンブラsmall-asmです。後半の自動テストにはPython 3も使います。
make run-shell連載のソースはGitHubのhandmade-vm-osにあります。前回までのサンプルは残したまま、今回の2本を新しいプログラムとして追加しています。
最初に動く親がprograms/shell.bin、editコマンドで起動される子がprograms/editor.binです。次の画面例では、helloを保存してeditorを終了し、もう一度editorを開いて読み戻しています。Command>やEditor>の後ろが、キーボードから入力した文字です。
Command> edit
Editor> set hello
Editor> show
hello
Editor> save
Saved.
Editor> quit
Goodbye from editor
CPU halted.
Editor finished.
Command> echo back
back
Command> edit
Editor> show
Editor> load
Loaded.
Editor> show
hello
Editor> quit
Goodbye from editor
CPU halted.
Editor finished.
Command> quit
Goodbye from Handmade VM
CPU halted.1回目のshowではhelloが表示されます。ところが、2回目のeditの直後にshowすると、空の行しか出ません。起動し直したeditorのメモリには、前回の編集内容が残っていないからです。loadのあとでhelloが戻るのは、保存先のファイルline.txtから明示的に読み込んだためです。
終了時の表示にも注目してください。editorでquitすると、子のeditorがHALT命令で停止し、そのあと親のshellが「Editor finished.」を表示してCommand>に戻ります。最後にshellでquitすると、今度は親自身が停止します。どちらも「CPU halted.」と表示されますが、止まっているVMは別のものです。
shellとeditorの役割分担
前回のprogram-launcherは、1つのプログラムでコマンドの受付と編集の両方をこなしていました。コマンドはhelp / echo / set / show / save / load / runです。今回は編集用のコマンドをeditorへ移し、shellは入力されたコマンドを受けて、行き先を選ぶ役に絞りました。
shell.bin Command>
help / echo / run / edit / quit
editor.bin Editor>
help / set / show / save / load / quitどちらも、自分の受け持ち以外のコマンドは受け付けません。たとえばCommand>でset helloと入力するとUnknown commandになり、Editor>もecho / run / editを受け付けません。helpに表示される案内も、それぞれのコマンドだけです。
shell.asmとeditor.asmは別々にアセンブルするので、命令も文字列もそれぞれのbinファイルに入ります。編集内容の表示や保存の処理はeditorだけが持ちます。shellは編集バッファを持たず、コマンド入力用の一時領域だけを使います。旧program-launcher.binも削除せずに残しています。
入力の読み取りとコマンド名の比較は、これまでの規約をそのまま引き継いでいます。区切りは半角空白だけで、タブは区切りとして扱いません。コマンド名は大文字と小文字を区別します。
editを実行したとき、親のshellで起きること
shellでeditが選ばれると、ラベルdo_editへ進みます。次はprograms/shell.asmから、editorの起動と結果表示の部分を抜き出したものです。親から子を起動する入口として、新しくSYSCALL 8を使います。
do_edit:
SYSCALL 8
MOVI R3, 0
CMP R0, R3
JNZ editor_failed
MOVI R0, editor_finished_text
JUMP launch_notice
editor_failed:
MOVI R0, editor_failed_text
launch_notice:
SYSCALL 1
JUMP command_loopSYSCALL 8は機械語で0x60000008(byte列では60 00 00 08)になり、shell.binの0xA8番地に置かれています。VMは命令を読み込んだ時点でPCを次の命令へ進めるので、親のPCは0xACを指した状態になります。その状態のまま、host側がeditorを実行し、終わるのを待ちます。
editorが終了すると、親のR0レジスタに結果が入ります。HALTで正常に止まれば0、起動に失敗したりHALT以外で止まったりすれば1です。続く3命令では、R3に0を入れてR0と比べ(CMP)、0でなければ(JNZ)editor_failedへ分岐します。
こうしてEditor finished.かEditor failed.のどちらかの文字列を選び、共通のlaunch_noticeで表示します。最後のJUMP command_loopで、shellは次のCommand>を出します。
ここで、サブルーチン呼び出しのCALLIと混同しないようにしてください。CALLIは親のスタックに戻り先を積み、同じVMの中で別の場所へジャンプします。SYSCALL 8で起動したeditorは、それとは別のVMとしてPC=0から動き始めます。editorが止まると処理はhost側のCコードへ戻り、そこから親が0xACの命令を続けます。親のPCと子のPCは別々の値なので、1本の流れとして追わないことが大切です。
編集内容はeditorのメモリにある
親のshellと子のeditorは、それぞれ1 MiBのメモリを持っています。どちらもコマンド入力に0x500番地からの64 byteを使いますが、番地の数値が同じでも、別のVMのメモリなので中身は別物です。編集内容を置く0x600番地からの64 byteは、editorだけが使います。
親 shell のメモリ 子 editor のメモリ
0x000 shellの命令 0x000 editorの命令
0x500 コマンド入力 0x500 コマンド入力
0x600 編集内容と終端0editorの先頭の3命令では、R5に0x600を入れ、その番地に0を書き込みます。文字列は0で終わる約束なので、これで「編集内容は空」という状態から始まります。
MOVI R5, 0x600
MOVI R0, 0
STB [R5], R0editorが終了すると、その子VMの領域は解放されます。次にeditを実行すると新しい子VMが初期化されるので、入力内容も編集内容もレジスタの値も、前回からは引き継がれません。前のメモリから内容を復元する機能や、編集バッファを親へ渡す機能もありません。冒頭の画面例で2回目のshowが空だったのは、このためです。
なお、この親子のメモリの分離は、hostが別々のVM構造体を用意しているだけで、MMUによるアドレス空間の分離ではありません。また実行は同期的で、子が動いている間、親は止まって待っています。
SYSCALL 8で、editor.binを起動する
前回追加したSYSCALL 6は、固定のprograms/run-child.binを起動するものでした。これはそのまま残し、editor用に番号8を追加しました。番号7は未実装のままにしています。既存のテストが、未実装syscallの診断や失敗の検出に7を使っているためです。
notes/vm.cのexecuteでは、番号が6か8のとき、次の判定をします。
if (vm->is_child) {
vm->regs[0] = 1;
} else {
vm->regs[0] = inst.imm == 6 ? launch_program() : launch_editor();
}is_childは、そのVMが子として起動されたかどうかを示すフラグです。親であれば、番号6ならlaunch_program、番号8ならlaunch_editorを呼びます。子がさらに子を起動しようとした場合は、ファイルを開く前に拒否し、新しいVMを作らずにR0へ1(失敗)を返します。
editorはrunやeditをコマンドとして受け付けませんが、仮にeditorのコードが直接SYSCALL 6や8を実行しても、このように1が返るだけです。その子がそのままHALTすれば、親が受け取る結果は、子全体としての正常終了を表す0になります。
起動するファイルを読み込むのは、notes/program-launch.hにあるload_child_programとload_editor_programです。どちらも子のメモリとその容量を受け取ります。ファイル名はhost側に文字列として固定されています。
static inline bool load_child_program(unsigned char *memory, size_t capacity) {
return load_fixed_program(memory, capacity, "programs/run-child.bin");
}
static inline bool load_editor_program(unsigned char *memory, size_t capacity) {
return load_fixed_program(memory, capacity, "programs/editor.bin");
}実際の読み込みは、共通のload_fixed_programが担当します。ファイルを開き、サイズが4 byte以上1 MiB以下であること、そしてread、ファイル末尾の確認、closeがすべて成功したことを確かめます。読み込みに失敗した子は実行しません。
VMからR0でファイル名の文字列を渡す仕組みは、まだ作っていません。shellのeditにも引数は付けられず、edit memo.txtと入力するとUnknown commandになります。今回は行き先を2つに固定して、起動、復帰、役割分担がきちんと動くことを確かめる段階です。
子VMの作成から解放までを共通化する
run-child.binとeditor.binのどちらを起動する場合も、「子VMを確保し、初期化し、プログラムを読み込んで実行し、解放する」という流れは同じです。今回はこれをlaunch_loaded_programにまとめました。引数のloaderは、メモリと容量を受け取ってboolを返す関数へのポインタです。
static uint32_t launch_loaded_program(bool (*loader)(unsigned char *, size_t)) {
VM *child = malloc(sizeof(*child));
if (child == NULL) {
return 1;
}
init_vm(child);
child->is_child = true;
bool success = loader(child->memory, MEMORY_SIZE) && run(child);
free(child);
return success ? 0 : 1;
}
static uint32_t launch_program(void) {
return launch_loaded_program(load_child_program);
}
static uint32_t launch_editor(void) {
return launch_loaded_program(load_editor_program);
}launch_programとlaunch_editorの違いは、渡す読み込み関数だけです。
処理を順に見ていきます。まずmallocで子のVM構造体を確保します。init_vmでレジスタとメモリを0にし、PC=0、SP=0x100000、zero flag=false、running=trueに設定します。続けてis_childをtrueにして、この子が起動要求を出したときに区別できるようにします。
loaderとrunの間の&&は短絡評価なので、読み込みに成功したときだけrunが呼ばれます。runがtrueを返すのは、HALTで止まった場合だけです。入力のEOF、不正な命令、範囲外のメモリアクセスなどで止まった場合は失敗になります。
実行が終わったとき、または読み込みに失敗したときは、freeで子VMを解放します。親の命令や入力、スタックには手を付けません。syscallの処理が書き換えるのは親のR0だけで、R1〜R7、SP、zero flag、running、メモリ全体はそのまま残ります。
saveとloadで、終了後も内容を残す
editorを終了しても内容を残したいときは、saveで保存します。次はdo_saveからの抜粋です。R0に編集バッファの先頭アドレス0x600を入れ、既存のSYSCALL 4に保存を頼みます。戻ってきたR0は、成功なら0、失敗なら1です。
do_save:
MOVI R0, 0x600
SYSCALL 4
MOVI R3, 0
CMP R0, R3
JNZ save_failed
MOVI R0, saved_text
JUMP storage_notice
save_failed:
MOVI R0, save_failed_text
JUMP storage_notice成功ならSaved.、失敗ならSave failed.を表示します。loadも同じ形で、SYSCALL 5を使って0x600へ読み込み、Loaded.またはLoad failed.を表示します。どちらの場合もeditorのコマンド入力へ戻るので、保存に失敗しても編集中の内容は消えません。
保存先は、VMを起動した作業ディレクトリにある固定名のファイルline.txtです。中身は0〜63 byteの本文だけで、終端の0や改行は書き込みません。空の内容を保存すると0 byteのファイルになります。UTF-8の文字もbyte列として扱い、文字数には換算しません。
loadは、いったんhost側の一時領域へ読み込んで中身を検査し、問題がなければ編集内容を置き換えます。ファイルがない、64 byte以上ある、NUL・CR・LFを含む、readやcloseに失敗した、といった場合は元の編集内容をそのまま残します。長いファイルを63 byteに切り詰めて読み込むことはしません。
一方、saveはファイルを直接上書きします。そのため書き込みの途中で失敗すると、古いファイルの内容が残る保証はありません。また、quitや入力のEOFで終了するときに、自動保存や「保存しますか?」という確認はありません。Editor finished.は正常に終了したという通知で、保存できたという意味ではない点に注意してください。
本文の長さの上限は、入力のしかたで変わります。setだけを入力して次の行に本文を書く場合は最大63 byteです。set helloのように同じ行に書く場合は、コマンド名と区切りの空白も上限に含まれるため最大59 byteになります。どちらも文字数ではなくbyte数です。
起動に失敗しても、shellに戻る
editor.binが見つからない場合、子の命令は1つも実行されず、親へ失敗の1が返ります。そのときの画面は次のとおりです。失敗のあともechoが動き、quitするまでshellを使い続けられます。
Command> edit
Editor failed.
Command> echo back
back
Command> quit
Goodbye from Handmade VM
CPU halted.親子でメモリは分かれていますが、標準入出力と作業ディレクトリは共有しています。そのため、子が読んだ入力を親がもう一度読むことはできません。また、子がline.txtを保存すれば、同じ作業ディレクトリで後から起動したeditorからもそのファイルが見えます。冒頭の画面例でloadが成功したのは、この共有のおかげです。
入力の終わり(EOF)も共有されます。editのあとで入力がEOFになると、子はinput EOFで停止し、親はEditor failed.を表示します。しかし、親が次の入力を読もうとしても入力はEOFのままなので、親もinput EOFで停止します。失敗から戻れることと、続きの入力があることは別の話です。
現状の制限もあります。子がHALTもエラーも起こさずに動き続けると、親はいつまでも待ちます。時間制限、並行実行、任意の終了値には対応していないので、一般的なOSのプロセス管理とは別物と考えてください。
直接起動とshell経由の両方でテストする
実装では、まずeditor用の読み込み部品だけを確認し、そのあとVMに組み込みました。次の2つのターゲットで、読み込み部品単体の14ケースと、組み込み後の読み込み14ケース・VM経由の20ケースを確認できます。
make test-shell-editor-parts
make test-shell-editor部品のテストでは、容量の境界、I/Oの失敗、旧起動先(run-child.bin)が変わっていないことを検査します。VM経由のテストでは、親のメモリ・レジスタ・SP・フラグ・復帰後のPCが保たれていること、子VMとファイルがきちんと解放されていることを照合します。
入出力の検査は265ケースです。内訳は、shell単体が49ケース、editorを直接起動するものが94ケース、同じ94ケースをshell経由で行うもの、起動と復帰などが28ケースです。同じ編集操作でも、「editorを単独で起動して動くこと」と「子として起動され、親へ戻れること」を別々に確かめています。
この2通りの起動をまとめて検査するのが、tools/test-shell-editor.pyのcheck_editorです。コード中のSはCommand>、FINはEditor finished.のbyte列を表します。shell経由の場合は入力の先頭にeditを付け、通常終了のケースでは最後にshellを終えるquitも付けます。
def check_editor(name, data, expected, *, initial=MISSING, final=MISSING, eof=False):
check(name, data, expected, group='editor direct', target=EDITOR, initial=initial, final=final)
check(name, b'edit\n' + data + (b'' if eof else b'quit\n'),
S + expected + (FAIL + SEOF if eof else FIN + SQ),
group='editor via shell', initial=initial, final=final)checkは、終了コードが0であること、標準出力の全文、標準エラーが空であること、ファイルの内容を照合します。ケースには、EOF、保存失敗後に内容が保たれること、未保存の内容が破棄されること、入力長の境界、子の初期化、monitor復帰も含まれます。
さらに、editorのセッションを1000回繰り返す検査と、小さな子プログラムで初期化を1000回確かめる検査もあります。テストは一時ディレクトリで実行するので、普段の作業ファイルを上書きすることはありません。
実装時に、これらのテストがすべて通ること、shell・editor・旧run-childを再アセンブルした結果がbinと一致すること、回帰テスト一式と自己テストが通ることを確認しました。この記事は、現行のソース・bin・その検証記録と照らし合わせて書いており、執筆時にテストは再実行していません。
2つのbinのメモリ配置を確かめる
shellは139命令(556 byte)と文字列14個(271 byte)で、合計827 byteです。editorは157命令(628 byte)と文字列15個(337 byte)で、合計965 byteです。ファイル末尾の次の番地は、それぞれ0x33Bと0x3C5になります。
プロンプトやhelpの文字列まで含めても、どちらも入力領域の0x500より手前に収まります。editorの編集領域0x600や、メモリの末尾から下向きに伸びるスタックとも重なりません。
おわりに
今回は、shellとeditorを別々のプログラムにし、SYSCALL 8で親から子を起動して戻る形にしました。編集内容は子のメモリにあるため、editorの終了とともに消えます。残したいときはsaveでline.txtへ書き出し、loadで読み戻します。
ただし、固定名のファイルを読み書きしているのはhost側の機能です。VM上で常駐するOSや、自作のファイルシステムができたわけではありません。任意のファイル名、複数行、画面全体の編集へ進むときは、必要なデータと操作の約束を、別の仕様としてあらためて決めていきます。
