Tests for validate symbol file using build-id.
[gdb/archer.git] / gdb / breakpoint.h
blob7df1122ed50ebbceb3afbbeedbdb1dd51361ff97
1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2013 Free Software Foundation, Inc.
4 This file is part of GDB.
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
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
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.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19 #if !defined (BREAKPOINT_H)
20 #define BREAKPOINT_H 1
22 #include "frame.h"
23 #include "value.h"
24 #include "vec.h"
25 #include "ax.h"
26 #include "command.h"
28 struct value;
29 struct block;
30 struct breakpoint_object;
31 struct get_number_or_range_state;
32 struct thread_info;
33 struct bpstats;
34 struct bp_location;
35 struct linespec_result;
36 struct linespec_sals;
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. */
43 #define BREAKPOINT_MAX 16
46 /* Type of breakpoint. */
47 /* FIXME In the future, we should fold all other breakpoint-like
48 things into here. This includes:
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). */
54 enum bptype
56 bp_none = 0, /* Eventpoint has been deleted */
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() */
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,
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,
81 /* Used by wait_for_inferior for stepping over subroutine calls,
82 and for skipping prologues. */
83 bp_step_resume,
85 /* Used by wait_for_inferior for stepping over signal
86 handlers. */
87 bp_hp_step_resume,
89 /* Used to detect when a watchpoint expression has gone out of
90 scope. These breakpoints are usually not visible to the user.
92 This breakpoint has some interesting properties:
94 1) There's always a 1:1 mapping between watchpoints
95 on local variables and watchpoint_scope breakpoints.
97 2) It automatically deletes itself and the watchpoint it's
98 associated with when hit.
100 3) It can never be disabled. */
101 bp_watchpoint_scope,
103 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
104 is chained with by related_breakpoint. */
105 bp_call_dummy,
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,
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).
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,
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).
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. */
129 bp_thread_event,
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. */
137 bp_overlay_event,
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. */
144 bp_longjmp_master,
146 /* Master copies of std::terminate breakpoints. */
147 bp_std_terminate_master,
149 /* Like bp_longjmp_master, but for exceptions. */
150 bp_exception_master,
152 bp_catchpoint,
154 bp_tracepoint,
155 bp_fast_tracepoint,
156 bp_static_tracepoint,
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,
165 /* Event for JIT compiled code generation or deletion. */
166 bp_jit_event,
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,
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,
182 /* States of enablement of breakpoint. */
184 enum enable_state
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). */
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. */
207 /* Disposition of breakpoint. Ie: what to do after hitting it. */
209 enum bpdisp
211 disp_del, /* Delete it */
212 disp_del_at_next_stop, /* Delete at next stop,
213 whether hit or not */
214 disp_disable, /* Disable it */
215 disp_donttouch /* Leave it alone */
218 enum target_hw_bp_type
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 */
227 /* Status of breakpoint conditions used when synchronizing
228 conditions with the target. */
230 enum condition_status
232 condition_unchanged = 0,
233 condition_modified,
234 condition_updated
237 /* Information used by targets to insert and remove breakpoints. */
239 struct bp_target_info
241 /* Address space at which the breakpoint was placed. */
242 struct address_space *placed_address_space;
244 /* Address at which the breakpoint was placed. This is normally the
245 same as ADDRESS from the bp_location, except when adjustment
246 happens in gdbarch_breakpoint_from_pc. The most common form of
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;
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;
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];
261 /* The length of the data cached in SHADOW_CONTENTS. */
262 int shadow_len;
264 /* The size of the placed breakpoint, according to
265 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
266 This is generally the same as SHADOW_LEN, unless we did not need
267 to read from the target to implement the memory breakpoint
268 (e.g. if a remote stub handled the details). We may still need
269 the size to remove the breakpoint safely. */
270 int placed_size;
272 /* Vector of conditions the target should evaluate if it supports target-side
273 breakpoint conditions. */
274 VEC(agent_expr_p) *conditions;
276 /* Vector of commands the target should evaluate if it supports
277 target-side breakpoint commands. */
278 VEC(agent_expr_p) *tcommands;
280 /* Flag that is true if the breakpoint should be left in place even
281 when GDB is not connected. */
282 int persist;
285 /* GDB maintains two types of information about each breakpoint (or
286 watchpoint, or other related event). The first type corresponds
287 to struct breakpoint; this is a relatively high-level structure
288 which contains the source location(s), stopping conditions, user
289 commands to execute when the breakpoint is hit, and so forth.
291 The second type of information corresponds to struct bp_location.
292 Each breakpoint has one or (eventually) more locations associated
293 with it, which represent target-specific and machine-specific
294 mechanisms for stopping the program. For instance, a watchpoint
295 expression may require multiple hardware watchpoints in order to
296 catch all changes in the value of the expression being watched. */
298 enum bp_loc_type
300 bp_loc_software_breakpoint,
301 bp_loc_hardware_breakpoint,
302 bp_loc_hardware_watchpoint,
303 bp_loc_other /* Miscellaneous... */
306 /* This structure is a collection of function pointers that, if
307 available, will be called instead of performing the default action
308 for this bp_loc_type. */
310 struct bp_location_ops
312 /* Destructor. Releases everything from SELF (but not SELF
313 itself). */
314 void (*dtor) (struct bp_location *self);
317 struct bp_location
319 /* Chain pointer to the next breakpoint location for
320 the same parent breakpoint. */
321 struct bp_location *next;
323 /* Methods associated with this location. */
324 const struct bp_location_ops *ops;
326 /* The reference count. */
327 int refc;
329 /* Type of this breakpoint location. */
330 enum bp_loc_type loc_type;
332 /* Each breakpoint location must belong to exactly one higher-level
333 breakpoint. This pointer is NULL iff this bp_location is no
334 longer attached to a breakpoint. For example, when a breakpoint
335 is deleted, its locations may still be found in the
336 moribund_locations list, or if we had stopped for it, in
337 bpstats. */
338 struct breakpoint *owner;
340 /* Conditional. Break only if this expression's value is nonzero.
341 Unlike string form of condition, which is associated with
342 breakpoint, this is associated with location, since if breakpoint
343 has several locations, the evaluation of expression can be
344 different for different locations. Only valid for real
345 breakpoints; a watchpoint's conditional expression is stored in
346 the owner breakpoint object. */
347 struct expression *cond;
349 /* Conditional expression in agent expression
350 bytecode form. This is used for stub-side breakpoint
351 condition evaluation. */
352 struct agent_expr *cond_bytecode;
354 /* Signals that the condition has changed since the last time
355 we updated the global location list. This means the condition
356 needs to be sent to the target again. This is used together
357 with target-side breakpoint conditions.
359 condition_unchanged: It means there has been no condition changes.
361 condition_modified: It means this location had its condition modified.
363 condition_updated: It means we already marked all the locations that are
364 duplicates of this location and thus we don't need to call
365 force_breakpoint_reinsertion (...) for this location. */
367 enum condition_status condition_changed;
369 struct agent_expr *cmd_bytecode;
371 /* Signals that breakpoint conditions and/or commands need to be
372 re-synched with the target. This has no use other than
373 target-side breakpoints. */
374 char needs_update;
376 /* This location's address is in an unloaded solib, and so this
377 location should not be inserted. It will be automatically
378 enabled when that solib is loaded. */
379 char shlib_disabled;
381 /* Is this particular location enabled. */
382 char enabled;
384 /* Nonzero if this breakpoint is now inserted. */
385 char inserted;
387 /* Nonzero if this is not the first breakpoint in the list
388 for the given address. location of tracepoint can _never_
389 be duplicated with other locations of tracepoints and other
390 kinds of breakpoints, because two locations at the same
391 address may have different actions, so both of these locations
392 should be downloaded and so that `tfind N' always works. */
393 char duplicate;
395 /* If we someday support real thread-specific breakpoints, then
396 the breakpoint location will need a thread identifier. */
398 /* Data for specific breakpoint types. These could be a union, but
399 simplicity is more important than memory usage for breakpoints. */
401 /* Architecture associated with this location's address. May be
402 different from the breakpoint architecture. */
403 struct gdbarch *gdbarch;
405 /* The program space associated with this breakpoint location
406 address. Note that an address space may be represented in more
407 than one program space (e.g. each uClinux program will be given
408 its own program space, but there will only be one address space
409 for all of them), but we must not insert more than one location
410 at the same address in the same address space. */
411 struct program_space *pspace;
413 /* Note that zero is a perfectly valid code address on some platforms
414 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
415 is not a special value for this field. Valid for all types except
416 bp_loc_other. */
417 CORE_ADDR address;
419 /* For hardware watchpoints, the size of the memory region being
420 watched. For hardware ranged breakpoints, the size of the
421 breakpoint range. */
422 int length;
424 /* Type of hardware watchpoint. */
425 enum target_hw_bp_type watchpoint_type;
427 /* For any breakpoint type with an address, this is the section
428 associated with the address. Used primarily for overlay
429 debugging. */
430 struct obj_section *section;
432 /* Address at which breakpoint was requested, either by the user or
433 by GDB for internal breakpoints. This will usually be the same
434 as ``address'' (above) except for cases in which
435 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
436 which to place the breakpoint in order to comply with a
437 processor's architectual constraints. */
438 CORE_ADDR requested_address;
440 /* An additional address assigned with this location. This is currently
441 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
442 of the resolver function. */
443 CORE_ADDR related_address;
445 /* If the location comes from a probe point, this is the probe associated
446 with it. */
447 struct probe *probe;
449 char *function_name;
451 /* Details of the placed breakpoint, when inserted. */
452 struct bp_target_info target_info;
454 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
455 struct bp_target_info overlay_target_info;
457 /* In a non-stop mode, it's possible that we delete a breakpoint,
458 but as we do that, some still running thread hits that breakpoint.
459 For that reason, we need to keep locations belonging to deleted
460 breakpoints for a bit, so that don't report unexpected SIGTRAP.
461 We can't keep such locations forever, so we use a heuristic --
462 after we process certain number of inferior events since
463 breakpoint was deleted, we retire all locations of that breakpoint.
464 This variable keeps a number of events still to go, when
465 it becomes 0 this location is retired. */
466 int events_till_retirement;
468 /* Line number which was used to place this location.
470 Breakpoint placed into a comment keeps it's user specified line number
471 despite ADDRESS resolves into a different line number. */
473 int line_number;
475 /* Symtab which was used to place this location. This is used
476 to find the corresponding source file name. */
478 struct symtab *symtab;
481 /* Return values for bpstat_explains_signal. Note that the order of
482 the constants is important here; they are compared directly in
483 bpstat_explains_signal. */
485 enum bpstat_signal_value
487 /* bpstat does not explain this signal. */
488 BPSTAT_SIGNAL_NO = 0,
490 /* bpstat explains this signal; signal should not be delivered. */
491 BPSTAT_SIGNAL_HIDE,
493 /* bpstat explains this signal; signal should be delivered. */
494 BPSTAT_SIGNAL_PASS
497 /* This structure is a collection of function pointers that, if available,
498 will be called instead of the performing the default action for this
499 bptype. */
501 struct breakpoint_ops
503 /* Destructor. Releases everything from SELF (but not SELF
504 itself). */
505 void (*dtor) (struct breakpoint *self);
507 /* Allocate a location for this breakpoint. */
508 struct bp_location * (*allocate_location) (struct breakpoint *);
510 /* Reevaluate a breakpoint. This is necessary after symbols change
511 (e.g., an executable or DSO was loaded, or the inferior just
512 started). */
513 void (*re_set) (struct breakpoint *self);
515 /* Insert the breakpoint or watchpoint or activate the catchpoint.
516 Return 0 for success, 1 if the breakpoint, watchpoint or
517 catchpoint type is not supported, -1 for failure. */
518 int (*insert_location) (struct bp_location *);
520 /* Remove the breakpoint/catchpoint that was previously inserted
521 with the "insert" method above. Return 0 for success, 1 if the
522 breakpoint, watchpoint or catchpoint type is not supported,
523 -1 for failure. */
524 int (*remove_location) (struct bp_location *);
526 /* Return true if it the target has stopped due to hitting
527 breakpoint location BL. This function does not check if we
528 should stop, only if BL explains the stop. ASPACE is the address
529 space in which the event occurred, BP_ADDR is the address at
530 which the inferior stopped, and WS is the target_waitstatus
531 describing the event. */
532 int (*breakpoint_hit) (const struct bp_location *bl,
533 struct address_space *aspace,
534 CORE_ADDR bp_addr,
535 const struct target_waitstatus *ws);
537 /* Check internal conditions of the breakpoint referred to by BS.
538 If we should not stop for this breakpoint, set BS->stop to 0. */
539 void (*check_status) (struct bpstats *bs);
541 /* Tell how many hardware resources (debug registers) are needed
542 for this breakpoint. If this function is not provided, then
543 the breakpoint or watchpoint needs one debug register. */
544 int (*resources_needed) (const struct bp_location *);
546 /* Tell whether we can downgrade from a hardware watchpoint to a software
547 one. If not, the user will not be able to enable the watchpoint when
548 there are not enough hardware resources available. */
549 int (*works_in_software_mode) (const struct breakpoint *);
551 /* The normal print routine for this breakpoint, called when we
552 hit it. */
553 enum print_stop_action (*print_it) (struct bpstats *bs);
555 /* Display information about this breakpoint, for "info
556 breakpoints". */
557 void (*print_one) (struct breakpoint *, struct bp_location **);
559 /* Display extra information about this breakpoint, below the normal
560 breakpoint description in "info breakpoints".
562 In the example below, the "address range" line was printed
563 by print_one_detail_ranged_breakpoint.
565 (gdb) info breakpoints
566 Num Type Disp Enb Address What
567 2 hw breakpoint keep y in main at test-watch.c:70
568 address range: [0x10000458, 0x100004c7]
571 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
573 /* Display information about this breakpoint after setting it
574 (roughly speaking; this is called from "mention"). */
575 void (*print_mention) (struct breakpoint *);
577 /* Print to FP the CLI command that recreates this breakpoint. */
578 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
580 /* Create SALs from address string, storing the result in linespec_result.
582 For an explanation about the arguments, see the function
583 `create_sals_from_address_default'.
585 This function is called inside `create_breakpoint'. */
586 void (*create_sals_from_address) (char **, struct linespec_result *,
587 enum bptype, char *, char **);
589 /* This method will be responsible for creating a breakpoint given its SALs.
590 Usually, it just calls `create_breakpoints_sal' (for ordinary
591 breakpoints). However, there may be some special cases where we might
592 need to do some tweaks, e.g., see
593 `strace_marker_create_breakpoints_sal'.
595 This function is called inside `create_breakpoint'. */
596 void (*create_breakpoints_sal) (struct gdbarch *,
597 struct linespec_result *,
598 struct linespec_sals *, char *,
599 char *,
600 enum bptype, enum bpdisp, int, int,
601 int, const struct breakpoint_ops *,
602 int, int, int, unsigned);
604 /* Given the address string (second parameter), this method decodes it
605 and provides the SAL locations related to it. For ordinary breakpoints,
606 it calls `decode_line_full'.
608 This function is called inside `addr_string_to_sals'. */
609 void (*decode_linespec) (struct breakpoint *, char **,
610 struct symtabs_and_lines *);
612 /* Return true if this breakpoint explains a signal, but the signal
613 should still be delivered to the inferior. This is used to make
614 'catch signal' interact properly with 'handle'; see
615 bpstat_explains_signal. */
616 enum bpstat_signal_value (*explains_signal) (struct breakpoint *);
619 /* Helper for breakpoint_ops->print_recreate implementations. Prints
620 the "thread" or "task" condition of B, and then a newline.
622 Necessary because most breakpoint implementations accept
623 thread/task conditions at the end of the spec line, like "break foo
624 thread 1", which needs outputting before any breakpoint-type
625 specific extra command necessary for B's recreation. */
626 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
628 enum watchpoint_triggered
630 /* This watchpoint definitely did not trigger. */
631 watch_triggered_no = 0,
633 /* Some hardware watchpoint triggered, and it might have been this
634 one, but we do not know which it was. */
635 watch_triggered_unknown,
637 /* This hardware watchpoint definitely did trigger. */
638 watch_triggered_yes
641 typedef struct bp_location *bp_location_p;
642 DEF_VEC_P(bp_location_p);
644 /* A reference-counted struct command_line. This lets multiple
645 breakpoints share a single command list. This is an implementation
646 detail to the breakpoints module. */
647 struct counted_command_line;
649 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
650 a watchpoint over a memory region. If this flag is true, GDB will use
651 only one register per watchpoint, thus assuming that all acesses that
652 modify a memory location happen at its starting address. */
654 extern int target_exact_watchpoints;
656 /* Note that the ->silent field is not currently used by any commands
657 (though the code is in there if it was to be, and set_raw_breakpoint
658 does set it to 0). I implemented it because I thought it would be
659 useful for a hack I had to put in; I'm going to leave it in because
660 I can see how there might be times when it would indeed be useful */
662 /* This is for all kinds of breakpoints. */
664 struct breakpoint
666 /* Methods associated with this breakpoint. */
667 const struct breakpoint_ops *ops;
669 struct breakpoint *next;
670 /* Type of breakpoint. */
671 enum bptype type;
672 /* Zero means disabled; remember the info but don't break here. */
673 enum enable_state enable_state;
674 /* What to do with this breakpoint after we hit it. */
675 enum bpdisp disposition;
676 /* Number assigned to distinguish breakpoints. */
677 int number;
679 /* Location(s) associated with this high-level breakpoint. */
680 struct bp_location *loc;
682 /* Non-zero means a silent breakpoint (don't print frame info
683 if we stop here). */
684 unsigned char silent;
685 /* Non-zero means display ADDR_STRING to the user verbatim. */
686 unsigned char display_canonical;
687 /* Number of stops at this breakpoint that should
688 be continued automatically before really stopping. */
689 int ignore_count;
691 /* Number of stops at this breakpoint before it will be
692 disabled. */
693 int enable_count;
695 /* Chain of command lines to execute when this breakpoint is
696 hit. */
697 struct counted_command_line *commands;
698 /* Stack depth (address of frame). If nonzero, break only if fp
699 equals this. */
700 struct frame_id frame_id;
702 /* The program space used to set the breakpoint. This is only set
703 for breakpoints which are specific to a program space; for
704 non-thread-specific ordinary breakpoints this is NULL. */
705 struct program_space *pspace;
707 /* String we used to set the breakpoint (malloc'd). */
708 char *addr_string;
710 /* The filter that should be passed to decode_line_full when
711 re-setting this breakpoint. This may be NULL, but otherwise is
712 allocated with xmalloc. */
713 char *filter;
715 /* For a ranged breakpoint, the string we used to find
716 the end of the range (malloc'd). */
717 char *addr_string_range_end;
719 /* Architecture we used to set the breakpoint. */
720 struct gdbarch *gdbarch;
721 /* Language we used to set the breakpoint. */
722 enum language language;
723 /* Input radix we used to set the breakpoint. */
724 int input_radix;
725 /* String form of the breakpoint condition (malloc'd), or NULL if
726 there is no condition. */
727 char *cond_string;
729 /* String form of extra parameters, or NULL if there are none.
730 Malloc'd. */
731 char *extra_string;
733 /* Holds the address of the related watchpoint_scope breakpoint
734 when using watchpoints on local variables (might the concept of
735 a related breakpoint be useful elsewhere, if not just call it
736 the watchpoint_scope breakpoint or something like that.
737 FIXME). */
738 struct breakpoint *related_breakpoint;
740 /* Thread number for thread-specific breakpoint,
741 or -1 if don't care. */
742 int thread;
744 /* Ada task number for task-specific breakpoint,
745 or 0 if don't care. */
746 int task;
748 /* Count of the number of times this breakpoint was taken, dumped
749 with the info, but not used for anything else. Useful for
750 seeing how many times you hit a break prior to the program
751 aborting, so you can back up to just before the abort. */
752 int hit_count;
754 /* Is breakpoint's condition not yet parsed because we found
755 no location initially so had no context to parse
756 the condition in. */
757 int condition_not_parsed;
759 /* With a Python scripting enabled GDB, store a reference to the
760 Python object that has been associated with this breakpoint.
761 This is always NULL for a GDB that is not script enabled. It
762 can sometimes be NULL for enabled GDBs as not all breakpoint
763 types are tracked by the Python scripting API. */
764 struct breakpoint_object *py_bp_object;
767 /* An instance of this type is used to represent a watchpoint. It
768 includes a "struct breakpoint" as a kind of base class; users
769 downcast to "struct breakpoint *" when needed. */
771 struct watchpoint
773 /* The base class. */
774 struct breakpoint base;
776 /* String form of exp to use for displaying to the user (malloc'd),
777 or NULL if none. */
778 char *exp_string;
779 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
780 char *exp_string_reparse;
782 /* The expression we are watching, or NULL if not a watchpoint. */
783 struct expression *exp;
784 /* The largest block within which it is valid, or NULL if it is
785 valid anywhere (e.g. consists just of global symbols). */
786 const struct block *exp_valid_block;
787 /* The conditional expression if any. */
788 struct expression *cond_exp;
789 /* The largest block within which it is valid, or NULL if it is
790 valid anywhere (e.g. consists just of global symbols). */
791 const struct block *cond_exp_valid_block;
792 /* Value of the watchpoint the last time we checked it, or NULL when
793 we do not know the value yet or the value was not readable. VAL
794 is never lazy. */
795 struct value *val;
796 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
797 then an error occurred reading the value. */
798 int val_valid;
800 /* Holds the frame address which identifies the frame this
801 watchpoint should be evaluated in, or `null' if the watchpoint
802 should be evaluated on the outermost frame. */
803 struct frame_id watchpoint_frame;
805 /* Holds the thread which identifies the frame this watchpoint
806 should be considered in scope for, or `null_ptid' if the
807 watchpoint should be evaluated in all threads. */
808 ptid_t watchpoint_thread;
810 /* For hardware watchpoints, the triggered status according to the
811 hardware. */
812 enum watchpoint_triggered watchpoint_triggered;
814 /* Whether this watchpoint is exact (see
815 target_exact_watchpoints). */
816 int exact;
818 /* The mask address for a masked hardware watchpoint. */
819 CORE_ADDR hw_wp_mask;
822 /* Return true if BPT is either a software breakpoint or a hardware
823 breakpoint. */
825 extern int is_breakpoint (const struct breakpoint *bpt);
827 /* Returns true if BPT is really a watchpoint. */
829 extern int is_watchpoint (const struct breakpoint *bpt);
831 /* An instance of this type is used to represent all kinds of
832 tracepoints. It includes a "struct breakpoint" as a kind of base
833 class; users downcast to "struct breakpoint *" when needed. */
835 struct tracepoint
837 /* The base class. */
838 struct breakpoint base;
840 /* Number of times this tracepoint should single-step and collect
841 additional data. */
842 long step_count;
844 /* Number of times this tracepoint should be hit before
845 disabling/ending. */
846 int pass_count;
848 /* The number of the tracepoint on the target. */
849 int number_on_target;
851 /* The total space taken by all the trace frames for this
852 tracepoint. */
853 ULONGEST traceframe_usage;
855 /* The static tracepoint marker id, if known. */
856 char *static_trace_marker_id;
858 /* LTTng/UST allow more than one marker with the same ID string,
859 although it unadvised because it confuses tools. When setting
860 static tracepoints by marker ID, this will record the index in
861 the array of markers we found for the given marker ID for which
862 this static tracepoint corresponds. When resetting breakpoints,
863 we will use this index to try to find the same marker again. */
864 int static_trace_marker_id_idx;
867 typedef struct breakpoint *breakpoint_p;
868 DEF_VEC_P(breakpoint_p);
870 /* The following stuff is an abstract data type "bpstat" ("breakpoint
871 status"). This provides the ability to determine whether we have
872 stopped at a breakpoint, and what we should do about it. */
874 typedef struct bpstats *bpstat;
876 /* Clears a chain of bpstat, freeing storage
877 of each. */
878 extern void bpstat_clear (bpstat *);
880 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
881 is part of the bpstat is copied as well. */
882 extern bpstat bpstat_copy (bpstat);
884 extern bpstat bpstat_stop_status (struct address_space *aspace,
885 CORE_ADDR pc, ptid_t ptid,
886 const struct target_waitstatus *ws);
888 /* This bpstat_what stuff tells wait_for_inferior what to do with a
889 breakpoint (a challenging task).
891 The enum values order defines priority-like order of the actions.
892 Once you've decided that some action is appropriate, you'll never
893 go back and decide something of a lower priority is better. Each
894 of these actions is mutually exclusive with the others. That
895 means, that if you find yourself adding a new action class here and
896 wanting to tell GDB that you have two simultaneous actions to
897 handle, something is wrong, and you probably don't actually need a
898 new action type.
900 Note that a step resume breakpoint overrides another breakpoint of
901 signal handling (see comment in wait_for_inferior at where we set
902 the step_resume breakpoint). */
904 enum bpstat_what_main_action
906 /* Perform various other tests; that is, this bpstat does not
907 say to perform any action (e.g. failed watchpoint and nothing
908 else). */
909 BPSTAT_WHAT_KEEP_CHECKING,
911 /* Remove breakpoints, single step once, then put them back in and
912 go back to what we were doing. It's possible that this should
913 be removed from the main_action and put into a separate field,
914 to more cleanly handle
915 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
916 BPSTAT_WHAT_SINGLE,
918 /* Set longjmp_resume breakpoint, remove all other breakpoints,
919 and continue. The "remove all other breakpoints" part is
920 required if we are also stepping over another breakpoint as
921 well as doing the longjmp handling. */
922 BPSTAT_WHAT_SET_LONGJMP_RESUME,
924 /* Clear longjmp_resume breakpoint, then handle as
925 BPSTAT_WHAT_KEEP_CHECKING. */
926 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
928 /* Clear step resume breakpoint, and keep checking. */
929 BPSTAT_WHAT_STEP_RESUME,
931 /* Rather than distinguish between noisy and silent stops here, it
932 might be cleaner to have bpstat_print make that decision (also
933 taking into account stop_print_frame and source_only). But the
934 implications are a bit scary (interaction with auto-displays,
935 etc.), so I won't try it. */
937 /* Stop silently. */
938 BPSTAT_WHAT_STOP_SILENT,
940 /* Stop and print. */
941 BPSTAT_WHAT_STOP_NOISY,
943 /* Clear step resume breakpoint, and keep checking. High-priority
944 step-resume breakpoints are used when even if there's a user
945 breakpoint at the current PC when we set the step-resume
946 breakpoint, we don't want to re-handle any breakpoint other
947 than the step-resume when it's hit; instead we want to move
948 past the breakpoint. This is used in the case of skipping
949 signal handlers. */
950 BPSTAT_WHAT_HP_STEP_RESUME,
953 /* An enum indicating the kind of "stack dummy" stop. This is a bit
954 of a misnomer because only one kind of truly a stack dummy. */
955 enum stop_stack_kind
957 /* We didn't stop at a stack dummy breakpoint. */
958 STOP_NONE = 0,
960 /* Stopped at a stack dummy. */
961 STOP_STACK_DUMMY,
963 /* Stopped at std::terminate. */
964 STOP_STD_TERMINATE
967 struct bpstat_what
969 enum bpstat_what_main_action main_action;
971 /* Did we hit a call dummy breakpoint? This only goes with a
972 main_action of BPSTAT_WHAT_STOP_SILENT or
973 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
974 dummy without popping the frame is not a useful one). */
975 enum stop_stack_kind call_dummy;
977 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
978 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
979 longjmp, false if we are handling an exception. */
980 int is_longjmp;
983 /* The possible return values for print_bpstat, print_it_normal,
984 print_it_done, print_it_noop. */
985 enum print_stop_action
987 /* We printed nothing or we need to do some more analysis. */
988 PRINT_UNKNOWN = -1,
990 /* We printed something, and we *do* desire that something to be
991 followed by a location. */
992 PRINT_SRC_AND_LOC,
994 /* We printed something, and we do *not* desire that something to
995 be followed by a location. */
996 PRINT_SRC_ONLY,
998 /* We already printed all we needed to print, don't print anything
999 else. */
1000 PRINT_NOTHING
1003 /* Tell what to do about this bpstat. */
1004 struct bpstat_what bpstat_what (bpstat);
1006 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1007 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
1009 /* Nonzero if a signal that we got in wait() was due to circumstances
1010 explained by the bpstat; and the signal should therefore not be
1011 delivered. */
1012 extern enum bpstat_signal_value bpstat_explains_signal (bpstat);
1014 /* Nonzero is this bpstat causes a stop. */
1015 extern int bpstat_causes_stop (bpstat);
1017 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1018 without hardware support). This isn't related to a specific bpstat,
1019 just to things like whether watchpoints are set. */
1020 extern int bpstat_should_step (void);
1022 /* Print a message indicating what happened. Returns nonzero to
1023 say that only the source line should be printed after this (zero
1024 return means print the frame as well as the source line). */
1025 extern enum print_stop_action bpstat_print (bpstat, int);
1027 /* Put in *NUM the breakpoint number of the first breakpoint we are
1028 stopped at. *BSP upon return is a bpstat which points to the
1029 remaining breakpoints stopped at (but which is not guaranteed to be
1030 good for anything but further calls to bpstat_num).
1032 Return 0 if passed a bpstat which does not indicate any breakpoints.
1033 Return -1 if stopped at a breakpoint that has been deleted since
1034 we set it.
1035 Return 1 otherwise. */
1036 extern int bpstat_num (bpstat *, int *);
1038 /* Perform actions associated with the stopped inferior. Actually, we
1039 just use this for breakpoint commands. Perhaps other actions will
1040 go here later, but this is executed at a late time (from the
1041 command loop). */
1042 extern void bpstat_do_actions (void);
1044 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1045 not be performed. */
1046 extern void bpstat_clear_actions (void);
1048 /* Implementation: */
1050 /* Values used to tell the printing routine how to behave for this
1051 bpstat. */
1052 enum bp_print_how
1054 /* This is used when we want to do a normal printing of the reason
1055 for stopping. The output will depend on the type of eventpoint
1056 we are dealing with. This is the default value, most commonly
1057 used. */
1058 print_it_normal,
1059 /* This is used when nothing should be printed for this bpstat
1060 entry. */
1061 print_it_noop,
1062 /* This is used when everything which needs to be printed has
1063 already been printed. But we still want to print the frame. */
1064 print_it_done
1067 struct bpstats
1069 /* Linked list because there can be more than one breakpoint at
1070 the same place, and a bpstat reflects the fact that all have
1071 been hit. */
1072 bpstat next;
1074 /* Location that caused the stop. Locations are refcounted, so
1075 this will never be NULL. Note that this location may end up
1076 detached from a breakpoint, but that does not necessary mean
1077 that the struct breakpoint is gone. E.g., consider a
1078 watchpoint with a condition that involves an inferior function
1079 call. Watchpoint locations are recreated often (on resumes,
1080 hence on infcalls too). Between creating the bpstat and after
1081 evaluating the watchpoint condition, this location may hence
1082 end up detached from its original owner watchpoint, even though
1083 the watchpoint is still listed. If it's condition evaluates as
1084 true, we still want this location to cause a stop, and we will
1085 still need to know which watchpoint it was originally attached.
1086 What this means is that we should not (in most cases) follow
1087 the `bpstat->bp_location->owner' link, but instead use the
1088 `breakpoint_at' field below. */
1089 struct bp_location *bp_location_at;
1091 /* Breakpoint that caused the stop. This is nullified if the
1092 breakpoint ends up being deleted. See comments on
1093 `bp_location_at' above for why do we need this field instead of
1094 following the location's owner. */
1095 struct breakpoint *breakpoint_at;
1097 /* The associated command list. */
1098 struct counted_command_line *commands;
1100 /* Old value associated with a watchpoint. */
1101 struct value *old_val;
1103 /* Nonzero if this breakpoint tells us to print the frame. */
1104 char print;
1106 /* Nonzero if this breakpoint tells us to stop. */
1107 char stop;
1109 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1110 associated with this element of the bpstat chain. */
1111 enum bp_print_how print_it;
1114 enum inf_context
1116 inf_starting,
1117 inf_running,
1118 inf_exited,
1119 inf_execd
1122 /* The possible return values for breakpoint_here_p.
1123 We guarantee that zero always means "no breakpoint here". */
1124 enum breakpoint_here
1126 no_breakpoint_here = 0,
1127 ordinary_breakpoint_here,
1128 permanent_breakpoint_here
1132 /* Prototypes for breakpoint-related functions. */
1134 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
1135 CORE_ADDR);
1137 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1139 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1141 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1142 CORE_ADDR);
1144 extern int software_breakpoint_inserted_here_p (struct address_space *,
1145 CORE_ADDR);
1147 /* Returns true if there's a hardware watchpoint or access watchpoint
1148 inserted in the range defined by ADDR and LEN. */
1149 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1150 CORE_ADDR addr,
1151 ULONGEST len);
1153 extern int breakpoint_thread_match (struct address_space *,
1154 CORE_ADDR, ptid_t);
1156 extern void until_break_command (char *, int, int);
1158 /* Initialize a struct bp_location. */
1160 extern void init_bp_location (struct bp_location *loc,
1161 const struct bp_location_ops *ops,
1162 struct breakpoint *owner);
1164 extern void update_breakpoint_locations (struct breakpoint *b,
1165 struct symtabs_and_lines sals,
1166 struct symtabs_and_lines sals_end);
1168 extern void breakpoint_re_set (void);
1170 extern void breakpoint_re_set_thread (struct breakpoint *);
1172 extern struct breakpoint *set_momentary_breakpoint
1173 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1175 extern struct breakpoint *set_momentary_breakpoint_at_pc
1176 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1178 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1180 extern void set_ignore_count (int, int, int);
1182 extern void breakpoint_init_inferior (enum inf_context);
1184 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1186 extern void delete_breakpoint (struct breakpoint *);
1188 extern void breakpoint_auto_delete (bpstat);
1190 typedef void (*walk_bp_location_callback) (struct bp_location *, void *);
1192 extern void iterate_over_bp_locations (walk_bp_location_callback);
1194 /* Return the chain of command lines to execute when this breakpoint
1195 is hit. */
1196 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1198 /* Return a string image of DISP. The string is static, and thus should
1199 NOT be deallocated after use. */
1200 const char *bpdisp_text (enum bpdisp disp);
1202 extern void break_command (char *, int);
1204 extern void hbreak_command_wrapper (char *, int);
1205 extern void thbreak_command_wrapper (char *, int);
1206 extern void rbreak_command_wrapper (char *, int);
1207 extern void watch_command_wrapper (char *, int, int);
1208 extern void awatch_command_wrapper (char *, int, int);
1209 extern void rwatch_command_wrapper (char *, int, int);
1210 extern void tbreak_command (char *, int);
1212 extern struct breakpoint_ops base_breakpoint_ops;
1213 extern struct breakpoint_ops bkpt_breakpoint_ops;
1214 extern struct breakpoint_ops tracepoint_breakpoint_ops;
1216 extern void initialize_breakpoint_ops (void);
1218 /* Arguments to pass as context to some catch command handlers. */
1219 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1220 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1222 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1223 lists, and pass some additional user data to the command
1224 function. */
1226 extern void
1227 add_catch_command (char *name, char *docstring,
1228 void (*sfunc) (char *args, int from_tty,
1229 struct cmd_list_element *command),
1230 completer_ftype *completer,
1231 void *user_data_catch,
1232 void *user_data_tcatch);
1234 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1236 extern void
1237 init_ada_exception_breakpoint (struct breakpoint *b,
1238 struct gdbarch *gdbarch,
1239 struct symtab_and_line sal,
1240 char *addr_string,
1241 const struct breakpoint_ops *ops,
1242 int tempflag,
1243 int from_tty);
1245 extern void init_catchpoint (struct breakpoint *b,
1246 struct gdbarch *gdbarch, int tempflag,
1247 char *cond_string,
1248 const struct breakpoint_ops *ops);
1250 /* Add breakpoint B on the breakpoint list, and notify the user, the
1251 target and breakpoint_created observers of its existence. If
1252 INTERNAL is non-zero, the breakpoint number will be allocated from
1253 the internal breakpoint count. If UPDATE_GLL is non-zero,
1254 update_global_location_list will be called. */
1256 extern void install_breakpoint (int internal, struct breakpoint *b,
1257 int update_gll);
1259 /* Flags that can be passed down to create_breakpoint, etc., to affect
1260 breakpoint creation in several ways. */
1262 enum breakpoint_create_flags
1264 /* We're adding a breakpoint to our tables that is already
1265 inserted in the target. */
1266 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1269 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
1270 char *cond_string, int thread,
1271 char *extra_string,
1272 int parse_arg,
1273 int tempflag, enum bptype wanted_type,
1274 int ignore_count,
1275 enum auto_boolean pending_break_support,
1276 const struct breakpoint_ops *ops,
1277 int from_tty,
1278 int enabled,
1279 int internal, unsigned flags);
1281 extern void insert_breakpoints (void);
1283 extern int remove_breakpoints (void);
1285 extern int remove_breakpoints_pid (int pid);
1287 /* This function can be used to physically insert eventpoints from the
1288 specified traced inferior process, without modifying the breakpoint
1289 package's state. This can be useful for those targets which
1290 support following the processes of a fork() or vfork() system call,
1291 when both of the resulting two processes are to be followed. */
1292 extern int reattach_breakpoints (int);
1294 /* This function can be used to update the breakpoint package's state
1295 after an exec() system call has been executed.
1297 This function causes the following:
1299 - All eventpoints are marked "not inserted".
1300 - All eventpoints with a symbolic address are reset such that
1301 the symbolic address must be reevaluated before the eventpoints
1302 can be reinserted.
1303 - The solib breakpoints are explicitly removed from the breakpoint
1304 list.
1305 - A step-resume breakpoint, if any, is explicitly removed from the
1306 breakpoint list.
1307 - All eventpoints without a symbolic address are removed from the
1308 breakpoint list. */
1309 extern void update_breakpoints_after_exec (void);
1311 /* This function can be used to physically remove hardware breakpoints
1312 and watchpoints from the specified traced inferior process, without
1313 modifying the breakpoint package's state. This can be useful for
1314 those targets which support following the processes of a fork() or
1315 vfork() system call, when one of the resulting two processes is to
1316 be detached and allowed to run free.
1318 It is an error to use this function on the process whose id is
1319 inferior_ptid. */
1320 extern int detach_breakpoints (ptid_t ptid);
1322 /* This function is called when program space PSPACE is about to be
1323 deleted. It takes care of updating breakpoints to not reference
1324 this PSPACE anymore. */
1325 extern void breakpoint_program_space_exit (struct program_space *pspace);
1327 extern void set_longjmp_breakpoint (struct thread_info *tp,
1328 struct frame_id frame);
1329 extern void delete_longjmp_breakpoint (int thread);
1331 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1332 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1334 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1335 extern void check_longjmp_breakpoint_for_call_dummy (int thread);
1337 extern void enable_overlay_breakpoints (void);
1338 extern void disable_overlay_breakpoints (void);
1340 extern void set_std_terminate_breakpoint (void);
1341 extern void delete_std_terminate_breakpoint (void);
1343 /* These functions respectively disable or reenable all currently
1344 enabled watchpoints. When disabled, the watchpoints are marked
1345 call_disabled. When re-enabled, they are marked enabled.
1347 The intended client of these functions is call_function_by_hand.
1349 The inferior must be stopped, and all breakpoints removed, when
1350 these functions are used.
1352 The need for these functions is that on some targets (e.g., HP-UX),
1353 gdb is unable to unwind through the dummy frame that is pushed as
1354 part of the implementation of a call command. Watchpoints can
1355 cause the inferior to stop in places where this frame is visible,
1356 and that can cause execution control to become very confused.
1358 Note that if a user sets breakpoints in an interactively called
1359 function, the call_disabled watchpoints will have been re-enabled
1360 when the first such breakpoint is reached. However, on targets
1361 that are unable to unwind through the call dummy frame, watches
1362 of stack-based storage may then be deleted, because gdb will
1363 believe that their watched storage is out of scope. (Sigh.) */
1364 extern void disable_watchpoints_before_interactive_call_start (void);
1366 extern void enable_watchpoints_after_interactive_call_stop (void);
1368 /* These functions disable and re-enable all breakpoints during
1369 inferior startup. They are intended to be called from solib
1370 code where necessary. This is needed on platforms where the
1371 main executable is relocated at some point during startup
1372 processing, making breakpoint addresses invalid.
1374 If additional breakpoints are created after the routine
1375 disable_breakpoints_before_startup but before the routine
1376 enable_breakpoints_after_startup was called, they will also
1377 be marked as disabled. */
1378 extern void disable_breakpoints_before_startup (void);
1379 extern void enable_breakpoints_after_startup (void);
1381 /* For script interpreters that need to define breakpoint commands
1382 after they've already read the commands into a struct
1383 command_line. */
1384 extern enum command_control_type commands_from_control_command
1385 (char *arg, struct command_line *cmd);
1387 extern void clear_breakpoint_hit_counts (void);
1389 extern struct breakpoint *get_breakpoint (int num);
1391 /* The following are for displays, which aren't really breakpoints,
1392 but here is as good a place as any for them. */
1394 extern void disable_current_display (void);
1396 extern void do_displays (void);
1398 extern void disable_display (int);
1400 extern void clear_displays (void);
1402 extern void disable_breakpoint (struct breakpoint *);
1404 extern void enable_breakpoint (struct breakpoint *);
1406 extern void breakpoint_set_commands (struct breakpoint *b,
1407 struct command_line *commands);
1409 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1411 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1413 extern void breakpoint_set_task (struct breakpoint *b, int task);
1415 /* Clear the "inserted" flag in all breakpoints. */
1416 extern void mark_breakpoints_out (void);
1418 extern void make_breakpoint_permanent (struct breakpoint *);
1420 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1421 CORE_ADDR);
1423 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1424 CORE_ADDR);
1426 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1427 CORE_ADDR);
1429 extern void remove_jit_event_breakpoints (void);
1431 extern void remove_solib_event_breakpoints (void);
1433 extern void remove_thread_event_breakpoints (void);
1435 extern void disable_breakpoints_in_shlibs (void);
1437 /* This function returns TRUE if ep is a catchpoint. */
1438 extern int is_catchpoint (struct breakpoint *);
1440 /* Shared helper function (MI and CLI) for creating and installing
1441 a shared object event catchpoint. */
1442 extern void add_solib_catchpoint (char *arg, int is_load, int is_temp,
1443 int enabled);
1445 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1446 deletes all breakpoints. */
1447 extern void delete_command (char *arg, int from_tty);
1449 /* Manage a software single step breakpoint (or two). Insert may be
1450 called twice before remove is called. */
1451 extern void insert_single_step_breakpoint (struct gdbarch *,
1452 struct address_space *,
1453 CORE_ADDR);
1454 extern int single_step_breakpoints_inserted (void);
1455 extern void remove_single_step_breakpoints (void);
1456 extern void cancel_single_step_breakpoints (void);
1458 /* Manage manual breakpoints, separate from the normal chain of
1459 breakpoints. These functions are used in murky target-specific
1460 ways. Please do not add more uses! */
1461 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1462 struct address_space *,
1463 CORE_ADDR);
1464 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1466 /* Check if any hardware watchpoints have triggered, according to the
1467 target. */
1468 int watchpoints_triggered (struct target_waitstatus *);
1470 /* Helper for transparent breakpoint hiding for memory read and write
1471 routines.
1473 Update one of READBUF or WRITEBUF with either the shadows
1474 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1475 breakpoints at the memory range defined by MEMADDR and extending
1476 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1477 on entry.*/
1478 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1479 const gdb_byte *writebuf_org,
1480 ULONGEST memaddr, LONGEST len);
1482 extern int breakpoints_always_inserted_mode (void);
1484 /* Called each time new event from target is processed.
1485 Retires previously deleted breakpoint locations that
1486 in our opinion won't ever trigger. */
1487 extern void breakpoint_retire_moribund (void);
1489 /* Set break condition of breakpoint B to EXP. */
1490 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1491 int from_tty);
1493 /* Checks if we are catching syscalls or not.
1494 Returns 0 if not, greater than 0 if we are. */
1495 extern int catch_syscall_enabled (void);
1497 /* Checks if we are catching syscalls with the specific
1498 syscall_number. Used for "filtering" the catchpoints.
1499 Returns 0 if not, greater than 0 if we are. */
1500 extern int catching_syscall_number (int syscall_number);
1502 /* Return a tracepoint with the given number if found. */
1503 extern struct tracepoint *get_tracepoint (int num);
1505 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1507 /* Find a tracepoint by parsing a number in the supplied string. */
1508 extern struct tracepoint *
1509 get_tracepoint_by_number (char **arg,
1510 struct get_number_or_range_state *state,
1511 int optional_p);
1513 /* Return a vector of all tracepoints currently defined. The vector
1514 is newly allocated; the caller should free when done with it. */
1515 extern VEC(breakpoint_p) *all_tracepoints (void);
1517 extern int is_tracepoint (const struct breakpoint *b);
1519 /* Return a vector of all static tracepoints defined at ADDR. The
1520 vector is newly allocated; the caller should free when done with
1521 it. */
1522 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1524 /* Function that can be passed to read_command_line to validate
1525 that each command is suitable for tracepoint command list. */
1526 extern void check_tracepoint_command (char *line, void *closure);
1528 /* Call at the start and end of an "rbreak" command to register
1529 breakpoint numbers for a later "commands" command. */
1530 extern void start_rbreak_breakpoints (void);
1531 extern void end_rbreak_breakpoints (void);
1533 /* Breakpoint iterator function.
1535 Calls a callback function once for each breakpoint, so long as the
1536 callback function returns false. If the callback function returns
1537 true, the iteration will end and the current breakpoint will be
1538 returned. This can be useful for implementing a search for a
1539 breakpoint with arbitrary attributes, or for applying an operation
1540 to every breakpoint. */
1541 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1542 void *), void *);
1544 /* Nonzero if the specified PC cannot be a location where functions
1545 have been inlined. */
1547 extern int pc_at_non_inline_function (struct address_space *aspace,
1548 CORE_ADDR pc,
1549 const struct target_waitstatus *ws);
1551 extern int user_breakpoint_p (struct breakpoint *);
1553 /* Attempt to determine architecture of location identified by SAL. */
1554 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1556 extern void handle_solib_event (void);
1558 extern void breakpoint_free_objfile (struct objfile *objfile);
1560 extern char *ep_parse_optional_if_clause (char **arg);
1562 #endif /* !defined (BREAKPOINT_H) */