[PATCH] Append to input history file instead of overwriting it

Patrick Palka
2015-01-10T15:18:44Z

This patch makes readline append new history lines to the GDB history
file on exit instead of overwriting the entire history file on exit.
This change allows us to run multiple simultaneous GDB sessions without
having each session overwrite the added history of each other session on
exit.

Care must be taken to ensure that the history file doesn't get corrupted
when multiple GDB processes are trying to simultaneously append to and
then truncate it. Safety is achieved in such a situation by using an
intermediate local history file to mutually exclude multiple processes
from simultaneoeusly performing write operations on the global history
file.

gdb/ChangeLog:

* top.h (gdb_add_history): Declare.
* top.c (command_count): New variable.
(gdb_add_history): New function.
(gdb_safe_append_history): New static function.
(quit_force): Call it.
(command_line_input): Use gdb_add_history instead of
add_history.
* event-top.c (command_line_handler): Likewise.
---
gdb/event-top.c | 2 +-
gdb/top.c | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++---
gdb/top.h | 2 ++
3 files changed, 59 insertions(+), 4 deletions(-)

diff --git a/gdb/event-top.c b/gdb/event-top.c
index 13ddee2..bbda5dc 100644
--- a/gdb/event-top.c
+++ b/gdb/event-top.c
@@ -667,7 +667,7 @@ command_line_handler (char *rl)

/* Add line to history if appropriate. */
if (*linebuffer && input_from_terminal_p ())
- add_history (linebuffer);
+ gdb_add_history (linebuffer);

/* Note: lines consisting solely of comments are added to the command
history. This is useful when you type a command, and then
diff --git a/gdb/top.c b/gdb/top.c
index b85ea1a..19fc1d2 100644
--- a/gdb/top.c
+++ b/gdb/top.c
@@ -895,7 +895,60 @@ gdb_rl_operate_and_get_next (int count, int key)

return rl_newline (1, key);
}
-\f
+
+/* Number of user commands executed during this session. */
+
+static int command_count = 0;
+
+/* Add the user command COMMAND to the input history list. */
+
+void
+gdb_add_history (const char *command)
+{
+ add_history (command);
+ command_count++;
+}
+
+/* Safely append new history entries to the history file in a corruption-free
+ way using an intermediate local history file. */
+
+static void
+gdb_safe_append_history (void)
+{
+ int ret, saved_errno;
+ char *local_history_filename;
+ struct cleanup *old_chain;
+
+ local_history_filename = xstrprintf ("%s.%d", history_filename, getpid ());
+ old_chain = make_cleanup (xfree, local_history_filename);
+
+ ret = rename (history_filename, local_history_filename);
+ if (ret < 0)
+ {
+ /* If the rename failed then either the global history file never existed
+ in the first place or another GDB process is currently appending to it
+ (and has thus temporarily renamed it). Since we can't distinguish
+ between these two cases, we have to conservatively assume the first
+ case and therefore must write out (not append) our known history to
+ our local history file and try to move it back anyway. Otherwise a
+ global history file would never get created! */
+ write_history (local_history_filename);
+ }
+ else
+ {
+ append_history (command_count, local_history_filename);
+ history_truncate_file (local_history_filename, history_max_entries);
+ }
+
+ ret = rename (local_history_filename, history_filename);
+ saved_errno = errno;
+ if (ret < 0)
+ warning (_("Could not rename %s to %s: error %d"),
+ local_history_filename, history_filename, saved_errno);
+
+ do_cleanups (old_chain);
+}
+
/* Read one line from the command input stream `instream'
into the local static buffer `linebuffer' (whose current length
is `linelength').
@@ -1094,7 +1147,7 @@ command_line_input (const char *prompt_arg, int repeat, char *annotation_suffix)

/* Add line to history if appropriate. */
if (*linebuffer && input_from_terminal_p ())
- add_history (linebuffer);
+ gdb_add_history (linebuffer);

/* Save into global buffer if appropriate. */
if (repeat)
@@ -1445,7 +1498,7 @@ quit_force (char *args, int from_tty)
{
if (write_history_p && history_filename
&& input_from_terminal_p ())
- write_history (history_filename);
+ gdb_safe_append_history ();
}
DO_PRINT_EX;

diff --git a/gdb/top.h b/gdb/top.h
index b68e896..987279b 100644
--- a/gdb/top.h
+++ b/gdb/top.h
@@ -79,6 +79,8 @@ extern int history_expansion_p;
extern int server_command;
extern char *lim_at_start;

+extern void gdb_add_history (const char *);
+
extern void show_commands (char *args, int from_tty);

extern void set_history (char *, int);
--
2.2.1.212.gc5b9256