Finish up the AtCoder env chapter

tatsuya6502 · tatsuya6502 · commit 1d654ca31a5a · 2019-07-02T17:06:43.000+08:00
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -20,9 +20,9 @@
   - [プログラムのテスト (TODO)](./todo.md)
   - [プログラムの提出 (TODO)](./todo.md)
 - [Tips（小技集） (TODO)](./todo.md)
-  - [クレートの利用例 (TODO)](./todo.md)
+  - [クレートの使用例 (TODO)](./todo.md)
 - [AtCoder運営者向けの情報](./atcoder-env/index.md)
-  - [本章で想定している環境と利用形態 (TODO)](./atcoder-env/supported-environment.md)
+  - [本章で想定している環境](./atcoder-env/supported-environment.md)
   - [インストール](./atcoder-env/installation.md)
     - [Rustツールチェインのインストール](./atcoder-env/installing-rust-toolchain.md)
     - [クレートのコンパイルとインストール](./atcoder-env/installing-rust-crates.md)
diff --git a/src/atcoder-env/compiling-and-running-program.md b/src/atcoder-env/compiling-and-running-program.md
@@ -19,7 +19,7 @@ $HOME             # ユーザのホームディレクトリ
 ```
 
 `WORKAREA`に`cd`で移動して、後述のコンパイルコマンドを実行します。
-すると以下のことが行われ`main`という名の実行可能ファイル（バイナリ）が生成されます。
+すると以下のことが行われ`main`という名の実行ファイルが生成されます。
 
 1. プログラムがアセンブリコードに変換されオブジェクトファイルが作られる
 1. オブジェクトファイルがRustの標準ライブラリや`${RUST_MOME}/lib/target/release/deps`配下に作成しておいた`rlib`とリンクされる
@@ -28,7 +28,7 @@ $HOME             # ユーザのホームディレクトリ
 $HOME
 └-- WORKAREA
     |-- main.rs
-    └-- main      # コンパイルとリンクの成果物。実行可能ファイル（バイナリ）
+    └-- main      # コンパイルとリンクの成果物。実行ファイル
 ```
 
 
@@ -53,26 +53,128 @@ $ echo $PATH
 コンパイルコマンドは以下のとおりです。
 
 ```console
-$ cd ${HOME}/WORKAREA
-$ RUST_LIB=${RUST_HOME}/lib
+$ cd $HOME/WORKAREA
+$ RUST_LIB=$RUST_HOME/lib
 $ rustc --edition=2018 -C opt-level=3 \
-    $(rustc-dep-option-generator ${RUST_LIB}/Cargo.toml ${RUST_LIB}/target/release/deps) \
+    $(rustc-dep-option-generator $RUST_LIB/Cargo.toml $RUST_LIB/target/release/deps) \
     main.rs
 ```
 
-これにより`${HOME}/WORKAREA`ディレクトリに`main`という名のバイナリが生成されます。
+これにより`$HOME/WORKAREA`ディレクトリに`main`という名の実行ファイルが生成されます。
 
 
 ### コンパイルオプションについて
 
