6-1. runcのコードを読んでみよう
これまでの章で何回か名前を挙げたruncは、Goで実装された低レベルコンテナランタイムで、現在デファクトスタンダードとなっています。
この節では、そんなruncのコードを実際に読むための糸口をつかむべく、どこから読んでいけばいいのかのヒントをお伝えします。
runc: https://github.com/opencontainers/runc
注意
この章は、runc v1.5.2時点の情報に基づいています。
runcとlibcontainerについて
runcの機能の中核を担うのが、libcontainerというパッケージです。
実はruncのCLI本体 (runcリポジトリ直下のファイル群) は、libcontainerの薄いラッパーでしかありません。
おススメの読み方は以下の通りです。
- まず特定のサブコマンドに着目する
runc createおよびrunc initが、今回実装した範囲に最も近い
- リポジトリ直下の
{サブコマンド}.goから、関数の定義をたどって処理の流れを追う
もちろん、runcはProduction Readyなランタイムであるため、コードは非常に複雑で多くのケースを考慮しています。
インターネットで調べたりAIに聞いたりしながら処理の大枠を把握し、それを手掛かりに具体的な処理を追っていくのが良いでしょう。
namespace分離・プロセス複製
数々の関数を経由して、最終的にnamespace分離やプロセス複製を行うのはlibcontainer/nsenterパッケージです。
nsenterパッケージは非常に特殊なパッケージで、パッケージのinit関数からcgoを介してC言語のコードが実行されます (libcontainer/nsenter/nsenter.go → libcontainer/nsenter/nsexec.c)。
すなわち、runcのnamespace分離やプロセス複製の処理は、Cで行われるということです。
この仕組みは、いくつかの理由が繋がった結果生まれています。
- 現在の低レベルコンテナランタイムの要件が複雑
- Rootless Containerをサポートするため、Double Forkを必要としている
libcontainer/nsenter/nsexec.c#L800-L845のコメントに詳しく書いてある- また、インターネット上で検索してみると、いくつか情報が出てくるはず
- Double Forkだけでなく、プロセス間通信も考慮する必要がある
- Rootless Containerをサポートするため、Double Forkを必要としている
- goroutineという仕組みは、これらのように「プロセス本体を気にする」処理には向いていない
- そもそもgoroutineが、プロセスを直接触るような難しい操作について開発者が考えなくてもいいように設計されている
- 考えなくてもいい = 深くは触れない というトレードオフ
- よって、Goで上記の処理を実装しようとすると、複雑 / 冗長で分かりにくいコードが生まれてしまう
- 最良の方法ではないが、この特定の処理だけcgoに委任し、コードが複雑になりすぎるのを防いでいる
nsenterパッケージは、runcの中でも特にハッキーな部分です。
これを読むのが楽しいと思えたら、あなたもコンテナ沼の住人になれること間違いなし!
マウント・rootfs処理
rootfsの分離に関しては、libcontainer/rootfs_linux.goというファイルに実装があります。
今回実装した範囲は、prepareRootfs()関数に当たる部分です。
prepareRootfs()とその周辺は比較的シンプルで読みやすいですが、こちらも面白ポイントが色々です。
- マウントは、ファイルの種類によって多数の処理に分岐する
- マウント設定のパース (別箇所) がかなり闇実装
- 設定によって
pivot_root()とchroot()が出し分けられている unix.PivotRoot(".", ".")という魔術が行われている
読み進めていくと、複数の関数にまたがってはいますが、今回実装した順番通りにsyscallが呼ばれているのが確認できるはずです。
まずはここから。ぜひトライしてみてください!
cgroup
runcのcgroup関連処理は、実は別リポジトリにあります。
cgroups: https://github.com/opencontainers/cgroups
cgroupsパッケージでは、cgroupのv1 / v2両方に対応した処理が実装されているだけでなく、DBusなどファイル書き込み以外の操作方法にも対応しています。
今回実装したのに近いのはfs2パッケージですね。
リポジトリ直下のcgroups.goには、type Manager interfaceが定義されています。
子パッケージであるfs2などがそのインターフェースを実装しているため、libcontainer側では柔軟に実装を切り替えることができるのです。
コントロールする項目が多いため分量は少々多いですが、やっていることはシンプルなので、順を追って読めば理解できるはずです。
その他
runcは、上記3つ以外にも、様々な機能を利用してプロセスを隔離しています。
apparmorcapabilitiesseccompselinux- etc...
これらの機能がどのように実装されているか、興味があれば覗いてみると良いでしょう。