DSR route request queue Since DSR is an on demand routing we queue requests while looking for route. More...
#include <dsr-rcache.h>
Classes | |
struct | Neighbor |
Public Types | |
typedef std::list < RouteCacheEntry::IP_VECTOR > | routeVector |
Define the vector of route entries. | |
Public Member Functions | |
RouteCache () | |
Constructor. | |
virtual | ~RouteCache () |
Destructor. | |
void | AddArpCache (Ptr< ArpCache >) |
Add ARP cache to be used to allow layer 2 notifications processing. | |
void | AddNeighbor (std::vector< Ipv4Address > nodeList, Ipv4Address ownAddress, Time expire) |
Add to the neighbor list. | |
bool | AddRoute (RouteCacheEntry &rt) |
Add route cache entry if it doesn't yet exist in route cache. More... | |
bool | AddRoute_Link (RouteCacheEntry::IP_VECTOR nodelist, Ipv4Address node) |
uint16_t | CheckUniqueAckId (Ipv4Address nextHop) |
Check for duplicate ids and save new entries if the id is not present in the table. More... | |
void | Clear () |
void | ClearMac () |
Remove all entries. | |
void | DelArpCache (Ptr< ArpCache >) |
Don't use given ARP cache any more (interface is down) | |
void | DeleteAllRoutesIncludeLink (Ipv4Address errorSrc, Ipv4Address unreachNode, Ipv4Address node) |
Delete all the routes which includes the link from next hop address that has just been notified as unreachable. More... | |
bool | DeleteRoute (Ipv4Address dst) |
Delete the route with certain destination address. More... | |
void | DropPathWithDst (Ipv4Address dst) |
Remove all packets with destination IP address dst. | |
bool | FindSameRoute (RouteCacheEntry &rt, std::list< RouteCacheEntry > &rtVector) |
Find the same route in the route cache. More... | |
uint16_t | GetAckSize () |
Get the ack table size. | |
Ipv4Address | GetDestination (void) const |
Get the destination address of the route. | |
Time | GetExpireTime (Ipv4Address addr) |
Return expire time for neighbor node with address addr, if exists, else return 0. | |
Callback< void, WifiMacHeader const & > | GetTxErrorCallback () const |
Get callback to ProcessTxError, this callback is trying to use the wifi mac tx error header to notify a link layer drop event, however, it is not fully supported yet. | |
bool | IsEqual (RouteCacheEntry ca) |
To know if the two entries are the same. | |
bool | IsLinkCache () |
bool | IsNeighbor (Ipv4Address addr) |
Check that node with address addr is neighbor. More... | |
Mac48Address | LookupMacAddress (Ipv4Address) |
Find MAC address by IP using list of ARP caches. | |
bool | LookupRoute (Ipv4Address id, RouteCacheEntry &rt) |
Lookup route cache entry with destination address dst. More... | |
void | Print (std::ostream &os) |
void | PrintRouteVector (std::list< RouteCacheEntry > route) |
Print all the route vector elements from the route list. More... | |
void | PrintVector (std::vector< Ipv4Address > &vec) |
Print the route vector elements. More... | |
void | ProcessTxError (WifiMacHeader const &) |
Process layer 2 TX error notification. | |
void | Purge () |
void | PurgeLinkNode () |
void | PurgeMac () |
Remove all expired mac entries. | |
void | RebuildBestRouteTable (Ipv4Address source) |
USE MAXWEIGHT TO REPRESENT MAX; USE BROADCAST ADDRESS TO REPRESENT NULL PRECEEDING ADDRESS. More... | |
void | RemoveLastEntry (std::list< RouteCacheEntry > &rtVector) |
Remove the aged route cache entries when the route cache is full. | |
void | ScheduleTimer () |
Schedule m_ntimer. | |
void | SetCacheType (std::string type) |
dijsktra algorithm to get the best route from m_netGraph and update the m_bestRoutesTable_link current graph information has changed More... | |
void | UpdateNeighbor (std::vector< Ipv4Address > nodeList, Time expire) |
Update expire time for entry with address addr, if it exists, else add new entry. | |
void | UpdateNetGraph () |
Update the Net Graph for the link and node cache has changed. | |
bool | UpdateRouteEntry (Ipv4Address dst) |
Update route cache entry if it has been recently used and successfully delivered the data packet. More... | |
void | UseExtends (RouteCacheEntry::IP_VECTOR rt) |
bool | GetSubRoute () const |
void | SetSubRoute (bool subRoute) |
uint32_t | GetMaxCacheLen () const |
void | SetMaxCacheLen (uint32_t len) |
Time | GetCacheTimeout () const |
void | SetCacheTimeout (Time t) |
uint32_t | GetMaxEntriesEachDst () const |
void | SetMaxEntriesEachDst (uint32_t entries) |
Time | GetBadLinkLifetime () const |
void | SetBadLinkLifetime (Time t) |
uint64_t | GetStabilityDecrFactor () const |
void | SetStabilityDecrFactor (uint64_t decrFactor) |
uint64_t | GetStabilityIncrFactor () const |
void | SetStabilityIncrFactor (uint64_t incrFactor) |
Time | GetInitStability () const |
void | SetInitStability (Time initStability) |
Time | GetMinLifeTime () const |
void | SetMinLifeTime (Time minLifeTime) |
Time | GetUseExtends () const |
void | SetUseExtends (Time useExtends) |
void | SetCallback (Callback< void, Ipv4Address, uint8_t > cb) |
Callback< void, Ipv4Address, uint8_t > | GetCallback () const |
Public Member Functions inherited from ns3::Object | |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
Public Member Functions inherited from ns3::ObjectBase | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId () |
The Route Cache used by DSR. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Public Attributes | |
std::vector< Ptr< ArpCache > > | m_arp |
list of ARP cached to be used for layer 2 notifications processing | |
Time | m_delay |
This timeout deals with the passive ack. | |
Callback< void, Ipv4Address, uint8_t > | m_handleLinkFailure |
link failure callback More... | |
std::vector< Neighbor > | m_nb |
vector of entries | |
Timer | m_ntimer |
Timer for neighbor's list. Schedule Purge(). | |
Callback< void, WifiMacHeader const & > | m_txErrorCallback |
TX error callback. | |
Private Types | |
typedef std::list < RouteCacheEntry > | routeEntryVector |
Private Member Functions | |
bool | DecStability (Ipv4Address node) |
decrease the stability of the node More... | |
bool | IncStability (Ipv4Address node) |
increase the stability of the node More... | |
bool | LookupRoute_Link (Ipv4Address id, RouteCacheEntry &rt) |
used by LookupRoute when LinkCache More... | |
RouteCache & | operator= (RouteCache const &) |
Private Attributes | |
std::map< Ipv4Address, uint16_t > | m_ackIdCache |
The id cache to ensure all the ids are unique. | |
Time | m_badLinkLifetime |
The time for which the neighboring node is put into the blacklist. | |
std::map< Ipv4Address, RouteCacheEntry::IP_VECTOR > | m_bestRoutesTable_link |
for link route cache | |
Time | m_initStability |
bool | m_isLinkCache |
Check if the route is using path cache or link cache. | |
std::map< Link, LinkStab > | m_linkCache |
The data structure to store link info. | |
uint32_t | m_maxCacheLen |
The maximum number of packets that we allow a routing protocol to buffer. | |
uint32_t | m_maxEntriesEachDst |
number of entries for each destination | |
Time | m_minLifeTime |
std::map< Ipv4Address, std::map< Ipv4Address, uint32_t > > | m_netGraph |
std::map< Ipv4Address, NodeStab > | m_nodeCache |
The data structure to store node info. | |
routeEntryVector | m_routeEntryVector |
Define the route vector. | |
std::map< Ipv4Address, routeEntryVector > | m_sortedRoutes |
Map the ipv4Address to route entry vector. | |
uint32_t | m_stabilityDecrFactor |
uint32_t | m_stabilityIncrFactor |
bool | m_subRoute |
Check if save the sub route entries or not. | |
Time | m_useExtends |
RouteCacheEntry::IP_VECTOR | m_vector |
The route vector to save the ip addresses for intermediate nodes. | |
Time | RouteCacheTimeout |
The maximum period of time that dsr is allowed to for an unused route. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
DSR route request queue Since DSR is an on demand routing we queue requests while looking for route.
Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Definition at line 305 of file dsr-rcache.h.
|
private |
Define the route cache data structure
Definition at line 593 of file dsr-rcache.h.
bool ns3::dsr::RouteCache::AddRoute | ( | RouteCacheEntry & | rt | ) |
Add route cache entry if it doesn't yet exist in route cache.
rt | route cache entry |
Save the new route cache along with the destination address in map
Drop the most aged packet when buffer reaches to max
Save the new route cache along with the destination address in map
Definition at line 655 of file dsr-rcache.cc.
References FindSameRoute(), m_maxEntriesEachDst, m_sortedRoutes, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, and RemoveLastEntry().
bool ns3::dsr::RouteCache::AddRoute_Link | ( | RouteCacheEntry::IP_VECTOR | nodelist, |
Ipv4Address | node | ||
) |
Purge the link node cache first
This is the node stability
Link represent the one link for the route
Link stability
Set the link stability as the smallest node stability
Set the link stability as the m)minLifeTime, default is 1 second
Definition at line 560 of file dsr-rcache.cc.
References ns3::Time::GetSeconds(), m_linkCache, m_nodeCache, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, PurgeLinkNode(), RebuildBestRouteTable(), ns3::dsr::LinkStab::SetLinkStability(), and UpdateNetGraph().
uint16_t ns3::dsr::RouteCache::CheckUniqueAckId | ( | Ipv4Address | nextHop | ) |
Check for duplicate ids and save new entries if the id is not present in the table.
This part of code maintains an Acknowledgment id cache for next hop and remove duplicate ids
Definition at line 1049 of file dsr-rcache.cc.
References m_ackIdCache, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
private |
decrease the stability of the node
node | the ip address of the node we want to decrease stability |
Definition at line 537 of file dsr-rcache.cc.
References m_nodeCache, m_stabilityDecrFactor, NS_LOG_FUNCTION, and NS_LOG_INFO.
Referenced by DeleteAllRoutesIncludeLink().
void ns3::dsr::RouteCache::DeleteAllRoutesIncludeLink | ( | Ipv4Address | errorSrc, |
Ipv4Address | unreachNode, | ||
Ipv4Address | node | ||
) |
Delete all the routes which includes the link from next hop address that has just been notified as unreachable.
errorSrc | The error source address |
unreachNode | The unreachable node |
node | This node's ip address |
TODO get rid of this one
Definition at line 772 of file dsr-rcache.cc.
References DecStability(), m_linkCache, m_nodeCache, m_sortedRoutes, m_subRoute, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC, PurgeLinkNode(), RebuildBestRouteTable(), and UpdateNetGraph().
bool ns3::dsr::RouteCache::DeleteRoute | ( | Ipv4Address | dst | ) |
Delete the route with certain destination address.
dst | the destination address of the routes that should be deleted |
Definition at line 758 of file dsr-rcache.cc.
References m_sortedRoutes, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
bool ns3::dsr::RouteCache::FindSameRoute | ( | RouteCacheEntry & | rt, |
std::list< RouteCacheEntry > & | rtVector | ||
) |
Find the same route in the route cache.
rt | entry with destination address dst, if exists |
rtVector | the route vector |
Definition at line 725 of file dsr-rcache.cc.
References ns3::Time::GetSeconds(), m_sortedRoutes, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by AddRoute().
|
private |
increase the stability of the node
node | the ip address of the node we want to increase stability |
TODO get rid of the debug here
Definition at line 513 of file dsr-rcache.cc.
References ns3::Time::GetSeconds(), m_nodeCache, NS_LOG_FUNCTION, and NS_LOG_INFO.
Referenced by UseExtends().
bool ns3::dsr::RouteCache::IsNeighbor | ( | Ipv4Address | addr | ) |
Check that node with address addr is neighbor.
This part maintains a neighbor list to handle unidirectional links and link-layer acks
Definition at line 1081 of file dsr-rcache.cc.
References m_nb, NS_LOG_FUNCTION, and PurgeMac().
bool ns3::dsr::RouteCache::LookupRoute | ( | Ipv4Address | id, |
RouteCacheEntry & | rt | ||
) |
Lookup route cache entry with destination address dst.
dst | destination address |
rt | entry with destination address dst, if exists |
Definition at line 206 of file dsr-rcache.cc.
References LookupRoute_Link(), m_sortedRoutes, NS_LOG_FUNCTION, NS_LOG_INFO, and NS_LOG_LOGIC.
|
private |
used by LookupRoute when LinkCache
id | the ip address we are looking for |
rt | the route cache entry to store the found one |
We need to purge the link node cache
Definition at line 431 of file dsr-rcache.cc.
References m_bestRoutesTable_link, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, PrintVector(), PurgeLinkNode(), and RouteCacheTimeout.
Referenced by LookupRoute().
void ns3::dsr::RouteCache::PrintRouteVector | ( | std::list< RouteCacheEntry > | route | ) |
Print all the route vector elements from the route list.
route | the route list |
Definition at line 951 of file dsr-rcache.cc.
References NS_LOG_FUNCTION, NS_LOG_INFO, and PrintVector().
void ns3::dsr::RouteCache::PrintVector | ( | std::vector< Ipv4Address > & | vec | ) |
Print the route vector elements.
vec | the route vector |
Definition at line 930 of file dsr-rcache.cc.
References NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by LookupRoute_Link(), PrintRouteVector(), and RebuildBestRouteTable().
void ns3::dsr::RouteCache::PurgeLinkNode | ( | ) |
may need to remove them after verify
Definition at line 463 of file dsr-rcache.cc.
References m_linkCache, m_nodeCache, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Seconds().
Referenced by AddRoute_Link(), DeleteAllRoutesIncludeLink(), LookupRoute_Link(), and UseExtends().
void ns3::dsr::RouteCache::RebuildBestRouteTable | ( | Ipv4Address | source | ) |
USE MAXWEIGHT TO REPRESENT MAX; USE BROADCAST ADDRESS TO REPRESENT NULL PRECEEDING ADDRESS.
The | source address the routes based on |
The followings are initialize-single-source
The followings are core of dijskra algorithm
Definition at line 315 of file dsr-rcache.cc.
References ns3::Ipv4Address::IsBroadcast(), m_bestRoutesTable_link, m_linkCache, m_netGraph, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and PrintVector().
Referenced by AddRoute_Link(), and DeleteAllRoutesIncludeLink().
void ns3::dsr::RouteCache::SetCacheType | ( | std::string | type | ) |
dijsktra algorithm to get the best route from m_netGraph and update the m_bestRoutesTable_link current graph information has changed
The | type of the cache |
Definition at line 289 of file dsr-rcache.cc.
References m_isLinkCache, NS_LOG_FUNCTION, and NS_LOG_INFO.
bool ns3::dsr::RouteCache::UpdateRouteEntry | ( | Ipv4Address | dst | ) |
Update route cache entry if it has been recently used and successfully delivered the data packet.
dst | destination address of the route |
vec | the route vector |
Definition at line 176 of file dsr-rcache.cc.
References m_sortedRoutes, NS_LOG_FUNCTION, NS_LOG_LOGIC, and RouteCacheTimeout.
void ns3::dsr::RouteCache::UseExtends | ( | RouteCacheEntry::IP_VECTOR | rt | ) |
When a link from the Route Cache is used in routing a packet originated or salvaged by that node, the stability metric for each of the two endpoint nodes of that link is incremented by the amount of time since that link was last used. When a link is used in a route chosen for a packet originated or salvaged by this node, the link's lifetime is set to be at least UseExtends into the future
Purge the link node cache first
TODO remove after debug
Increase the stability of the node cache
Definition at line 609 of file dsr-rcache.cc.
References IncStability(), m_linkCache, m_nodeCache, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, and PurgeLinkNode().
Callback<void, Ipv4Address, uint8_t > ns3::dsr::RouteCache::m_handleLinkFailure |
link failure callback
The following code handles link-layer acks
Definition at line 668 of file dsr-rcache.h.
Referenced by PurgeMac().
|
private |
Current network graph state for this node, double is weight, which is calculated by the node information and link information, any time some changes of link cache and node cache change the weight and then recompute the best choice for each node
Definition at line 616 of file dsr-rcache.h.
Referenced by RebuildBestRouteTable(), and UpdateNetGraph().
|
private |
Define the parameters for link cache type
Definition at line 585 of file dsr-rcache.h.
Referenced by DecStability().