Elixir Meetup #1 in DrecomにてElixirの動作についてIExを例にして話した資料です。

1. IEXを学ぶ

2. 自己紹介
名前：橘田 隼一
TwitterID：hayabusa333
興味：カーネル、GC、Erlang、Elixir
お仕事：派遣ウェッブプログラマ
所属：Joel教、翔鶴瑞鶴仲良し姉妹同盟

3. 自己紹介(宣伝)
ElixirとPhoenixの薄い本を出しました
（ページ数：240）

4. 自己紹介(宣伝)
・80部完売（Elixir/Phoenixの本に需要はあった！）
・電子書籍版をBOOTHで販売中

5. https://hayabusa333.booth.pm/items/186705

6. 本日のお話
ohrdevさん：
Elixirアプリの運用周りの話
ma2geさん：
PowerAssertについて
→さて、何を話すか？

7. Elixirの内部の話じゃね？

8. IExのコードを読んでいき
Elixirの内部をみていきます

9. 本日の目標
• なんとなくElixirのコード読めた感
を出す
• Elixirのコードはむずかしくない
• Erlangまでは下りていかない
• Elixirの内部はErlangのコード

10. それでは
見ていきましょう！

11. まずは起動したら、
どこが動くのかをmix.exsにて
確認する

12. lib/iex/mix.exs
def application do
[registered: [IEx.Supervisor, IEx.Config],
mod: {IEx.App, []},
env: [
autocomplete_server: IEx.Server,
colors: [],
inspect: [],
history_size: 20,
default_prompt: "%prefix(%counter)>",
alive_prompt: "%prefix(%node)%counter>"]]
end

13. lib/iex/mix.exs
def application do
[registered: [IEx.Supervisor, IEx.Config],
mod: {IEx.App, []},
∼略∼

14. lib/iex/mix.exs
∼略∼
env: [
autocomplete_server: IEx.Server,
colors: [],
inspect: [],
history_size: 20,
default_prompt: "%prefix(%counter)>",
alive_prompt: "%prefix(%node)%counter>"]]
end

15. mod: {IEx.App, []} と記載されている箇所から
IEx.Appをまず最初に呼び出すことが
わかります。

16. mod: で最初に動く関数は
startメソッドのため
IEx.App.start/2メソッドを
見に行きます

17. lib/iex/lib/iex/app.ex
def start(_type, _args) do
import Supervisor.Spec
children = [worker(IEx.Config, [])]
options = [strategy: :one_for_one, name: IEx.Supervisor]
tab = IEx.Config.new()
case Supervisor.start_link(children, options) do
{:ok, pid} ->
{:ok, pid, tab}
{:error, _} = error ->
IEx.Config.delete(tab)
error
end
end

18. modにて起動される
IEx.App.start/2を
確認するが長そう

19. 少しずつ見ていこう

20. lib/iex/lib/iex/app.ex
def start(_type, _args) do
import Supervisor.Spec

21. 新規のスーパーバイザーの定義を
行うためにSupervisor.Specの
importを実行する

22. lib/iex/lib/iex/app.ex
children = [worker(IEx.Config, [])]
options =
[strategy: :one_for_one, name: IEx.Supervisor]
tab = IEx.Config.new()

23. workerについて

24. worker(module, args, options [])
メソッドを呼び出している

25. worker(IEx.Config, [])
worker(module, args, options [])

26. 引数の数が違わない？

27. 引数が
options [] のように が記載さ
れている場合は、メソッド呼び出し
の際に値がない場合に の後ろの []
が値として入ってくる

28. 例
iex(1)> defmodule Test do
...(1)> def test(options []) do
...(1)> case options do
...(1)> [] -> IO.puts "[]"
...(1)> _ -> IO.puts "ちゃうよ"
...(1)> end
...(1)> end
...(1)> end
iex(2)> Test.test
[]
:ok
iex(3)> Test.test([1,2])
ちゃうよ
:ok

