Files
dokku/plugins/common/lock.go
T
Jose Diaz-Gonzalez 06a6fffb59 fix: build plugins/common on windows
On windows, `LockDirectory` now takes a `LockFileEx` lock on a `.dokku.lock` file inside the directory, as `flock` is unavailable there.
2026-11-08 21:13:25 -05:00

50 lines
1.7 KiB
Go

package common
import (
"os"
"path/filepath"
"strings"
)
// LockedDirectoriesEnvVar names the environment variable a caller holding a
// directory lock exports to its child processes. It holds a newline-separated
// list of directories, and LockDirectory runs its callback without locking a
// directory found in that list, so a subprocess spawned while the lock is held
// does not deadlock waiting on its own parent.
const LockedDirectoriesEnvVar = "DOKKU_LOCKED_DIRECTORIES"
// LockDirectory holds an exclusive lock on dir for the duration of fn. The
// directory must already exist. On unix the lock is a flock on the directory
// itself, and on windows it is a LockFileEx lock on a lock file inside the
// directory. The lock is advisory: it serializes callers that go through
// LockDirectory, and does not block plain reads. Locks are taken per open
// file, so goroutines in a single process exclude each other as well as
// separate processes do.
//
// A directory listed in DOKKU_LOCKED_DIRECTORIES is treated as already held by
// a parent process, and fn runs without taking the lock again. LockDirectory is
// not reentrant otherwise: fn must not call LockDirectory on the same
// directory, as that would block forever.
func LockDirectory(dir string, fn func() error) error {
dir = filepath.Clean(dir)
if isDirectoryLockHeld(dir) {
return fn()
}
return lockDirectory(dir, fn)
}
// isDirectoryLockHeld reports whether dir is listed in DOKKU_LOCKED_DIRECTORIES
func isDirectoryLockHeld(dir string) bool {
for _, held := range strings.Split(os.Getenv(LockedDirectoriesEnvVar), "\n") {
held = strings.TrimSpace(held)
if held == "" {
continue
}
if filepath.Clean(held) == dir {
return true
}
}
return false
}