The highest tagged major version is
Documentation
¶
Index ¶
- type FileLock
- type FileLockManager
- type InMemoryManager
- type Locker
- type Manager
- func NewFileLockManager(lockPath string) (Manager, error)
- func NewInMemoryManager(numLocks uint32) (Manager, error)
- func NewSHMLockManager(path string, numLocks uint32) (Manager, error)
- func OpenFileLockManager(path string) (Manager, error)
- func OpenSHMLockManager(path string, numLocks uint32) (Manager, error)
- type Mutex
- type SHMLock
- type SHMLockManager
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileLock ¶
type FileLock struct {
// contains filtered or unexported fields
}
FileLock is an individual shared memory lock.
type FileLockManager ¶
type FileLockManager struct {
// contains filtered or unexported fields
}
FileLockManager manages shared memory locks.
func (*FileLockManager) AllocateAndRetrieveLock ¶
func (m *FileLockManager) AllocateAndRetrieveLock(id uint32) (Locker, error)
AllocateAndRetrieveLock allocates the lock with the given ID and returns it. If the lock is already allocated, error.
func (*FileLockManager) AllocateLock ¶
func (m *FileLockManager) AllocateLock() (Locker, error)
AllocateLock allocates a new lock from the manager.
func (*FileLockManager) FreeAllLocks ¶
func (m *FileLockManager) FreeAllLocks() error
FreeAllLocks frees all locks in the manager. This function is DANGEROUS. Please read the full comment in locks.go before trying to use it.
func (*FileLockManager) RetrieveLock ¶
func (m *FileLockManager) RetrieveLock(id uint32) (Locker, error)
RetrieveLock retrieves a lock from the manager given its ID.
type InMemoryManager ¶
type InMemoryManager struct {
// contains filtered or unexported fields
}
InMemoryManager is a lock manager that allocates and retrieves local-only locks - that is, they are not multiprocess. This lock manager is intended purely for unit and integration testing and should not be used in production deployments.
func (*InMemoryManager) AllocateAndRetrieveLock ¶
func (m *InMemoryManager) AllocateAndRetrieveLock(id uint32) (Locker, error)
AllocateAndRetrieveLock allocates a lock with the given ID (if not already in use) and returns it.
func (*InMemoryManager) AllocateLock ¶
func (m *InMemoryManager) AllocateLock() (Locker, error)
AllocateLock allocates a lock from the manager.
func (*InMemoryManager) FreeAllLocks ¶
func (m *InMemoryManager) FreeAllLocks() error
FreeAllLocks frees all locks. This function is DANGEROUS. Please read the full comment in locks.go before trying to use it.
func (*InMemoryManager) RetrieveLock ¶
func (m *InMemoryManager) RetrieveLock(id uint32) (Locker, error)
RetrieveLock retrieves a lock from the manager.
type Locker ¶
type Locker interface {
// ID retrieves the lock's ID.
// ID is guaranteed to uniquely identify the lock within the
// Manager - that is, calling RetrieveLock with this ID will return
// another instance of the same lock.
ID() uint32
// Lock locks the lock.
// This call MUST block until it successfully acquires the lock or
// encounters a fatal error.
// All errors must be handled internally, as they are not returned. For
// the most part, panicking should be appropriate.
// Some lock implementations may require that Lock() and Unlock() occur
// within the same goroutine (SHM locking, for example). The usual Go
// Lock()/defer Unlock() pattern will still work fine in these cases.
Lock()
// Unlock unlocks the lock.
// All errors must be handled internally, as they are not returned. For
// the most part, panicking should be appropriate.
// This includes unlocking locks which are already unlocked.
Unlock()
// Free deallocates the underlying lock, allowing its reuse by other
// pods and containers.
// The lock MUST still be usable after a Free() - some libpod instances
// may still retain Container structs with the old lock. This simply
// advises the manager that the lock may be reallocated.
Free() error
}
Locker is similar to sync.Locker, but provides a method for freeing the lock to allow its reuse. All Locker implementations must maintain mutex semantics - the lock only allows one caller in the critical section at a time. All locks with the same ID must refer to the same underlying lock, even if they are within multiple processes.
type Manager ¶
type Manager interface {
// AllocateLock returns an unallocated lock.
// It is guaranteed that the same lock will not be returned again by
// AllocateLock until the returned lock has Free() called on it.
// If all available locks are allocated, AllocateLock will return an
// error.
AllocateLock() (Locker, error)
// RetrieveLock retrieves a lock given its UUID.
// The underlying lock MUST be the same as another other lock with the
// same UUID.
RetrieveLock(id uint32) (Locker, error)
// AllocateAndRetrieveLock marks the lock with the given UUID as in use
// and retrieves it.
// RetrieveAndAllocateLock will error if the lock in question has
// already been allocated.
// This is mostly used after a system restart to repopulate the list of
// locks in use.
AllocateAndRetrieveLock(id uint32) (Locker, error)
// PLEASE READ FULL DESCRIPTION BEFORE USING.
// FreeAllLocks frees all allocated locks, in preparation for lock
// reallocation.
// As this deallocates all presently-held locks, this can be very
// dangerous - if there are other processes running that might be
// attempting to allocate new locks and free existing locks, we may
// encounter races leading to an inconsistent state.
// (This is in addition to the fact that FreeAllLocks instantly makes
// the state inconsistent simply by using it, and requires a full
// lock renumbering to restore consistency!).
// In short, this should only be used as part of unit tests, or lock
// renumbering, where reasonable guarantees about other processes can be
// made.
FreeAllLocks() error
}
Manager provides an interface for allocating multiprocess locks. Locks returned by Manager MUST be multiprocess - allocating a lock in process A and retrieving that lock's ID in process B must return handles for the same lock, and locking the lock in A should exclude B from the lock until it is unlocked in A. All locks must be identified by a UUID (retrieved with Locker's ID() method). All locks with a given UUID must refer to the same underlying lock, and it must be possible to retrieve the lock given its UUID. Each UUID should refer to a unique underlying lock. Calls to AllocateLock() must return a unique, unallocated UUID. AllocateLock() must fail once all available locks have been allocated. Locks are returned to use by calls to Free(), and can subsequently be reallocated.
func NewFileLockManager ¶
NewFileLockManager makes a new FileLockManager at the specified directory.
func NewInMemoryManager ¶
NewInMemoryManager creates a new in-memory lock manager with the given number of locks.
func NewSHMLockManager ¶
NewSHMLockManager makes a new SHMLockManager with the given number of locks. Due to the underlying implementation, the exact number of locks created may be greater than the number given here.
func OpenFileLockManager ¶
OpenFileLockManager opens an existing FileLockManager at the specified directory.
type Mutex ¶
type Mutex struct {
// contains filtered or unexported fields
}
Mutex holds a single mutex and whether it has been allocated.
type SHMLock ¶
type SHMLock struct {
// contains filtered or unexported fields
}
SHMLock is an individual shared memory lock.
type SHMLockManager ¶
type SHMLockManager struct {
// contains filtered or unexported fields
}
SHMLockManager manages shared memory locks.
func (*SHMLockManager) AllocateAndRetrieveLock ¶
func (m *SHMLockManager) AllocateAndRetrieveLock(id uint32) (Locker, error)
AllocateAndRetrieveLock allocates the lock with the given ID and returns it. If the lock is already allocated, error.
func (*SHMLockManager) AllocateLock ¶
func (m *SHMLockManager) AllocateLock() (Locker, error)
AllocateLock allocates a new lock from the manager.
func (*SHMLockManager) FreeAllLocks ¶
func (m *SHMLockManager) FreeAllLocks() error
FreeAllLocks frees all locks in the manager. This function is DANGEROUS. Please read the full comment in locks.go before trying to use it.
func (*SHMLockManager) RetrieveLock ¶
func (m *SHMLockManager) RetrieveLock(id uint32) (Locker, error)
RetrieveLock retrieves a lock from the manager given its ID.
Source Files
Directories