gdb/cli/cli-logging.c

   1 /* Command-line output logging for GDB, the GNU debugger.
   2
   3    Copyright (c) 2003, 2004, 2007, 2008, 2009, 2010
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include "defs.h"
  22 #include "gdbcmd.h"
  23 #include "ui-out.h"
  24 #include "gdb_assert.h"
  25
  26 #include "gdb_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 };
  37 static struct saved_output_files saved_output;
  38 static char *saved_filename;
  39
  40 static char *logging_filename;
  41 static void
  42 show_logging_filename (struct ui_file *file, int from_tty,
  43                        struct cmd_list_element *c, const char *value)
  44 {
  45   fprintf_filtered (file, _("The current logfile is \"%s\".\n"),
  46                     value);
  47 }
  48
  49 static int logging_overwrite;
  50
  51 static void
  52 set_logging_overwrite (char *args, int from_tty, struct cmd_list_element *c)
  53 {
  54   if (saved_filename)
  55     warning (_("Currently logging to %s.  Turn the logging off and on to "
  56                "make the new setting effective."), saved_filename);
  57 }
  58
  59 static void
  60 show_logging_overwrite (struct ui_file *file, int from_tty,
  61                         struct cmd_list_element *c, const char *value)
  62 {
  63   fprintf_filtered (file, _("\
  64 Whether logging overwrites or appends to the log file is %s.\n"),
  65                     value);
  66 }
  67
  68 /* Value as configured by the user.  */
  69 static int logging_redirect;
  70
  71 /* The on-disk file in use if logging is currently active together with
  72    redirection turned off (and therefore using tee_file_new).  For active
  73    logging with redirection the on-disk file is directly in GDB_STDOUT and
  74    this variable is NULL.  */
  75 static struct ui_file *logging_no_redirect_file;
  76
  77 static void
  78 set_logging_redirect (char *args, int from_tty, struct cmd_list_element *c)
  79 {
  80   struct cleanup *cleanups = NULL;
  81   struct ui_file *output, *new_logging_no_redirect_file;
  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   if (logging_redirect != 0)
  89     {
  90       gdb_assert (logging_no_redirect_file != NULL);
  91
  92       /* ui_out_redirect still has not been called for next gdb_stdout.  */
  93       cleanups = make_cleanup_ui_file_delete (gdb_stdout);
  94
  95       output = logging_no_redirect_file;
  96       new_logging_no_redirect_file = NULL;
  97
  98       if (from_tty)
  99         fprintf_unfiltered (saved_output.out, "Redirecting output to %s.\n",
 100                             logging_filename);
 101     }
 102   else
 103     {
 104       gdb_assert (logging_no_redirect_file == NULL);
 105       output = tee_file_new (saved_output.out, 0, gdb_stdout, 0);
 106       if (output == NULL)
 107         perror_with_name (_("set logging"));
 108       new_logging_no_redirect_file = gdb_stdout;
 109
 110       if (from_tty)
 111         fprintf_unfiltered (saved_output.out, "Copying output to %s.\n",
 112                             logging_filename);
 113     }
 114
 115   gdb_stdout = output;
 116   gdb_stderr = output;
 117   gdb_stdlog = output;
 118   gdb_stdtarg = output;
 119   logging_no_redirect_file = new_logging_no_redirect_file;
 120
 121   /* It should not happen, the redirection has been already setup.  */
 122   if (ui_out_redirect (uiout, output) < 0)
 123     warning (_("Current output protocol does not support redirection"));
 124
 125   if (logging_redirect != 0)
 126     do_cleanups (cleanups);
 127 }
 128
 129 static void
 130 show_logging_redirect (struct ui_file *file, int from_tty,
 131                        struct cmd_list_element *c, const char *value)
 132 {
 133   fprintf_filtered (file, _("The logging output mode is %s.\n"), value);
 134 }
 135
 136 /* If we've pushed output files, close them and pop them.  */
 137 static void
 138 pop_output_files (void)
 139 {
 140   /* Only delete one of the files -- they are all set to the same
 141      value.  */
 142   ui_file_delete (gdb_stdout);
 143   if (logging_no_redirect_file)
 144     {
 145       ui_file_delete (logging_no_redirect_file);
 146       logging_no_redirect_file = NULL;
 147     }
 148   gdb_stdout = saved_output.out;
 149   gdb_stderr = saved_output.err;
 150   gdb_stdlog = saved_output.log;
 151   gdb_stdtarg = saved_output.targ;
 152   saved_output.out = NULL;
 153   saved_output.err = NULL;
 154   saved_output.log = NULL;
 155   saved_output.targ = NULL;
 156
 157   ui_out_redirect (uiout, NULL);
 158 }
 159
 160 /* This is a helper for the `set logging' command.  */
 161 static void
 162 handle_redirections (int from_tty)
 163 {
 164   struct cleanup *cleanups;
 165   struct ui_file *output;
 166
 167   if (saved_filename != NULL)
 168     {
 169       fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
 170                           saved_filename);
 171       return;
 172     }
 173
 174   output = gdb_fopen (logging_filename, logging_overwrite ? "w" : "a");
 175   if (output == NULL)
 176     perror_with_name (_("set logging"));
 177   cleanups = make_cleanup_ui_file_delete (output);
 178
 179   /* Redirects everything to gdb_stdout while this is running.  */
 180   if (!logging_redirect)
 181     {
 182       struct ui_file *no_redirect_file = output;
 183
 184       output = tee_file_new (gdb_stdout, 0, no_redirect_file, 0);
 185       if (output == NULL)
 186         perror_with_name (_("set logging"));
 187       make_cleanup_ui_file_delete (output);
 188       if (from_tty)
 189         fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
 190                             logging_filename);
 191       logging_no_redirect_file = no_redirect_file;
 192     }
 193   else
 194     {
 195       gdb_assert (logging_no_redirect_file == NULL);
 196
 197       if (from_tty)
 198         fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
 199                             logging_filename);
 200     }
 201
 202   discard_cleanups (cleanups);
 203
 204   saved_filename = xstrdup (logging_filename);
 205   saved_output.out = gdb_stdout;
 206   saved_output.err = gdb_stderr;
 207   saved_output.log = gdb_stdlog;
 208   saved_output.targ = gdb_stdtarg;
 209
 210   gdb_stdout = output;
 211   gdb_stderr = output;
 212   gdb_stdlog = output;
 213   gdb_stdtarg = output;
 214
 215   if (ui_out_redirect (uiout, gdb_stdout) < 0)
 216     warning (_("Current output protocol does not support redirection"));
 217 }
 218
 219 static void
 220 set_logging_on (char *args, int from_tty)
 221 {
 222   char *rest = args;
 223
 224   if (rest && *rest)
 225     {
 226       xfree (logging_filename);
 227       logging_filename = xstrdup (rest);
 228     }
 229   handle_redirections (from_tty);
 230 }
 231
 232 static void
 233 set_logging_off (char *args, int from_tty)
 234 {
 235   if (saved_filename == NULL)
 236     return;
 237
 238   pop_output_files ();
 239   if (from_tty)
 240     fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
 241   xfree (saved_filename);
 242   saved_filename = NULL;
 243 }
 244
 245 static void
 246 set_logging_command (char *args, int from_tty)
 247 {
 248   printf_unfiltered (_("\
 249 \"set logging\" lets you log output to a file.\n\
 250 Usage: set logging on [FILENAME]\n\
 251        set logging off\n\
 252        set logging file FILENAME\n\
 253        set logging overwrite [on|off]\n\
 254        set logging redirect [on|off]\n"));
 255 }
 256
 257 static void
 258 show_logging_command (char *args, int from_tty)
 259 {
 260   if (saved_filename)
 261     printf_unfiltered (_("Currently logging to \"%s\".\n"), saved_filename);
 262   if (saved_filename == NULL
 263       || strcmp (logging_filename, saved_filename) != 0)
 264     printf_unfiltered (_("Future logs will be written to %s.\n"),
 265                        logging_filename);
 266
 267   if (logging_overwrite)
 268     printf_unfiltered (_("Logs will overwrite the log file.\n"));
 269   else
 270     printf_unfiltered (_("Logs will be appended to the log file.\n"));
 271
 272   if (saved_filename)
 273     {
 274       if (logging_redirect)
 275         printf_unfiltered (_("Output is being sent only to the log file.\n"));
 276       else
 277         printf_unfiltered (_("Output is being logged and displayed.\n"));
 278     }
 279   else
 280     {
 281       if (logging_redirect)
 282         printf_unfiltered (_("Output will be sent only to the log file.\n"));
 283       else
 284         printf_unfiltered (_("Output will be logged and displayed.\n"));
 285     }
 286 }
 287
 288 /* Provide a prototype to silence -Wmissing-prototypes.  */
 289 extern initialize_file_ftype _initialize_cli_logging;
 290
 291 void
 292 _initialize_cli_logging (void)
 293 {
 294   static struct cmd_list_element *set_logging_cmdlist, *show_logging_cmdlist;
 295
 296   add_prefix_cmd ("logging", class_support, set_logging_command,
 297                   _("Set logging options"), &set_logging_cmdlist,
 298                   "set logging ", 0, &setlist);
 299   add_prefix_cmd ("logging", class_support, show_logging_command,
 300                   _("Show logging options"), &show_logging_cmdlist,
 301                   "show logging ", 0, &showlist);
 302   add_setshow_boolean_cmd ("overwrite", class_support, &logging_overwrite, _("\
 303 Set whether logging overwrites or appends to the log file."), _("\
 304 Show whether logging overwrites or appends to the log file."), _("\
 305 If set, logging overrides the log file."),
 306                            set_logging_overwrite,
 307                            show_logging_overwrite,
 308                            &set_logging_cmdlist, &show_logging_cmdlist);
 309   add_setshow_boolean_cmd ("redirect", class_support, &logging_redirect, _("\
 310 Set the logging output mode."), _("\
 311 Show the logging output mode."), _("\
 312 If redirect is off, output will go to both the screen and the log file.\n\
 313 If redirect is on, output will go only to the log file."),
 314                            set_logging_redirect,
 315                            show_logging_redirect,
 316                            &set_logging_cmdlist, &show_logging_cmdlist);
 317   add_setshow_filename_cmd ("file", class_support, &logging_filename, _("\
 318 Set the current logfile."), _("\
 319 Show the current logfile."), _("\
 320 The logfile is used when directing GDB's output."),
 321                             NULL,
 322                             show_logging_filename,
 323                             &set_logging_cmdlist, &show_logging_cmdlist);
 324   add_cmd ("on", class_support, set_logging_on,
 325            _("Enable logging."), &set_logging_cmdlist);
 326   add_cmd ("off", class_support, set_logging_off,
 327            _("Disable logging."), &set_logging_cmdlist);
 328
 329   logging_filename = xstrdup ("gdb.txt");
 330 }