Golangのスケジューラあたりの話

# はじめに
今年に入ってから仕事でGolang書いてるのでスケジューラあたりについて調べた。ググってもあんまり資料が多くなかったんでまとめる。ソースコードを参照する時はGo 1.9.3を見た。わかりやすさを重視してあえて雑に説明しているところがあるけどご了承ください。
多分間違ってるところあるんで詳しい人は優しく教えてください。

# goroutineあたりの基本的な話
goroutineはグリーンスレッド、つまりOSのスレッドは直接使ってない。なので、goroutineを作ることはネイティブスレッドを作る処理よりもはるかにコストが安い。このgoroutineを複数作るとランタイムが勝手にマルチスレッドで実行する。詳細は後述。
また、メインルーチンもgoroutineとして管理される。

# スケジューリングの登場人物
重要な登場人物はM, G, Pの3人。

* M(Machine)
    * OSのスレッドに対応する。
* G(Goroutine)
    * そのまま。
* P(Processor)
    * Gを貯めておくdequeと呼ばれる特殊なキューを持ち、GをMに割りあてる役割を持つ。
    * GOMAXPROCS環境変数はこれに対応する。
        * デフォルトで実行環境のコアの数が設定される[^1]

これらはソースコード上でm, g, pで定義されている。[^2]

# スケジューリングの基本的な仕組み
GOMAXPROCSの数だけM, Pのセットが用意される。GOMAXPROCSが2の場合、大まかには以下のような仕組みで実行される。
<img width="420" src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/94/00dfbd94-a70f-c894-23df-5050d079490e.png">


で、片方がGを全部実行してしまって暇になると、他のPから半分Gを奪い取る。
<img width="379" alt="スクリーンショット 2018-02-16 1.35.19.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/51ac129e-53dc-d337-b29b-5972cfb2917c.png">

このスケジューリングアルゴリズムをwork stealingアルゴリズムと言う。このwork stealingアルゴリズム、CPUバウンドな処理は非常に効率が良いが、io waitなどの無駄にブロックする処理とは相性が悪い。そこで、いくつかの工夫がなされており、これから説明する。

# 詳細に入る前の準備
詳細の前に必要な事前知識を簡単に説明。

* グローバルキュー
    * Pが持つGのキューとは別にグローバルキューというものがある。
    * 通常Gが実行待ち状態になるとPの持つキューに入るが、いくつかの状況ではグローバルキューに入る。
    * このグローバルキューは、以下の時に取り出される。
        * Mの自分のキューが空の時に取り出す
        * Mの自分のキューがまだあったとしても61回に1度取り出す（そうやってグローバルキューがずっと実行されないことを防ぐ）
* sysmon
    * 基本的にGOMAXPROCSの数だけのMとPのセットが動いてる、という説明をしてきたが、それとは別にsysmonという関数を実行し続ける特別なMが存在する。これはP無しで実行される。
    * このsysmonは処理本体は無限ループになっており、そのループの中で後述するnetpollのチェックや、実行時間の長いGのプリエンプト、必要があればGC用のGをグローバルキューに追加、などを行っている。
* P idle list
    * Pは他にやることがなければP idle listに入れられる。
* M idle list
    * Mも他にやることがなければM idle listに入れられる。

# syscallを実行した時

syscallを使ったとき、そのsyscallがすぐ返ってくるものなら普通の処理とほとんど変わらない。
syscallを使って時間がかかる場合(少なくとも20nsec以上)、sysmonがそれを検知し、そのMとGをPから切り離し、別のMとPを紐付けて処理を進める[^3]。
<img width="581" alt="スクリーンショット 2018-02-16 1.35.26.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/a299541b-685c-024d-e74a-ed4a4db6fff5.png">
↓
<img width="645" alt="スクリーンショット 2018-02-16 1.35.34.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/780e5ba3-357d-7015-0aa6-8972d214b763.png">

syscallが終わったら、まず暇なPがいたらそれを取ってきて処理を進めようとする。

