1 /* Internal header for GDB/Scheme code.
3 Copyright (C) 2014 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 const char gdbscm_print_excp_none[];
125 extern const char gdbscm_print_excp_full[];
126 extern const char gdbscm_print_excp_message[];
127 extern const char *gdbscm_print_excp;
129 extern SCM gdbscm_documentation_symbol;
130 extern SCM gdbscm_invalid_object_error_symbol;
132 extern SCM gdbscm_map_string;
133 extern SCM gdbscm_array_string;
134 extern SCM gdbscm_string_string;
138 extern void gdbscm_define_variables (const scheme_variable *, int public);
140 extern void gdbscm_define_functions (const scheme_function *, int public);
142 extern void gdbscm_define_integer_constants (const scheme_integer_constant *,
145 extern void gdbscm_printf (SCM port, const char *format, ...);
147 extern void gdbscm_debug_display (SCM obj);
149 extern void gdbscm_debug_write (SCM obj);
151 extern void gdbscm_parse_function_args (const char *function_name,
152 int beginning_arg_pos,
154 const char *format, ...);
156 extern SCM gdbscm_scm_from_longest (LONGEST l);
158 extern LONGEST gdbscm_scm_to_longest (SCM l);
160 extern SCM gdbscm_scm_from_ulongest (ULONGEST l);
162 extern ULONGEST gdbscm_scm_to_ulongest (SCM u);
164 extern void gdbscm_dynwind_xfree (void *ptr);
166 extern int gdbscm_is_procedure (SCM proc);
168 /* GDB smobs, from scm-gsmob.c */
170 /* All gdb smobs must contain one of the following as the first member:
171 gdb_smob, chained_gdb_smob, or eqable_gdb_smob.
173 Chained GDB smobs should have chained_gdb_smob as their first member. The
174 next,prev members of chained_gdb_smob allow for chaining gsmobs together so
175 that, for example, when an objfile is deleted we can clean up all smobs that
178 Eq-able GDB smobs should have eqable_gdb_smob as their first member. The
179 containing_scm member of eqable_gdb_smob allows for returning the same gsmob
180 instead of creating a new one, allowing them to be eq?-able.
182 All other smobs should have gdb_smob as their first member.
183 FIXME: dje/2014-05-26: gdb_smob was useful during early development as a
184 "baseclass" for all gdb smobs. If it's still unused by gdb 8.0 delete it.
186 IMPORTANT: chained_gdb_smob and eqable_gdb-smob are "subclasses" of
187 gdb_smob. The layout of chained_gdb_smob,eqable_gdb_smob must match
188 gdb_smob as if it is a subclass. To that end we use macro GDB_SMOB_HEAD
191 #define GDB_SMOB_HEAD \
192 int empty_base_class;
199 typedef struct _chained_gdb_smob
203 struct _chained_gdb_smob *prev;
204 struct _chained_gdb_smob *next;
207 typedef struct _eqable_gdb_smob
211 /* The object we are contained in.
212 This can be used for several purposes.
213 This is used by the eq? machinery: We need to be able to see if we have
214 already created an object for a symbol, and if so use that SCM.
215 This may also be used to protect the smob from GC if there is
216 a reference to this smob from outside of GC space (i.e., from gdb).
217 This can also be used in place of chained_gdb_smob where we need to
218 keep track of objfile referencing objects. When the objfile is deleted
219 we need to invalidate the objects: we can do that using the same hashtab
220 used to record the smob for eq-ability. */
229 /* A predicate that returns non-zero if an object is a particular kind
231 typedef int (gsmob_pred_func) (SCM);
233 extern scm_t_bits gdbscm_make_smob_type (const char *name, size_t size);
235 extern void gdbscm_init_gsmob (gdb_smob *base);
237 extern void gdbscm_init_chained_gsmob (chained_gdb_smob *base);
239 extern void gdbscm_init_eqable_gsmob (eqable_gdb_smob *base,
242 extern void gdbscm_add_objfile_ref (struct objfile *objfile,
243 const struct objfile_data *data_key,
244 chained_gdb_smob *g_smob);
246 extern void gdbscm_remove_objfile_ref (struct objfile *objfile,
247 const struct objfile_data *data_key,
248 chained_gdb_smob *g_smob);
250 extern htab_t gdbscm_create_eqable_gsmob_ptr_map (htab_hash hash_fn,
253 extern eqable_gdb_smob **gdbscm_find_eqable_gsmob_ptr_slot
254 (htab_t htab, eqable_gdb_smob *base);
256 extern void gdbscm_fill_eqable_gsmob_ptr_slot (eqable_gdb_smob **slot,
257 eqable_gdb_smob *base);
259 extern void gdbscm_clear_eqable_gsmob_ptr_slot (htab_t htab,
260 eqable_gdb_smob *base);
262 /* Exceptions and calling out to Guile. */
264 /* scm-exception.c */
266 extern SCM gdbscm_make_exception (SCM tag, SCM args);
268 extern int gdbscm_is_exception (SCM scm);
270 extern SCM gdbscm_exception_key (SCM excp);
272 extern SCM gdbscm_exception_args (SCM excp);
274 extern SCM gdbscm_make_exception_with_stack (SCM key, SCM args, SCM stack);
276 extern SCM gdbscm_make_error_scm (SCM key, SCM subr, SCM message,
279 extern SCM gdbscm_make_error (SCM key, const char *subr, const char *message,
282 extern SCM gdbscm_make_type_error (const char *subr, int arg_pos,
283 SCM bad_value, const char *expected_type);
285 extern SCM gdbscm_make_invalid_object_error (const char *subr, int arg_pos,
286 SCM bad_value, const char *error);
288 extern void gdbscm_invalid_object_error (const char *subr, int arg_pos,
289 SCM bad_value, const char *error)
292 extern SCM gdbscm_make_out_of_range_error (const char *subr, int arg_pos,
293 SCM bad_value, const char *error);
295 extern void gdbscm_out_of_range_error (const char *subr, int arg_pos,
296 SCM bad_value, const char *error)
299 extern SCM gdbscm_make_misc_error (const char *subr, int arg_pos,
300 SCM bad_value, const char *error);
302 extern void gdbscm_throw (SCM exception) ATTRIBUTE_NORETURN;
304 extern SCM gdbscm_scm_from_gdb_exception (struct gdb_exception exception);
306 extern void gdbscm_throw_gdb_exception (struct gdb_exception exception)
309 extern void gdbscm_print_exception_with_stack (SCM port, SCM stack,
312 extern void gdbscm_print_gdb_exception (SCM port, SCM exception);
314 extern char *gdbscm_exception_message_to_string (SCM exception);
316 extern excp_matcher_func gdbscm_memory_error_p;
318 extern SCM gdbscm_make_memory_error (const char *subr, const char *msg,
321 extern void gdbscm_memory_error (const char *subr, const char *msg, SCM args)
324 /* scm-safe-call.c */
326 extern void *gdbscm_with_guile (void *(*func) (void *), void *data);
328 extern SCM gdbscm_call_guile (SCM (*func) (void *), void *data,
329 excp_matcher_func *ok_excps);
331 extern SCM gdbscm_safe_call_0 (SCM proc, excp_matcher_func *ok_excps);
333 extern SCM gdbscm_safe_call_1 (SCM proc, SCM arg0,
334 excp_matcher_func *ok_excps);
336 extern SCM gdbscm_safe_call_2 (SCM proc, SCM arg0, SCM arg1,
337 excp_matcher_func *ok_excps);
339 extern SCM gdbscm_safe_call_3 (SCM proc, SCM arg0, SCM arg1, SCM arg2,
340 excp_matcher_func *ok_excps);
342 extern SCM gdbscm_safe_call_4 (SCM proc, SCM arg0, SCM arg1, SCM arg2,
344 excp_matcher_func *ok_excps);
346 extern SCM gdbscm_safe_apply_1 (SCM proc, SCM arg0, SCM args,
347 excp_matcher_func *ok_excps);
349 extern SCM gdbscm_unsafe_call_1 (SCM proc, SCM arg0);
351 extern char *gdbscm_safe_eval_string (const char *string, int display_result);
353 extern char *gdbscm_safe_source_script (const char *filename);
355 extern void gdbscm_enter_repl (void);
357 /* Interface to various GDB objects, in alphabetical order. */
361 typedef struct _arch_smob arch_smob;
363 extern struct gdbarch *arscm_get_gdbarch (arch_smob *a_smob);
365 extern arch_smob *arscm_get_arch_smob_arg_unsafe (SCM arch_scm, int arg_pos,
366 const char *func_name);
368 extern SCM arscm_scm_from_arch (struct gdbarch *gdbarch);
372 extern SCM bkscm_scm_from_block (const struct block *block,
373 struct objfile *objfile);
375 extern const struct block *bkscm_scm_to_block
376 (SCM block_scm, int arg_pos, const char *func_name, SCM *excp);
380 typedef struct _frame_smob frame_smob;
382 extern int frscm_is_frame (SCM scm);
384 extern frame_smob *frscm_get_frame_smob_arg_unsafe (SCM frame_scm, int arg_pos,
385 const char *func_name);
387 extern struct frame_info *frscm_frame_smob_to_frame (frame_smob *);
391 typedef struct _iterator_smob iterator_smob;
393 extern SCM itscm_iterator_smob_object (iterator_smob *i_smob);
395 extern SCM itscm_iterator_smob_progress (iterator_smob *i_smob);
397 extern void itscm_set_iterator_smob_progress_x (iterator_smob *i_smob,
400 extern const char *itscm_iterator_smob_name (void);
402 extern SCM gdbscm_make_iterator (SCM object, SCM progress, SCM next);
404 extern int itscm_is_iterator (SCM scm);
406 extern SCM gdbscm_end_of_iteration (void);
408 extern int itscm_is_end_of_iteration (SCM obj);
410 extern SCM itscm_safe_call_next_x (SCM iter, excp_matcher_func *ok_excps);
412 extern SCM itscm_get_iterator_arg_unsafe (SCM self, int arg_pos,
413 const char *func_name);
415 /* scm-lazy-string.c */
417 extern int lsscm_is_lazy_string (SCM scm);
419 extern SCM lsscm_make_lazy_string (CORE_ADDR address, int length,
420 const char *encoding, struct type *type);
422 extern struct value *lsscm_safe_lazy_string_to_value (SCM string,
424 const char *func_name,
427 extern void lsscm_val_print_lazy_string
428 (SCM string, struct ui_file *stream,
429 const struct value_print_options *options);
433 typedef struct _objfile_smob objfile_smob;
435 extern SCM ofscm_objfile_smob_pretty_printers (objfile_smob *o_smob);
437 extern objfile_smob *ofscm_objfile_smob_from_objfile (struct objfile *objfile);
439 extern SCM ofscm_scm_from_objfile (struct objfile *objfile);
443 extern char *gdbscm_scm_to_c_string (SCM string);
445 extern SCM gdbscm_scm_from_c_string (const char *string);
447 extern SCM gdbscm_scm_from_printf (const char *format, ...);
449 extern char *gdbscm_scm_to_string (SCM string, size_t *lenp,
451 int strict, SCM *except_scmp);
453 extern SCM gdbscm_scm_from_string (const char *string, size_t len,
454 const char *charset, int strict);
458 extern int syscm_is_symbol (SCM scm);
460 extern SCM syscm_scm_from_symbol (struct symbol *symbol);
462 extern struct symbol *syscm_get_valid_symbol_arg_unsafe
463 (SCM self, int arg_pos, const char *func_name);
467 extern SCM stscm_scm_from_symtab (struct symtab *symtab);
469 extern SCM stscm_scm_from_sal (struct symtab_and_line sal);
473 typedef struct _type_smob type_smob;
475 extern int tyscm_is_type (SCM scm);
477 extern SCM tyscm_scm_from_type (struct type *type);
479 extern type_smob *tyscm_get_type_smob_arg_unsafe (SCM type_scm, int arg_pos,
480 const char *func_name);
482 extern struct type *tyscm_type_smob_type (type_smob *t_smob);
484 extern SCM tyscm_scm_from_field (SCM type_scm, int field_num);
488 extern struct value *vlscm_scm_to_value (SCM scm);
490 extern int vlscm_is_value (SCM scm);
492 extern SCM vlscm_scm_from_value (struct value *value);
494 extern SCM vlscm_scm_from_value_unsafe (struct value *value);
496 extern struct value *vlscm_convert_typed_value_from_scheme
497 (const char *func_name, int obj_arg_pos, SCM obj,
498 int type_arg_pos, SCM type_scm, struct type *type, SCM *except_scmp,
499 struct gdbarch *gdbarch, const struct language_defn *language);
501 extern struct value *vlscm_convert_value_from_scheme
502 (const char *func_name, int obj_arg_pos, SCM obj, SCM *except_scmp,
503 struct gdbarch *gdbarch, const struct language_defn *language);
505 /* stript_lang methods */
507 extern objfile_script_sourcer_func gdbscm_source_objfile_script;
509 extern int gdbscm_auto_load_enabled (const struct extension_language_defn *);
511 extern void gdbscm_preserve_values
512 (const struct extension_language_defn *,
513 struct objfile *, htab_t copied_types);
515 extern enum ext_lang_rc gdbscm_apply_val_pretty_printer
516 (const struct extension_language_defn *,
517 struct type *type, const gdb_byte *valaddr,
518 int embedded_offset, CORE_ADDR address,
519 struct ui_file *stream, int recurse,
520 const struct value *val,
521 const struct value_print_options *options,
522 const struct language_defn *language);
524 extern int gdbscm_breakpoint_has_cond (const struct extension_language_defn *,
525 struct breakpoint *b);
527 extern enum ext_lang_bp_stop gdbscm_breakpoint_cond_says_stop
528 (const struct extension_language_defn *, struct breakpoint *b);
530 /* Initializers for each piece of Scheme support, in alphabetical order. */
532 extern void gdbscm_initialize_arches (void);
533 extern void gdbscm_initialize_auto_load (void);
534 extern void gdbscm_initialize_blocks (void);
535 extern void gdbscm_initialize_breakpoints (void);
536 extern void gdbscm_initialize_disasm (void);
537 extern void gdbscm_initialize_exceptions (void);
538 extern void gdbscm_initialize_frames (void);
539 extern void gdbscm_initialize_iterators (void);
540 extern void gdbscm_initialize_lazy_strings (void);
541 extern void gdbscm_initialize_math (void);
542 extern void gdbscm_initialize_objfiles (void);
543 extern void gdbscm_initialize_pretty_printers (void);
544 extern void gdbscm_initialize_ports (void);
545 extern void gdbscm_initialize_smobs (void);
546 extern void gdbscm_initialize_strings (void);
547 extern void gdbscm_initialize_symbols (void);
548 extern void gdbscm_initialize_symtabs (void);
549 extern void gdbscm_initialize_types (void);
550 extern void gdbscm_initialize_values (void);
552 /* Use these after a TRY_CATCH to throw the appropriate Scheme exception
553 if a GDB error occurred. */
555 #define GDBSCM_HANDLE_GDB_EXCEPTION(exception) \
557 if (exception.reason < 0) \
559 gdbscm_throw_gdb_exception (exception); \
564 /* If cleanups are establish outside the TRY_CATCH block, use this version. */
566 #define GDBSCM_HANDLE_GDB_EXCEPTION_WITH_CLEANUPS(exception, cleanups) \
568 if (exception.reason < 0) \
570 do_cleanups (cleanups); \
571 gdbscm_throw_gdb_exception (exception); \
576 #endif /* GDB_GUILE_INTERNAL_H */