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