Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Data structures associated with breakpoints in GDB. |
42a4f53d | 2 | Copyright (C) 1992-2019 Free Software Foundation, Inc. |
c906108c | 3 | |
c5aa993b | 4 | This file is part of GDB. |
c906108c | 5 | |
c5aa993b JM |
6 | This program is free software; you can redistribute it and/or modify |
7 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 8 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 9 | (at your option) any later version. |
c906108c | 10 | |
c5aa993b JM |
11 | This program is distributed in the hope that it will be useful, |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 | GNU General Public License for more details. | |
c906108c | 15 | |
c5aa993b | 16 | You should have received a copy of the GNU General Public License |
a9762ec7 | 17 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
18 | |
19 | #if !defined (BREAKPOINT_H) | |
20 | #define BREAKPOINT_H 1 | |
21 | ||
22 | #include "frame.h" | |
23 | #include "value.h" | |
0747795c | 24 | #include "common/vec.h" |
b775012e | 25 | #include "ax.h" |
625e8578 | 26 | #include "command.h" |
0747795c | 27 | #include "common/break-common.h" |
729662a5 | 28 | #include "probe.h" |
d28cd78a | 29 | #include "location.h" |
3cde5c42 | 30 | #include <vector> |
6c5b2ebe | 31 | #include "common/array-view.h" |
6b66338c | 32 | #include "cli/cli-script.h" |
c906108c | 33 | |
fe898f56 | 34 | struct block; |
4cb0213d | 35 | struct gdbpy_breakpoint_object; |
ed3ef339 | 36 | struct gdbscm_breakpoint_object; |
bfd28288 | 37 | struct number_or_range_parser; |
619cebe8 | 38 | struct thread_info; |
28010a5d PA |
39 | struct bpstats; |
40 | struct bp_location; | |
983af33b SDJ |
41 | struct linespec_result; |
42 | struct linespec_sals; | |
00431a78 | 43 | struct inferior; |
278cd55f | 44 | |
73971819 PA |
45 | /* Why are we removing the breakpoint from the target? */ |
46 | ||
47 | enum remove_bp_reason | |
48 | { | |
49 | /* A regular remove. Remove the breakpoint and forget everything | |
50 | about it. */ | |
51 | REMOVE_BREAKPOINT, | |
52 | ||
53 | /* Detach the breakpoints from a fork child. */ | |
54 | DETACH_BREAKPOINT, | |
55 | }; | |
56 | ||
0e2de366 MS |
57 | /* This is the maximum number of bytes a breakpoint instruction can |
58 | take. Feel free to increase it. It's just used in a few places to | |
59 | size arrays that should be independent of the target | |
60 | architecture. */ | |
c906108c SS |
61 | |
62 | #define BREAKPOINT_MAX 16 | |
63 | \f | |
a96d9b2e SDJ |
64 | |
65 | /* Type of breakpoint. */ | |
c5aa993b JM |
66 | |
67 | enum bptype | |
68 | { | |
0e2de366 | 69 | bp_none = 0, /* Eventpoint has been deleted */ |
c5aa993b JM |
70 | bp_breakpoint, /* Normal breakpoint */ |
71 | bp_hardware_breakpoint, /* Hardware assisted breakpoint */ | |
7c16b83e | 72 | bp_single_step, /* Software single-step */ |
c5aa993b JM |
73 | bp_until, /* used by until command */ |
74 | bp_finish, /* used by finish command */ | |
75 | bp_watchpoint, /* Watchpoint */ | |
76 | bp_hardware_watchpoint, /* Hardware assisted watchpoint */ | |
77 | bp_read_watchpoint, /* read watchpoint, (hardware assisted) */ | |
78 | bp_access_watchpoint, /* access watchpoint, (hardware assisted) */ | |
79 | bp_longjmp, /* secret breakpoint to find longjmp() */ | |
80 | bp_longjmp_resume, /* secret breakpoint to escape longjmp() */ | |
81 | ||
e2e4d78b JK |
82 | /* Breakpoint placed to the same location(s) like bp_longjmp but used to |
83 | protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and | |
84 | one bp_call_dummy are chained together by related_breakpoint for each | |
85 | DUMMY_FRAME. */ | |
86 | bp_longjmp_call_dummy, | |
87 | ||
186c406b TT |
88 | /* An internal breakpoint that is installed on the unwinder's |
89 | debug hook. */ | |
90 | bp_exception, | |
91 | /* An internal breakpoint that is set at the point where an | |
92 | exception will land. */ | |
93 | bp_exception_resume, | |
94 | ||
0e2de366 | 95 | /* Used by wait_for_inferior for stepping over subroutine calls, |
2c03e5be | 96 | and for skipping prologues. */ |
c5aa993b JM |
97 | bp_step_resume, |
98 | ||
2c03e5be PA |
99 | /* Used by wait_for_inferior for stepping over signal |
100 | handlers. */ | |
101 | bp_hp_step_resume, | |
102 | ||
c5aa993b JM |
103 | /* Used to detect when a watchpoint expression has gone out of |
104 | scope. These breakpoints are usually not visible to the user. | |
105 | ||
106 | This breakpoint has some interesting properties: | |
c906108c SS |
107 | |
108 | 1) There's always a 1:1 mapping between watchpoints | |
109 | on local variables and watchpoint_scope breakpoints. | |
110 | ||
111 | 2) It automatically deletes itself and the watchpoint it's | |
112 | associated with when hit. | |
113 | ||
114 | 3) It can never be disabled. */ | |
c5aa993b JM |
115 | bp_watchpoint_scope, |
116 | ||
e2e4d78b JK |
117 | /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it |
118 | is chained with by related_breakpoint. */ | |
c5aa993b JM |
119 | bp_call_dummy, |
120 | ||
aa7d318d TT |
121 | /* A breakpoint set on std::terminate, that is used to catch |
122 | otherwise uncaught exceptions thrown during an inferior call. */ | |
123 | bp_std_terminate, | |
124 | ||
c5aa993b JM |
125 | /* Some dynamic linkers (HP, maybe Solaris) can arrange for special |
126 | code in the inferior to run when significant events occur in the | |
127 | dynamic linker (for example a library is loaded or unloaded). | |
128 | ||
129 | By placing a breakpoint in this magic code GDB will get control | |
130 | when these significant events occur. GDB can then re-examine | |
131 | the dynamic linker's data structures to discover any newly loaded | |
132 | dynamic libraries. */ | |
133 | bp_shlib_event, | |
134 | ||
c4093a6a JM |
135 | /* Some multi-threaded systems can arrange for a location in the |
136 | inferior to be executed when certain thread-related events occur | |
137 | (such as thread creation or thread death). | |
138 | ||
139 | By placing a breakpoint at one of these locations, GDB will get | |
140 | control when these events occur. GDB can then update its thread | |
141 | lists etc. */ | |
142 | ||
143 | bp_thread_event, | |
144 | ||
1900040c MS |
145 | /* On the same principal, an overlay manager can arrange to call a |
146 | magic location in the inferior whenever there is an interesting | |
147 | change in overlay status. GDB can update its overlay tables | |
148 | and fiddle with breakpoints in overlays when this breakpoint | |
149 | is hit. */ | |
150 | ||
151 | bp_overlay_event, | |
152 | ||
0fd8e87f UW |
153 | /* Master copies of longjmp breakpoints. These are always installed |
154 | as soon as an objfile containing longjmp is loaded, but they are | |
155 | always disabled. While necessary, temporary clones of bp_longjmp | |
156 | type will be created and enabled. */ | |
157 | ||
158 | bp_longjmp_master, | |
159 | ||
aa7d318d TT |
160 | /* Master copies of std::terminate breakpoints. */ |
161 | bp_std_terminate_master, | |
162 | ||
186c406b TT |
163 | /* Like bp_longjmp_master, but for exceptions. */ |
164 | bp_exception_master, | |
165 | ||
ce78b96d | 166 | bp_catchpoint, |
1042e4c0 SS |
167 | |
168 | bp_tracepoint, | |
7a697b8d | 169 | bp_fast_tracepoint, |
0fb4aa4b | 170 | bp_static_tracepoint, |
4efc6507 | 171 | |
e7e0cddf SS |
172 | /* A dynamic printf stops at the given location, does a formatted |
173 | print, then automatically continues. (Although this is sort of | |
174 | like a macro packaging up standard breakpoint functionality, | |
175 | GDB doesn't have a way to construct types of breakpoint from | |
176 | elements of behavior.) */ | |
177 | bp_dprintf, | |
178 | ||
4efc6507 DE |
179 | /* Event for JIT compiled code generation or deletion. */ |
180 | bp_jit_event, | |
0e30163f JK |
181 | |
182 | /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB | |
183 | inserts new bp_gnu_ifunc_resolver_return at the caller. | |
184 | bp_gnu_ifunc_resolver is still being kept here as a different thread | |
185 | may still hit it before bp_gnu_ifunc_resolver_return is hit by the | |
186 | original thread. */ | |
187 | bp_gnu_ifunc_resolver, | |
188 | ||
189 | /* On its hit GDB now know the resolved address of the target | |
190 | STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be | |
191 | deleted now and the breakpoint moved to the target function entry | |
192 | point. */ | |
193 | bp_gnu_ifunc_resolver_return, | |
c5aa993b | 194 | }; |
c906108c | 195 | |
0e2de366 | 196 | /* States of enablement of breakpoint. */ |
c906108c | 197 | |
b5de0fa7 | 198 | enum enable_state |
c5aa993b | 199 | { |
0e2de366 MS |
200 | bp_disabled, /* The eventpoint is inactive, and cannot |
201 | trigger. */ | |
202 | bp_enabled, /* The eventpoint is active, and can | |
203 | trigger. */ | |
204 | bp_call_disabled, /* The eventpoint has been disabled while a | |
205 | call into the inferior is "in flight", | |
206 | because some eventpoints interfere with | |
207 | the implementation of a call on some | |
208 | targets. The eventpoint will be | |
209 | automatically enabled and reset when the | |
210 | call "lands" (either completes, or stops | |
211 | at another eventpoint). */ | |
c5aa993b | 212 | }; |
c906108c SS |
213 | |
214 | ||
0e2de366 | 215 | /* Disposition of breakpoint. Ie: what to do after hitting it. */ |
c906108c | 216 | |
c5aa993b JM |
217 | enum bpdisp |
218 | { | |
b5de0fa7 | 219 | disp_del, /* Delete it */ |
0e2de366 MS |
220 | disp_del_at_next_stop, /* Delete at next stop, |
221 | whether hit or not */ | |
b5de0fa7 EZ |
222 | disp_disable, /* Disable it */ |
223 | disp_donttouch /* Leave it alone */ | |
c5aa993b | 224 | }; |
c906108c | 225 | |
b775012e LM |
226 | /* Status of breakpoint conditions used when synchronizing |
227 | conditions with the target. */ | |
228 | ||
229 | enum condition_status | |
230 | { | |
231 | condition_unchanged = 0, | |
232 | condition_modified, | |
233 | condition_updated | |
234 | }; | |
235 | ||
8181d85f DJ |
236 | /* Information used by targets to insert and remove breakpoints. */ |
237 | ||
238 | struct bp_target_info | |
239 | { | |
6c95b8df PA |
240 | /* Address space at which the breakpoint was placed. */ |
241 | struct address_space *placed_address_space; | |
242 | ||
0d5ed153 MR |
243 | /* Address at which the breakpoint was placed. This is normally |
244 | the same as REQUESTED_ADDRESS, except when adjustment happens in | |
245 | gdbarch_breakpoint_from_pc. The most common form of adjustment | |
246 | is stripping an alternate ISA marker from the PC which is used | |
247 | to determine the type of breakpoint to insert. */ | |
8181d85f DJ |
248 | CORE_ADDR placed_address; |
249 | ||
0d5ed153 MR |
250 | /* Address at which the breakpoint was requested. */ |
251 | CORE_ADDR reqstd_address; | |
252 | ||
f1310107 TJB |
253 | /* If this is a ranged breakpoint, then this field contains the |
254 | length of the range that will be watched for execution. */ | |
255 | int length; | |
256 | ||
8181d85f DJ |
257 | /* If the breakpoint lives in memory and reading that memory would |
258 | give back the breakpoint, instead of the original contents, then | |
259 | the original contents are cached here. Only SHADOW_LEN bytes of | |
260 | this buffer are valid, and only when the breakpoint is inserted. */ | |
261 | gdb_byte shadow_contents[BREAKPOINT_MAX]; | |
262 | ||
263 | /* The length of the data cached in SHADOW_CONTENTS. */ | |
264 | int shadow_len; | |
265 | ||
579c6ad9 YQ |
266 | /* The breakpoint's kind. It is used in 'kind' parameter in Z |
267 | packets. */ | |
268 | int kind; | |
b775012e | 269 | |
3cde5c42 PA |
270 | /* Conditions the target should evaluate if it supports target-side |
271 | breakpoint conditions. These are non-owning pointers. */ | |
272 | std::vector<agent_expr *> conditions; | |
d3ce09f5 | 273 | |
3cde5c42 PA |
274 | /* Commands the target should evaluate if it supports target-side |
275 | breakpoint commands. These are non-owning pointers. */ | |
276 | std::vector<agent_expr *> tcommands; | |
d3ce09f5 SS |
277 | |
278 | /* Flag that is true if the breakpoint should be left in place even | |
279 | when GDB is not connected. */ | |
280 | int persist; | |
8181d85f DJ |
281 | }; |
282 | ||
5cab636d DJ |
283 | /* GDB maintains two types of information about each breakpoint (or |
284 | watchpoint, or other related event). The first type corresponds | |
285 | to struct breakpoint; this is a relatively high-level structure | |
286 | which contains the source location(s), stopping conditions, user | |
287 | commands to execute when the breakpoint is hit, and so forth. | |
288 | ||
289 | The second type of information corresponds to struct bp_location. | |
290 | Each breakpoint has one or (eventually) more locations associated | |
291 | with it, which represent target-specific and machine-specific | |
292 | mechanisms for stopping the program. For instance, a watchpoint | |
293 | expression may require multiple hardware watchpoints in order to | |
294 | catch all changes in the value of the expression being watched. */ | |
295 | ||
296 | enum bp_loc_type | |
297 | { | |
298 | bp_loc_software_breakpoint, | |
299 | bp_loc_hardware_breakpoint, | |
300 | bp_loc_hardware_watchpoint, | |
301 | bp_loc_other /* Miscellaneous... */ | |
302 | }; | |
303 | ||
28010a5d PA |
304 | /* This structure is a collection of function pointers that, if |
305 | available, will be called instead of performing the default action | |
306 | for this bp_loc_type. */ | |
307 | ||
308 | struct bp_location_ops | |
309 | { | |
310 | /* Destructor. Releases everything from SELF (but not SELF | |
311 | itself). */ | |
312 | void (*dtor) (struct bp_location *self); | |
313 | }; | |
314 | ||
5625a286 | 315 | class bp_location |
5cab636d | 316 | { |
5625a286 PA |
317 | public: |
318 | bp_location () = default; | |
319 | ||
320 | bp_location (const bp_location_ops *ops, breakpoint *owner); | |
321 | ||
0d381245 VP |
322 | /* Chain pointer to the next breakpoint location for |
323 | the same parent breakpoint. */ | |
5625a286 | 324 | bp_location *next = NULL; |
7cc221ef | 325 | |
28010a5d | 326 | /* Methods associated with this location. */ |
5625a286 | 327 | const bp_location_ops *ops = NULL; |
28010a5d | 328 | |
f431efe5 | 329 | /* The reference count. */ |
5625a286 | 330 | int refc = 0; |
f431efe5 | 331 | |
5cab636d | 332 | /* Type of this breakpoint location. */ |
5625a286 | 333 | bp_loc_type loc_type {}; |
5cab636d DJ |
334 | |
335 | /* Each breakpoint location must belong to exactly one higher-level | |
f431efe5 PA |
336 | breakpoint. This pointer is NULL iff this bp_location is no |
337 | longer attached to a breakpoint. For example, when a breakpoint | |
338 | is deleted, its locations may still be found in the | |
339 | moribund_locations list, or if we had stopped for it, in | |
340 | bpstats. */ | |
5625a286 | 341 | breakpoint *owner = NULL; |
5cab636d | 342 | |
60e1c644 PA |
343 | /* Conditional. Break only if this expression's value is nonzero. |
344 | Unlike string form of condition, which is associated with | |
345 | breakpoint, this is associated with location, since if breakpoint | |
346 | has several locations, the evaluation of expression can be | |
347 | different for different locations. Only valid for real | |
348 | breakpoints; a watchpoint's conditional expression is stored in | |
349 | the owner breakpoint object. */ | |
4d01a485 | 350 | expression_up cond; |
0d381245 | 351 | |
b775012e LM |
352 | /* Conditional expression in agent expression |
353 | bytecode form. This is used for stub-side breakpoint | |
354 | condition evaluation. */ | |
833177a4 | 355 | agent_expr_up cond_bytecode; |
b775012e LM |
356 | |
357 | /* Signals that the condition has changed since the last time | |
358 | we updated the global location list. This means the condition | |
359 | needs to be sent to the target again. This is used together | |
360 | with target-side breakpoint conditions. | |
361 | ||
362 | condition_unchanged: It means there has been no condition changes. | |
363 | ||
364 | condition_modified: It means this location had its condition modified. | |
365 | ||
366 | condition_updated: It means we already marked all the locations that are | |
367 | duplicates of this location and thus we don't need to call | |
368 | force_breakpoint_reinsertion (...) for this location. */ | |
369 | ||
5625a286 | 370 | condition_status condition_changed {}; |
b775012e | 371 | |
833177a4 | 372 | agent_expr_up cmd_bytecode; |
d3ce09f5 SS |
373 | |
374 | /* Signals that breakpoint conditions and/or commands need to be | |
375 | re-synched with the target. This has no use other than | |
376 | target-side breakpoints. */ | |
5625a286 | 377 | bool needs_update = false; |
b775012e | 378 | |
0d381245 VP |
379 | /* This location's address is in an unloaded solib, and so this |
380 | location should not be inserted. It will be automatically | |
381 | enabled when that solib is loaded. */ | |
5625a286 | 382 | bool shlib_disabled = false; |
0d381245 VP |
383 | |
384 | /* Is this particular location enabled. */ | |
5625a286 | 385 | bool enabled = false; |
511a6cd4 | 386 | |
5cab636d | 387 | /* Nonzero if this breakpoint is now inserted. */ |
5625a286 | 388 | bool inserted = false; |
5cab636d | 389 | |
1a853c52 PA |
390 | /* Nonzero if this is a permanent breakpoint. There is a breakpoint |
391 | instruction hard-wired into the target's code. Don't try to | |
392 | write another breakpoint instruction on top of it, or restore its | |
393 | value. Step over it using the architecture's | |
394 | gdbarch_skip_permanent_breakpoint method. */ | |
5625a286 | 395 | bool permanent = false; |
1a853c52 | 396 | |
5cab636d | 397 | /* Nonzero if this is not the first breakpoint in the list |
1e4d1764 YQ |
398 | for the given address. location of tracepoint can _never_ |
399 | be duplicated with other locations of tracepoints and other | |
400 | kinds of breakpoints, because two locations at the same | |
401 | address may have different actions, so both of these locations | |
402 | should be downloaded and so that `tfind N' always works. */ | |
5625a286 | 403 | bool duplicate = false; |
5cab636d DJ |
404 | |
405 | /* If we someday support real thread-specific breakpoints, then | |
406 | the breakpoint location will need a thread identifier. */ | |
407 | ||
408 | /* Data for specific breakpoint types. These could be a union, but | |
409 | simplicity is more important than memory usage for breakpoints. */ | |
410 | ||
a6d9a66e UW |
411 | /* Architecture associated with this location's address. May be |
412 | different from the breakpoint architecture. */ | |
5625a286 | 413 | struct gdbarch *gdbarch = NULL; |
a6d9a66e | 414 | |
6c95b8df PA |
415 | /* The program space associated with this breakpoint location |
416 | address. Note that an address space may be represented in more | |
417 | than one program space (e.g. each uClinux program will be given | |
418 | its own program space, but there will only be one address space | |
419 | for all of them), but we must not insert more than one location | |
420 | at the same address in the same address space. */ | |
5625a286 | 421 | program_space *pspace = NULL; |
6c95b8df | 422 | |
5cab636d DJ |
423 | /* Note that zero is a perfectly valid code address on some platforms |
424 | (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL | |
425 | is not a special value for this field. Valid for all types except | |
426 | bp_loc_other. */ | |
5625a286 | 427 | CORE_ADDR address = 0; |
5cab636d | 428 | |
a3be7890 | 429 | /* For hardware watchpoints, the size of the memory region being |
f1310107 TJB |
430 | watched. For hardware ranged breakpoints, the size of the |
431 | breakpoint range. */ | |
5625a286 | 432 | int length = 0; |
a5606eee | 433 | |
0e2de366 | 434 | /* Type of hardware watchpoint. */ |
5625a286 | 435 | target_hw_bp_type watchpoint_type {}; |
a5606eee | 436 | |
714835d5 | 437 | /* For any breakpoint type with an address, this is the section |
0e2de366 MS |
438 | associated with the address. Used primarily for overlay |
439 | debugging. */ | |
5625a286 | 440 | obj_section *section = NULL; |
cf3a9e5b | 441 | |
5cab636d DJ |
442 | /* Address at which breakpoint was requested, either by the user or |
443 | by GDB for internal breakpoints. This will usually be the same | |
444 | as ``address'' (above) except for cases in which | |
445 | ADJUST_BREAKPOINT_ADDRESS has computed a different address at | |
446 | which to place the breakpoint in order to comply with a | |
447 | processor's architectual constraints. */ | |
5625a286 | 448 | CORE_ADDR requested_address = 0; |
8181d85f | 449 | |
6a3a010b MR |
450 | /* An additional address assigned with this location. This is currently |
451 | only used by STT_GNU_IFUNC resolver breakpoints to hold the address | |
452 | of the resolver function. */ | |
5625a286 | 453 | CORE_ADDR related_address = 0; |
6a3a010b | 454 | |
55aa24fb SDJ |
455 | /* If the location comes from a probe point, this is the probe associated |
456 | with it. */ | |
5625a286 | 457 | bound_probe probe {}; |
55aa24fb | 458 | |
5625a286 | 459 | char *function_name = NULL; |
0d381245 | 460 | |
8181d85f | 461 | /* Details of the placed breakpoint, when inserted. */ |
5625a286 | 462 | bp_target_info target_info {}; |
8181d85f DJ |
463 | |
464 | /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */ | |
5625a286 | 465 | bp_target_info overlay_target_info {}; |
20874c92 VP |
466 | |
467 | /* In a non-stop mode, it's possible that we delete a breakpoint, | |
468 | but as we do that, some still running thread hits that breakpoint. | |
469 | For that reason, we need to keep locations belonging to deleted | |
470 | breakpoints for a bit, so that don't report unexpected SIGTRAP. | |
471 | We can't keep such locations forever, so we use a heuristic -- | |
472 | after we process certain number of inferior events since | |
473 | breakpoint was deleted, we retire all locations of that breakpoint. | |
474 | This variable keeps a number of events still to go, when | |
475 | it becomes 0 this location is retired. */ | |
5625a286 | 476 | int events_till_retirement = 0; |
f8eba3c6 | 477 | |
2f202fde JK |
478 | /* Line number which was used to place this location. |
479 | ||
480 | Breakpoint placed into a comment keeps it's user specified line number | |
481 | despite ADDRESS resolves into a different line number. */ | |
f8eba3c6 | 482 | |
5625a286 | 483 | int line_number = 0; |
f8eba3c6 | 484 | |
2f202fde JK |
485 | /* Symtab which was used to place this location. This is used |
486 | to find the corresponding source file name. */ | |
f8eba3c6 | 487 | |
5625a286 | 488 | struct symtab *symtab = NULL; |
4a27f119 KS |
489 | |
490 | /* The symbol found by the location parser, if any. This may be used to | |
491 | ascertain when an event location was set at a different location than | |
492 | the one originally selected by parsing, e.g., inlined symbols. */ | |
493 | const struct symbol *symbol = NULL; | |
3467ec66 PA |
494 | |
495 | /* Similarly, the minimal symbol found by the location parser, if | |
496 | any. This may be used to ascertain if the location was | |
497 | originally set on a GNU ifunc symbol. */ | |
498 | const minimal_symbol *msymbol = NULL; | |
499 | ||
500 | /* The objfile the symbol or minimal symbol were found in. */ | |
501 | const struct objfile *objfile = NULL; | |
5cab636d DJ |
502 | }; |
503 | ||
64166036 PA |
504 | /* The possible return values for print_bpstat, print_it_normal, |
505 | print_it_done, print_it_noop. */ | |
506 | enum print_stop_action | |
507 | { | |
508 | /* We printed nothing or we need to do some more analysis. */ | |
509 | PRINT_UNKNOWN = -1, | |
510 | ||
511 | /* We printed something, and we *do* desire that something to be | |
512 | followed by a location. */ | |
513 | PRINT_SRC_AND_LOC, | |
514 | ||
515 | /* We printed something, and we do *not* desire that something to be | |
516 | followed by a location. */ | |
517 | PRINT_SRC_ONLY, | |
518 | ||
519 | /* We already printed all we needed to print, don't print anything | |
520 | else. */ | |
521 | PRINT_NOTHING | |
522 | }; | |
523 | ||
3086aeae DJ |
524 | /* This structure is a collection of function pointers that, if available, |
525 | will be called instead of the performing the default action for this | |
526 | bptype. */ | |
527 | ||
77b06cd7 | 528 | struct breakpoint_ops |
3086aeae | 529 | { |
28010a5d PA |
530 | /* Allocate a location for this breakpoint. */ |
531 | struct bp_location * (*allocate_location) (struct breakpoint *); | |
532 | ||
533 | /* Reevaluate a breakpoint. This is necessary after symbols change | |
534 | (e.g., an executable or DSO was loaded, or the inferior just | |
535 | started). */ | |
536 | void (*re_set) (struct breakpoint *self); | |
537 | ||
77b06cd7 | 538 | /* Insert the breakpoint or watchpoint or activate the catchpoint. |
348d480f PA |
539 | Return 0 for success, 1 if the breakpoint, watchpoint or |
540 | catchpoint type is not supported, -1 for failure. */ | |
77b06cd7 | 541 | int (*insert_location) (struct bp_location *); |
ce78b96d JB |
542 | |
543 | /* Remove the breakpoint/catchpoint that was previously inserted | |
77b06cd7 TJB |
544 | with the "insert" method above. Return 0 for success, 1 if the |
545 | breakpoint, watchpoint or catchpoint type is not supported, | |
546 | -1 for failure. */ | |
73971819 | 547 | int (*remove_location) (struct bp_location *, enum remove_bp_reason reason); |
ce78b96d | 548 | |
28010a5d PA |
549 | /* Return true if it the target has stopped due to hitting |
550 | breakpoint location BL. This function does not check if we | |
09ac7c10 TT |
551 | should stop, only if BL explains the stop. ASPACE is the address |
552 | space in which the event occurred, BP_ADDR is the address at | |
553 | which the inferior stopped, and WS is the target_waitstatus | |
554 | describing the event. */ | |
555 | int (*breakpoint_hit) (const struct bp_location *bl, | |
bd522513 | 556 | const address_space *aspace, |
09ac7c10 TT |
557 | CORE_ADDR bp_addr, |
558 | const struct target_waitstatus *ws); | |
ce78b96d | 559 | |
28010a5d PA |
560 | /* Check internal conditions of the breakpoint referred to by BS. |
561 | If we should not stop for this breakpoint, set BS->stop to 0. */ | |
562 | void (*check_status) (struct bpstats *bs); | |
563 | ||
e09342b5 TJB |
564 | /* Tell how many hardware resources (debug registers) are needed |
565 | for this breakpoint. If this function is not provided, then | |
566 | the breakpoint or watchpoint needs one debug register. */ | |
567 | int (*resources_needed) (const struct bp_location *); | |
568 | ||
9c06b0b4 TJB |
569 | /* Tell whether we can downgrade from a hardware watchpoint to a software |
570 | one. If not, the user will not be able to enable the watchpoint when | |
571 | there are not enough hardware resources available. */ | |
572 | int (*works_in_software_mode) (const struct breakpoint *); | |
573 | ||
3086aeae DJ |
574 | /* The normal print routine for this breakpoint, called when we |
575 | hit it. */ | |
348d480f | 576 | enum print_stop_action (*print_it) (struct bpstats *bs); |
3086aeae | 577 | |
0e2de366 MS |
578 | /* Display information about this breakpoint, for "info |
579 | breakpoints". */ | |
a6d9a66e | 580 | void (*print_one) (struct breakpoint *, struct bp_location **); |
3086aeae | 581 | |
f1310107 TJB |
582 | /* Display extra information about this breakpoint, below the normal |
583 | breakpoint description in "info breakpoints". | |
584 | ||
585 | In the example below, the "address range" line was printed | |
586 | by print_one_detail_ranged_breakpoint. | |
587 | ||
588 | (gdb) info breakpoints | |
589 | Num Type Disp Enb Address What | |
590 | 2 hw breakpoint keep y in main at test-watch.c:70 | |
591 | address range: [0x10000458, 0x100004c7] | |
592 | ||
593 | */ | |
594 | void (*print_one_detail) (const struct breakpoint *, struct ui_out *); | |
595 | ||
0e2de366 MS |
596 | /* Display information about this breakpoint after setting it |
597 | (roughly speaking; this is called from "mention"). */ | |
3086aeae | 598 | void (*print_mention) (struct breakpoint *); |
6149aea9 PA |
599 | |
600 | /* Print to FP the CLI command that recreates this breakpoint. */ | |
601 | void (*print_recreate) (struct breakpoint *, struct ui_file *fp); | |
983af33b | 602 | |
5f700d83 | 603 | /* Create SALs from location, storing the result in linespec_result. |
983af33b SDJ |
604 | |
605 | For an explanation about the arguments, see the function | |
5f700d83 | 606 | `create_sals_from_location_default'. |
983af33b SDJ |
607 | |
608 | This function is called inside `create_breakpoint'. */ | |
f00aae0f KS |
609 | void (*create_sals_from_location) (const struct event_location *location, |
610 | struct linespec_result *canonical, | |
611 | enum bptype type_wanted); | |
983af33b SDJ |
612 | |
613 | /* This method will be responsible for creating a breakpoint given its SALs. | |
614 | Usually, it just calls `create_breakpoints_sal' (for ordinary | |
615 | breakpoints). However, there may be some special cases where we might | |
616 | need to do some tweaks, e.g., see | |
617 | `strace_marker_create_breakpoints_sal'. | |
618 | ||
619 | This function is called inside `create_breakpoint'. */ | |
620 | void (*create_breakpoints_sal) (struct gdbarch *, | |
621 | struct linespec_result *, | |
e1e01040 PA |
622 | gdb::unique_xmalloc_ptr<char>, |
623 | gdb::unique_xmalloc_ptr<char>, | |
983af33b SDJ |
624 | enum bptype, enum bpdisp, int, int, |
625 | int, const struct breakpoint_ops *, | |
44f238bb | 626 | int, int, int, unsigned); |
983af33b | 627 | |
c2f4122d | 628 | /* Given the location (second parameter), this method decodes it and |
6c5b2ebe | 629 | returns the SAL locations related to it. For ordinary |
c2f4122d PA |
630 | breakpoints, it calls `decode_line_full'. If SEARCH_PSPACE is |
631 | not NULL, symbol search is restricted to just that program space. | |
983af33b | 632 | |
5f700d83 | 633 | This function is called inside `location_to_sals'. */ |
6c5b2ebe PA |
634 | std::vector<symtab_and_line> (*decode_location) |
635 | (struct breakpoint *b, | |
636 | const struct event_location *location, | |
637 | struct program_space *search_pspace); | |
ab04a2af | 638 | |
47591c29 | 639 | /* Return true if this breakpoint explains a signal. See |
ab04a2af | 640 | bpstat_explains_signal. */ |
47591c29 | 641 | int (*explains_signal) (struct breakpoint *, enum gdb_signal); |
9d6e6e84 HZ |
642 | |
643 | /* Called after evaluating the breakpoint's condition, | |
644 | and only if it evaluated true. */ | |
645 | void (*after_condition_true) (struct bpstats *bs); | |
3086aeae DJ |
646 | }; |
647 | ||
d9b3f62e PA |
648 | /* Helper for breakpoint_ops->print_recreate implementations. Prints |
649 | the "thread" or "task" condition of B, and then a newline. | |
650 | ||
651 | Necessary because most breakpoint implementations accept | |
652 | thread/task conditions at the end of the spec line, like "break foo | |
653 | thread 1", which needs outputting before any breakpoint-type | |
654 | specific extra command necessary for B's recreation. */ | |
655 | extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp); | |
656 | ||
d983da9c DJ |
657 | enum watchpoint_triggered |
658 | { | |
659 | /* This watchpoint definitely did not trigger. */ | |
660 | watch_triggered_no = 0, | |
661 | ||
662 | /* Some hardware watchpoint triggered, and it might have been this | |
663 | one, but we do not know which it was. */ | |
664 | watch_triggered_unknown, | |
665 | ||
666 | /* This hardware watchpoint definitely did trigger. */ | |
667 | watch_triggered_yes | |
668 | }; | |
669 | ||
e09342b5 TJB |
670 | /* Some targets (e.g., embedded PowerPC) need two debug registers to set |
671 | a watchpoint over a memory region. If this flag is true, GDB will use | |
672 | only one register per watchpoint, thus assuming that all acesses that | |
673 | modify a memory location happen at its starting address. */ | |
674 | ||
675 | extern int target_exact_watchpoints; | |
676 | ||
c906108c SS |
677 | /* Note that the ->silent field is not currently used by any commands |
678 | (though the code is in there if it was to be, and set_raw_breakpoint | |
679 | does set it to 0). I implemented it because I thought it would be | |
680 | useful for a hack I had to put in; I'm going to leave it in because | |
681 | I can see how there might be times when it would indeed be useful */ | |
682 | ||
3a5c3e22 | 683 | /* This is for all kinds of breakpoints. */ |
c906108c SS |
684 | |
685 | struct breakpoint | |
bfb8cf90 | 686 | { |
c1fc2657 SM |
687 | virtual ~breakpoint (); |
688 | ||
bfb8cf90 | 689 | /* Methods associated with this breakpoint. */ |
16c4d54a | 690 | const breakpoint_ops *ops = NULL; |
bfb8cf90 | 691 | |
16c4d54a | 692 | breakpoint *next = NULL; |
bfb8cf90 | 693 | /* Type of breakpoint. */ |
16c4d54a | 694 | bptype type = bp_none; |
bfb8cf90 | 695 | /* Zero means disabled; remember the info but don't break here. */ |
16c4d54a | 696 | enum enable_state enable_state = bp_enabled; |
bfb8cf90 | 697 | /* What to do with this breakpoint after we hit it. */ |
16c4d54a | 698 | bpdisp disposition = disp_del; |
bfb8cf90 | 699 | /* Number assigned to distinguish breakpoints. */ |
16c4d54a | 700 | int number = 0; |
bfb8cf90 PA |
701 | |
702 | /* Location(s) associated with this high-level breakpoint. */ | |
16c4d54a | 703 | bp_location *loc = NULL; |
bfb8cf90 | 704 | |
16c4d54a PA |
705 | /* True means a silent breakpoint (don't print frame info if we stop |
706 | here). */ | |
707 | bool silent = false; | |
708 | /* True means display ADDR_STRING to the user verbatim. */ | |
709 | bool display_canonical = false; | |
bfb8cf90 PA |
710 | /* Number of stops at this breakpoint that should be continued |
711 | automatically before really stopping. */ | |
16c4d54a | 712 | int ignore_count = 0; |
bfb8cf90 PA |
713 | |
714 | /* Number of stops at this breakpoint before it will be | |
715 | disabled. */ | |
16c4d54a | 716 | int enable_count = 0; |
bfb8cf90 PA |
717 | |
718 | /* Chain of command lines to execute when this breakpoint is | |
719 | hit. */ | |
d1b0a7bf | 720 | counted_command_line commands; |
bfb8cf90 PA |
721 | /* Stack depth (address of frame). If nonzero, break only if fp |
722 | equals this. */ | |
16c4d54a | 723 | struct frame_id frame_id = null_frame_id; |
bfb8cf90 PA |
724 | |
725 | /* The program space used to set the breakpoint. This is only set | |
726 | for breakpoints which are specific to a program space; for | |
727 | non-thread-specific ordinary breakpoints this is NULL. */ | |
16c4d54a | 728 | program_space *pspace = NULL; |
bfb8cf90 PA |
729 | |
730 | /* Location we used to set the breakpoint. */ | |
731 | event_location_up location; | |
732 | ||
733 | /* The filter that should be passed to decode_line_full when | |
734 | re-setting this breakpoint. This may be NULL, but otherwise is | |
735 | allocated with xmalloc. */ | |
16c4d54a | 736 | char *filter = NULL; |
bfb8cf90 PA |
737 | |
738 | /* For a ranged breakpoint, the location we used to find the end of | |
739 | the range. */ | |
740 | event_location_up location_range_end; | |
741 | ||
742 | /* Architecture we used to set the breakpoint. */ | |
16c4d54a | 743 | struct gdbarch *gdbarch = NULL; |
bfb8cf90 | 744 | /* Language we used to set the breakpoint. */ |
16c4d54a | 745 | enum language language = language_unknown; |
bfb8cf90 | 746 | /* Input radix we used to set the breakpoint. */ |
16c4d54a | 747 | int input_radix = 0; |
bfb8cf90 PA |
748 | /* String form of the breakpoint condition (malloc'd), or NULL if |
749 | there is no condition. */ | |
16c4d54a | 750 | char *cond_string = NULL; |
bfb8cf90 PA |
751 | |
752 | /* String form of extra parameters, or NULL if there are none. | |
fb81d016 | 753 | Malloc'd. */ |
16c4d54a | 754 | char *extra_string = NULL; |
bfb8cf90 PA |
755 | |
756 | /* Holds the address of the related watchpoint_scope breakpoint when | |
757 | using watchpoints on local variables (might the concept of a | |
758 | related breakpoint be useful elsewhere, if not just call it the | |
759 | watchpoint_scope breakpoint or something like that. FIXME). */ | |
16c4d54a | 760 | breakpoint *related_breakpoint = NULL; |
bfb8cf90 PA |
761 | |
762 | /* Thread number for thread-specific breakpoint, or -1 if don't | |
763 | care. */ | |
16c4d54a | 764 | int thread = -1; |
bfb8cf90 PA |
765 | |
766 | /* Ada task number for task-specific breakpoint, or 0 if don't | |
767 | care. */ | |
16c4d54a | 768 | int task = 0; |
bfb8cf90 PA |
769 | |
770 | /* Count of the number of times this breakpoint was taken, dumped | |
771 | with the info, but not used for anything else. Useful for seeing | |
772 | how many times you hit a break prior to the program aborting, so | |
773 | you can back up to just before the abort. */ | |
16c4d54a | 774 | int hit_count = 0; |
bfb8cf90 PA |
775 | |
776 | /* Is breakpoint's condition not yet parsed because we found no | |
777 | location initially so had no context to parse the condition | |
778 | in. */ | |
16c4d54a | 779 | int condition_not_parsed = 0; |
bfb8cf90 PA |
780 | |
781 | /* With a Python scripting enabled GDB, store a reference to the | |
782 | Python object that has been associated with this breakpoint. | |
783 | This is always NULL for a GDB that is not script enabled. It can | |
784 | sometimes be NULL for enabled GDBs as not all breakpoint types | |
785 | are tracked by the scripting language API. */ | |
16c4d54a | 786 | gdbpy_breakpoint_object *py_bp_object = NULL; |
bfb8cf90 PA |
787 | |
788 | /* Same as py_bp_object, but for Scheme. */ | |
16c4d54a | 789 | gdbscm_breakpoint_object *scm_bp_object = NULL; |
bfb8cf90 | 790 | }; |
e09342b5 | 791 | |
c1fc2657 | 792 | /* An instance of this type is used to represent a watchpoint. */ |
9c06b0b4 | 793 | |
c1fc2657 | 794 | struct watchpoint : public breakpoint |
3a5c3e22 | 795 | { |
c1fc2657 | 796 | ~watchpoint () override; |
3a5c3e22 PA |
797 | |
798 | /* String form of exp to use for displaying to the user (malloc'd), | |
799 | or NULL if none. */ | |
800 | char *exp_string; | |
801 | /* String form to use for reparsing of EXP (malloc'd) or NULL. */ | |
802 | char *exp_string_reparse; | |
803 | ||
804 | /* The expression we are watching, or NULL if not a watchpoint. */ | |
4d01a485 | 805 | expression_up exp; |
3a5c3e22 PA |
806 | /* The largest block within which it is valid, or NULL if it is |
807 | valid anywhere (e.g. consists just of global symbols). */ | |
270140bd | 808 | const struct block *exp_valid_block; |
3a5c3e22 | 809 | /* The conditional expression if any. */ |
4d01a485 | 810 | expression_up cond_exp; |
3a5c3e22 PA |
811 | /* The largest block within which it is valid, or NULL if it is |
812 | valid anywhere (e.g. consists just of global symbols). */ | |
270140bd | 813 | const struct block *cond_exp_valid_block; |
3a5c3e22 PA |
814 | /* Value of the watchpoint the last time we checked it, or NULL when |
815 | we do not know the value yet or the value was not readable. VAL | |
816 | is never lazy. */ | |
850645cf | 817 | value_ref_ptr val; |
3a5c3e22 PA |
818 | /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL, |
819 | then an error occurred reading the value. */ | |
820 | int val_valid; | |
821 | ||
bb9d5f81 PP |
822 | /* When watching the location of a bitfield, contains the offset and size of |
823 | the bitfield. Otherwise contains 0. */ | |
824 | int val_bitpos; | |
825 | int val_bitsize; | |
826 | ||
3a5c3e22 PA |
827 | /* Holds the frame address which identifies the frame this |
828 | watchpoint should be evaluated in, or `null' if the watchpoint | |
829 | should be evaluated on the outermost frame. */ | |
830 | struct frame_id watchpoint_frame; | |
831 | ||
832 | /* Holds the thread which identifies the frame this watchpoint | |
833 | should be considered in scope for, or `null_ptid' if the | |
834 | watchpoint should be evaluated in all threads. */ | |
835 | ptid_t watchpoint_thread; | |
836 | ||
837 | /* For hardware watchpoints, the triggered status according to the | |
838 | hardware. */ | |
839 | enum watchpoint_triggered watchpoint_triggered; | |
840 | ||
841 | /* Whether this watchpoint is exact (see | |
842 | target_exact_watchpoints). */ | |
843 | int exact; | |
844 | ||
845 | /* The mask address for a masked hardware watchpoint. */ | |
846 | CORE_ADDR hw_wp_mask; | |
847 | }; | |
848 | ||
badd37ce SDJ |
849 | /* Given a function FUNC (struct breakpoint *B, void *DATA) and |
850 | USER_DATA, call FUNC for every known breakpoint passing USER_DATA | |
851 | as argument. | |
852 | ||
853 | If FUNC returns 1, the loop stops and the current | |
854 | 'struct breakpoint' being processed is returned. If FUNC returns | |
855 | zero, the loop continues. | |
856 | ||
857 | This function returns either a 'struct breakpoint' pointer or NULL. | |
858 | It was based on BFD's bfd_sections_find_if function. */ | |
859 | ||
860 | extern struct breakpoint *breakpoint_find_if | |
861 | (int (*func) (struct breakpoint *b, void *d), void *user_data); | |
862 | ||
b775012e LM |
863 | /* Return true if BPT is either a software breakpoint or a hardware |
864 | breakpoint. */ | |
865 | ||
866 | extern int is_breakpoint (const struct breakpoint *bpt); | |
867 | ||
3a5c3e22 PA |
868 | /* Returns true if BPT is really a watchpoint. */ |
869 | ||
870 | extern int is_watchpoint (const struct breakpoint *bpt); | |
d6e956e5 | 871 | |
d9b3f62e | 872 | /* An instance of this type is used to represent all kinds of |
c1fc2657 | 873 | tracepoints. */ |
d9b3f62e | 874 | |
c1fc2657 | 875 | struct tracepoint : public breakpoint |
d9b3f62e | 876 | { |
d9b3f62e PA |
877 | /* Number of times this tracepoint should single-step and collect |
878 | additional data. */ | |
879 | long step_count; | |
880 | ||
881 | /* Number of times this tracepoint should be hit before | |
882 | disabling/ending. */ | |
883 | int pass_count; | |
884 | ||
885 | /* The number of the tracepoint on the target. */ | |
886 | int number_on_target; | |
887 | ||
f196051f SS |
888 | /* The total space taken by all the trace frames for this |
889 | tracepoint. */ | |
890 | ULONGEST traceframe_usage; | |
891 | ||
d9b3f62e | 892 | /* The static tracepoint marker id, if known. */ |
5d9310c4 | 893 | std::string static_trace_marker_id; |
d9b3f62e PA |
894 | |
895 | /* LTTng/UST allow more than one marker with the same ID string, | |
896 | although it unadvised because it confuses tools. When setting | |
897 | static tracepoints by marker ID, this will record the index in | |
898 | the array of markers we found for the given marker ID for which | |
899 | this static tracepoint corresponds. When resetting breakpoints, | |
900 | we will use this index to try to find the same marker again. */ | |
901 | int static_trace_marker_id_idx; | |
902 | }; | |
903 | ||
c906108c | 904 | \f |
53a5351d JM |
905 | /* The following stuff is an abstract data type "bpstat" ("breakpoint |
906 | status"). This provides the ability to determine whether we have | |
907 | stopped at a breakpoint, and what we should do about it. */ | |
c906108c SS |
908 | |
909 | typedef struct bpstats *bpstat; | |
910 | ||
198757a8 VP |
911 | /* Clears a chain of bpstat, freeing storage |
912 | of each. */ | |
a14ed312 | 913 | extern void bpstat_clear (bpstat *); |
c906108c SS |
914 | |
915 | /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that | |
916 | is part of the bpstat is copied as well. */ | |
a14ed312 | 917 | extern bpstat bpstat_copy (bpstat); |
c906108c | 918 | |
ddfe970e KS |
919 | /* Build the (raw) bpstat chain for the stop information given by ASPACE, |
920 | BP_ADDR, and WS. Returns the head of the bpstat chain. */ | |
921 | ||
922 | extern bpstat build_bpstat_chain (const address_space *aspace, | |
923 | CORE_ADDR bp_addr, | |
924 | const struct target_waitstatus *ws); | |
925 | ||
926 | /* Get a bpstat associated with having just stopped at address | |
927 | BP_ADDR in thread PTID. STOP_CHAIN may be supplied as a previously | |
928 | computed stop chain or NULL, in which case the stop chain will be | |
929 | computed using build_bpstat_chain. | |
930 | ||
931 | Determine whether we stopped at a breakpoint, etc, or whether we | |
932 | don't understand this stop. Result is a chain of bpstat's such | |
933 | that: | |
934 | ||
935 | if we don't understand the stop, the result is a null pointer. | |
936 | ||
937 | if we understand why we stopped, the result is not null. | |
938 | ||
939 | Each element of the chain refers to a particular breakpoint or | |
940 | watchpoint at which we have stopped. (We may have stopped for | |
941 | several reasons concurrently.) | |
942 | ||
943 | Each element of the chain has valid next, breakpoint_at, | |
944 | commands, FIXME??? fields. */ | |
945 | ||
accd0bcd | 946 | extern bpstat bpstat_stop_status (const address_space *aspace, |
00431a78 | 947 | CORE_ADDR pc, thread_info *thread, |
ddfe970e KS |
948 | const struct target_waitstatus *ws, |
949 | bpstat stop_chain = NULL); | |
c906108c SS |
950 | \f |
951 | /* This bpstat_what stuff tells wait_for_inferior what to do with a | |
628fe4e4 JK |
952 | breakpoint (a challenging task). |
953 | ||
954 | The enum values order defines priority-like order of the actions. | |
955 | Once you've decided that some action is appropriate, you'll never | |
956 | go back and decide something of a lower priority is better. Each | |
957 | of these actions is mutually exclusive with the others. That | |
958 | means, that if you find yourself adding a new action class here and | |
959 | wanting to tell GDB that you have two simultaneous actions to | |
960 | handle, something is wrong, and you probably don't actually need a | |
961 | new action type. | |
962 | ||
963 | Note that a step resume breakpoint overrides another breakpoint of | |
964 | signal handling (see comment in wait_for_inferior at where we set | |
965 | the step_resume breakpoint). */ | |
c906108c | 966 | |
c5aa993b JM |
967 | enum bpstat_what_main_action |
968 | { | |
969 | /* Perform various other tests; that is, this bpstat does not | |
970 | say to perform any action (e.g. failed watchpoint and nothing | |
971 | else). */ | |
972 | BPSTAT_WHAT_KEEP_CHECKING, | |
973 | ||
c5aa993b | 974 | /* Remove breakpoints, single step once, then put them back in and |
0e2de366 MS |
975 | go back to what we were doing. It's possible that this should |
976 | be removed from the main_action and put into a separate field, | |
977 | to more cleanly handle | |
978 | BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */ | |
c5aa993b JM |
979 | BPSTAT_WHAT_SINGLE, |
980 | ||
981 | /* Set longjmp_resume breakpoint, remove all other breakpoints, | |
0e2de366 MS |
982 | and continue. The "remove all other breakpoints" part is |
983 | required if we are also stepping over another breakpoint as | |
984 | well as doing the longjmp handling. */ | |
c5aa993b JM |
985 | BPSTAT_WHAT_SET_LONGJMP_RESUME, |
986 | ||
987 | /* Clear longjmp_resume breakpoint, then handle as | |
988 | BPSTAT_WHAT_KEEP_CHECKING. */ | |
989 | BPSTAT_WHAT_CLEAR_LONGJMP_RESUME, | |
990 | ||
2c03e5be PA |
991 | /* Clear step resume breakpoint, and keep checking. */ |
992 | BPSTAT_WHAT_STEP_RESUME, | |
993 | ||
628fe4e4 JK |
994 | /* Rather than distinguish between noisy and silent stops here, it |
995 | might be cleaner to have bpstat_print make that decision (also | |
996 | taking into account stop_print_frame and source_only). But the | |
0e2de366 MS |
997 | implications are a bit scary (interaction with auto-displays, |
998 | etc.), so I won't try it. */ | |
c5aa993b | 999 | |
628fe4e4 JK |
1000 | /* Stop silently. */ |
1001 | BPSTAT_WHAT_STOP_SILENT, | |
c5aa993b | 1002 | |
628fe4e4 JK |
1003 | /* Stop and print. */ |
1004 | BPSTAT_WHAT_STOP_NOISY, | |
4efc6507 | 1005 | |
2c03e5be PA |
1006 | /* Clear step resume breakpoint, and keep checking. High-priority |
1007 | step-resume breakpoints are used when even if there's a user | |
1008 | breakpoint at the current PC when we set the step-resume | |
1009 | breakpoint, we don't want to re-handle any breakpoint other | |
1010 | than the step-resume when it's hit; instead we want to move | |
1011 | past the breakpoint. This is used in the case of skipping | |
1012 | signal handlers. */ | |
1013 | BPSTAT_WHAT_HP_STEP_RESUME, | |
c5aa993b JM |
1014 | }; |
1015 | ||
aa7d318d TT |
1016 | /* An enum indicating the kind of "stack dummy" stop. This is a bit |
1017 | of a misnomer because only one kind of truly a stack dummy. */ | |
1018 | enum stop_stack_kind | |
1019 | { | |
1020 | /* We didn't stop at a stack dummy breakpoint. */ | |
1021 | STOP_NONE = 0, | |
1022 | ||
1023 | /* Stopped at a stack dummy. */ | |
1024 | STOP_STACK_DUMMY, | |
1025 | ||
1026 | /* Stopped at std::terminate. */ | |
1027 | STOP_STD_TERMINATE | |
1028 | }; | |
1029 | ||
c5aa993b JM |
1030 | struct bpstat_what |
1031 | { | |
1032 | enum bpstat_what_main_action main_action; | |
1033 | ||
0e2de366 MS |
1034 | /* Did we hit a call dummy breakpoint? This only goes with a |
1035 | main_action of BPSTAT_WHAT_STOP_SILENT or | |
1036 | BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call | |
1037 | dummy without popping the frame is not a useful one). */ | |
aa7d318d | 1038 | enum stop_stack_kind call_dummy; |
186c406b TT |
1039 | |
1040 | /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and | |
1041 | BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a | |
1042 | longjmp, false if we are handling an exception. */ | |
1043 | int is_longjmp; | |
c5aa993b | 1044 | }; |
c906108c SS |
1045 | |
1046 | /* Tell what to do about this bpstat. */ | |
a14ed312 | 1047 | struct bpstat_what bpstat_what (bpstat); |
243a9253 PA |
1048 | |
1049 | /* Run breakpoint event callbacks associated with the breakpoints that | |
1050 | triggered. */ | |
1051 | extern void bpstat_run_callbacks (bpstat bs_head); | |
1052 | ||
0e2de366 | 1053 | /* Find the bpstat associated with a breakpoint. NULL otherwise. */ |
a14ed312 | 1054 | bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *); |
c906108c | 1055 | |
47591c29 PA |
1056 | /* Nonzero if a signal that we got in target_wait() was due to |
1057 | circumstances explained by the bpstat; the signal is therefore not | |
1058 | random. */ | |
1059 | extern int bpstat_explains_signal (bpstat, enum gdb_signal); | |
c906108c | 1060 | |
67822962 PA |
1061 | /* Nonzero is this bpstat causes a stop. */ |
1062 | extern int bpstat_causes_stop (bpstat); | |
1063 | ||
c906108c SS |
1064 | /* Nonzero if we should step constantly (e.g. watchpoints on machines |
1065 | without hardware support). This isn't related to a specific bpstat, | |
1066 | just to things like whether watchpoints are set. */ | |
a14ed312 | 1067 | extern int bpstat_should_step (void); |
c906108c | 1068 | |
c906108c SS |
1069 | /* Print a message indicating what happened. Returns nonzero to |
1070 | say that only the source line should be printed after this (zero | |
1071 | return means print the frame as well as the source line). */ | |
36dfb11c | 1072 | extern enum print_stop_action bpstat_print (bpstat, int); |
c906108c | 1073 | |
0e2de366 MS |
1074 | /* Put in *NUM the breakpoint number of the first breakpoint we are |
1075 | stopped at. *BSP upon return is a bpstat which points to the | |
1076 | remaining breakpoints stopped at (but which is not guaranteed to be | |
1077 | good for anything but further calls to bpstat_num). | |
1078 | ||
8671a17b PA |
1079 | Return 0 if passed a bpstat which does not indicate any breakpoints. |
1080 | Return -1 if stopped at a breakpoint that has been deleted since | |
1081 | we set it. | |
1082 | Return 1 otherwise. */ | |
1083 | extern int bpstat_num (bpstat *, int *); | |
c906108c | 1084 | |
347bddb7 PA |
1085 | /* Perform actions associated with the stopped inferior. Actually, we |
1086 | just use this for breakpoint commands. Perhaps other actions will | |
1087 | go here later, but this is executed at a late time (from the | |
1088 | command loop). */ | |
1089 | extern void bpstat_do_actions (void); | |
c906108c | 1090 | |
e93ca019 JK |
1091 | /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will |
1092 | not be performed. */ | |
1093 | extern void bpstat_clear_actions (void); | |
c906108c | 1094 | |
c906108c | 1095 | /* Implementation: */ |
e514a9d6 | 1096 | |
0e2de366 MS |
1097 | /* Values used to tell the printing routine how to behave for this |
1098 | bpstat. */ | |
e514a9d6 JM |
1099 | enum bp_print_how |
1100 | { | |
1101 | /* This is used when we want to do a normal printing of the reason | |
0e2de366 MS |
1102 | for stopping. The output will depend on the type of eventpoint |
1103 | we are dealing with. This is the default value, most commonly | |
1104 | used. */ | |
e514a9d6 | 1105 | print_it_normal, |
0e2de366 MS |
1106 | /* This is used when nothing should be printed for this bpstat |
1107 | entry. */ | |
e514a9d6 JM |
1108 | print_it_noop, |
1109 | /* This is used when everything which needs to be printed has | |
1110 | already been printed. But we still want to print the frame. */ | |
1111 | print_it_done | |
1112 | }; | |
1113 | ||
c906108c | 1114 | struct bpstats |
c5aa993b | 1115 | { |
04afa70c TT |
1116 | bpstats (); |
1117 | bpstats (struct bp_location *bl, bpstat **bs_link_pointer); | |
1118 | ~bpstats (); | |
1119 | ||
1120 | bpstats (const bpstats &); | |
1121 | bpstats &operator= (const bpstats &) = delete; | |
1122 | ||
f431efe5 PA |
1123 | /* Linked list because there can be more than one breakpoint at |
1124 | the same place, and a bpstat reflects the fact that all have | |
1125 | been hit. */ | |
c5aa993b | 1126 | bpstat next; |
f431efe5 PA |
1127 | |
1128 | /* Location that caused the stop. Locations are refcounted, so | |
1129 | this will never be NULL. Note that this location may end up | |
1130 | detached from a breakpoint, but that does not necessary mean | |
1131 | that the struct breakpoint is gone. E.g., consider a | |
1132 | watchpoint with a condition that involves an inferior function | |
1133 | call. Watchpoint locations are recreated often (on resumes, | |
1134 | hence on infcalls too). Between creating the bpstat and after | |
1135 | evaluating the watchpoint condition, this location may hence | |
1136 | end up detached from its original owner watchpoint, even though | |
1137 | the watchpoint is still listed. If it's condition evaluates as | |
1138 | true, we still want this location to cause a stop, and we will | |
1139 | still need to know which watchpoint it was originally attached. | |
1140 | What this means is that we should not (in most cases) follow | |
1141 | the `bpstat->bp_location->owner' link, but instead use the | |
1142 | `breakpoint_at' field below. */ | |
1143 | struct bp_location *bp_location_at; | |
1144 | ||
1145 | /* Breakpoint that caused the stop. This is nullified if the | |
1146 | breakpoint ends up being deleted. See comments on | |
1147 | `bp_location_at' above for why do we need this field instead of | |
1148 | following the location's owner. */ | |
1149 | struct breakpoint *breakpoint_at; | |
1150 | ||
9add0f1b | 1151 | /* The associated command list. */ |
d1b0a7bf | 1152 | counted_command_line commands; |
f431efe5 | 1153 | |
c5aa993b | 1154 | /* Old value associated with a watchpoint. */ |
850645cf | 1155 | value_ref_ptr old_val; |
c5aa993b JM |
1156 | |
1157 | /* Nonzero if this breakpoint tells us to print the frame. */ | |
1158 | char print; | |
1159 | ||
1160 | /* Nonzero if this breakpoint tells us to stop. */ | |
1161 | char stop; | |
1162 | ||
e514a9d6 JM |
1163 | /* Tell bpstat_print and print_bp_stop_message how to print stuff |
1164 | associated with this element of the bpstat chain. */ | |
1165 | enum bp_print_how print_it; | |
c5aa993b | 1166 | }; |
c906108c SS |
1167 | |
1168 | enum inf_context | |
c5aa993b JM |
1169 | { |
1170 | inf_starting, | |
1171 | inf_running, | |
6ca15a4b PA |
1172 | inf_exited, |
1173 | inf_execd | |
c5aa993b | 1174 | }; |
c2c6d25f JM |
1175 | |
1176 | /* The possible return values for breakpoint_here_p. | |
1177 | We guarantee that zero always means "no breakpoint here". */ | |
1178 | enum breakpoint_here | |
1179 | { | |
1180 | no_breakpoint_here = 0, | |
1181 | ordinary_breakpoint_here, | |
1182 | permanent_breakpoint_here | |
1183 | }; | |
c906108c | 1184 | \f |
c5aa993b | 1185 | |
c906108c SS |
1186 | /* Prototypes for breakpoint-related functions. */ |
1187 | ||
1cf4d951 PA |
1188 | /* Return 1 if there's a program/permanent breakpoint planted in |
1189 | memory at ADDRESS, return 0 otherwise. */ | |
1190 | ||
1191 | extern int program_breakpoint_here_p (struct gdbarch *gdbarch, CORE_ADDR address); | |
1192 | ||
accd0bcd | 1193 | extern enum breakpoint_here breakpoint_here_p (const address_space *, |
0e2de366 | 1194 | CORE_ADDR); |
c906108c | 1195 | |
d35ae833 PA |
1196 | /* Return true if an enabled breakpoint exists in the range defined by |
1197 | ADDR and LEN, in ASPACE. */ | |
accd0bcd | 1198 | extern int breakpoint_in_range_p (const address_space *aspace, |
d35ae833 PA |
1199 | CORE_ADDR addr, ULONGEST len); |
1200 | ||
accd0bcd | 1201 | extern int moribund_breakpoint_here_p (const address_space *, CORE_ADDR); |
1c5cfe86 | 1202 | |
accd0bcd YQ |
1203 | extern int breakpoint_inserted_here_p (const address_space *, |
1204 | CORE_ADDR); | |
c906108c | 1205 | |
accd0bcd | 1206 | extern int software_breakpoint_inserted_here_p (const address_space *, |
0e2de366 | 1207 | CORE_ADDR); |
4fa8626c | 1208 | |
9c02b525 PA |
1209 | /* Return non-zero iff there is a hardware breakpoint inserted at |
1210 | PC. */ | |
accd0bcd | 1211 | extern int hardware_breakpoint_inserted_here_p (const address_space *, |
9c02b525 PA |
1212 | CORE_ADDR); |
1213 | ||
34b7e8a6 PA |
1214 | /* Check whether any location of BP is inserted at PC. */ |
1215 | ||
1216 | extern int breakpoint_has_location_inserted_here (struct breakpoint *bp, | |
accd0bcd | 1217 | const address_space *aspace, |
34b7e8a6 PA |
1218 | CORE_ADDR pc); |
1219 | ||
accd0bcd | 1220 | extern int single_step_breakpoint_inserted_here_p (const address_space *, |
2adfaa28 PA |
1221 | CORE_ADDR); |
1222 | ||
9093389c PA |
1223 | /* Returns true if there's a hardware watchpoint or access watchpoint |
1224 | inserted in the range defined by ADDR and LEN. */ | |
accd0bcd | 1225 | extern int hardware_watchpoint_inserted_in_range (const address_space *, |
9093389c PA |
1226 | CORE_ADDR addr, |
1227 | ULONGEST len); | |
1228 | ||
31e77af2 PA |
1229 | /* Returns true if {ASPACE1,ADDR1} and {ASPACE2,ADDR2} represent the |
1230 | same breakpoint location. In most targets, this can only be true | |
1231 | if ASPACE1 matches ASPACE2. On targets that have global | |
1232 | breakpoints, the address space doesn't really matter. */ | |
1233 | ||
accd0bcd | 1234 | extern int breakpoint_address_match (const address_space *aspace1, |
31e77af2 | 1235 | CORE_ADDR addr1, |
accd0bcd | 1236 | const address_space *aspace2, |
31e77af2 PA |
1237 | CORE_ADDR addr2); |
1238 | ||
f2fc3015 | 1239 | extern void until_break_command (const char *, int, int); |
c906108c | 1240 | |
28010a5d PA |
1241 | /* Initialize a struct bp_location. */ |
1242 | ||
6c5b2ebe PA |
1243 | extern void update_breakpoint_locations |
1244 | (struct breakpoint *b, | |
1245 | struct program_space *filter_pspace, | |
1246 | gdb::array_view<const symtab_and_line> sals, | |
1247 | gdb::array_view<const symtab_and_line> sals_end); | |
0e30163f | 1248 | |
a14ed312 | 1249 | extern void breakpoint_re_set (void); |
69de3c6a | 1250 | |
a14ed312 | 1251 | extern void breakpoint_re_set_thread (struct breakpoint *); |
c906108c | 1252 | |
454dafbd TT |
1253 | extern void delete_breakpoint (struct breakpoint *); |
1254 | ||
1255 | struct breakpoint_deleter | |
1256 | { | |
1257 | void operator() (struct breakpoint *b) const | |
1258 | { | |
1259 | delete_breakpoint (b); | |
1260 | } | |
1261 | }; | |
1262 | ||
1263 | typedef std::unique_ptr<struct breakpoint, breakpoint_deleter> breakpoint_up; | |
1264 | ||
1265 | extern breakpoint_up set_momentary_breakpoint | |
a6d9a66e | 1266 | (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype); |
c906108c | 1267 | |
454dafbd | 1268 | extern breakpoint_up set_momentary_breakpoint_at_pc |
a6d9a66e | 1269 | (struct gdbarch *, CORE_ADDR pc, enum bptype type); |
611c83ae | 1270 | |
e58b0e63 PA |
1271 | extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt); |
1272 | ||
a14ed312 | 1273 | extern void set_ignore_count (int, int, int); |
c906108c | 1274 | |
a14ed312 | 1275 | extern void breakpoint_init_inferior (enum inf_context); |
c906108c | 1276 | |
a14ed312 | 1277 | extern void breakpoint_auto_delete (bpstat); |
c906108c | 1278 | |
20388dd6 YQ |
1279 | typedef void (*walk_bp_location_callback) (struct bp_location *, void *); |
1280 | ||
1281 | extern void iterate_over_bp_locations (walk_bp_location_callback); | |
1282 | ||
5cea2a26 PA |
1283 | /* Return the chain of command lines to execute when this breakpoint |
1284 | is hit. */ | |
1285 | extern struct command_line *breakpoint_commands (struct breakpoint *b); | |
1286 | ||
956a9fb9 JB |
1287 | /* Return a string image of DISP. The string is static, and thus should |
1288 | NOT be deallocated after use. */ | |
1289 | const char *bpdisp_text (enum bpdisp disp); | |
1290 | ||
0b39b52e | 1291 | extern void break_command (const char *, int); |
c906108c | 1292 | |
0b39b52e TT |
1293 | extern void hbreak_command_wrapper (const char *, int); |
1294 | extern void thbreak_command_wrapper (const char *, int); | |
1295 | extern void rbreak_command_wrapper (const char *, int); | |
f2fc3015 TT |
1296 | extern void watch_command_wrapper (const char *, int, int); |
1297 | extern void awatch_command_wrapper (const char *, int, int); | |
1298 | extern void rwatch_command_wrapper (const char *, int, int); | |
0b39b52e | 1299 | extern void tbreak_command (const char *, int); |
c906108c | 1300 | |
ab04a2af | 1301 | extern struct breakpoint_ops base_breakpoint_ops; |
348d480f | 1302 | extern struct breakpoint_ops bkpt_breakpoint_ops; |
19ca11c5 | 1303 | extern struct breakpoint_ops tracepoint_breakpoint_ops; |
c5867ab6 | 1304 | extern struct breakpoint_ops dprintf_breakpoint_ops; |
348d480f | 1305 | |
2060206e | 1306 | extern void initialize_breakpoint_ops (void); |
348d480f | 1307 | |
9ac4176b PA |
1308 | /* Arguments to pass as context to some catch command handlers. */ |
1309 | #define CATCH_PERMANENT ((void *) (uintptr_t) 0) | |
1310 | #define CATCH_TEMPORARY ((void *) (uintptr_t) 1) | |
1311 | ||
1312 | /* Like add_cmd, but add the command to both the "catch" and "tcatch" | |
1313 | lists, and pass some additional user data to the command | |
1314 | function. */ | |
1315 | ||
1316 | extern void | |
a121b7c1 | 1317 | add_catch_command (const char *name, const char *docstring, |
eb4c3f4a | 1318 | cmd_const_sfunc_ftype *sfunc, |
625e8578 | 1319 | completer_ftype *completer, |
9ac4176b PA |
1320 | void *user_data_catch, |
1321 | void *user_data_tcatch); | |
1322 | ||
28010a5d | 1323 | /* Initialize a breakpoint struct for Ada exception catchpoints. */ |
9ac4176b PA |
1324 | |
1325 | extern void | |
28010a5d PA |
1326 | init_ada_exception_breakpoint (struct breakpoint *b, |
1327 | struct gdbarch *gdbarch, | |
1328 | struct symtab_and_line sal, | |
f2fc3015 | 1329 | const char *addr_string, |
c0a91b2b | 1330 | const struct breakpoint_ops *ops, |
28010a5d | 1331 | int tempflag, |
349774ef | 1332 | int enabled, |
28010a5d PA |
1333 | int from_tty); |
1334 | ||
ab04a2af TT |
1335 | extern void init_catchpoint (struct breakpoint *b, |
1336 | struct gdbarch *gdbarch, int tempflag, | |
63160a43 | 1337 | const char *cond_string, |
ab04a2af TT |
1338 | const struct breakpoint_ops *ops); |
1339 | ||
28010a5d | 1340 | /* Add breakpoint B on the breakpoint list, and notify the user, the |
3a5c3e22 PA |
1341 | target and breakpoint_created observers of its existence. If |
1342 | INTERNAL is non-zero, the breakpoint number will be allocated from | |
3ea46bff YQ |
1343 | the internal breakpoint count. If UPDATE_GLL is non-zero, |
1344 | update_global_location_list will be called. */ | |
28010a5d | 1345 | |
b270e6f9 | 1346 | extern void install_breakpoint (int internal, std::unique_ptr<breakpoint> &&b, |
3ea46bff | 1347 | int update_gll); |
9ac4176b | 1348 | |
44f238bb PA |
1349 | /* Flags that can be passed down to create_breakpoint, etc., to affect |
1350 | breakpoint creation in several ways. */ | |
1351 | ||
1352 | enum breakpoint_create_flags | |
1353 | { | |
1354 | /* We're adding a breakpoint to our tables that is already | |
1355 | inserted in the target. */ | |
1356 | CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0 | |
1357 | }; | |
1358 | ||
f00aae0f KS |
1359 | /* Set a breakpoint. This function is shared between CLI and MI functions |
1360 | for setting a breakpoint at LOCATION. | |
1361 | ||
1362 | This function has two major modes of operations, selected by the | |
1363 | PARSE_EXTRA parameter. | |
1364 | ||
1365 | If PARSE_EXTRA is zero, LOCATION is just the breakpoint's location, | |
1366 | with condition, thread, and extra string specified by the COND_STRING, | |
1367 | THREAD, and EXTRA_STRING parameters. | |
1368 | ||
1369 | If PARSE_EXTRA is non-zero, this function will attempt to extract | |
1370 | the condition, thread, and extra string from EXTRA_STRING, ignoring | |
1371 | the similarly named parameters. | |
1372 | ||
1373 | If INTERNAL is non-zero, the breakpoint number will be allocated | |
1374 | from the internal breakpoint count. | |
1375 | ||
1376 | Returns true if any breakpoint was created; false otherwise. */ | |
1377 | ||
1378 | extern int create_breakpoint (struct gdbarch *gdbarch, | |
1379 | const struct event_location *location, | |
e1e01040 PA |
1380 | const char *cond_string, int thread, |
1381 | const char *extra_string, | |
f00aae0f | 1382 | int parse_extra, |
0fb4aa4b | 1383 | int tempflag, enum bptype wanted_type, |
8cdf0e15 VP |
1384 | int ignore_count, |
1385 | enum auto_boolean pending_break_support, | |
c0a91b2b | 1386 | const struct breakpoint_ops *ops, |
8cdf0e15 | 1387 | int from_tty, |
84f4c1fe | 1388 | int enabled, |
44f238bb | 1389 | int internal, unsigned flags); |
98deb0da | 1390 | |
e236ba44 | 1391 | extern void insert_breakpoints (void); |
c906108c | 1392 | |
a14ed312 | 1393 | extern int remove_breakpoints (void); |
c906108c | 1394 | |
00431a78 | 1395 | extern int remove_breakpoints_inf (inferior *inf); |
6c95b8df | 1396 | |
c906108c SS |
1397 | /* This function can be used to update the breakpoint package's state |
1398 | after an exec() system call has been executed. | |
1399 | ||
1400 | This function causes the following: | |
1401 | ||
c5aa993b JM |
1402 | - All eventpoints are marked "not inserted". |
1403 | - All eventpoints with a symbolic address are reset such that | |
1404 | the symbolic address must be reevaluated before the eventpoints | |
1405 | can be reinserted. | |
1406 | - The solib breakpoints are explicitly removed from the breakpoint | |
1407 | list. | |
1408 | - A step-resume breakpoint, if any, is explicitly removed from the | |
1409 | breakpoint list. | |
1410 | - All eventpoints without a symbolic address are removed from the | |
0e2de366 | 1411 | breakpoint list. */ |
a14ed312 | 1412 | extern void update_breakpoints_after_exec (void); |
c906108c SS |
1413 | |
1414 | /* This function can be used to physically remove hardware breakpoints | |
1415 | and watchpoints from the specified traced inferior process, without | |
1416 | modifying the breakpoint package's state. This can be useful for | |
1417 | those targets which support following the processes of a fork() or | |
1418 | vfork() system call, when one of the resulting two processes is to | |
1419 | be detached and allowed to run free. | |
c5aa993b | 1420 | |
c906108c | 1421 | It is an error to use this function on the process whose id is |
39f77062 | 1422 | inferior_ptid. */ |
d80ee84f | 1423 | extern int detach_breakpoints (ptid_t ptid); |
c5aa993b | 1424 | |
6c95b8df PA |
1425 | /* This function is called when program space PSPACE is about to be |
1426 | deleted. It takes care of updating breakpoints to not reference | |
1427 | this PSPACE anymore. */ | |
1428 | extern void breakpoint_program_space_exit (struct program_space *pspace); | |
1429 | ||
186c406b TT |
1430 | extern void set_longjmp_breakpoint (struct thread_info *tp, |
1431 | struct frame_id frame); | |
611c83ae PA |
1432 | extern void delete_longjmp_breakpoint (int thread); |
1433 | ||
f59f708a PA |
1434 | /* Mark all longjmp breakpoints from THREAD for later deletion. */ |
1435 | extern void delete_longjmp_breakpoint_at_next_stop (int thread); | |
1436 | ||
e2e4d78b | 1437 | extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void); |
b67a2c6f | 1438 | extern void check_longjmp_breakpoint_for_call_dummy (struct thread_info *tp); |
e2e4d78b | 1439 | |
1900040c MS |
1440 | extern void enable_overlay_breakpoints (void); |
1441 | extern void disable_overlay_breakpoints (void); | |
c906108c | 1442 | |
aa7d318d TT |
1443 | extern void set_std_terminate_breakpoint (void); |
1444 | extern void delete_std_terminate_breakpoint (void); | |
1445 | ||
c906108c SS |
1446 | /* These functions respectively disable or reenable all currently |
1447 | enabled watchpoints. When disabled, the watchpoints are marked | |
64b9b334 | 1448 | call_disabled. When re-enabled, they are marked enabled. |
c906108c | 1449 | |
04714b91 | 1450 | The intended client of these functions is call_function_by_hand. |
c906108c SS |
1451 | |
1452 | The inferior must be stopped, and all breakpoints removed, when | |
1453 | these functions are used. | |
1454 | ||
1455 | The need for these functions is that on some targets (e.g., HP-UX), | |
1456 | gdb is unable to unwind through the dummy frame that is pushed as | |
1457 | part of the implementation of a call command. Watchpoints can | |
1458 | cause the inferior to stop in places where this frame is visible, | |
1459 | and that can cause execution control to become very confused. | |
1460 | ||
7e73cedf | 1461 | Note that if a user sets breakpoints in an interactively called |
64b9b334 | 1462 | function, the call_disabled watchpoints will have been re-enabled |
c906108c SS |
1463 | when the first such breakpoint is reached. However, on targets |
1464 | that are unable to unwind through the call dummy frame, watches | |
1465 | of stack-based storage may then be deleted, because gdb will | |
1466 | believe that their watched storage is out of scope. (Sigh.) */ | |
a14ed312 | 1467 | extern void disable_watchpoints_before_interactive_call_start (void); |
c906108c | 1468 | |
a14ed312 | 1469 | extern void enable_watchpoints_after_interactive_call_stop (void); |
c906108c | 1470 | |
8bea4e01 UW |
1471 | /* These functions disable and re-enable all breakpoints during |
1472 | inferior startup. They are intended to be called from solib | |
1473 | code where necessary. This is needed on platforms where the | |
1474 | main executable is relocated at some point during startup | |
1475 | processing, making breakpoint addresses invalid. | |
1476 | ||
1477 | If additional breakpoints are created after the routine | |
1478 | disable_breakpoints_before_startup but before the routine | |
1479 | enable_breakpoints_after_startup was called, they will also | |
1480 | be marked as disabled. */ | |
1481 | extern void disable_breakpoints_before_startup (void); | |
1482 | extern void enable_breakpoints_after_startup (void); | |
1483 | ||
40c03ae8 | 1484 | /* For script interpreters that need to define breakpoint commands |
0e2de366 MS |
1485 | after they've already read the commands into a struct |
1486 | command_line. */ | |
40c03ae8 | 1487 | extern enum command_control_type commands_from_control_command |
896b6bda | 1488 | (const char *arg, struct command_line *cmd); |
c5aa993b | 1489 | |
a14ed312 | 1490 | extern void clear_breakpoint_hit_counts (void); |
c906108c | 1491 | |
48cb2d85 VP |
1492 | extern struct breakpoint *get_breakpoint (int num); |
1493 | ||
0e2de366 MS |
1494 | /* The following are for displays, which aren't really breakpoints, |
1495 | but here is as good a place as any for them. */ | |
c906108c | 1496 | |
a14ed312 | 1497 | extern void disable_current_display (void); |
c906108c | 1498 | |
a14ed312 | 1499 | extern void do_displays (void); |
c906108c | 1500 | |
a14ed312 | 1501 | extern void disable_display (int); |
c906108c | 1502 | |
a14ed312 | 1503 | extern void clear_displays (void); |
c906108c | 1504 | |
a14ed312 | 1505 | extern void disable_breakpoint (struct breakpoint *); |
c906108c | 1506 | |
a14ed312 | 1507 | extern void enable_breakpoint (struct breakpoint *); |
c906108c | 1508 | |
48cb2d85 | 1509 | extern void breakpoint_set_commands (struct breakpoint *b, |
12973681 | 1510 | counted_command_line &&commands); |
48cb2d85 | 1511 | |
45a43567 TT |
1512 | extern void breakpoint_set_silent (struct breakpoint *b, int silent); |
1513 | ||
1514 | extern void breakpoint_set_thread (struct breakpoint *b, int thread); | |
1515 | ||
1516 | extern void breakpoint_set_task (struct breakpoint *b, int task); | |
1517 | ||
25b22b0a PA |
1518 | /* Clear the "inserted" flag in all breakpoints. */ |
1519 | extern void mark_breakpoints_out (void); | |
1520 | ||
4efc6507 DE |
1521 | extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *, |
1522 | CORE_ADDR); | |
1523 | ||
a6d9a66e UW |
1524 | extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *, |
1525 | CORE_ADDR); | |
c906108c | 1526 | |
f37f681c PA |
1527 | /* Create an solib event breakpoint at ADDRESS in the current program |
1528 | space, and immediately try to insert it. Returns a pointer to the | |
1529 | breakpoint on success. Deletes the new breakpoint and returns NULL | |
1530 | if inserting the breakpoint fails. */ | |
1531 | extern struct breakpoint *create_and_insert_solib_event_breakpoint | |
1532 | (struct gdbarch *gdbarch, CORE_ADDR address); | |
1533 | ||
a6d9a66e UW |
1534 | extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *, |
1535 | CORE_ADDR); | |
c4093a6a | 1536 | |
03673fc7 PP |
1537 | extern void remove_jit_event_breakpoints (void); |
1538 | ||
a14ed312 | 1539 | extern void remove_solib_event_breakpoints (void); |
c906108c | 1540 | |
f37f681c PA |
1541 | /* Mark solib event breakpoints of the current program space with |
1542 | delete at next stop disposition. */ | |
1543 | extern void remove_solib_event_breakpoints_at_next_stop (void); | |
1544 | ||
cb851954 | 1545 | extern void disable_breakpoints_in_shlibs (void); |
c906108c | 1546 | |
0e2de366 | 1547 | /* This function returns TRUE if ep is a catchpoint. */ |
c326b90e | 1548 | extern int is_catchpoint (struct breakpoint *); |
c5aa993b | 1549 | |
91985142 MG |
1550 | /* Shared helper function (MI and CLI) for creating and installing |
1551 | a shared object event catchpoint. */ | |
a121b7c1 | 1552 | extern void add_solib_catchpoint (const char *arg, int is_load, int is_temp, |
91985142 MG |
1553 | int enabled); |
1554 | ||
7c16b83e PA |
1555 | /* Create and insert a new software single step breakpoint for the |
1556 | current thread. May be called multiple times; each time will add a | |
1557 | new location to the set of potential addresses the next instruction | |
1558 | is at. */ | |
6c95b8df | 1559 | extern void insert_single_step_breakpoint (struct gdbarch *, |
accd0bcd | 1560 | const address_space *, |
0e2de366 | 1561 | CORE_ADDR); |
93f9a11f YQ |
1562 | |
1563 | /* Insert all software single step breakpoints for the current frame. | |
1564 | Return true if any software single step breakpoints are inserted, | |
1565 | otherwise, return false. */ | |
1566 | extern int insert_single_step_breakpoints (struct gdbarch *); | |
1567 | ||
d983da9c DJ |
1568 | /* Check if any hardware watchpoints have triggered, according to the |
1569 | target. */ | |
1570 | int watchpoints_triggered (struct target_waitstatus *); | |
1571 | ||
f0ba3972 PA |
1572 | /* Helper for transparent breakpoint hiding for memory read and write |
1573 | routines. | |
1574 | ||
1575 | Update one of READBUF or WRITEBUF with either the shadows | |
1576 | (READBUF), or the breakpoint instructions (WRITEBUF) of inserted | |
1577 | breakpoints at the memory range defined by MEMADDR and extending | |
1578 | for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG | |
1579 | on entry.*/ | |
1580 | extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf, | |
1581 | const gdb_byte *writebuf_org, | |
1582 | ULONGEST memaddr, LONGEST len); | |
8defab1a | 1583 | |
b57bacec PA |
1584 | /* Return true if breakpoints should be inserted now. That'll be the |
1585 | case if either: | |
1586 | ||
1587 | - the target has global breakpoints. | |
1588 | ||
1589 | - "breakpoint always-inserted" is on, and the target has | |
1590 | execution. | |
1591 | ||
1592 | - threads are executing. | |
1593 | */ | |
a25a5a45 | 1594 | extern int breakpoints_should_be_inserted_now (void); |
74960c60 | 1595 | |
20874c92 VP |
1596 | /* Called each time new event from target is processed. |
1597 | Retires previously deleted breakpoint locations that | |
1598 | in our opinion won't ever trigger. */ | |
1599 | extern void breakpoint_retire_moribund (void); | |
1600 | ||
adc36818 | 1601 | /* Set break condition of breakpoint B to EXP. */ |
7a26bd4d | 1602 | extern void set_breakpoint_condition (struct breakpoint *b, const char *exp, |
adc36818 PM |
1603 | int from_tty); |
1604 | ||
a96d9b2e SDJ |
1605 | /* Checks if we are catching syscalls or not. |
1606 | Returns 0 if not, greater than 0 if we are. */ | |
1607 | extern int catch_syscall_enabled (void); | |
1608 | ||
1609 | /* Checks if we are catching syscalls with the specific | |
1610 | syscall_number. Used for "filtering" the catchpoints. | |
1611 | Returns 0 if not, greater than 0 if we are. */ | |
1612 | extern int catching_syscall_number (int syscall_number); | |
1613 | ||
1042e4c0 | 1614 | /* Return a tracepoint with the given number if found. */ |
d9b3f62e | 1615 | extern struct tracepoint *get_tracepoint (int num); |
1042e4c0 | 1616 | |
d9b3f62e | 1617 | extern struct tracepoint *get_tracepoint_by_number_on_target (int num); |
d5551862 | 1618 | |
1042e4c0 | 1619 | /* Find a tracepoint by parsing a number in the supplied string. */ |
d9b3f62e | 1620 | extern struct tracepoint * |
0b39b52e | 1621 | get_tracepoint_by_number (const char **arg, |
bfd28288 | 1622 | number_or_range_parser *parser); |
1042e4c0 | 1623 | |
f51e0e20 TT |
1624 | /* Return a vector of all tracepoints currently defined. */ |
1625 | extern std::vector<breakpoint *> all_tracepoints (void); | |
1042e4c0 | 1626 | |
d77f58be | 1627 | extern int is_tracepoint (const struct breakpoint *b); |
a7bdde9e | 1628 | |
f51e0e20 TT |
1629 | /* Return a vector of all static tracepoints defined at ADDR. */ |
1630 | extern std::vector<breakpoint *> static_tracepoints_here (CORE_ADDR addr); | |
0fb4aa4b | 1631 | |
c80049d3 TT |
1632 | /* Create an instance of this to start registering breakpoint numbers |
1633 | for a later "commands" command. */ | |
1634 | ||
1635 | class scoped_rbreak_breakpoints | |
1636 | { | |
1637 | public: | |
1638 | ||
1639 | scoped_rbreak_breakpoints (); | |
1640 | ~scoped_rbreak_breakpoints (); | |
1641 | ||
1642 | DISABLE_COPY_AND_ASSIGN (scoped_rbreak_breakpoints); | |
1643 | }; | |
95a42b64 | 1644 | |
84f4c1fe PM |
1645 | /* Breakpoint iterator function. |
1646 | ||
1647 | Calls a callback function once for each breakpoint, so long as the | |
1648 | callback function returns false. If the callback function returns | |
1649 | true, the iteration will end and the current breakpoint will be | |
1650 | returned. This can be useful for implementing a search for a | |
1651 | breakpoint with arbitrary attributes, or for applying an operation | |
1652 | to every breakpoint. */ | |
1653 | extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *, | |
1654 | void *), void *); | |
1655 | ||
0574c78f GB |
1656 | /* Nonzero if the specified PC cannot be a location where functions |
1657 | have been inlined. */ | |
1658 | ||
accd0bcd | 1659 | extern int pc_at_non_inline_function (const address_space *aspace, |
09ac7c10 TT |
1660 | CORE_ADDR pc, |
1661 | const struct target_waitstatus *ws); | |
0574c78f | 1662 | |
09d682a4 TT |
1663 | extern int user_breakpoint_p (struct breakpoint *); |
1664 | ||
93daf339 TT |
1665 | /* Return true if this breakpoint is pending, false if not. */ |
1666 | extern int pending_breakpoint_p (struct breakpoint *); | |
1667 | ||
1bfeeb0f JL |
1668 | /* Attempt to determine architecture of location identified by SAL. */ |
1669 | extern struct gdbarch *get_sal_arch (struct symtab_and_line sal); | |
1670 | ||
2f202fde JK |
1671 | extern void breakpoint_free_objfile (struct objfile *objfile); |
1672 | ||
63160a43 | 1673 | extern const char *ep_parse_optional_if_clause (const char **arg); |
916703c0 | 1674 | |
f303dbd6 PA |
1675 | /* Print the "Thread ID hit" part of "Thread ID hit Breakpoint N" to |
1676 | UIOUT iff debugging multiple threads. */ | |
1677 | extern void maybe_print_thread_hit_breakpoint (struct ui_out *uiout); | |
1678 | ||
65630365 PA |
1679 | /* Print the specified breakpoint. */ |
1680 | extern void print_breakpoint (breakpoint *bp); | |
1681 | ||
8588b356 SM |
1682 | /* Command element for the 'commands' command. */ |
1683 | extern cmd_list_element *commands_cmd_element; | |
1684 | ||
c906108c | 1685 | #endif /* !defined (BREAKPOINT_H) */ |