mirror of
https://github.com/restic/restic.git
synced 2024-08-22 04:13:23 +02:00
209 lines
3.7 KiB
Go
209 lines
3.7 KiB
Go
package debug
|
|
|
|
import (
|
|
"fmt"
|
|
"log"
|
|
"os"
|
|
"path"
|
|
"path/filepath"
|
|
"runtime"
|
|
"strings"
|
|
|
|
"github.com/restic/restic/internal/fs"
|
|
)
|
|
|
|
var opts struct {
|
|
isEnabled bool
|
|
logger *log.Logger
|
|
funcs map[string]bool
|
|
files map[string]bool
|
|
}
|
|
|
|
// make sure that all the initialization happens before the init() functions
|
|
// are called, cf https://golang.org/ref/spec#Package_initialization
|
|
var _ = initDebug()
|
|
|
|
func initDebug() bool {
|
|
initDebugLogger()
|
|
initDebugTags()
|
|
|
|
if opts.logger == nil && len(opts.funcs) == 0 && len(opts.files) == 0 {
|
|
opts.isEnabled = false
|
|
return false
|
|
}
|
|
|
|
opts.isEnabled = true
|
|
fmt.Fprintf(os.Stderr, "debug enabled\n")
|
|
|
|
return true
|
|
}
|
|
|
|
func initDebugLogger() {
|
|
debugfile := os.Getenv("DEBUG_LOG")
|
|
if debugfile == "" {
|
|
return
|
|
}
|
|
|
|
fmt.Fprintf(os.Stderr, "debug log file %v\n", debugfile)
|
|
|
|
f, err := fs.OpenFile(debugfile, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "unable to open debug log file: %v\n", err)
|
|
os.Exit(2)
|
|
}
|
|
|
|
opts.logger = log.New(f, "", log.LstdFlags)
|
|
}
|
|
|
|
func parseFilter(envname string, pad func(string) string) map[string]bool {
|
|
filter := make(map[string]bool)
|
|
|
|
env := os.Getenv(envname)
|
|
if env == "" {
|
|
return filter
|
|
}
|
|
|
|
for _, fn := range strings.Split(env, ",") {
|
|
t := pad(strings.TrimSpace(fn))
|
|
val := true
|
|
if t[0] == '-' {
|
|
val = false
|
|
t = t[1:]
|
|
} else if t[0] == '+' {
|
|
val = true
|
|
t = t[1:]
|
|
}
|
|
|
|
// test pattern
|
|
_, err := path.Match(t, "")
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "error: invalid pattern %q: %v\n", t, err)
|
|
os.Exit(5)
|
|
}
|
|
|
|
filter[t] = val
|
|
}
|
|
|
|
return filter
|
|
}
|
|
|
|
func padFunc(s string) string {
|
|
if s == "all" {
|
|
return s
|
|
}
|
|
|
|
return s
|
|
}
|
|
|
|
func padFile(s string) string {
|
|
if s == "all" {
|
|
return s
|
|
}
|
|
|
|
if !strings.Contains(s, "/") {
|
|
s = "*/" + s
|
|
}
|
|
|
|
if !strings.Contains(s, ":") {
|
|
s = s + ":*"
|
|
}
|
|
|
|
return s
|
|
}
|
|
|
|
func initDebugTags() {
|
|
opts.funcs = parseFilter("DEBUG_FUNCS", padFunc)
|
|
opts.files = parseFilter("DEBUG_FILES", padFile)
|
|
}
|
|
|
|
// taken from https://github.com/VividCortex/trace
|
|
func goroutineNum() int {
|
|
b := make([]byte, 20)
|
|
runtime.Stack(b, false)
|
|
var num int
|
|
|
|
fmt.Sscanf(string(b), "goroutine %d ", &num)
|
|
return num
|
|
}
|
|
|
|
// taken from https://github.com/VividCortex/trace
|
|
func getPosition() (fn, dir, file string, line int) {
|
|
pc, file, line, ok := runtime.Caller(2)
|
|
if !ok {
|
|
return "", "", "", 0
|
|
}
|
|
|
|
dirname, filename := filepath.Base(filepath.Dir(file)), filepath.Base(file)
|
|
|
|
Func := runtime.FuncForPC(pc)
|
|
|
|
return path.Base(Func.Name()), dirname, filename, line
|
|
}
|
|
|
|
func checkFilter(filter map[string]bool, key string) bool {
|
|
// check if key is enabled directly
|
|
if v, ok := filter[key]; ok {
|
|
return v
|
|
}
|
|
|
|
// check for globbing
|
|
for k, v := range filter {
|
|
if m, _ := path.Match(k, key); m {
|
|
return v
|
|
}
|
|
}
|
|
|
|
// check if tag "all" is enabled
|
|
if v, ok := filter["all"]; ok && v {
|
|
return true
|
|
}
|
|
|
|
return false
|
|
}
|
|
|
|
// Log prints a message to the debug log (if debug is enabled).
|
|
func Log(f string, args ...interface{}) {
|
|
if !opts.isEnabled {
|
|
return
|
|
}
|
|
|
|
fn, dir, file, line := getPosition()
|
|
goroutine := goroutineNum()
|
|
|
|
if len(f) == 0 || f[len(f)-1] != '\n' {
|
|
f += "\n"
|
|
}
|
|
|
|
type Shortener interface {
|
|
Str() string
|
|
}
|
|
|
|
for i, item := range args {
|
|
if shortener, ok := item.(Shortener); ok {
|
|
args[i] = shortener.Str()
|
|
}
|
|
}
|
|
|
|
pos := fmt.Sprintf("%s/%s:%d", dir, file, line)
|
|
|
|
formatString := fmt.Sprintf("%s\t%s\t%d\t%s", pos, fn, goroutine, f)
|
|
|
|
dbgprint := func() {
|
|
fmt.Fprintf(os.Stderr, formatString, args...)
|
|
}
|
|
|
|
if opts.logger != nil {
|
|
opts.logger.Printf(formatString, args...)
|
|
}
|
|
|
|
filename := fmt.Sprintf("%s/%s:%d", dir, file, line)
|
|
if checkFilter(opts.files, filename) {
|
|
dbgprint()
|
|
return
|
|
}
|
|
|
|
if checkFilter(opts.funcs, fn) {
|
|
dbgprint()
|
|
}
|
|
}
|