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