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