]>
Commit | Line | Data |
---|---|---|
9742079a | 1 | \input texinfo @c -*- texinfo -*- |
c906108c | 2 | @setfilename gdbint.info |
25822942 | 3 | @include gdb-cfg.texi |
03727ca6 | 4 | @dircategory Software development |
e9c75b65 | 5 | @direntry |
c906108c | 6 | * Gdb-Internals: (gdbint). The GNU debugger's internals. |
e9c75b65 | 7 | @end direntry |
c906108c SS |
8 | |
9 | @ifinfo | |
25822942 | 10 | This file documents the internals of the GNU debugger @value{GDBN}. |
c02a867d | 11 | Copyright (C) 1990, 1991, 1992, 1993, 1994, 1996, 1998, 1999, 2000, 2001, |
5009afc5 | 12 | 2002, 2003, 2004, 2005, 2006, 2008 |
e9c75b65 | 13 | Free Software Foundation, Inc. |
c906108c SS |
14 | Contributed by Cygnus Solutions. Written by John Gilmore. |
15 | Second Edition by Stan Shebs. | |
16 | ||
e9c75b65 EZ |
17 | Permission is granted to copy, distribute and/or modify this document |
18 | under the terms of the GNU Free Documentation License, Version 1.1 or | |
2a6585f0 | 19 | any later version published by the Free Software Foundation; with no |
e5249f67 AC |
20 | Invariant Sections, with no Front-Cover Texts, and with no Back-Cover |
21 | Texts. A copy of the license is included in the section entitled ``GNU | |
22 | Free Documentation License''. | |
c906108c SS |
23 | @end ifinfo |
24 | ||
25 | @setchapternewpage off | |
25822942 | 26 | @settitle @value{GDBN} Internals |
c906108c | 27 | |
56caf160 EZ |
28 | @syncodeindex fn cp |
29 | @syncodeindex vr cp | |
30 | ||
c906108c | 31 | @titlepage |
25822942 | 32 | @title @value{GDBN} Internals |
c906108c SS |
33 | @subtitle{A guide to the internals of the GNU debugger} |
34 | @author John Gilmore | |
35 | @author Cygnus Solutions | |
36 | @author Second Edition: | |
37 | @author Stan Shebs | |
38 | @author Cygnus Solutions | |
39 | @page | |
40 | @tex | |
41 | \def\$#1${{#1}} % Kluge: collect RCS revision info without $...$ | |
42 | \xdef\manvers{\$Revision$} % For use in headers, footers too | |
43 | {\parskip=0pt | |
44 | \hfill Cygnus Solutions\par | |
45 | \hfill \manvers\par | |
46 | \hfill \TeX{}info \texinfoversion\par | |
47 | } | |
48 | @end tex | |
49 | ||
50 | @vskip 0pt plus 1filll | |
1e698235 | 51 | Copyright @copyright{} 1990,1991,1992,1993,1994,1996,1998,1999,2000,2001, |
c91d38aa | 52 | 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
c906108c | 53 | |
e9c75b65 EZ |
54 | Permission is granted to copy, distribute and/or modify this document |
55 | under the terms of the GNU Free Documentation License, Version 1.1 or | |
2a6585f0 | 56 | any later version published by the Free Software Foundation; with no |
e5249f67 AC |
57 | Invariant Sections, with no Front-Cover Texts, and with no Back-Cover |
58 | Texts. A copy of the license is included in the section entitled ``GNU | |
59 | Free Documentation License''. | |
c906108c SS |
60 | @end titlepage |
61 | ||
449f3b6c | 62 | @contents |
449f3b6c | 63 | |
c906108c SS |
64 | @node Top |
65 | @c Perhaps this should be the title of the document (but only for info, | |
66 | @c not for TeX). Existing GNU manuals seem inconsistent on this point. | |
67 | @top Scope of this Document | |
68 | ||
25822942 DB |
69 | This document documents the internals of the GNU debugger, @value{GDBN}. It |
70 | includes description of @value{GDBN}'s key algorithms and operations, as well | |
71 | as the mechanisms that adapt @value{GDBN} to specific hosts and targets. | |
c906108c SS |
72 | |
73 | @menu | |
74 | * Requirements:: | |
75 | * Overall Structure:: | |
76 | * Algorithms:: | |
77 | * User Interface:: | |
89437448 | 78 | * libgdb:: |
669fac23 | 79 | * Stack Frames:: |
c906108c SS |
80 | * Symbol Handling:: |
81 | * Language Support:: | |
82 | * Host Definition:: | |
83 | * Target Architecture Definition:: | |
123dc839 | 84 | * Target Descriptions:: |
c906108c SS |
85 | * Target Vector Definition:: |
86 | * Native Debugging:: | |
87 | * Support Libraries:: | |
88 | * Coding:: | |
89 | * Porting GDB:: | |
d52fe014 | 90 | * Versions and Branches:: |
55f6ca0f | 91 | * Start of New Year Procedure:: |
8973da3a | 92 | * Releasing GDB:: |
085dd6e6 | 93 | * Testsuite:: |
c906108c | 94 | * Hints:: |
aab4e0ec | 95 | |
bcd7e15f | 96 | * GDB Observers:: @value{GDBN} Currently available observers |
aab4e0ec | 97 | * GNU Free Documentation License:: The license for this documentation |
56caf160 | 98 | * Index:: |
c906108c SS |
99 | @end menu |
100 | ||
101 | @node Requirements | |
102 | ||
103 | @chapter Requirements | |
56caf160 | 104 | @cindex requirements for @value{GDBN} |
c906108c SS |
105 | |
106 | Before diving into the internals, you should understand the formal | |
56caf160 EZ |
107 | requirements and other expectations for @value{GDBN}. Although some |
108 | of these may seem obvious, there have been proposals for @value{GDBN} | |
109 | that have run counter to these requirements. | |
c906108c | 110 | |
56caf160 EZ |
111 | First of all, @value{GDBN} is a debugger. It's not designed to be a |
112 | front panel for embedded systems. It's not a text editor. It's not a | |
113 | shell. It's not a programming environment. | |
c906108c | 114 | |
56caf160 EZ |
115 | @value{GDBN} is an interactive tool. Although a batch mode is |
116 | available, @value{GDBN}'s primary role is to interact with a human | |
117 | programmer. | |
c906108c | 118 | |
56caf160 EZ |
119 | @value{GDBN} should be responsive to the user. A programmer hot on |
120 | the trail of a nasty bug, and operating under a looming deadline, is | |
121 | going to be very impatient of everything, including the response time | |
122 | to debugger commands. | |
c906108c | 123 | |
56caf160 EZ |
124 | @value{GDBN} should be relatively permissive, such as for expressions. |
125 | While the compiler should be picky (or have the option to be made | |
be9c6c35 | 126 | picky), since source code lives for a long time usually, the |
56caf160 EZ |
127 | programmer doing debugging shouldn't be spending time figuring out to |
128 | mollify the debugger. | |
c906108c | 129 | |
56caf160 EZ |
130 | @value{GDBN} will be called upon to deal with really large programs. |
131 | Executable sizes of 50 to 100 megabytes occur regularly, and we've | |
132 | heard reports of programs approaching 1 gigabyte in size. | |
c906108c | 133 | |
56caf160 EZ |
134 | @value{GDBN} should be able to run everywhere. No other debugger is |
135 | available for even half as many configurations as @value{GDBN} | |
136 | supports. | |
c906108c SS |
137 | |
138 | ||
139 | @node Overall Structure | |
140 | ||
141 | @chapter Overall Structure | |
142 | ||
56caf160 EZ |
143 | @value{GDBN} consists of three major subsystems: user interface, |
144 | symbol handling (the @dfn{symbol side}), and target system handling (the | |
145 | @dfn{target side}). | |
c906108c | 146 | |
2e685b93 | 147 | The user interface consists of several actual interfaces, plus |
c906108c SS |
148 | supporting code. |
149 | ||
150 | The symbol side consists of object file readers, debugging info | |
151 | interpreters, symbol table management, source language expression | |
152 | parsing, type and value printing. | |
153 | ||
154 | The target side consists of execution control, stack frame analysis, and | |
155 | physical target manipulation. | |
156 | ||
157 | The target side/symbol side division is not formal, and there are a | |
158 | number of exceptions. For instance, core file support involves symbolic | |
159 | elements (the basic core file reader is in BFD) and target elements (it | |
160 | supplies the contents of memory and the values of registers). Instead, | |
161 | this division is useful for understanding how the minor subsystems | |
162 | should fit together. | |
163 | ||
164 | @section The Symbol Side | |
165 | ||
56caf160 EZ |
166 | The symbolic side of @value{GDBN} can be thought of as ``everything |
167 | you can do in @value{GDBN} without having a live program running''. | |
168 | For instance, you can look at the types of variables, and evaluate | |
169 | many kinds of expressions. | |
c906108c SS |
170 | |
171 | @section The Target Side | |
172 | ||
56caf160 EZ |
173 | The target side of @value{GDBN} is the ``bits and bytes manipulator''. |
174 | Although it may make reference to symbolic info here and there, most | |
175 | of the target side will run with only a stripped executable | |
176 | available---or even no executable at all, in remote debugging cases. | |
c906108c SS |
177 | |
178 | Operations such as disassembly, stack frame crawls, and register | |
179 | display, are able to work with no symbolic info at all. In some cases, | |
25822942 | 180 | such as disassembly, @value{GDBN} will use symbolic info to present addresses |
c906108c SS |
181 | relative to symbols rather than as raw numbers, but it will work either |
182 | way. | |
183 | ||
184 | @section Configurations | |
185 | ||
56caf160 EZ |
186 | @cindex host |
187 | @cindex target | |
25822942 | 188 | @dfn{Host} refers to attributes of the system where @value{GDBN} runs. |
c906108c SS |
189 | @dfn{Target} refers to the system where the program being debugged |
190 | executes. In most cases they are the same machine, in which case a | |
191 | third type of @dfn{Native} attributes come into play. | |
192 | ||
1f70da6a SS |
193 | Defines and include files needed to build on the host are host |
194 | support. Examples are tty support, system defined types, host byte | |
195 | order, host float format. These are all calculated by @code{autoconf} | |
196 | when the debugger is built. | |
c906108c SS |
197 | |
198 | Defines and information needed to handle the target format are target | |
199 | dependent. Examples are the stack frame format, instruction set, | |
200 | breakpoint instruction, registers, and how to set up and tear down the stack | |
201 | to call a function. | |
202 | ||
203 | Information that is only needed when the host and target are the same, | |
204 | is native dependent. One example is Unix child process support; if the | |
1f70da6a | 205 | host and target are not the same, calling @code{fork} to start the target |
c906108c SS |
206 | process is a bad idea. The various macros needed for finding the |
207 | registers in the @code{upage}, running @code{ptrace}, and such are all | |
208 | in the native-dependent files. | |
209 | ||
210 | Another example of native-dependent code is support for features that | |
211 | are really part of the target environment, but which require | |
212 | @code{#include} files that are only available on the host system. Core | |
213 | file handling and @code{setjmp} handling are two common cases. | |
214 | ||
1f70da6a SS |
215 | When you want to make @value{GDBN} work as the traditional native debugger |
216 | on a system, you will need to supply both target and native information. | |
c906108c | 217 | |
25ab7e6d EZ |
218 | @section Source Tree Structure |
219 | @cindex @value{GDBN} source tree structure | |
220 | ||
221 | The @value{GDBN} source directory has a mostly flat structure---there | |
222 | are only a few subdirectories. A file's name usually gives a hint as | |
223 | to what it does; for example, @file{stabsread.c} reads stabs, | |
7ce59000 | 224 | @file{dwarf2read.c} reads @sc{DWARF 2}, etc. |
25ab7e6d EZ |
225 | |
226 | Files that are related to some common task have names that share | |
227 | common substrings. For example, @file{*-thread.c} files deal with | |
228 | debugging threads on various platforms; @file{*read.c} files deal with | |
229 | reading various kinds of symbol and object files; @file{inf*.c} files | |
230 | deal with direct control of the @dfn{inferior program} (@value{GDBN} | |
231 | parlance for the program being debugged). | |
232 | ||
233 | There are several dozens of files in the @file{*-tdep.c} family. | |
234 | @samp{tdep} stands for @dfn{target-dependent code}---each of these | |
235 | files implements debug support for a specific target architecture | |
236 | (sparc, mips, etc). Usually, only one of these will be used in a | |
237 | specific @value{GDBN} configuration (sometimes two, closely related). | |
238 | ||
239 | Similarly, there are many @file{*-nat.c} files, each one for native | |
240 | debugging on a specific system (e.g., @file{sparc-linux-nat.c} is for | |
241 | native debugging of Sparc machines running the Linux kernel). | |
242 | ||
243 | The few subdirectories of the source tree are: | |
244 | ||
245 | @table @file | |
246 | @item cli | |
247 | Code that implements @dfn{CLI}, the @value{GDBN} Command-Line | |
248 | Interpreter. @xref{User Interface, Command Interpreter}. | |
249 | ||
250 | @item gdbserver | |
251 | Code for the @value{GDBN} remote server. | |
252 | ||
253 | @item gdbtk | |
254 | Code for Insight, the @value{GDBN} TK-based GUI front-end. | |
255 | ||
256 | @item mi | |
257 | The @dfn{GDB/MI}, the @value{GDBN} Machine Interface interpreter. | |
258 | ||
259 | @item signals | |
260 | Target signal translation code. | |
261 | ||
262 | @item tui | |
263 | Code for @dfn{TUI}, the @value{GDBN} Text-mode full-screen User | |
264 | Interface. @xref{User Interface, TUI}. | |
265 | @end table | |
c906108c SS |
266 | |
267 | @node Algorithms | |
268 | ||
269 | @chapter Algorithms | |
56caf160 | 270 | @cindex algorithms |
c906108c | 271 | |
56caf160 EZ |
272 | @value{GDBN} uses a number of debugging-specific algorithms. They are |
273 | often not very complicated, but get lost in the thicket of special | |
274 | cases and real-world issues. This chapter describes the basic | |
275 | algorithms and mentions some of the specific target definitions that | |
276 | they use. | |
c906108c | 277 | |
7d30c22d JB |
278 | @section Prologue Analysis |
279 | ||
280 | @cindex prologue analysis | |
281 | @cindex call frame information | |
282 | @cindex CFI (call frame information) | |
283 | To produce a backtrace and allow the user to manipulate older frames' | |
284 | variables and arguments, @value{GDBN} needs to find the base addresses | |
285 | of older frames, and discover where those frames' registers have been | |
286 | saved. Since a frame's ``callee-saves'' registers get saved by | |
287 | younger frames if and when they're reused, a frame's registers may be | |
288 | scattered unpredictably across younger frames. This means that | |
289 | changing the value of a register-allocated variable in an older frame | |
290 | may actually entail writing to a save slot in some younger frame. | |
291 | ||
292 | Modern versions of GCC emit Dwarf call frame information (``CFI''), | |
293 | which describes how to find frame base addresses and saved registers. | |
294 | But CFI is not always available, so as a fallback @value{GDBN} uses a | |
295 | technique called @dfn{prologue analysis} to find frame sizes and saved | |
296 | registers. A prologue analyzer disassembles the function's machine | |
297 | code starting from its entry point, and looks for instructions that | |
298 | allocate frame space, save the stack pointer in a frame pointer | |
299 | register, save registers, and so on. Obviously, this can't be done | |
b247355e | 300 | accurately in general, but it's tractable to do well enough to be very |
7d30c22d JB |
301 | helpful. Prologue analysis predates the GNU toolchain's support for |
302 | CFI; at one time, prologue analysis was the only mechanism | |
303 | @value{GDBN} used for stack unwinding at all, when the function | |
304 | calling conventions didn't specify a fixed frame layout. | |
305 | ||
306 | In the olden days, function prologues were generated by hand-written, | |
307 | target-specific code in GCC, and treated as opaque and untouchable by | |
308 | optimizers. Looking at this code, it was usually straightforward to | |
309 | write a prologue analyzer for @value{GDBN} that would accurately | |
310 | understand all the prologues GCC would generate. However, over time | |
311 | GCC became more aggressive about instruction scheduling, and began to | |
312 | understand more about the semantics of the prologue instructions | |
313 | themselves; in response, @value{GDBN}'s analyzers became more complex | |
314 | and fragile. Keeping the prologue analyzers working as GCC (and the | |
315 | instruction sets themselves) evolved became a substantial task. | |
316 | ||
317 | @cindex @file{prologue-value.c} | |
318 | @cindex abstract interpretation of function prologues | |
319 | @cindex pseudo-evaluation of function prologues | |
320 | To try to address this problem, the code in @file{prologue-value.h} | |
321 | and @file{prologue-value.c} provides a general framework for writing | |
322 | prologue analyzers that are simpler and more robust than ad-hoc | |
323 | analyzers. When we analyze a prologue using the prologue-value | |
324 | framework, we're really doing ``abstract interpretation'' or | |
325 | ``pseudo-evaluation'': running the function's code in simulation, but | |
326 | using conservative approximations of the values registers and memory | |
327 | would hold when the code actually runs. For example, if our function | |
328 | starts with the instruction: | |
329 | ||
330 | @example | |
331 | addi r1, 42 # add 42 to r1 | |
332 | @end example | |
333 | @noindent | |
334 | we don't know exactly what value will be in @code{r1} after executing | |
335 | this instruction, but we do know it'll be 42 greater than its original | |
336 | value. | |
337 | ||
338 | If we then see an instruction like: | |
339 | ||
340 | @example | |
341 | addi r1, 22 # add 22 to r1 | |
342 | @end example | |
343 | @noindent | |
344 | we still don't know what @code{r1's} value is, but again, we can say | |
345 | it is now 64 greater than its original value. | |
346 | ||
347 | If the next instruction were: | |
348 | ||
349 | @example | |
350 | mov r2, r1 # set r2 to r1's value | |
351 | @end example | |
352 | @noindent | |
353 | then we can say that @code{r2's} value is now the original value of | |
354 | @code{r1} plus 64. | |
355 | ||
356 | It's common for prologues to save registers on the stack, so we'll | |
357 | need to track the values of stack frame slots, as well as the | |
358 | registers. So after an instruction like this: | |
359 | ||
360 | @example | |
361 | mov (fp+4), r2 | |
362 | @end example | |
363 | @noindent | |
364 | then we'd know that the stack slot four bytes above the frame pointer | |
365 | holds the original value of @code{r1} plus 64. | |
366 | ||
367 | And so on. | |
368 | ||
369 | Of course, this can only go so far before it gets unreasonable. If we | |
370 | wanted to be able to say anything about the value of @code{r1} after | |
371 | the instruction: | |
372 | ||
373 | @example | |
374 | xor r1, r3 # exclusive-or r1 and r3, place result in r1 | |
375 | @end example | |
376 | @noindent | |
377 | then things would get pretty complex. But remember, we're just doing | |
378 | a conservative approximation; if exclusive-or instructions aren't | |
379 | relevant to prologues, we can just say @code{r1}'s value is now | |
380 | ``unknown''. We can ignore things that are too complex, if that loss of | |
381 | information is acceptable for our application. | |
382 | ||
383 | So when we say ``conservative approximation'' here, what we mean is an | |
384 | approximation that is either accurate, or marked ``unknown'', but | |
385 | never inaccurate. | |
386 | ||
387 | Using this framework, a prologue analyzer is simply an interpreter for | |
388 | machine code, but one that uses conservative approximations for the | |
389 | contents of registers and memory instead of actual values. Starting | |
390 | from the function's entry point, you simulate instructions up to the | |
391 | current PC, or an instruction that you don't know how to simulate. | |
392 | Now you can examine the state of the registers and stack slots you've | |
393 | kept track of. | |
394 | ||
395 | @itemize @bullet | |
396 | ||
397 | @item | |
398 | To see how large your stack frame is, just check the value of the | |
399 | stack pointer register; if it's the original value of the SP | |
400 | minus a constant, then that constant is the stack frame's size. | |
401 | If the SP's value has been marked as ``unknown'', then that means | |
402 | the prologue has done something too complex for us to track, and | |
403 | we don't know the frame size. | |
404 | ||
405 | @item | |
406 | To see where we've saved the previous frame's registers, we just | |
407 | search the values we've tracked --- stack slots, usually, but | |
408 | registers, too, if you want --- for something equal to the register's | |
409 | original value. If the calling conventions suggest a standard place | |
410 | to save a given register, then we can check there first, but really, | |
411 | anything that will get us back the original value will probably work. | |
412 | @end itemize | |
413 | ||
414 | This does take some work. But prologue analyzers aren't | |
415 | quick-and-simple pattern patching to recognize a few fixed prologue | |
416 | forms any more; they're big, hairy functions. Along with inferior | |
417 | function calls, prologue analysis accounts for a substantial portion | |
418 | of the time needed to stabilize a @value{GDBN} port. So it's | |
419 | worthwhile to look for an approach that will be easier to understand | |
420 | and maintain. In the approach described above: | |
421 | ||
422 | @itemize @bullet | |
423 | ||
424 | @item | |
425 | It's easier to see that the analyzer is correct: you just see | |
b247355e | 426 | whether the analyzer properly (albeit conservatively) simulates |
7d30c22d JB |
427 | the effect of each instruction. |
428 | ||
429 | @item | |
430 | It's easier to extend the analyzer: you can add support for new | |
431 | instructions, and know that you haven't broken anything that | |
432 | wasn't already broken before. | |
433 | ||
434 | @item | |
435 | It's orthogonal: to gather new information, you don't need to | |
436 | complicate the code for each instruction. As long as your domain | |
437 | of conservative values is already detailed enough to tell you | |
438 | what you need, then all the existing instruction simulations are | |
439 | already gathering the right data for you. | |
440 | ||
441 | @end itemize | |
442 | ||
443 | The file @file{prologue-value.h} contains detailed comments explaining | |
444 | the framework and how to use it. | |
445 | ||
446 | ||
c906108c SS |
447 | @section Breakpoint Handling |
448 | ||
56caf160 | 449 | @cindex breakpoints |
c906108c SS |
450 | In general, a breakpoint is a user-designated location in the program |
451 | where the user wants to regain control if program execution ever reaches | |
452 | that location. | |
453 | ||
454 | There are two main ways to implement breakpoints; either as ``hardware'' | |
455 | breakpoints or as ``software'' breakpoints. | |
456 | ||
56caf160 EZ |
457 | @cindex hardware breakpoints |
458 | @cindex program counter | |
c906108c SS |
459 | Hardware breakpoints are sometimes available as a builtin debugging |
460 | features with some chips. Typically these work by having dedicated | |
461 | register into which the breakpoint address may be stored. If the PC | |
56caf160 | 462 | (shorthand for @dfn{program counter}) |
c906108c | 463 | ever matches a value in a breakpoint registers, the CPU raises an |
56caf160 EZ |
464 | exception and reports it to @value{GDBN}. |
465 | ||
466 | Another possibility is when an emulator is in use; many emulators | |
467 | include circuitry that watches the address lines coming out from the | |
468 | processor, and force it to stop if the address matches a breakpoint's | |
469 | address. | |
470 | ||
471 | A third possibility is that the target already has the ability to do | |
472 | breakpoints somehow; for instance, a ROM monitor may do its own | |
473 | software breakpoints. So although these are not literally ``hardware | |
474 | breakpoints'', from @value{GDBN}'s point of view they work the same; | |
50e3ee83 | 475 | @value{GDBN} need not do anything more than set the breakpoint and wait |
56caf160 | 476 | for something to happen. |
c906108c SS |
477 | |
478 | Since they depend on hardware resources, hardware breakpoints may be | |
56caf160 | 479 | limited in number; when the user asks for more, @value{GDBN} will |
9742079a | 480 | start trying to set software breakpoints. (On some architectures, |
937f164b | 481 | notably the 32-bit x86 platforms, @value{GDBN} cannot always know |
9742079a EZ |
482 | whether there's enough hardware resources to insert all the hardware |
483 | breakpoints and watchpoints. On those platforms, @value{GDBN} prints | |
484 | an error message only when the program being debugged is continued.) | |
56caf160 EZ |
485 | |
486 | @cindex software breakpoints | |
487 | Software breakpoints require @value{GDBN} to do somewhat more work. | |
488 | The basic theory is that @value{GDBN} will replace a program | |
489 | instruction with a trap, illegal divide, or some other instruction | |
490 | that will cause an exception, and then when it's encountered, | |
491 | @value{GDBN} will take the exception and stop the program. When the | |
492 | user says to continue, @value{GDBN} will restore the original | |
c906108c SS |
493 | instruction, single-step, re-insert the trap, and continue on. |
494 | ||
495 | Since it literally overwrites the program being tested, the program area | |
be9c6c35 | 496 | must be writable, so this technique won't work on programs in ROM. It |
c906108c | 497 | can also distort the behavior of programs that examine themselves, |
56caf160 | 498 | although such a situation would be highly unusual. |
c906108c SS |
499 | |
500 | Also, the software breakpoint instruction should be the smallest size of | |
501 | instruction, so it doesn't overwrite an instruction that might be a jump | |
502 | target, and cause disaster when the program jumps into the middle of the | |
503 | breakpoint instruction. (Strictly speaking, the breakpoint must be no | |
504 | larger than the smallest interval between instructions that may be jump | |
505 | targets; perhaps there is an architecture where only even-numbered | |
506 | instructions may jumped to.) Note that it's possible for an instruction | |
507 | set not to have any instructions usable for a software breakpoint, | |
508 | although in practice only the ARC has failed to define such an | |
509 | instruction. | |
510 | ||
c906108c SS |
511 | Basic breakpoint object handling is in @file{breakpoint.c}. However, |
512 | much of the interesting breakpoint action is in @file{infrun.c}. | |
513 | ||
8181d85f DJ |
514 | @table @code |
515 | @cindex insert or remove software breakpoint | |
516 | @findex target_remove_breakpoint | |
517 | @findex target_insert_breakpoint | |
518 | @item target_remove_breakpoint (@var{bp_tgt}) | |
519 | @itemx target_insert_breakpoint (@var{bp_tgt}) | |
520 | Insert or remove a software breakpoint at address | |
521 | @code{@var{bp_tgt}->placed_address}. Returns zero for success, | |
522 | non-zero for failure. On input, @var{bp_tgt} contains the address of the | |
523 | breakpoint, and is otherwise initialized to zero. The fields of the | |
524 | @code{struct bp_target_info} pointed to by @var{bp_tgt} are updated | |
525 | to contain other information about the breakpoint on output. The field | |
526 | @code{placed_address} may be updated if the breakpoint was placed at a | |
527 | related address; the field @code{shadow_contents} contains the real | |
528 | contents of the bytes where the breakpoint has been inserted, | |
529 | if reading memory would return the breakpoint instead of the | |
530 | underlying memory; the field @code{shadow_len} is the length of | |
531 | memory cached in @code{shadow_contents}, if any; and the field | |
532 | @code{placed_size} is optionally set and used by the target, if | |
533 | it could differ from @code{shadow_len}. | |
534 | ||
535 | For example, the remote target @samp{Z0} packet does not require | |
536 | shadowing memory, so @code{shadow_len} is left at zero. However, | |
4a9bb1df | 537 | the length reported by @code{gdbarch_breakpoint_from_pc} is cached in |
8181d85f DJ |
538 | @code{placed_size}, so that a matching @samp{z0} packet can be |
539 | used to remove the breakpoint. | |
540 | ||
541 | @cindex insert or remove hardware breakpoint | |
542 | @findex target_remove_hw_breakpoint | |
543 | @findex target_insert_hw_breakpoint | |
544 | @item target_remove_hw_breakpoint (@var{bp_tgt}) | |
545 | @itemx target_insert_hw_breakpoint (@var{bp_tgt}) | |
546 | Insert or remove a hardware-assisted breakpoint at address | |
547 | @code{@var{bp_tgt}->placed_address}. Returns zero for success, | |
548 | non-zero for failure. See @code{target_insert_breakpoint} for | |
549 | a description of the @code{struct bp_target_info} pointed to by | |
550 | @var{bp_tgt}; the @code{shadow_contents} and | |
551 | @code{shadow_len} members are not used for hardware breakpoints, | |
552 | but @code{placed_size} may be. | |
553 | @end table | |
554 | ||
c906108c SS |
555 | @section Single Stepping |
556 | ||
557 | @section Signal Handling | |
558 | ||
559 | @section Thread Handling | |
560 | ||
561 | @section Inferior Function Calls | |
562 | ||
563 | @section Longjmp Support | |
564 | ||
56caf160 | 565 | @cindex @code{longjmp} debugging |
25822942 | 566 | @value{GDBN} has support for figuring out that the target is doing a |
c906108c SS |
567 | @code{longjmp} and for stopping at the target of the jump, if we are |
568 | stepping. This is done with a few specialized internal breakpoints, | |
56caf160 EZ |
569 | which are visible in the output of the @samp{maint info breakpoint} |
570 | command. | |
c906108c | 571 | |
4a9bb1df UW |
572 | @findex gdbarch_get_longjmp_target |
573 | To make this work, you need to define a function called | |
1f70da6a SS |
574 | @code{gdbarch_get_longjmp_target}, which will examine the |
575 | @code{jmp_buf} structure and extract the @code{longjmp} target address. | |
576 | Since @code{jmp_buf} is target specific and typically defined in a | |
577 | target header not available to @value{GDBN}, you will need to | |
578 | determine the offset of the PC manually and return that; many targets | |
579 | define a @code{jb_pc_offset} field in the tdep structure to save the | |
580 | value once calculated. | |
c906108c | 581 | |
9742079a EZ |
582 | @section Watchpoints |
583 | @cindex watchpoints | |
584 | ||
585 | Watchpoints are a special kind of breakpoints (@pxref{Algorithms, | |
586 | breakpoints}) which break when data is accessed rather than when some | |
587 | instruction is executed. When you have data which changes without | |
588 | your knowing what code does that, watchpoints are the silver bullet to | |
589 | hunt down and kill such bugs. | |
590 | ||
591 | @cindex hardware watchpoints | |
592 | @cindex software watchpoints | |
593 | Watchpoints can be either hardware-assisted or not; the latter type is | |
594 | known as ``software watchpoints.'' @value{GDBN} always uses | |
595 | hardware-assisted watchpoints if they are available, and falls back on | |
596 | software watchpoints otherwise. Typical situations where @value{GDBN} | |
597 | will use software watchpoints are: | |
598 | ||
599 | @itemize @bullet | |
600 | @item | |
601 | The watched memory region is too large for the underlying hardware | |
602 | watchpoint support. For example, each x86 debug register can watch up | |
603 | to 4 bytes of memory, so trying to watch data structures whose size is | |
604 | more than 16 bytes will cause @value{GDBN} to use software | |
605 | watchpoints. | |
606 | ||
607 | @item | |
608 | The value of the expression to be watched depends on data held in | |
609 | registers (as opposed to memory). | |
610 | ||
611 | @item | |
612 | Too many different watchpoints requested. (On some architectures, | |
613 | this situation is impossible to detect until the debugged program is | |
614 | resumed.) Note that x86 debug registers are used both for hardware | |
615 | breakpoints and for watchpoints, so setting too many hardware | |
616 | breakpoints might cause watchpoint insertion to fail. | |
617 | ||
618 | @item | |
619 | No hardware-assisted watchpoints provided by the target | |
620 | implementation. | |
621 | @end itemize | |
622 | ||
623 | Software watchpoints are very slow, since @value{GDBN} needs to | |
624 | single-step the program being debugged and test the value of the | |
625 | watched expression(s) after each instruction. The rest of this | |
626 | section is mostly irrelevant for software watchpoints. | |
627 | ||
b6b8ece6 EZ |
628 | When the inferior stops, @value{GDBN} tries to establish, among other |
629 | possible reasons, whether it stopped due to a watchpoint being hit. | |
d983da9c DJ |
630 | It first uses @code{STOPPED_BY_WATCHPOINT} to see if any watchpoint |
631 | was hit. If not, all watchpoint checking is skipped. | |
632 | ||
633 | Then @value{GDBN} calls @code{target_stopped_data_address} exactly | |
634 | once. This method returns the address of the watchpoint which | |
635 | triggered, if the target can determine it. If the triggered address | |
636 | is available, @value{GDBN} compares the address returned by this | |
637 | method with each watched memory address in each active watchpoint. | |
638 | For data-read and data-access watchpoints, @value{GDBN} announces | |
639 | every watchpoint that watches the triggered address as being hit. | |
640 | For this reason, data-read and data-access watchpoints | |
641 | @emph{require} that the triggered address be available; if not, read | |
642 | and access watchpoints will never be considered hit. For data-write | |
643 | watchpoints, if the triggered address is available, @value{GDBN} | |
644 | considers only those watchpoints which match that address; | |
645 | otherwise, @value{GDBN} considers all data-write watchpoints. For | |
646 | each data-write watchpoint that @value{GDBN} considers, it evaluates | |
647 | the expression whose value is being watched, and tests whether the | |
648 | watched value has changed. Watchpoints whose watched values have | |
649 | changed are announced as hit. | |
b6b8ece6 | 650 | |
1f70da6a SS |
651 | @c FIXME move these to the main lists of target/native defns |
652 | ||
9742079a EZ |
653 | @value{GDBN} uses several macros and primitives to support hardware |
654 | watchpoints: | |
655 | ||
656 | @table @code | |
657 | @findex TARGET_HAS_HARDWARE_WATCHPOINTS | |
658 | @item TARGET_HAS_HARDWARE_WATCHPOINTS | |
659 | If defined, the target supports hardware watchpoints. | |
1f70da6a | 660 | (Currently only used for several native configs.) |
9742079a EZ |
661 | |
662 | @findex TARGET_CAN_USE_HARDWARE_WATCHPOINT | |
663 | @item TARGET_CAN_USE_HARDWARE_WATCHPOINT (@var{type}, @var{count}, @var{other}) | |
664 | Return the number of hardware watchpoints of type @var{type} that are | |
665 | possible to be set. The value is positive if @var{count} watchpoints | |
666 | of this type can be set, zero if setting watchpoints of this type is | |
667 | not supported, and negative if @var{count} is more than the maximum | |
668 | number of watchpoints of type @var{type} that can be set. @var{other} | |
669 | is non-zero if other types of watchpoints are currently enabled (there | |
670 | are architectures which cannot set watchpoints of different types at | |
671 | the same time). | |
672 | ||
673 | @findex TARGET_REGION_OK_FOR_HW_WATCHPOINT | |
674 | @item TARGET_REGION_OK_FOR_HW_WATCHPOINT (@var{addr}, @var{len}) | |
675 | Return non-zero if hardware watchpoints can be used to watch a region | |
676 | whose address is @var{addr} and whose length in bytes is @var{len}. | |
677 | ||
b6b8ece6 | 678 | @cindex insert or remove hardware watchpoint |
9742079a EZ |
679 | @findex target_insert_watchpoint |
680 | @findex target_remove_watchpoint | |
681 | @item target_insert_watchpoint (@var{addr}, @var{len}, @var{type}) | |
682 | @itemx target_remove_watchpoint (@var{addr}, @var{len}, @var{type}) | |
683 | Insert or remove a hardware watchpoint starting at @var{addr}, for | |
684 | @var{len} bytes. @var{type} is the watchpoint type, one of the | |
685 | possible values of the enumerated data type @code{target_hw_bp_type}, | |
686 | defined by @file{breakpoint.h} as follows: | |
687 | ||
474c8240 | 688 | @smallexample |
9742079a EZ |
689 | enum target_hw_bp_type |
690 | @{ | |
691 | hw_write = 0, /* Common (write) HW watchpoint */ | |
692 | hw_read = 1, /* Read HW watchpoint */ | |
693 | hw_access = 2, /* Access (read or write) HW watchpoint */ | |
694 | hw_execute = 3 /* Execute HW breakpoint */ | |
695 | @}; | |
474c8240 | 696 | @end smallexample |
9742079a EZ |
697 | |
698 | @noindent | |
699 | These two macros should return 0 for success, non-zero for failure. | |
700 | ||
9742079a | 701 | @findex target_stopped_data_address |
ac77d04f JJ |
702 | @item target_stopped_data_address (@var{addr_p}) |
703 | If the inferior has some watchpoint that triggered, place the address | |
704 | associated with the watchpoint at the location pointed to by | |
d983da9c DJ |
705 | @var{addr_p} and return non-zero. Otherwise, return zero. This |
706 | is required for data-read and data-access watchpoints. It is | |
707 | not required for data-write watchpoints, but @value{GDBN} uses | |
708 | it to improve handling of those also. | |
709 | ||
710 | @value{GDBN} will only call this method once per watchpoint stop, | |
711 | immediately after calling @code{STOPPED_BY_WATCHPOINT}. If the | |
712 | target's watchpoint indication is sticky, i.e., stays set after | |
713 | resuming, this method should clear it. For instance, the x86 debug | |
714 | control register has sticky triggered flags. | |
9742079a | 715 | |
5009afc5 AS |
716 | @findex target_watchpoint_addr_within_range |
717 | @item target_watchpoint_addr_within_range (@var{target}, @var{addr}, @var{start}, @var{length}) | |
718 | Check whether @var{addr} (as returned by @code{target_stopped_data_address}) | |
719 | lies within the hardware-defined watchpoint region described by | |
720 | @var{start} and @var{length}. This only needs to be provided if the | |
721 | granularity of a watchpoint is greater than one byte, i.e., if the | |
722 | watchpoint can also trigger on nearby addresses outside of the watched | |
723 | region. | |
724 | ||
9742079a EZ |
725 | @findex HAVE_STEPPABLE_WATCHPOINT |
726 | @item HAVE_STEPPABLE_WATCHPOINT | |
727 | If defined to a non-zero value, it is not necessary to disable a | |
5009afc5 | 728 | watchpoint to step over it. Like @code{gdbarch_have_nonsteppable_watchpoint}, |
d983da9c DJ |
729 | this is usually set when watchpoints trigger at the instruction |
730 | which will perform an interesting read or write. It should be | |
731 | set if there is a temporary disable bit which allows the processor | |
732 | to step over the interesting instruction without raising the | |
733 | watchpoint exception again. | |
9742079a | 734 | |
4a9bb1df UW |
735 | @findex gdbarch_have_nonsteppable_watchpoint |
736 | @item int gdbarch_have_nonsteppable_watchpoint (@var{gdbarch}) | |
737 | If it returns a non-zero value, @value{GDBN} should disable a | |
d983da9c DJ |
738 | watchpoint to step the inferior over it. This is usually set when |
739 | watchpoints trigger at the instruction which will perform an | |
740 | interesting read or write. | |
9742079a EZ |
741 | |
742 | @findex HAVE_CONTINUABLE_WATCHPOINT | |
743 | @item HAVE_CONTINUABLE_WATCHPOINT | |
744 | If defined to a non-zero value, it is possible to continue the | |
d983da9c DJ |
745 | inferior after a watchpoint has been hit. This is usually set |
746 | when watchpoints trigger at the instruction following an interesting | |
747 | read or write. | |
9742079a EZ |
748 | |
749 | @findex CANNOT_STEP_HW_WATCHPOINTS | |
750 | @item CANNOT_STEP_HW_WATCHPOINTS | |
751 | If this is defined to a non-zero value, @value{GDBN} will remove all | |
752 | watchpoints before stepping the inferior. | |
753 | ||
754 | @findex STOPPED_BY_WATCHPOINT | |
755 | @item STOPPED_BY_WATCHPOINT (@var{wait_status}) | |
756 | Return non-zero if stopped by a watchpoint. @var{wait_status} is of | |
757 | the type @code{struct target_waitstatus}, defined by @file{target.h}. | |
b6b8ece6 EZ |
758 | Normally, this macro is defined to invoke the function pointed to by |
759 | the @code{to_stopped_by_watchpoint} member of the structure (of the | |
760 | type @code{target_ops}, defined on @file{target.h}) that describes the | |
761 | target-specific operations; @code{to_stopped_by_watchpoint} ignores | |
762 | the @var{wait_status} argument. | |
763 | ||
764 | @value{GDBN} does not require the non-zero value returned by | |
765 | @code{STOPPED_BY_WATCHPOINT} to be 100% correct, so if a target cannot | |
766 | determine for sure whether the inferior stopped due to a watchpoint, | |
767 | it could return non-zero ``just in case''. | |
9742079a EZ |
768 | @end table |
769 | ||
d983da9c DJ |
770 | @subsection Watchpoints and Threads |
771 | @cindex watchpoints, with threads | |
772 | ||
773 | @value{GDBN} only supports process-wide watchpoints, which trigger | |
774 | in all threads. @value{GDBN} uses the thread ID to make watchpoints | |
775 | act as if they were thread-specific, but it cannot set hardware | |
776 | watchpoints that only trigger in a specific thread. Therefore, even | |
777 | if the target supports threads, per-thread debug registers, and | |
778 | watchpoints which only affect a single thread, it should set the | |
779 | per-thread debug registers for all threads to the same value. On | |
780 | @sc{gnu}/Linux native targets, this is accomplished by using | |
781 | @code{ALL_LWPS} in @code{target_insert_watchpoint} and | |
782 | @code{target_remove_watchpoint} and by using | |
783 | @code{linux_set_new_thread} to register a handler for newly created | |
784 | threads. | |
785 | ||
786 | @value{GDBN}'s @sc{gnu}/Linux support only reports a single event | |
787 | at a time, although multiple events can trigger simultaneously for | |
788 | multi-threaded programs. When multiple events occur, @file{linux-nat.c} | |
789 | queues subsequent events and returns them the next time the program | |
790 | is resumed. This means that @code{STOPPED_BY_WATCHPOINT} and | |
791 | @code{target_stopped_data_address} only need to consult the current | |
792 | thread's state---the thread indicated by @code{inferior_ptid}. If | |
793 | two threads have hit watchpoints simultaneously, those routines | |
794 | will be called a second time for the second thread. | |
795 | ||
9742079a EZ |
796 | @subsection x86 Watchpoints |
797 | @cindex x86 debug registers | |
798 | @cindex watchpoints, on x86 | |
799 | ||
800 | The 32-bit Intel x86 (a.k.a.@: ia32) processors feature special debug | |
801 | registers designed to facilitate debugging. @value{GDBN} provides a | |
802 | generic library of functions that x86-based ports can use to implement | |
803 | support for watchpoints and hardware-assisted breakpoints. This | |
804 | subsection documents the x86 watchpoint facilities in @value{GDBN}. | |
805 | ||
1f70da6a SS |
806 | (At present, the library functions read and write debug registers directly, and are |
807 | thus only available for native configurations.) | |
808 | ||
9742079a EZ |
809 | To use the generic x86 watchpoint support, a port should do the |
810 | following: | |
811 | ||
812 | @itemize @bullet | |
813 | @findex I386_USE_GENERIC_WATCHPOINTS | |
814 | @item | |
815 | Define the macro @code{I386_USE_GENERIC_WATCHPOINTS} somewhere in the | |
816 | target-dependent headers. | |
817 | ||
818 | @item | |
819 | Include the @file{config/i386/nm-i386.h} header file @emph{after} | |
820 | defining @code{I386_USE_GENERIC_WATCHPOINTS}. | |
821 | ||
822 | @item | |
823 | Add @file{i386-nat.o} to the value of the Make variable | |
824 | @code{NATDEPFILES} (@pxref{Native Debugging, NATDEPFILES}) or | |
825 | @code{TDEPFILES} (@pxref{Target Architecture Definition, TDEPFILES}). | |
826 | ||
827 | @item | |
828 | Provide implementations for the @code{I386_DR_LOW_*} macros described | |
829 | below. Typically, each macro should call a target-specific function | |
830 | which does the real work. | |
831 | @end itemize | |
832 | ||
833 | The x86 watchpoint support works by maintaining mirror images of the | |
834 | debug registers. Values are copied between the mirror images and the | |
835 | real debug registers via a set of macros which each target needs to | |
836 | provide: | |
837 | ||
838 | @table @code | |
839 | @findex I386_DR_LOW_SET_CONTROL | |
840 | @item I386_DR_LOW_SET_CONTROL (@var{val}) | |
841 | Set the Debug Control (DR7) register to the value @var{val}. | |
842 | ||
843 | @findex I386_DR_LOW_SET_ADDR | |
844 | @item I386_DR_LOW_SET_ADDR (@var{idx}, @var{addr}) | |
845 | Put the address @var{addr} into the debug register number @var{idx}. | |
846 | ||
847 | @findex I386_DR_LOW_RESET_ADDR | |
848 | @item I386_DR_LOW_RESET_ADDR (@var{idx}) | |
849 | Reset (i.e.@: zero out) the address stored in the debug register | |
850 | number @var{idx}. | |
851 | ||
852 | @findex I386_DR_LOW_GET_STATUS | |
853 | @item I386_DR_LOW_GET_STATUS | |
854 | Return the value of the Debug Status (DR6) register. This value is | |
855 | used immediately after it is returned by | |
856 | @code{I386_DR_LOW_GET_STATUS}, so as to support per-thread status | |
857 | register values. | |
858 | @end table | |
859 | ||
860 | For each one of the 4 debug registers (whose indices are from 0 to 3) | |
861 | that store addresses, a reference count is maintained by @value{GDBN}, | |
862 | to allow sharing of debug registers by several watchpoints. This | |
863 | allows users to define several watchpoints that watch the same | |
864 | expression, but with different conditions and/or commands, without | |
865 | wasting debug registers which are in short supply. @value{GDBN} | |
866 | maintains the reference counts internally, targets don't have to do | |
867 | anything to use this feature. | |
868 | ||
869 | The x86 debug registers can each watch a region that is 1, 2, or 4 | |
870 | bytes long. The ia32 architecture requires that each watched region | |
871 | be appropriately aligned: 2-byte region on 2-byte boundary, 4-byte | |
872 | region on 4-byte boundary. However, the x86 watchpoint support in | |
873 | @value{GDBN} can watch unaligned regions and regions larger than 4 | |
874 | bytes (up to 16 bytes) by allocating several debug registers to watch | |
875 | a single region. This allocation of several registers per a watched | |
876 | region is also done automatically without target code intervention. | |
877 | ||
878 | The generic x86 watchpoint support provides the following API for the | |
879 | @value{GDBN}'s application code: | |
880 | ||
881 | @table @code | |
882 | @findex i386_region_ok_for_watchpoint | |
883 | @item i386_region_ok_for_watchpoint (@var{addr}, @var{len}) | |
884 | The macro @code{TARGET_REGION_OK_FOR_HW_WATCHPOINT} is set to call | |
885 | this function. It counts the number of debug registers required to | |
886 | watch a given region, and returns a non-zero value if that number is | |
887 | less than 4, the number of debug registers available to x86 | |
888 | processors. | |
889 | ||
890 | @findex i386_stopped_data_address | |
ac77d04f JJ |
891 | @item i386_stopped_data_address (@var{addr_p}) |
892 | The target function | |
893 | @code{target_stopped_data_address} is set to call this function. | |
894 | This | |
9742079a EZ |
895 | function examines the breakpoint condition bits in the DR6 Debug |
896 | Status register, as returned by the @code{I386_DR_LOW_GET_STATUS} | |
897 | macro, and returns the address associated with the first bit that is | |
898 | set in DR6. | |
899 | ||
ac77d04f JJ |
900 | @findex i386_stopped_by_watchpoint |
901 | @item i386_stopped_by_watchpoint (void) | |
902 | The macro @code{STOPPED_BY_WATCHPOINT} | |
903 | is set to call this function. The | |
904 | argument passed to @code{STOPPED_BY_WATCHPOINT} is ignored. This | |
905 | function examines the breakpoint condition bits in the DR6 Debug | |
906 | Status register, as returned by the @code{I386_DR_LOW_GET_STATUS} | |
907 | macro, and returns true if any bit is set. Otherwise, false is | |
908 | returned. | |
909 | ||
9742079a EZ |
910 | @findex i386_insert_watchpoint |
911 | @findex i386_remove_watchpoint | |
912 | @item i386_insert_watchpoint (@var{addr}, @var{len}, @var{type}) | |
913 | @itemx i386_remove_watchpoint (@var{addr}, @var{len}, @var{type}) | |
914 | Insert or remove a watchpoint. The macros | |
915 | @code{target_insert_watchpoint} and @code{target_remove_watchpoint} | |
916 | are set to call these functions. @code{i386_insert_watchpoint} first | |
917 | looks for a debug register which is already set to watch the same | |
918 | region for the same access types; if found, it just increments the | |
919 | reference count of that debug register, thus implementing debug | |
920 | register sharing between watchpoints. If no such register is found, | |
937f164b FF |
921 | the function looks for a vacant debug register, sets its mirrored |
922 | value to @var{addr}, sets the mirrored value of DR7 Debug Control | |
9742079a EZ |
923 | register as appropriate for the @var{len} and @var{type} parameters, |
924 | and then passes the new values of the debug register and DR7 to the | |
925 | inferior by calling @code{I386_DR_LOW_SET_ADDR} and | |
926 | @code{I386_DR_LOW_SET_CONTROL}. If more than one debug register is | |
927 | required to cover the given region, the above process is repeated for | |
928 | each debug register. | |
929 | ||
930 | @code{i386_remove_watchpoint} does the opposite: it resets the address | |
937f164b FF |
931 | in the mirrored value of the debug register and its read/write and |
932 | length bits in the mirrored value of DR7, then passes these new | |
9742079a EZ |
933 | values to the inferior via @code{I386_DR_LOW_RESET_ADDR} and |
934 | @code{I386_DR_LOW_SET_CONTROL}. If a register is shared by several | |
935 | watchpoints, each time a @code{i386_remove_watchpoint} is called, it | |
936 | decrements the reference count, and only calls | |
937 | @code{I386_DR_LOW_RESET_ADDR} and @code{I386_DR_LOW_SET_CONTROL} when | |
938 | the count goes to zero. | |
939 | ||
940 | @findex i386_insert_hw_breakpoint | |
941 | @findex i386_remove_hw_breakpoint | |
8181d85f DJ |
942 | @item i386_insert_hw_breakpoint (@var{bp_tgt}) |
943 | @itemx i386_remove_hw_breakpoint (@var{bp_tgt}) | |
9742079a EZ |
944 | These functions insert and remove hardware-assisted breakpoints. The |
945 | macros @code{target_insert_hw_breakpoint} and | |
946 | @code{target_remove_hw_breakpoint} are set to call these functions. | |
8181d85f DJ |
947 | The argument is a @code{struct bp_target_info *}, as described in |
948 | the documentation for @code{target_insert_breakpoint}. | |
9742079a EZ |
949 | These functions work like @code{i386_insert_watchpoint} and |
950 | @code{i386_remove_watchpoint}, respectively, except that they set up | |
951 | the debug registers to watch instruction execution, and each | |
952 | hardware-assisted breakpoint always requires exactly one debug | |
953 | register. | |
954 | ||
955 | @findex i386_stopped_by_hwbp | |
956 | @item i386_stopped_by_hwbp (void) | |
957 | This function returns non-zero if the inferior has some watchpoint or | |
958 | hardware breakpoint that triggered. It works like | |
ac77d04f | 959 | @code{i386_stopped_data_address}, except that it doesn't record the |
9742079a EZ |
960 | address whose watchpoint triggered. |
961 | ||
962 | @findex i386_cleanup_dregs | |
963 | @item i386_cleanup_dregs (void) | |
964 | This function clears all the reference counts, addresses, and control | |
965 | bits in the mirror images of the debug registers. It doesn't affect | |
966 | the actual debug registers in the inferior process. | |
967 | @end table | |
968 | ||
969 | @noindent | |
970 | @strong{Notes:} | |
971 | @enumerate 1 | |
972 | @item | |
973 | x86 processors support setting watchpoints on I/O reads or writes. | |
974 | However, since no target supports this (as of March 2001), and since | |
975 | @code{enum target_hw_bp_type} doesn't even have an enumeration for I/O | |
976 | watchpoints, this feature is not yet available to @value{GDBN} running | |
977 | on x86. | |
978 | ||
979 | @item | |
980 | x86 processors can enable watchpoints locally, for the current task | |
981 | only, or globally, for all the tasks. For each debug register, | |
982 | there's a bit in the DR7 Debug Control register that determines | |
983 | whether the associated address is watched locally or globally. The | |
984 | current implementation of x86 watchpoint support in @value{GDBN} | |
985 | always sets watchpoints to be locally enabled, since global | |
986 | watchpoints might interfere with the underlying OS and are probably | |
987 | unavailable in many platforms. | |
988 | @end enumerate | |
989 | ||
5c95884b MS |
990 | @section Checkpoints |
991 | @cindex checkpoints | |
992 | @cindex restart | |
993 | In the abstract, a checkpoint is a point in the execution history of | |
994 | the program, which the user may wish to return to at some later time. | |
995 | ||
996 | Internally, a checkpoint is a saved copy of the program state, including | |
997 | whatever information is required in order to restore the program to that | |
998 | state at a later time. This can be expected to include the state of | |
999 | registers and memory, and may include external state such as the state | |
1000 | of open files and devices. | |
1001 | ||
1002 | There are a number of ways in which checkpoints may be implemented | |
b247355e | 1003 | in gdb, e.g.@: as corefiles, as forked processes, and as some opaque |
5c95884b MS |
1004 | method implemented on the target side. |
1005 | ||
1006 | A corefile can be used to save an image of target memory and register | |
1007 | state, which can in principle be restored later --- but corefiles do | |
1008 | not typically include information about external entities such as | |
1009 | open files. Currently this method is not implemented in gdb. | |
1010 | ||
1011 | A forked process can save the state of user memory and registers, | |
1012 | as well as some subset of external (kernel) state. This method | |
1013 | is used to implement checkpoints on Linux, and in principle might | |
1014 | be used on other systems. | |
1015 | ||
b247355e | 1016 | Some targets, e.g.@: simulators, might have their own built-in |
5c95884b MS |
1017 | method for saving checkpoints, and gdb might be able to take |
1018 | advantage of that capability without necessarily knowing any | |
1019 | details of how it is done. | |
1020 | ||
1021 | ||
bcd7e15f JB |
1022 | @section Observing changes in @value{GDBN} internals |
1023 | @cindex observer pattern interface | |
1024 | @cindex notifications about changes in internals | |
1025 | ||
1026 | In order to function properly, several modules need to be notified when | |
1027 | some changes occur in the @value{GDBN} internals. Traditionally, these | |
1028 | modules have relied on several paradigms, the most common ones being | |
1029 | hooks and gdb-events. Unfortunately, none of these paradigms was | |
1030 | versatile enough to become the standard notification mechanism in | |
1031 | @value{GDBN}. The fact that they only supported one ``client'' was also | |
1032 | a strong limitation. | |
1033 | ||
1034 | A new paradigm, based on the Observer pattern of the @cite{Design | |
1035 | Patterns} book, has therefore been implemented. The goal was to provide | |
1036 | a new interface overcoming the issues with the notification mechanisms | |
1037 | previously available. This new interface needed to be strongly typed, | |
1038 | easy to extend, and versatile enough to be used as the standard | |
1039 | interface when adding new notifications. | |
1040 | ||
1041 | See @ref{GDB Observers} for a brief description of the observers | |
1042 | currently implemented in GDB. The rationale for the current | |
1043 | implementation is also briefly discussed. | |
1044 | ||
c906108c SS |
1045 | @node User Interface |
1046 | ||
1047 | @chapter User Interface | |
1048 | ||
1f70da6a SS |
1049 | @value{GDBN} has several user interfaces, of which the traditional |
1050 | command-line interface is perhaps the most familiar. | |
c906108c SS |
1051 | |
1052 | @section Command Interpreter | |
1053 | ||
56caf160 | 1054 | @cindex command interpreter |
0ee54786 | 1055 | @cindex CLI |
25822942 | 1056 | The command interpreter in @value{GDBN} is fairly simple. It is designed to |
c906108c SS |
1057 | allow for the set of commands to be augmented dynamically, and also |
1058 | has a recursive subcommand capability, where the first argument to | |
1059 | a command may itself direct a lookup on a different command list. | |
1060 | ||
56caf160 EZ |
1061 | For instance, the @samp{set} command just starts a lookup on the |
1062 | @code{setlist} command list, while @samp{set thread} recurses | |
c906108c SS |
1063 | to the @code{set_thread_cmd_list}. |
1064 | ||
56caf160 EZ |
1065 | @findex add_cmd |
1066 | @findex add_com | |
c906108c SS |
1067 | To add commands in general, use @code{add_cmd}. @code{add_com} adds to |
1068 | the main command list, and should be used for those commands. The usual | |
cfeada60 | 1069 | place to add commands is in the @code{_initialize_@var{xyz}} routines at |
9742079a | 1070 | the ends of most source files. |
cfeada60 | 1071 | |
40dd2248 TT |
1072 | @findex add_setshow_cmd |
1073 | @findex add_setshow_cmd_full | |
1074 | To add paired @samp{set} and @samp{show} commands, use | |
1075 | @code{add_setshow_cmd} or @code{add_setshow_cmd_full}. The former is | |
1076 | a slightly simpler interface which is useful when you don't need to | |
1077 | further modify the new command structures, while the latter returns | |
1078 | the new command structures for manipulation. | |
1079 | ||
56caf160 EZ |
1080 | @cindex deprecating commands |
1081 | @findex deprecate_cmd | |
cfeada60 FN |
1082 | Before removing commands from the command set it is a good idea to |
1083 | deprecate them for some time. Use @code{deprecate_cmd} on commands or | |
1084 | aliases to set the deprecated flag. @code{deprecate_cmd} takes a | |
1085 | @code{struct cmd_list_element} as it's first argument. You can use the | |
1086 | return value from @code{add_com} or @code{add_cmd} to deprecate the | |
1087 | command immediately after it is created. | |
1088 | ||
c72e7388 | 1089 | The first time a command is used the user will be warned and offered a |
cfeada60 | 1090 | replacement (if one exists). Note that the replacement string passed to |
d3e8051b | 1091 | @code{deprecate_cmd} should be the full name of the command, i.e., the |
cfeada60 | 1092 | entire string the user should type at the command line. |
c906108c | 1093 | |
0ee54786 EZ |
1094 | @section UI-Independent Output---the @code{ui_out} Functions |
1095 | @c This section is based on the documentation written by Fernando | |
1096 | @c Nasser <fnasser@redhat.com>. | |
1097 | ||
1098 | @cindex @code{ui_out} functions | |
1099 | The @code{ui_out} functions present an abstraction level for the | |
1100 | @value{GDBN} output code. They hide the specifics of different user | |
1101 | interfaces supported by @value{GDBN}, and thus free the programmer | |
1102 | from the need to write several versions of the same code, one each for | |
1103 | every UI, to produce output. | |
1104 | ||
1105 | @subsection Overview and Terminology | |
1106 | ||
1107 | In general, execution of each @value{GDBN} command produces some sort | |
1108 | of output, and can even generate an input request. | |
1109 | ||
1110 | Output can be generated for the following purposes: | |
1111 | ||
1112 | @itemize @bullet | |
1113 | @item | |
1114 | to display a @emph{result} of an operation; | |
1115 | ||
1116 | @item | |
1117 | to convey @emph{info} or produce side-effects of a requested | |
1118 | operation; | |
1119 | ||
1120 | @item | |
1121 | to provide a @emph{notification} of an asynchronous event (including | |
1122 | progress indication of a prolonged asynchronous operation); | |
1123 | ||
1124 | @item | |
1125 | to display @emph{error messages} (including warnings); | |
1126 | ||
1127 | @item | |
1128 | to show @emph{debug data}; | |
1129 | ||
1130 | @item | |
1131 | to @emph{query} or prompt a user for input (a special case). | |
1132 | @end itemize | |
1133 | ||
1134 | @noindent | |
1135 | This section mainly concentrates on how to build result output, | |
1136 | although some of it also applies to other kinds of output. | |
1137 | ||
1138 | Generation of output that displays the results of an operation | |
1139 | involves one or more of the following: | |
1140 | ||
1141 | @itemize @bullet | |
1142 | @item | |
1143 | output of the actual data | |
1144 | ||
1145 | @item | |
1146 | formatting the output as appropriate for console output, to make it | |
1147 | easily readable by humans | |
1148 | ||
1149 | @item | |
1150 | machine oriented formatting--a more terse formatting to allow for easy | |
1151 | parsing by programs which read @value{GDBN}'s output | |
1152 | ||
1153 | @item | |
c72e7388 AC |
1154 | annotation, whose purpose is to help legacy GUIs to identify interesting |
1155 | parts in the output | |
0ee54786 EZ |
1156 | @end itemize |
1157 | ||
1158 | The @code{ui_out} routines take care of the first three aspects. | |
c72e7388 AC |
1159 | Annotations are provided by separate annotation routines. Note that use |
1160 | of annotations for an interface between a GUI and @value{GDBN} is | |
0ee54786 EZ |
1161 | deprecated. |
1162 | ||
c72e7388 AC |
1163 | Output can be in the form of a single item, which we call a @dfn{field}; |
1164 | a @dfn{list} consisting of identical fields; a @dfn{tuple} consisting of | |
1165 | non-identical fields; or a @dfn{table}, which is a tuple consisting of a | |
1166 | header and a body. In a BNF-like form: | |
0ee54786 | 1167 | |
c72e7388 AC |
1168 | @table @code |
1169 | @item <table> @expansion{} | |
1170 | @code{<header> <body>} | |
1171 | @item <header> @expansion{} | |
1172 | @code{@{ <column> @}} | |
1173 | @item <column> @expansion{} | |
1174 | @code{<width> <alignment> <title>} | |
1175 | @item <body> @expansion{} | |
1176 | @code{@{<row>@}} | |
1177 | @end table | |
0ee54786 EZ |
1178 | |
1179 | ||
1180 | @subsection General Conventions | |
1181 | ||
c72e7388 AC |
1182 | Most @code{ui_out} routines are of type @code{void}, the exceptions are |
1183 | @code{ui_out_stream_new} (which returns a pointer to the newly created | |
1184 | object) and the @code{make_cleanup} routines. | |
0ee54786 | 1185 | |
c72e7388 AC |
1186 | The first parameter is always the @code{ui_out} vector object, a pointer |
1187 | to a @code{struct ui_out}. | |
0ee54786 | 1188 | |
c72e7388 AC |
1189 | The @var{format} parameter is like in @code{printf} family of functions. |
1190 | When it is present, there must also be a variable list of arguments | |
1191 | sufficient used to satisfy the @code{%} specifiers in the supplied | |
0ee54786 EZ |
1192 | format. |
1193 | ||
c72e7388 AC |
1194 | When a character string argument is not used in a @code{ui_out} function |
1195 | call, a @code{NULL} pointer has to be supplied instead. | |
0ee54786 EZ |
1196 | |
1197 | ||
c72e7388 | 1198 | @subsection Table, Tuple and List Functions |
0ee54786 EZ |
1199 | |
1200 | @cindex list output functions | |
1201 | @cindex table output functions | |
c72e7388 AC |
1202 | @cindex tuple output functions |
1203 | This section introduces @code{ui_out} routines for building lists, | |
1204 | tuples and tables. The routines to output the actual data items | |
1205 | (fields) are presented in the next section. | |
0ee54786 | 1206 | |
c72e7388 AC |
1207 | To recap: A @dfn{tuple} is a sequence of @dfn{fields}, each field |
1208 | containing information about an object; a @dfn{list} is a sequence of | |
1209 | fields where each field describes an identical object. | |
0ee54786 | 1210 | |
c72e7388 AC |
1211 | Use the @dfn{table} functions when your output consists of a list of |
1212 | rows (tuples) and the console output should include a heading. Use this | |
1213 | even when you are listing just one object but you still want the header. | |
0ee54786 EZ |
1214 | |
1215 | @cindex nesting level in @code{ui_out} functions | |
c72e7388 AC |
1216 | Tables can not be nested. Tuples and lists can be nested up to a |
1217 | maximum of five levels. | |
0ee54786 EZ |
1218 | |
1219 | The overall structure of the table output code is something like this: | |
1220 | ||
474c8240 | 1221 | @smallexample |
0ee54786 EZ |
1222 | ui_out_table_begin |
1223 | ui_out_table_header | |
c72e7388 | 1224 | @dots{} |
0ee54786 | 1225 | ui_out_table_body |
c72e7388 | 1226 | ui_out_tuple_begin |
0ee54786 | 1227 | ui_out_field_* |
c72e7388 AC |
1228 | @dots{} |
1229 | ui_out_tuple_end | |
1230 | @dots{} | |
0ee54786 | 1231 | ui_out_table_end |
474c8240 | 1232 | @end smallexample |
0ee54786 | 1233 | |
c72e7388 | 1234 | Here is the description of table-, tuple- and list-related @code{ui_out} |
0ee54786 EZ |
1235 | functions: |
1236 | ||
c72e7388 AC |
1237 | @deftypefun void ui_out_table_begin (struct ui_out *@var{uiout}, int @var{nbrofcols}, int @var{nr_rows}, const char *@var{tblid}) |
1238 | The function @code{ui_out_table_begin} marks the beginning of the output | |
1239 | of a table. It should always be called before any other @code{ui_out} | |
1240 | function for a given table. @var{nbrofcols} is the number of columns in | |
1241 | the table. @var{nr_rows} is the number of rows in the table. | |
1242 | @var{tblid} is an optional string identifying the table. The string | |
1243 | pointed to by @var{tblid} is copied by the implementation of | |
1244 | @code{ui_out_table_begin}, so the application can free the string if it | |
1245 | was @code{malloc}ed. | |
0ee54786 EZ |
1246 | |
1247 | The companion function @code{ui_out_table_end}, described below, marks | |
1248 | the end of the table's output. | |
1249 | @end deftypefun | |
1250 | ||
c72e7388 AC |
1251 | @deftypefun void ui_out_table_header (struct ui_out *@var{uiout}, int @var{width}, enum ui_align @var{alignment}, const char *@var{colhdr}) |
1252 | @code{ui_out_table_header} provides the header information for a single | |
1253 | table column. You call this function several times, one each for every | |
1254 | column of the table, after @code{ui_out_table_begin}, but before | |
1255 | @code{ui_out_table_body}. | |
0ee54786 EZ |
1256 | |
1257 | The value of @var{width} gives the column width in characters. The | |
1258 | value of @var{alignment} is one of @code{left}, @code{center}, and | |
1259 | @code{right}, and it specifies how to align the header: left-justify, | |
1260 | center, or right-justify it. @var{colhdr} points to a string that | |
1261 | specifies the column header; the implementation copies that string, so | |
c72e7388 AC |
1262 | column header strings in @code{malloc}ed storage can be freed after the |
1263 | call. | |
0ee54786 EZ |
1264 | @end deftypefun |
1265 | ||
1266 | @deftypefun void ui_out_table_body (struct ui_out *@var{uiout}) | |
c72e7388 | 1267 | This function delimits the table header from the table body. |
0ee54786 EZ |
1268 | @end deftypefun |
1269 | ||
1270 | @deftypefun void ui_out_table_end (struct ui_out *@var{uiout}) | |
c72e7388 AC |
1271 | This function signals the end of a table's output. It should be called |
1272 | after the table body has been produced by the list and field output | |
1273 | functions. | |
0ee54786 EZ |
1274 | |
1275 | There should be exactly one call to @code{ui_out_table_end} for each | |
c72e7388 AC |
1276 | call to @code{ui_out_table_begin}, otherwise the @code{ui_out} functions |
1277 | will signal an internal error. | |
0ee54786 EZ |
1278 | @end deftypefun |
1279 | ||
c72e7388 | 1280 | The output of the tuples that represent the table rows must follow the |
0ee54786 | 1281 | call to @code{ui_out_table_body} and precede the call to |
c72e7388 AC |
1282 | @code{ui_out_table_end}. You build a tuple by calling |
1283 | @code{ui_out_tuple_begin} and @code{ui_out_tuple_end}, with suitable | |
0ee54786 EZ |
1284 | calls to functions which actually output fields between them. |
1285 | ||
c72e7388 AC |
1286 | @deftypefun void ui_out_tuple_begin (struct ui_out *@var{uiout}, const char *@var{id}) |
1287 | This function marks the beginning of a tuple output. @var{id} points | |
1288 | to an optional string that identifies the tuple; it is copied by the | |
1289 | implementation, and so strings in @code{malloc}ed storage can be freed | |
1290 | after the call. | |
1291 | @end deftypefun | |
1292 | ||
1293 | @deftypefun void ui_out_tuple_end (struct ui_out *@var{uiout}) | |
1294 | This function signals an end of a tuple output. There should be exactly | |
1295 | one call to @code{ui_out_tuple_end} for each call to | |
1296 | @code{ui_out_tuple_begin}, otherwise an internal @value{GDBN} error will | |
1297 | be signaled. | |
1298 | @end deftypefun | |
1299 | ||
1300 | @deftypefun struct cleanup *make_cleanup_ui_out_tuple_begin_end (struct ui_out *@var{uiout}, const char *@var{id}) | |
1301 | This function first opens the tuple and then establishes a cleanup | |
1302 | (@pxref{Coding, Cleanups}) to close the tuple. It provides a convenient | |
1303 | and correct implementation of the non-portable@footnote{The function | |
b9aa90c9 | 1304 | cast is not portable ISO C.} code sequence: |
c72e7388 AC |
1305 | @smallexample |
1306 | struct cleanup *old_cleanup; | |
1307 | ui_out_tuple_begin (uiout, "..."); | |
1308 | old_cleanup = make_cleanup ((void(*)(void *)) ui_out_tuple_end, | |
1309 | uiout); | |
1310 | @end smallexample | |
1311 | @end deftypefun | |
1312 | ||
1313 | @deftypefun void ui_out_list_begin (struct ui_out *@var{uiout}, const char *@var{id}) | |
1314 | This function marks the beginning of a list output. @var{id} points to | |
1315 | an optional string that identifies the list; it is copied by the | |
1316 | implementation, and so strings in @code{malloc}ed storage can be freed | |
1317 | after the call. | |
0ee54786 EZ |
1318 | @end deftypefun |
1319 | ||
1320 | @deftypefun void ui_out_list_end (struct ui_out *@var{uiout}) | |
c72e7388 AC |
1321 | This function signals an end of a list output. There should be exactly |
1322 | one call to @code{ui_out_list_end} for each call to | |
1323 | @code{ui_out_list_begin}, otherwise an internal @value{GDBN} error will | |
1324 | be signaled. | |
1325 | @end deftypefun | |
1326 | ||
1327 | @deftypefun struct cleanup *make_cleanup_ui_out_list_begin_end (struct ui_out *@var{uiout}, const char *@var{id}) | |
1328 | Similar to @code{make_cleanup_ui_out_tuple_begin_end}, this function | |
1329 | opens a list and then establishes cleanup (@pxref{Coding, Cleanups}) | |
f66d1690 | 1330 | that will close the list. |
0ee54786 EZ |
1331 | @end deftypefun |
1332 | ||
1333 | @subsection Item Output Functions | |
1334 | ||
1335 | @cindex item output functions | |
1336 | @cindex field output functions | |
1337 | @cindex data output | |
1338 | The functions described below produce output for the actual data | |
1339 | items, or fields, which contain information about the object. | |
1340 | ||
1341 | Choose the appropriate function accordingly to your particular needs. | |
1342 | ||
1343 | @deftypefun void ui_out_field_fmt (struct ui_out *@var{uiout}, char *@var{fldname}, char *@var{format}, ...) | |
1344 | This is the most general output function. It produces the | |
1345 | representation of the data in the variable-length argument list | |
1346 | according to formatting specifications in @var{format}, a | |
1347 | @code{printf}-like format string. The optional argument @var{fldname} | |
1348 | supplies the name of the field. The data items themselves are | |
1349 | supplied as additional arguments after @var{format}. | |
1350 | ||
1351 | This generic function should be used only when it is not possible to | |
1352 | use one of the specialized versions (see below). | |
1353 | @end deftypefun | |
1354 | ||
c72e7388 | 1355 | @deftypefun void ui_out_field_int (struct ui_out *@var{uiout}, const char *@var{fldname}, int @var{value}) |
0ee54786 EZ |
1356 | This function outputs a value of an @code{int} variable. It uses the |
1357 | @code{"%d"} output conversion specification. @var{fldname} specifies | |
1358 | the name of the field. | |
1359 | @end deftypefun | |
8d19fbd2 JJ |
1360 | |
1361 | @deftypefun void ui_out_field_fmt_int (struct ui_out *@var{uiout}, int @var{width}, enum ui_align @var{alignment}, const char *@var{fldname}, int @var{value}) | |
1362 | This function outputs a value of an @code{int} variable. It differs from | |
1363 | @code{ui_out_field_int} in that the caller specifies the desired @var{width} and @var{alignment} of the output. | |
1364 | @var{fldname} specifies | |
1365 | the name of the field. | |
1366 | @end deftypefun | |
0ee54786 | 1367 | |
c72e7388 | 1368 | @deftypefun void ui_out_field_core_addr (struct ui_out *@var{uiout}, const char *@var{fldname}, CORE_ADDR @var{address}) |
0ee54786 EZ |
1369 | This function outputs an address. |
1370 | @end deftypefun | |
1371 | ||
c72e7388 | 1372 | @deftypefun void ui_out_field_string (struct ui_out *@var{uiout}, const char *@var{fldname}, const char *@var{string}) |
0ee54786 EZ |
1373 | This function outputs a string using the @code{"%s"} conversion |
1374 | specification. | |
1375 | @end deftypefun | |
1376 | ||
1377 | Sometimes, there's a need to compose your output piece by piece using | |
1378 | functions that operate on a stream, such as @code{value_print} or | |
1379 | @code{fprintf_symbol_filtered}. These functions accept an argument of | |
1380 | the type @code{struct ui_file *}, a pointer to a @code{ui_file} object | |
1381 | used to store the data stream used for the output. When you use one | |
1382 | of these functions, you need a way to pass their results stored in a | |
1383 | @code{ui_file} object to the @code{ui_out} functions. To this end, | |
1384 | you first create a @code{ui_stream} object by calling | |
1385 | @code{ui_out_stream_new}, pass the @code{stream} member of that | |
1386 | @code{ui_stream} object to @code{value_print} and similar functions, | |
1387 | and finally call @code{ui_out_field_stream} to output the field you | |
1388 | constructed. When the @code{ui_stream} object is no longer needed, | |
1389 | you should destroy it and free its memory by calling | |
1390 | @code{ui_out_stream_delete}. | |
1391 | ||
1392 | @deftypefun struct ui_stream *ui_out_stream_new (struct ui_out *@var{uiout}) | |
1393 | This function creates a new @code{ui_stream} object which uses the | |
1394 | same output methods as the @code{ui_out} object whose pointer is | |
1395 | passed in @var{uiout}. It returns a pointer to the newly created | |
1396 | @code{ui_stream} object. | |
1397 | @end deftypefun | |
1398 | ||
1399 | @deftypefun void ui_out_stream_delete (struct ui_stream *@var{streambuf}) | |
1400 | This functions destroys a @code{ui_stream} object specified by | |
1401 | @var{streambuf}. | |
1402 | @end deftypefun | |
1403 | ||
c72e7388 | 1404 | @deftypefun void ui_out_field_stream (struct ui_out *@var{uiout}, const char *@var{fieldname}, struct ui_stream *@var{streambuf}) |
0ee54786 EZ |
1405 | This function consumes all the data accumulated in |
1406 | @code{streambuf->stream} and outputs it like | |
1407 | @code{ui_out_field_string} does. After a call to | |
1408 | @code{ui_out_field_stream}, the accumulated data no longer exists, but | |
1409 | the stream is still valid and may be used for producing more fields. | |
1410 | @end deftypefun | |
1411 | ||
1412 | @strong{Important:} If there is any chance that your code could bail | |
1413 | out before completing output generation and reaching the point where | |
1414 | @code{ui_out_stream_delete} is called, it is necessary to set up a | |
1415 | cleanup, to avoid leaking memory and other resources. Here's a | |
1416 | skeleton code to do that: | |
1417 | ||
1418 | @smallexample | |
1419 | struct ui_stream *mybuf = ui_out_stream_new (uiout); | |
1420 | struct cleanup *old = make_cleanup (ui_out_stream_delete, mybuf); | |
1421 | ... | |
1422 | do_cleanups (old); | |
1423 | @end smallexample | |
1424 | ||
1425 | If the function already has the old cleanup chain set (for other kinds | |
1426 | of cleanups), you just have to add your cleanup to it: | |
1427 | ||
1428 | @smallexample | |
1429 | mybuf = ui_out_stream_new (uiout); | |
1430 | make_cleanup (ui_out_stream_delete, mybuf); | |
1431 | @end smallexample | |
1432 | ||
1433 | Note that with cleanups in place, you should not call | |
1434 | @code{ui_out_stream_delete} directly, or you would attempt to free the | |
1435 | same buffer twice. | |
1436 | ||
1437 | @subsection Utility Output Functions | |
1438 | ||
c72e7388 | 1439 | @deftypefun void ui_out_field_skip (struct ui_out *@var{uiout}, const char *@var{fldname}) |
0ee54786 EZ |
1440 | This function skips a field in a table. Use it if you have to leave |
1441 | an empty field without disrupting the table alignment. The argument | |
1442 | @var{fldname} specifies a name for the (missing) filed. | |
1443 | @end deftypefun | |
1444 | ||
c72e7388 | 1445 | @deftypefun void ui_out_text (struct ui_out *@var{uiout}, const char *@var{string}) |
0ee54786 EZ |
1446 | This function outputs the text in @var{string} in a way that makes it |
1447 | easy to be read by humans. For example, the console implementation of | |
1448 | this method filters the text through a built-in pager, to prevent it | |
1449 | from scrolling off the visible portion of the screen. | |
1450 | ||
1451 | Use this function for printing relatively long chunks of text around | |
1452 | the actual field data: the text it produces is not aligned according | |
1453 | to the table's format. Use @code{ui_out_field_string} to output a | |
1454 | string field, and use @code{ui_out_message}, described below, to | |
1455 | output short messages. | |
1456 | @end deftypefun | |
1457 | ||
1458 | @deftypefun void ui_out_spaces (struct ui_out *@var{uiout}, int @var{nspaces}) | |
1459 | This function outputs @var{nspaces} spaces. It is handy to align the | |
1460 | text produced by @code{ui_out_text} with the rest of the table or | |
1461 | list. | |
1462 | @end deftypefun | |
1463 | ||
c72e7388 | 1464 | @deftypefun void ui_out_message (struct ui_out *@var{uiout}, int @var{verbosity}, const char *@var{format}, ...) |
0ee54786 EZ |
1465 | This function produces a formatted message, provided that the current |
1466 | verbosity level is at least as large as given by @var{verbosity}. The | |
1467 | current verbosity level is specified by the user with the @samp{set | |
1468 | verbositylevel} command.@footnote{As of this writing (April 2001), | |
1469 | setting verbosity level is not yet implemented, and is always returned | |
1470 | as zero. So calling @code{ui_out_message} with a @var{verbosity} | |
1471 | argument more than zero will cause the message to never be printed.} | |
1472 | @end deftypefun | |
1473 | ||
1474 | @deftypefun void ui_out_wrap_hint (struct ui_out *@var{uiout}, char *@var{indent}) | |
1475 | This function gives the console output filter (a paging filter) a hint | |
1476 | of where to break lines which are too long. Ignored for all other | |
1477 | output consumers. @var{indent}, if non-@code{NULL}, is the string to | |
1478 | be printed to indent the wrapped text on the next line; it must remain | |
1479 | accessible until the next call to @code{ui_out_wrap_hint}, or until an | |
1480 | explicit newline is produced by one of the other functions. If | |
1481 | @var{indent} is @code{NULL}, the wrapped text will not be indented. | |
1482 | @end deftypefun | |
1483 | ||
1484 | @deftypefun void ui_out_flush (struct ui_out *@var{uiout}) | |
1485 | This function flushes whatever output has been accumulated so far, if | |
1486 | the UI buffers output. | |
1487 | @end deftypefun | |
1488 | ||
1489 | ||
1490 | @subsection Examples of Use of @code{ui_out} functions | |
1491 | ||
1492 | @cindex using @code{ui_out} functions | |
1493 | @cindex @code{ui_out} functions, usage examples | |
1494 | This section gives some practical examples of using the @code{ui_out} | |
1495 | functions to generalize the old console-oriented code in | |
1496 | @value{GDBN}. The examples all come from functions defined on the | |
1497 | @file{breakpoints.c} file. | |
1498 | ||
1499 | This example, from the @code{breakpoint_1} function, shows how to | |
1500 | produce a table. | |
1501 | ||
1502 | The original code was: | |
1503 | ||
474c8240 | 1504 | @smallexample |
0ee54786 EZ |
1505 | if (!found_a_breakpoint++) |
1506 | @{ | |
1507 | annotate_breakpoints_headers (); | |
1508 | ||
1509 | annotate_field (0); | |
1510 | printf_filtered ("Num "); | |
1511 | annotate_field (1); | |
1512 | printf_filtered ("Type "); | |
1513 | annotate_field (2); | |
1514 | printf_filtered ("Disp "); | |
1515 | annotate_field (3); | |
1516 | printf_filtered ("Enb "); | |
1517 | if (addressprint) | |
1518 | @{ | |
1519 | annotate_field (4); | |
1520 | printf_filtered ("Address "); | |
1521 | @} | |
1522 | annotate_field (5); | |
1523 | printf_filtered ("What\n"); | |
1524 | ||
1525 | annotate_breakpoints_table (); | |
1526 | @} | |
474c8240 | 1527 | @end smallexample |
0ee54786 EZ |
1528 | |
1529 | Here's the new version: | |
1530 | ||
474c8240 | 1531 | @smallexample |
c72e7388 AC |
1532 | nr_printable_breakpoints = @dots{}; |
1533 | ||
1534 | if (addressprint) | |
1535 | ui_out_table_begin (ui, 6, nr_printable_breakpoints, "BreakpointTable"); | |
1536 | else | |
1537 | ui_out_table_begin (ui, 5, nr_printable_breakpoints, "BreakpointTable"); | |
1538 | ||
1539 | if (nr_printable_breakpoints > 0) | |
1540 | annotate_breakpoints_headers (); | |
1541 | if (nr_printable_breakpoints > 0) | |
1542 | annotate_field (0); | |
1543 | ui_out_table_header (uiout, 3, ui_left, "number", "Num"); /* 1 */ | |
1544 | if (nr_printable_breakpoints > 0) | |
1545 | annotate_field (1); | |
1546 | ui_out_table_header (uiout, 14, ui_left, "type", "Type"); /* 2 */ | |
1547 | if (nr_printable_breakpoints > 0) | |
1548 | annotate_field (2); | |
1549 | ui_out_table_header (uiout, 4, ui_left, "disp", "Disp"); /* 3 */ | |
1550 | if (nr_printable_breakpoints > 0) | |
1551 | annotate_field (3); | |
1552 | ui_out_table_header (uiout, 3, ui_left, "enabled", "Enb"); /* 4 */ | |
1553 | if (addressprint) | |
1554 | @{ | |
1555 | if (nr_printable_breakpoints > 0) | |
1556 | annotate_field (4); | |
4a9bb1df | 1557 | if (gdbarch_addr_bit (current_gdbarch) <= 32) |
c72e7388 | 1558 | ui_out_table_header (uiout, 10, ui_left, "addr", "Address");/* 5 */ |
0ee54786 | 1559 | else |
c72e7388 AC |
1560 | ui_out_table_header (uiout, 18, ui_left, "addr", "Address");/* 5 */ |
1561 | @} | |
1562 | if (nr_printable_breakpoints > 0) | |
1563 | annotate_field (5); | |
1564 | ui_out_table_header (uiout, 40, ui_noalign, "what", "What"); /* 6 */ | |
1565 | ui_out_table_body (uiout); | |
1566 | if (nr_printable_breakpoints > 0) | |
1567 | annotate_breakpoints_table (); | |
474c8240 | 1568 | @end smallexample |
0ee54786 EZ |
1569 | |
1570 | This example, from the @code{print_one_breakpoint} function, shows how | |
1571 | to produce the actual data for the table whose structure was defined | |
1572 | in the above example. The original code was: | |
1573 | ||
474c8240 | 1574 | @smallexample |
0ee54786 EZ |
1575 | annotate_record (); |
1576 | annotate_field (0); | |
1577 | printf_filtered ("%-3d ", b->number); | |
1578 | annotate_field (1); | |
1579 | if ((int)b->type > (sizeof(bptypes)/sizeof(bptypes[0])) | |
1580 | || ((int) b->type != bptypes[(int) b->type].type)) | |
1581 | internal_error ("bptypes table does not describe type #%d.", | |
1582 | (int)b->type); | |
1583 | printf_filtered ("%-14s ", bptypes[(int)b->type].description); | |
1584 | annotate_field (2); | |
1585 | printf_filtered ("%-4s ", bpdisps[(int)b->disposition]); | |
1586 | annotate_field (3); | |
1587 | printf_filtered ("%-3c ", bpenables[(int)b->enable]); | |
c72e7388 | 1588 | @dots{} |
474c8240 | 1589 | @end smallexample |
0ee54786 EZ |
1590 | |
1591 | This is the new version: | |
1592 | ||
474c8240 | 1593 | @smallexample |
0ee54786 | 1594 | annotate_record (); |
c72e7388 | 1595 | ui_out_tuple_begin (uiout, "bkpt"); |
0ee54786 EZ |
1596 | annotate_field (0); |
1597 | ui_out_field_int (uiout, "number", b->number); | |
1598 | annotate_field (1); | |
1599 | if (((int) b->type > (sizeof (bptypes) / sizeof (bptypes[0]))) | |
1600 | || ((int) b->type != bptypes[(int) b->type].type)) | |
1601 | internal_error ("bptypes table does not describe type #%d.", | |
1602 | (int) b->type); | |
1603 | ui_out_field_string (uiout, "type", bptypes[(int)b->type].description); | |
1604 | annotate_field (2); | |
1605 | ui_out_field_string (uiout, "disp", bpdisps[(int)b->disposition]); | |
1606 | annotate_field (3); | |
1607 | ui_out_field_fmt (uiout, "enabled", "%c", bpenables[(int)b->enable]); | |
c72e7388 | 1608 | @dots{} |
474c8240 | 1609 | @end smallexample |
0ee54786 EZ |
1610 | |
1611 | This example, also from @code{print_one_breakpoint}, shows how to | |
1612 | produce a complicated output field using the @code{print_expression} | |
1613 | functions which requires a stream to be passed. It also shows how to | |
1614 | automate stream destruction with cleanups. The original code was: | |
1615 | ||
474c8240 | 1616 | @smallexample |
0ee54786 EZ |
1617 | annotate_field (5); |
1618 | print_expression (b->exp, gdb_stdout); | |
474c8240 | 1619 | @end smallexample |
0ee54786 EZ |
1620 | |
1621 | The new version is: | |
1622 | ||
474c8240 | 1623 | @smallexample |
0ee54786 EZ |
1624 | struct ui_stream *stb = ui_out_stream_new (uiout); |
1625 | struct cleanup *old_chain = make_cleanup_ui_out_stream_delete (stb); | |
1626 | ... | |
1627 | annotate_field (5); | |
1628 | print_expression (b->exp, stb->stream); | |
1629 | ui_out_field_stream (uiout, "what", local_stream); | |
474c8240 | 1630 | @end smallexample |
0ee54786 EZ |
1631 | |
1632 | This example, also from @code{print_one_breakpoint}, shows how to use | |
1633 | @code{ui_out_text} and @code{ui_out_field_string}. The original code | |
1634 | was: | |
1635 | ||
474c8240 | 1636 | @smallexample |
0ee54786 EZ |
1637 | annotate_field (5); |
1638 | if (b->dll_pathname == NULL) | |
1639 | printf_filtered ("<any library> "); | |
1640 | else | |
1641 | printf_filtered ("library \"%s\" ", b->dll_pathname); | |
474c8240 | 1642 | @end smallexample |
0ee54786 EZ |
1643 | |
1644 | It became: | |
1645 | ||
474c8240 | 1646 | @smallexample |
0ee54786 EZ |
1647 | annotate_field (5); |
1648 | if (b->dll_pathname == NULL) | |
1649 | @{ | |
1650 | ui_out_field_string (uiout, "what", "<any library>"); | |
1651 | ui_out_spaces (uiout, 1); | |
1652 | @} | |
1653 | else | |
1654 | @{ | |
1655 | ui_out_text (uiout, "library \""); | |
1656 | ui_out_field_string (uiout, "what", b->dll_pathname); | |
1657 | ui_out_text (uiout, "\" "); | |
1658 | @} | |
474c8240 | 1659 | @end smallexample |
0ee54786 EZ |
1660 | |
1661 | The following example from @code{print_one_breakpoint} shows how to | |
1662 | use @code{ui_out_field_int} and @code{ui_out_spaces}. The original | |
1663 | code was: | |
1664 | ||
474c8240 | 1665 | @smallexample |
0ee54786 EZ |
1666 | annotate_field (5); |
1667 | if (b->forked_inferior_pid != 0) | |
1668 | printf_filtered ("process %d ", b->forked_inferior_pid); | |
474c8240 | 1669 | @end smallexample |
0ee54786 EZ |
1670 | |
1671 | It became: | |
1672 | ||
474c8240 | 1673 | @smallexample |
0ee54786 EZ |
1674 | annotate_field (5); |
1675 | if (b->forked_inferior_pid != 0) | |
1676 | @{ | |
1677 | ui_out_text (uiout, "process "); | |
1678 | ui_out_field_int (uiout, "what", b->forked_inferior_pid); | |
1679 | ui_out_spaces (uiout, 1); | |
1680 | @} | |
474c8240 | 1681 | @end smallexample |
0ee54786 EZ |
1682 | |
1683 | Here's an example of using @code{ui_out_field_string}. The original | |
1684 | code was: | |
1685 | ||
474c8240 | 1686 | @smallexample |
0ee54786 EZ |
1687 | annotate_field (5); |
1688 | if (b->exec_pathname != NULL) | |
1689 | printf_filtered ("program \"%s\" ", b->exec_pathname); | |
474c8240 | 1690 | @end smallexample |
0ee54786 EZ |
1691 | |
1692 | It became: | |
1693 | ||
474c8240 | 1694 | @smallexample |
0ee54786 EZ |
1695 | annotate_field (5); |
1696 | if (b->exec_pathname != NULL) | |
1697 | @{ | |
1698 | ui_out_text (uiout, "program \""); | |
1699 | ui_out_field_string (uiout, "what", b->exec_pathname); | |
1700 | ui_out_text (uiout, "\" "); | |
1701 | @} | |
474c8240 | 1702 | @end smallexample |
0ee54786 EZ |
1703 | |
1704 | Finally, here's an example of printing an address. The original code: | |
1705 | ||
474c8240 | 1706 | @smallexample |
0ee54786 EZ |
1707 | annotate_field (4); |
1708 | printf_filtered ("%s ", | |
15a661f3 | 1709 | hex_string_custom ((unsigned long) b->address, 8)); |
474c8240 | 1710 | @end smallexample |
0ee54786 EZ |
1711 | |
1712 | It became: | |
1713 | ||
474c8240 | 1714 | @smallexample |
0ee54786 EZ |
1715 | annotate_field (4); |
1716 | ui_out_field_core_addr (uiout, "Address", b->address); | |
474c8240 | 1717 | @end smallexample |
0ee54786 EZ |
1718 | |
1719 | ||
c906108c SS |
1720 | @section Console Printing |
1721 | ||
1722 | @section TUI | |
1723 | ||
89437448 | 1724 | @node libgdb |
c906108c | 1725 | |
89437448 AC |
1726 | @chapter libgdb |
1727 | ||
1728 | @section libgdb 1.0 | |
1729 | @cindex @code{libgdb} | |
1730 | @code{libgdb} 1.0 was an abortive project of years ago. The theory was | |
1731 | to provide an API to @value{GDBN}'s functionality. | |
1732 | ||
1733 | @section libgdb 2.0 | |
56caf160 | 1734 | @cindex @code{libgdb} |
89437448 AC |
1735 | @code{libgdb} 2.0 is an ongoing effort to update @value{GDBN} so that is |
1736 | better able to support graphical and other environments. | |
1737 | ||
1738 | Since @code{libgdb} development is on-going, its architecture is still | |
1739 | evolving. The following components have so far been identified: | |
1740 | ||
1741 | @itemize @bullet | |
1742 | @item | |
1743 | Observer - @file{gdb-events.h}. | |
1744 | @item | |
1745 | Builder - @file{ui-out.h} | |
1746 | @item | |
1747 | Event Loop - @file{event-loop.h} | |
1748 | @item | |
1749 | Library - @file{gdb.h} | |
1750 | @end itemize | |
1751 | ||
1752 | The model that ties these components together is described below. | |
1753 | ||
1754 | @section The @code{libgdb} Model | |
1755 | ||
1756 | A client of @code{libgdb} interacts with the library in two ways. | |
1757 | ||
1758 | @itemize @bullet | |
1759 | @item | |
1760 | As an observer (using @file{gdb-events}) receiving notifications from | |
1761 | @code{libgdb} of any internal state changes (break point changes, run | |
1762 | state, etc). | |
1763 | @item | |
1764 | As a client querying @code{libgdb} (using the @file{ui-out} builder) to | |
1765 | obtain various status values from @value{GDBN}. | |
1766 | @end itemize | |
1767 | ||
c1468174 | 1768 | Since @code{libgdb} could have multiple clients (e.g., a GUI supporting |
89437448 AC |
1769 | the existing @value{GDBN} CLI), those clients must co-operate when |
1770 | controlling @code{libgdb}. In particular, a client must ensure that | |
1771 | @code{libgdb} is idle (i.e. no other client is using @code{libgdb}) | |
1772 | before responding to a @file{gdb-event} by making a query. | |
1773 | ||
1774 | @section CLI support | |
1775 | ||
1776 | At present @value{GDBN}'s CLI is very much entangled in with the core of | |
1777 | @code{libgdb}. Consequently, a client wishing to include the CLI in | |
1778 | their interface needs to carefully co-ordinate its own and the CLI's | |
1779 | requirements. | |
1780 | ||
1781 | It is suggested that the client set @code{libgdb} up to be bi-modal | |
1782 | (alternate between CLI and client query modes). The notes below sketch | |
1783 | out the theory: | |
1784 | ||
1785 | @itemize @bullet | |
1786 | @item | |
1787 | The client registers itself as an observer of @code{libgdb}. | |
1788 | @item | |
1789 | The client create and install @code{cli-out} builder using its own | |
1790 | versions of the @code{ui-file} @code{gdb_stderr}, @code{gdb_stdtarg} and | |
1791 | @code{gdb_stdout} streams. | |
1792 | @item | |
1793 | The client creates a separate custom @code{ui-out} builder that is only | |
1794 | used while making direct queries to @code{libgdb}. | |
1795 | @end itemize | |
1796 | ||
1797 | When the client receives input intended for the CLI, it simply passes it | |
1798 | along. Since the @code{cli-out} builder is installed by default, all | |
1799 | the CLI output in response to that command is routed (pronounced rooted) | |
1800 | through to the client controlled @code{gdb_stdout} et.@: al.@: streams. | |
1801 | At the same time, the client is kept abreast of internal changes by | |
1802 | virtue of being a @code{libgdb} observer. | |
1803 | ||
1804 | The only restriction on the client is that it must wait until | |
1805 | @code{libgdb} becomes idle before initiating any queries (using the | |
1806 | client's custom builder). | |
1807 | ||
1808 | @section @code{libgdb} components | |
1809 | ||
1810 | @subheading Observer - @file{gdb-events.h} | |
1811 | @file{gdb-events} provides the client with a very raw mechanism that can | |
1812 | be used to implement an observer. At present it only allows for one | |
1813 | observer and that observer must, internally, handle the need to delay | |
1814 | the processing of any event notifications until after @code{libgdb} has | |
1815 | finished the current command. | |
1816 | ||
1817 | @subheading Builder - @file{ui-out.h} | |
1818 | @file{ui-out} provides the infrastructure necessary for a client to | |
1819 | create a builder. That builder is then passed down to @code{libgdb} | |
1820 | when doing any queries. | |
1821 | ||
1822 | @subheading Event Loop - @file{event-loop.h} | |
1823 | @c There could be an entire section on the event-loop | |
1824 | @file{event-loop}, currently non-re-entrant, provides a simple event | |
1825 | loop. A client would need to either plug its self into this loop or, | |
1826 | implement a new event-loop that GDB would use. | |
1827 | ||
1828 | The event-loop will eventually be made re-entrant. This is so that | |
a9f12a31 | 1829 | @value{GDBN} can better handle the problem of some commands blocking |
89437448 AC |
1830 | instead of returning. |
1831 | ||
1832 | @subheading Library - @file{gdb.h} | |
1833 | @file{libgdb} is the most obvious component of this system. It provides | |
1834 | the query interface. Each function is parameterized by a @code{ui-out} | |
1835 | builder. The result of the query is constructed using that builder | |
1836 | before the query function returns. | |
c906108c | 1837 | |
669fac23 DJ |
1838 | @node Stack Frames |
1839 | @chapter Stack Frames | |
1840 | ||
1841 | @cindex frame | |
1842 | @cindex call stack frame | |
1843 | A frame is a construct that @value{GDBN} uses to keep track of calling | |
1844 | and called functions. | |
1845 | ||
1846 | @cindex unwind frame | |
1847 | @value{GDBN}'s frame model, a fresh design, was implemented with the | |
1848 | need to support @sc{dwarf}'s Call Frame Information in mind. In fact, | |
1849 | the term ``unwind'' is taken directly from that specification. | |
1850 | Developers wishing to learn more about unwinders, are encouraged to | |
1851 | read the @sc{dwarf} specification, available from | |
1852 | @url{http://www.dwarfstd.org}. | |
1853 | ||
1854 | @findex frame_register_unwind | |
1855 | @findex get_frame_register | |
1856 | @value{GDBN}'s model is that you find a frame's registers by | |
1857 | ``unwinding'' them from the next younger frame. That is, | |
1858 | @samp{get_frame_register} which returns the value of a register in | |
1859 | frame #1 (the next-to-youngest frame), is implemented by calling frame | |
1860 | #0's @code{frame_register_unwind} (the youngest frame). But then the | |
1861 | obvious question is: how do you access the registers of the youngest | |
1862 | frame itself? | |
1863 | ||
1864 | @cindex sentinel frame | |
1865 | @findex get_frame_type | |
1866 | @vindex SENTINEL_FRAME | |
1867 | To answer this question, GDB has the @dfn{sentinel} frame, the | |
1868 | ``-1st'' frame. Unwinding registers from the sentinel frame gives you | |
1869 | the current values of the youngest real frame's registers. If @var{f} | |
1870 | is a sentinel frame, then @code{get_frame_type (@var{f}) @equiv{} | |
1871 | SENTINEL_FRAME}. | |
1872 | ||
1873 | @section Selecting an Unwinder | |
1874 | ||
1875 | @findex frame_unwind_prepend_unwinder | |
1876 | @findex frame_unwind_append_unwinder | |
1877 | The architecture registers a list of frame unwinders (@code{struct | |
1878 | frame_unwind}), using the functions | |
1879 | @code{frame_unwind_prepend_unwinder} and | |
1880 | @code{frame_unwind_append_unwinder}. Each unwinder includes a | |
1881 | sniffer. Whenever @value{GDBN} needs to unwind a frame (to fetch the | |
1882 | previous frame's registers or the current frame's ID), it calls | |
1883 | registered sniffers in order to find one which recognizes the frame. | |
1884 | The first time a sniffer returns non-zero, the corresponding unwinder | |
1885 | is assigned to the frame. | |
1886 | ||
1887 | @section Unwinding the Frame ID | |
1888 | @cindex frame ID | |
1889 | ||
1890 | Every frame has an associated ID, of type @code{struct frame_id}. | |
1891 | The ID includes the stack base and function start address for | |
1892 | the frame. The ID persists through the entire life of the frame, | |
1893 | including while other called frames are running; it is used to | |
1894 | locate an appropriate @code{struct frame_info} from the cache. | |
1895 | ||
1896 | Every time the inferior stops, and at various other times, the frame | |
1897 | cache is flushed. Because of this, parts of @value{GDBN} which need | |
1898 | to keep track of individual frames cannot use pointers to @code{struct | |
1899 | frame_info}. A frame ID provides a stable reference to a frame, even | |
1900 | when the unwinder must be run again to generate a new @code{struct | |
1901 | frame_info} for the same frame. | |
1902 | ||
1903 | The frame's unwinder's @code{this_id} method is called to find the ID. | |
1904 | Note that this is different from register unwinding, where the next | |
1905 | frame's @code{prev_register} is called to unwind this frame's | |
1906 | registers. | |
1907 | ||
1908 | Both stack base and function address are required to identify the | |
1909 | frame, because a recursive function has the same function address for | |
1910 | two consecutive frames and a leaf function may have the same stack | |
1911 | address as its caller. On some platforms, a third address is part of | |
1912 | the ID to further disambiguate frames---for instance, on IA-64 | |
1913 | the separate register stack address is included in the ID. | |
1914 | ||
1915 | An invalid frame ID (@code{null_frame_id}) returned from the | |
1916 | @code{this_id} method means to stop unwinding after this frame. | |
1917 | ||
1918 | @section Unwinding Registers | |
1919 | ||
1920 | Each unwinder includes a @code{prev_register} method. This method | |
1921 | takes a frame, an associated cache pointer, and a register number. | |
1922 | It returns a @code{struct value *} describing the requested register, | |
1923 | as saved by this frame. This is the value of the register that is | |
1924 | current in this frame's caller. | |
1925 | ||
1926 | The returned value must have the same type as the register. It may | |
1927 | have any lvalue type. In most circumstances one of these routines | |
1928 | will generate the appropriate value: | |
1929 | ||
1930 | @table @code | |
1931 | @item frame_unwind_got_optimized | |
1932 | @findex frame_unwind_got_optimized | |
1933 | This register was not saved. | |
1934 | ||
1935 | @item frame_unwind_got_register | |
1936 | @findex frame_unwind_got_register | |
1937 | This register was copied into another register in this frame. This | |
1938 | is also used for unchanged registers; they are ``copied'' into the | |
1939 | same register. | |
1940 | ||
1941 | @item frame_unwind_got_memory | |
1942 | @findex frame_unwind_got_memory | |
1943 | This register was saved in memory. | |
1944 | ||
1945 | @item frame_unwind_got_constant | |
1946 | @findex frame_unwind_got_constant | |
1947 | This register was not saved, but the unwinder can compute the previous | |
1948 | value some other way. | |
1949 | ||
1950 | @item frame_unwind_got_address | |
1951 | @findex frame_unwind_got_address | |
1952 | Same as @code{frame_unwind_got_constant}, except that the value is a target | |
1953 | address. This is frequently used for the stack pointer, which is not | |
1954 | explicitly saved but has a known offset from this frame's stack | |
1955 | pointer. For architectures with a flat unified address space, this is | |
1956 | generally the same as @code{frame_unwind_got_constant}. | |
1957 | @end table | |
1958 | ||
c906108c SS |
1959 | @node Symbol Handling |
1960 | ||
1961 | @chapter Symbol Handling | |
1962 | ||
1f70da6a SS |
1963 | Symbols are a key part of @value{GDBN}'s operation. Symbols include |
1964 | variables, functions, and types. | |
1965 | ||
1966 | Symbol information for a large program can be truly massive, and | |
1967 | reading of symbol information is one of the major performance | |
1968 | bottlenecks in @value{GDBN}; it can take many minutes to process it | |
1969 | all. Studies have shown that nearly all the time spent is | |
1970 | computational, rather than file reading. | |
1971 | ||
1972 | One of the ways for @value{GDBN} to provide a good user experience is | |
1973 | to start up quickly, taking no more than a few seconds. It is simply | |
1974 | not possible to process all of a program's debugging info in that | |
1975 | time, and so we attempt to handle symbols incrementally. For instance, | |
1976 | we create @dfn{partial symbol tables} consisting of only selected | |
1977 | symbols, and only expand them to full symbol tables when necessary. | |
c906108c SS |
1978 | |
1979 | @section Symbol Reading | |
1980 | ||
56caf160 EZ |
1981 | @cindex symbol reading |
1982 | @cindex reading of symbols | |
1983 | @cindex symbol files | |
1984 | @value{GDBN} reads symbols from @dfn{symbol files}. The usual symbol | |
1985 | file is the file containing the program which @value{GDBN} is | |
1986 | debugging. @value{GDBN} can be directed to use a different file for | |
1987 | symbols (with the @samp{symbol-file} command), and it can also read | |
1f70da6a SS |
1988 | more symbols via the @samp{add-file} and @samp{load} commands. In |
1989 | addition, it may bring in more symbols while loading shared | |
1990 | libraries. | |
56caf160 EZ |
1991 | |
1992 | @findex find_sym_fns | |
1993 | Symbol files are initially opened by code in @file{symfile.c} using | |
1994 | the BFD library (@pxref{Support Libraries}). BFD identifies the type | |
1995 | of the file by examining its header. @code{find_sym_fns} then uses | |
1996 | this identification to locate a set of symbol-reading functions. | |
1997 | ||
1998 | @findex add_symtab_fns | |
1999 | @cindex @code{sym_fns} structure | |
2000 | @cindex adding a symbol-reading module | |
2001 | Symbol-reading modules identify themselves to @value{GDBN} by calling | |
c906108c SS |
2002 | @code{add_symtab_fns} during their module initialization. The argument |
2003 | to @code{add_symtab_fns} is a @code{struct sym_fns} which contains the | |
2004 | name (or name prefix) of the symbol format, the length of the prefix, | |
2005 | and pointers to four functions. These functions are called at various | |
56caf160 | 2006 | times to process symbol files whose identification matches the specified |
c906108c SS |
2007 | prefix. |
2008 | ||
2009 | The functions supplied by each module are: | |
2010 | ||
2011 | @table @code | |
2012 | @item @var{xyz}_symfile_init(struct sym_fns *sf) | |
2013 | ||
56caf160 | 2014 | @cindex secondary symbol file |
c906108c SS |
2015 | Called from @code{symbol_file_add} when we are about to read a new |
2016 | symbol file. This function should clean up any internal state (possibly | |
2017 | resulting from half-read previous files, for example) and prepare to | |
56caf160 EZ |
2018 | read a new symbol file. Note that the symbol file which we are reading |
2019 | might be a new ``main'' symbol file, or might be a secondary symbol file | |
c906108c SS |
2020 | whose symbols are being added to the existing symbol table. |
2021 | ||
2022 | The argument to @code{@var{xyz}_symfile_init} is a newly allocated | |
2023 | @code{struct sym_fns} whose @code{bfd} field contains the BFD for the | |
2024 | new symbol file being read. Its @code{private} field has been zeroed, | |
2025 | and can be modified as desired. Typically, a struct of private | |
2026 | information will be @code{malloc}'d, and a pointer to it will be placed | |
2027 | in the @code{private} field. | |
2028 | ||
2029 | There is no result from @code{@var{xyz}_symfile_init}, but it can call | |
2030 | @code{error} if it detects an unavoidable problem. | |
2031 | ||
2032 | @item @var{xyz}_new_init() | |
2033 | ||
2034 | Called from @code{symbol_file_add} when discarding existing symbols. | |
56caf160 EZ |
2035 | This function needs only handle the symbol-reading module's internal |
2036 | state; the symbol table data structures visible to the rest of | |
2037 | @value{GDBN} will be discarded by @code{symbol_file_add}. It has no | |
2038 | arguments and no result. It may be called after | |
2039 | @code{@var{xyz}_symfile_init}, if a new symbol table is being read, or | |
2040 | may be called alone if all symbols are simply being discarded. | |
c906108c SS |
2041 | |
2042 | @item @var{xyz}_symfile_read(struct sym_fns *sf, CORE_ADDR addr, int mainline) | |
2043 | ||
2044 | Called from @code{symbol_file_add} to actually read the symbols from a | |
2045 | symbol-file into a set of psymtabs or symtabs. | |
2046 | ||
56caf160 | 2047 | @code{sf} points to the @code{struct sym_fns} originally passed to |
c906108c SS |
2048 | @code{@var{xyz}_sym_init} for possible initialization. @code{addr} is |
2049 | the offset between the file's specified start address and its true | |
2050 | address in memory. @code{mainline} is 1 if this is the main symbol | |
c1468174 | 2051 | table being read, and 0 if a secondary symbol file (e.g., shared library |
c906108c SS |
2052 | or dynamically loaded file) is being read.@refill |
2053 | @end table | |
2054 | ||
2055 | In addition, if a symbol-reading module creates psymtabs when | |
2056 | @var{xyz}_symfile_read is called, these psymtabs will contain a pointer | |
2057 | to a function @code{@var{xyz}_psymtab_to_symtab}, which can be called | |
25822942 | 2058 | from any point in the @value{GDBN} symbol-handling code. |
c906108c SS |
2059 | |
2060 | @table @code | |
2061 | @item @var{xyz}_psymtab_to_symtab (struct partial_symtab *pst) | |
2062 | ||
56caf160 | 2063 | Called from @code{psymtab_to_symtab} (or the @code{PSYMTAB_TO_SYMTAB} macro) if |
c906108c SS |
2064 | the psymtab has not already been read in and had its @code{pst->symtab} |
2065 | pointer set. The argument is the psymtab to be fleshed-out into a | |
56caf160 EZ |
2066 | symtab. Upon return, @code{pst->readin} should have been set to 1, and |
2067 | @code{pst->symtab} should contain a pointer to the new corresponding symtab, or | |
c906108c SS |
2068 | zero if there were no symbols in that part of the symbol file. |
2069 | @end table | |
2070 | ||
2071 | @section Partial Symbol Tables | |
2072 | ||
56caf160 | 2073 | @value{GDBN} has three types of symbol tables: |
c906108c SS |
2074 | |
2075 | @itemize @bullet | |
56caf160 EZ |
2076 | @cindex full symbol table |
2077 | @cindex symtabs | |
2078 | @item | |
2079 | Full symbol tables (@dfn{symtabs}). These contain the main | |
2080 | information about symbols and addresses. | |
c906108c | 2081 | |
56caf160 EZ |
2082 | @cindex psymtabs |
2083 | @item | |
2084 | Partial symbol tables (@dfn{psymtabs}). These contain enough | |
c906108c SS |
2085 | information to know when to read the corresponding part of the full |
2086 | symbol table. | |
2087 | ||
56caf160 EZ |
2088 | @cindex minimal symbol table |
2089 | @cindex minsymtabs | |
2090 | @item | |
2091 | Minimal symbol tables (@dfn{msymtabs}). These contain information | |
c906108c | 2092 | gleaned from non-debugging symbols. |
c906108c SS |
2093 | @end itemize |
2094 | ||
56caf160 | 2095 | @cindex partial symbol table |
c906108c SS |
2096 | This section describes partial symbol tables. |
2097 | ||
2098 | A psymtab is constructed by doing a very quick pass over an executable | |
2099 | file's debugging information. Small amounts of information are | |
56caf160 | 2100 | extracted---enough to identify which parts of the symbol table will |
c906108c | 2101 | need to be re-read and fully digested later, when the user needs the |
25822942 | 2102 | information. The speed of this pass causes @value{GDBN} to start up very |
c906108c SS |
2103 | quickly. Later, as the detailed rereading occurs, it occurs in small |
2104 | pieces, at various times, and the delay therefrom is mostly invisible to | |
2105 | the user. | |
2106 | @c (@xref{Symbol Reading}.) | |
2107 | ||
2108 | The symbols that show up in a file's psymtab should be, roughly, those | |
2109 | visible to the debugger's user when the program is not running code from | |
2110 | that file. These include external symbols and types, static symbols and | |
56caf160 | 2111 | types, and @code{enum} values declared at file scope. |
c906108c SS |
2112 | |
2113 | The psymtab also contains the range of instruction addresses that the | |
2114 | full symbol table would represent. | |
2115 | ||
56caf160 EZ |
2116 | @cindex finding a symbol |
2117 | @cindex symbol lookup | |
c906108c SS |
2118 | The idea is that there are only two ways for the user (or much of the |
2119 | code in the debugger) to reference a symbol: | |
2120 | ||
2121 | @itemize @bullet | |
56caf160 EZ |
2122 | @findex find_pc_function |
2123 | @findex find_pc_line | |
2124 | @item | |
c1468174 | 2125 | By its address (e.g., execution stops at some address which is inside a |
56caf160 EZ |
2126 | function in this file). The address will be noticed to be in the |
2127 | range of this psymtab, and the full symtab will be read in. | |
2128 | @code{find_pc_function}, @code{find_pc_line}, and other | |
2129 | @code{find_pc_@dots{}} functions handle this. | |
c906108c | 2130 | |
56caf160 EZ |
2131 | @cindex lookup_symbol |
2132 | @item | |
2133 | By its name | |
c1468174 | 2134 | (e.g., the user asks to print a variable, or set a breakpoint on a |
c906108c SS |
2135 | function). Global names and file-scope names will be found in the |
2136 | psymtab, which will cause the symtab to be pulled in. Local names will | |
2137 | have to be qualified by a global name, or a file-scope name, in which | |
2138 | case we will have already read in the symtab as we evaluated the | |
56caf160 | 2139 | qualifier. Or, a local symbol can be referenced when we are ``in'' a |
c906108c SS |
2140 | local scope, in which case the first case applies. @code{lookup_symbol} |
2141 | does most of the work here. | |
c906108c SS |
2142 | @end itemize |
2143 | ||
2144 | The only reason that psymtabs exist is to cause a symtab to be read in | |
2145 | at the right moment. Any symbol that can be elided from a psymtab, | |
2146 | while still causing that to happen, should not appear in it. Since | |
2147 | psymtabs don't have the idea of scope, you can't put local symbols in | |
2148 | them anyway. Psymtabs don't have the idea of the type of a symbol, | |
2149 | either, so types need not appear, unless they will be referenced by | |
2150 | name. | |
2151 | ||
56caf160 EZ |
2152 | It is a bug for @value{GDBN} to behave one way when only a psymtab has |
2153 | been read, and another way if the corresponding symtab has been read | |
2154 | in. Such bugs are typically caused by a psymtab that does not contain | |
2155 | all the visible symbols, or which has the wrong instruction address | |
2156 | ranges. | |
c906108c | 2157 | |
56caf160 | 2158 | The psymtab for a particular section of a symbol file (objfile) could be |
c906108c SS |
2159 | thrown away after the symtab has been read in. The symtab should always |
2160 | be searched before the psymtab, so the psymtab will never be used (in a | |
2161 | bug-free environment). Currently, psymtabs are allocated on an obstack, | |
2162 | and all the psymbols themselves are allocated in a pair of large arrays | |
2163 | on an obstack, so there is little to be gained by trying to free them | |
2164 | unless you want to do a lot more work. | |
2165 | ||
2166 | @section Types | |
2167 | ||
56caf160 | 2168 | @unnumberedsubsec Fundamental Types (e.g., @code{FT_VOID}, @code{FT_BOOLEAN}). |
c906108c | 2169 | |
56caf160 | 2170 | @cindex fundamental types |
25822942 | 2171 | These are the fundamental types that @value{GDBN} uses internally. Fundamental |
c906108c SS |
2172 | types from the various debugging formats (stabs, ELF, etc) are mapped |
2173 | into one of these. They are basically a union of all fundamental types | |
56caf160 EZ |
2174 | that @value{GDBN} knows about for all the languages that @value{GDBN} |
2175 | knows about. | |
c906108c | 2176 | |
56caf160 | 2177 | @unnumberedsubsec Type Codes (e.g., @code{TYPE_CODE_PTR}, @code{TYPE_CODE_ARRAY}). |
c906108c | 2178 | |
56caf160 EZ |
2179 | @cindex type codes |
2180 | Each time @value{GDBN} builds an internal type, it marks it with one | |
2181 | of these types. The type may be a fundamental type, such as | |
2182 | @code{TYPE_CODE_INT}, or a derived type, such as @code{TYPE_CODE_PTR} | |
2183 | which is a pointer to another type. Typically, several @code{FT_*} | |
2184 | types map to one @code{TYPE_CODE_*} type, and are distinguished by | |
2185 | other members of the type struct, such as whether the type is signed | |
2186 | or unsigned, and how many bits it uses. | |
c906108c | 2187 | |
56caf160 | 2188 | @unnumberedsubsec Builtin Types (e.g., @code{builtin_type_void}, @code{builtin_type_char}). |
c906108c SS |
2189 | |
2190 | These are instances of type structs that roughly correspond to | |
56caf160 EZ |
2191 | fundamental types and are created as global types for @value{GDBN} to |
2192 | use for various ugly historical reasons. We eventually want to | |
2193 | eliminate these. Note for example that @code{builtin_type_int} | |
2194 | initialized in @file{gdbtypes.c} is basically the same as a | |
2195 | @code{TYPE_CODE_INT} type that is initialized in @file{c-lang.c} for | |
2196 | an @code{FT_INTEGER} fundamental type. The difference is that the | |
2197 | @code{builtin_type} is not associated with any particular objfile, and | |
2198 | only one instance exists, while @file{c-lang.c} builds as many | |
2199 | @code{TYPE_CODE_INT} types as needed, with each one associated with | |
2200 | some particular objfile. | |
c906108c SS |
2201 | |
2202 | @section Object File Formats | |
56caf160 | 2203 | @cindex object file formats |
c906108c SS |
2204 | |
2205 | @subsection a.out | |
2206 | ||
56caf160 EZ |
2207 | @cindex @code{a.out} format |
2208 | The @code{a.out} format is the original file format for Unix. It | |
2209 | consists of three sections: @code{text}, @code{data}, and @code{bss}, | |
2210 | which are for program code, initialized data, and uninitialized data, | |
2211 | respectively. | |
c906108c | 2212 | |
56caf160 | 2213 | The @code{a.out} format is so simple that it doesn't have any reserved |
c906108c | 2214 | place for debugging information. (Hey, the original Unix hackers used |
56caf160 EZ |
2215 | @samp{adb}, which is a machine-language debugger!) The only debugging |
2216 | format for @code{a.out} is stabs, which is encoded as a set of normal | |
c906108c SS |
2217 | symbols with distinctive attributes. |
2218 | ||
56caf160 | 2219 | The basic @code{a.out} reader is in @file{dbxread.c}. |
c906108c SS |
2220 | |
2221 | @subsection COFF | |
2222 | ||
56caf160 | 2223 | @cindex COFF format |
c906108c SS |
2224 | The COFF format was introduced with System V Release 3 (SVR3) Unix. |
2225 | COFF files may have multiple sections, each prefixed by a header. The | |
2226 | number of sections is limited. | |
2227 | ||
2228 | The COFF specification includes support for debugging. Although this | |
1f70da6a SS |
2229 | was a step forward, the debugging information was woefully limited. |
2230 | For instance, it was not possible to represent code that came from an | |
2231 | included file. GNU's COFF-using configs often use stabs-type info, | |
2232 | encapsulated in special sections. | |
c906108c SS |
2233 | |
2234 | The COFF reader is in @file{coffread.c}. | |
2235 | ||
2236 | @subsection ECOFF | |
2237 | ||
56caf160 | 2238 | @cindex ECOFF format |
c906108c SS |
2239 | ECOFF is an extended COFF originally introduced for Mips and Alpha |
2240 | workstations. | |
2241 | ||
2242 | The basic ECOFF reader is in @file{mipsread.c}. | |
2243 | ||
2244 | @subsection XCOFF | |
2245 | ||
56caf160 | 2246 | @cindex XCOFF format |
c906108c SS |
2247 | The IBM RS/6000 running AIX uses an object file format called XCOFF. |
2248 | The COFF sections, symbols, and line numbers are used, but debugging | |
56caf160 EZ |
2249 | symbols are @code{dbx}-style stabs whose strings are located in the |
2250 | @code{.debug} section (rather than the string table). For more | |
2251 | information, see @ref{Top,,,stabs,The Stabs Debugging Format}. | |
c906108c SS |
2252 | |
2253 | The shared library scheme has a clean interface for figuring out what | |
2254 | shared libraries are in use, but the catch is that everything which | |
2255 | refers to addresses (symbol tables and breakpoints at least) needs to be | |
2256 | relocated for both shared libraries and the main executable. At least | |
2257 | using the standard mechanism this can only be done once the program has | |
2258 | been run (or the core file has been read). | |
2259 | ||
2260 | @subsection PE | |
2261 | ||
56caf160 EZ |
2262 | @cindex PE-COFF format |
2263 | Windows 95 and NT use the PE (@dfn{Portable Executable}) format for their | |
c906108c SS |
2264 | executables. PE is basically COFF with additional headers. |
2265 | ||
25822942 | 2266 | While BFD includes special PE support, @value{GDBN} needs only the basic |
c906108c SS |
2267 | COFF reader. |
2268 | ||
2269 | @subsection ELF | |
2270 | ||
56caf160 | 2271 | @cindex ELF format |
1f70da6a SS |
2272 | The ELF format came with System V Release 4 (SVR4) Unix. ELF is |
2273 | similar to COFF in being organized into a number of sections, but it | |
2274 | removes many of COFF's limitations. Debugging info may be either stabs | |
2275 | encapsulated in ELF sections, or more commonly these days, DWARF. | |
c906108c SS |
2276 | |
2277 | The basic ELF reader is in @file{elfread.c}. | |
2278 | ||
2279 | @subsection SOM | |
2280 | ||
56caf160 | 2281 | @cindex SOM format |
c906108c SS |
2282 | SOM is HP's object file and debug format (not to be confused with IBM's |
2283 | SOM, which is a cross-language ABI). | |
2284 | ||
1a92f856 | 2285 | The SOM reader is in @file{somread.c}. |
c906108c | 2286 | |
c906108c SS |
2287 | @section Debugging File Formats |
2288 | ||
2289 | This section describes characteristics of debugging information that | |
2290 | are independent of the object file format. | |
2291 | ||
2292 | @subsection stabs | |
2293 | ||
56caf160 | 2294 | @cindex stabs debugging info |
c906108c SS |
2295 | @code{stabs} started out as special symbols within the @code{a.out} |
2296 | format. Since then, it has been encapsulated into other file | |
2297 | formats, such as COFF and ELF. | |
2298 | ||
2299 | While @file{dbxread.c} does some of the basic stab processing, | |
2300 | including for encapsulated versions, @file{stabsread.c} does | |
2301 | the real work. | |
2302 | ||
2303 | @subsection COFF | |
2304 | ||
56caf160 | 2305 | @cindex COFF debugging info |
c906108c SS |
2306 | The basic COFF definition includes debugging information. The level |
2307 | of support is minimal and non-extensible, and is not often used. | |
2308 | ||
2309 | @subsection Mips debug (Third Eye) | |
2310 | ||
56caf160 | 2311 | @cindex ECOFF debugging info |
c906108c SS |
2312 | ECOFF includes a definition of a special debug format. |
2313 | ||
2314 | The file @file{mdebugread.c} implements reading for this format. | |
2315 | ||
1f70da6a SS |
2316 | @c mention DWARF 1 as a formerly-supported format |
2317 | ||
c906108c SS |
2318 | @subsection DWARF 2 |
2319 | ||
56caf160 | 2320 | @cindex DWARF 2 debugging info |
c906108c SS |
2321 | DWARF 2 is an improved but incompatible version of DWARF 1. |
2322 | ||
2323 | The DWARF 2 reader is in @file{dwarf2read.c}. | |
2324 | ||
31fffb02 CS |
2325 | @subsection Compressed DWARF 2 |
2326 | ||
2327 | @cindex Compressed DWARF 2 debugging info | |
2328 | Compressed DWARF 2 is not technically a separate debugging format, but | |
2329 | merely DWARF 2 debug information that has been compressed. In this | |
2330 | format, every object-file section holding DWARF 2 debugging | |
2331 | information is compressed and prepended with a header. (The section | |
2332 | is also typically renamed, so a section called @code{.debug_info} in a | |
2333 | DWARF 2 binary would be called @code{.zdebug_info} in a compressed | |
2334 | DWARF 2 binary.) The header is 12 bytes long: | |
2335 | ||
2336 | @itemize @bullet | |
2337 | @item | |
2338 | 4 bytes: the literal string ``ZLIB'' | |
2339 | @item | |
2340 | 8 bytes: the uncompressed size of the section, in big-endian byte | |
2341 | order. | |
2342 | @end itemize | |
2343 | ||
2344 | The same reader is used for both compressed an normal DWARF 2 info. | |
2345 | Section decompression is done in @code{zlib_decompress_section} in | |
2346 | @file{dwarf2read.c}. | |
2347 | ||
1f70da6a SS |
2348 | @subsection DWARF 3 |
2349 | ||
2350 | @cindex DWARF 3 debugging info | |
2351 | DWARF 3 is an improved version of DWARF 2. | |
2352 | ||
c906108c SS |
2353 | @subsection SOM |
2354 | ||
56caf160 | 2355 | @cindex SOM debugging info |
c906108c SS |
2356 | Like COFF, the SOM definition includes debugging information. |
2357 | ||
25822942 | 2358 | @section Adding a New Symbol Reader to @value{GDBN} |
c906108c | 2359 | |
56caf160 EZ |
2360 | @cindex adding debugging info reader |
2361 | If you are using an existing object file format (@code{a.out}, COFF, ELF, etc), | |
c906108c SS |
2362 | there is probably little to be done. |
2363 | ||
2364 | If you need to add a new object file format, you must first add it to | |
2365 | BFD. This is beyond the scope of this document. | |
2366 | ||
2367 | You must then arrange for the BFD code to provide access to the | |
1f70da6a SS |
2368 | debugging symbols. Generally @value{GDBN} will have to call swapping |
2369 | routines from BFD and a few other BFD internal routines to locate the | |
2370 | debugging information. As much as possible, @value{GDBN} should not | |
2371 | depend on the BFD internal data structures. | |
c906108c SS |
2372 | |
2373 | For some targets (e.g., COFF), there is a special transfer vector used | |
2374 | to call swapping routines, since the external data structures on various | |
2375 | platforms have different sizes and layouts. Specialized routines that | |
2376 | will only ever be implemented by one object file format may be called | |
2377 | directly. This interface should be described in a file | |
56caf160 | 2378 | @file{bfd/lib@var{xyz}.h}, which is included by @value{GDBN}. |
c906108c | 2379 | |
c91d38aa DJ |
2380 | @section Memory Management for Symbol Files |
2381 | ||
2382 | Most memory associated with a loaded symbol file is stored on | |
2383 | its @code{objfile_obstack}. This includes symbols, types, | |
2384 | namespace data, and other information produced by the symbol readers. | |
2385 | ||
2386 | Because this data lives on the objfile's obstack, it is automatically | |
2387 | released when the objfile is unloaded or reloaded. Therefore one | |
2388 | objfile must not reference symbol or type data from another objfile; | |
2389 | they could be unloaded at different times. | |
2390 | ||
2391 | User convenience variables, et cetera, have associated types. Normally | |
2392 | these types live in the associated objfile. However, when the objfile | |
2393 | is unloaded, those types are deep copied to global memory, so that | |
2394 | the values of the user variables and history items are not lost. | |
2395 | ||
c906108c SS |
2396 | |
2397 | @node Language Support | |
2398 | ||
2399 | @chapter Language Support | |
2400 | ||
56caf160 EZ |
2401 | @cindex language support |
2402 | @value{GDBN}'s language support is mainly driven by the symbol reader, | |
2403 | although it is possible for the user to set the source language | |
2404 | manually. | |
c906108c | 2405 | |
56caf160 EZ |
2406 | @value{GDBN} chooses the source language by looking at the extension |
2407 | of the file recorded in the debug info; @file{.c} means C, @file{.f} | |
2408 | means Fortran, etc. It may also use a special-purpose language | |
2409 | identifier if the debug format supports it, like with DWARF. | |
c906108c | 2410 | |
25822942 | 2411 | @section Adding a Source Language to @value{GDBN} |
c906108c | 2412 | |
56caf160 EZ |
2413 | @cindex adding source language |
2414 | To add other languages to @value{GDBN}'s expression parser, follow the | |
2415 | following steps: | |
c906108c SS |
2416 | |
2417 | @table @emph | |
2418 | @item Create the expression parser. | |
2419 | ||
56caf160 | 2420 | @cindex expression parser |
c906108c | 2421 | This should reside in a file @file{@var{lang}-exp.y}. Routines for |
56caf160 | 2422 | building parsed expressions into a @code{union exp_element} list are in |
c906108c SS |
2423 | @file{parse.c}. |
2424 | ||
56caf160 | 2425 | @cindex language parser |
c906108c SS |
2426 | Since we can't depend upon everyone having Bison, and YACC produces |
2427 | parsers that define a bunch of global names, the following lines | |
56caf160 | 2428 | @strong{must} be included at the top of the YACC parser, to prevent the |
c906108c SS |
2429 | various parsers from defining the same global names: |
2430 | ||
474c8240 | 2431 | @smallexample |
56caf160 EZ |
2432 | #define yyparse @var{lang}_parse |
2433 | #define yylex @var{lang}_lex | |
2434 | #define yyerror @var{lang}_error | |
2435 | #define yylval @var{lang}_lval | |
2436 | #define yychar @var{lang}_char | |
2437 | #define yydebug @var{lang}_debug | |
2438 | #define yypact @var{lang}_pact | |
2439 | #define yyr1 @var{lang}_r1 | |
2440 | #define yyr2 @var{lang}_r2 | |
2441 | #define yydef @var{lang}_def | |
2442 | #define yychk @var{lang}_chk | |
2443 | #define yypgo @var{lang}_pgo | |
2444 | #define yyact @var{lang}_act | |
2445 | #define yyexca @var{lang}_exca | |
2446 | #define yyerrflag @var{lang}_errflag | |
2447 | #define yynerrs @var{lang}_nerrs | |
474c8240 | 2448 | @end smallexample |
c906108c SS |
2449 | |
2450 | At the bottom of your parser, define a @code{struct language_defn} and | |
2451 | initialize it with the right values for your language. Define an | |
2452 | @code{initialize_@var{lang}} routine and have it call | |
25822942 | 2453 | @samp{add_language(@var{lang}_language_defn)} to tell the rest of @value{GDBN} |
c906108c SS |
2454 | that your language exists. You'll need some other supporting variables |
2455 | and functions, which will be used via pointers from your | |
2456 | @code{@var{lang}_language_defn}. See the declaration of @code{struct | |
2457 | language_defn} in @file{language.h}, and the other @file{*-exp.y} files, | |
2458 | for more information. | |
2459 | ||
2460 | @item Add any evaluation routines, if necessary | |
2461 | ||
56caf160 EZ |
2462 | @cindex expression evaluation routines |
2463 | @findex evaluate_subexp | |
2464 | @findex prefixify_subexp | |
2465 | @findex length_of_subexp | |
c906108c SS |
2466 | If you need new opcodes (that represent the operations of the language), |
2467 | add them to the enumerated type in @file{expression.h}. Add support | |
56caf160 EZ |
2468 | code for these operations in the @code{evaluate_subexp} function |
2469 | defined in the file @file{eval.c}. Add cases | |
c906108c | 2470 | for new opcodes in two functions from @file{parse.c}: |
56caf160 | 2471 | @code{prefixify_subexp} and @code{length_of_subexp}. These compute |
c906108c SS |
2472 | the number of @code{exp_element}s that a given operation takes up. |
2473 | ||
2474 | @item Update some existing code | |
2475 | ||
2476 | Add an enumerated identifier for your language to the enumerated type | |
2477 | @code{enum language} in @file{defs.h}. | |
2478 | ||
2479 | Update the routines in @file{language.c} so your language is included. | |
2480 | These routines include type predicates and such, which (in some cases) | |
2481 | are language dependent. If your language does not appear in the switch | |
2482 | statement, an error is reported. | |
2483 | ||
56caf160 | 2484 | @vindex current_language |
c906108c SS |
2485 | Also included in @file{language.c} is the code that updates the variable |
2486 | @code{current_language}, and the routines that translate the | |
2487 | @code{language_@var{lang}} enumerated identifier into a printable | |
2488 | string. | |
2489 | ||
56caf160 | 2490 | @findex _initialize_language |
c906108c SS |
2491 | Update the function @code{_initialize_language} to include your |
2492 | language. This function picks the default language upon startup, so is | |
25822942 | 2493 | dependent upon which languages that @value{GDBN} is built for. |
c906108c | 2494 | |
56caf160 | 2495 | @findex allocate_symtab |
c906108c SS |
2496 | Update @code{allocate_symtab} in @file{symfile.c} and/or symbol-reading |
2497 | code so that the language of each symtab (source file) is set properly. | |
2498 | This is used to determine the language to use at each stack frame level. | |
2499 | Currently, the language is set based upon the extension of the source | |
2500 | file. If the language can be better inferred from the symbol | |
2501 | information, please set the language of the symtab in the symbol-reading | |
2502 | code. | |
2503 | ||
56caf160 EZ |
2504 | @findex print_subexp |
2505 | @findex op_print_tab | |
2506 | Add helper code to @code{print_subexp} (in @file{expprint.c}) to handle any new | |
c906108c SS |
2507 | expression opcodes you have added to @file{expression.h}. Also, add the |
2508 | printed representations of your operators to @code{op_print_tab}. | |
2509 | ||
2510 | @item Add a place of call | |
2511 | ||
56caf160 | 2512 | @findex parse_exp_1 |
c906108c | 2513 | Add a call to @code{@var{lang}_parse()} and @code{@var{lang}_error} in |
56caf160 | 2514 | @code{parse_exp_1} (defined in @file{parse.c}). |
c906108c | 2515 | |
c906108c SS |
2516 | @item Edit @file{Makefile.in} |
2517 | ||
2518 | Add dependencies in @file{Makefile.in}. Make sure you update the macro | |
2519 | variables such as @code{HFILES} and @code{OBJS}, otherwise your code may | |
2520 | not get linked in, or, worse yet, it may not get @code{tar}red into the | |
2521 | distribution! | |
c906108c SS |
2522 | @end table |
2523 | ||
2524 | ||
2525 | @node Host Definition | |
2526 | ||
2527 | @chapter Host Definition | |
2528 | ||
56caf160 | 2529 | With the advent of Autoconf, it's rarely necessary to have host |
7fd60527 AC |
2530 | definition machinery anymore. The following information is provided, |
2531 | mainly, as an historical reference. | |
c906108c SS |
2532 | |
2533 | @section Adding a New Host | |
2534 | ||
56caf160 EZ |
2535 | @cindex adding a new host |
2536 | @cindex host, adding | |
7fd60527 AC |
2537 | @value{GDBN}'s host configuration support normally happens via Autoconf. |
2538 | New host-specific definitions should not be needed. Older hosts | |
2539 | @value{GDBN} still use the host-specific definitions and files listed | |
2540 | below, but these mostly exist for historical reasons, and will | |
56caf160 | 2541 | eventually disappear. |
c906108c | 2542 | |
c906108c | 2543 | @table @file |
c906108c | 2544 | @item gdb/config/@var{arch}/@var{xyz}.mh |
1f70da6a SS |
2545 | This file is a Makefile fragment that once contained both host and |
2546 | native configuration information (@pxref{Native Debugging}) for the | |
2547 | machine @var{xyz}. The host configuration information is now handled | |
2548 | by Autoconf. | |
7fd60527 | 2549 | |
1f70da6a | 2550 | Host configuration information included definitions for @code{CC}, |
7708fa01 AC |
2551 | @code{SYSV_DEFINE}, @code{XM_CFLAGS}, @code{XM_ADD_FILES}, |
2552 | @code{XM_CLIBS}, @code{XM_CDEPS}, etc.; see @file{Makefile.in}. | |
c906108c | 2553 | |
1f70da6a | 2554 | New host-only configurations do not need this file. |
c906108c | 2555 | |
c906108c SS |
2556 | @end table |
2557 | ||
1f70da6a SS |
2558 | (Files named @file{gdb/config/@var{arch}/xm-@var{xyz}.h} were once |
2559 | used to define host-specific macros, but were no longer needed and | |
2560 | have all been removed.) | |
2561 | ||
c906108c SS |
2562 | @subheading Generic Host Support Files |
2563 | ||
56caf160 | 2564 | @cindex generic host support |
c906108c | 2565 | There are some ``generic'' versions of routines that can be used by |
1f70da6a | 2566 | various systems. |
c906108c SS |
2567 | |
2568 | @table @file | |
56caf160 EZ |
2569 | @cindex remote debugging support |
2570 | @cindex serial line support | |
c906108c | 2571 | @item ser-unix.c |
1f70da6a SS |
2572 | This contains serial line support for Unix systems. It is included by |
2573 | default on all Unix-like hosts. | |
2574 | ||
2575 | @item ser-pipe.c | |
2576 | This contains serial pipe support for Unix systems. It is included by | |
2577 | default on all Unix-like hosts. | |
2578 | ||
2579 | @item ser-mingw.c | |
2580 | This contains serial line support for 32-bit programs running under | |
2581 | Windows using MinGW. | |
c906108c SS |
2582 | |
2583 | @item ser-go32.c | |
2584 | This contains serial line support for 32-bit programs running under DOS, | |
56caf160 | 2585 | using the DJGPP (a.k.a.@: GO32) execution environment. |
c906108c | 2586 | |
56caf160 | 2587 | @cindex TCP remote support |
c906108c | 2588 | @item ser-tcp.c |
1f70da6a SS |
2589 | This contains generic TCP support using sockets. It is included by |
2590 | default on all Unix-like hosts and with MinGW. | |
c906108c SS |
2591 | @end table |
2592 | ||
2593 | @section Host Conditionals | |
2594 | ||
56caf160 EZ |
2595 | When @value{GDBN} is configured and compiled, various macros are |
2596 | defined or left undefined, to control compilation based on the | |
1f70da6a SS |
2597 | attributes of the host system. While formerly they could be set in |
2598 | host-specific header files, at present they can be changed only by | |
2599 | setting @code{CFLAGS} when building, or by editing the source code. | |
2600 | ||
2601 | These macros and their meanings (or if the meaning is not documented | |
2602 | here, then one of the source files where they are used is indicated) | |
2603 | are: | |
c906108c | 2604 | |
56caf160 | 2605 | @ftable @code |
25822942 | 2606 | @item @value{GDBN}INIT_FILENAME |
56caf160 EZ |
2607 | The default name of @value{GDBN}'s initialization file (normally |
2608 | @file{.gdbinit}). | |
c906108c | 2609 | |
c906108c SS |
2610 | @item SIGWINCH_HANDLER |
2611 | If your host defines @code{SIGWINCH}, you can define this to be the name | |
2612 | of a function to be called if @code{SIGWINCH} is received. | |
2613 | ||
2614 | @item SIGWINCH_HANDLER_BODY | |
2615 | Define this to expand into code that will define the function named by | |
2616 | the expansion of @code{SIGWINCH_HANDLER}. | |
2617 | ||
c906108c | 2618 | @item CRLF_SOURCE_FILES |
56caf160 | 2619 | @cindex DOS text files |
c906108c SS |
2620 | Define this if host files use @code{\r\n} rather than @code{\n} as a |
2621 | line terminator. This will cause source file listings to omit @code{\r} | |
56caf160 EZ |
2622 | characters when printing and it will allow @code{\r\n} line endings of files |
2623 | which are ``sourced'' by gdb. It must be possible to open files in binary | |
c906108c SS |
2624 | mode using @code{O_BINARY} or, for fopen, @code{"rb"}. |
2625 | ||
2626 | @item DEFAULT_PROMPT | |
56caf160 | 2627 | @cindex prompt |
c906108c SS |
2628 | The default value of the prompt string (normally @code{"(gdb) "}). |
2629 | ||
2630 | @item DEV_TTY | |
56caf160 | 2631 | @cindex terminal device |
c906108c SS |
2632 | The name of the generic TTY device, defaults to @code{"/dev/tty"}. |
2633 | ||
c906108c SS |
2634 | @item ISATTY |
2635 | Substitute for isatty, if not available. | |
2636 | ||
1f70da6a SS |
2637 | @item FOPEN_RB |
2638 | Define this if binary files are opened the same way as text files. | |
c906108c SS |
2639 | |
2640 | @item CC_HAS_LONG_LONG | |
56caf160 EZ |
2641 | @cindex @code{long long} data type |
2642 | Define this if the host C compiler supports @code{long long}. This is set | |
2643 | by the @code{configure} script. | |
c906108c SS |
2644 | |
2645 | @item PRINTF_HAS_LONG_LONG | |
2646 | Define this if the host can handle printing of long long integers via | |
56caf160 EZ |
2647 | the printf format conversion specifier @code{ll}. This is set by the |
2648 | @code{configure} script. | |
c906108c | 2649 | |
c906108c SS |
2650 | @item LSEEK_NOT_LINEAR |
2651 | Define this if @code{lseek (n)} does not necessarily move to byte number | |
2652 | @code{n} in the file. This is only used when reading source files. It | |
2653 | is normally faster to define @code{CRLF_SOURCE_FILES} when possible. | |
2654 | ||
c906108c SS |
2655 | @item NORETURN |
2656 | If defined, this should be one or more tokens, such as @code{volatile}, | |
2657 | that can be used in both the declaration and definition of functions to | |
2658 | indicate that they never return. The default is already set correctly | |
2659 | if compiling with GCC. This will almost never need to be defined. | |
2660 | ||
2661 | @item ATTR_NORETURN | |
2662 | If defined, this should be one or more tokens, such as | |
2663 | @code{__attribute__ ((noreturn))}, that can be used in the declarations | |
2664 | of functions to indicate that they never return. The default is already | |
2665 | set correctly if compiling with GCC. This will almost never need to be | |
2666 | defined. | |
2667 | ||
c906108c | 2668 | @item lint |
56caf160 | 2669 | Define this to help placate @code{lint} in some situations. |
c906108c SS |
2670 | |
2671 | @item volatile | |
2672 | Define this to override the defaults of @code{__volatile__} or | |
2673 | @code{/**/}. | |
56caf160 | 2674 | @end ftable |
c906108c SS |
2675 | |
2676 | ||
2677 | @node Target Architecture Definition | |
2678 | ||
2679 | @chapter Target Architecture Definition | |
2680 | ||
56caf160 EZ |
2681 | @cindex target architecture definition |
2682 | @value{GDBN}'s target architecture defines what sort of | |
2683 | machine-language programs @value{GDBN} can work with, and how it works | |
2684 | with them. | |
c906108c | 2685 | |
af6c57ea AC |
2686 | The target architecture object is implemented as the C structure |
2687 | @code{struct gdbarch *}. The structure, and its methods, are generated | |
93c2c750 | 2688 | using the Bourne shell script @file{gdbarch.sh}. |
c906108c | 2689 | |
b6fd0dfb NR |
2690 | @menu |
2691 | * OS ABI Variant Handling:: | |
2692 | * Initialize New Architecture:: | |
2693 | * Registers and Memory:: | |
2694 | * Pointers and Addresses:: | |
2695 | * Address Classes:: | |
2696 | * Raw and Virtual Registers:: | |
2697 | * Register and Memory Data:: | |
2698 | * Frame Interpretation:: | |
2699 | * Inferior Call Setup:: | |
2700 | * Compiler Characteristics:: | |
2701 | * Target Conditionals:: | |
2702 | * Adding a New Target:: | |
b6fd0dfb NR |
2703 | @end menu |
2704 | ||
2705 | @node OS ABI Variant Handling | |
70f80edf JT |
2706 | @section Operating System ABI Variant Handling |
2707 | @cindex OS ABI variants | |
2708 | ||
2709 | @value{GDBN} provides a mechanism for handling variations in OS | |
2710 | ABIs. An OS ABI variant may have influence over any number of | |
2711 | variables in the target architecture definition. There are two major | |
2712 | components in the OS ABI mechanism: sniffers and handlers. | |
2713 | ||
2714 | A @dfn{sniffer} examines a file matching a BFD architecture/flavour pair | |
2715 | (the architecture may be wildcarded) in an attempt to determine the | |
2716 | OS ABI of that file. Sniffers with a wildcarded architecture are considered | |
2717 | to be @dfn{generic}, while sniffers for a specific architecture are | |
2718 | considered to be @dfn{specific}. A match from a specific sniffer | |
2719 | overrides a match from a generic sniffer. Multiple sniffers for an | |
2720 | architecture/flavour may exist, in order to differentiate between two | |
2721 | different operating systems which use the same basic file format. The | |
2722 | OS ABI framework provides a generic sniffer for ELF-format files which | |
2723 | examines the @code{EI_OSABI} field of the ELF header, as well as note | |
2724 | sections known to be used by several operating systems. | |
2725 | ||
2726 | @cindex fine-tuning @code{gdbarch} structure | |
2727 | A @dfn{handler} is used to fine-tune the @code{gdbarch} structure for the | |
2728 | selected OS ABI. There may be only one handler for a given OS ABI | |
2729 | for each BFD architecture. | |
2730 | ||
f4b3909f | 2731 | The following OS ABI variants are defined in @file{defs.h}: |
70f80edf JT |
2732 | |
2733 | @table @code | |
2734 | ||
f4b3909f EZ |
2735 | @findex GDB_OSABI_UNINITIALIZED |
2736 | @item GDB_OSABI_UNINITIALIZED | |
2737 | Used for struct gdbarch_info if ABI is still uninitialized. | |
2738 | ||
70f80edf JT |
2739 | @findex GDB_OSABI_UNKNOWN |
2740 | @item GDB_OSABI_UNKNOWN | |
2741 | The ABI of the inferior is unknown. The default @code{gdbarch} | |
2742 | settings for the architecture will be used. | |
2743 | ||
2744 | @findex GDB_OSABI_SVR4 | |
2745 | @item GDB_OSABI_SVR4 | |
f4b3909f | 2746 | UNIX System V Release 4. |
70f80edf JT |
2747 | |
2748 | @findex GDB_OSABI_HURD | |
2749 | @item GDB_OSABI_HURD | |
f4b3909f | 2750 | GNU using the Hurd kernel. |
70f80edf JT |
2751 | |
2752 | @findex GDB_OSABI_SOLARIS | |
2753 | @item GDB_OSABI_SOLARIS | |
f4b3909f | 2754 | Sun Solaris. |
70f80edf JT |
2755 | |
2756 | @findex GDB_OSABI_OSF1 | |
2757 | @item GDB_OSABI_OSF1 | |
f4b3909f | 2758 | OSF/1, including Digital UNIX and Compaq Tru64 UNIX. |
70f80edf JT |
2759 | |
2760 | @findex GDB_OSABI_LINUX | |
2761 | @item GDB_OSABI_LINUX | |
f4b3909f | 2762 | GNU using the Linux kernel. |
70f80edf JT |
2763 | |
2764 | @findex GDB_OSABI_FREEBSD_AOUT | |
2765 | @item GDB_OSABI_FREEBSD_AOUT | |
f4b3909f | 2766 | FreeBSD using the @code{a.out} executable format. |
70f80edf JT |
2767 | |
2768 | @findex GDB_OSABI_FREEBSD_ELF | |
2769 | @item GDB_OSABI_FREEBSD_ELF | |
f4b3909f | 2770 | FreeBSD using the ELF executable format. |
70f80edf JT |
2771 | |
2772 | @findex GDB_OSABI_NETBSD_AOUT | |
2773 | @item GDB_OSABI_NETBSD_AOUT | |
f4b3909f | 2774 | NetBSD using the @code{a.out} executable format. |
70f80edf JT |
2775 | |
2776 | @findex GDB_OSABI_NETBSD_ELF | |
2777 | @item GDB_OSABI_NETBSD_ELF | |
f4b3909f EZ |
2778 | NetBSD using the ELF executable format. |
2779 | ||
2780 | @findex GDB_OSABI_OPENBSD_ELF | |
2781 | @item GDB_OSABI_OPENBSD_ELF | |
2782 | OpenBSD using the ELF executable format. | |
70f80edf JT |
2783 | |
2784 | @findex GDB_OSABI_WINCE | |
2785 | @item GDB_OSABI_WINCE | |
f4b3909f | 2786 | Windows CE. |
70f80edf | 2787 | |
1029b7fa MK |
2788 | @findex GDB_OSABI_GO32 |
2789 | @item GDB_OSABI_GO32 | |
f4b3909f | 2790 | DJGPP. |
1029b7fa | 2791 | |
f4b3909f EZ |
2792 | @findex GDB_OSABI_IRIX |
2793 | @item GDB_OSABI_IRIX | |
2794 | Irix. | |
2795 | ||
f4b3909f EZ |
2796 | @findex GDB_OSABI_INTERIX |
2797 | @item GDB_OSABI_INTERIX | |
2798 | Interix (Posix layer for MS-Windows systems). | |
1029b7fa | 2799 | |
f4b3909f EZ |
2800 | @findex GDB_OSABI_HPUX_ELF |
2801 | @item GDB_OSABI_HPUX_ELF | |
2802 | HP/UX using the ELF executable format. | |
70f80edf | 2803 | |
f4b3909f EZ |
2804 | @findex GDB_OSABI_HPUX_SOM |
2805 | @item GDB_OSABI_HPUX_SOM | |
2806 | HP/UX using the SOM executable format. | |
70f80edf | 2807 | |
f4b3909f EZ |
2808 | @findex GDB_OSABI_QNXNTO |
2809 | @item GDB_OSABI_QNXNTO | |
2810 | QNX Neutrino. | |
2811 | ||
2812 | @findex GDB_OSABI_CYGWIN | |
2813 | @item GDB_OSABI_CYGWIN | |
2814 | Cygwin. | |
2815 | ||
2816 | @findex GDB_OSABI_AIX | |
2817 | @item GDB_OSABI_AIX | |
2818 | AIX. | |
70f80edf JT |
2819 | |
2820 | @end table | |
2821 | ||
2822 | Here are the functions that make up the OS ABI framework: | |
2823 | ||
2824 | @deftypefun const char *gdbarch_osabi_name (enum gdb_osabi @var{osabi}) | |
2825 | Return the name of the OS ABI corresponding to @var{osabi}. | |
2826 | @end deftypefun | |
2827 | ||
c133ab7a | 2828 | @deftypefun void gdbarch_register_osabi (enum bfd_architecture @var{arch}, unsigned long @var{machine}, enum gdb_osabi @var{osabi}, void (*@var{init_osabi})(struct gdbarch_info @var{info}, struct gdbarch *@var{gdbarch})) |
70f80edf | 2829 | Register the OS ABI handler specified by @var{init_osabi} for the |
c133ab7a MK |
2830 | architecture, machine type and OS ABI specified by @var{arch}, |
2831 | @var{machine} and @var{osabi}. In most cases, a value of zero for the | |
2832 | machine type, which implies the architecture's default machine type, | |
2833 | will suffice. | |
70f80edf JT |
2834 | @end deftypefun |
2835 | ||
2836 | @deftypefun void gdbarch_register_osabi_sniffer (enum bfd_architecture @var{arch}, enum bfd_flavour @var{flavour}, enum gdb_osabi (*@var{sniffer})(bfd *@var{abfd})) | |
2837 | Register the OS ABI file sniffer specified by @var{sniffer} for the | |
2838 | BFD architecture/flavour pair specified by @var{arch} and @var{flavour}. | |
2839 | If @var{arch} is @code{bfd_arch_unknown}, the sniffer is considered to | |
2840 | be generic, and is allowed to examine @var{flavour}-flavoured files for | |
2841 | any architecture. | |
2842 | @end deftypefun | |
2843 | ||
2844 | @deftypefun enum gdb_osabi gdbarch_lookup_osabi (bfd *@var{abfd}) | |
2845 | Examine the file described by @var{abfd} to determine its OS ABI. | |
2846 | The value @code{GDB_OSABI_UNKNOWN} is returned if the OS ABI cannot | |
2847 | be determined. | |
2848 | @end deftypefun | |
2849 | ||
2850 | @deftypefun void gdbarch_init_osabi (struct gdbarch info @var{info}, struct gdbarch *@var{gdbarch}, enum gdb_osabi @var{osabi}) | |
2851 | Invoke the OS ABI handler corresponding to @var{osabi} to fine-tune the | |
2852 | @code{gdbarch} structure specified by @var{gdbarch}. If a handler | |
2853 | corresponding to @var{osabi} has not been registered for @var{gdbarch}'s | |
2854 | architecture, a warning will be issued and the debugging session will continue | |
2855 | with the defaults already established for @var{gdbarch}. | |
2856 | @end deftypefun | |
2857 | ||
f4b3909f EZ |
2858 | @deftypefun void generic_elf_osabi_sniff_abi_tag_sections (bfd *@var{abfd}, asection *@var{sect}, void *@var{obj}) |
2859 | Helper routine for ELF file sniffers. Examine the file described by | |
2860 | @var{abfd} and look at ABI tag note sections to determine the OS ABI | |
2861 | from the note. This function should be called via | |
2862 | @code{bfd_map_over_sections}. | |
2863 | @end deftypefun | |
2864 | ||
b6fd0dfb | 2865 | @node Initialize New Architecture |
7a107747 DJ |
2866 | @section Initializing a New Architecture |
2867 | ||
2868 | Each @code{gdbarch} is associated with a single @sc{bfd} architecture, | |
2869 | via a @code{bfd_arch_@var{arch}} constant. The @code{gdbarch} is | |
2870 | registered by a call to @code{register_gdbarch_init}, usually from | |
2871 | the file's @code{_initialize_@var{filename}} routine, which will | |
2872 | be automatically called during @value{GDBN} startup. The arguments | |
2873 | are a @sc{bfd} architecture constant and an initialization function. | |
2874 | ||
2875 | The initialization function has this type: | |
2876 | ||
2877 | @smallexample | |
2878 | static struct gdbarch * | |
2879 | @var{arch}_gdbarch_init (struct gdbarch_info @var{info}, | |
2880 | struct gdbarch_list *@var{arches}) | |
2881 | @end smallexample | |
2882 | ||
2883 | The @var{info} argument contains parameters used to select the correct | |
2884 | architecture, and @var{arches} is a list of architectures which | |
2885 | have already been created with the same @code{bfd_arch_@var{arch}} | |
2886 | value. | |
2887 | ||
2888 | The initialization function should first make sure that @var{info} | |
2889 | is acceptable, and return @code{NULL} if it is not. Then, it should | |
2890 | search through @var{arches} for an exact match to @var{info}, and | |
2891 | return one if found. Lastly, if no exact match was found, it should | |
2892 | create a new architecture based on @var{info} and return it. | |
2893 | ||
2894 | Only information in @var{info} should be used to choose the new | |
2895 | architecture. Historically, @var{info} could be sparse, and | |
2896 | defaults would be collected from the first element on @var{arches}. | |
2897 | However, @value{GDBN} now fills in @var{info} more thoroughly, | |
2898 | so new @code{gdbarch} initialization functions should not take | |
2899 | defaults from @var{arches}. | |
2900 | ||
b6fd0dfb | 2901 | @node Registers and Memory |
c906108c SS |
2902 | @section Registers and Memory |
2903 | ||
56caf160 EZ |
2904 | @value{GDBN}'s model of the target machine is rather simple. |
2905 | @value{GDBN} assumes the machine includes a bank of registers and a | |
2906 | block of memory. Each register may have a different size. | |
c906108c | 2907 | |
56caf160 EZ |
2908 | @value{GDBN} does not have a magical way to match up with the |
2909 | compiler's idea of which registers are which; however, it is critical | |
2910 | that they do match up accurately. The only way to make this work is | |
2911 | to get accurate information about the order that the compiler uses, | |
4a9bb1df | 2912 | and to reflect that in the @code{gdbarch_register_name} and related functions. |
c906108c | 2913 | |
25822942 | 2914 | @value{GDBN} can handle big-endian, little-endian, and bi-endian architectures. |
c906108c | 2915 | |
b6fd0dfb | 2916 | @node Pointers and Addresses |
93e79dbd JB |
2917 | @section Pointers Are Not Always Addresses |
2918 | @cindex pointer representation | |
2919 | @cindex address representation | |
2920 | @cindex word-addressed machines | |
2921 | @cindex separate data and code address spaces | |
2922 | @cindex spaces, separate data and code address | |
2923 | @cindex address spaces, separate data and code | |
2924 | @cindex code pointers, word-addressed | |
2925 | @cindex converting between pointers and addresses | |
2926 | @cindex D10V addresses | |
2927 | ||
2928 | On almost all 32-bit architectures, the representation of a pointer is | |
2929 | indistinguishable from the representation of some fixed-length number | |
2930 | whose value is the byte address of the object pointed to. On such | |
56caf160 | 2931 | machines, the words ``pointer'' and ``address'' can be used interchangeably. |
93e79dbd JB |
2932 | However, architectures with smaller word sizes are often cramped for |
2933 | address space, so they may choose a pointer representation that breaks this | |
2934 | identity, and allows a larger code address space. | |
2935 | ||
1f70da6a SS |
2936 | @c D10V is gone from sources - more current example? |
2937 | ||
172c2a43 | 2938 | For example, the Renesas D10V is a 16-bit VLIW processor whose |
93e79dbd JB |
2939 | instructions are 32 bits long@footnote{Some D10V instructions are |
2940 | actually pairs of 16-bit sub-instructions. However, since you can't | |
2941 | jump into the middle of such a pair, code addresses can only refer to | |
2942 | full 32 bit instructions, which is what matters in this explanation.}. | |
2943 | If the D10V used ordinary byte addresses to refer to code locations, | |
2944 | then the processor would only be able to address 64kb of instructions. | |
2945 | However, since instructions must be aligned on four-byte boundaries, the | |
56caf160 EZ |
2946 | low two bits of any valid instruction's byte address are always |
2947 | zero---byte addresses waste two bits. So instead of byte addresses, | |
2948 | the D10V uses word addresses---byte addresses shifted right two bits---to | |
93e79dbd JB |
2949 | refer to code. Thus, the D10V can use 16-bit words to address 256kb of |
2950 | code space. | |
2951 | ||
2952 | However, this means that code pointers and data pointers have different | |
2953 | forms on the D10V. The 16-bit word @code{0xC020} refers to byte address | |
2954 | @code{0xC020} when used as a data address, but refers to byte address | |
2955 | @code{0x30080} when used as a code address. | |
2956 | ||
2957 | (The D10V also uses separate code and data address spaces, which also | |
2958 | affects the correspondence between pointers and addresses, but we're | |
2959 | going to ignore that here; this example is already too long.) | |
2960 | ||
56caf160 EZ |
2961 | To cope with architectures like this---the D10V is not the only |
2962 | one!---@value{GDBN} tries to distinguish between @dfn{addresses}, which are | |
93e79dbd JB |
2963 | byte numbers, and @dfn{pointers}, which are the target's representation |
2964 | of an address of a particular type of data. In the example above, | |
2965 | @code{0xC020} is the pointer, which refers to one of the addresses | |
2966 | @code{0xC020} or @code{0x30080}, depending on the type imposed upon it. | |
2967 | @value{GDBN} provides functions for turning a pointer into an address | |
2968 | and vice versa, in the appropriate way for the current architecture. | |
2969 | ||
2970 | Unfortunately, since addresses and pointers are identical on almost all | |
2971 | processors, this distinction tends to bit-rot pretty quickly. Thus, | |
2972 | each time you port @value{GDBN} to an architecture which does | |
2973 | distinguish between pointers and addresses, you'll probably need to | |
2974 | clean up some architecture-independent code. | |
2975 | ||
2976 | Here are functions which convert between pointers and addresses: | |
2977 | ||
2978 | @deftypefun CORE_ADDR extract_typed_address (void *@var{buf}, struct type *@var{type}) | |
2979 | Treat the bytes at @var{buf} as a pointer or reference of type | |
2980 | @var{type}, and return the address it represents, in a manner | |
2981 | appropriate for the current architecture. This yields an address | |
2982 | @value{GDBN} can use to read target memory, disassemble, etc. Note that | |
2983 | @var{buf} refers to a buffer in @value{GDBN}'s memory, not the | |
2984 | inferior's. | |
2985 | ||
2986 | For example, if the current architecture is the Intel x86, this function | |
2987 | extracts a little-endian integer of the appropriate length from | |
2988 | @var{buf} and returns it. However, if the current architecture is the | |
2989 | D10V, this function will return a 16-bit integer extracted from | |
2990 | @var{buf}, multiplied by four if @var{type} is a pointer to a function. | |
2991 | ||
2992 | If @var{type} is not a pointer or reference type, then this function | |
2993 | will signal an internal error. | |
2994 | @end deftypefun | |
2995 | ||
2996 | @deftypefun CORE_ADDR store_typed_address (void *@var{buf}, struct type *@var{type}, CORE_ADDR @var{addr}) | |
2997 | Store the address @var{addr} in @var{buf}, in the proper format for a | |
2998 | pointer of type @var{type} in the current architecture. Note that | |
2999 | @var{buf} refers to a buffer in @value{GDBN}'s memory, not the | |
3000 | inferior's. | |
3001 | ||
3002 | For example, if the current architecture is the Intel x86, this function | |
3003 | stores @var{addr} unmodified as a little-endian integer of the | |
3004 | appropriate length in @var{buf}. However, if the current architecture | |
3005 | is the D10V, this function divides @var{addr} by four if @var{type} is | |
3006 | a pointer to a function, and then stores it in @var{buf}. | |
3007 | ||
3008 | If @var{type} is not a pointer or reference type, then this function | |
3009 | will signal an internal error. | |
3010 | @end deftypefun | |
3011 | ||
f23631e4 | 3012 | @deftypefun CORE_ADDR value_as_address (struct value *@var{val}) |
93e79dbd JB |
3013 | Assuming that @var{val} is a pointer, return the address it represents, |
3014 | as appropriate for the current architecture. | |
3015 | ||
3016 | This function actually works on integral values, as well as pointers. | |
3017 | For pointers, it performs architecture-specific conversions as | |
3018 | described above for @code{extract_typed_address}. | |
3019 | @end deftypefun | |
3020 | ||
3021 | @deftypefun CORE_ADDR value_from_pointer (struct type *@var{type}, CORE_ADDR @var{addr}) | |
3022 | Create and return a value representing a pointer of type @var{type} to | |
3023 | the address @var{addr}, as appropriate for the current architecture. | |
3024 | This function performs architecture-specific conversions as described | |
3025 | above for @code{store_typed_address}. | |
3026 | @end deftypefun | |
3027 | ||
4a9bb1df | 3028 | Here are two functions which architectures can define to indicate the |
93e79dbd JB |
3029 | relationship between pointers and addresses. These have default |
3030 | definitions, appropriate for architectures on which all pointers are | |
fc0c74b1 | 3031 | simple unsigned byte addresses. |
93e79dbd | 3032 | |
4a9bb1df | 3033 | @deftypefun CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *@var{current_gdbarch}, struct type *@var{type}, char *@var{buf}) |
93e79dbd JB |
3034 | Assume that @var{buf} holds a pointer of type @var{type}, in the |
3035 | appropriate format for the current architecture. Return the byte | |
3036 | address the pointer refers to. | |
3037 | ||
3038 | This function may safely assume that @var{type} is either a pointer or a | |
56caf160 | 3039 | C@t{++} reference type. |
4a9bb1df | 3040 | @end deftypefun |
93e79dbd | 3041 | |
4a9bb1df | 3042 | @deftypefun void gdbarch_address_to_pointer (struct gdbarch *@var{current_gdbarch}, struct type *@var{type}, char *@var{buf}, CORE_ADDR @var{addr}) |
93e79dbd JB |
3043 | Store in @var{buf} a pointer of type @var{type} representing the address |
3044 | @var{addr}, in the appropriate format for the current architecture. | |
3045 | ||
3046 | This function may safely assume that @var{type} is either a pointer or a | |
56caf160 | 3047 | C@t{++} reference type. |
4a9bb1df | 3048 | @end deftypefun |
93e79dbd | 3049 | |
b6fd0dfb | 3050 | @node Address Classes |
b5b0480a KB |
3051 | @section Address Classes |
3052 | @cindex address classes | |
3053 | @cindex DW_AT_byte_size | |
3054 | @cindex DW_AT_address_class | |
3055 | ||
3056 | Sometimes information about different kinds of addresses is available | |
3057 | via the debug information. For example, some programming environments | |
3058 | define addresses of several different sizes. If the debug information | |
3059 | distinguishes these kinds of address classes through either the size | |
3060 | info (e.g, @code{DW_AT_byte_size} in @w{DWARF 2}) or through an explicit | |
3061 | address class attribute (e.g, @code{DW_AT_address_class} in @w{DWARF 2}), the | |
3062 | following macros should be defined in order to disambiguate these | |
3063 | types within @value{GDBN} as well as provide the added information to | |
3064 | a @value{GDBN} user when printing type expressions. | |
3065 | ||
4a9bb1df | 3066 | @deftypefun int gdbarch_address_class_type_flags (struct gdbarch *@var{current_gdbarch}, int @var{byte_size}, int @var{dwarf2_addr_class}) |
b5b0480a KB |
3067 | Returns the type flags needed to construct a pointer type whose size |
3068 | is @var{byte_size} and whose address class is @var{dwarf2_addr_class}. | |
3069 | This function is normally called from within a symbol reader. See | |
3070 | @file{dwarf2read.c}. | |
4a9bb1df | 3071 | @end deftypefun |
b5b0480a | 3072 | |
4a9bb1df | 3073 | @deftypefun char *gdbarch_address_class_type_flags_to_name (struct gdbarch *@var{current_gdbarch}, int @var{type_flags}) |
b5b0480a KB |
3074 | Given the type flags representing an address class qualifier, return |
3075 | its name. | |
4a9bb1df | 3076 | @end deftypefun |
1f70da6a | 3077 | @deftypefun int gdbarch_address_class_name_to_type_flags (struct gdbarch *@var{current_gdbarch}, int @var{name}, int *@var{type_flags_ptr}) |
d3e8051b | 3078 | Given an address qualifier name, set the @code{int} referenced by @var{type_flags_ptr} to the type flags |
b5b0480a | 3079 | for that address class qualifier. |
4a9bb1df | 3080 | @end deftypefun |
b5b0480a KB |
3081 | |
3082 | Since the need for address classes is rather rare, none of | |
4a9bb1df UW |
3083 | the address class functions are defined by default. Predicate |
3084 | functions are provided to detect when they are defined. | |
b5b0480a KB |
3085 | |
3086 | Consider a hypothetical architecture in which addresses are normally | |
3087 | 32-bits wide, but 16-bit addresses are also supported. Furthermore, | |
3088 | suppose that the @w{DWARF 2} information for this architecture simply | |
3089 | uses a @code{DW_AT_byte_size} value of 2 to indicate the use of one | |
3090 | of these "short" pointers. The following functions could be defined | |
4a9bb1df | 3091 | to implement the address class functions: |
b5b0480a KB |
3092 | |
3093 | @smallexample | |
3094 | somearch_address_class_type_flags (int byte_size, | |
3095 | int dwarf2_addr_class) | |
f2abfe65 | 3096 | @{ |
b5b0480a KB |
3097 | if (byte_size == 2) |
3098 | return TYPE_FLAG_ADDRESS_CLASS_1; | |
3099 | else | |
3100 | return 0; | |
f2abfe65 | 3101 | @} |
b5b0480a KB |
3102 | |
3103 | static char * | |
3104 | somearch_address_class_type_flags_to_name (int type_flags) | |
f2abfe65 | 3105 | @{ |
b5b0480a KB |
3106 | if (type_flags & TYPE_FLAG_ADDRESS_CLASS_1) |
3107 | return "short"; | |
3108 | else | |
3109 | return NULL; | |
f2abfe65 | 3110 | @} |
b5b0480a KB |
3111 | |
3112 | int | |
3113 | somearch_address_class_name_to_type_flags (char *name, | |
3114 | int *type_flags_ptr) | |
f2abfe65 | 3115 | @{ |
b5b0480a | 3116 | if (strcmp (name, "short") == 0) |
f2abfe65 | 3117 | @{ |
b5b0480a KB |
3118 | *type_flags_ptr = TYPE_FLAG_ADDRESS_CLASS_1; |
3119 | return 1; | |
f2abfe65 | 3120 | @} |
b5b0480a KB |
3121 | else |
3122 | return 0; | |
f2abfe65 | 3123 | @} |
b5b0480a KB |
3124 | @end smallexample |
3125 | ||
3126 | The qualifier @code{@@short} is used in @value{GDBN}'s type expressions | |
3127 | to indicate the presence of one of these "short" pointers. E.g, if | |
3128 | the debug information indicates that @code{short_ptr_var} is one of these | |
3129 | short pointers, @value{GDBN} might show the following behavior: | |
3130 | ||
3131 | @smallexample | |
3132 | (gdb) ptype short_ptr_var | |
3133 | type = int * @@short | |
3134 | @end smallexample | |
3135 | ||
93e79dbd | 3136 | |
b6fd0dfb | 3137 | @node Raw and Virtual Registers |
13d01224 AC |
3138 | @section Raw and Virtual Register Representations |
3139 | @cindex raw register representation | |
3140 | @cindex virtual register representation | |
3141 | @cindex representations, raw and virtual registers | |
3142 | ||
3143 | @emph{Maintainer note: This section is pretty much obsolete. The | |
3144 | functionality described here has largely been replaced by | |
d0384fc4 TJB |
3145 | pseudo-registers and the mechanisms described in @ref{Register and |
3146 | Memory Data, , Using Different Register and Memory Data | |
13d01224 AC |
3147 | Representations}. See also @uref{http://www.gnu.org/software/gdb/bugs/, |
3148 | Bug Tracking Database} and | |
3149 | @uref{http://sources.redhat.com/gdb/current/ari/, ARI Index} for more | |
3150 | up-to-date information.} | |
af6c57ea | 3151 | |
9fb4dd36 JB |
3152 | Some architectures use one representation for a value when it lives in a |
3153 | register, but use a different representation when it lives in memory. | |
25822942 | 3154 | In @value{GDBN}'s terminology, the @dfn{raw} representation is the one used in |
9fb4dd36 | 3155 | the target registers, and the @dfn{virtual} representation is the one |
25822942 | 3156 | used in memory, and within @value{GDBN} @code{struct value} objects. |
9fb4dd36 | 3157 | |
13d01224 AC |
3158 | @emph{Maintainer note: Notice that the same mechanism is being used to |
3159 | both convert a register to a @code{struct value} and alternative | |
3160 | register forms.} | |
3161 | ||
9fb4dd36 JB |
3162 | For almost all data types on almost all architectures, the virtual and |
3163 | raw representations are identical, and no special handling is needed. | |
3164 | However, they do occasionally differ. For example: | |
3165 | ||
3166 | @itemize @bullet | |
9fb4dd36 | 3167 | @item |
56caf160 | 3168 | The x86 architecture supports an 80-bit @code{long double} type. However, when |
9fb4dd36 JB |
3169 | we store those values in memory, they occupy twelve bytes: the |
3170 | floating-point number occupies the first ten, and the final two bytes | |
3171 | are unused. This keeps the values aligned on four-byte boundaries, | |
3172 | allowing more efficient access. Thus, the x86 80-bit floating-point | |
3173 | type is the raw representation, and the twelve-byte loosely-packed | |
3174 | arrangement is the virtual representation. | |
3175 | ||
3176 | @item | |
25822942 DB |
3177 | Some 64-bit MIPS targets present 32-bit registers to @value{GDBN} as 64-bit |
3178 | registers, with garbage in their upper bits. @value{GDBN} ignores the top 32 | |
9fb4dd36 JB |
3179 | bits. Thus, the 64-bit form, with garbage in the upper 32 bits, is the |
3180 | raw representation, and the trimmed 32-bit representation is the | |
3181 | virtual representation. | |
9fb4dd36 JB |
3182 | @end itemize |
3183 | ||
3184 | In general, the raw representation is determined by the architecture, or | |
25822942 DB |
3185 | @value{GDBN}'s interface to the architecture, while the virtual representation |
3186 | can be chosen for @value{GDBN}'s convenience. @value{GDBN}'s register file, | |
56caf160 EZ |
3187 | @code{registers}, holds the register contents in raw format, and the |
3188 | @value{GDBN} remote protocol transmits register values in raw format. | |
9fb4dd36 | 3189 | |
56caf160 EZ |
3190 | Your architecture may define the following macros to request |
3191 | conversions between the raw and virtual format: | |
9fb4dd36 JB |
3192 | |
3193 | @deftypefn {Target Macro} int REGISTER_CONVERTIBLE (int @var{reg}) | |
3194 | Return non-zero if register number @var{reg}'s value needs different raw | |
3195 | and virtual formats. | |
6f6ef15a EZ |
3196 | |
3197 | You should not use @code{REGISTER_CONVERT_TO_VIRTUAL} for a register | |
3198 | unless this macro returns a non-zero value for that register. | |
9fb4dd36 JB |
3199 | @end deftypefn |
3200 | ||
9fb4dd36 JB |
3201 | @deftypefn {Target Macro} void REGISTER_CONVERT_TO_VIRTUAL (int @var{reg}, struct type *@var{type}, char *@var{from}, char *@var{to}) |
3202 | Convert the value of register number @var{reg} to @var{type}, which | |
1f70da6a | 3203 | should always be @code{gdbarch_register_type (@var{reg})}. The buffer |
9fb4dd36 JB |
3204 | at @var{from} holds the register's value in raw format; the macro should |
3205 | convert the value to virtual format, and place it at @var{to}. | |
3206 | ||
6f6ef15a EZ |
3207 | Note that @code{REGISTER_CONVERT_TO_VIRTUAL} and |
3208 | @code{REGISTER_CONVERT_TO_RAW} take their @var{reg} and @var{type} | |
3209 | arguments in different orders. | |
3210 | ||
3211 | You should only use @code{REGISTER_CONVERT_TO_VIRTUAL} with registers | |
3212 | for which the @code{REGISTER_CONVERTIBLE} macro returns a non-zero | |
3213 | value. | |
9fb4dd36 JB |
3214 | @end deftypefn |
3215 | ||
3216 | @deftypefn {Target Macro} void REGISTER_CONVERT_TO_RAW (struct type *@var{type}, int @var{reg}, char *@var{from}, char *@var{to}) | |
3217 | Convert the value of register number @var{reg} to @var{type}, which | |
1f70da6a | 3218 | should always be @code{gdbarch_register_type (@var{reg})}. The buffer |
9fb4dd36 JB |
3219 | at @var{from} holds the register's value in raw format; the macro should |
3220 | convert the value to virtual format, and place it at @var{to}. | |
3221 | ||
3222 | Note that REGISTER_CONVERT_TO_VIRTUAL and REGISTER_CONVERT_TO_RAW take | |
3223 | their @var{reg} and @var{type} arguments in different orders. | |
3224 | @end deftypefn | |
3225 | ||
3226 | ||
b6fd0dfb | 3227 | @node Register and Memory Data |
13d01224 AC |
3228 | @section Using Different Register and Memory Data Representations |
3229 | @cindex register representation | |
3230 | @cindex memory representation | |
3231 | @cindex representations, register and memory | |
3232 | @cindex register data formats, converting | |
3233 | @cindex @code{struct value}, converting register contents to | |
3234 | ||
3235 | @emph{Maintainer's note: The way GDB manipulates registers is undergoing | |
d3e8051b | 3236 | significant change. Many of the macros and functions referred to in this |
13d01224 AC |
3237 | section are likely to be subject to further revision. See |
3238 | @uref{http://sources.redhat.com/gdb/current/ari/, A.R. Index} and | |
3239 | @uref{http://www.gnu.org/software/gdb/bugs, Bug Tracking Database} for | |
3240 | further information. cagney/2002-05-06.} | |
3241 | ||
3242 | Some architectures can represent a data object in a register using a | |
3243 | form that is different to the objects more normal memory representation. | |
3244 | For example: | |
3245 | ||
3246 | @itemize @bullet | |
3247 | ||
3248 | @item | |
3249 | The Alpha architecture can represent 32 bit integer values in | |
3250 | floating-point registers. | |
3251 | ||
3252 | @item | |
3253 | The x86 architecture supports 80-bit floating-point registers. The | |
3254 | @code{long double} data type occupies 96 bits in memory but only 80 bits | |
3255 | when stored in a register. | |
3256 | ||
3257 | @end itemize | |
3258 | ||
3259 | In general, the register representation of a data type is determined by | |
3260 | the architecture, or @value{GDBN}'s interface to the architecture, while | |
3261 | the memory representation is determined by the Application Binary | |
3262 | Interface. | |
3263 | ||
3264 | For almost all data types on almost all architectures, the two | |
3265 | representations are identical, and no special handling is needed. | |
3266 | However, they do occasionally differ. Your architecture may define the | |
3267 | following macros to request conversions between the register and memory | |
3268 | representations of a data type: | |
3269 | ||
4a9bb1df | 3270 | @deftypefun int gdbarch_convert_register_p (struct gdbarch *@var{gdbarch}, int @var{reg}) |
13d01224 AC |
3271 | Return non-zero if the representation of a data value stored in this |
3272 | register may be different to the representation of that same data value | |
3273 | when stored in memory. | |
3274 | ||
4a9bb1df UW |
3275 | When non-zero, the macros @code{gdbarch_register_to_value} and |
3276 | @code{value_to_register} are used to perform any necessary conversion. | |
83acabca DJ |
3277 | |
3278 | This function should return zero for the register's native type, when | |
3279 | no conversion is necessary. | |
4a9bb1df | 3280 | @end deftypefun |
13d01224 | 3281 | |
4a9bb1df | 3282 | @deftypefun void gdbarch_register_to_value (struct gdbarch *@var{gdbarch}, int @var{reg}, struct type *@var{type}, char *@var{from}, char *@var{to}) |
13d01224 AC |
3283 | Convert the value of register number @var{reg} to a data object of type |
3284 | @var{type}. The buffer at @var{from} holds the register's value in raw | |
3285 | format; the converted value should be placed in the buffer at @var{to}. | |
3286 | ||
4a9bb1df UW |
3287 | Note that @code{gdbarch_register_to_value} and @code{gdbarch_value_to_register} |
3288 | take their @var{reg} and @var{type} arguments in different orders. | |
13d01224 | 3289 | |
4a9bb1df UW |
3290 | You should only use @code{gdbarch_register_to_value} with registers for which |
3291 | the @code{gdbarch_convert_register_p} function returns a non-zero value. | |
3292 | @end deftypefun | |
13d01224 | 3293 | |
4a9bb1df | 3294 | @deftypefun void gdbarch_value_to_register (struct gdbarch *@var{gdbarch}, struct type *@var{type}, int @var{reg}, char *@var{from}, char *@var{to}) |
13d01224 AC |
3295 | Convert a data value of type @var{type} to register number @var{reg}' |
3296 | raw format. | |
3297 | ||
4a9bb1df UW |
3298 | Note that @code{gdbarch_register_to_value} and @code{gdbarch_value_to_register} |
3299 | take their @var{reg} and @var{type} arguments in different orders. | |
13d01224 | 3300 | |
4a9bb1df UW |
3301 | You should only use @code{gdbarch_value_to_register} with registers for which |
3302 | the @code{gdbarch_convert_register_p} function returns a non-zero value. | |
3303 | @end deftypefun | |
13d01224 | 3304 | |
b6fd0dfb | 3305 | @node Frame Interpretation |
c906108c SS |
3306 | @section Frame Interpretation |
3307 | ||
b6fd0dfb | 3308 | @node Inferior Call Setup |
c906108c SS |
3309 | @section Inferior Call Setup |
3310 | ||
b6fd0dfb | 3311 | @node Compiler Characteristics |
c906108c SS |
3312 | @section Compiler Characteristics |
3313 | ||
b6fd0dfb | 3314 | @node Target Conditionals |
c906108c SS |
3315 | @section Target Conditionals |
3316 | ||
4a9bb1df UW |
3317 | This section describes the macros and functions that you can use to define the |
3318 | target machine. | |
c906108c SS |
3319 | |
3320 | @table @code | |
3321 | ||
4a9bb1df UW |
3322 | @item CORE_ADDR gdbarch_addr_bits_remove (@var{gdbarch}, @var{addr}) |
3323 | @findex gdbarch_addr_bits_remove | |
adf40b2e | 3324 | If a raw machine instruction address includes any bits that are not |
4a9bb1df UW |
3325 | really part of the address, then this function is used to zero those bits in |
3326 | @var{addr}. This is only used for addresses of instructions, and even then not | |
3327 | in all contexts. | |
adf40b2e JM |
3328 | |
3329 | For example, the two low-order bits of the PC on the Hewlett-Packard PA | |
3330 | 2.0 architecture contain the privilege level of the corresponding | |
3331 | instruction. Since instructions must always be aligned on four-byte | |
3332 | boundaries, the processor masks out these bits to generate the actual | |
4a9bb1df UW |
3333 | address of the instruction. @code{gdbarch_addr_bits_remove} would then for |
3334 | example look like that: | |
3335 | @smallexample | |
3336 | arch_addr_bits_remove (CORE_ADDR addr) | |
3337 | @{ | |
3338 | return (addr &= ~0x3); | |
3339 | @} | |
3340 | @end smallexample | |
c906108c | 3341 | |
4a9bb1df UW |
3342 | @item int address_class_name_to_type_flags (@var{gdbarch}, @var{name}, @var{type_flags_ptr}) |
3343 | @findex address_class_name_to_type_flags | |
b5b0480a KB |
3344 | If @var{name} is a valid address class qualifier name, set the @code{int} |
3345 | referenced by @var{type_flags_ptr} to the mask representing the qualifier | |
3346 | and return 1. If @var{name} is not a valid address class qualifier name, | |
3347 | return 0. | |
3348 | ||
3349 | The value for @var{type_flags_ptr} should be one of | |
3350 | @code{TYPE_FLAG_ADDRESS_CLASS_1}, @code{TYPE_FLAG_ADDRESS_CLASS_2}, or | |
3351 | possibly some combination of these values or'd together. | |
3352 | @xref{Target Architecture Definition, , Address Classes}. | |
3353 | ||
4a9bb1df UW |
3354 | @item int address_class_name_to_type_flags_p (@var{gdbarch}) |
3355 | @findex address_class_name_to_type_flags_p | |
3356 | Predicate which indicates whether @code{address_class_name_to_type_flags} | |
b5b0480a KB |
3357 | has been defined. |
3358 | ||
4a9bb1df UW |
3359 | @item int gdbarch_address_class_type_flags (@var{gdbarch}, @var{byte_size}, @var{dwarf2_addr_class}) |
3360 | @findex gdbarch_address_class_type_flags | |
b5b0480a KB |
3361 | Given a pointers byte size (as described by the debug information) and |
3362 | the possible @code{DW_AT_address_class} value, return the type flags | |
3363 | used by @value{GDBN} to represent this address class. The value | |
3364 | returned should be one of @code{TYPE_FLAG_ADDRESS_CLASS_1}, | |
3365 | @code{TYPE_FLAG_ADDRESS_CLASS_2}, or possibly some combination of these | |
3366 | values or'd together. | |
3367 | @xref{Target Architecture Definition, , Address Classes}. | |
3368 | ||
4a9bb1df UW |
3369 | @item int gdbarch_address_class_type_flags_p (@var{gdbarch}) |
3370 | @findex gdbarch_address_class_type_flags_p | |
3371 | Predicate which indicates whether @code{gdbarch_address_class_type_flags_p} has | |
b5b0480a KB |
3372 | been defined. |
3373 | ||
4a9bb1df UW |
3374 | @item const char *gdbarch_address_class_type_flags_to_name (@var{gdbarch}, @var{type_flags}) |
3375 | @findex gdbarch_address_class_type_flags_to_name | |
b5b0480a KB |
3376 | Return the name of the address class qualifier associated with the type |
3377 | flags given by @var{type_flags}. | |
3378 | ||
4a9bb1df UW |
3379 | @item int gdbarch_address_class_type_flags_to_name_p (@var{gdbarch}) |
3380 | @findex gdbarch_address_class_type_flags_to_name_p | |
3381 | Predicate which indicates whether @code{gdbarch_address_class_type_flags_to_name} has been defined. | |
b5b0480a KB |
3382 | @xref{Target Architecture Definition, , Address Classes}. |
3383 | ||
4a9bb1df UW |
3384 | @item void gdbarch_address_to_pointer (@var{gdbarch}, @var{type}, @var{buf}, @var{addr}) |
3385 | @findex gdbarch_address_to_pointer | |
93e79dbd JB |
3386 | Store in @var{buf} a pointer of type @var{type} representing the address |
3387 | @var{addr}, in the appropriate format for the current architecture. | |
4a9bb1df | 3388 | This function may safely assume that @var{type} is either a pointer or a |
56caf160 | 3389 | C@t{++} reference type. |
93e79dbd JB |
3390 | @xref{Target Architecture Definition, , Pointers Are Not Always Addresses}. |
3391 | ||
4a9bb1df UW |
3392 | @item int gdbarch_believe_pcc_promotion (@var{gdbarch}) |
3393 | @findex gdbarch_believe_pcc_promotion | |
3394 | Used to notify if the compiler promotes a @code{short} or @code{char} | |
56caf160 EZ |
3395 | parameter to an @code{int}, but still reports the parameter as its |
3396 | original type, rather than the promoted type. | |
c906108c | 3397 | |
32c9a795 MD |
3398 | @item gdbarch_bits_big_endian (@var{gdbarch}) |
3399 | @findex gdbarch_bits_big_endian | |
3400 | This is used if the numbering of bits in the targets does @strong{not} match | |
3401 | the endianness of the target byte order. A value of 1 means that the bits | |
56caf160 | 3402 | are numbered in a big-endian bit order, 0 means little-endian. |
c906108c | 3403 | |
32c9a795 MD |
3404 | @item set_gdbarch_bits_big_endian (@var{gdbarch}, @var{bits_big_endian}) |
3405 | @findex set_gdbarch_bits_big_endian | |
3406 | Calling set_gdbarch_bits_big_endian with a value of 1 indicates that the | |
3407 | bits in the target are numbered in a big-endian bit order, 0 indicates | |
3408 | little-endian. | |
3409 | ||
c906108c | 3410 | @item BREAKPOINT |
56caf160 | 3411 | @findex BREAKPOINT |
c906108c SS |
3412 | This is the character array initializer for the bit pattern to put into |
3413 | memory where a breakpoint is set. Although it's common to use a trap | |
3414 | instruction for a breakpoint, it's not required; for instance, the bit | |
3415 | pattern could be an invalid instruction. The breakpoint must be no | |
3416 | longer than the shortest instruction of the architecture. | |
3417 | ||
56caf160 | 3418 | @code{BREAKPOINT} has been deprecated in favor of |
4a9bb1df | 3419 | @code{gdbarch_breakpoint_from_pc}. |
7a292a7a | 3420 | |
c906108c | 3421 | @item BIG_BREAKPOINT |
56caf160 EZ |
3422 | @itemx LITTLE_BREAKPOINT |
3423 | @findex LITTLE_BREAKPOINT | |
3424 | @findex BIG_BREAKPOINT | |
c906108c SS |
3425 | Similar to BREAKPOINT, but used for bi-endian targets. |
3426 | ||
56caf160 | 3427 | @code{BIG_BREAKPOINT} and @code{LITTLE_BREAKPOINT} have been deprecated in |
4a9bb1df | 3428 | favor of @code{gdbarch_breakpoint_from_pc}. |
7a292a7a | 3429 | |
4a9bb1df UW |
3430 | @item const gdb_byte *gdbarch_breakpoint_from_pc (@var{gdbarch}, @var{pcptr}, @var{lenptr}) |
3431 | @findex gdbarch_breakpoint_from_pc | |
3432 | @anchor{gdbarch_breakpoint_from_pc} Use the program counter to determine the | |
2dd0da42 AC |
3433 | contents and size of a breakpoint instruction. It returns a pointer to |
3434 | a string of bytes that encode a breakpoint instruction, stores the | |
3435 | length of the string to @code{*@var{lenptr}}, and adjusts the program | |
3436 | counter (if necessary) to point to the actual memory location where the | |
3437 | breakpoint should be inserted. | |
c906108c SS |
3438 | |
3439 | Although it is common to use a trap instruction for a breakpoint, it's | |
3440 | not required; for instance, the bit pattern could be an invalid | |
3441 | instruction. The breakpoint must be no longer than the shortest | |
3442 | instruction of the architecture. | |
3443 | ||
7a292a7a SS |
3444 | Replaces all the other @var{BREAKPOINT} macros. |
3445 | ||
4a9bb1df UW |
3446 | @item int gdbarch_memory_insert_breakpoint (@var{gdbarch}, @var{bp_tgt}) |
3447 | @itemx gdbarch_memory_remove_breakpoint (@var{gdbarch}, @var{bp_tgt}) | |
3448 | @findex gdbarch_memory_remove_breakpoint | |
3449 | @findex gdbarch_memory_insert_breakpoint | |
917317f4 JM |
3450 | Insert or remove memory based breakpoints. Reasonable defaults |
3451 | (@code{default_memory_insert_breakpoint} and | |
3452 | @code{default_memory_remove_breakpoint} respectively) have been | |
4a9bb1df UW |
3453 | provided so that it is not necessary to set these for most |
3454 | architectures. Architectures which may want to set | |
3455 | @code{gdbarch_memory_insert_breakpoint} and @code{gdbarch_memory_remove_breakpoint} will likely have instructions that are oddly sized or are not stored in a | |
917317f4 JM |
3456 | conventional manner. |
3457 | ||
3458 | It may also be desirable (from an efficiency standpoint) to define | |
3459 | custom breakpoint insertion and removal routines if | |
4a9bb1df | 3460 | @code{gdbarch_breakpoint_from_pc} needs to read the target's memory for some |
917317f4 JM |
3461 | reason. |
3462 | ||
4a9bb1df UW |
3463 | @item CORE_ADDR gdbarch_adjust_breakpoint_address (@var{gdbarch}, @var{bpaddr}) |
3464 | @findex gdbarch_adjust_breakpoint_address | |
1485d690 KB |
3465 | @cindex breakpoint address adjusted |
3466 | Given an address at which a breakpoint is desired, return a breakpoint | |
3467 | address adjusted to account for architectural constraints on | |
3468 | breakpoint placement. This method is not needed by most targets. | |
3469 | ||
3470 | The FR-V target (see @file{frv-tdep.c}) requires this method. | |
3471 | The FR-V is a VLIW architecture in which a number of RISC-like | |
3472 | instructions are grouped (packed) together into an aggregate | |
3473 | instruction or instruction bundle. When the processor executes | |
3474 | one of these bundles, the component instructions are executed | |
3475 | in parallel. | |
3476 | ||
3477 | In the course of optimization, the compiler may group instructions | |
3478 | from distinct source statements into the same bundle. The line number | |
3479 | information associated with one of the latter statements will likely | |
3480 | refer to some instruction other than the first one in the bundle. So, | |
3481 | if the user attempts to place a breakpoint on one of these latter | |
3482 | statements, @value{GDBN} must be careful to @emph{not} place the break | |
3483 | instruction on any instruction other than the first one in the bundle. | |
3484 | (Remember though that the instructions within a bundle execute | |
3485 | in parallel, so the @emph{first} instruction is the instruction | |
3486 | at the lowest address and has nothing to do with execution order.) | |
3487 | ||
4a9bb1df | 3488 | The FR-V's @code{gdbarch_adjust_breakpoint_address} method will adjust a |
1485d690 KB |
3489 | breakpoint's address by scanning backwards for the beginning of |
3490 | the bundle, returning the address of the bundle. | |
3491 | ||
3492 | Since the adjustment of a breakpoint may significantly alter a user's | |
3493 | expectation, @value{GDBN} prints a warning when an adjusted breakpoint | |
3494 | is initially set and each time that that breakpoint is hit. | |
3495 | ||
4a9bb1df UW |
3496 | @item int gdbarch_call_dummy_location (@var{gdbarch}) |
3497 | @findex gdbarch_call_dummy_location | |
56caf160 | 3498 | See the file @file{inferior.h}. |
7a292a7a | 3499 | |
4a9bb1df UW |
3500 | This method has been replaced by @code{gdbarch_push_dummy_code} |
3501 | (@pxref{gdbarch_push_dummy_code}). | |
7043d8dc | 3502 | |
4a9bb1df UW |
3503 | @item int gdbarch_cannot_fetch_register (@var{gdbarch}, @var{regum}) |
3504 | @findex gdbarch_cannot_fetch_register | |
3505 | This function should return nonzero if @var{regno} cannot be fetched | |
c906108c SS |
3506 | from an inferior process. This is only relevant if |
3507 | @code{FETCH_INFERIOR_REGISTERS} is not defined. | |
3508 | ||
4a9bb1df UW |
3509 | @item int gdbarch_cannot_store_register (@var{gdbarch}, @var{regnum}) |
3510 | @findex gdbarch_cannot_store_register | |
3511 | This function should return nonzero if @var{regno} should not be | |
c906108c | 3512 | written to the target. This is often the case for program counters, |
4a9bb1df UW |
3513 | status words, and other special registers. This function returns 0 as |
3514 | default so that @value{GDBN} will assume that all registers may be written. | |
c906108c | 3515 | |
4a9bb1df UW |
3516 | @item int gdbarch_convert_register_p (@var{gdbarch}, @var{regnum}, struct type *@var{type}) |
3517 | @findex gdbarch_convert_register_p | |
83acabca DJ |
3518 | Return non-zero if register @var{regnum} represents data values of type |
3519 | @var{type} in a non-standard form. | |
13d01224 AC |
3520 | @xref{Target Architecture Definition, , Using Different Register and Memory Data Representations}. |
3521 | ||
4a9bb1df UW |
3522 | @item CORE_ADDR gdbarch_decr_pc_after_break (@var{gdbarch}) |
3523 | @findex gdbarch_decr_pc_after_break | |
3524 | This function shall return the amount by which to decrement the PC after the | |
c906108c | 3525 | program encounters a breakpoint. This is often the number of bytes in |
56caf160 | 3526 | @code{BREAKPOINT}, though not always. For most targets this value will be 0. |
c906108c | 3527 | |
56caf160 EZ |
3528 | @item DISABLE_UNSETTABLE_BREAK (@var{addr}) |
3529 | @findex DISABLE_UNSETTABLE_BREAK | |
c906108c SS |
3530 | If defined, this should evaluate to 1 if @var{addr} is in a shared |
3531 | library in which breakpoints cannot be set and so should be disabled. | |
3532 | ||
5fc14d0a | 3533 | @item void gdbarch_print_float_info (@var{gdbarch}, @var{file}, @var{frame}, @var{args}) |
4a9bb1df | 3534 | @findex gdbarch_print_float_info |
5e74b15c RE |
3535 | If defined, then the @samp{info float} command will print information about |
3536 | the processor's floating point unit. | |
3537 | ||
4a9bb1df UW |
3538 | @item void gdbarch_print_registers_info (@var{gdbarch}, @var{frame}, @var{regnum}, @var{all}) |
3539 | @findex gdbarch_print_registers_info | |
0ab7a791 AC |
3540 | If defined, pretty print the value of the register @var{regnum} for the |
3541 | specified @var{frame}. If the value of @var{regnum} is -1, pretty print | |
3542 | either all registers (@var{all} is non zero) or a select subset of | |
3543 | registers (@var{all} is zero). | |
3544 | ||
3545 | The default method prints one register per line, and if @var{all} is | |
3546 | zero omits floating-point registers. | |
3547 | ||
4a9bb1df UW |
3548 | @item int gdbarch_print_vector_info (@var{gdbarch}, @var{file}, @var{frame}, @var{args}) |
3549 | @findex gdbarch_print_vector_info | |
e76f1f2e AC |
3550 | If defined, then the @samp{info vector} command will call this function |
3551 | to print information about the processor's vector unit. | |
3552 | ||
3553 | By default, the @samp{info vector} command will print all vector | |
3554 | registers (the register's type having the vector attribute). | |
3555 | ||
4a9bb1df UW |
3556 | @item int gdbarch_dwarf2_reg_to_regnum (@var{gdbarch}, @var{dwarf2_regnr}) |
3557 | @findex gdbarch_dwarf2_reg_to_regnum | |
3558 | Convert DWARF2 register number @var{dwarf2_regnr} into @value{GDBN} regnum. | |
3559 | If not defined, no conversion will be performed. | |
0dcedd82 | 3560 | |
4a9bb1df UW |
3561 | @item int gdbarch_ecoff_reg_to_regnum (@var{gdbarch}, @var{ecoff_regnr}) |
3562 | @findex gdbarch_ecoff_reg_to_regnum | |
3563 | Convert ECOFF register number @var{ecoff_regnr} into @value{GDBN} regnum. If | |
3564 | not defined, no conversion will be performed. | |
c906108c | 3565 | |
4a9bb1df | 3566 | @item CORE_ADDR frame_align (@var{gdbarch}, @var{address}) |
790eb8f5 AC |
3567 | @anchor{frame_align} |
3568 | @findex frame_align | |
3569 | Define this to adjust @var{address} so that it meets the alignment | |
3570 | requirements for the start of a new stack frame. A stack frame's | |
3571 | alignment requirements are typically stronger than a target processors | |
5fc14d0a | 3572 | stack alignment requirements. |
790eb8f5 AC |
3573 | |
3574 | This function is used to ensure that, when creating a dummy frame, both | |
3575 | the initial stack pointer and (if needed) the address of the return | |
3576 | value are correctly aligned. | |
3577 | ||
5fc14d0a EZ |
3578 | This function always adjusts the address in the direction of stack |
3579 | growth. | |
790eb8f5 AC |
3580 | |
3581 | By default, no frame based stack alignment is performed. | |
3582 | ||
4a9bb1df UW |
3583 | @item int gdbarch_frame_red_zone_size (@var{gdbarch}) |
3584 | @findex gdbarch_frame_red_zone_size | |
8b148df9 AC |
3585 | The number of bytes, beyond the innermost-stack-address, reserved by the |
3586 | @sc{abi}. A function is permitted to use this scratch area (instead of | |
3587 | allocating extra stack space). | |
3588 | ||
3589 | When performing an inferior function call, to ensure that it does not | |
3590 | modify this area, @value{GDBN} adjusts the innermost-stack-address by | |
4a9bb1df | 3591 | @var{gdbarch_frame_red_zone_size} bytes before pushing parameters onto the |
8b148df9 AC |
3592 | stack. |
3593 | ||
3594 | By default, zero bytes are allocated. The value must be aligned | |
3595 | (@pxref{frame_align}). | |
3596 | ||
3597 | The @sc{amd64} (nee x86-64) @sc{abi} documentation refers to the | |
3598 | @emph{red zone} when describing this scratch area. | |
3599 | @cindex red zone | |
3600 | ||
fb8f8949 | 3601 | @code{FRAME_FIND_SAVED_REGS} is deprecated. |
c906108c | 3602 | |
4a9bb1df UW |
3603 | @item int gdbarch_frame_num_args (@var{gdbarch}, @var{frame}) |
3604 | @findex gdbarch_frame_num_args | |
3605 | For the frame described by @var{frame} return the number of arguments that | |
392a587b JM |
3606 | are being passed. If the number of arguments is not known, return |
3607 | @code{-1}. | |
c906108c | 3608 | |
4a9bb1df UW |
3609 | @item CORE_ADDR gdbarch_unwind_pc (@var{next_frame}) |
3610 | @findex gdbarch_unwind_pc | |
3611 | @anchor{gdbarch_unwind_pc} Return the instruction address, in | |
3612 | @var{next_frame}'s caller, at which execution will resume after | |
3613 | @var{next_frame} returns. This is commonly referred to as the return address. | |
12cc2063 AC |
3614 | |
3615 | The implementation, which must be frame agnostic (work with any frame), | |
3616 | is typically no more than: | |
3617 | ||
3618 | @smallexample | |
3619 | ULONGEST pc; | |
11411de3 | 3620 | pc = frame_unwind_register_unsigned (next_frame, S390_PC_REGNUM); |
4a9bb1df | 3621 | return gdbarch_addr_bits_remove (gdbarch, pc); |
12cc2063 AC |
3622 | @end smallexample |
3623 | ||
3624 | @noindent | |
c906108c | 3625 | |
4a9bb1df UW |
3626 | @item CORE_ADDR gdbarch_unwind_sp (@var{gdbarch}, @var{next_frame}) |
3627 | @findex gdbarch_unwind_sp | |
3628 | @anchor{gdbarch_unwind_sp} Return the frame's inner most stack address. This is | |
d3e8051b | 3629 | commonly referred to as the frame's @dfn{stack pointer}. |
a9e5fdc2 AC |
3630 | |
3631 | The implementation, which must be frame agnostic (work with any frame), | |
3632 | is typically no more than: | |
3633 | ||
3634 | @smallexample | |
3635 | ULONGEST sp; | |
11411de3 | 3636 | sp = frame_unwind_register_unsigned (next_frame, S390_SP_REGNUM); |
4a9bb1df | 3637 | return gdbarch_addr_bits_remove (gdbarch, sp); |
a9e5fdc2 AC |
3638 | @end smallexample |
3639 | ||
3640 | @noindent | |
3641 | @xref{TARGET_READ_SP}, which this method replaces. | |
3642 | ||
c906108c | 3643 | @item GCC_COMPILED_FLAG_SYMBOL |
56caf160 EZ |
3644 | @itemx GCC2_COMPILED_FLAG_SYMBOL |
3645 | @findex GCC2_COMPILED_FLAG_SYMBOL | |
3646 | @findex GCC_COMPILED_FLAG_SYMBOL | |
3647 | If defined, these are the names of the symbols that @value{GDBN} will | |
3648 | look for to detect that GCC compiled the file. The default symbols | |
3649 | are @code{gcc_compiled.} and @code{gcc2_compiled.}, | |
3650 | respectively. (Currently only defined for the Delta 68.) | |
c906108c | 3651 | |
4a9bb1df UW |
3652 | @item gdbarch_get_longjmp_target |
3653 | @findex gdbarch_get_longjmp_target | |
1f70da6a SS |
3654 | This function determines the target PC address that @code{longjmp} |
3655 | will jump to, assuming that we have just stopped at a @code{longjmp} | |
3656 | breakpoint. It takes a @code{CORE_ADDR *} as argument, and stores the | |
3657 | target PC value through this pointer. It examines the current state | |
3658 | of the machine as needed, typically by using a manually-determined | |
3659 | offset into the @code{jmp_buf}. (While we might like to get the offset | |
3660 | from the target's @file{jmpbuf.h}, that header file cannot be assumed | |
3661 | to be available when building a cross-debugger.) | |
c906108c | 3662 | |
268e2188 AC |
3663 | @item DEPRECATED_IBM6000_TARGET |
3664 | @findex DEPRECATED_IBM6000_TARGET | |
3665 | Shows that we are configured for an IBM RS/6000 system. This | |
c906108c | 3666 | conditional should be eliminated (FIXME) and replaced by |
1f70da6a | 3667 | feature-specific macros. It was introduced in haste and we are |
c906108c SS |
3668 | repenting at leisure. |
3669 | ||
9742079a EZ |
3670 | @item I386_USE_GENERIC_WATCHPOINTS |
3671 | An x86-based target can define this to use the generic x86 watchpoint | |
3672 | support; see @ref{Algorithms, I386_USE_GENERIC_WATCHPOINTS}. | |
3673 | ||
4a9bb1df UW |
3674 | @item int gdbarch_inner_than (@var{gdbarch}, @var{lhs}, @var{rhs}) |
3675 | @findex gdbarch_inner_than | |
c906108c | 3676 | Returns non-zero if stack address @var{lhs} is inner than (nearer to the |
4a9bb1df UW |
3677 | stack top) stack address @var{rhs}. Let the function return |
3678 | @w{@code{lhs < rhs}} if the target's stack grows downward in memory, or | |
3679 | @w{@code{lhs > rsh}} if the stack grows upward. | |
c906108c | 3680 | |
4a9bb1df | 3681 | @item gdbarch_in_function_epilogue_p (@var{gdbarch}, @var{addr}) |
9e5abb06 | 3682 | @findex gdbarch_in_function_epilogue_p |
4a9bb1df | 3683 | Returns non-zero if the given @var{addr} is in the epilogue of a function. |
9e5abb06 CV |
3684 | The epilogue of a function is defined as the part of a function where |
3685 | the stack frame of the function already has been destroyed up to the | |
3686 | final `return from function call' instruction. | |
3687 | ||
4a9bb1df UW |
3688 | @item int gdbarch_in_solib_return_trampoline (@var{gdbarch}, @var{pc}, @var{name}) |
3689 | @findex gdbarch_in_solib_return_trampoline | |
3690 | Define this function to return nonzero if the program is stopped in the | |
c906108c SS |
3691 | trampoline that returns from a shared library. |
3692 | ||
cfd8ab24 SS |
3693 | @item target_so_ops.in_dynsym_resolve_code (@var{pc}) |
3694 | @findex in_dynsym_resolve_code | |
4a9bb1df | 3695 | Define this to return nonzero if the program is stopped in the |
d4f3574e SS |
3696 | dynamic linker. |
3697 | ||
56caf160 EZ |
3698 | @item SKIP_SOLIB_RESOLVER (@var{pc}) |
3699 | @findex SKIP_SOLIB_RESOLVER | |
d4f3574e SS |
3700 | Define this to evaluate to the (nonzero) address at which execution |
3701 | should continue to get past the dynamic linker's symbol resolution | |
3702 | function. A zero value indicates that it is not important or necessary | |
3703 | to set a breakpoint to get through the dynamic linker and that single | |
3704 | stepping will suffice. | |
3705 | ||
4a9bb1df UW |
3706 | @item CORE_ADDR gdbarch_integer_to_address (@var{gdbarch}, @var{type}, @var{buf}) |
3707 | @findex gdbarch_integer_to_address | |
fc0c74b1 AC |
3708 | @cindex converting integers to addresses |
3709 | Define this when the architecture needs to handle non-pointer to address | |
3710 | conversions specially. Converts that value to an address according to | |
3711 | the current architectures conventions. | |
3712 | ||
3713 | @emph{Pragmatics: When the user copies a well defined expression from | |
3714 | their source code and passes it, as a parameter, to @value{GDBN}'s | |
3715 | @code{print} command, they should get the same value as would have been | |
3716 | computed by the target program. Any deviation from this rule can cause | |
3717 | major confusion and annoyance, and needs to be justified carefully. In | |
3718 | other words, @value{GDBN} doesn't really have the freedom to do these | |
3719 | conversions in clever and useful ways. It has, however, been pointed | |
3720 | out that users aren't complaining about how @value{GDBN} casts integers | |
3721 | to pointers; they are complaining that they can't take an address from a | |
3722 | disassembly listing and give it to @code{x/i}. Adding an architecture | |
4a9bb1df | 3723 | method like @code{gdbarch_integer_to_address} certainly makes it possible for |
fc0c74b1 AC |
3724 | @value{GDBN} to ``get it right'' in all circumstances.} |
3725 | ||
3726 | @xref{Target Architecture Definition, , Pointers Are Not Always | |
3727 | Addresses}. | |
3728 | ||
4a9bb1df UW |
3729 | @item CORE_ADDR gdbarch_pointer_to_address (@var{gdbarch}, @var{type}, @var{buf}) |
3730 | @findex gdbarch_pointer_to_address | |
93e79dbd JB |
3731 | Assume that @var{buf} holds a pointer of type @var{type}, in the |
3732 | appropriate format for the current architecture. Return the byte | |
3733 | address the pointer refers to. | |
3734 | @xref{Target Architecture Definition, , Pointers Are Not Always Addresses}. | |
3735 | ||
4a9bb1df UW |
3736 | @item void gdbarch_register_to_value(@var{gdbarch}, @var{frame}, @var{regnum}, @var{type}, @var{fur}) |
3737 | @findex gdbarch_register_to_value | |
13d01224 AC |
3738 | Convert the raw contents of register @var{regnum} into a value of type |
3739 | @var{type}. | |
4281a42e | 3740 | @xref{Target Architecture Definition, , Using Different Register and Memory Data Representations}. |
9fb4dd36 | 3741 | |
617073a9 AC |
3742 | @item register_reggroup_p (@var{gdbarch}, @var{regnum}, @var{reggroup}) |
3743 | @findex register_reggroup_p | |
3744 | @cindex register groups | |
3745 | Return non-zero if register @var{regnum} is a member of the register | |
3746 | group @var{reggroup}. | |
3747 | ||
3748 | By default, registers are grouped as follows: | |
3749 | ||
3750 | @table @code | |
3751 | @item float_reggroup | |
3752 | Any register with a valid name and a floating-point type. | |
3753 | @item vector_reggroup | |
3754 | Any register with a valid name and a vector type. | |
3755 | @item general_reggroup | |
3756 | Any register with a valid name and a type other than vector or | |
3757 | floating-point. @samp{float_reggroup}. | |
3758 | @item save_reggroup | |
3759 | @itemx restore_reggroup | |
3760 | @itemx all_reggroup | |
3761 | Any register with a valid name. | |
3762 | @end table | |
3763 | ||
77e7e267 AC |
3764 | @item struct type *register_type (@var{gdbarch}, @var{reg}) |
3765 | @findex register_type | |
1f70da6a SS |
3766 | If defined, return the type of register @var{reg}. |
3767 | @xref{Target Architecture Definition, , Raw and Virtual Register | |
3768 | Representations}. | |
77e7e267 | 3769 | |
9fb4dd36 | 3770 | @item REGISTER_CONVERT_TO_VIRTUAL(@var{reg}, @var{type}, @var{from}, @var{to}) |
56caf160 | 3771 | @findex REGISTER_CONVERT_TO_VIRTUAL |
9fb4dd36 | 3772 | Convert the value of register @var{reg} from its raw form to its virtual |
4281a42e | 3773 | form. |
13d01224 | 3774 | @xref{Target Architecture Definition, , Raw and Virtual Register Representations}. |
9fb4dd36 JB |
3775 | |
3776 | @item REGISTER_CONVERT_TO_RAW(@var{type}, @var{reg}, @var{from}, @var{to}) | |
56caf160 | 3777 | @findex REGISTER_CONVERT_TO_RAW |
9fb4dd36 | 3778 | Convert the value of register @var{reg} from its virtual form to its raw |
4281a42e | 3779 | form. |
13d01224 | 3780 | @xref{Target Architecture Definition, , Raw and Virtual Register Representations}. |
9fb4dd36 | 3781 | |
0ab4b752 MK |
3782 | @item const struct regset *regset_from_core_section (struct gdbarch * @var{gdbarch}, const char * @var{sect_name}, size_t @var{sect_size}) |
3783 | @findex regset_from_core_section | |
3784 | Return the appropriate register set for a core file section with name | |
3785 | @var{sect_name} and size @var{sect_size}. | |
3786 | ||
b0ed3589 | 3787 | @item SOFTWARE_SINGLE_STEP_P() |
56caf160 | 3788 | @findex SOFTWARE_SINGLE_STEP_P |
c906108c | 3789 | Define this as 1 if the target does not have a hardware single-step |
56caf160 | 3790 | mechanism. The macro @code{SOFTWARE_SINGLE_STEP} must also be defined. |
c906108c | 3791 | |
d3e8051b | 3792 | @item SOFTWARE_SINGLE_STEP(@var{signal}, @var{insert_breakpoints_p}) |
56caf160 EZ |
3793 | @findex SOFTWARE_SINGLE_STEP |
3794 | A function that inserts or removes (depending on | |
d3e8051b | 3795 | @var{insert_breakpoints_p}) breakpoints at each possible destinations of |
56caf160 | 3796 | the next instruction. See @file{sparc-tdep.c} and @file{rs6000-tdep.c} |
c906108c SS |
3797 | for examples. |
3798 | ||
e35879db UW |
3799 | @item set_gdbarch_sofun_address_maybe_missing (@var{gdbarch}, @var{set}) |
3800 | @findex set_gdbarch_sofun_address_maybe_missing | |
3801 | Somebody clever observed that, the more actual addresses you have in the | |
3802 | debug information, the more time the linker has to spend relocating | |
3803 | them. So whenever there's some other way the debugger could find the | |
3804 | address it needs, you should omit it from the debug info, to make | |
3805 | linking faster. | |
3806 | ||
3807 | Calling @code{set_gdbarch_sofun_address_maybe_missing} with a non-zero | |
3808 | argument @var{set} indicates that a particular set of hacks of this sort | |
3809 | are in use, affecting @code{N_SO} and @code{N_FUN} entries in stabs-format | |
3810 | debugging information. @code{N_SO} stabs mark the beginning and ending | |
3811 | addresses of compilation units in the text segment. @code{N_FUN} stabs | |
3812 | mark the starts and ends of functions. | |
3813 | ||
3814 | In this case, @value{GDBN} assumes two things: | |
3815 | ||
3816 | @itemize @bullet | |
3817 | @item | |
3818 | @code{N_FUN} stabs have an address of zero. Instead of using those | |
3819 | addresses, you should find the address where the function starts by | |
3820 | taking the function name from the stab, and then looking that up in the | |
3821 | minsyms (the linker/assembler symbol table). In other words, the stab | |
3822 | has the name, and the linker/assembler symbol table is the only place | |
3823 | that carries the address. | |
3824 | ||
3825 | @item | |
3826 | @code{N_SO} stabs have an address of zero, too. You just look at the | |
3827 | @code{N_FUN} stabs that appear before and after the @code{N_SO} stab, and | |
3828 | guess the starting and ending addresses of the compilation unit from them. | |
3829 | @end itemize | |
3830 | ||
4a9bb1df UW |
3831 | @item int gdbarch_pc_regnum (@var{gdbarch}) |
3832 | @findex gdbarch_pc_regnum | |
3833 | If the program counter is kept in a register, then let this function return | |
3834 | the number (greater than or equal to zero) of that register. | |
c906108c | 3835 | |
4a9bb1df UW |
3836 | This should only need to be defined if @code{gdbarch_read_pc} and |
3837 | @code{gdbarch_write_pc} are not defined. | |
2df3850c | 3838 | |
4a9bb1df UW |
3839 | @item int gdbarch_stabs_argument_has_addr (@var{gdbarch}, @var{type}) |
3840 | @findex gdbarch_stabs_argument_has_addr | |
4a9bb1df UW |
3841 | @anchor{gdbarch_stabs_argument_has_addr} Define this function to return |
3842 | nonzero if a function argument of type @var{type} is passed by reference | |
3843 | instead of value. | |
a38c9fe6 | 3844 | |
c906108c | 3845 | @item PROCESS_LINENUMBER_HOOK |
56caf160 | 3846 | @findex PROCESS_LINENUMBER_HOOK |
c906108c SS |
3847 | A hook defined for XCOFF reading. |
3848 | ||
4a9bb1df UW |
3849 | @item gdbarch_ps_regnum (@var{gdbarch} |
3850 | @findex gdbarch_ps_regnum | |
3851 | If defined, this function returns the number of the processor status | |
3852 | register. | |
3853 | (This definition is only used in generic code when parsing "$ps".) | |
c906108c | 3854 | |
4a9bb1df UW |
3855 | @item CORE_ADDR gdbarch_push_dummy_call (@var{gdbarch}, @var{function}, @var{regcache}, @var{bp_addr}, @var{nargs}, @var{args}, @var{sp}, @var{struct_return}, @var{struct_addr}) |
3856 | @findex gdbarch_push_dummy_call | |
4a9bb1df UW |
3857 | @anchor{gdbarch_push_dummy_call} Define this to push the dummy frame's call to |
3858 | the inferior function onto the stack. In addition to pushing @var{nargs}, the | |
3859 | code should push @var{struct_addr} (when @var{struct_return} is non-zero), and | |
3860 | the return address (@var{bp_addr}). | |
c906108c | 3861 | |
86fe4aaa | 3862 | @var{function} is a pointer to a @code{struct value}; on architectures that use |
d4b6d575 RC |
3863 | function descriptors, this contains the function descriptor value. |
3864 | ||
b24da7d0 | 3865 | Returns the updated top-of-stack pointer. |
b81774d8 | 3866 | |
4a9bb1df UW |
3867 | @item CORE_ADDR gdbarch_push_dummy_code (@var{gdbarch}, @var{sp}, @var{funaddr}, @var{using_gcc}, @var{args}, @var{nargs}, @var{value_type}, @var{real_pc}, @var{bp_addr}, @var{regcache}) |
3868 | @findex gdbarch_push_dummy_code | |
3869 | @anchor{gdbarch_push_dummy_code} Given a stack based call dummy, push the | |
7043d8dc AC |
3870 | instruction sequence (including space for a breakpoint) to which the |
3871 | called function should return. | |
3872 | ||
3873 | Set @var{bp_addr} to the address at which the breakpoint instruction | |
3874 | should be inserted, @var{real_pc} to the resume address when starting | |
3875 | the call sequence, and return the updated inner-most stack address. | |
3876 | ||
3877 | By default, the stack is grown sufficient to hold a frame-aligned | |
3878 | (@pxref{frame_align}) breakpoint, @var{bp_addr} is set to the address | |
3879 | reserved for that breakpoint, and @var{real_pc} set to @var{funaddr}. | |
3880 | ||
1f70da6a | 3881 | This method replaces @w{@code{gdbarch_call_dummy_location (@var{gdbarch})}}. |
7043d8dc | 3882 | |
4a9bb1df UW |
3883 | @item const char *gdbarch_register_name (@var{gdbarch}, @var{regnr}) |
3884 | @findex gdbarch_register_name | |
3885 | Return the name of register @var{regnr} as a string. May return @code{NULL} | |
3886 | to indicate that @var{regnr} is not a valid register. | |
c906108c | 3887 | |
4a9bb1df UW |
3888 | @item int gdbarch_sdb_reg_to_regnum (@var{gdbarch}, @var{sdb_regnr}) |
3889 | @findex gdbarch_sdb_reg_to_regnum | |
3890 | Use this function to convert sdb register @var{sdb_regnr} into @value{GDBN} | |
3891 | regnum. If not defined, no conversion will be done. | |
c906108c | 3892 | |
963e2bb7 | 3893 | @item enum return_value_convention gdbarch_return_value (struct gdbarch *@var{gdbarch}, struct type *@var{valtype}, struct regcache *@var{regcache}, void *@var{readbuf}, const void *@var{writebuf}) |
92ad9cd9 AC |
3894 | @findex gdbarch_return_value |
3895 | @anchor{gdbarch_return_value} Given a function with a return-value of | |
3896 | type @var{rettype}, return which return-value convention that function | |
3897 | would use. | |
3898 | ||
3899 | @value{GDBN} currently recognizes two function return-value conventions: | |
3900 | @code{RETURN_VALUE_REGISTER_CONVENTION} where the return value is found | |
3901 | in registers; and @code{RETURN_VALUE_STRUCT_CONVENTION} where the return | |
3902 | value is found in memory and the address of that memory location is | |
3903 | passed in as the function's first parameter. | |
3904 | ||
963e2bb7 AC |
3905 | If the register convention is being used, and @var{writebuf} is |
3906 | non-@code{NULL}, also copy the return-value in @var{writebuf} into | |
92ad9cd9 AC |
3907 | @var{regcache}. |
3908 | ||
963e2bb7 | 3909 | If the register convention is being used, and @var{readbuf} is |
92ad9cd9 | 3910 | non-@code{NULL}, also copy the return value from @var{regcache} into |
963e2bb7 | 3911 | @var{readbuf} (@var{regcache} contains a copy of the registers from the |
92ad9cd9 AC |
3912 | just returned function). |
3913 | ||
92ad9cd9 AC |
3914 | @emph{Maintainer note: This method replaces separate predicate, extract, |
3915 | store methods. By having only one method, the logic needed to determine | |
3916 | the return-value convention need only be implemented in one place. If | |
3917 | @value{GDBN} were written in an @sc{oo} language, this method would | |
3918 | instead return an object that knew how to perform the register | |
3919 | return-value extract and store.} | |
3920 | ||
3921 | @emph{Maintainer note: This method does not take a @var{gcc_p} | |
3922 | parameter, and such a parameter should not be added. If an architecture | |
3923 | that requires per-compiler or per-function information be identified, | |
3924 | then the replacement of @var{rettype} with @code{struct value} | |
d3e8051b | 3925 | @var{function} should be pursued.} |
92ad9cd9 AC |
3926 | |
3927 | @emph{Maintainer note: The @var{regcache} parameter limits this methods | |
3928 | to the inner most frame. While replacing @var{regcache} with a | |
3929 | @code{struct frame_info} @var{frame} parameter would remove that | |
3930 | limitation there has yet to be a demonstrated need for such a change.} | |
3931 | ||
4a9bb1df UW |
3932 | @item void gdbarch_skip_permanent_breakpoint (@var{gdbarch}, @var{regcache}) |
3933 | @findex gdbarch_skip_permanent_breakpoint | |
25822942 | 3934 | Advance the inferior's PC past a permanent breakpoint. @value{GDBN} normally |
c2c6d25f JM |
3935 | steps over a breakpoint by removing it, stepping one instruction, and |
3936 | re-inserting the breakpoint. However, permanent breakpoints are | |
3937 | hardwired into the inferior, and can't be removed, so this strategy | |
4a9bb1df UW |
3938 | doesn't work. Calling @code{gdbarch_skip_permanent_breakpoint} adjusts the |
3939 | processor's state so that execution will resume just after the breakpoint. | |
3940 | This function does the right thing even when the breakpoint is in the delay slot | |
c2c6d25f JM |
3941 | of a branch or jump. |
3942 | ||
4a9bb1df UW |
3943 | @item CORE_ADDR gdbarch_skip_prologue (@var{gdbarch}, @var{ip}) |
3944 | @findex gdbarch_skip_prologue | |
3945 | A function that returns the address of the ``real'' code beyond the | |
3946 | function entry prologue found at @var{ip}. | |
c906108c | 3947 | |
4a9bb1df UW |
3948 | @item CORE_ADDR gdbarch_skip_trampoline_code (@var{gdbarch}, @var{frame}, @var{pc}) |
3949 | @findex gdbarch_skip_trampoline_code | |
c906108c | 3950 | If the target machine has trampoline code that sits between callers and |
4a9bb1df | 3951 | the functions being called, then define this function to return a new PC |
c906108c SS |
3952 | that is at the start of the real function. |
3953 | ||
4a9bb1df UW |
3954 | @item int gdbarch_sp_regnum (@var{gdbarch}) |
3955 | @findex gdbarch_sp_regnum | |
3956 | If the stack-pointer is kept in a register, then use this function to return | |
6c0e89ed AC |
3957 | the number (greater than or equal to zero) of that register, or -1 if |
3958 | there is no such register. | |
c906108c | 3959 | |
1f70da6a SS |
3960 | @item int gdbarch_deprecated_fp_regnum (@var{gdbarch}) |
3961 | @findex gdbarch_deprecated_fp_regnum | |
3962 | If the frame pointer is in a register, use this function to return the | |
3963 | number of that register. | |
3964 | ||
4a9bb1df UW |
3965 | @item int gdbarch_stab_reg_to_regnum (@var{gdbarch}, @var{stab_regnr}) |
3966 | @findex gdbarch_stab_reg_to_regnum | |
3967 | Use this function to convert stab register @var{stab_regnr} into @value{GDBN} | |
3968 | regnum. If not defined, no conversion will be done. | |
3969 | ||
c906108c | 3970 | @item SYMBOL_RELOADING_DEFAULT |
56caf160 EZ |
3971 | @findex SYMBOL_RELOADING_DEFAULT |
3972 | The default value of the ``symbol-reloading'' variable. (Never defined in | |
c906108c SS |
3973 | current sources.) |
3974 | ||
c906108c | 3975 | @item TARGET_CHAR_BIT |
56caf160 | 3976 | @findex TARGET_CHAR_BIT |
c906108c SS |
3977 | Number of bits in a char; defaults to 8. |
3978 | ||
4a9bb1df UW |
3979 | @item int gdbarch_char_signed (@var{gdbarch}) |
3980 | @findex gdbarch_char_signed | |
c3d3ce5b JB |
3981 | Non-zero if @code{char} is normally signed on this architecture; zero if |
3982 | it should be unsigned. | |
3983 | ||
3984 | The ISO C standard requires the compiler to treat @code{char} as | |
3985 | equivalent to either @code{signed char} or @code{unsigned char}; any | |
3986 | character in the standard execution set is supposed to be positive. | |
3987 | Most compilers treat @code{char} as signed, but @code{char} is unsigned | |
3988 | on the IBM S/390, RS6000, and PowerPC targets. | |
3989 | ||
4a9bb1df UW |
3990 | @item int gdbarch_double_bit (@var{gdbarch}) |
3991 | @findex gdbarch_double_bit | |
3992 | Number of bits in a double float; defaults to @w{@code{8 * TARGET_CHAR_BIT}}. | |
c906108c | 3993 | |
4a9bb1df UW |
3994 | @item int gdbarch_float_bit (@var{gdbarch}) |
3995 | @findex gdbarch_float_bit | |
3996 | Number of bits in a float; defaults to @w{@code{4 * TARGET_CHAR_BIT}}. | |
ac9a91a7 | 3997 | |
4a9bb1df UW |
3998 | @item int gdbarch_int_bit (@var{gdbarch}) |
3999 | @findex gdbarch_int_bit | |
4000 | Number of bits in an integer; defaults to @w{@code{4 * TARGET_CHAR_BIT}}. | |
c906108c | 4001 | |
4a9bb1df UW |
4002 | @item int gdbarch_long_bit (@var{gdbarch}) |
4003 | @findex gdbarch_long_bit | |
4004 | Number of bits in a long integer; defaults to @w{@code{4 * TARGET_CHAR_BIT}}. | |
c906108c | 4005 | |
4a9bb1df UW |
4006 | @item int gdbarch_long_double_bit (@var{gdbarch}) |
4007 | @findex gdbarch_long_double_bit | |
c906108c | 4008 | Number of bits in a long double float; |
4a9bb1df UW |
4009 | defaults to @w{@code{2 * gdbarch_double_bit (@var{gdbarch})}}. |
4010 | ||
4011 | @item int gdbarch_long_long_bit (@var{gdbarch}) | |
4012 | @findex gdbarch_long_long_bit | |
4013 | Number of bits in a long long integer; defaults to | |
4014 | @w{@code{2 * gdbarch_long_bit (@var{gdbarch})}}. | |
4015 | ||
4016 | @item int gdbarch_ptr_bit (@var{gdbarch}) | |
4017 | @findex gdbarch_ptr_bit | |
4018 | Number of bits in a pointer; defaults to | |
4019 | @w{@code{gdbarch_int_bit (@var{gdbarch})}}. | |
4020 | ||
4021 | @item int gdbarch_short_bit (@var{gdbarch}) | |
4022 | @findex gdbarch_short_bit | |
4023 | Number of bits in a short integer; defaults to @w{@code{2 * TARGET_CHAR_BIT}}. | |
4024 | ||
4025 | @item CORE_ADDR gdbarch_read_pc (@var{gdbarch}, @var{regcache}) | |
4026 | @findex gdbarch_read_pc | |
4027 | @itemx gdbarch_write_pc (@var{gdbarch}, @var{regcache}, @var{val}) | |
4028 | @findex gdbarch_write_pc | |
4029 | @anchor{gdbarch_write_pc} | |
56caf160 EZ |
4030 | @itemx TARGET_READ_SP |
4031 | @findex TARGET_READ_SP | |
56caf160 EZ |
4032 | @itemx TARGET_READ_FP |
4033 | @findex TARGET_READ_FP | |
4a9bb1df UW |
4034 | @findex gdbarch_read_pc |
4035 | @findex gdbarch_write_pc | |
56caf160 | 4036 | @findex read_sp |
56caf160 | 4037 | @findex read_fp |
4a9bb1df UW |
4038 | @anchor{TARGET_READ_SP} These change the behavior of @code{gdbarch_read_pc}, |
4039 | @code{gdbarch_write_pc}, and @code{read_sp}. For most targets, these may be | |
9c8dbfa9 AC |
4040 | left undefined. @value{GDBN} will call the read and write register |
4041 | functions with the relevant @code{_REGNUM} argument. | |
c906108c | 4042 | |
4a9bb1df UW |
4043 | These macros and functions are useful when a target keeps one of these |
4044 | registers in a hard to get at place; for example, part in a segment register | |
4045 | and part in an ordinary register. | |
c906108c | 4046 | |
4a9bb1df | 4047 | @xref{gdbarch_unwind_sp}, which replaces @code{TARGET_READ_SP}. |
a9e5fdc2 | 4048 | |
4a9bb1df UW |
4049 | @item void gdbarch_virtual_frame_pointer (@var{gdbarch}, @var{pc}, @var{frame_regnum}, @var{frame_offset}) |
4050 | @findex gdbarch_virtual_frame_pointer | |
1f70da6a SS |
4051 | Returns a @code{(@var{register}, @var{offset})} pair representing the virtual |
4052 | frame pointer in use at the code address @var{pc}. If virtual frame | |
4053 | pointers are not used, a default definition simply returns | |
4054 | @code{gdbarch_deprecated_fp_regnum} (or @code{gdbarch_sp_regnum}, if | |
4055 | no frame pointer is defined), with an offset of zero. | |
4056 | ||
4057 | @c need to explain virtual frame pointers, they are recorded in agent expressions | |
4058 | @c for tracepoints | |
c906108c | 4059 | |
9742079a EZ |
4060 | @item TARGET_HAS_HARDWARE_WATCHPOINTS |
4061 | If non-zero, the target has support for hardware-assisted | |
4062 | watchpoints. @xref{Algorithms, watchpoints}, for more details and | |
4063 | other related macros. | |
4064 | ||
4a9bb1df UW |
4065 | @item int gdbarch_print_insn (@var{gdbarch}, @var{vma}, @var{info}) |
4066 | @findex gdbarch_print_insn | |
7ccaa899 | 4067 | This is the function used by @value{GDBN} to print an assembly |
4a9bb1df | 4068 | instruction. It prints the instruction at address @var{vma} in |
1f70da6a SS |
4069 | debugged memory and returns the length of the instruction, in bytes. |
4070 | This usually points to a function in the @code{opcodes} library | |
4071 | (@pxref{Support Libraries, ,Opcodes}). @var{info} is a structure (of | |
4072 | type @code{disassemble_info}) defined in the header file | |
4073 | @file{include/dis-asm.h}, and used to pass information to the | |
4074 | instruction decoding routine. | |
7ccaa899 | 4075 | |
669fac23 DJ |
4076 | @item frame_id gdbarch_dummy_id (@var{gdbarch}, @var{frame}) |
4077 | @findex gdbarch_dummy_id | |
4078 | @anchor{gdbarch_dummy_id} Given @var{frame} return a @w{@code{struct | |
4a9bb1df | 4079 | frame_id}} that uniquely identifies an inferior function call's dummy |
b24da7d0 | 4080 | frame. The value returned must match the dummy frame stack value |
669fac23 | 4081 | previously saved by @code{call_function_by_hand}. |
6314f104 | 4082 | |
4a9bb1df UW |
4083 | @item void gdbarch_value_to_register (@var{gdbarch}, @var{frame}, @var{type}, @var{buf}) |
4084 | @findex gdbarch_value_to_register | |
4085 | Convert a value of type @var{type} into the raw contents of a register. | |
13d01224 AC |
4086 | @xref{Target Architecture Definition, , Using Different Register and Memory Data Representations}. |
4087 | ||
c906108c SS |
4088 | @end table |
4089 | ||
4090 | Motorola M68K target conditionals. | |
4091 | ||
56caf160 | 4092 | @ftable @code |
c906108c SS |
4093 | @item BPT_VECTOR |
4094 | Define this to be the 4-bit location of the breakpoint trap vector. If | |
4095 | not defined, it will default to @code{0xf}. | |
4096 | ||
4097 | @item REMOTE_BPT_VECTOR | |
4098 | Defaults to @code{1}. | |
a23a7bf1 | 4099 | |
56caf160 | 4100 | @end ftable |
c906108c | 4101 | |
b6fd0dfb | 4102 | @node Adding a New Target |
c906108c SS |
4103 | @section Adding a New Target |
4104 | ||
56caf160 | 4105 | @cindex adding a target |
af6c57ea | 4106 | The following files add a target to @value{GDBN}: |
c906108c SS |
4107 | |
4108 | @table @file | |
56caf160 | 4109 | @vindex TDEPFILES |
c906108c SS |
4110 | @item gdb/config/@var{arch}/@var{ttt}.mt |
4111 | Contains a Makefile fragment specific to this target. Specifies what | |
4112 | object files are needed for target @var{ttt}, by defining | |
1f70da6a | 4113 | @samp{TDEPFILES=@dots{}} and @samp{TDEPLIBS=@dots{}}. |
104c1213 | 4114 | |
1f70da6a SS |
4115 | You can also define @samp{TM_CLIBS} and @samp{TM_CDEPS}, but these are |
4116 | now deprecated, replaced by autoconf, and may go away in future | |
4117 | versions of @value{GDBN}. | |
c906108c | 4118 | |
c906108c SS |
4119 | @item gdb/@var{ttt}-tdep.c |
4120 | Contains any miscellaneous code required for this target machine. On | |
1f70da6a | 4121 | some machines it doesn't exist at all. |
c906108c | 4122 | |
af6c57ea AC |
4123 | @item gdb/@var{arch}-tdep.c |
4124 | @itemx gdb/@var{arch}-tdep.h | |
1f70da6a SS |
4125 | This is required to describe the basic layout of the target machine's |
4126 | processor chip (registers, stack, etc.). It can be shared among many | |
4127 | targets that use the same processor architecture. | |
af6c57ea | 4128 | |
c906108c SS |
4129 | @end table |
4130 | ||
1f70da6a SS |
4131 | (Target header files such as |
4132 | @file{gdb/config/@var{arch}/tm-@var{ttt}.h}, | |
4133 | @file{gdb/config/@var{arch}/tm-@var{arch}.h}, and | |
4134 | @file{config/tm-@var{os}.h} are no longer used.) | |
c906108c | 4135 | |
123dc839 DJ |
4136 | @node Target Descriptions |
4137 | @chapter Target Descriptions | |
4138 | @cindex target descriptions | |
4139 | ||
4140 | The target architecture definition (@pxref{Target Architecture Definition}) | |
4141 | contains @value{GDBN}'s hard-coded knowledge about an architecture. For | |
4142 | some platforms, it is handy to have more flexible knowledge about a specific | |
4143 | instance of the architecture---for instance, a processor or development board. | |
4144 | @dfn{Target descriptions} provide a mechanism for the user to tell @value{GDBN} | |
4145 | more about what their target supports, or for the target to tell @value{GDBN} | |
4146 | directly. | |
4147 | ||
4148 | For details on writing, automatically supplying, and manually selecting | |
4149 | target descriptions, see @ref{Target Descriptions, , , gdb, | |
4150 | Debugging with @value{GDBN}}. This section will cover some related | |
4151 | topics about the @value{GDBN} internals. | |
4152 | ||
4153 | @menu | |
4154 | * Target Descriptions Implementation:: | |
4155 | * Adding Target Described Register Support:: | |
4156 | @end menu | |
4157 | ||
4158 | @node Target Descriptions Implementation | |
4159 | @section Target Descriptions Implementation | |
4160 | @cindex target descriptions, implementation | |
4161 | ||
4162 | Before @value{GDBN} connects to a new target, or runs a new program on | |
4163 | an existing target, it discards any existing target description and | |
4164 | reverts to a default gdbarch. Then, after connecting, it looks for a | |
4165 | new target description by calling @code{target_find_description}. | |
4166 | ||
4167 | A description may come from a user specified file (XML), the remote | |
4168 | @samp{qXfer:features:read} packet (also XML), or from any custom | |
4169 | @code{to_read_description} routine in the target vector. For instance, | |
4170 | the remote target supports guessing whether a MIPS target is 32-bit or | |
4171 | 64-bit based on the size of the @samp{g} packet. | |
4172 | ||
4173 | If any target description is found, @value{GDBN} creates a new gdbarch | |
4174 | incorporating the description by calling @code{gdbarch_update_p}. Any | |
4175 | @samp{<architecture>} element is handled first, to determine which | |
4176 | architecture's gdbarch initialization routine is called to create the | |
4177 | new architecture. Then the initialization routine is called, and has | |
4178 | a chance to adjust the constructed architecture based on the contents | |
4179 | of the target description. For instance, it can recognize any | |
4180 | properties set by a @code{to_read_description} routine. Also | |
4181 | see @ref{Adding Target Described Register Support}. | |
4182 | ||
4183 | @node Adding Target Described Register Support | |
4184 | @section Adding Target Described Register Support | |
4185 | @cindex target descriptions, adding register support | |
4186 | ||
4187 | Target descriptions can report additional registers specific to an | |
4188 | instance of the target. But it takes a little work in the architecture | |
4189 | specific routines to support this. | |
4190 | ||
4191 | A target description must either have no registers or a complete | |
4192 | set---this avoids complexity in trying to merge standard registers | |
4193 | with the target defined registers. It is the architecture's | |
4194 | responsibility to validate that a description with registers has | |
4195 | everything it needs. To keep architecture code simple, the same | |
4196 | mechanism is used to assign fixed internal register numbers to | |
4197 | standard registers. | |
4198 | ||
4199 | If @code{tdesc_has_registers} returns 1, the description contains | |
4200 | registers. The architecture's @code{gdbarch_init} routine should: | |
4201 | ||
4202 | @itemize @bullet | |
4203 | ||
4204 | @item | |
4205 | Call @code{tdesc_data_alloc} to allocate storage, early, before | |
4206 | searching for a matching gdbarch or allocating a new one. | |
4207 | ||
4208 | @item | |
4209 | Use @code{tdesc_find_feature} to locate standard features by name. | |
4210 | ||
4211 | @item | |
4212 | Use @code{tdesc_numbered_register} and @code{tdesc_numbered_register_choices} | |
4213 | to locate the expected registers in the standard features. | |
4214 | ||
4215 | @item | |
4216 | Return @code{NULL} if a required feature is missing, or if any standard | |
4217 | feature is missing expected registers. This will produce a warning that | |
4218 | the description was incomplete. | |
4219 | ||
4220 | @item | |
4221 | Free the allocated data before returning, unless @code{tdesc_use_registers} | |
4222 | is called. | |
4223 | ||
4224 | @item | |
4225 | Call @code{set_gdbarch_num_regs} as usual, with a number higher than any | |
4226 | fixed number passed to @code{tdesc_numbered_register}. | |
4227 | ||
4228 | @item | |
4229 | Call @code{tdesc_use_registers} after creating a new gdbarch, before | |
4230 | returning it. | |
4231 | ||
4232 | @end itemize | |
4233 | ||
4234 | After @code{tdesc_use_registers} has been called, the architecture's | |
4235 | @code{register_name}, @code{register_type}, and @code{register_reggroup_p} | |
4236 | routines will not be called; that information will be taken from | |
4237 | the target description. @code{num_regs} may be increased to account | |
4238 | for any additional registers in the description. | |
4239 | ||
4240 | Pseudo-registers require some extra care: | |
4241 | ||
4242 | @itemize @bullet | |
4243 | ||
4244 | @item | |
4245 | Using @code{tdesc_numbered_register} allows the architecture to give | |
4246 | constant register numbers to standard architectural registers, e.g.@: | |
4247 | as an @code{enum} in @file{@var{arch}-tdep.h}. But because | |
4248 | pseudo-registers are always numbered above @code{num_regs}, | |
4249 | which may be increased by the description, constant numbers | |
4250 | can not be used for pseudos. They must be numbered relative to | |
4251 | @code{num_regs} instead. | |
4252 | ||
4253 | @item | |
4254 | The description will not describe pseudo-registers, so the | |
4255 | architecture must call @code{set_tdesc_pseudo_register_name}, | |
4256 | @code{set_tdesc_pseudo_register_type}, and | |
4257 | @code{set_tdesc_pseudo_register_reggroup_p} to supply routines | |
4258 | describing pseudo registers. These routines will be passed | |
4259 | internal register numbers, so the same routines used for the | |
4260 | gdbarch equivalents are usually suitable. | |
4261 | ||
4262 | @end itemize | |
4263 | ||
4264 | ||
c906108c SS |
4265 | @node Target Vector Definition |
4266 | ||
4267 | @chapter Target Vector Definition | |
56caf160 | 4268 | @cindex target vector |
c906108c | 4269 | |
56caf160 EZ |
4270 | The target vector defines the interface between @value{GDBN}'s |
4271 | abstract handling of target systems, and the nitty-gritty code that | |
4272 | actually exercises control over a process or a serial port. | |
4273 | @value{GDBN} includes some 30-40 different target vectors; however, | |
4274 | each configuration of @value{GDBN} includes only a few of them. | |
c906108c | 4275 | |
52bb452f DJ |
4276 | @menu |
4277 | * Managing Execution State:: | |
4278 | * Existing Targets:: | |
4279 | @end menu | |
4280 | ||
4281 | @node Managing Execution State | |
4282 | @section Managing Execution State | |
4283 | @cindex execution state | |
4284 | ||
4285 | A target vector can be completely inactive (not pushed on the target | |
4286 | stack), active but not running (pushed, but not connected to a fully | |
4287 | manifested inferior), or completely active (pushed, with an accessible | |
4288 | inferior). Most targets are only completely inactive or completely | |
d3e8051b | 4289 | active, but some support persistent connections to a target even |
52bb452f DJ |
4290 | when the target has exited or not yet started. |
4291 | ||
4292 | For example, connecting to the simulator using @code{target sim} does | |
4293 | not create a running program. Neither registers nor memory are | |
4294 | accessible until @code{run}. Similarly, after @code{kill}, the | |
4295 | program can not continue executing. But in both cases @value{GDBN} | |
4296 | remains connected to the simulator, and target-specific commands | |
4297 | are directed to the simulator. | |
4298 | ||
4299 | A target which only supports complete activation should push itself | |
4300 | onto the stack in its @code{to_open} routine (by calling | |
4301 | @code{push_target}), and unpush itself from the stack in its | |
4302 | @code{to_mourn_inferior} routine (by calling @code{unpush_target}). | |
4303 | ||
4304 | A target which supports both partial and complete activation should | |
4305 | still call @code{push_target} in @code{to_open}, but not call | |
4306 | @code{unpush_target} in @code{to_mourn_inferior}. Instead, it should | |
4307 | call either @code{target_mark_running} or @code{target_mark_exited} | |
4308 | in its @code{to_open}, depending on whether the target is fully active | |
4309 | after connection. It should also call @code{target_mark_running} any | |
4310 | time the inferior becomes fully active (e.g.@: in | |
4311 | @code{to_create_inferior} and @code{to_attach}), and | |
4312 | @code{target_mark_exited} when the inferior becomes inactive (in | |
4313 | @code{to_mourn_inferior}). The target should also make sure to call | |
4314 | @code{target_mourn_inferior} from its @code{to_kill}, to return the | |
4315 | target to inactive state. | |
4316 | ||
4317 | @node Existing Targets | |
4318 | @section Existing Targets | |
4319 | @cindex targets | |
4320 | ||
4321 | @subsection File Targets | |
c906108c SS |
4322 | |
4323 | Both executables and core files have target vectors. | |
4324 | ||
52bb452f | 4325 | @subsection Standard Protocol and Remote Stubs |
c906108c | 4326 | |
56caf160 EZ |
4327 | @value{GDBN}'s file @file{remote.c} talks a serial protocol to code |
4328 | that runs in the target system. @value{GDBN} provides several sample | |
4329 | @dfn{stubs} that can be integrated into target programs or operating | |
1f70da6a SS |
4330 | systems for this purpose; they are named @file{@var{cpu}-stub.c}. Many |
4331 | operating systems, embedded targets, emulators, and simulators already | |
4332 | have a GDB stub built into them, and maintenance of the remote | |
4333 | protocol must be careful to preserve compatibility. | |
c906108c | 4334 | |
56caf160 EZ |
4335 | The @value{GDBN} user's manual describes how to put such a stub into |
4336 | your target code. What follows is a discussion of integrating the | |
4337 | SPARC stub into a complicated operating system (rather than a simple | |
4338 | program), by Stu Grossman, the author of this stub. | |
c906108c SS |
4339 | |
4340 | The trap handling code in the stub assumes the following upon entry to | |
56caf160 | 4341 | @code{trap_low}: |
c906108c SS |
4342 | |
4343 | @enumerate | |
56caf160 EZ |
4344 | @item |
4345 | %l1 and %l2 contain pc and npc respectively at the time of the trap; | |
c906108c | 4346 | |
56caf160 EZ |
4347 | @item |
4348 | traps are disabled; | |
c906108c | 4349 | |
56caf160 EZ |
4350 | @item |
4351 | you are in the correct trap window. | |
c906108c SS |
4352 | @end enumerate |
4353 | ||
4354 | As long as your trap handler can guarantee those conditions, then there | |
56caf160 | 4355 | is no reason why you shouldn't be able to ``share'' traps with the stub. |
c906108c SS |
4356 | The stub has no requirement that it be jumped to directly from the |
4357 | hardware trap vector. That is why it calls @code{exceptionHandler()}, | |
4358 | which is provided by the external environment. For instance, this could | |
56caf160 | 4359 | set up the hardware traps to actually execute code which calls the stub |
c906108c SS |
4360 | first, and then transfers to its own trap handler. |
4361 | ||
4362 | For the most point, there probably won't be much of an issue with | |
56caf160 | 4363 | ``sharing'' traps, as the traps we use are usually not used by the kernel, |
c906108c SS |
4364 | and often indicate unrecoverable error conditions. Anyway, this is all |
4365 | controlled by a table, and is trivial to modify. The most important | |
4366 | trap for us is for @code{ta 1}. Without that, we can't single step or | |
4367 | do breakpoints. Everything else is unnecessary for the proper operation | |
4368 | of the debugger/stub. | |
4369 | ||
4370 | From reading the stub, it's probably not obvious how breakpoints work. | |
25822942 | 4371 | They are simply done by deposit/examine operations from @value{GDBN}. |
c906108c | 4372 | |
52bb452f | 4373 | @subsection ROM Monitor Interface |
c906108c | 4374 | |
52bb452f | 4375 | @subsection Custom Protocols |
c906108c | 4376 | |
52bb452f | 4377 | @subsection Transport Layer |
c906108c | 4378 | |
52bb452f | 4379 | @subsection Builtin Simulator |
c906108c SS |
4380 | |
4381 | ||
4382 | @node Native Debugging | |
4383 | ||
4384 | @chapter Native Debugging | |
56caf160 | 4385 | @cindex native debugging |
c906108c | 4386 | |
25822942 | 4387 | Several files control @value{GDBN}'s configuration for native support: |
c906108c SS |
4388 | |
4389 | @table @file | |
56caf160 | 4390 | @vindex NATDEPFILES |
c906108c | 4391 | @item gdb/config/@var{arch}/@var{xyz}.mh |
7fd60527 | 4392 | Specifies Makefile fragments needed by a @emph{native} configuration on |
c906108c SS |
4393 | machine @var{xyz}. In particular, this lists the required |
4394 | native-dependent object files, by defining @samp{NATDEPFILES=@dots{}}. | |
4395 | Also specifies the header file which describes native support on | |
4396 | @var{xyz}, by defining @samp{NAT_FILE= nm-@var{xyz}.h}. You can also | |
4397 | define @samp{NAT_CFLAGS}, @samp{NAT_ADD_FILES}, @samp{NAT_CLIBS}, | |
3d0bb823 | 4398 | @samp{NAT_CDEPS}, @samp{NAT_GENERATED_FILES}, etc.; see @file{Makefile.in}. |
c906108c | 4399 | |
7fd60527 AC |
4400 | @emph{Maintainer's note: The @file{.mh} suffix is because this file |
4401 | originally contained @file{Makefile} fragments for hosting @value{GDBN} | |
4402 | on machine @var{xyz}. While the file is no longer used for this | |
937f164b | 4403 | purpose, the @file{.mh} suffix remains. Perhaps someone will |
7fd60527 AC |
4404 | eventually rename these fragments so that they have a @file{.mn} |
4405 | suffix.} | |
4406 | ||
c906108c | 4407 | @item gdb/config/@var{arch}/nm-@var{xyz}.h |
56caf160 | 4408 | (@file{nm.h} is a link to this file, created by @code{configure}). Contains C |
c906108c SS |
4409 | macro definitions describing the native system environment, such as |
4410 | child process control and core file support. | |
4411 | ||
4412 | @item gdb/@var{xyz}-nat.c | |
4413 | Contains any miscellaneous C code required for this native support of | |
4414 | this machine. On some machines it doesn't exist at all. | |
c906108c SS |
4415 | @end table |
4416 | ||
4417 | There are some ``generic'' versions of routines that can be used by | |
4418 | various systems. These can be customized in various ways by macros | |
4419 | defined in your @file{nm-@var{xyz}.h} file. If these routines work for | |
4420 | the @var{xyz} host, you can just include the generic file's name (with | |
4421 | @samp{.o}, not @samp{.c}) in @code{NATDEPFILES}. | |
4422 | ||
4423 | Otherwise, if your machine needs custom support routines, you will need | |
4424 | to write routines that perform the same functions as the generic file. | |
56caf160 | 4425 | Put them into @file{@var{xyz}-nat.c}, and put @file{@var{xyz}-nat.o} |
c906108c SS |
4426 | into @code{NATDEPFILES}. |
4427 | ||
4428 | @table @file | |
c906108c SS |
4429 | @item inftarg.c |
4430 | This contains the @emph{target_ops vector} that supports Unix child | |
4431 | processes on systems which use ptrace and wait to control the child. | |
4432 | ||
4433 | @item procfs.c | |
4434 | This contains the @emph{target_ops vector} that supports Unix child | |
4435 | processes on systems which use /proc to control the child. | |
4436 | ||
4437 | @item fork-child.c | |
56caf160 EZ |
4438 | This does the low-level grunge that uses Unix system calls to do a ``fork |
4439 | and exec'' to start up a child process. | |
c906108c SS |
4440 | |
4441 | @item infptrace.c | |
4442 | This is the low level interface to inferior processes for systems using | |
4443 | the Unix @code{ptrace} call in a vanilla way. | |
c906108c SS |
4444 | @end table |
4445 | ||
4446 | @section Native core file Support | |
56caf160 | 4447 | @cindex native core files |
c906108c SS |
4448 | |
4449 | @table @file | |
56caf160 | 4450 | @findex fetch_core_registers |
c906108c SS |
4451 | @item core-aout.c::fetch_core_registers() |
4452 | Support for reading registers out of a core file. This routine calls | |
4453 | @code{register_addr()}, see below. Now that BFD is used to read core | |
4454 | files, virtually all machines should use @code{core-aout.c}, and should | |
4455 | just provide @code{fetch_core_registers} in @code{@var{xyz}-nat.c} (or | |
4456 | @code{REGISTER_U_ADDR} in @code{nm-@var{xyz}.h}). | |
4457 | ||
4458 | @item core-aout.c::register_addr() | |
4459 | If your @code{nm-@var{xyz}.h} file defines the macro | |
4460 | @code{REGISTER_U_ADDR(addr, blockend, regno)}, it should be defined to | |
25822942 | 4461 | set @code{addr} to the offset within the @samp{user} struct of @value{GDBN} |
c906108c SS |
4462 | register number @code{regno}. @code{blockend} is the offset within the |
4463 | ``upage'' of @code{u.u_ar0}. If @code{REGISTER_U_ADDR} is defined, | |
4464 | @file{core-aout.c} will define the @code{register_addr()} function and | |
4465 | use the macro in it. If you do not define @code{REGISTER_U_ADDR}, but | |
4466 | you are using the standard @code{fetch_core_registers()}, you will need | |
4467 | to define your own version of @code{register_addr()}, put it into your | |
4468 | @code{@var{xyz}-nat.c} file, and be sure @code{@var{xyz}-nat.o} is in | |
4469 | the @code{NATDEPFILES} list. If you have your own | |
4470 | @code{fetch_core_registers()}, you may not need a separate | |
4471 | @code{register_addr()}. Many custom @code{fetch_core_registers()} | |
4472 | implementations simply locate the registers themselves.@refill | |
c906108c SS |
4473 | @end table |
4474 | ||
25822942 | 4475 | When making @value{GDBN} run native on a new operating system, to make it |
c906108c SS |
4476 | possible to debug core files, you will need to either write specific |
4477 | code for parsing your OS's core files, or customize | |
4478 | @file{bfd/trad-core.c}. First, use whatever @code{#include} files your | |
4479 | machine uses to define the struct of registers that is accessible | |
4480 | (possibly in the u-area) in a core file (rather than | |
4481 | @file{machine/reg.h}), and an include file that defines whatever header | |
c1468174 | 4482 | exists on a core file (e.g., the u-area or a @code{struct core}). Then |
56caf160 | 4483 | modify @code{trad_unix_core_file_p} to use these values to set up the |
c906108c SS |
4484 | section information for the data segment, stack segment, any other |
4485 | segments in the core file (perhaps shared library contents or control | |
4486 | information), ``registers'' segment, and if there are two discontiguous | |
c1468174 | 4487 | sets of registers (e.g., integer and float), the ``reg2'' segment. This |
c906108c SS |
4488 | section information basically delimits areas in the core file in a |
4489 | standard way, which the section-reading routines in BFD know how to seek | |
4490 | around in. | |
4491 | ||
25822942 | 4492 | Then back in @value{GDBN}, you need a matching routine called |
56caf160 | 4493 | @code{fetch_core_registers}. If you can use the generic one, it's in |
c906108c SS |
4494 | @file{core-aout.c}; if not, it's in your @file{@var{xyz}-nat.c} file. |
4495 | It will be passed a char pointer to the entire ``registers'' segment, | |
4496 | its length, and a zero; or a char pointer to the entire ``regs2'' | |
4497 | segment, its length, and a 2. The routine should suck out the supplied | |
25822942 | 4498 | register values and install them into @value{GDBN}'s ``registers'' array. |
c906108c SS |
4499 | |
4500 | If your system uses @file{/proc} to control processes, and uses ELF | |
4501 | format core files, then you may be able to use the same routines for | |
4502 | reading the registers out of processes and out of core files. | |
4503 | ||
4504 | @section ptrace | |
4505 | ||
4506 | @section /proc | |
4507 | ||
4508 | @section win32 | |
4509 | ||
4510 | @section shared libraries | |
4511 | ||
4512 | @section Native Conditionals | |
56caf160 | 4513 | @cindex native conditionals |
c906108c | 4514 | |
56caf160 EZ |
4515 | When @value{GDBN} is configured and compiled, various macros are |
4516 | defined or left undefined, to control compilation when the host and | |
4517 | target systems are the same. These macros should be defined (or left | |
4518 | undefined) in @file{nm-@var{system}.h}. | |
c906108c | 4519 | |
1f6d4158 AC |
4520 | @table @code |
4521 | ||
c906108c | 4522 | @item CHILD_PREPARE_TO_STORE |
56caf160 | 4523 | @findex CHILD_PREPARE_TO_STORE |
c906108c SS |
4524 | If the machine stores all registers at once in the child process, then |
4525 | define this to ensure that all values are correct. This usually entails | |
4526 | a read from the child. | |
4527 | ||
4528 | [Note that this is incorrectly defined in @file{xm-@var{system}.h} files | |
4529 | currently.] | |
4530 | ||
4531 | @item FETCH_INFERIOR_REGISTERS | |
56caf160 | 4532 | @findex FETCH_INFERIOR_REGISTERS |
c906108c SS |
4533 | Define this if the native-dependent code will provide its own routines |
4534 | @code{fetch_inferior_registers} and @code{store_inferior_registers} in | |
56caf160 | 4535 | @file{@var{host}-nat.c}. If this symbol is @emph{not} defined, and |
c906108c SS |
4536 | @file{infptrace.c} is included in this configuration, the default |
4537 | routines in @file{infptrace.c} are used for these functions. | |
4538 | ||
4a9bb1df UW |
4539 | @item int gdbarch_fp0_regnum (@var{gdbarch}) |
4540 | @findex gdbarch_fp0_regnum | |
4541 | This functions normally returns the number of the first floating | |
c906108c | 4542 | point register, if the machine has such registers. As such, it would |
56caf160 | 4543 | appear only in target-specific code. However, @file{/proc} support uses this |
c906108c SS |
4544 | to decide whether floats are in use on this target. |
4545 | ||
4a9bb1df UW |
4546 | @item int gdbarch_get_longjmp_target (@var{gdbarch}) |
4547 | @findex gdbarch_get_longjmp_target | |
4a9bb1df | 4548 | This function determines the target PC address that @code{longjmp} will jump to, |
c906108c | 4549 | assuming that we have just stopped at a longjmp breakpoint. It takes a |
56caf160 | 4550 | @code{CORE_ADDR *} as argument, and stores the target PC value through this |
c906108c SS |
4551 | pointer. It examines the current state of the machine as needed. |
4552 | ||
9742079a EZ |
4553 | @item I386_USE_GENERIC_WATCHPOINTS |
4554 | An x86-based machine can define this to use the generic x86 watchpoint | |
4555 | support; see @ref{Algorithms, I386_USE_GENERIC_WATCHPOINTS}. | |
4556 | ||
c906108c | 4557 | @item ONE_PROCESS_WRITETEXT |
56caf160 | 4558 | @findex ONE_PROCESS_WRITETEXT |
c906108c SS |
4559 | Define this to be able to, when a breakpoint insertion fails, warn the |
4560 | user that another process may be running with the same executable. | |
4561 | ||
4562 | @item PROC_NAME_FMT | |
56caf160 | 4563 | @findex PROC_NAME_FMT |
c906108c SS |
4564 | Defines the format for the name of a @file{/proc} device. Should be |
4565 | defined in @file{nm.h} @emph{only} in order to override the default | |
4566 | definition in @file{procfs.c}. | |
4567 | ||
990f9fe3 | 4568 | @item SOLIB_ADD (@var{filename}, @var{from_tty}, @var{targ}, @var{readsyms}) |
56caf160 | 4569 | @findex SOLIB_ADD |
c906108c | 4570 | Define this to expand into an expression that will cause the symbols in |
990f9fe3 FF |
4571 | @var{filename} to be added to @value{GDBN}'s symbol table. If |
4572 | @var{readsyms} is zero symbols are not read but any necessary low level | |
4573 | processing for @var{filename} is still done. | |
c906108c SS |
4574 | |
4575 | @item SOLIB_CREATE_INFERIOR_HOOK | |
56caf160 | 4576 | @findex SOLIB_CREATE_INFERIOR_HOOK |
c906108c SS |
4577 | Define this to expand into any shared-library-relocation code that you |
4578 | want to be run just after the child process has been forked. | |
4579 | ||
4580 | @item START_INFERIOR_TRAPS_EXPECTED | |
56caf160 EZ |
4581 | @findex START_INFERIOR_TRAPS_EXPECTED |
4582 | When starting an inferior, @value{GDBN} normally expects to trap | |
4583 | twice; once when | |
c906108c SS |
4584 | the shell execs, and once when the program itself execs. If the actual |
4585 | number of traps is something other than 2, then define this macro to | |
4586 | expand into the number expected. | |
4587 | ||
c906108c SS |
4588 | @end table |
4589 | ||
c906108c SS |
4590 | @node Support Libraries |
4591 | ||
4592 | @chapter Support Libraries | |
4593 | ||
4594 | @section BFD | |
56caf160 | 4595 | @cindex BFD library |
c906108c | 4596 | |
25822942 | 4597 | BFD provides support for @value{GDBN} in several ways: |
c906108c SS |
4598 | |
4599 | @table @emph | |
c906108c SS |
4600 | @item identifying executable and core files |
4601 | BFD will identify a variety of file types, including a.out, coff, and | |
4602 | several variants thereof, as well as several kinds of core files. | |
4603 | ||
4604 | @item access to sections of files | |
4605 | BFD parses the file headers to determine the names, virtual addresses, | |
4606 | sizes, and file locations of all the various named sections in files | |
56caf160 EZ |
4607 | (such as the text section or the data section). @value{GDBN} simply |
4608 | calls BFD to read or write section @var{x} at byte offset @var{y} for | |
4609 | length @var{z}. | |
c906108c SS |
4610 | |
4611 | @item specialized core file support | |
4612 | BFD provides routines to determine the failing command name stored in a | |
4613 | core file, the signal with which the program failed, and whether a core | |
56caf160 | 4614 | file matches (i.e.@: could be a core dump of) a particular executable |
c906108c SS |
4615 | file. |
4616 | ||
4617 | @item locating the symbol information | |
25822942 DB |
4618 | @value{GDBN} uses an internal interface of BFD to determine where to find the |
4619 | symbol information in an executable file or symbol-file. @value{GDBN} itself | |
c906108c | 4620 | handles the reading of symbols, since BFD does not ``understand'' debug |
25822942 | 4621 | symbols, but @value{GDBN} uses BFD's cached information to find the symbols, |
c906108c | 4622 | string table, etc. |
c906108c SS |
4623 | @end table |
4624 | ||
4625 | @section opcodes | |
56caf160 | 4626 | @cindex opcodes library |
c906108c | 4627 | |
25822942 | 4628 | The opcodes library provides @value{GDBN}'s disassembler. (It's a separate |
c906108c SS |
4629 | library because it's also used in binutils, for @file{objdump}). |
4630 | ||
4631 | @section readline | |
86f04699 EZ |
4632 | @cindex readline library |
4633 | The @code{readline} library provides a set of functions for use by applications | |
4634 | that allow users to edit command lines as they are typed in. | |
c906108c SS |
4635 | |
4636 | @section libiberty | |
1eb288ea EZ |
4637 | @cindex @code{libiberty} library |
4638 | ||
4639 | The @code{libiberty} library provides a set of functions and features | |
4640 | that integrate and improve on functionality found in modern operating | |
4641 | systems. Broadly speaking, such features can be divided into three | |
4642 | groups: supplemental functions (functions that may be missing in some | |
4643 | environments and operating systems), replacement functions (providing | |
4644 | a uniform and easier to use interface for commonly used standard | |
4645 | functions), and extensions (which provide additional functionality | |
4646 | beyond standard functions). | |
4647 | ||
4648 | @value{GDBN} uses various features provided by the @code{libiberty} | |
4649 | library, for instance the C@t{++} demangler, the @acronym{IEEE} | |
4650 | floating format support functions, the input options parser | |
4651 | @samp{getopt}, the @samp{obstack} extension, and other functions. | |
4652 | ||
4653 | @subsection @code{obstacks} in @value{GDBN} | |
4654 | @cindex @code{obstacks} | |
4655 | ||
4656 | The obstack mechanism provides a convenient way to allocate and free | |
4657 | chunks of memory. Each obstack is a pool of memory that is managed | |
4658 | like a stack. Objects (of any nature, size and alignment) are | |
4659 | allocated and freed in a @acronym{LIFO} fashion on an obstack (see | |
d3e8051b | 4660 | @code{libiberty}'s documentation for a more detailed explanation of |
1eb288ea EZ |
4661 | @code{obstacks}). |
4662 | ||
4663 | The most noticeable use of the @code{obstacks} in @value{GDBN} is in | |
4664 | object files. There is an obstack associated with each internal | |
4665 | representation of an object file. Lots of things get allocated on | |
4666 | these @code{obstacks}: dictionary entries, blocks, blockvectors, | |
4667 | symbols, minimal symbols, types, vectors of fundamental types, class | |
4668 | fields of types, object files section lists, object files section | |
d3e8051b | 4669 | offset lists, line tables, symbol tables, partial symbol tables, |
1eb288ea EZ |
4670 | string tables, symbol table private data, macros tables, debug |
4671 | information sections and entries, import and export lists (som), | |
4672 | unwind information (hppa), dwarf2 location expressions data. Plus | |
4673 | various strings such as directory names strings, debug format strings, | |
4674 | names of types. | |
4675 | ||
4676 | An essential and convenient property of all data on @code{obstacks} is | |
4677 | that memory for it gets allocated (with @code{obstack_alloc}) at | |
d3e8051b | 4678 | various times during a debugging session, but it is released all at |
1eb288ea EZ |
4679 | once using the @code{obstack_free} function. The @code{obstack_free} |
4680 | function takes a pointer to where in the stack it must start the | |
4681 | deletion from (much like the cleanup chains have a pointer to where to | |
4682 | start the cleanups). Because of the stack like structure of the | |
4683 | @code{obstacks}, this allows to free only a top portion of the | |
4684 | obstack. There are a few instances in @value{GDBN} where such thing | |
4685 | happens. Calls to @code{obstack_free} are done after some local data | |
4686 | is allocated to the obstack. Only the local data is deleted from the | |
4687 | obstack. Of course this assumes that nothing between the | |
4688 | @code{obstack_alloc} and the @code{obstack_free} allocates anything | |
4689 | else on the same obstack. For this reason it is best and safest to | |
4690 | use temporary @code{obstacks}. | |
4691 | ||
4692 | Releasing the whole obstack is also not safe per se. It is safe only | |
4693 | under the condition that we know the @code{obstacks} memory is no | |
4694 | longer needed. In @value{GDBN} we get rid of the @code{obstacks} only | |
4695 | when we get rid of the whole objfile(s), for instance upon reading a | |
4696 | new symbol file. | |
c906108c SS |
4697 | |
4698 | @section gnu-regex | |
56caf160 | 4699 | @cindex regular expressions library |
c906108c SS |
4700 | |
4701 | Regex conditionals. | |
4702 | ||
4703 | @table @code | |
c906108c SS |
4704 | @item C_ALLOCA |
4705 | ||
4706 | @item NFAILURES | |
4707 | ||
4708 | @item RE_NREGS | |
4709 | ||
4710 | @item SIGN_EXTEND_CHAR | |
4711 | ||
4712 | @item SWITCH_ENUM_BUG | |
4713 | ||
4714 | @item SYNTAX_TABLE | |
4715 | ||
4716 | @item Sword | |
4717 | ||
4718 | @item sparc | |
c906108c SS |
4719 | @end table |
4720 | ||
350da6ee DJ |
4721 | @section Array Containers |
4722 | @cindex Array Containers | |
4723 | @cindex VEC | |
4724 | ||
4725 | Often it is necessary to manipulate a dynamic array of a set of | |
4726 | objects. C forces some bookkeeping on this, which can get cumbersome | |
d3e8051b | 4727 | and repetitive. The @file{vec.h} file contains macros for defining |
350da6ee DJ |
4728 | and using a typesafe vector type. The functions defined will be |
4729 | inlined when compiling, and so the abstraction cost should be zero. | |
4730 | Domain checks are added to detect programming errors. | |
4731 | ||
4732 | An example use would be an array of symbols or section information. | |
4733 | The array can be grown as symbols are read in (or preallocated), and | |
4734 | the accessor macros provided keep care of all the necessary | |
4735 | bookkeeping. Because the arrays are type safe, there is no danger of | |
4736 | accidentally mixing up the contents. Think of these as C++ templates, | |
4737 | but implemented in C. | |
4738 | ||
4739 | Because of the different behavior of structure objects, scalar objects | |
4740 | and of pointers, there are three flavors of vector, one for each of | |
4741 | these variants. Both the structure object and pointer variants pass | |
4742 | pointers to objects around --- in the former case the pointers are | |
4743 | stored into the vector and in the latter case the pointers are | |
4744 | dereferenced and the objects copied into the vector. The scalar | |
4745 | object variant is suitable for @code{int}-like objects, and the vector | |
4746 | elements are returned by value. | |
4747 | ||
4748 | There are both @code{index} and @code{iterate} accessors. The iterator | |
4749 | returns a boolean iteration condition and updates the iteration | |
4750 | variable passed by reference. Because the iterator will be inlined, | |
4751 | the address-of can be optimized away. | |
4752 | ||
4753 | The vectors are implemented using the trailing array idiom, thus they | |
4754 | are not resizeable without changing the address of the vector object | |
4755 | itself. This means you cannot have variables or fields of vector type | |
4756 | --- always use a pointer to a vector. The one exception is the final | |
4757 | field of a structure, which could be a vector type. You will have to | |
4758 | use the @code{embedded_size} & @code{embedded_init} calls to create | |
4759 | such objects, and they will probably not be resizeable (so don't use | |
4760 | the @dfn{safe} allocation variants). The trailing array idiom is used | |
4761 | (rather than a pointer to an array of data), because, if we allow | |
4762 | @code{NULL} to also represent an empty vector, empty vectors occupy | |
4763 | minimal space in the structure containing them. | |
4764 | ||
4765 | Each operation that increases the number of active elements is | |
4766 | available in @dfn{quick} and @dfn{safe} variants. The former presumes | |
4767 | that there is sufficient allocated space for the operation to succeed | |
4768 | (it dies if there is not). The latter will reallocate the vector, if | |
4769 | needed. Reallocation causes an exponential increase in vector size. | |
4770 | If you know you will be adding N elements, it would be more efficient | |
4771 | to use the reserve operation before adding the elements with the | |
4772 | @dfn{quick} operation. This will ensure there are at least as many | |
4773 | elements as you ask for, it will exponentially increase if there are | |
4774 | too few spare slots. If you want reserve a specific number of slots, | |
4775 | but do not want the exponential increase (for instance, you know this | |
4776 | is the last allocation), use a negative number for reservation. You | |
4777 | can also create a vector of a specific size from the get go. | |
4778 | ||
4779 | You should prefer the push and pop operations, as they append and | |
4780 | remove from the end of the vector. If you need to remove several items | |
4781 | in one go, use the truncate operation. The insert and remove | |
4782 | operations allow you to change elements in the middle of the vector. | |
4783 | There are two remove operations, one which preserves the element | |
4784 | ordering @code{ordered_remove}, and one which does not | |
4785 | @code{unordered_remove}. The latter function copies the end element | |
4786 | into the removed slot, rather than invoke a memmove operation. The | |
4787 | @code{lower_bound} function will determine where to place an item in | |
4788 | the array using insert that will maintain sorted order. | |
4789 | ||
4790 | If you need to directly manipulate a vector, then the @code{address} | |
4791 | accessor will return the address of the start of the vector. Also the | |
4792 | @code{space} predicate will tell you whether there is spare capacity in the | |
4793 | vector. You will not normally need to use these two functions. | |
4794 | ||
4795 | Vector types are defined using a | |
4796 | @code{DEF_VEC_@{O,P,I@}(@var{typename})} macro. Variables of vector | |
4797 | type are declared using a @code{VEC(@var{typename})} macro. The | |
4798 | characters @code{O}, @code{P} and @code{I} indicate whether | |
4799 | @var{typename} is an object (@code{O}), pointer (@code{P}) or integral | |
4800 | (@code{I}) type. Be careful to pick the correct one, as you'll get an | |
4801 | awkward and inefficient API if you use the wrong one. There is a | |
4802 | check, which results in a compile-time warning, for the @code{P} and | |
4803 | @code{I} versions, but there is no check for the @code{O} versions, as | |
4804 | that is not possible in plain C. | |
4805 | ||
4806 | An example of their use would be, | |
4807 | ||
4808 | @smallexample | |
4809 | DEF_VEC_P(tree); // non-managed tree vector. | |
4810 | ||
4811 | struct my_struct @{ | |
4812 | VEC(tree) *v; // A (pointer to) a vector of tree pointers. | |
4813 | @}; | |
4814 | ||
4815 | struct my_struct *s; | |
4816 | ||
4817 | if (VEC_length(tree, s->v)) @{ we have some contents @} | |
4818 | VEC_safe_push(tree, s->v, decl); // append some decl onto the end | |
4819 | for (ix = 0; VEC_iterate(tree, s->v, ix, elt); ix++) | |
4820 | @{ do something with elt @} | |
4821 | ||
4822 | @end smallexample | |
4823 | ||
4824 | The @file{vec.h} file provides details on how to invoke the various | |
4825 | accessors provided. They are enumerated here: | |
4826 | ||
4827 | @table @code | |
4828 | @item VEC_length | |
4829 | Return the number of items in the array, | |
4830 | ||
4831 | @item VEC_empty | |
4832 | Return true if the array has no elements. | |
4833 | ||
4834 | @item VEC_last | |
4835 | @itemx VEC_index | |
4836 | Return the last or arbitrary item in the array. | |
4837 | ||
4838 | @item VEC_iterate | |
4839 | Access an array element and indicate whether the array has been | |
4840 | traversed. | |
4841 | ||
4842 | @item VEC_alloc | |
4843 | @itemx VEC_free | |
4844 | Create and destroy an array. | |
4845 | ||
4846 | @item VEC_embedded_size | |
4847 | @itemx VEC_embedded_init | |
4848 | Helpers for embedding an array as the final element of another struct. | |
4849 | ||
4850 | @item VEC_copy | |
4851 | Duplicate an array. | |
4852 | ||
4853 | @item VEC_space | |
4854 | Return the amount of free space in an array. | |
4855 | ||
4856 | @item VEC_reserve | |
4857 | Ensure a certain amount of free space. | |
4858 | ||
4859 | @item VEC_quick_push | |
4860 | @itemx VEC_safe_push | |
4861 | Append to an array, either assuming the space is available, or making | |
4862 | sure that it is. | |
4863 | ||
4864 | @item VEC_pop | |
4865 | Remove the last item from an array. | |
4866 | ||
4867 | @item VEC_truncate | |
4868 | Remove several items from the end of an array. | |
4869 | ||
4870 | @item VEC_safe_grow | |
4871 | Add several items to the end of an array. | |
4872 | ||
4873 | @item VEC_replace | |
4874 | Overwrite an item in the array. | |
4875 | ||
4876 | @item VEC_quick_insert | |
4877 | @itemx VEC_safe_insert | |
4878 | Insert an item into the middle of the array. Either the space must | |
4879 | already exist, or the space is created. | |
4880 | ||
4881 | @item VEC_ordered_remove | |
4882 | @itemx VEC_unordered_remove | |
4883 | Remove an item from the array, preserving order or not. | |
4884 | ||
4885 | @item VEC_block_remove | |
4886 | Remove a set of items from the array. | |
4887 | ||
4888 | @item VEC_address | |
4889 | Provide the address of the first element. | |
4890 | ||
4891 | @item VEC_lower_bound | |
4892 | Binary search the array. | |
4893 | ||
4894 | @end table | |
4895 | ||
c906108c SS |
4896 | @section include |
4897 | ||
4898 | @node Coding | |
4899 | ||
4900 | @chapter Coding | |
4901 | ||
4902 | This chapter covers topics that are lower-level than the major | |
25822942 | 4903 | algorithms of @value{GDBN}. |
c906108c SS |
4904 | |
4905 | @section Cleanups | |
56caf160 | 4906 | @cindex cleanups |
c906108c SS |
4907 | |
4908 | Cleanups are a structured way to deal with things that need to be done | |
cc1cb004 | 4909 | later. |
c906108c | 4910 | |
cc1cb004 AC |
4911 | When your code does something (e.g., @code{xmalloc} some memory, or |
4912 | @code{open} a file) that needs to be undone later (e.g., @code{xfree} | |
4913 | the memory or @code{close} the file), it can make a cleanup. The | |
4914 | cleanup will be done at some future point: when the command is finished | |
4915 | and control returns to the top level; when an error occurs and the stack | |
4916 | is unwound; or when your code decides it's time to explicitly perform | |
4917 | cleanups. Alternatively you can elect to discard the cleanups you | |
4918 | created. | |
c906108c SS |
4919 | |
4920 | Syntax: | |
4921 | ||
4922 | @table @code | |
c906108c SS |
4923 | @item struct cleanup *@var{old_chain}; |
4924 | Declare a variable which will hold a cleanup chain handle. | |
4925 | ||
56caf160 | 4926 | @findex make_cleanup |
c906108c SS |
4927 | @item @var{old_chain} = make_cleanup (@var{function}, @var{arg}); |
4928 | Make a cleanup which will cause @var{function} to be called with | |
4929 | @var{arg} (a @code{char *}) later. The result, @var{old_chain}, is a | |
cc1cb004 AC |
4930 | handle that can later be passed to @code{do_cleanups} or |
4931 | @code{discard_cleanups}. Unless you are going to call | |
4932 | @code{do_cleanups} or @code{discard_cleanups}, you can ignore the result | |
4933 | from @code{make_cleanup}. | |
c906108c | 4934 | |
56caf160 | 4935 | @findex do_cleanups |
c906108c | 4936 | @item do_cleanups (@var{old_chain}); |
cc1cb004 AC |
4937 | Do all cleanups added to the chain since the corresponding |
4938 | @code{make_cleanup} call was made. | |
4939 | ||
4940 | @findex discard_cleanups | |
4941 | @item discard_cleanups (@var{old_chain}); | |
4942 | Same as @code{do_cleanups} except that it just removes the cleanups from | |
4943 | the chain and does not call the specified functions. | |
4944 | @end table | |
4945 | ||
4946 | Cleanups are implemented as a chain. The handle returned by | |
4947 | @code{make_cleanups} includes the cleanup passed to the call and any | |
4948 | later cleanups appended to the chain (but not yet discarded or | |
4949 | performed). E.g.: | |
56caf160 | 4950 | |
474c8240 | 4951 | @smallexample |
c906108c | 4952 | make_cleanup (a, 0); |
cc1cb004 AC |
4953 | @{ |
4954 | struct cleanup *old = make_cleanup (b, 0); | |
4955 | make_cleanup (c, 0) | |
4956 | ... | |
4957 | do_cleanups (old); | |
4958 | @} | |
474c8240 | 4959 | @end smallexample |
56caf160 | 4960 | |
c906108c | 4961 | @noindent |
cc1cb004 AC |
4962 | will call @code{c()} and @code{b()} but will not call @code{a()}. The |
4963 | cleanup that calls @code{a()} will remain in the cleanup chain, and will | |
4964 | be done later unless otherwise discarded.@refill | |
4965 | ||
4966 | Your function should explicitly do or discard the cleanups it creates. | |
4967 | Failing to do this leads to non-deterministic behavior since the caller | |
4968 | will arbitrarily do or discard your functions cleanups. This need leads | |
4969 | to two common cleanup styles. | |
4970 | ||
4971 | The first style is try/finally. Before it exits, your code-block calls | |
4972 | @code{do_cleanups} with the old cleanup chain and thus ensures that your | |
4973 | code-block's cleanups are always performed. For instance, the following | |
4974 | code-segment avoids a memory leak problem (even when @code{error} is | |
4975 | called and a forced stack unwind occurs) by ensuring that the | |
4976 | @code{xfree} will always be called: | |
c906108c | 4977 | |
474c8240 | 4978 | @smallexample |
cc1cb004 AC |
4979 | struct cleanup *old = make_cleanup (null_cleanup, 0); |
4980 | data = xmalloc (sizeof blah); | |
4981 | make_cleanup (xfree, data); | |
4982 | ... blah blah ... | |
4983 | do_cleanups (old); | |
474c8240 | 4984 | @end smallexample |
cc1cb004 AC |
4985 | |
4986 | The second style is try/except. Before it exits, your code-block calls | |
4987 | @code{discard_cleanups} with the old cleanup chain and thus ensures that | |
4988 | any created cleanups are not performed. For instance, the following | |
4989 | code segment, ensures that the file will be closed but only if there is | |
4990 | an error: | |
4991 | ||
474c8240 | 4992 | @smallexample |
cc1cb004 AC |
4993 | FILE *file = fopen ("afile", "r"); |
4994 | struct cleanup *old = make_cleanup (close_file, file); | |
4995 | ... blah blah ... | |
4996 | discard_cleanups (old); | |
4997 | return file; | |
474c8240 | 4998 | @end smallexample |
c906108c | 4999 | |
c1468174 | 5000 | Some functions, e.g., @code{fputs_filtered()} or @code{error()}, specify |
c906108c SS |
5001 | that they ``should not be called when cleanups are not in place''. This |
5002 | means that any actions you need to reverse in the case of an error or | |
5003 | interruption must be on the cleanup chain before you call these | |
5004 | functions, since they might never return to your code (they | |
5005 | @samp{longjmp} instead). | |
5006 | ||
ba8c9337 AC |
5007 | @section Per-architecture module data |
5008 | @cindex per-architecture module data | |
5009 | @cindex multi-arch data | |
5010 | @cindex data-pointer, per-architecture/per-module | |
5011 | ||
fc989b7a AC |
5012 | The multi-arch framework includes a mechanism for adding module |
5013 | specific per-architecture data-pointers to the @code{struct gdbarch} | |
5014 | architecture object. | |
5015 | ||
5016 | A module registers one or more per-architecture data-pointers using: | |
5017 | ||
5018 | @deftypefun struct gdbarch_data *gdbarch_data_register_pre_init (gdbarch_data_pre_init_ftype *@var{pre_init}) | |
5019 | @var{pre_init} is used to, on-demand, allocate an initial value for a | |
5020 | per-architecture data-pointer using the architecture's obstack (passed | |
5021 | in as a parameter). Since @var{pre_init} can be called during | |
5022 | architecture creation, it is not parameterized with the architecture. | |
5023 | and must not call modules that use per-architecture data. | |
5024 | @end deftypefun | |
ba8c9337 | 5025 | |
fc989b7a AC |
5026 | @deftypefun struct gdbarch_data *gdbarch_data_register_post_init (gdbarch_data_post_init_ftype *@var{post_init}) |
5027 | @var{post_init} is used to obtain an initial value for a | |
5028 | per-architecture data-pointer @emph{after}. Since @var{post_init} is | |
5029 | always called after architecture creation, it both receives the fully | |
5030 | initialized architecture and is free to call modules that use | |
5031 | per-architecture data (care needs to be taken to ensure that those | |
5032 | other modules do not try to call back to this module as that will | |
5033 | create in cycles in the initialization call graph). | |
5034 | @end deftypefun | |
ba8c9337 | 5035 | |
fc989b7a AC |
5036 | These functions return a @code{struct gdbarch_data} that is used to |
5037 | identify the per-architecture data-pointer added for that module. | |
ba8c9337 | 5038 | |
fc989b7a | 5039 | The per-architecture data-pointer is accessed using the function: |
ba8c9337 | 5040 | |
fc989b7a AC |
5041 | @deftypefun void *gdbarch_data (struct gdbarch *@var{gdbarch}, struct gdbarch_data *@var{data_handle}) |
5042 | Given the architecture @var{arch} and module data handle | |
5043 | @var{data_handle} (returned by @code{gdbarch_data_register_pre_init} | |
5044 | or @code{gdbarch_data_register_post_init}), this function returns the | |
5045 | current value of the per-architecture data-pointer. If the data | |
5046 | pointer is @code{NULL}, it is first initialized by calling the | |
5047 | corresponding @var{pre_init} or @var{post_init} method. | |
ba8c9337 AC |
5048 | @end deftypefun |
5049 | ||
fc989b7a | 5050 | The examples below assume the following definitions: |
ba8c9337 AC |
5051 | |
5052 | @smallexample | |
e7f16015 | 5053 | struct nozel @{ int total; @}; |
ba8c9337 | 5054 | static struct gdbarch_data *nozel_handle; |
ba8c9337 AC |
5055 | @end smallexample |
5056 | ||
fc989b7a AC |
5057 | A module can extend the architecture vector, adding additional |
5058 | per-architecture data, using the @var{pre_init} method. The module's | |
5059 | per-architecture data is then initialized during architecture | |
5060 | creation. | |
ba8c9337 | 5061 | |
fc989b7a AC |
5062 | In the below, the module's per-architecture @emph{nozel} is added. An |
5063 | architecture can specify its nozel by calling @code{set_gdbarch_nozel} | |
5064 | from @code{gdbarch_init}. | |
ba8c9337 AC |
5065 | |
5066 | @smallexample | |
fc989b7a AC |
5067 | static void * |
5068 | nozel_pre_init (struct obstack *obstack) | |
ba8c9337 | 5069 | @{ |
fc989b7a AC |
5070 | struct nozel *data = OBSTACK_ZALLOC (obstack, struct nozel); |
5071 | return data; | |
5072 | @} | |
ba8c9337 AC |
5073 | @end smallexample |
5074 | ||
ba8c9337 | 5075 | @smallexample |
fc989b7a AC |
5076 | extern void |
5077 | set_gdbarch_nozel (struct gdbarch *gdbarch, int total) | |
ba8c9337 | 5078 | @{ |
ba8c9337 | 5079 | struct nozel *data = gdbarch_data (gdbarch, nozel_handle); |
fc989b7a | 5080 | data->total = nozel; |
ba8c9337 AC |
5081 | @} |
5082 | @end smallexample | |
5083 | ||
fc989b7a AC |
5084 | A module can on-demand create architecture dependant data structures |
5085 | using @code{post_init}. | |
ba8c9337 | 5086 | |
fc989b7a AC |
5087 | In the below, the nozel's total is computed on-demand by |
5088 | @code{nozel_post_init} using information obtained from the | |
5089 | architecture. | |
ba8c9337 AC |
5090 | |
5091 | @smallexample | |
fc989b7a AC |
5092 | static void * |
5093 | nozel_post_init (struct gdbarch *gdbarch) | |
ba8c9337 | 5094 | @{ |
fc989b7a AC |
5095 | struct nozel *data = GDBARCH_OBSTACK_ZALLOC (gdbarch, struct nozel); |
5096 | nozel->total = gdbarch@dots{} (gdbarch); | |
5097 | return data; | |
ba8c9337 AC |
5098 | @} |
5099 | @end smallexample | |
5100 | ||
5101 | @smallexample | |
fc989b7a AC |
5102 | extern int |
5103 | nozel_total (struct gdbarch *gdbarch) | |
ba8c9337 | 5104 | @{ |
fc989b7a AC |
5105 | struct nozel *data = gdbarch_data (gdbarch, nozel_handle); |
5106 | return data->total; | |
ba8c9337 AC |
5107 | @} |
5108 | @end smallexample | |
5109 | ||
c906108c | 5110 | @section Wrapping Output Lines |
56caf160 | 5111 | @cindex line wrap in output |
c906108c | 5112 | |
56caf160 | 5113 | @findex wrap_here |
c906108c SS |
5114 | Output that goes through @code{printf_filtered} or @code{fputs_filtered} |
5115 | or @code{fputs_demangled} needs only to have calls to @code{wrap_here} | |
5116 | added in places that would be good breaking points. The utility | |
5117 | routines will take care of actually wrapping if the line width is | |
5118 | exceeded. | |
5119 | ||
5120 | The argument to @code{wrap_here} is an indentation string which is | |
5121 | printed @emph{only} if the line breaks there. This argument is saved | |
5122 | away and used later. It must remain valid until the next call to | |
5123 | @code{wrap_here} or until a newline has been printed through the | |
5124 | @code{*_filtered} functions. Don't pass in a local variable and then | |
5125 | return! | |
5126 | ||
56caf160 | 5127 | It is usually best to call @code{wrap_here} after printing a comma or |
c906108c SS |
5128 | space. If you call it before printing a space, make sure that your |
5129 | indentation properly accounts for the leading space that will print if | |
5130 | the line wraps there. | |
5131 | ||
5132 | Any function or set of functions that produce filtered output must | |
5133 | finish by printing a newline, to flush the wrap buffer, before switching | |
56caf160 | 5134 | to unfiltered (@code{printf}) output. Symbol reading routines that |
c906108c SS |
5135 | print warnings are a good example. |
5136 | ||
25822942 | 5137 | @section @value{GDBN} Coding Standards |
56caf160 | 5138 | @cindex coding standards |
c906108c | 5139 | |
25822942 | 5140 | @value{GDBN} follows the GNU coding standards, as described in |
c906108c | 5141 | @file{etc/standards.texi}. This file is also available for anonymous |
af6c57ea AC |
5142 | FTP from GNU archive sites. @value{GDBN} takes a strict interpretation |
5143 | of the standard; in general, when the GNU standard recommends a practice | |
5144 | but does not require it, @value{GDBN} requires it. | |
c906108c | 5145 | |
56caf160 EZ |
5146 | @value{GDBN} follows an additional set of coding standards specific to |
5147 | @value{GDBN}, as described in the following sections. | |
c906108c | 5148 | |
af6c57ea | 5149 | |
b9aa90c9 | 5150 | @subsection ISO C |
af6c57ea | 5151 | |
b9aa90c9 AC |
5152 | @value{GDBN} assumes an ISO/IEC 9899:1990 (a.k.a.@: ISO C90) compliant |
5153 | compiler. | |
af6c57ea | 5154 | |
b9aa90c9 | 5155 | @value{GDBN} does not assume an ISO C or POSIX compliant C library. |
af6c57ea AC |
5156 | |
5157 | ||
5158 | @subsection Memory Management | |
5159 | ||
5160 | @value{GDBN} does not use the functions @code{malloc}, @code{realloc}, | |
5161 | @code{calloc}, @code{free} and @code{asprintf}. | |
5162 | ||
5163 | @value{GDBN} uses the functions @code{xmalloc}, @code{xrealloc} and | |
5164 | @code{xcalloc} when allocating memory. Unlike @code{malloc} et.al.@: | |
5165 | these functions do not return when the memory pool is empty. Instead, | |
5166 | they unwind the stack using cleanups. These functions return | |
5167 | @code{NULL} when requested to allocate a chunk of memory of size zero. | |
5168 | ||
5169 | @emph{Pragmatics: By using these functions, the need to check every | |
5170 | memory allocation is removed. These functions provide portable | |
5171 | behavior.} | |
5172 | ||
5173 | @value{GDBN} does not use the function @code{free}. | |
5174 | ||
5175 | @value{GDBN} uses the function @code{xfree} to return memory to the | |
5176 | memory pool. Consistent with ISO-C, this function ignores a request to | |
5177 | free a @code{NULL} pointer. | |
5178 | ||
5179 | @emph{Pragmatics: On some systems @code{free} fails when passed a | |
5180 | @code{NULL} pointer.} | |
5181 | ||
5182 | @value{GDBN} can use the non-portable function @code{alloca} for the | |
5183 | allocation of small temporary values (such as strings). | |
5184 | ||
5185 | @emph{Pragmatics: This function is very non-portable. Some systems | |
5186 | restrict the memory being allocated to no more than a few kilobytes.} | |
5187 | ||
5188 | @value{GDBN} uses the string function @code{xstrdup} and the print | |
b435e160 | 5189 | function @code{xstrprintf}. |
af6c57ea AC |
5190 | |
5191 | @emph{Pragmatics: @code{asprintf} and @code{strdup} can fail. Print | |
5192 | functions such as @code{sprintf} are very prone to buffer overflow | |
5193 | errors.} | |
5194 | ||
5195 | ||
5196 | @subsection Compiler Warnings | |
56caf160 | 5197 | @cindex compiler warnings |
af6c57ea | 5198 | |
aa79a185 DJ |
5199 | With few exceptions, developers should avoid the configuration option |
5200 | @samp{--disable-werror} when building @value{GDBN}. The exceptions | |
5201 | are listed in the file @file{gdb/MAINTAINERS}. The default, when | |
5202 | building with @sc{gcc}, is @samp{--enable-werror}. | |
af6c57ea AC |
5203 | |
5204 | This option causes @value{GDBN} (when built using GCC) to be compiled | |
5205 | with a carefully selected list of compiler warning flags. Any warnings | |
aa79a185 | 5206 | from those flags are treated as errors. |
af6c57ea AC |
5207 | |
5208 | The current list of warning flags includes: | |
5209 | ||
5210 | @table @samp | |
aa79a185 DJ |
5211 | @item -Wall |
5212 | Recommended @sc{gcc} warnings. | |
af6c57ea | 5213 | |
aa79a185 | 5214 | @item -Wdeclaration-after-statement |
af6c57ea | 5215 | |
aa79a185 DJ |
5216 | @sc{gcc} 3.x (and later) and @sc{c99} allow declarations mixed with |
5217 | code, but @sc{gcc} 2.x and @sc{c89} do not. | |
af6c57ea | 5218 | |
aa79a185 | 5219 | @item -Wpointer-arith |
af6c57ea | 5220 | |
aa79a185 DJ |
5221 | @item -Wformat-nonliteral |
5222 | Non-literal format strings, with a few exceptions, are bugs - they | |
d3e8051b | 5223 | might contain unintended user-supplied format specifiers. |
af6c57ea | 5224 | Since @value{GDBN} uses the @code{format printf} attribute on all |
aa79a185 | 5225 | @code{printf} like functions this checks not just @code{printf} calls |
af6c57ea AC |
5226 | but also calls to functions such as @code{fprintf_unfiltered}. |
5227 | ||
7be93b9e JB |
5228 | @item -Wno-pointer-sign |
5229 | In version 4.0, GCC began warning about pointer argument passing or | |
5230 | assignment even when the source and destination differed only in | |
5231 | signedness. However, most @value{GDBN} code doesn't distinguish | |
5232 | carefully between @code{char} and @code{unsigned char}. In early 2006 | |
5233 | the @value{GDBN} developers decided correcting these warnings wasn't | |
5234 | worth the time it would take. | |
5235 | ||
aa79a185 DJ |
5236 | @item -Wno-unused-parameter |
5237 | Due to the way that @value{GDBN} is implemented many functions have | |
5238 | unused parameters. Consequently this warning is avoided. The macro | |
af6c57ea AC |
5239 | @code{ATTRIBUTE_UNUSED} is not used as it leads to false negatives --- |
5240 | it is not an error to have @code{ATTRIBUTE_UNUSED} on a parameter that | |
aa79a185 DJ |
5241 | is being used. |
5242 | ||
5243 | @item -Wno-unused | |
5244 | @itemx -Wno-switch | |
58b38ee2 | 5245 | @itemx -Wno-char-subscripts |
aa79a185 DJ |
5246 | These are warnings which might be useful for @value{GDBN}, but are |
5247 | currently too noisy to enable with @samp{-Werror}. | |
af6c57ea | 5248 | |
aa79a185 | 5249 | @end table |
c906108c SS |
5250 | |
5251 | @subsection Formatting | |
5252 | ||
56caf160 | 5253 | @cindex source code formatting |
c906108c SS |
5254 | The standard GNU recommendations for formatting must be followed |
5255 | strictly. | |
5256 | ||
af6c57ea AC |
5257 | A function declaration should not have its name in column zero. A |
5258 | function definition should have its name in column zero. | |
5259 | ||
474c8240 | 5260 | @smallexample |
af6c57ea AC |
5261 | /* Declaration */ |
5262 | static void foo (void); | |
5263 | /* Definition */ | |
5264 | void | |
5265 | foo (void) | |
5266 | @{ | |
5267 | @} | |
474c8240 | 5268 | @end smallexample |
af6c57ea AC |
5269 | |
5270 | @emph{Pragmatics: This simplifies scripting. Function definitions can | |
5271 | be found using @samp{^function-name}.} | |
c906108c | 5272 | |
af6c57ea AC |
5273 | There must be a space between a function or macro name and the opening |
5274 | parenthesis of its argument list (except for macro definitions, as | |
5275 | required by C). There must not be a space after an open paren/bracket | |
5276 | or before a close paren/bracket. | |
c906108c SS |
5277 | |
5278 | While additional whitespace is generally helpful for reading, do not use | |
5279 | more than one blank line to separate blocks, and avoid adding whitespace | |
af6c57ea AC |
5280 | after the end of a program line (as of 1/99, some 600 lines had |
5281 | whitespace after the semicolon). Excess whitespace causes difficulties | |
5282 | for @code{diff} and @code{patch} utilities. | |
5283 | ||
5284 | Pointers are declared using the traditional K&R C style: | |
5285 | ||
474c8240 | 5286 | @smallexample |
af6c57ea | 5287 | void *foo; |
474c8240 | 5288 | @end smallexample |
af6c57ea AC |
5289 | |
5290 | @noindent | |
5291 | and not: | |
5292 | ||
474c8240 | 5293 | @smallexample |
af6c57ea AC |
5294 | void * foo; |
5295 | void* foo; | |
474c8240 | 5296 | @end smallexample |
c906108c SS |
5297 | |
5298 | @subsection Comments | |
5299 | ||
56caf160 | 5300 | @cindex comment formatting |
c906108c SS |
5301 | The standard GNU requirements on comments must be followed strictly. |
5302 | ||
af6c57ea AC |
5303 | Block comments must appear in the following form, with no @code{/*}- or |
5304 | @code{*/}-only lines, and no leading @code{*}: | |
c906108c | 5305 | |
474c8240 | 5306 | @smallexample |
c906108c SS |
5307 | /* Wait for control to return from inferior to debugger. If inferior |
5308 | gets a signal, we may decide to start it up again instead of | |
5309 | returning. That is why there is a loop in this function. When | |
5310 | this function actually returns it means the inferior should be left | |
25822942 | 5311 | stopped and @value{GDBN} should read more commands. */ |
474c8240 | 5312 | @end smallexample |
c906108c SS |
5313 | |
5314 | (Note that this format is encouraged by Emacs; tabbing for a multi-line | |
56caf160 | 5315 | comment works correctly, and @kbd{M-q} fills the block consistently.) |
c906108c SS |
5316 | |
5317 | Put a blank line between the block comments preceding function or | |
5318 | variable definitions, and the definition itself. | |
5319 | ||
5320 | In general, put function-body comments on lines by themselves, rather | |
5321 | than trying to fit them into the 20 characters left at the end of a | |
5322 | line, since either the comment or the code will inevitably get longer | |
5323 | than will fit, and then somebody will have to move it anyhow. | |
5324 | ||
5325 | @subsection C Usage | |
5326 | ||
56caf160 | 5327 | @cindex C data types |
c906108c SS |
5328 | Code must not depend on the sizes of C data types, the format of the |
5329 | host's floating point numbers, the alignment of anything, or the order | |
5330 | of evaluation of expressions. | |
5331 | ||
56caf160 | 5332 | @cindex function usage |
c906108c | 5333 | Use functions freely. There are only a handful of compute-bound areas |
56caf160 EZ |
5334 | in @value{GDBN} that might be affected by the overhead of a function |
5335 | call, mainly in symbol reading. Most of @value{GDBN}'s performance is | |
5336 | limited by the target interface (whether serial line or system call). | |
c906108c SS |
5337 | |
5338 | However, use functions with moderation. A thousand one-line functions | |
5339 | are just as hard to understand as a single thousand-line function. | |
5340 | ||
af6c57ea | 5341 | @emph{Macros are bad, M'kay.} |
9e678452 CF |
5342 | (But if you have to use a macro, make sure that the macro arguments are |
5343 | protected with parentheses.) | |
af6c57ea AC |
5344 | |
5345 | @cindex types | |
c906108c | 5346 | |
af6c57ea AC |
5347 | Declarations like @samp{struct foo *} should be used in preference to |
5348 | declarations like @samp{typedef struct foo @{ @dots{} @} *foo_ptr}. | |
5349 | ||
5350 | ||
5351 | @subsection Function Prototypes | |
56caf160 | 5352 | @cindex function prototypes |
af6c57ea AC |
5353 | |
5354 | Prototypes must be used when both @emph{declaring} and @emph{defining} | |
5355 | a function. Prototypes for @value{GDBN} functions must include both the | |
5356 | argument type and name, with the name matching that used in the actual | |
5357 | function definition. | |
c906108c | 5358 | |
53a5351d JM |
5359 | All external functions should have a declaration in a header file that |
5360 | callers include, except for @code{_initialize_*} functions, which must | |
5361 | be external so that @file{init.c} construction works, but shouldn't be | |
5362 | visible to random source files. | |
c906108c | 5363 | |
af6c57ea AC |
5364 | Where a source file needs a forward declaration of a static function, |
5365 | that declaration must appear in a block near the top of the source file. | |
5366 | ||
5367 | ||
5368 | @subsection Internal Error Recovery | |
5369 | ||
5370 | During its execution, @value{GDBN} can encounter two types of errors. | |
5371 | User errors and internal errors. User errors include not only a user | |
5372 | entering an incorrect command but also problems arising from corrupt | |
5373 | object files and system errors when interacting with the target. | |
937f164b FF |
5374 | Internal errors include situations where @value{GDBN} has detected, at |
5375 | run time, a corrupt or erroneous situation. | |
af6c57ea AC |
5376 | |
5377 | When reporting an internal error, @value{GDBN} uses | |
5378 | @code{internal_error} and @code{gdb_assert}. | |
5379 | ||
5380 | @value{GDBN} must not call @code{abort} or @code{assert}. | |
5381 | ||
5382 | @emph{Pragmatics: There is no @code{internal_warning} function. Either | |
5383 | the code detected a user error, recovered from it and issued a | |
5384 | @code{warning} or the code failed to correctly recover from the user | |
5385 | error and issued an @code{internal_error}.} | |
5386 | ||
5387 | @subsection File Names | |
5388 | ||
5389 | Any file used when building the core of @value{GDBN} must be in lower | |
5390 | case. Any file used when building the core of @value{GDBN} must be 8.3 | |
5391 | unique. These requirements apply to both source and generated files. | |
5392 | ||
5393 | @emph{Pragmatics: The core of @value{GDBN} must be buildable on many | |
5394 | platforms including DJGPP and MacOS/HFS. Every time an unfriendly file | |
5395 | is introduced to the build process both @file{Makefile.in} and | |
5396 | @file{configure.in} need to be modified accordingly. Compare the | |
5397 | convoluted conversion process needed to transform @file{COPYING} into | |
5398 | @file{copying.c} with the conversion needed to transform | |
5399 | @file{version.in} into @file{version.c}.} | |
5400 | ||
5401 | Any file non 8.3 compliant file (that is not used when building the core | |
5402 | of @value{GDBN}) must be added to @file{gdb/config/djgpp/fnchange.lst}. | |
5403 | ||
5404 | @emph{Pragmatics: This is clearly a compromise.} | |
5405 | ||
5406 | When @value{GDBN} has a local version of a system header file (ex | |
5407 | @file{string.h}) the file name based on the POSIX header prefixed with | |
b4177fca DJ |
5408 | @file{gdb_} (@file{gdb_string.h}). These headers should be relatively |
5409 | independent: they should use only macros defined by @file{configure}, | |
5410 | the compiler, or the host; they should include only system headers; they | |
5411 | should refer only to system types. They may be shared between multiple | |
5412 | programs, e.g.@: @value{GDBN} and @sc{gdbserver}. | |
af6c57ea AC |
5413 | |
5414 | For other files @samp{-} is used as the separator. | |
5415 | ||
5416 | ||
5417 | @subsection Include Files | |
5418 | ||
e2b28d04 | 5419 | A @file{.c} file should include @file{defs.h} first. |
af6c57ea | 5420 | |
e2b28d04 AC |
5421 | A @file{.c} file should directly include the @code{.h} file of every |
5422 | declaration and/or definition it directly refers to. It cannot rely on | |
5423 | indirect inclusion. | |
af6c57ea | 5424 | |
e2b28d04 AC |
5425 | A @file{.h} file should directly include the @code{.h} file of every |
5426 | declaration and/or definition it directly refers to. It cannot rely on | |
5427 | indirect inclusion. Exception: The file @file{defs.h} does not need to | |
5428 | be directly included. | |
af6c57ea | 5429 | |
e2b28d04 | 5430 | An external declaration should only appear in one include file. |
af6c57ea | 5431 | |
e2b28d04 AC |
5432 | An external declaration should never appear in a @code{.c} file. |
5433 | Exception: a declaration for the @code{_initialize} function that | |
5434 | pacifies @option{-Wmissing-declaration}. | |
5435 | ||
5436 | A @code{typedef} definition should only appear in one include file. | |
5437 | ||
5438 | An opaque @code{struct} declaration can appear in multiple @file{.h} | |
5439 | files. Where possible, a @file{.h} file should use an opaque | |
5440 | @code{struct} declaration instead of an include. | |
5441 | ||
5442 | All @file{.h} files should be wrapped in: | |
af6c57ea | 5443 | |
474c8240 | 5444 | @smallexample |
af6c57ea AC |
5445 | #ifndef INCLUDE_FILE_NAME_H |
5446 | #define INCLUDE_FILE_NAME_H | |
5447 | header body | |
5448 | #endif | |
474c8240 | 5449 | @end smallexample |
af6c57ea | 5450 | |
c906108c | 5451 | |
dab11f21 | 5452 | @subsection Clean Design and Portable Implementation |
c906108c | 5453 | |
56caf160 | 5454 | @cindex design |
c906108c | 5455 | In addition to getting the syntax right, there's the little question of |
25822942 | 5456 | semantics. Some things are done in certain ways in @value{GDBN} because long |
c906108c SS |
5457 | experience has shown that the more obvious ways caused various kinds of |
5458 | trouble. | |
5459 | ||
56caf160 | 5460 | @cindex assumptions about targets |
c906108c SS |
5461 | You can't assume the byte order of anything that comes from a target |
5462 | (including @var{value}s, object files, and instructions). Such things | |
56caf160 EZ |
5463 | must be byte-swapped using @code{SWAP_TARGET_AND_HOST} in |
5464 | @value{GDBN}, or one of the swap routines defined in @file{bfd.h}, | |
5465 | such as @code{bfd_get_32}. | |
c906108c SS |
5466 | |
5467 | You can't assume that you know what interface is being used to talk to | |
5468 | the target system. All references to the target must go through the | |
5469 | current @code{target_ops} vector. | |
5470 | ||
5471 | You can't assume that the host and target machines are the same machine | |
5472 | (except in the ``native'' support modules). In particular, you can't | |
5473 | assume that the target machine's header files will be available on the | |
5474 | host machine. Target code must bring along its own header files -- | |
5475 | written from scratch or explicitly donated by their owner, to avoid | |
5476 | copyright problems. | |
5477 | ||
56caf160 | 5478 | @cindex portability |
c906108c SS |
5479 | Insertion of new @code{#ifdef}'s will be frowned upon. It's much better |
5480 | to write the code portably than to conditionalize it for various | |
5481 | systems. | |
5482 | ||
56caf160 | 5483 | @cindex system dependencies |
c906108c SS |
5484 | New @code{#ifdef}'s which test for specific compilers or manufacturers |
5485 | or operating systems are unacceptable. All @code{#ifdef}'s should test | |
5486 | for features. The information about which configurations contain which | |
5487 | features should be segregated into the configuration files. Experience | |
5488 | has proven far too often that a feature unique to one particular system | |
5489 | often creeps into other systems; and that a conditional based on some | |
5490 | predefined macro for your current system will become worthless over | |
5491 | time, as new versions of your system come out that behave differently | |
5492 | with regard to this feature. | |
5493 | ||
5494 | Adding code that handles specific architectures, operating systems, | |
af6c57ea | 5495 | target interfaces, or hosts, is not acceptable in generic code. |
c906108c | 5496 | |
dab11f21 EZ |
5497 | @cindex portable file name handling |
5498 | @cindex file names, portability | |
5499 | One particularly notorious area where system dependencies tend to | |
5500 | creep in is handling of file names. The mainline @value{GDBN} code | |
5501 | assumes Posix semantics of file names: absolute file names begin with | |
5502 | a forward slash @file{/}, slashes are used to separate leading | |
5503 | directories, case-sensitive file names. These assumptions are not | |
5504 | necessarily true on non-Posix systems such as MS-Windows. To avoid | |
5505 | system-dependent code where you need to take apart or construct a file | |
5506 | name, use the following portable macros: | |
5507 | ||
5508 | @table @code | |
5509 | @findex HAVE_DOS_BASED_FILE_SYSTEM | |
5510 | @item HAVE_DOS_BASED_FILE_SYSTEM | |
5511 | This preprocessing symbol is defined to a non-zero value on hosts | |
5512 | whose filesystems belong to the MS-DOS/MS-Windows family. Use this | |
5513 | symbol to write conditional code which should only be compiled for | |
5514 | such hosts. | |
5515 | ||
5516 | @findex IS_DIR_SEPARATOR | |
4be31470 | 5517 | @item IS_DIR_SEPARATOR (@var{c}) |
dab11f21 EZ |
5518 | Evaluates to a non-zero value if @var{c} is a directory separator |
5519 | character. On Unix and GNU/Linux systems, only a slash @file{/} is | |
5520 | such a character, but on Windows, both @file{/} and @file{\} will | |
5521 | pass. | |
5522 | ||
5523 | @findex IS_ABSOLUTE_PATH | |
5524 | @item IS_ABSOLUTE_PATH (@var{file}) | |
5525 | Evaluates to a non-zero value if @var{file} is an absolute file name. | |
5526 | For Unix and GNU/Linux hosts, a name which begins with a slash | |
5527 | @file{/} is absolute. On DOS and Windows, @file{d:/foo} and | |
5528 | @file{x:\bar} are also absolute file names. | |
5529 | ||
5530 | @findex FILENAME_CMP | |
5531 | @item FILENAME_CMP (@var{f1}, @var{f2}) | |
5532 | Calls a function which compares file names @var{f1} and @var{f2} as | |
5533 | appropriate for the underlying host filesystem. For Posix systems, | |
5534 | this simply calls @code{strcmp}; on case-insensitive filesystems it | |
5535 | will call @code{strcasecmp} instead. | |
5536 | ||
5537 | @findex DIRNAME_SEPARATOR | |
5538 | @item DIRNAME_SEPARATOR | |
5539 | Evaluates to a character which separates directories in | |
5540 | @code{PATH}-style lists, typically held in environment variables. | |
5541 | This character is @samp{:} on Unix, @samp{;} on DOS and Windows. | |
5542 | ||
5543 | @findex SLASH_STRING | |
5544 | @item SLASH_STRING | |
5545 | This evaluates to a constant string you should use to produce an | |
5546 | absolute filename from leading directories and the file's basename. | |
5547 | @code{SLASH_STRING} is @code{"/"} on most systems, but might be | |
5548 | @code{"\\"} for some Windows-based ports. | |
5549 | @end table | |
5550 | ||
5551 | In addition to using these macros, be sure to use portable library | |
5552 | functions whenever possible. For example, to extract a directory or a | |
5553 | basename part from a file name, use the @code{dirname} and | |
5554 | @code{basename} library functions (available in @code{libiberty} for | |
5555 | platforms which don't provide them), instead of searching for a slash | |
5556 | with @code{strrchr}. | |
5557 | ||
25822942 DB |
5558 | Another way to generalize @value{GDBN} along a particular interface is with an |
5559 | attribute struct. For example, @value{GDBN} has been generalized to handle | |
56caf160 EZ |
5560 | multiple kinds of remote interfaces---not by @code{#ifdef}s everywhere, but |
5561 | by defining the @code{target_ops} structure and having a current target (as | |
c906108c SS |
5562 | well as a stack of targets below it, for memory references). Whenever |
5563 | something needs to be done that depends on which remote interface we are | |
56caf160 EZ |
5564 | using, a flag in the current target_ops structure is tested (e.g., |
5565 | @code{target_has_stack}), or a function is called through a pointer in the | |
c906108c | 5566 | current target_ops structure. In this way, when a new remote interface |
56caf160 | 5567 | is added, only one module needs to be touched---the one that actually |
c906108c SS |
5568 | implements the new remote interface. Other examples of |
5569 | attribute-structs are BFD access to multiple kinds of object file | |
25822942 | 5570 | formats, or @value{GDBN}'s access to multiple source languages. |
c906108c | 5571 | |
56caf160 EZ |
5572 | Please avoid duplicating code. For example, in @value{GDBN} 3.x all |
5573 | the code interfacing between @code{ptrace} and the rest of | |
5574 | @value{GDBN} was duplicated in @file{*-dep.c}, and so changing | |
5575 | something was very painful. In @value{GDBN} 4.x, these have all been | |
5576 | consolidated into @file{infptrace.c}. @file{infptrace.c} can deal | |
5577 | with variations between systems the same way any system-independent | |
5578 | file would (hooks, @code{#if defined}, etc.), and machines which are | |
5579 | radically different don't need to use @file{infptrace.c} at all. | |
c906108c | 5580 | |
af6c57ea AC |
5581 | All debugging code must be controllable using the @samp{set debug |
5582 | @var{module}} command. Do not use @code{printf} to print trace | |
5583 | messages. Use @code{fprintf_unfiltered(gdb_stdlog, ...}. Do not use | |
5584 | @code{#ifdef DEBUG}. | |
5585 | ||
c906108c | 5586 | |
8487521e | 5587 | @node Porting GDB |
c906108c | 5588 | |
25822942 | 5589 | @chapter Porting @value{GDBN} |
56caf160 | 5590 | @cindex porting to new machines |
c906108c | 5591 | |
56caf160 EZ |
5592 | Most of the work in making @value{GDBN} compile on a new machine is in |
5593 | specifying the configuration of the machine. This is done in a | |
5594 | dizzying variety of header files and configuration scripts, which we | |
5595 | hope to make more sensible soon. Let's say your new host is called an | |
5596 | @var{xyz} (e.g., @samp{sun4}), and its full three-part configuration | |
5597 | name is @code{@var{arch}-@var{xvend}-@var{xos}} (e.g., | |
5598 | @samp{sparc-sun-sunos4}). In particular: | |
c906108c | 5599 | |
56caf160 EZ |
5600 | @itemize @bullet |
5601 | @item | |
c906108c SS |
5602 | In the top level directory, edit @file{config.sub} and add @var{arch}, |
5603 | @var{xvend}, and @var{xos} to the lists of supported architectures, | |
5604 | vendors, and operating systems near the bottom of the file. Also, add | |
5605 | @var{xyz} as an alias that maps to | |
5606 | @code{@var{arch}-@var{xvend}-@var{xos}}. You can test your changes by | |
5607 | running | |
5608 | ||
474c8240 | 5609 | @smallexample |
c906108c | 5610 | ./config.sub @var{xyz} |
474c8240 | 5611 | @end smallexample |
56caf160 | 5612 | |
c906108c SS |
5613 | @noindent |
5614 | and | |
56caf160 | 5615 | |
474c8240 | 5616 | @smallexample |
c906108c | 5617 | ./config.sub @code{@var{arch}-@var{xvend}-@var{xos}} |
474c8240 | 5618 | @end smallexample |
56caf160 | 5619 | |
c906108c SS |
5620 | @noindent |
5621 | which should both respond with @code{@var{arch}-@var{xvend}-@var{xos}} | |
5622 | and no error messages. | |
5623 | ||
56caf160 | 5624 | @noindent |
c906108c SS |
5625 | You need to port BFD, if that hasn't been done already. Porting BFD is |
5626 | beyond the scope of this manual. | |
5627 | ||
56caf160 | 5628 | @item |
25822942 | 5629 | To configure @value{GDBN} itself, edit @file{gdb/configure.host} to recognize |
c906108c SS |
5630 | your system and set @code{gdb_host} to @var{xyz}, and (unless your |
5631 | desired target is already available) also edit @file{gdb/configure.tgt}, | |
5632 | setting @code{gdb_target} to something appropriate (for instance, | |
5633 | @var{xyz}). | |
5634 | ||
7fd60527 AC |
5635 | @emph{Maintainer's note: Work in progress. The file |
5636 | @file{gdb/configure.host} originally needed to be modified when either a | |
5637 | new native target or a new host machine was being added to @value{GDBN}. | |
5638 | Recent changes have removed this requirement. The file now only needs | |
5639 | to be modified when adding a new native configuration. This will likely | |
5640 | changed again in the future.} | |
5641 | ||
56caf160 | 5642 | @item |
25822942 | 5643 | Finally, you'll need to specify and define @value{GDBN}'s host-, native-, and |
c906108c SS |
5644 | target-dependent @file{.h} and @file{.c} files used for your |
5645 | configuration. | |
56caf160 | 5646 | @end itemize |
c906108c | 5647 | |
d52fe014 AC |
5648 | @node Versions and Branches |
5649 | @chapter Versions and Branches | |
8973da3a | 5650 | |
d52fe014 | 5651 | @section Versions |
8973da3a | 5652 | |
d52fe014 AC |
5653 | @value{GDBN}'s version is determined by the file |
5654 | @file{gdb/version.in} and takes one of the following forms: | |
fb0ff88f | 5655 | |
d52fe014 AC |
5656 | @table @asis |
5657 | @item @var{major}.@var{minor} | |
5658 | @itemx @var{major}.@var{minor}.@var{patchlevel} | |
53531fc1 AC |
5659 | an official release (e.g., 6.2 or 6.2.1) |
5660 | @item @var{major}.@var{minor}.@var{patchlevel}.@var{YYYY}@var{MM}@var{DD} | |
5661 | a snapshot taken at @var{YYYY}-@var{MM}-@var{DD}-gmt (e.g., | |
5662 | 6.1.50.20020302, 6.1.90.20020304, or 6.1.0.20020308) | |
5663 | @item @var{major}.@var{minor}.@var{patchlevel}.@var{YYYY}@var{MM}@var{DD}-cvs | |
5664 | a @sc{cvs} check out drawn on @var{YYYY}-@var{MM}-@var{DD} (e.g., | |
5665 | 6.1.50.20020302-cvs, 6.1.90.20020304-cvs, or 6.1.0.20020308-cvs) | |
5666 | @item @var{major}.@var{minor}.@var{patchlevel}.@var{YYYY}@var{MM}@var{DD} (@var{vendor}) | |
d52fe014 | 5667 | a vendor specific release of @value{GDBN}, that while based on@* |
53531fc1 AC |
5668 | @var{major}.@var{minor}.@var{patchlevel}.@var{YYYY}@var{MM}@var{DD}, |
5669 | may include additional changes | |
d52fe014 | 5670 | @end table |
fb0ff88f | 5671 | |
d52fe014 AC |
5672 | @value{GDBN}'s mainline uses the @var{major} and @var{minor} version |
5673 | numbers from the most recent release branch, with a @var{patchlevel} | |
53531fc1 AC |
5674 | of 50. At the time each new release branch is created, the mainline's |
5675 | @var{major} and @var{minor} version numbers are updated. | |
fb0ff88f | 5676 | |
53531fc1 AC |
5677 | @value{GDBN}'s release branch is similar. When the branch is cut, the |
5678 | @var{patchlevel} is changed from 50 to 90. As draft releases are | |
5679 | drawn from the branch, the @var{patchlevel} is incremented. Once the | |
5680 | first release (@var{major}.@var{minor}) has been made, the | |
5681 | @var{patchlevel} is set to 0 and updates have an incremented | |
5682 | @var{patchlevel}. | |
5683 | ||
5684 | For snapshots, and @sc{cvs} check outs, it is also possible to | |
5685 | identify the @sc{cvs} origin: | |
5686 | ||
5687 | @table @asis | |
5688 | @item @var{major}.@var{minor}.50.@var{YYYY}@var{MM}@var{DD} | |
5689 | drawn from the @sc{head} of mainline @sc{cvs} (e.g., 6.1.50.20020302) | |
5690 | @item @var{major}.@var{minor}.90.@var{YYYY}@var{MM}@var{DD} | |
5691 | @itemx @var{major}.@var{minor}.91.@var{YYYY}@var{MM}@var{DD} @dots{} | |
5692 | drawn from a release branch prior to the release (e.g., | |
5693 | 6.1.90.20020304) | |
5694 | @item @var{major}.@var{minor}.0.@var{YYYY}@var{MM}@var{DD} | |
5695 | @itemx @var{major}.@var{minor}.1.@var{YYYY}@var{MM}@var{DD} @dots{} | |
5696 | drawn from a release branch after the release (e.g., 6.2.0.20020308) | |
5697 | @end table | |
fb0ff88f | 5698 | |
d52fe014 AC |
5699 | If the previous @value{GDBN} version is 6.1 and the current version is |
5700 | 6.2, then, substituting 6 for @var{major} and 1 or 2 for @var{minor}, | |
5701 | here's an illustration of a typical sequence: | |
fb0ff88f | 5702 | |
d52fe014 AC |
5703 | @smallexample |
5704 | <HEAD> | |
5705 | | | |
53531fc1 | 5706 | 6.1.50.20020302-cvs |
d52fe014 | 5707 | | |
53531fc1 | 5708 | +--------------------------. |
d52fe014 | 5709 | | <gdb_6_2-branch> |
d52fe014 | 5710 | | | |
53531fc1 AC |
5711 | 6.2.50.20020303-cvs 6.1.90 (draft #1) |
5712 | | | | |
5713 | 6.2.50.20020304-cvs 6.1.90.20020304-cvs | |
5714 | | | | |
5715 | 6.2.50.20020305-cvs 6.1.91 (draft #2) | |
d52fe014 | 5716 | | | |
53531fc1 AC |
5717 | 6.2.50.20020306-cvs 6.1.91.20020306-cvs |
5718 | | | | |
5719 | 6.2.50.20020307-cvs 6.2 (release) | |
5720 | | | | |
5721 | 6.2.50.20020308-cvs 6.2.0.20020308-cvs | |
5722 | | | | |
5723 | 6.2.50.20020309-cvs 6.2.1 (update) | |
5724 | | | | |
5725 | 6.2.50.20020310-cvs <branch closed> | |
d52fe014 | 5726 | | |
53531fc1 | 5727 | 6.2.50.20020311-cvs |
d52fe014 | 5728 | | |
53531fc1 | 5729 | +--------------------------. |
d52fe014 | 5730 | | <gdb_6_3-branch> |
53531fc1 AC |
5731 | | | |
5732 | 6.3.50.20020312-cvs 6.2.90 (draft #1) | |
5733 | | | | |
d52fe014 | 5734 | @end smallexample |
fb0ff88f | 5735 | |
d52fe014 AC |
5736 | @section Release Branches |
5737 | @cindex Release Branches | |
fb0ff88f | 5738 | |
d52fe014 AC |
5739 | @value{GDBN} draws a release series (6.2, 6.2.1, @dots{}) from a |
5740 | single release branch, and identifies that branch using the @sc{cvs} | |
5741 | branch tags: | |
fb0ff88f | 5742 | |
d52fe014 AC |
5743 | @smallexample |
5744 | gdb_@var{major}_@var{minor}-@var{YYYY}@var{MM}@var{DD}-branchpoint | |
5745 | gdb_@var{major}_@var{minor}-branch | |
5746 | gdb_@var{major}_@var{minor}-@var{YYYY}@var{MM}@var{DD}-release | |
5747 | @end smallexample | |
5748 | ||
5749 | @emph{Pragmatics: To help identify the date at which a branch or | |
5750 | release is made, both the branchpoint and release tags include the | |
5751 | date that they are cut (@var{YYYY}@var{MM}@var{DD}) in the tag. The | |
5752 | branch tag, denoting the head of the branch, does not need this.} | |
5753 | ||
5754 | @section Vendor Branches | |
5755 | @cindex vendor branches | |
fb0ff88f AC |
5756 | |
5757 | To avoid version conflicts, vendors are expected to modify the file | |
5758 | @file{gdb/version.in} to include a vendor unique alphabetic identifier | |
5759 | (an official @value{GDBN} release never uses alphabetic characters in | |
d3e8051b | 5760 | its version identifier). E.g., @samp{6.2widgit2}, or @samp{6.2 (Widgit |
d52fe014 AC |
5761 | Inc Patch 2)}. |
5762 | ||
5763 | @section Experimental Branches | |
5764 | @cindex experimental branches | |
5765 | ||
5766 | @subsection Guidelines | |
5767 | ||
5768 | @value{GDBN} permits the creation of branches, cut from the @sc{cvs} | |
5769 | repository, for experimental development. Branches make it possible | |
5770 | for developers to share preliminary work, and maintainers to examine | |
5771 | significant new developments. | |
fb0ff88f | 5772 | |
d52fe014 | 5773 | The following are a set of guidelines for creating such branches: |
fb0ff88f | 5774 | |
d52fe014 AC |
5775 | @table @emph |
5776 | ||
5777 | @item a branch has an owner | |
5778 | The owner can set further policy for a branch, but may not change the | |
5779 | ground rules. In particular, they can set a policy for commits (be it | |
5780 | adding more reviewers or deciding who can commit). | |
5781 | ||
5782 | @item all commits are posted | |
5783 | All changes committed to a branch shall also be posted to | |
5784 | @email{gdb-patches@@sources.redhat.com, the @value{GDBN} patches | |
5785 | mailing list}. While commentary on such changes are encouraged, people | |
5786 | should remember that the changes only apply to a branch. | |
5787 | ||
5788 | @item all commits are covered by an assignment | |
5789 | This ensures that all changes belong to the Free Software Foundation, | |
5790 | and avoids the possibility that the branch may become contaminated. | |
5791 | ||
5792 | @item a branch is focused | |
5793 | A focused branch has a single objective or goal, and does not contain | |
5794 | unnecessary or irrelevant changes. Cleanups, where identified, being | |
5795 | be pushed into the mainline as soon as possible. | |
5796 | ||
5797 | @item a branch tracks mainline | |
5798 | This keeps the level of divergence under control. It also keeps the | |
5799 | pressure on developers to push cleanups and other stuff into the | |
5800 | mainline. | |
5801 | ||
5802 | @item a branch shall contain the entire @value{GDBN} module | |
5803 | The @value{GDBN} module @code{gdb} should be specified when creating a | |
5804 | branch (branches of individual files should be avoided). @xref{Tags}. | |
5805 | ||
5806 | @item a branch shall be branded using @file{version.in} | |
5807 | The file @file{gdb/version.in} shall be modified so that it identifies | |
5808 | the branch @var{owner} and branch @var{name}, e.g., | |
53531fc1 | 5809 | @samp{6.2.50.20030303_owner_name} or @samp{6.2 (Owner Name)}. |
d52fe014 AC |
5810 | |
5811 | @end table | |
fb0ff88f | 5812 | |
d52fe014 AC |
5813 | @subsection Tags |
5814 | @anchor{Tags} | |
fb0ff88f | 5815 | |
d52fe014 AC |
5816 | To simplify the identification of @value{GDBN} branches, the following |
5817 | branch tagging convention is strongly recommended: | |
fb0ff88f | 5818 | |
d52fe014 | 5819 | @table @code |
fb0ff88f | 5820 | |
d52fe014 AC |
5821 | @item @var{owner}_@var{name}-@var{YYYYMMDD}-branchpoint |
5822 | @itemx @var{owner}_@var{name}-@var{YYYYMMDD}-branch | |
5823 | The branch point and corresponding branch tag. @var{YYYYMMDD} is the | |
5824 | date that the branch was created. A branch is created using the | |
5825 | sequence: @anchor{experimental branch tags} | |
474c8240 | 5826 | @smallexample |
d52fe014 AC |
5827 | cvs rtag @var{owner}_@var{name}-@var{YYYYMMDD}-branchpoint gdb |
5828 | cvs rtag -b -r @var{owner}_@var{name}-@var{YYYYMMDD}-branchpoint \ | |
5829 | @var{owner}_@var{name}-@var{YYYYMMDD}-branch gdb | |
474c8240 | 5830 | @end smallexample |
fb0ff88f | 5831 | |
d52fe014 AC |
5832 | @item @var{owner}_@var{name}-@var{yyyymmdd}-mergepoint |
5833 | The tagged point, on the mainline, that was used when merging the branch | |
5834 | on @var{yyyymmdd}. To merge in all changes since the branch was cut, | |
5835 | use a command sequence like: | |
474c8240 | 5836 | @smallexample |
d52fe014 AC |
5837 | cvs rtag @var{owner}_@var{name}-@var{yyyymmdd}-mergepoint gdb |
5838 | cvs update \ | |
5839 | -j@var{owner}_@var{name}-@var{YYYYMMDD}-branchpoint | |
5840 | -j@var{owner}_@var{name}-@var{yyyymmdd}-mergepoint | |
474c8240 | 5841 | @end smallexample |
d52fe014 AC |
5842 | @noindent |
5843 | Similar sequences can be used to just merge in changes since the last | |
5844 | merge. | |
5845 | ||
5846 | @end table | |
fb0ff88f | 5847 | |
d52fe014 AC |
5848 | @noindent |
5849 | For further information on @sc{cvs}, see | |
5850 | @uref{http://www.gnu.org/software/cvs/, Concurrent Versions System}. | |
5851 | ||
55f6ca0f JB |
5852 | @node Start of New Year Procedure |
5853 | @chapter Start of New Year Procedure | |
5854 | @cindex new year procedure | |
5855 | ||
5856 | At the start of each new year, the following actions should be performed: | |
5857 | ||
5858 | @itemize @bullet | |
5859 | @item | |
5860 | Rotate the ChangeLog file | |
5861 | ||
5862 | The current @file{ChangeLog} file should be renamed into | |
5863 | @file{ChangeLog-YYYY} where YYYY is the year that has just passed. | |
5864 | A new @file{ChangeLog} file should be created, and its contents should | |
5865 | contain a reference to the previous ChangeLog. The following should | |
5866 | also be preserved at the end of the new ChangeLog, in order to provide | |
5867 | the appropriate settings when editing this file with Emacs: | |
5868 | @smallexample | |
5869 | Local Variables: | |
5870 | mode: change-log | |
5871 | left-margin: 8 | |
5872 | fill-column: 74 | |
5873 | version-control: never | |
5874 | End: | |
5875 | @end smallexample | |
5876 | ||
7f893741 JB |
5877 | @item |
5878 | Add an entry for the newly created ChangeLog file (@file{ChangeLog-YYYY}) | |
5879 | in @file{gdb/config/djgpp/fnchange.lst}. | |
5880 | ||
55f6ca0f JB |
5881 | @item |
5882 | Update the copyright year in the startup message | |
5883 | ||
5884 | Update the copyright year in file @file{top.c}, function | |
5885 | @code{print_gdb_version}. | |
6ec2edbe JB |
5886 | |
5887 | @item | |
5888 | Add the new year in the copyright notices of all source and documentation | |
5889 | files. This can be done semi-automatically by running the @code{copyright.sh} | |
5890 | script. This script requires Emacs 22 or later to be installed. | |
5891 | ||
55f6ca0f JB |
5892 | @end itemize |
5893 | ||
d52fe014 | 5894 | @node Releasing GDB |
fb0ff88f | 5895 | |
d52fe014 AC |
5896 | @chapter Releasing @value{GDBN} |
5897 | @cindex making a new release of gdb | |
fb0ff88f | 5898 | |
9bb0a4d8 AC |
5899 | @section Branch Commit Policy |
5900 | ||
5901 | The branch commit policy is pretty slack. @value{GDBN} releases 5.0, | |
5902 | 5.1 and 5.2 all used the below: | |
5903 | ||
5904 | @itemize @bullet | |
5905 | @item | |
5906 | The @file{gdb/MAINTAINERS} file still holds. | |
5907 | @item | |
5908 | Don't fix something on the branch unless/until it is also fixed in the | |
5909 | trunk. If this isn't possible, mentioning it in the @file{gdb/PROBLEMS} | |
4be31470 | 5910 | file is better than committing a hack. |
9bb0a4d8 AC |
5911 | @item |
5912 | When considering a patch for the branch, suggested criteria include: | |
5913 | Does it fix a build? Does it fix the sequence @kbd{break main; run} | |
5914 | when debugging a static binary? | |
5915 | @item | |
5916 | The further a change is from the core of @value{GDBN}, the less likely | |
5917 | the change will worry anyone (e.g., target specific code). | |
5918 | @item | |
5919 | Only post a proposal to change the core of @value{GDBN} after you've | |
5920 | sent individual bribes to all the people listed in the | |
5921 | @file{MAINTAINERS} file @t{;-)} | |
5922 | @end itemize | |
5923 | ||
5924 | @emph{Pragmatics: Provided updates are restricted to non-core | |
5925 | functionality there is little chance that a broken change will be fatal. | |
5926 | This means that changes such as adding a new architectures or (within | |
5927 | reason) support for a new host are considered acceptable.} | |
5928 | ||
5929 | ||
cbb09e6a | 5930 | @section Obsoleting code |
8973da3a | 5931 | |
8642bc8f | 5932 | Before anything else, poke the other developers (and around the source |
4be31470 EZ |
5933 | code) to see if there is anything that can be removed from @value{GDBN} |
5934 | (an old target, an unused file). | |
8973da3a | 5935 | |
8642bc8f | 5936 | Obsolete code is identified by adding an @code{OBSOLETE} prefix to every |
cbb09e6a AC |
5937 | line. Doing this means that it is easy to identify something that has |
5938 | been obsoleted when greping through the sources. | |
8973da3a | 5939 | |
cbb09e6a AC |
5940 | The process is done in stages --- this is mainly to ensure that the |
5941 | wider @value{GDBN} community has a reasonable opportunity to respond. | |
5942 | Remember, everything on the Internet takes a week. | |
8973da3a | 5943 | |
cbb09e6a | 5944 | @enumerate |
8973da3a | 5945 | @item |
cbb09e6a AC |
5946 | Post the proposal on @email{gdb@@sources.redhat.com, the GDB mailing |
5947 | list} Creating a bug report to track the task's state, is also highly | |
5948 | recommended. | |
8973da3a | 5949 | @item |
cbb09e6a | 5950 | Wait a week or so. |
8973da3a | 5951 | @item |
cbb09e6a AC |
5952 | Post the proposal on @email{gdb-announce@@sources.redhat.com, the GDB |
5953 | Announcement mailing list}. | |
8973da3a | 5954 | @item |
cbb09e6a | 5955 | Wait a week or so. |
8973da3a | 5956 | @item |
cbb09e6a AC |
5957 | Go through and edit all relevant files and lines so that they are |
5958 | prefixed with the word @code{OBSOLETE}. | |
5959 | @item | |
5960 | Wait until the next GDB version, containing this obsolete code, has been | |
5961 | released. | |
5962 | @item | |
5963 | Remove the obsolete code. | |
5964 | @end enumerate | |
5965 | ||
5966 | @noindent | |
5967 | @emph{Maintainer note: While removing old code is regrettable it is | |
5968 | hopefully better for @value{GDBN}'s long term development. Firstly it | |
5969 | helps the developers by removing code that is either no longer relevant | |
5970 | or simply wrong. Secondly since it removes any history associated with | |
5971 | the file (effectively clearing the slate) the developer has a much freer | |
5972 | hand when it comes to fixing broken files.} | |
8973da3a | 5973 | |
8973da3a | 5974 | |
9ae8b82c AC |
5975 | |
5976 | @section Before the Branch | |
8973da3a | 5977 | |
8642bc8f AC |
5978 | The most important objective at this stage is to find and fix simple |
5979 | changes that become a pain to track once the branch is created. For | |
5980 | instance, configuration problems that stop @value{GDBN} from even | |
5981 | building. If you can't get the problem fixed, document it in the | |
5982 | @file{gdb/PROBLEMS} file. | |
8973da3a | 5983 | |
9ae8b82c | 5984 | @subheading Prompt for @file{gdb/NEWS} |
8973da3a | 5985 | |
9ae8b82c AC |
5986 | People always forget. Send a post reminding them but also if you know |
5987 | something interesting happened add it yourself. The @code{schedule} | |
5988 | script will mention this in its e-mail. | |
8973da3a | 5989 | |
9ae8b82c | 5990 | @subheading Review @file{gdb/README} |
8973da3a | 5991 | |
9ae8b82c AC |
5992 | Grab one of the nightly snapshots and then walk through the |
5993 | @file{gdb/README} looking for anything that can be improved. The | |
5994 | @code{schedule} script will mention this in its e-mail. | |
8642bc8f AC |
5995 | |
5996 | @subheading Refresh any imported files. | |
8973da3a | 5997 | |
8642bc8f | 5998 | A number of files are taken from external repositories. They include: |
8973da3a | 5999 | |
8642bc8f AC |
6000 | @itemize @bullet |
6001 | @item | |
6002 | @file{texinfo/texinfo.tex} | |
6003 | @item | |
9ae8b82c AC |
6004 | @file{config.guess} et.@: al.@: (see the top-level @file{MAINTAINERS} |
6005 | file) | |
6006 | @item | |
6007 | @file{etc/standards.texi}, @file{etc/make-stds.texi} | |
8642bc8f AC |
6008 | @end itemize |
6009 | ||
9ae8b82c | 6010 | @subheading Check the ARI |
8642bc8f | 6011 | |
9ae8b82c AC |
6012 | @uref{http://sources.redhat.com/gdb/ari,,A.R.I.} is an @code{awk} script |
6013 | (Awk Regression Index ;-) that checks for a number of errors and coding | |
6014 | conventions. The checks include things like using @code{malloc} instead | |
6015 | of @code{xmalloc} and file naming problems. There shouldn't be any | |
6016 | regressions. | |
8642bc8f | 6017 | |
9ae8b82c | 6018 | @subsection Review the bug data base |
8642bc8f | 6019 | |
9ae8b82c | 6020 | Close anything obviously fixed. |
8642bc8f | 6021 | |
9ae8b82c | 6022 | @subsection Check all cross targets build |
8642bc8f | 6023 | |
9ae8b82c | 6024 | The targets are listed in @file{gdb/MAINTAINERS}. |
8642bc8f | 6025 | |
8642bc8f | 6026 | |
30107679 | 6027 | @section Cut the Branch |
8642bc8f | 6028 | |
30107679 | 6029 | @subheading Create the branch |
8642bc8f | 6030 | |
474c8240 | 6031 | @smallexample |
30107679 AC |
6032 | $ u=5.1 |
6033 | $ v=5.2 | |
6034 | $ V=`echo $v | sed 's/\./_/g'` | |
6035 | $ D=`date -u +%Y-%m-%d` | |
6036 | $ echo $u $V $D | |
6037 | 5.1 5_2 2002-03-03 | |
6038 | $ echo cvs -f -d :ext:sources.redhat.com:/cvs/src rtag \ | |
b247355e | 6039 | -D $D-gmt gdb_$V-$D-branchpoint insight |
30107679 | 6040 | cvs -f -d :ext:sources.redhat.com:/cvs/src rtag |
b247355e | 6041 | -D 2002-03-03-gmt gdb_5_2-2002-03-03-branchpoint insight |
30107679 AC |
6042 | $ ^echo ^^ |
6043 | ... | |
6044 | $ echo cvs -f -d :ext:sources.redhat.com:/cvs/src rtag \ | |
b247355e | 6045 | -b -r gdb_$V-$D-branchpoint gdb_$V-branch insight |
30107679 | 6046 | cvs -f -d :ext:sources.redhat.com:/cvs/src rtag \ |
b247355e | 6047 | -b -r gdb_5_2-2002-03-03-branchpoint gdb_5_2-branch insight |
30107679 AC |
6048 | $ ^echo ^^ |
6049 | ... | |
8642bc8f | 6050 | $ |
474c8240 | 6051 | @end smallexample |
8642bc8f AC |
6052 | |
6053 | @itemize @bullet | |
6054 | @item | |
b247355e | 6055 | By using @kbd{-D YYYY-MM-DD-gmt}, the branch is forced to an exact |
30107679 AC |
6056 | date/time. |
6057 | @item | |
b247355e | 6058 | The trunk is first tagged so that the branch point can easily be found. |
30107679 | 6059 | @item |
b247355e | 6060 | Insight, which includes @value{GDBN}, is tagged at the same time. |
8642bc8f | 6061 | @item |
b247355e | 6062 | @file{version.in} gets bumped to avoid version number conflicts. |
8642bc8f | 6063 | @item |
b247355e | 6064 | The reading of @file{.cvsrc} is disabled using @file{-f}. |
30107679 AC |
6065 | @end itemize |
6066 | ||
6067 | @subheading Update @file{version.in} | |
6068 | ||
6069 | @smallexample | |
6070 | $ u=5.1 | |
6071 | $ v=5.2 | |
6072 | $ V=`echo $v | sed 's/\./_/g'` | |
6073 | $ echo $u $v$V | |
6074 | 5.1 5_2 | |
6075 | $ cd /tmp | |
6076 | $ echo cvs -f -d :ext:sources.redhat.com:/cvs/src co \ | |
6077 | -r gdb_$V-branch src/gdb/version.in | |
6078 | cvs -f -d :ext:sources.redhat.com:/cvs/src co | |
6079 | -r gdb_5_2-branch src/gdb/version.in | |
6080 | $ ^echo ^^ | |
6081 | U src/gdb/version.in | |
6082 | $ cd src/gdb | |
6083 | $ echo $u.90-0000-00-00-cvs > version.in | |
6084 | $ cat version.in | |
6085 | 5.1.90-0000-00-00-cvs | |
6086 | $ cvs -f commit version.in | |
6087 | @end smallexample | |
6088 | ||
6089 | @itemize @bullet | |
6090 | @item | |
6091 | @file{0000-00-00} is used as a date to pump prime the version.in update | |
b247355e | 6092 | mechanism. |
30107679 AC |
6093 | @item |
6094 | @file{.90} and the previous branch version are used as fairly arbitrary | |
b247355e | 6095 | initial branch version number. |
8642bc8f AC |
6096 | @end itemize |
6097 | ||
8642bc8f AC |
6098 | |
6099 | @subheading Update the web and news pages | |
6100 | ||
30107679 AC |
6101 | Something? |
6102 | ||
8642bc8f AC |
6103 | @subheading Tweak cron to track the new branch |
6104 | ||
30107679 AC |
6105 | The file @file{gdbadmin/cron/crontab} contains gdbadmin's cron table. |
6106 | This file needs to be updated so that: | |
6107 | ||
6108 | @itemize @bullet | |
6109 | @item | |
b247355e | 6110 | A daily timestamp is added to the file @file{version.in}. |
30107679 | 6111 | @item |
b247355e | 6112 | The new branch is included in the snapshot process. |
30107679 AC |
6113 | @end itemize |
6114 | ||
6115 | @noindent | |
6116 | See the file @file{gdbadmin/cron/README} for how to install the updated | |
6117 | cron table. | |
6118 | ||
6119 | The file @file{gdbadmin/ss/README} should also be reviewed to reflect | |
6120 | any changes. That file is copied to both the branch/ and current/ | |
6121 | snapshot directories. | |
6122 | ||
6123 | ||
6124 | @subheading Update the NEWS and README files | |
6125 | ||
6126 | The @file{NEWS} file needs to be updated so that on the branch it refers | |
6127 | to @emph{changes in the current release} while on the trunk it also | |
6128 | refers to @emph{changes since the current release}. | |
6129 | ||
6130 | The @file{README} file needs to be updated so that it refers to the | |
6131 | current release. | |
6132 | ||
6133 | @subheading Post the branch info | |
6134 | ||
6135 | Send an announcement to the mailing lists: | |
6136 | ||
6137 | @itemize @bullet | |
6138 | @item | |
6139 | @email{gdb-announce@@sources.redhat.com, GDB Announcement mailing list} | |
6140 | @item | |
d3e8051b EZ |
6141 | @email{gdb@@sources.redhat.com, GDB Discussion mailing list} and |
6142 | @email{gdb-testers@@sources.redhat.com, GDB Testers mailing list} | |
16737d73 | 6143 | @end itemize |
30107679 AC |
6144 | |
6145 | @emph{Pragmatics: The branch creation is sent to the announce list to | |
6146 | ensure that people people not subscribed to the higher volume discussion | |
6147 | list are alerted.} | |
6148 | ||
6149 | The announcement should include: | |
6150 | ||
6151 | @itemize @bullet | |
6152 | @item | |
b247355e | 6153 | The branch tag. |
30107679 | 6154 | @item |
b247355e | 6155 | How to check out the branch using CVS. |
30107679 | 6156 | @item |
b247355e | 6157 | The date/number of weeks until the release. |
30107679 | 6158 | @item |
b247355e | 6159 | The branch commit policy still holds. |
16737d73 | 6160 | @end itemize |
30107679 | 6161 | |
8642bc8f AC |
6162 | @section Stabilize the branch |
6163 | ||
6164 | Something goes here. | |
6165 | ||
6166 | @section Create a Release | |
6167 | ||
0816590b AC |
6168 | The process of creating and then making available a release is broken |
6169 | down into a number of stages. The first part addresses the technical | |
6170 | process of creating a releasable tar ball. The later stages address the | |
6171 | process of releasing that tar ball. | |
8973da3a | 6172 | |
0816590b AC |
6173 | When making a release candidate just the first section is needed. |
6174 | ||
6175 | @subsection Create a release candidate | |
6176 | ||
6177 | The objective at this stage is to create a set of tar balls that can be | |
6178 | made available as a formal release (or as a less formal release | |
6179 | candidate). | |
6180 | ||
6181 | @subsubheading Freeze the branch | |
6182 | ||
6183 | Send out an e-mail notifying everyone that the branch is frozen to | |
6184 | @email{gdb-patches@@sources.redhat.com}. | |
6185 | ||
6186 | @subsubheading Establish a few defaults. | |
8973da3a | 6187 | |
474c8240 | 6188 | @smallexample |
0816590b AC |
6189 | $ b=gdb_5_2-branch |
6190 | $ v=5.2 | |
8642bc8f AC |
6191 | $ t=/sourceware/snapshot-tmp/gdbadmin-tmp |
6192 | $ echo $t/$b/$v | |
0816590b | 6193 | /sourceware/snapshot-tmp/gdbadmin-tmp/gdb_5_2-branch/5.2 |
8642bc8f AC |
6194 | $ mkdir -p $t/$b/$v |
6195 | $ cd $t/$b/$v | |
6196 | $ pwd | |
0816590b | 6197 | /sourceware/snapshot-tmp/gdbadmin-tmp/gdb_5_2-branch/5.2 |
8973da3a AC |
6198 | $ which autoconf |
6199 | /home/gdbadmin/bin/autoconf | |
8642bc8f | 6200 | $ |
474c8240 | 6201 | @end smallexample |
8973da3a | 6202 | |
0816590b AC |
6203 | @noindent |
6204 | Notes: | |
8973da3a | 6205 | |
0816590b AC |
6206 | @itemize @bullet |
6207 | @item | |
6208 | Check the @code{autoconf} version carefully. You want to be using the | |
4a2b4636 JB |
6209 | version taken from the @file{binutils} snapshot directory, which can be |
6210 | found at @uref{ftp://sources.redhat.com/pub/binutils/}. It is very | |
0816590b AC |
6211 | unlikely that a system installed version of @code{autoconf} (e.g., |
6212 | @file{/usr/bin/autoconf}) is correct. | |
6213 | @end itemize | |
6214 | ||
6215 | @subsubheading Check out the relevant modules: | |
8973da3a | 6216 | |
474c8240 | 6217 | @smallexample |
b247355e | 6218 | $ for m in gdb insight |
8642bc8f | 6219 | do |
8973da3a AC |
6220 | ( mkdir -p $m && cd $m && cvs -q -f -d /cvs/src co -P -r $b $m ) |
6221 | done | |
8642bc8f | 6222 | $ |
474c8240 | 6223 | @end smallexample |
8973da3a | 6224 | |
0816590b AC |
6225 | @noindent |
6226 | Note: | |
8642bc8f | 6227 | |
0816590b AC |
6228 | @itemize @bullet |
6229 | @item | |
6230 | The reading of @file{.cvsrc} is disabled (@file{-f}) so that there isn't | |
6231 | any confusion between what is written here and what your local | |
6232 | @code{cvs} really does. | |
6233 | @end itemize | |
6234 | ||
6235 | @subsubheading Update relevant files. | |
8973da3a | 6236 | |
0816590b AC |
6237 | @table @file |
6238 | ||
6239 | @item gdb/NEWS | |
8642bc8f AC |
6240 | |
6241 | Major releases get their comments added as part of the mainline. Minor | |
6242 | releases should probably mention any significant bugs that were fixed. | |
6243 | ||
0816590b | 6244 | Don't forget to include the @file{ChangeLog} entry. |
8973da3a | 6245 | |
474c8240 | 6246 | @smallexample |
8642bc8f AC |
6247 | $ emacs gdb/src/gdb/NEWS |
6248 | ... | |
6249 | c-x 4 a | |
6250 | ... | |
6251 | c-x c-s c-x c-c | |
6252 | $ cp gdb/src/gdb/NEWS insight/src/gdb/NEWS | |
6253 | $ cp gdb/src/gdb/ChangeLog insight/src/gdb/ChangeLog | |
474c8240 | 6254 | @end smallexample |
8973da3a | 6255 | |
0816590b AC |
6256 | @item gdb/README |
6257 | ||
6258 | You'll need to update: | |
8973da3a | 6259 | |
0816590b AC |
6260 | @itemize @bullet |
6261 | @item | |
b247355e | 6262 | The version. |
0816590b | 6263 | @item |
b247355e | 6264 | The update date. |
0816590b | 6265 | @item |
b247355e | 6266 | Who did it. |
0816590b | 6267 | @end itemize |
8973da3a | 6268 | |
474c8240 | 6269 | @smallexample |
8642bc8f AC |
6270 | $ emacs gdb/src/gdb/README |
6271 | ... | |
8973da3a | 6272 | c-x 4 a |
8642bc8f | 6273 | ... |
8973da3a | 6274 | c-x c-s c-x c-c |
8642bc8f AC |
6275 | $ cp gdb/src/gdb/README insight/src/gdb/README |
6276 | $ cp gdb/src/gdb/ChangeLog insight/src/gdb/ChangeLog | |
474c8240 | 6277 | @end smallexample |
8973da3a | 6278 | |
0816590b AC |
6279 | @emph{Maintainer note: Hopefully the @file{README} file was reviewed |
6280 | before the initial branch was cut so just a simple substitute is needed | |
6281 | to get it updated.} | |
8973da3a | 6282 | |
8642bc8f AC |
6283 | @emph{Maintainer note: Other projects generate @file{README} and |
6284 | @file{INSTALL} from the core documentation. This might be worth | |
6285 | pursuing.} | |
8973da3a | 6286 | |
0816590b | 6287 | @item gdb/version.in |
8973da3a | 6288 | |
474c8240 | 6289 | @smallexample |
8642bc8f | 6290 | $ echo $v > gdb/src/gdb/version.in |
0816590b AC |
6291 | $ cat gdb/src/gdb/version.in |
6292 | 5.2 | |
8642bc8f | 6293 | $ emacs gdb/src/gdb/version.in |
8973da3a AC |
6294 | ... |
6295 | c-x 4 a | |
0816590b | 6296 | ... Bump to version ... |
8973da3a | 6297 | c-x c-s c-x c-c |
8642bc8f AC |
6298 | $ cp gdb/src/gdb/version.in insight/src/gdb/version.in |
6299 | $ cp gdb/src/gdb/ChangeLog insight/src/gdb/ChangeLog | |
474c8240 | 6300 | @end smallexample |
8973da3a | 6301 | |
0816590b AC |
6302 | @end table |
6303 | ||
6304 | @subsubheading Do the dirty work | |
6305 | ||
6306 | This is identical to the process used to create the daily snapshot. | |
8973da3a | 6307 | |
4ce8657e MC |
6308 | @smallexample |
6309 | $ for m in gdb insight | |
6310 | do | |
6311 | ( cd $m/src && gmake -f src-release $m.tar ) | |
6312 | done | |
4ce8657e MC |
6313 | @end smallexample |
6314 | ||
6315 | If the top level source directory does not have @file{src-release} | |
6316 | (@value{GDBN} version 5.3.1 or earlier), try these commands instead: | |
6317 | ||
474c8240 | 6318 | @smallexample |
0816590b | 6319 | $ for m in gdb insight |
8642bc8f | 6320 | do |
0816590b | 6321 | ( cd $m/src && gmake -f Makefile.in $m.tar ) |
8973da3a | 6322 | done |
474c8240 | 6323 | @end smallexample |
8973da3a | 6324 | |
0816590b | 6325 | @subsubheading Check the source files |
8642bc8f | 6326 | |
0816590b | 6327 | You're looking for files that have mysteriously disappeared. |
8642bc8f AC |
6328 | @kbd{distclean} has the habit of deleting files it shouldn't. Watch out |
6329 | for the @file{version.in} update @kbd{cronjob}. | |
8973da3a | 6330 | |
474c8240 | 6331 | @smallexample |
8642bc8f AC |
6332 | $ ( cd gdb/src && cvs -f -q -n update ) |
6333 | M djunpack.bat | |
0816590b | 6334 | ? gdb-5.1.91.tar |
8642bc8f | 6335 | ? proto-toplev |
0816590b | 6336 | @dots{} lots of generated files @dots{} |
8642bc8f AC |
6337 | M gdb/ChangeLog |
6338 | M gdb/NEWS | |
6339 | M gdb/README | |
6340 | M gdb/version.in | |
0816590b | 6341 | @dots{} lots of generated files @dots{} |
8642bc8f | 6342 | $ |
474c8240 | 6343 | @end smallexample |
8973da3a | 6344 | |
0816590b | 6345 | @noindent |
8642bc8f AC |
6346 | @emph{Don't worry about the @file{gdb.info-??} or |
6347 | @file{gdb/p-exp.tab.c}. They were generated (and yes @file{gdb.info-1} | |
6348 | was also generated only something strange with CVS means that they | |
d3e8051b | 6349 | didn't get suppressed). Fixing it would be nice though.} |
8973da3a | 6350 | |
0816590b | 6351 | @subsubheading Create compressed versions of the release |
8973da3a | 6352 | |
474c8240 | 6353 | @smallexample |
0816590b AC |
6354 | $ cp */src/*.tar . |
6355 | $ cp */src/*.bz2 . | |
6356 | $ ls -F | |
b247355e | 6357 | gdb/ gdb-5.2.tar insight/ insight-5.2.tar |
0816590b AC |
6358 | $ for m in gdb insight |
6359 | do | |
6360 | bzip2 -v -9 -c $m-$v.tar > $m-$v.tar.bz2 | |
6361 | gzip -v -9 -c $m-$v.tar > $m-$v.tar.gz | |
6362 | done | |
6363 | $ | |
474c8240 | 6364 | @end smallexample |
8973da3a | 6365 | |
0816590b AC |
6366 | @noindent |
6367 | Note: | |
6368 | ||
6369 | @itemize @bullet | |
6370 | @item | |
6371 | A pipe such as @kbd{bunzip2 < xxx.bz2 | gzip -9 > xxx.gz} is not since, | |
6372 | in that mode, @code{gzip} does not know the name of the file and, hence, | |
6373 | can not include it in the compressed file. This is also why the release | |
6374 | process runs @code{tar} and @code{bzip2} as separate passes. | |
6375 | @end itemize | |
6376 | ||
6377 | @subsection Sanity check the tar ball | |
8973da3a | 6378 | |
0816590b | 6379 | Pick a popular machine (Solaris/PPC?) and try the build on that. |
8973da3a | 6380 | |
0816590b AC |
6381 | @smallexample |
6382 | $ bunzip2 < gdb-5.2.tar.bz2 | tar xpf - | |
6383 | $ cd gdb-5.2 | |
6384 | $ ./configure | |
6385 | $ make | |
6386 | @dots{} | |
6387 | $ ./gdb/gdb ./gdb/gdb | |
6388 | GNU gdb 5.2 | |
6389 | @dots{} | |
6390 | (gdb) b main | |
6391 | Breakpoint 1 at 0x80732bc: file main.c, line 734. | |
6392 | (gdb) run | |
6393 | Starting program: /tmp/gdb-5.2/gdb/gdb | |
6394 | ||
6395 | Breakpoint 1, main (argc=1, argv=0xbffff8b4) at main.c:734 | |
6396 | 734 catch_errors (captured_main, &args, "", RETURN_MASK_ALL); | |
6397 | (gdb) print args | |
6398 | $1 = @{argc = 136426532, argv = 0x821b7f0@} | |
6399 | (gdb) | |
6400 | @end smallexample | |
8973da3a | 6401 | |
0816590b | 6402 | @subsection Make a release candidate available |
8973da3a | 6403 | |
0816590b | 6404 | If this is a release candidate then the only remaining steps are: |
8642bc8f | 6405 | |
0816590b AC |
6406 | @enumerate |
6407 | @item | |
6408 | Commit @file{version.in} and @file{ChangeLog} | |
6409 | @item | |
6410 | Tweak @file{version.in} (and @file{ChangeLog} to read | |
6411 | @var{L}.@var{M}.@var{N}-0000-00-00-cvs so that the version update | |
6412 | process can restart. | |
6413 | @item | |
6414 | Make the release candidate available in | |
6415 | @uref{ftp://sources.redhat.com/pub/gdb/snapshots/branch} | |
6416 | @item | |
6417 | Notify the relevant mailing lists ( @email{gdb@@sources.redhat.com} and | |
6418 | @email{gdb-testers@@sources.redhat.com} that the candidate is available. | |
6419 | @end enumerate | |
8642bc8f | 6420 | |
0816590b | 6421 | @subsection Make a formal release available |
8642bc8f | 6422 | |
0816590b | 6423 | (And you thought all that was required was to post an e-mail.) |
8642bc8f | 6424 | |
0816590b | 6425 | @subsubheading Install on sware |
8642bc8f | 6426 | |
0816590b | 6427 | Copy the new files to both the release and the old release directory: |
8642bc8f | 6428 | |
474c8240 | 6429 | @smallexample |
0816590b | 6430 | $ cp *.bz2 *.gz ~ftp/pub/gdb/old-releases/ |
8642bc8f | 6431 | $ cp *.bz2 *.gz ~ftp/pub/gdb/releases |
474c8240 | 6432 | @end smallexample |
8642bc8f | 6433 | |
0816590b AC |
6434 | @noindent |
6435 | Clean up the releases directory so that only the most recent releases | |
6436 | are available (e.g. keep 5.2 and 5.2.1 but remove 5.1): | |
6437 | ||
6438 | @smallexample | |
6439 | $ cd ~ftp/pub/gdb/releases | |
6440 | $ rm @dots{} | |
6441 | @end smallexample | |
6442 | ||
6443 | @noindent | |
6444 | Update the file @file{README} and @file{.message} in the releases | |
6445 | directory: | |
6446 | ||
6447 | @smallexample | |
6448 | $ vi README | |
6449 | @dots{} | |
6450 | $ rm -f .message | |
6451 | $ ln README .message | |
6452 | @end smallexample | |
8642bc8f | 6453 | |
0816590b | 6454 | @subsubheading Update the web pages. |
8973da3a | 6455 | |
0816590b AC |
6456 | @table @file |
6457 | ||
6458 | @item htdocs/download/ANNOUNCEMENT | |
6459 | This file, which is posted as the official announcement, includes: | |
8973da3a AC |
6460 | @itemize @bullet |
6461 | @item | |
b247355e | 6462 | General announcement. |
8642bc8f | 6463 | @item |
0816590b AC |
6464 | News. If making an @var{M}.@var{N}.1 release, retain the news from |
6465 | earlier @var{M}.@var{N} release. | |
8973da3a | 6466 | @item |
b247355e | 6467 | Errata. |
0816590b AC |
6468 | @end itemize |
6469 | ||
6470 | @item htdocs/index.html | |
6471 | @itemx htdocs/news/index.html | |
6472 | @itemx htdocs/download/index.html | |
6473 | These files include: | |
6474 | @itemize @bullet | |
8642bc8f | 6475 | @item |
b247355e | 6476 | Announcement of the most recent release. |
8642bc8f | 6477 | @item |
b247355e | 6478 | News entry (remember to update both the top level and the news directory). |
8973da3a | 6479 | @end itemize |
0816590b | 6480 | These pages also need to be regenerate using @code{index.sh}. |
8973da3a | 6481 | |
0816590b | 6482 | @item download/onlinedocs/ |
8642bc8f AC |
6483 | You need to find the magic command that is used to generate the online |
6484 | docs from the @file{.tar.bz2}. The best way is to look in the output | |
0816590b | 6485 | from one of the nightly @code{cron} jobs and then just edit accordingly. |
8642bc8f AC |
6486 | Something like: |
6487 | ||
474c8240 | 6488 | @smallexample |
8642bc8f | 6489 | $ ~/ss/update-web-docs \ |
0816590b | 6490 | ~ftp/pub/gdb/releases/gdb-5.2.tar.bz2 \ |
8642bc8f | 6491 | $PWD/www \ |
0816590b | 6492 | /www/sourceware/htdocs/gdb/download/onlinedocs \ |
8642bc8f | 6493 | gdb |
474c8240 | 6494 | @end smallexample |
8642bc8f | 6495 | |
0816590b AC |
6496 | @item download/ari/ |
6497 | Just like the online documentation. Something like: | |
8642bc8f | 6498 | |
0816590b AC |
6499 | @smallexample |
6500 | $ /bin/sh ~/ss/update-web-ari \ | |
6501 | ~ftp/pub/gdb/releases/gdb-5.2.tar.bz2 \ | |
6502 | $PWD/www \ | |
6503 | /www/sourceware/htdocs/gdb/download/ari \ | |
6504 | gdb | |
6505 | @end smallexample | |
6506 | ||
6507 | @end table | |
6508 | ||
6509 | @subsubheading Shadow the pages onto gnu | |
6510 | ||
6511 | Something goes here. | |
6512 | ||
6513 | ||
6514 | @subsubheading Install the @value{GDBN} tar ball on GNU | |
6515 | ||
6516 | At the time of writing, the GNU machine was @kbd{gnudist.gnu.org} in | |
6517 | @file{~ftp/gnu/gdb}. | |
6518 | ||
6519 | @subsubheading Make the @file{ANNOUNCEMENT} | |
6520 | ||
6521 | Post the @file{ANNOUNCEMENT} file you created above to: | |
8642bc8f AC |
6522 | |
6523 | @itemize @bullet | |
6524 | @item | |
6525 | @email{gdb-announce@@sources.redhat.com, GDB Announcement mailing list} | |
6526 | @item | |
0816590b AC |
6527 | @email{info-gnu@@gnu.org, General GNU Announcement list} (but delay it a |
6528 | day or so to let things get out) | |
6529 | @item | |
6530 | @email{bug-gdb@@gnu.org, GDB Bug Report mailing list} | |
8642bc8f AC |
6531 | @end itemize |
6532 | ||
0816590b | 6533 | @subsection Cleanup |
8642bc8f | 6534 | |
0816590b | 6535 | The release is out but you're still not finished. |
8642bc8f | 6536 | |
0816590b | 6537 | @subsubheading Commit outstanding changes |
8642bc8f | 6538 | |
0816590b | 6539 | In particular you'll need to commit any changes to: |
8642bc8f AC |
6540 | |
6541 | @itemize @bullet | |
6542 | @item | |
6543 | @file{gdb/ChangeLog} | |
6544 | @item | |
6545 | @file{gdb/version.in} | |
6546 | @item | |
6547 | @file{gdb/NEWS} | |
6548 | @item | |
6549 | @file{gdb/README} | |
6550 | @end itemize | |
6551 | ||
0816590b | 6552 | @subsubheading Tag the release |
8642bc8f AC |
6553 | |
6554 | Something like: | |
6555 | ||
474c8240 | 6556 | @smallexample |
8642bc8f AC |
6557 | $ d=`date -u +%Y-%m-%d` |
6558 | $ echo $d | |
6559 | 2002-01-24 | |
6560 | $ ( cd insight/src/gdb && cvs -f -q update ) | |
0816590b | 6561 | $ ( cd insight/src && cvs -f -q tag gdb_5_2-$d-release ) |
474c8240 | 6562 | @end smallexample |
8642bc8f | 6563 | |
0816590b | 6564 | Insight is used since that contains more of the release than |
b247355e | 6565 | @value{GDBN}. |
0816590b AC |
6566 | |
6567 | @subsubheading Mention the release on the trunk | |
8642bc8f | 6568 | |
0816590b AC |
6569 | Just put something in the @file{ChangeLog} so that the trunk also |
6570 | indicates when the release was made. | |
6571 | ||
6572 | @subsubheading Restart @file{gdb/version.in} | |
8642bc8f AC |
6573 | |
6574 | If @file{gdb/version.in} does not contain an ISO date such as | |
6575 | @kbd{2002-01-24} then the daily @code{cronjob} won't update it. Having | |
6576 | committed all the release changes it can be set to | |
0816590b | 6577 | @file{5.2.0_0000-00-00-cvs} which will restart things (yes the @kbd{_} |
8642bc8f AC |
6578 | is important - it affects the snapshot process). |
6579 | ||
6580 | Don't forget the @file{ChangeLog}. | |
6581 | ||
0816590b | 6582 | @subsubheading Merge into trunk |
8973da3a | 6583 | |
8642bc8f AC |
6584 | The files committed to the branch may also need changes merged into the |
6585 | trunk. | |
8973da3a | 6586 | |
0816590b AC |
6587 | @subsubheading Revise the release schedule |
6588 | ||
6589 | Post a revised release schedule to @email{gdb@@sources.redhat.com, GDB | |
6590 | Discussion List} with an updated announcement. The schedule can be | |
6591 | generated by running: | |
6592 | ||
6593 | @smallexample | |
6594 | $ ~/ss/schedule `date +%s` schedule | |
6595 | @end smallexample | |
6596 | ||
6597 | @noindent | |
6598 | The first parameter is approximate date/time in seconds (from the epoch) | |
6599 | of the most recent release. | |
6600 | ||
6601 | Also update the schedule @code{cronjob}. | |
6602 | ||
8642bc8f | 6603 | @section Post release |
8973da3a | 6604 | |
8642bc8f | 6605 | Remove any @code{OBSOLETE} code. |
8973da3a | 6606 | |
085dd6e6 JM |
6607 | @node Testsuite |
6608 | ||
6609 | @chapter Testsuite | |
56caf160 | 6610 | @cindex test suite |
085dd6e6 | 6611 | |
56caf160 EZ |
6612 | The testsuite is an important component of the @value{GDBN} package. |
6613 | While it is always worthwhile to encourage user testing, in practice | |
6614 | this is rarely sufficient; users typically use only a small subset of | |
6615 | the available commands, and it has proven all too common for a change | |
6616 | to cause a significant regression that went unnoticed for some time. | |
085dd6e6 | 6617 | |
b247355e NR |
6618 | The @value{GDBN} testsuite uses the DejaGNU testing framework. The |
6619 | tests themselves are calls to various @code{Tcl} procs; the framework | |
6620 | runs all the procs and summarizes the passes and fails. | |
085dd6e6 JM |
6621 | |
6622 | @section Using the Testsuite | |
6623 | ||
56caf160 | 6624 | @cindex running the test suite |
25822942 | 6625 | To run the testsuite, simply go to the @value{GDBN} object directory (or to the |
085dd6e6 JM |
6626 | testsuite's objdir) and type @code{make check}. This just sets up some |
6627 | environment variables and invokes DejaGNU's @code{runtest} script. While | |
6628 | the testsuite is running, you'll get mentions of which test file is in use, | |
6629 | and a mention of any unexpected passes or fails. When the testsuite is | |
6630 | finished, you'll get a summary that looks like this: | |
56caf160 | 6631 | |
474c8240 | 6632 | @smallexample |
085dd6e6 JM |
6633 | === gdb Summary === |
6634 | ||
6635 | # of expected passes 6016 | |
6636 | # of unexpected failures 58 | |
6637 | # of unexpected successes 5 | |
6638 | # of expected failures 183 | |
6639 | # of unresolved testcases 3 | |
6640 | # of untested testcases 5 | |
474c8240 | 6641 | @end smallexample |
56caf160 | 6642 | |
a9f158ec JB |
6643 | To run a specific test script, type: |
6644 | @example | |
6645 | make check RUNTESTFLAGS='@var{tests}' | |
6646 | @end example | |
6647 | where @var{tests} is a list of test script file names, separated by | |
6648 | spaces. | |
6649 | ||
085dd6e6 JM |
6650 | The ideal test run consists of expected passes only; however, reality |
6651 | conspires to keep us from this ideal. Unexpected failures indicate | |
56caf160 EZ |
6652 | real problems, whether in @value{GDBN} or in the testsuite. Expected |
6653 | failures are still failures, but ones which have been decided are too | |
6654 | hard to deal with at the time; for instance, a test case might work | |
6655 | everywhere except on AIX, and there is no prospect of the AIX case | |
6656 | being fixed in the near future. Expected failures should not be added | |
6657 | lightly, since you may be masking serious bugs in @value{GDBN}. | |
6658 | Unexpected successes are expected fails that are passing for some | |
6659 | reason, while unresolved and untested cases often indicate some minor | |
6660 | catastrophe, such as the compiler being unable to deal with a test | |
6661 | program. | |
6662 | ||
6663 | When making any significant change to @value{GDBN}, you should run the | |
6664 | testsuite before and after the change, to confirm that there are no | |
6665 | regressions. Note that truly complete testing would require that you | |
6666 | run the testsuite with all supported configurations and a variety of | |
6667 | compilers; however this is more than really necessary. In many cases | |
6668 | testing with a single configuration is sufficient. Other useful | |
6669 | options are to test one big-endian (Sparc) and one little-endian (x86) | |
6670 | host, a cross config with a builtin simulator (powerpc-eabi, | |
6671 | mips-elf), or a 64-bit host (Alpha). | |
6672 | ||
6673 | If you add new functionality to @value{GDBN}, please consider adding | |
6674 | tests for it as well; this way future @value{GDBN} hackers can detect | |
6675 | and fix their changes that break the functionality you added. | |
6676 | Similarly, if you fix a bug that was not previously reported as a test | |
6677 | failure, please add a test case for it. Some cases are extremely | |
6678 | difficult to test, such as code that handles host OS failures or bugs | |
6679 | in particular versions of compilers, and it's OK not to try to write | |
6680 | tests for all of those. | |
085dd6e6 | 6681 | |
e7dc800a MC |
6682 | DejaGNU supports separate build, host, and target machines. However, |
6683 | some @value{GDBN} test scripts do not work if the build machine and | |
6684 | the host machine are not the same. In such an environment, these scripts | |
6685 | will give a result of ``UNRESOLVED'', like this: | |
6686 | ||
6687 | @smallexample | |
6688 | UNRESOLVED: gdb.base/example.exp: This test script does not work on a remote host. | |
6689 | @end smallexample | |
6690 | ||
085dd6e6 JM |
6691 | @section Testsuite Organization |
6692 | ||
56caf160 | 6693 | @cindex test suite organization |
085dd6e6 JM |
6694 | The testsuite is entirely contained in @file{gdb/testsuite}. While the |
6695 | testsuite includes some makefiles and configury, these are very minimal, | |
6696 | and used for little besides cleaning up, since the tests themselves | |
25822942 | 6697 | handle the compilation of the programs that @value{GDBN} will run. The file |
085dd6e6 | 6698 | @file{testsuite/lib/gdb.exp} contains common utility procs useful for |
25822942 | 6699 | all @value{GDBN} tests, while the directory @file{testsuite/config} contains |
085dd6e6 JM |
6700 | configuration-specific files, typically used for special-purpose |
6701 | definitions of procs like @code{gdb_load} and @code{gdb_start}. | |
6702 | ||
6703 | The tests themselves are to be found in @file{testsuite/gdb.*} and | |
6704 | subdirectories of those. The names of the test files must always end | |
6705 | with @file{.exp}. DejaGNU collects the test files by wildcarding | |
6706 | in the test directories, so both subdirectories and individual files | |
6707 | get chosen and run in alphabetical order. | |
6708 | ||
6709 | The following table lists the main types of subdirectories and what they | |
6710 | are for. Since DejaGNU finds test files no matter where they are | |
6711 | located, and since each test file sets up its own compilation and | |
6712 | execution environment, this organization is simply for convenience and | |
6713 | intelligibility. | |
6714 | ||
56caf160 | 6715 | @table @file |
085dd6e6 | 6716 | @item gdb.base |
085dd6e6 | 6717 | This is the base testsuite. The tests in it should apply to all |
25822942 | 6718 | configurations of @value{GDBN} (but generic native-only tests may live here). |
085dd6e6 | 6719 | The test programs should be in the subset of C that is valid K&R, |
49efadf5 | 6720 | ANSI/ISO, and C@t{++} (@code{#ifdef}s are allowed if necessary, for instance |
085dd6e6 JM |
6721 | for prototypes). |
6722 | ||
6723 | @item gdb.@var{lang} | |
56caf160 | 6724 | Language-specific tests for any language @var{lang} besides C. Examples are |
af6cf26d | 6725 | @file{gdb.cp} and @file{gdb.java}. |
085dd6e6 JM |
6726 | |
6727 | @item gdb.@var{platform} | |
085dd6e6 JM |
6728 | Non-portable tests. The tests are specific to a specific configuration |
6729 | (host or target), such as HP-UX or eCos. Example is @file{gdb.hp}, for | |
6730 | HP-UX. | |
6731 | ||
6732 | @item gdb.@var{compiler} | |
085dd6e6 JM |
6733 | Tests specific to a particular compiler. As of this writing (June |
6734 | 1999), there aren't currently any groups of tests in this category that | |
6735 | couldn't just as sensibly be made platform-specific, but one could | |
56caf160 EZ |
6736 | imagine a @file{gdb.gcc}, for tests of @value{GDBN}'s handling of GCC |
6737 | extensions. | |
085dd6e6 JM |
6738 | |
6739 | @item gdb.@var{subsystem} | |
25822942 | 6740 | Tests that exercise a specific @value{GDBN} subsystem in more depth. For |
085dd6e6 JM |
6741 | instance, @file{gdb.disasm} exercises various disassemblers, while |
6742 | @file{gdb.stabs} tests pathways through the stabs symbol reader. | |
085dd6e6 JM |
6743 | @end table |
6744 | ||
6745 | @section Writing Tests | |
56caf160 | 6746 | @cindex writing tests |
085dd6e6 | 6747 | |
25822942 | 6748 | In many areas, the @value{GDBN} tests are already quite comprehensive; you |
085dd6e6 JM |
6749 | should be able to copy existing tests to handle new cases. |
6750 | ||
6751 | You should try to use @code{gdb_test} whenever possible, since it | |
6752 | includes cases to handle all the unexpected errors that might happen. | |
6753 | However, it doesn't cost anything to add new test procedures; for | |
6754 | instance, @file{gdb.base/exprs.exp} defines a @code{test_expr} that | |
6755 | calls @code{gdb_test} multiple times. | |
6756 | ||
6757 | Only use @code{send_gdb} and @code{gdb_expect} when absolutely | |
8a3dae3e DJ |
6758 | necessary. Even if @value{GDBN} has several valid responses to |
6759 | a command, you can use @code{gdb_test_multiple}. Like @code{gdb_test}, | |
6760 | @code{gdb_test_multiple} recognizes internal errors and unexpected | |
6761 | prompts. | |
6762 | ||
6763 | Do not write tests which expect a literal tab character from @value{GDBN}. | |
6764 | On some operating systems (e.g.@: OpenBSD) the TTY layer expands tabs to | |
6765 | spaces, so by the time @value{GDBN}'s output reaches expect the tab is gone. | |
085dd6e6 JM |
6766 | |
6767 | The source language programs do @emph{not} need to be in a consistent | |
25822942 | 6768 | style. Since @value{GDBN} is used to debug programs written in many different |
085dd6e6 | 6769 | styles, it's worth having a mix of styles in the testsuite; for |
25822942 | 6770 | instance, some @value{GDBN} bugs involving the display of source lines would |
085dd6e6 JM |
6771 | never manifest themselves if the programs used GNU coding style |
6772 | uniformly. | |
6773 | ||
c906108c SS |
6774 | @node Hints |
6775 | ||
6776 | @chapter Hints | |
6777 | ||
6778 | Check the @file{README} file, it often has useful information that does not | |
6779 | appear anywhere else in the directory. | |
6780 | ||
6781 | @menu | |
25822942 | 6782 | * Getting Started:: Getting started working on @value{GDBN} |
33e16fad | 6783 | * Debugging GDB:: Debugging @value{GDBN} with itself |
c906108c SS |
6784 | @end menu |
6785 | ||
6786 | @node Getting Started,,, Hints | |
6787 | ||
6788 | @section Getting Started | |
6789 | ||
25822942 | 6790 | @value{GDBN} is a large and complicated program, and if you first starting to |
c906108c SS |
6791 | work on it, it can be hard to know where to start. Fortunately, if you |
6792 | know how to go about it, there are ways to figure out what is going on. | |
6793 | ||
25822942 DB |
6794 | This manual, the @value{GDBN} Internals manual, has information which applies |
6795 | generally to many parts of @value{GDBN}. | |
c906108c SS |
6796 | |
6797 | Information about particular functions or data structures are located in | |
6798 | comments with those functions or data structures. If you run across a | |
6799 | function or a global variable which does not have a comment correctly | |
25822942 | 6800 | explaining what is does, this can be thought of as a bug in @value{GDBN}; feel |
c906108c SS |
6801 | free to submit a bug report, with a suggested comment if you can figure |
6802 | out what the comment should say. If you find a comment which is | |
6803 | actually wrong, be especially sure to report that. | |
6804 | ||
6805 | Comments explaining the function of macros defined in host, target, or | |
6806 | native dependent files can be in several places. Sometimes they are | |
6807 | repeated every place the macro is defined. Sometimes they are where the | |
6808 | macro is used. Sometimes there is a header file which supplies a | |
6809 | default definition of the macro, and the comment is there. This manual | |
6810 | also documents all the available macros. | |
6811 | @c (@pxref{Host Conditionals}, @pxref{Target | |
6812 | @c Conditionals}, @pxref{Native Conditionals}, and @pxref{Obsolete | |
6813 | @c Conditionals}) | |
6814 | ||
56caf160 EZ |
6815 | Start with the header files. Once you have some idea of how |
6816 | @value{GDBN}'s internal symbol tables are stored (see @file{symtab.h}, | |
6817 | @file{gdbtypes.h}), you will find it much easier to understand the | |
6818 | code which uses and creates those symbol tables. | |
c906108c SS |
6819 | |
6820 | You may wish to process the information you are getting somehow, to | |
6821 | enhance your understanding of it. Summarize it, translate it to another | |
25822942 | 6822 | language, add some (perhaps trivial or non-useful) feature to @value{GDBN}, use |
c906108c SS |
6823 | the code to predict what a test case would do and write the test case |
6824 | and verify your prediction, etc. If you are reading code and your eyes | |
6825 | are starting to glaze over, this is a sign you need to use a more active | |
6826 | approach. | |
6827 | ||
25822942 | 6828 | Once you have a part of @value{GDBN} to start with, you can find more |
c906108c SS |
6829 | specifically the part you are looking for by stepping through each |
6830 | function with the @code{next} command. Do not use @code{step} or you | |
6831 | will quickly get distracted; when the function you are stepping through | |
6832 | calls another function try only to get a big-picture understanding | |
6833 | (perhaps using the comment at the beginning of the function being | |
6834 | called) of what it does. This way you can identify which of the | |
6835 | functions being called by the function you are stepping through is the | |
6836 | one which you are interested in. You may need to examine the data | |
6837 | structures generated at each stage, with reference to the comments in | |
6838 | the header files explaining what the data structures are supposed to | |
6839 | look like. | |
6840 | ||
6841 | Of course, this same technique can be used if you are just reading the | |
6842 | code, rather than actually stepping through it. The same general | |
6843 | principle applies---when the code you are looking at calls something | |
6844 | else, just try to understand generally what the code being called does, | |
6845 | rather than worrying about all its details. | |
6846 | ||
56caf160 EZ |
6847 | @cindex command implementation |
6848 | A good place to start when tracking down some particular area is with | |
6849 | a command which invokes that feature. Suppose you want to know how | |
6850 | single-stepping works. As a @value{GDBN} user, you know that the | |
6851 | @code{step} command invokes single-stepping. The command is invoked | |
6852 | via command tables (see @file{command.h}); by convention the function | |
6853 | which actually performs the command is formed by taking the name of | |
6854 | the command and adding @samp{_command}, or in the case of an | |
6855 | @code{info} subcommand, @samp{_info}. For example, the @code{step} | |
6856 | command invokes the @code{step_command} function and the @code{info | |
6857 | display} command invokes @code{display_info}. When this convention is | |
6858 | not followed, you might have to use @code{grep} or @kbd{M-x | |
6859 | tags-search} in emacs, or run @value{GDBN} on itself and set a | |
6860 | breakpoint in @code{execute_command}. | |
6861 | ||
6862 | @cindex @code{bug-gdb} mailing list | |
c906108c SS |
6863 | If all of the above fail, it may be appropriate to ask for information |
6864 | on @code{bug-gdb}. But @emph{never} post a generic question like ``I was | |
6865 | wondering if anyone could give me some tips about understanding | |
25822942 | 6866 | @value{GDBN}''---if we had some magic secret we would put it in this manual. |
c906108c SS |
6867 | Suggestions for improving the manual are always welcome, of course. |
6868 | ||
33e16fad | 6869 | @node Debugging GDB,,,Hints |
c906108c | 6870 | |
25822942 | 6871 | @section Debugging @value{GDBN} with itself |
56caf160 | 6872 | @cindex debugging @value{GDBN} |
c906108c | 6873 | |
25822942 | 6874 | If @value{GDBN} is limping on your machine, this is the preferred way to get it |
c906108c SS |
6875 | fully functional. Be warned that in some ancient Unix systems, like |
6876 | Ultrix 4.2, a program can't be running in one process while it is being | |
56caf160 | 6877 | debugged in another. Rather than typing the command @kbd{@w{./gdb |
c906108c | 6878 | ./gdb}}, which works on Suns and such, you can copy @file{gdb} to |
56caf160 | 6879 | @file{gdb2} and then type @kbd{@w{./gdb ./gdb2}}. |
c906108c | 6880 | |
25822942 | 6881 | When you run @value{GDBN} in the @value{GDBN} source directory, it will read a |
c906108c SS |
6882 | @file{.gdbinit} file that sets up some simple things to make debugging |
6883 | gdb easier. The @code{info} command, when executed without a subcommand | |
25822942 | 6884 | in a @value{GDBN} being debugged by gdb, will pop you back up to the top level |
c906108c SS |
6885 | gdb. See @file{.gdbinit} for details. |
6886 | ||
6887 | If you use emacs, you will probably want to do a @code{make TAGS} after | |
6888 | you configure your distribution; this will put the machine dependent | |
6889 | routines for your local machine where they will be accessed first by | |
6890 | @kbd{M-.} | |
6891 | ||
25822942 | 6892 | Also, make sure that you've either compiled @value{GDBN} with your local cc, or |
c906108c SS |
6893 | have run @code{fixincludes} if you are compiling with gcc. |
6894 | ||
6895 | @section Submitting Patches | |
6896 | ||
56caf160 | 6897 | @cindex submitting patches |
c906108c | 6898 | Thanks for thinking of offering your changes back to the community of |
25822942 | 6899 | @value{GDBN} users. In general we like to get well designed enhancements. |
c906108c SS |
6900 | Thanks also for checking in advance about the best way to transfer the |
6901 | changes. | |
6902 | ||
25822942 DB |
6903 | The @value{GDBN} maintainers will only install ``cleanly designed'' patches. |
6904 | This manual summarizes what we believe to be clean design for @value{GDBN}. | |
c906108c SS |
6905 | |
6906 | If the maintainers don't have time to put the patch in when it arrives, | |
6907 | or if there is any question about a patch, it goes into a large queue | |
6908 | with everyone else's patches and bug reports. | |
6909 | ||
56caf160 | 6910 | @cindex legal papers for code contributions |
c906108c SS |
6911 | The legal issue is that to incorporate substantial changes requires a |
6912 | copyright assignment from you and/or your employer, granting ownership | |
6913 | of the changes to the Free Software Foundation. You can get the | |
9e0b60a8 JM |
6914 | standard documents for doing this by sending mail to @code{gnu@@gnu.org} |
6915 | and asking for it. We recommend that people write in "All programs | |
6916 | owned by the Free Software Foundation" as "NAME OF PROGRAM", so that | |
56caf160 EZ |
6917 | changes in many programs (not just @value{GDBN}, but GAS, Emacs, GCC, |
6918 | etc) can be | |
9e0b60a8 | 6919 | contributed with only one piece of legalese pushed through the |
be9c6c35 | 6920 | bureaucracy and filed with the FSF. We can't start merging changes until |
9e0b60a8 JM |
6921 | this paperwork is received by the FSF (their rules, which we follow |
6922 | since we maintain it for them). | |
c906108c SS |
6923 | |
6924 | Technically, the easiest way to receive changes is to receive each | |
56caf160 EZ |
6925 | feature as a small context diff or unidiff, suitable for @code{patch}. |
6926 | Each message sent to me should include the changes to C code and | |
6927 | header files for a single feature, plus @file{ChangeLog} entries for | |
6928 | each directory where files were modified, and diffs for any changes | |
6929 | needed to the manuals (@file{gdb/doc/gdb.texinfo} or | |
6930 | @file{gdb/doc/gdbint.texinfo}). If there are a lot of changes for a | |
6931 | single feature, they can be split down into multiple messages. | |
9e0b60a8 JM |
6932 | |
6933 | In this way, if we read and like the feature, we can add it to the | |
c906108c | 6934 | sources with a single patch command, do some testing, and check it in. |
56caf160 EZ |
6935 | If you leave out the @file{ChangeLog}, we have to write one. If you leave |
6936 | out the doc, we have to puzzle out what needs documenting. Etc., etc. | |
c906108c | 6937 | |
9e0b60a8 JM |
6938 | The reason to send each change in a separate message is that we will not |
6939 | install some of the changes. They'll be returned to you with questions | |
6940 | or comments. If we're doing our job correctly, the message back to you | |
c906108c | 6941 | will say what you have to fix in order to make the change acceptable. |
9e0b60a8 JM |
6942 | The reason to have separate messages for separate features is so that |
6943 | the acceptable changes can be installed while one or more changes are | |
6944 | being reworked. If multiple features are sent in a single message, we | |
6945 | tend to not put in the effort to sort out the acceptable changes from | |
6946 | the unacceptable, so none of the features get installed until all are | |
6947 | acceptable. | |
6948 | ||
6949 | If this sounds painful or authoritarian, well, it is. But we get a lot | |
6950 | of bug reports and a lot of patches, and many of them don't get | |
6951 | installed because we don't have the time to finish the job that the bug | |
c906108c SS |
6952 | reporter or the contributor could have done. Patches that arrive |
6953 | complete, working, and well designed, tend to get installed on the day | |
9e0b60a8 JM |
6954 | they arrive. The others go into a queue and get installed as time |
6955 | permits, which, since the maintainers have many demands to meet, may not | |
6956 | be for quite some time. | |
c906108c | 6957 | |
56caf160 | 6958 | Please send patches directly to |
47b95330 | 6959 | @email{gdb-patches@@sources.redhat.com, the @value{GDBN} maintainers}. |
c906108c | 6960 | |
36af4ef6 MD |
6961 | @section Build Script |
6962 | ||
6963 | @cindex build script | |
6964 | ||
6965 | The script @file{gdb_buildall.sh} builds @value{GDBN} with flag | |
6966 | @option{--enable-targets=all} set. This builds @value{GDBN} with all supported | |
6967 | targets activated. This helps testing @value{GDBN} when doing changes that | |
6968 | affect more than one architecture and is much faster than using | |
6969 | @file{gdb_mbuild.sh}. | |
6970 | ||
6971 | After building @value{GDBN} the script checks which architectures are | |
6972 | supported and then switches the current architecture to each of those to get | |
6973 | information about the architecture. The test results are stored in log files | |
6974 | in the directory the script was called from. | |
6975 | ||
bcd7e15f | 6976 | @include observer.texi |
2154891a | 6977 | @raisesections |
aab4e0ec | 6978 | @include fdl.texi |
2154891a | 6979 | @lowersections |
aab4e0ec | 6980 | |
56caf160 EZ |
6981 | @node Index |
6982 | @unnumbered Index | |
6983 | ||
6984 | @printindex cp | |
6985 | ||
c906108c | 6986 | @bye |