This repository has been archived by the owner on Aug 24, 2019. It is now read-only.
forked from cmars/conflux
/
settings.go
234 lines (201 loc) · 6.8 KB
/
settings.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
/*
conflux - Distributed database synchronization library
Based on the algorithm described in
"Set Reconciliation with Nearly Optimal Communication Complexity",
Yaron Minsky, Ari Trachtenberg, and Richard Zippel, 2004.
Copyright (C) 2012 Casey Marshall <casey.marshall@gmail.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, version 3.
This program 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// Package recon provides the SKS reconciliation protocol, prefix tree interface
// and an in-memory prefix-tree implementation.
package recon
import (
"fmt"
"net"
"strings"
"github.com/BurntSushi/toml"
"gopkg.in/errgo.v1"
)
// Settings holds the configuration settings for the local reconciliation peer.
type Settings struct {
Version string `toml:"version"`
LogName string `toml:"logname"`
HTTPAddr string `toml:"httpAddr"`
HTTPNet network `toml:"httpNet"`
ReconAddr string `toml:"reconAddr"`
ReconNet network `toml:"reconNet"`
Partners map[string]Partner `toml:"partner"`
Filters []string `toml:"filters"`
// Backwards-compatible keys
CompatHTTPPort int `toml:"httpPort"`
CompatReconPort int `toml:"reconPort"`
CompatPartnerAddrs []string `toml:"partners"`
ThreshMult int `toml:"threshMult"`
BitQuantum int `toml:"bitQuantum"`
MBar int `toml:"mBar"`
GossipIntervalSecs int `toml:"gossipIntervalSecs"`
MaxOutstandingReconRequests int `toml:"maxOutstandingReconRequests"`
ConnTimeout int `toml:"connTimeout"`
ReadTimeout int `toml:"readTimeout"`
}
type Partner struct {
HTTPAddr string `toml:"httpAddr"`
HTTPNet network `toml:"httpNet"`
ReconAddr string `toml:"reconAddr"`
ReconNet network `toml:"reconNet"`
}
type network string
const (
networkDefault = network("")
networkTCP = network("tcp")
networkUnix = network("unix")
)
// String implements the fmt.Stringer interface.
func (n network) String() string {
if n == "" {
return string(networkTCP)
}
return string(n)
}
func (n network) Resolve(addr string) (net.Addr, error) {
switch n {
case networkDefault, networkTCP:
return net.ResolveTCPAddr("tcp", addr)
case networkUnix:
return net.ResolveUnixAddr("unix", addr)
}
return nil, fmt.Errorf("don't know how to resolve network %q address %q", n, addr)
}
const (
DefaultVersion = "1.1.3"
DefaultLogName = "conflux.recon"
DefaultHTTPAddr = ":11371"
DefaultReconAddr = ":11370"
DefaultGossipIntervalSecs = 60
DefaultMaxOutstandingReconRequests = 100
)
var defaultSettings = Settings{
Version: DefaultVersion,
LogName: DefaultLogName,
HTTPAddr: DefaultHTTPAddr,
ReconAddr: DefaultReconAddr,
ThreshMult: DefaultThreshMult,
BitQuantum: DefaultBitQuantum,
MBar: DefaultMBar,
GossipIntervalSecs: DefaultGossipIntervalSecs,
MaxOutstandingReconRequests: DefaultMaxOutstandingReconRequests,
}
// ParseSettings parses a TOML-formatted string representation into Settings.
func ParseSettings(data string) (*Settings, error) {
var doc struct {
Conflux struct {
Recon Settings `toml:"recon"`
} `toml:"conflux"`
}
doc.Conflux.Recon = defaultSettings
_, err := toml.Decode(data, &doc)
if err != nil {
return nil, err
}
settings := &doc.Conflux.Recon
if settings.CompatHTTPPort != 0 {
settings.HTTPAddr = fmt.Sprintf(":%d", settings.CompatHTTPPort)
}
if settings.CompatReconPort != 0 {
settings.ReconAddr = fmt.Sprintf(":%d", settings.CompatReconPort)
}
if len(settings.CompatPartnerAddrs) > 0 {
settings.Partners = map[string]Partner{}
for _, partnerAddr := range settings.CompatPartnerAddrs {
host, _, err := net.SplitHostPort(partnerAddr)
if err != nil {
return nil, errgo.Notef(err, "invalid 'partners' address %q", partnerAddr)
}
p := Partner{
HTTPAddr: fmt.Sprintf("%s:11371", host),
ReconAddr: partnerAddr,
}
settings.Partners[host] = p
}
}
_, err = settings.HTTPNet.Resolve(settings.HTTPAddr)
if err != nil {
return nil, errgo.Notef(err, "invalid httpNet %q httpAddr %q", settings.HTTPNet, settings.HTTPAddr)
}
_, err = settings.ReconNet.Resolve(settings.ReconAddr)
if err != nil {
return nil, errgo.Notef(err, "invalid reconNet %q reconAddr %q", settings.ReconNet, settings.ReconAddr)
}
return settings, nil
}
// DefaultSettings returns default peer configuration settings.
func DefaultSettings() *Settings {
settings := defaultSettings
return &settings
}
func resolveHTTPPortTCP(addr net.Addr) (int, bool) {
tcpAddr, ok := addr.(*net.TCPAddr)
if !ok {
return 0, false
}
return tcpAddr.Port, true
}
var resolveHTTPPort = resolveHTTPPortTCP
// Config returns a recon protocol config message that described this
// peer's configuration settings.
func (s *Settings) Config() (*Config, error) {
config := &Config{
Version: s.Version,
BitQuantum: s.BitQuantum,
MBar: s.MBar,
Filters: strings.Join(s.Filters, ","),
}
// Try to obtain httpPort
addr, err := s.HTTPNet.Resolve(s.HTTPAddr)
if err != nil {
return nil, errgo.Notef(err, "invalid httpNet %q httpAddr %q", s.HTTPNet, s.HTTPAddr)
}
port, ok := resolveHTTPPort(addr)
if !ok {
return nil, errgo.Newf("cannot determine httpPort from httpNet %q httpAddr %q", s.HTTPNet, s.HTTPAddr)
}
config.HTTPPort = port
return config, nil
}
// SplitThreshold returns the maximum number of elements a prefix tree node may
// contain before creating child nodes and distributing the elements among them.
func (s *Settings) SplitThreshold() int {
return s.ThreshMult * s.MBar
}
// JoinThreshold returns the minimum cumulative number of elements under a
// prefix tree parent node, below which all child nodes are merged into the
// parent.
func (s *Settings) JoinThreshold() int {
return s.SplitThreshold() / 2
}
// NumSamples returns the number of sample points used for interpolation.
// This must match among all reconciliation peers.
func (s *Settings) NumSamples() int {
return s.MBar + 1
}
// PartnerAddrs returns the resolved network addresses of configured partner
// peers.
func (s *Settings) PartnerAddrs() ([]net.Addr, error) {
var addrs []net.Addr
for _, partner := range s.Partners {
addr, err := partner.ReconNet.Resolve(partner.ReconAddr)
if err != nil {
return nil, err
}
addrs = append(addrs, addr)
}
return addrs, nil
}