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)