1 /* Command-line output logging for GDB, the GNU debugger.
3 Copyright (C) 2003-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/>. */
24 #include "gdb_assert.h"
28 /* These hold the pushed copies of the gdb output files.
29 If NULL then nothing has yet been pushed. */
30 struct saved_output_files
36 struct ui_file *targerr;
38 static struct saved_output_files saved_output;
39 static char *saved_filename;
41 static char *logging_filename;
43 show_logging_filename (struct ui_file *file, int from_tty,
44 struct cmd_list_element *c, const char *value)
46 fprintf_filtered (file, _("The current logfile is \"%s\".\n"),
50 static int logging_overwrite;
53 set_logging_overwrite (char *args, int from_tty, struct cmd_list_element *c)
56 warning (_("Currently logging to %s. Turn the logging off and on to "
57 "make the new setting effective."), saved_filename);
61 show_logging_overwrite (struct ui_file *file, int from_tty,
62 struct cmd_list_element *c, const char *value)
64 fprintf_filtered (file,
65 _("Whether logging overwrites or "
66 "appends to the log file is %s.\n"),
70 /* Value as configured by the user. */
71 static int logging_redirect;
73 /* The on-disk file in use if logging is currently active together
74 with redirection turned off (and therefore using tee_file_new).
75 For active logging with redirection the on-disk file is directly in
76 GDB_STDOUT and this variable is NULL. */
77 static struct ui_file *logging_no_redirect_file;
80 set_logging_redirect (char *args, int from_tty, struct cmd_list_element *c)
82 struct cleanup *cleanups;
83 struct ui_file *output, *new_logging_no_redirect_file;
84 struct ui_out *uiout = current_uiout;
86 if (saved_filename == NULL
87 || (logging_redirect != 0 && logging_no_redirect_file == NULL)
88 || (logging_redirect == 0 && logging_no_redirect_file != NULL))
91 cleanups = make_cleanup (null_cleanup, NULL);
93 if (logging_redirect != 0)
95 gdb_assert (logging_no_redirect_file != NULL);
97 /* ui_out_redirect still has not been called for next
99 make_cleanup_ui_file_delete (gdb_stdout);
101 output = logging_no_redirect_file;
102 new_logging_no_redirect_file = NULL;
105 fprintf_unfiltered (saved_output.out, "Redirecting output to %s.\n",
110 gdb_assert (logging_no_redirect_file == NULL);
111 output = tee_file_new (saved_output.out, 0, gdb_stdout, 0);
113 perror_with_name (_("set logging"));
114 new_logging_no_redirect_file = gdb_stdout;
117 fprintf_unfiltered (saved_output.out, "Copying output to %s.\n",
121 /* Give the current interpreter a chance to do anything special that
122 it might need for logging, such as updating other channels. */
123 if (current_interp_set_logging (1, output, NULL) == 0)
128 gdb_stdtarg = output;
129 gdb_stdtargerr = output;
132 logging_no_redirect_file = new_logging_no_redirect_file;
134 /* There is a former output pushed on the ui_out_redirect stack. We
135 want to replace it by OUTPUT so we must pop the former value
136 first. We should either do both the pop and push or to do
137 neither of it. At least do not try to push OUTPUT if the pop
140 if (ui_out_redirect (uiout, NULL) < 0
141 || ui_out_redirect (uiout, output) < 0)
142 warning (_("Current output protocol does not support redirection"));
144 do_cleanups (cleanups);
148 show_logging_redirect (struct ui_file *file, int from_tty,
149 struct cmd_list_element *c, const char *value)
151 fprintf_filtered (file, _("The logging output mode is %s.\n"), value);
154 /* If we've pushed output files, close them and pop them. */
156 pop_output_files (void)
158 if (logging_no_redirect_file)
160 ui_file_delete (logging_no_redirect_file);
161 logging_no_redirect_file = NULL;
164 if (current_interp_set_logging (0, NULL, NULL) == 0)
166 /* Only delete one of the files -- they are all set to the same
168 ui_file_delete (gdb_stdout);
170 gdb_stdout = saved_output.out;
171 gdb_stderr = saved_output.err;
172 gdb_stdlog = saved_output.log;
173 gdb_stdtarg = saved_output.targ;
174 gdb_stdtargerr = saved_output.targerr;
177 saved_output.out = NULL;
178 saved_output.err = NULL;
179 saved_output.log = NULL;
180 saved_output.targ = NULL;
181 saved_output.targerr = NULL;
183 ui_out_redirect (current_uiout, NULL);
186 /* This is a helper for the `set logging' command. */
188 handle_redirections (int from_tty)
190 struct cleanup *cleanups;
191 struct ui_file *output;
192 struct ui_file *no_redirect_file = NULL;
194 if (saved_filename != NULL)
196 fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
201 output = gdb_fopen (logging_filename, logging_overwrite ? "w" : "a");
203 perror_with_name (_("set logging"));
204 cleanups = make_cleanup_ui_file_delete (output);
206 /* Redirects everything to gdb_stdout while this is running. */
207 if (!logging_redirect)
209 no_redirect_file = output;
211 output = tee_file_new (gdb_stdout, 0, no_redirect_file, 0);
213 perror_with_name (_("set logging"));
214 make_cleanup_ui_file_delete (output);
216 fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
218 logging_no_redirect_file = no_redirect_file;
222 gdb_assert (logging_no_redirect_file == NULL);
225 fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
229 discard_cleanups (cleanups);
231 saved_filename = xstrdup (logging_filename);
232 saved_output.out = gdb_stdout;
233 saved_output.err = gdb_stderr;
234 saved_output.log = gdb_stdlog;
235 saved_output.targ = gdb_stdtarg;
236 saved_output.targerr = gdb_stdtargerr;
238 /* Let the interpreter do anything it needs. */
239 if (current_interp_set_logging (1, output, no_redirect_file) == 0)
244 gdb_stdtarg = output;
245 gdb_stdtargerr = output;
248 /* Don't do the redirect for MI, it confuses MI's ui-out scheme. */
249 if (!ui_out_is_mi_like_p (current_uiout))
251 if (ui_out_redirect (current_uiout, output) < 0)
252 warning (_("Current output protocol does not support redirection"));
257 set_logging_on (char *args, int from_tty)
263 xfree (logging_filename);
264 logging_filename = xstrdup (rest);
266 handle_redirections (from_tty);
270 set_logging_off (char *args, int from_tty)
272 if (saved_filename == NULL)
277 fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
278 xfree (saved_filename);
279 saved_filename = NULL;
283 set_logging_command (char *args, int from_tty)
285 printf_unfiltered (_("\"set logging\" lets you log output to a file.\n"
286 "Usage: set logging on [FILENAME]\n"
288 " set logging file FILENAME\n"
289 " set logging overwrite [on|off]\n"
290 " set logging redirect [on|off]\n"));
294 show_logging_command (char *args, int from_tty)
297 printf_unfiltered (_("Currently logging to \"%s\".\n"), saved_filename);
298 if (saved_filename == NULL
299 || strcmp (logging_filename, saved_filename) != 0)
300 printf_unfiltered (_("Future logs will be written to %s.\n"),
303 if (logging_overwrite)
304 printf_unfiltered (_("Logs will overwrite the log file.\n"));
306 printf_unfiltered (_("Logs will be appended to the log file.\n"));
310 if (logging_redirect)
311 printf_unfiltered (_("Output is being sent only to the log file.\n"));
313 printf_unfiltered (_("Output is being logged and displayed.\n"));
317 if (logging_redirect)
318 printf_unfiltered (_("Output will be sent only to the log file.\n"));
320 printf_unfiltered (_("Output will be logged and displayed.\n"));
324 /* Provide a prototype to silence -Wmissing-prototypes. */
325 extern initialize_file_ftype _initialize_cli_logging;
328 _initialize_cli_logging (void)
330 static struct cmd_list_element *set_logging_cmdlist, *show_logging_cmdlist;
332 add_prefix_cmd ("logging", class_support, set_logging_command,
333 _("Set logging options"), &set_logging_cmdlist,
334 "set logging ", 0, &setlist);
335 add_prefix_cmd ("logging", class_support, show_logging_command,
336 _("Show logging options"), &show_logging_cmdlist,
337 "show logging ", 0, &showlist);
338 add_setshow_boolean_cmd ("overwrite", class_support, &logging_overwrite, _("\
339 Set whether logging overwrites or appends to the log file."), _("\
340 Show whether logging overwrites or appends to the log file."), _("\
341 If set, logging overrides the log file."),
342 set_logging_overwrite,
343 show_logging_overwrite,
344 &set_logging_cmdlist, &show_logging_cmdlist);
345 add_setshow_boolean_cmd ("redirect", class_support, &logging_redirect, _("\
346 Set the logging output mode."), _("\
347 Show the logging output mode."), _("\
348 If redirect is off, output will go to both the screen and the log file.\n\
349 If redirect is on, output will go only to the log file."),
350 set_logging_redirect,
351 show_logging_redirect,
352 &set_logging_cmdlist, &show_logging_cmdlist);
353 add_setshow_filename_cmd ("file", class_support, &logging_filename, _("\
354 Set the current logfile."), _("\
355 Show the current logfile."), _("\
356 The logfile is used when directing GDB's output."),
358 show_logging_filename,
359 &set_logging_cmdlist, &show_logging_cmdlist);
360 add_cmd ("on", class_support, set_logging_on,
361 _("Enable logging."), &set_logging_cmdlist);
362 add_cmd ("off", class_support, set_logging_off,
363 _("Disable logging."), &set_logging_cmdlist);
365 logging_filename = xstrdup ("gdb.txt");