-
Notifications
You must be signed in to change notification settings - Fork 28
/
pprof.vdl.go
499 lines (442 loc) · 17 KB
/
pprof.vdl.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
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// This file was auto-generated by the vanadium vdl tool.
// Package: pprof
// Package pprof defines an interface for accessing runtime profiling data in
// the format expected by the pprof visualization tool. For more information
// about pprof, see http://code.google.com/p/google-perftools/.
package pprof
import (
"io"
"v.io/v23"
"v.io/v23/context"
"v.io/v23/rpc"
"v.io/v23/security/access"
"v.io/v23/vdl"
)
var _ = __VDLInit() // Must be first; see __VDLInit comments for details.
//////////////////////////////////////////////////
// Interface definitions
// PProfClientMethods is the client interface
// containing PProf methods.
type PProfClientMethods interface {
// CmdLine returns the command-line arguments of the server, including
// the name of the executable.
CmdLine(*context.T, ...rpc.CallOpt) ([]string, error)
// Profiles returns the list of available profiles.
Profiles(*context.T, ...rpc.CallOpt) ([]string, error)
// Profile streams the requested profile. The debug parameter enables
// additional output. Passing debug=0 includes only the hexadecimal
// addresses that pprof needs. Passing debug=1 adds comments translating
// addresses to function names and line numbers, so that a programmer
// can read the profile without tools.
Profile(_ *context.T, name string, debug int32, _ ...rpc.CallOpt) (PProfProfileClientCall, error)
// CpuProfile enables CPU profiling for the requested duration and
// streams the profile data.
CpuProfile(_ *context.T, seconds int32, _ ...rpc.CallOpt) (PProfCpuProfileClientCall, error)
// Symbol looks up the program counters and returns their respective
// function names.
Symbol(_ *context.T, programCounters []uint64, _ ...rpc.CallOpt) ([]string, error)
}
// PProfClientStub adds universal methods to PProfClientMethods.
type PProfClientStub interface {
PProfClientMethods
rpc.UniversalServiceMethods
}
// PProfClient returns a client stub for PProf.
func PProfClient(name string) PProfClientStub {
return implPProfClientStub{name}
}
type implPProfClientStub struct {
name string
}
func (c implPProfClientStub) CmdLine(ctx *context.T, opts ...rpc.CallOpt) (o0 []string, err error) {
err = v23.GetClient(ctx).Call(ctx, c.name, "CmdLine", nil, []interface{}{&o0}, opts...)
return
}
func (c implPProfClientStub) Profiles(ctx *context.T, opts ...rpc.CallOpt) (o0 []string, err error) {
err = v23.GetClient(ctx).Call(ctx, c.name, "Profiles", nil, []interface{}{&o0}, opts...)
return
}
func (c implPProfClientStub) Profile(ctx *context.T, i0 string, i1 int32, opts ...rpc.CallOpt) (ocall PProfProfileClientCall, err error) {
var call rpc.ClientCall
if call, err = v23.GetClient(ctx).StartCall(ctx, c.name, "Profile", []interface{}{i0, i1}, opts...); err != nil {
return
}
ocall = &implPProfProfileClientCall{ClientCall: call}
return
}
func (c implPProfClientStub) CpuProfile(ctx *context.T, i0 int32, opts ...rpc.CallOpt) (ocall PProfCpuProfileClientCall, err error) {
var call rpc.ClientCall
if call, err = v23.GetClient(ctx).StartCall(ctx, c.name, "CpuProfile", []interface{}{i0}, opts...); err != nil {
return
}
ocall = &implPProfCpuProfileClientCall{ClientCall: call}
return
}
func (c implPProfClientStub) Symbol(ctx *context.T, i0 []uint64, opts ...rpc.CallOpt) (o0 []string, err error) {
err = v23.GetClient(ctx).Call(ctx, c.name, "Symbol", []interface{}{i0}, []interface{}{&o0}, opts...)
return
}
// PProfProfileClientStream is the client stream for PProf.Profile.
type PProfProfileClientStream interface {
// RecvStream returns the receiver side of the PProf.Profile client stream.
RecvStream() interface {
// Advance stages an item so that it may be retrieved via Value. Returns
// true iff there is an item to retrieve. Advance must be called before
// Value is called. May block if an item is not available.
Advance() bool
// Value returns the item that was staged by Advance. May panic if Advance
// returned false or was not called. Never blocks.
Value() []byte
// Err returns any error encountered by Advance. Never blocks.
Err() error
}
}
// PProfProfileClientCall represents the call returned from PProf.Profile.
type PProfProfileClientCall interface {
PProfProfileClientStream
// Finish blocks until the server is done, and returns the positional return
// values for call.
//
// Finish returns immediately if the call has been canceled; depending on the
// timing the output could either be an error signaling cancelation, or the
// valid positional return values from the server.
//
// Calling Finish is mandatory for releasing stream resources, unless the call
// has been canceled or any of the other methods return an error. Finish should
// be called at most once.
Finish() error
}
type implPProfProfileClientCall struct {
rpc.ClientCall
valRecv []byte
errRecv error
}
func (c *implPProfProfileClientCall) RecvStream() interface {
Advance() bool
Value() []byte
Err() error
} {
return implPProfProfileClientCallRecv{c}
}
type implPProfProfileClientCallRecv struct {
c *implPProfProfileClientCall
}
func (c implPProfProfileClientCallRecv) Advance() bool {
c.c.errRecv = c.c.Recv(&c.c.valRecv)
return c.c.errRecv == nil
}
func (c implPProfProfileClientCallRecv) Value() []byte {
return c.c.valRecv
}
func (c implPProfProfileClientCallRecv) Err() error {
if c.c.errRecv == io.EOF {
return nil
}
return c.c.errRecv
}
func (c *implPProfProfileClientCall) Finish() (err error) {
err = c.ClientCall.Finish()
return
}
// PProfCpuProfileClientStream is the client stream for PProf.CpuProfile.
type PProfCpuProfileClientStream interface {
// RecvStream returns the receiver side of the PProf.CpuProfile client stream.
RecvStream() interface {
// Advance stages an item so that it may be retrieved via Value. Returns
// true iff there is an item to retrieve. Advance must be called before
// Value is called. May block if an item is not available.
Advance() bool
// Value returns the item that was staged by Advance. May panic if Advance
// returned false or was not called. Never blocks.
Value() []byte
// Err returns any error encountered by Advance. Never blocks.
Err() error
}
}
// PProfCpuProfileClientCall represents the call returned from PProf.CpuProfile.
type PProfCpuProfileClientCall interface {
PProfCpuProfileClientStream
// Finish blocks until the server is done, and returns the positional return
// values for call.
//
// Finish returns immediately if the call has been canceled; depending on the
// timing the output could either be an error signaling cancelation, or the
// valid positional return values from the server.
//
// Calling Finish is mandatory for releasing stream resources, unless the call
// has been canceled or any of the other methods return an error. Finish should
// be called at most once.
Finish() error
}
type implPProfCpuProfileClientCall struct {
rpc.ClientCall
valRecv []byte
errRecv error
}
func (c *implPProfCpuProfileClientCall) RecvStream() interface {
Advance() bool
Value() []byte
Err() error
} {
return implPProfCpuProfileClientCallRecv{c}
}
type implPProfCpuProfileClientCallRecv struct {
c *implPProfCpuProfileClientCall
}
func (c implPProfCpuProfileClientCallRecv) Advance() bool {
c.c.errRecv = c.c.Recv(&c.c.valRecv)
return c.c.errRecv == nil
}
func (c implPProfCpuProfileClientCallRecv) Value() []byte {
return c.c.valRecv
}
func (c implPProfCpuProfileClientCallRecv) Err() error {
if c.c.errRecv == io.EOF {
return nil
}
return c.c.errRecv
}
func (c *implPProfCpuProfileClientCall) Finish() (err error) {
err = c.ClientCall.Finish()
return
}
// PProfServerMethods is the interface a server writer
// implements for PProf.
type PProfServerMethods interface {
// CmdLine returns the command-line arguments of the server, including
// the name of the executable.
CmdLine(*context.T, rpc.ServerCall) ([]string, error)
// Profiles returns the list of available profiles.
Profiles(*context.T, rpc.ServerCall) ([]string, error)
// Profile streams the requested profile. The debug parameter enables
// additional output. Passing debug=0 includes only the hexadecimal
// addresses that pprof needs. Passing debug=1 adds comments translating
// addresses to function names and line numbers, so that a programmer
// can read the profile without tools.
Profile(_ *context.T, _ PProfProfileServerCall, name string, debug int32) error
// CpuProfile enables CPU profiling for the requested duration and
// streams the profile data.
CpuProfile(_ *context.T, _ PProfCpuProfileServerCall, seconds int32) error
// Symbol looks up the program counters and returns their respective
// function names.
Symbol(_ *context.T, _ rpc.ServerCall, programCounters []uint64) ([]string, error)
}
// PProfServerStubMethods is the server interface containing
// PProf methods, as expected by rpc.Server.
// The only difference between this interface and PProfServerMethods
// is the streaming methods.
type PProfServerStubMethods interface {
// CmdLine returns the command-line arguments of the server, including
// the name of the executable.
CmdLine(*context.T, rpc.ServerCall) ([]string, error)
// Profiles returns the list of available profiles.
Profiles(*context.T, rpc.ServerCall) ([]string, error)
// Profile streams the requested profile. The debug parameter enables
// additional output. Passing debug=0 includes only the hexadecimal
// addresses that pprof needs. Passing debug=1 adds comments translating
// addresses to function names and line numbers, so that a programmer
// can read the profile without tools.
Profile(_ *context.T, _ *PProfProfileServerCallStub, name string, debug int32) error
// CpuProfile enables CPU profiling for the requested duration and
// streams the profile data.
CpuProfile(_ *context.T, _ *PProfCpuProfileServerCallStub, seconds int32) error
// Symbol looks up the program counters and returns their respective
// function names.
Symbol(_ *context.T, _ rpc.ServerCall, programCounters []uint64) ([]string, error)
}
// PProfServerStub adds universal methods to PProfServerStubMethods.
type PProfServerStub interface {
PProfServerStubMethods
// Describe the PProf interfaces.
Describe__() []rpc.InterfaceDesc
}
// PProfServer returns a server stub for PProf.
// It converts an implementation of PProfServerMethods into
// an object that may be used by rpc.Server.
func PProfServer(impl PProfServerMethods) PProfServerStub {
stub := implPProfServerStub{
impl: impl,
}
// Initialize GlobState; always check the stub itself first, to handle the
// case where the user has the Glob method defined in their VDL source.
if gs := rpc.NewGlobState(stub); gs != nil {
stub.gs = gs
} else if gs := rpc.NewGlobState(impl); gs != nil {
stub.gs = gs
}
return stub
}
type implPProfServerStub struct {
impl PProfServerMethods
gs *rpc.GlobState
}
func (s implPProfServerStub) CmdLine(ctx *context.T, call rpc.ServerCall) ([]string, error) {
return s.impl.CmdLine(ctx, call)
}
func (s implPProfServerStub) Profiles(ctx *context.T, call rpc.ServerCall) ([]string, error) {
return s.impl.Profiles(ctx, call)
}
func (s implPProfServerStub) Profile(ctx *context.T, call *PProfProfileServerCallStub, i0 string, i1 int32) error {
return s.impl.Profile(ctx, call, i0, i1)
}
func (s implPProfServerStub) CpuProfile(ctx *context.T, call *PProfCpuProfileServerCallStub, i0 int32) error {
return s.impl.CpuProfile(ctx, call, i0)
}
func (s implPProfServerStub) Symbol(ctx *context.T, call rpc.ServerCall, i0 []uint64) ([]string, error) {
return s.impl.Symbol(ctx, call, i0)
}
func (s implPProfServerStub) Globber() *rpc.GlobState {
return s.gs
}
func (s implPProfServerStub) Describe__() []rpc.InterfaceDesc {
return []rpc.InterfaceDesc{PProfDesc}
}
// PProfDesc describes the PProf interface.
var PProfDesc rpc.InterfaceDesc = descPProf
// descPProf hides the desc to keep godoc clean.
var descPProf = rpc.InterfaceDesc{
Name: "PProf",
PkgPath: "v.io/v23/services/pprof",
Methods: []rpc.MethodDesc{
{
Name: "CmdLine",
Doc: "// CmdLine returns the command-line arguments of the server, including\n// the name of the executable.",
OutArgs: []rpc.ArgDesc{
{"", ``}, // []string
},
Tags: []*vdl.Value{vdl.ValueOf(access.Tag("Debug"))},
},
{
Name: "Profiles",
Doc: "// Profiles returns the list of available profiles.",
OutArgs: []rpc.ArgDesc{
{"", ``}, // []string
},
Tags: []*vdl.Value{vdl.ValueOf(access.Tag("Debug"))},
},
{
Name: "Profile",
Doc: "// Profile streams the requested profile. The debug parameter enables\n// additional output. Passing debug=0 includes only the hexadecimal\n// addresses that pprof needs. Passing debug=1 adds comments translating\n// addresses to function names and line numbers, so that a programmer\n// can read the profile without tools.",
InArgs: []rpc.ArgDesc{
{"name", ``}, // string
{"debug", ``}, // int32
},
Tags: []*vdl.Value{vdl.ValueOf(access.Tag("Debug"))},
},
{
Name: "CpuProfile",
Doc: "// CpuProfile enables CPU profiling for the requested duration and\n// streams the profile data.",
InArgs: []rpc.ArgDesc{
{"seconds", ``}, // int32
},
Tags: []*vdl.Value{vdl.ValueOf(access.Tag("Debug"))},
},
{
Name: "Symbol",
Doc: "// Symbol looks up the program counters and returns their respective\n// function names.",
InArgs: []rpc.ArgDesc{
{"programCounters", ``}, // []uint64
},
OutArgs: []rpc.ArgDesc{
{"", ``}, // []string
},
Tags: []*vdl.Value{vdl.ValueOf(access.Tag("Debug"))},
},
},
}
// PProfProfileServerStream is the server stream for PProf.Profile.
type PProfProfileServerStream interface {
// SendStream returns the send side of the PProf.Profile server stream.
SendStream() interface {
// Send places the item onto the output stream. Returns errors encountered
// while sending. Blocks if there is no buffer space; will unblock when
// buffer space is available.
Send(item []byte) error
}
}
// PProfProfileServerCall represents the context passed to PProf.Profile.
type PProfProfileServerCall interface {
rpc.ServerCall
PProfProfileServerStream
}
// PProfProfileServerCallStub is a wrapper that converts rpc.StreamServerCall into
// a typesafe stub that implements PProfProfileServerCall.
type PProfProfileServerCallStub struct {
rpc.StreamServerCall
}
// Init initializes PProfProfileServerCallStub from rpc.StreamServerCall.
func (s *PProfProfileServerCallStub) Init(call rpc.StreamServerCall) {
s.StreamServerCall = call
}
// SendStream returns the send side of the PProf.Profile server stream.
func (s *PProfProfileServerCallStub) SendStream() interface {
Send(item []byte) error
} {
return implPProfProfileServerCallSend{s}
}
type implPProfProfileServerCallSend struct {
s *PProfProfileServerCallStub
}
func (s implPProfProfileServerCallSend) Send(item []byte) error {
return s.s.Send(item)
}
// PProfCpuProfileServerStream is the server stream for PProf.CpuProfile.
type PProfCpuProfileServerStream interface {
// SendStream returns the send side of the PProf.CpuProfile server stream.
SendStream() interface {
// Send places the item onto the output stream. Returns errors encountered
// while sending. Blocks if there is no buffer space; will unblock when
// buffer space is available.
Send(item []byte) error
}
}
// PProfCpuProfileServerCall represents the context passed to PProf.CpuProfile.
type PProfCpuProfileServerCall interface {
rpc.ServerCall
PProfCpuProfileServerStream
}
// PProfCpuProfileServerCallStub is a wrapper that converts rpc.StreamServerCall into
// a typesafe stub that implements PProfCpuProfileServerCall.
type PProfCpuProfileServerCallStub struct {
rpc.StreamServerCall
}
// Init initializes PProfCpuProfileServerCallStub from rpc.StreamServerCall.
func (s *PProfCpuProfileServerCallStub) Init(call rpc.StreamServerCall) {
s.StreamServerCall = call
}
// SendStream returns the send side of the PProf.CpuProfile server stream.
func (s *PProfCpuProfileServerCallStub) SendStream() interface {
Send(item []byte) error
} {
return implPProfCpuProfileServerCallSend{s}
}
type implPProfCpuProfileServerCallSend struct {
s *PProfCpuProfileServerCallStub
}
func (s implPProfCpuProfileServerCallSend) Send(item []byte) error {
return s.s.Send(item)
}
var __VDLInitCalled bool
// __VDLInit performs vdl initialization. It is safe to call multiple times.
// If you have an init ordering issue, just insert the following line verbatim
// into your source files in this package, right after the "package foo" clause:
//
// var _ = __VDLInit()
//
// The purpose of this function is to ensure that vdl initialization occurs in
// the right order, and very early in the init sequence. In particular, vdl
// registration and package variable initialization needs to occur before
// functions like vdl.TypeOf will work properly.
//
// This function returns a dummy value, so that it can be used to initialize the
// first var in the file, to take advantage of Go's defined init order.
func __VDLInit() struct{} {
if __VDLInitCalled {
return struct{}{}
}
__VDLInitCalled = true
return struct{}{}
}