aboutsummaryrefslogtreecommitdiffstats
path: root/trie/node.go
blob: 0bfa21dc4362fc2f1d23be6a433c87eda626115a (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
// Copyright 2014 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 trie

import (
    "fmt"
    "io"
    "strings"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/rlp"
)

var indices = []string{"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "a", "b", "c", "d", "e", "f", "[17]"}

type node interface {
    fstring(string) string
}

type (
    fullNode  [17]node
    shortNode struct {
        Key []byte
        Val node
    }
    hashNode  []byte
    valueNode []byte
)

// Pretty printing.
func (n fullNode) String() string  { return n.fstring("") }
func (n shortNode) String() string { return n.fstring("") }
func (n hashNode) String() string  { return n.fstring("") }
func (n valueNode) String() string { return n.fstring("") }

func (n fullNode) fstring(ind string) string {
    resp := fmt.Sprintf("[\n%s  ", ind)
    for i, node := range n {
        if node == nil {
            resp += fmt.Sprintf("%s: <nil> ", indices[i])
        } else {
            resp += fmt.Sprintf("%s: %v", indices[i], node.fstring(ind+"  "))
        }
    }
    return resp + fmt.Sprintf("\n%s] ", ind)
}
func (n shortNode) fstring(ind string) string {
    return fmt.Sprintf("{%x: %v} ", n.Key, n.Val.fstring(ind+"  "))
}
func (n hashNode) fstring(ind string) string {
    return fmt.Sprintf("<%x> ", []byte(n))
}
func (n valueNode) fstring(ind string) string {
    return fmt.Sprintf("%x ", []byte(n))
}

func mustDecodeNode(dbkey, buf []byte) node {
    n, err := decodeNode(buf)
    if err != nil {
        panic(fmt.Sprintf("node %x: %v", dbkey, err))
    }
    return n
}

// decodeNode parses the RLP encoding of a trie node.
func decodeNode(buf []byte) (node, error) {
    if len(buf) == 0 {
        return nil, io.ErrUnexpectedEOF
    }
    elems, _, err := rlp.SplitList(buf)
    if err != nil {
        return nil, fmt.Errorf("decode error: %v", err)
    }
    switch c, _ := rlp.CountValues(elems); c {
    case 2:
        n, err := decodeShort(elems)
        return n, wrapError(err, "short")
    case 17:
        n, err := decodeFull(elems)
        return n, wrapError(err, "full")
    default:
        return nil, fmt.Errorf("invalid number of list elements: %v", c)
    }
}

func decodeShort(buf []byte) (node, error) {
    kbuf, rest, err := rlp.SplitString(buf)
    if err != nil {
        return nil, err
    }
    key := compactDecode(kbuf)
    if key[len(key)-1] == 16 {
        // value node
        val, _, err := rlp.SplitString(rest)
        if err != nil {
            return nil, fmt.Errorf("invalid value node: %v", err)
        }
        return shortNode{key, valueNode(val)}, nil
    }
    r, _, err := decodeRef(rest)
    if err != nil {
        return nil, wrapError(err, "val")
    }
    return shortNode{key, r}, nil
}

func decodeFull(buf []byte) (fullNode, error) {
    var n fullNode
    for i := 0; i < 16; i++ {
        cld, rest, err := decodeRef(buf)
        if err != nil {
            return n, wrapError(err, fmt.Sprintf("[%d]", i))
        }
        n[i], buf = cld, rest
    }
    val, _, err := rlp.SplitString(buf)
    if err != nil {
        return n, err
    }
    if len(val) > 0 {
        n[16] = valueNode(val)
    }
    return n, nil
}

const hashLen = len(common.Hash{})

func decodeRef(buf []byte) (node, []byte, error) {
    kind, val, rest, err := rlp.Split(buf)
    if err != nil {
        return nil, buf, err
    }
    switch {
    case kind == rlp.List:
        // 'embedded' node reference. The encoding must be smaller
        // than a hash in order to be valid.
        if size := len(buf) - len(rest); size > hashLen {
            err := fmt.Errorf("oversized embedded node (size is %d bytes, want size < %d)", size, hashLen)
            return nil, buf, err
        }
        n, err := decodeNode(buf)
        return n, rest, err
    case kind == rlp.String && len(val) == 0:
        // empty node
        return nil, rest, nil
    case kind == rlp.String && len(val) == 32:
        return hashNode(val), rest, nil
    default:
        return nil, nil, fmt.Errorf("invalid RLP string size %d (want 0 or 32)", len(val))
    }
}

// wraps a decoding error with information about the path to the
// invalid child node (for debugging encoding issues).
type decodeError struct {
    what  error
    stack []string
}

func wrapError(err error, ctx string) error {
    if err == nil {
        return nil
    }
    if decErr, ok := err.(*decodeError); ok {
        decErr.stack = append(decErr.stack, ctx)
        return decErr
    }
    return &decodeError{err, []string{ctx}}
}

func (err *decodeError) Error() string {
    return fmt.Sprintf("%v (decode path: %s)", err.what, strings.Join(err.stack, "<-"))
}