/usr/include/ns3.27/ns3/dsdv-routing-protocol.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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2010 Hemanth Narra, Yufei Cheng
*
* 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>
* Author: Yufei Cheng <yfcheng@ittc.ku.edu>
*
* 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_ROUTING_PROTOCOL_H
#define DSDV_ROUTING_PROTOCOL_H
#include "dsdv-rtable.h"
#include "dsdv-packet-queue.h"
#include "dsdv-packet.h"
#include "ns3/node.h"
#include "ns3/random-variable-stream.h"
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/ipv4-interface.h"
#include "ns3/ipv4-l3-protocol.h"
#include "ns3/output-stream-wrapper.h"
namespace ns3 {
namespace dsdv {
/**
* \ingroup dsdv
* \brief DSDV routing protocol.
*/
class RoutingProtocol : public Ipv4RoutingProtocol
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
static const uint32_t DSDV_PORT;
/// c-tor
RoutingProtocol ();
virtual
~RoutingProtocol ();
virtual void
DoDispose ();
// From Ipv4RoutingProtocol
Ptr<Ipv4Route> RouteOutput (Ptr<Packet> p, const Ipv4Header &header, Ptr<NetDevice> oif, Socket::SocketErrno &sockerr);
/**
* Route input packet
* \param p The packet
* \param header The IPv4 header
* \param idev The device
* \param ucb The unicast forward callback
* \param mcb The multicast forward callback
* \param lcb The local deliver callback
* \param ecb The error callback
* \returns true if successful
*/
bool RouteInput (Ptr<const Packet> p, const Ipv4Header &header, Ptr<const NetDevice> idev, UnicastForwardCallback ucb,
MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb);
virtual void PrintRoutingTable (Ptr<OutputStreamWrapper> stream, Time::Unit unit = Time::S) const;
virtual void NotifyInterfaceUp (uint32_t interface);
virtual void NotifyInterfaceDown (uint32_t interface);
virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address);
virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address);
virtual void SetIpv4 (Ptr<Ipv4> ipv4);
// Methods to handle protocol parameters
/**
* Set enable buffer flag
* \param f The enable buffer flag
*/
void SetEnableBufferFlag (bool f);
/**
* Get enable buffer flag
* \returns the enable buffer flag
*/
bool GetEnableBufferFlag () const;
/**
* Set weighted settling time (WST) flag
* \param f the weighted settling time (WST) flag
*/
void SetWSTFlag (bool f);
/**
* Get weighted settling time (WST) flag
* \returns the weighted settling time (WST) flag
*/
bool GetWSTFlag () const;
/**
* Set enable route aggregation (RA) flag
* \param f the enable route aggregation (RA) flag
*/
void SetEnableRAFlag (bool f);
/**
* Get enable route aggregation (RA) flag
* \returns the enable route aggregation (RA) flag
*/
bool GetEnableRAFlag () const;
/**
* Assign a fixed random variable stream number to the random variables
* used by this model. Return the number of streams (possibly zero) that
* have been assigned.
*
* \param stream first stream index to use
* \return the number of stream indices assigned by this model
*/
int64_t AssignStreams (int64_t stream);
private:
// Protocol parameters.
/// Holdtimes is the multiplicative factor of PeriodicUpdateInterval for which the node waits since the last update
/// before flushing a route from the routing table. If PeriodicUpdateInterval is 8s and Holdtimes is 3, the node
/// waits for 24s since the last update to flush this route from its routing table.
uint32_t Holdtimes;
/// PeriodicUpdateInterval specifies the periodic time interval between which the a node broadcasts
/// its entire routing table.
Time m_periodicUpdateInterval;
/// SettlingTime specifies the time for which a node waits before propagating an update.
/// It waits for this time interval in hope of receiving an update with a better metric.
Time m_settlingTime;
/// Nodes IP address
Ipv4Address m_mainAddress;
/// IP protocol
Ptr<Ipv4> m_ipv4;
/// Raw socket per each IP interface, map socket -> iface address (IP + mask)
std::map<Ptr<Socket>, Ipv4InterfaceAddress> m_socketAddresses;
/// Loopback device used to defer route requests until a route is found
Ptr<NetDevice> m_lo;
/// Main Routing table for the node
RoutingTable m_routingTable;
/// Advertised Routing table for the node
RoutingTable m_advRoutingTable;
/// The maximum number of packets that we allow a routing protocol to buffer.
uint32_t m_maxQueueLen;
/// The maximum number of packets that we allow per destination to buffer.
uint32_t m_maxQueuedPacketsPerDst;
/// The maximum period of time that a routing protocol is allowed to buffer a packet for.
Time m_maxQueueTime;
/// A "drop front on full" queue used by the routing layer to buffer packets to which it does not have a route.
PacketQueue m_queue;
/// Flag that is used to enable or disable buffering
bool EnableBuffering;
/// Flag that is used to enable or disable Weighted Settling Time
bool EnableWST;
/// This is the wighted factor to determine the weighted settling time
double m_weightedFactor;
/// This is a flag to enable route aggregation. Route aggregation will aggregate all routes for
/// 'RouteAggregationTime' from the time an update is received by a node and sends them as a single update .
bool EnableRouteAggregation;
/// Parameter that holds the route aggregation time interval
Time m_routeAggregationTime;
/// Unicast callback for own packets
UnicastForwardCallback m_scb;
/// Error callback for own packets
ErrorCallback m_ecb;
private:
/// Start protocol operation
void
Start ();
/**
* Queue packet until we find a route
* \param p the packet to route
* \param header the Ipv4Header
* \param ucb the UnicastForwardCallback function
* \param ecb the ErrorCallback function
*/
void
DeferredRouteOutput (Ptr<const Packet> p, const Ipv4Header & header, UnicastForwardCallback ucb, ErrorCallback ecb);
/// Look for any queued packets to send them out
void
LookForQueuedPackets (void);
/**
* Send packet from queue
* \param dst - destination address to which we are sending the packet to
* \param route - route identified for this packet
*/
void
SendPacketFromQueue (Ipv4Address dst, Ptr<Ipv4Route> route);
/**
* Find socket with local interface address iface
* \param iface the interface
* \returns the socket
*/
Ptr<Socket>
FindSocketWithInterfaceAddress (Ipv4InterfaceAddress iface) const;
// Receive dsdv control packets
/**
* Receive and process dsdv control packet
* \param socket the socket for receiving dsdv control packets
*/
void
RecvDsdv (Ptr<Socket> socket);
/// Send packet
void
Send (Ptr<Ipv4Route>, Ptr<const Packet>, const Ipv4Header &);
/**
* Create loopback route for given header
*
* \param header the IP header
* \param oif the device
* \returns the route
*/
Ptr<Ipv4Route>
LoopbackRoute (const Ipv4Header & header, Ptr<NetDevice> oif) const;
/**
* Get settlingTime for a destination
* \param dst - destination address
* \return settlingTime for the destination if found
*/
Time
GetSettlingTime (Ipv4Address dst);
/// Sends trigger update from a node
void
SendTriggeredUpdate ();
/// Broadcasts the entire routing table for every PeriodicUpdateInterval
void
SendPeriodicUpdate ();
/// Merge periodic updates
void
MergeTriggerPeriodicUpdates ();
/// Notify that packet is dropped for some reason
void
Drop (Ptr<const Packet>, const Ipv4Header &, Socket::SocketErrno);
/// Timer to trigger periodic updates from a node
Timer m_periodicUpdateTimer;
/// Timer used by the trigger updates in case of Weighted Settling Time is used
Timer m_triggeredExpireTimer;
/// Provides uniform random variables.
Ptr<UniformRandomVariable> m_uniformRandomVariable;
};
}
}
#endif /* DSDV_ROUTING_PROTOCOL_H */
|