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