gdb/cli/cli-logging.c

   1 /* Command-line output logging for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2019 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 static char *saved_filename;
  26
  27 static char *logging_filename;
  28 static void
  29 show_logging_filename (struct ui_file *file, int from_tty,
  30                        struct cmd_list_element *c, const char *value)
  31 {
  32   fprintf_filtered (file, _("The current logfile is \"%s\".\n"),
  33                     value);
  34 }
  35
  36 static int logging_overwrite;
  37
  38 static void
  39 maybe_warn_already_logging ()
  40 {
  41   if (saved_filename)
  42     warning (_("Currently logging to %s.  Turn the logging off and on to "
  43                "make the new setting effective."), saved_filename);
  44 }
  45
  46 static void
  47 set_logging_overwrite (const char *args,
  48                        int from_tty, struct cmd_list_element *c)
  49 {
  50   maybe_warn_already_logging ();
  51 }
  52
  53 static void
  54 show_logging_overwrite (struct ui_file *file, int from_tty,
  55                         struct cmd_list_element *c, const char *value)
  56 {
  57   fprintf_filtered (file,
  58                     _("Whether logging overwrites or "
  59                       "appends to the log file is %s.\n"),
  60                     value);
  61 }
  62
  63 /* Value as configured by the user.  */
  64 static int logging_redirect;
  65 static int debug_redirect;
  66
  67 static void
  68 set_logging_redirect (const char *args,
  69                       int from_tty, struct cmd_list_element *c)
  70 {
  71   maybe_warn_already_logging ();
  72 }
  73
  74 static void
  75 show_logging_redirect (struct ui_file *file, int from_tty,
  76                        struct cmd_list_element *c, const char *value)
  77 {
  78   fprintf_filtered (file, _("The logging output mode is %s.\n"), value);
  79 }
  80
  81 /* If we've pushed output files, close them and pop them.  */
  82 static void
  83 pop_output_files (void)
  84 {
  85   current_interp_set_logging (NULL, false, false);
  86
  87   /* Stay consistent with handle_redirections.  */
  88   if (!current_uiout->is_mi_like_p ())
  89     current_uiout->redirect (NULL);
  90 }
  91
  92 /* This is a helper for the `set logging' command.  */
  93 static void
  94 handle_redirections (int from_tty)
  95 {
  96   if (saved_filename != NULL)
  97     {
  98       fprintf_unfiltered (gdb_stdout, "Already logging to %s.\n",
  99                           saved_filename);
 100       return;
 101     }
 102
 103   stdio_file_up log (new no_terminal_escape_file ());
 104   if (!log->open (logging_filename, logging_overwrite ? "w" : "a"))
 105     perror_with_name (_("set logging"));
 106
 107   /* Redirects everything to gdb_stdout while this is running.  */
 108   if (from_tty)
 109     {
 110       if (!logging_redirect)
 111         fprintf_unfiltered (gdb_stdout, "Copying output to %s.\n",
 112                             logging_filename);
 113       else
 114         fprintf_unfiltered (gdb_stdout, "Redirecting output to %s.\n",
 115                             logging_filename);
 116
 117       if (!debug_redirect)
 118         fprintf_unfiltered (gdb_stdout, "Copying debug output to %s.\n",
 119                             logging_filename);
 120       else
 121         fprintf_unfiltered (gdb_stdout, "Redirecting debug output to %s.\n",
 122                             logging_filename);
 123     }
 124
 125   saved_filename = xstrdup (logging_filename);
 126
 127   /* Let the interpreter do anything it needs.  */
 128   current_interp_set_logging (std::move (log), logging_redirect,
 129                               debug_redirect);
 130
 131   /* Redirect the current ui-out object's output to the log.  Use
 132      gdb_stdout, not log, since the interpreter may have created a tee
 133      that wraps the log.  Don't do the redirect for MI, it confuses
 134      MI's ui-out scheme.  Note that we may get here with MI as current
 135      interpreter, but with the current ui_out as a CLI ui_out, with
 136      '-interpreter-exec console "set logging on"'.  */
 137   if (!current_uiout->is_mi_like_p ())
 138     current_uiout->redirect (gdb_stdout);
 139 }
 140
 141 static void
 142 set_logging_on (const char *args, int from_tty)
 143 {
 144   const char *rest = args;
 145
 146   if (rest && *rest)
 147     {
 148       xfree (logging_filename);
 149       logging_filename = xstrdup (rest);
 150     }
 151   handle_redirections (from_tty);
 152 }
 153
 154 static void
 155 set_logging_off (const char *args, int from_tty)
 156 {
 157   if (saved_filename == NULL)
 158     return;
 159
 160   pop_output_files ();
 161   if (from_tty)
 162     fprintf_unfiltered (gdb_stdout, "Done logging to %s.\n", saved_filename);
 163   xfree (saved_filename);
 164   saved_filename = NULL;
 165 }
 166
 167 static void
 168 set_logging_command (const char *args, int from_tty)
 169 {
 170   printf_unfiltered (_("\"set logging\" lets you log output to a file.\n"
 171                        "Usage: set logging on [FILENAME]\n"
 172                        "       set logging off\n"
 173                        "       set logging file FILENAME\n"
 174                        "       set logging overwrite [on|off]\n"
 175                        "       set logging redirect [on|off]\n"));
 176 }
 177
 178 static void
 179 show_logging_command (const char *args, int from_tty)
 180 {
 181   if (saved_filename)
 182     printf_unfiltered (_("Currently logging to \"%s\".\n"), saved_filename);
 183   if (saved_filename == NULL
 184       || strcmp (logging_filename, saved_filename) != 0)
 185     printf_unfiltered (_("Future logs will be written to %s.\n"),
 186                        logging_filename);
 187
 188   if (logging_overwrite)
 189     printf_unfiltered (_("Logs will overwrite the log file.\n"));
 190   else
 191     printf_unfiltered (_("Logs will be appended to the log file.\n"));
 192
 193   if (logging_redirect)
 194     printf_unfiltered (_("Output will be sent only to the log file.\n"));
 195   else
 196     printf_unfiltered (_("Output will be logged and displayed.\n"));
 197
 198   if (debug_redirect)
 199     printf_unfiltered (_("Debug output will be sent only to the log file.\n"));
 200   else
 201     printf_unfiltered (_("Debug output will be logged and displayed.\n"));
 202 }
 203
 204 void
 205 _initialize_cli_logging (void)
 206 {
 207   static struct cmd_list_element *set_logging_cmdlist, *show_logging_cmdlist;
 208
 209   add_prefix_cmd ("logging", class_support, set_logging_command,
 210                   _("Set logging options."), &set_logging_cmdlist,
 211                   "set logging ", 0, &setlist);
 212   add_prefix_cmd ("logging", class_support, show_logging_command,
 213                   _("Show logging options."), &show_logging_cmdlist,
 214                   "show logging ", 0, &showlist);
 215   add_setshow_boolean_cmd ("overwrite", class_support, &logging_overwrite, _("\
 216 Set whether logging overwrites or appends to the log file."), _("\
 217 Show whether logging overwrites or appends to the log file."), _("\
 218 If set, logging overrides the log file."),
 219                            set_logging_overwrite,
 220                            show_logging_overwrite,
 221                            &set_logging_cmdlist, &show_logging_cmdlist);
 222   add_setshow_boolean_cmd ("redirect", class_support, &logging_redirect, _("\
 223 Set the logging output mode."), _("\
 224 Show the logging output mode."), _("\
 225 If redirect is off, output will go to both the screen and the log file.\n\
 226 If redirect is on, output will go only to the log file."),
 227                            set_logging_redirect,
 228                            show_logging_redirect,
 229                            &set_logging_cmdlist, &show_logging_cmdlist);
 230   add_setshow_boolean_cmd ("debugredirect", class_support,
 231                            &debug_redirect, _("\
 232 Set the logging debug output mode."), _("\
 233 Show the logging debug output mode."), _("\
 234 If debug redirect is off, debug will go to both the screen and the log file.\n\
 235 If debug redirect is on, debug will go only to the log file."),
 236                            set_logging_redirect,
 237                            show_logging_redirect,
 238                            &set_logging_cmdlist, &show_logging_cmdlist);
 239   add_setshow_filename_cmd ("file", class_support, &logging_filename, _("\
 240 Set the current logfile."), _("\
 241 Show the current logfile."), _("\
 242 The logfile is used when directing GDB's output."),
 243                             NULL,
 244                             show_logging_filename,
 245                             &set_logging_cmdlist, &show_logging_cmdlist);
 246   add_cmd ("on", class_support, set_logging_on,
 247            _("Enable logging."), &set_logging_cmdlist);
 248   add_cmd ("off", class_support, set_logging_off,
 249            _("Disable logging."), &set_logging_cmdlist);
 250
 251   logging_filename = xstrdup ("gdb.txt");
 252 }