aboutsummaryrefslogtreecommitdiffstats
path: root/rpc/api/debug.go
blob: 5975f88ab14c62cff36399ff6d090a5f8404391a (plain) (blame)
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
package api

import (
    "fmt"
    "strings"
    "time"

    "github.com/ethereum/ethash"
    "github.com/ethereum/go-ethereum/core/state"
    "github.com/ethereum/go-ethereum/core/vm"
    "github.com/ethereum/go-ethereum/eth"
    "github.com/ethereum/go-ethereum/rlp"
    "github.com/ethereum/go-ethereum/rpc/codec"
    "github.com/ethereum/go-ethereum/rpc/shared"
    "github.com/ethereum/go-ethereum/xeth"
    "github.com/rcrowley/go-metrics"
)

const (
    DebugApiVersion = "1.0"
)

var (
    // mapping between methods and handlers
    DebugMapping = map[string]debughandler{
        "debug_dumpBlock":    (*debugApi).DumpBlock,
        "debug_getBlockRlp":  (*debugApi).GetBlockRlp,
        "debug_printBlock":   (*debugApi).PrintBlock,
        "debug_processBlock": (*debugApi).ProcessBlock,
        "debug_seedHash":     (*debugApi).SeedHash,
        "debug_setHead":      (*debugApi).SetHead,
        "debug_metrics":      (*debugApi).Metrics,
    }
)

// debug callback handler
type debughandler func(*debugApi, *shared.Request) (interface{}, error)

// admin api provider
type debugApi struct {
    xeth     *xeth.XEth
    ethereum *eth.Ethereum
    methods  map[string]debughandler
    codec    codec.ApiCoder
}

// create a new debug api instance
func NewDebugApi(xeth *xeth.XEth, ethereum *eth.Ethereum, coder codec.Codec) *debugApi {
    return &debugApi{
        xeth:     xeth,
        ethereum: ethereum,
        methods:  DebugMapping,
        codec:    coder.New(nil),
    }
}

// collection with supported methods
func (self *debugApi) Methods() []string {
    methods := make([]string, len(self.methods))
    i := 0
    for k := range self.methods {
        methods[i] = k
        i++
    }
    return methods
}

// Execute given request
func (self *debugApi) Execute(req *shared.Request) (interface{}, error) {
    if callback, ok := self.methods[req.Method]; ok {
        return callback(self, req)
    }

    return nil, &shared.NotImplementedError{req.Method}
}

func (self *debugApi) Name() string {
    return shared.DebugApiName
}

func (self *debugApi) ApiVersion() string {
    return DebugApiVersion
}

func (self *debugApi) PrintBlock(req *shared.Request) (interface{}, error) {
    args := new(BlockNumArg)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }

    block := self.xeth.EthBlockByNumber(args.BlockNumber)
    return fmt.Sprintf("%s", block), nil
}

func (self *debugApi) DumpBlock(req *shared.Request) (interface{}, error) {
    args := new(BlockNumArg)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }

    block := self.xeth.EthBlockByNumber(args.BlockNumber)
    if block == nil {
        return nil, fmt.Errorf("block #%d not found", args.BlockNumber)
    }

    stateDb := state.New(block.Root(), self.ethereum.StateDb())
    if stateDb == nil {
        return nil, nil
    }

    return stateDb.RawDump(), nil
}

func (self *debugApi) GetBlockRlp(req *shared.Request) (interface{}, error) {
    args := new(BlockNumArg)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }

    block := self.xeth.EthBlockByNumber(args.BlockNumber)
    if block == nil {
        return nil, fmt.Errorf("block #%d not found", args.BlockNumber)
    }
    encoded, err := rlp.EncodeToBytes(block)
    return fmt.Sprintf("%x", encoded), err
}

func (self *debugApi) SetHead(req *shared.Request) (interface{}, error) {
    args := new(BlockNumArg)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }

    block := self.xeth.EthBlockByNumber(args.BlockNumber)
    if block == nil {
        return nil, fmt.Errorf("block #%d not found", args.BlockNumber)
    }

    self.ethereum.ChainManager().SetHead(block)

    return nil, nil
}

func (self *debugApi) ProcessBlock(req *shared.Request) (interface{}, error) {
    args := new(BlockNumArg)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }

    block := self.xeth.EthBlockByNumber(args.BlockNumber)
    if block == nil {
        return nil, fmt.Errorf("block #%d not found", args.BlockNumber)
    }

    old := vm.Debug
    defer func() { vm.Debug = old }()
    vm.Debug = true

    _, err := self.ethereum.BlockProcessor().RetryProcess(block)
    if err == nil {
        return true, nil
    }
    return false, err
}

