Merge pull request #4305 from MichaelEischer/stracktrace-for-windows

Print stacktrace in SIGINT handler if RESTIC_DEBUG_STACKTRACE_SIGINT set

CONTRIBUTING.md

@@ -58,6 +58,16 @@ Please be aware that the debug log file will contain potentially sensitive
 things like file and directory names, so please either redact it before
 uploading it somewhere or post only the parts that are really relevant.
 
+If restic gets stuck, please also include a stacktrace in the description.
+On non-Windows systems, you can send a SIGQUIT signal to restic or press
+`Ctrl-\` to achieve the same result. This causes restic to print a stacktrace
+and then exit immediatelly. This will not damage your repository, however,
+it might be necessary to manually clean up stale lock files using
+`restic unlock`.
+
+On Windows, please set the environment variable `RESTIC_DEBUG_STACKTRACE_SIGINT`
+to `true` and press `Ctrl-C` to create a stacktrace.
+
 
 Development Environment
 =======================

cmd/restic/cleanup.go

@@ -62,6 +62,12 @@ func CleanupHandler(c <-chan os.Signal) {
 		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 {

internal/debug/stacktrace.go

@@ -0,0 +1,15 @@
+package debug
+
+import "runtime"
+
+func DumpStacktrace() string {
+	buf := make([]byte, 128*1024)
+
+	for {
+		l := runtime.Stack(buf, true)
+		if l < len(buf) {
+			return string(buf[:l])
+		}
+		buf = make([]byte, len(buf)*2)
+	}
+}