Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4753 from MichaelEischer/remove-cleanup-handlers
Replace cleanup handlers with context based command cancelation
- Loading branch information
Showing
44 changed files
with
350 additions
and
299 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,41 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "os" | ||
| "os/signal" | ||
| "sync" | ||
| "syscall" | ||
|
|
||
| "github.com/restic/restic/internal/debug" | ||
| ) | ||
|
|
||
| var cleanupHandlers struct { | ||
| sync.Mutex | ||
| list []func(code int) (int, error) | ||
| done bool | ||
| ch chan os.Signal | ||
| } | ||
|
|
||
| func init() { | ||
| cleanupHandlers.ch = make(chan os.Signal, 1) | ||
| go CleanupHandler(cleanupHandlers.ch) | ||
| signal.Notify(cleanupHandlers.ch, syscall.SIGINT, syscall.SIGTERM) | ||
| } | ||
| func createGlobalContext() context.Context { | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
|
|
||
| // AddCleanupHandler adds the function f to the list of cleanup handlers so | ||
| // that it is executed when all the cleanup handlers are run, e.g. when SIGINT | ||
| // is received. | ||
| func AddCleanupHandler(f func(code int) (int, error)) { | ||
| cleanupHandlers.Lock() | ||
| defer cleanupHandlers.Unlock() | ||
| ch := make(chan os.Signal, 1) | ||
| go cleanupHandler(ch, cancel) | ||
| signal.Notify(ch, syscall.SIGINT, syscall.SIGTERM) | ||
|
|
||
| // reset the done flag for integration tests | ||
| cleanupHandlers.done = false | ||
|
|
||
| cleanupHandlers.list = append(cleanupHandlers.list, f) | ||
| return ctx | ||
| } | ||
|
|
||
| // RunCleanupHandlers runs all registered cleanup handlers | ||
| func RunCleanupHandlers(code int) int { | ||
| cleanupHandlers.Lock() | ||
| defer cleanupHandlers.Unlock() | ||
|
|
||
| if cleanupHandlers.done { | ||
| return code | ||
| } | ||
| cleanupHandlers.done = true | ||
| // cleanupHandler handles the SIGINT and SIGTERM signals. | ||
| func cleanupHandler(c <-chan os.Signal, cancel context.CancelFunc) { | ||
| s := <-c | ||
| debug.Log("signal %v received, cleaning up", s) | ||
| Warnf("%ssignal %v received, cleaning up\n", clearLine(0), s) | ||
|
|
||
| for _, f := range cleanupHandlers.list { | ||
| var err error | ||
| code, err = f(code) | ||
| if err != nil { | ||
| Warnf("error in cleanup handler: %v\n", err) | ||
| } | ||
| if val, _ := os.LookupEnv("RESTIC_DEBUG_STACKTRACE_SIGINT"); val != "" { | ||
| _, _ = os.Stderr.WriteString("\n--- STACKTRACE START ---\n\n") | ||
| _, _ = os.Stderr.WriteString(debug.DumpStacktrace()) | ||
| _, _ = os.Stderr.WriteString("\n--- STACKTRACE END ---\n") | ||
| } | ||
| cleanupHandlers.list = nil | ||
| return code | ||
| } | ||
|
|
||
| // CleanupHandler handles the SIGINT and SIGTERM signals. | ||
| func CleanupHandler(c <-chan os.Signal) { | ||
| for s := range c { | ||
| debug.Log("signal %v received, cleaning up", s) | ||
| Warnf("%ssignal %v received, cleaning up\n", clearLine(0), s) | ||
|
|
||
| if val, _ := os.LookupEnv("RESTIC_DEBUG_STACKTRACE_SIGINT"); val != "" { | ||
| _, _ = os.Stderr.WriteString("\n--- STACKTRACE START ---\n\n") | ||
| _, _ = os.Stderr.WriteString(debug.DumpStacktrace()) | ||
| _, _ = os.Stderr.WriteString("\n--- STACKTRACE END ---\n") | ||
| } | ||
|
|
||
| code := 0 | ||
|
|
||
| if s == syscall.SIGINT || s == syscall.SIGTERM { | ||
| code = 130 | ||
| } else { | ||
| code = 1 | ||
| } | ||
|
|
||
| Exit(code) | ||
| } | ||
| cancel() | ||
| } | ||
|
|
||
| // Exit runs the cleanup handlers and then terminates the process with the | ||
| // given exit code. | ||
| // Exit terminates the process with the given exit code. | ||
| func Exit(code int) { | ||
| code = RunCleanupHandlers(code) | ||
| debug.Log("exiting with status code %d", code) | ||
| os.Exit(code) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.