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