Mercurial > emacs
annotate etc/DEBUG @ 39267:a8c0a02f6129
Spelling corrections.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 12 Sep 2001 21:03:47 +0000 |
parents | c4354368031e |
children | c824be0e27e2 |
rev | line source |
---|---|
25853 | 1 Debugging GNU Emacs |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
2 Copyright (c) 1985, 2000, 2001 Free Software Foundation, Inc. |
25853 | 3 |
4 Permission is granted to anyone to make or distribute verbatim copies | |
5 of this document as received, in any medium, provided that the | |
6 copyright notice and permission notice are preserved, | |
7 and that the distributor grants the recipient permission | |
8 for further redistribution as permitted by this notice. | |
9 | |
10 Permission is granted to distribute modified versions | |
11 of this document, or of portions of it, | |
12 under the above conditions, provided also that they | |
13 carry prominent notices stating who last changed them. | |
14 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
15 [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
|
16 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
|
17 document.] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
18 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
19 It is a good idea to run Emacs under GDB (or some other suitable |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
20 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
|
21 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
|
22 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
|
23 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
|
24 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
25 If Emacs hangs, or seems to be stuck in some infinite loop, typing |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
26 "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
|
27 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
|
28 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
29 ** Getting control to the debugger |
25853 | 30 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
31 `Fsignal' is a very useful place to put a breakpoint in. |
25853 | 32 All Lisp errors go through there. |
33 | |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
34 It is useful, when debugging, to have a guaranteed way to return to |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
35 the debugger at any time. When using X, this is easy: type C-c at the |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
36 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
|
37 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
|
38 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
|
39 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
40 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
|
41 (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
|
42 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
|
43 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
44 handle int stop nopass |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
45 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
46 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
|
47 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
|
48 `nopass'. |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
49 |
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
50 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
|
51 the code for some character into the variable stop_character. Thus, |
25853 | 52 |
53 set stop_character = 29 | |
54 | |
55 makes Control-] (decimal code 29) the stop character. | |
56 Typing Control-] will cause immediate stop. You cannot | |
57 use the set command until the inferior process has been started. | |
58 Put a breakpoint early in `main', or suspend the Emacs, | |
59 to get an opportunity to do the set command. | |
60 | |
61 ** Examining Lisp object values. | |
62 | |
63 When you have a live process to debug, and it has not encountered a | |
64 fatal error, you can use the GDB command `pr'. First print the value | |
65 in the ordinary way, with the `p' command. Then type `pr' with no | |
66 arguments. This calls a subroutine which uses the Lisp printer. | |
67 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
68 Note: It is not a good idea to try `pr' if you know that Emacs is in |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
69 deep trouble: its stack smashed (e.g., if it encountered SIGSEGV due |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
70 to stack overflow), or crucial data structures, such as `obarray', |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
71 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
|
72 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
|
73 debugging the original problem. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
74 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
75 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
|
76 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
|
77 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
|
78 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
|
79 Emacs will be between instructions and capable of handling `pr'. |
25853 | 80 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
81 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
|
82 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
|
83 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
|
84 the command that corresponds to that type. Here are these commands: |
25853 | 85 |
86 xint xptr xwindow xmarker xoverlay xmiscfree xintfwd xboolfwd xobjfwd | |
87 xbufobjfwd xkbobjfwd xbuflocal xbuffer xsymbol xstring xvector xframe | |
88 xwinconfig xcompiled xcons xcar xcdr xsubr xprocess xfloat xscrollbar | |
89 | |
90 Each one of them applies to a certain type or class of types. | |
91 (Some of these types are not visible in Lisp, because they exist only | |
92 internally.) | |
93 | |
94 Each x... command prints some information about the value, and | |
95 produces a GDB value (subsequently available in $) through which you | |
96 can get at the rest of the contents. | |
97 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
98 In general, most of the rest of the contents will be additional Lisp |
25853 | 99 objects which you can examine in turn with the x... commands. |
100 | |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
101 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
|
102 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
|
103 Here's an example using concepts explained in the node "Value History" |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
104 of the GDB manual to print the variable frame from this line in |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
105 xmenu.c: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
106 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
107 buf.frame_or_window = frame; |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
108 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
109 First, use these commands: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
110 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
111 cd src |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
112 gdb emacs |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
113 b xmenu.c:1296 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
114 r -q |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
115 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
116 Then type C-x 5 2 to create a new frame, and it hits the breakpoint: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
117 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
118 (gdb) p frame |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
119 $1 = 1077872640 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
120 (gdb) xtype |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
121 Lisp_Vectorlike |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
122 PVEC_FRAME |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
123 (gdb) xframe |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
124 $2 = (struct frame *) 0x3f0800 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
125 (gdb) p *$ |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
126 $3 = { |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
127 size = 536871989, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
128 next = 0x366240, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
129 name = 809661752, |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
130 [...] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
131 } |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
132 (gdb) p $3->name |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
133 $4 = 809661752 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
134 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
135 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
|
136 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
137 (gdb) pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
138 "emacs@steenrod.math.nwu.edu" |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
139 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
140 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
|
141 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
|
142 `add_command_key' from keyboard.c: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
143 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
144 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
|
145 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
146 XVECTOR is a macro, and therefore GDB does not know about it. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
147 GDB cannot evaluate "p XVECTOR (this_command_keys)". |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
148 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
149 However, you can use the xvector command in GDB to get the same |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
150 result. Here is how: |
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) p this_command_keys |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
153 $1 = 1078005760 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
154 (gdb) xvector |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
155 $2 = (struct Lisp_Vector *) 0x411000 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
156 0 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
157 (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
|
158 $3 = 1077872640 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
159 (gdb) p &$ |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
160 $4 = (int *) 0x411008 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
161 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
162 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
|
163 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
|
164 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
|
165 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
166 p recent_keys |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
167 pr |
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 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
|
170 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
|
171 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
|
172 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
173 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
|
174 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
175 So we define a GDB command `xvector-elts', so the last 10 keystrokes |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
176 are printed by |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
177 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
178 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
|
179 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
180 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
|
181 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
182 define xvector-elts |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
183 set $i = 0 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
184 p $arg0 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
185 xvector |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
186 set $foo = $ |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
187 while $i < $arg2 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
188 p $foo->contents[$arg1-($i++)] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
189 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
190 end |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
191 document xvector-elts |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
192 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
|
193 xvector-elts v n i |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
194 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
|
195 end |
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 ** 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
|
198 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
199 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
|
200 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
|
201 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
202 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
|
203 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
|
204 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
|
205 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
|
206 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
|
207 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
208 p *args |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
209 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
210 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
211 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
|
212 of function calling. |
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 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
|
215 values. Here's how to print the first argument: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
216 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
217 p args[1] |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
218 pr |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
219 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
220 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
|
221 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
|
222 conveniently. For example: |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
223 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
224 p *args |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
225 xtype |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
226 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
227 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
|
228 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
229 xsymbol |
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 ** 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
|
232 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
233 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
|
234 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
235 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
|
236 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
|
237 breakpoints in it. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
238 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
239 ** Debugging `temacs' |
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 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
|
242 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
|
243 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
|
244 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
245 ** If you encounter X protocol errors |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
246 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
247 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
|
248 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
|
249 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
|
250 which call really caused the error. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
251 |
36962
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
252 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
|
253 option, like this: |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
254 |
37534
3ea5075dc420
Fix a typo in the "emacs -xrm" command line. Reported by Kenichi Handa.
Eli Zaretskii <eliz@gnu.org>
parents:
37509
diff
changeset
|
255 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
|
256 |
9c7eb7e6bf3e
Document the use of -xrm to start EMacs in synchronous mode.
Eli Zaretskii <eliz@gnu.org>
parents:
36625
diff
changeset
|
257 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
|
258 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
|
259 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
|
260 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
261 ** 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
|
262 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
263 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
|
264 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
|
265 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
|
266 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
|
267 `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
|
268 looping, `step' will return. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
269 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
270 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
|
271 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
|
272 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
|
273 what the arguments are. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
274 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
275 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
|
276 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
|
277 `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
|
278 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
|
279 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
|
280 just tried to finish. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
281 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
282 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
|
283 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
|
284 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
|
285 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
|
286 not exit when it should. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
287 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
288 ** 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
|
289 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
|
290 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
291 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
|
292 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
|
293 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
|
294 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
295 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
|
296 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
|
297 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
|
298 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
299 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
|
300 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
|
301 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
|
302 |
25853 | 303 ** If GDB does not run and your debuggers can't load Emacs. |
304 | |
305 On some systems, no debugger can load Emacs with a symbol table, | |
306 perhaps because they all have fixed limits on the number of symbols | |
307 and Emacs exceeds the limits. Here is a method that can be used | |
308 in such an extremity. Do | |
309 | |
310 nm -n temacs > nmout | |
311 strip temacs | |
312 adb temacs | |
313 0xd:i | |
314 0xe:i | |
315 14:i | |
316 17:i | |
317 :r -l loadup (or whatever) | |
318 | |
319 It is necessary to refer to the file `nmout' to convert | |
320 numeric addresses into symbols and vice versa. | |
321 | |
322 It is useful to be running under a window system. | |
323 Then, if Emacs becomes hopelessly wedged, you can create | |
324 another window to do kill -9 in. kill -ILL is often | |
325 useful too, since that may make Emacs dump core or return | |
326 to adb. | |
327 | |
328 | |
329 ** Debugging incorrect screen updating. | |
330 | |
331 To debug Emacs problems that update the screen wrong, it is useful | |
332 to have a record of what input you typed and what Emacs sent to the | |
333 screen. To make these records, do | |
334 | |
335 (open-dribble-file "~/.dribble") | |
336 (open-termscript "~/.termscript") | |
337 | |
338 The dribble file contains all characters read by Emacs from the | |
339 terminal, and the termscript file contains all characters it sent to | |
340 the terminal. The use of the directory `~/' prevents interference | |
341 with any other user. | |
342 | |
343 If you have irreproducible display problems, put those two expressions | |
344 in your ~/.emacs file. When the problem happens, exit the Emacs that | |
345 you were running, kill it, and rename the two files. Then you can start | |
346 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
|
347 |
9b989029cccf
Add note aboute using `inverse-video' to detect excessive screen redraw.
Miles Bader <miles@gnu.org>
parents:
32523
diff
changeset
|
348 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
|
349 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
|
350 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
|
351 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
|
352 |
37509
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
353 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
|
354 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
|
355 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
|
356 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
|
357 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
358 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
|
359 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
360 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
|
361 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
|
362 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
|
363 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
|
364 investigated. |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
365 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
366 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
|
367 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
|
368 `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
|
369 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
|
370 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
|
371 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
|
372 `w': |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
373 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
374 (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
|
375 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
376 (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
|
377 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
|
378 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
|
379 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
|
380 |
ed5dca63a0ed
Document some of the facilities for debugging display code, including
Eli Zaretskii <eliz@gnu.org>
parents:
37481
diff
changeset
|
381 Several more functions for debugging display code are available in |
37565 | 382 Emacs compiled with GLYPH_DEBUG defined; type "C-h f dump- TAB" and |
383 "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
|
384 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
385 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
386 ** Debugging LessTif |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
387 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
388 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
|
389 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
|
390 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
|
391 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
|
392 For instance |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
393 |
36625
08aed53e171c
DEBUGSOURCES should contain a list of files, separated by colons.
Gerd Moellmann <gerd@gnu.org>
parents:
35861
diff
changeset
|
394 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
|
395 export DEBUG_FILE=/usr/tmp/LESSTIF_TRACE |
35720
c6ae90d82552
Clarify the instructions for debugging LessTif.
Eli Zaretskii <eliz@gnu.org>
parents:
35655
diff
changeset
|
396 emacs & |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
397 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
398 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
|
399 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
|
400 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
|
401 last line above. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
402 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
403 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
|
404 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
|
405 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
|
406 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
|
407 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
408 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
409 ** Debugging problems which happen in GC |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
410 |
37015
f8dd0e40dc34
Make it clear that last_marked[] holds pointers to Lisp objects, not
Eli Zaretskii <eliz@gnu.org>
parents:
36962
diff
changeset
|
411 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
|
412 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
|
413 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
|
414 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
|
415 `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
|
416 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
|
417 stored. |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
418 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
419 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
|
420 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
|
421 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
|
422 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
|
423 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
|
424 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
|
425 that objects were marked. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
426 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
427 Once you discover the corrupted Lisp object or data structure, it is |
35861 | 428 useful to look at it in a fresh Emacs session and compare its contents |
429 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
|
430 |
37481 | 431 ** Debugging problems with non-ASCII characters |
432 | |
433 If you experience problems which seem to be related to non-ASCII | |
434 characters, such as \201 characters appearing in the buffer or in your | |
435 files, set the variable byte-debug-flag to t. This causes Emacs to do | |
436 some extra checks, such as look for broken relations between byte and | |
437 character positions in buffers and strings; the resulting diagnostics | |
438 might pinpoint the cause of the problem. | |
439 | |
37586
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
440 ** 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
|
441 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
442 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
|
443 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
|
444 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
|
445 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
|
446 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
447 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
|
448 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
|
449 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
|
450 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
|
451 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
|
452 (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
|
453 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
|
454 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
455 - 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
|
456 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
457 - 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
|
458 "#define CANNOT_UNEXEC". |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
459 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
460 - 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
|
461 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
|
462 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
|
463 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
464 - Type "make" then "make -k install". |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
465 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
466 - 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
|
467 src/temacs for execution. |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
468 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
469 - cd ..; src/temacs |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
470 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
471 (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
|
472 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
|
473 |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
474 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
|
475 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
|
476 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
|
477 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
|
478 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
|
479 int). |
c4354368031e
Add hints for running Emacs with malloc debuggers.
Eli Zaretskii <eliz@gnu.org>
parents:
37565
diff
changeset
|
480 |
35655
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
481 ** 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
|
482 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
483 (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
|
484 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
485 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
|
486 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
|
487 |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
488 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
|
489 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
|
490 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
|
491 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
|
492 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
|
493 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
|
494 soon as a breakpoint is hit. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
495 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
496 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
|
497 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
|
498 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
|
499 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
|
500 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
|
501 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
|
502 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
|
503 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
|
504 breakpoint is hit. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
505 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
506 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
|
507 '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
|
508 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
|
509 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
|
510 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
|
511 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
|
512 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
|
513 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
|
514 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
|
515 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
|
516 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
|
517 'debug_print'. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
518 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
519 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
|
520 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
|
521 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
|
522 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
|
523 `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
|
524 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
|
525 "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
|
526 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
|
527 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
528 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
|
529 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
|
530 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
|
531 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
|
532 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
|
533 |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
534 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
|
535 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
|
536 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
|
537 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
|
538 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
|
539 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
|
540 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
|
541 threads. |
c3ac662ac2a3
Expand and update, based on the instructions to
Eli Zaretskii <eliz@gnu.org>
parents:
34594
diff
changeset
|
542 |
35791
7c5f4564ff27
Changes, clean-ups, and typo fixes from Richard Stallman.
Eli Zaretskii <eliz@gnu.org>
parents:
35720
diff
changeset
|
543 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
|
544 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
|
545 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
|
546 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
|
547 |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
548 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
|
549 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
|
550 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
|
551 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
|
552 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
|
553 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
|
554 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
|
555 that the debugger reports. |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
556 |
54ec1bffae34
Document problems with MS debugger working on optimized code.
Eli Zaretskii <eliz@gnu.org>
parents:
37157
diff
changeset
|
557 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
|
558 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
|
559 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
|
560 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
|
561 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
|
562 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
|
563 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
|
564 of these variables. |