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