router.h File Reference

#include <neighbor.h>

Include dependency graph for router.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_FIB_ENTRY

Typedefs
typedef struct _FIB_ENTRY	FIB_ENTRY
typedef struct _FIB_ENTRY *	PFIB_ENTRY

Functions
PFIB_ENTRY	RouterAddRoute (PIP_ADDRESS NetworkAddress, PIP_ADDRESS Netmask, PNEIGHBOR_CACHE_ENTRY Router, UINT Metric)
PNEIGHBOR_CACHE_ENTRY	RouterGetRoute (PIP_ADDRESS Destination)
NTSTATUS	RouterRemoveRoute (PIP_ADDRESS Target, PIP_ADDRESS Router)
PFIB_ENTRY	RouterCreateRoute (PIP_ADDRESS NetworkAddress, PIP_ADDRESS Netmask, PIP_ADDRESS RouterAddress, PIP_INTERFACE Interface)
NTSTATUS	RouterStartup (VOID)
NTSTATUS	RouterShutdown (VOID)
VOID	RouterRemoveRoutesForInterface (PIP_INTERFACE Interface)
UINT	CountFIBs (PIP_INTERFACE IF)
UINT	CopyFIBs (PIP_INTERFACE IF, PFIB_ENTRY Target)
UINT	ProcessAutoMetric (PIP_INTERFACE Interface)

Typedef Documentation

FIB_ENTRY

typedef struct _FIB_ENTRY FIB_ENTRY

PFIB_ENTRY

typedef struct _FIB_ENTRY * PFIB_ENTRY

Function Documentation

CopyFIBs()

UINT CopyFIBs	(	PIP_INTERFACE	IF,
		PFIB_ENTRY	Target
	)

Definition at line 150 of file router.c.

                                                     {
    UINT FibCount = 0;
    PLIST_ENTRY CurrentEntry;
    PLIST_ENTRY NextEntry;
    PFIB_ENTRY Current;
 
    CurrentEntry = FIBListHead.Flink;
    while (CurrentEntry != &FIBListHead) {
        NextEntry = CurrentEntry->Flink;
    Current = CONTAINING_RECORD(CurrentEntry, FIB_ENTRY, ListEntry);
        if (Current->Router->Interface == IF)
        {
        Target[FibCount] = *Current;
        FibCount++;
        }
        CurrentEntry = NextEntry;
    }
 
    return FibCount;
}

Referenced by InfoTdiQueryGetRouteTable().

CountFIBs()

UINT CountFIBs

(

PIP_INTERFACE

IF

)

Definition at line 131 of file router.c.

                                 {
    UINT FibCount = 0;
    PLIST_ENTRY CurrentEntry;
    PLIST_ENTRY NextEntry;
    PFIB_ENTRY Current;
 
    CurrentEntry = FIBListHead.Flink;
    while (CurrentEntry != &FIBListHead) {
        NextEntry = CurrentEntry->Flink;
        Current = CONTAINING_RECORD(CurrentEntry, FIB_ENTRY, ListEntry);
        if (Current->Router->Interface == IF)
        FibCount++;
        CurrentEntry = NextEntry;
    }
 
    return FibCount;
}

Referenced by InfoTdiQueryGetIPSnmpInfo(), and InfoTdiQueryGetRouteTable().

ProcessAutoMetric()

UINT ProcessAutoMetric

(

PIP_INTERFACE

Interface

)

RouterAddRoute()

PFIB_ENTRY RouterAddRoute	(	PIP_ADDRESS	NetworkAddress,
		PIP_ADDRESS	Netmask,
		PNEIGHBOR_CACHE_ENTRY	Router,
		UINT	Metric
	)

Definition at line 219 of file router.c.

{
    PFIB_ENTRY FIBE;
 
    TI_DbgPrint(DEBUG_ROUTER, ("Called. NetworkAddress (0x%X)  Netmask (0x%X) "
        "Router (0x%X)  Metric (%d).\n", NetworkAddress, Netmask, Router, Metric));
 
    TI_DbgPrint(DEBUG_ROUTER, ("NetworkAddress (%s)  Netmask (%s)  Router (%s).\n",
                   A2S(NetworkAddress),
                   A2S(Netmask),
                   A2S(&Router->Address)));
 
    FIBE = ExAllocatePoolWithTag(NonPagedPool, sizeof(FIB_ENTRY), FIB_TAG);
    if (!FIBE) {
        TI_DbgPrint(MIN_TRACE, ("Insufficient resources.\n"));
        return NULL;
    }
 
    RtlCopyMemory( &FIBE->NetworkAddress, NetworkAddress,
           sizeof(FIBE->NetworkAddress) );
    RtlCopyMemory( &FIBE->Netmask, Netmask,
           sizeof(FIBE->Netmask) );
    FIBE->Router         = Router;
    FIBE->Metric         = Metric;
 
    /* Add FIB to the forward information base */
    TcpipInterlockedInsertTailList(&FIBListHead, &FIBE->ListEntry, &FIBLock);
 
    return FIBE;
}