-**TODO**
+`rustc`コマンドに渡すコンパイルオプションは、`cargo`でデフォルトのreleaseプロファイルを使用した時に、`cargo build --release`で生成される、ごく一般的なものを使用します。
+たとえばバイナリの実行速度を最適化するためのオプションとしては`-C opt-level=3`だけを指定しています。
+
+もし実行速度を追求するなら`-C target-cpu=native`のようなオプションを追加することもできます。
+しかしAtCoder運営者様から以下のようなお話があったため、今回の言語アップデートでは使用しないことにします。
+
+[https://twitter.com/chokudai/status/1138677406984691712](https://twitter.com/chokudai/status/1138677406984691712)
+
+> もうすぐジャッジアップデートの話を出すけれども、ジャッジの目的は「正解と不正解を分けること」であって、「最速を目指すこと」ではないので、十分に早い言語（C++, Rustなど）では、過剰な最適化とかを含めた提案はRejectすることがあるかも。
+
+[https://twitter.com/chokudai/status/1138677959059943424](https://twitter.com/chokudai/status/1138677959059943424)
+
+> といいつつ、言語間の差を減らすために「C++はO2とか付けない！」みたいな滅茶苦茶なことを言い出すつもりは全くなくて、「AtCoder環境がちょっと変わると動かなくなる」みたいな最適化は受け入れない、くらいの話です。
+
+通常形式のコンテスト（アルゴリズム系）では最速を目指すことには意味がありません。
+
+一方、マラソン系のコンテストでは、たとえ数パーセントでも速度が向上するなら嬉しいことも多くあります。
+AtCoderでは将来マラソン系のコンテストもRatedにする可能性があり、その際にコンパイルオプションを追加するか検討できるかもしれません（[参考][twitter-20190619]）
+
+[twitter-20190619]: https://twitter.com/tatsuya6502/status/1140049804082311168
+
+
+### コンパイルコマンドが動作することの確認
+
+コンパイルコマンドが動作することを確認しましょう。
+クレートのインストールに使用したCargoプロジェクトには、それらのクレートを使用する簡単なサンプルコードが含まれています。
+
+以下の方法でコンパイルできます。
+
+```console
+## 一般ユーザで実行
+
+## 作業用のディレクトリを作成する
+
+$ mkdir $HOME/WORKAREA
+$ cd $HOME/WORKAREA
+
+## サンプルコードの入ったソースファイル（2つある）をコピーする
+
+$ RUST_LIB=$RUST_HOME/lib
+
+$ cp -p $RUST_LIB/src/main.rs .
+$ cp -p $RUST_LIB/tests/test_jemallocator.rs .
+
+## サンプルコードをコンパイル、リンクする
+
+$ rustc --edition=2018 -C opt-level=3 \
+    $(rustc-dep-option-generator $RUST_LIB/Cargo.toml $RUST_LIB/target/release/deps) \
+    main.rs
+
+$ rustc --edition=2018 -C opt-level=3 \
+    $(rustc-dep-option-generator $RUST_LIB/Cargo.toml $RUST_LIB/target/release/deps) \
+    test_jemallocator.rs
+```
+
+コンパイルとリンクに成功すると実行ファイルが作られます。
+
+```console
+$ file main
+main: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV),
+  dynamically linked, interpreter /lib64/l, for GNU/Linux 3.2.0,
+  BuildID[sha1]=50373af3038c60f2a3e7a162b310e5226b08c8a9,
+  with debug_info, not stripped
+
+$ file test_jemallocator
+test_jemallocator: ELF 64-bit LSB shared object, x86-64, version 1 (SYSV),
+  dynamically linked, interpreter /lib64/l, for GNU/Linux 3.2.0,
+  BuildID[sha1]=31b718908ebf067f4b1161b1dc5cf679f012ad7f,
+  with debug_info, not stripped
+```
 
 
 ## 実行コマンド
 
-バイナリを実行するコマンドは以下のとおりです。
+実行ファイルを実行するコマンドは以下のとおりです。
+
+```console
+$ cd $HOME/WORKAREA
+$ ./main
+```
+
+
+### 実行コマンドが動作することの確認
+
+実行コマンドが動作することを確認しましょう。
+先ほど作成した実行ファイルを実行します。
 
 ```console
-$ cd ${HOME}/WORKAREA
-$ ./main < 入力データファイル
+## 一般ユーザで実行
+
+$ cd $HOME/WORKAREA
+
+$ ./main
+...
+
+## いろいろなメッセージが表示されるが、テスト用の出力なので内容は確認しなくてよい
+## 終了コード0で終了したことだけを確認すればOK
+
+$ echo $?
+0
+
+$ ./test_jemallocator
+...
+
+## こちらも終了コード0で終了したことだけを確認すればOK
+$ $?
+0
 ```
+
+AtCoder運営者向けの情報は以上となります。
+内容について質問などがありましたら、[GitHub Issue][gh-issue]などでご連絡ください。
+
+[gh-issue]: https://github.com/rust-lang-ja/atcoder-rust-resources/issues
diff --git a/src/atcoder-env/index.md b/src/atcoder-env/index.md
@@ -7,6 +7,8 @@
 - Rustツールチェインやクレート（外部ライブラリ）をジャッジサーバへインストールする手順
 - 提出されたプログラムのコンパイルおよび実行手順
 
+本章のMarkdownソースファイルはGitHub [rust-lang-ja/atcoder-rust-resources][gh]にあります。
 内容について質問などがありましたら、[GitHub Issue][gh-issue]などでご連絡ください。
 
+[gh]: https://github.com/rust-lang-ja/atcoder-rust-resources
 [gh-issue]: https://github.com/rust-lang-ja/atcoder-rust-resources/issues
diff --git a/src/atcoder-env/installation.md b/src/atcoder-env/installation.md
@@ -5,6 +5,5 @@
 本節では以下の内容について説明します。
 
 - Rustツールチェインのインストール
-- クレート（外部ライブラリ）のコンパイルとインストール
+- クレートのコンパイルとインストール
 - クレートの検索パス生成ツールのインストール
-- インストール後の動作確認
diff --git a/src/atcoder-env/installing-rust-crates.md b/src/atcoder-env/installing-rust-crates.md
@@ -15,18 +15,19 @@
 - 他のいくつかの言語の標準ライブラリにあって、Rustにない機能を提供するもの
   - 例：C++の`lower_bound`や`BitSet`に相当する機能
 - 競技プログラミングの面白さを損なわない範囲（ズルにならない範囲）で便利になるもの
-  - 例：Rustでは入出力関連の記述が煩雑になりがちなので、それらを簡潔に記述できるマクロ集
+  - 例：Rustでは入力関連の記述が煩雑になりがちなので、それらを簡潔に記述できるマクロ集
 - セキュリティなどの理由から高速性が犠牲になっている機能を置き換えるもの
   - 例：標準ライブラリのハッシュ関数はDoS攻撃を避けるために暗号強度があり、計算量が多い。
     競技プログラミングでは暗号強度は求められず、より計算量の少ないハッシュ関数で十分
 
 **AtCoder運営者様へのお願い**
 
-対象クレートの一覧は このページ（**TODO**、[仮のページはこちら](https://github.com/rust-lang-ja/atcoder-rust-resources/wiki/Crates-2019)） にあります。
-インストールして問題がないか、事前にレビューをお願いいたします。
+対象クレートの一覧は[このページ](crates-2019)にあります。
+ジャッジサーバで使用して問題ない内容か、インストール前にレビューをお願いいたします。
 
 質問や要望などがありましたら、[GitHub Issue][gh-issue]などでご連絡ください。
 
+[crates-2019]: https://github.com/rust-lang-ja/atcoder-rust-resources/wiki/Crates-2019
 [gh-issue]: https://github.com/rust-lang-ja/atcoder-rust-resources/issues
 
 
@@ -55,11 +56,11 @@ $HOME   # ユーザのホームディレクトリ
             |-- deps
             |   |-- X.rlib  # コンパイル済みのクレート
             |   └-- Y.rlib
-            └-- main        # コンパイル、リンク済みの実行可能ファイル（バイナリ）
+            └-- main        # コンパイル、リンク済みの実行ファイル
 ```
 
 この方法ではユーザプログラムをコンパイルする際にクレートもコンパイルします。
-もしジャッジサーバでこの方法をとると、ジャッジの際のサーバ負荷が増えてしまいます。
+もしジャッジサーバでこの方法をとると、ユーザプログラムが提出されるごとにクレートがコンパイルされることになり、サーバの負荷が増えてしまいます。
 
 そこで今回は各ファイルを以下のように配置し、クレートのコンパイルは導入時に済ませておくことにします。
 
@@ -88,18 +89,18 @@ $RUST_HOME (/usr/local/lib/rust)
 $HOME             # ユーザのホームディレクトリ
 └-- WORKAREA      # ジャッジ用の一時ディレクトリ
     |-- main.rs   # ユーザプログラム（提出されたプログラム）のソースコード
-    └-- main      # コンパイル、リンク済みの実行可能ファイル（バイナリ）
+    └-- main      # コンパイル、リンク済みの実行ファイル
 ```
 
 
 ## クレートのコンパイルに使用するCargoパッケージのダウンロード
 
 それではインストール作業に入りましょう。
-クレートの事前コンパイルに使用するCargoパッケージをGitHubからダウンロードし、`/usr/local/lib/rust/lib`に配置します。
+クレートの事前コンパイルに使用するCargoパッケージは、GitHub [rust-lang-ja/atcoder-rust-base（ja-all-enabledブランチ）][rust-base-branch]に用意されています。
 このパッケージには`Cargo.toml`ファイルなどが含まれており、インストール対象のクレートがすでに設定されています。
 （`[dependencies]`セクションに書かれています）
 
-以下のコマンドを実行します。
+このリポジトリを`git clone`し、`/usr/local/lib/rust/lib`に配置します。以下のコマンドを実行します。
 
 ```console
 ## rootユーザで作業する
@@ -116,6 +117,7 @@ root
     ${RUST_HOME}/lib
 ```
 
+[rust-base-branch]: https://github.com/rust-lang-ja/atcoder-rust-base/tree/ja-all-enabled
 
 
 ## クレートのコンパイル
@@ -142,7 +144,8 @@ $
 以下のコマンドを実行します。
 
 ```console
-$ find target/release/deps/ -name '*.rlib' | wc -l
-59   # この数字を確認
+$ find target/release/deps/ -type f | egrep -c '\.(rlib|so)$'
+66
+# ↑ 上の数字を確認
 ```
 
diff --git a/src/atcoder-env/installing-rust-toolchain.md b/src/atcoder-env/installing-rust-toolchain.md
@@ -10,7 +10,7 @@
 今回の言語アップデートでは2019年5月20日にリリースされた1.35.0をインストールします。
 
 Rustの安定版（stable版）は6週間ごとにリリースされますので、次の1.36.0は7月4日にリリースされます。
-言語アップデート作業は2019年6月末から開始される予定ですので、1.36.0をインストールすることも可能です。
+言語アップデート作業は2019年7月から始まりましたので、1.36.0をインストールすることも可能です。
 しかし今回は安全のために、リリースされてから少し日が経っている1.35.0を選択します。
 
 ツールチェインのインストールには`rustup`というRustプロジェクト公式のコマンドラインツールを使います。
@@ -26,16 +26,14 @@ Rustの安定版（stable版）は6週間ごとにリリースされますので
 - Rustの標準ライブラリとAPIドキュメント
 
 `cargo`はRustプログラムの開発には欠かせないツールですが、ジャッジの際には使用しません。
-ジャッジサーバでは`rustc`を直接呼び出すことでユーザプログラムをコンパイルし、事前にコンパイルしておいたクレート（外部ライブラリ）とリンクします。
-理由については次のページで説明します。
+ジャッジサーバでは`rustc`を直接呼び出すことでユーザプログラムをコンパイルし、事前にコンパイルしておいたクレートとリンクします。
+理由については前のページで説明したとおり、ジャッジの際にクレートが毎回コンパイルされることなどを防ぐためです。
 
 `cargo`は環境の構築時、具体的にはこのページに続く数ページでRustのクレートや関連ツールをビルドする際に使用します。
 
 Rustツールチェインはデフォルトでは`rustup`を実行したLinuxユーザのホームディレクトリ配下（`~/.rustup/toolchains`）にインストールされます。
 しかし今回はジャッジサーバ上の全てのLinuxユーザから使えるよう、`/usr/local/lib/rust`配下にインストールします。
-このディレクトリは一般のLinuxユーザからは書き込みができないように設定し、ジャッジの際にユーザプログラムからツールチェインが変更されないように守ります。
-
-インストールにあたってインターネット接続が必要です。
+このディレクトリは一般のLinuxユーザからは書き込みができないように設定し、ジャッジの際にツールチェインがユーザプログラムによって変更されないよう保護します。
 
 
 ## 依存ソフトウェアのインストール
@@ -44,7 +42,7 @@ Rustツールチェインをインストールする前に、Rustプログラム
 必要なソフトウェアは以下のとおりです。
 
 - Rustツールチェインやクレートのダウンロードに必要なツール：curl, git-core
-- Rustプログラムのリンク時に必要なツール：gcc, binutils
+- ユーザプログラムのリンク時に必要なツール：gcc, binutils
 - 一部のRustクレートのビルドに必要なツール：make, pkg-config
 
 以下のコマンドを実行します。
diff --git a/src/atcoder-env/installing-rustc-dep-option-generator.md b/src/atcoder-env/installing-rustc-dep-option-generator.md
@@ -27,7 +27,7 @@ $ sudo apt install -y libssl-dev
 
 `cargo install`コマンドでインストールします。
 以下のコマンドを実行すると、GitHubのリポジトリからツールのソースコードがダウンロードされ、ビルドが実行されます。
-ビルドに成功すると、生成されたバイナリ（実行可能ファイル）が`$CARGO_HOME/bin`配下にインストールされます。
+ビルドに成功すると、生成された実行ファイルが`$CARGO_HOME/bin`配下にインストールされます。
 
 ```console
 $ sudo -i
diff --git a/src/atcoder-env/supported-environment.md b/src/atcoder-env/supported-environment.md
