競技プログラミングでRuntime Errorを防ぐためのvalgrindとfsanitizeオプション

この記事は [Competitive Programming (1) Advent Calendar 2018](https://adventar.org/calendars/2931) 1日目の記事として書かれたものです。
それと、僕が[このツイート](https://twitter.com/hamko_intel/status/1065030248721375232)で大きい騒ぎを起こしてしまったことへの贖罪です。

##C++のプログラムの「不確かさ」
C++では配列の長さなどが静的であり、配列外参照をした場合に**条件によっては**ランタイムエラー (RE) を起こしてしまいます。また、変数を未初期化の状態で使ってしまうと、REを起こさずにプログラムが誤った出力を返してしまう**可能性があります**。必ずREを起こすならば、そのような場所を特定することは容易ですが、エラーが起きたり起きなかったりする場合はデバッグが困難になってしまいます。このことから、REによるバグには時間が取られてしまう傾向にあります。

配列外参照や未初期化変数参照が起きる可能性のある場所が事前にわかれば、バグを特定して直すことは簡単になります。これを実現するツールとして、`valgrind`と`-fsanitize`オプションを紹介します。

`-fsanitize`, `valgrind`の重要な点は、REするかどうかを事前に知ることができることです。**これらで事前チェックした時にエラーが発生している場合は必ずバグっています**。特にペナルティのあるコンテストでは、必ずREするコードを提出せずに済みます。

この記事では実際に競技プログラミングでREを起こした提出を`-fsanitize`オプションと`valgrind`で解析し、実際にデバッグしてみます。

##記事を書いた動機と先行事例
現代的には、`valgrind`ではなく[コンパイルオプションに-sanitizeをすればよい](https://twitter.com/gusmachine/status/1065460037265448960)という言及があります。これは、プログラムの重大なミスを検出するだけならば正しいと思います。一方、`valgrind`では配列外参照がメモリの読み書きのどちらで起きたのかをも検出できます。また、未初期化変数の参照を検出することもできます。更に、warningでメモリリークを検出する機能があるので、競技プログラミングでは使えないかも知れませんが、実用的には利用されると思います。

今までにも、競技プログラミングでのREの自動検出は言及されてきました([ブログ1](https://blog.cormoran-web.com/blog/clang-sanitizer/)、[ブログ2](http://aki33524.hatenablog.com/entry/2017/01/16/212526))。しかし、実際のREした問題に対してどのような挙動をするのかについては説明がされてきていませんでした。

[-D_GLIBCXX_DEBUG](https://twitter.com/yosupot/status/1065188270517055489)を使って落ちたらgdbなどのデバッグツールを利用する方法があります([ブログ2](http://aki33524.hatenablog.com/entry/2017/01/16/212526))。`-fsanitize`, `valgrind`では、`gdb`を利用するまでもなく問題の箇所が行レベルで解析できる点がメリットだと思います。

`valgrind`は`gdb`に比べると詳細な変数の中身の取得ができませんが、問題の箇所を全列挙することができて便利です。僕は`valgrind`で見つけたバグの箇所を直すためにソースコードを眺めても、どういう条件で落ちているのかわからない時に`gdb`を使います。

[「慣れると目で当てる方が早くなってくる人が一定数いる」](https://twitter.com/catupper/status/1065064607394365440)という問題もあります。超優秀なエンジニアが小さいプログラムを組む時はそうかもしれません。しかし、競技プログラミングから少し離れて、複数人数で多少大きなC++プログラムを作る時は`valgrind`でエラーと警告を監視し、それを徹底的に潰すことをルールにすると、安心感が全然違います。`valgrind`は歴史あるツールなので、使えるようになっておくと良いと思います（KotlinだのSwiftだのポンポン出てくる謎ツールと違って）。

その他の方法としては、`assert`やSTLの`at`関数も利用可能です。競技プログラミングでは、`at`関数を使うと複数次元DPの添字の表記が爆散することや、数学を直接コードに移すときに冗長な表記を除外したいため不便です。`assert`は配列外参照を起こしそうな位置全てにチェックを入れる必要があり、それが可能なほどの注意力を持っているならば配列外参照をそもそも起こさないプログラムを作ることもできてしまうと思います。

##`-fsanitize`, `valgrind`の使い方
- `a.cpp`を用意します。
- `a.cpp`のコンパイルの際に、`-g -fsanitize=undefined`を付けてコンパイルします。僕はいつも`clang++-3.5 -std=c++11 -g -Wall  -fsanitize=undefined -Wno-deprecated -Wno-unneeded-internal-declaration a.cpp`でコンパイルしています。
- `a.out`が生成されます。
- `./a.out`で実行します。この時、`-fsanitize=undefined`が付いている場合、ランタイムエラーの原因を行番号付きで報告してくれます。

 ![image.png](https://qiita-image-store.s3.amazonaws.com/0/115641/ee6a49ef-0c19-0aaf-ca8a-838db3ddb878.png)

- `valgrind ./a.out`で実行します。この時、配列外参照が起きているメモリで、その読込時でエラーが起きているか書込時にエラーが起きているかを区別できます。また、どの関数から呼び出された時にエラーが起きているのかがわかります。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/115641/b5a85510-89f3-afdd-b202-8cdc729edaaf.png)

##`-fsanitize`, `valgrind`の比較
これらのRE防止ツールにはメリット・デメリットがあります。これらを以下にリスト表記でまとめました。`+`がメリット、`-`がデメリットです。

`-fsanitize=undefined`

- + 配列外参照が検知できる
- + 0除算、returnのない戻り値を要求する関数の終了、オーバーフローが検知できる。
- - 配列外参照が読みで起きているのか書きで起きているのかわからない
- - 未初期化変数の使用を検知できない
- - メモリリークを検出できない
- - 異常動作を起こす行の行番号しかわからない（どのような経路でそこに到達したかがわからない）
- + REする原因となりえる部分を全列挙できる（gdbでは1箇所見つけると止まってしまう）
- + プログラム実行が高速

`valgrind`

- + 配列外参照が検知できる
- - 0除算、returnのない戻り値を要求する関数の終了、オーバーフローが検知できない
- + 配列外参照が読みで起きているのか書きで起きているのかがわかる
- - 未初期化変数の使用を検知できる
- + メモリリークを検出できる
- + 異常動作を起こす行に到達した関数の経路がわかる（スタックトレース的な）
- + REする原因となりえる部分を全列挙できる（gdbでは1箇所見つけると止まってしまう）
- - プログラム実行が低速（体感10倍程度遅い）


##競技プログラミングでの利用場面
サンプルを`-fsanitize=undefined`, `valgrind`で確認して問題がなければ、かなり安心して提出できます。注意点としては、$n$行$m$列の盤面問題では、極端に$n \ne m$としたテストケースでないとバグが検出できない場合が多いです。

##デバッグテスト
ここでは、AtCoderでいくつかRE (Runtime Error)が出ているプログラムを手当たり次第にvalgrindにかけてサンプルを動かしてみます。それを元に、デバッグを試しに行ってみたいと思います。なお、コンパイルオプションは`clang++-3.5 -std=c++11 -g -Wall  -fsanitize=undefined -Wno-deprecated -Wno-unneeded-internal-declaration`です。

### AtCoder Beginner Contest 114 D - 756
https://beta.atcoder.jp/contests/abc114/submissions/3708441
![範囲を選択_340.png](https://qiita-image-store.s3.amazonaws.com/0/115641/9b21d8d7-7bcb-59cb-c0fd-10ee90360fb5.png)
valgrindを使うレベルの問題ではありませんでした。なお、Floating point exception時に、`division by zero`の行数が出ています。これは`-fsanitize=undefined`オプションによるものです。おすすめ。

### AtCoder Beginner Contest 114 C - 755
https://beta.atcoder.jp/contests/abc114/submissions/3704470
![範囲を選択_341.png](https://qiita-image-store.s3.amazonaws.com/0/115641/aa4fe4a7-0d18-9ac3-0405-f2ab0a732aa3.png)
valgrindを使うレベルの問題ではありませんでした。returnがないまま関数が終わってしまっているようです。ちなみにこのruntime errorでの説明文は、`-fsanitize=undefined`オプションによるものです。このオプションがない場合、以下のように非常に不親切になります。
![範囲を選択_342.png](https://qiita-image-store.s3.amazonaws.com/0/115641/09e2f781-efce-d779-16a7-feda14d6d788.png)

### Dwango Programming Contest V / 第5回 ドワンゴからの挑戦状 予選 - C - k-DMC
https://beta.atcoder.jp/contests/dwacon5th-prelims/submissions/3655162
![範囲を選択_343.png](https://qiita-image-store.s3.amazonaws.com/0/115641/73cb43b0-7d6b-5a92-9ba5-894eb59b55b5.png)
ランタイムエラーが一つのケースだけで出ていますが、検出できませんでした。こういうのは割とどうしようもないです。こうなるとvalgrindのメリットは、愚直解不要でテストケースジェネレータさえあればvalgrindを回すことができるくらいです。

### Dwango Programming Contest V / 第5回 ドワンゴからの挑戦状 予選 - C - k-DMC
https://beta.atcoder.jp/contests/dwacon5th-prelims/submissions/3679762
![範囲を選択_344.png](https://qiita-image-store.s3.amazonaws.com/0/115641/66f4394a-3382-56ea-f922-5da8de550671.png)
valgrindを使うレベルの問題ではありませんでした。returnが無いまま関数が終わってしまっているようです。ちなみにこのruntime errorでの説明文は、`-fsanitize=undefined`オプションによるものです。


### AtCoder Beginner Contest 113 D - Number of Amidakuji
https://beta.atcoder.jp/contests/abc113/submissions/3537267
![範囲を選択_345.png](https://qiita-image-store.s3.amazonaws.com/0/115641/78fd4d9e-76d6-c031-f87b-9e8c97acdb85.png)
範囲外参照をしています。ちなみにこのruntime errorでの説明文は、`-fsanitize=undefined`オプションによるものです。これによると、何らかの二次元配列の配列外参照を起こしています。15行目を見ると、そのような型のものはdpのみなので、dpが配列外参照していることがわかります。このことから、配列サイズを110くらいにしてやれば[通ります](https://beta.atcoder.jp/contests/abc113/submissions/3722200)。このvalgrindの出力を見ると、以下のように「配列外のメモリを読んでいるよ」という細かな情報を得ることができます。
![範囲を選択_346.png](https://qiita-image-store.s3.amazonaws.com/0/115641/c83093fb-35d9-9ba9-01f6-65d4dcdb5dd9.png)

###デバッグのまとめ
大多数は、基本的には`-fsanitize`で十分であることがわかりました。`valgrind`は補助ツール程度に考えれば良いと思います。また、REしているケースがコーナーケースなど特殊な場合は、ランダムテストケースジェネレータとの併用が必要になることもわかりました。

##実際的な運用
僕は、信頼性が高い必要があるプログラミング（研究やロボットプログラミングや長い間動作するプログラム）では、`valgrind`でエラーもワーニングも出ないことを確認してからコミットしています。例えば、ロボットでは誤った挙動が物理的な実世界不確かさによるのか、未定義動作によるのか、確率的アルゴリズムの暴走なのか、そういうのを切り分けるのが大変なので、valgrindでの確認は重要です。また、長い時間動作するプログラムでは、メモリリークがあるとメモリをいつの日か使い果たしてしまう可能性があるので、ワーニングも消すようにしています。これは経験則ですが、ワーニングが出るようなC++コードは往々にして予期せぬバグを埋め込んでいるので、それを事前に除外することができることもメリットの一つです。


## まとめ
この記事では、C++でランタイムエラーを防ぐための方法として、`valgrind`と`-fsanitize`を紹介しました。REしたコードをいくつかデバッグする限りでは、基本的には`-fsanitize`だけで競技プログラミング上十分ですが、`valgrind`を併用するとより詳細な情報が手に入るので、デバッグが容易になる可能性を示しました。REするコードを提出してペナルティを食らう前に、これらのツールで確認してから提出してはいかがでしょうか。