ソースコード以外の情報源

Size: px

Start display at page:

Download "ソースコード以外の情報源"

あまめけいれい
5 years ago
Views:

1 著者 : 大和正武 <yamato@redhat.com> 生成日時 : :59 Copyright 2013 Red Hat, K.K. Copyright 2015 Red Hat, K.K. ソースコード以外の情報源 The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

2 はじめにソースコードを読まずに済むのであれば読まずに済ませる読む場合でも基底知識があった方が効率が良いソースコード以外の情報源文章プログラムの実行結果実行環境 2

3 文章ドメイン知識アルゴリズムデータ構造ソースコードツリーやパッケージに同梱されたドキュメント 3

4 文章 : ドメイン知識ソフトウェアが扱う分野について一般的な知識を学習しておく公開されている仕様に沿ったソフトウェアであれば仕様書を入手するネットワーク分野 : RFC コンパイラやカーネル : CPU の仕様書ソースコード中で実装している仕様に言及していることがある if (uh->check == 0) { /* RFC 2460 section 8.1 says that we SHOULD log this error. Well, it is reasonable. */ LIMIT_NETDEBUG(KERN_INFO "IPv6: udp checksum is 0\n"); goto discard; } /* 出典 : linux/net/ipv6/udp.c */ 4

5 文章 : アルゴリズムデータ構造特別なアルゴリズムやデータ構造を使っている場合ソースコード中でその実装にあたり参照した論文や書籍について言及していることがありますソースコードを読む前に読んでおくべきです /* * The first version of this code was based upon Yair Amir's PhD thesis: * (ch4,5). * * The current version of totemsrp implements the Totem protocol specified in: * */ /* 出典 : corosync/exec/totemsrp.c */ 5

6 文章 : ソフトウェアに同梱されたドキュメントオンラインマニュアル (man) オンラインマニュアル (info) パッケージに由来する情報ヘルプメッセージ 6

7 文章 : ソフトウェアに同梱されたドキュメントオンラインマニュアル (man) manコマンドは引数で指定したトピックについてページャーで表示する man [ セクション番号 ] TOPIC TOPICにはコマンド名システムコール名ライブラリ関数名設定ファイル名などを指定する良く使うセクション番号 1 実行プログラムまたはシェルのコマンド 2 システムコール ( カーネルが提供する関数 ) 3 ライブラリコール ( システムライブラリに含まれる関数 ) 7 概念 ( 例 : tcp) printfコマンドとprintfライブラリ関数など同じ名前のエントリーをセクションで区別する 7

8 キーワード検索をする : man -k キーワード manファイルを指定して閲覧する : man -l ファイルデモ 8

9 文章 : ソフトウェアに同梱されたドキュメントオンラインマニュアル (info) GNU プロジェクトに由来するソフトウェアのマニュアルは info 形式で提供される glibc gcc gdb make... info コマンドで閲覧する : info [TOPIC] ハイパーリンクをサポートしている * で始まる文字列はリンクカーソルキーでカーソルを移動してリターンでジャンプするページ送り : スペースキー q で終了する検索 9

10 ^s 順方向インクリメンタルサーチ ^r 逆方向インクリメンタルサーチリターンサーチ確定デモ 10

11 文章 : ソフトウェアに同梱されたドキュメントパッケージに由来する情報 rpm -qi の出力中に Description フィールドに指定したパッケージの最低限の情報が記載されている man や info では閲覧できな形式のドキュメントがパッケージに同梱されていることがある /usr/share/doc/ パッケージ名 - バージョン名以下に配置されるドキュメントだけを保持する独立したパッケージが用意されていることがあるパッケージ A に対して A-doc, A-docs あるいは A-manual などといった名前がつけられる 11

12 文章 : ソフトウェアに同梱されたドキュメントヘルプメッセージ 12 特別な引数を指定して実行するとヘルプメッセージ表示するプログラムがある --help -h -? help コマンドラインの前に LANG=C とすると翻訳カタログの利用を避けることができる $ LANG=C ls --help Usage: ls [OPTION]... [FILE]... List information about the FILEs (the current directory by default). Sort entries alphabetically if none of -cftuvsux nor --sort is specified. Mandatory arguments to long options are mandatory for short options too. -a, --all do not ignore entries starting with. -A, --almost-all do not list implied. and.. 痕跡文字列として使える

13 プログラムの実行結果出力先終了ステータスログ 13

14 プログラムの実行結果出力先標準出力 (stdout) 正常に処理が進行した場合に対する結果の出力先標準エラー出力 (stderr) 異常が発生した場合に対するエラーや警告メッセージなどの出力先特に指定しない限り stdout, stderr はプログラムを起動したターミナルと関連付けられる 14

15 プログラムの実行結果典型的な出力関数 printf: 標準出力への書き出しに使う代表的な関数 printf("%s\n", "something normal data"); fprintf: 標準エラー出力への書き出しに使う代表的な関数 fprintf(stderr, "%s\n", "something error message"); 15

