Mirrors/restic
1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-03-09 00:00:02 +01:00
Code Issues Releases Wiki Activity

restorer: HardlinkIndex: better comments

Browse source
This commit is contained in:
Ivan Shapovalov 2024-11-30 14:34:42 +04:00
parent 47dc871c25
commit 051597b7b6
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
internal/restorer/hardlinks_index.go
View file

@ -4,25 +4,26 @@ import (
"sync"
)
// HardlinkKey is a composed key for finding inodes on a specific device.
// HardlinkKey is a composite key that identifies a unique inode on a device.
type HardlinkKey struct {
Inode, Device uint64
}
// HardlinkIndex contains a list of inodes, devices these inodes are one, and associated file names.
// HardlinkIndex is a mapping of unique inodes (hardlink targets) to arbitrary
// data, e.g. known names of those inodes.
type HardlinkIndex[T any] struct {
m sync.Mutex
Index map[HardlinkKey]T
}
// NewHardlinkIndex create a new index for hard links
// NewHardlinkIndex create a new HardlinkIndex for a given value type.
func NewHardlinkIndex[T any]() *HardlinkIndex[T] {
return &HardlinkIndex[T]{
Index: make(map[HardlinkKey]T),
}
}
// Has checks whether the link already exist in the index.
// Has checks whether a given inode already exists in the index.
func (idx *HardlinkIndex[T]) Has(inode uint64, device uint64) bool {
idx.m.Lock()
defer idx.m.Unlock()
@ -31,7 +32,8 @@ func (idx *HardlinkIndex[T]) Has(inode uint64, device uint64) bool {
return ok
}
// Add adds a link to the index.
// Add adds a new inode with its accompanying data to the index, if one did not
// exist before.
func (idx *HardlinkIndex[T]) Add(inode uint64, device uint64, value T) {
idx.m.Lock()
defer idx.m.Unlock()
@ -42,14 +44,14 @@ func (idx *HardlinkIndex[T]) Add(inode uint64, device uint64, value T) {
}
}
// Value obtains the filename from the index.
func (idx *HardlinkIndex[T]) Value(inode uint64, device uint64) T {
// Value looks up the associated data for a given inode.
func (idx *HardlinkIndex[T]) Value(inode uint64, device uint64) (T, bool) {
idx.m.Lock()
defer idx.m.Unlock()
return idx.Index[HardlinkKey{inode, device}]
}
// Remove removes a link from the index.
// Remove removes an inode from the index.
func (idx *HardlinkIndex[T]) Remove(inode uint64, device uint64) {
idx.m.Lock()
defer idx.m.Unlock()