/usr/include/ns3.27/ns3/dsdv-rtable.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2010 Hemanth Narra
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Hemanth Narra <hemanth@ittc.ku.com>
*
* James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
* ResiliNets Research Group http://wiki.ittc.ku.edu/resilinets
* Information and Telecommunication Technology Center (ITTC)
* and Department of Electrical Engineering and Computer Science
* The University of Kansas Lawrence, KS USA.
*
* Work supported in part by NSF FIND (Future Internet Design) Program
* under grant CNS-0626918 (Postmodern Internet Architecture),
* NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
* US Department of Defense (DoD), and ITTC at The University of Kansas.
*/
#ifndef DSDV_RTABLE_H
#define DSDV_RTABLE_H
#include <cassert>
#include <map>
#include <sys/types.h>
#include "ns3/ipv4.h"
#include "ns3/ipv4-route.h"
#include "ns3/timer.h"
#include "ns3/net-device.h"
#include "ns3/output-stream-wrapper.h"
namespace ns3 {
namespace dsdv {
enum RouteFlags
{
VALID = 0, // !< VALID
INVALID = 1, // !< INVALID
};
/**
* \ingroup dsdv
* \brief Routing table entry
*/
class RoutingTableEntry
{
public:
/**
* c-tor
*
* \param dev the net device
* \param dst the destination IP address
* \param seqNo the sequence number
* \param iface the interface
* \param hops the number of hops
* \param nextHop the IP address of the next hop
* \param lifetime the lifetime
* \param SettlingTime the settling time
* \param changedEntries flag for changed entries
*/
RoutingTableEntry (Ptr<NetDevice> dev = 0, Ipv4Address dst = Ipv4Address (), uint32_t seqNo = 0,
Ipv4InterfaceAddress iface = Ipv4InterfaceAddress (), uint32_t hops = 0, Ipv4Address nextHop = Ipv4Address (),
Time lifetime = Simulator::Now (), Time SettlingTime = Simulator::Now (), bool changedEntries = false);
~RoutingTableEntry ();
/**
* Get destination IP address
* \returns the destination IPv4 address
*/
Ipv4Address
GetDestination () const
{
return m_ipv4Route->GetDestination ();
}
/**
* Get route
* \returns the IPv4 route
*/
Ptr<Ipv4Route>
GetRoute () const
{
return m_ipv4Route;
}
/**
* Set route
* \param route the IPv4 route
*/
void
SetRoute (Ptr<Ipv4Route> route)
{
m_ipv4Route = route;
}
/**
* Set next hop
* \param nextHop the IPv4 address of the next hop
*/
void
SetNextHop (Ipv4Address nextHop)
{
m_ipv4Route->SetGateway (nextHop);
}
/**
* Get next hop
* \returns the IPv4 address of the next hop
*/
Ipv4Address
GetNextHop () const
{
return m_ipv4Route->GetGateway ();
}
/**
* Set output device
* \param device the output device
*/
void
SetOutputDevice (Ptr<NetDevice> device)
{
m_ipv4Route->SetOutputDevice (device);
}
/**
* Get output device
* \returns the output device
*/
Ptr<NetDevice>
GetOutputDevice () const
{
return m_ipv4Route->GetOutputDevice ();
}
/**
* Get interface address
* \returns the IPv4 interface address
*/
Ipv4InterfaceAddress
GetInterface () const
{
return m_iface;
}
/**
* Set interface address
* \param iface the IPv4 interface address
*/
void
SetInterface (Ipv4InterfaceAddress iface)
{
m_iface = iface;
}
/**
* Set sequence number
* \param sequenceNumber the sequence number
*/
void
SetSeqNo (uint32_t sequenceNumber)
{
m_seqNo = sequenceNumber;
}
/**
* Get sequence number
* \returns the sequence number
*/
uint32_t
GetSeqNo () const
{
return m_seqNo;
}
/**
* Set hop
* \param hopCount the hop count
*/
void
SetHop (uint32_t hopCount)
{
m_hops = hopCount;
}
/**
* Get hop
* \returns the hop count
*/
uint32_t
GetHop () const
{
return m_hops;
}
/**
* Set lifetime
* \param lifeTime the lifetime value
*/
void
SetLifeTime (Time lifeTime)
{
m_lifeTime = lifeTime;
}
/**
* Get lifetime
* \returns the lifetime value
*/
Time
GetLifeTime () const
{
return (Simulator::Now () - m_lifeTime);
}
/**
* Set settling time
* \param settlingTime the settling time
*/
void
SetSettlingTime (Time settlingTime)
{
m_settlingTime = settlingTime;
}
/**
* Get settling time
* \returns the settling time
*/
Time
GetSettlingTime () const
{
return (m_settlingTime);
}
/**
* Set route flags
* \param flag the route flags
*/
void
SetFlag (RouteFlags flag)
{
m_flag = flag;
}
/**
* Get route flags
* \returns the route flags
*/
RouteFlags
GetFlag () const
{
return m_flag;
}
/**
* Set entries changed indicator
* \param entriesChanged
*/
void
SetEntriesChanged (bool entriesChanged)
{
m_entriesChanged = entriesChanged;
}
/**
* Get entries changed
* \returns the entries changed flag
*/
bool
GetEntriesChanged () const
{
return m_entriesChanged;
}
/**
* \brief Compare destination address
* \param destination destination node IP address
* \return true if equal
*/
bool
operator== (Ipv4Address const destination) const
{
return (m_ipv4Route->GetDestination () == destination);
}
/**
* Print routing table entry
* \param stream the output stream
*/
void
Print (Ptr<OutputStreamWrapper> stream) const;
private:
// Fields
/// Destination Sequence Number
uint32_t m_seqNo;
/// Hop Count (number of hops needed to reach destination)
uint32_t m_hops;
/**
* \brief Expiration or deletion time of the route
* Lifetime field in the routing table plays dual role --
* for an active route it is the expiration time, and for an invalid route
* it is the deletion time.
*/
Time m_lifeTime;
/** Ip route, include
* - destination address
* - source address
* - next hop address (gateway)
* - output device
*/
Ptr<Ipv4Route> m_ipv4Route;
/// Output interface address
Ipv4InterfaceAddress m_iface;
/// Routing flags: valid, invalid or in search
RouteFlags m_flag;
/// Time for which the node retains an update with changed metric before broadcasting it.
/// A node does that in hope of receiving a better update.
Time m_settlingTime;
/// Flag to show if any of the routing table entries were changed with the routing update.
uint32_t m_entriesChanged;
};
/**
* \ingroup dsdv
* \brief The Routing table used by DSDV protocol
*/
class RoutingTable
{
public:
/// c-tor
RoutingTable ();
/**
* Add routing table entry if it doesn't yet exist in routing table
* \param r routing table entry
* \return true in success
*/
bool
AddRoute (RoutingTableEntry & r);
/**
* Delete routing table entry with destination address dst, if it exists.
* \param dst destination address
* \return true on success
*/
bool
DeleteRoute (Ipv4Address dst);
/**
* Lookup routing table entry with destination address dst
* \param dst destination address
* \param rt entry with destination address dst, if exists
* \return true on success
*/
bool
LookupRoute (Ipv4Address dst, RoutingTableEntry & rt);
/**
* Lookup routing table entry with destination address dst
* \param id destination address
* \param rt entry with destination address dst, if exists
* \param forRouteInput for routing input
* \return true on success
*/
bool
LookupRoute (Ipv4Address id, RoutingTableEntry & rt, bool forRouteInput);
/**
* Updating the routing Table with routing table entry rt
* \param rt routing table entry
* \return true on success
*/
bool
Update (RoutingTableEntry & rt);
/**
* Lookup list of addresses for which nxtHp is the next Hop address
* \param nxtHp nexthop's address for which we want the list of destinations
* \param dstList is the list that will hold all these destination addresses
*/
void
GetListOfDestinationWithNextHop (Ipv4Address nxtHp, std::map<Ipv4Address, RoutingTableEntry> & dstList);
/**
* Lookup list of all addresses in the routing table
* \param allRoutes is the list that will hold all these addresses present in the nodes routing table
*/
void
GetListOfAllRoutes (std::map<Ipv4Address, RoutingTableEntry> & allRoutes);
/**
* Delete all route from interface with address iface
* \param iface the interface
*/
void
DeleteAllRoutesFromInterface (Ipv4InterfaceAddress iface);
/// Delete all entries from routing table
void
Clear ()
{
m_ipv4AddressEntry.clear ();
}
/**
* Delete all outdated entries if Lifetime is expired
* \param removedAddresses is the list of addresses to purge
*/
void
Purge (std::map<Ipv4Address, RoutingTableEntry> & removedAddresses);
/**
* Print routing table
* \param stream the output stream
*/
void
Print (Ptr<OutputStreamWrapper> stream) const;
/**
* Provides the number of routes present in that nodes routing table.
* \returns the number of routes
*/
uint32_t
RoutingTableSize ();
/**
* Add an event for a destination address so that the update to for that destination is sent
* after the event is completed.
* \param address destination address for which this event is running.
* \param id unique eventid that was generated.
* \return true on success
*/
bool
AddIpv4Event (Ipv4Address address, EventId id);
/**
* Clear up the entry from the map after the event is completed
* \param address destination address for which this event is running.
* \return true on success
*/
bool
DeleteIpv4Event (Ipv4Address address);
/**
* Force delete an update waiting for settling time to complete as a better update to
* same destination was received.
* \param address destination address for which this event is running.
* \return true on success
*/
bool
AnyRunningEvent (Ipv4Address address);
/**
* Force delete an update waiting for settling time to complete as a better update to
* same destination was received.
* \param address destination address for which this event is running.
* \return true on finding out that an event is already running for that destination address.
*/
bool
ForceDeleteIpv4Event (Ipv4Address address);
/**
* Get the EcentId associated with that address.
* \param address destination address for which this event is running.
* \return EventId on finding out an event is associated else return NULL.
*/
EventId
GetEventId (Ipv4Address address);
/**
* Get hold down time (time until an invalid route may be deleted)
* \returns the hold down time
*/
Time Getholddowntime () const
{
return m_holddownTime;
}
/**
* Set hold down time (time until an invalid route may be deleted)
* \param t the hold down time
*/
void Setholddowntime (Time t)
{
m_holddownTime = t;
}
private:
// Fields
/// an entry in the routing table.
std::map<Ipv4Address, RoutingTableEntry> m_ipv4AddressEntry;
/// an entry in the event table.
std::map<Ipv4Address, EventId> m_ipv4Events;
/// hold down time of an expired route
Time m_holddownTime;
};
}
}
#endif /* DSDV_RTABLE_H */
|