Debugging Apache installed with apt-get

以前の記事では、ソースからビルドした Apache を gdb でライブ デバッグする方法について触れました。apt-get でダウンロードした Apache では、ディレクトリ構成や構成ファイル名などが異なっているので、デバッグの方法も少し異なります。その方法を紹介します。

Ubuntu では、"apt-get install apache2" コマンドで Apache 2.x をダウンロード/インストールできます。ダウンロードされるバイナリにデバッグ情報は含まれていないので、Apache のコアモジュールをデバッグするのはあまり現実的ではありませんが、自分で作ったモジュールをデバッグするには十分です。

まずは環境を用意します。apt-get install したパッケージは以下の通り。

  • build-essential
  • libtool
  • manpages-dev
  • gdb
  • apache2
  • apache2-dev
  • git

使うバージョンは以下の通り。

  • Ubuntu Server 14.04.1 LTS x64
  • Linux Kernel 3.13.0-32-generic
  • gcc (Ubuntu 4.8.2-19ubuntu1) 4.8.2
  • GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1
  • Apache/2.4.7 (Ubuntu)
  • git version 1.9.1

新しくサイトを作るのも面倒くさいので、既存の /etc/apache2/sites-available/000-default.conf を以下のように編集します。この段階では、ServerName を追加するだけです。

ServerName http://www.example.com
<VirtualHost *:80>
    ServerAdmin webmaster@localhost
    DocumentRoot /var/www/html

    LogLevel info ssl:warn

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

Apache を再起動します。

john@ubuntu14041:~$ sudo service apache2 restart
* Restarting web server apache2         [ OK ]
john@ubuntu14041:~$

ブラウザーからアクセスします。今回は IE11+KB3008923 を使います。

image

これで準備は完了です。では、デバッグ対象となるモジュールを用意します。今回はこれで。

https://github.com/msmania/mod_clover

クローンします。

john@ubuntu14041:~$ git clone https://github.com/msmania/mod_clover.git
Cloning into ‘mod_clover’…
remote: Counting objects: 22, done.
remote: Compressing objects: 100% (15/15), done.
remote: Total 22 (delta 7), reused 20 (delta 5)
Unpacking objects: 100% (22/22), done.
Checking connectivity… done.

ダウンロードされた ./build.sh と ./install.sh はパスが異なっていて使えないので、ビルドとインストールは直に apxs を実行します。

john@ubuntu14041:~/mod_clover$ apxs -c mod_clover.c
/usr/share/apr-1.0/build/libtool –silent –mode=compile –tag=disable-static x86_64-linux-gnu-gcc -std=gnu99 -prefer-pic -pipe -g -O2 -fstack-protector –param=ssp-buffer-size=4 -Wformat -Werror=format-security  -D_FORTIFY_SOURCE=2   -DLINUX -D_REENTRANT -D_GNU_SOURCE  -pthread  -I/usr/include/apache2  -I/usr/include/apr-1.0   -I/usr/include/apr-1.0 -I/usr/include  -c -o mod_clover.lo mod_clover.c && touch mod_clover.slo
/usr/share/apr-1.0/build/libtool –silent –mode=link –tag=disable-static x86_64-linux-gnu-gcc -std=gnu99 -Wl,–as-needed -Wl,-Bsymbolic-functions -Wl,-z,relro -Wl,-z,now    -o mod_clover.la  -rpath /usr/lib/apache2/modules -module -avoid-version    mod_clover.lo

john@ubuntu14041:~/mod_clover$ sudo apxs -i mod_clover.la
/usr/share/apache2/build/instdso.sh SH_LIBTOOL=’/usr/share/apr-1.0/build/libtool’ mod_clover.la /usr/lib/apache2/modules
/usr/share/apr-1.0/build/libtool –mode=install install mod_clover.la /usr/lib/apache2/modules/
libtool: install: install .libs/mod_clover.so /usr/lib/apache2/modules/mod_clover.so
libtool: install: install .libs/mod_clover.lai /usr/lib/apache2/modules/mod_clover.la
libtool: finish: PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/sbin" ldconfig -n /usr/lib/apache2/modules
———————————————————————-
Libraries have been installed in:
   /usr/lib/apache2/modules

