e4561a313fc224e5673344e6f7b87e6fecfbf5d8
[asterisk/asterisk.git] / doc / backtrace.txt
1 This document is to provide information on how to obtain the
2 backtraces required on the asterisk bug tracker, available at
3 http://bugs.digium.com. The information is required by developers to
4 help fix problem with bugs of any kind. Backtraces provide information
5 about what was wrong when a program crashed; in our case,
6 Asterisk. There are two kind of backtraces (aka 'bt'), which are
7 useful: bt and bt full.
8
9 First of all, when you start Asterisk, you MUST start it with option
10 -g (this tells Asterisk to produce a core file if it crashes).
11
12 If you start Asterisk with the safe_asterisk script, it automatically
13 starts using the option -g.
14
15 If you're not sure if Asterisk is running with the -g option, type the
16 following command in your shell:
17
18 debian:/tmp# ps aux | grep asterisk
19 root     17832  0.0  1.2   2348   788 pts/1    S    Aug12   0:00 /bin/sh /usr/sbin/safe_asterisk
20 root     26686  0.0  2.8  15544  1744 pts/1    S    Aug13   0:02 asterisk -vvvg -c
21 [...]
22
23 The interesting information is located in the last column.
24
25 Second, your copy of Asterisk must have been built without
26 optimization or the backtrace will be (nearly) unusable. This can be
27 done by using 'make dont-optimize' instead of 'make install' to build
28 and install the Asterisk binary and modules.
29
30 After Asterisk crashes, a core file will be "dumped" in your /tmp/
31 directory. To make sure it's really there, you can just type the
32 following command in your shell:
33
34 debian:/tmp# ls -l /tmp/core.*
35 -rw-------  1 root root 10592256 Aug 12 19:40 /tmp/core.26252
36 -rw-------  1 root root  9924608 Aug 12 20:12 /tmp/core.26340
37 -rw-------  1 root root 10862592 Aug 12 20:14 /tmp/core.26374
38 -rw-------  1 root root  9105408 Aug 12 20:19 /tmp/core.26426
39 -rw-------  1 root root  9441280 Aug 12 20:20 /tmp/core.26462
40 -rw-------  1 root root  8331264 Aug 13 00:32 /tmp/core.26647
41 debian:/tmp#
42
43 Now that we've verified the core file has been written to disk, the
44 final part is to extract 'bt' from the core file. Core files are
45 pretty big, don't be scared, it's normal.
46
47 *** NOTE: Don't attach core files on the bug tracker, we only need the bt and bt full. ***
48
49 For extraction, we use a really nice tool, called gdb. To verify that
50 you have gdb installed on your system:
51
52 debian:/tmp# gdb -v
53 GNU gdb 6.3-debian
54 Copyright 2004 Free Software Foundation, Inc.
55 GDB is free software, covered by the GNU General Public License, and you are
56 welcome to change it and/or distribute copies of it under certain conditions.
57 Type "show copying" to see the conditions.
58 There is absolutely no warranty for GDB.  Type "show warranty" for details.
59 This GDB was configured as "i386-linux".
60 debian:/tmp#
61
62 Which is great, we can continue. If you don't have gdb installed, go install gdb.
63
64 Now load the core file in gdb, as follows:
65
66 debian:/tmp# gdb -se "asterisk" -c /tmp/core.26252
67 [...]
68 (You would see a lot of output here.)
69 [...]
70 Reading symbols from /usr/lib/asterisk/modules/app_externalivr.so...done.
71 Loaded symbols for /usr/lib/asterisk/modules/app_externalivr.so
72 #0  0x29b45d7e in ?? ()
73 (gdb)
74
75 Now at the gdb prompt, type: bt
76 You would see output similar to:
77 (gdb) bt
78 #0  0x29b45d7e in ?? ()
79 #1  0x08180bf8 in ?? ()
80 #2  0xbcdffa58 in ?? ()
81 #3  0x08180bf8 in ?? ()
82 #4  0xbcdffa60 in ?? ()
83 #5  0x08180bf8 in ?? ()
84 #6  0x180bf894 in ?? ()
85 #7  0x0bf80008 in ?? ()
86 #8  0x180b0818 in ?? ()
87 #9  0x08068008 in ast_stopstream (tmp=0x40758d38) at file.c:180
88 #10 0x000000a0 in ?? ()
89 #11 0x000000a0 in ?? ()
90 #12 0x00000000 in ?? ()
91 #13 0x407513c3 in confcall_careful_stream (conf=0x8180bf8, filename=0x8181de8 "Zap/pseudo-1324221520") at app_meetme.c:262
92 #14 0x40751332 in streamconfthread (args=0x8180bf8) at app_meetme.c:1965
93 #15 0xbcdffbe0 in ?? ()
94 #16 0x40028e51 in pthread_start_thread () from /lib/libpthread.so.0
95 #17 0x401ec92a in clone () from /lib/libc.so.6
96 (gdb)
97
98
99 The bt's output is the information that we need on the bug tracker.
100
101 Now do a bt full as follows:
102 (gdb) bt full
103 #0  0x29b45d7e in ?? ()
104 No symbol table info available.
105 #1  0x08180bf8 in ?? ()
106 No symbol table info available.
107 #2  0xbcdffa58 in ?? ()
108 No symbol table info available.
109 #3  0x08180bf8 in ?? ()
110 No symbol table info available.
111 #4  0xbcdffa60 in ?? ()
112 No symbol table info available.
113 #5  0x08180bf8 in ?? ()
114 No symbol table info available.
115 #6  0x180bf894 in ?? ()
116 No symbol table info available.
117 #7  0x0bf80008 in ?? ()
118 No symbol table info available.
119 #8  0x180b0818 in ?? ()
120 No symbol table info available.
121 #9  0x08068008 in ast_stopstream (tmp=0x40758d38) at file.c:180
122 No locals.
123 #10 0x000000a0 in ?? ()
124 No symbol table info available.
125 #11 0x000000a0 in ?? ()
126 No symbol table info available.
127 #12 0x00000000 in ?? ()
128 No symbol table info available.
129 #13 0x407513c3 in confcall_careful_stream (conf=0x8180bf8, filename=0x8181de8 "Zap/pseudo-1324221520") at app_meetme.c:262
130         f = (struct ast_frame *) 0x8180bf8
131         trans = (struct ast_trans_pvt *) 0x0
132 #14 0x40751332 in streamconfthread (args=0x8180bf8) at app_meetme.c:1965
133 No locals.
134 #15 0xbcdffbe0 in ?? ()
135 No symbol table info available.
136 #16 0x40028e51 in pthread_start_thread () from /lib/libpthread.so.0
137 No symbol table info available.
138 #17 0x401ec92a in clone () from /lib/libc.so.6
139 No symbol table info available.
140 (gdb)
141
142 We also need gdb's output. That output gives more details compared to
143 the simple "bt". So we recommend that you use bt full instead of bt.
144 But, if you could include both, we appreciate that.
145
146 The final "extraction" would the to know all traces by all
147 threads. Even if asterisk runs on the same thread for each calls, it
148 could have some new threads created.
149
150 To make sure we have the correct informations, just do:
151 (gdb) thread apply all bt
152
153 Thread 1 (process 26252):
154 #0  0x29b45d7e in ?? ()
155 #1  0x08180bf8 in ?? ()
156 #2  0xbcdffa58 in ?? ()
157 #3  0x08180bf8 in ?? ()
158 #4  0xbcdffa60 in ?? ()
159 #5  0x08180bf8 in ?? ()
160 #6  0x180bf894 in ?? ()
161 #7  0x0bf80008 in ?? ()
162 #8  0x180b0818 in ?? ()
163 #9  0x08068008 in ast_stopstream (tmp=0x40758d38) at file.c:180
164 #10 0x000000a0 in ?? ()
165 #11 0x000000a0 in ?? ()
166 #12 0x00000000 in ?? ()
167 #13 0x407513c3 in confcall_careful_stream (conf=0x8180bf8, filename=0x8181de8 "Zap/pseudo-1324221520") at app_meetme.c:262
168 #14 0x40751332 in streamconfthread (args=0x8180bf8) at app_meetme.c:1965
169 #15 0xbcdffbe0 in ?? ()
170 #16 0x40028e51 in pthread_start_thread () from /lib/libpthread.so.0
171 #17 0x401ec92a in clone () from /lib/libc.so.6
172 (gdb)
173
174
175 That output tell us crucial informations for threads.
176
177 Now, just create a output.txt and dump your "bt full" (and/or "bt")
178 AND with "thread apply all bt".
179
180 Note: Please ATTACH your output, DO NOT paste it as a note.
181
182 And you're ready for upload on bug tracker.
183
184
185 Questions or comments regarding this documentation, feel free to pass
186 by #asterisk-bugs on FreeNode.
187