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