mirror of
https://github.com/rclone/rclone.git
synced 2024-11-26 18:34:41 +01:00
8d847a4e94
Before this change CTRL-C could come in to exit rclone which would start the atexit actions running. The Fuse unmount then signals rclone to exit which wasn't waiting for the already running atexit actions to complete. This change makes sure that if the atexit actions are started they should be completed.
109 lines
2.4 KiB
Go
109 lines
2.4 KiB
Go
// Package atexit provides handling for functions you want called when
|
|
// the program exits unexpectedly due to a signal.
|
|
//
|
|
// You should also make sure you call Run in the normal exit path.
|
|
package atexit
|
|
|
|
import (
|
|
"os"
|
|
"os/signal"
|
|
"sync"
|
|
"sync/atomic"
|
|
|
|
"github.com/rclone/rclone/fs"
|
|
)
|
|
|
|
var (
|
|
fns = make(map[FnHandle]bool)
|
|
fnsMutex sync.Mutex
|
|
exitChan chan os.Signal
|
|
exitOnce sync.Once
|
|
registerOnce sync.Once
|
|
signalled int32
|
|
)
|
|
|
|
// FnHandle is the type of the handle returned by function `Register`
|
|
// that can be used to unregister an at-exit function
|
|
type FnHandle *func()
|
|
|
|
// Register a function to be called on exit.
|
|
// Returns a handle which can be used to unregister the function with `Unregister`.
|
|
func Register(fn func()) FnHandle {
|
|
fnsMutex.Lock()
|
|
fns[&fn] = true
|
|
fnsMutex.Unlock()
|
|
|
|
// Run AtExit handlers on exitSignals so everything gets tidied up properly
|
|
registerOnce.Do(func() {
|
|
exitChan = make(chan os.Signal, 1)
|
|
signal.Notify(exitChan, exitSignals...)
|
|
go func() {
|
|
sig := <-exitChan
|
|
if sig == nil {
|
|
return
|
|
}
|
|
atomic.StoreInt32(&signalled, 1)
|
|
fs.Infof(nil, "Signal received: %s", sig)
|
|
Run()
|
|
fs.Infof(nil, "Exiting...")
|
|
os.Exit(0)
|
|
}()
|
|
})
|
|
|
|
return &fn
|
|
}
|
|
|
|
// Signalled returns true if an exit signal has been received
|
|
func Signalled() bool {
|
|
return atomic.LoadInt32(&signalled) != 0
|
|
}
|
|
|
|
// Unregister a function using the handle returned by `Register`
|
|
func Unregister(handle FnHandle) {
|
|
fnsMutex.Lock()
|
|
defer fnsMutex.Unlock()
|
|
delete(fns, handle)
|
|
}
|
|
|
|
// IgnoreSignals disables the signal handler and prevents Run from being executed automatically
|
|
func IgnoreSignals() {
|
|
registerOnce.Do(func() {})
|
|
if exitChan != nil {
|
|
signal.Stop(exitChan)
|
|
close(exitChan)
|
|
exitChan = nil
|
|
}
|
|
}
|
|
|
|
// Run all the at exit functions if they haven't been run already
|
|
func Run() {
|
|
// Take the lock here so we wait until all have run before returning
|
|
fnsMutex.Lock()
|
|
defer fnsMutex.Unlock()
|
|
exitOnce.Do(func() {
|
|
for fnHandle := range fns {
|
|
(*fnHandle)()
|
|
}
|
|
})
|
|
}
|
|
|
|
// OnError registers fn with atexit and returns a function which
|
|
// runs fn() if *perr != nil and deregisters fn
|
|
//
|
|
// It should be used in a defer statement normally so
|
|
//
|
|
// defer OnError(&err, cancelFunc)()
|
|
//
|
|
// So cancelFunc will be run if the function exits with an error or
|
|
// at exit.
|
|
func OnError(perr *error, fn func()) func() {
|
|
handle := Register(fn)
|
|
return func() {
|
|
defer Unregister(handle)
|
|
if *perr != nil {
|
|
fn()
|
|
}
|
|
}
|
|
|
|
}
|