SystemTapのtapsetのソースコードを読んでいると、以下のような記述が出てくる。
# systemtap/tapset/linux/x86_64/sysc_mmap.stp
probe syscall.mmap = dw_syscall.mmap !, nd_syscall.mmap ? {}
このびっくりマークというかexclamation markは、"probe pointが見つかったらそこで評価しろ"の意味。 IBMのRedbook(http://www.redbooks.ibm.com/redpapers/pdfs/redp4469.pdf)にわかりやすい例が載っていたので、引用しておく。
# SystemTap: Instrumenting the Linux Kernel for Analyzing Performance and Functional Problems
# P16より
kernel.function(“this_might_exist”) !,
kernel.function(“if_not_then_this_should”) !,
kernel.function(“if_all_else_fails”) { ... }
この例では、kernel.function(“this_might_exits”)があれば、そこで{…}を評価する。 なければ、kernel.function(“if_not_then_this_should”)を探し、存在すれば{…}を評価する。 どちらもなければ、kernel.function(“if_all_else_fails”)を探す。
この例、SystemTap開発元のLanguage Referenceに載っていないのでつらい。
うちのICカードリーダ*1とルネサス製と思しきUSB3.0コントローラ *2 の相性が悪く、使っていると以下のようなメッセージが2秒おきに出続ける。
xhci_hcd 0000:03:00.0: WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk? xhci_hcd 0000:03:00.0: WARN Event TRB for slot 1 ep 8 with no TDs queued?
前者は、ソースコードをみた感じだと、前者はデータ転送に成功しているけど、 期待したよりも転送長が長くないときに出るもののようだ。
// drivers/usb/host/xhci-ring.c 2300 static int handle_tx_event(struct xhci_hcd *xhci, 2301 struct xhci_transfer_event *event) <snipped...> 2373 switch (trb_comp_code) { 2374 /* Skip codes that require special handling depending on 2375 * transfer type 2376 */ 2377 case COMP_SUCCESS: 2378 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0) 2379 break; 2380 if (xhci->quirks & XHCI_TRUST_TX_LENGTH) 2381 trb_comp_code = COMP_SHORT_TX; 2382 else 2383 xhci_warn_ratelimited(xhci, 2384 "WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk?\n"); ★これ
後者はというと、2483行目と2484行目にひっかかっているらしい。 リストが空っぽなのにSTOPじゃないのがダメとか、そういう感じなんだろうか。
// drivers/usb/host/xhci-ring.c 2477 if (list_empty(&ep_ring->td_list)) { 2478 /* 2479 * A stopped endpoint may generate an extra completion 2480 * event if the device was suspended. Don't print 2481 * warnings. 2482 */ 2483 if (!(trb_comp_code == COMP_STOP || 2484 trb_comp_code == COMP_STOP_INVAL)) { 2485 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n", 2486 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)), 2487 ep_index); 2488 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n", 2489 (le32_to_cpu(event->flags) & 2490 TRB_TYPE_BITMASK)>>10); 2491 xhci_print_trb_offsets(xhci, (union xhci_trb *) event); 2492 }
出続けたから何だというわけでもないが、dmesgが埋め尽くされるのはなんとなく嫌なので*3、 これをKernelを改変せずに抑止したい。どうすればよいか？今回は、Systemtapを使ってみる。
MOCHI /home/bisco% uname -r 4.4.0-78-generic MOCHI /home/bisco% cat /etc/lsb-release DISTRIB_ID=Ubuntu DISTRIB_RELEASE=16.04 DISTRIB_CODENAME=xenial DISTRIB_DESCRIPTION="Ubuntu 16.04.2 LTS"
具体的にはここ。 ざっくり言うと、動作中のKernelやユーザプロセスに対し、動的に情報を取ったりメモリを書き換えたりできるツール*4。
今回はKernelをいじるので、Systemtapバイナリに加えてKernelのデバッグ情報をインストールする。 全部まとめてここに書いてあることに従えばよい。
Systemtapで変数を書き換える行を特定するためにソースコードを取得する必要がある。 ソースコードもaptで取得できる。
$ sudo vim /etc/apt/sources.list # deb-srcから始まる行のコメントを外す $ sudo apt update $ sudo apt source linux-image-$(uname -r) # カレントディレクトリにソースコードをダウンロードする
needs XHCI_TRUST_TX_LENGTH quirk?に関しては、以下の2ステップ。
xhci->quirksにXHCI_TRUST_TX_LENGTH bitを立てるSystemtapは、tapした行が実行される前に効果を発揮するようなので、 2381行目で変数を書き換えても期待した結果が得られない。
// drivers/usb/host/xhci-ring.c(再掲) 2300 static int handle_tx_event(struct xhci_hcd *xhci, 2301 struct xhci_transfer_event *event) <snipped...> 2373 switch (trb_comp_code) { 2374 /* Skip codes that require special handling depending on 2375 * transfer type 2376 */ 2377 case COMP_SUCCESS: 2378 if (EVENT_TRB_LEN(le32_to_cpu(event->transfer_len)) == 0) 2379 break; 2380 if (xhci->quirks & XHCI_TRUST_TX_LENGTH) ★ここ 2381 trb_comp_code = COMP_SHORT_TX; 2382 else 2383 xhci_warn_ratelimited(xhci, 2384 "WARN Successful completion on short TX: needs XHCI_TRUST_TX_LENGTH quirk?\n"); <snipped...> 2463 default: 2464 if (xhci_is_vendor_info_code(xhci, trb_comp_code)) { 2465 status = 0; 2466 break; 2467 } 2468 xhci_warn(xhci, "ERROR Unknown event condition %u, HC probably busted\n", 2469 trb_comp_code); 2470 goto cleanup; 2471 } 2472 2473 do { 2474 /* This TRB should be in the TD at the head of this ring's 2475 * TD list. 2476 */ 2477 if (list_empty(&ep_ring->td_list)) { ★ここ
with no TDs queued?に関しては、以下の2ステップ。
ここでは2483行目でtrb_comp_codeを書き換えたいんだけど、 2483行目からはtrb_comp_codeにアクセスできないので、しょうがなくこうする。
2473 do { 2474 /* This TRB should be in the TD at the head of this ring's 2475 * TD list. 2476 */ 2477 if (list_empty(&ep_ring->td_list)) { 2478 /* 2479 * A stopped endpoint may generate an extra completion 2480 * event if the device was suspended. Don't print 2481 * warnings. 2482 */ 2483 if (!(trb_comp_code == COMP_STOP || 2484 trb_comp_code == COMP_STOP_INVAL)) { 2485 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n", 2486 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)), 2487 ep_index); 2488 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n", 2489 (le32_to_cpu(event->flags) & 2490 TRB_TYPE_BITMASK)>>10); 2491 xhci_print_trb_offsets(xhci, (union xhci_trb *) event); 2492 } 2493 if (ep->skip) { 2494 ep->skip = false; 2495 xhci_dbg(xhci, "td_list is empty while skip " 2496 "flag set. Clear skip flag.\n"); 2497 }
ちなみに、アクセスできる/できない変数は、-Lオプションで調べることができる。
アクセスできる変数は$xxxxと表示されるんだけど、2483行目にはtrb_comp_codeがない。
$ stap -L 'kernel.statement("handle_tx_event@drivers/usb/host/xhci-ring.c:*")' | grep 248 kernel.statement("handle_tx_event@/build/linux-0XAgc4/linux-4.4.0/drivers/usb/host/xhci-ring.c:2483") $xhci:struct xhci_hcd* $event:struct xhci_transfer_event* $xdev:struct xhci_virt_device* $ep_ring:struct xhci_ring* $event_trb:union xhci_trb* $status:int $td_num:int $__func__:char const[] const kernel.statement("handle_tx_event@/build/linux-0XAgc4/linux-4.4.0/drivers/usb/host/xhci-ring.c:2485") $xhci:struct xhci_hcd* $event:struct xhci_transfer_event* $xdev:struct xhci_virt_device* $ep_ring:struct xhci_ring* $event_trb:union xhci_trb* $status:int $trb_comp_code:u32 $td_num:int $__func__:char const[] const kernel.statement("handle_tx_event@/build/linux-0XAgc4/linux-4.4.0/drivers/usb/host/xhci-ring.c:2488") $descriptor:struct _ddebug $xhci:struct xhci_hcd* $event:struct xhci_transfer_event* $xdev:struct xhci_virt_device* $ep_ring:struct xhci_ring* $status:int $__func__:char const[] const
上記の変更をSystemtapスクリプトにすると、こうなる。
kernel.statement(<PATH>) で、ソースコードの位置を指定する。<PATH>のフォーマットは関数名@ファイルへのパス(ビルドしたときのルートディレクトリからの相対パスでよい)。->を使う。globalをつけて宣言すると使えるこのスクリプトを-gオプションを付けて実行する。
-gオプションを渡すと、guruモードと呼ばれている変数を書き換えられるモードにしてくれる。
$ sudo stap -gv usb.stp
quirks?のほうは抑止できたけど、with no TDs queued?はなぜか抑止できなかった。うーん、原因がわからん。
Systemtapスクリプトの実行をCtrl-C止めても、quirks?のメッセージが出なくなった。何か残ってるのか・・・？
このコードに対して
2473 do { 2474 /* This TRB should be in the TD at the head of this ring's 2475 * TD list. 2476 */ 2477 if (list_empty(&ep_ring->td_list)) { 2478 /* 2479 * A stopped endpoint may generate an extra completion 2480 * event if the device was suspended. Don't print 2481 * warnings. 2482 */ 2483 if (!(trb_comp_code == COMP_STOP || 2484 trb_comp_code == COMP_STOP_INVAL)) { 2485 xhci_warn(xhci, "WARN Event TRB for slot %d ep %d with no TDs queued?\n", 2486 TRB_TO_SLOT_ID(le32_to_cpu(event->flags)), 2487 ep_index); 2488 xhci_dbg(xhci, "Event TRB with TRB type ID %u\n", 2489 (le32_to_cpu(event->flags) & 2490 TRB_TYPE_BITMASK)>>10); 2491 xhci_print_trb_offsets(xhci, (union xhci_trb *) event); 2492 }
このtap
probe begin {
printf("force stop warning short TX\n")
}
probe end {
printf("stop probe\n")
}
probe kernel.statement("handle_tx_event@drivers/usb/host/xhci-ring.c:2477") {
next_addr = @cast(&$ep_ring->td_list, "list_head", "kernel")->next
list_addr = &$ep_ring->td_list
if(next_addr == list_addr) {
$trb_comp_code = 26
printf(">> trb_comp_code = %d\n", $trb_comp_code)
}
}
probe kernel.statement("handle_tx_event@drivers/usb/host/xhci-ring.c:2485") {
printf("trb_comp_code = %d\n", $trb_comp_code)
}
結果がこれ
Pass 1: parsed user script and 110 library script(s) using 109624virt/43860res/6236shr/37692data kb, in 320usr/40sys/359real ms. Pass 2: analyzed script: 4 probe(s), 4 function(s), 0 embed(s), 0 global(s) using 302812virt/236012res/7292shr/230880data kb, in 3640usr/130sys/3774real ms. Pass 3: translated to C into "/tmp/stapdRn9iB/stap_072980ba0aa3ed0cb26e4f8ce5aa1922_3963_src.c" using 302812virt/236140res/7420shr/230880data kb, in 10usr/10sys/12real ms. Pass 4: compiled C into "stap_072980ba0aa3ed0cb26e4f8ce5aa1922_3963.ko" in 3850usr/440sys/4690real ms. Pass 5: starting run. force stop warning short TX >> trb_comp_code = 26 trb_comp_code = 26 >> trb_comp_code = 26 trb_comp_code = 26 >> trb_comp_code = 26 trb_comp_code = 26 >> trb_comp_code = 26 trb_comp_code = 26
COMP_STOP = 26という事実からすると、systemtapがおかしいようにも思うし、
自分の理解が間違っているのではという感もあり、よくわからなくなった。
たまに使うときに毎回調べなくてもよいようにC用Makefileのテンプレートを作った。
Cでプログラムを書くときに、Makefileを書こうとして毎回書き方を探し回っている間抜けの極みなんですが、 だいたい書く内容は変わらないので、テンプレを作って使いまわせるようにしておきたくなった。
$(<関数名> <引数>)みたいに書くと関数をコールできる。
Makeにはいくつかビルトインの便利関数がある。カンマ前後はスペースを入れないように。
realpath：指定されたディレクトリの単一絶対パス(canonical absolute path)を取得する。
canonicalというのは、.、..、symlinkを含まないpathのこと。abspathと違ってsymlinkを解決するという違いがあるけども、
この違いがMakefileに及ぼす影響はよくわからない・・・wildcard：wildcardで指定したパターンに該当するものをスペース区切りで出力してくれる関数。
ファイルパスを渡すと、指定したパターンに該当するファイルを出力してくれる。subst：$(subst <from>,<to>,<置き換え対象文字列(空白区切り)>)というように、<置き換え対象文字列>内の全てのpatsubst：$(<変数名>:<置き換え前suffix>=<置き換え後suffix>)という形式で使っている。指定したパターンを残して置き換えをしてくれる。filter-out：あるパターンに一致するものを除外する。$(filter-out <除外したいパターン>,<空白区切り文字列>)とすると、
除外パターンに完全一致する文字列を除外して文字列を返してくれる。make cleanみたいに、何もファイルを作らないがコマンドを実行したいときに指定しておくターゲット。
テンプレでは、default、conf、cleanの3つのPhonyターゲットを指定している。
default：Makeを引数無しで実行すると実行されるもの。Makefileの変数を出力して、バイナリを作ってくれるようにしている。conf：Makefileの変数を出力するターゲット。clean：おなじみのやつ。オブジェクトファイルと実行ファイルを消すターゲット。Makefileにおける以下の部分のこと。%はワイルドカードで、$(OBJDIR)以下の*.oファイルは、
$(SRCDIR)/*.cから作られますよということをMakeに教えてあげるのがパターンマッチルール。
$(OBJDIR)/%.o : $(SRCDIR)/%.c
SRCDIR：ソースファイルを格納するディレクトリ。テンプレではMakefileと同じディレクトリ。
Makefileの置いてあるディレクトリは毎回変わるけども、realpath関数でカレントディレクトリを取得するようにしている。INCDIR：ヘッダファイルを格納するディレクトリ。テンプレではSRCDIRと同じ。OBJDIR：オブジェクトファイルを格納するディレクトリ。テンプレではOBJDIRと同じ。IGNORE：コンパイル時に無視してほしいファイルを指定する。SRCDIRがフルパスなので、IGNOREもテンプレみたいにフルパスで指定する必要がある。SRCS：SRCDIR内のCファイル全部。いちいち指定するのが大変なので、wildcard関数を使って、ワイルドカードで指定できるようにしている。OBJS：オブジェクトファイル全部。patsubst関数($(SRCS:.c=.o)の:のこと)を使って、Cファイルの".c"部分を".o"に変えている。
オブジェクトファイル置き場が変わったときのことを考えて、subst関数によりファイルパスのSRCDIR部分をOBJDIRに置き換えるようにしている。だいたい事足りそうなMakefileが書けたと思う。 これでちょこっとCでプログラムを書くときに、長いオプションをつけてgccコマンドを打たなくてよくなると思うと少し気が楽になる。
fishのfish_preexecイベントをフックして、tmuxのwindow nameをコマンド履歴に変えることができる。
tmuxを使っていると、このwindowでは一体何をしていたんだっけという状況に陥ることがままある。 そういうとき、window nameが最後に実行したコマンドだと、何をしていたか思い出すのに役立つ*1。
以下の2つの材料から結構簡単にできちゃう。 ちなみに、"フックをかける"というのは、イベント発生時に何かコマンドが実行できるよ、って意味。
tmux rename-window <window name>でwindowの名前が変えられるfish_preexecイベントフックは、~/.config/fish/config.fishに書くのが作法らしい*2。
実際にはこんな感じになる。
tmuxを使っているときは、環境変数$TERMがscreenかtmuxになるので、そのときだけwindow nameを変えるコマンドを打つ。
あんまり長いコマンドを表示してもあれなので、16文字くらいで打ち止めするようにしている。
# rename tmux window function window_rename --on-event fish_preexec if test -n (echo $TERM | grep -e screen -e tmux) tmux rename-window (printf "%.16s" $argv[1]) end end
fish_preexecイベントのおかげで、簡単にtmuxのwindow nameを動的に変えることができる。
新しいことを覚えるのはなかなかに大変で、しかも普段使わないようなものに 労力を払いたくない人はきっと多いと思う。特に文字だけしか表示されない端末。
端末操作って見た目黒魔術っぽくて、何かとっつきにくいように思うかもしれない。 なんとなく覚えている範囲で不足なく使えるからどうでもいいやと思うかもしれない。 でも、どうせなら作業効率を上げて早く帰りたい、もっと楽をしたいと思う人もたくさんいるはずだ。
そんなあなた、特に以下に該当するあなたに、fishを導入することをおすすめしたい。
いろいろ便利機能があるシェルで、設定をあまりしなくてもそれなりに整ったものが使えるのが特徴。 いろいろな便利機能とは、例えば以下。きっともっといっぱいあるけど、慣れてからでいい。
UbuntuとかDebianだったら、aptで入る。CentOSのあなたは諦めてソースコードからビルドしろ。
$ sudo apt install fish
インストールが終わったら、単にfishと打てばいい。
サジェストされたコマンドを使いたい？ コマンドを途中まで打つと履歴等々含めてサジェストしてくれるので、 Ctrl-Eか、→キーを押してくれれば確定する。
履歴を簡単に辿りたい？ コマンドを途中まで打って、↑キーを押せば、そのコマンドの履歴だけ辿ってくれる。例えばこんな感じ。
# cdの履歴を辿る例：まずはcdと打つ $ cd # 次に↑キーを押すと、cdの履歴が順繰りに出てくるので、使いたい履歴を引いたらエンターを押す $ cd ../xxxx/xxxx/
以下のコマンドを打つと、fishのほうでPATHに追加してくれる*1。 設定ファイルに書く必要はない(書いちゃダメ)。
set -U fish_user_paths <追加したいディレクトリ> $fish_user_path
まあデフォルトでそれなりに使えるfishだけど、見栄えには好みがあるので、好みの見栄えになるように調整したい。 調整するには設定ファイルを書く必要があるので、"設定ファイルを書くくらいならそのままでいいや"のあなたは 飛ばしてくれればOK。
プロンプトは、"~/.config/fish/functions/fish_prompt.fish"というファイルで設定する。
僕は
といったような趣味があるので、設定ファイルとしてはこんな感じになる。
function fish_prompt
set_color cyan
printf "%s@%s " (whoami) (hostname)
set_color yellow
printf "%s" (pwd)
set_color normal
printf "%s " (__fish_git_prompt)
printf "\n> "
end
この設定ファイルを使うと、こんな感じに表示される。色は正しく表示されていないので、各自で。。。
bisco@bisco-server /home/bisco/.config/fish/functions >
gitのブランチ名だけだとちょっと物足りないので、状態(未コミットのファイルがあるとか、そういうこと)を 表示するようにしたい。
その場合は、"~/.config/fish/config.fish"に以下の設定を追記すればよい。意味に関してはぐぐろう。。
# fish git prompt set __fish_git_prompt_showdirtystate 'yes' set __fish_git_prompt_showstashstate 'yes' set __fish_git_prompt_showupstream 'yes' set __fish_git_prompt_showuntrackedfiles 'yes' set __fish_git_prompt_show_informative_status 'yes' set __fish_git_prompt_showcolorhints 'yes'
この設定を書くと、何か状態が変化するとそれっぽいフォントで表示してくれる。なお、フォントがない場合は?になるので注意。
# 変更がないとき bisco@bisco-server /home/bisco/dotfiles (master|✔) # 未トラックのファイルが1つあるとき bisco@bisco-server /home/bisco/dotfiles (master|…1) # addしていないファイルが1つ、未トラックのファイルが1つあるとき bisco@bisco-server /home/bisco/dotfiles (master|✚1…1) # addしたファイルが1つあるとき bisco@bisco-server /home/bisco/dotfiles (master|●1) # リモートブランチよりも1つコミットが進んでいるとき bisco@bisco-server /home/bisco/dotfiles (master↑1|✔) # リモートブランチよりも1つコミットが遅れているとき bisco@bisco-server /home/bisco/dotfiles (master↓1|✔)
fishを使うと設定ファイル書かなくてもある程度使えるし、設定ファイルを書くとさらに快適になりますね。
*1:正確にはPATHに追加するんじゃなくて、fish_user_pathsという変数に追加して、PATHに付け足してくれる