GDB (xrefs)
Loading...
Searching...
No Matches
interps.c
Go to the documentation of this file.
1/* Manages interpreters for GDB, the GNU debugger.
2
3 Copyright (C) 2000-2023 Free Software Foundation, Inc.
4
5 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
6
7 This file is part of GDB.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21
22/* This is just a first cut at separating out the "interpreter"
23 functions of gdb into self-contained modules. There are a couple
24 of open areas that need to be sorted out:
25
26 1) The interpreter explicitly contains a UI_OUT, and can insert itself
27 into the event loop, but it doesn't explicitly contain hooks for readline.
28 I did this because it seems to me many interpreters won't want to use
29 the readline command interface, and it is probably simpler to just let
30 them take over the input in their resume proc. */
31
32#include "defs.h"
33#include "gdbcmd.h"
34#include "ui-out.h"
35#include "gdbsupport/event-loop.h"
36#include "event-top.h"
37#include "interps.h"
38#include "completer.h"
39#include "ui.h"
40#include "main.h"
41#include "gdbsupport/buildargv.h"
42#include "gdbsupport/scope-exit.h"
43
44/* The magic initialization routine for this module. */
45
46static struct interp *interp_lookup_existing (struct ui *ui,
47 const char *name);
48
49interp::interp (const char *name)
50 : m_name (name)
51{
52}
53
54interp::~interp () = default;
55
56/* An interpreter factory. Maps an interpreter name to the factory
57 function that instantiates an interpreter by that name. */
58
60{
61 interp_factory (const char *name_, interp_factory_func func_)
62 : name (name_), func (func_)
63 {}
64
65 /* This is the name in "-i=INTERP" and "interpreter-exec INTERP". */
66 const char *name;
67
68 /* The function that creates the interpreter. */
70};
71
72/* The registered interpreter factories. */
73static std::vector<interp_factory> interpreter_factories;
74
75/* See interps.h. */
76
77void
79{
80 /* Assert that no factory for NAME is already registered. */
82 if (strcmp (f.name, name) == 0)
83 {
84 internal_error (_("interpreter factory already registered: \"%s\"\n"),
85 name);
86 }
87
88 interpreter_factories.emplace_back (name, func);
89}
90
91/* Add interpreter INTERP to the gdb interpreter list. The
92 interpreter must not have previously been added. */
93static void
94interp_add (struct ui *ui, struct interp *interp)
95{
96 gdb_assert (interp_lookup_existing (ui, interp->name ()) == NULL);
97
98 ui->interp_list.push_back (*interp);
99}
100
101/* This sets the current interpreter to be INTERP. If INTERP has not
102 been initialized, then this will also run the init method.
103
104 The TOP_LEVEL parameter tells if this new interpreter is
105 the top-level one. The top-level is what is requested
106 on the command line, and is responsible for reporting general
107 notification about target state changes. For example, if
108 MI is the top-level interpreter, then it will always report
109 events such as target stops and new thread creation, even if they
110 are caused by CLI commands. */
111
112static void
113interp_set (struct interp *interp, bool top_level)
114{
115 struct interp *old_interp = current_ui->current_interpreter;
116
117 /* If we already have an interpreter, then trying to
118 set top level interpreter is kinda pointless. */
119 gdb_assert (!top_level || !current_ui->current_interpreter);
120 gdb_assert (!top_level || !current_ui->top_level_interpreter);
121
122 if (old_interp != NULL)
123 {
124 current_uiout->flush ();
125 old_interp->suspend ();
126 }
127
129 if (top_level)
131
132 if (interpreter_p != interp->name ())
134
135 /* Run the init proc. */
136 if (!interp->inited)
137 {
138 interp->init (top_level);
139 interp->inited = true;
140 }
141
142 /* Do this only after the interpreter is initialized. */
144
145 /* Clear out any installed interpreter hooks/event handlers. */
147
148 interp->resume ();
149}
150
151/* Look up the interpreter for NAME. If no such interpreter exists,
152 return NULL, otherwise return a pointer to the interpreter. */
153
154static struct interp *
155interp_lookup_existing (struct ui *ui, const char *name)
156{
157 for (interp &interp : ui->interp_list)
158 if (strcmp (interp.name (), name) == 0)
159 return &interp;
160
161 return nullptr;
162}
163
164/* See interps.h. */
165
166struct interp *
167interp_lookup (struct ui *ui, const char *name)
168{
169 if (name == NULL || strlen (name) == 0)
170 return NULL;
171
172 /* Only create each interpreter once per top level. */
174 if (interp != NULL)
175 return interp;
176
177 for (const interp_factory &factory : interpreter_factories)
178 if (strcmp (factory.name, name) == 0)
179 {
180 interp = factory.func (factory.name);
182 return interp;
183 }
184
185 return NULL;
186}
187
188/* See interps.h. */
189
190void
192{
193 /* Find it. */
195
196 if (interp == NULL)
197 error (_("Interpreter `%s' unrecognized"), name);
198 /* Install it. */
199 interp_set (interp, true);
200}
201
202void
210
211/* Temporarily overrides the current interpreter. */
212struct interp *
214{
216 struct interp *old_interp = current_ui->current_interpreter;
217
218 if (interp)
220
221 return old_interp;
222}
223
224/* Returns true if the current interp is the passed in name. */
225int
226current_interp_named_p (const char *interp_name)
227{
229
230 if (interp != NULL)
231 return (strcmp (interp->name (), interp_name) == 0);
232
233 return 0;
234}
235
236/* The interpreter that was active when a command was executed.
237 Normally that'd always be CURRENT_INTERPRETER, except that MI's
238 -interpreter-exec command doesn't actually flip the current
239 interpreter when running its sub-command. The
240 `command_interpreter' global tracks when interp_exec is called
241 (IOW, when -interpreter-exec is called). If that is set, it is
242 INTERP in '-interpreter-exec INTERP "CMD"' or in 'interpreter-exec
243 INTERP "CMD". Otherwise, interp_exec isn't active, and so the
244 interpreter running the command is the current interpreter. */
245
246struct interp *
248{
249 if (current_ui->command_interpreter != nullptr)
251 else
253}
254
255/* interp_exec - This executes COMMAND_STR in the current
256 interpreter. */
257
258void
259interp_exec (struct interp *interp, const char *command_str)
260{
261 /* See `command_interp' for why we do this. */
262 scoped_restore save_command_interp
263 = make_scoped_restore (&current_ui->command_interpreter, interp);
264
265 interp->exec (command_str);
266}
267
268/* A convenience routine that nulls out all the common command hooks.
269 Use it when removing your interpreter in its suspend proc. */
270void
284
285static void
286interpreter_exec_cmd (const char *args, int from_tty)
287{
288 struct interp *interp_to_use;
289 unsigned int nrules;
290 unsigned int i;
291
292 /* Interpreters may clobber stdout/stderr (e.g. in mi_interp::resume at time
293 of writing), preserve their state here. */
294 scoped_restore save_stdout = make_scoped_restore (&gdb_stdout);
295 scoped_restore save_stderr = make_scoped_restore (&gdb_stderr);
296 scoped_restore save_stdlog = make_scoped_restore (&gdb_stdlog);
297 scoped_restore save_stdtarg = make_scoped_restore (&gdb_stdtarg);
298 scoped_restore save_stdtargerr = make_scoped_restore (&gdb_stdtargerr);
299
300 if (args == NULL)
301 error_no_arg (_("interpreter-exec command"));
302
303 gdb_argv prules (args);
304 nrules = prules.count ();
305
306 if (nrules < 2)
307 error (_("Usage: interpreter-exec INTERPRETER COMMAND..."));
308
310
311 interp_to_use = interp_lookup (current_ui, prules[0]);
312 if (interp_to_use == NULL)
313 error (_("Could not find interpreter \"%s\"."), prules[0]);
314
315 interp_set (interp_to_use, false);
316 SCOPE_EXIT
317 {
318 interp_set (old_interp, false);
319 };
320
321 for (i = 1; i < nrules; i++)
322 interp_exec (interp_to_use, prules[i]);
323}
324
325/* See interps.h. */
326
327void
329 completion_tracker &tracker,
330 const char *text, const char *word)
331{
332 int textlen = strlen (text);
333
335 {
336 if (strncmp (interp.name, text, textlen) == 0)
337 {
338 tracker.add_completion
339 (make_completion_match_str (interp.name, text, word));
340 }
341 }
342}
343
344struct interp *
349
350/* See interps.h. */
351
352struct interp *
357
358/* Helper interps_notify_* functions. Call METHOD on the top-level interpreter
359 of all UIs. */
360
361template <typename ...Args>
362void
363interps_notify (void (interp::*method) (Args...), Args... args)
364{
366 {
368 if (tli != nullptr)
369 (tli->*method) (args...);
370 }
371}
372
373/* See interps.h. */
374
375void
380
381/* See interps.h. */
382
383void
388
389/* See interps.h. */
390
391void
396
397/* See interps.h. */
398
399void
404
405/* See interps.h. */
406
407void
412
413/* See interps.h. */
414
415void
420
421/* See interps.h. */
422
423void
428
429/* See interps.h. */
430
431void
433 gdb::optional<ULONGEST> exit_code,
434 int silent)
435{
436 interps_notify (&interp::on_thread_exited, t, exit_code, silent);
437}
438
439/* See interps.h. */
440
441void
446
447/* See interps.h. */
448
449void
454
455/* See interps.h. */
456
457void
462
463/* See interps.h. */
464
465void
470
471/* See interps.h. */
472
473void
474interps_notify_record_changed (inferior *inf, int started, const char *method,
475 const char *format)
476{
477 interps_notify (&interp::on_record_changed, inf, started, method, format);
478}
479
480/* See interps.h. */
481
482void
487
488/* See interps.h. */
489
490void
495
496/* See interps.h. */
497
498void
503
504/* See interps.h. */
505
506void
508{
510}
511
512/* See interps.h. */
513
514void
519
520/* See interps.h. */
521
522void
527
528/* See interps.h. */
529
530void
535
536/* See interps.h. */
537
538void
543
544/* See interps.h. */
545
546void
551
552/* See interps.h. */
553
554void
559
560/* See interps.h. */
561
562void
563interps_notify_param_changed (const char *param, const char *value)
564{
566}
567
568/* See interps.h. */
569
570void
571interps_notify_memory_changed (inferior *inf, CORE_ADDR addr, ssize_t len,
572 const bfd_byte *data)
573{
574 interps_notify (&interp::on_memory_changed, inf, addr, len, data);
575}
576
577/* This just adds the "interpreter-exec" command. */
579void
581{
582 struct cmd_list_element *c;
583
584 c = add_cmd ("interpreter-exec", class_support,
586Execute a command in an interpreter.\n\
587Usage: interpreter-exec INTERPRETER COMMAND...\n\
588The first argument is the name of the interpreter to use.\n\
589The following arguments are the commands to execute.\n\
590A command can have arguments, separated by spaces.\n\
591These spaces must be escaped using \\ or the command\n\
592and its arguments must be enclosed in double quotes."), &cmdlist);
594}
const char *const name
void f()
Definition 1.cc:36
void add_completion(gdb::unique_xmalloc_ptr< char > name, completion_match_for_lcd *match_for_lcd=NULL, const char *text=NULL, const char *word=NULL)
Definition completer.c:1579
virtual void on_target_resumed(ptid_t ptid)
Definition interps.h:147
virtual void on_param_changed(const char *param, const char *value)
Definition interps.h:181
virtual void on_inferior_disappeared(inferior *inf)
Definition interps.h:136
virtual void on_breakpoint_modified(breakpoint *b)
Definition interps.h:178
virtual void suspend()=0
virtual void exec(const char *command)=0
virtual void on_inferior_added(inferior *inf)
Definition interps.h:130
virtual void on_traceframe_changed(int tfnum, int tpnum)
Definition interps.h:160
virtual void on_memory_changed(inferior *inf, CORE_ADDR addr, ssize_t len, const bfd_byte *data)
Definition interps.h:184
virtual void on_user_selected_context_changed(user_selected_what selection)
Definition interps.h:118
virtual void on_no_history()
Definition interps.h:107
virtual void on_signal_exited(gdb_signal sig)
Definition interps.h:96
virtual void on_new_thread(thread_info *t)
Definition interps.h:122
virtual ~interp()=0
virtual void resume()=0
virtual void on_breakpoint_deleted(breakpoint *b)
Definition interps.h:175
virtual void set_logging(ui_file_up logfile, bool logging_redirect, bool debug_redirect)=0
virtual void on_breakpoint_created(breakpoint *b)
Definition interps.h:172
virtual ui_out * interp_ui_out()=0
virtual void on_tsv_modified(const trace_state_variable *tsv)
Definition interps.h:169
virtual void on_record_changed(inferior *inf, int started, const char *method, const char *format)
Definition interps.h:143
virtual void on_solib_unloaded(so_list *so)
Definition interps.h:153
virtual void on_exited(int status)
Definition interps.h:103
virtual void on_tsv_deleted(const trace_state_variable *tsv)
Definition interps.h:166
bool inited
Definition interps.h:193
virtual void on_thread_exited(thread_info *, gdb::optional< ULONGEST > exit_code, int silent)
Definition interps.h:125
const char * name() const
Definition interps.h:87
const char * m_name
Definition interps.h:189
virtual void on_inferior_appeared(inferior *inf)
Definition interps.h:133
virtual void init(bool top_level)
Definition interps.h:56
virtual void on_signal_received(gdb_signal sig)
Definition interps.h:92
virtual void on_tsv_created(const trace_state_variable *tsv)
Definition interps.h:163
virtual void on_inferior_removed(inferior *inf)
Definition interps.h:139
virtual void on_solib_loaded(so_list *so)
Definition interps.h:150
interp(const char *name)
Definition interps.c:49
virtual void on_normal_stop(bpstat *bs, int print_frame)
Definition interps.h:99
struct interp * set_interp(const char *name)
Definition interps.c:213
void error_no_arg(const char *why)
Definition cli-cmds.c:206
struct cmd_list_element * cmdlist
Definition cli-cmds.c:87
struct cmd_list_element * add_cmd(const char *name, enum command_class theclass, const char *doc, struct cmd_list_element **list)
Definition cli-decode.c:233
void set_cmd_completer(struct cmd_list_element *cmd, completer_ftype *completer)
Definition cli-decode.c:117
static bool debug_redirect
Definition cli-logging.c:67
static bool logging_redirect
Definition cli-logging.c:66
@ class_support
Definition command.h:58
gdb::unique_xmalloc_ptr< char > make_completion_match_str(const char *match_name, const char *text, const char *word)
Definition completer.c:1646
void(* deprecated_readline_end_hook)(void)
Definition top.c:240
void(* deprecated_print_frame_info_listing_hook)(struct symtab *s, int line, int stopline, int noerror)
Definition top.c:214
int(* deprecated_query_hook)(const char *, va_list) ATTRIBUTE_FPTR_PRINTF(1
Definition top.c:220
char *(* deprecated_readline_hook)(const char *)
Definition top.c:239
int void void(* deprecated_readline_begin_hook)(const char *,...) ATTRIBUTE_FPTR_PRINTF_1
Definition top.c:238
void(* deprecated_call_command_hook)(struct cmd_list_element *c, const char *cmd, int from_tty)
Definition top.c:251
int void(* deprecated_warning_hook)(const char *, va_list) ATTRIBUTE_FPTR_PRINTF(1
Definition top.c:224
void(* deprecated_context_hook)(int)
Definition top.c:256
mach_port_t mach_port_t name mach_port_t mach_port_t name kern_return_t int status
Definition gnu-nat.c:1790
void interps_notify_inferior_removed(inferior *inf)
Definition interps.c:466
struct interp * interp_lookup(struct ui *ui, const char *name)
Definition interps.c:167
static struct interp * interp_lookup_existing(struct ui *ui, const char *name)
Definition interps.c:155
void interps_notify_breakpoint_created(breakpoint *b)
Definition interps.c:539
void interps_notify_no_history()
Definition interps.c:392
void interps_notify_solib_loaded(so_list *so)
Definition interps.c:491
void clear_interpreter_hooks(void)
Definition interps.c:271
void interps_notify_thread_exited(thread_info *t, gdb::optional< ULONGEST > exit_code, int silent)
Definition interps.c:432
int current_interp_named_p(const char *interp_name)
Definition interps.c:226
void interps_notify_tsv_deleted(const trace_state_variable *tsv)
Definition interps.c:523
struct interp * current_interpreter(void)
Definition interps.c:353
struct interp * top_level_interpreter(void)
Definition interps.c:345
void interps_notify_signal_received(gdb_signal sig)
Definition interps.c:376
static void interpreter_exec_cmd(const char *args, int from_tty)
Definition interps.c:286
void interps_notify_breakpoint_modified(breakpoint *b)
Definition interps.c:555
void set_top_level_interpreter(const char *name)
Definition interps.c:191
void interps_notify_normal_stop(bpstat *bs, int print_frame)
Definition interps.c:400
void interp_exec(struct interp *interp, const char *command_str)
Definition interps.c:259
void _initialize_interpreter()
Definition interps.c:580
void interps_notify_inferior_added(inferior *inf)
Definition interps.c:442
struct interp * command_interp(void)
Definition interps.c:247
void interp_factory_register(const char *name, interp_factory_func func)
Definition interps.c:78
static void interp_add(struct ui *ui, struct interp *interp)
Definition interps.c:94
void interps_notify_solib_unloaded(so_list *so)
Definition interps.c:499
void interps_notify_breakpoint_deleted(breakpoint *b)
Definition interps.c:547
void interpreter_completer(struct cmd_list_element *ignore, completion_tracker &tracker, const char *text, const char *word)
Definition interps.c:328
void interps_notify_signal_exited(gdb_signal sig)
Definition interps.c:384
void current_interp_set_logging(ui_file_up logfile, bool logging_redirect, bool debug_redirect)
Definition interps.c:203
void interps_notify_user_selected_context_changed(user_selected_what selection)
Definition interps.c:416
void interps_notify_target_resumed(ptid_t ptid)
Definition interps.c:483
void interps_notify_param_changed(const char *param, const char *value)
Definition interps.c:563
void interps_notify_traceframe_changed(int tfnum, int tpnum)
Definition interps.c:507
void interps_notify_new_thread(thread_info *t)
Definition interps.c:424
static std::vector< interp_factory > interpreter_factories
Definition interps.c:73
void interps_notify_memory_changed(inferior *inf, CORE_ADDR addr, ssize_t len, const bfd_byte *data)
Definition interps.c:571
static void interp_set(struct interp *interp, bool top_level)
Definition interps.c:113
void interps_notify_inferior_disappeared(inferior *inf)
Definition interps.c:458
void interps_notify_exited(int status)
Definition interps.c:408
void interps_notify_inferior_appeared(inferior *inf)
Definition interps.c:450
void interps_notify(void(interp::*method)(Args...), Args... args)
Definition interps.c:363
void interps_notify_tsv_created(const trace_state_variable *tsv)
Definition interps.c:515
void interps_notify_tsv_modified(const trace_state_variable *tsv)
Definition interps.c:531
void interps_notify_record_changed(inferior *inf, int started, const char *method, const char *format)
Definition interps.c:474
struct interp * interp_lookup(struct ui *ui, const char *name)
Definition interps.c:167
struct interp *(* interp_factory_func)(const char *name)
Definition interps.h:37
std::string interpreter_p
Definition main.c:61
struct ui_file * gdb_stdtarg
Definition main.c:80
struct ui_file * gdb_stdtargerr
Definition main.c:81
void(* func)(remote_target *remote, char *)
static void print_frame(const frame_print_options &opts, frame_info_ptr frame, int print_level, enum print_what print_what, int print_args, struct symtab_and_line sal)
Definition gnu-nat.c:153
interp_factory_func func
Definition interps.c:69
interp_factory(const char *name_, interp_factory_func func_)
Definition interps.c:61
const char * name
Definition interps.c:66
Definition ui.h:55
interp * current_interpreter
Definition ui.h:91
interp * top_level_interpreter
Definition ui.h:92
interp * command_interpreter
Definition ui.h:96
intrusive_list< interp > interp_list
Definition ui.h:90
Definition value.h:130
std::unique_ptr< ui_file > ui_file_up
Definition ui-file.h:150
#define current_uiout
Definition ui-out.h:40
struct ui * current_ui
Definition ui.c:35
#define SWITCH_THRU_ALL_UIS()
Definition ui.h:215
void(* deprecated_error_begin_hook)(void)
Definition utils.c:85
#define gdb_stderr
Definition utils.h:187
#define gdb_stdlog
Definition utils.h:190
#define gdb_stdout
Definition utils.h:182