/** @file
The functions and routines to handle the route caches and route table.
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Ip6Impl.h"
/**
This is the worker function for IP6_ROUTE_CACHE_HASH(). It calculates the value
as the index of the route cache bucket according to the prefix of two IPv6 addresses.
@param[in] Ip1 The IPv6 address.
@param[in] Ip2 The IPv6 address.
@return The hash value of the prefix of two IPv6 addresses.
**/
)
{
}
/**
Allocate a route entry then initialize it with the Destination/PrefixLength
and Gateway.
@param[in] Destination The IPv6 destination address. This is an optional
parameter that may be NULL.
@param[in] PrefixLength The destination network's prefix length.
@param[in] GatewayAddress The next hop address. This is an optional parameter
that may be NULL.
@return NULL if failed to allocate memeory; otherwise, the newly created route entry.
**/
)
{
return NULL;
}
if (Destination != NULL) {
}
if (GatewayAddress != NULL) {
}
return RtEntry;
}
/**
Free the route table entry. It is reference counted.
@param[in, out] RtEntry The route entry to free.
**/
)
{
}
}
/**
Search the route table for a most specific match to the Dst. It searches
from the longest route area (prefix length == 128) to the shortest route area
(default routes). In each route area, it will first search the instance's
route table, then the default route table. This is required per the following
requirements:
1. IP search the route table for a most specific match.
2. The local route entries have precedence over the default route entry.
@param[in] RtTable The route table to search from.
@param[in] Destination The destionation address to search. If NULL, search
the route table by NextHop.
@param[in] NextHop The next hop address. If NULL, search the route table
by Destination.
@return NULL if no route matches the Dst. Otherwise, the point to the
@return most specific route to the Dst.
**/
)
{
if (Destination != NULL) {
return RtEntry;
}
return RtEntry;
}
}
}
}
return NULL;
}
/**
Allocate and initialize a IP6 route cache entry.
@param[in] Dst The destination address.
@param[in] Src The source address.
@param[in] GateWay The next hop address.
@param[in] Tag The tag from the caller. This marks all the cache entries
spawned from one route table entry.
@return NULL if failed to allocate memory for the cache. Otherwise, point
to the created route cache entry.
**/
)
{
if (RtCacheEntry == NULL) {
return NULL;
}
return RtCacheEntry;
}
/**
Free the route cache entry. It is reference counted.
@param[in, out] RtCacheEntry The route cache entry to free.
**/
)
{
if (--RtCacheEntry->RefCnt == 0) {
}
}
/**
Find a route cache with the destination and source address. This is
used by the ICMPv6 redirect messasge process.
@param[in] RtTable The route table to search the cache for.
@param[in] Dest The destination address.
@param[in] Src The source address.
@return NULL if no route entry to the (Dest, Src). Otherwise, the pointer
to the correct route cache entry.
**/
)
{
if (EFI_IP6_EQUAL (Dest, &RtCacheEntry->Destination)&& EFI_IP6_EQUAL (Src, &RtCacheEntry->Source)) {
return RtCacheEntry;
}
}
return NULL;
}
/**
Build an array of EFI_IP6_ROUTE_TABLE to be returned to the caller. The number
of EFI_IP6_ROUTE_TABLE is also returned.
@param[in] RouteTable The pointer of IP6_ROUTE_TABLE internal used.
@param[out] EfiRouteCount The number of returned route entries.
@param[out] EfiRouteTable The pointer to the array of EFI_IP6_ROUTE_TABLE.
If NULL, only the route entry count is returned.
@retval EFI_SUCCESS The EFI_IP6_ROUTE_TABLE successfully built.
@retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the route table.
**/
)
{
*EfiRouteCount = Count;
return EFI_SUCCESS;
}
if (*EfiRouteTable == NULL) {
if (*EfiRouteTable == NULL) {
return EFI_OUT_OF_RESOURCES;
}
}
//
// Copy the route entry to EFI route table.
//
Count = 0;
);
Count++;
}
}
return EFI_SUCCESS;
}
/**
Create an empty route table. This includes its internal route cache.
@return NULL if failed to allocate memory for the route table. Otherwise,
the point to newly created route table.
**/
)
{
return NULL;
}
}
}
return RtTable;
}
/**
Free the route table and its associated route cache. Route
table is reference counted.
@param[in, out] RtTable The route table to free.
**/
)
{
return ;
}
//
// Free all the route table entry and its route cache.
//
}
}
}
}
}
/**
Remove all the cache entries bearing the Tag. When a route cache
entry is created, it is tagged with the address of route entry
from which it is spawned. When a route entry is deleted, the cache
entries spawned from it are also deleted.
@param[in] RtCache Route cache to remove the entries from.
@param[in] Tag The Tag of the entries to remove.
**/
)
{
}
}
}
}
/**
Add a route entry to the route table. It is the help function for EfiIp6Routes.
@param[in, out] RtTable Route table to add route to.
@param[in] Destination The destination of the network.
@param[in] PrefixLength The PrefixLength of the destination.
@param[in] GatewayAddress The next hop address.
@retval EFI_ACCESS_DENIED The same route already exists.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the entry.
@retval EFI_SUCCESS The route was added successfully.
**/
)
{
//
// First check whether the route exists
//
return EFI_ACCESS_DENIED;
}
}
//
// Create a route entry and insert it to the route area.
//
return EFI_OUT_OF_RESOURCES;
}
if (NetIp6IsUnspecifiedAddr (GatewayAddress)) {
}
return EFI_SUCCESS;
}
/**
Remove a route entry and all the route caches spawn from it.
It is the help function for EfiIp6Routes.
@param[in, out] RtTable The route table to remove the route from.
@param[in] Destination The destination network.
@param[in] PrefixLength The PrefixLength of the Destination.
@param[in] GatewayAddress The next hop address.
@retval EFI_SUCCESS The route entry was successfully removed.
@retval EFI_NOT_FOUND There is no route entry in the table with that
property.
**/
)
{
continue;
}
continue;
}
}
}
/**
cache if there is a route to the destination.
@param[in] IpSb The IP6 service data.
@param[in] Dest The destination address to search for.
@param[in] Src The source address to search for.
@return NULL if it failed to route the packet. Otherwise, a route cache
entry that can be used to route packets.
**/
Ip6Route (
)
{
//
// Search the destination cache in IP6_ROUTE_TABLE.
//
//
// If found, promote the cache entry to the head of the hash bucket.
//
if (RtCacheEntry != NULL) {
return RtCacheEntry;
}
//
// Search the route table for the most specific route
//
return NULL;
}
//
// Found a route to the Dest, if it is a direct route, the packet
// will be send directly to the destination, such as for connected
// network. Otherwise, it is an indirect route, the packet will be
// send the next hop router.
//
} else {
}
//
// Create a route cache entry, and tag it as spawned from this route entry
//
if (RtCacheEntry == NULL) {
return NULL;
}
return RtCacheEntry;
}