Referenced by IPAddInterfaceRoute(), and RouterCreateRoute().

RouterCreateRoute()

PFIB_ENTRY RouterCreateRoute	(	PIP_ADDRESS	NetworkAddress,
		PIP_ADDRESS	Netmask,
		PIP_ADDRESS	RouterAddress,
		PIP_INTERFACE	Interface
	)

Definition at line 451 of file router.c.

{
    KIRQL OldIrql;
    PLIST_ENTRY CurrentEntry;
    PLIST_ENTRY NextEntry;
    PFIB_ENTRY Current;
    PNEIGHBOR_CACHE_ENTRY NCE;
 
    TcpipAcquireSpinLock(&FIBLock, &OldIrql);
 
    CurrentEntry = FIBListHead.Flink;
    while (CurrentEntry != &FIBListHead) {
        NextEntry = CurrentEntry->Flink;
        Current = CONTAINING_RECORD(CurrentEntry, FIB_ENTRY, ListEntry);
 
        NCE   = Current->Router;
 
        if(AddrIsEqual(NetworkAddress, &Current->NetworkAddress) &&
           AddrIsEqual(Netmask, &Current->Netmask) &&
           NCE->Interface == Interface)
        {
            TI_DbgPrint(DEBUG_ROUTER,("Attempting to add duplicate route to %s\n", A2S(NetworkAddress)));
            TcpipReleaseSpinLock(&FIBLock, OldIrql);
            return NULL;
        }
 
        CurrentEntry = NextEntry;
    }
 
    TcpipReleaseSpinLock(&FIBLock, OldIrql);
 
    /* The NCE references RouterAddress. The NCE is referenced for us */
    NCE = NBFindOrCreateNeighbor(Interface, RouterAddress, TRUE);
 
    if (!NCE) {
        /* Not enough free resources */
        return NULL;
    }
 
    return RouterAddRoute(NetworkAddress, Netmask, NCE, ProcessAutoMetric(Interface));
}

Referenced by InfoTdiSetRoute(), and ReadIpConfiguration().

RouterGetRoute()

PNEIGHBOR_CACHE_ENTRY RouterGetRoute

(

PIP_ADDRESS

Destination

)

Definition at line 269 of file router.c.

{
    KIRQL OldIrql;
    PLIST_ENTRY CurrentEntry;
    PLIST_ENTRY NextEntry;
    PFIB_ENTRY Current;
    UCHAR State;
    UINT Length, BestLength = 0, MaskLength;
    PNEIGHBOR_CACHE_ENTRY NCE, BestNCE = NULL;
 
    TI_DbgPrint(DEBUG_ROUTER, ("Called. Destination (0x%X)\n", Destination));
 
    TI_DbgPrint(DEBUG_ROUTER, ("Destination (%s)\n", A2S(Destination)));
 
    TcpipAcquireSpinLock(&FIBLock, &OldIrql);
 
    CurrentEntry = FIBListHead.Flink;
    while (CurrentEntry != &FIBListHead) {
        NextEntry = CurrentEntry->Flink;
        Current = CONTAINING_RECORD(CurrentEntry, FIB_ENTRY, ListEntry);
 
        NCE   = Current->Router;
        State = NCE->State;
 
    Length = CommonPrefixLength(Destination, &Current->NetworkAddress);
    MaskLength = AddrCountPrefixBits(&Current->Netmask);
 
    TI_DbgPrint(DEBUG_ROUTER,("This-Route: %s (Sharing %d bits)\n",
                  A2S(&NCE->Address), Length));
 
    if(Length >= MaskLength && (Length > BestLength || !BestNCE) &&
           ((!(State & NUD_STALE) && !(State & NUD_INCOMPLETE)) || !BestNCE)) {
        /* This seems to be a better router */
        BestNCE    = NCE;
        BestLength = Length;
        TI_DbgPrint(DEBUG_ROUTER,("Route selected\n"));
    }
 
        CurrentEntry = NextEntry;
    }
 
    TcpipReleaseSpinLock(&FIBLock, OldIrql);
 
    if( BestNCE ) {
    TI_DbgPrint(DEBUG_ROUTER,("Routing to %s\n", A2S(&BestNCE->Address)));
    } else {
    TI_DbgPrint(DEBUG_ROUTER,("Packet won't be routed\n"));
    }
 
    return BestNCE;
}

