]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/breakpoint.h
Stop infrun from tracking breakpoint insertion status.
[thirdparty/binutils-gdb.git] / gdb / breakpoint.h
1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2007 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20 #if !defined (BREAKPOINT_H)
21 #define BREAKPOINT_H 1
22
23 #include "frame.h"
24 #include "value.h"
25 #include "vec.h"
26
27 #include "gdb-events.h"
28
29 struct value;
30 struct block;
31
32 /* This is the maximum number of bytes a breakpoint instruction can take.
33 Feel free to increase it. It's just used in a few places to size
34 arrays that should be independent of the target architecture. */
35
36 #define BREAKPOINT_MAX 16
37 \f
38 /* Type of breakpoint. */
39 /* FIXME In the future, we should fold all other breakpoint-like things into
40 here. This includes:
41
42 * single-step (for machines where we have to simulate single stepping)
43 (probably, though perhaps it is better for it to look as much as
44 possible like a single-step to wait_for_inferior). */
45
46 enum bptype
47 {
48 bp_none = 0, /* Eventpoint has been deleted. */
49 bp_breakpoint, /* Normal breakpoint */
50 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
51 bp_until, /* used by until command */
52 bp_finish, /* used by finish command */
53 bp_watchpoint, /* Watchpoint */
54 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
55 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
56 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
57 bp_longjmp, /* secret breakpoint to find longjmp() */
58 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
59
60 /* Used by wait_for_inferior for stepping over subroutine calls, for
61 stepping over signal handlers, and for skipping prologues. */
62 bp_step_resume,
63
64 /* Used to detect when a watchpoint expression has gone out of
65 scope. These breakpoints are usually not visible to the user.
66
67 This breakpoint has some interesting properties:
68
69 1) There's always a 1:1 mapping between watchpoints
70 on local variables and watchpoint_scope breakpoints.
71
72 2) It automatically deletes itself and the watchpoint it's
73 associated with when hit.
74
75 3) It can never be disabled. */
76 bp_watchpoint_scope,
77
78 /* The breakpoint at the end of a call dummy. */
79 /* FIXME: What if the function we are calling longjmp()s out of the
80 call, or the user gets out with the "return" command? We currently
81 have no way of cleaning up the breakpoint in these (obscure) situations.
82 (Probably can solve this by noticing longjmp, "return", etc., it's
83 similar to noticing when a watchpoint on a local variable goes out
84 of scope (with hardware support for watchpoints)). */
85 bp_call_dummy,
86
87 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
88 code in the inferior to run when significant events occur in the
89 dynamic linker (for example a library is loaded or unloaded).
90
91 By placing a breakpoint in this magic code GDB will get control
92 when these significant events occur. GDB can then re-examine
93 the dynamic linker's data structures to discover any newly loaded
94 dynamic libraries. */
95 bp_shlib_event,
96
97 /* Some multi-threaded systems can arrange for a location in the
98 inferior to be executed when certain thread-related events occur
99 (such as thread creation or thread death).
100
101 By placing a breakpoint at one of these locations, GDB will get
102 control when these events occur. GDB can then update its thread
103 lists etc. */
104
105 bp_thread_event,
106
107 /* On the same principal, an overlay manager can arrange to call a
108 magic location in the inferior whenever there is an interesting
109 change in overlay status. GDB can update its overlay tables
110 and fiddle with breakpoints in overlays when this breakpoint
111 is hit. */
112
113 bp_overlay_event,
114
115 /* These breakpoints are used to implement the "catch load" command
116 on platforms whose dynamic linkers support such functionality. */
117 bp_catch_load,
118
119 /* These breakpoints are used to implement the "catch unload" command
120 on platforms whose dynamic linkers support such functionality. */
121 bp_catch_unload,
122
123 /* These are not really breakpoints, but are catchpoints that
124 implement the "catch fork", "catch vfork" and "catch exec" commands
125 on platforms whose kernel support such functionality. (I.e.,
126 kernels which can raise an event when a fork or exec occurs, as
127 opposed to the debugger setting breakpoints on functions named
128 "fork" or "exec".) */
129 bp_catch_fork,
130 bp_catch_vfork,
131 bp_catch_exec,
132
133 /* These are catchpoints to implement "catch catch" and "catch throw"
134 commands for C++ exception handling. */
135 bp_catch_catch,
136 bp_catch_throw
137
138
139 };
140
141 /* States of enablement of breakpoint. */
142
143 enum enable_state
144 {
145 bp_disabled, /* The eventpoint is inactive, and cannot trigger. */
146 bp_enabled, /* The eventpoint is active, and can trigger. */
147 bp_call_disabled, /* The eventpoint has been disabled while a call
148 into the inferior is "in flight", because some
149 eventpoints interfere with the implementation of
150 a call on some targets. The eventpoint will be
151 automatically enabled and reset when the call
152 "lands" (either completes, or stops at another
153 eventpoint). */
154 bp_permanent /* There is a breakpoint instruction hard-wired into
155 the target's code. Don't try to write another
156 breakpoint instruction on top of it, or restore
157 its value. Step over it using the architecture's
158 SKIP_INSN macro. */
159 };
160
161
162 /* Disposition of breakpoint. Ie: what to do after hitting it. */
163
164 enum bpdisp
165 {
166 disp_del, /* Delete it */
167 disp_del_at_next_stop, /* Delete at next stop, whether hit or not */
168 disp_disable, /* Disable it */
169 disp_donttouch /* Leave it alone */
170 };
171
172 enum target_hw_bp_type
173 {
174 hw_write = 0, /* Common HW watchpoint */
175 hw_read = 1, /* Read HW watchpoint */
176 hw_access = 2, /* Access HW watchpoint */
177 hw_execute = 3 /* Execute HW breakpoint */
178 };
179
180
181 /* Information used by targets to insert and remove breakpoints. */
182
183 struct bp_target_info
184 {
185 /* Address at which the breakpoint was placed. This is normally the
186 same as ADDRESS from the bp_location, except when adjustment
187 happens in gdbarch_breakpoint_from_pc. The most common form of
188 adjustment is stripping an alternate ISA marker from the PC which
189 is used to determine the type of breakpoint to insert. */
190 CORE_ADDR placed_address;
191
192 /* If the breakpoint lives in memory and reading that memory would
193 give back the breakpoint, instead of the original contents, then
194 the original contents are cached here. Only SHADOW_LEN bytes of
195 this buffer are valid, and only when the breakpoint is inserted. */
196 gdb_byte shadow_contents[BREAKPOINT_MAX];
197
198 /* The length of the data cached in SHADOW_CONTENTS. */
199 int shadow_len;
200
201 /* The size of the placed breakpoint, according to
202 gdbarch_breakpoint_from_pc, when the breakpoint was inserted. This is
203 generally the same as SHADOW_LEN, unless we did not need
204 to read from the target to implement the memory breakpoint
205 (e.g. if a remote stub handled the details). We may still
206 need the size to remove the breakpoint safely. */
207 int placed_size;
208 };
209
210 /* GDB maintains two types of information about each breakpoint (or
211 watchpoint, or other related event). The first type corresponds
212 to struct breakpoint; this is a relatively high-level structure
213 which contains the source location(s), stopping conditions, user
214 commands to execute when the breakpoint is hit, and so forth.
215
216 The second type of information corresponds to struct bp_location.
217 Each breakpoint has one or (eventually) more locations associated
218 with it, which represent target-specific and machine-specific
219 mechanisms for stopping the program. For instance, a watchpoint
220 expression may require multiple hardware watchpoints in order to
221 catch all changes in the value of the expression being watched. */
222
223 enum bp_loc_type
224 {
225 bp_loc_software_breakpoint,
226 bp_loc_hardware_breakpoint,
227 bp_loc_hardware_watchpoint,
228 bp_loc_other /* Miscellaneous... */
229 };
230
231 struct bp_location
232 {
233 /* Chain pointer to the next breakpoint location for
234 the same parent breakpoint. */
235 struct bp_location *next;
236
237 /* Pointer to the next breakpoint location, in a global
238 list of all breakpoint locations. */
239 struct bp_location *global_next;
240
241 /* Type of this breakpoint location. */
242 enum bp_loc_type loc_type;
243
244 /* Each breakpoint location must belong to exactly one higher-level
245 breakpoint. This and the DUPLICATE flag are more straightforward
246 than reference counting. */
247 struct breakpoint *owner;
248
249 /* Conditional. Break only if this expression's value is nonzero.
250 Unlike string form of condition, which is associated with breakpoint,
251 this is associated with location, since if breakpoint has several
252 locations, the evaluation of expression can be different for
253 different locations. */
254 struct expression *cond;
255
256 /* This location's address is in an unloaded solib, and so this
257 location should not be inserted. It will be automatically
258 enabled when that solib is loaded. */
259 char shlib_disabled;
260
261 /* Is this particular location enabled. */
262 char enabled;
263
264 /* Nonzero if this breakpoint is now inserted. */
265 char inserted;
266
267 /* Nonzero if this is not the first breakpoint in the list
268 for the given address. */
269 char duplicate;
270
271 /* If we someday support real thread-specific breakpoints, then
272 the breakpoint location will need a thread identifier. */
273
274 /* Data for specific breakpoint types. These could be a union, but
275 simplicity is more important than memory usage for breakpoints. */
276
277 /* Note that zero is a perfectly valid code address on some platforms
278 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
279 is not a special value for this field. Valid for all types except
280 bp_loc_other. */
281 CORE_ADDR address;
282
283 /* For any breakpoint type with an address, this is the BFD section
284 associated with the address. Used primarily for overlay debugging. */
285 asection *section;
286
287 /* Address at which breakpoint was requested, either by the user or
288 by GDB for internal breakpoints. This will usually be the same
289 as ``address'' (above) except for cases in which
290 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
291 which to place the breakpoint in order to comply with a
292 processor's architectual constraints. */
293 CORE_ADDR requested_address;
294
295 char *function_name;
296
297 /* Details of the placed breakpoint, when inserted. */
298 struct bp_target_info target_info;
299
300 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
301 struct bp_target_info overlay_target_info;
302 };
303
304 /* This structure is a collection of function pointers that, if available,
305 will be called instead of the performing the default action for this
306 bptype. */
307
308 struct breakpoint_ops
309 {
310 /* The normal print routine for this breakpoint, called when we
311 hit it. */
312 enum print_stop_action (*print_it) (struct breakpoint *);
313
314 /* Display information about this breakpoint, for "info breakpoints". */
315 void (*print_one) (struct breakpoint *, CORE_ADDR *);
316
317 /* Display information about this breakpoint after setting it (roughly
318 speaking; this is called from "mention"). */
319 void (*print_mention) (struct breakpoint *);
320 };
321
322 enum watchpoint_triggered
323 {
324 /* This watchpoint definitely did not trigger. */
325 watch_triggered_no = 0,
326
327 /* Some hardware watchpoint triggered, and it might have been this
328 one, but we do not know which it was. */
329 watch_triggered_unknown,
330
331 /* This hardware watchpoint definitely did trigger. */
332 watch_triggered_yes
333 };
334
335 /* Note that the ->silent field is not currently used by any commands
336 (though the code is in there if it was to be, and set_raw_breakpoint
337 does set it to 0). I implemented it because I thought it would be
338 useful for a hack I had to put in; I'm going to leave it in because
339 I can see how there might be times when it would indeed be useful */
340
341 /* This is for a breakpoint or a watchpoint. */
342
343 struct breakpoint
344 {
345 struct breakpoint *next;
346 /* Type of breakpoint. */
347 enum bptype type;
348 /* Zero means disabled; remember the info but don't break here. */
349 enum enable_state enable_state;
350 /* What to do with this breakpoint after we hit it. */
351 enum bpdisp disposition;
352 /* Number assigned to distinguish breakpoints. */
353 int number;
354
355 /* Location(s) associated with this high-level breakpoint. */
356 struct bp_location *loc;
357
358 /* Line number of this address. */
359
360 int line_number;
361
362 /* Source file name of this address. */
363
364 char *source_file;
365
366 /* Non-zero means a silent breakpoint (don't print frame info
367 if we stop here). */
368 unsigned char silent;
369 /* Number of stops at this breakpoint that should
370 be continued automatically before really stopping. */
371 int ignore_count;
372 /* Chain of command lines to execute when this breakpoint is hit. */
373 struct command_line *commands;
374 /* Stack depth (address of frame). If nonzero, break only if fp
375 equals this. */
376 struct frame_id frame_id;
377
378 /* String we used to set the breakpoint (malloc'd). */
379 char *addr_string;
380 /* Language we used to set the breakpoint. */
381 enum language language;
382 /* Input radix we used to set the breakpoint. */
383 int input_radix;
384 /* String form of the breakpoint condition (malloc'd), or NULL if there
385 is no condition. */
386 char *cond_string;
387 /* String form of exp (malloc'd), or NULL if none. */
388 char *exp_string;
389
390 /* The expression we are watching, or NULL if not a watchpoint. */
391 struct expression *exp;
392 /* The largest block within which it is valid, or NULL if it is
393 valid anywhere (e.g. consists just of global symbols). */
394 struct block *exp_valid_block;
395 /* Value of the watchpoint the last time we checked it. */
396 struct value *val;
397
398 /* Holds the value chain for a hardware watchpoint expression. */
399 struct value *val_chain;
400
401 /* Holds the address of the related watchpoint_scope breakpoint
402 when using watchpoints on local variables (might the concept
403 of a related breakpoint be useful elsewhere, if not just call
404 it the watchpoint_scope breakpoint or something like that. FIXME). */
405 struct breakpoint *related_breakpoint;
406
407 /* Holds the frame address which identifies the frame this
408 watchpoint should be evaluated in, or `null' if the watchpoint
409 should be evaluated on the outermost frame. */
410 struct frame_id watchpoint_frame;
411
412 /* For hardware watchpoints, the triggered status according to the
413 hardware. */
414 enum watchpoint_triggered watchpoint_triggered;
415
416 /* Thread number for thread-specific breakpoint, or -1 if don't care */
417 int thread;
418
419 /* Count of the number of times this breakpoint was taken, dumped
420 with the info, but not used for anything else. Useful for
421 seeing how many times you hit a break prior to the program
422 aborting, so you can back up to just before the abort. */
423 int hit_count;
424
425 /* Filename of a dynamically-linked library (dll), used for
426 bp_catch_load and bp_catch_unload (malloc'd), or NULL if any
427 library is significant. */
428 char *dll_pathname;
429
430 /* Filename of a dll whose state change (e.g., load or unload)
431 triggered this catchpoint. This field is only valid immediately
432 after this catchpoint has triggered. */
433 char *triggered_dll_pathname;
434
435 /* Process id of a child process whose forking triggered this
436 catchpoint. This field is only valid immediately after this
437 catchpoint has triggered. */
438 int forked_inferior_pid;
439
440 /* Filename of a program whose exec triggered this catchpoint.
441 This field is only valid immediately after this catchpoint has
442 triggered. */
443 char *exec_pathname;
444
445 /* Methods associated with this breakpoint. */
446 struct breakpoint_ops *ops;
447
448 /* Is breakpoint's condition not yet parsed because we found
449 no location initially so had no context to parse
450 the condition in. */
451 int condition_not_parsed;
452 };
453
454 typedef struct breakpoint *breakpoint_p;
455 DEF_VEC_P(breakpoint_p);
456 \f
457 /* The following stuff is an abstract data type "bpstat" ("breakpoint
458 status"). This provides the ability to determine whether we have
459 stopped at a breakpoint, and what we should do about it. */
460
461 typedef struct bpstats *bpstat;
462
463 /* Frees any storage that is part of a bpstat.
464 Does not walk the 'next' chain. */
465 extern void bpstat_free (bpstat);
466
467 /* Clears a chain of bpstat, freeing storage
468 of each. */
469 extern void bpstat_clear (bpstat *);
470
471 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
472 is part of the bpstat is copied as well. */
473 extern bpstat bpstat_copy (bpstat);
474
475 extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid);
476 \f
477 /* This bpstat_what stuff tells wait_for_inferior what to do with a
478 breakpoint (a challenging task). */
479
480 enum bpstat_what_main_action
481 {
482 /* Perform various other tests; that is, this bpstat does not
483 say to perform any action (e.g. failed watchpoint and nothing
484 else). */
485 BPSTAT_WHAT_KEEP_CHECKING,
486
487 /* Rather than distinguish between noisy and silent stops here, it
488 might be cleaner to have bpstat_print make that decision (also
489 taking into account stop_print_frame and source_only). But the
490 implications are a bit scary (interaction with auto-displays, etc.),
491 so I won't try it. */
492
493 /* Stop silently. */
494 BPSTAT_WHAT_STOP_SILENT,
495
496 /* Stop and print. */
497 BPSTAT_WHAT_STOP_NOISY,
498
499 /* Remove breakpoints, single step once, then put them back in and
500 go back to what we were doing. It's possible that this should be
501 removed from the main_action and put into a separate field, to more
502 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
503 BPSTAT_WHAT_SINGLE,
504
505 /* Set longjmp_resume breakpoint, remove all other breakpoints,
506 and continue. The "remove all other breakpoints" part is required
507 if we are also stepping over another breakpoint as well as doing
508 the longjmp handling. */
509 BPSTAT_WHAT_SET_LONGJMP_RESUME,
510
511 /* Clear longjmp_resume breakpoint, then handle as
512 BPSTAT_WHAT_KEEP_CHECKING. */
513 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
514
515 /* Clear longjmp_resume breakpoint, then handle as BPSTAT_WHAT_SINGLE. */
516 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE,
517
518 /* Clear step resume breakpoint, and keep checking. */
519 BPSTAT_WHAT_STEP_RESUME,
520
521 /* Check the dynamic linker's data structures for new libraries, then
522 keep checking. */
523 BPSTAT_WHAT_CHECK_SHLIBS,
524
525 /* Check the dynamic linker's data structures for new libraries, then
526 resume out of the dynamic linker's callback, stop and print. */
527 BPSTAT_WHAT_CHECK_SHLIBS_RESUME_FROM_HOOK,
528
529 /* This is just used to keep track of how many enums there are. */
530 BPSTAT_WHAT_LAST
531 };
532
533 struct bpstat_what
534 {
535 enum bpstat_what_main_action main_action;
536
537 /* Did we hit a call dummy breakpoint? This only goes with a main_action
538 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of
539 continuing from a call dummy without popping the frame is not a
540 useful one). */
541 int call_dummy;
542 };
543
544 /* The possible return values for print_bpstat, print_it_normal,
545 print_it_done, print_it_noop. */
546 enum print_stop_action
547 {
548 PRINT_UNKNOWN = -1,
549 PRINT_SRC_AND_LOC,
550 PRINT_SRC_ONLY,
551 PRINT_NOTHING
552 };
553
554 /* Tell what to do about this bpstat. */
555 struct bpstat_what bpstat_what (bpstat);
556 \f
557 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
558 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
559
560 /* Find a step_resume breakpoint associated with this bpstat.
561 (If there are multiple step_resume bp's on the list, this function
562 will arbitrarily pick one.)
563
564 It is an error to use this function if BPSTAT doesn't contain a
565 step_resume breakpoint.
566
567 See wait_for_inferior's use of this function.
568 */
569 extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat);
570
571 /* Nonzero if a signal that we got in wait() was due to circumstances
572 explained by the BS. */
573 /* Currently that is true if we have hit a breakpoint, or if there is
574 a watchpoint enabled. */
575 #define bpstat_explains_signal(bs) ((bs) != NULL)
576
577 /* Nonzero if we should step constantly (e.g. watchpoints on machines
578 without hardware support). This isn't related to a specific bpstat,
579 just to things like whether watchpoints are set. */
580 extern int bpstat_should_step (void);
581
582 /* Nonzero if there are enabled hardware watchpoints. */
583 extern int bpstat_have_active_hw_watchpoints (void);
584
585 /* Print a message indicating what happened. Returns nonzero to
586 say that only the source line should be printed after this (zero
587 return means print the frame as well as the source line). */
588 extern enum print_stop_action bpstat_print (bpstat);
589
590 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped
591 at. *BSP upon return is a bpstat which points to the remaining
592 breakpoints stopped at (but which is not guaranteed to be good for
593 anything but further calls to bpstat_num).
594 Return 0 if passed a bpstat which does not indicate any breakpoints.
595 Return -1 if stopped at a breakpoint that has been deleted since
596 we set it.
597 Return 1 otherwise. */
598 extern int bpstat_num (bpstat *, int *);
599
600 /* Perform actions associated with having stopped at *BSP. Actually, we just
601 use this for breakpoint commands. Perhaps other actions will go here
602 later, but this is executed at a late time (from the command loop). */
603 extern void bpstat_do_actions (bpstat *);
604
605 /* Modify BS so that the actions will not be performed. */
606 extern void bpstat_clear_actions (bpstat);
607
608 /* Given a bpstat that records zero or more triggered eventpoints, this
609 function returns another bpstat which contains only the catchpoints
610 on that first list, if any.
611 */
612 extern void bpstat_get_triggered_catchpoints (bpstat, bpstat *);
613
614 /* Implementation: */
615
616 /* Values used to tell the printing routine how to behave for this bpstat. */
617 enum bp_print_how
618 {
619 /* This is used when we want to do a normal printing of the reason
620 for stopping. The output will depend on the type of eventpoint
621 we are dealing with. This is the default value, most commonly
622 used. */
623 print_it_normal,
624 /* This is used when nothing should be printed for this bpstat entry. */
625 print_it_noop,
626 /* This is used when everything which needs to be printed has
627 already been printed. But we still want to print the frame. */
628 print_it_done
629 };
630
631 struct bpstats
632 {
633 /* Linked list because there can be two breakpoints at the same
634 place, and a bpstat reflects the fact that both have been hit. */
635 bpstat next;
636 /* Breakpoint that we are at. */
637 const struct bp_location *breakpoint_at;
638 /* Commands left to be done. */
639 struct command_line *commands;
640 /* Old value associated with a watchpoint. */
641 struct value *old_val;
642
643 /* Nonzero if this breakpoint tells us to print the frame. */
644 char print;
645
646 /* Nonzero if this breakpoint tells us to stop. */
647 char stop;
648
649 /* Tell bpstat_print and print_bp_stop_message how to print stuff
650 associated with this element of the bpstat chain. */
651 enum bp_print_how print_it;
652 };
653
654 enum inf_context
655 {
656 inf_starting,
657 inf_running,
658 inf_exited
659 };
660
661 /* The possible return values for breakpoint_here_p.
662 We guarantee that zero always means "no breakpoint here". */
663 enum breakpoint_here
664 {
665 no_breakpoint_here = 0,
666 ordinary_breakpoint_here,
667 permanent_breakpoint_here
668 };
669 \f
670
671 /* Prototypes for breakpoint-related functions. */
672
673 extern enum breakpoint_here breakpoint_here_p (CORE_ADDR);
674
675 extern int breakpoint_inserted_here_p (CORE_ADDR);
676
677 extern int regular_breakpoint_inserted_here_p (CORE_ADDR);
678
679 extern int software_breakpoint_inserted_here_p (CORE_ADDR);
680
681 extern int breakpoint_thread_match (CORE_ADDR, ptid_t);
682
683 extern void until_break_command (char *, int, int);
684
685 extern void breakpoint_re_set (void);
686
687 extern void breakpoint_re_set_thread (struct breakpoint *);
688
689 extern int ep_is_exception_catchpoint (struct breakpoint *);
690
691 extern struct breakpoint *set_momentary_breakpoint
692 (struct symtab_and_line, struct frame_id, enum bptype);
693
694 extern void set_ignore_count (int, int, int);
695
696 extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int);
697
698 extern void breakpoint_init_inferior (enum inf_context);
699
700 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
701
702 extern struct cleanup *make_exec_cleanup_delete_breakpoint (struct breakpoint *);
703
704 extern void delete_breakpoint (struct breakpoint *);
705
706 extern void breakpoint_auto_delete (bpstat);
707
708 extern void breakpoint_clear_ignore_counts (void);
709
710 extern void break_command (char *, int);
711
712 extern void hbreak_command_wrapper (char *, int);
713 extern void thbreak_command_wrapper (char *, int);
714 extern void rbreak_command_wrapper (char *, int);
715 extern void watch_command_wrapper (char *, int);
716 extern void awatch_command_wrapper (char *, int);
717 extern void rwatch_command_wrapper (char *, int);
718 extern void tbreak_command (char *, int);
719
720 extern int insert_breakpoints (void);
721
722 extern int remove_breakpoints (void);
723
724 /* This function can be used to physically insert eventpoints from the
725 specified traced inferior process, without modifying the breakpoint
726 package's state. This can be useful for those targets which support
727 following the processes of a fork() or vfork() system call, when both
728 of the resulting two processes are to be followed. */
729 extern int reattach_breakpoints (int);
730
731 /* This function can be used to update the breakpoint package's state
732 after an exec() system call has been executed.
733
734 This function causes the following:
735
736 - All eventpoints are marked "not inserted".
737 - All eventpoints with a symbolic address are reset such that
738 the symbolic address must be reevaluated before the eventpoints
739 can be reinserted.
740 - The solib breakpoints are explicitly removed from the breakpoint
741 list.
742 - A step-resume breakpoint, if any, is explicitly removed from the
743 breakpoint list.
744 - All eventpoints without a symbolic address are removed from the
745 breakpoint list. */
746 extern void update_breakpoints_after_exec (void);
747
748 /* This function can be used to physically remove hardware breakpoints
749 and watchpoints from the specified traced inferior process, without
750 modifying the breakpoint package's state. This can be useful for
751 those targets which support following the processes of a fork() or
752 vfork() system call, when one of the resulting two processes is to
753 be detached and allowed to run free.
754
755 It is an error to use this function on the process whose id is
756 inferior_ptid. */
757 extern int detach_breakpoints (int);
758
759 extern void enable_longjmp_breakpoint (void);
760 extern void disable_longjmp_breakpoint (void);
761 extern void enable_overlay_breakpoints (void);
762 extern void disable_overlay_breakpoints (void);
763
764 extern void set_longjmp_resume_breakpoint (CORE_ADDR, struct frame_id);
765 /* These functions respectively disable or reenable all currently
766 enabled watchpoints. When disabled, the watchpoints are marked
767 call_disabled. When reenabled, they are marked enabled.
768
769 The intended client of these functions is call_function_by_hand.
770
771 The inferior must be stopped, and all breakpoints removed, when
772 these functions are used.
773
774 The need for these functions is that on some targets (e.g., HP-UX),
775 gdb is unable to unwind through the dummy frame that is pushed as
776 part of the implementation of a call command. Watchpoints can
777 cause the inferior to stop in places where this frame is visible,
778 and that can cause execution control to become very confused.
779
780 Note that if a user sets breakpoints in an interactively called
781 function, the call_disabled watchpoints will have been reenabled
782 when the first such breakpoint is reached. However, on targets
783 that are unable to unwind through the call dummy frame, watches
784 of stack-based storage may then be deleted, because gdb will
785 believe that their watched storage is out of scope. (Sigh.) */
786 extern void disable_watchpoints_before_interactive_call_start (void);
787
788 extern void enable_watchpoints_after_interactive_call_stop (void);
789
790 /* For script interpreters that need to define breakpoint commands
791 after they've already read the commands into a struct command_line. */
792 extern enum command_control_type commands_from_control_command
793 (char *arg, struct command_line *cmd);
794
795 extern void clear_breakpoint_hit_counts (void);
796
797 extern int get_number (char **);
798
799 extern int get_number_or_range (char **);
800
801 /* The following are for displays, which aren't really breakpoints, but
802 here is as good a place as any for them. */
803
804 extern void disable_current_display (void);
805
806 extern void do_displays (void);
807
808 extern void disable_display (int);
809
810 extern void clear_displays (void);
811
812 extern void disable_breakpoint (struct breakpoint *);
813
814 extern void enable_breakpoint (struct breakpoint *);
815
816 extern void make_breakpoint_permanent (struct breakpoint *);
817
818 extern struct breakpoint *create_solib_event_breakpoint (CORE_ADDR);
819
820 extern struct breakpoint *create_thread_event_breakpoint (CORE_ADDR);
821
822 extern void remove_solib_event_breakpoints (void);
823
824 extern void remove_thread_event_breakpoints (void);
825
826 extern void disable_breakpoints_in_shlibs (void);
827
828 /* This function returns TRUE if ep is a catchpoint. */
829 extern int ep_is_catchpoint (struct breakpoint *);
830
831 /* This function returns TRUE if ep is a catchpoint of a
832 shared library (aka dynamically-linked library) event,
833 such as a library load or unload. */
834 extern int ep_is_shlib_catchpoint (struct breakpoint *);
835
836 /* Enable breakpoints and delete when hit. Called with ARG == NULL
837 deletes all breakpoints. */
838 extern void delete_command (char *arg, int from_tty);
839
840 /* Pull all H/W watchpoints from the target. Return non-zero if the
841 remove fails. */
842 extern int remove_hw_watchpoints (void);
843
844 /* Manage a software single step breakpoint (or two). Insert may be called
845 twice before remove is called. */
846 extern void insert_single_step_breakpoint (CORE_ADDR);
847 extern void remove_single_step_breakpoints (void);
848
849 /* Manage manual breakpoints, separate from the normal chain of
850 breakpoints. These functions are used in murky target-specific
851 ways. Please do not add more uses! */
852 extern void *deprecated_insert_raw_breakpoint (CORE_ADDR);
853 extern int deprecated_remove_raw_breakpoint (void *);
854
855 /* Check if any hardware watchpoints have triggered, according to the
856 target. */
857 int watchpoints_triggered (struct target_waitstatus *);
858
859 #endif /* !defined (BREAKPOINT_H) */