mirror of
https://gitee.com/johng/gf.git
synced 2024-12-02 20:28:17 +08:00
118 lines
3.1 KiB
Go
118 lines
3.1 KiB
Go
// Copyright 2019 gf Author(https://github.com/gogf/gf). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
|
|
// Package debug contains facilities for programs to debug themselves while
|
|
// they are running.
|
|
package debug
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"runtime"
|
|
"strings"
|
|
)
|
|
|
|
const (
|
|
gMAX_DEPTH = 1000
|
|
gFILTER_KEY = "/g/internal/debug/stack.go"
|
|
)
|
|
|
|
var (
|
|
// goRootForFilter is used for stack filtering purpose.
|
|
goRootForFilter = runtime.GOROOT()
|
|
)
|
|
|
|
func init() {
|
|
if goRootForFilter != "" {
|
|
goRootForFilter = strings.Replace(goRootForFilter, "\\", "/", -1)
|
|
}
|
|
}
|
|
|
|
// PrintStack prints to standard error the stack trace returned by runtime.Stack.
|
|
func PrintStack(skip ...int) {
|
|
fmt.Print(Stack(skip...))
|
|
}
|
|
|
|
// Stack returns a formatted stack trace of the goroutine that calls it.
|
|
// It calls runtime.Stack with a large enough buffer to capture the entire trace.
|
|
func Stack(skip ...int) string {
|
|
return StackWithFilter("", skip...)
|
|
}
|
|
|
|
// StackWithFilter returns a formatted stack trace of the goroutine that calls it.
|
|
// It calls runtime.Stack with a large enough buffer to capture the entire trace.
|
|
//
|
|
// The parameter <filter> is used to filter the path of the caller.
|
|
func StackWithFilter(filter string, skip ...int) string {
|
|
number := 0
|
|
if len(skip) > 0 {
|
|
number = skip[0]
|
|
}
|
|
name := ""
|
|
index := 1
|
|
buffer := bytes.NewBuffer(nil)
|
|
for i := callerFromIndex() + number; i < gMAX_DEPTH; i++ {
|
|
if pc, file, line, ok := runtime.Caller(i); ok {
|
|
if filter != "" && strings.Contains(file, filter) {
|
|
continue
|
|
}
|
|
if goRootForFilter != "" && len(file) >= len(goRootForFilter) && file[0:len(goRootForFilter)] == goRootForFilter {
|
|
continue
|
|
}
|
|
if fn := runtime.FuncForPC(pc); fn == nil {
|
|
name = "unknown"
|
|
} else {
|
|
name = fn.Name()
|
|
}
|
|
buffer.WriteString(fmt.Sprintf("%d.\t%s\n\t%s:%d\n", index, name, file, line))
|
|
index++
|
|
} else {
|
|
break
|
|
}
|
|
}
|
|
return buffer.String()
|
|
}
|
|
|
|
// CallerPath returns the absolute file path along with its line number of the caller.
|
|
func Caller(skip ...int) string {
|
|
return CallerWithFilter("", skip...)
|
|
}
|
|
|
|
// CallerPathWithFilter returns the absolute file path along with its line number of the caller.
|
|
//
|
|
// The parameter <filter> is used to filter the path of the caller.
|
|
func CallerWithFilter(filter string, skip ...int) string {
|
|
number := 0
|
|
if len(skip) > 0 {
|
|
number = skip[0]
|
|
}
|
|
for i := callerFromIndex() + number; i < gMAX_DEPTH; i++ {
|
|
if _, file, line, ok := runtime.Caller(i); ok {
|
|
if filter != "" && strings.Contains(file, filter) {
|
|
continue
|
|
}
|
|
return fmt.Sprintf(`%s:%d`, file, line)
|
|
} else {
|
|
break
|
|
}
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// callerFromIndex returns the caller position exclusive of the debug package.
|
|
func callerFromIndex() int {
|
|
for i := 0; i < gMAX_DEPTH; i++ {
|
|
if _, file, _, ok := runtime.Caller(i); ok {
|
|
if strings.Contains(file, gFILTER_KEY) {
|
|
continue
|
|
}
|
|
// exclude the depth from the function of current package.
|
|
return i - 1
|
|
}
|
|
}
|
|
return 0
|
|
}
|