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