]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/Tcp4Dxe/Tcp4Dispatcher.c
refine the code and add more security check.
[mirror_edk2.git] / MdeModulePkg / Universal / Network / Tcp4Dxe / Tcp4Dispatcher.c
index d63c294945bacbe34d06696b19c2d315504abb42..664d25a1a2aa4c03afb544daaf280e161f4cbc4e 100644 (file)
@@ -1,21 +1,15 @@
 /** @file\r
+  Tcp request dispatcher implementation.\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+Copyright (c) 2005 - 2010, 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
-  Tcp4Dispatcher.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #include "Tcp4Main.h"\r
@@ -23,43 +17,33 @@ Abstract:
 #define TCP_COMP_VAL(Min, Max, Default, Val) \\r
   ((((Val) <= (Max)) && ((Val) >= (Min))) ? (Val) : (Default))\r
 \r
-STATIC\r
+/**\r
+  Add or remove a route entry in the IP route table associated with this TCP instance.\r
+\r
+  @param  Tcb                   Pointer to the TCP_CB of this TCP instance.\r
+  @param  RouteInfo             Pointer to the route info to be processed.\r
+\r
+  @retval EFI_SUCCESS           The operation completed successfully.\r
+  @retval EFI_NOT_STARTED       The driver instance has not been started.\r
+  @retval EFI_NO_MAPPING        When using the default address, configuration(DHCP,\r
+                                BOOTP, RARP, etc.) is not finished yet.\r
+  @retval EFI_OUT_OF_RESOURCES  Could not add the entry to the routing table.\r
+  @retval EFI_NOT_FOUND         This route is not in the routing table\r
+                                (when RouteInfo->DeleteRoute is TRUE).\r
+  @retval EFI_ACCESS_DENIED     The route is already defined in the routing table\r
+                                (when RouteInfo->DeleteRoute is FALSE).\r
+**/\r
 EFI_STATUS\r
 Tcp4Route (\r
   IN TCP_CB           *Tcb,\r
   IN TCP4_ROUTE_INFO  *RouteInfo\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Add or remove a route entry in the IP route table associated\r
-  with this TCP instance.\r
-\r
-Arguments:\r
-\r
-  Tcb       - Pointer to the TCP_CB of this TCP instance.\r
-  RouteInfo - Pointer to the route info to be processed.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS          - The operation completed successfully.\r
-  EFI_NOT_STARTED      - The driver instance has not been started.\r
-  EFI_NO_MAPPING       - When using the default address, configuration(DHCP,\r
-                         BOOTP, RARP, etc.) is not finished yet.\r
-  EFI_OUT_OF_RESOURCES - Could not add the entry to the routing table.\r
-  EFI_NOT_FOUND        - This route is not in the routing table\r
-                         (when RouteInfo->DeleteRoute is TRUE).\r
-  EFI_ACCESS_DENIED    - The route is already defined in the routing table\r
-                         (when RouteInfo->DeleteRoute is FALSE).\r
-\r
---*/\r
 {\r
   EFI_IP4_PROTOCOL  *Ip;\r
 \r
   Ip = Tcb->IpInfo->Ip;\r
 \r
-  ASSERT (Ip);\r
+  ASSERT (Ip != NULL);\r
 \r
   return Ip->Routes (\r
               Ip,\r
@@ -84,11 +68,10 @@ Returns:
                                  instance hasn't been started.\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 Tcp4GetMode (\r
-  IN TCP_CB         *Tcb,\r
-  IN TCP4_MODE_DATA *Mode\r
+  IN     TCP_CB         *Tcb,\r
+  IN OUT TCP4_MODE_DATA *Mode\r
   )\r
 {\r
   SOCKET                *Sock;\r
@@ -103,18 +86,18 @@ Tcp4GetMode (
     return EFI_NOT_STARTED;\r
   }\r
 \r
-  if (Mode->Tcp4State) {\r
+  if (Mode->Tcp4State != NULL) {\r
     *(Mode->Tcp4State) = (EFI_TCP4_CONNECTION_STATE) Tcb->State;\r
   }\r
 \r
-  if (Mode->Tcp4ConfigData) {\r
+  if (Mode->Tcp4ConfigData != NULL) {\r
 \r
     ConfigData                      = Mode->Tcp4ConfigData;\r
     AccessPoint                     = &(ConfigData->AccessPoint);\r
     Option                          = ConfigData->ControlOption;\r
 \r
-    ConfigData->TypeOfService       = Tcb->TOS;\r
-    ConfigData->TimeToLive          = Tcb->TTL;\r
+    ConfigData->TypeOfService       = Tcb->Tos;\r
+    ConfigData->TimeToLive          = Tcb->Ttl;\r
 \r
     AccessPoint->UseDefaultAddress  = Tcb->UseDefaultAddr;\r
 \r
@@ -149,7 +132,7 @@ Tcp4GetMode (
   }\r
 \r
   Ip = Tcb->IpInfo->Ip;\r
-  ASSERT (Ip);\r
+  ASSERT (Ip != NULL);\r
 \r
   return Ip->GetModeData (Ip, Mode->Ip4ModeData, Mode->MnpConfigData, Mode->SnpModeData);\r
 }\r
@@ -167,7 +150,6 @@ Tcp4GetMode (
   @retval EFI_OUT_OF_RESOURCES   No port can be allocated.\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 Tcp4Bind (\r
   IN EFI_TCP4_ACCESS_POINT *AP\r
@@ -223,14 +205,11 @@ Tcp4Bind (
 \r
 \r
 /**\r
-  Flush the Tcb add its associated protocols..\r
+  Flush the Tcb add its associated protocols.\r
 \r
   @param  Tcb                    Pointer to the TCP_CB to be flushed.\r
 \r
-  @retval EFI_SUCCESS            The operation is completed successfully.\r
-\r
 **/\r
-STATIC\r
 VOID\r
 Tcp4FlushPcb (\r
   IN TCP_CB *Tcb\r
@@ -248,14 +227,16 @@ Tcp4FlushPcb (
     RemoveEntryList (&Tcb->List);\r
 \r
     //\r
-    // Uninstall the device path protocl.\r
+    // Uninstall the device path protocol.\r
     //\r
-    gBS->UninstallProtocolInterface (\r
-           Sock->SockHandle,\r
-           &gEfiDevicePathProtocolGuid,\r
-           Sock->DevicePath\r
-           );\r
-    gBS->FreePool (Sock->DevicePath);\r
+    if (Sock->DevicePath != NULL) {\r
+      gBS->UninstallProtocolInterface (\r
+             Sock->SockHandle,\r
+             &gEfiDevicePathProtocolGuid,\r
+             Sock->DevicePath\r
+             );\r
+      FreePool (Sock->DevicePath);\r
+    }\r
 \r
     TcpSetVariableData (TcpProto->TcpService);\r
   }\r
@@ -264,7 +245,15 @@ Tcp4FlushPcb (
   NetbufFreeList (&Tcb->RcvQue);\r
 }\r
 \r
-STATIC\r
+/**\r
+  Attach a Pcb to the socket.\r
+\r
+  @param  Sk                     Pointer to the socket of this TCP instance.\r
+\r
+  @retval EFI_SUCCESS            The operation is completed successfully.\r
+  @retval EFI_OUT_OF_RESOURCES   Failed due to resource limit.\r
+\r
+**/\r
 EFI_STATUS\r
 Tcp4AttachPcb (\r
   IN SOCKET  *Sk\r
@@ -292,7 +281,7 @@ Tcp4AttachPcb (
   Tcb->IpInfo = IpIoAddIp (IpIo);\r
   if (Tcb->IpInfo == NULL) {\r
 \r
-    gBS->FreePool (Tcb);\r
+    FreePool (Tcb);\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
@@ -307,7 +296,12 @@ Tcp4AttachPcb (
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
+/**\r
+  Detach the Pcb of the socket.\r
+\r
+  @param  Sk                     Pointer to the socket of this TCP instance.\r
+\r
+**/\r
 VOID\r
 Tcp4DetachPcb (\r
   IN SOCKET  *Sk\r
@@ -325,17 +319,16 @@ Tcp4DetachPcb (
 \r
   IpIoRemoveIp (ProtoData->TcpService->IpIo, Tcb->IpInfo);\r
 \r
-  gBS->FreePool (Tcb);\r
+  FreePool (Tcb);\r
 \r
   ProtoData->TcpPcb = NULL;\r
 }\r
 \r
 \r
 /**\r
-  Configure the Tcb using CfgData.\r
+  Configure the Pcb using CfgData.\r
 \r
   @param  Sk                     Pointer to the socket of this TCP instance.\r
-  @param  SkTcb                  Pointer to the TCP_CB of this TCP instance.\r
   @param  CfgData                Pointer to the TCP configuration data.\r
 \r
   @retval EFI_SUCCESS            The operation is completed successfully.\r
@@ -344,7 +337,6 @@ Tcp4DetachPcb (
   @retval EFI_OUT_OF_RESOURCES   Failed due to resource limit.\r
 \r
 **/\r
-STATIC\r
 EFI_STATUS\r
 Tcp4ConfigurePcb (\r
   IN SOCKET               *Sk,\r
@@ -357,7 +349,7 @@ Tcp4ConfigurePcb (
   TCP4_PROTO_DATA     *TcpProto;\r
   TCP_CB              *Tcb;\r
 \r
-  ASSERT (CfgData && Sk && Sk->SockHandle);\r
+  ASSERT ((CfgData != NULL) && (Sk != NULL) && (Sk->SockHandle != NULL));\r
 \r
   TcpProto = (TCP4_PROTO_DATA *) Sk->ProtoReserved;\r
   Tcb      = TcpProto->TcpPcb;\r
@@ -367,7 +359,7 @@ Tcp4ConfigurePcb (
   //\r
   // Add Ip for send pkt to the peer\r
   //\r
-  CopyMem (&IpCfgData, &mIpIoDefaultIpConfigData, sizeof (IpCfgData));\r
+  CopyMem (&IpCfgData, &mIp4IoDefaultIpConfigData, sizeof (IpCfgData));\r
   IpCfgData.DefaultProtocol   = EFI_IP_PROTO_TCP;\r
   IpCfgData.UseDefaultAddress = CfgData->AccessPoint.UseDefaultAddress;\r
   IpCfgData.StationAddress    = CfgData->AccessPoint.StationAddress;\r
@@ -434,8 +426,8 @@ Tcp4ConfigurePcb (
   //\r
   // initialize Tcb in the light of CfgData\r
   //\r
-  Tcb->TTL            = CfgData->TimeToLive;\r
-  Tcb->TOS            = CfgData->TypeOfService;\r
+  Tcb->Ttl            = CfgData->TimeToLive;\r
+  Tcb->Tos            = CfgData->TypeOfService;\r
 \r
   Tcb->UseDefaultAddr = CfgData->AccessPoint.UseDefaultAddress;\r
 \r
@@ -540,15 +532,15 @@ Tcp4ConfigurePcb (
                             (UINT32) (Option->ConnectionTimeout * TCP_TICK_HZ)\r
                             );\r
 \r
-    if (Option->EnableNagle == FALSE) {\r
+    if (!Option->EnableNagle) {\r
       TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_NAGLE);\r
     }\r
 \r
-    if (Option->EnableTimeStamp == FALSE) {\r
+    if (!Option->EnableTimeStamp) {\r
       TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_TS);\r
     }\r
 \r
-    if (Option->EnableWindowScaling == FALSE) {\r
+    if (!Option->EnableWindowScaling) {\r
       TCP_SET_FLG (Tcb->CtrlFlag, TCP_CTRL_NO_WS);\r
     }\r
   }\r
@@ -565,7 +557,7 @@ Tcp4ConfigurePcb (
   //\r
   // update state of Tcb and socket\r
   //\r
-  if (CfgData->AccessPoint.ActiveFlag == FALSE) {\r
+  if (!CfgData->AccessPoint.ActiveFlag) {\r
 \r
     TcpSetState (Tcb, TCP_LISTEN);\r
     SockSetState (Sk, SO_LISTENING);\r
@@ -602,7 +594,7 @@ OnExit:
 EFI_STATUS\r
 Tcp4Dispatcher (\r
   IN SOCKET                  *Sock,\r
-  IN SOCK_REQUEST            Request,\r
+  IN UINT8                   Request,\r
   IN VOID                    *Data    OPTIONAL\r
   )\r
 {\r
@@ -615,7 +607,7 @@ Tcp4Dispatcher (
 \r
   switch (Request) {\r
   case SOCK_POLL:\r
-    Ip = ProtoData->TcpService->IpIo->Ip;\r
+    Ip = (EFI_IP4_PROTOCOL *) (ProtoData->TcpService->IpIo->Ip);\r
     Ip->Poll (Ip);\r
     break;\r
 \r
@@ -625,13 +617,13 @@ Tcp4Dispatcher (
     // notify TCP using this message to give it a chance to send out\r
     // window update information\r
     //\r
-    ASSERT (Tcb);\r
+    ASSERT (Tcb != NULL);\r
     TcpOnAppConsume (Tcb);\r
     break;\r
 \r
   case SOCK_SND:\r
 \r
-    ASSERT (Tcb);\r
+    ASSERT (Tcb != NULL);\r
     TcpOnAppSend (Tcb);\r
     break;\r
 \r
@@ -694,7 +686,7 @@ Tcp4Dispatcher (
 \r
   case SOCK_MODE:\r
 \r
-    ASSERT (Data && Tcb);\r
+    ASSERT ((Data != NULL) && (Tcb != NULL));\r
 \r
     return Tcp4GetMode (Tcb, (TCP4_MODE_DATA *) Data);\r
 \r
@@ -702,7 +694,7 @@ Tcp4Dispatcher (
 \r
   case SOCK_ROUTE:\r
 \r
-    ASSERT (Data && Tcb);\r
+    ASSERT ((Data != NULL) && (Tcb != NULL));\r
 \r
     return Tcp4Route (Tcb, (TCP4_ROUTE_INFO *) Data);\r
 \r