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 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 which was used to place this location. 469 470 Breakpoint placed into a comment keeps it's user specified line number 471 despite ADDRESS resolves into a different line number. */ 472 473 int line_number; 474 475 /* Symtab which was used to place this location. This is used 476 to find the corresponding source file name. */ 477 478 struct symtab *symtab; 479 }; 480 481 /* Return values for bpstat_explains_signal. Note that the order of 482 the constants is important here; they are compared directly in 483 bpstat_explains_signal. */ 484 485 enum bpstat_signal_value 486 { 487 /* bpstat does not explain this signal. */ 488 BPSTAT_SIGNAL_NO = 0, 489 490 /* bpstat explains this signal; signal should not be delivered. */ 491 BPSTAT_SIGNAL_HIDE, 492 493 /* bpstat explains this signal; signal should be delivered. */ 494 BPSTAT_SIGNAL_PASS 495 }; 496 497 /* This structure is a collection of function pointers that, if available, 498 will be called instead of the performing the default action for this 499 bptype. */ 500 501 struct breakpoint_ops 502 { 503 /* Destructor. Releases everything from SELF (but not SELF 504 itself). */ 505 void (*dtor) (struct breakpoint *self); 506 507 /* Allocate a location for this breakpoint. */ 508 struct bp_location * (*allocate_location) (struct breakpoint *); 509 510 /* Reevaluate a breakpoint. This is necessary after symbols change 511 (e.g., an executable or DSO was loaded, or the inferior just 512 started). */ 513 void (*re_set) (struct breakpoint *self); 514 515 /* Insert the breakpoint or watchpoint or activate the catchpoint. 516 Return 0 for success, 1 if the breakpoint, watchpoint or 517 catchpoint type is not supported, -1 for failure. */ 518 int (*insert_location) (struct bp_location *); 519 520 /* Remove the breakpoint/catchpoint that was previously inserted 521 with the "insert" method above. Return 0 for success, 1 if the 522 breakpoint, watchpoint or catchpoint type is not supported, 523 -1 for failure. */ 524 int (*remove_location) (struct bp_location *); 525 526 /* Return true if it the target has stopped due to hitting 527 breakpoint location BL. This function does not check if we 528 should stop, only if BL explains the stop. ASPACE is the address 529 space in which the event occurred, BP_ADDR is the address at 530 which the inferior stopped, and WS is the target_waitstatus 531 describing the event. */ 532 int (*breakpoint_hit) (const struct bp_location *bl, 533 struct address_space *aspace, 534 CORE_ADDR bp_addr, 535 const struct target_waitstatus *ws); 536 537 /* Check internal conditions of the breakpoint referred to by BS. 538 If we should not stop for this breakpoint, set BS->stop to 0. */ 539 void (*check_status) (struct bpstats *bs); 540 541 /* Tell how many hardware resources (debug registers) are needed 542 for this breakpoint. If this function is not provided, then 543 the breakpoint or watchpoint needs one debug register. */ 544 int (*resources_needed) (const struct bp_location *); 545 546 /* Tell whether we can downgrade from a hardware watchpoint to a software 547 one. If not, the user will not be able to enable the watchpoint when 548 there are not enough hardware resources available. */ 549 int (*works_in_software_mode) (const struct breakpoint *); 550 551 /* The normal print routine for this breakpoint, called when we 552 hit it. */ 553 enum print_stop_action (*print_it) (struct bpstats *bs); 554 555 /* Display information about this breakpoint, for "info 556 breakpoints". */ 557 void (*print_one) (struct breakpoint *, struct bp_location **); 558 559 /* Display extra information about this breakpoint, below the normal 560 breakpoint description in "info breakpoints". 561 562 In the example below, the "address range" line was printed 563 by print_one_detail_ranged_breakpoint. 564 565 (gdb) info breakpoints 566 Num Type Disp Enb Address What 567 2 hw breakpoint keep y in main at test-watch.c:70 568 address range: [0x10000458, 0x100004c7] 569 570 */ 571 void (*print_one_detail) (const struct breakpoint *, struct ui_out *); 572 573 /* Display information about this breakpoint after setting it 574 (roughly speaking; this is called from "mention"). */ 575 void (*print_mention) (struct breakpoint *); 576 577 /* Print to FP the CLI command that recreates this breakpoint. */ 578 void (*print_recreate) (struct breakpoint *, struct ui_file *fp); 579 580 /* Create SALs from address string, storing the result in linespec_result. 581 582 For an explanation about the arguments, see the function 583 `create_sals_from_address_default'. 584 585 This function is called inside `create_breakpoint'. */ 586 void (*create_sals_from_address) (char **, struct linespec_result *, 587 enum bptype, char *, char **); 588 589 /* This method will be responsible for creating a breakpoint given its SALs. 590 Usually, it just calls `create_breakpoints_sal' (for ordinary 591 breakpoints). However, there may be some special cases where we might 592 need to do some tweaks, e.g., see 593 `strace_marker_create_breakpoints_sal'. 594 595 This function is called inside `create_breakpoint'. */ 596 void (*create_breakpoints_sal) (struct gdbarch *, 597 struct linespec_result *, 598 struct linespec_sals *, char *, 599 char *, 600 enum bptype, enum bpdisp, int, int, 601 int, const struct breakpoint_ops *, 602 int, int, int, unsigned); 603 604 /* Given the address string (second parameter), this method decodes it 605 and provides the SAL locations related to it. For ordinary breakpoints, 606 it calls `decode_line_full'. 607 608 This function is called inside `addr_string_to_sals'. */ 609 void (*decode_linespec) (struct breakpoint *, char **, 610 struct symtabs_and_lines *); 611 612 /* Return true if this breakpoint explains a signal, but the signal 613 should still be delivered to the inferior. This is used to make 614 'catch signal' interact properly with 'handle'; see 615 bpstat_explains_signal. */ 616 enum bpstat_signal_value (*explains_signal) (struct breakpoint *, 617 enum gdb_signal); 618 619 /* Called after evaluating the breakpoint's condition, 620 and only if it evaluated true. */ 621 void (*after_condition_true) (struct bpstats *bs); 622 }; 623 624 /* Helper for breakpoint_ops->print_recreate implementations. Prints 625 the "thread" or "task" condition of B, and then a newline. 626 627 Necessary because most breakpoint implementations accept 628 thread/task conditions at the end of the spec line, like "break foo 629 thread 1", which needs outputting before any breakpoint-type 630 specific extra command necessary for B's recreation. */ 631 extern void print_recreate_thread (struct breakpoint *b, struct ui_file *fp); 632 633 enum watchpoint_triggered 634 { 635 /* This watchpoint definitely did not trigger. */ 636 watch_triggered_no = 0, 637 638 /* Some hardware watchpoint triggered, and it might have been this 639 one, but we do not know which it was. */ 640 watch_triggered_unknown, 641 642 /* This hardware watchpoint definitely did trigger. */ 643 watch_triggered_yes 644 }; 645 646 typedef struct bp_location *bp_location_p; 647 DEF_VEC_P(bp_location_p); 648 649 /* A reference-counted struct command_line. This lets multiple 650 breakpoints share a single command list. This is an implementation 651 detail to the breakpoints module. */ 652 struct counted_command_line; 653 654 /* Some targets (e.g., embedded PowerPC) need two debug registers to set 655 a watchpoint over a memory region. If this flag is true, GDB will use 656 only one register per watchpoint, thus assuming that all acesses that 657 modify a memory location happen at its starting address. */ 658 659 extern int target_exact_watchpoints; 660 661 /* Note that the ->silent field is not currently used by any commands 662 (though the code is in there if it was to be, and set_raw_breakpoint 663 does set it to 0). I implemented it because I thought it would be 664 useful for a hack I had to put in; I'm going to leave it in because 665 I can see how there might be times when it would indeed be useful */ 666 667 /* This is for all kinds of breakpoints. */ 668 669 struct breakpoint 670 { 671 /* Methods associated with this breakpoint. */ 672 const struct breakpoint_ops *ops; 673 674 struct breakpoint *next; 675 /* Type of breakpoint. */ 676 enum bptype type; 677 /* Zero means disabled; remember the info but don't break here. */ 678 enum enable_state enable_state; 679 /* What to do with this breakpoint after we hit it. */ 680 enum bpdisp disposition; 681 /* Number assigned to distinguish breakpoints. */ 682 int number; 683 684 /* Location(s) associated with this high-level breakpoint. */ 685 struct bp_location *loc; 686 687 /* Non-zero means a silent breakpoint (don't print frame info 688 if we stop here). */ 689 unsigned char silent; 690 /* Non-zero means display ADDR_STRING to the user verbatim. */ 691 unsigned char display_canonical; 692 /* Number of stops at this breakpoint that should 693 be continued automatically before really stopping. */ 694 int ignore_count; 695 696 /* Number of stops at this breakpoint before it will be 697 disabled. */ 698 int enable_count; 699 700 /* Chain of command lines to execute when this breakpoint is 701 hit. */ 702 struct counted_command_line *commands; 703 /* Stack depth (address of frame). If nonzero, break only if fp 704 equals this. */ 705 struct frame_id frame_id; 706 707 /* The program space used to set the breakpoint. This is only set 708 for breakpoints which are specific to a program space; for 709 non-thread-specific ordinary breakpoints this is NULL. */ 710 struct program_space *pspace; 711 712 /* String we used to set the breakpoint (malloc'd). */ 713 char *addr_string; 714 715 /* The filter that should be passed to decode_line_full when 716 re-setting this breakpoint. This may be NULL, but otherwise is 717 allocated with xmalloc. */ 718 char *filter; 719 720 /* For a ranged breakpoint, the string we used to find 721 the end of the range (malloc'd). */ 722 char *addr_string_range_end; 723 724 /* Architecture we used to set the breakpoint. */ 725 struct gdbarch *gdbarch; 726 /* Language we used to set the breakpoint. */ 727 enum language language; 728 /* Input radix we used to set the breakpoint. */ 729 int input_radix; 730 /* String form of the breakpoint condition (malloc'd), or NULL if 731 there is no condition. */ 732 char *cond_string; 733 734 /* String form of extra parameters, or NULL if there are none. */ 735 char *extra_string; 736 737 /* Holds the address of the related watchpoint_scope breakpoint 738 when using watchpoints on local variables (might the concept of 739 a related breakpoint be useful elsewhere, if not just call it 740 the watchpoint_scope breakpoint or something like that. 741 FIXME). */ 742 struct breakpoint *related_breakpoint; 743 744 /* Thread number for thread-specific breakpoint, 745 or -1 if don't care. */ 746 int thread; 747 748 /* Ada task number for task-specific breakpoint, 749 or 0 if don't care. */ 750 int task; 751 752 /* Count of the number of times this breakpoint was taken, dumped 753 with the info, but not used for anything else. Useful for 754 seeing how many times you hit a break prior to the program 755 aborting, so you can back up to just before the abort. */ 756 int hit_count; 757 758 /* Is breakpoint's condition not yet parsed because we found 759 no location initially so had no context to parse 760 the condition in. */ 761 int condition_not_parsed; 762 763 /* With a Python scripting enabled GDB, store a reference to the 764 Python object that has been associated with this breakpoint. 765 This is always NULL for a GDB that is not script enabled. It 766 can sometimes be NULL for enabled GDBs as not all breakpoint 767 types are tracked by the Python scripting API. */ 768 struct breakpoint_object *py_bp_object; 769 }; 770 771 /* An instance of this type is used to represent a watchpoint. It 772 includes a "struct breakpoint" as a kind of base class; users 773 downcast to "struct breakpoint *" when needed. */ 774 775 struct watchpoint 776 { 777 /* The base class. */ 778 struct breakpoint base; 779 780 /* String form of exp to use for displaying to the user (malloc'd), 781 or NULL if none. */ 782 char *exp_string; 783 /* String form to use for reparsing of EXP (malloc'd) or NULL. */ 784 char *exp_string_reparse; 785 786 /* The expression we are watching, or NULL if not a watchpoint. */ 787 struct expression *exp; 788 /* The largest block within which it is valid, or NULL if it is 789 valid anywhere (e.g. consists just of global symbols). */ 790 const struct block *exp_valid_block; 791 /* The conditional expression if any. */ 792 struct expression *cond_exp; 793 /* The largest block within which it is valid, or NULL if it is 794 valid anywhere (e.g. consists just of global symbols). */ 795 const struct block *cond_exp_valid_block; 796 /* Value of the watchpoint the last time we checked it, or NULL when 797 we do not know the value yet or the value was not readable. VAL 798 is never lazy. */ 799 struct value *val; 800 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL, 801 then an error occurred reading the value. */ 802 int val_valid; 803 804 /* Holds the frame address which identifies the frame this 805 watchpoint should be evaluated in, or `null' if the watchpoint 806 should be evaluated on the outermost frame. */ 807 struct frame_id watchpoint_frame; 808 809 /* Holds the thread which identifies the frame this watchpoint 810 should be considered in scope for, or `null_ptid' if the 811 watchpoint should be evaluated in all threads. */ 812 ptid_t watchpoint_thread; 813 814 /* For hardware watchpoints, the triggered status according to the 815 hardware. */ 816 enum watchpoint_triggered watchpoint_triggered; 817 818 /* Whether this watchpoint is exact (see 819 target_exact_watchpoints). */ 820 int exact; 821 822 /* The mask address for a masked hardware watchpoint. */ 823 CORE_ADDR hw_wp_mask; 824 }; 825 826 /* Return true if BPT is either a software breakpoint or a hardware 827 breakpoint. */ 828 829 extern int is_breakpoint (const struct breakpoint *bpt); 830 831 /* Returns true if BPT is really a watchpoint. */ 832 833 extern int is_watchpoint (const struct breakpoint *bpt); 834 835 /* An instance of this type is used to represent all kinds of 836 tracepoints. It includes a "struct breakpoint" as a kind of base 837 class; users downcast to "struct breakpoint *" when needed. */ 838 839 struct tracepoint 840 { 841 /* The base class. */ 842 struct breakpoint base; 843 844 /* Number of times this tracepoint should single-step and collect 845 additional data. */ 846 long step_count; 847 848 /* Number of times this tracepoint should be hit before 849 disabling/ending. */ 850 int pass_count; 851 852 /* The number of the tracepoint on the target. */ 853 int number_on_target; 854 855 /* The total space taken by all the trace frames for this 856 tracepoint. */ 857 ULONGEST traceframe_usage; 858 859 /* The static tracepoint marker id, if known. */ 860 char *static_trace_marker_id; 861 862 /* LTTng/UST allow more than one marker with the same ID string, 863 although it unadvised because it confuses tools. When setting 864 static tracepoints by marker ID, this will record the index in 865 the array of markers we found for the given marker ID for which 866 this static tracepoint corresponds. When resetting breakpoints, 867 we will use this index to try to find the same marker again. */ 868 int static_trace_marker_id_idx; 869 }; 870 871 typedef struct breakpoint *breakpoint_p; 872 DEF_VEC_P(breakpoint_p); 873 874 /* The following stuff is an abstract data type "bpstat" ("breakpoint 875 status"). This provides the ability to determine whether we have 876 stopped at a breakpoint, and what we should do about it. */ 877 878 typedef struct bpstats *bpstat; 879 880 /* Clears a chain of bpstat, freeing storage 881 of each. */ 882 extern void bpstat_clear (bpstat *); 883 884 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that 885 is part of the bpstat is copied as well. */ 886 extern bpstat bpstat_copy (bpstat); 887 888 extern bpstat bpstat_stop_status (struct address_space *aspace, 889 CORE_ADDR pc, ptid_t ptid, 890 const struct target_waitstatus *ws); 891 892 /* This bpstat_what stuff tells wait_for_inferior what to do with a 893 breakpoint (a challenging task). 894 895 The enum values order defines priority-like order of the actions. 896 Once you've decided that some action is appropriate, you'll never 897 go back and decide something of a lower priority is better. Each 898 of these actions is mutually exclusive with the others. That 899 means, that if you find yourself adding a new action class here and 900 wanting to tell GDB that you have two simultaneous actions to 901 handle, something is wrong, and you probably don't actually need a 902 new action type. 903 904 Note that a step resume breakpoint overrides another breakpoint of 905 signal handling (see comment in wait_for_inferior at where we set 906 the step_resume breakpoint). */ 907 908 enum bpstat_what_main_action 909 { 910 /* Perform various other tests; that is, this bpstat does not 911 say to perform any action (e.g. failed watchpoint and nothing 912 else). */ 913 BPSTAT_WHAT_KEEP_CHECKING, 914 915 /* Remove breakpoints, single step once, then put them back in and 916 go back to what we were doing. It's possible that this should 917 be removed from the main_action and put into a separate field, 918 to more cleanly handle 919 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */ 920 BPSTAT_WHAT_SINGLE, 921 922 /* Set longjmp_resume breakpoint, remove all other breakpoints, 923 and continue. The "remove all other breakpoints" part is 924 required if we are also stepping over another breakpoint as 925 well as doing the longjmp handling. */ 926 BPSTAT_WHAT_SET_LONGJMP_RESUME, 927 928 /* Clear longjmp_resume breakpoint, then handle as 929 BPSTAT_WHAT_KEEP_CHECKING. */ 930 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME, 931 932 /* Clear step resume breakpoint, and keep checking. */ 933 BPSTAT_WHAT_STEP_RESUME, 934 935 /* Rather than distinguish between noisy and silent stops here, it 936 might be cleaner to have bpstat_print make that decision (also 937 taking into account stop_print_frame and source_only). But the 938 implications are a bit scary (interaction with auto-displays, 939 etc.), so I won't try it. */ 940 941 /* Stop silently. */ 942 BPSTAT_WHAT_STOP_SILENT, 943 944 /* Stop and print. */ 945 BPSTAT_WHAT_STOP_NOISY, 946 947 /* Clear step resume breakpoint, and keep checking. High-priority 948 step-resume breakpoints are used when even if there's a user 949 breakpoint at the current PC when we set the step-resume 950 breakpoint, we don't want to re-handle any breakpoint other 951 than the step-resume when it's hit; instead we want to move 952 past the breakpoint. This is used in the case of skipping 953 signal handlers. */ 954 BPSTAT_WHAT_HP_STEP_RESUME, 955 }; 956 957 /* An enum indicating the kind of "stack dummy" stop. This is a bit 958 of a misnomer because only one kind of truly a stack dummy. */ 959 enum stop_stack_kind 960 { 961 /* We didn't stop at a stack dummy breakpoint. */ 962 STOP_NONE = 0, 963 964 /* Stopped at a stack dummy. */ 965 STOP_STACK_DUMMY, 966 967 /* Stopped at std::terminate. */ 968 STOP_STD_TERMINATE 969 }; 970 971 struct bpstat_what 972 { 973 enum bpstat_what_main_action main_action; 974 975 /* Did we hit a call dummy breakpoint? This only goes with a 976 main_action of BPSTAT_WHAT_STOP_SILENT or 977 BPSTAT_WHAT_STOP_NOISY (the concept of continuing from a call 978 dummy without popping the frame is not a useful one). */ 979 enum stop_stack_kind call_dummy; 980 981 /* Used for BPSTAT_WHAT_SET_LONGJMP_RESUME and 982 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME. True if we are handling a 983 longjmp, false if we are handling an exception. */ 984 int is_longjmp; 985 }; 986 987 /* The possible return values for print_bpstat, print_it_normal, 988 print_it_done, print_it_noop. */ 989 enum print_stop_action 990 { 991 /* We printed nothing or we need to do some more analysis. */ 992 PRINT_UNKNOWN = -1, 993 994 /* We printed something, and we *do* desire that something to be 995 followed by a location. */ 996 PRINT_SRC_AND_LOC, 997 998 /* We printed something, and we do *not* desire that something to 999 be followed by a location. */ 1000 PRINT_SRC_ONLY, 1001 1002 /* We already printed all we needed to print, don't print anything 1003 else. */ 1004 PRINT_NOTHING 1005 }; 1006 1007 /* Tell what to do about this bpstat. */ 1008 struct bpstat_what bpstat_what (bpstat); 1009 1010 /* Find the bpstat associated with a breakpoint. NULL otherwise. */ 1011 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *); 1012 1013 /* Nonzero if a signal that we got in wait() was due to circumstances 1014 explained by the bpstat; and the signal should therefore not be 1015 delivered. */ 1016 extern enum bpstat_signal_value bpstat_explains_signal (bpstat, 1017 enum gdb_signal); 1018 1019 /* Nonzero is this bpstat causes a stop. */ 1020 extern int bpstat_causes_stop (bpstat); 1021 1022 /* Nonzero if we should step constantly (e.g. watchpoints on machines 1023 without hardware support). This isn't related to a specific bpstat, 1024 just to things like whether watchpoints are set. */ 1025 extern int bpstat_should_step (void); 1026 1027 /* Print a message indicating what happened. Returns nonzero to 1028 say that only the source line should be printed after this (zero 1029 return means print the frame as well as the source line). */ 1030 extern enum print_stop_action bpstat_print (bpstat, int); 1031 1032 /* Put in *NUM the breakpoint number of the first breakpoint we are 1033 stopped at. *BSP upon return is a bpstat which points to the 1034 remaining breakpoints stopped at (but which is not guaranteed to be 1035 good for anything but further calls to bpstat_num). 1036 1037 Return 0 if passed a bpstat which does not indicate any breakpoints. 1038 Return -1 if stopped at a breakpoint that has been deleted since 1039 we set it. 1040 Return 1 otherwise. */ 1041 extern int bpstat_num (bpstat *, int *); 1042 1043 /* Perform actions associated with the stopped inferior. Actually, we 1044 just use this for breakpoint commands. Perhaps other actions will 1045 go here later, but this is executed at a late time (from the 1046 command loop). */ 1047 extern void bpstat_do_actions (void); 1048 1049 /* Modify all entries of STOP_BPSTAT of INFERIOR_PTID so that the actions will 1050 not be performed. */ 1051 extern void bpstat_clear_actions (void); 1052 1053 /* Implementation: */ 1054 1055 /* Values used to tell the printing routine how to behave for this 1056 bpstat. */ 1057 enum bp_print_how 1058 { 1059 /* This is used when we want to do a normal printing of the reason 1060 for stopping. The output will depend on the type of eventpoint 1061 we are dealing with. This is the default value, most commonly 1062 used. */ 1063 print_it_normal, 1064 /* This is used when nothing should be printed for this bpstat 1065 entry. */ 1066 print_it_noop, 1067 /* This is used when everything which needs to be printed has 1068 already been printed. But we still want to print the frame. */ 1069 print_it_done 1070 }; 1071 1072 struct bpstats 1073 { 1074 /* Linked list because there can be more than one breakpoint at 1075 the same place, and a bpstat reflects the fact that all have 1076 been hit. */ 1077 bpstat next; 1078 1079 /* Location that caused the stop. Locations are refcounted, so 1080 this will never be NULL. Note that this location may end up 1081 detached from a breakpoint, but that does not necessary mean 1082 that the struct breakpoint is gone. E.g., consider a 1083 watchpoint with a condition that involves an inferior function 1084 call. Watchpoint locations are recreated often (on resumes, 1085 hence on infcalls too). Between creating the bpstat and after 1086 evaluating the watchpoint condition, this location may hence 1087 end up detached from its original owner watchpoint, even though 1088 the watchpoint is still listed. If it's condition evaluates as 1089 true, we still want this location to cause a stop, and we will 1090 still need to know which watchpoint it was originally attached. 1091 What this means is that we should not (in most cases) follow 1092 the `bpstat->bp_location->owner' link, but instead use the 1093 `breakpoint_at' field below. */ 1094 struct bp_location *bp_location_at; 1095 1096 /* Breakpoint that caused the stop. This is nullified if the 1097 breakpoint ends up being deleted. See comments on 1098 `bp_location_at' above for why do we need this field instead of 1099 following the location's owner. */ 1100 struct breakpoint *breakpoint_at; 1101 1102 /* The associated command list. */ 1103 struct counted_command_line *commands; 1104 1105 /* Old value associated with a watchpoint. */ 1106 struct value *old_val; 1107 1108 /* Nonzero if this breakpoint tells us to print the frame. */ 1109 char print; 1110 1111 /* Nonzero if this breakpoint tells us to stop. */ 1112 char stop; 1113 1114 /* Tell bpstat_print and print_bp_stop_message how to print stuff 1115 associated with this element of the bpstat chain. */ 1116 enum bp_print_how print_it; 1117 }; 1118 1119 enum inf_context 1120 { 1121 inf_starting, 1122 inf_running, 1123 inf_exited, 1124 inf_execd 1125 }; 1126 1127 /* The possible return values for breakpoint_here_p. 1128 We guarantee that zero always means "no breakpoint here". */ 1129 enum breakpoint_here 1130 { 1131 no_breakpoint_here = 0, 1132 ordinary_breakpoint_here, 1133 permanent_breakpoint_here 1134 }; 1135 1136 1137 /* Prototypes for breakpoint-related functions. */ 1138 1139 extern enum breakpoint_here breakpoint_here_p (struct address_space *, 1140 CORE_ADDR); 1141 1142 extern int moribund_breakpoint_here_p (struct address_space *, CORE_ADDR); 1143 1144 extern int breakpoint_inserted_here_p (struct address_space *, CORE_ADDR); 1145 1146 extern int regular_breakpoint_inserted_here_p (struct address_space *, 1147 CORE_ADDR); 1148 1149 extern int software_breakpoint_inserted_here_p (struct address_space *, 1150 CORE_ADDR); 1151 1152 /* Returns true if there's a hardware watchpoint or access watchpoint 1153 inserted in the range defined by ADDR and LEN. */ 1154 extern int hardware_watchpoint_inserted_in_range (struct address_space *, 1155 CORE_ADDR addr, 1156 ULONGEST len); 1157 1158 extern int breakpoint_thread_match (struct address_space *, 1159 CORE_ADDR, ptid_t); 1160 1161 extern void until_break_command (char *, int, int); 1162 1163 /* Initialize a struct bp_location. */ 1164 1165 extern void init_bp_location (struct bp_location *loc, 1166 const struct bp_location_ops *ops, 1167 struct breakpoint *owner); 1168 1169 extern void update_breakpoint_locations (struct breakpoint *b, 1170 struct symtabs_and_lines sals, 1171 struct symtabs_and_lines sals_end); 1172 1173 extern void breakpoint_re_set (void); 1174 1175 extern void breakpoint_re_set_thread (struct breakpoint *); 1176 1177 extern struct breakpoint *set_momentary_breakpoint 1178 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype); 1179 1180 extern struct breakpoint *set_momentary_breakpoint_at_pc 1181 (struct gdbarch *, CORE_ADDR pc, enum bptype type); 1182 1183 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt); 1184 1185 extern void set_ignore_count (int, int, int); 1186 1187 extern void breakpoint_init_inferior (enum inf_context); 1188 1189 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *); 1190 1191 extern void delete_breakpoint (struct breakpoint *); 1192 1193 extern void breakpoint_auto_delete (bpstat); 1194 1195 typedef void (*walk_bp_location_callback) (struct bp_location *, void *); 1196 1197 extern void iterate_over_bp_locations (walk_bp_location_callback); 1198 1199 /* Return the chain of command lines to execute when this breakpoint 1200 is hit. */ 1201 extern struct command_line *breakpoint_commands (struct breakpoint *b); 1202 1203 /* Return a string image of DISP. The string is static, and thus should 1204 NOT be deallocated after use. */ 1205 const char *bpdisp_text (enum bpdisp disp); 1206 1207 extern void break_command (char *, int); 1208 1209 extern void hbreak_command_wrapper (char *, int); 1210 extern void thbreak_command_wrapper (char *, int); 1211 extern void rbreak_command_wrapper (char *, int); 1212 extern void watch_command_wrapper (char *, int, int); 1213 extern void awatch_command_wrapper (char *, int, int); 1214 extern void rwatch_command_wrapper (char *, int, int); 1215 extern void tbreak_command (char *, int); 1216 1217 extern struct breakpoint_ops base_breakpoint_ops; 1218 extern struct breakpoint_ops bkpt_breakpoint_ops; 1219 extern struct breakpoint_ops tracepoint_breakpoint_ops; 1220 1221 extern void initialize_breakpoint_ops (void); 1222 1223 /* Arguments to pass as context to some catch command handlers. */ 1224 #define CATCH_PERMANENT ((void *) (uintptr_t) 0) 1225 #define CATCH_TEMPORARY ((void *) (uintptr_t) 1) 1226 1227 /* Like add_cmd, but add the command to both the "catch" and "tcatch" 1228 lists, and pass some additional user data to the command 1229 function. */ 1230 1231 extern void 1232 add_catch_command (char *name, char *docstring, 1233 void (*sfunc) (char *args, int from_tty, 1234 struct cmd_list_element *command), 1235 completer_ftype *completer, 1236 void *user_data_catch, 1237 void *user_data_tcatch); 1238 1239 /* Initialize a breakpoint struct for Ada exception catchpoints. */ 1240 1241 extern void 1242 init_ada_exception_breakpoint (struct breakpoint *b, 1243 struct gdbarch *gdbarch, 1244 struct symtab_and_line sal, 1245 char *addr_string, 1246 const struct breakpoint_ops *ops, 1247 int tempflag, 1248 int from_tty); 1249 1250 extern void init_catchpoint (struct breakpoint *b, 1251 struct gdbarch *gdbarch, int tempflag, 1252 char *cond_string, 1253 const struct breakpoint_ops *ops); 1254 1255 /* Add breakpoint B on the breakpoint list, and notify the user, the 1256 target and breakpoint_created observers of its existence. If 1257 INTERNAL is non-zero, the breakpoint number will be allocated from 1258 the internal breakpoint count. If UPDATE_GLL is non-zero, 1259 update_global_location_list will be called. */ 1260 1261 extern void install_breakpoint (int internal, struct breakpoint *b, 1262 int update_gll); 1263 1264 /* Flags that can be passed down to create_breakpoint, etc., to affect 1265 breakpoint creation in several ways. */ 1266 1267 enum breakpoint_create_flags 1268 { 1269 /* We're adding a breakpoint to our tables that is already 1270 inserted in the target. */ 1271 CREATE_BREAKPOINT_FLAGS_INSERTED = 1 << 0 1272 }; 1273 1274 extern int create_breakpoint (struct gdbarch *gdbarch, char *arg, 1275 char *cond_string, int thread, 1276 char *extra_string, 1277 int parse_condition_and_thread, 1278 int tempflag, enum bptype wanted_type, 1279 int ignore_count, 1280 enum auto_boolean pending_break_support, 1281 const struct breakpoint_ops *ops, 1282 int from_tty, 1283 int enabled, 1284 int internal, unsigned flags); 1285 1286 extern void insert_breakpoints (void); 1287 1288 extern int remove_breakpoints (void); 1289 1290 extern int remove_breakpoints_pid (int pid); 1291 1292 /* This function can be used to physically insert eventpoints from the 1293 specified traced inferior process, without modifying the breakpoint 1294 package's state. This can be useful for those targets which 1295 support following the processes of a fork() or vfork() system call, 1296 when both of the resulting two processes are to be followed. */ 1297 extern int reattach_breakpoints (int); 1298 1299 /* This function can be used to update the breakpoint package's state 1300 after an exec() system call has been executed. 1301 1302 This function causes the following: 1303 1304 - All eventpoints are marked "not inserted". 1305 - All eventpoints with a symbolic address are reset such that 1306 the symbolic address must be reevaluated before the eventpoints 1307 can be reinserted. 1308 - The solib breakpoints are explicitly removed from the breakpoint 1309 list. 1310 - A step-resume breakpoint, if any, is explicitly removed from the 1311 breakpoint list. 1312 - All eventpoints without a symbolic address are removed from the 1313 breakpoint list. */ 1314 extern void update_breakpoints_after_exec (void); 1315 1316 /* This function can be used to physically remove hardware breakpoints 1317 and watchpoints from the specified traced inferior process, without 1318 modifying the breakpoint package's state. This can be useful for 1319 those targets which support following the processes of a fork() or 1320 vfork() system call, when one of the resulting two processes is to 1321 be detached and allowed to run free. 1322 1323 It is an error to use this function on the process whose id is 1324 inferior_ptid. */ 1325 extern int detach_breakpoints (ptid_t ptid); 1326 1327 /* This function is called when program space PSPACE is about to be 1328 deleted. It takes care of updating breakpoints to not reference 1329 this PSPACE anymore. */ 1330 extern void breakpoint_program_space_exit (struct program_space *pspace); 1331 1332 extern void set_longjmp_breakpoint (struct thread_info *tp, 1333 struct frame_id frame); 1334 extern void delete_longjmp_breakpoint (int thread); 1335 1336 /* Mark all longjmp breakpoints from THREAD for later deletion. */ 1337 extern void delete_longjmp_breakpoint_at_next_stop (int thread); 1338 1339 extern struct breakpoint *set_longjmp_breakpoint_for_call_dummy (void); 1340 extern void check_longjmp_breakpoint_for_call_dummy (int thread); 1341 1342 extern void enable_overlay_breakpoints (void); 1343 extern void disable_overlay_breakpoints (void); 1344 1345 extern void set_std_terminate_breakpoint (void); 1346 extern void delete_std_terminate_breakpoint (void); 1347 1348 /* These functions respectively disable or reenable all currently 1349 enabled watchpoints. When disabled, the watchpoints are marked 1350 call_disabled. When re-enabled, they are marked enabled. 1351 1352 The intended client of these functions is call_function_by_hand. 1353 1354 The inferior must be stopped, and all breakpoints removed, when 1355 these functions are used. 1356 1357 The need for these functions is that on some targets (e.g., HP-UX), 1358 gdb is unable to unwind through the dummy frame that is pushed as 1359 part of the implementation of a call command. Watchpoints can 1360 cause the inferior to stop in places where this frame is visible, 1361 and that can cause execution control to become very confused. 1362 1363 Note that if a user sets breakpoints in an interactively called 1364 function, the call_disabled watchpoints will have been re-enabled 1365 when the first such breakpoint is reached. However, on targets 1366 that are unable to unwind through the call dummy frame, watches 1367 of stack-based storage may then be deleted, because gdb will 1368 believe that their watched storage is out of scope. (Sigh.) */ 1369 extern void disable_watchpoints_before_interactive_call_start (void); 1370 1371 extern void enable_watchpoints_after_interactive_call_stop (void); 1372 1373 /* These functions disable and re-enable all breakpoints during 1374 inferior startup. They are intended to be called from solib 1375 code where necessary. This is needed on platforms where the 1376 main executable is relocated at some point during startup 1377 processing, making breakpoint addresses invalid. 1378 1379 If additional breakpoints are created after the routine 1380 disable_breakpoints_before_startup but before the routine 1381 enable_breakpoints_after_startup was called, they will also 1382 be marked as disabled. */ 1383 extern void disable_breakpoints_before_startup (void); 1384 extern void enable_breakpoints_after_startup (void); 1385 1386 /* For script interpreters that need to define breakpoint commands 1387 after they've already read the commands into a struct 1388 command_line. */ 1389 extern enum command_control_type commands_from_control_command 1390 (char *arg, struct command_line *cmd); 1391 1392 extern void clear_breakpoint_hit_counts (void); 1393 1394 extern struct breakpoint *get_breakpoint (int num); 1395 1396 /* The following are for displays, which aren't really breakpoints, 1397 but here is as good a place as any for them. */ 1398 1399 extern void disable_current_display (void); 1400 1401 extern void do_displays (void); 1402 1403 extern void disable_display (int); 1404 1405 extern void clear_displays (void); 1406 1407 extern void disable_breakpoint (struct breakpoint *); 1408 1409 extern void enable_breakpoint (struct breakpoint *); 1410 1411 extern void breakpoint_set_commands (struct breakpoint *b, 1412 struct command_line *commands); 1413 1414 extern void breakpoint_set_silent (struct breakpoint *b, int silent); 1415 1416 extern void breakpoint_set_thread (struct breakpoint *b, int thread); 1417 1418 extern void breakpoint_set_task (struct breakpoint *b, int task); 1419 1420 /* Clear the "inserted" flag in all breakpoints. */ 1421 extern void mark_breakpoints_out (void); 1422 1423 extern void make_breakpoint_permanent (struct breakpoint *); 1424 1425 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *, 1426 CORE_ADDR); 1427 1428 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *, 1429 CORE_ADDR); 1430 1431 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *, 1432 CORE_ADDR); 1433 1434 extern void remove_jit_event_breakpoints (void); 1435 1436 extern void remove_solib_event_breakpoints (void); 1437 1438 extern void remove_thread_event_breakpoints (void); 1439 1440 extern void disable_breakpoints_in_shlibs (void); 1441 1442 /* This function returns TRUE if ep is a catchpoint. */ 1443 extern int is_catchpoint (struct breakpoint *); 1444 1445 /* Shared helper function (MI and CLI) for creating and installing 1446 a shared object event catchpoint. */ 1447 extern void add_solib_catchpoint (char *arg, int is_load, int is_temp, 1448 int enabled); 1449 1450 /* Enable breakpoints and delete when hit. Called with ARG == NULL 1451 deletes all breakpoints. */ 1452 extern void delete_command (char *arg, int from_tty); 1453 1454 /* Manage a software single step breakpoint (or two). Insert may be 1455 called twice before remove is called. */ 1456 extern void insert_single_step_breakpoint (struct gdbarch *, 1457 struct address_space *, 1458 CORE_ADDR); 1459 extern int single_step_breakpoints_inserted (void); 1460 extern void remove_single_step_breakpoints (void); 1461 extern void cancel_single_step_breakpoints (void); 1462 1463 /* Manage manual breakpoints, separate from the normal chain of 1464 breakpoints. These functions are used in murky target-specific 1465 ways. Please do not add more uses! */ 1466 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *, 1467 struct address_space *, 1468 CORE_ADDR); 1469 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *); 1470 1471 /* Check if any hardware watchpoints have triggered, according to the 1472 target. */ 1473 int watchpoints_triggered (struct target_waitstatus *); 1474 1475 /* Helper for transparent breakpoint hiding for memory read and write 1476 routines. 1477 1478 Update one of READBUF or WRITEBUF with either the shadows 1479 (READBUF), or the breakpoint instructions (WRITEBUF) of inserted 1480 breakpoints at the memory range defined by MEMADDR and extending 1481 for LEN bytes. If writing, then WRITEBUF is a copy of WRITEBUF_ORG 1482 on entry.*/ 1483 extern void breakpoint_xfer_memory (gdb_byte *readbuf, gdb_byte *writebuf, 1484 const gdb_byte *writebuf_org, 1485 ULONGEST memaddr, LONGEST len); 1486 1487 extern int breakpoints_always_inserted_mode (void); 1488 1489 /* Called each time new event from target is processed. 1490 Retires previously deleted breakpoint locations that 1491 in our opinion won't ever trigger. */ 1492 extern void breakpoint_retire_moribund (void); 1493 1494 /* Set break condition of breakpoint B to EXP. */ 1495 extern void set_breakpoint_condition (struct breakpoint *b, char *exp, 1496 int from_tty); 1497 1498 /* Checks if we are catching syscalls or not. 1499 Returns 0 if not, greater than 0 if we are. */ 1500 extern int catch_syscall_enabled (void); 1501 1502 /* Checks if we are catching syscalls with the specific 1503 syscall_number. Used for "filtering" the catchpoints. 1504 Returns 0 if not, greater than 0 if we are. */ 1505 extern int catching_syscall_number (int syscall_number); 1506 1507 /* Return a tracepoint with the given number if found. */ 1508 extern struct tracepoint *get_tracepoint (int num); 1509 1510 extern struct tracepoint *get_tracepoint_by_number_on_target (int num); 1511 1512 /* Find a tracepoint by parsing a number in the supplied string. */ 1513 extern struct tracepoint * 1514 get_tracepoint_by_number (char **arg, 1515 struct get_number_or_range_state *state, 1516 int optional_p); 1517 1518 /* Return a vector of all tracepoints currently defined. The vector 1519 is newly allocated; the caller should free when done with it. */ 1520 extern VEC(breakpoint_p) *all_tracepoints (void); 1521 1522 extern int is_tracepoint (const struct breakpoint *b); 1523 1524 /* Return a vector of all static tracepoints defined at ADDR. The 1525 vector is newly allocated; the caller should free when done with 1526 it. */ 1527 extern VEC(breakpoint_p) *static_tracepoints_here (CORE_ADDR addr); 1528 1529 /* Function that can be passed to read_command_line to validate 1530 that each command is suitable for tracepoint command list. */ 1531 extern void check_tracepoint_command (char *line, void *closure); 1532 1533 /* Call at the start and end of an "rbreak" command to register 1534 breakpoint numbers for a later "commands" command. */ 1535 extern void start_rbreak_breakpoints (void); 1536 extern void end_rbreak_breakpoints (void); 1537 1538 /* Breakpoint iterator function. 1539 1540 Calls a callback function once for each breakpoint, so long as the 1541 callback function returns false. If the callback function returns 1542 true, the iteration will end and the current breakpoint will be 1543 returned. This can be useful for implementing a search for a 1544 breakpoint with arbitrary attributes, or for applying an operation 1545 to every breakpoint. */ 1546 extern struct breakpoint *iterate_over_breakpoints (int (*) (struct breakpoint *, 1547 void *), void *); 1548 1549 /* Nonzero if the specified PC cannot be a location where functions 1550 have been inlined. */ 1551 1552 extern int pc_at_non_inline_function (struct address_space *aspace, 1553 CORE_ADDR pc, 1554 const struct target_waitstatus *ws); 1555 1556 extern int user_breakpoint_p (struct breakpoint *); 1557 1558 /* Attempt to determine architecture of location identified by SAL. */ 1559 extern struct gdbarch *get_sal_arch (struct symtab_and_line sal); 1560 1561 extern void handle_solib_event (void); 1562 1563 extern void breakpoint_free_objfile (struct objfile *objfile); 1564 1565 #endif /* !defined (BREAKPOINT_H) */ 1566