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