If you ever happen to want to link against installed libraries
in a given directory, LIBDIR, you must either use libtool, and
specify the full pathname of the library, or use the `-LLIBDIR’
flag during linking and do at least one of the following:
   – add LIBDIR to the `LD_LIBRARY_PATH’ environment variable
     during execution
   – add LIBDIR to the `LD_RUN_PATH’ environment variable
     during linking
   – use the `-Wl,-rpath -Wl,LIBDIR’ linker flag
   – have your system administrator add LIBDIR to `/etc/ld.so.conf’

See any operating system documentation about shared libraries for
more information, such as the ld(1) and ld.so(8) manual pages.
———————————————————————-
chmod 644 /usr/lib/apache2/modules/mod_clover.so

設定は apxs に任せず、手動でやることにします。さっきも編集した /etc/apache2/sites-available/000-default.conf に以下の行 (青字) を追加。

ServerName www.example.com

LoadModule clover_module /usr/lib/apache2/modules/mod_clover.so
AddOutputFilterByType CLOVER text/html

<VirtualHost *:80>
    ServerAdmin webmaster@localhost
    DocumentRoot /var/www/html

    LogLevel info ssl:warn

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

    Clover_Dynamic 1
</VirtualHost>

apache 再起動。エラーが出なければモジュールは読み込みは成功です。

john@ubuntu14041:~/mod_clover$ sudo service apache2 restart
* Restarting web server apache2                    [ OK ]

この mod_clover とかいうモジュールの正体ですが、URL に渡すクエリ文字列によって、サーバーが返す HTML の DOCTYPE と IE の Document Mode を変更できる、というものです。といってもフィルター内で HTML の構造を完全にパースしているのではなく、行単位で置換するだけです。あまり融通が利きません。

フィルターが正しく動作できるように、/var/www/html/index.html を少し手直しして、ファイルの出だしを以下のようにします。変更は、1 行目の空行の削除と、x-ua-compatible メタ情報の追加の二ヶ所です。

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="
http://www.w3.org/1999/xhtml">
  <!–
    Modified from the Debian original for Ubuntu
    Last updated: 2014-03-19
    See:
https://launchpad.net/bugs/1288690
  –>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="x-ua-compatible" content="IE=edge" />
    <title>Apache2 Ubuntu Default Page: It works</title>
    <style type="text/css" media="screen">
  * {
    margin: 0px 0px 0px 0px;

例えばオリジナルの URL が http://11.10.90.10/ だったときに、http://11.10.90.10/?t=1&m=9 という URL でアクセスすると、DOCTYPE が HTML5、Document Mode が IE9 になる、はずです。

実際に開いてみると、DOCTYPE は XHTML1.0 のまま、DocMode も edge のままでフィルターが動いてくれません。ではデバッガーをアタッチして見てみます。

image

アタッチすべきプロセスを ps で確かめると、/usr/sbin/apache2 だと分かります。ワーカー プロセスが複数起動されているので、デバッグのためには –X オプションを付けてシングル プロセス モードで起動したいところです。

john@ubuntu14041:~$ ps -ef | grep apache
root     18052     1  0 17:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data 18055 18052  0 17:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data 18056 18052  0 17:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data 18057 18052  0 17:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data 18058 18052  0 17:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data 18059 18052  0 17:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data 18068 18052  0 17:17 ?        00:00:00 /usr/sbin/apache2 -k start
john     18090  1376  0 17:30 pts/0    00:00:00 grep –color=auto apache

ソースからビルドした httpd のときのように、apache2 を gdb 下で直接実行しようとしてもうまくいきません。

john@ubuntu14041:~$ sudo service apache2 stop
[sudo] password for john:
* Stopping web server apache2 *

john@ubuntu14041:~$ sudo gdb /usr/sbin/apache2
GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1
Copyright (C) 2014 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <
http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "x86_64-linux-gnu".
Type "show configuration" for configuration details.
For bug reporting instructions, please see:
<
http://www.gnu.org/software/gdb/bugs/>.
Find the GDB manual and other documentation resources online at:
<
http://www.gnu.org/software/gdb/documentation/>.
For help, type "help".
Type "apropos word" to search for commands related to "word"…
Reading symbols from /usr/sbin/apache2…(no debugging symbols found)…done.
(gdb) r -X
Starting program: /usr/sbin/apache2 -X
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
[Thu Jan 01 17:32:59.261766 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_LOCK_DIR} is not defined
[Thu Jan 01 17:32:59.261944 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_PID_FILE} is not defined
[Thu Jan 01 17:32:59.262003 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_RUN_USER} is not defined
[Thu Jan 01 17:32:59.262065 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_RUN_GROUP} is not defined
[Thu Jan 01 17:32:59.262127 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_LOG_DIR} is not defined
[Thu Jan 01 17:32:59.370505 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_RUN_DIR} is not defined
[Thu Jan 01 17:32:59.370823 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_LOG_DIR} is not defined
[Thu Jan 01 17:32:59.374724 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_LOG_DIR} is not defined
[Thu Jan 01 17:32:59.374848 2015] [core:warn] [pid 18128] AH00111: Config variable ${APACHE_LOG_DIR} is not defined
AH00526: Syntax error on line 74 of /etc/apache2/apache2.conf:
Invalid Mutex directory in argument file:${APACHE_LOCK_DIR}
[Inferior 1 (process 18128) exited with code 01]
(gdb)

赤字で示したエラー メッセージから、環境変数が足りないことが分かります。試行錯誤したところ、起動スクリプトである apache2ctl を編集するのが最も簡単だったので、その方法を紹介します。なお apachectl は、apache2ctl へのシンボリック リンクです。

john@ubuntu14041:~$ ls -l /usr/sbin/ap*
-rwxr-xr-x 1 root root 637496 Jul 22 07:38 /usr/sbin/apache2
-rwxr-xr-x 1 root root   6402 Jan  3  2014 /usr/sbin/apache2ctl
lrwxrwxrwx 1 root root     10 Jul 22 07:37 /usr/sbin/apachectl -> apache2ctl
lrwxrwxrwx 1 root root      9 Apr  3  2014 /usr/sbin/apparmor_status -> aa-status

apache2ctl は、start や stop といったパラメーターを取ることができますが、そこにデバッグ用のオプションを追加します。追加するのは以下の青字で示した 3 行です。

case $ARGV in
start)
    # ssl_scache shouldn’t be here if we’re just starting up.
    # (this is bad if there are several apache2 instances running)
    rm -f ${APACHE_RUN_DIR:-/var/run/apache2}/*ssl_scache*
    $HTTPD ${APACHE_ARGUMENTS} -k $ARGV
    ERROR=$?
    ;;
stop|graceful-stop)
    $HTTPD ${APACHE_ARGUMENTS} -k $ARGV
    ERROR=$?
    ;;
debug)
    gdb $HTTPD
    ;;

restart|graceful)
(..snip..)

起動します。今度はうまくいきました。r -X した後にワーカー スレッドが作られたことを示すログが出力されないことから、apt-get するパッケージの Apache はマルチスレッド モデルではないようです。

john@ubuntu14041:~$ sudo apachectl debug
GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1
Copyright (C) 2014 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <
http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "x86_64-linux-gnu".
Type "show configuration" for configuration details.
For bug reporting instructions, please see:
<
http://www.gnu.org/software/gdb/bugs/>.
Find the GDB manual and other documentation resources online at:
<
http://www.gnu.org/software/gdb/documentation/>.
For help, type "help".
Type "apropos word" to search for commands related to "word"…
Reading symbols from /usr/sbin/apache2…(no debugging symbols found)…done.
(gdb) r -X
Starting program: /usr/sbin/apache2 -X
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".

念のため別コンソールからシングル プロセス モードになっているかを確認します。

john@ubuntu14041:~/mod_clover$ ps -ef | grep apache
root     18173  1376  0 17:41 pts/0    00:00:00 sudo apachectl debug
root     18174 18173  0 17:41 pts/0    00:00:00 /bin/sh /usr/sbin/apachectl debug
root     18176 18174  1 17:41 pts/0    00:00:00 gdb /usr/sbin/apache2
www-data 18178 18176  0 17:41 pts/0    00:00:00 /usr/sbin/apache2 -X
john     18183  3010  0 17:42 pts/2    00:00:00 grep –color=auto apache

プロセス名は apache2 なので、任意のタイミングでブレークさせるときは以下のコマンドを実行します。

john@ubuntu14041:~/mod_clover$ sudo killall -SIGTRAP apache2

マルチスレッド モデルではないため、ソースからビルドした Apache と異なり、デバッガーのコンソール上で Ctrl-C を押してもブレーク/再開させることができます。

^C
Program received signal SIGINT, Interrupt.
0x00007ffff725b573 in __epoll_wait_nocancel () at ../sysdeps/unix/syscall-template.S:81
81      in ../sysdeps/unix/syscall-template.S
(gdb) c
Continuing.

デバッガーの準備ができたところで、mod_clover のハンドラーでブレークさせます。

(gdb) i functions clover
All functions matching regular expression "clover":

File mod_clover.c:
static apr_status_t clover_handler(ap_filter_t *, apr_bucket_brigade *);
static void clover_register_hooks(apr_pool_t *);
(gdb) break clover_handler
Breakpoint 1 at 0x7ffff1827030: file mod_clover.c, line 220.
(gdb) c
Continuing.

(ブラウザーから http://11.10.90.10/?t=1&m=9 にアクセス)

Breakpoint 1, clover_handler (f=0x7fffec22d308, bb=0x7fffec22d9f0) at mod_clover.c:220
220     static apr_status_t clover_handler(ap_filter_t *f, apr_bucket_brigade *bb) {
(gdb) bt
#0  clover_handler (f=0x7fffec22d308, bb=0x7fffec22d9f0) at mod_clover.c:220
#1  0x00007ffff4ca2194 in ?? () from /usr/lib/apache2/modules/mod_filter.so
#2  0x00007ffff54c7841 in ?? () from /usr/lib/apache2/modules/mod_deflate.so
#3  0x00007ffff4ca2194 in ?? () from /usr/lib/apache2/modules/mod_filter.so
#4  0x000055555559a0af in ?? ()
#5  0x00005555555aa680 in ap_run_handler ()
#6  0x00005555555aabc9 in ap_invoke_handler ()
#7  0x00005555555c016a in ap_process_async_request ()
#8  0x00005555555c0444 in ap_process_request ()
#9  0x00005555555bcf02 in ?? ()
#10 0x00005555555b3cc0 in ap_run_process_connection ()
#11 0x00007ffff4896767 in ?? () from /usr/lib/apache2/modules/mod_mpm_prefork.so
#12 0x00007ffff489696c in ?? () from /usr/lib/apache2/modules/mod_mpm_prefork.so
#13 0x00007ffff48976b1 in ?? () from /usr/lib/apache2/modules/mod_mpm_prefork.so
#14 0x000055555559169e in ap_run_mpm ()
#15 0x000055555558ae36 in main ()

ハンドラーは呼ばれているようです。デバッグ情報がないのでシンボル名は ?? になっていますが、mod_clover が呼ばれる前に、mod_deflate フィルターの処理が実行されているのが見えます。mod_deflate は圧縮を行うフィルターなので、mod_clover に流れてくるデータがテキストではなく圧縮されたデータになっていて、正しく処理できていない、ということが予想できます。

フィルターの順番を入れ替える前に、実際にどのようなデータが来ているのかをデバッガーから確認します。

mod_clover の処理は、流れてくる bucket brigade を行単位に再構成し、正規表現にマッチした行を置き換えるという動作になっています。apr_brigade_pflatten 関数によって 1 行分の文字列を作成しているので、この関数が返す文字列を見てみます。

gdb の操作に慣れるため、あえて最適化されたコードのままデバッグを行ない、アセンブリ言語をベースにコードを追いかけることにします。行番号があまり当てにならないので、disassemble で clover_handler をダンプしてどこでブレークさせるかを考えます。以下は apr_brigade_pflatten 呼び出しのあたりを抜き出したものです。

0x00007ffff1827134 <+260>:   e9 dc 00 00 00  jmpq   0x7ffff1827215 <clover_handler+485>
0x00007ffff1827139 <+265>:   0f 1f 80 00 00 00 00    nopl   0x0(%rax)
0x00007ffff1827140 <+272>:   48 8b 45 08     mov    0x8(%rbp),%rax
0x00007ffff1827144 <+276>:   48 8b 55 00     mov    0x0(%rbp),%rdx
0x00007ffff1827148 <+280>:   48 8b 7b 08     mov    0x8(%rbx),%rdi
0x00007ffff182714c <+284>:   48 89 10        mov    %rdx,(%rax)
0x00007ffff182714f <+287>:   48 8b 45 00     mov    0x0(%rbp),%rax
0x00007ffff1827153 <+291>:   48 8b 55 08     mov    0x8(%rbp),%rdx
0x00007ffff1827157 <+295>:   48 89 50 08     mov    %rdx,0x8(%rax)
0x00007ffff182715b <+299>:   48 8d 47 08     lea    0x8(%rdi),%rax
0x00007ffff182715f <+303>:   48 89 45 00     mov    %rax,0x0(%rbp)
0x00007ffff1827163 <+307>:   48 8b 47 10     mov    0x10(%rdi),%rax
0x00007ffff1827167 <+311>:   48 89 45 08     mov    %rax,0x8(%rbp)
0x00007ffff182716b <+315>:   48 8b 47 10     mov    0x10(%rdi),%rax
0x00007ffff182716f <+319>:   48 89 28        mov    %rbp,(%rax)
0x00007ffff1827172 <+322>:   48 89 6f 10     mov    %rbp,0x10(%rdi)
0x00007ffff1827176 <+326>:   48 c7 44 24 50 00 00 00 00      movq   $0x0,0x50(%rsp)
0x00007ffff182717f <+335>:   48 8b 4b 10     mov    0x10(%rbx),%rcx
0x00007ffff1827183 <+339>:   48 8b 54 24 10  mov    0x10(%rsp),%rdx
0x00007ffff1827188 <+344>:   4c 89 f6        mov    %r14,%rsi
0x00007ffff182718b <+347>:   e8 10 fb ff ff  callq  0x7ffff1826ca0 <apr_brigade_pflatten@plt>
0x00007ffff1827190 <+352>:   85 c0   test   %eax,%eax
0x00007ffff1827192 <+354>:   0f 85 78 02 00 00       jne    0x7ffff1827410 <clover_handler+992>
0x00007ffff1827198 <+360>:   8b 53 38        mov    0x38(%rbx),%edx
0x00007ffff182719b <+363>:   45 31 ff        xor    %r15d,%r15d
0x00007ffff182719e <+366>:   85 d2   test   %edx,%edx
0x00007ffff18271a0 <+368>:   0f 84 ea 01 00 00       je     0x7ffff1827390 <clover_handler+864>
0x00007ffff18271a6 <+374>:   8b 43 3c        mov    0x3c(%rbx),%eax
0x00007ffff18271a9 <+377>:   c7 43 38 01 00 00 00    movl   $0x1,0x38(%rbx)
0x00007ffff18271b0 <+384>:   85 c0   test   %eax,%eax
0x00007ffff18271b2 <+386>:   0f 84 80 01 00 00       je     0x7ffff1827338 <clover_handler+776>
0x00007ffff18271b8 <+392>:   48 8b 74 24 58  mov    0x58(%rsp),%rsi
0x00007ffff18271bd <+397>:   49 8b 44 24 18  mov    0x18(%r12),%rax
0x00007ffff18271c2 <+402>:   4d 85 ff        test   %r15,%r15
0x00007ffff18271c5 <+405>:   4c 89 ff        mov    %r15,%rdi
0x00007ffff18271c8 <+408>:   48 0f 44 7c 24 60       cmove  0x60(%rsp),%rdi
0x00007ffff18271ce <+414>:   48 8b 40 08     mov    0x8(%rax),%rax
0x00007ffff18271d2 <+418>:   48 8b 90 80 00 00 00    mov    0x80(%rax),%rdx
0x00007ffff18271d9 <+425>:   e8 f2 fa ff ff  callq  0x7ffff1826cd0 <apr_bucket_transient_create@plt>

x64 Linux の呼び出し規約は、System V Application Binary Interface (ABI) として定義されています。仕様は ↓ にあります。

AMD64 Documentation
http://www.x86-64.org/documentation.html

"Figure 3.4: Register Usage" の図にパラメーターを渡す時に使われるレジスターの一覧があります。整数の場合、rdi -> rsi -> rdx -> rcx -> r8 -> r9 の順番で使われるようです。何これ Windows と全然違う・・・

デバッガーに戻り、今回確認したい文字列は第二パラメーターの linestr なので、rsi レジスターに入るはずです。デバッグ時のログはこんな感じ・・

(gdb) break *0x00007ffff182718b
Breakpoint 3 at 0x7ffff182718b: file mod_clover.c, line 295.
(gdb) c
Continuing.

(ブラウザーから http://11.10.90.10/?t=1&m=9 にアクセス)

Breakpoint 3, 0x00007ffff182718b in clover_handler (f=0x7fffec22f308, bb=0x7fffec22f9f0)
    at mod_clover.c:295
295                             status = apr_brigade_pflatten(context->snippets, &linestr, &linelength, context->subpool);
(gdb) i r r14 rsi
r14            0x7fffffffde20   140737488346656
rsi            0x7fffffffde20   140737488346656
(gdb) x/g 0x7fffffffde20
0x7fffffffde20: 0x0000000000000000
(gdb) ni
296                             if ( status!=APR_SUCCESS ) {
(gdb) i r eax
eax            0x0      0
(gdb) i r r14 rsi
r14            0x7fffffffde20   140737488346656
rsi            0x7fffec222056   140737155047510
(gdb) x/g $r14
0x7fffffffde20: 0x00007fffec2260a8
(gdb) p linestr
$1 = 0x7fffec2260a8 "37\213\b"
(gdb) x/s 0x00007fffec2260a8
0x7fffec2260a8: "37\213\b"
(gdb) x/8x 0x00007fffec2260a8
0x7fffec2260a8: 0x1f    0x8b    0x08    0x00    0x00    0x00    0x00    0x00
(gdb) c
Continuing.

Breakpoint 3, 0x00007ffff182718b in clover_handler (f=0x7fffec22f308, bb=0x7fffec22f9f0)
    at mod_clover.c:295
295                             status = apr_brigade_pflatten(context->snippets, &linestr, &linelength, context->subpool);
(gdb) ni
296                             if ( status!=APR_SUCCESS ) {
(gdb) x/g $r14
0x7fffffffde20: 0x00007fffec2262b0
(gdb) x/8b 0x00007fffec2262b0
0x7fffec2262b0: 0xbe    0x00    0x65    0x22    0x30    0x2a    0x53    0x85
(gdb) p linestr
$2 = 0x7fffec2262b0 "\276"
(gdb)

青字で示した行が、mod_deflate から流れてきたデータです。確かに文字列ではありません。念のため Network Monitor でパケットを確認すると、デバッガーに表示されているものと全く同じ 1F 8B 08 00 00 … で始まるバイナリ データが HTTP 応答として返ってきています。

image

というわけで、フィルター処理の順番として、mod_deflate の前に mod_clover を実行させる必要があります。

有効化されているモジュールのロード、及び初期設定パラメーターは、/etc/apache2/apache2.conf に記載されている IncludeOptional によってインクルードされるので、その前に mod_clover に関する設定を記述します。青字の 2 行を追加しました。000-default.conf からは、LoadModule と AddOutputFilterByType を消しておきます。

#
# LogLevel: Control the severity of messages logged to the error_log.
# Available values: trace8, …, trace1, debug, info, notice, warn,
# error, crit, alert, emerg.
# It is also possible to configure the log level for particular modules, e.g.
# "LogLevel info ssl:warn"
#
LogLevel warn

LoadModule clover_module /usr/lib/apache2/modules/mod_clover.so
AddOutputFilterByType CLOVER text/html

# Include module configuration:
IncludeOptional mods-enabled/*.load
IncludeOptional mods-enabled/*.conf

# Include list of ports to listen on
Include ports.conf

Apache を再起動し、http://11.10.90.10/?t=1&m=9 を開きます。今度は、DOCTYPE が HTML5、DocMode が IE9 になっており、mod_clover が意図通りに動いています。フィルターの順番を変えただけなので、HTTP 応答の圧縮も正しく行われています。

image

広告

Apache Output Filter and Bucket Brigade

Apache のフィルター モジュールを書きました。

参考にしたのは以下の情報。

データの入出力は、bucket brigade (バケツ リレー) という名前で呼ばれる双方向循環リストを通して行います。何だか Windows カーネルのようだ。これは Apache 1.x から 2 になったときに導入されたらしい。リストを使うことで、ストリームを途中で分割したり、長さの異なるデータに置換したりするのが楽になる、というのがメリットです。

書いたモジュールは以下の 2 つ。コーヒーとサンドイッチ。塩漬けになっていた GitHub を使ってみた。

サンドイッチの方は、上記参考 URL の最後にある apachetutor とほぼ同じ。完全なソースは ↓ で見つかりました。

mod_txt
http://apache.webthing.com/mod_txt/mod_txt.c

フィルターに限らず、Apache のモジュールを開発するときは apxs というツールを使うと便利です。実体は Perl スクリプトです。Apache をソースからビルドしたときは、bin フォルダーに apxs が入っています。

$ ls -l /usr/local/apache-httpd/current/bin
total 4448
-rwxr-xr-x 1 root root 1992139 Dec  3 23:36 ab
-rwxr-xr-x 1 john john    3537 Dec 22 21:51 apachectl
-rwxr-xr-x 1 john john   23533 Dec  3 23:19 apxs
-rwxr-xr-x 1 root root   13657 Dec  3 23:36 checkgid
-rwxr-xr-x 1 john john    8925 Dec  3 23:19 dbmmanage
-rw-rw-r– 1 john john    1109 Dec  3 23:19 envvars
-rw-rw-r– 1 john john    1109 Dec  3 23:19 envvars-std
-rwxr-xr-x 1 root root   24063 Dec  3 23:36 fcgistarter
-rwxr-xr-x 1 root root   80843 Dec  3 23:36 htcacheclean
-rwxr-xr-x 1 root root   51710 Dec  3 23:36 htdbm
-rwxr-xr-x 1 root root   25987 Dec  3 23:36 htdigest
-rwxr-xr-x 1 root root   51035 Dec  3 23:36 htpasswd
-rwxr-xr-x 1 root root 2149389 Dec  3 23:36 httpd
-rwxr-xr-x 1 root root   22250 Dec  3 23:36 httxt2dbm
-rwxr-xr-x 1 root root   25086 Dec  3 23:36 logresolve
-rwxr-xr-x 1 root root   45976 Dec  3 23:36 rotatelogs

apt-get した Apache に対して使うときは、apache2-dev というパッケージに入っているので、それを別途インストールして下さい。手元の Ubuntu だと、スクリプトは /usr/bin にできました。apxs2 というのは単なるシンボリックリンクです。

$ ls -l /usr/bin/apxs*
-rwxr-xr-x 1 root root 19761 Jul 22 07:36 /usr/bin/apxs
lrwxrwxrwx 1 root root     4 Jul 22 07:37 /usr/bin/apxs2 -> apxs

apxs コマンドの主な役割は 3 つです。

  • ソースコードのテンプレートの作成 = オプション -g
  • ビルド = オプション -c
  • Apache へのインストール = オプション -i

開発環境は以下の通り。

  • Ubuntu Server 14.04 LTS x64
  • Linux Kernel 3.13.0-24-generic
  • Apache httpd 2.4.10 (ソースからビルド)
  • gcc (Ubuntu 4.8.2-19ubuntu1) 4.8.2
  • GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1

まずは、テンプレートを作ります。モジュール名のディレクトリも apxs が作ります。

john@glycine:~$ /usr/local/apache-httpd/current/bin/apxs -g -n coffee
Creating [DIR]  coffee
Creating [FILE] coffee/Makefile
Creating [FILE] coffee/modules.mk
Creating [FILE] coffee/mod_coffee.c
Creating [FILE] coffee/.deps

mod_coffee.c が唯一のソース ファイルです。このファイルのコメントに書いてありますが、生成されたまま何も変更を加えない状態でも動作をテストできるのでやってみます。

apxs を使ってビルド、するわけですが、この後のデバッグでビルドとインストールコマンドを飽きるほど実行するので、スクリプトを作っておきます。もうちょっと汎用的なスクリプト書けよ、という突っ込みはなしの方向で (汗

john@glycine:~/coffee$ cat build.sh
/usr/local/apache-httpd/current/bin/apxs -c mod_coffee.c
john@glycine:~/coffee$ cat install.sh
/usr/local/apache-httpd/current/bin/apxs -i mod_coffee.la

ビルドします。

john@glycine:~/coffee$ ./build.sh
/usr/local/apr/apr-1.5.1/build-1/libtool –silent –mode=compile gcc -std=gnu99 -prefer-pic   -DLINUX -D_REENTRANT -D_GNU_SOURCE -g -O2 -pthread -I/usr/local/apache-httpd/httpd-2.4.10/include  -I/usr/local/apr/apr-1.5.1/include/apr-1   -I/usr/local/apr-util/apr-util-1.5.4/include/apr-1   -c -o mod_coffee.lo mod_coffee.c && touch mod_coffee.slo

/usr/local/apr/apr-1.5.1/build-1/libtool –silent –mode=link gcc -std=gnu99    -o mod_coffee.la  -rpath /usr/local/apache-httpd/httpd-2.4.10/modules -module -avoid-version    mod_coffee.lo

コンパイル エラーはなくビルドは上手くいったので、Apache にインストールします。root 権限が必要です。

john@glycine:~/coffee$ sudo ./install.sh
[sudo] password for john:
no talloc stackframe at ../source3/param/loadparm.c:4864, leaking memory
/usr/local/apache-httpd/httpd-2.4.10/build/instdso.sh SH_LIBTOOL=’/usr/local/apr/apr-1.5.1/build-1/libtool’ mod_coffee.la /usr/local/apache-httpd/httpd-2.4.10/modules
/usr/local/apr/apr-1.5.1/build-1/libtool –mode=install install mod_coffee.la /usr/local/apache-httpd/httpd-2.4.10/modules/
libtool: install: install .libs/mod_coffee.so /usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.so
libtool: install: install .libs/mod_coffee.lai /usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.la
libtool: install: install .libs/mod_coffee.a /usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.a
libtool: install: chmod 644 /usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.a
libtool: install: ranlib /usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.a
libtool: finish: PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/sbin" ldconfig -n /usr/local/apache-httpd/httpd-2.4.10/modules
———————————————————————-
Libraries have been installed in:
   /usr/local/apache-httpd/httpd-2.4.10/modules

If you ever happen to want to link against installed libraries
in a given directory, LIBDIR, you must either use libtool, and
specify the full pathname of the library, or use the `-LLIBDIR’
flag during linking and do at least one of the following:
   – add LIBDIR to the `LD_LIBRARY_PATH’ environment variable
     during execution
   – add LIBDIR to the `LD_RUN_PATH’ environment variable
     during linking
   – use the `-Wl,-rpath -Wl,LIBDIR’ linker flag
   – have your system administrator add LIBDIR to `/etc/ld.so.conf’

