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