]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Network/Tcp4Dxe/SockImpl.c
Import SnpDxe, Tcp4Dxe, Udp4Dxe and MnpDxe.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / SockImpl.c
CommitLineData
8a67d61d 1/** @file\r
2\r
3Copyright (c) 2005 - 2006, Intel Corporation\r
4All rights reserved. This program and the accompanying materials\r
5are licensed and made available under the terms and conditions of the BSD License\r
6which accompanies this distribution. The full text of the license may be found at\r
7http://opensource.org/licenses/bsd-license.php\r
8\r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
11\r
12Module Name:\r
13\r
14 SockImpl.c\r
15\r
16Abstract:\r
17\r
18\r
19**/\r
20\r
21#include "SockImpl.h"\r
22\r
23STATIC\r
24UINT32\r
25SockTcpDataToRcv (\r
26 IN SOCK_BUFFER *SockBuffer,\r
27 OUT BOOLEAN *IsOOB,\r
28 IN UINT32 BufLen\r
29 );\r
30\r
31STATIC\r
32VOID\r
33SockProcessSndToken (\r
34 IN SOCKET *Sock\r
35 );\r
36\r
37VOID\r
38SockFreeFoo (\r
39 IN EFI_EVENT Event\r
40 )\r
41{\r
42 return ;\r
43}\r
44\r
45\r
46/**\r
47 Get the length of the data that can be retrieved from the socket\r
48 receive buffer.\r
49\r
50 @param SockBuffer Pointer to the socket receive buffer.\r
51 @param IsUrg Pointer to a BOOLEAN variable. If TRUE the data is\r
52 OOB.\r
53 @param BufLen The maximum length of the data buffer to store the\r
54 received data in socket layer.\r
55\r
56 @return The length of the data can be retreived.\r
57\r
58**/\r
59STATIC\r
60UINT32\r
61SockTcpDataToRcv (\r
62 IN SOCK_BUFFER *SockBuffer,\r
63 OUT BOOLEAN *IsUrg,\r
64 IN UINT32 BufLen\r
65 )\r
66{\r
67 NET_BUF *RcvBufEntry;\r
68 UINT32 DataLen;\r
69 TCP_RSV_DATA *TcpRsvData;\r
70 BOOLEAN Urg;\r
71\r
72 ASSERT (SockBuffer && IsUrg && (BufLen > 0));\r
73\r
74 RcvBufEntry = SockBufFirst (SockBuffer);\r
75 ASSERT (RcvBufEntry);\r
76\r
77 TcpRsvData = (TCP_RSV_DATA *) RcvBufEntry->ProtoData;\r
78\r
79 *IsUrg = ((TcpRsvData->UrgLen > 0) ? TRUE : FALSE);\r
80\r
81 if (*IsUrg && TcpRsvData->UrgLen < RcvBufEntry->TotalSize) {\r
82\r
83 DataLen = NET_MIN (TcpRsvData->UrgLen, BufLen);\r
84\r
85 if (DataLen < TcpRsvData->UrgLen) {\r
86 TcpRsvData->UrgLen = TcpRsvData->UrgLen - DataLen;\r
87 } else {\r
88 TcpRsvData->UrgLen = 0;\r
89 }\r
90\r
91 return DataLen;\r
92\r
93 }\r
94\r
95 DataLen = RcvBufEntry->TotalSize;\r
96\r
97 RcvBufEntry = SockBufNext (SockBuffer, RcvBufEntry);\r
98\r
99 while ((BufLen > DataLen) && (RcvBufEntry != NULL)) {\r
100\r
101 TcpRsvData = (TCP_RSV_DATA *) RcvBufEntry->ProtoData;\r
102\r
103 Urg = ((TcpRsvData->UrgLen > 0) ? TRUE : FALSE);\r
104\r
105 if (*IsUrg != Urg) {\r
106 break;\r
107 }\r
108\r
109 if (*IsUrg && TcpRsvData->UrgLen < RcvBufEntry->TotalSize) {\r
110\r
111 if (TcpRsvData->UrgLen + DataLen < BufLen) {\r
112 TcpRsvData->UrgLen = 0;\r
113 } else {\r
114 TcpRsvData->UrgLen = TcpRsvData->UrgLen - (BufLen - DataLen);\r
115 }\r
116\r
117 return NET_MIN (TcpRsvData->UrgLen + DataLen, BufLen);\r
118\r
119 }\r
120\r
121 DataLen += RcvBufEntry->TotalSize;\r
122\r
123 RcvBufEntry = SockBufNext (SockBuffer, RcvBufEntry);\r
124 }\r
125\r
126 DataLen = NET_MIN (BufLen, DataLen);\r
127 return DataLen;\r
128}\r
129\r
130\r
131/**\r
132 Copy data from socket buffer to application provided receive buffer.\r
133\r
134 @param Sock Pointer to the socket.\r
135 @param TcpRxData Pointer to the application provided receive buffer.\r
136 @param RcvdBytes The maximum length of the data can be copied.\r
137 @param IsOOB If TURE the data is OOB, else the data is normal.\r
138\r
139 @return None.\r
140\r
141**/\r
142VOID\r
143SockSetTcpRxData (\r
144 IN SOCKET *Sock,\r
145 IN VOID *TcpRxData,\r
146 IN UINT32 RcvdBytes,\r
147 IN BOOLEAN IsOOB\r
148 )\r
149{\r
150 UINT32 Index;\r
151 UINT32 CopyBytes;\r
152 UINT32 OffSet;\r
153 EFI_TCP4_RECEIVE_DATA *RxData;\r
154 EFI_TCP4_FRAGMENT_DATA *Fragment;\r
155\r
156 RxData = (EFI_TCP4_RECEIVE_DATA *) TcpRxData;\r
157\r
158 OffSet = 0;\r
159\r
160 ASSERT (RxData->DataLength >= RcvdBytes);\r
161\r
162 RxData->DataLength = RcvdBytes;\r
163 RxData->UrgentFlag = IsOOB;\r
164\r
165 for (Index = 0; (Index < RxData->FragmentCount) && (RcvdBytes > 0); Index++) {\r
166\r
167 Fragment = &RxData->FragmentTable[Index];\r
168 CopyBytes = NET_MIN (Fragment->FragmentLength, RcvdBytes);\r
169\r
170 NetbufQueCopy (\r
171 Sock->RcvBuffer.DataQueue,\r
172 OffSet,\r
173 CopyBytes,\r
174 Fragment->FragmentBuffer\r
175 );\r
176\r
177 Fragment->FragmentLength = CopyBytes;\r
178 RcvdBytes -= CopyBytes;\r
179 OffSet += CopyBytes;\r
180 }\r
181}\r
182\r
183\r
184/**\r
185 Get received data from the socket layer to the receive token.\r
186\r
187 @param Sock Pointer to the socket.\r
188 @param RcvToken Pointer to the application provided receive token.\r
189\r
190 @return The length of data received in this token.\r
191\r
192**/\r
193UINT32\r
194SockProcessRcvToken (\r
195 IN SOCKET *Sock,\r
196 IN SOCK_IO_TOKEN *RcvToken\r
197 )\r
198{\r
199 UINT32 TokenRcvdBytes;\r
200 EFI_TCP4_RECEIVE_DATA *RxData;\r
201 BOOLEAN IsUrg;\r
202\r
203 ASSERT (Sock);\r
204\r
205 ASSERT (SOCK_STREAM == Sock->Type);\r
206\r
207 RxData = RcvToken->Packet.RxData;\r
208\r
209 TokenRcvdBytes = SockTcpDataToRcv (\r
210 &Sock->RcvBuffer,\r
211 &IsUrg,\r
212 RxData->DataLength\r
213 );\r
214\r
215 //\r
216 // Copy data from RcvBuffer of socket to user\r
217 // provided RxData and set the fields in TCP RxData\r
218 //\r
219 SockSetTcpRxData (Sock, RxData, TokenRcvdBytes, IsUrg);\r
220\r
221 SOCK_TRIM_RCV_BUFF (Sock, TokenRcvdBytes);\r
222 SIGNAL_TOKEN (&(RcvToken->Token), EFI_SUCCESS);\r
223\r
224 return TokenRcvdBytes;\r
225}\r
226\r
227\r
228/**\r
229 Process the TCP send data, buffer the tcp txdata and append\r
230 the buffer to socket send buffer,then try to send it.\r
231\r
232 @param Sock Pointer to the socket.\r
233 @param TcpTxData Pointer to the tcp txdata.\r
234\r
235 @retval EFI_SUCCESS The operation is completed successfully.\r
236 @retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r
237\r
238**/\r
239EFI_STATUS\r
240SockProcessTcpSndData (\r
241 IN SOCKET *Sock,\r
242 IN VOID *TcpTxData\r
243 )\r
244{\r
245 NET_BUF *SndData;\r
246 EFI_STATUS Status;\r
247 EFI_TCP4_TRANSMIT_DATA *TxData;\r
248\r
249 TxData = (EFI_TCP4_TRANSMIT_DATA *) TcpTxData;\r
250\r
251 //\r
252 // transform this TxData into a NET_BUFFER\r
253 // and insert it into Sock->SndBuffer\r
254 //\r
255 SndData = NetbufFromExt (\r
256 (NET_FRAGMENT *) TxData->FragmentTable,\r
257 TxData->FragmentCount,\r
258 0,\r
259 0,\r
260 SockFreeFoo,\r
261 NULL\r
262 );\r
263\r
264 if (NULL == SndData) {\r
265 SOCK_DEBUG_ERROR (("SockKProcessSndData: Failed to"\r
266 " call NetBufferFromExt\n"));\r
267\r
268 return EFI_OUT_OF_RESOURCES;\r
269 }\r
270\r
271 NetbufQueAppend (Sock->SndBuffer.DataQueue, SndData);\r
272\r
273 //\r
274 // notify the low layer protocol to handle this send token\r
275 //\r
276 if (TxData->Urgent) {\r
277 Status = Sock->ProtoHandler (Sock, SOCK_SNDURG, NULL);\r
278\r
279 if (EFI_ERROR (Status)) {\r
280 return Status;\r
281 }\r
282 }\r
283\r
284 if (TxData->Push) {\r
285 Status = Sock->ProtoHandler (Sock, SOCK_SNDPUSH, NULL);\r
286\r
287 if (EFI_ERROR (Status)) {\r
288 return Status;\r
289 }\r
290 }\r
291\r
292 //\r
293 // low layer protocol should really handle the sending\r
294 // process when catching SOCK_SND request\r
295 //\r
296 Status = Sock->ProtoHandler (Sock, SOCK_SND, NULL);\r
297\r
298 if (EFI_ERROR (Status)) {\r
299 return Status;\r
300 }\r
301\r
302 return EFI_SUCCESS;\r
303}\r
304\r
305\r
306/**\r
307 Flush the tokens in the specific token list.\r
308\r
309 @param Sock Pointer to the socket.\r
310 @param PendingTokenList Pointer to the token list to be flushed.\r
311\r
312 @return None.\r
313\r
314**/\r
315STATIC\r
316VOID\r
317SockFlushPendingToken (\r
318 IN SOCKET *Sock,\r
319 IN NET_LIST_ENTRY *PendingTokenList\r
320 )\r
321{\r
322 SOCK_TOKEN *SockToken;\r
323 SOCK_COMPLETION_TOKEN *Token;\r
324\r
325 ASSERT (Sock && PendingTokenList);\r
326\r
327 while (!NetListIsEmpty (PendingTokenList)) {\r
328 SockToken = NET_LIST_HEAD (\r
329 PendingTokenList,\r
330 SOCK_TOKEN,\r
331 TokenList\r
332 );\r
333\r
334 Token = SockToken->Token;\r
335 SIGNAL_TOKEN (Token, Sock->SockError);\r
336\r
337 NetListRemoveEntry (&(SockToken->TokenList));\r
338 NetFreePool (SockToken);\r
339 }\r
340}\r
341\r
342\r
343/**\r
344 Wake up the connection token while the connection is\r
345 successfully established, then try to process any\r
346 pending send token.\r
347\r
348 @param Sock Pointer to the socket.\r
349\r
350 @return None.\r
351\r
352**/\r
353STATIC\r
354VOID\r
355SockWakeConnToken (\r
356 IN SOCKET *Sock\r
357 )\r
358{\r
359 ASSERT (Sock->ConnectionToken != NULL);\r
360\r
361 SIGNAL_TOKEN (Sock->ConnectionToken, EFI_SUCCESS);\r
362 Sock->ConnectionToken = NULL;\r
363\r
364 //\r
365 // check to see if some pending send token existed?\r
366 //\r
367 SockProcessSndToken (Sock);\r
368 return ;\r
369}\r
370\r
371\r
372/**\r
373 Wake up the listen token while the connection is\r
374 established successfully.\r
375\r
376 @param Sock Pointer to the socket.\r
377\r
378 @return None.\r
379\r
380**/\r
381STATIC\r
382VOID\r
383SockWakeListenToken (\r
384 IN SOCKET *Sock\r
385 )\r
386{\r
387 SOCKET *Parent;\r
388 SOCK_TOKEN *SockToken;\r
389 EFI_TCP4_LISTEN_TOKEN *ListenToken;\r
390\r
391 Parent = Sock->Parent;\r
392\r
393 ASSERT (Parent && SOCK_IS_LISTENING (Parent) && SOCK_IS_CONNECTED (Sock));\r
394\r
395 if (!NetListIsEmpty (&Parent->ListenTokenList)) {\r
396 SockToken = NET_LIST_HEAD (\r
397 &Parent->ListenTokenList,\r
398 SOCK_TOKEN,\r
399 TokenList\r
400 );\r
401\r
402 ListenToken = (EFI_TCP4_LISTEN_TOKEN *) SockToken->Token;\r
403 ListenToken->NewChildHandle = Sock->SockHandle;\r
404\r
405 SIGNAL_TOKEN (&(ListenToken->CompletionToken), EFI_SUCCESS);\r
406\r
407 NetListRemoveEntry (&SockToken->TokenList);\r
408 NetFreePool (SockToken);\r
409\r
410 NetListRemoveEntry (&Sock->ConnectionList);\r
411\r
412 Parent->ConnCnt--;\r
413 SOCK_DEBUG_WARN (("SockWakeListenToken: accept a socket,"\r
414 "now conncnt is %d", Parent->ConnCnt));\r
415\r
416 Sock->Parent = NULL;\r
417 }\r
418}\r
419\r
420\r
421/**\r
422 Wake up the receive token while some data is received.\r
423\r
424 @param Sock Pointer to the socket.\r
425\r
426 @return None.\r
427\r
428**/\r
429STATIC\r
430VOID\r
431SockWakeRcvToken (\r
432 IN SOCKET *Sock\r
433 )\r
434{\r
435 UINT32 RcvdBytes;\r
436 UINT32 TokenRcvdBytes;\r
437 SOCK_TOKEN *SockToken;\r
438 SOCK_IO_TOKEN *RcvToken;\r
439\r
440 ASSERT (Sock->RcvBuffer.DataQueue);\r
441\r
442 RcvdBytes = (Sock->RcvBuffer.DataQueue)->BufSize;\r
443\r
444 ASSERT (RcvdBytes > 0);\r
445\r
446 while (RcvdBytes > 0 && !NetListIsEmpty (&Sock->RcvTokenList)) {\r
447\r
448 SockToken = NET_LIST_HEAD (\r
449 &Sock->RcvTokenList,\r
450 SOCK_TOKEN,\r
451 TokenList\r
452 );\r
453\r
454 RcvToken = (SOCK_IO_TOKEN *) SockToken->Token;\r
455 TokenRcvdBytes = SockProcessRcvToken (Sock, RcvToken);\r
456\r
457 if (0 == TokenRcvdBytes) {\r
458 return ;\r
459 }\r
460\r
461 NetListRemoveEntry (&(SockToken->TokenList));\r
462 NetFreePool (SockToken);\r
463 RcvdBytes -= TokenRcvdBytes;\r
464 }\r
465}\r
466\r
467\r
468/**\r
469 Process the send token.\r
470\r
471 @param Sock Pointer to the socket.\r
472\r
473 @return None.\r
474\r
475**/\r
476STATIC\r
477VOID\r
478SockProcessSndToken (\r
479 IN SOCKET *Sock\r
480 )\r
481{\r
482 UINT32 FreeSpace;\r
483 SOCK_TOKEN *SockToken;\r
484 UINT32 DataLen;\r
485 SOCK_IO_TOKEN *SndToken;\r
486 EFI_TCP4_TRANSMIT_DATA *TxData;\r
487 EFI_STATUS Status;\r
488\r
489 ASSERT (Sock && (SOCK_STREAM == Sock->Type));\r
490\r
491 FreeSpace = SockGetFreeSpace (Sock, SOCK_SND_BUF);\r
492\r
493 //\r
494 // to determine if process a send token using\r
495 // socket layer flow control policy\r
496 //\r
497 while ((FreeSpace >= Sock->SndBuffer.LowWater) &&\r
498 !NetListIsEmpty (&Sock->SndTokenList)) {\r
499\r
500 SockToken = NET_LIST_HEAD (\r
501 &(Sock->SndTokenList),\r
502 SOCK_TOKEN,\r
503 TokenList\r
504 );\r
505\r
506 //\r
507 // process this token\r
508 //\r
509 NetListRemoveEntry (&(SockToken->TokenList));\r
510 NetListInsertTail (\r
511 &(Sock->ProcessingSndTokenList),\r
512 &(SockToken->TokenList)\r
513 );\r
514\r
515 //\r
516 // Proceess it in the light of SockType\r
517 //\r
518 SndToken = (SOCK_IO_TOKEN *) SockToken->Token;\r
519 TxData = SndToken->Packet.TxData;\r
520\r
521 DataLen = TxData->DataLength;\r
522 Status = SockProcessTcpSndData (Sock, TxData);\r
523\r
524 if (EFI_ERROR (Status)) {\r
525 goto OnError;\r
526 }\r
527\r
528 if (DataLen >= FreeSpace) {\r
529 FreeSpace = 0;\r
530\r
531 } else {\r
532 FreeSpace -= DataLen;\r
533\r
534 }\r
535 }\r
536\r
537 return ;\r
538\r
539OnError:\r
540\r
541 NetListRemoveEntry (&SockToken->TokenList);\r
542 SIGNAL_TOKEN (SockToken->Token, Status);\r
543 NetFreePool (SockToken);\r
544}\r
545\r
546\r
547/**\r
548 Create a socket with initial data SockInitData.\r
549\r
550 @param SockInitData Pointer to the initial data of the socket.\r
551\r
552 @return Pointer to the newly created socket.\r
553\r
554**/\r
555SOCKET *\r
556SockCreate (\r
557 IN SOCK_INIT_DATA *SockInitData\r
558 )\r
559{\r
560 SOCKET *Sock;\r
561 SOCKET *Parent;\r
562 EFI_STATUS Status;\r
563\r
564 ASSERT (SockInitData && SockInitData->ProtoHandler);\r
565 ASSERT (SockInitData->Type == SOCK_STREAM);\r
566\r
567 Parent = SockInitData->Parent;\r
568\r
569 if (Parent && (Parent->ConnCnt == Parent->BackLog)) {\r
570 SOCK_DEBUG_ERROR (\r
571 ("SockCreate: Socket parent has "\r
572 "reached its connection limit with %d ConnCnt and %d BackLog\n",\r
573 Parent->ConnCnt,\r
574 Parent->BackLog)\r
575 );\r
576\r
577 return NULL;\r
578 }\r
579\r
580 Sock = NetAllocateZeroPool (sizeof (SOCKET));\r
581 if (NULL == Sock) {\r
582\r
583 SOCK_DEBUG_ERROR (("SockCreate: No resource to create a new socket\n"));\r
584 return NULL;\r
585 }\r
586\r
587 NetListInit (&Sock->ConnectionList);\r
588 NetListInit (&Sock->ListenTokenList);\r
589 NetListInit (&Sock->RcvTokenList);\r
590 NetListInit (&Sock->SndTokenList);\r
591 NetListInit (&Sock->ProcessingSndTokenList);\r
592\r
593 NET_LOCK_INIT (&(Sock->Lock));\r
594\r
595 Sock->SndBuffer.DataQueue = NetbufQueAlloc ();\r
596 if (NULL == Sock->SndBuffer.DataQueue) {\r
597 SOCK_DEBUG_ERROR (("SockCreate: No resource to allocate"\r
598 " SndBuffer for new socket\n"));\r
599\r
600 goto OnError;\r
601 }\r
602\r
603 Sock->RcvBuffer.DataQueue = NetbufQueAlloc ();\r
604 if (NULL == Sock->RcvBuffer.DataQueue) {\r
605 SOCK_DEBUG_ERROR (("SockCreate: No resource to allocate "\r
606 "RcvBuffer for new socket\n"));\r
607\r
608 goto OnError;\r
609 }\r
610\r
611 Sock->Signature = SOCK_SIGNATURE;\r
612\r
613 Sock->Parent = Parent;\r
614 Sock->BackLog = SockInitData->BackLog;\r
615 Sock->ProtoHandler = SockInitData->ProtoHandler;\r
616 Sock->SndBuffer.HighWater = SockInitData->SndBufferSize;\r
617 Sock->RcvBuffer.HighWater = SockInitData->RcvBufferSize;\r
618 Sock->Type = SockInitData->Type;\r
619 Sock->DriverBinding = SockInitData->DriverBinding;\r
620 Sock->State = SockInitData->State;\r
621\r
622 Sock->SockError = EFI_ABORTED;\r
623 Sock->SndBuffer.LowWater = SOCK_BUFF_LOW_WATER;\r
624 Sock->RcvBuffer.LowWater = SOCK_BUFF_LOW_WATER;\r
625\r
626 //\r
627 // Install protocol on Sock->SockHandle\r
628 //\r
629 NetCopyMem (\r
630 &(Sock->NetProtocol.TcpProtocol),\r
631 SockInitData->Protocol,\r
632 sizeof (EFI_TCP4_PROTOCOL)\r
633 );\r
634\r
635 Status = gBS->InstallMultipleProtocolInterfaces (\r
636 &Sock->SockHandle,\r
637 &gEfiTcp4ProtocolGuid,\r
638 &(Sock->NetProtocol.TcpProtocol),\r
639 NULL\r
640 );\r
641\r
642 if (EFI_ERROR (Status)) {\r
643 SOCK_DEBUG_ERROR (("SockCreate: Install TCP protocol in "\r
644 "socket failed with %r\n", Status));\r
645\r
646 goto OnError;\r
647 }\r
648\r
649 if (Parent != NULL) {\r
650 ASSERT (Parent->BackLog > 0);\r
651 ASSERT (SOCK_IS_LISTENING (Parent));\r
652\r
653 //\r
654 // need to add it into Parent->ConnectionList\r
655 // if the Parent->ConnCnt < Parent->BackLog\r
656 //\r
657 Parent->ConnCnt++;\r
658\r
659 SOCK_DEBUG_WARN (("SockCreate: Create a new socket and"\r
660 "add to parent, now conncnt is %d\n", Parent->ConnCnt));\r
661\r
662 NetListInsertTail (&Parent->ConnectionList, &Sock->ConnectionList);\r
663 }\r
664\r
665 return Sock;\r
666\r
667OnError:\r
668 if (NULL != Sock) {\r
669\r
670 if (NULL != Sock->SndBuffer.DataQueue) {\r
671 NetbufQueFree (Sock->SndBuffer.DataQueue);\r
672 }\r
673\r
674 if (NULL != Sock->RcvBuffer.DataQueue) {\r
675 NetbufQueFree (Sock->RcvBuffer.DataQueue);\r
676 }\r
677\r
678 NetFreePool (Sock);\r
679 }\r
680\r
681 return NULL;\r
682}\r
683\r
684\r
685/**\r
686 Destroy a socket.\r
687\r
688 @param Sock Pointer to the socket.\r
689\r
690 @return None.\r
691\r
692**/\r
693VOID\r
694SockDestroy (\r
695 IN SOCKET *Sock\r
696 )\r
697{\r
698 VOID *SockProtocol;\r
699 EFI_GUID *ProtocolGuid;\r
700 EFI_STATUS Status;\r
701\r
702 ASSERT (SOCK_STREAM == Sock->Type);\r
703\r
704 //\r
705 // Flush the completion token buffered\r
706 // by sock and rcv, snd buffer\r
707 //\r
708 if (!SOCK_IS_UNCONFIGURED (Sock)) {\r
709\r
710 SockConnFlush (Sock);\r
711 SockSetState (Sock, SO_CLOSED);\r
712 Sock->ConfigureState = SO_UNCONFIGURED;\r
713\r
714 }\r
715 //\r
716 // Destory the RcvBuffer Queue and SendBuffer Queue\r
717 //\r
718 NetbufQueFree (Sock->RcvBuffer.DataQueue);\r
719 NetbufQueFree (Sock->SndBuffer.DataQueue);\r
720\r
721 //\r
722 // Remove it from parent connection list if needed\r
723 //\r
724 if (Sock->Parent) {\r
725\r
726 NetListRemoveEntry (&(Sock->ConnectionList));\r
727 (Sock->Parent->ConnCnt)--;\r
728\r
729 SOCK_DEBUG_WARN (("SockDestory: Delete a unaccepted socket from parent"\r
730 "now conncnt is %d\n", Sock->Parent->ConnCnt));\r
731\r
732 Sock->Parent = NULL;\r
733 }\r
734\r
735 //\r
736 // Set the protocol guid and driver binding handle\r
737 // in the light of Sock->SockType\r
738 //\r
739 ProtocolGuid = &gEfiTcp4ProtocolGuid;\r
740\r
741 //\r
742 // Retrieve the protocol installed on this sock\r
743 //\r
744 Status = gBS->OpenProtocol (\r
745 Sock->SockHandle,\r
746 ProtocolGuid,\r
747 &SockProtocol,\r
748 Sock->DriverBinding,\r
749 Sock->SockHandle,\r
750 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
751 );\r
752\r
753 if (EFI_ERROR (Status)) {\r
754\r
755 SOCK_DEBUG_ERROR (("SockDestroy: Open protocol installed "\r
756 "on socket failed with %r\n", Status));\r
757\r
758 goto FreeSock;\r
759 }\r
760\r
761 //\r
762 // Uninstall the protocol installed on this sock\r
763 // in the light of Sock->SockType\r
764 //\r
765 gBS->UninstallMultipleProtocolInterfaces (\r
766 Sock->SockHandle,\r
767 ProtocolGuid,\r
768 SockProtocol,\r
769 NULL\r
770 );\r
771\r
772FreeSock:\r
773 NetFreePool (Sock);\r
774 return ;\r
775}\r
776\r
777\r
778/**\r
779 Flush the socket.\r
780\r
781 @param Sock Pointer to the socket.\r
782\r
783 @return None.\r
784\r
785**/\r
786VOID\r
787SockConnFlush (\r
788 IN SOCKET *Sock\r
789 )\r
790{\r
791 SOCKET *Child;\r
792\r
793 ASSERT (Sock);\r
794\r
795 //\r
796 // Clear the flag in this socket\r
797 //\r
798 Sock->Flag = 0;\r
799\r
800 //\r
801 // Flush the SndBuffer and RcvBuffer of Sock\r
802 //\r
803 NetbufQueFlush (Sock->SndBuffer.DataQueue);\r
804 NetbufQueFlush (Sock->RcvBuffer.DataQueue);\r
805\r
806 //\r
807 // Signal the pending token\r
808 //\r
809 if (Sock->ConnectionToken != NULL) {\r
810 SIGNAL_TOKEN (Sock->ConnectionToken, Sock->SockError);\r
811 Sock->ConnectionToken = NULL;\r
812 }\r
813\r
814 if (Sock->CloseToken != NULL) {\r
815 SIGNAL_TOKEN (Sock->CloseToken, Sock->SockError);\r
816 Sock->CloseToken = NULL;\r
817 }\r
818\r
819 SockFlushPendingToken (Sock, &(Sock->ListenTokenList));\r
820 SockFlushPendingToken (Sock, &(Sock->RcvTokenList));\r
821 SockFlushPendingToken (Sock, &(Sock->SndTokenList));\r
822 SockFlushPendingToken (Sock, &(Sock->ProcessingSndTokenList));\r
823\r
824 //\r
825 // Destroy the pending connection, if it is a listening socket\r
826 //\r
827 if (SOCK_IS_LISTENING (Sock)) {\r
828 while (!NetListIsEmpty (&Sock->ConnectionList)) {\r
829 Child = NET_LIST_HEAD (\r
830 &Sock->ConnectionList,\r
831 SOCKET,\r
832 ConnectionList\r
833 );\r
834\r
835 SockDestroyChild (Child);\r
836 }\r
837\r
838 Sock->ConnCnt = 0;\r
839 }\r
840\r
841 return ;\r
842}\r
843\r
844\r
845/**\r
846 Set the state of the socket.\r
847\r
848 @param Sock Pointer to the socket.\r
849 @param State The new state to be set.\r
850\r
851 @return None.\r
852\r
853**/\r
854VOID\r
855SockSetState (\r
856 IN SOCKET *Sock,\r
857 IN SOCK_STATE State\r
858 )\r
859{\r
860 Sock->State = State;\r
861}\r
862\r
863\r
864/**\r
865 Clone a new socket including its associated protocol control block.\r
866\r
867 @param Sock Pointer to the socket to be cloned.\r
868\r
869 @retval * Pointer to the newly cloned socket. If NULL, error\r
870 condition occurred.\r
871\r
872**/\r
873SOCKET *\r
874SockClone (\r
875 IN SOCKET *Sock\r
876 )\r
877{\r
878 SOCKET *ClonedSock;\r
879 SOCK_INIT_DATA InitData;\r
880\r
881 InitData.BackLog = Sock->BackLog;\r
882 InitData.Parent = Sock;\r
883 InitData.State = Sock->State;\r
884 InitData.ProtoHandler = Sock->ProtoHandler;\r
885 InitData.Type = Sock->Type;\r
886 InitData.RcvBufferSize = Sock->RcvBuffer.HighWater;\r
887 InitData.SndBufferSize = Sock->SndBuffer.HighWater;\r
888 InitData.DriverBinding = Sock->DriverBinding;\r
889 InitData.Protocol = &(Sock->NetProtocol);\r
890\r
891 ClonedSock = SockCreate (&InitData);\r
892\r
893 if (NULL == ClonedSock) {\r
894 SOCK_DEBUG_ERROR (("SockClone: no resource to create a cloned sock\n"));\r
895 return NULL;\r
896 }\r
897\r
898 NetCopyMem (\r
899 ClonedSock->ProtoReserved,\r
900 Sock->ProtoReserved,\r
901 PROTO_RESERVED_LEN\r
902 );\r
903\r
904 SockSetState (ClonedSock, SO_CONNECTING);\r
905 ClonedSock->ConfigureState = Sock->ConfigureState;\r
906\r
907 return ClonedSock;\r
908}\r
909\r
910\r
911/**\r
912 Called by the low layer protocol to indicate the socket\r
913 a connection is established. This function just changes\r
914 the socket's state to SO_CONNECTED and signals the token\r
915 used for connection establishment.\r
916\r
917 @param Sock Pointer to the socket associated with the\r
918 established connection.\r
919\r
920 @return None.\r
921\r
922**/\r
923VOID\r
924SockConnEstablished (\r
925 IN SOCKET *Sock\r
926 )\r
927{\r
928\r
929 ASSERT (SO_CONNECTING == Sock->State);\r
930\r
931 SockSetState (Sock, SO_CONNECTED);\r
932\r
933 if (NULL == Sock->Parent) {\r
934 SockWakeConnToken (Sock);\r
935 } else {\r
936 SockWakeListenToken (Sock);\r
937 }\r
938\r
939 return ;\r
940}\r
941\r
942\r
943/**\r
944 Called by the low layer protocol to indicate the connection\r
945 is closed. This function flushes the socket, sets the state\r
946 to SO_CLOSED and signals the close token.\r
947\r
948 @param Sock Pointer to the socket associated with the closed\r
949 connection.\r
950\r
951 @return None.\r
952\r
953**/\r
954VOID\r
955SockConnClosed (\r
956 IN SOCKET *Sock\r
957 )\r
958{\r
959 if (Sock->CloseToken) {\r
960 SIGNAL_TOKEN (Sock->CloseToken, EFI_SUCCESS);\r
961 Sock->CloseToken = NULL;\r
962 }\r
963\r
964 SockConnFlush (Sock);\r
965 SockSetState (Sock, SO_CLOSED);\r
966\r
967 if (Sock->Parent != NULL) {\r
968 SockDestroyChild (Sock);\r
969 }\r
970\r
971}\r
972\r
973\r
974/**\r
975 Called by low layer protocol to indicate that some\r
976 data is sent or processed. This function trims the\r
977 sent data in the socket send buffer, signals the\r
978 data token if proper\r
979\r
980 @param Sock Pointer to the socket.\r
981 @param Count The length of the data processed or sent, in bytes.\r
982\r
983 @return None.\r
984\r
985**/\r
986VOID\r
987SockDataSent (\r
988 IN SOCKET *Sock,\r
989 IN UINT32 Count\r
990 )\r
991{\r
992 SOCK_TOKEN *SockToken;\r
993 SOCK_COMPLETION_TOKEN *SndToken;\r
994\r
995 ASSERT (!NetListIsEmpty (&Sock->ProcessingSndTokenList));\r
996 ASSERT (Count <= (Sock->SndBuffer.DataQueue)->BufSize);\r
997\r
998 NetbufQueTrim (Sock->SndBuffer.DataQueue, Count);\r
999\r
1000 //\r
1001 // To check if we can signal some snd token in this socket\r
1002 //\r
1003 while (Count > 0) {\r
1004 SockToken = NET_LIST_HEAD (\r
1005 &(Sock->ProcessingSndTokenList),\r
1006 SOCK_TOKEN,\r
1007 TokenList\r
1008 );\r
1009\r
1010 SndToken = SockToken->Token;\r
1011\r
1012 if (SockToken->RemainDataLen <= Count) {\r
1013\r
1014 NetListRemoveEntry (&(SockToken->TokenList));\r
1015 SIGNAL_TOKEN (SndToken, EFI_SUCCESS);\r
1016 Count -= SockToken->RemainDataLen;\r
1017 NetFreePool (SockToken);\r
1018 } else {\r
1019\r
1020 SockToken->RemainDataLen -= Count;\r
1021 Count = 0;\r
1022 }\r
1023 }\r
1024\r
1025 //\r
1026 // to judge if we can process some send token in\r
1027 // Sock->SndTokenList, if so process those send token\r
1028 //\r
1029 SockProcessSndToken (Sock);\r
1030 return ;\r
1031}\r
1032\r
1033\r
1034/**\r
1035 Called by the low layer protocol to copy some data in socket send\r
1036 buffer starting from the specific offset to a buffer provided by\r
1037 the caller.\r
1038\r
1039 @param Sock Pointer to the socket.\r
1040 @param Offset The start point of the data to be copied.\r
1041 @param Len The length of the data to be copied.\r
1042 @param Dest Pointer to the destination to copy the data.\r
1043\r
1044 @return The data size copied.\r
1045\r
1046**/\r
1047UINT32\r
1048SockGetDataToSend (\r
1049 IN SOCKET *Sock,\r
1050 IN UINT32 Offset,\r
1051 IN UINT32 Len,\r
1052 IN UINT8 *Dest\r
1053 )\r
1054{\r
1055 ASSERT (Sock && SOCK_STREAM == Sock->Type);\r
1056\r
1057 return NetbufQueCopy (\r
1058 Sock->SndBuffer.DataQueue,\r
1059 Offset,\r
1060 Len,\r
1061 Dest\r
1062 );\r
1063}\r
1064\r
1065\r
1066/**\r
1067 Called by the low layer protocol to deliver received data\r
1068 to socket layer. This function will append the data to the\r
1069 socket receive buffer, set ther urgent data length and then\r
1070 check if any receive token can be signaled.\r
1071\r
1072 @param Sock Pointer to the socket.\r
1073 @param NetBuffer Pointer to the buffer that contains the received\r
1074 data.\r
1075 @param UrgLen The length of the urgent data in the received data.\r
1076\r
1077 @return None.\r
1078\r
1079**/\r
1080VOID\r
1081SockDataRcvd (\r
1082 IN SOCKET *Sock,\r
1083 IN NET_BUF *NetBuffer,\r
1084 IN UINT32 UrgLen\r
1085 )\r
1086{\r
1087 ASSERT (Sock && Sock->RcvBuffer.DataQueue &&\r
1088 UrgLen <= NetBuffer->TotalSize);\r
1089\r
1090 NET_GET_REF (NetBuffer);\r
1091\r
1092 ((TCP_RSV_DATA *) (NetBuffer->ProtoData))->UrgLen = UrgLen;\r
1093\r
1094 NetbufQueAppend (Sock->RcvBuffer.DataQueue, NetBuffer);\r
1095\r
1096 SockWakeRcvToken (Sock);\r
1097 return ;\r
1098}\r
1099\r
1100\r
1101/**\r
1102 Get the length of the free space of the specific socket buffer.\r
1103\r
1104 @param Sock Pointer to the socket.\r
1105 @param Which Flag to indicate which socket buffer to check,\r
1106 either send buffer or receive buffer.\r
1107\r
1108 @return The length of the free space, in bytes.\r
1109\r
1110**/\r
1111UINT32\r
1112SockGetFreeSpace (\r
1113 IN SOCKET *Sock,\r
1114 IN UINT32 Which\r
1115 )\r
1116{\r
1117 UINT32 BufferCC;\r
1118 SOCK_BUFFER *SockBuffer;\r
1119\r
1120 ASSERT (Sock && ((SOCK_SND_BUF == Which) || (SOCK_RCV_BUF == Which)));\r
1121\r
1122 if (SOCK_SND_BUF == Which) {\r
1123 SockBuffer = &(Sock->SndBuffer);\r
1124 } else {\r
1125 SockBuffer = &(Sock->RcvBuffer);\r
1126 }\r
1127\r
1128 BufferCC = (SockBuffer->DataQueue)->BufSize;\r
1129\r
1130 if (BufferCC >= SockBuffer->HighWater) {\r
1131\r
1132 return 0;\r
1133 }\r
1134\r
1135 return SockBuffer->HighWater - BufferCC;\r
1136}\r
1137\r
1138\r
1139/**\r
1140 Signal the receive token with the specific error or\r
1141 set socket error code after error is received.\r
1142\r
1143 @param Sock Pointer to the socket.\r
1144 @param Error The error code received.\r
1145\r
1146 @return None.\r
1147\r
1148**/\r
1149VOID\r
1150SockRcvdErr (\r
1151 IN SOCKET *Sock,\r
1152 IN EFI_STATUS Error\r
1153 )\r
1154{\r
1155 SOCK_TOKEN *SockToken;\r
1156\r
1157 if (!NetListIsEmpty (&Sock->RcvTokenList)) {\r
1158\r
1159 SockToken = NET_LIST_HEAD (\r
1160 &Sock->RcvTokenList,\r
1161 SOCK_TOKEN,\r
1162 TokenList\r
1163 );\r
1164\r
1165 NetListRemoveEntry (&SockToken->TokenList);\r
1166\r
1167 SIGNAL_TOKEN (SockToken->Token, Error);\r
1168\r
1169 NetFreePool (SockToken);\r
1170 } else {\r
1171\r
1172 SOCK_ERROR (Sock, Error);\r
1173 }\r
1174}\r
1175\r
1176\r
1177/**\r
1178 Called by the low layer protocol to indicate that there\r
1179 will be no more data from the communication peer. This\r
1180 function set the socket's state to SO_NO_MORE_DATA and\r
1181 signal all queued IO tokens with the error status\r
1182 EFI_CONNECTION_FIN.\r
1183\r
1184 @param Sock Pointer to the socket.\r
1185\r
1186 @return None.\r
1187\r
1188**/\r
1189VOID\r
1190SockNoMoreData (\r
1191 IN SOCKET *Sock\r
1192 )\r
1193{\r
1194 EFI_STATUS Err;\r
1195\r
1196 SOCK_NO_MORE_DATA (Sock);\r
1197\r
1198 if (!NetListIsEmpty (&Sock->RcvTokenList)) {\r
1199\r
1200 ASSERT (0 == GET_RCV_DATASIZE (Sock));\r
1201\r
1202 Err = Sock->SockError;\r
1203\r
1204 SOCK_ERROR (Sock, EFI_CONNECTION_FIN);\r
1205\r
1206 SockFlushPendingToken (Sock, &Sock->RcvTokenList);\r
1207\r
1208 SOCK_ERROR (Sock, Err);\r
1209\r
1210 }\r
1211\r
1212}\r
1213\r
1214\r
1215/**\r
1216 Get the first buffer block in the specific socket buffer.\r
1217\r
1218 @param Sockbuf Pointer to the socket buffer.\r
1219\r
1220 @return Pointer to the first buffer in the queue. NULL if the queue is empty.\r
1221\r
1222**/\r
1223NET_BUF *\r
1224SockBufFirst (\r
1225 IN SOCK_BUFFER *Sockbuf\r
1226 )\r
1227{\r
1228 NET_LIST_ENTRY *NetbufList;\r
1229\r
1230 NetbufList = &(Sockbuf->DataQueue->BufList);\r
1231\r
1232 if (NetListIsEmpty (NetbufList)) {\r
1233 return NULL;\r
1234 }\r
1235\r
1236 return NET_LIST_HEAD (NetbufList, NET_BUF, List);\r
1237}\r
1238\r
1239\r
1240/**\r
1241 Get the next buffer block in the specific socket buffer.\r
1242\r
1243 @param Sockbuf Pointer to the socket buffer.\r
1244 @param SockEntry Pointer to the buffer block prior to the required\r
1245 one.\r
1246\r
1247 @return Pointer to the buffer block next to SockEntry. NULL if SockEntry is the tail or head entry.\r
1248\r
1249**/\r
1250NET_BUF *\r
1251SockBufNext (\r
1252 IN SOCK_BUFFER *Sockbuf,\r
1253 IN NET_BUF *SockEntry\r
1254 )\r
1255{\r
1256 NET_LIST_ENTRY *NetbufList;\r
1257\r
1258 NetbufList = &(Sockbuf->DataQueue->BufList);\r
1259\r
1260 if ((SockEntry->List.ForwardLink == NetbufList) ||\r
1261 (SockEntry->List.BackLink == &SockEntry->List) ||\r
1262 (SockEntry->List.ForwardLink == &SockEntry->List)\r
1263 ) {\r
1264\r
1265 return NULL;\r
1266 }\r
1267\r
1268 return NET_LIST_USER_STRUCT (SockEntry->List.ForwardLink, NET_BUF, List);\r
1269}\r