1 /* Scheme interface to breakpoints.
3 Copyright (C) 2008-2023 Free Software Foundation, Inc.
5 This file is part of GDB.
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.
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.
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/>. */
20 /* See README file in this directory for implementation notes, coding
21 conventions, et.al. */
25 #include "breakpoint.h"
27 #include "gdbthread.h"
28 #include "observable.h"
29 #include "cli/cli-script.h"
31 #include "arch-utils.h"
33 #include "guile-internal.h"
36 /* The <gdb:breakpoint> smob.
37 N.B.: The name of this struct is known to breakpoint.h.
39 Note: Breakpoints are added to gdb using a two step process:
40 1) Call make-breakpoint to create a <gdb:breakpoint> object.
41 2) Call register-breakpoint! to add the breakpoint to gdb.
42 It is done this way so that the constructor, make-breakpoint, doesn't have
43 any side-effects. This means that the smob needs to store everything
44 that was passed to make-breakpoint. */
46 typedef struct gdbscm_breakpoint_object
48 /* This always appears first. */
51 /* Non-zero if this breakpoint was created with make-breakpoint. */
54 /* For breakpoints created with make-breakpoint, these are the parameters
55 that were passed to make-breakpoint. These values are not used except
56 to register the breakpoint with GDB. */
59 /* The string representation of the breakpoint.
60 Space for this lives in GC space. */
63 /* The kind of breakpoint.
64 At the moment this can only be one of bp_breakpoint, bp_watchpoint. */
67 /* If a watchpoint, the kind of watchpoint. */
68 enum target_hw_bp_type access_type
;
70 /* Non-zero if the breakpoint is an "internal" breakpoint. */
73 /* Non-zero if the breakpoint is temporary. */
77 /* The breakpoint number according to gdb.
78 For breakpoints created from Scheme, this has the value -1 until the
79 breakpoint is registered with gdb.
80 This is recorded here because BP will be NULL when deleted. */
83 /* The gdb breakpoint object, or NULL if the breakpoint has not been
84 registered yet, or has been deleted. */
85 struct breakpoint
*bp
;
87 /* Backlink to our containing <gdb:breakpoint> smob.
88 This is needed when we are deleted, we need to unprotect the object
92 /* A stop condition or #f. */
96 static const char breakpoint_smob_name
[] = "gdb:breakpoint";
98 /* The tag Guile knows the breakpoint smob by. */
99 static scm_t_bits breakpoint_smob_tag
;
101 /* Variables used to pass information between the breakpoint_smob
102 constructor and the breakpoint-created hook function. */
103 static SCM pending_breakpoint_scm
= SCM_BOOL_F
;
105 /* Keywords used by create-breakpoint!. */
106 static SCM type_keyword
;
107 static SCM wp_class_keyword
;
108 static SCM internal_keyword
;
109 static SCM temporary_keyword
;
111 /* Administrivia for breakpoint smobs. */
113 /* The smob "free" function for <gdb:breakpoint>. */
116 bpscm_free_breakpoint_smob (SCM self
)
118 breakpoint_smob
*bp_smob
= (breakpoint_smob
*) SCM_SMOB_DATA (self
);
121 bp_smob
->bp
->scm_bp_object
= NULL
;
123 /* Not necessary, done to catch bugs. */
125 bp_smob
->containing_scm
= SCM_UNDEFINED
;
126 bp_smob
->stop
= SCM_UNDEFINED
;
131 /* Return the name of TYPE.
132 This doesn't handle all types, just the ones we export. */
135 bpscm_type_to_string (enum bptype type
)
139 case bp_none
: return "BP_NONE";
140 case bp_breakpoint
: return "BP_BREAKPOINT";
141 case bp_watchpoint
: return "BP_WATCHPOINT";
142 case bp_hardware_watchpoint
: return "BP_HARDWARE_WATCHPOINT";
143 case bp_read_watchpoint
: return "BP_READ_WATCHPOINT";
144 case bp_access_watchpoint
: return "BP_ACCESS_WATCHPOINT";
145 case bp_catchpoint
: return "BP_CATCHPOINT";
146 default: return "internal/other";
150 /* Return the name of ENABLE_STATE. */
153 bpscm_enable_state_to_string (enum enable_state enable_state
)
155 switch (enable_state
)
157 case bp_disabled
: return "disabled";
158 case bp_enabled
: return "enabled";
159 case bp_call_disabled
: return "call_disabled";
160 default: return "unknown";
164 /* The smob "print" function for <gdb:breakpoint>. */
167 bpscm_print_breakpoint_smob (SCM self
, SCM port
, scm_print_state
*pstate
)
169 breakpoint_smob
*bp_smob
= (breakpoint_smob
*) SCM_SMOB_DATA (self
);
170 struct breakpoint
*b
= bp_smob
->bp
;
172 gdbscm_printf (port
, "#<%s", breakpoint_smob_name
);
174 /* Only print what we export to the user.
175 The rest are possibly internal implementation details. */
177 gdbscm_printf (port
, " #%d", bp_smob
->number
);
179 /* Careful, the breakpoint may be invalid. */
182 gdbscm_printf (port
, " %s %s %s",
183 bpscm_type_to_string (b
->type
),
184 bpscm_enable_state_to_string (b
->enable_state
),
185 b
->silent
? "silent" : "noisy");
187 gdbscm_printf (port
, " hit:%d", b
->hit_count
);
188 gdbscm_printf (port
, " ignore:%d", b
->ignore_count
);
190 if (b
->locspec
!= nullptr)
192 const char *str
= b
->locspec
->to_string ();
194 gdbscm_printf (port
, " @%s", str
);
198 scm_puts (">", port
);
200 scm_remember_upto_here_1 (self
);
202 /* Non-zero means success. */
206 /* Low level routine to create a <gdb:breakpoint> object. */
209 bpscm_make_breakpoint_smob (void)
211 breakpoint_smob
*bp_smob
= (breakpoint_smob
*)
212 scm_gc_malloc (sizeof (breakpoint_smob
), breakpoint_smob_name
);
215 memset (bp_smob
, 0, sizeof (*bp_smob
));
216 bp_smob
->number
= -1;
217 bp_smob
->stop
= SCM_BOOL_F
;
218 bp_scm
= scm_new_smob (breakpoint_smob_tag
, (scm_t_bits
) bp_smob
);
219 bp_smob
->containing_scm
= bp_scm
;
220 gdbscm_init_gsmob (&bp_smob
->base
);
225 /* Return non-zero if we want a Scheme wrapper for breakpoint B.
226 If FROM_SCHEME is non-zero,this is called for a breakpoint created
227 by the user from Scheme. Otherwise it is zero. */
230 bpscm_want_scm_wrapper_p (struct breakpoint
*bp
, int from_scheme
)
232 /* Don't create <gdb:breakpoint> objects for internal GDB breakpoints. */
233 if (bp
->number
< 0 && !from_scheme
)
236 /* The others are not supported. */
237 if (bp
->type
!= bp_breakpoint
238 && bp
->type
!= bp_watchpoint
239 && bp
->type
!= bp_hardware_watchpoint
240 && bp
->type
!= bp_read_watchpoint
241 && bp
->type
!= bp_access_watchpoint
242 && bp
->type
!= bp_catchpoint
)
248 /* Install the Scheme side of a breakpoint, CONTAINING_SCM, in
252 bpscm_attach_scm_to_breakpoint (struct breakpoint
*bp
, SCM containing_scm
)
254 breakpoint_smob
*bp_smob
;
256 bp_smob
= (breakpoint_smob
*) SCM_SMOB_DATA (containing_scm
);
257 bp_smob
->number
= bp
->number
;
259 bp_smob
->containing_scm
= containing_scm
;
260 bp_smob
->bp
->scm_bp_object
= bp_smob
;
262 /* The owner of this breakpoint is not in GC-controlled memory, so we need
263 to protect it from GC until the breakpoint is deleted. */
264 scm_gc_protect_object (containing_scm
);
267 /* Return non-zero if SCM is a breakpoint smob. */
270 bpscm_is_breakpoint (SCM scm
)
272 return SCM_SMOB_PREDICATE (breakpoint_smob_tag
, scm
);
275 /* (breakpoint? scm) -> boolean */
278 gdbscm_breakpoint_p (SCM scm
)
280 return scm_from_bool (bpscm_is_breakpoint (scm
));
283 /* Returns the <gdb:breakpoint> object in SELF.
284 Throws an exception if SELF is not a <gdb:breakpoint> object. */
287 bpscm_get_breakpoint_arg_unsafe (SCM self
, int arg_pos
, const char *func_name
)
289 SCM_ASSERT_TYPE (bpscm_is_breakpoint (self
), self
, arg_pos
, func_name
,
290 breakpoint_smob_name
);
295 /* Returns a pointer to the breakpoint smob of SELF.
296 Throws an exception if SELF is not a <gdb:breakpoint> object. */
298 static breakpoint_smob
*
299 bpscm_get_breakpoint_smob_arg_unsafe (SCM self
, int arg_pos
,
300 const char *func_name
)
302 SCM bp_scm
= bpscm_get_breakpoint_arg_unsafe (self
, arg_pos
, func_name
);
303 breakpoint_smob
*bp_smob
= (breakpoint_smob
*) SCM_SMOB_DATA (bp_scm
);
308 /* Return non-zero if breakpoint BP_SMOB is valid. */
311 bpscm_is_valid (breakpoint_smob
*bp_smob
)
313 return bp_smob
->bp
!= NULL
;
316 /* Returns the breakpoint smob in SELF, verifying it's valid.
317 Throws an exception if SELF is not a <gdb:breakpoint> object,
320 static breakpoint_smob
*
321 bpscm_get_valid_breakpoint_smob_arg_unsafe (SCM self
, int arg_pos
,
322 const char *func_name
)
324 breakpoint_smob
*bp_smob
325 = bpscm_get_breakpoint_smob_arg_unsafe (self
, arg_pos
, func_name
);
327 if (!bpscm_is_valid (bp_smob
))
329 gdbscm_invalid_object_error (func_name
, arg_pos
, self
,
330 _("<gdb:breakpoint>"));
336 /* Breakpoint methods. */
338 /* (make-breakpoint string [#:type integer] [#:wp-class integer]
339 [#:internal boolean] [#:temporary boolean]) -> <gdb:breakpoint>
341 The result is the <gdb:breakpoint> Scheme object.
342 The breakpoint is not available to be used yet, however.
343 It must still be added to gdb with register-breakpoint!. */
346 gdbscm_make_breakpoint (SCM location_scm
, SCM rest
)
348 const SCM keywords
[] = {
349 type_keyword
, wp_class_keyword
, internal_keyword
,
350 temporary_keyword
, SCM_BOOL_F
354 int type_arg_pos
= -1, access_type_arg_pos
= -1,
355 internal_arg_pos
= -1, temporary_arg_pos
= -1;
356 int type
= bp_breakpoint
;
357 int access_type
= hw_write
;
361 breakpoint_smob
*bp_smob
;
363 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG1
, keywords
, "s#iitt",
364 location_scm
, &location
, rest
,
365 &type_arg_pos
, &type
,
366 &access_type_arg_pos
, &access_type
,
367 &internal_arg_pos
, &internal
,
368 &temporary_arg_pos
, &temporary
);
370 result
= bpscm_make_breakpoint_smob ();
371 bp_smob
= (breakpoint_smob
*) SCM_SMOB_DATA (result
);
374 location
= gdbscm_gc_xstrdup (s
);
380 if (access_type_arg_pos
> 0)
382 gdbscm_misc_error (FUNC_NAME
, access_type_arg_pos
,
383 scm_from_int (access_type
),
384 _("access type with breakpoint is not allowed"));
395 gdbscm_out_of_range_error (FUNC_NAME
, access_type_arg_pos
,
396 scm_from_int (access_type
),
397 _("invalid watchpoint class"));
401 case bp_hardware_watchpoint
:
402 case bp_read_watchpoint
:
403 case bp_access_watchpoint
:
406 const char *type_name
= bpscm_type_to_string ((enum bptype
) type
);
407 gdbscm_misc_error (FUNC_NAME
, type_arg_pos
,
408 gdbscm_scm_from_c_string (type_name
),
409 _("unsupported breakpoint type"));
413 gdbscm_out_of_range_error (FUNC_NAME
, type_arg_pos
,
415 _("invalid breakpoint type"));
418 bp_smob
->is_scheme_bkpt
= 1;
419 bp_smob
->spec
.location
= location
;
420 bp_smob
->spec
.type
= (enum bptype
) type
;
421 bp_smob
->spec
.access_type
= (enum target_hw_bp_type
) access_type
;
422 bp_smob
->spec
.is_internal
= internal
;
423 bp_smob
->spec
.is_temporary
= temporary
;
428 /* (register-breakpoint! <gdb:breakpoint>) -> unspecified
430 It is an error to register a breakpoint created outside of Guile,
431 or an already-registered breakpoint. */
434 gdbscm_register_breakpoint_x (SCM self
)
436 breakpoint_smob
*bp_smob
437 = bpscm_get_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
438 gdbscm_gdb_exception except
{};
439 const char *location
, *copy
;
441 /* We only support registering breakpoints created with make-breakpoint. */
442 if (!bp_smob
->is_scheme_bkpt
)
443 scm_misc_error (FUNC_NAME
, _("not a Scheme breakpoint"), SCM_EOL
);
445 if (bpscm_is_valid (bp_smob
))
446 scm_misc_error (FUNC_NAME
, _("breakpoint is already registered"), SCM_EOL
);
448 pending_breakpoint_scm
= self
;
449 location
= bp_smob
->spec
.location
;
450 copy
= skip_spaces (location
);
451 location_spec_up locspec
452 = string_to_location_spec_basic (©
,
454 symbol_name_match_type::WILD
);
458 int internal
= bp_smob
->spec
.is_internal
;
459 int temporary
= bp_smob
->spec
.is_temporary
;
461 switch (bp_smob
->spec
.type
)
465 const breakpoint_ops
*ops
=
466 breakpoint_ops_for_location_spec (locspec
.get (), false);
467 create_breakpoint (get_current_arch (),
468 locspec
.get (), NULL
, -1, NULL
, false,
470 temporary
, bp_breakpoint
,
479 enum target_hw_bp_type access_type
= bp_smob
->spec
.access_type
;
481 if (access_type
== hw_write
)
482 watch_command_wrapper (location
, 0, internal
);
483 else if (access_type
== hw_access
)
484 awatch_command_wrapper (location
, 0, internal
);
485 else if (access_type
== hw_read
)
486 rwatch_command_wrapper (location
, 0, internal
);
488 gdb_assert_not_reached ("invalid access type");
492 gdb_assert_not_reached ("invalid breakpoint type");
495 catch (const gdb_exception
&ex
)
497 except
= unpack (ex
);
500 /* Ensure this gets reset, even if there's an error. */
501 pending_breakpoint_scm
= SCM_BOOL_F
;
502 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
504 return SCM_UNSPECIFIED
;
507 /* (delete-breakpoint! <gdb:breakpoint>) -> unspecified
508 Scheme function which deletes (removes) the underlying GDB breakpoint
509 from GDB's list of breakpoints. This triggers the breakpoint_deleted
510 observer which will call gdbscm_breakpoint_deleted; that function cleans
511 up the Scheme bits. */
514 gdbscm_delete_breakpoint_x (SCM self
)
516 breakpoint_smob
*bp_smob
517 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
519 gdbscm_gdb_exception exc
{};
522 delete_breakpoint (bp_smob
->bp
);
524 catch (const gdb_exception
&except
)
526 exc
= unpack (except
);
529 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
530 return SCM_UNSPECIFIED
;
533 /* iterate_over_breakpoints function for gdbscm_breakpoints. */
536 bpscm_build_bp_list (struct breakpoint
*bp
, SCM
*list
)
538 breakpoint_smob
*bp_smob
= bp
->scm_bp_object
;
540 /* Lazily create wrappers for breakpoints created outside Scheme. */
544 if (bpscm_want_scm_wrapper_p (bp
, 0))
548 bp_scm
= bpscm_make_breakpoint_smob ();
549 bpscm_attach_scm_to_breakpoint (bp
, bp_scm
);
551 bp_smob
= bp
->scm_bp_object
;
555 /* Not all breakpoints will have a companion Scheme object.
556 Only breakpoints that trigger the created_breakpoint observer call,
557 and satisfy certain conditions (see bpscm_want_scm_wrapper_p),
558 get a companion object (this includes Scheme-created breakpoints). */
561 *list
= scm_cons (bp_smob
->containing_scm
, *list
);
564 /* (breakpoints) -> list
565 Return a list of all breakpoints. */
568 gdbscm_breakpoints (void)
572 for (breakpoint
&bp
: all_breakpoints ())
573 bpscm_build_bp_list (&bp
, &list
);
575 return scm_reverse_x (list
, SCM_EOL
);
578 /* (breakpoint-valid? <gdb:breakpoint>) -> boolean
579 Returns #t if SELF is still valid. */
582 gdbscm_breakpoint_valid_p (SCM self
)
584 breakpoint_smob
*bp_smob
585 = bpscm_get_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
587 return scm_from_bool (bpscm_is_valid (bp_smob
));
590 /* (breakpoint-enabled? <gdb:breakpoint>) -> boolean */
593 gdbscm_breakpoint_enabled_p (SCM self
)
595 breakpoint_smob
*bp_smob
596 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
598 return scm_from_bool (bp_smob
->bp
->enable_state
== bp_enabled
);
601 /* (set-breakpoint-enabled? <gdb:breakpoint> boolean) -> unspecified */
604 gdbscm_set_breakpoint_enabled_x (SCM self
, SCM newvalue
)
606 breakpoint_smob
*bp_smob
607 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
609 SCM_ASSERT_TYPE (gdbscm_is_bool (newvalue
), newvalue
, SCM_ARG2
, FUNC_NAME
,
612 gdbscm_gdb_exception exc
{};
615 if (gdbscm_is_true (newvalue
))
616 enable_breakpoint (bp_smob
->bp
);
618 disable_breakpoint (bp_smob
->bp
);
620 catch (const gdb_exception
&except
)
622 exc
= unpack (except
);
625 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
626 return SCM_UNSPECIFIED
;
629 /* (breakpoint-silent? <gdb:breakpoint>) -> boolean */
632 gdbscm_breakpoint_silent_p (SCM self
)
634 breakpoint_smob
*bp_smob
635 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
637 return scm_from_bool (bp_smob
->bp
->silent
);
640 /* (set-breakpoint-silent?! <gdb:breakpoint> boolean) -> unspecified */
643 gdbscm_set_breakpoint_silent_x (SCM self
, SCM newvalue
)
645 breakpoint_smob
*bp_smob
646 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
648 SCM_ASSERT_TYPE (gdbscm_is_bool (newvalue
), newvalue
, SCM_ARG2
, FUNC_NAME
,
651 gdbscm_gdb_exception exc
{};
654 breakpoint_set_silent (bp_smob
->bp
, gdbscm_is_true (newvalue
));
656 catch (const gdb_exception
&except
)
658 exc
= unpack (except
);
661 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
662 return SCM_UNSPECIFIED
;
665 /* (breakpoint-ignore-count <gdb:breakpoint>) -> integer */
668 gdbscm_breakpoint_ignore_count (SCM self
)
670 breakpoint_smob
*bp_smob
671 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
673 return scm_from_long (bp_smob
->bp
->ignore_count
);
676 /* (set-breakpoint-ignore-count! <gdb:breakpoint> integer)
680 gdbscm_set_breakpoint_ignore_count_x (SCM self
, SCM newvalue
)
682 breakpoint_smob
*bp_smob
683 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
686 SCM_ASSERT_TYPE (scm_is_signed_integer (newvalue
, LONG_MIN
, LONG_MAX
),
687 newvalue
, SCM_ARG2
, FUNC_NAME
, _("integer"));
689 value
= scm_to_long (newvalue
);
693 gdbscm_gdb_exception exc
{};
696 set_ignore_count (bp_smob
->number
, (int) value
, 0);
698 catch (const gdb_exception
&except
)
700 exc
= unpack (except
);
703 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
704 return SCM_UNSPECIFIED
;
707 /* (breakpoint-hit-count <gdb:breakpoint>) -> integer */
710 gdbscm_breakpoint_hit_count (SCM self
)
712 breakpoint_smob
*bp_smob
713 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
715 return scm_from_long (bp_smob
->bp
->hit_count
);
718 /* (set-breakpoint-hit-count! <gdb:breakpoint> integer) -> unspecified */
721 gdbscm_set_breakpoint_hit_count_x (SCM self
, SCM newvalue
)
723 breakpoint_smob
*bp_smob
724 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
727 SCM_ASSERT_TYPE (scm_is_signed_integer (newvalue
, LONG_MIN
, LONG_MAX
),
728 newvalue
, SCM_ARG2
, FUNC_NAME
, _("integer"));
730 value
= scm_to_long (newvalue
);
736 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, newvalue
,
737 _("hit-count must be zero"));
740 bp_smob
->bp
->hit_count
= 0;
742 return SCM_UNSPECIFIED
;
745 /* (breakpoint-thread <gdb:breakpoint>) -> integer */
748 gdbscm_breakpoint_thread (SCM self
)
750 breakpoint_smob
*bp_smob
751 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
753 if (bp_smob
->bp
->thread
== -1)
756 return scm_from_long (bp_smob
->bp
->thread
);
759 /* (set-breakpoint-thread! <gdb:breakpoint> integer) -> unspecified */
762 gdbscm_set_breakpoint_thread_x (SCM self
, SCM newvalue
)
764 breakpoint_smob
*bp_smob
765 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
768 if (scm_is_signed_integer (newvalue
, LONG_MIN
, LONG_MAX
))
770 id
= scm_to_long (newvalue
);
771 if (!valid_global_thread_id (id
))
773 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, newvalue
,
774 _("invalid thread id"));
777 if (bp_smob
->bp
->task
!= -1)
778 scm_misc_error (FUNC_NAME
,
779 _("cannot set both task and thread attributes"),
782 else if (gdbscm_is_false (newvalue
))
785 SCM_ASSERT_TYPE (0, newvalue
, SCM_ARG2
, FUNC_NAME
, _("integer or #f"));
787 breakpoint_set_thread (bp_smob
->bp
, id
);
789 return SCM_UNSPECIFIED
;
792 /* (breakpoint-task <gdb:breakpoint>) -> integer */
795 gdbscm_breakpoint_task (SCM self
)
797 breakpoint_smob
*bp_smob
798 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
800 if (bp_smob
->bp
->task
== -1)
803 return scm_from_long (bp_smob
->bp
->task
);
806 /* (set-breakpoint-task! <gdb:breakpoint> integer) -> unspecified */
809 gdbscm_set_breakpoint_task_x (SCM self
, SCM newvalue
)
811 breakpoint_smob
*bp_smob
812 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
816 if (scm_is_signed_integer (newvalue
, LONG_MIN
, LONG_MAX
))
818 id
= scm_to_long (newvalue
);
820 gdbscm_gdb_exception exc
{};
823 valid_id
= valid_task_id (id
);
825 catch (const gdb_exception
&except
)
827 exc
= unpack (except
);
830 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
833 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, newvalue
,
834 _("invalid task id"));
837 if (bp_smob
->bp
->thread
!= -1)
838 scm_misc_error (FUNC_NAME
,
839 _("cannot set both task and thread attributes"),
842 else if (gdbscm_is_false (newvalue
))
845 SCM_ASSERT_TYPE (0, newvalue
, SCM_ARG2
, FUNC_NAME
, _("integer or #f"));
847 gdbscm_gdb_exception exc
{};
850 breakpoint_set_task (bp_smob
->bp
, id
);
852 catch (const gdb_exception
&except
)
854 exc
= unpack (except
);
857 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
858 return SCM_UNSPECIFIED
;
861 /* (breakpoint-location <gdb:breakpoint>) -> string */
864 gdbscm_breakpoint_location (SCM self
)
866 breakpoint_smob
*bp_smob
867 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
869 if (bp_smob
->bp
->type
!= bp_breakpoint
)
872 const char *str
= bp_smob
->bp
->locspec
->to_string ();
876 return gdbscm_scm_from_c_string (str
);
879 /* (breakpoint-expression <gdb:breakpoint>) -> string
880 This is only valid for watchpoints.
881 Returns #f for non-watchpoints. */
884 gdbscm_breakpoint_expression (SCM self
)
886 breakpoint_smob
*bp_smob
887 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
888 struct watchpoint
*wp
;
890 if (!is_watchpoint (bp_smob
->bp
))
893 wp
= (struct watchpoint
*) bp_smob
->bp
;
895 const char *str
= wp
->exp_string
.get ();
899 return gdbscm_scm_from_c_string (str
);
902 /* (breakpoint-condition <gdb:breakpoint>) -> string */
905 gdbscm_breakpoint_condition (SCM self
)
907 breakpoint_smob
*bp_smob
908 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
911 str
= bp_smob
->bp
->cond_string
.get ();
915 return gdbscm_scm_from_c_string (str
);
918 /* (set-breakpoint-condition! <gdb:breakpoint> string|#f)
922 gdbscm_set_breakpoint_condition_x (SCM self
, SCM newvalue
)
924 breakpoint_smob
*bp_smob
925 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
927 SCM_ASSERT_TYPE (scm_is_string (newvalue
) || gdbscm_is_false (newvalue
),
928 newvalue
, SCM_ARG2
, FUNC_NAME
,
931 return gdbscm_wrap ([=]
933 gdb::unique_xmalloc_ptr
<char> exp
934 = (gdbscm_is_false (newvalue
)
936 : gdbscm_scm_to_c_string (newvalue
));
938 set_breakpoint_condition (bp_smob
->bp
, exp
? exp
.get () : "", 0, false);
940 return SCM_UNSPECIFIED
;
944 /* (breakpoint-stop <gdb:breakpoint>) -> procedure or #f */
947 gdbscm_breakpoint_stop (SCM self
)
949 breakpoint_smob
*bp_smob
950 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
952 return bp_smob
->stop
;
955 /* (set-breakpoint-stop! <gdb:breakpoint> procedure|#f)
959 gdbscm_set_breakpoint_stop_x (SCM self
, SCM newvalue
)
961 breakpoint_smob
*bp_smob
962 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
963 const struct extension_language_defn
*extlang
= NULL
;
965 SCM_ASSERT_TYPE (gdbscm_is_procedure (newvalue
)
966 || gdbscm_is_false (newvalue
),
967 newvalue
, SCM_ARG2
, FUNC_NAME
,
968 _("procedure or #f"));
970 if (bp_smob
->bp
->cond_string
!= NULL
)
971 extlang
= get_ext_lang_defn (EXT_LANG_GDB
);
973 extlang
= get_breakpoint_cond_ext_lang (bp_smob
->bp
, EXT_LANG_GUILE
);
977 = xstrprintf (_("Only one stop condition allowed. There is"
978 " currently a %s stop condition defined for"
979 " this breakpoint."),
980 ext_lang_capitalized_name (extlang
)).release ();
982 scm_dynwind_begin ((scm_t_dynwind_flags
) 0);
983 gdbscm_dynwind_xfree (error_text
);
984 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG1
, self
, error_text
);
985 /* The following line, while unnecessary, is present for completeness
990 bp_smob
->stop
= newvalue
;
992 return SCM_UNSPECIFIED
;
995 /* (breakpoint-commands <gdb:breakpoint>) -> string */
998 gdbscm_breakpoint_commands (SCM self
)
1000 breakpoint_smob
*bp_smob
1001 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
1002 struct breakpoint
*bp
;
1007 if (bp
->commands
== NULL
)
1012 gdbscm_gdb_exception exc
{};
1015 ui_out_redirect_pop
redir (current_uiout
, &buf
);
1016 print_command_lines (current_uiout
, breakpoint_commands (bp
), 0);
1018 catch (const gdb_exception
&except
)
1020 exc
= unpack (except
);
1023 GDBSCM_HANDLE_GDB_EXCEPTION (exc
);
1024 result
= gdbscm_scm_from_c_string (buf
.c_str ());
1029 /* (breakpoint-type <gdb:breakpoint>) -> integer */
1032 gdbscm_breakpoint_type (SCM self
)
1034 breakpoint_smob
*bp_smob
1035 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
1037 return scm_from_long (bp_smob
->bp
->type
);
1040 /* (breakpoint-visible? <gdb:breakpoint>) -> boolean */
1043 gdbscm_breakpoint_visible (SCM self
)
1045 breakpoint_smob
*bp_smob
1046 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
1048 return scm_from_bool (bp_smob
->bp
->number
>= 0);
1051 /* (breakpoint-number <gdb:breakpoint>) -> integer */
1054 gdbscm_breakpoint_number (SCM self
)
1056 breakpoint_smob
*bp_smob
1057 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
1059 return scm_from_long (bp_smob
->number
);
1062 /* (breakpoint-temporary? <gdb:breakpoint>) -> boolean */
1065 gdbscm_breakpoint_temporary (SCM self
)
1067 breakpoint_smob
*bp_smob
1068 = bpscm_get_valid_breakpoint_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
1070 return scm_from_bool (bp_smob
->bp
->disposition
== disp_del
1071 || bp_smob
->bp
->disposition
== disp_del_at_next_stop
);
1074 /* Return TRUE if "stop" has been set for this breakpoint.
1076 This is the extension_language_ops.breakpoint_has_cond "method". */
1079 gdbscm_breakpoint_has_cond (const struct extension_language_defn
*extlang
,
1080 struct breakpoint
*b
)
1082 breakpoint_smob
*bp_smob
= b
->scm_bp_object
;
1084 if (bp_smob
== NULL
)
1087 return gdbscm_is_procedure (bp_smob
->stop
);
1090 /* Call the "stop" method in the breakpoint class.
1091 This must only be called if gdbscm_breakpoint_has_cond returns true.
1092 If the stop method returns #t, the inferior will be stopped at the
1093 breakpoint. Otherwise the inferior will be allowed to continue
1094 (assuming other conditions don't indicate "stop").
1096 This is the extension_language_ops.breakpoint_cond_says_stop "method". */
1098 enum ext_lang_bp_stop
1099 gdbscm_breakpoint_cond_says_stop
1100 (const struct extension_language_defn
*extlang
, struct breakpoint
*b
)
1102 breakpoint_smob
*bp_smob
= b
->scm_bp_object
;
1103 SCM predicate_result
;
1106 if (bp_smob
== NULL
)
1107 return EXT_LANG_BP_STOP_UNSET
;
1108 if (!gdbscm_is_procedure (bp_smob
->stop
))
1109 return EXT_LANG_BP_STOP_UNSET
;
1114 = gdbscm_safe_call_1 (bp_smob
->stop
, bp_smob
->containing_scm
, NULL
);
1116 if (gdbscm_is_exception (predicate_result
))
1117 ; /* Exception already printed. */
1118 /* If the "stop" function returns #f that means
1119 the Scheme breakpoint wants GDB to continue. */
1120 else if (gdbscm_is_false (predicate_result
))
1123 return stop
? EXT_LANG_BP_STOP_YES
: EXT_LANG_BP_STOP_NO
;
1126 /* Event callback functions. */
1128 /* Callback that is used when a breakpoint is created.
1129 For breakpoints created by Scheme, i.e., gdbscm_create_breakpoint_x, finish
1130 object creation by connecting the Scheme wrapper to the gdb object.
1131 We ignore breakpoints created from gdb or python here, we create the
1132 Scheme wrapper for those when there's a need to, e.g.,
1133 gdbscm_breakpoints. */
1136 bpscm_breakpoint_created (struct breakpoint
*bp
)
1140 if (gdbscm_is_false (pending_breakpoint_scm
))
1143 /* Verify our caller error checked the user's request. */
1144 gdb_assert (bpscm_want_scm_wrapper_p (bp
, 1));
1146 bp_scm
= pending_breakpoint_scm
;
1147 pending_breakpoint_scm
= SCM_BOOL_F
;
1149 bpscm_attach_scm_to_breakpoint (bp
, bp_scm
);
1152 /* Callback that is used when a breakpoint is deleted. This will
1153 invalidate the corresponding Scheme object. */
1156 bpscm_breakpoint_deleted (struct breakpoint
*b
)
1158 int num
= b
->number
;
1159 struct breakpoint
*bp
;
1161 /* TODO: Why the lookup? We have B. */
1163 bp
= get_breakpoint (num
);
1166 breakpoint_smob
*bp_smob
= bp
->scm_bp_object
;
1171 bp_smob
->number
= -1;
1172 bp_smob
->stop
= SCM_BOOL_F
;
1173 scm_gc_unprotect_object (bp_smob
->containing_scm
);
1178 /* Initialize the Scheme breakpoint code. */
1180 static const scheme_integer_constant breakpoint_integer_constants
[] =
1182 { "BP_NONE", bp_none
},
1183 { "BP_BREAKPOINT", bp_breakpoint
},
1184 { "BP_WATCHPOINT", bp_watchpoint
},
1185 { "BP_HARDWARE_WATCHPOINT", bp_hardware_watchpoint
},
1186 { "BP_READ_WATCHPOINT", bp_read_watchpoint
},
1187 { "BP_ACCESS_WATCHPOINT", bp_access_watchpoint
},
1188 { "BP_CATCHPOINT", bp_catchpoint
},
1190 { "WP_READ", hw_read
},
1191 { "WP_WRITE", hw_write
},
1192 { "WP_ACCESS", hw_access
},
1194 END_INTEGER_CONSTANTS
1197 static const scheme_function breakpoint_functions
[] =
1199 { "make-breakpoint", 1, 0, 1, as_a_scm_t_subr (gdbscm_make_breakpoint
),
1201 Create a GDB breakpoint object.\n\
1204 location [#:type <type>] [#:wp-class <wp-class>] [#:internal <bool>] [#:temporary <bool>]\n\
1206 <gdb:breakpoint> object" },
1208 { "register-breakpoint!", 1, 0, 0,
1209 as_a_scm_t_subr (gdbscm_register_breakpoint_x
),
1211 Register a <gdb:breakpoint> object with GDB." },
1213 { "delete-breakpoint!", 1, 0, 0, as_a_scm_t_subr (gdbscm_delete_breakpoint_x
),
1215 Delete the breakpoint from GDB." },
1217 { "breakpoints", 0, 0, 0, as_a_scm_t_subr (gdbscm_breakpoints
),
1219 Return a list of all GDB breakpoints.\n\
1223 { "breakpoint?", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_p
),
1225 Return #t if the object is a <gdb:breakpoint> object." },
1227 { "breakpoint-valid?", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_valid_p
),
1229 Return #t if the breakpoint has not been deleted from GDB." },
1231 { "breakpoint-number", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_number
),
1233 Return the breakpoint's number." },
1235 { "breakpoint-temporary?", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_temporary
),
1237 Return #t if the breakpoint is a temporary breakpoint." },
1239 { "breakpoint-type", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_type
),
1241 Return the type of the breakpoint." },
1243 { "breakpoint-visible?", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_visible
),
1245 Return #t if the breakpoint is visible to the user." },
1247 { "breakpoint-location", 1, 0, 0,
1248 as_a_scm_t_subr (gdbscm_breakpoint_location
),
1250 Return the location of the breakpoint as specified by the user." },
1252 { "breakpoint-expression", 1, 0, 0,
1253 as_a_scm_t_subr (gdbscm_breakpoint_expression
),
1255 Return the expression of the breakpoint as specified by the user.\n\
1256 Valid for watchpoints only, returns #f for non-watchpoints." },
1258 { "breakpoint-enabled?", 1, 0, 0,
1259 as_a_scm_t_subr (gdbscm_breakpoint_enabled_p
),
1261 Return #t if the breakpoint is enabled." },
1263 { "set-breakpoint-enabled!", 2, 0, 0,
1264 as_a_scm_t_subr (gdbscm_set_breakpoint_enabled_x
),
1266 Set the breakpoint's enabled state.\n\
1268 Arguments: <gdb:breakpoint> boolean" },
1270 { "breakpoint-silent?", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_silent_p
),
1272 Return #t if the breakpoint is silent." },
1274 { "set-breakpoint-silent!", 2, 0, 0,
1275 as_a_scm_t_subr (gdbscm_set_breakpoint_silent_x
),
1277 Set the breakpoint's silent state.\n\
1279 Arguments: <gdb:breakpoint> boolean" },
1281 { "breakpoint-ignore-count", 1, 0, 0,
1282 as_a_scm_t_subr (gdbscm_breakpoint_ignore_count
),
1284 Return the breakpoint's \"ignore\" count." },
1286 { "set-breakpoint-ignore-count!", 2, 0, 0,
1287 as_a_scm_t_subr (gdbscm_set_breakpoint_ignore_count_x
),
1289 Set the breakpoint's \"ignore\" count.\n\
1291 Arguments: <gdb:breakpoint> count" },
1293 { "breakpoint-hit-count", 1, 0, 0,
1294 as_a_scm_t_subr (gdbscm_breakpoint_hit_count
),
1296 Return the breakpoint's \"hit\" count." },
1298 { "set-breakpoint-hit-count!", 2, 0, 0,
1299 as_a_scm_t_subr (gdbscm_set_breakpoint_hit_count_x
),
1301 Set the breakpoint's \"hit\" count. The value must be zero.\n\
1303 Arguments: <gdb:breakpoint> 0" },
1305 { "breakpoint-thread", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_thread
),
1307 Return the breakpoint's global thread id or #f if there isn't one." },
1309 { "set-breakpoint-thread!", 2, 0, 0,
1310 as_a_scm_t_subr (gdbscm_set_breakpoint_thread_x
),
1312 Set the global thread id for this breakpoint.\n\
1314 Arguments: <gdb:breakpoint> global-thread-id" },
1316 { "breakpoint-task", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_task
),
1318 Return the breakpoint's Ada task-id or #f if there isn't one." },
1320 { "set-breakpoint-task!", 2, 0, 0,
1321 as_a_scm_t_subr (gdbscm_set_breakpoint_task_x
),
1323 Set the breakpoint's Ada task-id.\n\
1325 Arguments: <gdb:breakpoint> task-id" },
1327 { "breakpoint-condition", 1, 0, 0,
1328 as_a_scm_t_subr (gdbscm_breakpoint_condition
),
1330 Return the breakpoint's condition as specified by the user.\n\
1331 Return #f if there isn't one." },
1333 { "set-breakpoint-condition!", 2, 0, 0,
1334 as_a_scm_t_subr (gdbscm_set_breakpoint_condition_x
),
1336 Set the breakpoint's condition.\n\
1338 Arguments: <gdb:breakpoint> condition\n\
1339 condition: a string" },
1341 { "breakpoint-stop", 1, 0, 0, as_a_scm_t_subr (gdbscm_breakpoint_stop
),
1343 Return the breakpoint's stop predicate.\n\
1344 Return #f if there isn't one." },
1346 { "set-breakpoint-stop!", 2, 0, 0,
1347 as_a_scm_t_subr (gdbscm_set_breakpoint_stop_x
),
1349 Set the breakpoint's stop predicate.\n\
1351 Arguments: <gdb:breakpoint> procedure\n\
1352 procedure: A procedure of one argument, the breakpoint.\n\
1353 Its result is true if program execution should stop." },
1355 { "breakpoint-commands", 1, 0, 0,
1356 as_a_scm_t_subr (gdbscm_breakpoint_commands
),
1358 Return the breakpoint's commands." },
1364 gdbscm_initialize_breakpoints (void)
1367 = gdbscm_make_smob_type (breakpoint_smob_name
, sizeof (breakpoint_smob
));
1368 scm_set_smob_free (breakpoint_smob_tag
, bpscm_free_breakpoint_smob
);
1369 scm_set_smob_print (breakpoint_smob_tag
, bpscm_print_breakpoint_smob
);
1371 gdb::observers::breakpoint_created
.attach (bpscm_breakpoint_created
,
1373 gdb::observers::breakpoint_deleted
.attach (bpscm_breakpoint_deleted
,
1376 gdbscm_define_integer_constants (breakpoint_integer_constants
, 1);
1377 gdbscm_define_functions (breakpoint_functions
, 1);
1379 type_keyword
= scm_from_latin1_keyword ("type");
1380 wp_class_keyword
= scm_from_latin1_keyword ("wp-class");
1381 internal_keyword
= scm_from_latin1_keyword ("internal");
1382 temporary_keyword
= scm_from_latin1_keyword ("temporary");