gdb/cli/cli-logging.c

   1 /* Command-line output logging for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2014 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 #include "defs.h"
  21 #include "gdbcmd.h"
  22 #include "ui-out.h"
  23 #include "interps.h"
  24 #include "gdb_assert.h"
  25
  26 #include <string.h>
  27
  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
  31 {
  32   struct ui_file *out;
  33   struct ui_file *err;
  34   struct ui_file *log;
  35   struct ui_file *targ;
  36   struct ui_file *targerr;
  37 };
  38 static struct saved_output_files saved_output;
  39 static char *saved_filename;
  40
  41 static char *logging_filename;
  42 static void
  43 show_logging_filename (struct ui_file *file, int from_tty,
  44                        struct cmd_list_element *c, const char *value)
  45 {
  46   fprintf_filtered (file, _("The current logfile is \"%s\".\n"),
  47                     value);
  48 }
  49
  50 static int logging_overwrite;
  51
  52 static void
  53 set_logging_overwrite (char *args, int from_tty, struct cmd_list_element *c)
  54 {
  55   if (saved_filename)
  56     warning (_("Currently logging to %s.  Turn the logging off and on to "
  57                "make the new setting effective."), saved_filename);
  58 }
  59
  60 static void
  61 show_logging_overwrite (struct ui_file *file, int from_tty,
  62                         struct cmd_list_element *c, const char *value)
  63 {
  64   fprintf_filtered (file,
  65                     _("Whether logging overwrites or "
  66                       "appends to the log file is %s.\n"),
  67                     value);
  68 }
  69
  70 /* Value as configured by the user.  */
  71 static int logging_redirect;
  72
  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;
  78
  79 static void
  80 set_logging_redirect (char *args, int from_tty, struct cmd_list_element *c)
  81 {
  82   struct cleanup *cleanups;
  83   struct ui_file *output, *new_logging_no_redirect_file;
  84   struct ui_out *uiout = current_uiout;
  85
  86   if (saved_filename == NULL
  87       || (logging_redirect != 0 && logging_no_redirect_file == NULL)
  88       || (logging_redirect == 0 && logging_no_redirect_file != NULL))
  89     return;
  90
  91   cleanups = make_cleanup (null_cleanup, NULL);
  92
  93   if (logging_redirect != 0)
  94     {
  95       gdb_assert (logging_no_redirect_file != NULL);
  96
  97       /* ui_out_redirect still has not been called for next
  98          gdb_stdout.  */
  99       make_cleanup_ui_file_delete (gdb_stdout);
 100
 101       output = logging_no_redirect_file;
 102       new_logging_no_redirect_file = NULL;
 103
 104       if (from_tty)
 105         fprintf_unfiltered (saved_output.out, "Redirecting output to %s.\n",
 106                             logging_filename);
 107     }
 108   else
 109     {
 110       gdb_assert (logging_no_redirect_file == NULL);
 111       output = tee_file_new (saved_output.out, 0, gdb_stdout, 0);
 112       if (output == NULL)
 113         perror_with_name (_("set logging"));
 114       new_logging_no_redirect_file = gdb_stdout;
 115
 116       if (from_tty)
 117         fprintf_unfiltered (saved_output.out, "Copying output to %s.\n",
 118                             logging_filename);
 119     }
 120
 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)
 124     {
 125       gdb_stdout = output;
 126       gdb_stdlog = output;
 127       gdb_stderr = output;
 128       gdb_stdtarg = output;
 129       gdb_stdtargerr = output;
 130     }
 131
 132   logging_no_redirect_file = new_logging_no_redirect_file;
 133
 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
 138      already failed.  */
 139
 140   if (ui_out_redirect (uiout, NULL) < 0
 141       || ui_out_redirect (uiout, output) < 0)
 142     warning (_("Current output protocol does not support redirection"));
 143
 144   do_cleanups (cleanups);
 145 }
 146
 147 static void
 148 show_logging_redirect (struct ui_file *file, int from_tty,
 149                        struct cmd_list_element *c, const char *value)
 150 {
 151   fprintf_filtered (file, _("The logging output mode is %s.\n"), value);
 152 }
 153
 154 /* If we've pushed output files, close them and pop them.  */
 155 static void
 156 pop_output_files (void)
 157 {
 158   if (logging_no_redirect_file)
 159     {
 160       ui_file_delete (logging_no_redirect_file);
 161       logging_no_redirect_file = NULL;
 162     }
 163
 164   if (current_interp_set_logging (0, NULL, NULL) == 0)
 165     {
 166       /* Only delete one of the files -- they are all set to the same
 167          value.  */
 168       ui_file_delete (gdb_stdout);
 169
 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.targ;
 175     }
 176
 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;
 182
 183   ui_out_redirect (current_uiout, NULL);
 184 }
 185
 186 /* This is a helper for the `set logging' command.  */
 187 static void
 188 handle_redirections (int from_tty)
 189 {
 190   struct cleanup *cleanups;
 191   struct ui_file *output;
 192   struct ui_file *no_redirect_file = NULL;
 193
 194   if (saved_filename != NULL)
 195     {
 196       fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
 197                           saved_filename);
 198       return;
 199     }
 200
 201   output = gdb_fopen (logging_filename, logging_overwrite ? "w" : "a");
 202   if (output == NULL)
 203     perror_with_name (_("set logging"));
 204   cleanups = make_cleanup_ui_file_delete (output);
 205
 206   /* Redirects everything to gdb_stdout while this is running.  */
 207   if (!logging_redirect)
 208     {
 209       no_redirect_file = output;
 210
 211       output = tee_file_new (gdb_stdout, 0, no_redirect_file, 0);
 212       if (output == NULL)
 213         perror_with_name (_("set logging"));
 214       make_cleanup_ui_file_delete (output);
 215       if (from_tty)
 216         fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
 217                             logging_filename);
 218       logging_no_redirect_file = no_redirect_file;
 219     }
 220   else
 221     {
 222       gdb_assert (logging_no_redirect_file == NULL);
 223
 224       if (from_tty)
 225         fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
 226                             logging_filename);
 227     }
 228
 229   discard_cleanups (cleanups);
 230
 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;
 237
 238   /* Let the interpreter do anything it needs.  */
 239   if (current_interp_set_logging (1, output, no_redirect_file) == 0)
 240     {
 241       gdb_stdout = output;
 242       gdb_stdlog = output;
 243       gdb_stderr = output;
 244       gdb_stdtarg = output;
 245       gdb_stdtargerr = output;
 246     }
 247
 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))
 250     {
 251       if (ui_out_redirect (current_uiout, output) < 0)
 252         warning (_("Current output protocol does not support redirection"));
 253     }
 254 }
 255
 256 static void
 257 set_logging_on (char *args, int from_tty)
 258 {
 259   char *rest = args;
 260
 261   if (rest && *rest)
 262     {
 263       xfree (logging_filename);
 264       logging_filename = xstrdup (rest);
 265     }
 266   handle_redirections (from_tty);
 267 }
 268
 269 static void
 270 set_logging_off (char *args, int from_tty)
 271 {
 272   if (saved_filename == NULL)
 273     return;
 274
 275   pop_output_files ();
 276   if (from_tty)
 277     fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
 278   xfree (saved_filename);
 279   saved_filename = NULL;
 280 }
 281
 282 static void
 283 set_logging_command (char *args, int from_tty)
 284 {
 285   printf_unfiltered (_("\"set logging\" lets you log output to a file.\n"
 286                        "Usage: set logging on [FILENAME]\n"
 287                        "       set logging off\n"
 288                        "       set logging file FILENAME\n"
 289                        "       set logging overwrite [on|off]\n"
 290                        "       set logging redirect [on|off]\n"));
 291 }
 292
 293 static void
 294 show_logging_command (char *args, int from_tty)
 295 {
 296   if (saved_filename)
 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"),
 301                        logging_filename);
 302
 303   if (logging_overwrite)
 304     printf_unfiltered (_("Logs will overwrite the log file.\n"));
 305   else
 306     printf_unfiltered (_("Logs will be appended to the log file.\n"));
 307
 308   if (saved_filename)
 309     {
 310       if (logging_redirect)
 311         printf_unfiltered (_("Output is being sent only to the log file.\n"));
 312       else
 313         printf_unfiltered (_("Output is being logged and displayed.\n"));
 314     }
 315   else
 316     {
 317       if (logging_redirect)
 318         printf_unfiltered (_("Output will be sent only to the log file.\n"));
 319       else
 320         printf_unfiltered (_("Output will be logged and displayed.\n"));
 321     }
 322 }
 323
 324 /* Provide a prototype to silence -Wmissing-prototypes.  */
 325 extern initialize_file_ftype _initialize_cli_logging;
 326
 327 void
 328 _initialize_cli_logging (void)
 329 {
 330   static struct cmd_list_element *set_logging_cmdlist, *show_logging_cmdlist;
 331
 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."),
 357                             NULL,
 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);
 364
 365   logging_filename = xstrdup ("gdb.txt");
 366 }