]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Tcp4Dxe/SockInterface.c
1. Add EFI_COMPONENT_NAME2_PROTOCOL.GetControllerName() support.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / SockInterface.c
index 5d25124ebd1929a56b5806c01cd74d9ae4becfa6..feed86c5903eef3e5e7ffb6238d331ea55bbb1d8 100644 (file)
@@ -1,21 +1,15 @@
 /** @file\r
+  Interface function of the Socket.\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2005 - 2012, Intel Corporation. All rights reserved.<BR>\r
+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
-  SockInterface.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 \r
@@ -28,18 +22,17 @@ Abstract:
   @param  List                 Pointer to the token list to be searched.\r
   @param  Event                The event to be checked.\r
 \r
-  @retval BOOLEAN              If TRUE, the specific Event exists in the List. If\r
-                               FALSE, the specific Event is not in the List.\r
+  @retval  TRUE                The specific Event exists in the List. \r
+  @retval  FALSE               The specific Event is not in the List.\r
 \r
 **/\r
-STATIC\r
 BOOLEAN\r
 SockTokenExistedInList (\r
-  IN NET_LIST_ENTRY *List,\r
+  IN LIST_ENTRY     *List,\r
   IN EFI_EVENT      Event\r
   )\r
 {\r
-  NET_LIST_ENTRY  *ListEntry;\r
+  LIST_ENTRY      *ListEntry;\r
   SOCK_TOKEN      *SockToken;\r
 \r
   NET_LIST_FOR_EACH (ListEntry, List) {\r
@@ -65,7 +58,8 @@ SockTokenExistedInList (
   @param  Sock                 Pointer to the instance's socket.\r
   @param  Event                The event to be checked.\r
 \r
-  @return The specific Event exists in one of socket's lists or not.\r
+  @retval  TRUE                The Event exists in related socket's lists. \r
+  @retval  FALSE               The Event is not in related socket's lists.\r
 \r
 **/\r
 BOOLEAN\r
@@ -78,8 +72,7 @@ SockTokenExisted (
   if (SockTokenExistedInList (&Sock->SndTokenList, Event) ||\r
       SockTokenExistedInList (&Sock->ProcessingSndTokenList, Event) ||\r
       SockTokenExistedInList (&Sock->RcvTokenList, Event) ||\r
-      SockTokenExistedInList (&Sock->ListenTokenList, Event)\r
-        ) {\r
+      SockTokenExistedInList (&Sock->ListenTokenList, Event)) {\r
 \r
     return TRUE;\r
   }\r
@@ -112,17 +105,17 @@ SockTokenExisted (
 SOCK_TOKEN *\r
 SockBufferToken (\r
   IN SOCKET         *Sock,\r
-  IN NET_LIST_ENTRY *List,\r
+  IN LIST_ENTRY     *List,\r
   IN VOID           *Token,\r
   IN UINT32         DataLen\r
   )\r
 {\r
   SOCK_TOKEN  *SockToken;\r
 \r
-  SockToken = NetAllocatePool (sizeof (SOCK_TOKEN));\r
+  SockToken = AllocatePool (sizeof (SOCK_TOKEN));\r
   if (NULL == SockToken) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockBufferIOToken: No Memory "\r
+    DEBUG ((EFI_D_ERROR, "SockBufferIOToken: No Memory "\r
       "to allocate SockToken\n"));\r
 \r
     return NULL;\r
@@ -131,14 +124,14 @@ SockBufferToken (
   SockToken->Sock           = Sock;\r
   SockToken->Token          = (SOCK_COMPLETION_TOKEN *) Token;\r
   SockToken->RemainDataLen  = DataLen;\r
-  NetListInsertTail (List, &SockToken->TokenList);\r
+  InsertTailList (List, &SockToken->TokenList);\r
 \r
   return SockToken;\r
 }\r
 \r
 \r
 /**\r
-  Destory the socket Sock and its associated protocol control block.\r
+  Destroy the socket Sock and its associated protocol control block.\r
 \r
   @param  Sock                 The socket to be destroyed.\r
 \r
@@ -148,23 +141,23 @@ SockBufferToken (
 **/\r
 EFI_STATUS\r
 SockDestroyChild (\r
-  IN   SOCKET *Sock\r
+  IN SOCKET *Sock\r
   )\r
 {\r
   EFI_STATUS  Status;\r
 \r
-  ASSERT (Sock && Sock->ProtoHandler);\r
+  ASSERT ((Sock != NULL) && (Sock->ProtoHandler != NULL));\r
 \r
-  if (Sock->IsDestroyed) {\r
+  if (Sock->InDestroy) {\r
     return EFI_SUCCESS;\r
   }\r
 \r
-  Sock->IsDestroyed = TRUE;\r
+  Sock->InDestroy = TRUE;\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockDestroyChild: Get the lock to "\r
+    DEBUG ((EFI_D_ERROR, "SockDestroyChild: Get the lock to "\r
       "access socket failed with %r\n", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -177,10 +170,10 @@ SockDestroyChild (
 \r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockDestroyChild: Protocol detach socket"\r
+    DEBUG ((EFI_D_ERROR, "SockDestroyChild: Protocol detach socket"\r
       " failed with %r\n", Status));\r
 \r
-    Sock->IsDestroyed = FALSE;\r
+    Sock->InDestroy = FALSE;\r
   } else if (SOCK_IS_CONFIGURED (Sock)) {\r
 \r
     SockConnFlush (Sock);\r
@@ -189,7 +182,7 @@ SockDestroyChild (
     Sock->ConfigureState = SO_UNCONFIGURED;\r
   }\r
 \r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
 \r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
@@ -206,9 +199,7 @@ SockDestroyChild (
   data ProtoData.\r
 \r
   @param  SockInitData         Inital data to setting the socket.\r
-  @param  ProtoData            Pointer to the protocol specific data.\r
-  @param  Len                  Length of the protocol specific data.\r
-\r
+  \r
   @return Pointer to the newly created socket. If NULL, error condition occured.\r
 \r
 **/\r
@@ -226,16 +217,16 @@ SockCreateChild (
   Sock = SockCreate (SockInitData);\r
   if (NULL == Sock) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockCreateChild: No resource to "\r
+    DEBUG ((EFI_D_ERROR, "SockCreateChild: No resource to "\r
       "create a new socket\n"));\r
 \r
     return NULL;\r
   }\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockCreateChild: Get the lock to "\r
+    DEBUG ((EFI_D_ERROR, "SockCreateChild: Get the lock to "\r
       "access socket failed with %r\n", Status));\r
 \r
     SockDestroy (Sock);\r
@@ -246,23 +237,22 @@ SockCreateChild (
   // with a new protocol control block\r
   //\r
   Status = Sock->ProtoHandler (Sock, SOCK_ATTACH, NULL);\r
+  EfiReleaseLock (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockCreateChild: Protocol failed to"\r
+    DEBUG ((EFI_D_ERROR, "SockCreateChild: Protocol failed to"\r
       " attach a socket with %r\n", Status));\r
 \r
     SockDestroy (Sock);\r
     Sock = NULL;\r
   }\r
 \r
-  NET_UNLOCK (&(Sock->Lock));\r
   return Sock;\r
 }\r
 \r
 \r
 /**\r
-  Configure the specific socket Sock using configuration data\r
-  ConfigData.\r
+  Configure the specific socket Sock using configuration data ConfigData.\r
 \r
   @param  Sock                 Pointer to the socket to be configured.\r
   @param  ConfigData           Pointer to the configuration data.\r
@@ -280,10 +270,10 @@ SockConfigure (
 {\r
   EFI_STATUS  Status;\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockConfigure: Get the access for "\r
+    DEBUG ((EFI_D_ERROR, "SockConfigure: Get the access for "\r
       "socket failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -299,7 +289,7 @@ SockConfigure (
   Status = Sock->ProtoHandler (Sock, SOCK_CONFIGURE, ConfigData);\r
 \r
 OnExit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
 \r
   return Status;\r
 }\r
@@ -332,10 +322,10 @@ SockConnect (
   EFI_STATUS  Status;\r
   EFI_EVENT   Event;\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockConnect: Get the access for "\r
+    DEBUG ((EFI_D_ERROR, "SockConnect: Get the access for "\r
       "socket failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -371,7 +361,7 @@ SockConnect (
   Status = Sock->ProtoHandler (Sock, SOCK_CONNECT, NULL);\r
 \r
 OnExit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r
 \r
@@ -402,17 +392,17 @@ SockAccept (
   )\r
 {\r
   EFI_TCP4_LISTEN_TOKEN *ListenToken;\r
-  NET_LIST_ENTRY        *ListEntry;\r
+  LIST_ENTRY            *ListEntry;\r
   EFI_STATUS            Status;\r
   SOCKET                *Socket;\r
   EFI_EVENT             Event;\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockAccept: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockAccept: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -456,14 +446,16 @@ SockAccept (
       ListenToken->NewChildHandle = Socket->SockHandle;\r
       SIGNAL_TOKEN (&(ListenToken->CompletionToken), EFI_SUCCESS);\r
 \r
-      NetListRemoveEntry (ListEntry);\r
+      RemoveEntryList (ListEntry);\r
 \r
-      ASSERT (Socket->Parent);\r
+      ASSERT (Socket->Parent != NULL);\r
 \r
       Socket->Parent->ConnCnt--;\r
 \r
-      SOCK_DEBUG_WARN (("SockAccept: Accept a socket,"\r
-        "now conncount is %d", Socket->Parent->ConnCnt)\r
+      DEBUG (\r
+        (EFI_D_INFO,\r
+        "SockAccept: Accept a socket, now conncount is %d",\r
+        Socket->Parent->ConnCnt)\r
         );\r
       Socket->Parent = NULL;\r
 \r
@@ -480,7 +472,7 @@ SockAccept (
   }\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
 \r
   return Status;\r
 }\r
@@ -518,12 +510,12 @@ SockSend (
   SOCK_TOKEN              *SockToken;\r
   UINT32                  DataLen;\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockSend: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockSend: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -587,7 +579,7 @@ SockSend (
                   );\r
 \r
     if (NULL == SockToken) {\r
-      SOCK_DEBUG_ERROR (("SockSend: Failed to buffer IO token into"\r
+      DEBUG ((EFI_D_ERROR, "SockSend: Failed to buffer IO token into"\r
         " socket processing SndToken List\n", Status));\r
 \r
       Status = EFI_OUT_OF_RESOURCES;\r
@@ -597,16 +589,16 @@ SockSend (
     Status = SockProcessTcpSndData (Sock, TxData);\r
 \r
     if (EFI_ERROR (Status)) {\r
-      SOCK_DEBUG_ERROR (("SockSend: Failed to process "\r
+      DEBUG ((EFI_D_ERROR, "SockSend: Failed to process "\r
         "Snd Data\n", Status));\r
 \r
-      NetListRemoveEntry (&(SockToken->TokenList));\r
-      NetFreePool (SockToken);\r
+      RemoveEntryList (&(SockToken->TokenList));\r
+      FreePool (SockToken);\r
     }\r
   }\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r
 \r
@@ -641,12 +633,12 @@ SockRcv (
   EFI_STATUS    Status;\r
   EFI_EVENT     Event;\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockRcv: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockRcv: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -720,7 +712,7 @@ SockRcv (
   }\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r
 \r
@@ -741,12 +733,12 @@ SockFlush (
 {\r
   EFI_STATUS  Status;\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockFlush: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockFlush: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -759,7 +751,7 @@ SockFlush (
   Status = Sock->ProtoHandler (Sock, SOCK_FLUSH, NULL);\r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockFlush: Protocol failed handling"\r
+    DEBUG ((EFI_D_ERROR, "SockFlush: Protocol failed handling"\r
       " SOCK_FLUSH with %r", Status));\r
 \r
     goto Exit;\r
@@ -772,7 +764,7 @@ SockFlush (
   Sock->ConfigureState = SO_UNCONFIGURED;\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r
 \r
@@ -806,11 +798,11 @@ SockClose (
   EFI_STATUS  Status;\r
   EFI_EVENT   Event;\r
 \r
-  ASSERT (SOCK_STREAM == Sock->Type);\r
+  ASSERT (SockStream == Sock->Type);\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
-    SOCK_DEBUG_ERROR (("SockClose: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockClose: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -848,7 +840,7 @@ SockClose (
   }\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r
 \r
@@ -866,8 +858,8 @@ Exit:
 **/\r
 EFI_STATUS\r
 SockGetMode (\r
-  IN SOCKET *Sock,\r
-  IN VOID   *Mode\r
+  IN     SOCKET *Sock,\r
+  IN OUT VOID   *Mode\r
   )\r
 {\r
   return Sock->ProtoHandler (Sock, SOCK_MODE, Mode);\r
@@ -895,11 +887,11 @@ SockGroup (
 {\r
   EFI_STATUS  Status;\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
 \r
   if (EFI_ERROR (Status)) {\r
 \r
-    SOCK_DEBUG_ERROR (("SockGroup: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockGroup: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -913,7 +905,7 @@ SockGroup (
   Status = Sock->ProtoHandler (Sock, SOCK_GROUP, GroupInfo);\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r
 \r
@@ -941,9 +933,9 @@ SockRoute (
 {\r
   EFI_STATUS  Status;\r
 \r
-  Status = NET_TRYLOCK (&(Sock->Lock));\r
+  Status = EfiAcquireLockOrFail (&(Sock->Lock));\r
   if (EFI_ERROR (Status)) {\r
-    SOCK_DEBUG_ERROR (("SockRoute: Get the access for socket"\r
+    DEBUG ((EFI_D_ERROR, "SockRoute: Get the access for socket"\r
       " failed with %r", Status));\r
 \r
     return EFI_ACCESS_DENIED;\r
@@ -962,6 +954,6 @@ SockRoute (
   Status = Sock->ProtoHandler (Sock, SOCK_ROUTE, RouteInfo);\r
 \r
 Exit:\r
-  NET_UNLOCK (&(Sock->Lock));\r
+  EfiReleaseLock (&(Sock->Lock));\r
   return Status;\r
 }\r