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