<img width="637" alt="スクリーンショット 2018-02-16 1.35.40.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/fb698d4e-ec4b-97bd-75d9-0f1ef7a903b4.png">
↓
<img width="643" alt="スクリーンショット 2018-02-19 1.41.58.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/7b57ee7c-9491-68ba-f82b-9831635e6721.png">

それが無理ならグローバルキューに追加する。MはM idle listに追加される。
<img width="776" alt="スクリーンショット 2018-02-16 1.35.53.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/d8cdf857-245b-c734-6ce4-e459b8aa617d.png">


# ネットワーク処理した時
ネットワーク処理にはnetpollerと呼ばれる仕組みが導入されている。Goのライブラリが提供するネットワーク処理のAPI的にはブロッキングするが、このnetpollerというやつが実行時にノンブロッキングな処理にしてくれる。そのノンブロッキングな処理は中身的にはLinuxならepoll, BSDならkqueueなどOSが提供する機能を使っている。

実際の仕組みは、ネットワークの待ちになった時にGがMから切り離されnetpollerに登録される。sysmonがnetpollerを定期的にチェックし、ネットワーク処理が準備完了していたら、そのGをグローバルキューにエンキューする。
<img width="571" alt="スクリーンショット 2018-02-17 23.08.46.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/afd89e38-bf1a-952a-49b4-d86dd1772ebd.png">

これらはepollを使った実装の場合、登録部分にepoll_ctl, 取得部分にepoll_waitを使っている。

# Gの実行時間が長い時
Mがずっと同じGを実行し続けていたら(少なくとも10ms以上)そのGをプリエンプトする機能もある。
sysmonが10ms以上かかっているGを見つけると、そのGのpreemptフラグをtrueにする。この時点ではプリエンプトはしない。
実際にプリエンプトするのはフラグをつけられた側。フラグがつけられたGが関数呼び出しをする際、自分のpreemptフラグを見てtrueならグローバルキューにエンキューする。

<img width="677" alt="スクリーンショット 2018-02-18 1.29.44.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/4e3d4021-e69b-540c-63e8-9ff1bc132bad.png">

# channelをreceive/sendした時
Gがchannel(channel1とする)のreceiveを待つと、channel1の待ちGリストにエンキューされる。
別のGがchannel1にsendすると、channel1の待ちGリストからデキューされ、sendしたGのPのキューにエンキューされる。
<img width="602" alt="スクリーンショット 2018-02-18 1.39.40.png" src="https://qiita-image-store.s3.amazonaws.com/0/94/68610f2c-20e7-bb57-23ea-3aebba5ddeb6.png">

