/** @file\r
+ Implementation of the Socket.\r
\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+Copyright (c) 2005 - 2009, Intel Corporation<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+http://opensource.org/licenses/bsd-license.php<BR>\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
-\r
- SockImpl.c\r
+**/\r
\r
-Abstract:\r
+#include "SockImpl.h"\r
\r
+/**\r
+ Get the length of the data that can be retrieved from the socket\r
+ receive buffer.\r
\r
-**/\r
+ @param SockBuffer Pointer to the socket receive buffer.\r
+ @param IsUrg Pointer to a BOOLEAN variable. If TRUE the data is\r
+ OOB.\r
+ @param BufLen The maximum length of the data buffer to store the\r
+ received data in socket layer.\r
\r
-#include "SockImpl.h"\r
+ @return The length of the data can be retreived.\r
\r
-STATIC\r
+**/\r
UINT32\r
SockTcpDataToRcv (\r
- IN SOCK_BUFFER *SockBuffer,\r
- OUT BOOLEAN *IsOOB,\r
- IN UINT32 BufLen\r
+ IN SOCK_BUFFER *SockBuffer,\r
+ OUT BOOLEAN *IsUrg,\r
+ IN UINT32 BufLen\r
);\r
+ \r
+/**\r
+ Process the send token.\r
\r
-STATIC\r
+ @param Sock Pointer to the socket.\r
+\r
+**/\r
VOID\r
SockProcessSndToken (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
);\r
\r
+/**\r
+ Supporting function for both SockImpl and SockInterface.\r
+\r
+ @param Event The Event this notify function registered to, ignored.\r
+ \r
+**/\r
VOID\r
SockFreeFoo (\r
IN EFI_EVENT Event\r
@return The length of the data can be retreived.\r
\r
**/\r
-STATIC\r
UINT32\r
SockTcpDataToRcv (\r
- IN SOCK_BUFFER *SockBuffer,\r
- OUT BOOLEAN *IsUrg,\r
- IN UINT32 BufLen\r
+ IN SOCK_BUFFER *SockBuffer,\r
+ OUT BOOLEAN *IsUrg,\r
+ IN UINT32 BufLen\r
)\r
{\r
NET_BUF *RcvBufEntry;\r
UINT32 DataLen;\r
TCP_RSV_DATA *TcpRsvData;\r
BOOLEAN Urg;\r
-\r
- ASSERT (SockBuffer && IsUrg && (BufLen > 0));\r
+ ASSERT ((SockBuffer != NULL) && (IsUrg != NULL) && (BufLen > 0));\r
\r
RcvBufEntry = SockBufFirst (SockBuffer);\r
- ASSERT (RcvBufEntry);\r
+ ASSERT (RcvBufEntry != NULL);\r
\r
TcpRsvData = (TCP_RSV_DATA *) RcvBufEntry->ProtoData;\r
\r
@param Sock Pointer to the socket.\r
@param TcpRxData Pointer to the application provided receive buffer.\r
@param RcvdBytes The maximum length of the data can be copied.\r
- @param IsOOB If TURE the data is OOB, else the data is normal.\r
-\r
- @return None.\r
+ @param IsOOB If TURE the data is OOB, FALSE the data is normal.\r
\r
**/\r
VOID\r
**/\r
UINT32\r
SockProcessRcvToken (\r
- IN SOCKET *Sock,\r
- IN SOCK_IO_TOKEN *RcvToken\r
+ IN SOCKET *Sock,\r
+ IN OUT SOCK_IO_TOKEN *RcvToken\r
)\r
{\r
UINT32 TokenRcvdBytes;\r
EFI_TCP4_RECEIVE_DATA *RxData;\r
BOOLEAN IsUrg;\r
\r
- ASSERT (Sock);\r
+ ASSERT (Sock != NULL);\r
\r
- ASSERT (SOCK_STREAM == Sock->Type);\r
+ ASSERT (SockStream == Sock->Type);\r
\r
RxData = RcvToken->Packet.RxData;\r
\r
//\r
SockSetTcpRxData (Sock, RxData, TokenRcvdBytes, IsUrg);\r
\r
- SOCK_TRIM_RCV_BUFF (Sock, TokenRcvdBytes);\r
+ NetbufQueTrim (Sock->RcvBuffer.DataQueue, TokenRcvdBytes);\r
SIGNAL_TOKEN (&(RcvToken->Token), EFI_SUCCESS);\r
\r
return TokenRcvdBytes;\r
the buffer to socket send buffer,then try to send it.\r
\r
@param Sock Pointer to the socket.\r
- @param TcpTxData Pointer to the tcp txdata.\r
+ @param TcpTxData Pointer to the application provided send buffer.\r
\r
@retval EFI_SUCCESS The operation is completed successfully.\r
@retval EFI_OUT_OF_RESOURCES Failed due to resource limit.\r
\r
@param Sock Pointer to the socket.\r
@param PendingTokenList Pointer to the token list to be flushed.\r
-\r
- @return None.\r
-\r
+ \r
**/\r
-STATIC\r
VOID\r
SockFlushPendingToken (\r
IN SOCKET *Sock,\r
SOCK_TOKEN *SockToken;\r
SOCK_COMPLETION_TOKEN *Token;\r
\r
- ASSERT (Sock && PendingTokenList);\r
+ ASSERT ((Sock != NULL) && (PendingTokenList != NULL));\r
\r
while (!IsListEmpty (PendingTokenList)) {\r
SockToken = NET_LIST_HEAD (\r
\r
\r
/**\r
- Wake up the connection token while the connection is\r
- successfully established, then try to process any\r
- pending send token.\r
+ Wake up the connection token while the connection is successfully established, \r
+ then try to process any pending send token.\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
-STATIC\r
VOID\r
SockWakeConnToken (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
ASSERT (Sock->ConnectionToken != NULL);\r
\r
\r
/**\r
- Wake up the listen token while the connection is\r
- established successfully.\r
+ Wake up the listen token while the connection is established successfully.\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
-STATIC\r
VOID\r
SockWakeListenToken (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
SOCKET *Parent;\r
\r
Parent = Sock->Parent;\r
\r
- ASSERT (Parent && SOCK_IS_LISTENING (Parent) && SOCK_IS_CONNECTED (Sock));\r
+ ASSERT ((Parent != NULL) && SOCK_IS_LISTENING (Parent) && SOCK_IS_CONNECTED (Sock));\r
\r
if (!IsListEmpty (&Parent->ListenTokenList)) {\r
SockToken = NET_LIST_HEAD (\r
RemoveEntryList (&Sock->ConnectionList);\r
\r
Parent->ConnCnt--;\r
- DEBUG ((EFI_D_WARN, "SockWakeListenToken: accept a socket, now conncnt is %d", Parent->ConnCnt));\r
+ DEBUG ((EFI_D_INFO, "SockWakeListenToken: accept a socket, now conncnt is %d", Parent->ConnCnt));\r
\r
Sock->Parent = NULL;\r
}\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
-STATIC\r
VOID\r
SockWakeRcvToken (\r
IN SOCKET *Sock\r
SOCK_TOKEN *SockToken;\r
SOCK_IO_TOKEN *RcvToken;\r
\r
- ASSERT (Sock->RcvBuffer.DataQueue);\r
+ ASSERT (Sock->RcvBuffer.DataQueue != NULL);\r
\r
RcvdBytes = (Sock->RcvBuffer.DataQueue)->BufSize;\r
\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
-STATIC\r
VOID\r
SockProcessSndToken (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
UINT32 FreeSpace;\r
EFI_TCP4_TRANSMIT_DATA *TxData;\r
EFI_STATUS Status;\r
\r
- ASSERT (Sock && (SOCK_STREAM == Sock->Type));\r
+ ASSERT ((Sock != NULL) && (SockStream == Sock->Type));\r
\r
FreeSpace = SockGetFreeSpace (Sock, SOCK_SND_BUF);\r
\r
\r
@param SockInitData Pointer to the initial data of the socket.\r
\r
- @return Pointer to the newly created socket.\r
+ @return Pointer to the newly created socket, return NULL when exception occured.\r
\r
**/\r
SOCKET *\r
SOCKET *Parent;\r
EFI_STATUS Status;\r
\r
- ASSERT (SockInitData && SockInitData->ProtoHandler);\r
- ASSERT (SockInitData->Type == SOCK_STREAM);\r
- ASSERT (SockInitData->ProtoData && (SockInitData->DataSize <= PROTO_RESERVED_LEN));\r
+ ASSERT ((SockInitData != NULL) && (SockInitData->ProtoHandler != NULL));\r
+ ASSERT (SockInitData->Type == SockStream);\r
+ ASSERT ((SockInitData->ProtoData != NULL) && (SockInitData->DataSize <= PROTO_RESERVED_LEN));\r
\r
Parent = SockInitData->Parent;\r
\r
- if (Parent && (Parent->ConnCnt == Parent->BackLog)) {\r
+ if ((Parent != NULL) && (Parent->ConnCnt == Parent->BackLog)) {\r
DEBUG (\r
(EFI_D_ERROR,\r
"SockCreate: Socket parent has "\r
Parent->ConnCnt++;\r
\r
DEBUG (\r
- (EFI_D_WARN,\r
+ (EFI_D_INFO,\r
"SockCreate: Create a new socket and add to parent, now conncnt is %d\n",\r
Parent->ConnCnt)\r
);\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
SockDestroy (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
VOID *SockProtocol;\r
EFI_GUID *ProtocolGuid;\r
EFI_STATUS Status;\r
\r
- ASSERT (SOCK_STREAM == Sock->Type);\r
+ ASSERT (SockStream == Sock->Type);\r
\r
if (Sock->DestroyCallback != NULL) {\r
Sock->DestroyCallback (Sock, Sock->Context);\r
//\r
// Remove it from parent connection list if needed\r
//\r
- if (Sock->Parent) {\r
+ if (Sock->Parent != NULL) {\r
\r
RemoveEntryList (&(Sock->ConnectionList));\r
(Sock->Parent->ConnCnt)--;\r
\r
DEBUG (\r
- (EFI_D_WARN,\r
+ (EFI_D_INFO,\r
"SockDestory: Delete a unaccepted socket from parent"\r
"now conncnt is %d\n",\r
Sock->Parent->ConnCnt)\r
\r
\r
/**\r
- Flush the socket.\r
+ Flush the sndBuffer and rcvBuffer of socket.\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
SockConnFlush (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
SOCKET *Child;\r
\r
- ASSERT (Sock);\r
+ ASSERT (Sock != NULL);\r
\r
//\r
// Clear the flag in this socket\r
Set the state of the socket.\r
\r
@param Sock Pointer to the socket.\r
- @param State The new state to be set.\r
-\r
- @return None.\r
+ @param State The new socket state to be set.\r
\r
**/\r
VOID\r
SockSetState (\r
- IN SOCKET *Sock,\r
- IN SOCK_STATE State\r
+ IN OUT SOCKET *Sock,\r
+ IN UINT8 State\r
)\r
{\r
Sock->State = State;\r
\r
@param Sock Pointer to the socket to be cloned.\r
\r
- @retval * Pointer to the newly cloned socket. If NULL, error\r
- condition occurred.\r
+ @return Pointer to the newly cloned socket. If NULL, error condition occurred.\r
\r
**/\r
SOCKET *\r
SOCKET *ClonedSock;\r
SOCK_INIT_DATA InitData;\r
\r
- InitData.BackLog = Sock->BackLog;\r
- InitData.Parent = Sock;\r
- InitData.State = Sock->State;\r
- InitData.ProtoHandler = Sock->ProtoHandler;\r
- InitData.Type = Sock->Type;\r
- InitData.RcvBufferSize = Sock->RcvBuffer.HighWater;\r
- InitData.SndBufferSize = Sock->SndBuffer.HighWater;\r
- InitData.DriverBinding = Sock->DriverBinding;\r
- InitData.Protocol = &(Sock->NetProtocol);\r
+ InitData.BackLog = Sock->BackLog;\r
+ InitData.Parent = Sock;\r
+ InitData.State = Sock->State;\r
+ InitData.ProtoHandler = Sock->ProtoHandler;\r
+ InitData.Type = Sock->Type;\r
+ InitData.RcvBufferSize = Sock->RcvBuffer.HighWater;\r
+ InitData.SndBufferSize = Sock->SndBuffer.HighWater;\r
+ InitData.DriverBinding = Sock->DriverBinding;\r
+ InitData.Protocol = &(Sock->NetProtocol);\r
InitData.CreateCallback = Sock->CreateCallback;\r
InitData.DestroyCallback = Sock->DestroyCallback;\r
InitData.Context = Sock->Context;\r
InitData.ProtoData = Sock->ProtoReserved;\r
InitData.DataSize = sizeof (Sock->ProtoReserved);\r
\r
- ClonedSock = SockCreate (&InitData);\r
+ ClonedSock = SockCreate (&InitData);\r
\r
if (NULL == ClonedSock) {\r
DEBUG ((EFI_D_ERROR, "SockClone: no resource to create a cloned sock\n"));\r
\r
\r
/**\r
- Called by the low layer protocol to indicate the socket\r
- a connection is established. This function just changes\r
- the socket's state to SO_CONNECTED and signals the token\r
- used for connection establishment.\r
+ Called by the low layer protocol to indicate the socket a connection is \r
+ established. \r
+ \r
+ This function just changes the socket's state to SO_CONNECTED \r
+ and signals the token used for connection establishment.\r
\r
@param Sock Pointer to the socket associated with the\r
established connection.\r
-\r
- @return None.\r
-\r
**/\r
VOID\r
SockConnEstablished (\r
\r
\r
/**\r
- Called by the low layer protocol to indicate the connection\r
- is closed. This function flushes the socket, sets the state\r
- to SO_CLOSED and signals the close token.\r
+ Called by the low layer protocol to indicate the connection is closed.\r
+ \r
+ This function flushes the socket, sets the state to SO_CLOSED and signals \r
+ the close token.\r
\r
@param Sock Pointer to the socket associated with the closed\r
connection.\r
-\r
- @return None.\r
-\r
+ \r
**/\r
VOID\r
SockConnClosed (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
- if (Sock->CloseToken) {\r
+ if (Sock->CloseToken != NULL) {\r
SIGNAL_TOKEN (Sock->CloseToken, EFI_SUCCESS);\r
Sock->CloseToken = NULL;\r
}\r
\r
\r
/**\r
- Called by low layer protocol to indicate that some\r
- data is sent or processed. This function trims the\r
- sent data in the socket send buffer, signals the\r
- data token if proper\r
+ Called by low layer protocol to indicate that some data is sent or processed.\r
+ \r
+ This function trims the sent data in the socket send buffer, signals the data \r
+ token if proper.\r
\r
@param Sock Pointer to the socket.\r
@param Count The length of the data processed or sent, in bytes.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
SockDataSent (\r
IN UINT8 *Dest\r
)\r
{\r
- ASSERT (Sock && SOCK_STREAM == Sock->Type);\r
+ ASSERT ((Sock != NULL) && SockStream == Sock->Type);\r
\r
return NetbufQueCopy (\r
Sock->SndBuffer.DataQueue,\r
\r
\r
/**\r
- Called by the low layer protocol to deliver received data\r
- to socket layer. This function will append the data to the\r
- socket receive buffer, set ther urgent data length and then\r
- check if any receive token can be signaled.\r
+ Called by the low layer protocol to deliver received data to socket layer.\r
+ \r
+ This function will append the data to the socket receive buffer, set ther \r
+ urgent data length and then check if any receive token can be signaled.\r
\r
@param Sock Pointer to the socket.\r
@param NetBuffer Pointer to the buffer that contains the received\r
data.\r
@param UrgLen The length of the urgent data in the received data.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
SockDataRcvd (\r
- IN SOCKET *Sock,\r
- IN NET_BUF *NetBuffer,\r
- IN UINT32 UrgLen\r
+ IN SOCKET *Sock,\r
+ IN OUT NET_BUF *NetBuffer,\r
+ IN UINT32 UrgLen\r
)\r
{\r
- ASSERT (Sock && Sock->RcvBuffer.DataQueue &&\r
+ ASSERT ((Sock != NULL) && (Sock->RcvBuffer.DataQueue != NULL) &&\r
UrgLen <= NetBuffer->TotalSize);\r
\r
NET_GET_REF (NetBuffer);\r
UINT32 BufferCC;\r
SOCK_BUFFER *SockBuffer;\r
\r
- ASSERT (Sock && ((SOCK_SND_BUF == Which) || (SOCK_RCV_BUF == Which)));\r
+ ASSERT ((Sock != NULL) && ((SOCK_SND_BUF == Which) || (SOCK_RCV_BUF == Which)));\r
\r
if (SOCK_SND_BUF == Which) {\r
SockBuffer = &(Sock->SndBuffer);\r
@param Sock Pointer to the socket.\r
@param Error The error code received.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
SockRcvdErr (\r
- IN SOCKET *Sock,\r
- IN EFI_STATUS Error\r
+ IN OUT SOCKET *Sock,\r
+ IN EFI_STATUS Error\r
)\r
{\r
SOCK_TOKEN *SockToken;\r
\r
\r
/**\r
- Called by the low layer protocol to indicate that there\r
- will be no more data from the communication peer. This\r
- function set the socket's state to SO_NO_MORE_DATA and\r
- signal all queued IO tokens with the error status\r
- EFI_CONNECTION_FIN.\r
+ Called by the low layer protocol to indicate that there will be no more data \r
+ from the communication peer.\r
+ \r
+ This function set the socket's state to SO_NO_MORE_DATA and signal all queued \r
+ IO tokens with the error status EFI_CONNECTION_FIN.\r
\r
@param Sock Pointer to the socket.\r
\r
- @return None.\r
-\r
**/\r
VOID\r
SockNoMoreData (\r
- IN SOCKET *Sock\r
+ IN OUT SOCKET *Sock\r
)\r
{\r
EFI_STATUS Err;\r
@param SockEntry Pointer to the buffer block prior to the required\r
one.\r
\r
- @return Pointer to the buffer block next to SockEntry. NULL if SockEntry is the tail or head entry.\r
+ @return Pointer to the buffer block next to SockEntry. NULL if SockEntry is \r
+ the tail or head entry.\r
\r
**/\r
NET_BUF *\r
\r
if ((SockEntry->List.ForwardLink == NetbufList) ||\r
(SockEntry->List.BackLink == &SockEntry->List) ||\r
- (SockEntry->List.ForwardLink == &SockEntry->List)\r
- ) {\r
+ (SockEntry->List.ForwardLink == &SockEntry->List)) {\r
\r
return NULL;\r
}\r
projects / mirror_edk2.git / blobdiff