See any operating system documentation about shared libraries for
more information, such as the ld(1) and ld.so(8) manual pages.
———————————————————————-
chmod 755 /usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.so

これで、mod_coffee.so が Apache の modules ディレクトリに作られました。では httpd.conf を編集します。以下の 4 行を追加します。

LoadModule coffee_module modules/mod_coffee.so
<Location /coffee>
    SetHandler coffee
</Location>

最後に httpd を再起動して、ブラウザーで /coffee を開きます。"The sample page from…" という文字列が表示されれば成功です。

image

apxs コマンドでは、-c -i -a というように同時にオプションを指定すると、ビルド、インストール、設定ファイルへの LoadModule の追加を一気にやってくれます、が、実際にモジュールを開発するときは分けて実行した方がよさそうです。コンパイル エラー出まくるし・・。

apxs が生成したテンプレートはコンテンツ ハンドラーで、フィルターではありません。フィルターのテンプレートは作ってくれないので、自分で全部書かないといけません。ハンドラーとなるコールバック関数は、 coffee_register_hooks の中でap_hook_handler によって登録されていますが、これの代わりに ap_register_output_filter を使うと出力フィルターのコールバック関数を登録できます。

サーバーが応答するときに、ap_register_output_filter で登録したコールバック関数が前述の bucket brigade をパラメーターとして呼び出されます。bucket brigade が表現するストリーム データが HTTP 応答として送信されるデータになります。フィルターは、この bucket brigade を加工することができます。Apache は複数のフィルターを持つことができ、コールバック関数がパラメーターとして受け取る bucket brigade は、前のフィルターから渡されてきています。つまり、bucket brigade を受け取ったフィルターは、データを加工した後、次のフィルターに加工済みの bucket brigade を流すことでデータを出力したことになります。このあたりがバケツ リレーという名前の由来になっているのでしょう。

