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