* gdb.texinfo (Target Commands): Fix typo.
[deliverable/binutils-gdb.git] / gdb / breakpoint.h
1 /* Data structures associated with breakpoints in GDB.
2 Copyright (C) 1992-2013 Free Software Foundation, Inc.
3
4 This file is part of GDB.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
10
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
18
19 #if !defined (BREAKPOINT_H)
20 #define BREAKPOINT_H 1
21
22 #include "frame.h"
23 #include "value.h"
24 #include "vec.h"
25 #include "ax.h"
26 #include "command.h"
27
28 struct value;
29 struct block;
30 struct breakpoint_object;
31 struct get_number_or_range_state;
32 struct thread_info;
33 struct bpstats;
34 struct bp_location;
35 struct linespec_result;
36 struct linespec_sals;
37
38 /* This is the maximum number of bytes a breakpoint instruction can
39 take. Feel free to increase it. It's just used in a few places to
40 size arrays that should be independent of the target
41 architecture. */
42
43 #define BREAKPOINT_MAX 16
44 \f
45
46 /* Type of breakpoint. */
47 /* FIXME In the future, we should fold all other breakpoint-like
48 things into here. This includes:
49
50 * single-step (for machines where we have to simulate single
51 stepping) (probably, though perhaps it is better for it to look as
52 much as possible like a single-step to wait_for_inferior). */
53
54 enum bptype
55 {
56 bp_none = 0, /* Eventpoint has been deleted */
57 bp_breakpoint, /* Normal breakpoint */
58 bp_hardware_breakpoint, /* Hardware assisted breakpoint */
59 bp_until, /* used by until command */
60 bp_finish, /* used by finish command */
61 bp_watchpoint, /* Watchpoint */
62 bp_hardware_watchpoint, /* Hardware assisted watchpoint */
63 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */
64 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */
65 bp_longjmp, /* secret breakpoint to find longjmp() */
66 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */
67
68 /* Breakpoint placed to the same location(s) like bp_longjmp but used to
69 protect against stale DUMMY_FRAME. Multiple bp_longjmp_call_dummy and
70 one bp_call_dummy are chained together by related_breakpoint for each
71 DUMMY_FRAME. */
72 bp_longjmp_call_dummy,
73
74 /* An internal breakpoint that is installed on the unwinder's
75 debug hook. */
76 bp_exception,
77 /* An internal breakpoint that is set at the point where an
78 exception will land. */
79 bp_exception_resume,
80
81 /* Used by wait_for_inferior for stepping over subroutine calls,
82 and for skipping prologues. */
83 bp_step_resume,
84
85 /* Used by wait_for_inferior for stepping over signal
86 handlers. */
87 bp_hp_step_resume,
88
89 /* Used to detect when a watchpoint expression has gone out of
90 scope. These breakpoints are usually not visible to the user.
91
92 This breakpoint has some interesting properties:
93
94 1) There's always a 1:1 mapping between watchpoints
95 on local variables and watchpoint_scope breakpoints.
96
97 2) It automatically deletes itself and the watchpoint it's
98 associated with when hit.
99
100 3) It can never be disabled. */
101 bp_watchpoint_scope,
102
103 /* The breakpoint at the end of a call dummy. See bp_longjmp_call_dummy it
104 is chained with by related_breakpoint. */
105 bp_call_dummy,
106
107 /* A breakpoint set on std::terminate, that is used to catch
108 otherwise uncaught exceptions thrown during an inferior call. */
109 bp_std_terminate,
110
111 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special
112 code in the inferior to run when significant events occur in the
113 dynamic linker (for example a library is loaded or unloaded).
114
115 By placing a breakpoint in this magic code GDB will get control
116 when these significant events occur. GDB can then re-examine
117 the dynamic linker's data structures to discover any newly loaded
118 dynamic libraries. */
119 bp_shlib_event,
120
121 /* Some multi-threaded systems can arrange for a location in the
122 inferior to be executed when certain thread-related events occur
123 (such as thread creation or thread death).
124
125 By placing a breakpoint at one of these locations, GDB will get
126 control when these events occur. GDB can then update its thread
127 lists etc. */
128
129 bp_thread_event,
130
131 /* On the same principal, an overlay manager can arrange to call a
132 magic location in the inferior whenever there is an interesting
133 change in overlay status. GDB can update its overlay tables
134 and fiddle with breakpoints in overlays when this breakpoint
135 is hit. */
136
137 bp_overlay_event,
138
139 /* Master copies of longjmp breakpoints. These are always installed
140 as soon as an objfile containing longjmp is loaded, but they are
141 always disabled. While necessary, temporary clones of bp_longjmp
142 type will be created and enabled. */
143
144 bp_longjmp_master,
145
146 /* Master copies of std::terminate breakpoints. */
147 bp_std_terminate_master,
148
149 /* Like bp_longjmp_master, but for exceptions. */
150 bp_exception_master,
151
152 bp_catchpoint,
153
154 bp_tracepoint,
155 bp_fast_tracepoint,
156 bp_static_tracepoint,
157
158 /* A dynamic printf stops at the given location, does a formatted
159 print, then automatically continues. (Although this is sort of
160 like a macro packaging up standard breakpoint functionality,
161 GDB doesn't have a way to construct types of breakpoint from
162 elements of behavior.) */
163 bp_dprintf,
164
165 /* Event for JIT compiled code generation or deletion. */
166 bp_jit_event,
167
168 /* Breakpoint is placed at the STT_GNU_IFUNC resolver. When hit GDB
169 inserts new bp_gnu_ifunc_resolver_return at the caller.
170 bp_gnu_ifunc_resolver is still being kept here as a different thread
171 may still hit it before bp_gnu_ifunc_resolver_return is hit by the
172 original thread. */
173 bp_gnu_ifunc_resolver,
174
175 /* On its hit GDB now know the resolved address of the target
176 STT_GNU_IFUNC function. Associated bp_gnu_ifunc_resolver can be
177 deleted now and the breakpoint moved to the target function entry
178 point. */
179 bp_gnu_ifunc_resolver_return,
180 };
181
182 /* States of enablement of breakpoint. */
183
184 enum enable_state
185 {
186 bp_disabled, /* The eventpoint is inactive, and cannot
187 trigger. */
188 bp_enabled, /* The eventpoint is active, and can
189 trigger. */
190 bp_call_disabled, /* The eventpoint has been disabled while a
191 call into the inferior is "in flight",
192 because some eventpoints interfere with
193 the implementation of a call on some
194 targets. The eventpoint will be
195 automatically enabled and reset when the
196 call "lands" (either completes, or stops
197 at another eventpoint). */
198 bp_permanent /* There is a breakpoint instruction
199 hard-wired into the target's code. Don't
200 try to write another breakpoint
201 instruction on top of it, or restore its
202 value. Step over it using the
203 architecture's SKIP_INSN macro. */
204 };
205
206
207 /* Disposition of breakpoint. Ie: what to do after hitting it. */
208
209 enum bpdisp
210 {
211 disp_del, /* Delete it */
212 disp_del_at_next_stop, /* Delete at next stop,
213 whether hit or not */
214 disp_disable, /* Disable it */
215 disp_donttouch /* Leave it alone */
216 };
217
218 enum target_hw_bp_type
219 {
220 hw_write = 0, /* Common HW watchpoint */
221 hw_read = 1, /* Read HW watchpoint */
222 hw_access = 2, /* Access HW watchpoint */
223 hw_execute = 3 /* Execute HW breakpoint */
224 };
225
226
227 /* Status of breakpoint conditions used when synchronizing
228 conditions with the target. */
229
230 enum condition_status
231 {
232 condition_unchanged = 0,
233 condition_modified,
234 condition_updated
235 };
236
237 /* Information used by targets to insert and remove breakpoints. */
238
239 struct bp_target_info
240 {
241 /* Address space at which the breakpoint was placed. */
242 struct address_space *placed_address_space;
243
244 /* Address at which the breakpoint was placed. This is normally the
245 same as ADDRESS from the bp_location, except when adjustment
246 happens in gdbarch_breakpoint_from_pc. The most common form of
247 adjustment is stripping an alternate ISA marker from the PC which
248 is used to determine the type of breakpoint to insert. */
249 CORE_ADDR placed_address;
250
251 /* If this is a ranged breakpoint, then this field contains the
252 length of the range that will be watched for execution. */
253 int length;
254
255 /* If the breakpoint lives in memory and reading that memory would
256 give back the breakpoint, instead of the original contents, then
257 the original contents are cached here. Only SHADOW_LEN bytes of
258 this buffer are valid, and only when the breakpoint is inserted. */
259 gdb_byte shadow_contents[BREAKPOINT_MAX];
260
261 /* The length of the data cached in SHADOW_CONTENTS. */
262 int shadow_len;
263
264 /* The size of the placed breakpoint, according to
265 gdbarch_breakpoint_from_pc, when the breakpoint was inserted.
266 This is generally the same as SHADOW_LEN, unless we did not need
267 to read from the target to implement the memory breakpoint
268 (e.g. if a remote stub handled the details). We may still need
269 the size to remove the breakpoint safely. */
270 int placed_size;
271
272 /* Vector of conditions the target should evaluate if it supports target-side
273 breakpoint conditions. */
274 VEC(agent_expr_p) *conditions;
275
276 /* Vector of commands the target should evaluate if it supports
277 target-side breakpoint commands. */
278 VEC(agent_expr_p) *tcommands;
279
280 /* Flag that is true if the breakpoint should be left in place even
281 when GDB is not connected. */
282 int persist;
283 };
284
285 /* GDB maintains two types of information about each breakpoint (or
286 watchpoint, or other related event). The first type corresponds
287 to struct breakpoint; this is a relatively high-level structure
288 which contains the source location(s), stopping conditions, user
289 commands to execute when the breakpoint is hit, and so forth.
290
291 The second type of information corresponds to struct bp_location.
292 Each breakpoint has one or (eventually) more locations associated
293 with it, which represent target-specific and machine-specific
294 mechanisms for stopping the program. For instance, a watchpoint
295 expression may require multiple hardware watchpoints in order to
296 catch all changes in the value of the expression being watched. */
297
298 enum bp_loc_type
299 {
300 bp_loc_software_breakpoint,
301 bp_loc_hardware_breakpoint,
302 bp_loc_hardware_watchpoint,
303 bp_loc_other /* Miscellaneous... */
304 };
305
306 /* This structure is a collection of function pointers that, if
307 available, will be called instead of performing the default action
308 for this bp_loc_type. */
309
310 struct bp_location_ops
311 {
312 /* Destructor. Releases everything from SELF (but not SELF
313 itself). */
314 void (*dtor) (struct bp_location *self);
315 };
316
317 struct bp_location
318 {
319 /* Chain pointer to the next breakpoint location for
320 the same parent breakpoint. */
321 struct bp_location *next;
322
323 /* Methods associated with this location. */
324 const struct bp_location_ops *ops;
325
326 /* The reference count. */
327 int refc;
328
329 /* Type of this breakpoint location. */
330 enum bp_loc_type loc_type;
331
332 /* Each breakpoint location must belong to exactly one higher-level
333 breakpoint. This pointer is NULL iff this bp_location is no
334 longer attached to a breakpoint. For example, when a breakpoint
335 is deleted, its locations may still be found in the
336 moribund_locations list, or if we had stopped for it, in
337 bpstats. */
338 struct breakpoint *owner;
339
340 /* Conditional. Break only if this expression's value is nonzero.
341 Unlike string form of condition, which is associated with
342 breakpoint, this is associated with location, since if breakpoint
343 has several locations, the evaluation of expression can be
344 different for different locations. Only valid for real
345 breakpoints; a watchpoint's conditional expression is stored in
346 the owner breakpoint object. */
347 struct expression *cond;
348
349 /* Conditional expression in agent expression
350 bytecode form. This is used for stub-side breakpoint
351 condition evaluation. */
352 struct agent_expr *cond_bytecode;
353
354 /* Signals that the condition has changed since the last time
355 we updated the global location list. This means the condition
356 needs to be sent to the target again. This is used together
357 with target-side breakpoint conditions.
358
359 condition_unchanged: It means there has been no condition changes.
360
361 condition_modified: It means this location had its condition modified.
362
363 condition_updated: It means we already marked all the locations that are
364 duplicates of this location and thus we don't need to call
365 force_breakpoint_reinsertion (...) for this location. */
366
367 enum condition_status condition_changed;
368
369 struct agent_expr *cmd_bytecode;
370
371 /* Signals that breakpoint conditions and/or commands need to be
372 re-synched with the target. This has no use other than
373 target-side breakpoints. */
374 char needs_update;
375
376 /* This location's address is in an unloaded solib, and so this
377 location should not be inserted. It will be automatically
378 enabled when that solib is loaded. */
379 char shlib_disabled;
380
381 /* Is this particular location enabled. */
382 char enabled;
383
384 /* Nonzero if this breakpoint is now inserted. */
385 char inserted;
386
387 /* Nonzero if this is not the first breakpoint in the list
388 for the given address. location of tracepoint can _never_
389 be duplicated with other locations of tracepoints and other
390 kinds of breakpoints, because two locations at the same
391 address may have different actions, so both of these locations
392 should be downloaded and so that `tfind N' always works. */
393 char duplicate;
394
395 /* If we someday support real thread-specific breakpoints, then
396 the breakpoint location will need a thread identifier. */
397
398 /* Data for specific breakpoint types. These could be a union, but
399 simplicity is more important than memory usage for breakpoints. */
400
401 /* Architecture associated with this location's address. May be
402 different from the breakpoint architecture. */
403 struct gdbarch *gdbarch;
404
405 /* The program space associated with this breakpoint location
406 address. Note that an address space may be represented in more
407 than one program space (e.g. each uClinux program will be given
408 its own program space, but there will only be one address space
409 for all of them), but we must not insert more than one location
410 at the same address in the same address space. */
411 struct program_space *pspace;
412
413 /* Note that zero is a perfectly valid code address on some platforms
414 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL
415 is not a special value for this field. Valid for all types except
416 bp_loc_other. */
417 CORE_ADDR address;
418
419 /* For hardware watchpoints, the size of the memory region being
420 watched. For hardware ranged breakpoints, the size of the
421 breakpoint range. */
422 int length;
423
424 /* Type of hardware watchpoint. */
425 enum target_hw_bp_type watchpoint_type;
426
427 /* For any breakpoint type with an address, this is the section
428 associated with the address. Used primarily for overlay
429 debugging. */
430 struct obj_section *section;
431
432 /* Address at which breakpoint was requested, either by the user or
433 by GDB for internal breakpoints. This will usually be the same
434 as ``address'' (above) except for cases in which
435 ADJUST_BREAKPOINT_ADDRESS has computed a different address at
436 which to place the breakpoint in order to comply with a
437 processor's architectual constraints. */
438 CORE_ADDR requested_address;
439
440 /* An additional address assigned with this location. This is currently
441 only used by STT_GNU_IFUNC resolver breakpoints to hold the address
442 of the resolver function. */
443 CORE_ADDR related_address;
444
445 /* If the location comes from a probe point, this is the probe associated
446 with it. */
447 struct probe *probe;
448
449 char *function_name;
450
451 /* Details of the placed breakpoint, when inserted. */
452 struct bp_target_info target_info;
453
454 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */
455 struct bp_target_info overlay_target_info;
456
457 /* In a non-stop mode, it's possible that we delete a breakpoint,
458 but as we do that, some still running thread hits that breakpoint.
459 For that reason, we need to keep locations belonging to deleted
460 breakpoints for a bit, so that don't report unexpected SIGTRAP.
461 We can't keep such locations forever, so we use a heuristic --
462 after we process certain number of inferior events since
463 breakpoint was deleted, we retire all locations of that breakpoint.
464 This variable keeps a number of events still to go, when
465 it becomes 0 this location is retired. */
466 int events_till_retirement;
467
468 /* Line number of this address. */
469
470 int line_number;
471
472 /* Source file name of this address. */
473
474 char *source_file;
475 };
476
477 /* Return values for bpstat_explains_signal. Note that the order of
478 the constants is important here; they are compared directly in
479 bpstat_explains_signal. */
480
481 enum bpstat_signal_value
482 {
483 /* bpstat does not explain this signal. */
484 BPSTAT_SIGNAL_NO = 0,
485
486 /* bpstat explains this signal; signal should not be delivered. */
487 BPSTAT_SIGNAL_HIDE,
488
489 /* bpstat explains this signal; signal should be delivered. */
490 BPSTAT_SIGNAL_PASS
491 };
492
493 /* This structure is a collection of function pointers that, if available,
494 will be called instead of the performing the default action for this
495 bptype. */
496
497 struct breakpoint_ops
498 {
499 /* Destructor. Releases everything from SELF (but not SELF
500 itself). */
501 void (*dtor) (struct breakpoint *self);
502
503 /* Allocate a location for this breakpoint. */
504 struct bp_location * (*allocate_location) (struct breakpoint *);
505
506 /* Reevaluate a breakpoint. This is necessary after symbols change
507 (e.g., an executable or DSO was loaded, or the inferior just
508 started). */
509 void (*re_set) (struct breakpoint *self);
510
511 /* Insert the breakpoint or watchpoint or activate the catchpoint.
512 Return 0 for success, 1 if the breakpoint, watchpoint or
513 catchpoint type is not supported, -1 for failure. */
514 int (*insert_location) (struct bp_location *);
515
516 /* Remove the breakpoint/catchpoint that was previously inserted
517 with the "insert" method above. Return 0 for success, 1 if the
518 breakpoint, watchpoint or catchpoint type is not supported,
519 -1 for failure. */
520 int (*remove_location) (struct bp_location *);
521
522 /* Return true if it the target has stopped due to hitting
523 breakpoint location BL. This function does not check if we
524 should stop, only if BL explains the stop. ASPACE is the address
525 space in which the event occurred, BP_ADDR is the address at
526 which the inferior stopped, and WS is the target_waitstatus
527 describing the event. */
528 int (*breakpoint_hit) (const struct bp_location *bl,
529 struct address_space *aspace,
530 CORE_ADDR bp_addr,
531 const struct target_waitstatus *ws);
532
533 /* Check internal conditions of the breakpoint referred to by BS.
534 If we should not stop for this breakpoint, set BS->stop to 0. */
535 void (*check_status) (struct bpstats *bs);
536
537 /* Tell how many hardware resources (debug registers) are needed
538 for this breakpoint. If this function is not provided, then
539 the breakpoint or watchpoint needs one debug register. */
540 int (*resources_needed) (const struct bp_location *);
541
542 /* Tell whether we can downgrade from a hardware watchpoint to a software
543 one. If not, the user will not be able to enable the watchpoint when
544 there are not enough hardware resources available. */
545 int (*works_in_software_mode) (const struct breakpoint *);
546
547 /* The normal print routine for this breakpoint, called when we
548 hit it. */
549 enum print_stop_action (*print_it) (struct bpstats *bs);
550
551 /* Display information about this breakpoint, for "info
552 breakpoints". */
553 void (*print_one) (struct breakpoint *, struct bp_location **);
554
555 /* Display extra information about this breakpoint, below the normal
556 breakpoint description in "info breakpoints".
557
558 In the example below, the "address range" line was printed
559 by print_one_detail_ranged_breakpoint.
560
561 (gdb) info breakpoints
562 Num Type Disp Enb Address What
563 2 hw breakpoint keep y in main at test-watch.c:70
564 address range: [0x10000458, 0x100004c7]
565
566 */
567 void (*print_one_detail) (const struct breakpoint *, struct ui_out *);
568
569 /* Display information about this breakpoint after setting it
570 (roughly speaking; this is called from "mention"). */
571 void (*print_mention) (struct breakpoint *);
572
573 /* Print to FP the CLI command that recreates this breakpoint. */
574 void (*print_recreate) (struct breakpoint *, struct ui_file *fp);
575
576 /* Create SALs from address string, storing the result in linespec_result.
577
578 For an explanation about the arguments, see the function
579 `create_sals_from_address_default'.
580
581 This function is called inside `create_breakpoint'. */
582 void (*create_sals_from_address) (char **, struct linespec_result *,
583 enum bptype, char *, char **);
584
585 /* This method will be responsible for creating a breakpoint given its SALs.
586 Usually, it just calls `create_breakpoints_sal' (for ordinary
587 breakpoints). However, there may be some special cases where we might
588 need to do some tweaks, e.g., see
589 `strace_marker_create_breakpoints_sal'.
590
591 This function is called inside `create_breakpoint'. */
592 void (*create_breakpoints_sal) (struct gdbarch *,
593 struct linespec_result *,
594 struct linespec_sals *, char *,
595 char *,
596 enum bptype, enum bpdisp, int, int,
597 int, const struct breakpoint_ops *,
598 int, int, int, unsigned);
599
600 /* Given the address string (second parameter), this method decodes it
601 and provides the SAL locations related to it. For ordinary breakpoints,
602 it calls `decode_line_full'.
603
604 This function is called inside `addr_string_to_sals'. */
605 void (*decode_linespec) (struct breakpoint *, char **,
606 struct symtabs_and_lines *);
607
608 /* Return true if this breakpoint explains a signal, but the signal
609 should still be delivered to the inferior. This is used to make
610 'catch signal' interact properly with 'handle'; see
611 bpstat_explains_signal. */
612 enum bpstat_signal_value (*explains_signal) (struct breakpoint *);
613 };
614
615 /* Helper for breakpoint_ops->print_recreate implementations. Prints
616 the "thread" or "task" condition of B, and then a newline.
617
618 Necessary because most breakpoint implementations accept
619 thread/task conditions at the end of the spec line, like "break foo
620 thread 1", which needs outputting before any breakpoint-type
621 specific extra command necessary for B's recreation. */
622 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp);
623
624 enum watchpoint_triggered
625 {
626 /* This watchpoint definitely did not trigger. */
627 watch_triggered_no = 0,
628
629 /* Some hardware watchpoint triggered, and it might have been this
630 one, but we do not know which it was. */
631 watch_triggered_unknown,
632
633 /* This hardware watchpoint definitely did trigger. */
634 watch_triggered_yes
635 };
636
637 typedef struct bp_location *bp_location_p;
638 DEF_VEC_P(bp_location_p);
639
640 /* A reference-counted struct command_line. This lets multiple
641 breakpoints share a single command list. This is an implementation
642 detail to the breakpoints module. */
643 struct counted_command_line;
644
645 /* Some targets (e.g., embedded PowerPC) need two debug registers to set
646 a watchpoint over a memory region. If this flag is true, GDB will use
647 only one register per watchpoint, thus assuming that all acesses that
648 modify a memory location happen at its starting address. */
649
650 extern int target_exact_watchpoints;
651
652 /* Note that the ->silent field is not currently used by any commands
653 (though the code is in there if it was to be, and set_raw_breakpoint
654 does set it to 0). I implemented it because I thought it would be
655 useful for a hack I had to put in; I'm going to leave it in because
656 I can see how there might be times when it would indeed be useful */
657
658 /* This is for all kinds of breakpoints. */
659
660 struct breakpoint
661 {
662 /* Methods associated with this breakpoint. */
663 const struct breakpoint_ops *ops;
664
665 struct breakpoint *next;
666 /* Type of breakpoint. */
667 enum bptype type;
668 /* Zero means disabled; remember the info but don't break here. */
669 enum enable_state enable_state;
670 /* What to do with this breakpoint after we hit it. */
671 enum bpdisp disposition;
672 /* Number assigned to distinguish breakpoints. */
673 int number;
674
675 /* Location(s) associated with this high-level breakpoint. */
676 struct bp_location *loc;
677
678 /* Non-zero means a silent breakpoint (don't print frame info
679 if we stop here). */
680 unsigned char silent;
681 /* Non-zero means display ADDR_STRING to the user verbatim. */
682 unsigned char display_canonical;
683 /* Number of stops at this breakpoint that should
684 be continued automatically before really stopping. */
685 int ignore_count;
686
687 /* Number of stops at this breakpoint before it will be
688 disabled. */
689 int enable_count;
690
691 /* Chain of command lines to execute when this breakpoint is
692 hit. */
693 struct counted_command_line *commands;
694 /* Stack depth (address of frame). If nonzero, break only if fp
695 equals this. */
696 struct frame_id frame_id;
697
698 /* The program space used to set the breakpoint. This is only set
699 for breakpoints which are specific to a program space; for
700 non-thread-specific ordinary breakpoints this is NULL. */
701 struct program_space *pspace;
702
703 /* String we used to set the breakpoint (malloc'd). */
704 char *addr_string;
705
706 /* The filter that should be passed to decode_line_full when
707 re-setting this breakpoint. This may be NULL, but otherwise is
708 allocated with xmalloc. */
709 char *filter;
710
711 /* For a ranged breakpoint, the string we used to find
712 the end of the range (malloc'd). */
713 char *addr_string_range_end;
714
715 /* Architecture we used to set the breakpoint. */
716 struct gdbarch *gdbarch;
717 /* Language we used to set the breakpoint. */
718 enum language language;
719 /* Input radix we used to set the breakpoint. */
720 int input_radix;
721 /* String form of the breakpoint condition (malloc'd), or NULL if
722 there is no condition. */
723 char *cond_string;
724
725 /* String form of extra parameters, or NULL if there are none. */
726 char *extra_string;
727
728 /* Holds the address of the related watchpoint_scope breakpoint
729 when using watchpoints on local variables (might the concept of
730 a related breakpoint be useful elsewhere, if not just call it
731 the watchpoint_scope breakpoint or something like that.
732 FIXME). */
733 struct breakpoint *related_breakpoint;
734
735 /* Thread number for thread-specific breakpoint,
736 or -1 if don't care. */
737 int thread;
738
739 /* Ada task number for task-specific breakpoint,
740 or 0 if don't care. */
741 int task;
742
743 /* Count of the number of times this breakpoint was taken, dumped
744 with the info, but not used for anything else. Useful for
745 seeing how many times you hit a break prior to the program
746 aborting, so you can back up to just before the abort. */
747 int hit_count;
748
749 /* Is breakpoint's condition not yet parsed because we found
750 no location initially so had no context to parse
751 the condition in. */
752 int condition_not_parsed;
753
754 /* With a Python scripting enabled GDB, store a reference to the
755 Python object that has been associated with this breakpoint.
756 This is always NULL for a GDB that is not script enabled. It
757 can sometimes be NULL for enabled GDBs as not all breakpoint
758 types are tracked by the Python scripting API. */
759 struct breakpoint_object *py_bp_object;
760 };
761
762 /* An instance of this type is used to represent a watchpoint. It
763 includes a "struct breakpoint" as a kind of base class; users
764 downcast to "struct breakpoint *" when needed. */
765
766 struct watchpoint
767 {
768 /* The base class. */
769 struct breakpoint base;
770
771 /* String form of exp to use for displaying to the user (malloc'd),
772 or NULL if none. */
773 char *exp_string;
774 /* String form to use for reparsing of EXP (malloc'd) or NULL. */
775 char *exp_string_reparse;
776
777 /* The expression we are watching, or NULL if not a watchpoint. */
778 struct expression *exp;
779 /* The largest block within which it is valid, or NULL if it is
780 valid anywhere (e.g. consists just of global symbols). */
781 const struct block *exp_valid_block;
782 /* The conditional expression if any. */
783 struct expression *cond_exp;
784 /* The largest block within which it is valid, or NULL if it is
785 valid anywhere (e.g. consists just of global symbols). */
786 const struct block *cond_exp_valid_block;
787 /* Value of the watchpoint the last time we checked it, or NULL when
788 we do not know the value yet or the value was not readable. VAL
789 is never lazy. */
790 struct value *val;
791 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL,
792 then an error occurred reading the value. */
793 int val_valid;
794
795 /* Holds the frame address which identifies the frame this
796 watchpoint should be evaluated in, or `null' if the watchpoint
797 should be evaluated on the outermost frame. */
798 struct frame_id watchpoint_frame;
799
800 /* Holds the thread which identifies the frame this watchpoint
801 should be considered in scope for, or `null_ptid' if the
802 watchpoint should be evaluated in all threads. */
803 ptid_t watchpoint_thread;
804
805 /* For hardware watchpoints, the triggered status according to the
806 hardware. */
807 enum watchpoint_triggered watchpoint_triggered;
808
809 /* Whether this watchpoint is exact (see
810 target_exact_watchpoints). */
811 int exact;
812
813 /* The mask address for a masked hardware watchpoint. */
814 CORE_ADDR hw_wp_mask;
815 };
816
817 /* Return true if BPT is either a software breakpoint or a hardware
818 breakpoint. */
819
820 extern int is_breakpoint (const struct breakpoint *bpt);
821
822 /* Returns true if BPT is really a watchpoint. */
823
824 extern int is_watchpoint (const struct breakpoint *bpt);
825
826 /* An instance of this type is used to represent all kinds of
827 tracepoints. It includes a "struct breakpoint" as a kind of base
828 class; users downcast to "struct breakpoint *" when needed. */
829
830 struct tracepoint
831 {
832 /* The base class. */
833 struct breakpoint base;
834
835 /* Number of times this tracepoint should single-step and collect
836 additional data. */
837 long step_count;
838
839 /* Number of times this tracepoint should be hit before
840 disabling/ending. */
841 int pass_count;
842
843 /* The number of the tracepoint on the target. */
844 int number_on_target;
845
846 /* The total space taken by all the trace frames for this
847 tracepoint. */
848 ULONGEST traceframe_usage;
849
850 /* The static tracepoint marker id, if known. */
851 char *static_trace_marker_id;
852
853 /* LTTng/UST allow more than one marker with the same ID string,
854 although it unadvised because it confuses tools. When setting
855 static tracepoints by marker ID, this will record the index in
856 the array of markers we found for the given marker ID for which
857 this static tracepoint corresponds. When resetting breakpoints,
858 we will use this index to try to find the same marker again. */
859 int static_trace_marker_id_idx;
860 };
861
862 typedef struct breakpoint *breakpoint_p;
863 DEF_VEC_P(breakpoint_p);
864 \f
865 /* The following stuff is an abstract data type "bpstat" ("breakpoint
866 status"). This provides the ability to determine whether we have
867 stopped at a breakpoint, and what we should do about it. */
868
869 typedef struct bpstats *bpstat;
870
871 /* Clears a chain of bpstat, freeing storage
872 of each. */
873 extern void bpstat_clear (bpstat *);
874
875 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that
876 is part of the bpstat is copied as well. */
877 extern bpstat bpstat_copy (bpstat);
878
879 extern bpstat bpstat_stop_status (struct address_space *aspace,
880 CORE_ADDR pc, ptid_t ptid,
881 const struct target_waitstatus *ws);
882 \f
883 /* This bpstat_what stuff tells wait_for_inferior what to do with a
884 breakpoint (a challenging task).
885
886 The enum values order defines priority-like order of the actions.
887 Once you've decided that some action is appropriate, you'll never
888 go back and decide something of a lower priority is better. Each
889 of these actions is mutually exclusive with the others. That
890 means, that if you find yourself adding a new action class here and
891 wanting to tell GDB that you have two simultaneous actions to
892 handle, something is wrong, and you probably don't actually need a
893 new action type.
894
895 Note that a step resume breakpoint overrides another breakpoint of
896 signal handling (see comment in wait_for_inferior at where we set
897 the step_resume breakpoint). */
898
899 enum bpstat_what_main_action
900 {
901 /* Perform various other tests; that is, this bpstat does not
902 say to perform any action (e.g. failed watchpoint and nothing
903 else). */
904 BPSTAT_WHAT_KEEP_CHECKING,
905
906 /* Remove breakpoints, single step once, then put them back in and
907 go back to what we were doing. It's possible that this should
908 be removed from the main_action and put into a separate field,
909 to more cleanly handle
910 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */
911 BPSTAT_WHAT_SINGLE,
912
913 /* Set longjmp_resume breakpoint, remove all other breakpoints,
914 and continue. The "remove all other breakpoints" part is
915 required if we are also stepping over another breakpoint as
916 well as doing the longjmp handling. */
917 BPSTAT_WHAT_SET_LONGJMP_RESUME,
918
919 /* Clear longjmp_resume breakpoint, then handle as
920 BPSTAT_WHAT_KEEP_CHECKING. */
921 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME,
922
923 /* Clear step resume breakpoint, and keep checking. */
924 BPSTAT_WHAT_STEP_RESUME,
925
926 /* Rather than distinguish between noisy and silent stops here, it
927 might be cleaner to have bpstat_print make that decision (also
928 taking into account stop_print_frame and source_only). But the
929 implications are a bit scary (interaction with auto-displays,
930 etc.), so I won't try it. */
931
932 /* Stop silently. */
933 BPSTAT_WHAT_STOP_SILENT,
934
935 /* Stop and print. */
936 BPSTAT_WHAT_STOP_NOISY,
937
938 /* Clear step resume breakpoint, and keep checking. High-priority
939 step-resume breakpoints are used when even if there's a user
940 breakpoint at the current PC when we set the step-resume
941 breakpoint, we don't want to re-handle any breakpoint other
942 than the step-resume when it's hit; instead we want to move
943 past the breakpoint. This is used in the case of skipping
944 signal handlers. */
945 BPSTAT_WHAT_HP_STEP_RESUME,
946 };
947
948 /* An enum indicating the kind of "stack dummy" stop. This is a bit
949 of a misnomer because only one kind of truly a stack dummy. */
950 enum stop_stack_kind
951 {
952 /* We didn't stop at a stack dummy breakpoint. */
953 STOP_NONE = 0,
954
955 /* Stopped at a stack dummy. */
956 STOP_STACK_DUMMY,
957
958 /* Stopped at std::terminate. */
959 STOP_STD_TERMINATE
960 };
961
962 struct bpstat_what
963 {
964 enum bpstat_what_main_action main_action;
965
966 /* Did we hit a call dummy breakpoint? This only goes with a
967 main_action of BPSTAT_WHAT_STOP_SILENT or
968 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call
969 dummy without popping the frame is not a useful one). */
970 enum stop_stack_kind call_dummy;
971
972 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and
973 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a
974 longjmp, false if we are handling an exception. */
975 int is_longjmp;
976 };
977
978 /* The possible return values for print_bpstat, print_it_normal,
979 print_it_done, print_it_noop. */
980 enum print_stop_action
981 {
982 /* We printed nothing or we need to do some more analysis. */
983 PRINT_UNKNOWN = -1,
984
985 /* We printed something, and we *do* desire that something to be
986 followed by a location. */
987 PRINT_SRC_AND_LOC,
988
989 /* We printed something, and we do *not* desire that something to
990 be followed by a location. */
991 PRINT_SRC_ONLY,
992
993 /* We already printed all we needed to print, don't print anything
994 else. */
995 PRINT_NOTHING
996 };
997
998 /* Tell what to do about this bpstat. */
999 struct bpstat_what bpstat_what (bpstat);
1000 \f
1001 /* Find the bpstat associated with a breakpoint. NULL otherwise. */
1002 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *);
1003
1004 /* Nonzero if a signal that we got in wait() was due to circumstances
1005 explained by the bpstat; and the signal should therefore not be
1006 delivered. */
1007 extern enum bpstat_signal_value bpstat_explains_signal (bpstat);
1008
1009 /* Nonzero is this bpstat causes a stop. */
1010 extern int bpstat_causes_stop (bpstat);
1011
1012 /* Nonzero if we should step constantly (e.g. watchpoints on machines
1013 without hardware support). This isn't related to a specific bpstat,
1014 just to things like whether watchpoints are set. */
1015 extern int bpstat_should_step (void);
1016
1017 /* Print a message indicating what happened. Returns nonzero to
1018 say that only the source line should be printed after this (zero
1019 return means print the frame as well as the source line). */
1020 extern enum print_stop_action bpstat_print (bpstat, int);
1021
1022 /* Put in *NUM the breakpoint number of the first breakpoint we are
1023 stopped at. *BSP upon return is a bpstat which points to the
1024 remaining breakpoints stopped at (but which is not guaranteed to be
1025 good for anything but further calls to bpstat_num).
1026
1027 Return 0 if passed a bpstat which does not indicate any breakpoints.
1028 Return -1 if stopped at a breakpoint that has been deleted since
1029 we set it.
1030 Return 1 otherwise. */
1031 extern int bpstat_num (bpstat *, int *);
1032
1033 /* Perform actions associated with the stopped inferior. Actually, we
1034 just use this for breakpoint commands. Perhaps other actions will
1035 go here later, but this is executed at a late time (from the
1036 command loop). */
1037 extern void bpstat_do_actions (void);
1038
1039 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will
1040 not be performed. */
1041 extern void bpstat_clear_actions (void);
1042
1043 /* Implementation: */
1044
1045 /* Values used to tell the printing routine how to behave for this
1046 bpstat. */
1047 enum bp_print_how
1048 {
1049 /* This is used when we want to do a normal printing of the reason
1050 for stopping. The output will depend on the type of eventpoint
1051 we are dealing with. This is the default value, most commonly
1052 used. */
1053 print_it_normal,
1054 /* This is used when nothing should be printed for this bpstat
1055 entry. */
1056 print_it_noop,
1057 /* This is used when everything which needs to be printed has
1058 already been printed. But we still want to print the frame. */
1059 print_it_done
1060 };
1061
1062 struct bpstats
1063 {
1064 /* Linked list because there can be more than one breakpoint at
1065 the same place, and a bpstat reflects the fact that all have
1066 been hit. */
1067 bpstat next;
1068
1069 /* Location that caused the stop. Locations are refcounted, so
1070 this will never be NULL. Note that this location may end up
1071 detached from a breakpoint, but that does not necessary mean
1072 that the struct breakpoint is gone. E.g., consider a
1073 watchpoint with a condition that involves an inferior function
1074 call. Watchpoint locations are recreated often (on resumes,
1075 hence on infcalls too). Between creating the bpstat and after
1076 evaluating the watchpoint condition, this location may hence
1077 end up detached from its original owner watchpoint, even though
1078 the watchpoint is still listed. If it's condition evaluates as
1079 true, we still want this location to cause a stop, and we will
1080 still need to know which watchpoint it was originally attached.
1081 What this means is that we should not (in most cases) follow
1082 the `bpstat->bp_location->owner' link, but instead use the
1083 `breakpoint_at' field below. */
1084 struct bp_location *bp_location_at;
1085
1086 /* Breakpoint that caused the stop. This is nullified if the
1087 breakpoint ends up being deleted. See comments on
1088 `bp_location_at' above for why do we need this field instead of
1089 following the location's owner. */
1090 struct breakpoint *breakpoint_at;
1091
1092 /* The associated command list. */
1093 struct counted_command_line *commands;
1094
1095 /* Old value associated with a watchpoint. */
1096 struct value *old_val;
1097
1098 /* Nonzero if this breakpoint tells us to print the frame. */
1099 char print;
1100
1101 /* Nonzero if this breakpoint tells us to stop. */
1102 char stop;
1103
1104 /* Tell bpstat_print and print_bp_stop_message how to print stuff
1105 associated with this element of the bpstat chain. */
1106 enum bp_print_how print_it;
1107 };
1108
1109 enum inf_context
1110 {
1111 inf_starting,
1112 inf_running,
1113 inf_exited,
1114 inf_execd
1115 };
1116
1117 /* The possible return values for breakpoint_here_p.
1118 We guarantee that zero always means "no breakpoint here". */
1119 enum breakpoint_here
1120 {
1121 no_breakpoint_here = 0,
1122 ordinary_breakpoint_here,
1123 permanent_breakpoint_here
1124 };
1125 \f
1126
1127 /* Prototypes for breakpoint-related functions. */
1128
1129 extern enum breakpoint_here breakpoint_here_p (struct address_space *,
1130 CORE_ADDR);
1131
1132 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR);
1133
1134 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR);
1135
1136 extern int regular_breakpoint_inserted_here_p (struct address_space *,
1137 CORE_ADDR);
1138
1139 extern int software_breakpoint_inserted_here_p (struct address_space *,
1140 CORE_ADDR);
1141
1142 /* Returns true if there's a hardware watchpoint or access watchpoint
1143 inserted in the range defined by ADDR and LEN. */
1144 extern int hardware_watchpoint_inserted_in_range (struct address_space *,
1145 CORE_ADDR addr,
1146 ULONGEST len);
1147
1148 extern int breakpoint_thread_match (struct address_space *,
1149 CORE_ADDR, ptid_t);
1150
1151 extern void until_break_command (char *, int, int);
1152
1153 /* Initialize a struct bp_location. */
1154
1155 extern void init_bp_location (struct bp_location *loc,
1156 const struct bp_location_ops *ops,
1157 struct breakpoint *owner);
1158
1159 extern void update_breakpoint_locations (struct breakpoint *b,
1160 struct symtabs_and_lines sals,
1161 struct symtabs_and_lines sals_end);
1162
1163 extern void breakpoint_re_set (void);
1164
1165 extern void breakpoint_re_set_thread (struct breakpoint *);
1166
1167 extern struct breakpoint *set_momentary_breakpoint
1168 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype);
1169
1170 extern struct breakpoint *set_momentary_breakpoint_at_pc
1171 (struct gdbarch *, CORE_ADDR pc, enum bptype type);
1172
1173 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt);
1174
1175 extern void set_ignore_count (int, int, int);
1176
1177 extern void breakpoint_init_inferior (enum inf_context);
1178
1179 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *);
1180
1181 extern void delete_breakpoint (struct breakpoint *);
1182
1183 extern void breakpoint_auto_delete (bpstat);
1184
1185 typedef void (*walk_bp_location_callback) (struct bp_location *, void *);
1186
1187 extern void iterate_over_bp_locations (walk_bp_location_callback);
1188
1189 /* Return the chain of command lines to execute when this breakpoint
1190 is hit. */
1191 extern struct command_line *breakpoint_commands (struct breakpoint *b);
1192
1193 /* Return a string image of DISP. The string is static, and thus should
1194 NOT be deallocated after use. */
1195 const char *bpdisp_text (enum bpdisp disp);
1196
1197 extern void break_command (char *, int);
1198
1199 extern void hbreak_command_wrapper (char *, int);
1200 extern void thbreak_command_wrapper (char *, int);
1201 extern void rbreak_command_wrapper (char *, int);
1202 extern void watch_command_wrapper (char *, int, int);
1203 extern void awatch_command_wrapper (char *, int, int);
1204 extern void rwatch_command_wrapper (char *, int, int);
1205 extern void tbreak_command (char *, int);
1206
1207 extern struct breakpoint_ops base_breakpoint_ops;
1208 extern struct breakpoint_ops bkpt_breakpoint_ops;
1209 extern struct breakpoint_ops tracepoint_breakpoint_ops;
1210
1211 extern void initialize_breakpoint_ops (void);
1212
1213 /* Arguments to pass as context to some catch command handlers. */
1214 #define CATCH_PERMANENT ((void *) (uintptr_t) 0)
1215 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1)
1216
1217 /* Like add_cmd, but add the command to both the "catch" and "tcatch"
1218 lists, and pass some additional user data to the command
1219 function. */
1220
1221 extern void
1222 add_catch_command (char *name, char *docstring,
1223 void (*sfunc) (char *args, int from_tty,
1224 struct cmd_list_element *command),
1225 completer_ftype *completer,
1226 void *user_data_catch,
1227 void *user_data_tcatch);
1228
1229 /* Initialize a breakpoint struct for Ada exception catchpoints. */
1230
1231 extern void
1232 init_ada_exception_breakpoint (struct breakpoint *b,
1233 struct gdbarch *gdbarch,
1234 struct symtab_and_line sal,
1235 char *addr_string,
1236 const struct breakpoint_ops *ops,
1237 int tempflag,
1238 int from_tty);
1239
1240 extern void init_catchpoint (struct breakpoint *b,
1241 struct gdbarch *gdbarch, int tempflag,
1242 char *cond_string,
1243 const struct breakpoint_ops *ops);
1244
1245 /* Add breakpoint B on the breakpoint list, and notify the user, the
1246 target and breakpoint_created observers of its existence. If
1247 INTERNAL is non-zero, the breakpoint number will be allocated from
1248 the internal breakpoint count. If UPDATE_GLL is non-zero,
1249 update_global_location_list will be called. */
1250
1251 extern void install_breakpoint (int internal, struct breakpoint *b,
1252 int update_gll);
1253
1254 /* Flags that can be passed down to create_breakpoint, etc., to affect
1255 breakpoint creation in several ways. */
1256
1257 enum breakpoint_create_flags
1258 {
1259 /* We're adding a breakpoint to our tables that is already
1260 inserted in the target. */
1261 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0
1262 };
1263
1264 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg,
1265 char *cond_string, int thread,
1266 char *extra_string,
1267 int parse_condition_and_thread,
1268 int tempflag, enum bptype wanted_type,
1269 int ignore_count,
1270 enum auto_boolean pending_break_support,
1271 const struct breakpoint_ops *ops,
1272 int from_tty,
1273 int enabled,
1274 int internal, unsigned flags);
1275
1276 extern void insert_breakpoints (void);
1277
1278 extern int remove_breakpoints (void);
1279
1280 extern int remove_breakpoints_pid (int pid);
1281
1282 /* This function can be used to physically insert eventpoints from the
1283 specified traced inferior process, without modifying the breakpoint
1284 package's state. This can be useful for those targets which
1285 support following the processes of a fork() or vfork() system call,
1286 when both of the resulting two processes are to be followed. */
1287 extern int reattach_breakpoints (int);
1288
1289 /* This function can be used to update the breakpoint package's state
1290 after an exec() system call has been executed.
1291
1292 This function causes the following:
1293
1294 - All eventpoints are marked "not inserted".
1295 - All eventpoints with a symbolic address are reset such that
1296 the symbolic address must be reevaluated before the eventpoints
1297 can be reinserted.
1298 - The solib breakpoints are explicitly removed from the breakpoint
1299 list.
1300 - A step-resume breakpoint, if any, is explicitly removed from the
1301 breakpoint list.
1302 - All eventpoints without a symbolic address are removed from the
1303 breakpoint list. */
1304 extern void update_breakpoints_after_exec (void);
1305
1306 /* This function can be used to physically remove hardware breakpoints
1307 and watchpoints from the specified traced inferior process, without
1308 modifying the breakpoint package's state. This can be useful for
1309 those targets which support following the processes of a fork() or
1310 vfork() system call, when one of the resulting two processes is to
1311 be detached and allowed to run free.
1312
1313 It is an error to use this function on the process whose id is
1314 inferior_ptid. */
1315 extern int detach_breakpoints (ptid_t ptid);
1316
1317 /* This function is called when program space PSPACE is about to be
1318 deleted. It takes care of updating breakpoints to not reference
1319 this PSPACE anymore. */
1320 extern void breakpoint_program_space_exit (struct program_space *pspace);
1321
1322 extern void set_longjmp_breakpoint (struct thread_info *tp,
1323 struct frame_id frame);
1324 extern void delete_longjmp_breakpoint (int thread);
1325
1326 /* Mark all longjmp breakpoints from THREAD for later deletion. */
1327 extern void delete_longjmp_breakpoint_at_next_stop (int thread);
1328
1329 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void);
1330 extern void check_longjmp_breakpoint_for_call_dummy (int thread);
1331
1332 extern void enable_overlay_breakpoints (void);
1333 extern void disable_overlay_breakpoints (void);
1334
1335 extern void set_std_terminate_breakpoint (void);
1336 extern void delete_std_terminate_breakpoint (void);
1337
1338 /* These functions respectively disable or reenable all currently
1339 enabled watchpoints. When disabled, the watchpoints are marked
1340 call_disabled. When re-enabled, they are marked enabled.
1341
1342 The intended client of these functions is call_function_by_hand.
1343
1344 The inferior must be stopped, and all breakpoints removed, when
1345 these functions are used.
1346
1347 The need for these functions is that on some targets (e.g., HP-UX),
1348 gdb is unable to unwind through the dummy frame that is pushed as
1349 part of the implementation of a call command. Watchpoints can
1350 cause the inferior to stop in places where this frame is visible,
1351 and that can cause execution control to become very confused.
1352
1353 Note that if a user sets breakpoints in an interactively called
1354 function, the call_disabled watchpoints will have been re-enabled
1355 when the first such breakpoint is reached. However, on targets
1356 that are unable to unwind through the call dummy frame, watches
1357 of stack-based storage may then be deleted, because gdb will
1358 believe that their watched storage is out of scope. (Sigh.) */
1359 extern void disable_watchpoints_before_interactive_call_start (void);
1360
1361 extern void enable_watchpoints_after_interactive_call_stop (void);
1362
1363 /* These functions disable and re-enable all breakpoints during
1364 inferior startup. They are intended to be called from solib
1365 code where necessary. This is needed on platforms where the
1366 main executable is relocated at some point during startup
1367 processing, making breakpoint addresses invalid.
1368
1369 If additional breakpoints are created after the routine
1370 disable_breakpoints_before_startup but before the routine
1371 enable_breakpoints_after_startup was called, they will also
1372 be marked as disabled. */
1373 extern void disable_breakpoints_before_startup (void);
1374 extern void enable_breakpoints_after_startup (void);
1375
1376 /* For script interpreters that need to define breakpoint commands
1377 after they've already read the commands into a struct
1378 command_line. */
1379 extern enum command_control_type commands_from_control_command
1380 (char *arg, struct command_line *cmd);
1381
1382 extern void clear_breakpoint_hit_counts (void);
1383
1384 extern struct breakpoint *get_breakpoint (int num);
1385
1386 /* The following are for displays, which aren't really breakpoints,
1387 but here is as good a place as any for them. */
1388
1389 extern void disable_current_display (void);
1390
1391 extern void do_displays (void);
1392
1393 extern void disable_display (int);
1394
1395 extern void clear_displays (void);
1396
1397 extern void disable_breakpoint (struct breakpoint *);
1398
1399 extern void enable_breakpoint (struct breakpoint *);
1400
1401 extern void breakpoint_set_commands (struct breakpoint *b,
1402 struct command_line *commands);
1403
1404 extern void breakpoint_set_silent (struct breakpoint *b, int silent);
1405
1406 extern void breakpoint_set_thread (struct breakpoint *b, int thread);
1407
1408 extern void breakpoint_set_task (struct breakpoint *b, int task);
1409
1410 /* Clear the "inserted" flag in all breakpoints. */
1411 extern void mark_breakpoints_out (void);
1412
1413 extern void make_breakpoint_permanent (struct breakpoint *);
1414
1415 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *,
1416 CORE_ADDR);
1417
1418 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *,
1419 CORE_ADDR);
1420
1421 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *,
1422 CORE_ADDR);
1423
1424 extern void remove_jit_event_breakpoints (void);
1425
1426 extern void remove_solib_event_breakpoints (void);
1427
1428 extern void remove_thread_event_breakpoints (void);
1429
1430 extern void disable_breakpoints_in_shlibs (void);
1431
1432 /* This function returns TRUE if ep is a catchpoint. */
1433 extern int is_catchpoint (struct breakpoint *);
1434
1435 /* Shared helper function (MI and CLI) for creating and installing
1436 a shared object event catchpoint. */
1437 extern void add_solib_catchpoint (char *arg, int is_load, int is_temp,
1438 int enabled);
1439
1440 /* Enable breakpoints and delete when hit. Called with ARG == NULL
1441 deletes all breakpoints. */
1442 extern void delete_command (char *arg, int from_tty);
1443
1444 /* Manage a software single step breakpoint (or two). Insert may be
1445 called twice before remove is called. */
1446 extern void insert_single_step_breakpoint (struct gdbarch *,
1447 struct address_space *,
1448 CORE_ADDR);
1449 extern int single_step_breakpoints_inserted (void);
1450 extern void remove_single_step_breakpoints (void);
1451 extern void cancel_single_step_breakpoints (void);
1452
1453 /* Manage manual breakpoints, separate from the normal chain of
1454 breakpoints. These functions are used in murky target-specific
1455 ways. Please do not add more uses! */
1456 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *,
1457 struct address_space *,
1458 CORE_ADDR);
1459 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *);
1460
1461 /* Check if any hardware watchpoints have triggered, according to the
1462 target. */
1463 int watchpoints_triggered (struct target_waitstatus *);
1464
1465 /* Helper for transparent breakpoint hiding for memory read and write
1466 routines.
1467
1468 Update one of READBUF or WRITEBUF with either the shadows
1469 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted
1470 breakpoints at the memory range defined by MEMADDR and extending
1471 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG
1472 on entry.*/
1473 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf,
1474 const gdb_byte *writebuf_org,
1475 ULONGEST memaddr, LONGEST len);
1476
1477 extern int breakpoints_always_inserted_mode (void);
1478
1479 /* Called each time new event from target is processed.
1480 Retires previously deleted breakpoint locations that
1481 in our opinion won't ever trigger. */
1482 extern void breakpoint_retire_moribund (void);
1483
1484 /* Set break condition of breakpoint B to EXP. */
1485 extern void set_breakpoint_condition (struct breakpoint *b, char *exp,
1486 int from_tty);
1487
1488 /* Checks if we are catching syscalls or not.
1489 Returns 0 if not, greater than 0 if we are. */
1490 extern int catch_syscall_enabled (void);
1491
1492 /* Checks if we are catching syscalls with the specific
1493 syscall_number. Used for "filtering" the catchpoints.
1494 Returns 0 if not, greater than 0 if we are. */
1495 extern int catching_syscall_number (int syscall_number);
1496
1497 /* Return a tracepoint with the given number if found. */
1498 extern struct tracepoint *get_tracepoint (int num);
1499
1500 extern struct tracepoint *get_tracepoint_by_number_on_target (int num);
1501
1502 /* Find a tracepoint by parsing a number in the supplied string. */
1503 extern struct tracepoint *
1504 get_tracepoint_by_number (char **arg,
1505 struct get_number_or_range_state *state,
1506 int optional_p);
1507
1508 /* Return a vector of all tracepoints currently defined. The vector
1509 is newly allocated; the caller should free when done with it. */
1510 extern VEC(breakpoint_p) *all_tracepoints (void);
1511
1512 extern int is_tracepoint (const struct breakpoint *b);
1513
1514 /* Return a vector of all static tracepoints defined at ADDR. The
1515 vector is newly allocated; the caller should free when done with
1516 it. */
1517 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr);
1518
1519 /* Function that can be passed to read_command_line to validate
1520 that each command is suitable for tracepoint command list. */
1521 extern void check_tracepoint_command (char *line, void *closure);
1522
1523 /* Call at the start and end of an "rbreak" command to register
1524 breakpoint numbers for a later "commands" command. */
1525 extern void start_rbreak_breakpoints (void);
1526 extern void end_rbreak_breakpoints (void);
1527
1528 /* Breakpoint iterator function.
1529
1530 Calls a callback function once for each breakpoint, so long as the
1531 callback function returns false. If the callback function returns
1532 true, the iteration will end and the current breakpoint will be
1533 returned. This can be useful for implementing a search for a
1534 breakpoint with arbitrary attributes, or for applying an operation
1535 to every breakpoint. */
1536 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *,
1537 void *), void *);
1538
1539 /* Nonzero if the specified PC cannot be a location where functions
1540 have been inlined. */
1541
1542 extern int pc_at_non_inline_function (struct address_space *aspace,
1543 CORE_ADDR pc,
1544 const struct target_waitstatus *ws);
1545
1546 extern int user_breakpoint_p (struct breakpoint *);
1547
1548 /* Attempt to determine architecture of location identified by SAL. */
1549 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal);
1550
1551 extern void handle_solib_event (void);
1552
1553 #endif /* !defined (BREAKPOINT_H) */
This page took 0.085325 seconds and 4 git commands to generate.