29. worker(IEx.Config, [])
worker(module, args, options [])
第一引数が IEx.Configというモジュール名
第二引数が空配列
第三引数も空配列でWokerを作成

30. っということで
Supervisor.Spec.worker/3の
実装をみていくよー

31. lib/elixir/lib/supervisor/spec.ex
def worker(module, args, options []) do
child(:worker, module, args, options)
end

32. Supervisor.Spec.child/4を呼び
出しているだけですね。
Supervisor.Spec.child/4の実装
を確認しにいきましょう。

33. lib/elixir/lib/supervisor/spec.ex
defp child(type, module, args, options) do
id = Keyword.get(options, :id, module)
modules = Keyword.get(options, :modules, modules(module))
function = Keyword.get(options, :function, :start_link)
restart = Keyword.get(options, :restart, :permanent)
shutdown = Keyword.get(options, :shutdown, 5000)
{id, {module, function, args},
restart, shutdown, type, modules}
end

34. Keyword.getをして、取得した値を返
しているようである

35. KeywordはElixirにて定義されて
いるモジュール

36. Keyword.getはキーに一致する値を取
得します。
取得できなかった場合はデフォルト値
となる

37. それでは、コードを戻っ
ていきましょう

38. lib/iex/lib/iex/app.ex
children = [worker(IEx.Config, [])]
options =
[strategy: :one_for_one, name: IEx.Supervisor]
tab = IEx.Config.new()

39. Workerの登録は実施したので、次はスーパーバ
イザーの戦略を決定していきます。
[strategy: :one_for_one, name:
IEx.Supervisor]
と記載されている通り、IExでは one_for_one
の戦略をとっているようです。

40. one_for_oneの戦略は自
分自身が死んだとしても他
人に影響されずに再起動す
るという戦略となります。

41. one_for_one以外の戦略としては、
下記のような戦略があります。
• simple_one_for_one
• rest_for_one
• one_for_all

42. スーパーバイザーを使用
するために起動戦略を設
定しないといけないため、
その設定を行いました。

43. lib/iex/lib/iex/app.ex
children = [worker(IEx.Config, [])]
options =
[strategy: :one_for_one, name: IEx.Supervisor]
tab = IEx.Config.new()

44. IEx.Config.newの結果を
tabにパターンマッチして
いるようです。

45. IEx.Config.newを見
てみましょう。

46. lib/iex/lib/iex/config.ex
def new() do
tab =
:ets.new(@table, [:named_table, :public])
true =
:ets.insert_new(tab, [after_spawn: []])
tab
end

47. それほど長くなさそう
いけるいける

48. lib/iex/lib/iex/config.ex
@table __MODULE__
def new() do
tab =
:ets.new(@table, [:named_table, :public])
true =
:ets.insert_new(tab, [after_spawn: []])
tab
end

49. ETSはErlangのETSモジュールを
介してメモリ内のテーブルに保存
しておくことができるものです。

50. :ets.newにて新しいテーブル
を作成します。

51. @table は __MODULE__ と定義さ
れているため定義されている箇所の
モジュール名が値として入っており
ます。
今回で言えば、IEx.Config ですね。

52. lib/iex/lib/iex/config.ex
def new() do
tab =
:ets.new(@table, [:named_table, :public])
true =
:ets.insert_new(tab, [after_spawn: []])
tab
end

53. :ets.insert_newにて
オブジェクトの追加を行います。

54. lib/iex/lib/iex/config.ex
def new() do
tab =
:ets.new(@table, [:named_table, :public])
true =
:ets.insert_new(tab, [after_spawn: []])
tab
end

55. Elixirは最後の結果が返り値と
なるため tab にパターンマッ
チされた結果が返る

56. lib/iex/lib/iex/app.ex
tab = IEx.Config.new()
case Supervisor.start_link(children, options) do
{:ok, pid} ->
{:ok, pid, tab}
{:error, _} = error ->
IEx.Config.delete(tab)
error
end

