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