1 /* Internal header for GDB/Scheme code.
3 Copyright (C) 2014-2018 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. */
23 #ifndef GDB_GUILE_INTERNAL_H
24 #define GDB_GUILE_INTERNAL_H
27 #include "extension-priv.h"
36 /* A function to pass to the safe-call routines to ignore things like
38 typedef int excp_matcher_func (SCM key
);
40 /* Scheme variables to define during initialization. */
46 const char *doc_string
;
49 /* End of scheme_variable table mark. */
51 #define END_VARIABLES { NULL, SCM_BOOL_F, NULL }
53 /* Although scm_t_subr is meant to hold a function pointer, at least
54 in some versions of guile, it is actually a typedef to "void *".
55 That means that in C++, an explicit cast is necessary to convert
56 function pointer to scm_t_subr. But a cast also makes it possible
57 to pass function pointers with the wrong type by mistake. So
58 instead of adding such casts throughout, we use 'as_a_scm_t_subr'
59 to do the conversion, which (only) has overloads for function
60 pointer types that are valid.
62 See https://lists.gnu.org/archive/html/guile-devel/2013-03/msg00001.html.
65 static inline scm_t_subr
66 as_a_scm_t_subr (SCM (*func
) (void))
68 return (scm_t_subr
) func
;
71 static inline scm_t_subr
72 as_a_scm_t_subr (SCM (*func
) (SCM
))
74 return (scm_t_subr
) func
;
77 static inline scm_t_subr
78 as_a_scm_t_subr (SCM (*func
) (SCM
, SCM
))
80 return (scm_t_subr
) func
;
83 static inline scm_t_subr
84 as_a_scm_t_subr (SCM (*func
) (SCM
, SCM
, SCM
))
86 return (scm_t_subr
) func
;
89 /* Scheme functions to define during initialization. */
98 const char *doc_string
;
101 /* End of scheme_function table mark. */
103 #define END_FUNCTIONS { NULL, 0, 0, 0, NULL, NULL }
105 /* Useful for defining a set of constants. */
111 } scheme_integer_constant
;
113 #define END_INTEGER_CONSTANTS { NULL, 0 }
115 /* Pass this instead of 0 to routines like SCM_ASSERT to indicate the value
116 is not a function argument. */
117 #define GDBSCM_ARG_NONE 0
119 /* Ensure new code doesn't accidentally try to use this. */
120 #undef scm_make_smob_type
121 #define scm_make_smob_type USE_gdbscm_make_smob_type_INSTEAD
123 /* They brought over () == #f from lisp.
124 Let's avoid that for now. */
128 #define scm_is_bool USE_gdbscm_is_bool_INSTEAD
129 #define scm_is_false USE_gdbscm_is_false_INSTEAD
130 #define scm_is_true USE_gdbscm_is_true_INSTEAD
131 #define gdbscm_is_bool(scm) \
132 (scm_is_eq ((scm), SCM_BOOL_F) || scm_is_eq ((scm), SCM_BOOL_T))
133 #define gdbscm_is_false(scm) scm_is_eq ((scm), SCM_BOOL_F)
134 #define gdbscm_is_true(scm) (!gdbscm_is_false (scm))
136 #ifndef HAVE_SCM_NEW_SMOB
138 /* Guile <= 2.0.5 did not provide this function, so provide it here. */
141 scm_new_smob (scm_t_bits tc
, scm_t_bits data
)
143 SCM_RETURN_NEWSMOB (tc
, data
);
148 /* Function name that is passed around in case an error needs to be reported.
149 __func is in C99, but we provide a wrapper "just in case",
150 and because FUNC_NAME is the canonical value used in guile sources.
151 IWBN to use the Scheme version of the name (e.g. foo-bar vs foo_bar),
152 but let's KISS for now. */
153 #define FUNC_NAME __func__
155 extern const char gdbscm_module_name
[];
156 extern const char gdbscm_init_module_name
[];
158 extern int gdb_scheme_initialized
;
160 extern int gdbscm_guile_major_version
;
161 extern int gdbscm_guile_minor_version
;
162 extern int gdbscm_guile_micro_version
;
164 extern const char gdbscm_print_excp_none
[];
165 extern const char gdbscm_print_excp_full
[];
166 extern const char gdbscm_print_excp_message
[];
167 extern const char *gdbscm_print_excp
;
169 extern SCM gdbscm_documentation_symbol
;
170 extern SCM gdbscm_invalid_object_error_symbol
;
172 extern SCM gdbscm_map_string
;
173 extern SCM gdbscm_array_string
;
174 extern SCM gdbscm_string_string
;
178 extern void gdbscm_define_variables (const scheme_variable
*, int is_public
);
180 extern void gdbscm_define_functions (const scheme_function
*, int is_public
);
182 extern void gdbscm_define_integer_constants (const scheme_integer_constant
*,
185 extern void gdbscm_printf (SCM port
, const char *format
, ...)
186 ATTRIBUTE_PRINTF (2, 3);
188 extern void gdbscm_debug_display (SCM obj
);
190 extern void gdbscm_debug_write (SCM obj
);
192 extern void gdbscm_parse_function_args (const char *function_name
,
193 int beginning_arg_pos
,
195 const char *format
, ...);
197 extern SCM
gdbscm_scm_from_longest (LONGEST l
);
199 extern LONGEST
gdbscm_scm_to_longest (SCM l
);
201 extern SCM
gdbscm_scm_from_ulongest (ULONGEST l
);
203 extern ULONGEST
gdbscm_scm_to_ulongest (SCM u
);
205 extern void gdbscm_dynwind_xfree (void *ptr
);
207 extern int gdbscm_is_procedure (SCM proc
);
209 extern char *gdbscm_gc_xstrdup (const char *);
211 extern const char * const *gdbscm_gc_dup_argv (char **argv
);
213 extern int gdbscm_guile_version_is_at_least (int major
, int minor
, int micro
);
215 /* GDB smobs, from scm-gsmob.c */
217 /* All gdb smobs must contain one of the following as the first member:
218 gdb_smob, chained_gdb_smob, or eqable_gdb_smob.
220 Chained GDB smobs should have chained_gdb_smob as their first member. The
221 next,prev members of chained_gdb_smob allow for chaining gsmobs together so
222 that, for example, when an objfile is deleted we can clean up all smobs that
225 Eq-able GDB smobs should have eqable_gdb_smob as their first member. The
226 containing_scm member of eqable_gdb_smob allows for returning the same gsmob
227 instead of creating a new one, allowing them to be eq?-able.
229 All other smobs should have gdb_smob as their first member.
230 FIXME: dje/2014-05-26: gdb_smob was useful during early development as a
231 "baseclass" for all gdb smobs. If it's still unused by gdb 8.0 delete it.
233 IMPORTANT: chained_gdb_smob and eqable_gdb-smob are "subclasses" of
234 gdb_smob. The layout of chained_gdb_smob,eqable_gdb_smob must match
235 gdb_smob as if it is a subclass. To that end we use macro GDB_SMOB_HEAD
238 #define GDB_SMOB_HEAD \
239 int empty_base_class;
246 typedef struct _chained_gdb_smob
250 struct _chained_gdb_smob
*prev
;
251 struct _chained_gdb_smob
*next
;
254 typedef struct _eqable_gdb_smob
258 /* The object we are contained in.
259 This can be used for several purposes.
260 This is used by the eq? machinery: We need to be able to see if we have
261 already created an object for a symbol, and if so use that SCM.
262 This may also be used to protect the smob from GC if there is
263 a reference to this smob from outside of GC space (i.e., from gdb).
264 This can also be used in place of chained_gdb_smob where we need to
265 keep track of objfile referencing objects. When the objfile is deleted
266 we need to invalidate the objects: we can do that using the same hashtab
267 used to record the smob for eq-ability. */
276 /* A predicate that returns non-zero if an object is a particular kind
278 typedef int (gsmob_pred_func
) (SCM
);
280 extern scm_t_bits
gdbscm_make_smob_type (const char *name
, size_t size
);
282 extern void gdbscm_init_gsmob (gdb_smob
*base
);
284 extern void gdbscm_init_chained_gsmob (chained_gdb_smob
*base
);
286 extern void gdbscm_init_eqable_gsmob (eqable_gdb_smob
*base
,
289 extern void gdbscm_add_objfile_ref (struct objfile
*objfile
,
290 const struct objfile_data
*data_key
,
291 chained_gdb_smob
*g_smob
);
293 extern void gdbscm_remove_objfile_ref (struct objfile
*objfile
,
294 const struct objfile_data
*data_key
,
295 chained_gdb_smob
*g_smob
);
297 extern htab_t
gdbscm_create_eqable_gsmob_ptr_map (htab_hash hash_fn
,
300 extern eqable_gdb_smob
**gdbscm_find_eqable_gsmob_ptr_slot
301 (htab_t htab
, eqable_gdb_smob
*base
);
303 extern void gdbscm_fill_eqable_gsmob_ptr_slot (eqable_gdb_smob
**slot
,
304 eqable_gdb_smob
*base
);
306 extern void gdbscm_clear_eqable_gsmob_ptr_slot (htab_t htab
,
307 eqable_gdb_smob
*base
);
309 /* Exceptions and calling out to Guile. */
311 /* scm-exception.c */
313 extern SCM
gdbscm_make_exception (SCM tag
, SCM args
);
315 extern int gdbscm_is_exception (SCM scm
);
317 extern SCM
gdbscm_exception_key (SCM excp
);
319 extern SCM
gdbscm_exception_args (SCM excp
);
321 extern SCM
gdbscm_make_exception_with_stack (SCM key
, SCM args
, SCM stack
);
323 extern SCM
gdbscm_make_error_scm (SCM key
, SCM subr
, SCM message
,
326 extern SCM
gdbscm_make_error (SCM key
, const char *subr
, const char *message
,
329 extern SCM
gdbscm_make_type_error (const char *subr
, int arg_pos
,
330 SCM bad_value
, const char *expected_type
);
332 extern SCM
gdbscm_make_invalid_object_error (const char *subr
, int arg_pos
,
333 SCM bad_value
, const char *error
);
335 extern void gdbscm_invalid_object_error (const char *subr
, int arg_pos
,
336 SCM bad_value
, const char *error
)
339 extern SCM
gdbscm_make_out_of_range_error (const char *subr
, int arg_pos
,
340 SCM bad_value
, const char *error
);
342 extern void gdbscm_out_of_range_error (const char *subr
, int arg_pos
,
343 SCM bad_value
, const char *error
)
346 extern SCM
gdbscm_make_misc_error (const char *subr
, int arg_pos
,
347 SCM bad_value
, const char *error
);
349 extern void gdbscm_misc_error (const char *subr
, int arg_pos
,
350 SCM bad_value
, const char *error
)
353 extern void gdbscm_throw (SCM exception
) ATTRIBUTE_NORETURN
;
355 extern SCM
gdbscm_scm_from_gdb_exception (struct gdb_exception exception
);
357 extern void gdbscm_throw_gdb_exception (struct gdb_exception exception
)
360 extern void gdbscm_print_exception_with_stack (SCM port
, SCM stack
,
363 extern void gdbscm_print_gdb_exception (SCM port
, SCM exception
);
365 extern gdb::unique_xmalloc_ptr
<char> gdbscm_exception_message_to_string
368 extern excp_matcher_func gdbscm_memory_error_p
;
370 extern excp_matcher_func gdbscm_user_error_p
;
372 extern SCM
gdbscm_make_memory_error (const char *subr
, const char *msg
,
375 extern void gdbscm_memory_error (const char *subr
, const char *msg
, SCM args
)
378 /* scm-safe-call.c */
380 extern const char *gdbscm_with_guile (const char *(*func
) (void *), void *data
);
382 extern SCM
gdbscm_call_guile (SCM (*func
) (void *), void *data
,
383 excp_matcher_func
*ok_excps
);
385 extern SCM
gdbscm_safe_call_0 (SCM proc
, excp_matcher_func
*ok_excps
);
387 extern SCM
gdbscm_safe_call_1 (SCM proc
, SCM arg0
,
388 excp_matcher_func
*ok_excps
);
390 extern SCM
gdbscm_safe_call_2 (SCM proc
, SCM arg0
, SCM arg1
,
391 excp_matcher_func
*ok_excps
);
393 extern SCM
gdbscm_safe_call_3 (SCM proc
, SCM arg0
, SCM arg1
, SCM arg2
,
394 excp_matcher_func
*ok_excps
);
396 extern SCM
gdbscm_safe_call_4 (SCM proc
, SCM arg0
, SCM arg1
, SCM arg2
,
398 excp_matcher_func
*ok_excps
);
400 extern SCM
gdbscm_safe_apply_1 (SCM proc
, SCM arg0
, SCM args
,
401 excp_matcher_func
*ok_excps
);
403 extern SCM
gdbscm_unsafe_call_1 (SCM proc
, SCM arg0
);
405 extern gdb::unique_xmalloc_ptr
<char> gdbscm_safe_eval_string
406 (const char *string
, int display_result
);
408 extern char *gdbscm_safe_source_script (const char *filename
);
410 extern void gdbscm_enter_repl (void);
412 /* Interface to various GDB objects, in alphabetical order. */
416 typedef struct _arch_smob arch_smob
;
418 extern struct gdbarch
*arscm_get_gdbarch (arch_smob
*a_smob
);
420 extern arch_smob
*arscm_get_arch_smob_arg_unsafe (SCM arch_scm
, int arg_pos
,
421 const char *func_name
);
423 extern SCM
arscm_scm_from_arch (struct gdbarch
*gdbarch
);
427 extern SCM
bkscm_scm_from_block (const struct block
*block
,
428 struct objfile
*objfile
);
430 extern const struct block
*bkscm_scm_to_block
431 (SCM block_scm
, int arg_pos
, const char *func_name
, SCM
*excp
);
435 extern char *gdbscm_parse_command_name (const char *name
,
436 const char *func_name
, int arg_pos
,
437 struct cmd_list_element
***base_list
,
438 struct cmd_list_element
**start_list
);
440 extern int gdbscm_valid_command_class_p (int command_class
);
442 extern char *gdbscm_canonicalize_command_name (const char *name
,
443 int want_trailing_space
);
447 typedef struct _frame_smob frame_smob
;
449 extern int frscm_is_frame (SCM scm
);
451 extern frame_smob
*frscm_get_frame_smob_arg_unsafe (SCM frame_scm
, int arg_pos
,
452 const char *func_name
);
454 extern struct frame_info
*frscm_frame_smob_to_frame (frame_smob
*);
458 typedef struct _iterator_smob iterator_smob
;
460 extern SCM
itscm_iterator_smob_object (iterator_smob
*i_smob
);
462 extern SCM
itscm_iterator_smob_progress (iterator_smob
*i_smob
);
464 extern void itscm_set_iterator_smob_progress_x (iterator_smob
*i_smob
,
467 extern const char *itscm_iterator_smob_name (void);
469 extern SCM
gdbscm_make_iterator (SCM object
, SCM progress
, SCM next
);
471 extern int itscm_is_iterator (SCM scm
);
473 extern SCM
gdbscm_end_of_iteration (void);
475 extern int itscm_is_end_of_iteration (SCM obj
);
477 extern SCM
itscm_safe_call_next_x (SCM iter
, excp_matcher_func
*ok_excps
);
479 extern SCM
itscm_get_iterator_arg_unsafe (SCM self
, int arg_pos
,
480 const char *func_name
);
482 /* scm-lazy-string.c */
484 extern int lsscm_is_lazy_string (SCM scm
);
486 extern SCM
lsscm_make_lazy_string (CORE_ADDR address
, int length
,
487 const char *encoding
, struct type
*type
);
489 extern struct value
*lsscm_safe_lazy_string_to_value (SCM string
,
491 const char *func_name
,
494 extern void lsscm_val_print_lazy_string
495 (SCM string
, struct ui_file
*stream
,
496 const struct value_print_options
*options
);
500 typedef struct _objfile_smob objfile_smob
;
502 extern SCM
ofscm_objfile_smob_pretty_printers (objfile_smob
*o_smob
);
504 extern objfile_smob
*ofscm_objfile_smob_from_objfile (struct objfile
*objfile
);
506 extern SCM
ofscm_scm_from_objfile (struct objfile
*objfile
);
508 /* scm-progspace.c */
510 typedef struct _pspace_smob pspace_smob
;
512 extern SCM
psscm_pspace_smob_pretty_printers (const pspace_smob
*);
514 extern pspace_smob
*psscm_pspace_smob_from_pspace (struct program_space
*);
516 extern SCM
psscm_scm_from_pspace (struct program_space
*);
520 extern int gdbscm_scm_string_to_int (SCM string
);
522 extern char *gdbscm_scm_to_c_string (SCM string
);
524 extern SCM
gdbscm_scm_from_c_string (const char *string
);
526 extern SCM
gdbscm_scm_from_printf (const char *format
, ...)
527 ATTRIBUTE_PRINTF (1, 2);
529 extern char *gdbscm_scm_to_string (SCM string
, size_t *lenp
,
531 int strict
, SCM
*except_scmp
);
533 extern SCM
gdbscm_scm_from_string (const char *string
, size_t len
,
534 const char *charset
, int strict
);
536 extern char *gdbscm_scm_to_host_string (SCM string
, size_t *lenp
, SCM
*except
);
538 extern SCM
gdbscm_scm_from_host_string (const char *string
, size_t len
);
542 extern int syscm_is_symbol (SCM scm
);
544 extern SCM
syscm_scm_from_symbol (struct symbol
*symbol
);
546 extern struct symbol
*syscm_get_valid_symbol_arg_unsafe
547 (SCM self
, int arg_pos
, const char *func_name
);
551 extern SCM
stscm_scm_from_symtab (struct symtab
*symtab
);
553 extern SCM
stscm_scm_from_sal (struct symtab_and_line sal
);
557 typedef struct _type_smob type_smob
;
559 extern int tyscm_is_type (SCM scm
);
561 extern SCM
tyscm_scm_from_type (struct type
*type
);
563 extern type_smob
*tyscm_get_type_smob_arg_unsafe (SCM type_scm
, int arg_pos
,
564 const char *func_name
);
566 extern struct type
*tyscm_scm_to_type (SCM t_scm
);
568 extern struct type
*tyscm_type_smob_type (type_smob
*t_smob
);
570 extern SCM
tyscm_scm_from_field (SCM type_scm
, int field_num
);
574 extern struct value
*vlscm_scm_to_value (SCM scm
);
576 extern int vlscm_is_value (SCM scm
);
578 extern SCM
vlscm_scm_from_value (struct value
*value
);
580 extern SCM
vlscm_scm_from_value_unsafe (struct value
*value
);
582 extern struct value
*vlscm_convert_typed_value_from_scheme
583 (const char *func_name
, int obj_arg_pos
, SCM obj
,
584 int type_arg_pos
, SCM type_scm
, struct type
*type
, SCM
*except_scmp
,
585 struct gdbarch
*gdbarch
, const struct language_defn
*language
);
587 extern struct value
*vlscm_convert_value_from_scheme
588 (const char *func_name
, int obj_arg_pos
, SCM obj
, SCM
*except_scmp
,
589 struct gdbarch
*gdbarch
, const struct language_defn
*language
);
591 /* stript_lang methods */
593 extern objfile_script_sourcer_func gdbscm_source_objfile_script
;
594 extern objfile_script_executor_func gdbscm_execute_objfile_script
;
596 extern int gdbscm_auto_load_enabled (const struct extension_language_defn
*);
598 extern void gdbscm_preserve_values
599 (const struct extension_language_defn
*,
600 struct objfile
*, htab_t copied_types
);
602 extern enum ext_lang_rc gdbscm_apply_val_pretty_printer
603 (const struct extension_language_defn
*,
605 LONGEST embedded_offset
, CORE_ADDR address
,
606 struct ui_file
*stream
, int recurse
,
608 const struct value_print_options
*options
,
609 const struct language_defn
*language
);
611 extern int gdbscm_breakpoint_has_cond (const struct extension_language_defn
*,
612 struct breakpoint
*b
);
614 extern enum ext_lang_bp_stop gdbscm_breakpoint_cond_says_stop
615 (const struct extension_language_defn
*, struct breakpoint
*b
);
617 /* Initializers for each piece of Scheme support, in alphabetical order. */
619 extern void gdbscm_initialize_arches (void);
620 extern void gdbscm_initialize_auto_load (void);
621 extern void gdbscm_initialize_blocks (void);
622 extern void gdbscm_initialize_breakpoints (void);
623 extern void gdbscm_initialize_commands (void);
624 extern void gdbscm_initialize_disasm (void);
625 extern void gdbscm_initialize_exceptions (void);
626 extern void gdbscm_initialize_frames (void);
627 extern void gdbscm_initialize_iterators (void);
628 extern void gdbscm_initialize_lazy_strings (void);
629 extern void gdbscm_initialize_math (void);
630 extern void gdbscm_initialize_objfiles (void);
631 extern void gdbscm_initialize_pretty_printers (void);
632 extern void gdbscm_initialize_parameters (void);
633 extern void gdbscm_initialize_ports (void);
634 extern void gdbscm_initialize_pspaces (void);
635 extern void gdbscm_initialize_smobs (void);
636 extern void gdbscm_initialize_strings (void);
637 extern void gdbscm_initialize_symbols (void);
638 extern void gdbscm_initialize_symtabs (void);
639 extern void gdbscm_initialize_types (void);
640 extern void gdbscm_initialize_values (void);
642 /* Use these after a TRY_CATCH to throw the appropriate Scheme exception
643 if a GDB error occurred. */
645 #define GDBSCM_HANDLE_GDB_EXCEPTION(exception) \
647 if (exception.reason < 0) \
649 gdbscm_throw_gdb_exception (exception); \
654 /* If cleanups are establish outside the TRY_CATCH block, use this version. */
656 #define GDBSCM_HANDLE_GDB_EXCEPTION_WITH_CLEANUPS(exception, cleanups) \
658 if (exception.reason < 0) \
660 do_cleanups (cleanups); \
661 gdbscm_throw_gdb_exception (exception); \
666 #endif /* GDB_GUILE_INTERNAL_H */