-
Notifications
You must be signed in to change notification settings - Fork 211
/
conn.go
417 lines (358 loc) · 10.4 KB
/
conn.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
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
package net
import (
"context"
"errors"
"github.com/spacemeshos/go-spacemesh/log"
"github.com/spacemeshos/go-spacemesh/p2p/config"
"github.com/spacemeshos/go-spacemesh/p2p/metrics"
"github.com/spacemeshos/go-spacemesh/p2p/net/wire/delimited"
"github.com/spacemeshos/go-spacemesh/p2p/p2pcrypto"
"time"
"fmt"
"io"
"net"
"sync"
"github.com/spacemeshos/go-spacemesh/crypto"
)
var (
// ErrConnectionClosed is sent when the connection is closed after Close was called
ErrConnectionClosed = errors.New("connections was intentionally closed")
)
// ConnectionSource specifies the connection originator - local or remote node.
type ConnectionSource int
// ConnectionSource values
const (
Local ConnectionSource = iota
Remote
)
// MessageQueueSize is the size for queue of messages before pushing them on the socket
const MessageQueueSize = 250
type msgToSend struct {
payload []byte
reqID string
}
// Connection is an interface stating the API of all secured connections in the system
type Connection interface {
fmt.Stringer
ID() string
RemotePublicKey() p2pcrypto.PublicKey
SetRemotePublicKey(key p2pcrypto.PublicKey)
Created() time.Time
RemoteAddr() net.Addr
Session() NetworkSession
SetSession(session NetworkSession)
Send(ctx context.Context, m []byte) error
Close() error
Closed() bool
}
// FormattedConnection is an io.Writer and an io.Closer
// A network connection supporting full-duplex messaging
type FormattedConnection struct {
// metadata for logging / debugging
logger log.Log
id string // uuid for logging
created time.Time
remotePub p2pcrypto.PublicKey
remoteAddr net.Addr
networker networker // network context
session NetworkSession
deadline time.Duration
r formattedReader
wmtx sync.Mutex
w formattedWriter
closed bool
deadliner deadliner
messages chan msgToSend
stopSending chan struct{}
close io.Closer
msgSizeLimit int
}
type networker interface {
HandlePreSessionIncomingMessage(c Connection, msg []byte) error
EnqueueMessage(ctx context.Context, ime IncomingMessageEvent)
SubscribeClosingConnections(func(context.Context, ConnectionWithErr))
publishClosingConnection(c ConnectionWithErr)
NetworkID() int8
}
type readWriteCloseAddresser interface {
io.ReadWriteCloser
deadliner
RemoteAddr() net.Addr
}
type deadliner interface {
SetReadDeadline(t time.Time) error
SetWriteDeadline(t time.Time) error
}
type formattedReader interface {
Next() ([]byte, error)
}
type formattedWriter interface {
WriteRecord([]byte) (int, error)
}
type fmtConnection interface {
Connection
SendSock([]byte) error
setupIncoming(context.Context, time.Duration) error
beginEventProcessing(context.Context)
}
// Create a new connection wrapping a net.Conn with a provided connection manager
func newConnection(conn readWriteCloseAddresser, netw networker,
remotePub p2pcrypto.PublicKey, session NetworkSession, msgSizeLimit int, deadline time.Duration, log log.Log) fmtConnection {
// todo parametrize channel size - hard-coded for now
connection := &FormattedConnection{
logger: log,
id: crypto.UUIDString(),
created: time.Now(),
remotePub: remotePub,
remoteAddr: conn.RemoteAddr(),
r: delimited.NewReader(conn),
w: delimited.NewWriter(conn),
close: conn,
deadline: deadline,
deadliner: conn,
networker: netw,
session: session,
messages: make(chan msgToSend, MessageQueueSize),
stopSending: make(chan struct{}),
msgSizeLimit: msgSizeLimit,
}
go connection.sendListener()
return connection
}
// ID returns the channel's ID
func (c *FormattedConnection) ID() string {
return c.id
}
// RemoteAddr returns the channel's remote peer address
func (c *FormattedConnection) RemoteAddr() net.Addr {
return c.remoteAddr
}
// SetRemotePublicKey sets the remote peer's public key
func (c *FormattedConnection) SetRemotePublicKey(key p2pcrypto.PublicKey) {
c.remotePub = key
}
// RemotePublicKey returns the remote peer's public key
func (c *FormattedConnection) RemotePublicKey() p2pcrypto.PublicKey {
return c.remotePub
}
// SetSession sets the network session
func (c *FormattedConnection) SetSession(session NetworkSession) {
c.session = session
}
// Session returns the network session
func (c *FormattedConnection) Session() NetworkSession {
return c.session
}
// String returns a string describing the connection
func (c *FormattedConnection) String() string {
return c.id
}
// Created is the time the connection was created
func (c *FormattedConnection) Created() time.Time {
return c.created
}
func (c *FormattedConnection) publish(ctx context.Context, message []byte) {
// Print a log line to establish a link between the originating sessionID and this requestID,
// before the sessionID disappears.
c.logger.WithContext(ctx).Debug("enqueuing incoming message")
// Rather than store the context on the heap, which is an antipattern, we instead extract the sessionID and store
// that.
ime := IncomingMessageEvent{Conn: c, Message: message}
if requestID, ok := log.ExtractRequestID(ctx); ok {
ime.RequestID = requestID
}
c.networker.EnqueueMessage(ctx, ime)
}
// NOTE: this is left here intended to help debugging in the future.
//func (c *FormattedConnection) measureSend() context.CancelFunc {
// ctx, cancel := context.WithCancel(context.Background())
// go func(ctx context.Context) {
// timer := time.NewTimer(time.Second * 20)
// select {
// case <-timer.C:
// i := crypto.UUIDString()
// c.logger.With().Info("sending message is taking more than 20 seconds", log.String("peer", c.RemotePublicKey().String()), log.String("file", fmt.Sprintf("/tmp/stacktrace%v", i)))
// buf := make([]byte, 1024)
// for {
// n := runtime.Stack(buf, true)
// if n < len(buf) {
// break
// }
// buf = make([]byte, 2*len(buf))
// }
// err := ioutil.WriteFile(fmt.Sprintf("/tmp/stacktrace%v", i), buf, 0644)
// if err != nil {
// c.logger.Error("ERR WIRTING FILE %v", err)
// }
// case <-ctx.Done():
// return
// }
// }(ctx)
// return cancel
//}
func (c *FormattedConnection) sendListener() {
for {
select {
case m := <-c.messages:
c.logger.With().Debug("sending outgoing message", log.String("requestId", m.reqID))
//todo: we are hiding the error here...
if err := c.SendSock(m.payload); err != nil {
c.logger.With().Error("cannot send message to peer",
log.String("requestId", m.reqID),
log.Err(err))
}
case <-c.stopSending:
return
}
}
}
// Send pushes a message into the queue if the connection is not closed.
func (c *FormattedConnection) Send(ctx context.Context, m []byte) error {
c.wmtx.Lock()
if c.closed {
c.wmtx.Unlock()
return fmt.Errorf("connection was closed")
}
c.wmtx.Unlock()
// try to extract a requestID from the context
reqID, _ := log.ExtractRequestID(ctx)
c.logger.WithContext(ctx).Debug("enqueuing outgoing message")
c.messages <- msgToSend{m, reqID}
return nil
}
// SendSock sends a message directly on the socket without waiting for the queue.
func (c *FormattedConnection) SendSock(m []byte) error {
c.wmtx.Lock()
if c.closed {
c.wmtx.Unlock()
return fmt.Errorf("connection was closed")
}
err := c.deadliner.SetWriteDeadline(time.Now().Add(c.deadline))
if err != nil {
return err
}
_, err = c.w.WriteRecord(m)
if err != nil {
cerr := c.closeUnlocked()
c.wmtx.Unlock()
if cerr != ErrAlreadyClosed {
c.networker.publishClosingConnection(ConnectionWithErr{c, err}) // todo: reconsider
}
return err
}
c.wmtx.Unlock()
metrics.PeerRecv.With(metrics.PeerIDLabel, c.remotePub.String()).Add(float64(len(m)))
return nil
}
// ErrAlreadyClosed is an error for when `Close` is called on a closed connection.
var ErrAlreadyClosed = errors.New("connection is already closed")
func (c *FormattedConnection) closeUnlocked() error {
if c.closed {
return ErrAlreadyClosed
}
err := c.close.Close()
c.closed = true
if err != nil {
return err
}
return nil
}
// Close closes the connection (implements io.Closer). It is go safe.
func (c *FormattedConnection) Close() error {
c.wmtx.Lock()
defer c.wmtx.Unlock()
err := c.closeUnlocked()
if err != nil {
return err
}
close(c.stopSending)
return nil
}
// Closed returns whether the connection is closed
func (c *FormattedConnection) Closed() bool {
c.wmtx.Lock()
defer c.wmtx.Unlock()
return c.closed
}
var (
// ErrTriedToSetupExistingConn occurs when handshake packet is sent twice on a connection
ErrTriedToSetupExistingConn = errors.New("tried to setup existing connection")
// ErrMsgExceededLimit occurs when a received message size exceeds the defined message size
ErrMsgExceededLimit = errors.New("message size exceeded limit")
)
func (c *FormattedConnection) setupIncoming(ctx context.Context, timeout time.Duration) error {
be := make(chan struct {
b []byte
e error
})
go func() {
// TODO: some other way to make sure this groutine closes
err := c.deadliner.SetReadDeadline(time.Now().Add(timeout))
if err != nil {
be <- struct {
b []byte
e error
}{b: nil, e: err}
return
}
msg, err := c.r.Next()
be <- struct {
b []byte
e error
}{b: msg, e: err}
err = c.deadliner.SetReadDeadline(time.Time{}) // disable read deadline
if err != nil {
c.logger.Warning("could not set a read deadline err:", err)
}
}()
msgbe := <-be
msg := msgbe.b
err := msgbe.e
if err != nil {
c.Close()
return err
}
if c.msgSizeLimit != config.UnlimitedMsgSize && len(msg) > c.msgSizeLimit {
c.logger.With().Error("setupIncoming: message is too big",
log.Int("limit", c.msgSizeLimit), log.Int("actual", len(msg)))
return ErrMsgExceededLimit
}
if c.session != nil {
c.Close()
return errors.New("setup connection twice")
}
err = c.networker.HandlePreSessionIncomingMessage(c, msg)
if err != nil {
c.Close()
return err
}
return nil
}
// Read from the incoming new messages and send down the connection
func (c *FormattedConnection) beginEventProcessing(ctx context.Context) {
//TODO: use a buffer pool
var err error
var buf []byte
for {
buf, err = c.r.Next()
if err != nil && err != io.EOF {
break
}
if c.session == nil {
err = ErrTriedToSetupExistingConn
break
}
if len(buf) > 0 {
newbuf := make([]byte, len(buf))
copy(newbuf, buf)
c.publish(log.WithNewRequestID(ctx), newbuf)
}
if err != nil {
break
}
}
cerr := c.Close()
if cerr != ErrAlreadyClosed {
c.networker.publishClosingConnection(ConnectionWithErr{c, err})
}
}