| 1 | package urpm::lock; | ||
| 2 | |||
| 3 | |||
| 4 | 1 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 5 | 0 | ▶ | use urpm::msg; |
|
Subroutine
BEGIN: called CC=1 SCAR=2.6
| |||
| 6 | use urpm::util 'cat_'; | ||
| 7 | |||
| 8 | #- avoid putting a require on Fcntl ':flock' (which is perl and not perl-base). | ||
| 9 | my ($LOCK_SH, $LOCK_EX, $LOCK_NB, $LOCK_UN) = (1, 2, 4, 8); | ||
| 10 | |||
| 11 | |||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | urpm::lock - urpm/rpm DB locking related routines for urpmi | ||
| 16 | |||
| 17 | =head1 SYNOPSIS | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | =head1 CLASS FUNCTIONS | ||
| 22 | |||
| 23 | =over | ||
| 24 | |||
| 25 | =item rpm_db($urpm, $b_exclusive, %options) | ||
| 26 | |||
| 27 | Lock rpm DB. | ||
| 28 | |||
| 29 | Lock policy concerning chroot : lock rpm db in chroot | ||
| 30 | |||
| 31 | Options: nofatal, wait | ||
| 32 | |||
| 33 | =cut | ||
| 34 | |||
| 35 | sub rpm_db { | ||
| 36 | my ($urpm, $b_exclusive, %options) = @_; | ||
| 37 | my $f = ($urpm->{root} ? "$urpm->{root}/" : '') . "/var/lib/rpm/.RPMLOCK"; | ||
| 38 | urpm::lock->new($urpm, $f, 'rpm', $b_exclusive, %options); | ||
| 39 | } | ||
| 40 | |||
| 41 | =item urpmi_db($urpm, $b_exclusive, %options) | ||
| 42 | |||
| 43 | Lock urpmi DB. | ||
| 44 | |||
| 45 | Lock policy concerning chroot : lock urpmi db in / | ||
| 46 | |||
| 47 | Options: nofatal, wait | ||
| 48 | |||
| 49 | =cut | ||
| 50 | |||
| 51 | sub urpmi_db { | ||
| 52 | my ($urpm, $b_exclusive, %options) = @_; | ||
| 53 | urpm::lock->new($urpm, "$urpm->{statedir}/.LOCK", 'urpmi', $b_exclusive, %options); | ||
| 54 | } | ||
| 55 | |||
| 56 | =back | ||
| 57 | |||
| 58 | =head1 METHODS | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item new($_class, $urpm, $file, $db_name, $b_exclusive, %options) | ||
| 63 | |||
| 64 | Create a new lock. | ||
| 65 | You don't want to use it directly. Either use urpmi_db() or rpm_db(). | ||
| 66 | |||
| 67 | Options: | ||
| 68 | |||
| 69 | =over 4 | ||
| 70 | |||
| 71 | =item * nofatal | ||
| 72 | |||
| 73 | =item * wait | ||
| 74 | |||
| 75 | =back | ||
| 76 | |||
| 77 | =cut | ||
| 78 | |||
| 79 | sub new { | ||
| 80 | my ($_class, $urpm, $file, $db_name, $b_exclusive, %options) = @_; | ||
| 81 | |||
| 82 | my $fh; | ||
| 83 | #- we don't care what the mode is. ">" allow creating the file, but can't be done as user | ||
| 84 | open($fh, '>', $file) or open($fh, '<', $file) or return; | ||
| 85 | |||
| 86 | my $lock = bless { | ||
| 87 | fh => $fh, db_name => $db_name, | ||
| 88 | fatal => $options{nofatal} ? $urpm->{error} : sub { $urpm->{fatal}(7, $_[0]) }, | ||
| 89 | info => $urpm->{info}, | ||
| 90 | log => $urpm->{log}, | ||
| 91 | }; | ||
| 92 | _lock($lock, $b_exclusive, $options{wait}); | ||
| 93 | $lock; | ||
| 94 | } | ||
| 95 | |||
| 96 | sub get_lock_pid { | ||
| 97 | my ($fh) = @_; | ||
| 98 | my ($dev, $ino, undef) = stat($fh); | ||
| 99 | my $major = int($dev/256); | ||
| 100 | my $minor = $dev % 256; | ||
| 101 | my $fileid = sprintf("%02x:%02x:%d",$major,$minor,$ino); | ||
| 102 | foreach (urpm::util::cat_('/proc/locks')) { /FLOCK.*WRITE\s*(\d+)\s*$fileid\s/ && return $1 } | ||
| 103 | } | ||
| 104 | |||
| 105 | sub warn_about_locker { | ||
| 106 | my ($lock) = @_; | ||
| 107 | if (my $pid = get_lock_pid($lock->{fh})) { | ||
| 108 | my $name = urpm::util::cat_("/proc/$pid/cmdline"); | ||
| 109 | $name =~ tr/\0/ /; | ||
| 110 | $name =~ s/ *$//; | ||
| 111 | $lock->{fatal}(N("%s database is locked, process %d is already using it", $lock->{db_name}, $pid) . ($name ? " ($name)" : "")); | ||
| 112 | } else { | ||
| 113 | $lock->{fatal}(N("%s database is locked (another program is already using it)", $lock->{db_name})); | ||
| 114 | } | ||
| 115 | } | ||
| 116 | |||
| 117 | sub _lock { | ||
| 118 | my ($lock, $b_exclusive, $b_wait) = @_; | ||
| 119 | $b_exclusive ||= ''; | ||
| 120 | if ($lock->{log}) { | ||
| 121 | my $action = $lock->{exclusive} && !$b_exclusive ? 'releasing exclusive' : $b_exclusive ? 'getting exclusive' : 'getting'; | ||
| 122 | $lock->{log}("$action lock on $lock->{db_name}"); | ||
| 123 | } | ||
| 124 | my $mode = $b_exclusive ? $LOCK_EX : $LOCK_SH; | ||
| 125 | if (!flock($lock->{fh}, $mode | $LOCK_NB)) { | ||
| 126 | if ($b_wait) { | ||
| 127 | $lock->{info}(N("%s database is locked. Waiting...", $lock->{db_name})); | ||
| 128 | flock($lock->{fh}, $mode) or $lock->{fatal}(N("aborting")); | ||
| 129 | } else { | ||
| 130 | warn_about_locker($lock); | ||
| 131 | } | ||
| 132 | } | ||
| 133 | $lock->{locked} = 1; | ||
| 134 | $lock->{exclusive} = $b_exclusive; | ||
| 135 | } | ||
| 136 | |||
| 137 | |||
| 138 | =item unlock($lock) | ||
| 139 | |||
| 140 | Free a lock. | ||
| 141 | |||
| 142 | =cut | ||
| 143 | |||
| 144 | |||
| 145 | sub unlock { | ||
| 146 | my ($lock) = @_; | ||
| 147 | $lock->{fh} or warn "lock $lock->{db_name} already released\n", return; | ||
| 148 | |||
| 149 | if ($lock->{locked}) { | ||
| 150 | $lock->{log} and $lock->{log}("unlocking $lock->{db_name} database"); | ||
| 151 | flock $lock->{fh}, $LOCK_UN; | ||
| 152 | } | ||
| 153 | close $lock->{fh}; | ||
| 154 | delete $lock->{fh}; | ||
| 155 | } | ||
| 156 | |||
| 157 | sub DESTROY { | ||
| 158 | my ($lock) = @_; | ||
| 159 | unlock($lock) if $lock->{fh}; | ||
| 160 | } | ||
| 161 | |||
| 162 | =back | ||
| 163 | |||
| 164 | =head1 COPYRIGHT | ||
| 165 | |||
| 166 | Copyright (C) 2005 MandrakeSoft SA | ||
| 167 | |||
| 168 | Copyright (C) 2005-2010 Mandriva SA | ||
| 169 | |||
| 170 | Copyright (C) 2011-2020 Mageia | ||
| 171 | |||
| 172 | =cut | ||