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
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
|
/****************************************************************************************************
RepRapFirmware - Network: RepRapPro Ormerod with Arduino Due controller
2014-04-05 Created from portions taken out of Platform.cpp by dc42
2014-04-07 Added portions of httpd.c. These portions are subject to the following copyright notice:
* Copyright (c) 2001-2003 Swedish Institute of Computer Science.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
* This file is part of the lwIP TCP/IP stack.
*
* Author: Adam Dunkels <adam@sics.se>
*
* (end httpd.c copyright notice)
****************************************************************************************************/
#include "Network.h"
#include "ConnectionState.h"
#include "NetworkTransaction.h"
#include "Platform.h"
#include "RepRap.h"
#include "Webserver.h"
#include "Version.h"
extern "C"
{
#include "ethernet_sam.h"
#include "lwipopts.h"
#ifdef LWIP_STATS
#include "lwip/src/include/lwip/stats.h"
#endif
#include "lwip/src/include/lwip/tcp.h"
#include "lwip/src/include/lwip/tcp_impl.h"
#include "contrib/apps/netbios/netbios.h"
#include "contrib/apps/mdns/mdns_responder.h"
}
static volatile bool lwipLocked = false;
static bool ethernetStarted = false;
const size_t NumProtocols = 3; // number of network protocols we support
const size_t HttpProtocolIndex = 0, FtpProtocolIndex = 1, TelnetProtocolIndex = 2; // index of theHTTP service above
const Port DefaultPortNumbers[NumProtocols] = { DefaultHttpPort, DefaultFtpPort, DefaultTelnetPort };
const char * const ProtocolNames[NumProtocols] = { "HTTP", "FTP", "TELNET" };
const char * const MdnsServiceStrings[NumProtocols] = { "\x05_http\x04_tcp\x05local", "\x04_ftp\x04_tcp\x05local", "\x07_telnet\x04_tcp\x05local" };
static Port portNumbers[NumProtocols] = { DefaultHttpPort, DefaultFtpPort, DefaultTelnetPort }; // port number used for each protocol
static bool protocolEnabled[NumProtocols] = { true, false, false }; // by default only HTTP is enabled
static tcp_pcb *pcbs[NumProtocols] = { nullptr, nullptr, nullptr };
static tcp_pcb *ftp_pasv_pcb = nullptr;
const size_t NumMdnsFixedProtocols = 1; // what we need to add to the protocol index in order to access the corresponding entry in mdns_services
static struct mdns_service mdns_services[NumMdnsFixedProtocols + NumProtocols] =
{
{
.name = "\x05_echo\x04_tcp\x05local",
.port = 7,
},
{
0
},
{
0
},
{
0
}
};
static const char *mdns_txt_records[] =
{
"product=" FIRMWARE_NAME,
"version=" VERSION,
NULL
};
static bool closingDataPort = false;
ConnectionState *sendingConnection = nullptr;
static uint32_t sendingWindow32[(TCP_WND + 3)/4]; // should be 32-bit aligned for efficiency
char * const sendingWindow = reinterpret_cast<char *>(sendingWindow32);
uint16_t sendingWindowSize, sentDataOutstanding;
uint8_t sendingRetries;
err_t writeResult, outputResult;
/*-----------------------------------------------------------------------------------*/
extern "C"
{
// Lock functions for LWIP (LWIP generally isn't thread-safe)
bool LockLWIP()
{
if (lwipLocked)
return false;
lwipLocked = true;
return true;
}
void UnlockLWIP()
{
lwipLocked = false;
}
// Callback functions for the EMAC driver and for LwIP
// Callback to report when the network interface has gone up or down.
// Note that this is only a rough indicator and may not be called when
// the IP address is changed on-the-fly!
static void ethernet_status_callback(struct netif *netif)
{
if (netif_is_up(netif))
{
char ip[16];
ipaddr_ntoa_r(&(netif->ip_addr), ip, sizeof(ip));
reprap.GetPlatform()->MessageF(HOST_MESSAGE, "Network up, IP=%s\n", ip);
}
else
{
reprap.GetPlatform()->Message(HOST_MESSAGE, "Network down\n");
}
}
// Called from ISR
static void ethernet_rx_callback(uint32_t ul_status)
{
// Because the LWIP stack can become corrupted if we work with it in parallel,
// we may have to wait for the next Spin() call to read the next packet.
if (LockLWIP())
{
ethernet_task();
UnlockLWIP();
}
else
{
ethernet_set_rx_callback(nullptr);
reprap.GetNetwork()->ResetCallback();
}
}
// Callback functions for LWIP (may be called from ISR)
static void conn_err(void *arg, err_t err)
{
// Report the error to the monitor
reprap.GetPlatform()->MessageF(HOST_MESSAGE, "Network: Connection error, code %d\n", err);
// Tell the higher levels about the error
ConnectionState *cs = (ConnectionState*)arg;
if (cs != nullptr)
{
cs->isTerminated = true;
reprap.GetNetwork()->ConnectionClosed(cs, false);
}
}
static err_t conn_recv(void *arg, tcp_pcb *pcb, pbuf *p, err_t err)
{
ConnectionState *cs = (ConnectionState*)arg;
if (err == ERR_OK && cs != nullptr)
{
if (cs->pcb != pcb)
{
reprap.GetPlatform()->Message(HOST_MESSAGE, "Network: Mismatched pcb in conn_recv!\n");
tcp_abort(pcb);
return ERR_ABRT;
}
bool processingOk = true;
if (p != nullptr)
{
// Tell higher levels that we are receiving data
processingOk = reprap.GetNetwork()->ReceiveInput(p, cs);
}
else
{
// Tell higher levels that a connection has been closed
processingOk = reprap.GetNetwork()->ConnectionClosedGracefully(cs);
}
if (!processingOk)
{
// Something went wrong, discard whatever has been received
if (p != nullptr)
{
pbuf_free(p);
}
// Also reset the connection. This will call conn_err() too
tcp_abort(pcb);
return ERR_ABRT;
}
}
return ERR_OK;
}
static err_t conn_accept(void *arg, tcp_pcb *pcb, err_t err)
{
LWIP_UNUSED_ARG(arg);
LWIP_UNUSED_ARG(err);
// Keep the listening PCBs running
tcp_pcb *targetPcb = nullptr;
for (size_t i = 0; i < NumProtocols && targetPcb == nullptr; ++i)
{
if (pcbs[i] != nullptr && pcb->local_port == portNumbers[i])
{
targetPcb = pcbs[i];
}
}
if (targetPcb == nullptr && ftp_pasv_pcb != nullptr && pcb->local_port == ftp_pasv_pcb->local_port)
{
targetPcb = ftp_pasv_pcb;
}
if (targetPcb != nullptr)
{
// Allocate a new ConnectionState for this connection
ConnectionState *cs = reprap.GetNetwork()->ConnectionAccepted(pcb);
if (cs != nullptr)
{
tcp_accepted(targetPcb);
tcp_arg(pcb, cs); // tell LWIP that this is the structure we wish to be passed for our callbacks
tcp_recv(pcb, conn_recv); // tell LWIP that we wish to be informed of incoming data by a call to the conn_recv() function
tcp_err(pcb, conn_err);
return ERR_OK;
}
}
tcp_abort(pcb);
return ERR_ABRT;
}
} // end extern "C"
//***************************************************************************************************
// Network/Ethernet class
Network::Network(Platform* p) :
platform(p), freeTransactions(nullptr), readyTransactions(nullptr), writingTransactions(nullptr),
state(NetworkInactive), isEnabled(true), resetCallback(false),
dataCs(nullptr), ftpCs(nullptr), telnetCs(nullptr), freeConnections(nullptr)
{
}
void Network::Init()
{
for (size_t i = 0; i < NETWORK_TRANSACTION_COUNT; i++)
{
freeTransactions = new NetworkTransaction(freeTransactions);
}
for (size_t i = 0; i < MEMP_NUM_TCP_PCB; i++)
{
ConnectionState *cs = new ConnectionState;
cs->next = freeConnections;
freeConnections = cs;
}
strcpy(hostname, HOSTNAME);
init_ethernet();
netbios_init();
longWait = platform->Time();
}
void Network::EnableProtocol(int protocol, int port, int secure, StringRef& reply)
{
if (secure != 0 && secure != -1)
{
reply.copy("Error: this firmware does not support TLS");
}
else if (protocol >= 0 && protocol < (int)NumProtocols)
{
const Port portToUse = (port < 0) ? DefaultPortNumbers[protocol] : port;
if (portToUse != portNumbers[protocol])
{
// We need to shut down and restart the protocol if it is active because the port number has changed
ShutdownProtocol(protocol);
protocolEnabled[protocol] = false;
}
portNumbers[protocol] = portToUse;
if (!protocolEnabled[protocol])
{
protocolEnabled[protocol] = true;
StartProtocol(protocol);
if (state == NetworkActive)
{
DoMdnsAnnounce();
}
}
ReportOneProtocol(protocol, reply);
}
else
{
reply.copy("Invalid protocol parameter");
}
}
void Network::DisableProtocol(int protocol, StringRef& reply)
{
if (protocol >= 0 && protocol < (int)NumProtocols)
{
ShutdownProtocol(protocol);
protocolEnabled[protocol] = false;
ReportOneProtocol(protocol, reply);
}
else
{
reply.copy("Invalid protocol parameter");
}
}
void Network::StartProtocol(size_t protocol)
{
if (pcbs[protocol] == nullptr)
{
tcp_pcb* pcb = tcp_new();
tcp_bind(pcb, IP_ADDR_ANY, portNumbers[protocol]);
pcbs[protocol] = tcp_listen(pcb);
tcp_accept(pcbs[protocol], conn_accept);
}
}
void Network::ShutdownProtocol(size_t protocol)
{
if (pcbs[protocol] != nullptr)
{
tcp_close(pcbs[protocol]);
pcbs[protocol] = nullptr;
}
}
// Report the protocols and ports in use
void Network::ReportProtocols(StringRef& reply) const
{
reply.Clear();
for (size_t i = 0; i < NumProtocols; ++i)
{
if (i != 0)
{
reply.cat('\n');
}
ReportOneProtocol(i, reply);
}
}
void Network::ReportOneProtocol(size_t protocol, StringRef& reply) const
{
if (protocolEnabled[protocol])
{
reply.catf("%s is enabled on port %u", ProtocolNames[protocol], portNumbers[protocol]);
}
else
{
reply.catf("%s is disabled", ProtocolNames[protocol]);
}
}
void Network::DoMdnsAnnounce()
{
// Fill in the table of services
size_t numServices = NumMdnsFixedProtocols;
for (size_t i = 0; i < NumProtocols; ++i)
{
if (protocolEnabled[i])
{
mdns_services[numServices].name = MdnsServiceStrings[i];
mdns_services[numServices].port = portNumbers[i];
++numServices;
}
}
// We have patched mdns_responder_init so that it can be called more than once
mdns_responder_init(mdns_services, numServices, mdns_txt_records);
mdns_announce();
}
void Network::Spin(bool full)
{
if (LockLWIP()) // basically we can't do anything if we can't interact with LWIP
{
if (state == NetworkObtainingIP || state == NetworkActive)
{
// Is the link still up?
if (!ethernet_link_established())
{
state = NetworkEstablishingLink;
UnlockLWIP();
platform->ClassReport(longWait);
return;
}
// See if we can read any packets. They may include DHCP responses too
ethernet_task();
if (resetCallback)
{
resetCallback = false;
ethernet_set_rx_callback(ðernet_rx_callback);
}
// See if we can send anything - only if full spin i.e. not in the middle of file i/o
if (full)
{
// Have we obtained a valid IP address yet?
if (state == NetworkObtainingIP)
{
const uint8_t * const ip = ethernet_get_ipaddress();
if (ip[0] != 0 && ip[1] != 0 && ip[2] != 0 && ip[3] != 0)
{
// Yes - we're good to go now
state = NetworkActive;
for (size_t i = 0; i < NumProtocols; ++i)
{
if (protocolEnabled[i])
{
StartProtocol(i);
}
}
// Send mDNS announcement so that some routers can perform hostname mapping
// if the board is connected via a non-IGMP capable WiFi bridge (like the TP-Link WR701N)
DoMdnsAnnounce();
}
}
NetworkTransaction *transaction = writingTransactions;
if (transaction != nullptr && sendingConnection == nullptr)
{
if (transaction->next != nullptr)
{
// Data is supposed to be sent and the last packet has been acknowledged.
// Rotate the transactions so every client is served even while multiple files are sent
NetworkTransaction *next = transaction->next;
writingTransactions = next;
AppendTransaction(&writingTransactions, transaction);
transaction = next;
}
if (transaction->Send())
{
// This transaction can be released, do this here
writingTransactions = transaction->next;
PrependTransaction(&freeTransactions, transaction);
// If there is more data to write on this connection, do it sometime soon
NetworkTransaction *nextWrite = transaction->nextWrite;
if (nextWrite != nullptr)
{
PrependTransaction(&writingTransactions, nextWrite);
}
}
}
}
}
else if (state == NetworkEstablishingLink && ethernet_establish_link())
{
if (!ethernetStarted)
{
start_ethernet(platform->GetIPAddress(), platform->NetMask(), platform->GateWay(), ðernet_status_callback);
ethernetStarted = true;
}
else
{
ethernet_set_configuration(platform->GetIPAddress(), platform->NetMask(), platform->GateWay());
}
state = NetworkObtainingIP;
}
UnlockLWIP();
}
platform->ClassReport(longWait);
}
void Network::Interrupt()
{
if (state != NetworkInactive && LockLWIP())
{
ethernet_timers_update();
UnlockLWIP();
}
}
void Network::Diagnostics(MessageType mtype)
{
platform->Message(mtype, "=== Network ===\n");
size_t numFreeConnections = 0;
ConnectionState *freeConn = freeConnections;
while (freeConn != nullptr)
{
numFreeConnections++;
freeConn = freeConn->next;
}
platform->MessageF(mtype, "Free connections: %d of %d\n", numFreeConnections, MEMP_NUM_TCP_PCB);
size_t numFreeTransactions = 0;
NetworkTransaction *freeTrans = freeTransactions;
while (freeTrans != nullptr)
{
numFreeTransactions++;
freeTrans = freeTrans->next;
}
platform->MessageF(mtype, "Free transactions: %d of %d\n", numFreeTransactions, NETWORK_TRANSACTION_COUNT);
#if LWIP_STATS
// Normally we should NOT try to display LWIP stats here, because it uses debugPrintf(), which will hang the system if no USB cable is connected.
if (reprap.Debug(moduleNetwork))
{
stats_display();
}
#endif
}
void Network::ResetCallback()
{
resetCallback = true;
}
// Called when data has been received. Return false if we cannot process it
bool Network::ReceiveInput(pbuf *pb, ConnectionState* cs)
{
NetworkTransaction* r = freeTransactions;
if (r == nullptr)
{
platform->Message(HOST_MESSAGE, "Network::ReceiveInput() - no free transactions!\n");
return false;
}
freeTransactions = r->next;
r->Set(pb, cs, receiving);
AppendTransaction(&readyTransactions, r);
// debugPrintf("Network - input received\n");
return true;
}
// This is called when a connection is being established and returns an initialised ConnectionState instance
// or NULL if no more items are available. This would reset the connection immediately
ConnectionState *Network::ConnectionAccepted(tcp_pcb *pcb)
{
ConnectionState *cs = freeConnections;
if (cs == nullptr)
{
platform->Message(HOST_MESSAGE, "Network::ConnectionAccepted() - no free ConnectionStates!\n");
return nullptr;
}
NetworkTransaction* transaction = freeTransactions;
if (transaction == nullptr)
{
platform->Message(HOST_MESSAGE, "Network::ConnectionAccepted() - no free transactions!\n");
return nullptr;
}
// Initialise a new connection
freeConnections = cs->next;
cs->Init(pcb);
// Notify the webserver about this
transaction->Set(nullptr, cs, connected);
freeTransactions = transaction->next;
AppendTransaction(&readyTransactions, transaction);
return cs;
}
// This is called when a connection is being closed or has gone down unexpectedly
void Network::ConnectionClosed(ConnectionState* cs, bool closeConnection)
{
// Make sure these connections are not reused. Remove all references to it
if (cs == dataCs)
{
// FTP data connection
dataCs = nullptr;
if (closingDataPort && ftp_pasv_pcb != nullptr)
{
tcp_accept(ftp_pasv_pcb, nullptr);
tcp_close(ftp_pasv_pcb);
ftp_pasv_pcb = nullptr;
}
closingDataPort = false;
}
if (cs == ftpCs)
{
// Main FTP connection
ftpCs = nullptr;
}
if (cs == telnetCs)
{
telnetCs = nullptr;
}
if (cs == sendingConnection)
{
// Stop sending if the connection is going down
sendingConnection = nullptr;
}
// Remove all callbacks and close the PCB if requested
tcp_pcb *pcb = cs->pcb;
tcp_sent(pcb, nullptr);
tcp_recv(pcb, nullptr);
tcp_poll(pcb, nullptr, TCP_WRITE_TIMEOUT / TCP_SLOW_INTERVAL / TCP_MAX_SEND_RETRIES);
if (pcb != nullptr && closeConnection)
{
tcp_err(pcb, nullptr);
tcp_close(pcb);
}
cs->pcb = nullptr;
// Inform the Webserver that we are about to remove an existing connection
reprap.GetWebserver()->ConnectionLost(cs);
// Remove all transactions that point to cs from the list of ready transactions
NetworkTransaction *previous = nullptr, *item = readyTransactions;
while (item != nullptr)
{
if (item->cs == cs)
{
item->Discard();
item = (previous == nullptr) ? readyTransactions : previous->next;
}
else
{
previous = item;
item = item->next;
}
}
// Do the same for the writing transaction. There is only one transaction on writingTransactions
// per connection and cs->sendingTransaction points to it. Check if we have to free it here
NetworkTransaction *sendingTransaction = cs->sendingTransaction;
if (sendingTransaction != nullptr)
{
// Take care of other transactions that want to write data over the closed connection too
NetworkTransaction *nextWrite = sendingTransaction->nextWrite;
while (nextWrite != nullptr)
{
NetworkTransaction *temp = nextWrite;
nextWrite = nextWrite->nextWrite;
temp->Discard();
}
// Unlink the sending transaction from the writing transactions
previous = nullptr;
for(item = writingTransactions; item != nullptr; item = item->next)
{
if (item == sendingTransaction)
{
if (previous == nullptr)
{
writingTransactions = item->next;
}
else
{
previous->next = item->next;
}
break;
}
previous = item;
}
// Discard it. This will add it back to the list of free transactions too
sendingTransaction->Discard();
}
// Free up this cs again
cs->next = freeConnections;
freeConnections = cs;
}
// This enqueues a new transaction to indicate a graceful reset. Do this to keep the time line of incoming transactions valid.
// Return false if we cannot process this event, which would result in an immediate connection reset
bool Network::ConnectionClosedGracefully(ConnectionState *cs)
{
// We need a valid transaction to do something.
// If that fails, the connection will be reset and the error handler will take care of this connection
NetworkTransaction *transaction = freeTransactions;
if (transaction == nullptr)
{
platform->Message(HOST_MESSAGE, "Network::ConnectionClosedGracefully() - no free transactions!\n");
return false;
}
// Invalidate the PCB
tcp_sent(cs->pcb, nullptr);
tcp_recv(cs->pcb, nullptr);
tcp_poll(cs->pcb, nullptr, TCP_WRITE_TIMEOUT / TCP_SLOW_INTERVAL / TCP_MAX_SEND_RETRIES);
tcp_err(cs->pcb, nullptr);
tcp_close(cs->pcb);
cs->pcb = nullptr;
// Close the sending transaction (if any)
NetworkTransaction *sendingTransaction = cs->sendingTransaction;
if (sendingTransaction != nullptr)
{
sendingTransaction->Close();
}
// Notify the webserver about this event
freeTransactions = transaction->next;
transaction->Set(nullptr, cs, disconnected);
AppendTransaction(&readyTransactions, transaction);
return true;
}
bool Network::Lock()
{
return LockLWIP();
}
void Network::Unlock()
{
UnlockLWIP();
}
bool Network::InLwip() const
{
return lwipLocked;
}
const uint8_t *Network::GetIPAddress() const
{
return ethernet_get_ipaddress();
}
void Network::SetIPAddress(const uint8_t ipAddress[], const uint8_t netmask[], const uint8_t gateway[])
{
if (state == NetworkObtainingIP || state == NetworkActive)
{
// This performs IP changes on-the-fly
ethernet_set_configuration(ipAddress, netmask, gateway);
}
}
// Set the network hostname. Removes all whitespaces and converts the name to lower-case.
void Network::SetHostname(const char *name)
{
size_t i = 0;
while (*name && i < ARRAY_UPB(hostname))
{
char c = *name++;
if (c >= 'A' && c <= 'Z')
{
c += 'a' - 'A';
}
if ((c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || (c == '-') || (c == '_'))
{
hostname[i++] = c;
}
}
if (i > 0)
{
hostname[i] = 0;
}
else
{
// Don't allow empty hostnames
strcpy(hostname, HOSTNAME);
}
if (state == NetworkActive)
{
mdns_update_hostname();
}
}
void Network::Enable()
{
if (state == NetworkInactive)
{
if (!ethernetStarted)
{
// Allow the MAC address to be set only before LwIP is started...
ethernet_configure_interface(platform->MACAddress(), hostname);
}
resetCallback = true; // Reset EMAC RX callback on next Spin calls
state = NetworkEstablishingLink;
isEnabled = true;
}
}
void Network::Disable()
{
if (state != NetworkInactive)
{
for (size_t i = 0; i < NumProtocols; ++i)
{
ShutdownProtocol(i);
}
resetCallback = false;
ethernet_set_rx_callback(nullptr);
state = NetworkInactive;
isEnabled = false;
}
}
// This is called by the web server to get the next networking transaction.
//
// If cs is NULL, the transaction from the head of readyTransactions will be retrieved.
// If cs is not NULL, the first transaction with the matching connection will be returned.
//
// This method also ensures that the retrieved transaction is moved to the first item of
// readyTransactions, so that a subsequent call with a NULL cs parameter will return exactly
// the same instance.
NetworkTransaction *Network::GetTransaction(const ConnectionState *cs)
{
// See if there is any transaction at all
NetworkTransaction *transaction = readyTransactions;
if (transaction == nullptr)
{
return nullptr;
}
// If no specific connection is specified or if the first item already matches the
// connection we are looking for, just return it
if (cs == nullptr || transaction->GetConnection() == cs)
{
return transaction;
}
// We are looking for a specific transaction, but it's not the first item.
// Search for it and move it to the head of readyTransactions
NetworkTransaction *previous = transaction;
for(NetworkTransaction *item = transaction->next; item != nullptr; item = item->next)
{
if (item->GetConnection() == cs)
{
previous->next = item->next;
item->next = readyTransactions;
readyTransactions = item;
return item;
}
previous = item;
}
// We failed to find a valid transaction for the given connection
return nullptr;
}
void Network::AppendTransaction(NetworkTransaction* volatile* list, NetworkTransaction *r)
{
r->next = nullptr;
while (*list != nullptr)
{
list = &((*list)->next);
}
*list = r;
}
void Network::PrependTransaction(NetworkTransaction* volatile* list, NetworkTransaction *r)
{
r->next = *list;
*list = r;
}
Port Network::GetHttpPort()
{
return portNumbers[HttpProtocolIndex];
}
Port Network::GetFtpPort()
{
return portNumbers[FtpProtocolIndex];
}
Port Network::GetTelnetPort()
{
return portNumbers[TelnetProtocolIndex];
}
Port Network::GetDataPort()
{
return (closingDataPort || ftp_pasv_pcb == nullptr) ? 0 : ftp_pasv_pcb->local_port;
}
void Network::OpenDataPort(Port port)
{
closingDataPort = false;
tcp_pcb* pcb = tcp_new();
tcp_bind(pcb, IP_ADDR_ANY, port);
ftp_pasv_pcb = tcp_listen(pcb);
tcp_accept(ftp_pasv_pcb, conn_accept);
}
// Close FTP data port and purge associated PCB
void Network::CloseDataPort()
{
// See if it's already being closed
if (closingDataPort)
{
return;
}
closingDataPort = true;
// Close remote connection of our data port or do it as soon as the last packet has been sent
if (dataCs != nullptr)
{
NetworkTransaction *mySendingTransaction = dataCs->sendingTransaction;
if (mySendingTransaction != nullptr)
{
mySendingTransaction->Close();
return;
}
}
// We can close it now, so do it here
if (ftp_pasv_pcb != nullptr)
{
tcp_accept(ftp_pasv_pcb, nullptr);
tcp_close(ftp_pasv_pcb);
ftp_pasv_pcb = nullptr;
}
closingDataPort = false;
}
// These methods keep track of our connections in case we need to send to one of them
void Network::SaveDataConnection()
{
dataCs = readyTransactions->cs;
}
void Network::SaveFTPConnection()
{
ftpCs = readyTransactions->cs;
}
void Network::SaveTelnetConnection()
{
telnetCs = readyTransactions->cs;
}
bool Network::AcquireFTPTransaction()
{
return AcquireTransaction(ftpCs);
}
bool Network::AcquireDataTransaction()
{
return AcquireTransaction(dataCs);
}
bool Network::AcquireTelnetTransaction()
{
return AcquireTransaction(telnetCs);
}
// Retrieves the NetworkTransaction of a sending connection to which data can be appended to,
// or prepares a released NetworkTransaction, which can easily be sent via Commit().
bool Network::AcquireTransaction(ConnectionState *cs)
{
// Make sure we have a valid connection
if (cs == nullptr)
{
return false;
}
// Does the head of ready transaction already belong to cs and was it acquired before?
NetworkTransaction *currentTransaction = readyTransactions;
if (currentTransaction != nullptr && currentTransaction->GetConnection() == cs &&
currentTransaction->GetStatus() == acquired)
{
// Yes - don't look for another one
return true;
}
// No - try to allocate a free one
NetworkTransaction *acquiredTransaction = freeTransactions;
if (acquiredTransaction == nullptr)
{
platform->Message(HOST_MESSAGE, "Network: Could not acquire free transaction!\n");
return false;
}
freeTransactions = acquiredTransaction->next;
acquiredTransaction->Set(nullptr, cs, acquired);
PrependTransaction(&readyTransactions, acquiredTransaction);
return true;
}
/*static*/ Port Network::GetLocalPort(Connection conn) { return conn->GetLocalPort(); }
/*static*/ Port Network::GetRemotePort(Connection conn) { return conn->GetRemotePort(); }
/*static*/ uint32_t Network::GetRemoteIP(Connection conn) { return conn->GetRemoteIP(); }
/*static*/ bool Network::IsConnected(Connection conn) { return conn->IsConnected(); }
/*static*/ bool Network::IsTerminated(Connection conn) { return conn->IsTerminated(); }
/*static*/ void Network::Terminate(Connection conn) { conn->Terminate(); }
// End
|