2 EFI IP4 route table and route cache table defintions.
4 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __EFI_IP4_ROUTE_H__
16 #define __EFI_IP4_ROUTE_H__
18 #include "Ip4Common.h"
20 #define IP4_DIRECT_ROUTE 0x00000001
22 #define IP4_ROUTE_CACHE_HASH_VALUE 31
23 #define IP4_ROUTE_CACHE_MAX 64 // Max NO. of cache entry per hash bucket
25 #define IP4_ROUTE_CACHE_HASH(Dst, Src) (((Dst) ^ (Src)) % IP4_ROUTE_CACHE_HASH_VALUE)
28 /// The route entry in the route table. Dest/Netmask is the destion
29 /// network. The nexthop is the gateway to send the packet to in
30 /// order to reach the Dest/Netmask. If the Flag has IP4_DIRECT_ROUTE
31 /// on, the gateway is the destination of the IP packet itself. Route
32 /// enties of the connected network have the flag on.
44 /// The route cache entry. The route cache entry is optional.
45 /// But it is necessary to support the ICMP redirect message.
46 /// Check Ip4ProcessIcmpRedirect for information.
48 /// The cache entry field Tag is used to tag all the route
49 /// cache entry spawned from a route table entry. This makes
50 /// it simple to delete all the route cache entries from a
51 /// to-be-deleted route entry.
60 } IP4_ROUTE_CACHE_ENTRY
;
63 /// The route cache table is organized as a hash table. Each
64 /// IP4 route table has a embedded route cache. For now the
65 /// route cache and route table are binded togehter. But keep
66 /// the route cache a seperated structure in case we want to
67 /// detach them later.
70 LIST_ENTRY CacheBucket
[IP4_ROUTE_CACHE_HASH_VALUE
];
74 /// Each IP4 instance has its own route table. Each ServiceBinding
75 /// instance has a default route table and default address.
77 /// All the route table entries with the same mask are linked
78 /// together in one route area. For example, RouteArea[0] contains
79 /// the default routes. A route table also contains a route cache.
81 typedef struct _IP4_ROUTE_TABLE IP4_ROUTE_TABLE
;
83 struct _IP4_ROUTE_TABLE
{
86 LIST_ENTRY RouteArea
[IP4_MASK_NUM
];
87 IP4_ROUTE_TABLE
*Next
;
88 IP4_ROUTE_CACHE Cache
;
92 Create an empty route table, includes its internal route cache
94 @return NULL if failed to allocate memory for the route table, otherwise
95 the point to newly created route table.
104 Free the route table and its associated route cache. Route
105 table is reference counted.
107 @param[in] RtTable The route table to free.
112 IN IP4_ROUTE_TABLE
*RtTable
116 Add a route entry to the route table. All the IP4_ADDRs are in
119 @param[in, out] RtTable Route table to add route to
120 @param[in] Dest The destination of the network
121 @param[in] Netmask The netmask of the destination
122 @param[in] Gateway The next hop address
124 @retval EFI_ACCESS_DENIED The same route already exists
125 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry
126 @retval EFI_SUCCESS The route is added successfully.
131 IN OUT IP4_ROUTE_TABLE
*RtTable
,
138 Remove a route entry and all the route caches spawn from it.
140 @param RtTable The route table to remove the route from
141 @param Dest The destination network
142 @param Netmask The netmask of the Dest
143 @param Gateway The next hop address
145 @retval EFI_SUCCESS The route entry is successfully removed
146 @retval EFI_NOT_FOUND There is no route entry in the table with that
152 IN OUT IP4_ROUTE_TABLE
*RtTable
,
159 Find a route cache with the dst and src. This is used by ICMP
160 redirect messasge process. All kinds of redirect is treated as
161 host redirect according to RFC1122. So, only route cache entries
162 are modified according to the ICMP redirect message.
164 @param[in] RtTable The route table to search the cache for
165 @param[in] Dest The destination address
166 @param[in] Src The source address
168 @return NULL if no route entry to the (Dest, Src). Otherwise the point
169 to the correct route cache entry.
172 IP4_ROUTE_CACHE_ENTRY
*
174 IN IP4_ROUTE_TABLE
*RtTable
,
180 Free the route cache entry. It is reference counted.
182 @param RtCacheEntry The route cache entry to free.
186 Ip4FreeRouteCacheEntry (
187 IN IP4_ROUTE_CACHE_ENTRY
*RtCacheEntry
191 Search the route table to route the packet. Return/create a route
192 cache if there is a route to the destination.
194 @param[in] RtTable The route table to search from
195 @param[in] Dest The destination address to search for
196 @param[in] Src The source address to search for
197 @param[in] SubnetMask The subnet mask of the Src address, this field is
198 used to check if the station is using /32 subnet.
199 @param[in] AlwaysTryDestAddr Always try to use the dest address as next hop even
200 though we can't find a matching route entry. This
201 field is only valid when using /32 subnet.
203 @return NULL if failed to route packet, otherwise a route cache
204 entry that can be used to route packet.
207 IP4_ROUTE_CACHE_ENTRY
*
209 IN IP4_ROUTE_TABLE
*RtTable
,
212 IN IP4_ADDR SubnetMask
,
213 IN BOOLEAN AlwaysTryDestAddr
217 Build a EFI_IP4_ROUTE_TABLE to be returned to the caller of
218 GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the
219 internal operation of the IP4 driver.
221 @param[in] IpInstance The IP4 child that requests the route table.
223 @retval EFI_SUCCESS The route table is successfully build
224 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the rotue table.
228 Ip4BuildEfiRouteTable (
229 IN IP4_PROTOCOL
*IpInstance