Remove places that say if no language is specified it will default to english......
[asterisk/asterisk.git] / doc / backtrace.txt
1 This document is intended 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 selecting the 'DONT_OPTIMIZE' option in the Compiler Flags
28 submenu in the 'make menuselect' tree before building Asterisk.
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 In the event that there are multiple core files present (as in the
44 above example), it is important to look at the file timestamps in
45 order to determine which one you really intend to look at.
46
47 Now that we've verified the core file has been written to disk, the
48 final part is to extract 'bt' from the core file. Core files are
49 pretty big, don't be scared, it's normal.
50
51 *** NOTE: Don't attach core files on the bug tracker, we only need the bt and bt full. ***
52
53 For extraction, we use a really nice tool, called gdb. To verify that
54 you have gdb installed on your system:
55
56 debian:/tmp# gdb -v
57 GNU gdb 6.3-debian
58 Copyright 2004 Free Software Foundation, Inc.
59 GDB is free software, covered by the GNU General Public License, and you are
60 welcome to change it and/or distribute copies of it under certain conditions.
61 Type "show copying" to see the conditions.
62 There is absolutely no warranty for GDB.  Type "show warranty" for details.
63 This GDB was configured as "i386-linux".
64 debian:/tmp#
65
66 Which is great, we can continue. If you don't have gdb installed, go install gdb.
67
68 Now load the core file in gdb, as follows:
69
70 debian:/tmp# gdb asterisk /tmp/core.26252
71 [...]
72 (You would see a lot of output here.)
73 [...]
74 Reading symbols from /usr/lib/asterisk/modules/app_externalivr.so...done.
75 Loaded symbols for /usr/lib/asterisk/modules/app_externalivr.so
76 #0  0x29b45d7e in ?? ()
77 (gdb)
78
79 Now at the gdb prompt, type: bt
80 You would see output similar to:
81 (gdb) bt
82 #0  0x29b45d7e in ?? ()
83 #1  0x08180bf8 in ?? ()
84 #2  0xbcdffa58 in ?? ()
85 #3  0x08180bf8 in ?? ()
86 #4  0xbcdffa60 in ?? ()
87 #5  0x08180bf8 in ?? ()
88 #6  0x180bf894 in ?? ()
89 #7  0x0bf80008 in ?? ()
90 #8  0x180b0818 in ?? ()
91 #9  0x08068008 in ast_stopstream (tmp=0x40758d38) at file.c:180
92 #10 0x000000a0 in ?? ()
93 #11 0x000000a0 in ?? ()
94 #12 0x00000000 in ?? ()
95 #13 0x407513c3 in confcall_careful_stream (conf=0x8180bf8, filename=0x8181de8 "Zap/pseudo-1324221520") at app_meetme.c:262
96 #14 0x40751332 in streamconfthread (args=0x8180bf8) at app_meetme.c:1965
97 #15 0xbcdffbe0 in ?? ()
98 #16 0x40028e51 in pthread_start_thread () from /lib/libpthread.so.0
99 #17 0x401ec92a in clone () from /lib/libc.so.6
100 (gdb)
101
102
103 The bt's output is the information that we need on the bug tracker.
104
105 Now do a bt full as follows:
106 (gdb) bt full
107 #0  0x29b45d7e in ?? ()
108 No symbol table info available.
109 #1  0x08180bf8 in ?? ()
110 No symbol table info available.
111 #2  0xbcdffa58 in ?? ()
112 No symbol table info available.
113 #3  0x08180bf8 in ?? ()
114 No symbol table info available.
115 #4  0xbcdffa60 in ?? ()
116 No symbol table info available.
117 #5  0x08180bf8 in ?? ()
118 No symbol table info available.
119 #6  0x180bf894 in ?? ()
120 No symbol table info available.
121 #7  0x0bf80008 in ?? ()
122 No symbol table info available.
123 #8  0x180b0818 in ?? ()
124 No symbol table info available.
125 #9  0x08068008 in ast_stopstream (tmp=0x40758d38) at file.c:180
126 No locals.
127 #10 0x000000a0 in ?? ()
128 No symbol table info available.
129 #11 0x000000a0 in ?? ()
130 No symbol table info available.
131 #12 0x00000000 in ?? ()
132 No symbol table info available.
133 #13 0x407513c3 in confcall_careful_stream (conf=0x8180bf8, filename=0x8181de8 "Zap/pseudo-1324221520") at app_meetme.c:262
134         f = (struct ast_frame *) 0x8180bf8
135         trans = (struct ast_trans_pvt *) 0x0
136 #14 0x40751332 in streamconfthread (args=0x8180bf8) at app_meetme.c:1965
137 No locals.
138 #15 0xbcdffbe0 in ?? ()
139 No symbol table info available.
140 #16 0x40028e51 in pthread_start_thread () from /lib/libpthread.so.0
141 No symbol table info available.
142 #17 0x401ec92a in clone () from /lib/libc.so.6
143 No symbol table info available.
144 (gdb)
145
146 We also need gdb's output. That output gives more details compared to
147 the simple "bt". So we recommend that you use bt full instead of bt.
148 But, if you could include both, we appreciate that.
149
150 The final "extraction" would be to know all traces by all
151 threads. Even if asterisk runs on the same thread for each call, it
152 could have created some new threads.
153
154 To make sure we have the correct information, just do:
155 (gdb) thread apply all bt
156
157 Thread 1 (process 26252):
158 #0  0x29b45d7e in ?? ()
159 #1  0x08180bf8 in ?? ()
160 #2  0xbcdffa58 in ?? ()
161 #3  0x08180bf8 in ?? ()
162 #4  0xbcdffa60 in ?? ()
163 #5  0x08180bf8 in ?? ()
164 #6  0x180bf894 in ?? ()
165 #7  0x0bf80008 in ?? ()
166 #8  0x180b0818 in ?? ()
167 #9  0x08068008 in ast_stopstream (tmp=0x40758d38) at file.c:180
168 #10 0x000000a0 in ?? ()
169 #11 0x000000a0 in ?? ()
170 #12 0x00000000 in ?? ()
171 #13 0x407513c3 in confcall_careful_stream (conf=0x8180bf8, filename=0x8181de8 "Zap/pseudo-1324221520") at app_meetme.c:262
172 #14 0x40751332 in streamconfthread (args=0x8180bf8) at app_meetme.c:1965
173 #15 0xbcdffbe0 in ?? ()
174 #16 0x40028e51 in pthread_start_thread () from /lib/libpthread.so.0
175 #17 0x401ec92a in clone () from /lib/libc.so.6
176 (gdb)
177
178
179 That output tells us crucial information about each thread.
180
181 Now, just create an output.txt file and dump your "bt full"
182 (and/or "bt") ALONG WITH "thread apply all bt" into it.
183
184 Note: Please ATTACH your output, DO NOT paste it as a note.
185
186 And you're ready for upload on the bug tracker.
187
188
189 If you have questions or comments regarding this documentation, feel
190 free to pass by the #asterisk-bugs channel on irc.freenode.net.
191