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