Mercurial > emacs
annotate etc/DEBUG @ 69431:2dc590b0aeb9
(x_create_tip_frame): Apply 2006-03-11 change for xfns.c.
author | YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp> |
---|---|
date | Sun, 12 Mar 2006 08:19:50 +0000 |
parents | e8a3fb527b77 |
children | 4a8aa0c1f128 c5406394f567 |
rev | line source |
---|---|
25853 | 1 Debugging GNU Emacs |
65088
f05a048483cc
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
63310
diff
changeset
|
2 Copyright (C) 1985, 2000, 2001, 2002, 2003, 2004, |
68640
e8a3fb527b77
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
66719
diff
changeset
|
3 2005, 2006 Free Software Foundation, Inc. |
25853 | 4 |
5 Permission is granted to anyone to make or distribute verbatim copies | |
6 of this document as received, in any medium, provided that the | |
7 copyright notice and permission notice are preserved, | |
8 and that the distributor grants the recipient permission | |
9 for further redistribution as permitted by this notice. | |
10 | |
11 Permission is granted to distribute modified versions | |
12 of this document, or of portions of it, | |
13 under the above conditions, provided also that they | |
14 carry prominent notices stating who last changed them. | |
15 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
16 [People who debug Emacs on Windows using native Windows debuggers |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
17 should read the Windows-specific section near the end of this |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
18 document.] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
19 |
43432
7fe131ded6d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
43106
diff
changeset
|
20 ** When you debug Emacs with GDB, you should start it in the directory |
59939 | 21 where the executable was made. That directory has a .gdbinit file |
22 that defines various "user-defined" commands for debugging Emacs. | |
43432
7fe131ded6d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
43106
diff
changeset
|
23 |
60334
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
24 ** When you are trying to analyze failed assertions, it will be |
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
25 essential to compile Emacs either completely without optimizations or |
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
26 at least (when using GCC) with the -fno-crossjumping option. Failure |
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
27 to do so may make the compiler recycle the same abort call for all |
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
28 assertions in a given function, rendering the stack backtrace useless |
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
29 for identifying the specific failed assertion. |
ec7a860cdd57
Add information about `-fno-crossjumping' for GCC.
David Kastrup <dak@gnu.org>
parents:
59939
diff
changeset
|
30 |
43432
7fe131ded6d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
43106
diff
changeset
|
31 ** It is a good idea to run Emacs under GDB (or some other suitable |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
32 debugger) *all the time*. Then, when Emacs crashes, you will be able |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
33 to debug the live process, not just a core dump. (This is especially |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
34 important on systems which don't support core files, and instead print |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
35 just the registers and some stack addresses.) |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
36 |
43432
7fe131ded6d9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
43106
diff
changeset
|
37 ** If Emacs hangs, or seems to be stuck in some infinite loop, typing |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
38 "kill -TSTP PID", where PID is the Emacs process ID, will cause GDB to |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
39 kick in, provided that you run under GDB. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
40 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
41 ** Getting control to the debugger |
25853 | 42 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
43 `Fsignal' is a very useful place to put a breakpoint in. |
25853 | 44 All Lisp errors go through there. |
45 | |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
46 It is useful, when debugging, to have a guaranteed way to return to |
44813
927a6a3e6c8f
Tell them to use C-z, not C-c, to stop Emacs under X.
Eli Zaretskii <eliz@gnu.org>
parents:
43432
diff
changeset
|
47 the debugger at any time. When using X, this is easy: type C-z at the |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
48 window where Emacs is running under GDB, and it will stop Emacs just |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
49 as it would stop any ordinary program. When Emacs is running in a |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
50 terminal, things are not so easy. |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
51 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
52 The src/.gdbinit file in the Emacs distribution arranges for SIGINT |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
53 (C-g in Emacs) to be passed to Emacs and not give control back to GDB. |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
54 On modern POSIX systems, you can override that with this command: |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
55 |
43106
cd4549362019
Fix a typo in "handle SIGINT" command.
Eli Zaretskii <eliz@gnu.org>
parents:
41839
diff
changeset
|
56 handle SIGINT stop nopass |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
57 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
58 After this `handle' command, SIGINT will return control to GDB. If |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
59 you want the C-g to cause a QUIT within Emacs as well, omit the |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
60 `nopass'. |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
61 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
62 A technique that can work when `handle SIGINT' does not is to store |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
63 the code for some character into the variable stop_character. Thus, |
25853 | 64 |
65 set stop_character = 29 | |
66 | |
67 makes Control-] (decimal code 29) the stop character. | |
68 Typing Control-] will cause immediate stop. You cannot | |
69 use the set command until the inferior process has been started. | |
70 Put a breakpoint early in `main', or suspend the Emacs, | |
71 to get an opportunity to do the set command. | |
72 | |
59613
1c3d052ef4bf
Suggest separate terminal for debug session.
Nick Roberts <nickrob@snap.net.nz>
parents:
58969
diff
changeset
|
73 When Emacs is running in a terminal, it is useful to use a separate terminal |
1c3d052ef4bf
Suggest separate terminal for debug session.
Nick Roberts <nickrob@snap.net.nz>
parents:
58969
diff
changeset
|
74 for the debug session. This can be done by starting Emacs as usual, then |
1c3d052ef4bf
Suggest separate terminal for debug session.
Nick Roberts <nickrob@snap.net.nz>
parents:
58969
diff
changeset
|
75 attaching to it from gdb with the `attach' command which is explained in the |
1c3d052ef4bf
Suggest separate terminal for debug session.
Nick Roberts <nickrob@snap.net.nz>
parents:
58969
diff
changeset
|
76 node "Attach" of the GDB manual. |
1c3d052ef4bf
Suggest separate terminal for debug session.
Nick Roberts <nickrob@snap.net.nz>
parents:
58969
diff
changeset
|
77 |
25853 | 78 ** Examining Lisp object values. |
79 | |
80 When you have a live process to debug, and it has not encountered a | |
81 fatal error, you can use the GDB command `pr'. First print the value | |
82 in the ordinary way, with the `p' command. Then type `pr' with no | |
83 arguments. This calls a subroutine which uses the Lisp printer. | |
84 | |
57307 | 85 You can also use `pp value' to print the emacs value directly. |
86 | |
87 Note: It is not a good idea to try `pr' or `pp' if you know that Emacs | |
88 is in deep trouble: its stack smashed (e.g., if it encountered SIGSEGV | |
89 due to stack overflow), or crucial data structures, such as `obarray', | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
90 corrupted, etc. In such cases, the Emacs subroutine called by `pr' |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
91 might make more damage, like overwrite some data that is important for |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
92 debugging the original problem. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
93 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
94 Also, on some systems it is impossible to use `pr' if you stopped |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
95 Emacs while it was inside `select'. This is in fact what happens if |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
96 you stop Emacs while it is waiting. In such a situation, don't try to |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
97 use `pr'. Instead, use `s' to step out of the system call. Then |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
98 Emacs will be between instructions and capable of handling `pr'. |
25853 | 99 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
100 If you can't use `pr' command, for whatever reason, you can fall back |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
101 on lower-level commands. Use the `xtype' command to print out the |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
102 data type of the last data value. Once you know the data type, use |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
103 the command that corresponds to that type. Here are these commands: |
25853 | 104 |
105 xint xptr xwindow xmarker xoverlay xmiscfree xintfwd xboolfwd xobjfwd | |
106 xbufobjfwd xkbobjfwd xbuflocal xbuffer xsymbol xstring xvector xframe | |
107 xwinconfig xcompiled xcons xcar xcdr xsubr xprocess xfloat xscrollbar | |
108 | |
109 Each one of them applies to a certain type or class of types. | |
110 (Some of these types are not visible in Lisp, because they exist only | |
111 internally.) | |
112 | |
113 Each x... command prints some information about the value, and | |
114 produces a GDB value (subsequently available in $) through which you | |
115 can get at the rest of the contents. | |
116 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
117 In general, most of the rest of the contents will be additional Lisp |
25853 | 118 objects which you can examine in turn with the x... commands. |
119 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
120 Even with a live process, these x... commands are useful for |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
121 examining the fields in a buffer, window, process, frame or marker. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
122 Here's an example using concepts explained in the node "Value History" |
58969
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
123 of the GDB manual to print values associated with the variable |
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
124 called frame. First, use these commands: |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
125 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
126 cd src |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
127 gdb emacs |
58969
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
128 b set_frame_buffer_list |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49489
diff
changeset
|
129 r -q |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
130 |
59613
1c3d052ef4bf
Suggest separate terminal for debug session.
Nick Roberts <nickrob@snap.net.nz>
parents:
58969
diff
changeset
|
131 Then Emacs hits the breakpoint: |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
132 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
133 (gdb) p frame |
58969
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
134 $1 = 139854428 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
135 (gdb) xtype |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
136 Lisp_Vectorlike |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
137 PVEC_FRAME |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
138 (gdb) xframe |
58969
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
139 $2 = (struct frame *) 0x8560258 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
140 (gdb) p *$ |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
141 $3 = { |
58969
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
142 size = 1073742931, |
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
143 next = 0x85dfe58, |
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
144 name = 140615219, |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
145 [...] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
146 } |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
147 (gdb) p $3->name |
58969
eae7969f1b06
Change printing example to break on a procedure name.
Nick Roberts <nickrob@snap.net.nz>
parents:
57307
diff
changeset
|
148 $4 = 140615219 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
149 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
150 Now we can use `pr' to print the name of the frame: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
151 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
152 (gdb) pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
153 "emacs@steenrod.math.nwu.edu" |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
154 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
155 The Emacs C code heavily uses macros defined in lisp.h. So suppose |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
156 we want the address of the l-value expression near the bottom of |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
157 `add_command_key' from keyboard.c: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
158 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
159 XVECTOR (this_command_keys)->contents[this_command_key_count++] = key; |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
160 |
66719
c0eb744f79f7
Describe how to provide preprocessor macro information.
Nick Roberts <nickrob@snap.net.nz>
parents:
66645
diff
changeset
|
161 XVECTOR is a macro, so GDB only knows about it if Emacs has been compiled with |
c0eb744f79f7
Describe how to provide preprocessor macro information.
Nick Roberts <nickrob@snap.net.nz>
parents:
66645
diff
changeset
|
162 preprocessor macro information. GCC provides this if you specify the options |
c0eb744f79f7
Describe how to provide preprocessor macro information.
Nick Roberts <nickrob@snap.net.nz>
parents:
66645
diff
changeset
|
163 `-gdwarf-2' and `-g3'. In this case, GDB can evaluate expressions like |
c0eb744f79f7
Describe how to provide preprocessor macro information.
Nick Roberts <nickrob@snap.net.nz>
parents:
66645
diff
changeset
|
164 "p XVECTOR (this_command_keys)". |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
165 |
66719
c0eb744f79f7
Describe how to provide preprocessor macro information.
Nick Roberts <nickrob@snap.net.nz>
parents:
66645
diff
changeset
|
166 When this information isn't available, you can use the xvector command in GDB |
c0eb744f79f7
Describe how to provide preprocessor macro information.
Nick Roberts <nickrob@snap.net.nz>
parents:
66645
diff
changeset
|
167 to get the same result. Here is how: |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
168 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
169 (gdb) p this_command_keys |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
170 $1 = 1078005760 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
171 (gdb) xvector |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
172 $2 = (struct Lisp_Vector *) 0x411000 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
173 0 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
174 (gdb) p $->contents[this_command_key_count] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
175 $3 = 1077872640 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
176 (gdb) p &$ |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
177 $4 = (int *) 0x411008 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
178 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
179 Here's a related example of macros and the GDB `define' command. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
180 There are many Lisp vectors such as `recent_keys', which contains the |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
181 last 100 keystrokes. We can print this Lisp vector |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
182 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
183 p recent_keys |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
184 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
185 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
186 But this may be inconvenient, since `recent_keys' is much more verbose |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
187 than `C-h l'. We might want to print only the last 10 elements of |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
188 this vector. `recent_keys' is updated in keyboard.c by the command |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
189 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
190 XVECTOR (recent_keys)->contents[recent_keys_index] = c; |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
191 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
192 So we define a GDB command `xvector-elts', so the last 10 keystrokes |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49489
diff
changeset
|
193 are printed by |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
194 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
195 xvector-elts recent_keys recent_keys_index 10 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
196 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
197 where you can define xvector-elts as follows: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
198 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
199 define xvector-elts |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
200 set $i = 0 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
201 p $arg0 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
202 xvector |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
203 set $foo = $ |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
204 while $i < $arg2 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49489
diff
changeset
|
205 p $foo->contents[$arg1-($i++)] |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
206 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
207 end |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
208 document xvector-elts |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
209 Prints a range of elements of a Lisp vector. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
210 xvector-elts v n i |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
211 prints `i' elements of the vector `v' ending at the index `n'. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
212 end |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
213 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
214 ** Getting Lisp-level backtrace information within GDB |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
215 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
216 The most convenient way is to use the `xbacktrace' command. This |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
217 shows the names of the Lisp functions that are currently active. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
218 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
219 If that doesn't work (e.g., because the `backtrace_list' structure is |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
220 corrupted), type "bt" at the GDB prompt, to produce the C-level |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
221 backtrace, and look for stack frames that call Ffuncall. Select them |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
222 one by one in GDB, by typing "up N", where N is the appropriate number |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
223 of frames to go up, and in each frame that calls Ffuncall type this: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
224 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
225 p *args |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
226 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
227 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
228 This will print the name of the Lisp function called by that level |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
229 of function calling. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
230 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
231 By printing the remaining elements of args, you can see the argument |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
232 values. Here's how to print the first argument: |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49489
diff
changeset
|
233 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
234 p args[1] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
235 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
236 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
237 If you do not have a live process, you can use xtype and the other |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
238 x... commands such as xsymbol to get such information, albeit less |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
239 conveniently. For example: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
240 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
241 p *args |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
242 xtype |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
243 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
244 and, assuming that "xtype" says that args[0] is a symbol: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
245 |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49489
diff
changeset
|
246 xsymbol |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
247 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
248 ** Debugging what happens while preloading and dumping Emacs |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
249 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
250 Type `gdb temacs' and start it with `r -batch -l loadup dump'. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
251 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
252 If temacs actually succeeds when running under GDB in this way, do not |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
253 try to run the dumped Emacs, because it was dumped with the GDB |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
254 breakpoints in it. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
255 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
256 ** Debugging `temacs' |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
257 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
258 Debugging `temacs' is useful when you want to establish whether a |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
259 problem happens in an undumped Emacs. To run `temacs' under a |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
260 debugger, type "gdb temacs", then start it with `r -batch -l loadup'. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
261 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
262 ** If you encounter X protocol errors |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
263 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
264 Try evaluating (x-synchronize t). That puts Emacs into synchronous |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
265 mode, where each Xlib call checks for errors before it returns. This |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
266 mode is much slower, but when you get an error, you will see exactly |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
267 which call really caused the error. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
268 |
36962
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
269 You can start Emacs in a synchronous mode by invoking it with the -xrm |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
270 option, like this: |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
271 |
37534
3ea5075dc420
Fix a typo in the "emacs -xrm" command line. Reported by Kenichi Handa.
Eli Zaretskii <eliz@gnu.org>
parents:
37509
diff
changeset
|
272 emacs -xrm "emacs.synchronous: true" |
36962
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
273 |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
274 Setting a breakpoint in the function `x_error_quitter' and looking at |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
275 the backtrace when Emacs stops inside that function will show what |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
276 code causes the X protocol errors. |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
277 |
41839
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
278 Some bugs related to the X protocol disappear when Emacs runs in a |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
279 synchronous mode. To track down those bugs, we suggest the following |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
280 procedure: |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
281 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
282 - Run Emacs under a debugger and put a breakpoint inside the |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
283 primitive function which, when called from Lisp, triggers the X |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
284 protocol errors. For example, if the errors happen when you |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
285 delete a frame, put a breakpoint inside `Fdelete_frame'. |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
286 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
287 - When the breakpoint breaks, step through the code, looking for |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
288 calls to X functions (the ones whose names begin with "X" or |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
289 "Xt" or "Xm"). |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
290 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
291 - Insert calls to `XSync' before and after each call to the X |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
292 functions, like this: |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
293 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
294 XSync (f->output_data.x->display_info->display, 0); |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
295 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
296 where `f' is the pointer to the `struct frame' of the selected |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
297 frame, normally available via XFRAME (selected_frame). (Most |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
298 functions which call X already have some variable that holds the |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
299 pointer to the frame, perhaps called `f' or `sf', so you shouldn't |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
300 need to compute it.) |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
301 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
302 If your debugger can call functions in the program being debugged, |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
303 you should be able to issue the calls to `XSync' without recompiling |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
304 Emacs. For example, with GDB, just type: |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
305 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
306 call XSync (f->output_data.x->display_info->display, 0) |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
307 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
308 before and immediately after the suspect X calls. If your |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
309 debugger does not support this, you will need to add these pairs |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
310 of calls in the source and rebuild Emacs. |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
311 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
312 Either way, systematically step through the code and issue these |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
313 calls until you find the first X function called by Emacs after |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
314 which a call to `XSync' winds up in the function |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
315 `x_error_quitter'. The first X function call for which this |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
316 happens is the one that generated the X protocol error. |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
317 |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
318 - You should now look around this offending X call and try to figure |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
319 out what is wrong with it. |
902e47b4907b
Advice how to debug X protocol error which disappear in the
Eli Zaretskii <eliz@gnu.org>
parents:
40348
diff
changeset
|
320 |
49489 | 321 ** If Emacs causes errors or memory leaks in your X server |
322 | |
323 You can trace the traffic between Emacs and your X server with a tool | |
324 like xmon, available at ftp://ftp.x.org/contrib/devel_tools/. | |
325 | |
326 Xmon can be used to see exactly what Emacs sends when X protocol errors | |
327 happen. If Emacs causes the X server memory usage to increase you can | |
328 use xmon to see what items Emacs creates in the server (windows, | |
329 graphical contexts, pixmaps) and what items Emacs delete. If there | |
330 are consistently more creations than deletions, the type of item | |
331 and the activity you do when the items get created can give a hint where | |
332 to start debugging. | |
333 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
334 ** If the symptom of the bug is that Emacs fails to respond |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
335 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
336 Don't assume Emacs is `hung'--it may instead be in an infinite loop. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
337 To find out which, make the problem happen under GDB and stop Emacs |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
338 once it is not responding. (If Emacs is using X Windows directly, you |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
339 can stop Emacs by typing C-z at the GDB job.) Then try stepping with |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
340 `step'. If Emacs is hung, the `step' command won't return. If it is |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
341 looping, `step' will return. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
342 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
343 If this shows Emacs is hung in a system call, stop it again and |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
344 examine the arguments of the call. If you report the bug, it is very |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
345 important to state exactly where in the source the system call is, and |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
346 what the arguments are. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
347 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
348 If Emacs is in an infinite loop, try to determine where the loop |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
349 starts and ends. The easiest way to do this is to use the GDB command |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
350 `finish'. Each time you use it, Emacs resumes execution until it |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
351 exits one stack frame. Keep typing `finish' until it doesn't |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
352 return--that means the infinite loop is in the stack frame which you |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
353 just tried to finish. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
354 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
355 Stop Emacs again, and use `finish' repeatedly again until you get back |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
356 to that frame. Then use `next' to step through that frame. By |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
357 stepping, you will see where the loop starts and ends. Also, examine |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
358 the data being used in the loop and try to determine why the loop does |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
359 not exit when it should. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
360 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
361 ** If certain operations in Emacs are slower than they used to be, here |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
362 is some advice for how to find out why. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
363 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
364 Stop Emacs repeatedly during the slow operation, and make a backtrace |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
365 each time. Compare the backtraces looking for a pattern--a specific |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
366 function that shows up more often than you'd expect. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
367 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
368 If you don't see a pattern in the C backtraces, get some Lisp |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
369 backtrace information by typing "xbacktrace" or by looking at Ffuncall |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
370 frames (see above), and again look for a pattern. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
371 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
372 When using X, you can stop Emacs at any time by typing C-z at GDB. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
373 When not using X, you can do this with C-g. On non-Unix platforms, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
374 such as MS-DOS, you might need to press C-BREAK instead. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
375 |
25853 | 376 ** If GDB does not run and your debuggers can't load Emacs. |
377 | |
378 On some systems, no debugger can load Emacs with a symbol table, | |
379 perhaps because they all have fixed limits on the number of symbols | |
380 and Emacs exceeds the limits. Here is a method that can be used | |
381 in such an extremity. Do | |
382 | |
383 nm -n temacs > nmout | |
384 strip temacs | |
385 adb temacs | |
386 0xd:i | |
387 0xe:i | |
388 14:i | |
389 17:i | |
390 :r -l loadup (or whatever) | |
391 | |
392 It is necessary to refer to the file `nmout' to convert | |
393 numeric addresses into symbols and vice versa. | |
394 | |
395 It is useful to be running under a window system. | |
396 Then, if Emacs becomes hopelessly wedged, you can create | |
397 another window to do kill -9 in. kill -ILL is often | |
398 useful too, since that may make Emacs dump core or return | |
399 to adb. | |
400 | |
401 | |
402 ** Debugging incorrect screen updating. | |
403 | |
404 To debug Emacs problems that update the screen wrong, it is useful | |
405 to have a record of what input you typed and what Emacs sent to the | |
406 screen. To make these records, do | |
407 | |
408 (open-dribble-file "~/.dribble") | |
409 (open-termscript "~/.termscript") | |
410 | |
411 The dribble file contains all characters read by Emacs from the | |
412 terminal, and the termscript file contains all characters it sent to | |
413 the terminal. The use of the directory `~/' prevents interference | |
414 with any other user. | |
415 | |
416 If you have irreproducible display problems, put those two expressions | |
417 in your ~/.emacs file. When the problem happens, exit the Emacs that | |
418 you were running, kill it, and rename the two files. Then you can start | |
419 another Emacs without clobbering those files, and use it to examine them. | |
34594
9b989029cccf
Add note aboute using `inverse-video' to detect excessive screen redraw.
Miles Bader <miles@gnu.org>
parents:
32523
diff
changeset
|
420 |
9b989029cccf
Add note aboute using `inverse-video' to detect excessive screen redraw.
Miles Bader <miles@gnu.org>
parents:
32523
diff
changeset
|
421 An easy way to see if too much text is being redrawn on a terminal is to |
9b989029cccf
Add note aboute using `inverse-video' to detect excessive screen redraw.
Miles Bader <miles@gnu.org>
parents:
32523
diff
changeset
|
422 evaluate `(setq inverse-video t)' before you try the operation you think |
9b989029cccf
Add note aboute using `inverse-video' to detect excessive screen redraw.
Miles Bader <miles@gnu.org>
parents:
32523
diff
changeset
|
423 will cause too much redrawing. This doesn't refresh the screen, so only |
9b989029cccf
Add note aboute using `inverse-video' to detect excessive screen redraw.
Miles Bader <miles@gnu.org>
parents:
32523
diff
changeset
|
424 newly drawn text is in inverse video. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
425 |
37509
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
426 The Emacs display code includes special debugging code, but it is |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
427 normally disabled. You can enable it by building Emacs with the |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
428 pre-processing symbol GLYPH_DEBUG defined. Here's one easy way, |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
429 suitable for Unix and GNU systems, to build such a debugging version: |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
430 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
431 MYCPPFLAGS='-DGLYPH_DEBUG=1' make |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
432 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
433 Building Emacs like that activates many assertions which scrutinize |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
434 display code operation more than Emacs does normally. (To see the |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
435 code which tests these assertions, look for calls to the `xassert' |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
436 macros.) Any assertion that is reported to fail should be |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
437 investigated. |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
438 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
439 Building with GLYPH_DEBUG defined also defines several helper |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
440 functions which can help debugging display code. One such function is |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
441 `dump_glyph_matrix'. If you run Emacs under GDB, you can print the |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
442 contents of any glyph matrix by just calling that function with the |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
443 matrix as its argument. For example, the following command will print |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
444 the contents of the current matrix of the window whose pointer is in |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
445 `w': |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
446 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
447 (gdb) p dump_glyph_matrix (w->current_matrix, 2) |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
448 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
449 (The second argument 2 tells dump_glyph_matrix to print the glyphs in |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
450 a long form.) You can dump the selected window's current glyph matrix |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
451 interactively with "M-x dump-glyph-matrix RET"; see the documentation |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
452 of this function for more details. |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
453 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
454 Several more functions for debugging display code are available in |
37565 | 455 Emacs compiled with GLYPH_DEBUG defined; type "C-h f dump- TAB" and |
456 "C-h f trace- TAB" to see the full list. | |
37509
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
457 |
57307 | 458 When you debug display problems running emacs under X, you can use |
459 the `ff' command to flush all pending display updates to the screen. | |
460 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
461 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
462 ** Debugging LessTif |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
463 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
464 If you encounter bugs whereby Emacs built with LessTif grabs all mouse |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
465 and keyboard events, or LessTif menus behave weirdly, it might be |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
466 helpful to set the `DEBUGSOURCES' and `DEBUG_FILE' environment |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
467 variables, so that one can see what LessTif was doing at this point. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
468 For instance |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
49489
diff
changeset
|
469 |
36625
08aed53e171c
DEBUGSOURCES should contain a list of files, separated by colons.
Gerd Moellmann <gerd@gnu.org>
parents:
35861
diff
changeset
|
470 export DEBUGSOURCES="RowColumn.c:MenuShell.c:MenuUtil.c" |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
471 export DEBUG_FILE=/usr/tmp/LESSTIF_TRACE |
35720
c6ae90d82552
Clarify the instructions for debugging LessTif.
Eli Zaretskii <eliz@gnu.org>
parents:
35655
diff
changeset
|
472 emacs & |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
473 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
474 causes LessTif to print traces from the three named source files to a |
35720
c6ae90d82552
Clarify the instructions for debugging LessTif.
Eli Zaretskii <eliz@gnu.org>
parents:
35655
diff
changeset
|
475 file in `/usr/tmp' (that file can get pretty large). The above should |
c6ae90d82552
Clarify the instructions for debugging LessTif.
Eli Zaretskii <eliz@gnu.org>
parents:
35655
diff
changeset
|
476 be typed at the shell prompt before invoking Emacs, as shown by the |
c6ae90d82552
Clarify the instructions for debugging LessTif.
Eli Zaretskii <eliz@gnu.org>
parents:
35655
diff
changeset
|
477 last line above. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
478 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
479 Running GDB from another terminal could also help with such problems. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
480 You can arrange for GDB to run on one machine, with the Emacs display |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
481 appearing on another. Then, when the bug happens, you can go back to |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
482 the machine where you started GDB and use the debugger from there. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
483 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
484 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
485 ** Debugging problems which happen in GC |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
486 |
37015
f8dd0e40dc34
Make it clear that last_marked[] holds pointers to Lisp objects, not
Eli Zaretskii <eliz@gnu.org>
parents:
36962
diff
changeset
|
487 The array `last_marked' (defined on alloc.c) can be used to display up |
f8dd0e40dc34
Make it clear that last_marked[] holds pointers to Lisp objects, not
Eli Zaretskii <eliz@gnu.org>
parents:
36962
diff
changeset
|
488 to 500 last objects marked by the garbage collection process. |
37076
ec5579aad1bb
Fix the wording in the last change.
Eli Zaretskii <eliz@gnu.org>
parents:
37015
diff
changeset
|
489 Whenever the garbage collector marks a Lisp object, it records the |
ec5579aad1bb
Fix the wording in the last change.
Eli Zaretskii <eliz@gnu.org>
parents:
37015
diff
changeset
|
490 pointer to that object in the `last_marked' array. The variable |
37015
f8dd0e40dc34
Make it clear that last_marked[] holds pointers to Lisp objects, not
Eli Zaretskii <eliz@gnu.org>
parents:
36962
diff
changeset
|
491 `last_marked_index' holds the index into the `last_marked' array one |
f8dd0e40dc34
Make it clear that last_marked[] holds pointers to Lisp objects, not
Eli Zaretskii <eliz@gnu.org>
parents:
36962
diff
changeset
|
492 place beyond where the pointer to the very last marked object is |
f8dd0e40dc34
Make it clear that last_marked[] holds pointers to Lisp objects, not
Eli Zaretskii <eliz@gnu.org>
parents:
36962
diff
changeset
|
493 stored. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
494 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
495 The single most important goal in debugging GC problems is to find the |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
496 Lisp data structure that got corrupted. This is not easy since GC |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
497 changes the tag bits and relocates strings which make it hard to look |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
498 at Lisp objects with commands such as `pr'. It is sometimes necessary |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
499 to convert Lisp_Object variables into pointers to C struct's manually. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
500 Use the `last_marked' array and the source to reconstruct the sequence |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
501 that objects were marked. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
502 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
503 Once you discover the corrupted Lisp object or data structure, it is |
35861 | 504 useful to look at it in a fresh Emacs session and compare its contents |
505 with a session that you are debugging. | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
506 |
37481 | 507 ** Debugging problems with non-ASCII characters |
508 | |
509 If you experience problems which seem to be related to non-ASCII | |
510 characters, such as \201 characters appearing in the buffer or in your | |
511 files, set the variable byte-debug-flag to t. This causes Emacs to do | |
512 some extra checks, such as look for broken relations between byte and | |
513 character positions in buffers and strings; the resulting diagnostics | |
514 might pinpoint the cause of the problem. | |
515 | |
40247
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
516 ** Debugging the TTY (non-windowed) version |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
517 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
518 The most convenient method of debugging the character-terminal display |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
519 is to do that on a window system such as X. Begin by starting an |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
520 xterm window, then type these commands inside that window: |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
521 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
522 $ tty |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
523 $ echo $TERM |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
524 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
525 Let's say these commands print "/dev/ttyp4" and "xterm", respectively. |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
526 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
527 Now start Emacs (the normal, windowed-display session, i.e. without |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
528 the `-nw' option), and invoke "M-x gdb RET emacs RET" from there. Now |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
529 type these commands at GDB's prompt: |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
530 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
531 (gdb) set args -nw -t /dev/ttyp4 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
532 (gdb) set environment TERM xterm |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
533 (gdb) run |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
534 |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
535 The debugged Emacs should now start in no-window mode with its display |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
536 directed to the xterm window you opened above. |
c824be0e27e2
Add information about debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
37586
diff
changeset
|
537 |
40348
380d8f312f3a
Mention that screen(1) can come in handy for debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
40247
diff
changeset
|
538 Similar arrangement is possible on a character terminal by using the |
380d8f312f3a
Mention that screen(1) can come in handy for debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
40247
diff
changeset
|
539 `screen' package. |
380d8f312f3a
Mention that screen(1) can come in handy for debugging the tty version.
Eli Zaretskii <eliz@gnu.org>
parents:
40247
diff
changeset
|
540 |
37586
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
541 ** Running Emacs built with malloc debugging packages |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
542 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
543 If Emacs exhibits bugs that seem to be related to use of memory |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
544 allocated off the heap, it might be useful to link Emacs with a |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
545 special debugging library, such as Electric Fence (a.k.a. efence) or |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
546 GNU Checker, which helps find such problems. |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
547 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
548 Emacs compiled with such packages might not run without some hacking, |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
549 because Emacs replaces the system's memory allocation functions with |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
550 its own versions, and because the dumping process might be |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
551 incompatible with the way these packages use to track allocated |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
552 memory. Here are some of the changes you might find necessary |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
553 (SYSTEM-NAME and MACHINE-NAME are the names of your OS- and |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
554 CPU-specific headers in the subdirectories of `src'): |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
555 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
556 - In src/s/SYSTEM-NAME.h add "#define SYSTEM_MALLOC". |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
557 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
558 - In src/m/MACHINE-NAME.h add "#define CANNOT_DUMP" and |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
559 "#define CANNOT_UNEXEC". |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
560 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
561 - Configure with a different --prefix= option. If you use GCC, |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
562 version 2.7.2 is preferred, as some malloc debugging packages |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
563 work a lot better with it than with 2.95 or later versions. |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
564 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
565 - Type "make" then "make -k install". |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
566 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
567 - If required, invoke the package-specific command to prepare |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
568 src/temacs for execution. |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
569 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
570 - cd ..; src/temacs |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
571 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
572 (Note that this runs `temacs' instead of the usual `emacs' executable. |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
573 This avoids problems with dumping Emacs mentioned above.) |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
574 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
575 Some malloc debugging libraries might print lots of false alarms for |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
576 bitfields used by Emacs in some data structures. If you want to get |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
577 rid of the false alarms, you will have to hack the definitions of |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
578 these data structures on the respective headers to remove the `:N' |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
579 bitfield definitions (which will cause each such field to use a full |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
580 int). |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
581 |
63310 | 582 ** How to recover buffer contents from an Emacs core dump file |
583 | |
584 The file etc/emacs-buffer.gdb defines a set of GDB commands for | |
585 recovering the contents of Emacs buffers from a core dump file. You | |
586 might also find those commands useful for displaying the list of | |
587 buffers in human-readable format from within the debugger. | |
588 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
589 ** Some suggestions for debugging on MS Windows: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
590 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
591 (written by Marc Fleischeuers, Geoff Voelker and Andrew Innes) |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
592 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
593 To debug Emacs with Microsoft Visual C++, you either start emacs from |
37333
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
594 the debugger or attach the debugger to a running emacs process. |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
595 |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
596 To start emacs from the debugger, you can use the file bin/debug.bat. |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
597 The Microsoft Developer studio will start and under Project, Settings, |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
598 Debug, General you can set the command-line arguments and Emacs's |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
599 startup directory. Set breakpoints (Edit, Breakpoints) at Fsignal and |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
600 other functions that you want to examine. Run the program (Build, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
601 Start debug). Emacs will start and the debugger will take control as |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
602 soon as a breakpoint is hit. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
603 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
604 You can also attach the debugger to an already running Emacs process. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
605 To do this, start up the Microsoft Developer studio and select Build, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
606 Start debug, Attach to process. Choose the Emacs process from the |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
607 list. Send a break to the running process (Debug, Break) and you will |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
608 find that execution is halted somewhere in user32.dll. Open the stack |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
609 trace window and go up the stack to w32_msg_pump. Now you can set |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
610 breakpoints in Emacs (Edit, Breakpoints). Continue the running Emacs |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
611 process (Debug, Step out) and control will return to Emacs, until a |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
612 breakpoint is hit. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
613 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
614 To examine the contents of a Lisp variable, you can use the function |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
615 'debug_print'. Right-click on a variable, select QuickWatch (it has |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
616 an eyeglass symbol on its button in the toolbar), and in the text |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
617 field at the top of the window, place 'debug_print(' and ')' around |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
618 the expression. Press 'Recalculate' and the output is sent to stderr, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
619 and to the debugger via the OutputDebugString routine. The output |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
620 sent to stderr should be displayed in the console window that was |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
621 opened when the emacs.exe executable was started. The output sent to |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
622 the debugger should be displayed in the 'Debug' pane in the Output |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
623 window. If Emacs was started from the debugger, a console window was |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
624 opened at Emacs' startup; this console window also shows the output of |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
625 'debug_print'. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
626 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
627 For example, start and run Emacs in the debugger until it is waiting |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
628 for user input. Then click on the `Break' button in the debugger to |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
629 halt execution. Emacs should halt in `ZwUserGetMessage' waiting for |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
630 an input event. Use the `Call Stack' window to select the procedure |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
631 `w32_msp_pump' up the call stack (see below for why you have to do |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
632 this). Open the QuickWatch window and enter |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
633 "debug_print(Vexec_path)". Evaluating this expression will then print |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
634 out the contents of the Lisp variable `exec-path'. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
635 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
636 If QuickWatch reports that the symbol is unknown, then check the call |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
637 stack in the `Call Stack' window. If the selected frame in the call |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
638 stack is not an Emacs procedure, then the debugger won't recognize |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
639 Emacs symbols. Instead, select a frame that is inside an Emacs |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
640 procedure and try using `debug_print' again. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
641 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
642 If QuickWatch invokes debug_print but nothing happens, then check the |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
643 thread that is selected in the debugger. If the selected thread is |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
644 not the last thread to run (the "current" thread), then it cannot be |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
645 used to execute debug_print. Use the Debug menu to select the current |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
646 thread and try using debug_print again. Note that the debugger halts |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
647 execution (e.g., due to a breakpoint) in the context of the current |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
648 thread, so this should only be a problem if you've explicitly switched |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
649 threads. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
650 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
651 It is also possible to keep appropriately masked and typecast Lisp |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
652 symbols in the Watch window, this is more convenient when steeping |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
653 though the code. For instance, on entering apply_lambda, you can |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
654 watch (struct Lisp_Symbol *) (0xfffffff & args[0]). |
37333
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
655 |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
656 Optimizations often confuse the MS debugger. For example, the |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
657 debugger will sometimes report wrong line numbers, e.g., when it |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
658 prints the backtrace for a crash. It is usually best to look at the |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
659 disassembly to determine exactly what code is being run--the |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
660 disassembly will probably show several source lines followed by a |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
661 block of assembler for those lines. The actual point where Emacs |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
662 crashes will be one of those source lines, but not neccesarily the one |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
663 that the debugger reports. |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
664 |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
665 Another problematic area with the MS debugger is with variables that |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
666 are stored in registers: it will sometimes display wrong values for |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
667 those variables. Usually you will not be able to see any value for a |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
668 register variable, but if it is only being stored in a register |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
669 temporarily, you will see an old value for it. Again, you need to |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
670 look at the disassembly to determine which registers are being used, |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
671 and look at those registers directly, to see the actual current values |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
672 of these variables. |
52401 | 673 |
674 ;;; arch-tag: fbf32980-e35d-481f-8e4c-a2eca2586e6b |