bucket brigade は双方向循環リストでありapr_bucket_brigade 構造体で表されます。リストの個々の要素はバケツと呼ばれ、apr_bucket 構造体で表されます。バケツには種類があり、メモリ上の BLOB を表す HEAP だけでなく、ディスク上のファイルを表す FILE、ストリームの末尾を表す EOS などがあります。EOS などのメタデータではなく、実データが入っているバケツからは、apr_bucket_read などの関数を使ってデータを char の配列として取り出すことができます。

フィルターは、入力データの bucket brigade に対して、バケツの分割や削除、新しいバケツの追加などを行うことができます。最終的には次のフィルターに対して bucket brigade の形でデータを流せばそれが応答になるので、次のフィルターに渡さなかったバケツはフィルターによって削除されたように見えます。次のフィルターに bucket brigade を渡すのは、ap_pass_brigade 関数で行います。渡すことができるのは bucket brigade であり、バケツ単体を渡すことはできません。

ここでポイントになるのは、上から流れてきたバケツ リレーと同じものを下のフィルターに渡す必要は全くないということです。フィルターの中で新たにリストの構造 (=apr_bucket_brigade) を作って、中のバケツを新たなリストに移動させて次のフィルターに渡しても全く問題ありません。元のバケツ リレーのリストからバケツを削除したとしても、次のフィルターに渡さない限りその構造は使われないためです。

mod_sed や mod_substitute のソースを見ると、コールバック関数の中で bucket brigade の中身を一つずつ読む大きなループを書くのが一般的なように見えます。このとき、次のフィルターに bucket brigade を渡す方法は 2 通り考えられます。ループの中で、バケツ毎に ap_pass_brigade を呼び出す方法、もしくは、ループの中では新しい bucket brigade にバケツを追加するだけにとどめ、ループの後でまとめて ap_pass_brigade を呼び出す方法です。どちらの方法でも構いませんが、後者の方法を取るときは、FLUSH バケツが来たときに、自分がバッファーしているバケツを即時に次のフィルターへ流す処理を実装しないといけません。

Guide to writing output filters – Apache HTTP Server Version 2.5
http://httpd.apache.org/docs/trunk/developer/output-filters.html

A FLUSH bucket indicates that the filter should flush any buffered buckets (if applicable) down the filter chain immediately.

例えば mod_substitute は前者の方法にしているので、以下のようなコメントがあります。

/*
* No need to handle FLUSH buckets separately as we call
* ap_pass_brigade anyway at the end of the loop.
*/

細かいことを挙げていくとキリがありませんが、以上が調べていて分かった bucket brigade の大体のイメージです。で、何のフィルターを書いたかというと、サンドイッチは、流れてきたデータを HTML ではなくテキストとして表示するためのフィルターで、コーヒーは、どんなバケツが流れてきているのかをコンソール、もしくはエラー ログに出力するためのフィルターです。

GitHub にあるコードをビルドして、Apache にインストールした後、httpd.conf に以下の設定を追加します。

AddOutputFilterByType SANDWICH text/html
Sandwich_Header "conf/header"
Sandwich_Footer "conf/footer"

AddOutputFilterByType Sed text/html
OutputSed "s/Welcome/WELCOME/g"

AddOutputFilterByType SUBSTITUTE text/html
Substitute "s/h3>/h2>/"

AddOutputFilterByType COFFEE text/html
Coffee_LogOption 1

mod_sandwich が使うヘッダーとフッターのファイルを作成します。

john@glycine:~$ cat /usr/local/apache-httpd/current/conf/header
<!DOCTYPE html><html><head></head><body><pre>

john@glycine:~$ cat /usr/local/apache-httpd/current/conf/footer
</pre></body></html>

index.html はこれを使います。

<!DOCTYPE html>
<html><head>
<meta http-equiv="x-ua-compatible" content="IE=8">
</head><body><h3>Welcome!</h3><p>This is a body text.</p></body></html>

httpd をデバッガーから起動してブラウザーでサーバーにアクセスすると、以下のように表示されます。

image

httpd.conf に設定したように、データは mod_sandwich –> mod_sed –> mod_substitute –> mod_coffee の順に処理されます。welcome は大文字に置換されますが、h3 エレメントは最初の mod_sandwich によって ">" がエスケープされているので置換されません。最後の mod_coffee によって、デバッガー上でには以下のようなログが出力されます。

