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