aboutsummaryrefslogtreecommitdiffstats
path: root/rlp/typecache.go
blob: f5387a2717f58b00d2c0d260cdeb77c1f9417015 (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
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// go-ethereum 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 rlp

import (
    "reflect"
    "sync"
)

var (
    typeCacheMutex sync.RWMutex
    typeCache      = make(map[typekey]*typeinfo)
)

type typeinfo struct {
    decoder
    writer
}

// represents struct tags
type tags struct {
    nilOK bool
}

type typekey struct {
    reflect.Type
    // the key must include the struct tags because they
    // might generate a different decoder.
    tags
}

type decoder func(*Stream, reflect.Value) error

type writer func(reflect.Value, *encbuf) error

func cachedTypeInfo(typ reflect.Type, tags tags) (*typeinfo, error) {
    typeCacheMutex.RLock()
    info := typeCache[typekey{typ, tags}]
    typeCacheMutex.RUnlock()
    if info != nil {
        return info, nil
    }
    // not in the cache, need to generate info for this type.
    typeCacheMutex.Lock()
    defer typeCacheMutex.Unlock()
    return cachedTypeInfo1(typ, tags)
}

func cachedTypeInfo1(typ reflect.Type, tags tags) (*typeinfo, error) {
    key := typekey{typ, tags}
    info := typeCache[key]
    if info != nil {
        // another goroutine got the write lock first
        return info, nil
    }
    // put a dummmy value into the cache before generating.
    // if the generator tries to lookup itself, it will get
    // the dummy value and won't call itself recursively.
    typeCache[key] = new(typeinfo)
    info, err := genTypeInfo(typ, tags)
    if err != nil {
        // remove the dummy value if the generator fails
        delete(typeCache, key)
        return nil, err
    }
    *typeCache[key] = *info
    return typeCache[key], err
}

type field struct {
    index int
    info  *typeinfo
}

func structFields(typ reflect.Type) (fields []field, err error) {
    for i := 0; i < typ.NumField(); i++ {
        if f := typ.Field(i); f.PkgPath == "" { // exported
            tags := parseStructTag(f.Tag.Get("rlp"))
            info, err := cachedTypeInfo1(f.Type, tags)
            if err != nil {
                return nil, err
            }
            fields = append(fields, field{i, info})
        }
    }
    return fields, nil
}

func parseStructTag(tag string) tags {
    return tags{nilOK: tag == "nil"}
}

func genTypeInfo(typ reflect.Type, tags tags) (info *typeinfo, err error) {
    info = new(typeinfo)
    if info.decoder, err = makeDecoder(typ, tags); err != nil {
        return nil, err
    }
    if info.writer, err = makeWriter(typ); err != nil {
        return nil, err
    }
    return info, nil
}

func isUint(k reflect.Kind) bool {
    return k >= reflect.Uint && k <= reflect.Uintptr
}