gdb/cli/cli-logging.c

   1 /* Command-line output logging for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2015 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
  25 /* These hold the pushed copies of the gdb output files.
  26    If NULL then nothing has yet been pushed.  */
  27 struct saved_output_files
  28 {
  29   struct ui_file *out;
  30   struct ui_file *err;
  31   struct ui_file *log;
  32   struct ui_file *targ;
  33   struct ui_file *targerr;
  34 };
  35 static struct saved_output_files saved_output;
  36 static char *saved_filename;
  37
  38 static char *logging_filename;
  39 static void
  40 show_logging_filename (struct ui_file *file, int from_tty,
  41                        struct cmd_list_element *c, const char *value)
  42 {
  43   fprintf_filtered (file, _("The current logfile is \"%s\".\n"),
  44                     value);
  45 }
  46
  47 static int logging_overwrite;
  48
  49 static void
  50 set_logging_overwrite (char *args, int from_tty, struct cmd_list_element *c)
  51 {
  52   if (saved_filename)
  53     warning (_("Currently logging to %s.  Turn the logging off and on to "
  54                "make the new setting effective."), saved_filename);
  55 }
  56
  57 static void
  58 show_logging_overwrite (struct ui_file *file, int from_tty,
  59                         struct cmd_list_element *c, const char *value)
  60 {
  61   fprintf_filtered (file,
  62                     _("Whether logging overwrites or "
  63                       "appends to the log file is %s.\n"),
  64                     value);
  65 }
  66
  67 /* Value as configured by the user.  */
  68 static int logging_redirect;
  69
  70 /* The on-disk file in use if logging is currently active together
  71    with redirection turned off (and therefore using tee_file_new).
  72    For active logging with redirection the on-disk file is directly in
  73    GDB_STDOUT and this variable is NULL.  */
  74 static struct ui_file *logging_no_redirect_file;
  75
  76 static void
  77 set_logging_redirect (char *args, int from_tty, struct cmd_list_element *c)
  78 {
  79   struct cleanup *cleanups;
  80   struct ui_file *output, *new_logging_no_redirect_file;
  81   struct ui_out *uiout = current_uiout;
  82
  83   if (saved_filename == NULL
  84       || (logging_redirect != 0 && logging_no_redirect_file == NULL)
  85       || (logging_redirect == 0 && logging_no_redirect_file != NULL))
  86     return;
  87
  88   cleanups = make_cleanup (null_cleanup, NULL);
  89
  90   if (logging_redirect != 0)
  91     {
  92       gdb_assert (logging_no_redirect_file != NULL);
  93
  94       /* ui_out_redirect still has not been called for next
  95          gdb_stdout.  */
  96       make_cleanup_ui_file_delete (gdb_stdout);
  97
  98       output = logging_no_redirect_file;
  99       new_logging_no_redirect_file = NULL;
 100
 101       if (from_tty)
 102         fprintf_unfiltered (saved_output.out, "Redirecting output to %s.\n",
 103                             logging_filename);
 104     }
 105   else
 106     {
 107       gdb_assert (logging_no_redirect_file == NULL);
 108       output = tee_file_new (saved_output.out, 0, gdb_stdout, 0);
 109       if (output == NULL)
 110         perror_with_name (_("set logging"));
 111       new_logging_no_redirect_file = gdb_stdout;
 112
 113       if (from_tty)
 114         fprintf_unfiltered (saved_output.out, "Copying output to %s.\n",
 115                             logging_filename);
 116     }
 117
 118   /* Give the current interpreter a chance to do anything special that
 119      it might need for logging, such as updating other channels.  */
 120   if (current_interp_set_logging (1, output, NULL) == 0)
 121     {
 122       gdb_stdout = output;
 123       gdb_stdlog = output;
 124       gdb_stderr = output;
 125       gdb_stdtarg = output;
 126       gdb_stdtargerr = output;
 127     }
 128
 129   logging_no_redirect_file = new_logging_no_redirect_file;
 130
 131   /* There is a former output pushed on the ui_out_redirect stack.  We
 132      want to replace it by OUTPUT so we must pop the former value
 133      first.  We should either do both the pop and push or to do
 134      neither of it.  At least do not try to push OUTPUT if the pop
 135      already failed.  */
 136
 137   if (ui_out_redirect (uiout, NULL) < 0
 138       || ui_out_redirect (uiout, output) < 0)
 139     warning (_("Current output protocol does not support redirection"));
 140
 141   do_cleanups (cleanups);
 142 }
 143
 144 static void
 145 show_logging_redirect (struct ui_file *file, int from_tty,
 146                        struct cmd_list_element *c, const char *value)
 147 {
 148   fprintf_filtered (file, _("The logging output mode is %s.\n"), value);
 149 }
 150
 151 /* If we've pushed output files, close them and pop them.  */
 152 static void
 153 pop_output_files (void)
 154 {
 155   if (logging_no_redirect_file)
 156     {
 157       ui_file_delete (logging_no_redirect_file);
 158       logging_no_redirect_file = NULL;
 159     }
 160
 161   if (current_interp_set_logging (0, NULL, NULL) == 0)
 162     {
 163       /* Only delete one of the files -- they are all set to the same
 164          value.  */
 165       ui_file_delete (gdb_stdout);
 166
 167       gdb_stdout = saved_output.out;
 168       gdb_stderr = saved_output.err;
 169       gdb_stdlog = saved_output.log;
 170       gdb_stdtarg = saved_output.targ;
 171       gdb_stdtargerr = saved_output.targerr;
 172     }
 173
 174   saved_output.out = NULL;
 175   saved_output.err = NULL;
 176   saved_output.log = NULL;
 177   saved_output.targ = NULL;
 178   saved_output.targerr = NULL;
 179
 180   ui_out_redirect (current_uiout, NULL);
 181 }
 182
 183 /* This is a helper for the `set logging' command.  */
 184 static void
 185 handle_redirections (int from_tty)
 186 {
 187   struct cleanup *cleanups;
 188   struct ui_file *output;
 189   struct ui_file *no_redirect_file = NULL;
 190
 191   if (saved_filename != NULL)
 192     {
 193       fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
 194                           saved_filename);
 195       return;
 196     }
 197
 198   output = gdb_fopen (logging_filename, logging_overwrite ? "w" : "a");
 199   if (output == NULL)
 200     perror_with_name (_("set logging"));
 201   cleanups = make_cleanup_ui_file_delete (output);
 202
 203   /* Redirects everything to gdb_stdout while this is running.  */
 204   if (!logging_redirect)
 205     {
 206       no_redirect_file = output;
 207
 208       output = tee_file_new (gdb_stdout, 0, no_redirect_file, 0);
 209       if (output == NULL)
 210         perror_with_name (_("set logging"));
 211       make_cleanup_ui_file_delete (output);
 212       if (from_tty)
 213         fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
 214                             logging_filename);
 215       logging_no_redirect_file = no_redirect_file;
 216     }
 217   else
 218     {
 219       gdb_assert (logging_no_redirect_file == NULL);
 220
 221       if (from_tty)
 222         fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
 223                             logging_filename);
 224     }
 225
 226   discard_cleanups (cleanups);
 227
 228   saved_filename = xstrdup (logging_filename);
 229   saved_output.out = gdb_stdout;
 230   saved_output.err = gdb_stderr;
 231   saved_output.log = gdb_stdlog;
 232   saved_output.targ = gdb_stdtarg;
 233   saved_output.targerr = gdb_stdtargerr;
 234
 235   /* Let the interpreter do anything it needs.  */
 236   if (current_interp_set_logging (1, output, no_redirect_file) == 0)
 237     {
 238       gdb_stdout = output;
 239       gdb_stdlog = output;
 240       gdb_stderr = output;
 241       gdb_stdtarg = output;
 242       gdb_stdtargerr = output;
 243     }
 244
 245   /* Don't do the redirect for MI, it confuses MI's ui-out scheme.  */
 246   if (!ui_out_is_mi_like_p (current_uiout))
 247     {
 248       if (ui_out_redirect (current_uiout, output) < 0)
 249         warning (_("Current output protocol does not support redirection"));
 250     }
 251 }
 252
 253 static void
 254 set_logging_on (char *args, int from_tty)
 255 {
 256   char *rest = args;
 257
 258   if (rest && *rest)
 259     {
 260       xfree (logging_filename);
 261       logging_filename = xstrdup (rest);
 262     }
 263   handle_redirections (from_tty);
 264 }
 265
 266 static void
 267 set_logging_off (char *args, int from_tty)
 268 {
 269   if (saved_filename == NULL)
 270     return;
 271
 272   pop_output_files ();
 273   if (from_tty)
 274     fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
 275   xfree (saved_filename);
 276   saved_filename = NULL;
 277 }
 278
 279 static void
 280 set_logging_command (char *args, int from_tty)
 281 {
 282   printf_unfiltered (_("\"set logging\" lets you log output to a file.\n"
 283                        "Usage: set logging on [FILENAME]\n"
 284                        "       set logging off\n"
 285                        "       set logging file FILENAME\n"
 286                        "       set logging overwrite [on|off]\n"
 287                        "       set logging redirect [on|off]\n"));
 288 }
 289
 290 static void
 291 show_logging_command (char *args, int from_tty)
 292 {
 293   if (saved_filename)
 294     printf_unfiltered (_("Currently logging to \"%s\".\n"), saved_filename);
 295   if (saved_filename == NULL
 296       || strcmp (logging_filename, saved_filename) != 0)
 297     printf_unfiltered (_("Future logs will be written to %s.\n"),
 298                        logging_filename);
 299
 300   if (logging_overwrite)
 301     printf_unfiltered (_("Logs will overwrite the log file.\n"));
 302   else
 303     printf_unfiltered (_("Logs will be appended to the log file.\n"));
 304
 305   if (saved_filename)
 306     {
 307       if (logging_redirect)
 308         printf_unfiltered (_("Output is being sent only to the log file.\n"));
 309       else
 310         printf_unfiltered (_("Output is being logged and displayed.\n"));
 311     }
 312   else
 313     {
 314       if (logging_redirect)
 315         printf_unfiltered (_("Output will be sent only to the log file.\n"));
 316       else
 317         printf_unfiltered (_("Output will be logged and displayed.\n"));
 318     }
 319 }
 320
 321 /* Provide a prototype to silence -Wmissing-prototypes.  */
 322 extern initialize_file_ftype _initialize_cli_logging;
 323
 324 void
 325 _initialize_cli_logging (void)
 326 {
 327   static struct cmd_list_element *set_logging_cmdlist, *show_logging_cmdlist;
 328
 329   add_prefix_cmd ("logging", class_support, set_logging_command,
 330                   _("Set logging options"), &set_logging_cmdlist,
 331                   "set logging ", 0, &setlist);
 332   add_prefix_cmd ("logging", class_support, show_logging_command,
 333                   _("Show logging options"), &show_logging_cmdlist,
 334                   "show logging ", 0, &showlist);
 335   add_setshow_boolean_cmd ("overwrite", class_support, &logging_overwrite, _("\
 336 Set whether logging overwrites or appends to the log file."), _("\
 337 Show whether logging overwrites or appends to the log file."), _("\
 338 If set, logging overrides the log file."),
 339                            set_logging_overwrite,
 340                            show_logging_overwrite,
 341                            &set_logging_cmdlist, &show_logging_cmdlist);
 342   add_setshow_boolean_cmd ("redirect", class_support, &logging_redirect, _("\
 343 Set the logging output mode."), _("\
 344 Show the logging output mode."), _("\
 345 If redirect is off, output will go to both the screen and the log file.\n\
 346 If redirect is on, output will go only to the log file."),
 347                            set_logging_redirect,
 348                            show_logging_redirect,
 349                            &set_logging_cmdlist, &show_logging_cmdlist);
 350   add_setshow_filename_cmd ("file", class_support, &logging_filename, _("\
 351 Set the current logfile."), _("\
 352 Show the current logfile."), _("\
 353 The logfile is used when directing GDB's output."),
 354                             NULL,
 355                             show_logging_filename,
 356                             &set_logging_cmdlist, &show_logging_cmdlist);
 357   add_cmd ("on", class_support, set_logging_on,
 358            _("Enable logging."), &set_logging_cmdlist);
 359   add_cmd ("off", class_support, set_logging_off,
 360            _("Disable logging."), &set_logging_cmdlist);
 361
 362   logging_filename = xstrdup ("gdb.txt");
 363 }