# Golangのソースコードの歩き方
ここまででランタイムの動きの話は終わり。
Goのライブラリのソースコードを読んでいると、途中で宣言はあるけど実装がない関数が出てくることがある。これはgo:linknameディレクティブが使われている場合と、アセンブリ言語で定義されている場合とがある[^4]。
go:linknameディレクティブの場合、`^//go:linkname \S* importpath\.name`で検索すると出てくる。例えば、[poll. runtime_pollWait](https://github.com/golang/go/blob/go1.9.3/src/internal/poll/fd_poll_runtime.go#L23)はそれで、`^//go:linkname \S+ internal/poll\.runtime_pollWait`で検索するとわかる。

```
$ grep -P -r '^//go:linkname \S+ internal/poll\.runtime_pollWait' .
./runtime/netpoll.go://go:linkname poll_runtime_pollWait internal/poll.runtime_pollWait
./runtime/netpoll.go://go:linkname poll_runtime_pollWaitCanceled internal/poll.runtime_pollWaitCanceled
```

つまり、実装はこれ

* https://github.com/golang/go/blob/go1.9.3/src/runtime/netpoll.go#L164

参考: https://golang.org/cmd/compile/#hdr-Compiler_Directives

アセンブリ言語で定義されている場合は、`^TEXT.*·Name\(`で検索すれば出てくる（Nameの手前は`.`ではなく`·`(U+00B7)であることに注意）。例えば、[syscall.Syscall](https://github.com/golang/go/blob/go1.9.3/src/syscall/syscall_unix.go#L29)がそれで、こんな感じ。

```
$ grep -P -r '^TEXT.*·Syscall\('
syscall/asm_darwin_386.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_darwin_amd64.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
syscall/asm_darwin_arm.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_darwin_arm64.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
syscall/asm_freebsd_arm.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_linux_386.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_linux_amd64.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
syscall/asm_linux_arm.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_linux_arm64.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
syscall/asm_linux_mips64x.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
syscall/asm_linux_mipsx.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_linux_ppc64x.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
syscall/asm_linux_s390x.s:TEXT ·Syscall(SB),NOSPLIT,$0-56
syscall/asm_nacl_386.s:TEXT ·Syscall(SB),NOSPLIT,$12-28
syscall/asm_nacl_amd64p32.s:TEXT ·Syscall(SB),NOSPLIT,$0-28
syscall/asm_nacl_arm.s:TEXT ·Syscall(SB),NOSPLIT,$0-28
syscall/asm_netbsd_arm.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_openbsd_arm.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_plan9_386.s:TEXT	·Syscall(SB),NOSPLIT,$0-32
syscall/asm_plan9_amd64.s:TEXT	·Syscall(SB),NOSPLIT,$0-64
syscall/asm_plan9_arm.s:TEXT	·Syscall(SB),NOSPLIT,$0-32
syscall/asm_solaris_amd64.s:TEXT ·Syscall(SB),NOSPLIT,$0
syscall/asm_unix_386.s:TEXT	·Syscall(SB),NOSPLIT,$0-28
syscall/asm_unix_amd64.s:TEXT	·Syscall(SB),NOSPLIT,$0-56
```

参考: https://golang.org/doc/asm#directives

また、ファイル名でOS, アーキテクチャの指定ができて、`name_GOOS_GOARCH`という文法になっている。
参考: https://golang.org/pkg/go/build/#hdr-Build_Constraints

# 参考

* [The Go scheduler - Morsing's blog](https://morsmachine.dk/go-scheduler)
* [The Go netpoller - Morsing's blog](https://morsmachine.dk/netpoller)
* [GOMAXPROCS | Dave Cheney](https://dave.cheney.net/tag/gomaxprocs)
* [Golangのソースコードを研究する(二) goroutineの動作原理 - Qiita](https://qiita.com/CountryMan/items/fedc6a677721e077af25)
* [channel - go routine blocking the others one - Stack Overflow](https://stackoverflow.com/questions/17953269/go-routine-blocking-the-others-one)
* [100万回のWebSocket接続とGo | プログラミング | POSTD](http://postd.cc/100%e4%b8%87%e5%9b%9e%e3%81%aewebsocket%e6%8e%a5%e7%b6%9a%e3%81%a8go/)
* [Golang 垃圾回收剖析 | Legendtkl](http://legendtkl.com/2017/04/28/golang-gc/)

# 主な参照したソースコード

* https://github.com/golang/go/blob/go1.9.3/src/runtime/proc.go
    * sysmon, entersyscall, exitsyscall, scheduleらへん
* https://github.com/golang/go/blob/go1.9.3/src/runtime/runtime2.go
    * G, M, Pの定義
* https://github.com/golang/go/blob/go1.9.3/src/runtime/chan.go
    * channel
* https://github.com/golang/go/blob/go1.9.3/src/runtime/netpoll.go
* https://github.com/golang/go/blob/go1.9.3/src/runtime/netpoll_epoll.go
    * netpoll
* https://github.com/golang/go/blob/master/src/runtime/stack.go
    * newstack(preemptの話のところ)

[^1]: Go1.5から。それ以前はデフォルト１。あと論理的なコアの数なので、ハイパースレッディングがあれば２倍。
[^2]: ソースコード読むとき検索しづらいからやめてほしい。
[^3]: なので、この場合GOMAXPROCSが2でもMは(sysmonと合わせて)4以上になる。
[^4]: 他にもあるかもしれないけど、僕はその２パターンに遭遇した。