Commit | Line | Data |
---|---|---|
a933dad1 | 1 | Debugging GNU Emacs |
5b87ad55 | 2 | |
ba318903 | 3 | Copyright (C) 1985, 2000-2014 Free Software Foundation, Inc. |
5b87ad55 | 4 | See the end of the file for license conditions. |
a933dad1 | 5 | |
a933dad1 | 6 | |
6259c2ec GM |
7 | [People who debug Emacs on Windows using Microsoft debuggers should |
8 | read the Windows-specific section near the end of this document.] | |
437368fe | 9 | |
42a3c627 | 10 | ** When you debug Emacs with GDB, you should start it in the directory |
83c54ddf EZ |
11 | where the executable was made (the 'src' directory in the Emacs source |
12 | tree). That directory has a .gdbinit file that defines various | |
13 | "user-defined" commands for debugging Emacs. (These commands are | |
14 | described below under "Examining Lisp object values" and "Debugging | |
15 | Emacs Redisplay problems".) | |
16 | ||
17 | Some GDB versions by default do not automatically load .gdbinit files | |
18 | in the directory where you invoke GDB. With those versions of GDB, | |
19 | you will see a warning when GDB starts, like this: | |
20 | ||
21 | warning: File ".../src/.gdbinit" auto-loading has been declined by your `auto-load safe-path' set to "$debugdir:$datadir/auto-load". | |
22 | ||
23 | There are several ways to overcome that difficulty, they are all | |
24 | described in the node "Auto-loading safe path" in the GDB user manual. | |
25 | ||
26 | ** When you are trying to analyze failed assertions or backtraces, it | |
11169e6f PE |
27 | is essential to compile Emacs with flags suitable for debugging. |
28 | With GCC 4.8 or later, you can invoke 'make' with CFLAGS="-Og -g3". | |
5ebb1ee6 | 29 | With older GCC or non-GCC compilers, you can use CFLAGS="-O0 -g3". |
3865c463 PE |
30 | With GCC and higher optimization levels such as -O2, the |
31 | -fno-omit-frame-pointer and -fno-crossjumping options are often | |
32 | essential. The latter prevents GCC from using the same abort call for | |
33 | all assertions in a given function, rendering the stack backtrace | |
34 | useless for identifying the specific failed assertion. | |
70d9a9cd | 35 | |
42a3c627 | 36 | ** It is a good idea to run Emacs under GDB (or some other suitable |
437368fe EZ |
37 | debugger) *all the time*. Then, when Emacs crashes, you will be able |
38 | to debug the live process, not just a core dump. (This is especially | |
39 | important on systems which don't support core files, and instead print | |
40 | just the registers and some stack addresses.) | |
41 | ||
42a3c627 | 42 | ** If Emacs hangs, or seems to be stuck in some infinite loop, typing |
437368fe EZ |
43 | "kill -TSTP PID", where PID is the Emacs process ID, will cause GDB to |
44 | kick in, provided that you run under GDB. | |
45 | ||
46 | ** Getting control to the debugger | |
a933dad1 | 47 | |
3102e429 | 48 | `Fsignal' is a very useful place to put a breakpoint in. |
a933dad1 DL |
49 | All Lisp errors go through there. |
50 | ||
3102e429 | 51 | It is useful, when debugging, to have a guaranteed way to return to |
eb55f651 | 52 | the debugger at any time. When using X, this is easy: type C-z at the |
3102e429 EZ |
53 | window where Emacs is running under GDB, and it will stop Emacs just |
54 | as it would stop any ordinary program. When Emacs is running in a | |
55 | terminal, things are not so easy. | |
56 | ||
57 | The src/.gdbinit file in the Emacs distribution arranges for SIGINT | |
58 | (C-g in Emacs) to be passed to Emacs and not give control back to GDB. | |
59 | On modern POSIX systems, you can override that with this command: | |
60 | ||
7718638c | 61 | handle SIGINT stop nopass |
3102e429 EZ |
62 | |
63 | After this `handle' command, SIGINT will return control to GDB. If | |
6259c2ec | 64 | you want the C-g to cause a QUIT within Emacs as well, omit the `nopass'. |
3102e429 EZ |
65 | |
66 | A technique that can work when `handle SIGINT' does not is to store | |
67 | the code for some character into the variable stop_character. Thus, | |
a933dad1 DL |
68 | |
69 | set stop_character = 29 | |
70 | ||
71 | makes Control-] (decimal code 29) the stop character. | |
72 | Typing Control-] will cause immediate stop. You cannot | |
73 | use the set command until the inferior process has been started. | |
74 | Put a breakpoint early in `main', or suspend the Emacs, | |
75 | to get an opportunity to do the set command. | |
76 | ||
06b6baf6 NR |
77 | When Emacs is running in a terminal, it is sometimes useful to use a separate |
78 | terminal for the debug session. This can be done by starting Emacs as usual, | |
79 | then attaching to it from gdb with the `attach' command which is explained in | |
80 | the node "Attach" of the GDB manual. | |
8ef597fe | 81 | |
a933dad1 DL |
82 | ** Examining Lisp object values. |
83 | ||
84 | When you have a live process to debug, and it has not encountered a | |
85 | fatal error, you can use the GDB command `pr'. First print the value | |
86 | in the ordinary way, with the `p' command. Then type `pr' with no | |
87 | arguments. This calls a subroutine which uses the Lisp printer. | |
88 | ||
1ce9f40a KS |
89 | You can also use `pp value' to print the emacs value directly. |
90 | ||
11eced2f KS |
91 | To see the current value of a Lisp Variable, use `pv variable'. |
92 | ||
93 | Note: It is not a good idea to try `pr', `pp', or `pv' if you know that Emacs | |
1ce9f40a KS |
94 | is in deep trouble: its stack smashed (e.g., if it encountered SIGSEGV |
95 | due to stack overflow), or crucial data structures, such as `obarray', | |
437368fe EZ |
96 | corrupted, etc. In such cases, the Emacs subroutine called by `pr' |
97 | might make more damage, like overwrite some data that is important for | |
98 | debugging the original problem. | |
99 | ||
3102e429 EZ |
100 | Also, on some systems it is impossible to use `pr' if you stopped |
101 | Emacs while it was inside `select'. This is in fact what happens if | |
102 | you stop Emacs while it is waiting. In such a situation, don't try to | |
103 | use `pr'. Instead, use `s' to step out of the system call. Then | |
104 | Emacs will be between instructions and capable of handling `pr'. | |
a933dad1 | 105 | |
11eced2f KS |
106 | If you can't use `pr' command, for whatever reason, you can use the |
107 | `xpr' command to print out the data type and value of the last data | |
108 | value, For example: | |
109 | ||
110 | p it->object | |
111 | xpr | |
112 | ||
113 | You may also analyze data values using lower-level commands. Use the | |
114 | `xtype' command to print out the data type of the last data value. | |
115 | Once you know the data type, use the command that corresponds to that | |
116 | type. Here are these commands: | |
a933dad1 DL |
117 | |
118 | xint xptr xwindow xmarker xoverlay xmiscfree xintfwd xboolfwd xobjfwd | |
119 | xbufobjfwd xkbobjfwd xbuflocal xbuffer xsymbol xstring xvector xframe | |
120 | xwinconfig xcompiled xcons xcar xcdr xsubr xprocess xfloat xscrollbar | |
121 | ||
122 | Each one of them applies to a certain type or class of types. | |
123 | (Some of these types are not visible in Lisp, because they exist only | |
124 | internally.) | |
125 | ||
126 | Each x... command prints some information about the value, and | |
127 | produces a GDB value (subsequently available in $) through which you | |
128 | can get at the rest of the contents. | |
129 | ||
437368fe | 130 | In general, most of the rest of the contents will be additional Lisp |
a933dad1 DL |
131 | objects which you can examine in turn with the x... commands. |
132 | ||
437368fe EZ |
133 | Even with a live process, these x... commands are useful for |
134 | examining the fields in a buffer, window, process, frame or marker. | |
135 | Here's an example using concepts explained in the node "Value History" | |
aa1f38cd NR |
136 | of the GDB manual to print values associated with the variable |
137 | called frame. First, use these commands: | |
437368fe EZ |
138 | |
139 | cd src | |
140 | gdb emacs | |
aa1f38cd | 141 | b set_frame_buffer_list |
177c0ea7 | 142 | r -q |
437368fe | 143 | |
8ef597fe | 144 | Then Emacs hits the breakpoint: |
437368fe EZ |
145 | |
146 | (gdb) p frame | |
aa1f38cd | 147 | $1 = 139854428 |
11eced2f | 148 | (gdb) xpr |
437368fe EZ |
149 | Lisp_Vectorlike |
150 | PVEC_FRAME | |
aa1f38cd | 151 | $2 = (struct frame *) 0x8560258 |
11eced2f | 152 | "emacs@localhost" |
437368fe EZ |
153 | (gdb) p *$ |
154 | $3 = { | |
aa1f38cd NR |
155 | size = 1073742931, |
156 | next = 0x85dfe58, | |
157 | name = 140615219, | |
437368fe EZ |
158 | [...] |
159 | } | |
437368fe | 160 | |
11eced2f KS |
161 | Now we can use `pr' to print the frame parameters: |
162 | ||
163 | (gdb) pp $->param_alist | |
164 | ((background-mode . light) (display-type . color) [...]) | |
437368fe | 165 | |
437368fe EZ |
166 | |
167 | The Emacs C code heavily uses macros defined in lisp.h. So suppose | |
168 | we want the address of the l-value expression near the bottom of | |
169 | `add_command_key' from keyboard.c: | |
170 | ||
171 | XVECTOR (this_command_keys)->contents[this_command_key_count++] = key; | |
172 | ||
f6e405a2 NR |
173 | XVECTOR is a macro, so GDB only knows about it if Emacs has been compiled with |
174 | preprocessor macro information. GCC provides this if you specify the options | |
175 | `-gdwarf-2' and `-g3'. In this case, GDB can evaluate expressions like | |
176 | "p XVECTOR (this_command_keys)". | |
437368fe | 177 | |
f6e405a2 NR |
178 | When this information isn't available, you can use the xvector command in GDB |
179 | to get the same result. Here is how: | |
437368fe EZ |
180 | |
181 | (gdb) p this_command_keys | |
182 | $1 = 1078005760 | |
183 | (gdb) xvector | |
184 | $2 = (struct Lisp_Vector *) 0x411000 | |
185 | 0 | |
186 | (gdb) p $->contents[this_command_key_count] | |
187 | $3 = 1077872640 | |
188 | (gdb) p &$ | |
189 | $4 = (int *) 0x411008 | |
190 | ||
191 | Here's a related example of macros and the GDB `define' command. | |
192 | There are many Lisp vectors such as `recent_keys', which contains the | |
6d02b70b | 193 | last 300 keystrokes. We can print this Lisp vector |
437368fe EZ |
194 | |
195 | p recent_keys | |
196 | pr | |
197 | ||
198 | But this may be inconvenient, since `recent_keys' is much more verbose | |
199 | than `C-h l'. We might want to print only the last 10 elements of | |
200 | this vector. `recent_keys' is updated in keyboard.c by the command | |
201 | ||
202 | XVECTOR (recent_keys)->contents[recent_keys_index] = c; | |
203 | ||
204 | So we define a GDB command `xvector-elts', so the last 10 keystrokes | |
177c0ea7 | 205 | are printed by |
437368fe EZ |
206 | |
207 | xvector-elts recent_keys recent_keys_index 10 | |
208 | ||
209 | where you can define xvector-elts as follows: | |
210 | ||
211 | define xvector-elts | |
212 | set $i = 0 | |
213 | p $arg0 | |
214 | xvector | |
215 | set $foo = $ | |
216 | while $i < $arg2 | |
177c0ea7 | 217 | p $foo->contents[$arg1-($i++)] |
437368fe EZ |
218 | pr |
219 | end | |
220 | document xvector-elts | |
221 | Prints a range of elements of a Lisp vector. | |
222 | xvector-elts v n i | |
223 | prints `i' elements of the vector `v' ending at the index `n'. | |
224 | end | |
225 | ||
226 | ** Getting Lisp-level backtrace information within GDB | |
227 | ||
3102e429 EZ |
228 | The most convenient way is to use the `xbacktrace' command. This |
229 | shows the names of the Lisp functions that are currently active. | |
437368fe EZ |
230 | |
231 | If that doesn't work (e.g., because the `backtrace_list' structure is | |
232 | corrupted), type "bt" at the GDB prompt, to produce the C-level | |
233 | backtrace, and look for stack frames that call Ffuncall. Select them | |
234 | one by one in GDB, by typing "up N", where N is the appropriate number | |
235 | of frames to go up, and in each frame that calls Ffuncall type this: | |
236 | ||
237 | p *args | |
238 | pr | |
239 | ||
240 | This will print the name of the Lisp function called by that level | |
241 | of function calling. | |
242 | ||
243 | By printing the remaining elements of args, you can see the argument | |
244 | values. Here's how to print the first argument: | |
177c0ea7 | 245 | |
437368fe EZ |
246 | p args[1] |
247 | pr | |
248 | ||
249 | If you do not have a live process, you can use xtype and the other | |
250 | x... commands such as xsymbol to get such information, albeit less | |
251 | conveniently. For example: | |
252 | ||
253 | p *args | |
254 | xtype | |
255 | ||
256 | and, assuming that "xtype" says that args[0] is a symbol: | |
257 | ||
177c0ea7 | 258 | xsymbol |
437368fe | 259 | |
11eced2f KS |
260 | ** Debugging Emacs Redisplay problems |
261 | ||
262 | The src/.gdbinit file defines many useful commands for dumping redisplay | |
263 | related data structures in a terse and user-friendly format: | |
264 | ||
265 | `ppt' prints value of PT, narrowing, and gap in current buffer. | |
266 | `pit' dumps the current display iterator `it'. | |
267 | `pwin' dumps the current window 'win'. | |
268 | `prow' dumps the current glyph_row `row'. | |
269 | `pg' dumps the current glyph `glyph'. | |
270 | `pgi' dumps the next glyph. | |
271 | `pgrow' dumps all glyphs in current glyph_row `row'. | |
272 | `pcursor' dumps current output_cursor. | |
273 | ||
274 | The above commands also exist in a version with an `x' suffix which | |
275 | takes an object of the relevant type as argument. | |
276 | ||
6205d23a NR |
277 | ** Following longjmp call. |
278 | ||
279 | Recent versions of glibc (2.4+?) encrypt stored values for setjmp/longjmp which | |
280 | prevents GDB from being able to follow a longjmp call using `next'. To | |
281 | disable this protection you need to set the environment variable | |
282 | LD_POINTER_GUARD to 0. | |
283 | ||
c167547b NR |
284 | ** Using GDB in Emacs |
285 | ||
286 | Debugging with GDB in Emacs offers some advantages over the command line (See | |
287 | the GDB Graphical Interface node of the Emacs manual). There are also some | |
288 | features available just for debugging Emacs: | |
289 | ||
a313dc7b EZ |
290 | 1) The command gud-pp is available on the tool bar (the `pp' icon) and |
291 | allows the user to print the s-expression of the variable at point, | |
292 | in the GUD buffer. | |
c167547b NR |
293 | |
294 | 2) Pressing `p' on a component of a watch expression that is a lisp object | |
295 | in the speedbar prints its s-expression in the GUD buffer. | |
296 | ||
297 | 3) The STOP button on the tool bar is adjusted so that it sends SIGTSTP | |
298 | instead of the usual SIGINT. | |
299 | ||
300 | 4) The command gud-pv has the global binding 'C-x C-a C-v' and prints the | |
301 | value of the lisp variable at point. | |
302 | ||
437368fe EZ |
303 | ** Debugging what happens while preloading and dumping Emacs |
304 | ||
305 | Type `gdb temacs' and start it with `r -batch -l loadup dump'. | |
306 | ||
307 | If temacs actually succeeds when running under GDB in this way, do not | |
308 | try to run the dumped Emacs, because it was dumped with the GDB | |
309 | breakpoints in it. | |
310 | ||
311 | ** Debugging `temacs' | |
312 | ||
313 | Debugging `temacs' is useful when you want to establish whether a | |
314 | problem happens in an undumped Emacs. To run `temacs' under a | |
315 | debugger, type "gdb temacs", then start it with `r -batch -l loadup'. | |
316 | ||
317 | ** If you encounter X protocol errors | |
318 | ||
a2ebb43f RS |
319 | The X server normally reports protocol errors asynchronously, |
320 | so you find out about them long after the primitive which caused | |
321 | the error has returned. | |
322 | ||
323 | To get clear information about the cause of an error, try evaluating | |
324 | (x-synchronize t). That puts Emacs into synchronous mode, where each | |
325 | Xlib call checks for errors before it returns. This mode is much | |
326 | slower, but when you get an error, you will see exactly which call | |
327 | really caused the error. | |
437368fe | 328 | |
ec4054f0 EZ |
329 | You can start Emacs in a synchronous mode by invoking it with the -xrm |
330 | option, like this: | |
331 | ||
9031cdf2 | 332 | emacs -xrm "emacs.synchronous: true" |
ec4054f0 EZ |
333 | |
334 | Setting a breakpoint in the function `x_error_quitter' and looking at | |
335 | the backtrace when Emacs stops inside that function will show what | |
336 | code causes the X protocol errors. | |
337 | ||
1d3adc26 EZ |
338 | Some bugs related to the X protocol disappear when Emacs runs in a |
339 | synchronous mode. To track down those bugs, we suggest the following | |
340 | procedure: | |
341 | ||
342 | - Run Emacs under a debugger and put a breakpoint inside the | |
343 | primitive function which, when called from Lisp, triggers the X | |
344 | protocol errors. For example, if the errors happen when you | |
345 | delete a frame, put a breakpoint inside `Fdelete_frame'. | |
346 | ||
347 | - When the breakpoint breaks, step through the code, looking for | |
348 | calls to X functions (the ones whose names begin with "X" or | |
349 | "Xt" or "Xm"). | |
350 | ||
351 | - Insert calls to `XSync' before and after each call to the X | |
352 | functions, like this: | |
353 | ||
354 | XSync (f->output_data.x->display_info->display, 0); | |
355 | ||
356 | where `f' is the pointer to the `struct frame' of the selected | |
357 | frame, normally available via XFRAME (selected_frame). (Most | |
358 | functions which call X already have some variable that holds the | |
359 | pointer to the frame, perhaps called `f' or `sf', so you shouldn't | |
360 | need to compute it.) | |
361 | ||
362 | If your debugger can call functions in the program being debugged, | |
363 | you should be able to issue the calls to `XSync' without recompiling | |
364 | Emacs. For example, with GDB, just type: | |
365 | ||
366 | call XSync (f->output_data.x->display_info->display, 0) | |
367 | ||
368 | before and immediately after the suspect X calls. If your | |
369 | debugger does not support this, you will need to add these pairs | |
370 | of calls in the source and rebuild Emacs. | |
371 | ||
372 | Either way, systematically step through the code and issue these | |
373 | calls until you find the first X function called by Emacs after | |
374 | which a call to `XSync' winds up in the function | |
375 | `x_error_quitter'. The first X function call for which this | |
376 | happens is the one that generated the X protocol error. | |
377 | ||
378 | - You should now look around this offending X call and try to figure | |
379 | out what is wrong with it. | |
380 | ||
46def989 JD |
381 | ** If Emacs causes errors or memory leaks in your X server |
382 | ||
383 | You can trace the traffic between Emacs and your X server with a tool | |
384 | like xmon, available at ftp://ftp.x.org/contrib/devel_tools/. | |
385 | ||
386 | Xmon can be used to see exactly what Emacs sends when X protocol errors | |
387 | happen. If Emacs causes the X server memory usage to increase you can | |
388 | use xmon to see what items Emacs creates in the server (windows, | |
389 | graphical contexts, pixmaps) and what items Emacs delete. If there | |
390 | are consistently more creations than deletions, the type of item | |
391 | and the activity you do when the items get created can give a hint where | |
392 | to start debugging. | |
393 | ||
437368fe EZ |
394 | ** If the symptom of the bug is that Emacs fails to respond |
395 | ||
396 | Don't assume Emacs is `hung'--it may instead be in an infinite loop. | |
397 | To find out which, make the problem happen under GDB and stop Emacs | |
398 | once it is not responding. (If Emacs is using X Windows directly, you | |
399 | can stop Emacs by typing C-z at the GDB job.) Then try stepping with | |
400 | `step'. If Emacs is hung, the `step' command won't return. If it is | |
401 | looping, `step' will return. | |
402 | ||
403 | If this shows Emacs is hung in a system call, stop it again and | |
404 | examine the arguments of the call. If you report the bug, it is very | |
405 | important to state exactly where in the source the system call is, and | |
406 | what the arguments are. | |
407 | ||
408 | If Emacs is in an infinite loop, try to determine where the loop | |
409 | starts and ends. The easiest way to do this is to use the GDB command | |
410 | `finish'. Each time you use it, Emacs resumes execution until it | |
411 | exits one stack frame. Keep typing `finish' until it doesn't | |
412 | return--that means the infinite loop is in the stack frame which you | |
413 | just tried to finish. | |
414 | ||
415 | Stop Emacs again, and use `finish' repeatedly again until you get back | |
416 | to that frame. Then use `next' to step through that frame. By | |
417 | stepping, you will see where the loop starts and ends. Also, examine | |
418 | the data being used in the loop and try to determine why the loop does | |
419 | not exit when it should. | |
420 | ||
0438ce91 DC |
421 | You can also trying sending Emacs SIGUSR2, which, if `debug-on-event' |
422 | has its default value, will cause Emacs to attempt to break it out of | |
423 | its current loop and into the Lisp debugger. This feature is useful | |
424 | when a C-level debugger is not conveniently available. | |
425 | ||
437368fe EZ |
426 | ** If certain operations in Emacs are slower than they used to be, here |
427 | is some advice for how to find out why. | |
428 | ||
429 | Stop Emacs repeatedly during the slow operation, and make a backtrace | |
430 | each time. Compare the backtraces looking for a pattern--a specific | |
431 | function that shows up more often than you'd expect. | |
432 | ||
433 | If you don't see a pattern in the C backtraces, get some Lisp | |
434 | backtrace information by typing "xbacktrace" or by looking at Ffuncall | |
435 | frames (see above), and again look for a pattern. | |
436 | ||
437 | When using X, you can stop Emacs at any time by typing C-z at GDB. | |
438 | When not using X, you can do this with C-g. On non-Unix platforms, | |
439 | such as MS-DOS, you might need to press C-BREAK instead. | |
440 | ||
a933dad1 DL |
441 | ** If GDB does not run and your debuggers can't load Emacs. |
442 | ||
443 | On some systems, no debugger can load Emacs with a symbol table, | |
444 | perhaps because they all have fixed limits on the number of symbols | |
445 | and Emacs exceeds the limits. Here is a method that can be used | |
446 | in such an extremity. Do | |
447 | ||
448 | nm -n temacs > nmout | |
449 | strip temacs | |
450 | adb temacs | |
451 | 0xd:i | |
452 | 0xe:i | |
453 | 14:i | |
454 | 17:i | |
455 | :r -l loadup (or whatever) | |
456 | ||
457 | It is necessary to refer to the file `nmout' to convert | |
458 | numeric addresses into symbols and vice versa. | |
459 | ||
460 | It is useful to be running under a window system. | |
6259c2ec GM |
461 | Then, if Emacs becomes hopelessly wedged, you can create another |
462 | window to do kill -9 in. kill -ILL is often useful too, since that | |
463 | may make Emacs dump core or return to adb. | |
a933dad1 DL |
464 | |
465 | ||
466 | ** Debugging incorrect screen updating. | |
467 | ||
468 | To debug Emacs problems that update the screen wrong, it is useful | |
469 | to have a record of what input you typed and what Emacs sent to the | |
470 | screen. To make these records, do | |
471 | ||
472 | (open-dribble-file "~/.dribble") | |
473 | (open-termscript "~/.termscript") | |
474 | ||
475 | The dribble file contains all characters read by Emacs from the | |
476 | terminal, and the termscript file contains all characters it sent to | |
477 | the terminal. The use of the directory `~/' prevents interference | |
478 | with any other user. | |
479 | ||
480 | If you have irreproducible display problems, put those two expressions | |
481 | in your ~/.emacs file. When the problem happens, exit the Emacs that | |
482 | you were running, kill it, and rename the two files. Then you can start | |
483 | another Emacs without clobbering those files, and use it to examine them. | |
125f929e MB |
484 | |
485 | An easy way to see if too much text is being redrawn on a terminal is to | |
486 | evaluate `(setq inverse-video t)' before you try the operation you think | |
487 | will cause too much redrawing. This doesn't refresh the screen, so only | |
488 | newly drawn text is in inverse video. | |
437368fe | 489 | |
3f715e77 EZ |
490 | The Emacs display code includes special debugging code, but it is |
491 | normally disabled. You can enable it by building Emacs with the | |
492 | pre-processing symbol GLYPH_DEBUG defined. Here's one easy way, | |
493 | suitable for Unix and GNU systems, to build such a debugging version: | |
494 | ||
495 | MYCPPFLAGS='-DGLYPH_DEBUG=1' make | |
496 | ||
497 | Building Emacs like that activates many assertions which scrutinize | |
498 | display code operation more than Emacs does normally. (To see the | |
499 | code which tests these assertions, look for calls to the `xassert' | |
6259c2ec | 500 | macros.) Any assertion that is reported to fail should be investigated. |
3f715e77 EZ |
501 | |
502 | Building with GLYPH_DEBUG defined also defines several helper | |
503 | functions which can help debugging display code. One such function is | |
504 | `dump_glyph_matrix'. If you run Emacs under GDB, you can print the | |
505 | contents of any glyph matrix by just calling that function with the | |
506 | matrix as its argument. For example, the following command will print | |
6259c2ec | 507 | the contents of the current matrix of the window whose pointer is in `w': |
3f715e77 EZ |
508 | |
509 | (gdb) p dump_glyph_matrix (w->current_matrix, 2) | |
510 | ||
511 | (The second argument 2 tells dump_glyph_matrix to print the glyphs in | |
512 | a long form.) You can dump the selected window's current glyph matrix | |
513 | interactively with "M-x dump-glyph-matrix RET"; see the documentation | |
514 | of this function for more details. | |
515 | ||
516 | Several more functions for debugging display code are available in | |
71d6b459 EZ |
517 | Emacs compiled with GLYPH_DEBUG defined; type "C-h f dump- TAB" and |
518 | "C-h f trace- TAB" to see the full list. | |
3f715e77 | 519 | |
1ce9f40a KS |
520 | When you debug display problems running emacs under X, you can use |
521 | the `ff' command to flush all pending display updates to the screen. | |
522 | ||
437368fe EZ |
523 | |
524 | ** Debugging LessTif | |
525 | ||
526 | If you encounter bugs whereby Emacs built with LessTif grabs all mouse | |
527 | and keyboard events, or LessTif menus behave weirdly, it might be | |
528 | helpful to set the `DEBUGSOURCES' and `DEBUG_FILE' environment | |
529 | variables, so that one can see what LessTif was doing at this point. | |
530 | For instance | |
177c0ea7 | 531 | |
6806e867 | 532 | export DEBUGSOURCES="RowColumn.c:MenuShell.c:MenuUtil.c" |
437368fe | 533 | export DEBUG_FILE=/usr/tmp/LESSTIF_TRACE |
2aa25884 | 534 | emacs & |
437368fe EZ |
535 | |
536 | causes LessTif to print traces from the three named source files to a | |
2aa25884 EZ |
537 | file in `/usr/tmp' (that file can get pretty large). The above should |
538 | be typed at the shell prompt before invoking Emacs, as shown by the | |
539 | last line above. | |
437368fe EZ |
540 | |
541 | Running GDB from another terminal could also help with such problems. | |
542 | You can arrange for GDB to run on one machine, with the Emacs display | |
543 | appearing on another. Then, when the bug happens, you can go back to | |
544 | the machine where you started GDB and use the debugger from there. | |
545 | ||
546 | ||
437368fe EZ |
547 | ** Debugging problems which happen in GC |
548 | ||
f46cc673 EZ |
549 | The array `last_marked' (defined on alloc.c) can be used to display up |
550 | to 500 last objects marked by the garbage collection process. | |
62578de5 | 551 | Whenever the garbage collector marks a Lisp object, it records the |
1a527e27 EZ |
552 | pointer to that object in the `last_marked' array, which is maintained |
553 | as a circular buffer. The variable `last_marked_index' holds the | |
554 | index into the `last_marked' array one place beyond where the pointer | |
555 | to the very last marked object is stored. | |
437368fe EZ |
556 | |
557 | The single most important goal in debugging GC problems is to find the | |
558 | Lisp data structure that got corrupted. This is not easy since GC | |
559 | changes the tag bits and relocates strings which make it hard to look | |
560 | at Lisp objects with commands such as `pr'. It is sometimes necessary | |
561 | to convert Lisp_Object variables into pointers to C struct's manually. | |
437368fe | 562 | |
1a527e27 EZ |
563 | Use the `last_marked' array and the source to reconstruct the sequence |
564 | that objects were marked. In general, you need to correlate the | |
565 | values recorded in the `last_marked' array with the corresponding | |
566 | stack frames in the backtrace, beginning with the innermost frame. | |
567 | Some subroutines of `mark_object' are invoked recursively, others loop | |
568 | over portions of the data structure and mark them as they go. By | |
569 | looking at the code of those routines and comparing the frames in the | |
570 | backtrace with the values in `last_marked', you will be able to find | |
571 | connections between the values in `last_marked'. E.g., when GC finds | |
572 | a cons cell, it recursively marks its car and its cdr. Similar things | |
573 | happen with properties of symbols, elements of vectors, etc. Use | |
574 | these connections to reconstruct the data structure that was being | |
575 | marked, paying special attention to the strings and names of symbols | |
576 | that you encounter: these strings and symbol names can be used to grep | |
577 | the sources to find out what high-level symbols and global variables | |
578 | are involved in the crash. | |
579 | ||
580 | Once you discover the corrupted Lisp object or data structure, grep | |
581 | the sources for its uses and try to figure out what could cause the | |
2fbcf174 | 582 | corruption. If looking at the sources doesn't help, you could try |
1a527e27 EZ |
583 | setting a watchpoint on the corrupted data, and see what code modifies |
584 | it in some invalid way. (Obviously, this technique is only useful for | |
585 | data that is modified only very rarely.) | |
586 | ||
587 | It is also useful to look at the corrupted object or data structure in | |
588 | a fresh Emacs session and compare its contents with a session that you | |
589 | are debugging. | |
437368fe | 590 | |
93699019 EZ |
591 | ** Debugging problems with non-ASCII characters |
592 | ||
593 | If you experience problems which seem to be related to non-ASCII | |
594 | characters, such as \201 characters appearing in the buffer or in your | |
595 | files, set the variable byte-debug-flag to t. This causes Emacs to do | |
596 | some extra checks, such as look for broken relations between byte and | |
597 | character positions in buffers and strings; the resulting diagnostics | |
598 | might pinpoint the cause of the problem. | |
599 | ||
036cb5a2 EZ |
600 | ** Debugging the TTY (non-windowed) version |
601 | ||
602 | The most convenient method of debugging the character-terminal display | |
603 | is to do that on a window system such as X. Begin by starting an | |
604 | xterm window, then type these commands inside that window: | |
605 | ||
606 | $ tty | |
607 | $ echo $TERM | |
608 | ||
609 | Let's say these commands print "/dev/ttyp4" and "xterm", respectively. | |
610 | ||
611 | Now start Emacs (the normal, windowed-display session, i.e. without | |
612 | the `-nw' option), and invoke "M-x gdb RET emacs RET" from there. Now | |
613 | type these commands at GDB's prompt: | |
614 | ||
615 | (gdb) set args -nw -t /dev/ttyp4 | |
616 | (gdb) set environment TERM xterm | |
617 | (gdb) run | |
618 | ||
619 | The debugged Emacs should now start in no-window mode with its display | |
620 | directed to the xterm window you opened above. | |
621 | ||
e039053d EZ |
622 | Similar arrangement is possible on a character terminal by using the |
623 | `screen' package. | |
624 | ||
19cf8f36 EZ |
625 | ** Running Emacs built with malloc debugging packages |
626 | ||
627 | If Emacs exhibits bugs that seem to be related to use of memory | |
628 | allocated off the heap, it might be useful to link Emacs with a | |
629 | special debugging library, such as Electric Fence (a.k.a. efence) or | |
630 | GNU Checker, which helps find such problems. | |
631 | ||
632 | Emacs compiled with such packages might not run without some hacking, | |
633 | because Emacs replaces the system's memory allocation functions with | |
634 | its own versions, and because the dumping process might be | |
635 | incompatible with the way these packages use to track allocated | |
6259c2ec | 636 | memory. Here are some of the changes you might find necessary: |
19cf8f36 | 637 | |
6259c2ec | 638 | - Edit configure, to set system_malloc and CANNOT_DUMP to "yes". |
19cf8f36 EZ |
639 | |
640 | - Configure with a different --prefix= option. If you use GCC, | |
641 | version 2.7.2 is preferred, as some malloc debugging packages | |
642 | work a lot better with it than with 2.95 or later versions. | |
643 | ||
644 | - Type "make" then "make -k install". | |
645 | ||
646 | - If required, invoke the package-specific command to prepare | |
647 | src/temacs for execution. | |
648 | ||
649 | - cd ..; src/temacs | |
650 | ||
651 | (Note that this runs `temacs' instead of the usual `emacs' executable. | |
652 | This avoids problems with dumping Emacs mentioned above.) | |
653 | ||
654 | Some malloc debugging libraries might print lots of false alarms for | |
655 | bitfields used by Emacs in some data structures. If you want to get | |
656 | rid of the false alarms, you will have to hack the definitions of | |
657 | these data structures on the respective headers to remove the `:N' | |
658 | bitfield definitions (which will cause each such field to use a full | |
659 | int). | |
660 | ||
270bf00e EZ |
661 | ** How to recover buffer contents from an Emacs core dump file |
662 | ||
663 | The file etc/emacs-buffer.gdb defines a set of GDB commands for | |
664 | recovering the contents of Emacs buffers from a core dump file. You | |
665 | might also find those commands useful for displaying the list of | |
666 | buffers in human-readable format from within the debugger. | |
667 | ||
437368fe EZ |
668 | ** Some suggestions for debugging on MS Windows: |
669 | ||
670 | (written by Marc Fleischeuers, Geoff Voelker and Andrew Innes) | |
671 | ||
3102e429 | 672 | To debug Emacs with Microsoft Visual C++, you either start emacs from |
961e2394 EZ |
673 | the debugger or attach the debugger to a running emacs process. |
674 | ||
675 | To start emacs from the debugger, you can use the file bin/debug.bat. | |
676 | The Microsoft Developer studio will start and under Project, Settings, | |
3102e429 | 677 | Debug, General you can set the command-line arguments and Emacs's |
437368fe EZ |
678 | startup directory. Set breakpoints (Edit, Breakpoints) at Fsignal and |
679 | other functions that you want to examine. Run the program (Build, | |
680 | Start debug). Emacs will start and the debugger will take control as | |
681 | soon as a breakpoint is hit. | |
682 | ||
3102e429 | 683 | You can also attach the debugger to an already running Emacs process. |
437368fe EZ |
684 | To do this, start up the Microsoft Developer studio and select Build, |
685 | Start debug, Attach to process. Choose the Emacs process from the | |
686 | list. Send a break to the running process (Debug, Break) and you will | |
687 | find that execution is halted somewhere in user32.dll. Open the stack | |
688 | trace window and go up the stack to w32_msg_pump. Now you can set | |
689 | breakpoints in Emacs (Edit, Breakpoints). Continue the running Emacs | |
690 | process (Debug, Step out) and control will return to Emacs, until a | |
691 | breakpoint is hit. | |
692 | ||
3102e429 | 693 | To examine the contents of a Lisp variable, you can use the function |
437368fe EZ |
694 | 'debug_print'. Right-click on a variable, select QuickWatch (it has |
695 | an eyeglass symbol on its button in the toolbar), and in the text | |
696 | field at the top of the window, place 'debug_print(' and ')' around | |
697 | the expression. Press 'Recalculate' and the output is sent to stderr, | |
698 | and to the debugger via the OutputDebugString routine. The output | |
699 | sent to stderr should be displayed in the console window that was | |
700 | opened when the emacs.exe executable was started. The output sent to | |
701 | the debugger should be displayed in the 'Debug' pane in the Output | |
702 | window. If Emacs was started from the debugger, a console window was | |
703 | opened at Emacs' startup; this console window also shows the output of | |
704 | 'debug_print'. | |
705 | ||
706 | For example, start and run Emacs in the debugger until it is waiting | |
707 | for user input. Then click on the `Break' button in the debugger to | |
708 | halt execution. Emacs should halt in `ZwUserGetMessage' waiting for | |
709 | an input event. Use the `Call Stack' window to select the procedure | |
710 | `w32_msp_pump' up the call stack (see below for why you have to do | |
711 | this). Open the QuickWatch window and enter | |
712 | "debug_print(Vexec_path)". Evaluating this expression will then print | |
3102e429 | 713 | out the contents of the Lisp variable `exec-path'. |
437368fe EZ |
714 | |
715 | If QuickWatch reports that the symbol is unknown, then check the call | |
716 | stack in the `Call Stack' window. If the selected frame in the call | |
717 | stack is not an Emacs procedure, then the debugger won't recognize | |
718 | Emacs symbols. Instead, select a frame that is inside an Emacs | |
719 | procedure and try using `debug_print' again. | |
720 | ||
721 | If QuickWatch invokes debug_print but nothing happens, then check the | |
722 | thread that is selected in the debugger. If the selected thread is | |
723 | not the last thread to run (the "current" thread), then it cannot be | |
724 | used to execute debug_print. Use the Debug menu to select the current | |
725 | thread and try using debug_print again. Note that the debugger halts | |
726 | execution (e.g., due to a breakpoint) in the context of the current | |
727 | thread, so this should only be a problem if you've explicitly switched | |
728 | threads. | |
729 | ||
3102e429 | 730 | It is also possible to keep appropriately masked and typecast Lisp |
437368fe EZ |
731 | symbols in the Watch window, this is more convenient when steeping |
732 | though the code. For instance, on entering apply_lambda, you can | |
733 | watch (struct Lisp_Symbol *) (0xfffffff & args[0]). | |
961e2394 EZ |
734 | |
735 | Optimizations often confuse the MS debugger. For example, the | |
736 | debugger will sometimes report wrong line numbers, e.g., when it | |
737 | prints the backtrace for a crash. It is usually best to look at the | |
738 | disassembly to determine exactly what code is being run--the | |
739 | disassembly will probably show several source lines followed by a | |
740 | block of assembler for those lines. The actual point where Emacs | |
2fbcf174 | 741 | crashes will be one of those source lines, but not necessarily the one |
961e2394 EZ |
742 | that the debugger reports. |
743 | ||
744 | Another problematic area with the MS debugger is with variables that | |
745 | are stored in registers: it will sometimes display wrong values for | |
746 | those variables. Usually you will not be able to see any value for a | |
747 | register variable, but if it is only being stored in a register | |
748 | temporarily, you will see an old value for it. Again, you need to | |
749 | look at the disassembly to determine which registers are being used, | |
750 | and look at those registers directly, to see the actual current values | |
751 | of these variables. | |
ab5796a9 | 752 | |
bf69439f | 753 | \f |
5b87ad55 GM |
754 | This file is part of GNU Emacs. |
755 | ||
ab73e885 | 756 | GNU Emacs is free software: you can redistribute it and/or modify |
5b87ad55 | 757 | it under the terms of the GNU General Public License as published by |
ab73e885 GM |
758 | the Free Software Foundation, either version 3 of the License, or |
759 | (at your option) any later version. | |
5b87ad55 GM |
760 | |
761 | GNU Emacs is distributed in the hope that it will be useful, | |
762 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
763 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
764 | GNU General Public License for more details. | |
765 | ||
766 | You should have received a copy of the GNU General Public License | |
ab73e885 | 767 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
5b87ad55 GM |
768 | |
769 | \f | |
bf69439f NR |
770 | Local variables: |
771 | mode: outline | |
772 | paragraph-separate: "[ \f]*$" | |
773 | end: |