MdeModulePkg: Fix IPv4 double free

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Route.h

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h
index 5ba2b578efc5951dff92da67c5c1f4b7c8ec0e8d..778c97dc8b30904904d4713db7d373738a1c05e8 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h
@@ -1,7 +1,8 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+  EFI IP4 route table and route cache table defintions.\r
+  \r
+Copyright (c) 2005 - 2009, 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
@@ -9,16 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-\r
-Module Name:\r
-\r
-  Ip4Route.h\r
-\r
-Abstract:\r
-\r
-  EFI IP4 route table and route cache table defintions.\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_IP4_ROUTE_H__\r
@@ -26,14 +17,12 @@ Abstract:
 \r
 #include "Ip4Common.h"\r
 \r
-typedef enum {\r
-  IP4_DIRECT_ROUTE      = 0x00000001,\r
+#define IP4_DIRECT_ROUTE       0x00000001\r
 \r
-  IP4_ROUTE_CACHE_HASH  = 31,\r
-  IP4_ROUTE_CACHE_MAX   = 64  // Max NO. of cache entry per hash bucket\r
-} IP4_ROUTE_ENUM_TYPES;\r
+#define IP4_ROUTE_CACHE_HASH_VALUE 31\r
+#define IP4_ROUTE_CACHE_MAX        64  // Max NO. of cache entry per hash bucket\r
 \r
-#define IP4_ROUTE_CACHE_HASH(Dst, Src)  (((Dst) ^ (Src)) % IP4_ROUTE_CACHE_HASH)\r
+#define IP4_ROUTE_CACHE_HASH(Dst, Src)  (((Dst) ^ (Src)) % IP4_ROUTE_CACHE_HASH_VALUE)\r
 \r
 ///\r
 /// The route entry in the route table. Dest/Netmask is the destion\r
@@ -78,7 +67,7 @@ typedef struct {
 /// detach them later.\r
 ///\r
 typedef struct {\r
-  LIST_ENTRY                CacheBucket[IP4_ROUTE_CACHE_HASH];\r
+  LIST_ENTRY                CacheBucket[IP4_ROUTE_CACHE_HASH_VALUE];\r
 } IP4_ROUTE_CACHE;\r
 \r
 ///\r
@@ -115,9 +104,7 @@ Ip4CreateRouteTable (
   Free the route table and its associated route cache. Route\r
   table is reference counted.\r
 \r
-  @param  RtTable               The route table to free.\r
-\r
-  @return None\r
+  @param[in]  RtTable               The route table to free.\r
 \r
 **/\r
 VOID\r
@@ -129,10 +116,10 @@ Ip4FreeRouteTable (
   Add a route entry to the route table. All the IP4_ADDRs are in\r
   host byte order.\r
 \r
-  @param  RtTable               Route table to add route to\r
-  @param  Dest                  The destination of the network\r
-  @param  Netmask               The netmask of the destination\r
-  @param  Gateway               The next hop address\r
+  @param[in, out]  RtTable      Route table to add route to\r
+  @param[in]       Dest         The destination of the network\r
+  @param[in]       Netmask      The netmask of the destination\r
+  @param[in]       Gateway      The next hop address\r
 \r
   @retval EFI_ACCESS_DENIED     The same route already exists\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory for the entry\r
@@ -150,10 +137,10 @@ Ip4AddRoute (
 /**\r
   Remove a route entry and all the route caches spawn from it.\r
 \r
-  @param  RtTable               The route table to remove the route from\r
-  @param  Dest                  The destination network\r
-  @param  Netmask               The netmask of the Dest\r
-  @param  Gateway               The next hop address\r
+  @param  RtTable           The route table to remove the route from\r
+  @param  Dest              The destination network\r
+  @param  Netmask           The netmask of the Dest\r
+  @param  Gateway           The next hop address\r
 \r
   @retval EFI_SUCCESS           The route entry is successfully removed\r
   @retval EFI_NOT_FOUND         There is no route entry in the table with that\r
@@ -174,9 +161,9 @@ Ip4DelRoute (
   host redirect according to RFC1122. So, only route cache entries\r
   are modified according to the ICMP redirect message.\r
 \r
-  @param  RtTable               The route table to search the cache for\r
-  @param  Dest                  The destination address\r
-  @param  Src                   The source address\r
+  @param[in]  RtTable               The route table to search the cache for\r
+  @param[in]  Dest                  The destination address\r
+  @param[in]  Src                   The source address\r
 \r
   @return NULL if no route entry to the (Dest, Src). Otherwise the point\r
           to the correct route cache entry.\r
@@ -194,8 +181,6 @@ Ip4FindRouteCache (
 \r
   @param  RtCacheEntry          The route cache entry to free.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 Ip4FreeRouteCacheEntry (\r
@@ -206,9 +191,9 @@ Ip4FreeRouteCacheEntry (
   Search the route table to route the packet. Return/create a route\r
   cache if there is a route to the destination.\r
 \r
-  @param  RtTable               The route table to search from\r
-  @param  Dest                  The destination address to search for\r
-  @param  Src                   The source address to search for\r
+  @param[in]  RtTable               The route table to search from\r
+  @param[in]  Dest                  The destination address to search for\r
+  @param[in]  Src                   The source address to search for\r
 \r
   @return NULL if failed to route packet, otherwise a route cache\r
           entry that can be used to route packet.\r
@@ -226,7 +211,7 @@ Ip4Route (
   GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the\r
   internal operation of the IP4 driver.\r
 \r
-  @param  IpInstance            The IP4 child that requests the route table.\r
+  @param[in]  IpInstance        The IP4 child that requests the route table.\r
 \r
   @retval EFI_SUCCESS           The route table is successfully build\r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate the memory for the rotue table.\r