Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Data structures associated with breakpoints in GDB. |
197e01b6 | 2 | Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, |
6aba47ca | 3 | 2002, 2003, 2004, 2007 Free Software Foundation, Inc. |
c906108c | 4 | |
c5aa993b | 5 | This file is part of GDB. |
c906108c | 6 | |
c5aa993b JM |
7 | This program is free software; you can redistribute it and/or modify |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 2 of the License, or | |
10 | (at your option) any later version. | |
c906108c | 11 | |
c5aa993b JM |
12 | This program is distributed in the hope that it will be useful, |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
c906108c | 16 | |
c5aa993b JM |
17 | You should have received a copy of the GNU General Public License |
18 | along with this program; if not, write to the Free Software | |
197e01b6 EZ |
19 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
20 | Boston, MA 02110-1301, USA. */ | |
c906108c SS |
21 | |
22 | #if !defined (BREAKPOINT_H) | |
23 | #define BREAKPOINT_H 1 | |
24 | ||
25 | #include "frame.h" | |
26 | #include "value.h" | |
27 | ||
104c1213 JM |
28 | #include "gdb-events.h" |
29 | ||
278cd55f | 30 | struct value; |
fe898f56 | 31 | struct block; |
278cd55f | 32 | |
c906108c SS |
33 | /* This is the maximum number of bytes a breakpoint instruction can take. |
34 | Feel free to increase it. It's just used in a few places to size | |
35 | arrays that should be independent of the target architecture. */ | |
36 | ||
37 | #define BREAKPOINT_MAX 16 | |
38 | \f | |
39 | /* Type of breakpoint. */ | |
40 | /* FIXME In the future, we should fold all other breakpoint-like things into | |
41 | here. This includes: | |
42 | ||
43 | * single-step (for machines where we have to simulate single stepping) | |
c5aa993b JM |
44 | (probably, though perhaps it is better for it to look as much as |
45 | possible like a single-step to wait_for_inferior). */ | |
46 | ||
47 | enum bptype | |
48 | { | |
49 | bp_none = 0, /* Eventpoint has been deleted. */ | |
50 | bp_breakpoint, /* Normal breakpoint */ | |
51 | bp_hardware_breakpoint, /* Hardware assisted breakpoint */ | |
52 | bp_until, /* used by until command */ | |
53 | bp_finish, /* used by finish command */ | |
54 | bp_watchpoint, /* Watchpoint */ | |
55 | bp_hardware_watchpoint, /* Hardware assisted watchpoint */ | |
56 | bp_read_watchpoint, /* read watchpoint, (hardware assisted) */ | |
57 | bp_access_watchpoint, /* access watchpoint, (hardware assisted) */ | |
58 | bp_longjmp, /* secret breakpoint to find longjmp() */ | |
59 | bp_longjmp_resume, /* secret breakpoint to escape longjmp() */ | |
60 | ||
61 | /* Used by wait_for_inferior for stepping over subroutine calls, for | |
62 | stepping over signal handlers, and for skipping prologues. */ | |
63 | bp_step_resume, | |
64 | ||
c5aa993b JM |
65 | /* Used to detect when a watchpoint expression has gone out of |
66 | scope. These breakpoints are usually not visible to the user. | |
67 | ||
68 | This breakpoint has some interesting properties: | |
c906108c SS |
69 | |
70 | 1) There's always a 1:1 mapping between watchpoints | |
71 | on local variables and watchpoint_scope breakpoints. | |
72 | ||
73 | 2) It automatically deletes itself and the watchpoint it's | |
74 | associated with when hit. | |
75 | ||
76 | 3) It can never be disabled. */ | |
c5aa993b JM |
77 | bp_watchpoint_scope, |
78 | ||
79 | /* The breakpoint at the end of a call dummy. */ | |
80 | /* FIXME: What if the function we are calling longjmp()s out of the | |
81 | call, or the user gets out with the "return" command? We currently | |
82 | have no way of cleaning up the breakpoint in these (obscure) situations. | |
83 | (Probably can solve this by noticing longjmp, "return", etc., it's | |
84 | similar to noticing when a watchpoint on a local variable goes out | |
85 | of scope (with hardware support for watchpoints)). */ | |
86 | bp_call_dummy, | |
87 | ||
88 | /* Some dynamic linkers (HP, maybe Solaris) can arrange for special | |
89 | code in the inferior to run when significant events occur in the | |
90 | dynamic linker (for example a library is loaded or unloaded). | |
91 | ||
92 | By placing a breakpoint in this magic code GDB will get control | |
93 | when these significant events occur. GDB can then re-examine | |
94 | the dynamic linker's data structures to discover any newly loaded | |
95 | dynamic libraries. */ | |
96 | bp_shlib_event, | |
97 | ||
c4093a6a JM |
98 | /* Some multi-threaded systems can arrange for a location in the |
99 | inferior to be executed when certain thread-related events occur | |
100 | (such as thread creation or thread death). | |
101 | ||
102 | By placing a breakpoint at one of these locations, GDB will get | |
103 | control when these events occur. GDB can then update its thread | |
104 | lists etc. */ | |
105 | ||
106 | bp_thread_event, | |
107 | ||
1900040c MS |
108 | /* On the same principal, an overlay manager can arrange to call a |
109 | magic location in the inferior whenever there is an interesting | |
110 | change in overlay status. GDB can update its overlay tables | |
111 | and fiddle with breakpoints in overlays when this breakpoint | |
112 | is hit. */ | |
113 | ||
114 | bp_overlay_event, | |
115 | ||
c5aa993b JM |
116 | /* These breakpoints are used to implement the "catch load" command |
117 | on platforms whose dynamic linkers support such functionality. */ | |
118 | bp_catch_load, | |
119 | ||
120 | /* These breakpoints are used to implement the "catch unload" command | |
121 | on platforms whose dynamic linkers support such functionality. */ | |
122 | bp_catch_unload, | |
123 | ||
124 | /* These are not really breakpoints, but are catchpoints that | |
125 | implement the "catch fork", "catch vfork" and "catch exec" commands | |
126 | on platforms whose kernel support such functionality. (I.e., | |
127 | kernels which can raise an event when a fork or exec occurs, as | |
128 | opposed to the debugger setting breakpoints on functions named | |
129 | "fork" or "exec".) */ | |
130 | bp_catch_fork, | |
131 | bp_catch_vfork, | |
132 | bp_catch_exec, | |
133 | ||
134 | /* These are catchpoints to implement "catch catch" and "catch throw" | |
135 | commands for C++ exception handling. */ | |
136 | bp_catch_catch, | |
137 | bp_catch_throw | |
138 | ||
139 | ||
140 | }; | |
c906108c SS |
141 | |
142 | /* States of enablement of breakpoint. */ | |
143 | ||
b5de0fa7 | 144 | enum enable_state |
c5aa993b | 145 | { |
b5de0fa7 EZ |
146 | bp_disabled, /* The eventpoint is inactive, and cannot trigger. */ |
147 | bp_enabled, /* The eventpoint is active, and can trigger. */ | |
148 | bp_shlib_disabled, /* The eventpoint's address is in an unloaded solib. | |
53a5351d JM |
149 | The eventpoint will be automatically enabled |
150 | and reset when that solib is loaded. */ | |
b5de0fa7 | 151 | bp_call_disabled, /* The eventpoint has been disabled while a call |
53a5351d JM |
152 | into the inferior is "in flight", because some |
153 | eventpoints interfere with the implementation of | |
154 | a call on some targets. The eventpoint will be | |
155 | automatically enabled and reset when the call | |
156 | "lands" (either completes, or stops at another | |
157 | eventpoint). */ | |
b5de0fa7 | 158 | bp_permanent /* There is a breakpoint instruction hard-wired into |
c2c6d25f JM |
159 | the target's code. Don't try to write another |
160 | breakpoint instruction on top of it, or restore | |
161 | its value. Step over it using the architecture's | |
162 | SKIP_INSN macro. */ | |
c5aa993b | 163 | }; |
c906108c SS |
164 | |
165 | ||
166 | /* Disposition of breakpoint. Ie: what to do after hitting it. */ | |
167 | ||
c5aa993b JM |
168 | enum bpdisp |
169 | { | |
b5de0fa7 EZ |
170 | disp_del, /* Delete it */ |
171 | disp_del_at_next_stop, /* Delete at next stop, whether hit or not */ | |
172 | disp_disable, /* Disable it */ | |
173 | disp_donttouch /* Leave it alone */ | |
c5aa993b | 174 | }; |
c906108c | 175 | |
53a5351d JM |
176 | enum target_hw_bp_type |
177 | { | |
178 | hw_write = 0, /* Common HW watchpoint */ | |
179 | hw_read = 1, /* Read HW watchpoint */ | |
180 | hw_access = 2, /* Access HW watchpoint */ | |
181 | hw_execute = 3 /* Execute HW breakpoint */ | |
182 | }; | |
183 | ||
8181d85f DJ |
184 | |
185 | /* Information used by targets to insert and remove breakpoints. */ | |
186 | ||
187 | struct bp_target_info | |
188 | { | |
189 | /* Address at which the breakpoint was placed. This is normally the | |
190 | same as ADDRESS from the bp_location, except when adjustment | |
191 | happens in BREAKPOINT_FROM_PC. The most common form of | |
192 | adjustment is stripping an alternate ISA marker from the PC which | |
193 | is used to determine the type of breakpoint to insert. */ | |
194 | CORE_ADDR placed_address; | |
195 | ||
196 | /* If the breakpoint lives in memory and reading that memory would | |
197 | give back the breakpoint, instead of the original contents, then | |
198 | the original contents are cached here. Only SHADOW_LEN bytes of | |
199 | this buffer are valid, and only when the breakpoint is inserted. */ | |
200 | gdb_byte shadow_contents[BREAKPOINT_MAX]; | |
201 | ||
202 | /* The length of the data cached in SHADOW_CONTENTS. */ | |
203 | int shadow_len; | |
204 | ||
205 | /* The size of the placed breakpoint, according to | |
206 | BREAKPOINT_FROM_PC, when the breakpoint was inserted. This is | |
207 | generally the same as SHADOW_LEN, unless we did not need | |
208 | to read from the target to implement the memory breakpoint | |
209 | (e.g. if a remote stub handled the details). We may still | |
210 | need the size to remove the breakpoint safely. */ | |
211 | int placed_size; | |
212 | }; | |
213 | ||
5cab636d DJ |
214 | /* GDB maintains two types of information about each breakpoint (or |
215 | watchpoint, or other related event). The first type corresponds | |
216 | to struct breakpoint; this is a relatively high-level structure | |
217 | which contains the source location(s), stopping conditions, user | |
218 | commands to execute when the breakpoint is hit, and so forth. | |
219 | ||
220 | The second type of information corresponds to struct bp_location. | |
221 | Each breakpoint has one or (eventually) more locations associated | |
222 | with it, which represent target-specific and machine-specific | |
223 | mechanisms for stopping the program. For instance, a watchpoint | |
224 | expression may require multiple hardware watchpoints in order to | |
225 | catch all changes in the value of the expression being watched. */ | |
226 | ||
227 | enum bp_loc_type | |
228 | { | |
229 | bp_loc_software_breakpoint, | |
230 | bp_loc_hardware_breakpoint, | |
231 | bp_loc_hardware_watchpoint, | |
232 | bp_loc_other /* Miscellaneous... */ | |
233 | }; | |
234 | ||
235 | struct bp_location | |
236 | { | |
7cc221ef DJ |
237 | /* Chain pointer to the next breakpoint location. */ |
238 | struct bp_location *next; | |
239 | ||
5cab636d DJ |
240 | /* Type of this breakpoint location. */ |
241 | enum bp_loc_type loc_type; | |
242 | ||
243 | /* Each breakpoint location must belong to exactly one higher-level | |
244 | breakpoint. This and the DUPLICATE flag are more straightforward | |
245 | than reference counting. */ | |
246 | struct breakpoint *owner; | |
247 | ||
248 | /* Nonzero if this breakpoint is now inserted. */ | |
249 | char inserted; | |
250 | ||
251 | /* Nonzero if this is not the first breakpoint in the list | |
252 | for the given address. */ | |
253 | char duplicate; | |
254 | ||
255 | /* If we someday support real thread-specific breakpoints, then | |
256 | the breakpoint location will need a thread identifier. */ | |
257 | ||
258 | /* Data for specific breakpoint types. These could be a union, but | |
259 | simplicity is more important than memory usage for breakpoints. */ | |
260 | ||
261 | /* Note that zero is a perfectly valid code address on some platforms | |
262 | (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL | |
263 | is not a special value for this field. Valid for all types except | |
264 | bp_loc_other. */ | |
265 | CORE_ADDR address; | |
266 | ||
cf3a9e5b DJ |
267 | /* For any breakpoint type with an address, this is the BFD section |
268 | associated with the address. Used primarily for overlay debugging. */ | |
269 | asection *section; | |
270 | ||
5cab636d DJ |
271 | /* Address at which breakpoint was requested, either by the user or |
272 | by GDB for internal breakpoints. This will usually be the same | |
273 | as ``address'' (above) except for cases in which | |
274 | ADJUST_BREAKPOINT_ADDRESS has computed a different address at | |
275 | which to place the breakpoint in order to comply with a | |
276 | processor's architectual constraints. */ | |
277 | CORE_ADDR requested_address; | |
8181d85f DJ |
278 | |
279 | /* Details of the placed breakpoint, when inserted. */ | |
280 | struct bp_target_info target_info; | |
281 | ||
282 | /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */ | |
283 | struct bp_target_info overlay_target_info; | |
5cab636d DJ |
284 | }; |
285 | ||
3086aeae DJ |
286 | /* This structure is a collection of function pointers that, if available, |
287 | will be called instead of the performing the default action for this | |
288 | bptype. */ | |
289 | ||
290 | struct breakpoint_ops | |
291 | { | |
292 | /* The normal print routine for this breakpoint, called when we | |
293 | hit it. */ | |
294 | enum print_stop_action (*print_it) (struct breakpoint *); | |
295 | ||
296 | /* Display information about this breakpoint, for "info breakpoints". */ | |
297 | void (*print_one) (struct breakpoint *, CORE_ADDR *); | |
298 | ||
299 | /* Display information about this breakpoint after setting it (roughly | |
300 | speaking; this is called from "mention"). */ | |
301 | void (*print_mention) (struct breakpoint *); | |
302 | }; | |
303 | ||
c906108c SS |
304 | /* Note that the ->silent field is not currently used by any commands |
305 | (though the code is in there if it was to be, and set_raw_breakpoint | |
306 | does set it to 0). I implemented it because I thought it would be | |
307 | useful for a hack I had to put in; I'm going to leave it in because | |
308 | I can see how there might be times when it would indeed be useful */ | |
309 | ||
310 | /* This is for a breakpoint or a watchpoint. */ | |
311 | ||
312 | struct breakpoint | |
c5aa993b JM |
313 | { |
314 | struct breakpoint *next; | |
315 | /* Type of breakpoint. */ | |
316 | enum bptype type; | |
317 | /* Zero means disabled; remember the info but don't break here. */ | |
b5de0fa7 | 318 | enum enable_state enable_state; |
c5aa993b JM |
319 | /* What to do with this breakpoint after we hit it. */ |
320 | enum bpdisp disposition; | |
321 | /* Number assigned to distinguish breakpoints. */ | |
322 | int number; | |
323 | ||
5cab636d DJ |
324 | /* Location(s) associated with this high-level breakpoint. */ |
325 | struct bp_location *loc; | |
76897487 | 326 | |
644a1fe1 | 327 | /* Line number of this address. */ |
c5aa993b JM |
328 | |
329 | int line_number; | |
330 | ||
644a1fe1 | 331 | /* Source file name of this address. */ |
c5aa993b JM |
332 | |
333 | char *source_file; | |
334 | ||
335 | /* Non-zero means a silent breakpoint (don't print frame info | |
336 | if we stop here). */ | |
337 | unsigned char silent; | |
338 | /* Number of stops at this breakpoint that should | |
339 | be continued automatically before really stopping. */ | |
340 | int ignore_count; | |
c5aa993b JM |
341 | /* Chain of command lines to execute when this breakpoint is hit. */ |
342 | struct command_line *commands; | |
343 | /* Stack depth (address of frame). If nonzero, break only if fp | |
344 | equals this. */ | |
818dd999 | 345 | struct frame_id frame_id; |
c5aa993b JM |
346 | /* Conditional. Break only if this expression's value is nonzero. */ |
347 | struct expression *cond; | |
348 | ||
644a1fe1 | 349 | /* String we used to set the breakpoint (malloc'd). */ |
c5aa993b JM |
350 | char *addr_string; |
351 | /* Language we used to set the breakpoint. */ | |
352 | enum language language; | |
353 | /* Input radix we used to set the breakpoint. */ | |
354 | int input_radix; | |
355 | /* String form of the breakpoint condition (malloc'd), or NULL if there | |
356 | is no condition. */ | |
357 | char *cond_string; | |
358 | /* String form of exp (malloc'd), or NULL if none. */ | |
359 | char *exp_string; | |
360 | ||
361 | /* The expression we are watching, or NULL if not a watchpoint. */ | |
362 | struct expression *exp; | |
363 | /* The largest block within which it is valid, or NULL if it is | |
364 | valid anywhere (e.g. consists just of global symbols). */ | |
365 | struct block *exp_valid_block; | |
366 | /* Value of the watchpoint the last time we checked it. */ | |
278cd55f | 367 | struct value *val; |
c5aa993b JM |
368 | |
369 | /* Holds the value chain for a hardware watchpoint expression. */ | |
278cd55f | 370 | struct value *val_chain; |
c5aa993b JM |
371 | |
372 | /* Holds the address of the related watchpoint_scope breakpoint | |
373 | when using watchpoints on local variables (might the concept | |
374 | of a related breakpoint be useful elsewhere, if not just call | |
375 | it the watchpoint_scope breakpoint or something like that. FIXME). */ | |
376 | struct breakpoint *related_breakpoint; | |
377 | ||
101dcfbe AC |
378 | /* Holds the frame address which identifies the frame this |
379 | watchpoint should be evaluated in, or `null' if the watchpoint | |
380 | should be evaluated on the outermost frame. */ | |
381 | struct frame_id watchpoint_frame; | |
c5aa993b JM |
382 | |
383 | /* Thread number for thread-specific breakpoint, or -1 if don't care */ | |
384 | int thread; | |
385 | ||
386 | /* Count of the number of times this breakpoint was taken, dumped | |
387 | with the info, but not used for anything else. Useful for | |
388 | seeing how many times you hit a break prior to the program | |
389 | aborting, so you can back up to just before the abort. */ | |
390 | int hit_count; | |
391 | ||
53a5351d JM |
392 | /* Filename of a dynamically-linked library (dll), used for |
393 | bp_catch_load and bp_catch_unload (malloc'd), or NULL if any | |
394 | library is significant. */ | |
c5aa993b JM |
395 | char *dll_pathname; |
396 | ||
397 | /* Filename of a dll whose state change (e.g., load or unload) | |
7e73cedf | 398 | triggered this catchpoint. This field is only valid immediately |
c5aa993b JM |
399 | after this catchpoint has triggered. */ |
400 | char *triggered_dll_pathname; | |
401 | ||
53a5351d | 402 | /* Process id of a child process whose forking triggered this |
7e73cedf | 403 | catchpoint. This field is only valid immediately after this |
53a5351d | 404 | catchpoint has triggered. */ |
c5aa993b JM |
405 | int forked_inferior_pid; |
406 | ||
53a5351d | 407 | /* Filename of a program whose exec triggered this catchpoint. |
7e73cedf | 408 | This field is only valid immediately after this catchpoint has |
53a5351d | 409 | triggered. */ |
c5aa993b JM |
410 | char *exec_pathname; |
411 | ||
3086aeae DJ |
412 | /* Methods associated with this breakpoint. */ |
413 | struct breakpoint_ops *ops; | |
0101ce28 JJ |
414 | |
415 | /* Was breakpoint issued from a tty? Saved for the use of pending breakpoints. */ | |
416 | int from_tty; | |
417 | ||
418 | /* Flag value for pending breakpoint. | |
419 | first bit : 0 non-temporary, 1 temporary. | |
420 | second bit : 0 normal breakpoint, 1 hardware breakpoint. */ | |
421 | int flag; | |
422 | ||
423 | /* Is breakpoint pending on shlib loads? */ | |
424 | int pending; | |
c5aa993b | 425 | }; |
c906108c | 426 | \f |
53a5351d JM |
427 | /* The following stuff is an abstract data type "bpstat" ("breakpoint |
428 | status"). This provides the ability to determine whether we have | |
429 | stopped at a breakpoint, and what we should do about it. */ | |
c906108c SS |
430 | |
431 | typedef struct bpstats *bpstat; | |
432 | ||
433 | /* Interface: */ | |
434 | /* Clear a bpstat so that it says we are not at any breakpoint. | |
435 | Also free any storage that is part of a bpstat. */ | |
a14ed312 | 436 | extern void bpstat_clear (bpstat *); |
c906108c SS |
437 | |
438 | /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that | |
439 | is part of the bpstat is copied as well. */ | |
a14ed312 | 440 | extern bpstat bpstat_copy (bpstat); |
c906108c | 441 | |
00d4360e UW |
442 | extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid, |
443 | int stopped_by_watchpoint); | |
c906108c SS |
444 | \f |
445 | /* This bpstat_what stuff tells wait_for_inferior what to do with a | |
446 | breakpoint (a challenging task). */ | |
447 | ||
c5aa993b JM |
448 | enum bpstat_what_main_action |
449 | { | |
450 | /* Perform various other tests; that is, this bpstat does not | |
451 | say to perform any action (e.g. failed watchpoint and nothing | |
452 | else). */ | |
453 | BPSTAT_WHAT_KEEP_CHECKING, | |
454 | ||
455 | /* Rather than distinguish between noisy and silent stops here, it | |
456 | might be cleaner to have bpstat_print make that decision (also | |
457 | taking into account stop_print_frame and source_only). But the | |
458 | implications are a bit scary (interaction with auto-displays, etc.), | |
459 | so I won't try it. */ | |
460 | ||
461 | /* Stop silently. */ | |
462 | BPSTAT_WHAT_STOP_SILENT, | |
463 | ||
464 | /* Stop and print. */ | |
465 | BPSTAT_WHAT_STOP_NOISY, | |
466 | ||
467 | /* Remove breakpoints, single step once, then put them back in and | |
468 | go back to what we were doing. It's possible that this should be | |
469 | removed from the main_action and put into a separate field, to more | |
470 | cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */ | |
471 | BPSTAT_WHAT_SINGLE, | |
472 | ||
473 | /* Set longjmp_resume breakpoint, remove all other breakpoints, | |
474 | and continue. The "remove all other breakpoints" part is required | |
475 | if we are also stepping over another breakpoint as well as doing | |
476 | the longjmp handling. */ | |
477 | BPSTAT_WHAT_SET_LONGJMP_RESUME, | |
478 | ||
479 | /* Clear longjmp_resume breakpoint, then handle as | |
480 | BPSTAT_WHAT_KEEP_CHECKING. */ | |
481 | BPSTAT_WHAT_CLEAR_LONGJMP_RESUME, | |
482 | ||
483 | /* Clear longjmp_resume breakpoint, then handle as BPSTAT_WHAT_SINGLE. */ | |
484 | BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE, | |
485 | ||
486 | /* Clear step resume breakpoint, and keep checking. */ | |
487 | BPSTAT_WHAT_STEP_RESUME, | |
488 | ||
c5aa993b JM |
489 | /* Check the dynamic linker's data structures for new libraries, then |
490 | keep checking. */ | |
491 | BPSTAT_WHAT_CHECK_SHLIBS, | |
492 | ||
493 | /* Check the dynamic linker's data structures for new libraries, then | |
494 | resume out of the dynamic linker's callback, stop and print. */ | |
495 | BPSTAT_WHAT_CHECK_SHLIBS_RESUME_FROM_HOOK, | |
496 | ||
497 | /* This is just used to keep track of how many enums there are. */ | |
498 | BPSTAT_WHAT_LAST | |
499 | }; | |
500 | ||
501 | struct bpstat_what | |
502 | { | |
503 | enum bpstat_what_main_action main_action; | |
504 | ||
505 | /* Did we hit a call dummy breakpoint? This only goes with a main_action | |
506 | of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of | |
507 | continuing from a call dummy without popping the frame is not a | |
508 | useful one). */ | |
509 | int call_dummy; | |
510 | }; | |
c906108c | 511 | |
5c44784c JM |
512 | /* The possible return values for print_bpstat, print_it_normal, |
513 | print_it_done, print_it_noop. */ | |
514 | enum print_stop_action | |
515 | { | |
516 | PRINT_UNKNOWN = -1, | |
517 | PRINT_SRC_AND_LOC, | |
518 | PRINT_SRC_ONLY, | |
519 | PRINT_NOTHING | |
520 | }; | |
521 | ||
c906108c | 522 | /* Tell what to do about this bpstat. */ |
a14ed312 | 523 | struct bpstat_what bpstat_what (bpstat); |
c906108c SS |
524 | \f |
525 | /* Find the bpstat associated with a breakpoint. NULL otherwise. */ | |
a14ed312 | 526 | bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *); |
c906108c SS |
527 | |
528 | /* Find a step_resume breakpoint associated with this bpstat. | |
529 | (If there are multiple step_resume bp's on the list, this function | |
530 | will arbitrarily pick one.) | |
531 | ||
532 | It is an error to use this function if BPSTAT doesn't contain a | |
533 | step_resume breakpoint. | |
534 | ||
535 | See wait_for_inferior's use of this function. | |
c5aa993b | 536 | */ |
a14ed312 | 537 | extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat); |
c906108c SS |
538 | |
539 | /* Nonzero if a signal that we got in wait() was due to circumstances | |
540 | explained by the BS. */ | |
541 | /* Currently that is true if we have hit a breakpoint, or if there is | |
542 | a watchpoint enabled. */ | |
543 | #define bpstat_explains_signal(bs) ((bs) != NULL) | |
544 | ||
545 | /* Nonzero if we should step constantly (e.g. watchpoints on machines | |
546 | without hardware support). This isn't related to a specific bpstat, | |
547 | just to things like whether watchpoints are set. */ | |
a14ed312 | 548 | extern int bpstat_should_step (void); |
c906108c SS |
549 | |
550 | /* Nonzero if there are enabled hardware watchpoints. */ | |
a14ed312 | 551 | extern int bpstat_have_active_hw_watchpoints (void); |
c906108c SS |
552 | |
553 | /* Print a message indicating what happened. Returns nonzero to | |
554 | say that only the source line should be printed after this (zero | |
555 | return means print the frame as well as the source line). */ | |
a14ed312 | 556 | extern enum print_stop_action bpstat_print (bpstat); |
c906108c | 557 | |
8671a17b | 558 | /* Put in *NUM the breakpoint number of the first breakpoint we are stopped |
c906108c SS |
559 | at. *BSP upon return is a bpstat which points to the remaining |
560 | breakpoints stopped at (but which is not guaranteed to be good for | |
561 | anything but further calls to bpstat_num). | |
8671a17b PA |
562 | Return 0 if passed a bpstat which does not indicate any breakpoints. |
563 | Return -1 if stopped at a breakpoint that has been deleted since | |
564 | we set it. | |
565 | Return 1 otherwise. */ | |
566 | extern int bpstat_num (bpstat *, int *); | |
c906108c SS |
567 | |
568 | /* Perform actions associated with having stopped at *BSP. Actually, we just | |
569 | use this for breakpoint commands. Perhaps other actions will go here | |
570 | later, but this is executed at a late time (from the command loop). */ | |
a14ed312 | 571 | extern void bpstat_do_actions (bpstat *); |
c906108c SS |
572 | |
573 | /* Modify BS so that the actions will not be performed. */ | |
a14ed312 | 574 | extern void bpstat_clear_actions (bpstat); |
c906108c SS |
575 | |
576 | /* Given a bpstat that records zero or more triggered eventpoints, this | |
577 | function returns another bpstat which contains only the catchpoints | |
578 | on that first list, if any. | |
c5aa993b | 579 | */ |
a14ed312 | 580 | extern void bpstat_get_triggered_catchpoints (bpstat, bpstat *); |
c5aa993b | 581 | |
c906108c | 582 | /* Implementation: */ |
e514a9d6 JM |
583 | |
584 | /* Values used to tell the printing routine how to behave for this bpstat. */ | |
585 | enum bp_print_how | |
586 | { | |
587 | /* This is used when we want to do a normal printing of the reason | |
588 | for stopping. The output will depend on the type of eventpoint | |
589 | we are dealing with. This is the default value, most commonly | |
590 | used. */ | |
591 | print_it_normal, | |
592 | /* This is used when nothing should be printed for this bpstat entry. */ | |
593 | print_it_noop, | |
594 | /* This is used when everything which needs to be printed has | |
595 | already been printed. But we still want to print the frame. */ | |
596 | print_it_done | |
597 | }; | |
598 | ||
c906108c | 599 | struct bpstats |
c5aa993b | 600 | { |
53a5351d JM |
601 | /* Linked list because there can be two breakpoints at the same |
602 | place, and a bpstat reflects the fact that both have been hit. */ | |
c5aa993b JM |
603 | bpstat next; |
604 | /* Breakpoint that we are at. */ | |
605 | struct breakpoint *breakpoint_at; | |
606 | /* Commands left to be done. */ | |
607 | struct command_line *commands; | |
608 | /* Old value associated with a watchpoint. */ | |
278cd55f | 609 | struct value *old_val; |
c5aa993b JM |
610 | |
611 | /* Nonzero if this breakpoint tells us to print the frame. */ | |
612 | char print; | |
613 | ||
614 | /* Nonzero if this breakpoint tells us to stop. */ | |
615 | char stop; | |
616 | ||
e514a9d6 JM |
617 | /* Tell bpstat_print and print_bp_stop_message how to print stuff |
618 | associated with this element of the bpstat chain. */ | |
619 | enum bp_print_how print_it; | |
c5aa993b | 620 | }; |
c906108c SS |
621 | |
622 | enum inf_context | |
c5aa993b JM |
623 | { |
624 | inf_starting, | |
625 | inf_running, | |
626 | inf_exited | |
627 | }; | |
c2c6d25f JM |
628 | |
629 | /* The possible return values for breakpoint_here_p. | |
630 | We guarantee that zero always means "no breakpoint here". */ | |
631 | enum breakpoint_here | |
632 | { | |
633 | no_breakpoint_here = 0, | |
634 | ordinary_breakpoint_here, | |
635 | permanent_breakpoint_here | |
636 | }; | |
c906108c | 637 | \f |
c5aa993b | 638 | |
c906108c SS |
639 | /* Prototypes for breakpoint-related functions. */ |
640 | ||
a14ed312 | 641 | extern enum breakpoint_here breakpoint_here_p (CORE_ADDR); |
c906108c | 642 | |
a14ed312 | 643 | extern int breakpoint_inserted_here_p (CORE_ADDR); |
c906108c | 644 | |
4fa8626c DJ |
645 | extern int software_breakpoint_inserted_here_p (CORE_ADDR); |
646 | ||
39f77062 | 647 | extern int breakpoint_thread_match (CORE_ADDR, ptid_t); |
c906108c | 648 | |
ae66c1fc | 649 | extern void until_break_command (char *, int, int); |
c906108c | 650 | |
a14ed312 | 651 | extern void breakpoint_re_set (void); |
c906108c | 652 | |
a14ed312 | 653 | extern void breakpoint_re_set_thread (struct breakpoint *); |
c906108c | 654 | |
a14ed312 | 655 | extern int ep_is_exception_catchpoint (struct breakpoint *); |
c906108c SS |
656 | |
657 | extern struct breakpoint *set_momentary_breakpoint | |
818dd999 | 658 | (struct symtab_and_line, struct frame_id, enum bptype); |
c906108c | 659 | |
a14ed312 | 660 | extern void set_ignore_count (int, int, int); |
c906108c | 661 | |
a14ed312 | 662 | extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int); |
c906108c | 663 | |
a14ed312 | 664 | extern void mark_breakpoints_out (void); |
c906108c | 665 | |
a14ed312 | 666 | extern void breakpoint_init_inferior (enum inf_context); |
c906108c | 667 | |
4d6140d9 AC |
668 | extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *); |
669 | ||
670 | extern struct cleanup *make_exec_cleanup_delete_breakpoint (struct breakpoint *); | |
671 | ||
a14ed312 | 672 | extern void delete_breakpoint (struct breakpoint *); |
c906108c | 673 | |
a14ed312 | 674 | extern void breakpoint_auto_delete (bpstat); |
c906108c | 675 | |
a14ed312 | 676 | extern void breakpoint_clear_ignore_counts (void); |
c906108c | 677 | |
a14ed312 | 678 | extern void break_command (char *, int); |
c906108c | 679 | |
a14ed312 KB |
680 | extern void hbreak_command_wrapper (char *, int); |
681 | extern void thbreak_command_wrapper (char *, int); | |
682 | extern void rbreak_command_wrapper (char *, int); | |
683 | extern void watch_command_wrapper (char *, int); | |
684 | extern void awatch_command_wrapper (char *, int); | |
685 | extern void rwatch_command_wrapper (char *, int); | |
686 | extern void tbreak_command (char *, int); | |
c906108c | 687 | |
a14ed312 | 688 | extern int insert_breakpoints (void); |
c906108c | 689 | |
a14ed312 | 690 | extern int remove_breakpoints (void); |
c906108c SS |
691 | |
692 | /* This function can be used to physically insert eventpoints from the | |
693 | specified traced inferior process, without modifying the breakpoint | |
694 | package's state. This can be useful for those targets which support | |
695 | following the processes of a fork() or vfork() system call, when both | |
696 | of the resulting two processes are to be followed. */ | |
a14ed312 | 697 | extern int reattach_breakpoints (int); |
c906108c SS |
698 | |
699 | /* This function can be used to update the breakpoint package's state | |
700 | after an exec() system call has been executed. | |
701 | ||
702 | This function causes the following: | |
703 | ||
c5aa993b JM |
704 | - All eventpoints are marked "not inserted". |
705 | - All eventpoints with a symbolic address are reset such that | |
706 | the symbolic address must be reevaluated before the eventpoints | |
707 | can be reinserted. | |
708 | - The solib breakpoints are explicitly removed from the breakpoint | |
709 | list. | |
710 | - A step-resume breakpoint, if any, is explicitly removed from the | |
711 | breakpoint list. | |
712 | - All eventpoints without a symbolic address are removed from the | |
713 | breakpoint list. */ | |
a14ed312 | 714 | extern void update_breakpoints_after_exec (void); |
c906108c SS |
715 | |
716 | /* This function can be used to physically remove hardware breakpoints | |
717 | and watchpoints from the specified traced inferior process, without | |
718 | modifying the breakpoint package's state. This can be useful for | |
719 | those targets which support following the processes of a fork() or | |
720 | vfork() system call, when one of the resulting two processes is to | |
721 | be detached and allowed to run free. | |
c5aa993b | 722 | |
c906108c | 723 | It is an error to use this function on the process whose id is |
39f77062 | 724 | inferior_ptid. */ |
a14ed312 | 725 | extern int detach_breakpoints (int); |
c5aa993b | 726 | |
a14ed312 | 727 | extern void enable_longjmp_breakpoint (void); |
a14ed312 | 728 | extern void disable_longjmp_breakpoint (void); |
1900040c MS |
729 | extern void enable_overlay_breakpoints (void); |
730 | extern void disable_overlay_breakpoints (void); | |
c906108c | 731 | |
818dd999 | 732 | extern void set_longjmp_resume_breakpoint (CORE_ADDR, struct frame_id); |
c906108c SS |
733 | /* These functions respectively disable or reenable all currently |
734 | enabled watchpoints. When disabled, the watchpoints are marked | |
735 | call_disabled. When reenabled, they are marked enabled. | |
736 | ||
04714b91 | 737 | The intended client of these functions is call_function_by_hand. |
c906108c SS |
738 | |
739 | The inferior must be stopped, and all breakpoints removed, when | |
740 | these functions are used. | |
741 | ||
742 | The need for these functions is that on some targets (e.g., HP-UX), | |
743 | gdb is unable to unwind through the dummy frame that is pushed as | |
744 | part of the implementation of a call command. Watchpoints can | |
745 | cause the inferior to stop in places where this frame is visible, | |
746 | and that can cause execution control to become very confused. | |
747 | ||
7e73cedf | 748 | Note that if a user sets breakpoints in an interactively called |
c906108c SS |
749 | function, the call_disabled watchpoints will have been reenabled |
750 | when the first such breakpoint is reached. However, on targets | |
751 | that are unable to unwind through the call dummy frame, watches | |
752 | of stack-based storage may then be deleted, because gdb will | |
753 | believe that their watched storage is out of scope. (Sigh.) */ | |
a14ed312 | 754 | extern void disable_watchpoints_before_interactive_call_start (void); |
c906108c | 755 | |
a14ed312 | 756 | extern void enable_watchpoints_after_interactive_call_stop (void); |
c906108c | 757 | |
40c03ae8 EZ |
758 | /* For script interpreters that need to define breakpoint commands |
759 | after they've already read the commands into a struct command_line. */ | |
760 | extern enum command_control_type commands_from_control_command | |
761 | (char *arg, struct command_line *cmd); | |
c5aa993b | 762 | |
a14ed312 | 763 | extern void clear_breakpoint_hit_counts (void); |
c906108c | 764 | |
a14ed312 | 765 | extern int get_number (char **); |
5c44784c | 766 | |
a14ed312 | 767 | extern int get_number_or_range (char **); |
5c44784c | 768 | |
c906108c SS |
769 | /* The following are for displays, which aren't really breakpoints, but |
770 | here is as good a place as any for them. */ | |
771 | ||
a14ed312 | 772 | extern void disable_current_display (void); |
c906108c | 773 | |
a14ed312 | 774 | extern void do_displays (void); |
c906108c | 775 | |
a14ed312 | 776 | extern void disable_display (int); |
c906108c | 777 | |
a14ed312 | 778 | extern void clear_displays (void); |
c906108c | 779 | |
a14ed312 | 780 | extern void disable_breakpoint (struct breakpoint *); |
c906108c | 781 | |
a14ed312 | 782 | extern void enable_breakpoint (struct breakpoint *); |
c906108c | 783 | |
a14ed312 | 784 | extern void make_breakpoint_permanent (struct breakpoint *); |
c2c6d25f | 785 | |
a14ed312 | 786 | extern struct breakpoint *create_solib_event_breakpoint (CORE_ADDR); |
c906108c | 787 | |
a14ed312 | 788 | extern struct breakpoint *create_thread_event_breakpoint (CORE_ADDR); |
c4093a6a | 789 | |
a14ed312 | 790 | extern void remove_solib_event_breakpoints (void); |
c906108c | 791 | |
a14ed312 | 792 | extern void remove_thread_event_breakpoints (void); |
c4093a6a | 793 | |
a14ed312 | 794 | extern void disable_breakpoints_in_shlibs (int silent); |
c906108c | 795 | |
a14ed312 | 796 | extern void re_enable_breakpoints_in_shlibs (void); |
c906108c | 797 | |
a14ed312 | 798 | extern void create_solib_load_event_breakpoint (char *, int, char *, char *); |
c5aa993b | 799 | |
a14ed312 KB |
800 | extern void create_solib_unload_event_breakpoint (char *, int, |
801 | char *, char *); | |
c5aa993b | 802 | |
a14ed312 | 803 | extern void create_fork_event_catchpoint (int, char *); |
c5aa993b | 804 | |
a14ed312 | 805 | extern void create_vfork_event_catchpoint (int, char *); |
c906108c | 806 | |
a14ed312 | 807 | extern void create_exec_event_catchpoint (int, char *); |
c5aa993b | 808 | |
c906108c | 809 | /* This function returns TRUE if ep is a catchpoint. */ |
a14ed312 | 810 | extern int ep_is_catchpoint (struct breakpoint *); |
c5aa993b | 811 | |
c906108c SS |
812 | /* This function returns TRUE if ep is a catchpoint of a |
813 | shared library (aka dynamically-linked library) event, | |
814 | such as a library load or unload. */ | |
a14ed312 | 815 | extern int ep_is_shlib_catchpoint (struct breakpoint *); |
c5aa993b | 816 | |
a14ed312 | 817 | extern struct breakpoint *set_breakpoint_sal (struct symtab_and_line); |
c906108c | 818 | |
c2c6d25f JM |
819 | /* Enable breakpoints and delete when hit. Called with ARG == NULL |
820 | deletes all breakpoints. */ | |
821 | extern void delete_command (char *arg, int from_tty); | |
822 | ||
80ce1ecb AC |
823 | /* Pull all H/W watchpoints from the target. Return non-zero if the |
824 | remove fails. */ | |
825 | extern int remove_hw_watchpoints (void); | |
826 | ||
8181d85f DJ |
827 | /* Manage a software single step breakpoint (or two). Insert may be called |
828 | twice before remove is called. */ | |
829 | extern void insert_single_step_breakpoint (CORE_ADDR); | |
830 | extern void remove_single_step_breakpoints (void); | |
831 | ||
832 | /* Manage manual breakpoints, separate from the normal chain of | |
833 | breakpoints. These functions are used in murky target-specific | |
834 | ways. Please do not add more uses! */ | |
835 | extern void *deprecated_insert_raw_breakpoint (CORE_ADDR); | |
836 | extern int deprecated_remove_raw_breakpoint (void *); | |
f83f82bc | 837 | |
c906108c | 838 | #endif /* !defined (BREAKPOINT_H) */ |