1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
//go:build linux
// +build linux
package libgoal
import (
"fmt"
"io"
"os"
"golang.org/x/sys/unix"
)
type linuxLocker struct {
setLockWait int
}
// makeLocker create a unix file locker.
// Note that the desired way is to use the OFD locker, which locks on the file descriptor level.
// Since older kernels (Linux kernel < 3.15) do not support OFD, we fall back to non-OFD in that case.
// Falling back to the non-OFD lock would allow obtaining two locks by the same process. If this becomes
// and issue, we might want to use flock, which wouldn't work across NFS on older Linux kernels.
func makeLocker() (*linuxLocker, error) {
locker := &linuxLocker{}
// Check whether F_OFD_SETLKW is supported
getlk := unix.Flock_t{Type: unix.F_RDLCK}
err := unix.FcntlFlock(0, unix.F_OFD_GETLK, &getlk)
if err == nil {
locker.setLockWait = unix.F_OFD_SETLKW
} else if err == unix.EINVAL {
// The command F_OFD_SETLKW is not available
// Fall back to non-OFD locks
locker.setLockWait = unix.F_SETLKW
} else {
// Another unknown error occurred
return nil, fmt.Errorf("unknown error of FnctlFlock: %v", err)
}
return locker, nil
}
// the FcntlFlock has the most consistent behaviour across platforms,
// and supports both local and network file systems.
func (f *linuxLocker) tryRLock(fd *os.File) error {
flock := &unix.Flock_t{
Type: unix.F_RDLCK,
Whence: int16(io.SeekStart),
Start: 0,
Len: 0,
}
return unix.FcntlFlock(fd.Fd(), f.setLockWait, flock)
}
func (f *linuxLocker) tryLock(fd *os.File) error {
flock := &unix.Flock_t{
Type: unix.F_WRLCK,
Whence: int16(io.SeekStart),
Start: 0,
Len: 0,
}
return unix.FcntlFlock(fd.Fd(), f.setLockWait, flock)
}
func (f *linuxLocker) unlock(fd *os.File) error {
flock := &unix.Flock_t{
Type: unix.F_UNLCK,
Whence: int16(io.SeekStart),
Start: 0,
Len: 0,
}
return unix.FcntlFlock(fd.Fd(), f.setLockWait, flock)
}
|