57. IEx.Config.newで返ってきた
tabの値をtabにパターンマッ
チさせる

58. lib/iex/lib/iex/app.ex
tab = IEx.Config.new()
case Supervisor.start_link(children, options) do
{:ok, pid} ->
{:ok, pid, tab}
{:error, _} = error ->
IEx.Config.delete(tab)
error
end

59. Supervisor.start_link(children, options)
にてスーパーバイザーの登録を行う。
成功したら {:ok, pid, tab}を返す
失敗したら IEx.Config.delete(tab) を実
行してから、errorを返す

60. これでIExの
スーパーバイザーの登録が完了！

61. あれ？
登録だけで、実際のIExの動作関連は？

62. ドキュメントにも
なにも書いていない…

63. lib/iex/lib/iex.ex
def start(opts [], mfa {IEx, :dont_display_result, []}) do
spawn fn ->
case :init.notify_when_started(self()) do
:started -> :ok
_ -> :init.wait_until_started()
end
:ok = start_iex()
:ok = set_expand_fun()
:ok = run_after_spawn()
IEx.Server.start(opts, mfa)
end
end

64. lib/iex/lib/iex.ex
def start(opts [], mfa
{IEx, :dont_display_result, []}) do
spawn fn ->
case :init.notify_when_started(self()) do
:started -> :ok
_ -> :init.wait_until_started()
end

65. lib/iex/lib/iex.ex
:ok = start_iex()
:ok = set_expand_fun()
:ok = run_after_spawn()
IEx.Server.start(opts, mfa)
end
end

66. IEx.startが
動くはずである

67. ドキュメントを探る
• Mix
→ 書いてない
• IEx
→ 書いてない

68. オワタ＼(^o^)／

69. 過去のコードを追う！

70. IExが初めて入ってきたのはElixir v0.7.0か
らだけど、そのときのコードの動作だと
スーパーバイザーは使っていない

71. ※ちなみにコードが綺麗に
分割されているのはElixir v0.6.0からのよ
うなので、読むなら、そのあたりから読み
始めると良さそう。

72. 過去のコードから追いかけるか…
しかし時間終了

73. …と思ったら

75. Elixirのドキュメントの
Applicationの中に書いてありそう

76. ・・・

77. 次回作にご期待ください！

78. ちなみに

79. lib/iex/mix.exs
∼略∼
env: [
autocomplete_server: IEx.Server,
colors: [],
inspect: [],
history_size: 20,
default_prompt: "%prefix(%counter)>",
alive_prompt: "%prefix(%node)%counter>"]]
end

80. mix.exsに見慣れない
envの設定がある

81. 一応、関係ありそうな変更を発見
https://github.com/elixir-lang/elixir/
commit/
5e21d0d22dbbd55ff603763a31afe
21885c12658

82. lib/iex/lib/iex/autocomplete.ex
defp env_aliases do
- IEx.Server.current_env.aliases
+
Application.get_env(:iex, :autocomplete_serve
r).current_env.aliases
end

83. lib/iex/mix.exs
[registered: [IEx.Supervisor, IEx.Config],
mod: {IEx.App, []},
env: [
+ autocomplete_server: IEx.Server,
colors: [],
inspect: [],
history_size: 20,
default_prompt: "%prefix(%counter)>",
alive_prompt: "%prefix(%node)%counter>"]]
end

84. IEx envをautocomplete
server側に移したという
コミットメッセージ

85. 他のElixirのライブラリで
は誰も行っていない方法

86. これだけだとわからない
よね…

88. Elixirのドキュメントの
Applicationの中に:envについて
も書いてあった

89. 次回作に(ry

90. Elixirのガチ勢の
ガチコードはわからん

91. Elixirにて実装されている内部
コードを読むとElixirの実行
コードを読むことになる

92. Elixirの良い勉強になる

93. それほど難しくもない

94. ※ただしドキュメントが
ある範囲での話

95. 誰かの良い情報になった
のならば幸いです

96. ご静聴ありがとうございました