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