ENTERING coffee_filter
Processing data bucket (len=46)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=27)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=25)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=87)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=140)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=21)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
LEAVING coffee_filter
ENTERING coffee_filter
Processing EOS bucket.
        ==> ap_pass_brigade returned 0
LEAVING coffee_filter

上記出力から、coffee_filter は 2 回呼び出されていることが分かります。ほとんどは 1 回目の呼び出し時に処理されていますが、EOS だけの bucket brigade が 2 回目の呼び出し時に流れてきています。一回のリクエストであっても、フィルターのコールバック関数が何回呼ばれるのかは、その他のフィルターなどの設定に依存します。

フィルターの多くは、入力データを見て、その内容に応じてデータを加工することになるはずです。例えばストリームの先頭の方のデータを見て、末尾の方のデータを変更する、となったときに、先頭のデータを元にする情報はどこかに保持していないといけません。しかし、コールバック関数が何度呼ばれるか分からない以上、それをコールバック関数のローカル変数として保持させるわけにはいきません。このため、多くのフィルターでは、コールバック関数のもう一つのパラメーターである ap_filter_t 構造体の ctx を使います。このポインターに、フィルター独自の構造体を割り当てておくことで、異なるタイミングで呼ばれたコールバック関数内でも一貫したデータを扱えるようになります。

デバッガーから、mod_coffee が呼ばれるときのコールスタックを見てみます。

(gdb) i functions coffee
All functions matching regular expression "coffee":

File mod_coffee.c:
static apr_status_t coffee_filter(ap_filter_t *, apr_bucket_brigade *);
static void coffee_register_hooks(apr_pool_t *);
(gdb) break coffee_filter
Breakpoint 1 at 0x7ffff3aacd30: file mod_coffee.c, line 95.
(gdb) command 1
Type commands for breakpoint(s) 1, one per line.
End with a line saying just "end".
>bt
>c
>end
(gdb) i break
Num     Type           Disp Enb Address            What
1       breakpoint     keep y   0x00007ffff3aacd30 in coffee_filter at mod_coffee.c:95
        bt
        c
(gdb) !touch /usr/local/apache-httpd/current/htdocs/index.html
(gdb) r -X
The program being debugged has been started already.
Start it from the beginning? (y or n) y
Starting program: /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -X
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
warning: Temporarily disabling breakpoints for unloaded shared library "/usr/local/apache-httpd/httpd-2.4.10/modules/mod_coffee.so"
[New Thread 0x7ffff306c700 (LWP 19607)]
...snip...
[New Thread 0x7fffe1feb700 (LWP 19633)]
[Thread 0x7ffff306c700 (LWP 19607) exited]
[Switching to Thread 0x7fffe27ec700 (LWP 19632)]

Breakpoint 1, coffee_filter (f=0x7fffdc008bf8, bb=0x7fffdc00a248) at mod_coffee.c:95
95      static apr_status_t coffee_filter(ap_filter_t *f, apr_bucket_brigade *bb) {
#0  coffee_filter (f=0x7fffdc008bf8, bb=0x7fffdc00a248) at mod_coffee.c:95
#1  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008bf8, bb=0x7fffdc00a248) at mod_filter.c:323
#2  0x00007ffff54f1bb5 in substitute_filter (f=0x7fffdc008bd0, bb=0x7fffdc00a0d0) at mod_substitute.c:511
#3  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008bd0, bb=0x7fffdc00a0d0) at mod_filter.c:323
#4  0x00007ffff52e81f6 in sed_response_filter (f=0x7fffdc008ba8, bb=0x7fffdc009040) at mod_sed.c:376
#5  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008ba8, bb=0x7fffdc009040) at mod_filter.c:323
#6  0x00007ffff38a9e6f in sandwich_filter_handler (filter=0x7fffdc008b80, bb=0x7fffdc009040) at mod_sandwich.c:165
#7  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008b80, bb=0x7fffdc009040) at mod_filter.c:323
#8  0x0000000000439f07 in default_handler (r=0x7fffdc002970) at core.c:4369
#9  0x000000000044a260 in ap_run_handler (r=0x7fffdc002970) at config.c:169
#10 0x000000000044a7a9 in ap_invoke_handler (r=r@entry=0x7fffdc002970) at config.c:433
#11 0x000000000045dd5a in ap_process_async_request (r=r@entry=0x7fffdc002970) at http_request.c:317
#12 0x000000000045ad70 in ap_process_http_async_connection (c=0x7fffec0372a0) at http_core.c:143
#13 ap_process_http_connection (c=0x7fffec0372a0) at http_core.c:228
#14 0x0000000000453580 in ap_run_process_connection (c=0x7fffec0372a0) at connection.c:41
#15 0x0000000000465d94 in process_socket (my_thread_num=24, my_child_num=0, cs=0x7fffec037218, sock=<optimized out>,
    p=<optimized out>, thd=<optimized out>) at event.c:1035
#16 worker_thread (thd=<optimized out>, dummy=<optimized out>) at event.c:1875
#17 0x00007ffff754e182 in start_thread (arg=0x7fffe27ec700) at pthread_create.c:312
#18 0x00007ffff727afbd in clone () at ../sysdeps/unix/sysv/linux/x86_64/clone.S:111
ENTERING coffee_filter
Processing data bucket (len=46)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=27)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=25)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=87)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=140)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=21)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
LEAVING coffee_filter

Breakpoint 1, coffee_filter (f=0x7fffdc008bf8, bb=0x7fffdc00a248) at mod_coffee.c:95
95      static apr_status_t coffee_filter(ap_filter_t *f, apr_bucket_brigade *bb) {
#0  coffee_filter (f=0x7fffdc008bf8, bb=0x7fffdc00a248) at mod_coffee.c:95
#1  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008bf8, bb=0x7fffdc00a248) at mod_filter.c:323
#2  0x00007ffff54f1bb5 in substitute_filter (f=0x7fffdc008bd0, bb=0x7fffdc00a0d0) at mod_substitute.c:511
#3  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008bd0, bb=0x7fffdc00a0d0) at mod_filter.c:323
#4  0x00007ffff52e81f6 in sed_response_filter (f=0x7fffdc008ba8, bb=0x7fffdc009040) at mod_sed.c:376
#5  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008ba8, bb=0x7fffdc009040) at mod_filter.c:323
#6  0x00007ffff38a9e6f in sandwich_filter_handler (filter=0x7fffdc008b80, bb=0x7fffdc009040) at mod_sandwich.c:165
#7  0x00007ffff56f6194 in filter_harness (f=0x7fffdc008b80, bb=0x7fffdc009040) at mod_filter.c:323
#8  0x0000000000439f07 in default_handler (r=0x7fffdc002970) at core.c:4369
#9  0x000000000044a260 in ap_run_handler (r=0x7fffdc002970) at config.c:169
---Type <return> to continue, or q <return> to quit---
#10 0x000000000044a7a9 in ap_invoke_handler (r=r@entry=0x7fffdc002970) at config.c:433
#11 0x000000000045dd5a in ap_process_async_request (r=r@entry=0x7fffdc002970) at http_request.c:317
#12 0x000000000045ad70 in ap_process_http_async_connection (c=0x7fffec0372a0) at http_core.c:143
#13 ap_process_http_connection (c=0x7fffec0372a0) at http_core.c:228
#14 0x0000000000453580 in ap_run_process_connection (c=0x7fffec0372a0) at connection.c:41
#15 0x0000000000465d94 in process_socket (my_thread_num=24, my_child_num=0, cs=0x7fffec037218, sock=<optimized out>,
    p=<optimized out>, thd=<optimized out>) at event.c:1035
#16 worker_thread (thd=<optimized out>, dummy=<optimized out>) at event.c:1875
#17 0x00007ffff754e182 in start_thread (arg=0x7fffe27ec700) at pthread_create.c:312
#18 0x00007ffff727afbd in clone () at ../sysdeps/unix/sysv/linux/x86_64/clone.S:111
ENTERING coffee_filter
Processing EOS bucket.
        ==> ap_pass_brigade returned 0
LEAVING coffee_filter

4 つのフィルターが、httpd.conf に設定した通りの順で呼ばれていることが分かります。行番号を見ると、フィルターから ap_pass_brigade を呼び出すことで filter_harness が呼ばれ、次のフィルターのコールバック関数に繋がることが分かります。

次にフィルターの順番を入れ替えます。mod_coffee を mod_sandwich の直後にしました。

AddOutputFilterByType SANDWICH text/html
Sandwich_Header "conf/header"
Sandwich_Footer "conf/footer"

AddOutputFilterByType COFFEE text/html
Coffee_LogOption 1

AddOutputFilterByType Sed text/html
OutputSed "s/Welcome/WELCOME/g"

AddOutputFilterByType SUBSTITUTE text/html
Substitute "s/h3>/h2>/"

ブラウザーから見たときの出力結果は変わりませんが、mod_coffee によるコンソール出力がかなり長くなります。

ENTERING coffee_filter
Processing data bucket (len=47)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=0)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=8)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=6)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=1)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
(..snip..)
Processing data bucket (len=0)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=5)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=0)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=5)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=4)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=2)
        ==> ap_pass_brigade returned 0
Processing data bucket (len=22)
        ==> ap_pass_brigade returned 0
Processing EOS bucket.
        ==> ap_pass_brigade returned 0
LEAVING coffee_filter

