forked from google/gvisor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
profile.go
179 lines (158 loc) · 4.98 KB
/
profile.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
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
// Copyright 2021 The gVisor Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package profile contains profiling utils.
package profile
import (
"os"
"runtime"
"runtime/pprof"
"runtime/trace"
"github.com/maxnasonov/gvisor/pkg/log"
"github.com/maxnasonov/gvisor/pkg/sentry/control"
"github.com/maxnasonov/gvisor/runsc/flag"
)
// Kind is the kind of profiling to perform.
type Kind int
const (
// Block profile.
Block Kind = iota
// CPU profile.
CPU
// Heap profile.
Heap
// Mutex profile.
Mutex
// Trace profile.
Trace
)
// FDArgs are the arguments that describe which profiles to enable and which
// FDs to write them to. Profiling of a given type will only be enabled if the
// corresponding FD is >=0.
type FDArgs struct {
// BlockFD is the file descriptor to write a block profile to.
// Valid if >=0.
BlockFD int
// CPUFD is the file descriptor to write a CPU profile to.
// Valid if >=0.
CPUFD int
// HeapFD is the file descriptor to write a heap profile to.
// Valid if >=0.
HeapFD int
// MutexFD is the file descriptor to write a mutex profile to.
// Valid if >=0.
MutexFD int
// TraceFD is the file descriptor to write a Go execution trace to.
// Valid if >=0.
TraceFD int
}
// SetFromFlags sets the FDArgs from the given flags. The default value for
// each FD is -1.
func (fds *FDArgs) SetFromFlags(f *flag.FlagSet) {
f.IntVar(&fds.BlockFD, "profile-block-fd", -1, "file descriptor to write block profile to. -1 disables profiling.")
f.IntVar(&fds.CPUFD, "profile-cpu-fd", -1, "file descriptor to write CPU profile to. -1 disables profiling.")
f.IntVar(&fds.HeapFD, "profile-heap-fd", -1, "file descriptor to write heap profile to. -1 disables profiling.")
f.IntVar(&fds.MutexFD, "profile-mutex-fd", -1, "file descriptor to write mutex profile to. -1 disables profiling.")
f.IntVar(&fds.TraceFD, "trace-fd", -1, "file descriptor to write Go execution trace to. -1 disables tracing.")
}
// Opts is a map of profile Kind to FD.
type Opts map[Kind]uintptr
// ToOpts turns FDArgs into an Opts struct which can be passed to Start.
func (fds *FDArgs) ToOpts() Opts {
o := Opts{}
if fds.BlockFD >= 0 {
o[Block] = uintptr(fds.BlockFD)
}
if fds.CPUFD >= 0 {
o[CPU] = uintptr(fds.CPUFD)
}
if fds.HeapFD >= 0 {
o[Heap] = uintptr(fds.HeapFD)
}
if fds.MutexFD >= 0 {
o[Mutex] = uintptr(fds.MutexFD)
}
if fds.TraceFD >= 0 {
o[Trace] = uintptr(fds.TraceFD)
}
return o
}
// Start starts profiling for the given Kinds in opts, and writes the profile
// data to the corresponding FDs in opts. It returns a function which will stop
// profiling.
func Start(opts Opts) func() {
var onStopProfiling []func()
stopProfiling := func() {
for _, f := range onStopProfiling {
f()
}
}
if fd, ok := opts[Block]; ok {
log.Infof("Block profiling enabled")
file := os.NewFile(fd, "profile-block")
runtime.SetBlockProfileRate(control.DefaultBlockProfileRate)
onStopProfiling = append(onStopProfiling, func() {
if err := pprof.Lookup("block").WriteTo(file, 0); err != nil {
log.Warningf("Error writing block profile: %v", err)
}
file.Close()
runtime.SetBlockProfileRate(0)
log.Infof("Block profiling stopped")
})
}
if fd, ok := opts[CPU]; ok {
log.Infof("CPU profiling enabled")
file := os.NewFile(fd, "profile-cpu")
pprof.StartCPUProfile(file)
onStopProfiling = append(onStopProfiling, func() {
pprof.StopCPUProfile()
file.Close()
log.Infof("CPU profiling stopped")
})
}
if fd, ok := opts[Heap]; ok {
log.Infof("Heap profiling enabled")
file := os.NewFile(fd, "profile-heap")
onStopProfiling = append(onStopProfiling, func() {
if err := pprof.Lookup("heap").WriteTo(file, 0); err != nil {
log.Warningf("Error writing heap profile: %v", err)
}
file.Close()
log.Infof("Heap profiling stopped")
})
}
if fd, ok := opts[Mutex]; ok {
log.Infof("Mutex profiling enabled")
file := os.NewFile(fd, "profile-mutex")
prev := runtime.SetMutexProfileFraction(control.DefaultMutexProfileRate)
onStopProfiling = append(onStopProfiling, func() {
if err := pprof.Lookup("mutex").WriteTo(file, 0); err != nil {
log.Warningf("Error writing mutex profile: %v", err)
}
file.Close()
runtime.SetMutexProfileFraction(prev)
log.Infof("Mutex profiling stopped")
})
}
if fd, ok := opts[Trace]; ok {
log.Infof("Tracing enabled")
file := os.NewFile(fd, "trace")
trace.Start(file)
onStopProfiling = append(onStopProfiling, func() {
trace.Stop()
file.Close()
log.Infof("Tracing stopped")
})
}
return stopProfiling
}