1 /* Internal header for GDB/Scheme code.
3 Copyright (C) 2014-2015 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 /* Scheme functions to define during initialization. */
62 const char *doc_string;
65 /* End of scheme_function table mark. */
67 #define END_FUNCTIONS { NULL, 0, 0, 0, NULL, NULL }
69 /* Useful for defining a set of constants. */
75 } scheme_integer_constant;
77 #define END_INTEGER_CONSTANTS { NULL, 0 }
79 /* Pass this instead of 0 to routines like SCM_ASSERT to indicate the value
80 is not a function argument. */
81 #define GDBSCM_ARG_NONE 0
83 /* Ensure new code doesn't accidentally try to use this. */
84 #undef scm_make_smob_type
85 #define scm_make_smob_type USE_gdbscm_make_smob_type_INSTEAD
87 /* They brought over () == #f from lisp.
88 Let's avoid that for now. */
92 #define scm_is_bool USE_gdbscm_is_bool_INSTEAD
93 #define scm_is_false USE_gdbscm_is_false_INSTEAD
94 #define scm_is_true USE_gdbscm_is_true_INSTEAD
95 #define gdbscm_is_bool(scm) \
96 (scm_is_eq ((scm), SCM_BOOL_F) || scm_is_eq ((scm), SCM_BOOL_T))
97 #define gdbscm_is_false(scm) scm_is_eq ((scm), SCM_BOOL_F)
98 #define gdbscm_is_true(scm) (!gdbscm_is_false (scm))
100 #ifndef HAVE_SCM_NEW_SMOB
102 /* Guile <= 2.0.5 did not provide this function, so provide it here. */
105 scm_new_smob (scm_t_bits tc, scm_t_bits data)
107 SCM_RETURN_NEWSMOB (tc, data);
112 /* Function name that is passed around in case an error needs to be reported.
113 __func is in C99, but we provide a wrapper "just in case",
114 and because FUNC_NAME is the canonical value used in guile sources.
115 IWBN to use the Scheme version of the name (e.g. foo-bar vs foo_bar),
116 but let's KISS for now. */
117 #define FUNC_NAME __func__
119 extern const char gdbscm_module_name[];
120 extern const char gdbscm_init_module_name[];
122 extern int gdb_scheme_initialized;
124 extern int gdbscm_guile_major_version;
125 extern int gdbscm_guile_minor_version;
126 extern int gdbscm_guile_micro_version;
128 extern const char gdbscm_print_excp_none[];
129 extern const char gdbscm_print_excp_full[];
130 extern const char gdbscm_print_excp_message[];
131 extern const char *gdbscm_print_excp;
133 extern SCM gdbscm_documentation_symbol;
134 extern SCM gdbscm_invalid_object_error_symbol;
136 extern SCM gdbscm_map_string;
137 extern SCM gdbscm_array_string;
138 extern SCM gdbscm_string_string;
142 extern void gdbscm_define_variables (const scheme_variable *, int public);
144 extern void gdbscm_define_functions (const scheme_function *, int public);
146 extern void gdbscm_define_integer_constants (const scheme_integer_constant *,
149 extern void gdbscm_printf (SCM port, const char *format, ...)
150 ATTRIBUTE_PRINTF (2, 3);
152 extern void gdbscm_debug_display (SCM obj);
154 extern void gdbscm_debug_write (SCM obj);
156 extern void gdbscm_parse_function_args (const char *function_name,
157 int beginning_arg_pos,
159 const char *format, ...);
161 extern SCM gdbscm_scm_from_longest (LONGEST l);
163 extern LONGEST gdbscm_scm_to_longest (SCM l);
165 extern SCM gdbscm_scm_from_ulongest (ULONGEST l);
167 extern ULONGEST gdbscm_scm_to_ulongest (SCM u);
169 extern void gdbscm_dynwind_xfree (void *ptr);
171 extern int gdbscm_is_procedure (SCM proc);
173 extern char *gdbscm_gc_xstrdup (const char *);
175 extern const char * const *gdbscm_gc_dup_argv (char **argv);
177 extern int gdbscm_guile_version_is_at_least (int major, int minor, int micro);
179 /* GDB smobs, from scm-gsmob.c */
181 /* All gdb smobs must contain one of the following as the first member:
182 gdb_smob, chained_gdb_smob, or eqable_gdb_smob.
184 Chained GDB smobs should have chained_gdb_smob as their first member. The
185 next,prev members of chained_gdb_smob allow for chaining gsmobs together so
186 that, for example, when an objfile is deleted we can clean up all smobs that
189 Eq-able GDB smobs should have eqable_gdb_smob as their first member. The
190 containing_scm member of eqable_gdb_smob allows for returning the same gsmob
191 instead of creating a new one, allowing them to be eq?-able.
193 All other smobs should have gdb_smob as their first member.
194 FIXME: dje/2014-05-26: gdb_smob was useful during early development as a
195 "baseclass" for all gdb smobs. If it's still unused by gdb 8.0 delete it.
197 IMPORTANT: chained_gdb_smob and eqable_gdb-smob are "subclasses" of
198 gdb_smob. The layout of chained_gdb_smob,eqable_gdb_smob must match
199 gdb_smob as if it is a subclass. To that end we use macro GDB_SMOB_HEAD
202 #define GDB_SMOB_HEAD \
203 int empty_base_class;
210 typedef struct _chained_gdb_smob
214 struct _chained_gdb_smob *prev;
215 struct _chained_gdb_smob *next;
218 typedef struct _eqable_gdb_smob
222 /* The object we are contained in.
223 This can be used for several purposes.
224 This is used by the eq? machinery: We need to be able to see if we have
225 already created an object for a symbol, and if so use that SCM.
226 This may also be used to protect the smob from GC if there is
227 a reference to this smob from outside of GC space (i.e., from gdb).
228 This can also be used in place of chained_gdb_smob where we need to
229 keep track of objfile referencing objects. When the objfile is deleted
230 we need to invalidate the objects: we can do that using the same hashtab
231 used to record the smob for eq-ability. */
240 /* A predicate that returns non-zero if an object is a particular kind
242 typedef int (gsmob_pred_func) (SCM);
244 extern scm_t_bits gdbscm_make_smob_type (const char *name, size_t size);
246 extern void gdbscm_init_gsmob (gdb_smob *base);
248 extern void gdbscm_init_chained_gsmob (chained_gdb_smob *base);
250 extern void gdbscm_init_eqable_gsmob (eqable_gdb_smob *base,
253 extern void gdbscm_add_objfile_ref (struct objfile *objfile,
254 const struct objfile_data *data_key,
255 chained_gdb_smob *g_smob);
257 extern void gdbscm_remove_objfile_ref (struct objfile *objfile,
258 const struct objfile_data *data_key,
259 chained_gdb_smob *g_smob);
261 extern htab_t gdbscm_create_eqable_gsmob_ptr_map (htab_hash hash_fn,
264 extern eqable_gdb_smob **gdbscm_find_eqable_gsmob_ptr_slot
265 (htab_t htab, eqable_gdb_smob *base);
267 extern void gdbscm_fill_eqable_gsmob_ptr_slot (eqable_gdb_smob **slot,
268 eqable_gdb_smob *base);
270 extern void gdbscm_clear_eqable_gsmob_ptr_slot (htab_t htab,
271 eqable_gdb_smob *base);
273 /* Exceptions and calling out to Guile. */
275 /* scm-exception.c */
277 extern SCM gdbscm_make_exception (SCM tag, SCM args);
279 extern int gdbscm_is_exception (SCM scm);
281 extern SCM gdbscm_exception_key (SCM excp);
283 extern SCM gdbscm_exception_args (SCM excp);
285 extern SCM gdbscm_make_exception_with_stack (SCM key, SCM args, SCM stack);
287 extern SCM gdbscm_make_error_scm (SCM key, SCM subr, SCM message,
290 extern SCM gdbscm_make_error (SCM key, const char *subr, const char *message,
293 extern SCM gdbscm_make_type_error (const char *subr, int arg_pos,
294 SCM bad_value, const char *expected_type);
296 extern SCM gdbscm_make_invalid_object_error (const char *subr, int arg_pos,
297 SCM bad_value, const char *error);
299 extern void gdbscm_invalid_object_error (const char *subr, int arg_pos,
300 SCM bad_value, const char *error)
303 extern SCM gdbscm_make_out_of_range_error (const char *subr, int arg_pos,
304 SCM bad_value, const char *error);
306 extern void gdbscm_out_of_range_error (const char *subr, int arg_pos,
307 SCM bad_value, const char *error)
310 extern SCM gdbscm_make_misc_error (const char *subr, int arg_pos,
311 SCM bad_value, const char *error);
313 extern void gdbscm_misc_error (const char *subr, int arg_pos,
314 SCM bad_value, const char *error)
317 extern void gdbscm_throw (SCM exception) ATTRIBUTE_NORETURN;
319 extern SCM gdbscm_scm_from_gdb_exception (struct gdb_exception exception);
321 extern void gdbscm_throw_gdb_exception (struct gdb_exception exception)
324 extern void gdbscm_print_exception_with_stack (SCM port, SCM stack,
327 extern void gdbscm_print_gdb_exception (SCM port, SCM exception);
329 extern char *gdbscm_exception_message_to_string (SCM exception);
331 extern excp_matcher_func gdbscm_memory_error_p;
333 extern excp_matcher_func gdbscm_user_error_p;
335 extern SCM gdbscm_make_memory_error (const char *subr, const char *msg,
338 extern void gdbscm_memory_error (const char *subr, const char *msg, SCM args)
341 /* scm-safe-call.c */
343 extern void *gdbscm_with_guile (void *(*func) (void *), void *data);
345 extern SCM gdbscm_call_guile (SCM (*func) (void *), void *data,
346 excp_matcher_func *ok_excps);
348 extern SCM gdbscm_safe_call_0 (SCM proc, excp_matcher_func *ok_excps);
350 extern SCM gdbscm_safe_call_1 (SCM proc, SCM arg0,
351 excp_matcher_func *ok_excps);
353 extern SCM gdbscm_safe_call_2 (SCM proc, SCM arg0, SCM arg1,
354 excp_matcher_func *ok_excps);
356 extern SCM gdbscm_safe_call_3 (SCM proc, SCM arg0, SCM arg1, SCM arg2,
357 excp_matcher_func *ok_excps);
359 extern SCM gdbscm_safe_call_4 (SCM proc, SCM arg0, SCM arg1, SCM arg2,
361 excp_matcher_func *ok_excps);
363 extern SCM gdbscm_safe_apply_1 (SCM proc, SCM arg0, SCM args,
364 excp_matcher_func *ok_excps);
366 extern SCM gdbscm_unsafe_call_1 (SCM proc, SCM arg0);
368 extern char *gdbscm_safe_eval_string (const char *string, int display_result);
370 extern char *gdbscm_safe_source_script (const char *filename);
372 extern void gdbscm_enter_repl (void);
374 /* Interface to various GDB objects, in alphabetical order. */
378 typedef struct _arch_smob arch_smob;
380 extern struct gdbarch *arscm_get_gdbarch (arch_smob *a_smob);
382 extern arch_smob *arscm_get_arch_smob_arg_unsafe (SCM arch_scm, int arg_pos,
383 const char *func_name);
385 extern SCM arscm_scm_from_arch (struct gdbarch *gdbarch);
389 extern SCM bkscm_scm_from_block (const struct block *block,
390 struct objfile *objfile);
392 extern const struct block *bkscm_scm_to_block
393 (SCM block_scm, int arg_pos, const char *func_name, SCM *excp);
397 extern char *gdbscm_parse_command_name (const char *name,
398 const char *func_name, int arg_pos,
399 struct cmd_list_element ***base_list,
400 struct cmd_list_element **start_list);
402 extern int gdbscm_valid_command_class_p (int command_class);
404 extern char *gdbscm_canonicalize_command_name (const char *name,
405 int want_trailing_space);
409 typedef struct _frame_smob frame_smob;
411 extern int frscm_is_frame (SCM scm);
413 extern frame_smob *frscm_get_frame_smob_arg_unsafe (SCM frame_scm, int arg_pos,
414 const char *func_name);
416 extern struct frame_info *frscm_frame_smob_to_frame (frame_smob *);
420 typedef struct _iterator_smob iterator_smob;
422 extern SCM itscm_iterator_smob_object (iterator_smob *i_smob);
424 extern SCM itscm_iterator_smob_progress (iterator_smob *i_smob);
426 extern void itscm_set_iterator_smob_progress_x (iterator_smob *i_smob,
429 extern const char *itscm_iterator_smob_name (void);
431 extern SCM gdbscm_make_iterator (SCM object, SCM progress, SCM next);
433 extern int itscm_is_iterator (SCM scm);
435 extern SCM gdbscm_end_of_iteration (void);
437 extern int itscm_is_end_of_iteration (SCM obj);
439 extern SCM itscm_safe_call_next_x (SCM iter, excp_matcher_func *ok_excps);
441 extern SCM itscm_get_iterator_arg_unsafe (SCM self, int arg_pos,
442 const char *func_name);
444 /* scm-lazy-string.c */
446 extern int lsscm_is_lazy_string (SCM scm);
448 extern SCM lsscm_make_lazy_string (CORE_ADDR address, int length,
449 const char *encoding, struct type *type);
451 extern struct value *lsscm_safe_lazy_string_to_value (SCM string,
453 const char *func_name,
456 extern void lsscm_val_print_lazy_string
457 (SCM string, struct ui_file *stream,
458 const struct value_print_options *options);
462 typedef struct _objfile_smob objfile_smob;
464 extern SCM ofscm_objfile_smob_pretty_printers (objfile_smob *o_smob);
466 extern objfile_smob *ofscm_objfile_smob_from_objfile (struct objfile *objfile);
468 extern SCM ofscm_scm_from_objfile (struct objfile *objfile);
470 /* scm-progspace.c */
472 typedef struct _pspace_smob pspace_smob;
474 extern SCM psscm_pspace_smob_pretty_printers (const pspace_smob *);
476 extern pspace_smob *psscm_pspace_smob_from_pspace (struct program_space *);
478 extern SCM psscm_scm_from_pspace (struct program_space *);
482 extern int gdbscm_scm_string_to_int (SCM string);
484 extern char *gdbscm_scm_to_c_string (SCM string);
486 extern SCM gdbscm_scm_from_c_string (const char *string);
488 extern SCM gdbscm_scm_from_printf (const char *format, ...)
489 ATTRIBUTE_PRINTF (1, 2);
491 extern char *gdbscm_scm_to_string (SCM string, size_t *lenp,
493 int strict, SCM *except_scmp);
495 extern SCM gdbscm_scm_from_string (const char *string, size_t len,
496 const char *charset, int strict);
498 extern char *gdbscm_scm_to_host_string (SCM string, size_t *lenp, SCM *except);
500 extern SCM gdbscm_scm_from_host_string (const char *string, size_t len);
504 extern int syscm_is_symbol (SCM scm);
506 extern SCM syscm_scm_from_symbol (struct symbol *symbol);
508 extern struct symbol *syscm_get_valid_symbol_arg_unsafe
509 (SCM self, int arg_pos, const char *func_name);
513 extern SCM stscm_scm_from_symtab (struct symtab *symtab);
515 extern SCM stscm_scm_from_sal (struct symtab_and_line sal);
519 typedef struct _type_smob type_smob;
521 extern int tyscm_is_type (SCM scm);
523 extern SCM tyscm_scm_from_type (struct type *type);
525 extern type_smob *tyscm_get_type_smob_arg_unsafe (SCM type_scm, int arg_pos,
526 const char *func_name);
528 extern struct type *tyscm_type_smob_type (type_smob *t_smob);
530 extern SCM tyscm_scm_from_field (SCM type_scm, int field_num);
534 extern struct value *vlscm_scm_to_value (SCM scm);
536 extern int vlscm_is_value (SCM scm);
538 extern SCM vlscm_scm_from_value (struct value *value);
540 extern SCM vlscm_scm_from_value_unsafe (struct value *value);
542 extern struct value *vlscm_convert_typed_value_from_scheme
543 (const char *func_name, int obj_arg_pos, SCM obj,
544 int type_arg_pos, SCM type_scm, struct type *type, SCM *except_scmp,
545 struct gdbarch *gdbarch, const struct language_defn *language);
547 extern struct value *vlscm_convert_value_from_scheme
548 (const char *func_name, int obj_arg_pos, SCM obj, SCM *except_scmp,
549 struct gdbarch *gdbarch, const struct language_defn *language);
551 /* stript_lang methods */
553 extern objfile_script_sourcer_func gdbscm_source_objfile_script;
554 extern objfile_script_executor_func gdbscm_execute_objfile_script;
556 extern int gdbscm_auto_load_enabled (const struct extension_language_defn *);
558 extern void gdbscm_preserve_values
559 (const struct extension_language_defn *,
560 struct objfile *, htab_t copied_types);
562 extern enum ext_lang_rc gdbscm_apply_val_pretty_printer
563 (const struct extension_language_defn *,
564 struct type *type, const gdb_byte *valaddr,
565 int embedded_offset, CORE_ADDR address,
566 struct ui_file *stream, int recurse,
567 const struct value *val,
568 const struct value_print_options *options,
569 const struct language_defn *language);
571 extern int gdbscm_breakpoint_has_cond (const struct extension_language_defn *,
572 struct breakpoint *b);
574 extern enum ext_lang_bp_stop gdbscm_breakpoint_cond_says_stop
575 (const struct extension_language_defn *, struct breakpoint *b);
577 /* Initializers for each piece of Scheme support, in alphabetical order. */
579 extern void gdbscm_initialize_arches (void);
580 extern void gdbscm_initialize_auto_load (void);
581 extern void gdbscm_initialize_blocks (void);
582 extern void gdbscm_initialize_breakpoints (void);
583 extern void gdbscm_initialize_commands (void);
584 extern void gdbscm_initialize_disasm (void);
585 extern void gdbscm_initialize_exceptions (void);
586 extern void gdbscm_initialize_frames (void);
587 extern void gdbscm_initialize_iterators (void);
588 extern void gdbscm_initialize_lazy_strings (void);
589 extern void gdbscm_initialize_math (void);
590 extern void gdbscm_initialize_objfiles (void);
591 extern void gdbscm_initialize_pretty_printers (void);
592 extern void gdbscm_initialize_parameters (void);
593 extern void gdbscm_initialize_ports (void);
594 extern void gdbscm_initialize_pspaces (void);
595 extern void gdbscm_initialize_smobs (void);
596 extern void gdbscm_initialize_strings (void);
597 extern void gdbscm_initialize_symbols (void);
598 extern void gdbscm_initialize_symtabs (void);
599 extern void gdbscm_initialize_types (void);
600 extern void gdbscm_initialize_values (void);
602 /* Use these after a TRY_CATCH to throw the appropriate Scheme exception
603 if a GDB error occurred. */
605 #define GDBSCM_HANDLE_GDB_EXCEPTION(exception) \
607 if (exception.reason < 0) \
609 gdbscm_throw_gdb_exception (exception); \
614 /* If cleanups are establish outside the TRY_CATCH block, use this version. */
616 #define GDBSCM_HANDLE_GDB_EXCEPTION_WITH_CLEANUPS(exception, cleanups) \
618 if (exception.reason < 0) \
620 do_cleanups (cleanups); \
621 gdbscm_throw_gdb_exception (exception); \
626 #endif /* GDB_GUILE_INTERNAL_H */