manual/LDP_man-pages/release/man3/backtrace.3

   1 .\" Copyright (C) 2007 Michael Kerrisk <mtk.manpages@gmail.com>
   2 .\" drawing on material by Justin Pryzby <pryzbyj@justinpryzby.com>
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining
   5 .\" a copy of this software and associated documentation files (the
   6 .\" "Software"), to deal in the Software without restriction, including
   7 .\" without limitation the rights to use, copy, modify, merge, publish,
   8 .\" distribute, sublicense, and/or sell copies of the Software, and to
   9 .\" permit persons to whom the Software is furnished to do so, subject to
  10 .\" the following conditions:
  11 .\"
  12 .\" The above copyright notice and this permission notice shall be
  13 .\" included in all copies or substantial portions of the Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18 .\" IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  19 .\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  20 .\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  21 .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .\" References:
  24 .\"   glibc manual and source
  25 .\"
  26 .\" Japanese Version Copyright (c) 2007  Akihiro MOTOKI
  27 .\"         all rights reserved.
  28 .\" Translated 2007-10-16, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.66
  29 .\"
  30 .TH BACKTRACE 3 2008-06-14 GNU "Linux Programmer's Manual"
  31 .SH 名前
  32 backtrace, backtrace_symbols, backtrace_symbols_fd \-
  33 アプリケーション自身でのデバッグのサポート
  34 .SH 書式
  35 .B #include <execinfo.h>
  36
  37 .B int backtrace(void
  38 .BI ** buffer ,
  39 .B int
  40 .IB size );
  41
  42 .B char **backtrace_symbols(void *const
  43 .BI * buffer ,
  44 .B int
  45 .IB size );
  46
  47 .B void backtrace_symbols_fd(void *const
  48 .BI * buffer ,
  49 .B int
  50 .IB size ,
  51 .B int
  52 .IB fd );
  53 .SH 説明
  54 .BR backtrace ()
  55 は、呼び出したプログラムのバックトレースを
  56 .I buffer
  57 が指す配列に入れて返す。バックトレースは、プログラムで
  58 現在動作中の関数呼び出しの並びである。
  59 .I buffer
  60 が指す配列の個々の要素は \fIvoid *\fP 型で、
  61 対応するスタックフレームからのリターンアドレスである。
  62 .I size
  63 引き数は
  64 .I buffer
  65 に格納できるアドレスの最大個数を指定する。
  66 バックトレースが
  67 .I size
  68 より大きい場合、
  69 .I size
  70 個の直近の関数呼び出しに対応するアドレスが返される。
  71 完全なバックトレースを取得するためには、確実に
  72 .I buffer
  73 と
  74 .I size
  75 が十分大きくなるようにすること。
  76
  77 .BR backtrace ()
  78 によって
  79 .I buffer
  80 にアドレスの集合が得られたら、
  81 .BR backtrace_symbols ()
  82 によって、アドレス集合を、そのアドレスをシンボルで表した文字列の配列
  83 に翻訳できる。
  84 .I size
  85 引き数は
  86 .I buffer
  87 に格納されたアドレスの数を指定する。
  88 個々のアドレスのシンボル表現は、関数名 (特定できた場合)、
  89 関数へのオフセット (16進表記)、実際のリターンアドレス (16進表記)
  90 から構成される。
  91 .BR backtrace_symbols ()
  92 の実行結果としては、
  93 文字列ポインタの配列のアドレスが返される。
  94 この配列は
  95 .BR backtrace_symbols ()
  96 によって
  97 .BR malloc (3)
  98 され、呼び出し側で free しなければならない
  99 (ポインタの配列が指す個々の文字列は free する必要はないし、
 100 free すべきでもない)。
 101
 102 .BR backtrace_symbols_fd ()
 103 は、
 104 .BR backtrace_symbols ()
 105 と同じ引き数
 106 .I buffer
 107 と
 108 .I size
 109 をとるが、呼び出し側に文字列の配列を返す代わりに、
 110 文字列をファイルディスクリプタ
 111 .I fd
 112 に 1 行に 1 エントリの形で書き込む。
 113 .BR backtrace_symbols_fd ()
 114 は
 115 .BR malloc (3)
 116 を呼び出さない。
 117 そのため、これに続く関数が失敗する可能性がある状況でも利用できる。
 118 .SH 返り値
 119 .BR backtrace ()
 120 は
 121 .I buffer
 122 に格納したアドレスの個数を返す。その個数は
 123 .I size
 124 より大きくなることはない。
 125 返り値が
 126 .I size
 127 より小さい場合、バックトレース全体が格納されている。返り値が
 128 .I size
 129 と等しい場合、バックトレースは切り詰められているかもしれない。
 130 切り詰められた場合、最も古いスタックフレームのアドレスは
 131 返されないことになる。
 132
 133 .BR backtrace_symbols ()
 134 は、成功すると、この呼び出しで
 135 .BR malloc (3)
 136 された配列へのポインタを返す。
 137 エラーの場合、 NULL を返す。
 138 .SH バージョン
 139 .BR backtrace (),
 140 .BR backtrace_symbols (),
 141 .BR backtrace_symbols_fd ()
 142 はバージョン 2.1 以降の glibc で提供されている。
 143 .SH 準拠
 144 これらの関数は GNU による拡張である。
 145 .SH 注意
 146 これらの関数は、関数のリターンアドレスがスタック上でどのように格納されるか
 147 に関してある仮定を置いている。
 148 以下の点に注意。
 149 .IP * 3
 150 .RB ( gcc (1)
 151 の 0 以外の最適化レベルで暗黙のうちに行われる)
 152 フレームポインタの省略を行うと、これらの前提が崩れる可能性がある。
 153 .IP *
 154 インライン関数はスタックフレームを持たない。
 155 .IP *
 156 末尾呼び出しの最適化 (tail-call optimization) を行うと、
 157 あるスタックフレームが別のスタックフレームを置き換える可能性がある。
 158 .PP
 159 シンボル名は特別なリンカ・オプションを使用しないと利用できない場合がある。
 160 GNU リンカを使用するシステムでは、
 161 .I \-rdynamic
 162 リンカ・オプションを使う必要がある。
 163 "static" な関数のシンボル名は公開されず、
 164 バックトレースでは利用できない点に注意すること。
 165 .SH 例
 166 以下のプログラムは、
 167 .BR backtrace ()
 168 と
 169 .BR backtrace_symbols ()
 170 の使用例を示したものである。
 171 以下に示すシェルのセッションは、
 172 このプログラムを動かした際の実行例である。
 173 .nf
 174 .in +4n
 175
 176 .RB "$" " cc \-rdynamic prog.c \-o prog"
 177 .RB "$" " ./prog 3"
 178 backtrace() returned 8 addresses
 179 \&./prog(myfunc3+0x5c) [0x80487f0]
 180 \&./prog [0x8048871]
 181 \&./prog(myfunc+0x21) [0x8048894]
 182 \&./prog(myfunc+0x1a) [0x804888d]
 183 \&./prog(myfunc+0x1a) [0x804888d]
 184 \&./prog(main+0x65) [0x80488fb]
 185 \&/lib/libc.so.6(__libc_start_main+0xdc) [0xb7e38f9c]
 186 \&./prog [0x8048711]
 187 .in
 188 .fi
 189 .SS プログラムのソース
 190 \&
 191 .nf
 192 #include <execinfo.h>
 193 #include <stdio.h>
 194 #include <stdlib.h>
 195 #include <unistd.h>
 196
 197 void
 198 myfunc3(void)
 199 {
 200     int j, nptrs;
 201 #define SIZE 100
 202     void *buffer[100];
 203     char **strings;
 204
 205     nptrs = backtrace(buffer, SIZE);
 206     printf("backtrace() returned %d addresses\\n", nptrs);
 207
 208     /* backtrace_symbols_fd(buffer, nptrs, STDOUT_FILENO) を
 209        呼び出しても、以下と同様の出力が得られる。 */
 210
 211     strings = backtrace_symbols(buffer, nptrs);
 212     if (strings == NULL) {
 213         perror("backtrace_symbols");
 214         exit(EXIT_FAILURE);
 215     }
 216
 217     for (j = 0; j < nptrs; j++)
 218         printf("%s\\n", strings[j]);
 219
 220     free(strings);
 221 }
 222
 223 static void   /* "static" はシンボルを公開しないことを意味する */
 224 myfunc2(void)
 225 {
 226     myfunc3();
 227 }
 228
 229 void
 230 myfunc(int ncalls)
 231 {
 232     if (ncalls > 1)
 233         myfunc(ncalls \- 1);
 234     else
 235         myfunc2();
 236 }
 237
 238 int
 239 main(int argc, char *argv[])
 240 {
 241     if (argc != 2) {
 242         fprintf(stderr, "%s num\-calls\\n", argv[0]);
 243         exit(EXIT_FAILURE);
 244     }
 245
 246     myfunc(atoi(argv[1]));
 247     exit(EXIT_SUCCESS);
 248 }
 249 .fi
 250 .SH 関連項目
 251 .BR gcc (1),
 252 .BR ld (1),
 253 .BR dlopen (3),
 254 .BR malloc (3)