aboutsummaryrefslogtreecommitdiffstats
path: root/les/benchmark.go
blob: 925d1d89e8d3a3dc740ab08d392d0c2dd40ccb5c (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
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
// Copyright 2018 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 les

import (
    "encoding/binary"
    "fmt"
    "math/big"
    "math/rand"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/mclock"
    "github.com/ethereum/go-ethereum/core/rawdb"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/les/flowcontrol"
    "github.com/ethereum/go-ethereum/log"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/enode"
    "github.com/ethereum/go-ethereum/params"
    "github.com/ethereum/go-ethereum/rlp"
)

// requestBenchmark is an interface for different randomized request generators
type requestBenchmark interface {
    // init initializes the generator for generating the given number of randomized requests
    init(pm *ProtocolManager, count int) error
    // request initiates sending a single request to the given peer
    request(peer *peer, index int) error
}

// benchmarkBlockHeaders implements requestBenchmark
type benchmarkBlockHeaders struct {
    amount, skip    int
    reverse, byHash bool
    offset, randMax int64
    hashes          []common.Hash
}

func (b *benchmarkBlockHeaders) init(pm *ProtocolManager, count int) error {
    d := int64(b.amount-1) * int64(b.skip+1)
    b.offset = 0
    b.randMax = pm.blockchain.CurrentHeader().Number.Int64() + 1 - d
    if b.randMax < 0 {
        return fmt.Errorf("chain is too short")
    }
    if b.reverse {
        b.offset = d
    }
    if b.byHash {
        b.hashes = make([]common.Hash, count)
        for i := range b.hashes {
            b.hashes[i] = rawdb.ReadCanonicalHash(pm.chainDb, uint64(b.offset+rand.Int63n(b.randMax)))
        }
    }
    return nil
}

func (b *benchmarkBlockHeaders) request(peer *peer, index int) error {
    if b.byHash {
        return peer.RequestHeadersByHash(0, 0, b.hashes[index], b.amount, b.skip, b.reverse)
    } else {
        return peer.RequestHeadersByNumber(0, 0, uint64(b.offset+rand.Int63n(b.randMax)), b.amount, b.skip, b.reverse)
    }
}

// benchmarkBodiesOrReceipts implements requestBenchmark
type benchmarkBodiesOrReceipts struct {
    receipts bool
    hashes   []common.Hash
}

func (b *benchmarkBodiesOrReceipts) init(pm *ProtocolManager, count int) error {
    randMax := pm.blockchain.CurrentHeader().Number.Int64() + 1
    b.hashes = make([]common.Hash, count)
    for i := range b.hashes {
        b.hashes[i] = rawdb.ReadCanonicalHash(pm.chainDb, uint64(rand.Int63n(randMax)))
    }
    return nil
}

func (b *benchmarkBodiesOrReceipts) request(peer *peer, index int) error {
    if b.receipts {
        return peer.RequestReceipts(0, 0, []common.Hash{b.hashes[index]})
    } else {
        return peer.RequestBodies(0, 0, []common.Hash{b.hashes[index]})
    }
}

// benchmarkProofsOrCode implements requestBenchmark
type benchmarkProofsOrCode struct {
    code     bool
    headHash common.Hash
}

func (b *benchmarkProofsOrCode) init(pm *ProtocolManager, count int) error {
    b.headHash = pm.blockchain.CurrentHeader().Hash()
    return nil
}

func (b *benchmarkProofsOrCode) request(peer *peer, index int) error {
    key := make([]byte, 32)
    rand.Read(key)
    if b.code {
        return peer.RequestCode(0, 0, []CodeReq{{BHash: b.headHash, AccKey: key}})
    } else {
        return peer.RequestProofs(0, 0, []ProofReq{{BHash: b.headHash, Key: key}})
    }
}

// benchmarkHelperTrie implements requestBenchmark
type benchmarkHelperTrie struct {
    bloom                 bool
    reqCount              int
    sectionCount, headNum uint64
}

func (b *benchmarkHelperTrie) init(pm *ProtocolManager, count int) error {
    if b.bloom {
        b.sectionCount, b.headNum, _ = pm.server.bloomTrieIndexer.Sections()
    } else {
        b.sectionCount, _, _ = pm.server.chtIndexer.Sections()
        b.headNum = b.sectionCount*params.CHTFrequency - 1
    }
    if b.sectionCount == 0 {
        return fmt.Errorf("no processed sections available")
    }
    return nil
}

func (b *benchmarkHelperTrie) request(peer *peer, index int) error {
    reqs := make([]HelperTrieReq, b.reqCount)

    if b.bloom {
        bitIdx := uint16(rand.Intn(2048))
        for i := range reqs {
            key := make([]byte, 10)
            binary.BigEndian.PutUint16(key[:2], bitIdx)
            binary.BigEndian.PutUint64(key[2:], uint64(rand.Int63n(int64(b.sectionCount))))
            reqs[i] = HelperTrieReq{Type: htBloomBits, TrieIdx: b.sectionCount - 1, Key: key}
        }
    } else {
        for i := range reqs {
            key := make([]byte, 8)
            binary.BigEndian.PutUint64(key[:], uint64(rand.Int63n(int64(b.headNum))))
            reqs[i] = HelperTrieReq{Type: htCanonical, TrieIdx: b.sectionCount - 1, Key: key, AuxReq: auxHeader}
        }
    }

    return peer.RequestHelperTrieProofs(0, 0, reqs)
}

// benchmarkTxSend implements requestBenchmark
type benchmarkTxSend struct {
    txs types.Transactions
}

func (b *benchmarkTxSend) init(pm *ProtocolManager, count int) error {
    key, _ := crypto.GenerateKey()
    addr := crypto.PubkeyToAddress(key.PublicKey)
    signer := types.NewEIP155Signer(big.NewInt(18))
    b.txs = make(types.Transactions, count)

    for i := range b.txs {
        data := make([]byte, txSizeCostLimit)
        rand.Read(data)
        tx, err := types.SignTx(types.NewTransaction(0, addr, new(big.Int), 0, new(big.Int), data), signer, key)
        if err != nil {
            panic(err)
        }
        b.txs[i] = tx
    }
    return nil
}

func (b *benchmarkTxSend) request(peer *peer, index int) error {
    enc, _ := rlp.EncodeToBytes(types.Transactions{b.txs[index]})
    return peer.SendTxs(0, 0, enc)
}

// benchmarkTxStatus implements requestBenchmark
type benchmarkTxStatus struct{}

func (b *benchmarkTxStatus) init(pm *ProtocolManager, count int) error {
    return nil
}

func (b *benchmarkTxStatus) request(peer *peer, index int) error {
    var hash common.Hash
    rand.Read(hash[:])
    return peer.RequestTxStatus(0, 0, []common.Hash{hash})
}

// benchmarkSetup stores measurement data for a single benchmark type
type benchmarkSetup struct {
    req                   requestBenchmark
    totalCount            int
    totalTime, avgTime    time.Duration
    maxInSize, maxOutSize uint32
    err                   error
}

// runBenchmark runs a benchmark cycle for all benchmark types in the specified
// number of passes
func (pm *ProtocolManager) runBenchmark(benchmarks []requestBenchmark, passCount int, targetTime time.Duration) []*benchmarkSetup {
    setup := make([]*benchmarkSetup, len(benchmarks))
    for i, b := range benchmarks {
        setup[i] = &benchmarkSetup{req: b}
    }
    for i := 0; i < passCount; i++ {
        log.Info("Running benchmark", "pass", i+1, "total", passCount)
        todo := make([]*benchmarkSetup, len(benchmarks))
        copy(todo, setup)
        for len(todo) > 0 {
            // select a random element
            index := rand.Intn(len(todo))
            next := todo[index]
            todo[index] = todo[len(todo)-1]
            todo = todo[:len(todo)-1]

            if next.err == nil {
                // calculate request count
                count := 50
                if next.totalTime > 0 {
                    count = int(uint64(next.totalCount) * uint64(targetTime) / uint64(next.totalTime))
                }
                if err := pm.measure(next, count); err != nil {
                    next.err = err
                }
            }
        }
    }
    log.Info("Benchmark completed")

    for _, s := range setup {
        if s.err == nil {
            s.avgTime = s.totalTime / time.Duration(s.totalCount)
        }
    }
    return setup
}

// meteredPipe implements p2p.MsgReadWriter and remembers the largest single
// message size sent through the pipe
type meteredPipe struct {
    rw      p2p.MsgReadWriter
    maxSize uint32
}

func (m *meteredPipe) ReadMsg() (p2p.Msg, error) {
    return m.rw.ReadMsg()
}

func (m *meteredPipe) WriteMsg(msg p2p.Msg) error {
    if msg.Size > m.maxSize {
        m.maxSize = msg.Size
    }
    return m.rw.WriteMsg(msg)
}

// measure runs a benchmark for a single type in a single pass, with the given
// number of requests
func (pm *ProtocolManager) measure(setup *benchmarkSetup, count int) error {
    clientPipe, serverPipe := p2p.MsgPipe()
    clientMeteredPipe := &meteredPipe{rw: clientPipe}
    serverMeteredPipe := &meteredPipe{rw: serverPipe}
    var id enode.ID
    rand.Read(id[:])
    clientPeer := pm.newPeer(lpv2, NetworkId, p2p.NewPeer(id, "client", nil), clientMeteredPipe)
    serverPeer := pm.newPeer(lpv2, NetworkId, p2p.NewPeer(id, "server", nil), serverMeteredPipe)
    serverPeer.sendQueue = newExecQueue(count)
    serverPeer.announceType = announceTypeNone
    serverPeer.fcCosts = make(requestCostTable)
    c := &requestCosts{}
    for code := range requests {
        serverPeer.fcCosts[code] = c
    }
    serverPeer.fcParams = flowcontrol.ServerParams{BufLimit: 1, MinRecharge: 1}
    serverPeer.fcClient = flowcontrol.NewClientNode(pm.server.fcManager, serverPeer.fcParams)
    defer serverPeer.fcClient.Disconnect()

    if err := setup.req.init(pm, count); err != nil {
        return err
    }

    errCh := make(chan error, 10)
    start := mclock.Now()

    go func() {
        for i := 0; i < count; i++ {
            if err := setup.req.request(clientPeer, i); err != nil {
                errCh <- err
                return
            }
        }
    }()
    go func() {
        for i := 0; i < count; i++ {
            if err := pm.handleMsg(serverPeer); err != nil {
                errCh <- err
                return
            }
        }
    }()
    go func() {
        for i := 0; i < count; i++ {
            msg, err := clientPipe.ReadMsg()
            if err != nil {
                errCh <- err
                return
            }
            var i interface{}
            msg.Decode(&i)
        }
        // at this point we can be sure that the other two
        // goroutines finished successfully too
        close(errCh)
    }()
    select {
    case err := <-errCh:
        if err != nil {
            return err
        }
    case <-pm.quitSync:
        clientPipe.Close()
        serverPipe.Close()
        return fmt.Errorf("Benchmark cancelled")
    }

    setup.totalTime += time.Duration(mclock.Now() - start)
    setup.totalCount += count
    setup.maxInSize = clientMeteredPipe.maxSize
    setup.maxOutSize = serverMeteredPipe.maxSize
    clientPipe.Close()
    serverPipe.Close()
    return nil
}