Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
bsc/internal/debug/api.go at master · https-github-com-Carlena-cole/bsc · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
See all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
https-github-com-Carlena-cole
bsc
Repository navigation
Code
Pull requests
Actions
Projects
Security and quality
Insights
More
items
Files
Expand file tree
master
Breadcrumbs
bsc
/
internal
/
debug
/
api.go
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
266 lines (237 loc) · 7.93 KB
master
Breadcrumbs
bsc
/
internal
/
debug
/
api.go
Copy path
Top
File metadata and controls
Code
Blame
266 lines (237 loc) · 7.93 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
// Package debug interfaces Go runtime debugging facilities.
// This package is mostly glue code making these facilities available
// through the CLI and RPC subsystem. If you want to use them from Go code,
// use package runtime instead.
package
debug
import
(
"bytes"
"errors"
"io"
"os"
"os/user"
"path/filepath"
"regexp"
"runtime"
"runtime/debug"
"runtime/pprof"
"strings"
"sync"
"time"
"github.com/ethereum/go-ethereum/log"
"github.com/hashicorp/go-bexpr"
)
// Handler is the global debugging handler.
var
Handler
=
new
(
HandlerT
)
// HandlerT implements the debugging API.
// Do not create values of this type, use the one
// in the Handler variable instead.
type
HandlerT
struct
{
mu
sync.
Mutex
cpuW
io.
WriteCloser
cpuFile
string
traceW
io.
WriteCloser
traceFile
string
}
// Verbosity sets the log verbosity ceiling. The verbosity of individual packages
// and source files can be raised using Vmodule.
func
(
*
HandlerT
)
Verbosity
(
level
int
) {
glogger
.
Verbosity
(
log
.
FromLegacyLevel
(
level
))
}
// Vmodule sets the log verbosity pattern. See package log for details on the
// pattern syntax.
func
(
*
HandlerT
)
Vmodule
(
pattern
string
)
error
{
return
glogger
.
Vmodule
(
pattern
)
}
// MemStats returns detailed runtime memory statistics.
func
(
*
HandlerT
)
MemStats
()
*
runtime.
MemStats
{
s
:=
new
(runtime.
MemStats
)
runtime
.
ReadMemStats
(
s
)
return
s
}
// GcStats returns GC statistics.
func
(
*
HandlerT
)
GcStats
()
*
debug.
GCStats
{
s
:=
new
(debug.
GCStats
)
debug
.
ReadGCStats
(
s
)
return
s
}
// CpuProfile turns on CPU profiling for nsec seconds and writes
// profile data to file.
func
(
h
*
HandlerT
)
CpuProfile
(
file
string
,
nsec
uint
)
error
{
if
err
:=
h
.
StartCPUProfile
(
file
);
err
!=
nil
{
return
err
}
time
.
Sleep
(
time
.
Duration
(
nsec
)
*
time
.
Second
)
h
.
StopCPUProfile
()
return
nil
}
// StartCPUProfile turns on CPU profiling, writing to the given file.
func
(
h
*
HandlerT
)
StartCPUProfile
(
file
string
)
error
{
h
.
mu
.
Lock
()
defer
h
.
mu
.
Unlock
()
if
h
.
cpuW
!=
nil
{
return
errors
.
New
(
"CPU profiling already in progress"
)
}
f
,
err
:=
os
.
Create
(
expandHome
(
file
))
if
err
!=
nil
{
return
err
}
if
err
:=
pprof
.
StartCPUProfile
(
f
);
err
!=
nil
{
f
.
Close
()
return
err
}
h
.
cpuW
=
f
h
.
cpuFile
=
file
log
.
Info
(
"CPU profiling started"
,
"dump"
,
h
.
cpuFile
)
return
nil
}
// StopCPUProfile stops an ongoing CPU profile.
func
(
h
*
HandlerT
)
StopCPUProfile
()
error
{
h
.
mu
.
Lock
()
defer
h
.
mu
.
Unlock
()
pprof
.
StopCPUProfile
()
if
h
.
cpuW
==
nil
{
return
errors
.
New
(
"CPU profiling not in progress"
)
}
log
.
Info
(
"Done writing CPU profile"
,
"dump"
,
h
.
cpuFile
)
h
.
cpuW
.
Close
()
h
.
cpuW
=
nil
h
.
cpuFile
=
""
return
nil
}
// GoTrace turns on tracing for nsec seconds and writes
// trace data to file.
func
(
h
*
HandlerT
)
GoTrace
(
file
string
,
nsec
uint
)
error
{
if
err
:=
h
.
StartGoTrace
(
file
);
err
!=
nil
{
return
err
}
time
.
Sleep
(
time
.
Duration
(
nsec
)
*
time
.
Second
)
h
.
StopGoTrace
()
return
nil
}
// BlockProfile turns on goroutine profiling for nsec seconds and writes profile data to
// file. It uses a profile rate of 1 for most accurate information. If a different rate is
// desired, set the rate and write the profile manually.
func
(
*
HandlerT
)
BlockProfile
(
file
string
,
nsec
uint
)
error
{
runtime
.
SetBlockProfileRate
(
1
)
time
.
Sleep
(
time
.
Duration
(
nsec
)
*
time
.
Second
)
defer
runtime
.
SetBlockProfileRate
(
0
)
return
writeProfile
(
"block"
,
file
)
}
// SetBlockProfileRate sets the rate of goroutine block profile data collection.
// rate 0 disables block profiling.
func
(
*
HandlerT
)
SetBlockProfileRate
(
rate
int
) {
runtime
.
SetBlockProfileRate
(
rate
)
}
// WriteBlockProfile writes a goroutine blocking profile to the given file.
func
(
*
HandlerT
)
WriteBlockProfile
(
file
string
)
error
{
return
writeProfile
(
"block"
,
file
)
}
// MutexProfile turns on mutex profiling for nsec seconds and writes profile data to file.
// It uses a profile rate of 1 for most accurate information. If a different rate is
// desired, set the rate and write the profile manually.
func
(
*
HandlerT
)
MutexProfile
(
file
string
,
nsec
uint
)
error
{
runtime
.
SetMutexProfileFraction
(
1
)
time
.
Sleep
(
time
.
Duration
(
nsec
)
*
time
.
Second
)
defer
runtime
.
SetMutexProfileFraction
(
0
)
return
writeProfile
(
"mutex"
,
file
)
}
// SetMutexProfileFraction sets the rate of mutex profiling.
func
(
*
HandlerT
)
SetMutexProfileFraction
(
rate
int
) {
runtime
.
SetMutexProfileFraction
(
rate
)
}
// WriteMutexProfile writes a goroutine blocking profile to the given file.
func
(
*
HandlerT
)
WriteMutexProfile
(
file
string
)
error
{
return
writeProfile
(
"mutex"
,
file
)
}
// WriteMemProfile writes an allocation profile to the given file.
// Note that the profiling rate cannot be set through the API,
// it must be set on the command line.
func
(
*
HandlerT
)
WriteMemProfile
(
file
string
)
error
{
return
writeProfile
(
"heap"
,
file
)
}
// Stacks returns a printed representation of the stacks of all goroutines. It
// also permits the following optional filters to be used:
// - filter: boolean expression of packages to filter for
func
(
*
HandlerT
)
Stacks
(
filter
*
string
)
string
{
buf
:=
new
(bytes.
Buffer
)
pprof
.
Lookup
(
"goroutine"
).
WriteTo
(
buf
,
2
)
// If any filtering was requested, execute them now
if
filter
!=
nil
&&
len
(
*
filter
)
>
0
{
expanded
:=
*
filter
// The input filter is a logical expression of package names. Transform
// it into a proper boolean expression that can be fed into a parser and
// interpreter:
//
// E.g. (eth || snap) && !p2p -> (eth in Value || snap in Value) && p2p not in Value
expanded
=
regexp
.
MustCompile
(
`[:/\.A-Za-z0-9_-]+`
).
ReplaceAllString
(
expanded
,
"`$0` in Value"
)
expanded
=
regexp
.
MustCompile
(
"!(`[:/
\\
.A-Za-z0-9_-]+`)"
).
ReplaceAllString
(
expanded
,
"$1 not"
)
expanded
=
strings
.
ReplaceAll
(
expanded
,
"||"
,
"or"
)
expanded
=
strings
.
ReplaceAll
(
expanded
,
"&&"
,
"and"
)
log
.
Info
(
"Expanded filter expression"
,
"filter"
,
*
filter
,
"expanded"
,
expanded
)
expr
,
err
:=
bexpr
.
CreateEvaluator
(
expanded
)
if
err
!=
nil
{
log
.
Error
(
"Failed to parse filter expression"
,
"expanded"
,
expanded
,
"err"
,
err
)
return
""
}
// Split the goroutine dump into segments and filter each
dump
:=
buf
.
String
()
buf
.
Reset
()
for
_
,
trace
:=
range
strings
.
Split
(
dump
,
"
\n
\n
"
) {
if
ok
,
_
:=
expr
.
Evaluate
(
map
[
string
]
string
{
"Value"
:
trace
});
ok
{
buf
.
WriteString
(
trace
)
buf
.
WriteString
(
"
\n
\n
"
)
}
}
}
return
buf
.
String
()
}
// FreeOSMemory forces a garbage collection.
func
(
*
HandlerT
)
FreeOSMemory
() {
debug
.
FreeOSMemory
()
}
// SetGCPercent sets the garbage collection target percentage. It returns the previous
// setting. A negative value disables GC.
func
(
*
HandlerT
)
SetGCPercent
(
v
int
)
int
{
return
debug
.
SetGCPercent
(
v
)
}
func
writeProfile
(
name
,
file
string
)
error
{
p
:=
pprof
.
Lookup
(
name
)
log
.
Info
(
"Writing profile records"
,
"count"
,
p
.
Count
(),
"type"
,
name
,
"dump"
,
file
)
f
,
err
:=
os
.
Create
(
expandHome
(
file
))
if
err
!=
nil
{
return
err
}
defer
f
.
Close
()
return
p
.
WriteTo
(
f
,
0
)
}
// expands home directory in file paths.
// ~someuser/tmp will not be expanded.
func
expandHome
(
p
string
)
string
{
if
strings
.
HasPrefix
(
p
,
"~/"
)
||
strings
.
HasPrefix
(
p
,
"~
\\
"
) {
home
:=
os
.
Getenv
(
"HOME"
)
if
home
==
""
{
if
usr
,
err
:=
user
.
Current
();
err
==
nil
{
home
=
usr
.
HomeDir
}
}
if
home
!=
""
{
p
=
home
+
p
[
1
:]
}
}
return
filepath
.
Clean
(
p
)
}
You can’t perform that action at this time.