tusd/pkg/memorylocker/memorylocker.go

65 lines
1.8 KiB
Go
Raw Normal View History

// Package memorylocker provides an in-memory locking mechanism.
//
// When multiple processes are attempting to access an upload, whether it be
2016-09-27 20:10:16 +00:00
// by reading or writing, a synchronization mechanism is required to prevent
// data corruption, especially to ensure correct offset values and the proper
// order of chunks inside a single upload.
//
// MemoryLocker persists locks using memory and therefore allowing a simple and
2016-09-27 20:10:16 +00:00
// cheap mechanism. Locks will only exist as long as this object is kept in
// reference and will be erased if the program exits.
package memorylocker
import (
2016-03-04 21:27:44 +00:00
"sync"
"github.com/tus/tusd/pkg/handler"
)
2015-12-18 22:20:52 +00:00
// MemoryLocker persists locks using memory and therefore allowing a simple and
2016-09-27 20:10:16 +00:00
// cheap mechanism. Locks will only exist as long as this object is kept in
2015-12-18 22:20:52 +00:00
// reference and will be erased if the program exits.
type MemoryLocker struct {
locks map[string]struct{}
mutex sync.Mutex
}
2016-03-04 21:25:15 +00:00
// New creates a new in-memory locker.
2016-02-21 22:25:35 +00:00
func New() *MemoryLocker {
return &MemoryLocker{
locks: make(map[string]struct{}),
}
}
// UseIn adds this locker to the passed composer.
func (locker *MemoryLocker) UseIn(composer *handler.StoreComposer) {
2016-02-21 22:25:35 +00:00
composer.UseLocker(locker)
}
2015-12-18 22:20:52 +00:00
// LockUpload tries to obtain the exclusive lock.
func (locker *MemoryLocker) LockUpload(id string) error {
2016-03-04 21:27:44 +00:00
locker.mutex.Lock()
defer locker.mutex.Unlock()
// Ensure file is not locked
if _, ok := locker.locks[id]; ok {
return handler.ErrFileLocked
}
locker.locks[id] = struct{}{}
return nil
}
2015-12-18 22:20:52 +00:00
// UnlockUpload releases a lock. If no such lock exists, no error will be returned.
func (locker *MemoryLocker) UnlockUpload(id string) error {
2016-03-04 21:27:44 +00:00
locker.mutex.Lock()
// Deleting a non-existing key does not end in unexpected errors or panic
// since this operation results in a no-op
delete(locker.locks, id)
locker.mutex.Unlock()
return nil
}