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