出力が長くなる理由は、mod_sandwich が特殊文字をエスケープするたびにバケツを分割しているためです。例えば上記のうち、len=4 となっているバケツは &gt; か &lt; という 4 文字の文字列と考えられます。しかし、先ほどと違って coffee_filter は一度しか呼ばれません。mod_sed か mod_substitute のどちらかが、細々に分割されたバケツをある程度繋げたのだと判断できます。

Apache Live-Debugging on Linux

数ヶ月前、初めて仕事で必要になって、オープンソースのソフトをちょこちょこっと改変してビルドして使うという機会がありました。Windows ばっかり使っているとだめですね。弄ったのは openssl のコードで、それを元に Apache の mod_ssl を動かしたのですが、そのときは Apache のデバッグ方法がよく分からず、勉強に費やす時間もなかったので printf を書きまくる力技で何とか目的の動作を実現させました。が、複雑なことをやろうとすると、デバッガーを繋いで変数を見たり、コールスタックを見たりする必要が出てきます。後日、その方法を一通り覚えたのでまとめておこうと思います。

自作のモジュールをデバッグするだけなら、apache 本体は apt-get したものを使えば一応事足ります。しかし多くの場合は apache 内部の変数や関数を見たくなる時もありそうなので、apache 本体のデバッグ情報も得るため、全部ソースからビルドしておきます。自分用のメモも兼ねてその手順から。

Linux 初心者としてけっこう困るのが、ディレクトリーの使い分け方。複数の流派があって、どこに何を置けばいいのか決められない。最近は統一しようという動きがあるみたいですが。プログラムをソースからビルドしてインストールする際、以下のブログに書かれているルールが明確でいい感じだったので、真似させてもらうことにしました。

Apache 2.4をソースからインストール – Starlight
http://d.hatena.ne.jp/Kazuhira/20121117/1353159552

/usr/local/[ソフトウェア名]/[ソフトウェア名-Version]
/usr/local/[ソフトウェア名]/current  # 現在使用中のバージョンへのシンボリックリンク

環境はこちら。Hyper-V 上の仮想マシンですが、だからといって特別なことはありません。

  • Ubuntu Server 14.04 LTS x64
  • Linux Kernel 3.13.0-24-generic
  • gcc (Ubuntu 4.8.2-19ubuntu1) 4.8.2
  • GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1

gcc と gdb を apt-get するコマンドはこれ。

$ sudo apt-get install build-essential libtool manpages-dev gdb

将来使いそうなので、OpenSSL もビルドしておきます。依存関係を考慮すると、必要なモジュールは以下の通り。

名前 URL バージョン
(2014/12 での最新)
依存関係
OpenSSL http://www.openssl.org/source/ 1.0.1j なし
APR (=Apache Portal Runtime) http://apr.apache.org/download.cgi 1.5.1 なし
APR-util http://apr.apache.org/download.cgi 1.5.4 APR
PCRE
(= Perl Compatible Regular Expressions)
http://pcre.org/ 8.36 なし
Apache http://httpd.apache.org/download.cgi 2.4.10 APR
APR-util
PCRE
OpenSSL

 

ソースからビルドすると言っても、実はとても簡単で、configure で Makefile を作って、make でビルドして、sudo make install でインストールするだけです。どうやらこれを "configure-make-make install dance" というようです。configure を実行するところで、インストール ディレクトリや、コンパイル オプション、リンカ オプションなどをいろいろ指定できます。

冒頭で決めたルールに従って、実行したコマンドを載せておきます。なお、ソースは全部 /usr/src にダウンロードして、そのまま同じところに解凍しました。

まずは OpenSSL から。configure のときに -fPIC オプションをつけないと、Apache のビルドの時にエラーが出るので注意。

$ wget http://www.openssl.org/source/openssl-1.0.1j.tar.gz
$ tar -zxvf openssl-1.0.1j.tar.gz
$ cd openssl-1.0.1j/
$ ./config –prefix=/usr/local/openssl/openssl-1.0.1j -fPIC
$ make
$ sudo make install
$ sudo ln -s /usr/local/openssl/openssl-1.0.1j /usr/local/openssl/current

Ubuntu 12.04 には、もともと OpenSSL 1.0.1f が /usr/bin に入っているので、ビルドした 1.0.1j へのシンボリックリンクで置き換えておきます。

$ openssl version
OpenSSL 1.0.1f 6 Jan 2014

$ sudo mv /usr/bin/openssl /usr/bin/openssl-1.0.1f
$ sudo ln /usr/local/openssl/current/bin/openssl /usr/bin/openssl

john@glycine:/usr/src/openssl-1.0.1j$ openssl version
OpenSSL 1.0.1j 15 Oct 2014

次、APR。

$ wget http://apache.mesi.com.ar/apr/apr-1.5.1.tar.gz
$ tar -zxvf apr-1.5.1.tar.gz
$ cd apr-1.5.1/
$ ./configure –prefix=/usr/local/apr/apr-1.5.1
$ make
$ sudo make install
$ sudo ln -s /usr/local/apr/apr-1.5.1 /usr/local/apr/current

次は APR-util。APR のディレクトリを指定するときに、シンボリックリンクの current を使っています。

$ wget http://apache.claz.org/apr/apr-util-1.5.4.tar.gz
$ tar -zxvf apr-util-1.5.4.tar.gz
$ cd apr-util-1.5.4/
$ ./configure –prefix=/usr/local/apr-util/apr-util-1.5.4 \
> –with-apr=/usr/local/apr/current
$ make
$ sudo make install
$ sudo ln -s /usr/local/apr-util/apr-util-1.5.4 /usr/local/apr-util/current

次は PCRE。

$ wget ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-8.36.tar.gz
$ tar -zxvf pcre-8.36.tar.gz
$ cd pcre-8.36/
$ ./configure –prefix=/usr/local/pcre/pcre-8.36
$ make
$ sudo make install
$ sudo ln -s /usr/local/pcre/pcre-8.36 /usr/local/pcre/current

ここまででハマるポイントはありませんでした。ではいよいよ Apache のビルドです。これまでに作ったモジュールのパスを全部指定します。また、mod_so、mod_ssl、mod_rewrite をデフォルトで有効にしておきます。何となくです。

$ wget http://apache.mesi.com.ar/httpd/httpd-2.4.10.tar.gz
$ tar -zxvf httpd-2.4.10.tar.gz
$ cd httpd-2.4.10/
$ ./configure –prefix=/usr/local/apache-httpd/httpd-2.4.10 \
> –with-apr=/usr/local/apr/current \
> –with-apr-util=/usr/local/apr-util/current \
> –with-pcre=/usr/local/pcre/current \
> –with-ssl=/usr/local/openssl/current \
> –enable-so \
> –enable-ssl \
> –enable-rewrite
$ make 
$ sudo make install
$ sudo ln -s /usr/local/apache-httpd/httpd-2.4.10 /usr/local/apache-httpd/current

$ sudo /usr/local/apache-httpd/current/bin/apachectl -V
Server version: Apache/2.4.10 (Unix)
Server built:   Dec  3 2014 23:31:13
Server’s Module Magic Number: 20120211:36
Server loaded:  APR 1.5.1, APR-UTIL 1.5.4
Compiled using: APR 1.5.1, APR-UTIL 1.5.4
Architecture:   64-bit
Server MPM:     event
  threaded:     yes (fixed thread count)
    forked:     yes (variable process count)
Server compiled with….
-D APR_HAS_SENDFILE
-D APR_HAS_MMAP
-D APR_HAVE_IPV6 (IPv4-mapped addresses enabled)
-D APR_USE_SYSVSEM_SERIALIZE
-D APR_USE_PTHREAD_SERIALIZE
-D SINGLE_LISTEN_UNSERIALIZED_ACCEPT
-D APR_HAS_OTHER_CHILD
-D AP_HAVE_RELIABLE_PIPED_LOGS
-D DYNAMIC_MODULE_LIMIT=256
-D HTTPD_ROOT="/usr/local/apache-httpd/httpd-2.4.10"
-D SUEXEC_BIN="/usr/local/apache-httpd/httpd-2.4.10/bin/suexec"
-D DEFAULT_PIDLOG="logs/httpd.pid"
-D DEFAULT_SCOREBOARD="logs/apache_runtime_status"
-D DEFAULT_ERRORLOG="logs/error_log"
-D AP_TYPES_CONFIG_FILE="conf/mime.types"
-D SERVER_CONFIG_FILE="conf/httpd.conf"

OpenSSL のところで触れましたが、OpenSSL は -fPIC オプションをつけてコンパイルしないといけません。PIC とは、Position Independent Code の略です。

Position-independent code – Wikipedia, the free encyclopedia
http://en.wikipedia.org/wiki/Position-independent_code

もし、PIC なしで OpenSSL をコンパイルすると、Apache のビルド時に以下のエラーが出ます。この場合、OpenSSL を make clean して configure から実行し直せば問題なしです。

