1 .\" Copyright (C) 2007 Michael Kerrisk <mtk.manpages@gmail.com>
2 .\" drawing on material by Justin Pryzby <pryzbyj@justinpryzby.com>
4 .\" %%%LICENSE_START(PERMISSIVE_MISC)
5 .\" Permission is hereby granted, free of charge, to any person obtaining
6 .\" a copy of this software and associated documentation files (the
7 .\" "Software"), to deal in the Software without restriction, including
8 .\" without limitation the rights to use, copy, modify, merge, publish,
9 .\" distribute, sublicense, and/or sell copies of the Software, and to
10 .\" permit persons to whom the Software is furnished to do so, subject to
11 .\" the following conditions:
13 .\" The above copyright notice and this permission notice shall be
14 .\" included in all copies or substantial portions of the Software.
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 .\" IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20 .\" CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21 .\" TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22 .\" SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 .\" glibc manual and source
27 .\"*******************************************************************
29 .\" This file was generated with po4a. Translate the source file.
31 .\"*******************************************************************
33 .\" Japanese Version Copyright (c) 2007 Akihiro MOTOKI
34 .\" all rights reserved.
35 .\" Translated 2007-10-16, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.66
37 .TH BACKTRACE 3 2008\-06\-14 GNU "Linux Programmer's Manual"
39 backtrace, backtrace_symbols, backtrace_symbols_fd \- アプリケーション自身でのデバッグのサポート
41 \fB#include <execinfo.h>\fP
43 \fBint backtrace(void\fP \fB**\fP\fIbuffer\fP\fB,\fP \fBint\fP \fIsize\fP\fB);\fP
45 \fBchar **backtrace_symbols(void *const\fP \fB*\fP\fIbuffer\fP\fB,\fP \fBint\fP
48 \fBvoid backtrace_symbols_fd(void *const\fP \fB*\fP\fIbuffer\fP\fB,\fP \fBint\fP
49 \fIsize\fP\fB,\fP \fBint\fP \fIfd\fP\fB);\fP
51 \fBbacktrace\fP() は、呼び出したプログラムのバックトレースを \fIbuffer\fP が指す配列に入れて返す。バックトレースは、プログラムで
52 現在動作中の関数呼び出しの並びである。 \fIbuffer\fP が指す配列の個々の要素は \fIvoid\ *\fP 型で、
53 対応するスタックフレームからのリターンアドレスである。 \fIsize\fP 引き数は \fIbuffer\fP に格納できるアドレスの最大個数を指定する。
54 バックトレースが \fIsize\fP より大きい場合、 \fIsize\fP 個の直近の関数呼び出しに対応するアドレスが返される。
55 完全なバックトレースを取得するためには、確実に \fIbuffer\fP と \fIsize\fP が十分大きくなるようにすること。
57 \fBbacktrace\fP() によって \fIbuffer\fP にアドレスの集合が得られたら、 \fBbacktrace_symbols\fP()
58 によって、アドレス集合を、そのアドレスをシンボルで表した文字列の配列 に翻訳できる。 \fIsize\fP 引き数は \fIbuffer\fP
59 に格納されたアドレスの数を指定する。 個々のアドレスのシンボル表現は、関数名 (特定できた場合)、 関数へのオフセット
60 (16進表記)、実際のリターンアドレス (16進表記) から構成される。 \fBbacktrace_symbols\fP() の実行結果としては、
61 文字列ポインタの配列のアドレスが返される。 この配列は \fBbacktrace_symbols\fP() によって \fBmalloc\fP(3)
62 され、呼び出し側で free しなければならない (ポインタの配列が指す個々の文字列は free する必要はないし、 free すべきでもない)。
64 \fBbacktrace_symbols_fd\fP() は、 \fBbacktrace_symbols\fP() と同じ引き数 \fIbuffer\fP と
65 \fIsize\fP をとるが、呼び出し側に文字列の配列を返す代わりに、 文字列をファイルディスクリプタ \fIfd\fP に 1 行に 1
66 エントリの形で書き込む。 \fBbacktrace_symbols_fd\fP() は \fBmalloc\fP(3) を呼び出さない。
67 そのため、これに続く関数が失敗する可能性がある状況でも利用できる。
69 \fBbacktrace\fP() は \fIbuffer\fP に格納したアドレスの個数を返す。その個数は \fIsize\fP より大きくなることはない。 返り値が
70 \fIsize\fP より小さい場合、バックトレース全体が格納されている。返り値が \fIsize\fP
71 と等しい場合、バックトレースは切り詰められているかもしれない。 切り詰められた場合、最も古いスタックフレームのアドレスは 返されないことになる。
73 \fBbacktrace_symbols\fP() は、成功すると、この呼び出しで \fBmalloc\fP(3) された配列へのポインタを返す。
76 \fBbacktrace\fP(), \fBbacktrace_symbols\fP(), \fBbacktrace_symbols_fd\fP() はバージョン
77 2.1 以降の glibc で提供されている。
81 これらの関数は、関数のリターンアドレスがスタック上でどのように格納されるか に関してある仮定を置いている。 以下の点に注意。
83 (\fBgcc\fP(1) の 0 以外の最適化レベルで暗黙のうちに行われる) フレームポインタの省略を行うと、これらの前提が崩れる可能性がある。
85 インライン関数はスタックフレームを持たない。
87 末尾呼び出しの最適化 (tail\-call optimization) を行うと、 あるスタックフレームが別のスタックフレームを置き換える可能性がある。
89 シンボル名は特別なリンカ・オプションを使用しないと利用できない場合がある。 GNU リンカを使用するシステムでは、 \fI\-rdynamic\fP
90 リンカ・オプションを使う必要がある。 "static" な関数のシンボル名は公開されず、 バックトレースでは利用できない点に注意すること。
92 以下のプログラムは、 \fBbacktrace\fP() と \fBbacktrace_symbols\fP() の使用例を示したものである。
93 以下に示すシェルのセッションは、 このプログラムを動かした際の実行例である。
97 $\fB cc \-rdynamic prog.c \-o prog\fP
99 backtrace() returned 8 addresses
100 \&./prog(myfunc3+0x5c) [0x80487f0]
102 \&./prog(myfunc+0x21) [0x8048894]
103 \&./prog(myfunc+0x1a) [0x804888d]
104 \&./prog(myfunc+0x1a) [0x804888d]
105 \&./prog(main+0x65) [0x80488fb]
106 \&/lib/libc.so.6(__libc_start_main+0xdc) [0xb7e38f9c]
113 #include <execinfo.h>
126 nptrs = backtrace(buffer, SIZE);
127 printf("backtrace() returned %d addresses\en", nptrs);
129 /* backtrace_symbols_fd(buffer, nptrs, STDOUT_FILENO) を
130 呼び出しても、以下と同様の出力が得られる。 */
132 strings = backtrace_symbols(buffer, nptrs);
133 if (strings == NULL) {
134 perror("backtrace_symbols");
138 for (j = 0; j < nptrs; j++)
139 printf("%s\en", strings[j]);
144 static void /* "static" はシンボルを公開しないことを意味する */
160 main(int argc, char *argv[])
163 fprintf(stderr, "%s num\-calls\en", argv[0]);
167 myfunc(atoi(argv[1]));
172 \fBgcc\fP(1), \fBld\fP(1), \fBdlopen\fP(3), \fBmalloc\fP(3)
174 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
175 である。プロジェクトの説明とバグ報告に関する情報は
176 http://www.kernel.org/doc/man\-pages/ に書かれている。