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 Free Software Foundation, Inc. 4 5 This file is part of GDB. 6 7 This program is free software; you can redistribute it and/or modify 8 it under the terms of the GNU General Public License as published by 9 the Free Software Foundation; either version 3 of the License, or 10 (at your option) any later version. 11 12 This program is distributed in the hope that it will be useful, 13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 GNU General Public License for more details. 16 17 You should have received a copy of the GNU General Public License 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 19 20 #if !defined (BREAKPOINT_H) 21 #define BREAKPOINT_H 1 22 23 #include "frame.h" 24 #include "value.h" 25 #include "vec.h" 26 27 struct value; 28 struct block; 29 30 /* This is the maximum number of bytes a breakpoint instruction can take. 31 Feel free to increase it. It's just used in a few places to size 32 arrays that should be independent of the target architecture. */ 33 34 #define BREAKPOINT_MAX 16 35 36 37 /* Type of breakpoint. */ 38 /* FIXME In the future, we should fold all other breakpoint-like things into 39 here. This includes: 40 41 * single-step (for machines where we have to simulate single stepping) 42 (probably, though perhaps it is better for it to look as much as 43 possible like a single-step to wait_for_inferior). */ 44 45 enum bptype 46 { 47 bp_none = 0, /* Eventpoint has been deleted. */ 48 bp_breakpoint, /* Normal breakpoint */ 49 bp_hardware_breakpoint, /* Hardware assisted breakpoint */ 50 bp_until, /* used by until command */ 51 bp_finish, /* used by finish command */ 52 bp_watchpoint, /* Watchpoint */ 53 bp_hardware_watchpoint, /* Hardware assisted watchpoint */ 54 bp_read_watchpoint, /* read watchpoint, (hardware assisted) */ 55 bp_access_watchpoint, /* access watchpoint, (hardware assisted) */ 56 bp_longjmp, /* secret breakpoint to find longjmp() */ 57 bp_longjmp_resume, /* secret breakpoint to escape longjmp() */ 58 59 /* Used by wait_for_inferior for stepping over subroutine calls, for 60 stepping over signal handlers, and for skipping prologues. */ 61 bp_step_resume, 62 63 /* Used to detect when a watchpoint expression has gone out of 64 scope. These breakpoints are usually not visible to the user. 65 66 This breakpoint has some interesting properties: 67 68 1) There's always a 1:1 mapping between watchpoints 69 on local variables and watchpoint_scope breakpoints. 70 71 2) It automatically deletes itself and the watchpoint it's 72 associated with when hit. 73 74 3) It can never be disabled. */ 75 bp_watchpoint_scope, 76 77 /* The breakpoint at the end of a call dummy. */ 78 /* FIXME: What if the function we are calling longjmp()s out of the 79 call, or the user gets out with the "return" command? We currently 80 have no way of cleaning up the breakpoint in these (obscure) situations. 81 (Probably can solve this by noticing longjmp, "return", etc., it's 82 similar to noticing when a watchpoint on a local variable goes out 83 of scope (with hardware support for watchpoints)). */ 84 bp_call_dummy, 85 86 /* Some dynamic linkers (HP, maybe Solaris) can arrange for special 87 code in the inferior to run when significant events occur in the 88 dynamic linker (for example a library is loaded or unloaded). 89 90 By placing a breakpoint in this magic code GDB will get control 91 when these significant events occur. GDB can then re-examine 92 the dynamic linker's data structures to discover any newly loaded 93 dynamic libraries. */ 94 bp_shlib_event, 95 96 /* Some multi-threaded systems can arrange for a location in the 97 inferior to be executed when certain thread-related events occur 98 (such as thread creation or thread death). 99 100 By placing a breakpoint at one of these locations, GDB will get 101 control when these events occur. GDB can then update its thread 102 lists etc. */ 103 104 bp_thread_event, 105 106 /* On the same principal, an overlay manager can arrange to call a 107 magic location in the inferior whenever there is an interesting 108 change in overlay status. GDB can update its overlay tables 109 and fiddle with breakpoints in overlays when this breakpoint 110 is hit. */ 111 112 bp_overlay_event, 113 114 /* Master copies of longjmp breakpoints. These are always installed 115 as soon as an objfile containing longjmp is loaded, but they are 116 always disabled. While necessary, temporary clones of bp_longjmp 117 type will be created and enabled. */ 118 119 bp_longjmp_master, 120 121 bp_catchpoint, 122 123 bp_tracepoint, 124 125 /* Event for JIT compiled code generation or deletion. */ 126 bp_jit_event, 127 }; 128 129 /* States of enablement of breakpoint. */ 130 131 enum enable_state 132 { 133 bp_disabled, /* The eventpoint is inactive, and cannot trigger. */ 134 bp_enabled, /* The eventpoint is active, and can trigger. */ 135 bp_call_disabled, /* The eventpoint has been disabled while a call 136 into the inferior is "in flight", because some 137 eventpoints interfere with the implementation of 138 a call on some targets. The eventpoint will be 139 automatically enabled and reset when the call 140 "lands" (either completes, or stops at another 141 eventpoint). */ 142 bp_startup_disabled,/* The eventpoint has been disabled during inferior 143 startup. This is necessary on some targets where 144 the main executable will get relocated during 145 startup, making breakpoint addresses invalid. 146 The eventpoint will be automatically enabled and 147 reset once inferior startup is complete. */ 148 bp_permanent /* There is a breakpoint instruction hard-wired into 149 the target's code. Don't try to write another 150 breakpoint instruction on top of it, or restore 151 its value. Step over it using the architecture's 152 SKIP_INSN macro. */ 153 }; 154 155 156 /* Disposition of breakpoint. Ie: what to do after hitting it. */ 157 158 enum bpdisp 159 { 160 disp_del, /* Delete it */ 161 disp_del_at_next_stop, /* Delete at next stop, whether hit or not */ 162 disp_disable, /* Disable it */ 163 disp_donttouch /* Leave it alone */ 164 }; 165 166 enum target_hw_bp_type 167 { 168 hw_write = 0, /* Common HW watchpoint */ 169 hw_read = 1, /* Read HW watchpoint */ 170 hw_access = 2, /* Access HW watchpoint */ 171 hw_execute = 3 /* Execute HW breakpoint */ 172 }; 173 174 175 /* Information used by targets to insert and remove breakpoints. */ 176 177 struct bp_target_info 178 { 179 /* Address at which the breakpoint was placed. This is normally the 180 same as ADDRESS from the bp_location, except when adjustment 181 happens in gdbarch_breakpoint_from_pc. The most common form of 182 adjustment is stripping an alternate ISA marker from the PC which 183 is used to determine the type of breakpoint to insert. */ 184 CORE_ADDR placed_address; 185 186 /* If the breakpoint lives in memory and reading that memory would 187 give back the breakpoint, instead of the original contents, then 188 the original contents are cached here. Only SHADOW_LEN bytes of 189 this buffer are valid, and only when the breakpoint is inserted. */ 190 gdb_byte shadow_contents[BREAKPOINT_MAX]; 191 192 /* The length of the data cached in SHADOW_CONTENTS. */ 193 int shadow_len; 194 195 /* The size of the placed breakpoint, according to 196 gdbarch_breakpoint_from_pc, when the breakpoint was inserted. This is 197 generally the same as SHADOW_LEN, unless we did not need 198 to read from the target to implement the memory breakpoint 199 (e.g. if a remote stub handled the details). We may still 200 need the size to remove the breakpoint safely. */ 201 int placed_size; 202 }; 203 204 /* GDB maintains two types of information about each breakpoint (or 205 watchpoint, or other related event). The first type corresponds 206 to struct breakpoint; this is a relatively high-level structure 207 which contains the source location(s), stopping conditions, user 208 commands to execute when the breakpoint is hit, and so forth. 209 210 The second type of information corresponds to struct bp_location. 211 Each breakpoint has one or (eventually) more locations associated 212 with it, which represent target-specific and machine-specific 213 mechanisms for stopping the program. For instance, a watchpoint 214 expression may require multiple hardware watchpoints in order to 215 catch all changes in the value of the expression being watched. */ 216 217 enum bp_loc_type 218 { 219 bp_loc_software_breakpoint, 220 bp_loc_hardware_breakpoint, 221 bp_loc_hardware_watchpoint, 222 bp_loc_other /* Miscellaneous... */ 223 }; 224 225 struct bp_location 226 { 227 /* Chain pointer to the next breakpoint location for 228 the same parent breakpoint. */ 229 struct bp_location *next; 230 231 /* Pointer to the next breakpoint location, in a global 232 list of all breakpoint locations. */ 233 struct bp_location *global_next; 234 235 /* Type of this breakpoint location. */ 236 enum bp_loc_type loc_type; 237 238 /* Each breakpoint location must belong to exactly one higher-level 239 breakpoint. This and the DUPLICATE flag are more straightforward 240 than reference counting. */ 241 struct breakpoint *owner; 242 243 /* Conditional. Break only if this expression's value is nonzero. 244 Unlike string form of condition, which is associated with breakpoint, 245 this is associated with location, since if breakpoint has several 246 locations, the evaluation of expression can be different for 247 different locations. */ 248 struct expression *cond; 249 250 /* This location's address is in an unloaded solib, and so this 251 location should not be inserted. It will be automatically 252 enabled when that solib is loaded. */ 253 char shlib_disabled; 254 255 /* Is this particular location enabled. */ 256 char enabled; 257 258 /* Nonzero if this breakpoint is now inserted. */ 259 char inserted; 260 261 /* Nonzero if this is not the first breakpoint in the list 262 for the given address. */ 263 char duplicate; 264 265 /* If we someday support real thread-specific breakpoints, then 266 the breakpoint location will need a thread identifier. */ 267 268 /* Data for specific breakpoint types. These could be a union, but 269 simplicity is more important than memory usage for breakpoints. */ 270 271 /* Architecture associated with this location's address. May be 272 different from the breakpoint architecture. */ 273 struct gdbarch *gdbarch; 274 275 /* Note that zero is a perfectly valid code address on some platforms 276 (for example, the mn10200 (OBSOLETE) and mn10300 simulators). NULL 277 is not a special value for this field. Valid for all types except 278 bp_loc_other. */ 279 CORE_ADDR address; 280 281 /* For hardware watchpoints, the size of data ad ADDRESS being watches. */ 282 int length; 283 284 /* Type of hardware watchpoint. */ 285 enum target_hw_bp_type watchpoint_type; 286 287 /* For any breakpoint type with an address, this is the section 288 associated with the address. Used primarily for overlay debugging. */ 289 struct obj_section *section; 290 291 /* Address at which breakpoint was requested, either by the user or 292 by GDB for internal breakpoints. This will usually be the same 293 as ``address'' (above) except for cases in which 294 ADJUST_BREAKPOINT_ADDRESS has computed a different address at 295 which to place the breakpoint in order to comply with a 296 processor's architectual constraints. */ 297 CORE_ADDR requested_address; 298 299 char *function_name; 300 301 /* Details of the placed breakpoint, when inserted. */ 302 struct bp_target_info target_info; 303 304 /* Similarly, for the breakpoint at an overlay's LMA, if necessary. */ 305 struct bp_target_info overlay_target_info; 306 307 /* In a non-stop mode, it's possible that we delete a breakpoint, 308 but as we do that, some still running thread hits that breakpoint. 309 For that reason, we need to keep locations belonging to deleted 310 breakpoints for a bit, so that don't report unexpected SIGTRAP. 311 We can't keep such locations forever, so we use a heuristic -- 312 after we process certain number of inferior events since 313 breakpoint was deleted, we retire all locations of that breakpoint. 314 This variable keeps a number of events still to go, when 315 it becomes 0 this location is retired. */ 316 int events_till_retirement; 317 }; 318 319 /* This structure is a collection of function pointers that, if available, 320 will be called instead of the performing the default action for this 321 bptype. */ 322 323 struct breakpoint_ops 324 { 325 /* Insert the breakpoint or activate the catchpoint. Should raise 326 an exception if the operation failed. */ 327 void (*insert) (struct breakpoint *); 328 329 /* Remove the breakpoint/catchpoint that was previously inserted 330 with the "insert" method above. Return non-zero if the operation 331 succeeded. */ 332 int (*remove) (struct breakpoint *); 333 334 /* Return non-zero if the debugger should tell the user that this 335 breakpoint was hit. */ 336 int (*breakpoint_hit) (struct breakpoint *); 337 338 /* The normal print routine for this breakpoint, called when we 339 hit it. */ 340 enum print_stop_action (*print_it) (struct breakpoint *); 341 342 /* Display information about this breakpoint, for "info breakpoints". */ 343 void (*print_one) (struct breakpoint *, struct bp_location **); 344 345 /* Display information about this breakpoint after setting it (roughly 346 speaking; this is called from "mention"). */ 347 void (*print_mention) (struct breakpoint *); 348 }; 349 350 enum watchpoint_triggered 351 { 352 /* This watchpoint definitely did not trigger. */ 353 watch_triggered_no = 0, 354 355 /* Some hardware watchpoint triggered, and it might have been this 356 one, but we do not know which it was. */ 357 watch_triggered_unknown, 358 359 /* This hardware watchpoint definitely did trigger. */ 360 watch_triggered_yes 361 }; 362 363 /* This is used to declare the VEC syscalls_to_be_caught. */ 364 DEF_VEC_I(int); 365 366 typedef struct bp_location *bp_location_p; 367 DEF_VEC_P(bp_location_p); 368 369 /* Note that the ->silent field is not currently used by any commands 370 (though the code is in there if it was to be, and set_raw_breakpoint 371 does set it to 0). I implemented it because I thought it would be 372 useful for a hack I had to put in; I'm going to leave it in because 373 I can see how there might be times when it would indeed be useful */ 374 375 /* This is for a breakpoint or a watchpoint. */ 376 377 struct breakpoint 378 { 379 struct breakpoint *next; 380 /* Type of breakpoint. */ 381 enum bptype type; 382 /* Zero means disabled; remember the info but don't break here. */ 383 enum enable_state enable_state; 384 /* What to do with this breakpoint after we hit it. */ 385 enum bpdisp disposition; 386 /* Number assigned to distinguish breakpoints. */ 387 int number; 388 389 /* Location(s) associated with this high-level breakpoint. */ 390 struct bp_location *loc; 391 392 /* Line number of this address. */ 393 394 int line_number; 395 396 /* Source file name of this address. */ 397 398 char *source_file; 399 400 /* Non-zero means a silent breakpoint (don't print frame info 401 if we stop here). */ 402 unsigned char silent; 403 /* Number of stops at this breakpoint that should 404 be continued automatically before really stopping. */ 405 int ignore_count; 406 /* Chain of command lines to execute when this breakpoint is hit. */ 407 struct command_line *commands; 408 /* Stack depth (address of frame). If nonzero, break only if fp 409 equals this. */ 410 struct frame_id frame_id; 411 412 /* String we used to set the breakpoint (malloc'd). */ 413 char *addr_string; 414 /* Architecture we used to set the breakpoint. */ 415 struct gdbarch *gdbarch; 416 /* Language we used to set the breakpoint. */ 417 enum language language; 418 /* Input radix we used to set the breakpoint. */ 419 int input_radix; 420 /* String form of the breakpoint condition (malloc'd), or NULL if there 421 is no condition. */ 422 char *cond_string; 423 /* String form of exp (malloc'd), or NULL if none. */ 424 char *exp_string; 425 426 /* The expression we are watching, or NULL if not a watchpoint. */ 427 struct expression *exp; 428 /* The largest block within which it is valid, or NULL if it is 429 valid anywhere (e.g. consists just of global symbols). */ 430 struct block *exp_valid_block; 431 /* Value of the watchpoint the last time we checked it, or NULL 432 when we do not know the value yet or the value was not 433 readable. VAL is never lazy. */ 434 struct value *val; 435 /* Nonzero if VAL is valid. If VAL_VALID is set but VAL is NULL, 436 then an error occurred reading the value. */ 437 int val_valid; 438 439 /* Holds the address of the related watchpoint_scope breakpoint 440 when using watchpoints on local variables (might the concept 441 of a related breakpoint be useful elsewhere, if not just call 442 it the watchpoint_scope breakpoint or something like that. FIXME). */ 443 struct breakpoint *related_breakpoint; 444 445 /* Holds the frame address which identifies the frame this 446 watchpoint should be evaluated in, or `null' if the watchpoint 447 should be evaluated on the outermost frame. */ 448 struct frame_id watchpoint_frame; 449 450 /* For hardware watchpoints, the triggered status according to the 451 hardware. */ 452 enum watchpoint_triggered watchpoint_triggered; 453 454 /* Thread number for thread-specific breakpoint, or -1 if don't care. */ 455 int thread; 456 457 /* Ada task number for task-specific breakpoint, or 0 if don't care. */ 458 int task; 459 460 /* Count of the number of times this breakpoint was taken, dumped 461 with the info, but not used for anything else. Useful for 462 seeing how many times you hit a break prior to the program 463 aborting, so you can back up to just before the abort. */ 464 int hit_count; 465 466 /* Process id of a child process whose forking triggered this 467 catchpoint. This field is only valid immediately after this 468 catchpoint has triggered. */ 469 ptid_t forked_inferior_pid; 470 471 /* Filename of a program whose exec triggered this catchpoint. 472 This field is only valid immediately after this catchpoint has 473 triggered. */ 474 char *exec_pathname; 475 476 /* Syscall numbers used for the 'catch syscall' feature. 477 If no syscall has been specified for filtering, its value is NULL. 478 Otherwise, it holds a list of all syscalls to be caught. 479 The list elements are allocated with xmalloc. */ 480 VEC(int) *syscalls_to_be_caught; 481 482 /* Methods associated with this breakpoint. */ 483 struct breakpoint_ops *ops; 484 485 /* Is breakpoint's condition not yet parsed because we found 486 no location initially so had no context to parse 487 the condition in. */ 488 int condition_not_parsed; 489 490 /* Number of times this tracepoint should single-step 491 and collect additional data. */ 492 long step_count; 493 494 /* Number of times this tracepoint should be hit before 495 disabling/ending. */ 496 int pass_count; 497 498 /* Chain of action lines to execute when this tracepoint is hit. */ 499 struct action_line *actions; 500 }; 501 502 typedef struct breakpoint *breakpoint_p; 503 DEF_VEC_P(breakpoint_p); 504 505 /* The following stuff is an abstract data type "bpstat" ("breakpoint 506 status"). This provides the ability to determine whether we have 507 stopped at a breakpoint, and what we should do about it. */ 508 509 typedef struct bpstats *bpstat; 510 511 /* Frees any storage that is part of a bpstat. 512 Does not walk the 'next' chain. */ 513 extern void bpstat_free (bpstat); 514 515 /* Clears a chain of bpstat, freeing storage 516 of each. */ 517 extern void bpstat_clear (bpstat *); 518 519 /* Return a copy of a bpstat. Like "bs1 = bs2" but all storage that 520 is part of the bpstat is copied as well. */ 521 extern bpstat bpstat_copy (bpstat); 522 523 extern bpstat bpstat_stop_status (CORE_ADDR pc, ptid_t ptid); 524 525 /* This bpstat_what stuff tells wait_for_inferior what to do with a 526 breakpoint (a challenging task). */ 527 528 enum bpstat_what_main_action 529 { 530 /* Perform various other tests; that is, this bpstat does not 531 say to perform any action (e.g. failed watchpoint and nothing 532 else). */ 533 BPSTAT_WHAT_KEEP_CHECKING, 534 535 /* Rather than distinguish between noisy and silent stops here, it 536 might be cleaner to have bpstat_print make that decision (also 537 taking into account stop_print_frame and source_only). But the 538 implications are a bit scary (interaction with auto-displays, etc.), 539 so I won't try it. */ 540 541 /* Stop silently. */ 542 BPSTAT_WHAT_STOP_SILENT, 543 544 /* Stop and print. */ 545 BPSTAT_WHAT_STOP_NOISY, 546 547 /* Remove breakpoints, single step once, then put them back in and 548 go back to what we were doing. It's possible that this should be 549 removed from the main_action and put into a separate field, to more 550 cleanly handle BPSTAT_WHAT_CLEAR_LONGJMP_RESUME_SINGLE. */ 551 BPSTAT_WHAT_SINGLE, 552 553 /* Set longjmp_resume breakpoint, remove all other breakpoints, 554 and continue. The "remove all other breakpoints" part is required 555 if we are also stepping over another breakpoint as well as doing 556 the longjmp handling. */ 557 BPSTAT_WHAT_SET_LONGJMP_RESUME, 558 559 /* Clear longjmp_resume breakpoint, then handle as 560 BPSTAT_WHAT_KEEP_CHECKING. */ 561 BPSTAT_WHAT_CLEAR_LONGJMP_RESUME, 562 563 /* Clear step resume breakpoint, and keep checking. */ 564 BPSTAT_WHAT_STEP_RESUME, 565 566 /* Check the dynamic linker's data structures for new libraries, then 567 keep checking. */ 568 BPSTAT_WHAT_CHECK_SHLIBS, 569 570 /* Check for new JITed code. */ 571 BPSTAT_WHAT_CHECK_JIT, 572 573 /* This is just used to keep track of how many enums there are. */ 574 BPSTAT_WHAT_LAST 575 }; 576 577 struct bpstat_what 578 { 579 enum bpstat_what_main_action main_action; 580 581 /* Did we hit a call dummy breakpoint? This only goes with a main_action 582 of BPSTAT_WHAT_STOP_SILENT or BPSTAT_WHAT_STOP_NOISY (the concept of 583 continuing from a call dummy without popping the frame is not a 584 useful one). */ 585 int call_dummy; 586 }; 587 588 /* The possible return values for print_bpstat, print_it_normal, 589 print_it_done, print_it_noop. */ 590 enum print_stop_action 591 { 592 PRINT_UNKNOWN = -1, 593 PRINT_SRC_AND_LOC, 594 PRINT_SRC_ONLY, 595 PRINT_NOTHING 596 }; 597 598 /* Tell what to do about this bpstat. */ 599 struct bpstat_what bpstat_what (bpstat); 600 601 /* Find the bpstat associated with a breakpoint. NULL otherwise. */ 602 bpstat bpstat_find_breakpoint (bpstat, struct breakpoint *); 603 604 /* Find a step_resume breakpoint associated with this bpstat. 605 (If there are multiple step_resume bp's on the list, this function 606 will arbitrarily pick one.) 607 608 It is an error to use this function if BPSTAT doesn't contain a 609 step_resume breakpoint. 610 611 See wait_for_inferior's use of this function. 612 */ 613 extern struct breakpoint *bpstat_find_step_resume_breakpoint (bpstat); 614 615 /* Nonzero if a signal that we got in wait() was due to circumstances 616 explained by the BS. */ 617 /* Currently that is true if we have hit a breakpoint, or if there is 618 a watchpoint enabled. */ 619 #define bpstat_explains_signal(bs) ((bs) != NULL) 620 621 /* Nonzero if we should step constantly (e.g. watchpoints on machines 622 without hardware support). This isn't related to a specific bpstat, 623 just to things like whether watchpoints are set. */ 624 extern int bpstat_should_step (void); 625 626 /* Print a message indicating what happened. Returns nonzero to 627 say that only the source line should be printed after this (zero 628 return means print the frame as well as the source line). */ 629 extern enum print_stop_action bpstat_print (bpstat); 630 631 /* Put in *NUM the breakpoint number of the first breakpoint we are stopped 632 at. *BSP upon return is a bpstat which points to the remaining 633 breakpoints stopped at (but which is not guaranteed to be good for 634 anything but further calls to bpstat_num). 635 Return 0 if passed a bpstat which does not indicate any breakpoints. 636 Return -1 if stopped at a breakpoint that has been deleted since 637 we set it. 638 Return 1 otherwise. */ 639 extern int bpstat_num (bpstat *, int *); 640 641 /* Perform actions associated with the stopped inferior. Actually, we 642 just use this for breakpoint commands. Perhaps other actions will 643 go here later, but this is executed at a late time (from the 644 command loop). */ 645 extern void bpstat_do_actions (void); 646 647 /* Modify BS so that the actions will not be performed. */ 648 extern void bpstat_clear_actions (bpstat); 649 650 /* Implementation: */ 651 652 /* Values used to tell the printing routine how to behave for this bpstat. */ 653 enum bp_print_how 654 { 655 /* This is used when we want to do a normal printing of the reason 656 for stopping. The output will depend on the type of eventpoint 657 we are dealing with. This is the default value, most commonly 658 used. */ 659 print_it_normal, 660 /* This is used when nothing should be printed for this bpstat entry. */ 661 print_it_noop, 662 /* This is used when everything which needs to be printed has 663 already been printed. But we still want to print the frame. */ 664 print_it_done 665 }; 666 667 struct bpstats 668 { 669 /* Linked list because there can be two breakpoints at the same 670 place, and a bpstat reflects the fact that both have been hit. */ 671 bpstat next; 672 /* Breakpoint that we are at. */ 673 const struct bp_location *breakpoint_at; 674 /* Commands left to be done. */ 675 struct command_line *commands; 676 /* Old value associated with a watchpoint. */ 677 struct value *old_val; 678 679 /* Nonzero if this breakpoint tells us to print the frame. */ 680 char print; 681 682 /* Nonzero if this breakpoint tells us to stop. */ 683 char stop; 684 685 /* Tell bpstat_print and print_bp_stop_message how to print stuff 686 associated with this element of the bpstat chain. */ 687 enum bp_print_how print_it; 688 }; 689 690 enum inf_context 691 { 692 inf_starting, 693 inf_running, 694 inf_exited, 695 inf_execd 696 }; 697 698 /* The possible return values for breakpoint_here_p. 699 We guarantee that zero always means "no breakpoint here". */ 700 enum breakpoint_here 701 { 702 no_breakpoint_here = 0, 703 ordinary_breakpoint_here, 704 permanent_breakpoint_here 705 }; 706 707 708 /* Prototypes for breakpoint-related functions. */ 709 710 extern enum breakpoint_here breakpoint_here_p (CORE_ADDR); 711 712 extern int moribund_breakpoint_here_p (CORE_ADDR); 713 714 extern int breakpoint_inserted_here_p (CORE_ADDR); 715 716 extern int regular_breakpoint_inserted_here_p (CORE_ADDR); 717 718 extern int software_breakpoint_inserted_here_p (CORE_ADDR); 719 720 extern int breakpoint_thread_match (CORE_ADDR, ptid_t); 721 722 extern void until_break_command (char *, int, int); 723 724 extern void breakpoint_re_set (void); 725 726 extern void breakpoint_re_set_thread (struct breakpoint *); 727 728 extern struct breakpoint *set_momentary_breakpoint 729 (struct gdbarch *, struct symtab_and_line, struct frame_id, enum bptype); 730 731 extern struct breakpoint *set_momentary_breakpoint_at_pc 732 (struct gdbarch *, CORE_ADDR pc, enum bptype type); 733 734 extern struct breakpoint *clone_momentary_breakpoint (struct breakpoint *bpkt); 735 736 extern void set_ignore_count (int, int, int); 737 738 extern void set_default_breakpoint (int, CORE_ADDR, struct symtab *, int); 739 740 extern void breakpoint_init_inferior (enum inf_context); 741 742 extern struct cleanup *make_cleanup_delete_breakpoint (struct breakpoint *); 743 744 extern void delete_breakpoint (struct breakpoint *); 745 746 extern void breakpoint_auto_delete (bpstat); 747 748 extern void break_command (char *, int); 749 750 extern void hbreak_command_wrapper (char *, int); 751 extern void thbreak_command_wrapper (char *, int); 752 extern void rbreak_command_wrapper (char *, int); 753 extern void watch_command_wrapper (char *, int); 754 extern void awatch_command_wrapper (char *, int); 755 extern void rwatch_command_wrapper (char *, int); 756 extern void tbreak_command (char *, int); 757 758 extern void set_breakpoint (struct gdbarch *gdbarch, 759 char *address, char *condition, 760 int hardwareflag, int tempflag, 761 int thread, int ignore_count, 762 int pending, 763 int enabled); 764 765 extern void insert_breakpoints (void); 766 767 extern int remove_breakpoints (void); 768 769 /* This function can be used to physically insert eventpoints from the 770 specified traced inferior process, without modifying the breakpoint 771 package's state. This can be useful for those targets which support 772 following the processes of a fork() or vfork() system call, when both 773 of the resulting two processes are to be followed. */ 774 extern int reattach_breakpoints (int); 775 776 /* This function can be used to update the breakpoint package's state 777 after an exec() system call has been executed. 778 779 This function causes the following: 780 781 - All eventpoints are marked "not inserted". 782 - All eventpoints with a symbolic address are reset such that 783 the symbolic address must be reevaluated before the eventpoints 784 can be reinserted. 785 - The solib breakpoints are explicitly removed from the breakpoint 786 list. 787 - A step-resume breakpoint, if any, is explicitly removed from the 788 breakpoint list. 789 - All eventpoints without a symbolic address are removed from the 790 breakpoint list. */ 791 extern void update_breakpoints_after_exec (void); 792 793 /* This function can be used to physically remove hardware breakpoints 794 and watchpoints from the specified traced inferior process, without 795 modifying the breakpoint package's state. This can be useful for 796 those targets which support following the processes of a fork() or 797 vfork() system call, when one of the resulting two processes is to 798 be detached and allowed to run free. 799 800 It is an error to use this function on the process whose id is 801 inferior_ptid. */ 802 extern int detach_breakpoints (int); 803 804 extern void set_longjmp_breakpoint (int thread); 805 extern void delete_longjmp_breakpoint (int thread); 806 807 extern void enable_overlay_breakpoints (void); 808 extern void disable_overlay_breakpoints (void); 809 810 /* These functions respectively disable or reenable all currently 811 enabled watchpoints. When disabled, the watchpoints are marked 812 call_disabled. When reenabled, they are marked enabled. 813 814 The intended client of these functions is call_function_by_hand. 815 816 The inferior must be stopped, and all breakpoints removed, when 817 these functions are used. 818 819 The need for these functions is that on some targets (e.g., HP-UX), 820 gdb is unable to unwind through the dummy frame that is pushed as 821 part of the implementation of a call command. Watchpoints can 822 cause the inferior to stop in places where this frame is visible, 823 and that can cause execution control to become very confused. 824 825 Note that if a user sets breakpoints in an interactively called 826 function, the call_disabled watchpoints will have been reenabled 827 when the first such breakpoint is reached. However, on targets 828 that are unable to unwind through the call dummy frame, watches 829 of stack-based storage may then be deleted, because gdb will 830 believe that their watched storage is out of scope. (Sigh.) */ 831 extern void disable_watchpoints_before_interactive_call_start (void); 832 833 extern void enable_watchpoints_after_interactive_call_stop (void); 834 835 /* These functions disable and re-enable all breakpoints during 836 inferior startup. They are intended to be called from solib 837 code where necessary. This is needed on platforms where the 838 main executable is relocated at some point during startup 839 processing, making breakpoint addresses invalid. 840 841 If additional breakpoints are created after the routine 842 disable_breakpoints_before_startup but before the routine 843 enable_breakpoints_after_startup was called, they will also 844 be marked as disabled. */ 845 extern void disable_breakpoints_before_startup (void); 846 extern void enable_breakpoints_after_startup (void); 847 848 /* For script interpreters that need to define breakpoint commands 849 after they've already read the commands into a struct command_line. */ 850 extern enum command_control_type commands_from_control_command 851 (char *arg, struct command_line *cmd); 852 853 extern void clear_breakpoint_hit_counts (void); 854 855 extern int get_number (char **); 856 857 extern int get_number_or_range (char **); 858 859 extern struct breakpoint *get_breakpoint (int num); 860 861 /* The following are for displays, which aren't really breakpoints, but 862 here is as good a place as any for them. */ 863 864 extern void disable_current_display (void); 865 866 extern void do_displays (void); 867 868 extern void disable_display (int); 869 870 extern void clear_displays (void); 871 872 extern void disable_breakpoint (struct breakpoint *); 873 874 extern void enable_breakpoint (struct breakpoint *); 875 876 extern void breakpoint_set_commands (struct breakpoint *b, 877 struct command_line *commands); 878 879 /* Clear the "inserted" flag in all breakpoints. */ 880 extern void mark_breakpoints_out (void); 881 882 extern void make_breakpoint_permanent (struct breakpoint *); 883 884 extern struct breakpoint *create_jit_event_breakpoint (struct gdbarch *, 885 CORE_ADDR); 886 887 extern struct breakpoint *create_solib_event_breakpoint (struct gdbarch *, 888 CORE_ADDR); 889 890 extern struct breakpoint *create_thread_event_breakpoint (struct gdbarch *, 891 CORE_ADDR); 892 893 extern void remove_solib_event_breakpoints (void); 894 895 extern void remove_thread_event_breakpoints (void); 896 897 extern void disable_breakpoints_in_shlibs (void); 898 899 /* This function returns TRUE if ep is a catchpoint. */ 900 extern int ep_is_catchpoint (struct breakpoint *); 901 902 /* Enable breakpoints and delete when hit. Called with ARG == NULL 903 deletes all breakpoints. */ 904 extern void delete_command (char *arg, int from_tty); 905 906 /* Pull all H/W watchpoints from the target. Return non-zero if the 907 remove fails. */ 908 extern int remove_hw_watchpoints (void); 909 910 /* Manage a software single step breakpoint (or two). Insert may be called 911 twice before remove is called. */ 912 extern void insert_single_step_breakpoint (struct gdbarch *, CORE_ADDR); 913 extern void remove_single_step_breakpoints (void); 914 915 /* Manage manual breakpoints, separate from the normal chain of 916 breakpoints. These functions are used in murky target-specific 917 ways. Please do not add more uses! */ 918 extern void *deprecated_insert_raw_breakpoint (struct gdbarch *, CORE_ADDR); 919 extern int deprecated_remove_raw_breakpoint (struct gdbarch *, void *); 920 921 /* Check if any hardware watchpoints have triggered, according to the 922 target. */ 923 int watchpoints_triggered (struct target_waitstatus *); 924 925 /* Update BUF, which is LEN bytes read from the target address MEMADDR, 926 by replacing any memory breakpoints with their shadowed contents. */ 927 void breakpoint_restore_shadows (gdb_byte *buf, ULONGEST memaddr, 928 LONGEST len); 929 930 extern int breakpoints_always_inserted_mode (void); 931 932 /* Called each time new event from target is processed. 933 Retires previously deleted breakpoint locations that 934 in our opinion won't ever trigger. */ 935 extern void breakpoint_retire_moribund (void); 936 937 /* Checks if we are catching syscalls or not. 938 Returns 0 if not, greater than 0 if we are. */ 939 extern int catch_syscall_enabled (void); 940 941 /* Checks if we are catching syscalls with the specific 942 syscall_number. Used for "filtering" the catchpoints. 943 Returns 0 if not, greater than 0 if we are. */ 944 extern int catching_syscall_number (int syscall_number); 945 946 /* Tell a breakpoint to be quiet. */ 947 extern void make_breakpoint_silent (struct breakpoint *); 948 949 /* Return a tracepoint with the given number if found. */ 950 extern struct breakpoint *get_tracepoint (int num); 951 952 /* Find a tracepoint by parsing a number in the supplied string. */ 953 extern struct breakpoint *get_tracepoint_by_number (char **arg, int multi_p, 954 int optional_p); 955 956 /* Return a vector of all tracepoints currently defined. The vector 957 is newly allocated; the caller should free when done with it. */ 958 extern VEC(breakpoint_p) *all_tracepoints (void); 959 960 #endif /* !defined (BREAKPOINT_H) */ 961