/
errors.go
110 lines (99 loc) · 3.14 KB
/
errors.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
* Copyright (c) 2019, Psiphon Inc.
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
/*
Package errors provides error wrapping helpers that add inline, single frame
stack trace information to error messages.
*/
package errors
import (
"fmt"
"runtime"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/stacktrace"
)
// TraceNew returns a new error with the given message, wrapped with the caller
// stack frame information.
func TraceNew(message string) error {
err := fmt.Errorf("%s", message)
pc, _, line, ok := runtime.Caller(1)
if !ok {
return fmt.Errorf("[unknown]: %w", err)
}
return fmt.Errorf("%s#%d: %w", stacktrace.GetFunctionName(pc), line, err)
}
// BackTraceNew returns a new error with the given message, wrapped with the
// caller stack frame information going back up the stack until the caller of
// the specified function name is encountered.
func BackTraceNew(backTraceFuncName, message string) error {
err := fmt.Errorf("%s", message)
return fmt.Errorf("%s%w", backTrace(backTraceFuncName), err)
}
// Tracef returns a new error with the given formatted message, wrapped with
// the caller stack frame information.
func Tracef(format string, args ...interface{}) error {
err := fmt.Errorf(format, args...)
pc, _, line, ok := runtime.Caller(1)
if !ok {
return fmt.Errorf("[unknown]: %w", err)
}
return fmt.Errorf("%s#%d: %w", stacktrace.GetFunctionName(pc), line, err)
}
// Trace wraps the given error with the caller stack frame information.
func Trace(err error) error {
if err == nil {
return nil
}
pc, _, line, ok := runtime.Caller(1)
if !ok {
return fmt.Errorf("[unknown]: %w", err)
}
return fmt.Errorf("%s#%d: %w", stacktrace.GetFunctionName(pc), line, err)
}
// TraceMsg wraps the given error with the caller stack frame information
// and the given message.
func TraceMsg(err error, message string) error {
if err == nil {
return nil
}
pc, _, line, ok := runtime.Caller(1)
if !ok {
return fmt.Errorf("[unknown]: %s: %w", message, err)
}
return fmt.Errorf("%s#%d: %s: %w", stacktrace.GetFunctionName(pc), line, message, err)
}
func backTrace(backTraceFuncName string) string {
stop := false
trace := ""
// Skip starts at 2, assuming backTrace is called as a helper function.
for n := 2; ; n++ {
pc, _, line, ok := runtime.Caller(n)
if !ok {
break
}
funcName := stacktrace.GetFunctionName(pc)
trace = fmt.Sprintf("%s#%d: ", funcName, line) + trace
if stop {
break
}
if funcName == backTraceFuncName {
// Stop after the _next_ function
stop = true
}
}
return trace
}