16 プログラムの実行結果出力の保存標準出力を保存する標準エラー出力の内容はそのままターミナルに出る #./a.out > /tmp/stdout.txt 標準エラー出力の保存する標準出力の内容はそのままターミナルに出る #./a.out 2> /tmp/stderr.txt 標準出力と標準エラー出力の内容を別々のファイルに保存する #./a.out > /tmp/stdout.txt 2> /tmp/stderr.txt 標準出力を捨てて標準エラー出力の内容を保存する #./a.out > /dev/null 2> /tmp/stderr.txt 標準出力標準エラー出力の両方をまとめて保存する #./a.out > /tmp/stdout+err.txt 2>&1 16

17 プログラムの実行結果終了ステータスプログラムは終了時 int 型の値を一つだけその起動元に伝えることができる伝える側は main 関数の返り値あるいは exit 関数の引数に正数を指定する直前のプログラム実行に対する終了ステータスは $? というシェル変数に格納されている int main(int argc, char** argv) { return 17; } $ gcc foo.c $./a.out $ echo $? 17 慣例として 0 は成功を意味する 17

18 プログラムの実行結果ログ端末から切り離されて実行されるデーモンプログラムは実行中に管理者へ伝えたいメッセージがあればログに記録する通常ログは /var/log/messages に保存される閲覧にはルート権限が必要となる痕跡文字列の宝庫である # cat /var/log/messages... Nov 7 01:04:16 localhost NetworkManager[631]: <info> dhclient started with pid Nov 7 01:04:16 localhost NetworkManager[631]: <info> Activation (em1) Stage 3 of 5 (IP C Nov 7 01:04:16 localhost dhclient[16694]: Internet Systems Consortium DHCP Client Nov 7 01:04:16 localhost dhclient[16694]: Copyright Internet Systems Consortiu Nov 7 01:04:16 localhost dhclient[16694]: All rights reserved. ログの記録を依頼するには syslog ライブラリ関数を用いる syslog(priority, "%s", "this is log message\n"); 18

19 19 デーモンプログラムの設定によってログの量を調整できる

20 実行環境 20

21 実行環境 linux カーネル glibc ライブラリ ( 図 ) プロセス 1 プロセス 2 プロセス 3 プロセス 4 system call glibc C ライブラリ linux カーネル strace を使うと覗き見ることができるハードウェア 21

22 実行環境 linux カーネル glibc ライブラリ ( 説明 ) プロセスプログラムファイルを実行したときその実体をプロセスと言う linux カーネル上では複数のプロセスを同時に実行できるプロセスは互いに独立しているカーネル複数のプロセスの実行を管理するハードウェア資源へのアクセスを抽象化するハードウェア資源への同時アクセスを調停するシステムコール経由でサービスを提供する libc 言語に依存しない CPU に依存する標準 C ライブラリ関数などアプリケーションで共通に使われる関数群 22

23 23 システムコールを C 言語から簡単に利用できるようにするための薄いラッパー関数群

24 実行環境システムコール 24 種類プログラム実行 fork clone execve ファイル I/O open read lseek write close ネットワーク I/O socket

25 recv send bind connect accept shutdown などシステムコールの失敗理由は負の正数で表現される glibc の定義するラッパーがこの負の正数の絶対値を errno 大域変数に格納する 25

26 実行環境 strace strace を使うとコマンドラインで指定したプログラムを起動してどのようなシステムコールが実行されているか確認できる $ strace /bin/echo "hello" execve("/bin/echo", ["/bin/echo", "hello"], [/* 57 vars */]) = 0 brk(0) = 0xdb3000 mmap(null, 4096, PROT_READ PROT_WRITE, MAP_PRIVATE MAP_ANONYMOUS, -1, 0) = 0x7f168738e000 access("/etc/ld.so.preload", R_OK) = -1 ENOENT (No such file or directory) open("/etc/ld.so.cache", O_RDONLY O_CLOEXEC) = 3... mmap(null, 4096, PROT_READ PROT_WRITE, MAP_PRIVATE MAP_ANONYMOUS, -1, 0) = 0x7f168738d000 write(1, "hello\n", 6hello ) = 6 close(1) = 0 munmap(0x7f168738d000, 4096) = 0 close(2) = 0 exit_group(0) =? +++ exited with

27 オプション-o FILE 名とするとstraceの結果をファイルに保存できる : strace -o /tmp/log.strace /usr/bin/pwd 出力をlessで見たい場合 strace -o /tmp/log.strace /usr/bin/pwd 2>&1 less とする 27

28 実行環境プロセスプロセス process id(pid) == 452 実行コード変数定数ターミナルより入力ターミナルへ出力ターミナルへ出力ファイルを読み書き n 他のプロセスと通信 n+1 ネットワークサーバと通信メモリ空間ファイル記述子テーブル 28