Referenced by RouteGetRouteToDestination().

RouterRemoveRoute()

NTSTATUS RouterRemoveRoute	(	PIP_ADDRESS	Target,
		PIP_ADDRESS	Router
	)

Definition at line 394 of file router.c.

{
    KIRQL OldIrql;
    PLIST_ENTRY CurrentEntry;
    PLIST_ENTRY NextEntry;
    PFIB_ENTRY Current;
    BOOLEAN Found = FALSE;
    PNEIGHBOR_CACHE_ENTRY NCE;
 
    TI_DbgPrint(DEBUG_ROUTER, ("Called\n"));
    TI_DbgPrint(DEBUG_ROUTER, ("Deleting Route From: %s\n", A2S(Router)));
    TI_DbgPrint(DEBUG_ROUTER, ("                 To: %s\n", A2S(Target)));
 
    TcpipAcquireSpinLock(&FIBLock, &OldIrql);
 
    RouterDumpRoutes();
 
    CurrentEntry = FIBListHead.Flink;
    while (CurrentEntry != &FIBListHead) {
        NextEntry = CurrentEntry->Flink;
    Current = CONTAINING_RECORD(CurrentEntry, FIB_ENTRY, ListEntry);
 
        NCE   = Current->Router;
 
    if( AddrIsEqual( &Current->NetworkAddress, Target ) &&
        AddrIsEqual( &NCE->Address, Router ) ) {
        Found = TRUE;
        break;
    }
 
    Current = NULL;
        CurrentEntry = NextEntry;
    }
 
    if( Found ) {
        TI_DbgPrint(DEBUG_ROUTER, ("Deleting route\n"));
        DestroyFIBE( Current );
    }
 
    RouterDumpRoutes();
 
    TcpipReleaseSpinLock(&FIBLock, OldIrql);
 
    TI_DbgPrint(DEBUG_ROUTER, ("Leaving\n"));
 
    return Found ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL;
}

Referenced by InfoTdiSetRoute(), and IPRemoveInterfaceRoute().

RouterRemoveRoutesForInterface()

VOID RouterRemoveRoutesForInterface

(

PIP_INTERFACE

Interface

)

Definition at line 371 of file router.c.

{
    KIRQL OldIrql;
    PLIST_ENTRY CurrentEntry;
    PLIST_ENTRY NextEntry;
    PFIB_ENTRY Current;
 
    TcpipAcquireSpinLock(&FIBLock, &OldIrql);
 
    CurrentEntry = FIBListHead.Flink;
    while (CurrentEntry != &FIBListHead) {
        NextEntry = CurrentEntry->Flink;
        Current = CONTAINING_RECORD(CurrentEntry, FIB_ENTRY, ListEntry);
 
        if (Interface == Current->Router->Interface)
            DestroyFIBE(Current);
 
        CurrentEntry = NextEntry;
    }
 
    TcpipReleaseSpinLock(&FIBLock, OldIrql);
}

Referenced by ReconfigureAdapter().

RouterShutdown()

NTSTATUS RouterShutdown

(

VOID

)

Definition at line 528 of file router.c.

{
    KIRQL OldIrql;
 
    TI_DbgPrint(DEBUG_ROUTER, ("Called.\n"));
 
    /* Clear Forward Information Base */
    TcpipAcquireSpinLock(&FIBLock, &OldIrql);
    DestroyFIBEs();
    TcpipReleaseSpinLock(&FIBLock, OldIrql);
 
    return STATUS_SUCCESS;
}

Referenced by IPShutdown().

RouterStartup()

NTSTATUS RouterStartup

(

VOID

)

Definition at line 510 of file router.c.

{
    TI_DbgPrint(DEBUG_ROUTER, ("Called.\n"));
 
    /* Initialize the Forward Information Base */
    InitializeListHead(&FIBListHead);
    TcpipInitializeSpinLock(&FIBLock);
 
    return STATUS_SUCCESS;
}

Referenced by IPStartup().