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