Mercurial > vim
annotate runtime/doc/debug.txt @ 2490:1e5bc1cdec13 vim73
7.3d -> 7.3e.
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Wed, 04 Aug 2010 19:29:04 +0200 |
parents | 150b5dbccff9 |
children | a89f8c036bc5 |
rev | line source |
---|---|
2490 | 1 *debug.txt* For Vim version 7.3e. Last change: 2010 Jul 20 |
502 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Debugging Vim *debug-vim* | |
8 | |
9 This is for debugging Vim itself, when it doesn't work properly. | |
606 | 10 For debugging Vim scripts, functions, etc. see |debug-scripts| |
502 | 11 |
12 1. Location of a crash, using gcc and gdb |debug-gcc| | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
13 2. Locating memory leaks |debug-leaks| |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
14 3. Windows Bug Reporting |debug-win32| |
502 | 15 |
16 ============================================================================== | |
17 | |
18 1. Location of a crash, using gcc and gdb *debug-gcc* | |
19 | |
20 When Vim crashes in one of the test files, and you are using gcc for | |
21 compilation, here is what you can do to find out exactly where Vim crashes. | |
22 This also applies when using the MingW tools. | |
23 | |
24 1. Compile Vim with the "-g" option (there is a line in the Makefile for this, | |
25 which you can uncomment). | |
26 | |
27 2. Execute these commands (replace "11" with the test that fails): > | |
28 cd testdir | |
29 gdb ../vim | |
30 run -u unix.vim -U NONE -s dotest.in test11.in | |
31 | |
32 3. Check where Vim crashes, gdb should give a message for this. | |
33 | |
34 4. Get a stack trace from gdb with this command: > | |
35 where | |
36 < You can check out different places in the stack trace with: > | |
37 frame 3 | |
38 < Replace "3" with one of the numbers in the stack trace. | |
39 | |
40 ============================================================================== | |
41 | |
2309
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
42 2. Locating memory leaks *debug-leaks* *valgrind* |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
43 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
44 If you suspect Vim is leaking memory and you are using Linux, the valgrind |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
45 tool is very useful to pinpoint memory leaks. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
46 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
47 First of all, build Vim with EXITFREE defined. Search for this in MAKEFILE |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
48 and uncomment the line. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
49 |
2309
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
50 Use this command to start Vim: |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
51 > |
2309
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
52 valgrind --log-file=valgrind.log --leak-check=full ./vim |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
53 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
54 Note: Vim will run much slower. If your .vimrc is big or you have several |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
55 plugins you need to be patient for startup, or run with the "-u NONE" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
56 argument. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
57 |
2309
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
58 There are often a few leaks from libraries, such as getpwuid() and |
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
59 XtVaAppCreateShell(). Those are unavoidable. The number of bytes should be |
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
60 very small a Kbyte or less. |
543ea69d037f
Add clipboard support in Mac console. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
61 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
62 ============================================================================== |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
63 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
64 3. Windows Bug Reporting *debug-win32* |
502 | 65 |
842 | 66 If the Windows version of Vim crashes in a reproducible manner, you can take |
67 some steps to provide a useful bug report. | |
68 | |
502 | 69 |
842 | 70 GENERIC ~ |
71 | |
72 You must obtain the debugger symbols (PDB) file for your executable: gvim.pdb | |
857 | 73 for gvim.exe, or vim.pdb for vim.exe. The PDB should be available from the |
74 same place that you obtained the executable. Be sure to use the PDB that | |
75 matches the EXE (same date). | |
502 | 76 |
77 If you built the executable yourself with the Microsoft Visual C++ compiler, | |
78 then the PDB was built with the EXE. | |
79 | |
842 | 80 Alternatively, if you have the source files, you can import Make_ivc.mak into |
81 Visual Studio as a workspace. Then select a debug configuration, build and | |
82 you can do all kinds of debugging (set breakpoints, watch variables, etc.). | |
83 | |
84 If you have Visual Studio, use that instead of the VC Toolkit and WinDbg. | |
85 | |
86 For other compilers, you should always use the corresponding debugger: TD for | |
87 a Vim executable compiled with the Borland compiler; gdb (see above | |
88 |debug-gcc|) for the Cygwin and MinGW compilers. | |
89 | |
90 | |
857 | 91 *debug-vs2005* |
92 2.2 Debugging Vim crashes with Visual Studio 2005/Visual C++ 2005 Express ~ | |
842 | 93 |
94 First launch vim.exe or gvim.exe and then launch Visual Studio. (If you don't | |
857 | 95 have Visual Studio, follow the instructions at |get-ms-debuggers| to obtain a |
842 | 96 free copy of Visual C++ 2005 Express Edition.) |
97 | |
98 On the Tools menu, click Attach to Process. Choose the Vim process. | |
99 | |
100 In Vim, reproduce the crash. A dialog will appear in Visual Studio, telling | |
101 you about the unhandled exception in the Vim process. Click Break to break | |
102 into the process. | |
103 | |
104 Visual Studio will pop up another dialog, telling you that no symbols are | |
105 loaded and that the source code cannot be displayed. Click OK. | |
106 | |
107 Several windows will open. Right-click in the Call Stack window. Choose Load | |
108 Symbols. The Find Symbols dialog will open, looking for (g)vim.pdb. Navigate | |
109 to the directory where you have the PDB file and click Open. | |
110 | |
111 At this point, you should have a full call stack with vim function names and | |
112 line numbers. Double-click one of the lines and the Find Source dialog will | |
113 appear. Navigate to the directory where the Vim source is (if you have it.) | |
114 | |
115 If you don't know how to debug this any further, follow the instructions | |
116 at ":help bug-reports". Paste the call stack into the bug report. | |
117 | |
118 If you have a non-free version of Visual Studio, you can save a minidump via | |
119 the Debug menu and send it with the bug report. A minidump is a small file | |
120 (<100KB), which contains information about the state of your process. | |
857 | 121 Visual C++ 2005 Express Edition cannot save minidumps and it cannot be |
122 installed as a just-in-time debugger. Use WinDbg, |debug-windbg|, if you | |
123 need to save minidumps or you want a just-in-time (postmortem) debugger. | |
842 | 124 |
857 | 125 *debug-windbg* |
126 2.3 Debugging Vim crashes with WinDbg ~ | |
127 | |
128 See |get-ms-debuggers| to obtain a copy of WinDbg. | |
842 | 129 |
857 | 130 As with the Visual Studio IDE, you can attach WinDbg to a running Vim process. |
131 You can also have your system automatically invoke WinDbg as a postmortem | |
132 debugger. To set WinDbg as your postmortem debugger, run "windbg -I". | |
133 | |
134 To attach WinDbg to a running Vim process, launch WinDbg. On the File menu, | |
135 choose Attach to a Process. Select the Vim process and click OK. | |
136 | |
137 At this point, choose Symbol File Path on the File menu, and add the folder | |
138 containing your Vim PDB to the sympath. If you have Vim source available, | |
139 use Source File Path on the File menu. You can now open source files in WinDbg | |
140 and set breakpoints, if you like. Reproduce your crash. WinDbg should open the | |
141 source file at the point of the crash. Using the View menu, you can examine | |
142 the call stack, local variables, watch windows, and so on. | |
842 | 143 |
857 | 144 If WinDbg is your postmortem debugger, you do not need to attach WinDbg to |
145 your Vim process. Simply reproduce the crash and WinDbg will launch | |
146 automatically. As above, set the Symbol File Path and the Source File Path. | |
147 | |
148 To save a minidump, type the following at the WinDbg command line: > | |
149 .dump vim.dmp | |
150 < | |
151 *debug-minidump* | |
152 2.4 Opening a Minidump ~ | |
153 | |
154 If you have a minidump file, you can open it in Visual Studio or in WinDbg. | |
502 | 155 |
857 | 156 In Visual Studio 2005: on the File menu, choose Open, then Project/Solution. |
157 Navigate to the .dmp file and open it. Now press F5 to invoke the debugger. | |
158 Follow the instructions in |debug-vs2005| to set the Symbol File Path. | |
159 | |
160 In WinDbg: choose Open Crash Dump on the File menu. Follow the instructions in | |
161 |debug-windbg| to set the Symbol File Path. | |
162 | |
163 *get-ms-debuggers* | |
164 2.5 Obtaining Microsoft Debugging Tools ~ | |
165 | |
166 The Debugging Tools for Windows (including WinDbg) can be downloaded from | |
502 | 167 http://www.microsoft.com/whdc/devtools/debugging/default.mspx |
168 This includes the WinDbg debugger. | |
169 | |
857 | 170 Visual C++ 2005 Express Edition can be downloaded for free from: |
171 http://msdn.microsoft.com/vstudio/express/visualC/default.aspx | |
502 | 172 |
173 ========================================================================= | |
174 vim:tw=78:ts=8:ft=help:norl: |