Skip to content

Commit

Permalink
struct lock_file: declare some fields volatile
Browse files Browse the repository at this point in the history
The function remove_lock_file_on_signal() is used as a signal handler.
It is not realistic to make the signal handler conform strictly to the
C standard, which is very restrictive about what a signal handler is
allowed to do.  But let's increase the likelihood that it will work:

The lock_file_list global variable and several fields from struct
lock_file are used by the signal handler.  Declare those values
"volatile" to (1) force the main process to write the values to RAM
promptly, and (2) prevent updates to these fields from being reordered
in a way that leaves an opportunity for a jump to the signal handler
while the object is in an inconsistent state.

We don't mark the filename field volatile because that would prevent
the use of strcpy(), and it is anyway unlikely that a compiler
re-orders a strcpy() call across other expressions.  So in practice it
should be possible to get away without "volatile" in the "filename"
case.

Suggested-by: Johannes Sixt <j6t@kdbg.org>
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Michael Haggerty authored and Junio C Hamano committed Oct 1, 2014
1 parent 707103f commit 2091c50
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions cache.h
Original file line number Diff line number Diff line change
Expand Up @@ -575,10 +575,10 @@ extern int refresh_index(struct index_state *, unsigned int flags, const struct
#define LOCK_SUFFIX_LEN 5

struct lock_file {
struct lock_file *next;
struct lock_file *volatile next;
volatile sig_atomic_t active;
int fd;
pid_t owner;
volatile int fd;
volatile pid_t owner;
char on_list;
char filename[PATH_MAX];
};
Expand Down
2 changes: 1 addition & 1 deletion lockfile.c
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
* on_list is set.
*/

static struct lock_file *lock_file_list;
static struct lock_file *volatile lock_file_list;

static void remove_lock_file(void)
{
Expand Down

0 comments on commit 2091c50

Please sign in to comment.