/usr/bin/ld: /usr/local/openssl/current/lib/libssl.a(s3_srvr.o): relocation R_X86_64_32 against `.rodata’ can not be used when making a shared object; recompile with -fPIC
/usr/local/openssl/current/lib/libssl.a: error adding symbols: Bad value
collect2: error: ld returned 1 exit status

無事に Apache がビルドできたら、念のため httpd.conf のバックアップを取り、とりあえず起動してみます。起動は bin に入っている apachectl というスクリプトを使うと楽です。実行可能ファイルの実体は httpd というファイルです。AH00558 という警告は、httpd.conf の ServerName オプションに適当な名前を指定すれば発生しなくなります。

john@glycine:~$ sudo /usr/local/apache-httpd/current/bin/apachectl start
AH00558: httpd: Could not reliably determine the server’s fully qualified domain name, using 127.0.1.1. Set the ‘ServerName’ directive globally to suppress this message
john@glycine:~$ ps -ef | grep
Usage: grep [OPTION]… PATTERN [FILE]…
Try ‘grep –help’ for more information.
john@glycine:~$ ps -ef | grep apache
root      1195     1  0 22:16 ?        00:00:00 /usr/sbin/apache2 -k start
www-data  1198  1195  0 22:16 ?        00:00:01 /usr/sbin/apache2 -k start
www-data  1199  1195  0 22:16 ?        00:00:01 /usr/sbin/apache2 -k start
root     10953     1  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
daemon   10954 10953  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
daemon   10955 10953  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
daemon   10956 10953  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
john     11041  1431  0 23:43 pts/1    00:00:00 grep –color=auto apache
john@glycine:~$

ブラウザで見ると、"It works!" というテキストのみのページが表示されます。これは htdocs にある index.html です。

image

 

これで Apache が起動できるようになりました。次に、モジュールをデバッグする手順です。どのモジュールでもいいのですが、後でやろうとしていることの都合上、ここではフィルターの一つであるmod_sed モジュールをデバッグします。なぜかヘルプのページが Apache 2.5 になっている・・。

mod_sed – Apache HTTP Server Version 2.5
http://httpd.apache.org/docs/trunk/mod/mod_sed.html

httpd.conf に mod_sed の設定を追加します。まず、元のファイルに以下の行がコメントアウトされているはずなので、行の先頭の # を消します。

LoadModule sed_module modules/mod_sed.so

次に、適当な Directory セクションを追加するなり、元からあるものを選ぶなりして、以下の 2 行 (青字) を追加します。

<Directory "/usr/local/apache-httpd/httpd-2.4.10/htdocs">
(snip)

    #
    # Controls who can get stuff from this server.
    #
    Require all granted

    AddOutputFilter Sed html
    OutputSed "s/HERE/Hello/g"

</Directory>

最後に、htdocs/index.html を適当に書き換えます。

<!DOCTYPE html>
<html>
<head>
</head>
<body>
<h3>HERE</h3>
<p>This is a body text.</p>
</body>
</html>

mod_sed が正常に動作するかどうかを確認するため、httpd を再起動してブラウザーで開きます。

john@glycine:~$ sudo /usr/local/apache-httpd/current/bin/apachectl -k stop
john@glycine:~$ sudo /usr/local/apache-httpd/current/bin/apachectl -k start
john@glycine:~$ ps -ef | grep apache
john      2357  1490  0 23:37 pts/1    00:00:00 vi /usr/local/apache-httpd/current/conf/httpd.conf
root      2491     1  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
daemon    2492  2491  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
daemon    2493  2491  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
daemon    2494  2491  0 23:43 ?        00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -k start
john      2577  1406  0 23:43 pts/0    00:00:00 grep –color=auto apache
john@glycine:~$

見出しの HERE が mod_sed によって Hello に置換されているのが分かります。

image

さて、いよいよ httpd に gdb をアタッチするわけですが、上記 ps -ef コマンドを見る限り、httpd のプロセスが複数起動されています。詳しくは知りませんが、並列処理のためにプロセスをフォークして複数プロセスで要求を処理するのでしょう。これだと、要求が来たときにどのプロセスで処理されるのかが分からないので、不可能ではありませんが、デバッグが面倒くさくなりそうです。Apache には、デバッグ用のためのシングル プロセス モードが用意されているのでそれを使います。httpd の実行時に -X オプションをつければデバッグ モードになります。

Apache を gdb でデバッグするときの公式のガイドが ↓ にあります。

Apache HTTPD Debugging Guide – The Apache HTTP Server Project
http://httpd.apache.org/dev/debugging.html

では実際にやってみます。

john@glycine:~$ sudo gdb /usr/local/apache-httpd/current/bin/httpd
GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1
Copyright (C) 2014 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <
http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "x86_64-linux-gnu".
Type "show configuration" for configuration details.
For bug reporting instructions, please see:
<
http://www.gnu.org/software/gdb/bugs/>.
Find the GDB manual and other documentation resources online at:
<
http://www.gnu.org/software/gdb/documentation/>.
For help, type "help".
Type "apropos word" to search for commands related to "word"…
Reading symbols from /usr/local/apache-httpd/current/bin/httpd…done.
(gdb) r -X
Starting program: /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -X
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
[New Thread 0x7ffff3676700 (LWP 2776)]
[New Thread 0x7ffff2e75700 (LWP 2777)]
[New Thread 0x7ffff2674700 (LWP 2778)]
[New Thread 0x7ffff1e73700 (LWP 2779)]
[New Thread 0x7ffff1672700 (LWP 2780)]
[New Thread 0x7ffff0e71700 (LWP 2781)]
[New Thread 0x7fffebfff700 (LWP 2782)]
[New Thread 0x7fffeb7fe700 (LWP 2783)]
[New Thread 0x7fffeaffd700 (LWP 2784)]
[New Thread 0x7fffea7fc700 (LWP 2785)]
[New Thread 0x7fffe9ffb700 (LWP 2786)]
[New Thread 0x7fffe97fa700 (LWP 2787)]
[New Thread 0x7fffe8ff9700 (LWP 2788)]
[New Thread 0x7fffe87f8700 (LWP 2789)]
[New Thread 0x7fffe7ff7700 (LWP 2790)]
[New Thread 0x7fffe77f6700 (LWP 2791)]
[New Thread 0x7fffe6ff5700 (LWP 2792)]
[New Thread 0x7fffe67f4700 (LWP 2793)]
[New Thread 0x7fffe5ff3700 (LWP 2794)]
[New Thread 0x7fffe57f2700 (LWP 2795)]
[New Thread 0x7fffe4ff1700 (LWP 2796)]
[New Thread 0x7fffe47f0700 (LWP 2797)]
[New Thread 0x7fffe3fef700 (LWP 2798)]
[New Thread 0x7fffe37ee700 (LWP 2799)]
[New Thread 0x7fffe2fed700 (LWP 2800)]
[New Thread 0x7fffe27ec700 (LWP 2801)]
[New Thread 0x7fffe1feb700 (LWP 2802)]
[Thread 0x7ffff3676700 (LWP 2776) exited]

スレッドが大量に作られました。別のコンソール セッションからプロセスを確認すると、確かに httpd のインスタンスは 1 つだけです。

john@glycine:~$ ps -ef | grep httpd
root      2769  1406  0 23:58 pts/0    00:00:00 sudo gdb /usr/local/apache-httpd/current/bin/httpd
root      2770  2769  0 23:58 pts/0    00:00:00 gdb /usr/local/apache-httpd/current/bin/httpd
daemon    2772  2770  0 23:58 pts/0    00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -X
john      2805  1490  0 23:59 pts/1    00:00:00 grep –color=auto httpd

ブラウザーからページを開けるので、サーバーとして問題はなさそうです。さて、ここからやりたいことは当然、ブレークさせてブレークポイントを設定することです。が、ここからの手順が若干トリッキー、というかあまり情報がありませんでした。

普通は、デバッガー上でキーボードから Ctrl-C なり Ctrl-Break を押してブレークさせます。実際にやるとこうなります。sed_response_filter は mod_sed 内の関数です。

^C <<<< デバッガー上で Ctrl-C
[Thread 0x7fffe37ee700 (LWP 2799) exited]
[Thread 0x7fffe2fed700 (LWP 2800) exited]

Program received signal SIGHUP, Hangup.
[Switching to Thread 0x7fffe1feb700 (LWP 2802)]
0x00007ffff727b653 in epoll_wait () at ../sysdeps/unix/syscall-template.S:81
81      ../sysdeps/unix/syscall-template.S: No such file or directory.
(gdb) i functions sed_response_filter
All functions matching regular expression "sed_response_filter":

File mod_sed.c:
static apr_status_t sed_response_filter(ap_filter_t *, apr_bucket_brigade *);
(gdb) break sed_response_filter
Breakpoint 1 at 0x7ffff54ec0a0: file mod_sed.c, line 269.
(gdb) c
Continuing.
[Thread 0x7ffff2674700 (LWP 2778) exited]
[Thread 0x7fffe1feb700 (LWP 2802) exited]
[Thread 0x7fffe4ff1700 (LWP 2796) exited]
[Thread 0x7fffe27ec700 (LWP 2801) exited]
[Thread 0x7fffe7ff7700 (LWP 2790) exited]
[Thread 0x7fffe3fef700 (LWP 2798) exited]
[Thread 0x7ffff0e71700 (LWP 2781) exited]
[Thread 0x7fffe47f0700 (LWP 2797) exited]
[Thread 0x7fffe9ffb700 (LWP 2786) exited]
[Thread 0x7fffe57f2700 (LWP 2795) exited]
[Thread 0x7fffe97fa700 (LWP 2787) exited]
[Thread 0x7fffe5ff3700 (LWP 2794) exited]
[Thread 0x7fffe6ff5700 (LWP 2792) exited]
[Thread 0x7fffe67f4700 (LWP 2793) exited]
[Thread 0x7ffff1672700 (LWP 2780) exited]
[Thread 0x7fffe77f6700 (LWP 2791) exited]
[Thread 0x7ffff2e75700 (LWP 2777) exited]
[Thread 0x7fffe87f8700 (LWP 2789) exited]
[Thread 0x7ffff1e73700 (LWP 2779) exited]
[Thread 0x7fffe8ff9700 (LWP 2788) exited]
[Thread 0x7fffeb7fe700 (LWP 2783) exited]
[Thread 0x7fffea7fc700 (LWP 2785) exited]
[Thread 0x7fffebfff700 (LWP 2782) exited]
[Thread 0x7fffeaffd700 (LWP 2784) exited]
[Inferior 1 (process 2772) exited normally]
(gdb) c
The program is not being run.
(gdb)

ブレークポイントは問題なくセットできましたが、continue した瞬間にスレッドが全部死にました。というか Ctrl-C のときに既にスレッド 2799 と 2800 が死んでいて、たぶんこれが原因です。この後、continue は不可能になってしまいました。run -X をもう一度実行して新たにプロセスを開始すればブレークポイントもそのまま有効になりますが、ブレークさせるたびにプロセスが死んでいてはデバッグになりません。

Linux に詳しくないので間違っているかもしれませんが、Ctrl-C を押すと SIGINT シグナルが送られて、Apache には独自のハンドラーがあって、ワーカー スレッドが SIGINT を処理するとスレッドが終了してしまうようになっているのかもしれません。(全くの勘です。ご指摘があれば嬉しいです。自分で調べろよって話ですが。)

(2015/1/2 追記)
Ctrl+C でスレッドが死ぬ現象は、Apache がマルチスレッド モードでビルドされている場合のため、Apache をビルドするときにマルチスレッドではないモデルを選んでおけば、ソースからビルドした Apache でも Ctrl+C によってブレークさせることができます。具体的には、Apache の configure を実行するときに "–with-mpm=prefork" オプションを追加してください。

Multi-Processing Modules (MPMs) – Apache HTTP Server Version 2.4
http://httpd.apache.org/docs/2.4/mpm.html

prefork – Apache HTTP Server Version 2.4
http://httpd.apache.org/docs/2.4/mod/prefork.html

マルチスレッド モデルのときの解決策ですが、SIGINT ではなく、SIGTRAP を kill コマンドで送信するという手がありました。

john@glycine:~$ ps -ef | grep httpd
root      2824  1406  0 00:13 pts/0    00:00:00 sudo gdb /usr/local/apache-httpd/current/bin/httpd
root      2825  2824  6 00:13 pts/0    00:00:00 gdb /usr/local/apache-httpd/current/bin/httpd
daemon    2827  2825  0 00:13 pts/0    00:00:00 /usr/local/apache-httpd/httpd-2.4.10/bin/httpd -X
john      2861  1490  0 00:13 pts/1    00:00:00 grep –color=auto httpd
john@glycine:~$ sudo kill -SIGTRAP 2827
[sudo] password for john:
no talloc stackframe at ../source3/param/loadparm.c:4864, leaking memory

kill コマンドを実行すると、デバッガーにブレークインしてくれるので、先ほどと同じように sed_response_filter にブレークポイントを設定し、 conitnue します。今度はスレッドが死なないはずです。sed_response_filter は、名前の通り HTTP レスポンスを返す時に呼ばれるので、ブラウザーでページを開くだけでブレークします。以下は、コールスタックや引数の f を表示させている例です。

[New Thread 0x7fffe3fef700 (LWP 2853)]
[New Thread 0x7fffe37ee700 (LWP 2854)]
[New Thread 0x7fffe2fed700 (LWP 2855)]
[New Thread 0x7fffe27ec700 (LWP 2856)]
[New Thread 0x7fffe1feb700 (LWP 2857)]
[Thread 0x7ffff3676700 (LWP 2831) exited]

Program received signal SIGTRAP, Trace/breakpoint trap. <<<< kill コマンドによる SIGTRAP
0x00007ffff75560d1 in do_sigwait (sig=0x7fffffffe2ac, set=<optimized out>)
    at ../nptl/sysdeps/unix/sysv/linux/../../../../../sysdeps/unix/sysv/linux/sigwait.c:60
60      ../nptl/sysdeps/unix/sysv/linux/../../../../../sysdeps/unix/sysv/linux/sigwait.c: No such file or directory.
(gdb) break sed_response_filter
Breakpoint 1 at 0x7ffff54ec0a0: file mod_sed.c, line 269.
(gdb) c
Continuing.
[Switching to Thread 0x7fffe27ec700 (LWP 2856)]

Breakpoint 1, sed_response_filter (f=0x7fffdc007c50, bb=0x7fffdc008e18) at mod_sed.c:269
269     {
(gdb) bt
#0  sed_response_filter (f=0x7fffdc007c50, bb=0x7fffdc008e18) at mod_sed.c:269
#1  0x0000000000439f07 in default_handler (r=0x7fffdc002970) at core.c:4369
#2  0x000000000044a260 in ap_run_handler (r=0x7fffdc002970) at config.c:169
#3  0x000000000044a7a9 in ap_invoke_handler (r=r@entry=0x7fffdc002970) at config.c:433
#4  0x000000000045dd5a in ap_process_async_request (r=r@entry=0x7fffdc002970) at http_request.c:317
#5  0x000000000045ad70 in ap_process_http_async_connection (c=0x7fffec0372a0) at http_core.c:143
#6  ap_process_http_connection (c=0x7fffec0372a0) at http_core.c:228
#7  0x0000000000453580 in ap_run_process_connection (c=0x7fffec0372a0) at connection.c:41
#8  0x0000000000465d94 in process_socket (my_thread_num=24, my_child_num=0, cs=0x7fffec037218, sock=<optimized out>,
    p=<optimized out>, thd=<optimized out>) at event.c:1035
#9  worker_thread (thd=<optimized out>, dummy=<optimized out>) at event.c:1875
#10 0x00007ffff754e182 in start_thread (arg=0x7fffe27ec700) at pthread_create.c:312
#11 0x00007ffff727afbd in clone () at ../sysdeps/unix/sysv/linux/x86_64/clone.S:111
(gdb) p *f->r
$8 = {pool = 0x7fffdc0028f8, connection = 0x7fffec0372a0, server = 0x6c4618, next = 0x0, prev = 0x0, main = 0x0,
  the_request = 0x7fffdc003b58 "GET /?q=aaa HTTP/1.1", assbackwards = 0, proxyreq = 0, header_only = 0,
  proto_num = 1001, protocol = 0x7fffdc003b98 "HTTP/1.1", hostname = 0x7fffdc003d88 "10.10.90.10",
  request_time = 1419322660195931, status_line = 0x0, status = 304, method_number = 0, method = 0x7fffdc003b70 "GET",
  allowed = 0, allowed_xmethods = 0x0, allowed_methods = 0x7fffdc002c28, sent_bodyct = 0, bytes_sent = 0,
  mtime = 1419313062006926, range = 0x0, clength = 104, chunked = 0, read_body = 0, read_chunked = 0,
  expecting_100 = 0, kept_body = 0x0, body_table = 0x0, remaining = 0, read_length = 0, headers_in = 0x7fffdc002c68,
  headers_out = 0x7fffdc004650, err_headers_out = 0x7fffdc004778, subprocess_env = 0x7fffdc008928,
  notes = 0x7fffdc004528, content_type = 0x6f23e0 "text/html", handler = 0x6f23e0 "text/html", content_encoding = 0x0,
  content_languages = 0x0, vlist_validator = 0x0, user = 0x0, ap_auth_type = 0x0,
  unparsed_uri = 0x7fffdc003b80 "/?q=aaa", uri = 0x7fffdc0079f8 "/index.html",
  filename = 0x7fffdc007a50 "/usr/local/apache-httpd/httpd-2.4.10/htdocs/index.html",
  canonical_filename = 0x7fffdc007a10 "/usr/local/apache-httpd/httpd-2.4.10/htdocs/index.html", path_info = 0x0,
  args = 0x7fffdc007a08 "q=aaa", used_path_info = 2, eos_sent = 1, per_dir_config = 0x7fffdc004108,
  request_config = 0x7fffdc0038f0, log = 0x6c4638, log_id = 0x0, htaccess = 0x0, output_filters = 0x7fffdc007c50,
  input_filters = 0x7fffdc003da8, proto_output_filters = 0x7fffdc003a58, proto_input_filters = 0x7fffdc003da8,
  no_cache = 0, no_local_copy = 0, invoke_mtx = 0x7fffdc003dd0, parsed_uri = {scheme = 0x0, hostinfo = 0x0,
    user = 0x0, password = 0x0, hostname = 0x0, port_str = 0x7fffdc003da0 "50000", path = 0x7fffdc003b88 "/",
    query = 0x7fffdc003b90 "q=aaa", fragment = 0x0, hostent = 0x0, port = 50000, is_initialized = 1,
    dns_looked_up = 0, dns_resolved = 0}, finfo = {pool = 0x7fffdc006918, valid = 7598960, protection = 1604,
    filetype = APR_REG, user = 1000, group = 1000, inode = 2768083, device = 2049, nlink = 1, size = 104,
    csize = 4096, atime = 1419313378554926, mtime = 1419313062006926, ctime = 1419313062086926,
    fname = 0x7fffdc007a50 "/usr/local/apache-httpd/httpd-2.4.10/htdocs/index.html", name = 0x0, filehand = 0x0},
  useragent_addr = 0x7fffec037120, useragent_ip = 0x7fffec037600 "10.10.1.252"}

これで Linux 上のサービス (Linux 的にはデーモンか) のデバッグも余裕・・・!

事前に httpd の PID を取得しなくても、killall という素敵なコマンドがありました。これで一発。

$ sudo killall -SIGTRAP httpd