func (self *debugApi) SeedHash(req *shared.Request) (interface{}, error) {
    args := new(BlockNumArg)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }

    if hash, err := ethash.GetSeedHash(uint64(args.BlockNumber)); err == nil {
        return fmt.Sprintf("0x%x", hash), nil
    } else {
        return nil, err
    }
}

func (self *debugApi) Metrics(req *shared.Request) (interface{}, error) {
    args := new(MetricsArgs)
    if err := self.codec.Decode(req.Params, &args); err != nil {
        return nil, shared.NewDecodeParamError(err.Error())
    }
    // Create a rate formatter
    units := []string{"", "K", "M", "G", "T", "E", "P"}
    round := func(value float64, prec int) string {
        unit := 0
        for value >= 1000 {
            unit, value, prec = unit+1, value/1000, 2
        }
        return fmt.Sprintf(fmt.Sprintf("%%.%df%s", prec, units[unit]), value)
    }
    format := func(total float64, rate float64) string {
        return fmt.Sprintf("%s (%s/s)", round(total, 0), round(rate, 2))
    }
    // Create the percentile units
    percentiles := make([]float64, 101)
    for i := 0; i <= 100; i++ {
        percentiles[i] = float64(i) / 100
    }
    // Iterate over all the metrics, and just dump for now
    counters := make(map[string]interface{})
    metrics.DefaultRegistry.Each(func(name string, metric interface{}) {
        // Create or retrieve the counter hierarchy for this metric
        root, parts := counters, strings.Split(name, "/")
        for _, part := range parts[:len(parts)-1] {
            if _, ok := root[part]; !ok {
                root[part] = make(map[string]interface{})
            }
            root = root[part].(map[string]interface{})
        }
        name = parts[len(parts)-1]

        // Fill the counter with the metric details, formatting if requested
        if args.Raw {
            switch metric := metric.(type) {
            case metrics.Meter:
                root[name] = map[string]interface{}{
                    "AvgRate01Min": metric.Rate1(),
                    "AvgRate05Min": metric.Rate5(),
                    "AvgRate15Min": metric.Rate15(),
                    "MeanRate":     metric.RateMean(),
                    "Total":        float64(metric.Count()),
                }

            case metrics.Timer:
                ps := make(map[string]interface{})
                for i, p := range metric.Percentiles(percentiles) {
                    ps[fmt.Sprintf("%d", i)] = p
                }
                root[name] = map[string]interface{}{
                    "AvgRate01Min": metric.Rate1(),
                    "AvgRate05Min": metric.Rate5(),
                    "AvgRate15Min": metric.Rate15(),
                    "MeanRate":     metric.RateMean(),
                    "Total":        float64(metric.Count()),
                    "Percentiles":  ps,
                }

            default:
                root[name] = "Unknown metric type"
            }
        } else {
            switch metric := metric.(type) {
            case metrics.Meter:
                root[name] = map[string]interface{}{
                    "Avg01Min": format(metric.Rate1()*60, metric.Rate1()),
                    "Avg05Min": format(metric.Rate5()*300, metric.Rate5()),
                    "Avg15Min": format(metric.Rate15()*900, metric.Rate15()),
                    "Total":    format(float64(metric.Count()), metric.RateMean()),
                }

            case metrics.Timer:
                root[name] = map[string]interface{}{
                    "Avg01Min": format(metric.Rate1()*60, metric.Rate1()),
                    "Avg05Min": format(metric.Rate5()*300, metric.Rate5()),
                    "Avg15Min": format(metric.Rate15()*900, metric.Rate15()),
                    "Total":    format(float64(metric.Count()), metric.RateMean()),
                    "Maximum":  time.Duration(metric.Max()).String(),
                    "Minimum":  time.Duration(metric.Min()).String(),
                    "Percentiles": map[string]interface{}{
                        "20": time.Duration(metric.Percentile(0.2)).String(),
                        "50": time.Duration(metric.Percentile(0.5)).String(),
                        "80": time.Duration(metric.Percentile(0.8)).String(),
                        "95": time.Duration(metric.Percentile(0.95)).String(),
                        "99": time.Duration(metric.Percentile(0.99)).String(),
                    },
                }

            default:
                root[name] = "Unknown metric type"
            }
        }
    })
    return counters, nil
}