24#include "ns3/address-utils.h"
25#include "ns3/ipv4-route.h"
27#include "ns3/packet.h"
28#include "ns3/simulator.h"
29#include "ns3/socket.h"
30#include "ns3/wifi-mac-header.h"
105 : m_ackTimer(
Timer::CANCEL_ON_DESTROY),
110 m_blackListState(false),
146 m_maxEntriesEachDst(3),
147 m_isLinkCache(false),
148 m_ntimer(
Timer::CANCEL_ON_DESTROY),
180 NS_LOG_LOGIC(
"Failed to find the route entry for the destination " << dst);
185 std::list<DsrRouteCacheEntry> rtVector = i->second;
188 rtVector.pop_front();
189 rtVector.push_back(successEntry);
195 auto result =
m_sortedRoutes.insert(std::make_pair(dst, rtVector));
196 return result.second;
213 NS_LOG_LOGIC(
"Route to " <<
id <<
" not found; m_sortedRoutes is empty");
222 std::list<DsrRouteCacheEntry> rtVector =
227 for (
auto k = rtVector.begin(); k != rtVector.end(); ++k)
235 changeVector.push_back(*l);
246 if ((changeVector.size() <
routeVector.size()) && (changeVector.size() > 1))
254 std::list<DsrRouteCacheEntry> newVector;
255 newVector.push_back(changeEntry);
259 NS_LOG_INFO(
"We have a sub-route to " <<
id <<
" add it in route cache");
264 NS_LOG_INFO(
"Here we check the route cache again after updated the sub routes");
274 std::list<DsrRouteCacheEntry> rtVector = m->second;
275 rt = rtVector.front();
276 NS_LOG_LOGIC(
"Route to " <<
id <<
" with route size " << rtVector.size());
284 if (type ==
"LinkCache")
288 else if (type ==
"PathCache")
314 std::map<Ipv4Address, uint32_t> d;
316 std::map<Ipv4Address, Ipv4Address> pre;
319 if (i->second.find(source) != i->second.end())
321 d[i->first] = i->second[source];
322 pre[i->first] = source;
335 std::map<Ipv4Address, bool> s;
341 for (
auto j = d.begin(); j != d.end(); ++j)
344 if (s.find(ip) == s.end())
349 if (j->second <= temp)
361 if (s.find(k->first) == s.end() && d[k->first] > d[tempip] + k->second)
363 d[k->first] = d[tempip] + k->second;
364 pre[k->first] = tempip;
373 else if (d[k->first] == d[tempip] + k->second)
379 if (oldlink->second.GetLinkStability() < newlink->second.GetLinkStability())
381 NS_LOG_INFO(
"Select the link with longest expected lifetime");
382 d[k->first] = d[tempip] + k->second;
383 pre[k->first] = tempip;
396 for (
auto i = pre.begin(); i != pre.end(); ++i)
402 if (!i->second.IsBroadcast() && iptemp != source)
404 while (iptemp != source)
406 route.push_back(iptemp);
407 iptemp = pre[iptemp];
409 route.push_back(source);
432 if (i->second.size() < 2)
442 NS_LOG_INFO(
"Route to " <<
id <<
" found with the length " << i->second.size());
444 std::vector<Ipv4Address> path = rt.
GetVector();
457 if (i->second.GetLinkStability().IsNegative())
472 if (i->second.GetNodeStability().IsNegative())
494 m_netGraph[i->first.m_low][i->first.m_high] = weight;
495 m_netGraph[i->first.m_high][i->first.m_low] = weight;
555 for (
uint32_t i = 0; i < nodelist.size() - 1; i++)
568 Link link(nodelist[i], nodelist[i + 1]);
609 for (
auto i = rt.begin(); i != rt.end() - 1; ++i)
611 Link link(*i, *(i + 1));
628 for (
auto i = rt.begin(); i != rt.end(); ++i)
639 NS_LOG_INFO(
"The node stability has already been increased");
650 std::list<DsrRouteCacheEntry> rtVector;
652 std::vector<Ipv4Address> route = rt.
GetVector();
659 rtVector.push_back(rt);
664 auto result =
m_sortedRoutes.insert(std::make_pair(dst, rtVector));
665 return result.second;
668 rtVector = i->second;
669 NS_LOG_DEBUG(
"The existing route size " << rtVector.size() <<
" for destination address "
683 "Find same vector, the FindSameRoute function will update the route expire time");
691 rtVector.push_back(rt);
696 <<
" The second time "
697 << rtVector.back().GetExpireTime().As(
Time::S));
698 NS_LOG_DEBUG(
"The first hop" << rtVector.front().GetVector().size()
699 <<
" The second hop "
700 << rtVector.back().GetVector().size());
705 auto result =
m_sortedRoutes.insert(std::make_pair(dst, rtVector));
706 return result.second;
710 NS_LOG_INFO(
"The newly found route is already expired");
721 for (
auto i = rtVector.begin(); i != rtVector.end(); ++i)
729 NS_LOG_DEBUG(
"Found same routes in the route cache with the vector size "
732 <<
" the original expire time "
733 << i->GetExpireTime().As(
Time::S));
744 return result.second;
757 NS_LOG_LOGIC(
"Route deletion to " << dst <<
" successful");
760 NS_LOG_LOGIC(
"Route deletion to " << dst <<
" not successful");
778 Link link1(errorSrc, unreachNode);
779 Link link2(unreachNode, errorSrc);
791 NS_LOG_LOGIC(
"Update the node stability unsuccessfully");
800 NS_LOG_LOGIC(
"Update the node stability unsuccessfully");
827 std::list<DsrRouteCacheEntry> rtVector = j->second;
831 for (
auto k = rtVector.begin(); k != rtVector.end();)
843 changeVector.push_back(*i);
847 changeVector.push_back(*i);
849 if (*(i + 1) == unreachNode)
860 NS_LOG_DEBUG(
"The route does not contain the broken link");
863 else if ((changeVector.size() <
routeVector.size()) && (changeVector.size() > 1))
868 Time expire = k->GetExpireTime();
872 k = rtVector.erase(k);
876 NS_LOG_DEBUG(
"The destination of the newly formed route "
877 << destination <<
" and the size of the route "
878 << changeVector.size());
882 rtVector.push_back(changeEntry);
890 k = rtVector.erase(k);
895 NS_LOG_LOGIC(
"Cut route unsuccessful and erase the route");
899 k = rtVector.erase(k);
907 if (!rtVector.empty())
917 NS_LOG_DEBUG(
"There is no route left for that destination " << address);
937 for (
auto i = vec.begin(); i != vec.end(); ++i)
948 for (
auto i = route.begin(); i != route.end(); i++)
950 std::vector<Ipv4Address> path = i->GetVector();
974 std::list<DsrRouteCacheEntry> rtVector = i->second;
975 NS_LOG_DEBUG(
"The route vector size of 1 " << dst <<
" " << rtVector.size());
976 if (!rtVector.empty())
978 for (
auto j = rtVector.begin(); j != rtVector.end();)
980 NS_LOG_DEBUG(
"The expire time of every entry with expire time "
981 << j->GetExpireTime());
985 if (j->GetExpireTime().IsNegative())
990 NS_LOG_DEBUG(
"Erase the expired route for " << dst <<
" with expire time "
991 << j->GetExpireTime());
992 j = rtVector.erase(j);
999 NS_LOG_DEBUG(
"The route vector size of 2 " << dst <<
" " << rtVector.size());
1000 if (!rtVector.empty())
1028 os <<
"\nDSR Route Cache\n"
1029 <<
"Destination\tGateway\t\tInterface\tFlag\tExpire\tHops\n";
1049 <<
" found and use id 1 for the first network ack id");
1055 NS_LOG_LOGIC(
"Ack id for " << nextHop <<
" found in the cache has value " << ackId);
1076 for (
auto i =
m_nb.begin(); i !=
m_nb.end(); ++i)
1078 if (i->m_neighborAddress == addr)
1091 for (
auto i =
m_nb.begin(); i !=
m_nb.end(); ++i)
1093 if (i->m_neighborAddress == addr)
1105 for (
auto i =
m_nb.begin(); i !=
m_nb.end(); ++i)
1107 for (
auto j = nodeList.begin(); j != nodeList.end(); ++j)
1109 if (i->m_neighborAddress == (*j))
1111 i->m_expireTime = std::max(expire +
Simulator::Now(), i->m_expireTime);
1124 m_nb.push_back(neighbor);
1131 NS_LOG_LOGIC(
"Add neighbor number " << nodeList.size());
1132 for (
auto j = nodeList.begin(); j != nodeList.end();)
1135 if (addr == ownAddress)
1137 j = nodeList.erase(j);
1138 NS_LOG_DEBUG(
"The node list size " << nodeList.size());
1145 m_nb.push_back(neighbor);
1176 for (
auto j =
m_nb.begin(); j !=
m_nb.end(); ++j)
1180 NS_LOG_LOGIC(
"Close link to " << j->m_neighborAddress);
1214 for (
auto i =
m_arp.begin(); i !=
m_arp.end(); ++i)
1231 for (
auto i =
m_nb.begin(); i !=
m_nb.end(); ++i)
1233 if (i->m_hardwareAddress == addr)
A record that that holds information about an ArpCache entry.
Address GetMacAddress() const
Ipv4 addresses are stored in host order in this class.
static Mac48Address ConvertFrom(const Address &address)
A base class which provides memory management and object aggregation.
Smart pointer class similar to boost::intrusive_ptr.
Control the scheduling of simulation events.
static Time Now()
Return the current simulation virtual time.
Simulation virtual time values and global simulation resolution.
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
bool IsStrictlyPositive() const
Exactly equivalent to t > 0.
A simple virtual Timer class.
void SetDelay(const Time &delay)
void Cancel()
Cancel the currently-running event if there is one.
void Schedule()
Schedule a new event using the currently-configured delay, function, and arguments.
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
DsrLinkStab class (DSR link stability)
Time GetLinkStability() const
get the link stability
DsrLinkStab(Time linkStab=Simulator::Now())
Constructor.
void Print() const
Print function.
void SetLinkStability(Time linkStab)
set the link stability
virtual ~DsrLinkStab()
Destructor.
DsrNodeStab class (DSR node stability)
void SetNodeStability(Time nodeStab)
Set node stability.
DsrNodeStab(Time nodeStab=Simulator::Now())
Constructor.
DsrRouteCacheEntry class for entries in the route cache.
IP_VECTOR GetVector() const
Get the IP vector.
void SetDestination(Ipv4Address d)
Set destination address.
Time m_expire
Expire time for queue entry.
DsrRouteCacheEntry(IP_VECTOR const &ip=IP_VECTOR(), Ipv4Address dst=Ipv4Address(), Time exp=Simulator::Now())
Constructor.
Ipv4Address m_dst
The destination Ip address.
uint8_t m_reqCount
Number of route requests.
Ipv4Address GetDestination() const
Get destination address.
virtual ~DsrRouteCacheEntry()
void Invalidate(Time badLinkLifetime)
Mark entry as "down" (i.e.
void Print(std::ostream &os) const
Print necessary fields.
std::vector< Ipv4Address > IP_VECTOR
Define the vector to hold Ip address.
Time GetExpireTime() const
Get expire time.
void SetExpireTime(Time exp)
Set expire time.
void SetVector(IP_VECTOR v)
Sets the IP vector.
DSR route request queue Since DSR is an on demand routing we queue requests while looking for route.
std::map< Ipv4Address, std::map< Ipv4Address, uint32_t > > m_netGraph
Current network graph state for this node, double is weight, which is calculated by the node informat...
uint32_t m_stabilityDecrFactor
stability decrease factor
std::list< DsrRouteCacheEntry::IP_VECTOR > routeVector
Define the vector of route entries.
static TypeId GetTypeId()
Get the type ID.
void PurgeLinkNode()
Purge from the cache if the stability time expired.
Callback< void, Ipv4Address, uint8_t > m_handleLinkFailure
The following code handles link-layer acks.
std::map< Link, DsrLinkStab > m_linkCache
The data structure to store link info.
void ScheduleTimer()
Schedule m_ntimer.
void RebuildBestRouteTable(Ipv4Address source)
Rebuild the best route table.
void SetCacheType(std::string type)
Dijsktra algorithm to get the best route from m_netGraph and update the m_bestRoutesTable_link when c...
routeEntryVector m_routeEntryVector
Define the route vector.
void AddArpCache(Ptr< ArpCache > a)
Add ARP cache to be used to allow layer 2 notifications processing.
std::map< Ipv4Address, DsrNodeStab > m_nodeCache
The data structure to store node info.
void Purge()
Delete all outdated entries and invalidate valid entry if Lifetime is expired.
Time m_initStability
initial stability
uint16_t CheckUniqueAckId(Ipv4Address nextHop)
Check for duplicate ids and save new entries if the id is not present in the table.
bool IsLinkCache()
is link cached
uint32_t m_stabilityIncrFactor
stability increase factor
bool LookupRoute(Ipv4Address id, DsrRouteCacheEntry &rt)
Lookup route cache entry with destination address dst.
uint16_t GetAckSize()
Get the ack table size.
std::map< Ipv4Address, uint16_t > m_ackIdCache
The id cache to ensure all the ids are unique.
void ProcessTxError(const WifiMacHeader &hdr)
Process layer 2 TX error notification.
Time RouteCacheTimeout
The maximum period of time that dsr is allowed to for an unused route.
bool AddRoute_Link(DsrRouteCacheEntry::IP_VECTOR nodelist, Ipv4Address node)
dd route link to cache
std::vector< Ptr< ArpCache > > m_arp
list of ARP cached to be used for layer 2 notifications processing
Mac48Address LookupMacAddress(Ipv4Address addr)
Find MAC address by IP using list of ARP caches.
void UseExtends(DsrRouteCacheEntry::IP_VECTOR rt)
When a link from the Route Cache is used in routing a packet originated or salvaged by that node,...
void PurgeMac()
Remove all expired mac entries.
bool FindSameRoute(DsrRouteCacheEntry &rt, std::list< DsrRouteCacheEntry > &rtVector)
Find the same route in the route cache.
~DsrRouteCache() override
std::map< Ipv4Address, routeEntryVector > m_sortedRoutes
Map the ipv4Address to route entry vector.
void PrintVector(std::vector< Ipv4Address > &vec)
Print the route vector elements.
bool m_isLinkCache
Check if the route is using path cache or link cache.
Time m_delay
This timeout deals with the passive ack.
bool DeleteRoute(Ipv4Address dst)
Delete the route with certain destination address.
bool IncStability(Ipv4Address node)
increase the stability of the node
void PrintRouteVector(std::list< DsrRouteCacheEntry > route)
Print all the route vector elements from the route list.
uint32_t m_maxEntriesEachDst
number of entries for each destination
Time GetExpireTime(Ipv4Address addr)
Return expire time for neighbor node with address addr, if exists, else return 0.
Time m_useExtends
use extend
std::vector< Neighbor > m_nb
vector of entries
Time m_minLifeTime
minimum lifetime
void DelArpCache(Ptr< ArpCache >)
Don't use the provided ARP cache any more (interface is down)
void Print(std::ostream &os)
Print route cache.
bool LookupRoute_Link(Ipv4Address id, DsrRouteCacheEntry &rt)
used by LookupRoute when LinkCache
bool UpdateRouteEntry(Ipv4Address dst)
Update route cache entry if it has been recently used and successfully delivered the data packet.
void UpdateNeighbor(std::vector< Ipv4Address > nodeList, Time expire)
Update expire time for entry with address addr, if it exists, else add new entry.
void RemoveLastEntry(std::list< DsrRouteCacheEntry > &rtVector)
Remove the aged route cache entries when the route cache is full.
Timer m_ntimer
Timer for neighbor's list. Schedule Purge().
bool m_subRoute
Check if save the sub route entries or not.
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 un...
bool IsNeighbor(Ipv4Address addr)
Check that node with address addr is neighbor.
std::map< Ipv4Address, DsrRouteCacheEntry::IP_VECTOR > m_bestRoutesTable_link
for link route cache
bool DecStability(Ipv4Address node)
decrease the stability of the node
void UpdateNetGraph()
Update the Net Graph for the link and node cache has changed.
bool AddRoute(DsrRouteCacheEntry &rt)
Add route cache entry if it doesn't yet exist in route cache.
void AddNeighbor(std::vector< Ipv4Address > nodeList, Ipv4Address ownAddress, Time expire)
Add to the neighbor list.
#define MAXWEIGHT
The link cache to update all the link status, bi-link is two link for link is a struct when the weigh...
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Time Now()
create an ns3::Time instance which contains the current simulation time.
Time Seconds(double value)
Construct a Time in the indicated unit.
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
bool CompareRoutesBoth(const DsrRouteCacheEntry &a, const DsrRouteCacheEntry &b)
bool CompareRoutesExpire(const DsrRouteCacheEntry &a, const DsrRouteCacheEntry &b)
bool CompareRoutesHops(const DsrRouteCacheEntry &a, const DsrRouteCacheEntry &b)
std::list< DsrRouteCacheEntry >::value_type route_pair
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool operator()(const DsrRouteCache::Neighbor &nb) const
Check if the entry is expired.
Structure to manage neighbor state.
Time m_expireTime
route expire time
bool close
is route active
The route cache structure.
void Print() const
Print function.
Ipv4Address m_low
low IP address
Ipv4Address m_high
high IP address