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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
|
/*
* NetworkTransacrion.cpp
*
* Created on: 23 Dec 2016
* Author: David
*/
#include "NetworkTransaction.h"
#include <cstdarg>
//***************************************************************************************************
// ConnectionState class
#if 0
void ConnectionState::Init(tcp_pcb *p)
{
pcb = p;
localPort = p->local_port;
remoteIPAddress = p->remote_ip.addr;
remotePort = p->remote_port;
next = nullptr;
sendingTransaction = nullptr;
persistConnection = true;
isTerminated = false;
}
#endif
void ConnectionState::Terminate()
{
//TODO
#if 0
if (pcb != nullptr)
{
tcp_abort(pcb);
}
#endif
}
bool ConnectionState::IsConnected() const
{
//TODO
return false;
}
//***************************************************************************************************
// NetworkTransaction class
NetworkTransaction::NetworkTransaction(NetworkTransaction *n) : next(n), status(released)
{
sendStack = new OutputStack();
}
#if 0
void NetworkTransaction::Set(pbuf *p, ConnectionState *c, TransactionStatus s)
{
cs = c;
// pb = readingPb = p;
status = s;
// inputPointer = 0;
sendBuffer = nullptr;
fileBeingSent = nullptr;
closeRequested = false;
nextWrite = nullptr;
dataAcknowledged = false;
}
#endif
bool NetworkTransaction::HasMoreDataToRead() const
{
//TODO
return false;
}
// Read one char from the NetworkTransaction
bool NetworkTransaction::Read(char& b)
{
#if 1
return false;
#else
if (readingPb == nullptr)
{
b = 0;
return false;
}
b = ((const char*)readingPb->payload)[inputPointer++];
if (inputPointer == readingPb->len)
{
readingPb = readingPb->next;
inputPointer = 0;
}
return true;
#endif
}
// Read data from the NetworkTransaction and return true on success
bool NetworkTransaction::ReadBuffer(const char *&buffer, size_t &len)
{
#if 1
return false;
#else
if (readingPb == nullptr)
{
return false;
}
if (inputPointer >= readingPb->len)
{
readingPb = readingPb->next;
inputPointer = 0;
if (readingPb == nullptr)
{
return false;
}
}
buffer = (const char*)readingPb->payload + inputPointer;
len = readingPb->len - inputPointer;
readingPb = readingPb->next;
inputPointer = 0;
return true;
#endif
}
void NetworkTransaction::Write(char b)
{
if (CanWrite())
{
if (sendBuffer == nullptr && !OutputBuffer::Allocate(sendBuffer))
{
// Should never get here
return;
}
sendBuffer->cat(b);
}
}
void NetworkTransaction::Write(const char* s)
{
if (CanWrite())
{
if (sendBuffer == nullptr && !OutputBuffer::Allocate(sendBuffer))
{
// Should never get here
return;
}
sendBuffer->cat(s);
}
}
void NetworkTransaction::Write(StringRef ref)
{
Write(ref.Pointer(), ref.strlen());
}
void NetworkTransaction::Write(const char* s, size_t len)
{
if (CanWrite())
{
if (sendBuffer == nullptr && !OutputBuffer::Allocate(sendBuffer))
{
// Should never get here
return;
}
sendBuffer->cat(s, len);
}
}
void NetworkTransaction::Write(OutputBuffer *buffer)
{
if (CanWrite())
{
// Note we use an individual stack here, because we don't want to link different
// OutputBuffers for different destinations together...
sendStack->Push(buffer);
}
else
{
// Don't keep buffers we can't send...
OutputBuffer::ReleaseAll(buffer);
}
}
void NetworkTransaction::Write(OutputStack *stack)
{
if (stack != nullptr)
{
if (CanWrite())
{
sendStack->Append(stack);
}
else
{
stack->ReleaseAll();
}
}
}
void NetworkTransaction::Printf(const char* fmt, ...)
{
if (CanWrite() && (sendBuffer != nullptr || OutputBuffer::Allocate(sendBuffer)))
{
va_list p;
va_start(p, fmt);
sendBuffer->vprintf(fmt, p);
va_end(p);
}
}
void NetworkTransaction::SetFileToWrite(FileStore *file)
{
if (CanWrite())
{
fileBeingSent = file;
}
else if (file != nullptr)
{
file->Close();
}
}
// Send exactly one TCP window of data and return true when this transaction can be released
bool NetworkTransaction::Send()
{
#if 1
return true;
#else
// Free up this transaction if the connection is supposed to be closed
if (closeRequested)
{
reprap.GetNetwork()->ConnectionClosed(cs, true); // This will release the transaction too
return false;
}
// Fill up the TCP window with some data chunks from our OutputBuffer instances
size_t bytesBeingSent = 0, bytesLeftToSend = TCP_WND;
while (sendBuffer != nullptr && bytesLeftToSend > 0)
{
size_t copyLength = min<size_t>(bytesLeftToSend, sendBuffer->BytesLeft());
memcpy(sendingWindow + bytesBeingSent, sendBuffer->Read(copyLength), copyLength);
bytesBeingSent += copyLength;
bytesLeftToSend -= copyLength;
if (sendBuffer->BytesLeft() == 0)
{
sendBuffer = OutputBuffer::Release(sendBuffer);
if (sendBuffer == nullptr)
{
sendBuffer = sendStack->Pop();
}
}
}
// We also intend to send a file, so check if we can fill up the TCP window
if (sendBuffer == nullptr && bytesLeftToSend != 0 && fileBeingSent != nullptr)
{
// For HSMCI efficiency, read from the file in multiples of 4 bytes except at the end.
// This ensures that the second and subsequent chunks can be DMA'd directly into sendingWindow.
size_t bytesToRead = bytesLeftToSend & (~3);
if (bytesToRead != 0)
{
int bytesRead = fileBeingSent->Read(sendingWindow + bytesBeingSent, bytesToRead);
if (bytesRead > 0)
{
bytesBeingSent += bytesRead;
}
if (bytesRead != (int)bytesToRead)
{
fileBeingSent->Close();
fileBeingSent = nullptr;
}
}
}
if (bytesBeingSent == 0)
{
// If we have no data to send, this connection can be closed next time
if (!cs->persistConnection && nextWrite == nullptr)
{
Close();
return false;
}
// We want to send data from another transaction as well, so only free up this one
cs->sendingTransaction = nextWrite;
return true;
}
// The TCP window has been filled up as much as possible, so send it now. There is no need to check
// the available space in the SNDBUF queue, because we really write only one TCP window at once.
writeResult = tcp_write(cs->pcb, sendingWindow, bytesBeingSent, 0);
if (ERR_IS_FATAL(writeResult))
{
reprap.GetPlatform()->MessageF(HOST_MESSAGE, "Network: Failed to write data in Send (code %d)\n", writeResult);
tcp_abort(cs->pcb);
return false;
}
outputResult = tcp_output(cs->pcb);
if (ERR_IS_FATAL(outputResult))
{
reprap.GetPlatform()->MessageF(HOST_MESSAGE, "Network: Failed to output data in Send (code %d)\n", outputResult);
tcp_abort(cs->pcb);
return false;
}
if (outputResult != ERR_OK && reprap.Debug(moduleNetwork))
{
reprap.GetPlatform()->MessageF(HOST_MESSAGE, "Network: tcp_output resulted in error code %d\n", outputResult);
}
// Set LwIP callbacks for ACK and retransmission handling
tcp_poll(cs->pcb, conn_poll, TCP_WRITE_TIMEOUT / TCP_SLOW_INTERVAL / TCP_MAX_SEND_RETRIES);
tcp_sent(cs->pcb, conn_sent);
// Set all values for the send process
sendingConnection = cs;
sendingRetries = 0;
sendingWindowSize = sentDataOutstanding = bytesBeingSent;
return false;
#endif
}
// This is called by the Webserver to send output data to a client. If keepConnectionAlive is set to false,
// the current connection will be terminated once everything has been sent.
void NetworkTransaction::Commit(bool keepConnectionAlive)
{
#if 0
// If the connection has been terminated (e.g. RST received while writing upload data), discard this transaction
if (!IsConnected() || status == released)
{
Discard();
return;
}
// Free buffer holding the incoming data and prepare some values for the sending process
FreePbuf();
cs->persistConnection = keepConnectionAlive;
if (sendBuffer == nullptr)
{
sendBuffer = sendStack->Pop();
}
status = sending;
// Unlink the item(s) from the list of ready transactions
if (keepConnectionAlive)
{
// Our connection is still of interest, remove only this transaction from the list
NetworkTransaction *previous = nullptr;
for(NetworkTransaction *item = reprap.GetNetwork()->readyTransactions; item != nullptr; item = item->next)
{
if (item == this)
{
if (previous == nullptr)
{
reprap.GetNetwork()->readyTransactions = next;
}
else
{
previous->next = next;
}
break;
}
previous = item;
}
}
else
{
// We will close this connection soon, stop receiving data from this PCB
tcp_recv(cs->pcb, nullptr);
// Also remove all ready transactions pointing to our ConnectionState
NetworkTransaction *previous = nullptr, *item = reprap.GetNetwork()->readyTransactions;
while (item != nullptr)
{
if (item->cs == cs)
{
if (item == this)
{
// Only unlink this item
if (previous == nullptr)
{
reprap.GetNetwork()->readyTransactions = next;
}
else
{
previous->next = next;
}
item = next;
}
else
{
// Remove all others
item->Discard();
item = (previous == nullptr) ? reprap.GetNetwork()->readyTransactions : previous->next;
}
}
else
{
previous = item;
item = item->next;
}
}
}
// Enqueue this transaction, so it's sent in the right order
NetworkTransaction *mySendingTransaction = cs->sendingTransaction;
if (mySendingTransaction == nullptr)
{
cs->sendingTransaction = this;
reprap.GetNetwork()->AppendTransaction(&reprap.GetNetwork()->writingTransactions, this);
}
else
{
while (mySendingTransaction->nextWrite != nullptr)
{
mySendingTransaction = mySendingTransaction->nextWrite;
}
mySendingTransaction->nextWrite = this;
}
#endif
}
// Call this to perform some networking tasks while processing deferred requests,
// and to move this transaction and all transactions that are associated with its
// connection to the end of readyTransactions. There are three ways to do this:
//
// 1) DeferOnly: Do not modify any of the processed data and don't send an ACK.
// This will ensure that zero-window packets are sent back to the client
// 2) ResetData: Reset the read pointers and acknowledge that the data has been processed
// 3) DiscardData: Free the processed data, acknowledge it and append this transaction as
// an empty item again without payload (i.e. without pbufs)
//
void NetworkTransaction::Defer(DeferralMode mode)
{
#if 0
if (mode == DeferralMode::ResetData)
{
// Reset the reading pointers and send an ACK
inputPointer = 0;
readingPb = pb;
if (IsConnected() && pb != nullptr && !dataAcknowledged)
{
tcp_recved(cs->pcb, pb->tot_len);
dataAcknowledged = true;
}
}
else if (mode == DeferralMode::DiscardData)
{
// Discard the incoming data, because we don't need to process it any more
FreePbuf();
}
status = deferred;
// Unlink this transaction from the list of ready transactions and append it again
Network *network = reprap.GetNetwork();
NetworkTransaction *item, *previous = nullptr;
for(item = network->readyTransactions; item != nullptr; item = item->next)
{
if (item == this)
{
if (previous == nullptr)
{
network->readyTransactions = next;
}
else
{
previous->next = next;
}
break;
}
previous = item;
}
network->AppendTransaction(&network->readyTransactions, this);
// Append all other transactions that are associated to this connection, so that the
// Webserver gets a chance to deal with all connected clients even while multiple
// deferred requests are present in the list.
item = network->readyTransactions;
previous = nullptr;
while (item != this)
{
if (item->cs == cs)
{
NetworkTransaction *nextItem = item->next;
if (previous == nullptr)
{
network->readyTransactions = item->next;
network->AppendTransaction(&network->readyTransactions, item);
}
else
{
previous->next = item->next;
network->AppendTransaction(&network->readyTransactions, item);
}
item = nextItem;
}
else
{
previous = item;
item = item->next;
}
}
#endif
}
// This method should be called if we don't want to send data to the client and if we
// don't want to interfere with the connection state. May also be called from ISR!
void NetworkTransaction::Discard()
{
#if 0
// Can we do anything?
if (status == released)
{
// No - don't free up released items multiple times
return;
}
// Free up some resources
FreePbuf();
if (fileBeingSent != nullptr)
{
fileBeingSent->Close();
fileBeingSent = nullptr;
}
OutputBuffer::ReleaseAll(sendBuffer);
sendStack->ReleaseAll();
// Unlink this transactions from the list of ready transactions and free it. It is then appended to the list of
// free transactions because we don't want to risk reusing it when the ethernet ISR processes incoming data
NetworkTransaction *previous = nullptr;
for(NetworkTransaction *item = reprap.GetNetwork()->readyTransactions; item != nullptr; item = item->next)
{
if (item == this)
{
if (previous == nullptr)
{
reprap.GetNetwork()->readyTransactions = next;
}
else
{
previous->next = next;
}
break;
}
previous = item;
}
reprap.GetNetwork()->AppendTransaction(&reprap.GetNetwork()->freeTransactions, this);
bool callDisconnectHandler = (cs != nullptr && status == disconnected);
status = released;
// Call disconnect event if this transaction indicates a graceful disconnect and if the connection
// still persists (may not be the case if a RST packet was received before)
if (callDisconnectHandler)
{
if (reprap.Debug(moduleNetwork))
{
reprap.GetPlatform()->Message(HOST_MESSAGE, "Network: Discard() is handling a graceful disconnect\n");
}
reprap.GetNetwork()->ConnectionClosed(cs, false);
}
#endif
}
uint32_t NetworkTransaction::GetRemoteIP() const
{
return (cs != nullptr) ? cs->GetRemoteIP() : 0;
}
uint16_t NetworkTransaction::GetRemotePort() const
{
return (cs != nullptr) ? cs->GetRemotePort() : 0;
}
uint16_t NetworkTransaction::GetLocalPort() const
{
return (cs != nullptr) ? cs->GetLocalPort() : 0;
}
void NetworkTransaction::Close()
{
#if 0
tcp_pcb *pcb = cs->pcb;
tcp_recv(pcb, nullptr);
closeRequested = true;
#endif
}
// End
|