File: lockfile_unix.go

package info (click to toggle)
golang-github-containers-storage 1.57.2%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,072 kB
  • sloc: sh: 637; ansic: 389; makefile: 143; awk: 12
file content (106 lines) | stat: -rw-r--r-- 2,778 bytes parent folder | download
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
//go:build !windows

package lockfile

import (
	"time"

	"github.com/containers/storage/pkg/system"
	"golang.org/x/sys/unix"
)

type fileHandle uintptr

// GetLastWrite returns a LastWrite value corresponding to current state of the lock.
// This is typically called before (_not after_) loading the state when initializing a consumer
// of the data protected by the lock.
// During the lifetime of the consumer, the consumer should usually call ModifiedSince instead.
//
// The caller must hold the lock (for reading or writing).
func (l *LockFile) GetLastWrite() (LastWrite, error) {
	l.AssertLocked()
	contents := make([]byte, lastWriterIDSize)
	n, err := unix.Pread(int(l.fd), contents, 0)
	if err != nil {
		return LastWrite{}, err
	}
	// It is important to handle the partial read case, because
	// the initial size of the lock file is zero, which is a valid
	// state (no writes yet)
	contents = contents[:n]
	return newLastWriteFromData(contents), nil
}

// RecordWrite updates the lock with a new LastWrite value, and returns the new value.
//
// If this function fails, the LastWriter value of the lock is indeterminate;
// the caller should keep using the previously-recorded LastWrite value,
// and possibly detecting its own modification as an external one:
//
//	lw, err := state.lock.RecordWrite()
//	if err != nil { /* fail */ }
//	state.lastWrite = lw
//
// The caller must hold the lock for writing.
func (l *LockFile) RecordWrite() (LastWrite, error) {
	l.AssertLockedForWriting()
	lw := newLastWrite()
	lockContents := lw.serialize()
	n, err := unix.Pwrite(int(l.fd), lockContents, 0)
	if err != nil {
		return LastWrite{}, err
	}
	if n != len(lockContents) {
		return LastWrite{}, unix.ENOSPC
	}
	return lw, nil
}

// TouchedSince indicates if the lock file has been touched since the specified time
func (l *LockFile) TouchedSince(when time.Time) bool {
	st, err := system.Fstat(int(l.fd))
	if err != nil {
		return true
	}
	mtim := st.Mtim()
	touched := time.Unix(mtim.Unix())
	return when.Before(touched)
}

func openHandle(path string, mode int) (fileHandle, error) {
	mode |= unix.O_CLOEXEC
	fd, err := unix.Open(path, mode, 0o644)
	return fileHandle(fd), err
}

func lockHandle(fd fileHandle, lType lockType, nonblocking bool) error {
	fType := unix.F_RDLCK
	if lType != readLock {
		fType = unix.F_WRLCK
	}
	lk := unix.Flock_t{
		Type:   int16(fType),
		Whence: int16(unix.SEEK_SET),
		Start:  0,
		Len:    0,
	}
	cmd := unix.F_SETLKW
	if nonblocking {
		cmd = unix.F_SETLK
	}
	for {
		err := unix.FcntlFlock(uintptr(fd), cmd, &lk)
		if err == nil || nonblocking {
			return err
		}
		time.Sleep(10 * time.Millisecond)
	}
}

func unlockAndCloseHandle(fd fileHandle) {
	unix.Close(int(fd))
}

func closeHandle(fd fileHandle) {
	unix.Close(int(fd))
}