29 実行環境プロセス ID(pid) ある週間に実行されているプロセスを一意に識別する番号 ps コマンドで動作中のプロセス一覧を見ることができる $ ps ax PID TTY STAT TIME COMMAND 1? Ss 0:03 /usr/lib/systemd/systemd --system --deserialize 40 2? S 0:00 [kthreadd] 3? S 0:01 [ksoftirqd/0] 5? S< 0:00 [kworker/0:0h] 7? S< 0:00 [kworker/u:0h] 8? S 0:09 [migration/0] ? Sl 0:01 /usr/libexec/mission-control ? Sl 1:32 /usr/libexec/ibus-ui-gtk3 1871? Sl 0:00 /usr/libexec/goa-daemon 1875? Sl 0:01 /usr/libexec/evolution-addressbook-factory 1882? Sl 2:06 /usr/libexec/ibus-x11 --kill-daemon 29

30 1923? Sl 1:38 /usr/libexec/ibus-engine-simple 1947? S 0:00 /usr/libexec/gvfsd-metadata ? Ss 0:04 sendmail: accepting connections 16084? Ss 0:00 sendmail: Queue runner@01:00:00 for /var/spool/clientmqueu PID を指定して動作中のプロセスに strace をアタッチできる strace -p PID 30

31 実行環境メモリ空間プログラム ( やライブラリ ) の実行コードや変数群がプロセスのメモリ空間に配置される各プロセスでメモリ空間は独立している /proc/pid/maps を見ると用途がわかる #include <stdlib.h> int main(void) { void *c = malloc(1024); while (1); return 0; } $ gcc empty.c $./a.out & [1]

32 $ cat /proc/5550/maps r-xp : /tmp/a.out rw-p : /tmp/a.out 01dc dea000 rw-p :00 0 [heap] r-xp : /usr/lib64/ld-2.15.so f r--p 0001f000 08: /usr/lib64/ld-2.15.so rw-p : /usr/lib64/ld-2.15.so rw-p : ac000 r-xp : /usr/lib64/libc-2.15.so 31719ac bac p 001ac000 08: /usr/lib64/libc-2.15.so 3171bac bb0000 r--p 001ac000 08: /usr/lib64/libc-2.15.so 3171bb bb2000 rw-p 001b : /usr/lib64/libc-2.15.so 3171bb bb7000 rw-p :00 0 7f045f0b3000-7f045f0b6000 rw-p :00 0 7f045f0d4000-7f045f0d5000 rw-p :00 0 7fff368b5000-7fff368d6000 rw-p :00 0 [stack] 7fff fff r-xp :00 0 [vdso] ffffffffff ffffffffff r-xp :00 0 [vsyscall] 32

33 実行環境ファイル記述子テーブル様々な I/O ファイルの読み書き他のプロセスとのやりとりネットワーク... オープン中の全ての I/O の経路に整数値 ( ファイル記述子 ) が与えられるプロセス中で一意に定まるシステムコール (open や socket など ) の結果として与えられる /proc/pid/fd を見るとプロセスがオープンしている全てのファイル記述子を確認できる $ ps ax grep emacs 2880? Rl 9:58 emacs pts/3 S+ 0:00 grep --color=auto emacs $ ls -l /proc/2880/fd 33

34 34 ls -l /proc/2880/fd 合計 0 lr-x yamato yamato 月 8 14:50 0 -> /dev/null lrwx yamato yamato 月 8 14:50 1 -> /home/yamato/.xsession-errors lrwx yamato yamato 月 8 14: > anon_inode:[eventfd] lrwx yamato yamato 月 8 14: > socket:[38064] lrwx yamato yamato 月 8 14: > socket:[37310] lrwx yamato yamato 月 8 14: > /dev/ptmx lrwx yamato yamato 月 8 14: > /dev/ptmx lrwx yamato yamato 月 8 14:50 2 -> /home/yamato/.xsession-errors lrwx yamato yamato 月 8 14:50 3 -> socket:[37275] lrwx yamato yamato 月 8 14:50 4 -> anon_inode:[eventfd] lrwx yamato yamato 月 8 14:50 5 -> socket:[35318] lrwx yamato yamato 月 8 14:50 6 -> anon_inode:[eventfd] lrwx yamato yamato 月 8 14:50 7 -> socket:[39422] lrwx yamato yamato 月 8 14:50 8 -> anon_inode:[eventfd] lrwx yamato yamato 月 8 14:50 9 -> socket:[37988]

slide4.pptx

slide4.pptx ソフトウェア工学入門第 4 回ライブラリ関数ライブラリ関数 stdio stdio : 標準入出力ライブラリカーネルレベルのストリームに API を追加しインタフェースを提供するカーネル fd read(2) write(2) stdio バッファ BUFSIZ プログラム BUFSIZ ごと小さい単位バッファ : 一時的にデータを保存しておく場所のことバッファリング : バッファを経由してデータをやり取りすること