| 1 |
=head1 NAME |
| 2 |
|
| 3 |
AnyEvent::MCP::File - private state file locking and replacement |
| 4 |
|
| 5 |
=head1 DESCRIPTION |
| 6 |
|
| 7 |
Internal utility for small state files shared by MCP processes, |
| 8 |
such as the workdir ID registry. C<lock> obtains a lock on the current |
| 9 |
pathname; C<replace> writes a complete new version atomically. The caller |
| 10 |
owns serialization, validation and the lock's lifetime. |
| 11 |
|
| 12 |
For example, after building a new complete file body: |
| 13 |
|
| 14 |
use AnyEvent::MCP::File (); |
| 15 |
|
| 16 |
my $lock = AnyEvent::MCP::File::lock $path; |
| 17 |
# read and validate the current state under this lock |
| 18 |
AnyEvent::MCP::File::replace $path, $new_bytes; |
| 19 |
close $lock; |
| 20 |
|
| 21 |
The lock protects cooperating writers, not other programs that write the |
| 22 |
file without this protocol. Use L<AnyEvent::MCP::Workdirs> for the workdir |
| 23 |
registry rather than implementing its update rules here. |
| 24 |
|
| 25 |
=head1 FUNCTIONS |
| 26 |
|
| 27 |
=over |
| 28 |
|
| 29 |
=item $lock = AnyEvent::MCP::File::lock $file |
| 30 |
|
| 31 |
Create the parent directory and file if necessary, and lock the current file |
| 32 |
exclusively. Retries if an atomic replacement changed the pathname while waiting for the lock. |
| 33 |
Keep the returned handle alive through reading, modifying and replacing |
| 34 |
the file. All writers must use this locking protocol. |
| 35 |
|
| 36 |
=item AnyEvent::MCP::File::replace $file, $bytes |
| 37 |
|
| 38 |
Write bytes to a temporary file beside C<$file>, preserve the mode of an |
| 39 |
existing file, then atomically rename over C<$file>. The caller holds the lock. |
| 40 |
Removes the temporary file on failure. This provides atomic visibility, |
| 41 |
not crash durability. |
| 42 |
|
| 43 |
=back |
| 44 |
|
| 45 |
=cut |
| 46 |
|
| 47 |
package AnyEvent::MCP::File; |
| 48 |
|
| 49 |
use common::sense; |
| 50 |
use File::Path (); |
| 51 |
use File::Basename (); |
| 52 |
use Fcntl qw(O_RDWR O_WRONLY O_CREAT O_EXCL LOCK_EX); |
| 53 |
use Errno qw(ENOENT EEXIST); |
| 54 |
|
| 55 |
sub lock { |
| 56 |
my ($file) = @_; |
| 57 |
|
| 58 |
File::Path::mkpath (File::Basename::dirname ($file), 0, 0700); |
| 59 |
|
| 60 |
while (1) { |
| 61 |
my $fh; |
| 62 |
sysopen $fh, $file, O_RDWR | O_CREAT | O_EXCL, 0600 or do { |
| 63 |
die "$file: $!\n" unless $! == EEXIST; |
| 64 |
sysopen $fh, $file, O_RDWR or die "$file: $!\n"; |
| 65 |
}; |
| 66 |
|
| 67 |
my @stat = stat $fh; |
| 68 |
flock $fh, LOCK_EX or die "$file: $!\n"; |
| 69 |
my @current = stat $file; |
| 70 |
|
| 71 |
return $fh if @current && $stat[0] == $current[0] && $stat[1] == $current[1]; |
| 72 |
|
| 73 |
die "$file: $!\n" unless @current || $! == ENOENT; |
| 74 |
|
| 75 |
close $fh; |
| 76 |
} |
| 77 |
} |
| 78 |
|
| 79 |
sub replace { |
| 80 |
my ($file, $bytes) = @_; |
| 81 |
|
| 82 |
my @stat = stat $file; |
| 83 |
die "$file: $!\n" unless @stat || $! == ENOENT; |
| 84 |
|
| 85 |
my $temporary = "$file.$$~"; |
| 86 |
sysopen my $fh, $temporary, O_WRONLY | O_CREAT | O_EXCL, 0600 or die "$temporary: $!\n"; |
| 87 |
|
| 88 |
my $ok = eval { |
| 89 |
print {$fh} $bytes or die "$temporary: $!\n"; |
| 90 |
if (@stat) { |
| 91 |
my $mode = $stat[2] & 07777; |
| 92 |
chmod $mode, $fh or die "$temporary: $!\n"; |
| 93 |
} |
| 94 |
close $fh or die "$temporary: $!\n"; |
| 95 |
rename $temporary, $file or die "$file: $!\n"; |
| 96 |
1 |
| 97 |
}; |
| 98 |
|
| 99 |
my $error = $@; |
| 100 |
unlink $temporary unless $ok; |
| 101 |
die $error unless $ok; |
| 102 |
} |
| 103 |
|
| 104 |
1; |
