-
Notifications
You must be signed in to change notification settings - Fork 0
/
client.go
538 lines (478 loc) · 15.4 KB
/
client.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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
// ,+---+
// +---+´| HASHBOX SOURCE
// | # | | Copyright 2015-2024
// +---+´
// Hashbox core, version 0.1
package core
import (
"io"
"runtime/debug"
"github.com/fredli74/bytearray"
"encoding/binary"
"errors"
"fmt"
"net"
"runtime"
"sync"
"sync/atomic"
"time"
)
const DEFAULT_QUEUE_SIZE int64 = 32 * 1024 * 1024 // 32 MiB max memory
const DEFAULT_CONNECTION_TIMEOUT time.Duration = 5 * time.Minute
type messageDispatch struct {
msg *ProtocolMessage
returnChannel chan interface{}
}
type Client struct {
// variables used in atomic operations (declared first to make sure they are 32 / 64 bit aligned)
msgNum uint32 // protocol message number, 32-bit because there are no 16-bit atomic functions
sendworkers int32 // number of active send workers
transmittedBlocks int32 // number of transmitted blocks
skippedBlocks int32 // number of skipped blocks
WriteData int64 // total data written
WriteDataCompressed int64 // total compressed data written
Session
AccessKey Byte128 // = hmac^20000( AccountName "*ACCESS*KEY*PAD*", md5( password ))
ServerAddress string
connection *TimeoutConn
wg sync.WaitGroup
EnablePaint bool
QueueMax int64 // max size of the outgoing block queue (in bytes)
ThreadMax int32 // maximum number of goroutines started by send queue (defaults to runtime.NumCPU)
sendMutex sync.Mutex // protects from two threads sending at the same time
// mutex protected
dispatchMutex sync.Mutex
closing bool
blockbuffer map[Byte128]*HashboxBlock
blockqueuesize int64 // queue size in bytes
sendqueue []*sendQueueEntry
dispatchChannel chan *messageDispatch // input to goroutine; buffered list of outgoing messages to dispatch
storeChannel chan *messageDispatch // input to goroutine; next block in queue to store
errorChannel chan error // output from goroutine; ioHandler encountered an error
lastError error // last error encountered
}
func NewClient(address string, account string, accesskey Byte128) *Client {
client := &Client{
ServerAddress: address,
AccessKey: accesskey,
Session: Session{
AccountNameH: Hash([]byte(account)),
},
blockbuffer: make(map[Byte128]*HashboxBlock),
QueueMax: DEFAULT_QUEUE_SIZE,
ThreadMax: int32(runtime.NumCPU() / 2),
dispatchChannel: make(chan *messageDispatch, 1024),
storeChannel: make(chan *messageDispatch, 1),
}
if address != "" {
client.Connect()
}
client.errorChannel = make(chan error, 1)
client.wg.Add(1)
go client.ioHandler()
return client
}
var lastPaint string = "\n"
func (c *Client) Paint(what string) {
if c.EnablePaint && (what != "\n" || what != lastPaint) {
fmt.Print(what)
lastPaint = what
}
}
func (c *Client) Close(polite bool) {
c.dispatchMutex.Lock()
if !c.closing {
if polite {
c.dispatchMutex.Unlock()
func() {
defer func() {
r := recover()
if r != nil {
Log(LogDebug, "Error sending Goodbye message to server (%v)", r)
}
}()
c.dispatchAndWait(MsgTypeGoodbye, nil)
}()
c.dispatchMutex.Lock()
}
c.closing = true
close(c.dispatchChannel)
close(c.storeChannel)
}
c.dispatchMutex.Unlock()
if connection := c.connection; connection != nil {
connection.Close() // This will cancel a blocking IO-read if we have one
}
c.wg.Wait()
}
type sendQueueEntry struct {
state int32 // (atomic alignment) 0 - new, 1 - compressing, 2 - compressed, 3 - sending, 4 - sent
block *HashboxBlock
}
func (c *Client) sendQueue(what Byte128) {
c.dispatchMutex.Lock()
defer c.dispatchMutex.Unlock()
block := c.blockbuffer[what]
if block != nil {
c.sendqueue = append(c.sendqueue, &sendQueueEntry{0, block})
// fmt.Printf("+q=%d;", len(c.sendqueue))
if c.sendworkers < 1 || c.sendworkers < c.ThreadMax {
atomic.AddInt32(&c.sendworkers, 1)
go func() {
defer func() { // a panic was raised inside the goroutine (most likely the channel was closed)
if r := recover(); !c.closing && r != nil {
if c.lastError != nil {
panic(c.lastError)
}
err, _ := <-c.errorChannel
if err != nil {
panic(err)
}
panic(r)
}
}()
for done := false; !done; {
var workItem *sendQueueEntry
c.dispatchMutex.Lock()
if len(c.sendqueue) > 0 {
if c.sendqueue[0].state == 2 { // compressed
c.blockqueuesize -= bytearray.ChunkQuantize(int64(c.sendqueue[0].block.UncompressedSize))
c.blockqueuesize += bytearray.ChunkQuantize(int64(c.sendqueue[0].block.CompressedSize))
workItem = c.sendqueue[0] // send it
} else if c.sendqueue[0].state == 4 { // sent
c.sendqueue = c.sendqueue[1:] // remove it
// fmt.Printf("-q=%d;", len(c.sendqueue))
} else {
for i := 0; i < len(c.sendqueue); i++ {
if c.sendqueue[i].state == 0 { // new
workItem = c.sendqueue[i] // compress it
break
}
}
}
if workItem != nil {
atomic.AddInt32(&workItem.state, 1)
}
} else {
done = true
atomic.AddInt32(&c.sendworkers, -1)
// fmt.Println("worker stopping")
}
c.dispatchMutex.Unlock()
if workItem != nil {
switch workItem.state {
case 0:
panic("ASSERT!")
case 1:
workItem.block.CompressData()
atomic.AddInt32(&workItem.state, 1)
case 2:
panic("ASSERT!")
case 3:
atomic.AddInt64(&c.WriteData, int64(workItem.block.UncompressedSize))
atomic.AddInt64(&c.WriteDataCompressed, int64(workItem.block.CompressedSize))
atomic.AddInt32(&c.transmittedBlocks, 1) // c.transmittedBlocks++
c.Paint("*")
msg := &ProtocolMessage{Type: MsgTypeWriteBlock, Data: &MsgClientWriteBlock{Block: workItem.block}}
c.storeChannel <- &messageDispatch{msg: msg}
atomic.AddInt32(&workItem.state, 1)
default:
panic("ASSERT!")
}
} else {
time.Sleep(25 * time.Millisecond)
}
}
}()
}
}
}
func (c *Client) Authorize(connection *TimeoutConn) {
{ // Say hello
data := c.singleExchange(connection, &messageDispatch{msg: &ProtocolMessage{Type: MsgTypeGreeting, Data: &MsgClientGreeting{Version: ProtocolVersion}}}).Data
if data == nil {
panic(errors.New("Server did not respond correctly to handshake"))
}
r := data.(*MsgServerGreeting)
clientTime := uint64(time.Now().Unix())
serverTime := binary.BigEndian.Uint64(r.SessionNonce[:]) / 1000000000
if clientTime < serverTime-600 || clientTime > serverTime+600 {
panic(errors.New("Connection refused, system time difference between client and server is more than 10 minutes"))
}
c.SessionNonce = r.SessionNonce
c.GenerateSessionKey(c.AccessKey)
}
{ // Authenticate
c.singleExchange(connection, &messageDispatch{msg: &ProtocolMessage{Type: MsgTypeAuthenticate, Data: &MsgClientAuthenticate{
AccountNameH: c.AccountNameH,
AuthenticationH: DeepHmac(1, c.AccountNameH[:], c.SessionKey),
}}})
}
}
func (c *Client) Connect() {
c.connection = nil // Drop previous connection object
conn, err := net.Dial("tcp", c.ServerAddress)
if err != nil {
panic(err)
}
newConnection := NewTimeoutConn(conn, DEFAULT_CONNECTION_TIMEOUT)
c.Authorize(newConnection)
// If we reached here, we're all good
c.connection = newConnection
}
func (c *Client) singleExchange(connection *TimeoutConn, outgoing *messageDispatch) *ProtocolMessage {
// Send an outgoing message
outgoing.msg.Num = uint16(atomic.AddUint32(&c.msgNum, 1) - 1)
WriteMessage(connection, outgoing.msg)
// Wait for the reply
incoming := ReadMessage(connection)
if incoming.Num != outgoing.msg.Num {
panic(errors.New("ASSERT! This should never happen unless the server is coded wrong"))
}
if outgoing.returnChannel != nil {
outgoing.returnChannel <- incoming
close(outgoing.returnChannel)
}
// Handle block queue
switch d := incoming.Data.(type) {
case *MsgServerError:
panic(errors.New("Received error from server: " + string(d.ErrorMessage)))
case *MsgServerAcknowledgeBlock:
var skipped bool = false
c.dispatchMutex.Lock()
block := c.blockbuffer[d.BlockID]
if block != nil {
if block.CompressedSize < 0 { // no encoded data = never sent
skipped = true
c.blockqueuesize -= bytearray.ChunkQuantize(int64(block.UncompressedSize))
} else {
c.blockqueuesize -= bytearray.ChunkQuantize(int64(block.CompressedSize))
}
block.Release()
delete(c.blockbuffer, d.BlockID)
}
c.dispatchMutex.Unlock()
if skipped {
atomic.AddInt32(&c.skippedBlocks, 1) //c.skippedBlocks++
c.Paint("-")
}
case *MsgServerReadBlock:
c.sendQueue(d.BlockID)
case *MsgServerWriteBlock:
}
return incoming
}
func (c *Client) retryingExchange(outgoing *messageDispatch) (r *ProtocolMessage) {
if c.ServerAddress == "" {
// Only used in unit testing
return c.singleExchange(c.connection, outgoing)
}
for ever := true; ever && !c.closing; {
ever = func() (retry bool) {
retry = outgoing.msg.Type != MsgTypeGreeting && outgoing.msg.Type != MsgTypeGoodbye && outgoing.msg.Type != MsgTypeAuthenticate
defer func() {
err := recover()
if err == nil {
return
}
c.connection = nil
switch e := err.(type) {
case net.Error:
Log(LogError, e.Error())
Log(LogInfo, "Stacktrace from panic: %s", debug.Stack())
return // Network error, retry and retry again
case error:
if e == io.EOF {
Log(LogError, "Lost connection with server (%v)", e.Error())
Log(LogInfo, "Stacktrace from panic: %s", debug.Stack())
return // Network stream closed, non fatal
}
Log(LogError, e.Error())
Log(LogError, fmt.Sprint(e))
default:
Log(LogError, "Unknown error in client communication")
Log(LogError, fmt.Sprint(e))
}
panic(err)
}()
if c.connection == nil {
if retry {
Log(LogInfo, "Retrying connection in 15 seconds")
time.Sleep(15 * time.Second)
Log(LogInfo, "Reconnecting to server")
c.Connect()
}
} else {
r = c.singleExchange(c.connection, outgoing)
retry = false
}
return
}()
}
return r
}
func (c *Client) ioHandler() {
defer func() {
if r := recover(); !c.closing && r != nil { // a panic was raised inside the goroutine
c.lastError = r.(error)
c.errorChannel <- r.(error)
close(c.errorChannel) // close it to trigger everyone to stop
}
c.wg.Done()
}()
for {
select {
case outgoing, ok := <-c.storeChannel:
if !ok {
// Channel is closed
return
}
c.retryingExchange(outgoing)
case outgoing, ok := <-c.dispatchChannel:
if !ok {
// Channel is closed
return
}
c.retryingExchange(outgoing)
}
}
}
// dispatchMessage returns a result channel if a returnChannel was specified, otherwise it just returns nil
func (c *Client) dispatchMessage(msgType uint32, msgData interface{}, returnChannel chan interface{}) {
defer func() {
if r := recover(); !c.closing && r != nil { // a panic was raised (most likely the channel was closed)
if c.lastError != nil {
panic(c.lastError)
}
panic(r)
}
}()
if !c.closing {
select {
case c.dispatchChannel <- &messageDispatch{msg: &ProtocolMessage{Type: msgType, Data: msgData}, returnChannel: returnChannel}:
return
case err, _ := <-c.errorChannel:
if c.lastError != nil {
panic(c.lastError)
}
if err != nil {
panic(err)
}
panic("Why did we end up here?")
}
} else {
if returnChannel != nil {
close(returnChannel)
}
}
}
// dispatchAndWait will always return the response you were waiting for or throw a panic, so there is no need to check return values
func (c *Client) dispatchAndWait(msgType uint32, msgData interface{}) interface{} {
waiter := make(chan interface{}, 1)
c.dispatchMessage(msgType, msgData, waiter)
select {
case R, ok := <-waiter:
if !ok {
panic(errors.New("Server disconnected while waiting for a response"))
}
switch t := R.(type) {
case *ProtocolMessage:
switch dt := t.Data.(type) {
case *MsgServerError:
panic(errors.New("Received error from server: " + string(dt.ErrorMessage)))
default:
return t.Data
}
}
case err := <-c.errorChannel:
if c.lastError != nil {
panic(c.lastError)
}
if err != nil {
panic(err)
}
panic(errors.New("Connection was closed while waiting for a response"))
}
panic(errors.New("ASSERT! We should not reach this point"))
}
func (c *Client) GetAccountInfo() *MsgServerAccountInfo {
r := c.dispatchAndWait(MsgTypeAccountInfo, &MsgClientAccountInfo{AccountNameH: c.AccountNameH}).(*MsgServerAccountInfo)
return r
}
func (c *Client) ListDataset(datasetName string) *MsgServerListDataset {
r := c.dispatchAndWait(MsgTypeListDataset, &MsgClientListDataset{AccountNameH: c.AccountNameH, DatasetName: String(datasetName)}).(*MsgServerListDataset)
return r
}
func (c *Client) AddDatasetState(datasetName string, state DatasetState) {
c.dispatchAndWait(MsgTypeAddDatasetState, &MsgClientAddDatasetState{AccountNameH: c.AccountNameH, DatasetName: String(datasetName), State: state})
}
func (c *Client) RemoveDatasetState(datasetName string, stateID Byte128) {
c.dispatchAndWait(MsgTypeRemoveDatasetState, &MsgClientRemoveDatasetState{AccountNameH: c.AccountNameH, DatasetName: String(datasetName), StateID: stateID})
}
func (c *Client) VerifyBlock(blockID Byte128) bool {
r := c.dispatchAndWait(MsgTypeAllocateBlock, &MsgClientAllocateBlock{BlockID: blockID})
switch r.(type) {
case *MsgServerAcknowledgeBlock:
return true
case *MsgServerReadBlock:
return false
default:
panic(errors.New("Unknown response from server"))
}
}
func (c *Client) StoreData(dataType byte, data bytearray.ByteArray, links []Byte128) Byte128 {
// Create a block
block := NewHashboxBlock(dataType, data, links)
return c.StoreBlock(block)
}
// StoreBlock is blocking if the blockbuffer is full
func (c *Client) StoreBlock(block *HashboxBlock) Byte128 {
// Add the block to the io queue
for full := true; full; { //
c.dispatchMutex.Lock()
if c.closing {
c.dispatchMutex.Unlock()
panic(errors.New("Connection closed"))
} else if c.blockbuffer[block.BlockID] != nil {
block.Release()
c.dispatchMutex.Unlock()
return block.BlockID
} else if c.blockqueuesize == 0 || c.blockqueuesize+bytearray.ChunkQuantize(int64(block.UncompressedSize))*2 < c.QueueMax {
c.blockbuffer[block.BlockID] = block
c.blockqueuesize += bytearray.ChunkQuantize(int64(block.UncompressedSize))
full = false
}
c.dispatchMutex.Unlock()
if full {
time.Sleep(25 * time.Millisecond)
}
}
// Put an allocate block on the line
c.dispatchMessage(MsgTypeAllocateBlock, &MsgClientAllocateBlock{BlockID: block.BlockID}, nil)
return block.BlockID
}
func (c *Client) ReadBlock(blockID Byte128) *HashboxBlock {
b := c.dispatchAndWait(MsgTypeReadBlock, &MsgClientReadBlock{BlockID: blockID}).(*MsgServerWriteBlock)
b.Block.UncompressData()
return b.Block
}
func (c *Client) Commit() {
for done := false; !done; time.Sleep(100 * time.Millisecond) {
func() {
done = c.Done()
}()
}
}
func (c *Client) Done() bool {
c.dispatchMutex.Lock()
defer c.dispatchMutex.Unlock()
return c.closing || len(c.blockbuffer) == 0
}
const hashPadding_accesskey = "*ACCESS*KEY*PAD*" // TODO: move to client source
// binary.BigEndian.Get and binary.BigEndian.Put much faster than
// binary.Read and binary.Write
func (c *Client) GetStats() (tranismitted int32, skipped int32, queued int32, queuesize int64) {
c.dispatchMutex.Lock()
defer c.dispatchMutex.Unlock()
return c.transmittedBlocks, c.skippedBlocks, int32(len(c.blockbuffer)), c.blockqueuesize
}