6b5faa38bcc1e5b2df4da3475ccf54488a8712c8
[deliverable/binutils-gdb.git] / gdb / guile / guile.c
1 /* General GDB/Guile code.
2
3 Copyright (C) 2014-2018 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 /* See README file in this directory for implementation notes, coding
21 conventions, et.al. */
22
23 #include "defs.h"
24 #include "breakpoint.h"
25 #include "cli/cli-cmds.h"
26 #include "cli/cli-script.h"
27 #include "cli/cli-utils.h"
28 #include "command.h"
29 #include "gdbcmd.h"
30 #include "top.h"
31 #include "extension-priv.h"
32 #include "utils.h"
33 #include "version.h"
34 #ifdef HAVE_GUILE
35 #include "guile.h"
36 #include "guile-internal.h"
37 #endif
38 #include <signal.h>
39
40 /* The Guile version we're using.
41 We *could* use the macros in libguile/version.h but that would preclude
42 handling the user switching in a different version with, e.g.,
43 LD_LIBRARY_PATH (using a different version than what gdb was compiled with
44 is not something to be done lightly, but can be useful). */
45 int gdbscm_guile_major_version;
46 int gdbscm_guile_minor_version;
47 int gdbscm_guile_micro_version;
48
49 /* The guile subdirectory within gdb's data-directory. */
50 static const char *guile_datadir;
51
52 /* Declared constants and enum for guile exception printing. */
53 const char gdbscm_print_excp_none[] = "none";
54 const char gdbscm_print_excp_full[] = "full";
55 const char gdbscm_print_excp_message[] = "message";
56
57 /* "set guile print-stack" choices. */
58 static const char *const guile_print_excp_enums[] =
59 {
60 gdbscm_print_excp_none,
61 gdbscm_print_excp_full,
62 gdbscm_print_excp_message,
63 NULL
64 };
65
66 /* The exception printing variable. 'full' if we want to print the
67 error message and stack, 'none' if we want to print nothing, and
68 'message' if we only want to print the error message. 'message' is
69 the default. */
70 const char *gdbscm_print_excp = gdbscm_print_excp_message;
71
72 #ifdef HAVE_GUILE
73 /* Forward decls, these are defined later. */
74 extern const struct extension_language_script_ops guile_extension_script_ops;
75 extern const struct extension_language_ops guile_extension_ops;
76 #endif
77
78 /* The main struct describing GDB's interface to the Guile
79 extension language. */
80 extern const struct extension_language_defn extension_language_guile =
81 {
82 EXT_LANG_GUILE,
83 "guile",
84 "Guile",
85
86 ".scm",
87 "-gdb.scm",
88
89 guile_control,
90
91 #ifdef HAVE_GUILE
92 &guile_extension_script_ops,
93 &guile_extension_ops
94 #else
95 NULL,
96 NULL
97 #endif
98 };
99 \f
100 #ifdef HAVE_GUILE
101
102 static void gdbscm_finish_initialization
103 (const struct extension_language_defn *);
104 static int gdbscm_initialized (const struct extension_language_defn *);
105 static void gdbscm_eval_from_control_command
106 (const struct extension_language_defn *, struct command_line *);
107 static script_sourcer_func gdbscm_source_script;
108
109 int gdb_scheme_initialized;
110
111 /* Symbol for setting documentation strings. */
112 SCM gdbscm_documentation_symbol;
113
114 /* Keywords used by various functions. */
115 static SCM from_tty_keyword;
116 static SCM to_string_keyword;
117
118 /* The name of the various modules (without the surrounding parens). */
119 const char gdbscm_module_name[] = "gdb";
120 const char gdbscm_init_module_name[] = "gdb";
121
122 /* The name of the bootstrap file. */
123 static const char boot_scm_filename[] = "boot.scm";
124
125 /* The interface between gdb proper and loading of python scripts. */
126
127 const struct extension_language_script_ops guile_extension_script_ops =
128 {
129 gdbscm_source_script,
130 gdbscm_source_objfile_script,
131 gdbscm_execute_objfile_script,
132 gdbscm_auto_load_enabled
133 };
134
135 /* The interface between gdb proper and guile scripting. */
136
137 const struct extension_language_ops guile_extension_ops =
138 {
139 gdbscm_finish_initialization,
140 gdbscm_initialized,
141
142 gdbscm_eval_from_control_command,
143
144 NULL, /* gdbscm_start_type_printers, */
145 NULL, /* gdbscm_apply_type_printers, */
146 NULL, /* gdbscm_free_type_printers, */
147
148 gdbscm_apply_val_pretty_printer,
149
150 NULL, /* gdbscm_apply_frame_filter, */
151
152 gdbscm_preserve_values,
153
154 gdbscm_breakpoint_has_cond,
155 gdbscm_breakpoint_cond_says_stop,
156
157 NULL, /* gdbscm_check_quit_flag, */
158 NULL, /* gdbscm_set_quit_flag, */
159 };
160
161 /* Implementation of the gdb "guile-repl" command. */
162
163 static void
164 guile_repl_command (const char *arg, int from_tty)
165 {
166 scoped_restore restore_async = make_scoped_restore (&current_ui->async, 0);
167
168 arg = skip_spaces (arg);
169
170 /* This explicitly rejects any arguments for now.
171 "It is easier to relax a restriction than impose one after the fact."
172 We would *like* to be able to pass arguments to the interactive shell
173 but that's not what python-interactive does. Until there is time to
174 sort it out, we forbid arguments. */
175
176 if (arg && *arg)
177 error (_("guile-repl currently does not take any arguments."));
178 else
179 {
180 dont_repeat ();
181 gdbscm_enter_repl ();
182 }
183 }
184
185 /* Implementation of the gdb "guile" command.
186 Note: Contrary to the Python version this displays the result.
187 Have to see which is better.
188
189 TODO: Add the result to Guile's history? */
190
191 static void
192 guile_command (const char *arg, int from_tty)
193 {
194 scoped_restore restore_async = make_scoped_restore (&current_ui->async, 0);
195
196 arg = skip_spaces (arg);
197
198 if (arg && *arg)
199 {
200 gdb::unique_xmalloc_ptr<char> msg = gdbscm_safe_eval_string (arg, 1);
201
202 if (msg != NULL)
203 error ("%s", msg.get ());
204 }
205 else
206 {
207 counted_command_line l = get_command_line (guile_control, "");
208
209 execute_control_command_untraced (l.get ());
210 }
211 }
212
213 /* Given a command_line, return a command string suitable for passing
214 to Guile. Lines in the string are separated by newlines. The return
215 value is allocated using xmalloc and the caller is responsible for
216 freeing it. */
217
218 static char *
219 compute_scheme_string (struct command_line *l)
220 {
221 struct command_line *iter;
222 char *script = NULL;
223 int size = 0;
224 int here;
225
226 for (iter = l; iter; iter = iter->next)
227 size += strlen (iter->line) + 1;
228
229 script = (char *) xmalloc (size + 1);
230 here = 0;
231 for (iter = l; iter; iter = iter->next)
232 {
233 int len = strlen (iter->line);
234
235 strcpy (&script[here], iter->line);
236 here += len;
237 script[here++] = '\n';
238 }
239 script[here] = '\0';
240 return script;
241 }
242
243 /* Take a command line structure representing a "guile" command, and
244 evaluate its body using the Guile interpreter.
245 This is the extension_language_ops.eval_from_control_command "method". */
246
247 static void
248 gdbscm_eval_from_control_command
249 (const struct extension_language_defn *extlang, struct command_line *cmd)
250 {
251 char *script;
252
253 if (cmd->body_list_1 != nullptr)
254 error (_("Invalid \"guile\" block structure."));
255
256 script = compute_scheme_string (cmd->body_list_0.get ());
257 gdb::unique_xmalloc_ptr<char> msg = gdbscm_safe_eval_string (script, 0);
258 xfree (script);
259 if (msg != NULL)
260 error ("%s", msg.get ());
261 }
262
263 /* Read a file as Scheme code.
264 This is the extension_language_script_ops.script_sourcer "method".
265 FILE is the file to run. FILENAME is name of the file FILE.
266 This does not throw any errors. If an exception occurs an error message
267 is printed. */
268
269 static void
270 gdbscm_source_script (const struct extension_language_defn *extlang,
271 FILE *file, const char *filename)
272 {
273 char *msg = gdbscm_safe_source_script (filename);
274
275 if (msg != NULL)
276 {
277 fprintf_filtered (gdb_stderr, "%s\n", msg);
278 xfree (msg);
279 }
280 }
281 \f
282 /* (execute string [#:from-tty boolean] [#:to-string boolean])
283 A Scheme function which evaluates a string using the gdb CLI. */
284
285 static SCM
286 gdbscm_execute_gdb_command (SCM command_scm, SCM rest)
287 {
288 int from_tty_arg_pos = -1, to_string_arg_pos = -1;
289 int from_tty = 0, to_string = 0;
290 const SCM keywords[] = { from_tty_keyword, to_string_keyword, SCM_BOOL_F };
291 char *command;
292 struct cleanup *cleanups;
293 struct gdb_exception except = exception_none;
294
295 gdbscm_parse_function_args (FUNC_NAME, SCM_ARG1, keywords, "s#tt",
296 command_scm, &command, rest,
297 &from_tty_arg_pos, &from_tty,
298 &to_string_arg_pos, &to_string);
299
300 /* Note: The contents of "command" may get modified while it is
301 executed. */
302 cleanups = make_cleanup (xfree, command);
303
304 std::string to_string_res;
305
306 TRY
307 {
308 scoped_restore restore_async = make_scoped_restore (&current_ui->async,
309 0);
310
311 scoped_restore preventer = prevent_dont_repeat ();
312 if (to_string)
313 to_string_res = execute_command_to_string (command, from_tty);
314 else
315 execute_command (command, from_tty);
316
317 /* Do any commands attached to breakpoint we stopped at. */
318 bpstat_do_actions ();
319 }
320 CATCH (ex, RETURN_MASK_ALL)
321 {
322 except = ex;
323 }
324 END_CATCH
325
326 do_cleanups (cleanups);
327 GDBSCM_HANDLE_GDB_EXCEPTION (except);
328
329 if (to_string)
330 return gdbscm_scm_from_c_string (to_string_res.c_str ());
331 return SCM_UNSPECIFIED;
332 }
333
334 /* (data-directory) -> string */
335
336 static SCM
337 gdbscm_data_directory (void)
338 {
339 return gdbscm_scm_from_c_string (gdb_datadir);
340 }
341
342 /* (guile-data-directory) -> string */
343
344 static SCM
345 gdbscm_guile_data_directory (void)
346 {
347 return gdbscm_scm_from_c_string (guile_datadir);
348 }
349
350 /* (gdb-version) -> string */
351
352 static SCM
353 gdbscm_gdb_version (void)
354 {
355 return gdbscm_scm_from_c_string (version);
356 }
357
358 /* (host-config) -> string */
359
360 static SCM
361 gdbscm_host_config (void)
362 {
363 return gdbscm_scm_from_c_string (host_name);
364 }
365
366 /* (target-config) -> string */
367
368 static SCM
369 gdbscm_target_config (void)
370 {
371 return gdbscm_scm_from_c_string (target_name);
372 }
373
374 #else /* ! HAVE_GUILE */
375
376 /* Dummy implementation of the gdb "guile-repl" and "guile"
377 commands. */
378
379 static void
380 guile_repl_command (const char *arg, int from_tty)
381 {
382 arg = skip_spaces (arg);
383 if (arg && *arg)
384 error (_("guile-repl currently does not take any arguments."));
385 error (_("Guile scripting is not supported in this copy of GDB."));
386 }
387
388 static void
389 guile_command (const char *arg, int from_tty)
390 {
391 arg = skip_spaces (arg);
392 if (arg && *arg)
393 error (_("Guile scripting is not supported in this copy of GDB."));
394 else
395 {
396 /* Even if Guile isn't enabled, we still have to slurp the
397 command list to the corresponding "end". */
398 counted_command_line l = get_command_line (guile_control, "");
399
400 execute_control_command_untraced (l.get ());
401 }
402 }
403
404 #endif /* ! HAVE_GUILE */
405 \f
406 /* Lists for 'set,show,info guile' commands. */
407
408 static struct cmd_list_element *set_guile_list;
409 static struct cmd_list_element *show_guile_list;
410 static struct cmd_list_element *info_guile_list;
411
412 /* Function for use by 'set guile' prefix command. */
413
414 static void
415 set_guile_command (const char *args, int from_tty)
416 {
417 help_list (set_guile_list, "set guile ", all_commands, gdb_stdout);
418 }
419
420 /* Function for use by 'show guile' prefix command. */
421
422 static void
423 show_guile_command (const char *args, int from_tty)
424 {
425 cmd_show_list (show_guile_list, from_tty, "");
426 }
427
428 /* The "info scheme" command is defined as a prefix, with
429 allow_unknown 0. Therefore, its own definition is called only for
430 "info scheme" with no args. */
431
432 static void
433 info_guile_command (const char *args, int from_tty)
434 {
435 printf_unfiltered (_("\"info guile\" must be followed"
436 " by the name of an info command.\n"));
437 help_list (info_guile_list, "info guile ", all_commands, gdb_stdout);
438 }
439 \f
440 /* Initialization. */
441
442 #ifdef HAVE_GUILE
443
444 static const scheme_function misc_guile_functions[] =
445 {
446 { "execute", 1, 0, 1, as_a_scm_t_subr (gdbscm_execute_gdb_command),
447 "\
448 Execute the given GDB command.\n\
449 \n\
450 Arguments: string [#:to-string boolean] [#:from-tty boolean]\n\
451 If #:from-tty is true then the command executes as if entered\n\
452 from the keyboard. The default is false (#f).\n\
453 If #:to-string is true then the result is returned as a string.\n\
454 Otherwise output is sent to the current output port,\n\
455 which is the default.\n\
456 Returns: The result of the command if #:to-string is true.\n\
457 Otherwise returns unspecified." },
458
459 { "data-directory", 0, 0, 0, as_a_scm_t_subr (gdbscm_data_directory),
460 "\
461 Return the name of GDB's data directory." },
462
463 { "guile-data-directory", 0, 0, 0,
464 as_a_scm_t_subr (gdbscm_guile_data_directory),
465 "\
466 Return the name of the Guile directory within GDB's data directory." },
467
468 { "gdb-version", 0, 0, 0, as_a_scm_t_subr (gdbscm_gdb_version),
469 "\
470 Return GDB's version string." },
471
472 { "host-config", 0, 0, 0, as_a_scm_t_subr (gdbscm_host_config),
473 "\
474 Return the name of the host configuration." },
475
476 { "target-config", 0, 0, 0, as_a_scm_t_subr (gdbscm_target_config),
477 "\
478 Return the name of the target configuration." },
479
480 END_FUNCTIONS
481 };
482
483 /* Load BOOT_SCM_FILE, the first Scheme file that gets loaded. */
484
485 static SCM
486 boot_guile_support (void *boot_scm_file)
487 {
488 /* Load boot.scm without compiling it (there's no need to compile it).
489 The other files should have been compiled already, and boot.scm is
490 expected to adjust '%load-compiled-path' accordingly. If they haven't
491 been compiled, Guile will auto-compile them. The important thing to keep
492 in mind is that there's a >= 100x speed difference between compiled and
493 non-compiled files. */
494 return scm_c_primitive_load ((const char *) boot_scm_file);
495 }
496
497 /* Return non-zero if ARGS has the "standard" format for throw args.
498 The standard format is:
499 (function format-string (format-string-args-list) ...).
500 FUNCTION is #f if no function was recorded. */
501
502 static int
503 standard_throw_args_p (SCM args)
504 {
505 if (gdbscm_is_true (scm_list_p (args))
506 && scm_ilength (args) >= 3)
507 {
508 /* The function in which the error occurred. */
509 SCM arg0 = scm_list_ref (args, scm_from_int (0));
510 /* The format string. */
511 SCM arg1 = scm_list_ref (args, scm_from_int (1));
512 /* The arguments of the format string. */
513 SCM arg2 = scm_list_ref (args, scm_from_int (2));
514
515 if ((scm_is_string (arg0) || gdbscm_is_false (arg0))
516 && scm_is_string (arg1)
517 && gdbscm_is_true (scm_list_p (arg2)))
518 return 1;
519 }
520
521 return 0;
522 }
523
524 /* Print the error recorded in a "standard" throw args. */
525
526 static void
527 print_standard_throw_error (SCM args)
528 {
529 /* The function in which the error occurred. */
530 SCM arg0 = scm_list_ref (args, scm_from_int (0));
531 /* The format string. */
532 SCM arg1 = scm_list_ref (args, scm_from_int (1));
533 /* The arguments of the format string. */
534 SCM arg2 = scm_list_ref (args, scm_from_int (2));
535
536 /* ARG0 is #f if no function was recorded. */
537 if (gdbscm_is_true (arg0))
538 {
539 scm_simple_format (scm_current_error_port (),
540 scm_from_latin1_string (_("Error in function ~s:~%")),
541 scm_list_1 (arg0));
542 }
543 scm_simple_format (scm_current_error_port (), arg1, arg2);
544 }
545
546 /* Print the error message recorded in KEY, ARGS, the arguments to throw.
547 Normally we let Scheme print the error message.
548 This function is used when Scheme initialization fails.
549 We can still use the Scheme C API though. */
550
551 static void
552 print_throw_error (SCM key, SCM args)
553 {
554 /* IWBN to call gdbscm_print_exception_with_stack here, but Guile didn't
555 boot successfully so play it safe and avoid it. The "format string" and
556 its args are embedded in ARGS, but the content of ARGS depends on KEY.
557 Make sure ARGS has the expected canonical content before trying to use
558 it. */
559 if (standard_throw_args_p (args))
560 print_standard_throw_error (args);
561 else
562 {
563 scm_simple_format (scm_current_error_port (),
564 scm_from_latin1_string (_("Throw to key `~a' with args `~s'.~%")),
565 scm_list_2 (key, args));
566 }
567 }
568
569 /* Handle an exception thrown while loading BOOT_SCM_FILE. */
570
571 static SCM
572 handle_boot_error (void *boot_scm_file, SCM key, SCM args)
573 {
574 fprintf_unfiltered (gdb_stderr, ("Exception caught while booting Guile.\n"));
575
576 print_throw_error (key, args);
577
578 fprintf_unfiltered (gdb_stderr, "\n");
579 warning (_("Could not complete Guile gdb module initialization from:\n"
580 "%s.\n"
581 "Limited Guile support is available.\n"
582 "Suggest passing --data-directory=/path/to/gdb/data-directory.\n"),
583 (const char *) boot_scm_file);
584
585 return SCM_UNSPECIFIED;
586 }
587
588 /* Load gdb/boot.scm, the Scheme side of GDB/Guile support.
589 Note: This function assumes it's called within the gdb module. */
590
591 static void
592 initialize_scheme_side (void)
593 {
594 char *boot_scm_path;
595
596 guile_datadir = concat (gdb_datadir, SLASH_STRING, "guile", (char *) NULL);
597 boot_scm_path = concat (guile_datadir, SLASH_STRING, "gdb",
598 SLASH_STRING, boot_scm_filename, (char *) NULL);
599
600 scm_c_catch (SCM_BOOL_T, boot_guile_support, boot_scm_path,
601 handle_boot_error, boot_scm_path, NULL, NULL);
602
603 xfree (boot_scm_path);
604 }
605
606 /* Install the gdb scheme module.
607 The result is a boolean indicating success.
608 If initializing the gdb module fails an error message is printed.
609 Note: This function runs in the context of the gdb module. */
610
611 static void
612 initialize_gdb_module (void *data)
613 {
614 /* Computing these is a pain, so only do it once.
615 Also, do it here and save the result so that obtaining the values
616 is thread-safe. */
617 gdbscm_guile_major_version = gdbscm_scm_string_to_int (scm_major_version ());
618 gdbscm_guile_minor_version = gdbscm_scm_string_to_int (scm_minor_version ());
619 gdbscm_guile_micro_version = gdbscm_scm_string_to_int (scm_micro_version ());
620
621 /* The documentation symbol needs to be defined before any calls to
622 gdbscm_define_{variables,functions}. */
623 gdbscm_documentation_symbol = scm_from_latin1_symbol ("documentation");
624
625 /* The smob and exception support must be initialized early. */
626 gdbscm_initialize_smobs ();
627 gdbscm_initialize_exceptions ();
628
629 /* The rest are initialized in alphabetical order. */
630 gdbscm_initialize_arches ();
631 gdbscm_initialize_auto_load ();
632 gdbscm_initialize_blocks ();
633 gdbscm_initialize_breakpoints ();
634 gdbscm_initialize_commands ();
635 gdbscm_initialize_disasm ();
636 gdbscm_initialize_frames ();
637 gdbscm_initialize_iterators ();
638 gdbscm_initialize_lazy_strings ();
639 gdbscm_initialize_math ();
640 gdbscm_initialize_objfiles ();
641 gdbscm_initialize_parameters ();
642 gdbscm_initialize_ports ();
643 gdbscm_initialize_pretty_printers ();
644 gdbscm_initialize_pspaces ();
645 gdbscm_initialize_strings ();
646 gdbscm_initialize_symbols ();
647 gdbscm_initialize_symtabs ();
648 gdbscm_initialize_types ();
649 gdbscm_initialize_values ();
650
651 gdbscm_define_functions (misc_guile_functions, 1);
652
653 from_tty_keyword = scm_from_latin1_keyword ("from-tty");
654 to_string_keyword = scm_from_latin1_keyword ("to-string");
655
656 initialize_scheme_side ();
657
658 gdb_scheme_initialized = 1;
659 }
660
661 /* Utility to call scm_c_define_module+initialize_gdb_module from
662 within scm_with_guile. */
663
664 static void *
665 call_initialize_gdb_module (void *data)
666 {
667 /* Most of the initialization is done by initialize_gdb_module.
668 It is called via scm_c_define_module so that the initialization is
669 performed within the desired module. */
670 scm_c_define_module (gdbscm_module_name, initialize_gdb_module, NULL);
671
672 #if HAVE_GUILE_MANUAL_FINALIZATION
673 scm_run_finalizers ();
674 #endif
675
676 return NULL;
677 }
678
679 /* A callback to finish Guile initialization after gdb has finished all its
680 initialization.
681 This is the extension_language_ops.finish_initialization "method". */
682
683 static void
684 gdbscm_finish_initialization (const struct extension_language_defn *extlang)
685 {
686 /* Restore the environment to the user interaction one. */
687 scm_set_current_module (scm_interaction_environment ());
688 }
689
690 /* The extension_language_ops.initialized "method". */
691
692 static int
693 gdbscm_initialized (const struct extension_language_defn *extlang)
694 {
695 return gdb_scheme_initialized;
696 }
697
698 /* Enable or disable Guile backtraces. */
699
700 static void
701 gdbscm_set_backtrace (int enable)
702 {
703 static const char disable_bt[] = "(debug-disable 'backtrace)";
704 static const char enable_bt[] = "(debug-enable 'backtrace)";
705
706 if (enable)
707 gdbscm_safe_eval_string (enable_bt, 0);
708 else
709 gdbscm_safe_eval_string (disable_bt, 0);
710 }
711
712 #endif /* HAVE_GUILE */
713
714 /* Install the various gdb commands used by Guile. */
715
716 static void
717 install_gdb_commands (void)
718 {
719 add_com ("guile-repl", class_obscure,
720 guile_repl_command,
721 #ifdef HAVE_GUILE
722 _("\
723 Start an interactive Guile prompt.\n\
724 \n\
725 To return to GDB, type the EOF character (e.g., Ctrl-D on an empty\n\
726 prompt) or ,quit.")
727 #else /* HAVE_GUILE */
728 _("\
729 Start a Guile interactive prompt.\n\
730 \n\
731 Guile scripting is not supported in this copy of GDB.\n\
732 This command is only a placeholder.")
733 #endif /* HAVE_GUILE */
734 );
735 add_com_alias ("gr", "guile-repl", class_obscure, 1);
736
737 /* Since "help guile" is easy to type, and intuitive, we add general help
738 in using GDB+Guile to this command. */
739 add_com ("guile", class_obscure, guile_command,
740 #ifdef HAVE_GUILE
741 _("\
742 Evaluate one or more Guile expressions.\n\
743 \n\
744 The expression(s) can be given as an argument, for instance:\n\
745 \n\
746 guile (display 23)\n\
747 \n\
748 The result of evaluating the last expression is printed.\n\
749 \n\
750 If no argument is given, the following lines are read and passed\n\
751 to Guile for evaluation. Type a line containing \"end\" to indicate\n\
752 the end of the set of expressions.\n\
753 \n\
754 The Guile GDB module must first be imported before it can be used.\n\
755 Do this with:\n\
756 (gdb) guile (use-modules (gdb))\n\
757 or if you want to import the (gdb) module with a prefix, use:\n\
758 (gdb) guile (use-modules ((gdb) #:renamer (symbol-prefix-proc 'gdb:)))\n\
759 \n\
760 The Guile interactive session, started with the \"guile-repl\"\n\
761 command, provides extensive help and apropos capabilities.\n\
762 Type \",help\" once in a Guile interactive session.")
763 #else /* HAVE_GUILE */
764 _("\
765 Evaluate a Guile expression.\n\
766 \n\
767 Guile scripting is not supported in this copy of GDB.\n\
768 This command is only a placeholder.")
769 #endif /* HAVE_GUILE */
770 );
771 add_com_alias ("gu", "guile", class_obscure, 1);
772
773 add_prefix_cmd ("guile", class_obscure, set_guile_command,
774 _("Prefix command for Guile preference settings."),
775 &set_guile_list, "set guile ", 0,
776 &setlist);
777 add_alias_cmd ("gu", "guile", class_obscure, 1, &setlist);
778
779 add_prefix_cmd ("guile", class_obscure, show_guile_command,
780 _("Prefix command for Guile preference settings."),
781 &show_guile_list, "show guile ", 0,
782 &showlist);
783 add_alias_cmd ("gu", "guile", class_obscure, 1, &showlist);
784
785 add_prefix_cmd ("guile", class_obscure, info_guile_command,
786 _("Prefix command for Guile info displays."),
787 &info_guile_list, "info guile ", 0,
788 &infolist);
789 add_info_alias ("gu", "guile", 1);
790
791 /* The name "print-stack" is carried over from Python.
792 A better name is "print-exception". */
793 add_setshow_enum_cmd ("print-stack", no_class, guile_print_excp_enums,
794 &gdbscm_print_excp, _("\
795 Set mode for Guile exception printing on error."), _("\
796 Show the mode of Guile exception printing on error."), _("\
797 none == no stack or message will be printed.\n\
798 full == a message and a stack will be printed.\n\
799 message == an error message without a stack will be printed."),
800 NULL, NULL,
801 &set_guile_list, &show_guile_list);
802 }
803
804 void
805 _initialize_guile (void)
806 {
807 install_gdb_commands ();
808
809 #if HAVE_GUILE
810 {
811 #ifdef HAVE_SIGPROCMASK
812 sigset_t sigchld_mask, prev_mask;
813 #endif
814
815 /* The Python support puts the C side in module "_gdb", leaving the Python
816 side to define module "gdb" which imports "_gdb". There is evidently no
817 similar convention in Guile so we skip this. */
818
819 #if HAVE_GUILE_MANUAL_FINALIZATION
820 /* Our SMOB free functions are not thread-safe, as GDB itself is not
821 intended to be thread-safe. Disable automatic finalization so that
822 finalizers aren't run in other threads. */
823 scm_set_automatic_finalization_enabled (0);
824 #endif
825
826 #ifdef HAVE_SIGPROCMASK
827 /* Before we initialize Guile, block SIGCHLD.
828 This is done so that all threads created during Guile initialization
829 have SIGCHLD blocked. PR 17247.
830 Really libgc and Guile should do this, but we need to work with
831 libgc 7.4.x. */
832 sigemptyset (&sigchld_mask);
833 sigaddset (&sigchld_mask, SIGCHLD);
834 sigprocmask (SIG_BLOCK, &sigchld_mask, &prev_mask);
835 #endif
836
837 /* scm_with_guile is the most portable way to initialize Guile.
838 Plus we need to initialize the Guile support while in Guile mode
839 (e.g., called from within a call to scm_with_guile). */
840 scm_with_guile (call_initialize_gdb_module, NULL);
841
842 #ifdef HAVE_SIGPROCMASK
843 sigprocmask (SIG_SETMASK, &prev_mask, NULL);
844 #endif
845
846 /* Set Guile's backtrace to match the "set guile print-stack" default.
847 [N.B. The two settings are still separate.]
848 But only do this after we've initialized Guile, it's nice to see a
849 backtrace if there's an error during initialization.
850 OTOH, if the error is that gdb/init.scm wasn't found because gdb is
851 being run from the build tree, the backtrace is more noise than signal.
852 Sigh. */
853 gdbscm_set_backtrace (0);
854 }
855 #endif
856 }
This page took 0.045663 seconds and 4 git commands to generate.