29#include "ns3/assert.h"
34#include "ns3/random-variable-stream.h"
35#include "ns3/uinteger.h"
39#define RIP_ALL_NODE "224.0.0.9"
51 m_splitHorizonStrategy(
Rip::POISON_REVERSE),
54 m_rng = CreateObject<UniformRandomVariable>();
67 .SetGroupName(
"Internet")
68 .AddConstructor<
Rip>()
69 .AddAttribute(
"UnsolicitedRoutingUpdate",
70 "The time between two Unsolicited Routing Updates.",
74 .AddAttribute(
"StartupDelay",
75 "Maximum random delay for protocol startup (send route requests).",
79 .AddAttribute(
"TimeoutDelay",
80 "The delay to invalidate a route.",
84 .AddAttribute(
"GarbageCollectionDelay",
85 "The delay to delete an expired route.",
89 .AddAttribute(
"MinTriggeredCooldown",
90 "Min cooldown delay after a Triggered Update.",
94 .AddAttribute(
"MaxTriggeredCooldown",
95 "Max cooldown delay after a Triggered Update.",
99 .AddAttribute(
"SplitHorizon",
100 "Split Horizon strategy.",
109 .AddAttribute(
"LinkDownValue",
110 "Value for link down in count to infinity.",
113 MakeUintegerChecker<uint32_t>());
131 bool addedGlobal =
false;
147 bool activeInterface =
false;
150 activeInterface =
true;
151 m_ipv4->SetForwarding(i,
true);
159 NS_LOG_LOGIC(
"RIP: adding socket to " << address.GetLocal());
164 socket->BindToNetDevice(
m_ipv4->GetNetDevice(i));
165 int ret = socket->Bind(local);
169 socket->SetIpRecvTtl(
true);
170 socket->SetRecvPktInfo(
true);
229 rtentry =
Lookup(destination,
true, oif);
285 NS_LOG_LOGIC(
"Dropping packet not for me and with dst Broadcast");
294 if (!
m_ipv4->IsForwarding(iif))
309 NS_LOG_LOGIC(
"Found unicast destination - calling unicast callback");
310 ucb(rtentry, p, header);
315 NS_LOG_LOGIC(
"Did not find unicast destination - returning false");
334 Ipv4Mask networkMask = address.GetMask();
335 Ipv4Address networkAddress = address.GetLocal().CombineMask(networkMask);
348 bool sendSocketFound =
false;
351 if (iter->second == i)
353 sendSocketFound =
true;
358 bool activeInterface =
false;
361 activeInterface =
true;
362 m_ipv4->SetForwarding(i,
true);
371 NS_LOG_LOGIC(
"RIP: adding sending socket to " << address.GetLocal());
376 socket->BindToNetDevice(
m_ipv4->GetNetDevice(i));
379 socket->SetIpRecvTtl(
true);
380 socket->SetRecvPktInfo(
true);
411 if (it->first->GetInterface() == interface)
419 NS_LOG_INFO(
"Checking socket for interface " << interface);
420 if (iter->second == interface)
422 NS_LOG_INFO(
"Removed socket for interface " << interface);
423 iter->first->Close();
440 if (!
m_ipv4->IsUp(interface))
450 Ipv4Address networkAddress = address.GetLocal().CombineMask(address.GetMask());
451 Ipv4Mask networkMask = address.GetMask();
466 if (!
m_ipv4->IsUp(interface))
476 Ipv4Address networkAddress = address.GetLocal().CombineMask(address.GetMask());
477 Ipv4Mask networkMask = address.GetMask();
483 if (it->first->GetInterface() == interface && it->first->IsNetwork() &&
484 it->first->GetDestNetwork() == networkAddress &&
485 it->first->GetDestNetworkMask() == networkMask)
506 for (i = 0; i <
m_ipv4->GetNInterfaces(); i++)
524 std::ostream* os = stream->GetStream();
526 std::ios oldState(
nullptr);
527 oldState.copyfmt(*os);
529 *os << std::resetiosflags(std::ios::adjustfield) << std::setiosflags(std::ios::left);
531 *os <<
"Node: " <<
m_ipv4->GetObject<
Node>()->GetId() <<
", Time: " <<
Now().
As(unit)
532 <<
", Local time: " <<
m_ipv4->GetObject<
Node>()->GetLocalTime().As(unit)
533 <<
", IPv4 RIP table" << std::endl;
537 *os <<
"Destination Gateway Genmask Flags Metric Ref Use Iface"
546 std::ostringstream dest;
547 std::ostringstream gw;
548 std::ostringstream mask;
549 std::ostringstream flags;
551 *os << std::setw(16) << dest.str();
553 *os << std::setw(16) << gw.str();
555 *os << std::setw(16) << mask.str();
565 *os << std::setw(6) << flags.str();
587 (*os).copyfmt(oldState);
608 iter->first->Close();
626 uint16_t longestMask = 0;
632 "Try to send on local multicast address, and no interface index is given!");
633 rtentry = Create<Ipv4Route>();
635 m_ipv4->SourceAddressSelection(
m_ipv4->GetInterfaceForDevice(interface), dst));
636 rtentry->SetDestination(dst);
638 rtentry->SetOutputDevice(interface);
652 NS_LOG_LOGIC(
"Searching for route to " << dst <<
", mask length " << maskLen);
656 NS_LOG_LOGIC(
"Found global network route " << j <<
", mask length " << maskLen);
661 if (maskLen < longestMask)
667 longestMask = maskLen;
671 rtentry = Create<Ipv4Route>();
683 m_ipv4->SourceAddressSelection(interfaceIdx, route->
GetDest()));
687 rtentry->SetDestination(route->
GetDest());
689 rtentry->SetOutputDevice(
m_ipv4->GetNetDevice(interfaceIdx));
697 NS_LOG_LOGIC(
"Matching route via " << rtentry->GetDestination() <<
" (through "
698 << rtentry->GetGateway() <<
") at the end");
709 NS_LOG_FUNCTION(
this << network << networkPrefix << nextHop << interface);
740 if (it->first == route)
745 if (it->second.IsRunning())
754 NS_ABORT_MSG(
"RIP::InvalidateRoute - cannot find the route to update");
764 if (it->first == route)
771 NS_ABORT_MSG(
"RIP::DeleteRoute - cannot find the route to delete");
786 uint16_t senderPort = senderAddr.
GetPort();
790 NS_LOG_LOGIC(
"Received a packet from the multicast socket");
794 NS_LOG_LOGIC(
"Received a packet from one of the unicast sockets");
798 if (!packet->RemovePacketTag(interfaceInfo))
800 NS_ABORT_MSG(
"No incoming interface on RIP message, aborting.");
803 Ptr<Node> node = this->GetObject<Node>();
808 if (!packet->RemovePacketTag(hoplimitTag))
810 NS_ABORT_MSG(
"No incoming Hop Count on RIP message, aborting.");
812 uint8_t hopLimit = hoplimitTag.
GetTtl();
814 int32_t interfaceForAddress =
m_ipv4->GetInterfaceForAddress(senderAddress);
815 if (interfaceForAddress != -1)
822 packet->RemoveHeader(hdr);
834 HandleRequests(hdr, senderAddress, senderPort, ipInterfaceIndex, hopLimit);
849 NS_LOG_FUNCTION(
this << senderAddress <<
int(senderPort) << incomingInterface <<
int(hopLimit)
852 std::list<RipRte> rtes = requestHdr.
GetRteList();
860 if (rtes.size() == 1)
863 rtes.begin()->GetSubnetMask().GetPrefixLength() == 0 &&
876 if (iter->second == incomingInterface)
878 sendingSocket = iter->first;
882 "HandleRequest - Impossible to find a socket to send the reply");
884 uint16_t mtu =
m_ipv4->GetMtu(incomingInterface);
892 p->RemovePacketTag(tag);
901 p->AddPacketTag(tag);
908 bool splitHorizoning = (rtIter->first->GetInterface() == incomingInterface);
912 rtIter->first->GetDestNetworkMask());
915 bool isDefaultRoute =
918 (rtIter->first->GetInterface() != incomingInterface));
920 if ((isGlobal || isDefaultRoute) &&
924 rte.
SetPrefix(rtIter->first->GetDestNetwork());
946 p->RemoveHeader(hdr);
965 p->RemovePacketTag(tag);
974 p->AddPacketTag(tag);
979 for (std::list<RipRte>::iterator iter = rtes.begin(); iter != rtes.end(); iter++)
986 rtIter->first->GetDestNetworkMask());
991 requestedAddress.
CombineMask(iter->GetSubnetMask());
992 Ipv4Address rtAddress = rtIter->first->GetDestNetwork();
993 rtAddress.
CombineMask(rtIter->first->GetDestNetworkMask());
995 if (requestedAddress == rtAddress)
997 iter->SetRouteMetric(rtIter->first->GetRouteMetric());
998 iter->SetRouteTag(rtIter->first->GetRouteTag());
1008 iter->SetRouteTag(0);
1024 NS_LOG_FUNCTION(
this << senderAddress << incomingInterface <<
int(hopLimit) << hdr);
1029 "Ignoring an update message from an excluded interface: " << incomingInterface);
1036 for (std::list<RipRte>::iterator iter = rtes.begin(); iter != rtes.end(); iter++)
1038 if (iter->GetRouteMetric() == 0 || iter->GetRouteMetric() >
m_linkDown)
1040 NS_LOG_LOGIC(
"Ignoring an update message with malformed metric: "
1041 <<
int(iter->GetRouteMetric()));
1044 if (iter->GetPrefix().IsLocalhost() || iter->GetPrefix().IsBroadcast() ||
1045 iter->GetPrefix().IsMulticast())
1047 NS_LOG_LOGIC(
"Ignoring an update message with wrong prefixes: " << iter->GetPrefix());
1052 bool changed =
false;
1054 for (std::list<RipRte>::iterator iter = rtes.begin(); iter != rtes.end(); iter++)
1056 Ipv4Mask rtePrefixMask = iter->GetSubnetMask();
1066 uint64_t rteMetric = iter->GetRouteMetric() + interfaceMetric;
1076 if (it->first->GetDestNetwork() == rteAddr &&
1077 it->first->GetDestNetworkMask() == rtePrefixMask)
1080 if (rteMetric < it->
first->GetRouteMetric())
1082 if (senderAddress != it->first->GetGateway())
1093 it->first->SetRouteTag(iter->GetRouteTag());
1094 it->first->SetRouteChanged(
true);
1095 it->second.Cancel();
1100 else if (rteMetric == it->first->GetRouteMetric())
1102 if (senderAddress == it->first->GetGateway())
1104 it->second.Cancel();
1125 it->second.Cancel();
1134 else if (rteMetric > it->first->GetRouteMetric() &&
1135 senderAddress == it->first->GetGateway())
1137 it->second.Cancel();
1140 it->first->SetRouteMetric(rteMetric);
1142 it->first->SetRouteTag(iter->GetRouteTag());
1143 it->first->SetRouteChanged(
true);
1144 it->second.Cancel();
1160 NS_LOG_LOGIC(
"Received a RTE with new route, adding.");
1192 uint16_t mtu =
m_ipv4->GetMtu(interface);
1200 p->AddPacketTag(tag);
1207 bool splitHorizoning = (rtIter->first->GetInterface() == interface);
1210 rtIter->first->GetDestNetworkMask());
1213 <<
int(rtIter->first->IsRouteChanged()));
1216 bool isDefaultRoute =
1219 (rtIter->first->GetInterface() != interface));
1221 bool sameNetwork =
false;
1222 for (
uint32_t index = 0; index <
m_ipv4->GetNAddresses(interface); index++)
1226 rtIter->first->GetDestNetwork())
1232 if ((isGlobal || isDefaultRoute) && (periodic || rtIter->first->IsRouteChanged()) &&
1236 rte.
SetPrefix(rtIter->first->GetDestNetwork());
1261 p->RemoveHeader(hdr);
1275 rtIter->first->SetRouteChanged(
false);
1286 NS_LOG_LOGIC(
"Skipping Triggered Update due to cooldown");
1347 std::map<uint32_t, uint8_t>::const_iterator iter =
m_interfaceMetrics.find(interface);
1350 return iter->second;
1373 p->RemovePacketTag(tag);
1375 p->AddPacketTag(tag);
1415 m_status(RIP_INVALID),
1428 m_status(RIP_INVALID),
1440 m_status(RIP_INVALID),
1452 if (
m_tag != routeTag)
1512 os << static_cast<const Ipv4RoutingTableEntry&>(rte);
a polymophic address class
bool IsNull() const
Check for null implementation.
Hold variables of type enum.
An identifier for simulation events.
void Cancel()
This method is syntactic sugar for the ns3::Simulator::Cancel method.
bool IsRunning() const
This method is syntactic sugar for !IsExpired().
Ipv4Address GetIpv4() const
static InetSocketAddress ConvertFrom(const Address &address)
Returns an InetSocketAddress which corresponds to the input Address.
Ipv4 addresses are stored in host order in this class.
static Ipv4Address GetZero()
Ipv4Address CombineMask(const Ipv4Mask &mask) const
Combine this address with a network mask.
static Ipv4Address GetAny()
bool IsLocalMulticast() const
a class to store IPv4 address information on an interface
Ipv4Mask GetMask() const
Get the network mask.
Ipv4InterfaceAddress::InterfaceAddressScope_e GetScope() const
Get address scope.
Ipv4Address GetLocal() const
Get the local address.
a class to represent an Ipv4 address mask
uint16_t GetPrefixLength() const
bool IsMatch(Ipv4Address a, Ipv4Address b) const
static Ipv4Mask GetZero()
This class implements Linux struct pktinfo in order to deliver ancillary information to the socket in...
uint32_t GetRecvIf() const
Get the tag's receiving interface.
Abstract base class for IPv4 routing protocols.
A record of an IPv4 routing table entry for Ipv4GlobalRouting and Ipv4StaticRouting.
Ipv4Address GetDest() const
Ipv4Address GetGateway() const
Ipv4Address GetDestNetwork() const
uint32_t GetInterface() const
Ipv4Mask GetDestNetworkMask() const
static std::string FindName(Ptr< Object > object)
Given a pointer to an object, look to see if that object has a name associated with it and,...
virtual void DoInitialize()
Initialize() implementation.
virtual void DoDispose()
Destructor implementation.
Smart pointer class similar to boost::intrusive_ptr.
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
RIP Routing Protocol, defined in RFC 2453.
void SetInterfaceMetric(uint32_t interface, uint8_t metric)
Set the metric for an interface.
void DoSendRouteUpdate(bool periodic)
Send Routing Updates on all interfaces.
void DoDispose() override
Dispose this object.
SplitHorizonType_e m_splitHorizonStrategy
Split Horizon strategy.
Ptr< Ipv4Route > Lookup(Ipv4Address dest, bool setSource, Ptr< NetDevice >=nullptr)
Lookup in the forwarding table for destination.
Time m_startupDelay
Random delay before protocol startup.
void NotifyInterfaceDown(uint32_t interface) override
std::map< uint32_t, uint8_t > m_interfaceMetrics
Map of interface metrics.
std::set< uint32_t > m_interfaceExclusions
Set of excluded interfaces.
std::list< std::pair< RipRoutingTableEntry *, EventId > >::iterator RoutesI
Iterator for container for the network routes.
uint32_t m_linkDown
Link down value.
void HandleRequests(RipHeader hdr, Ipv4Address senderAddress, uint16_t senderPort, uint32_t incomingInterface, uint8_t hopLimit)
Handle RIP requests.
void DeleteRoute(RipRoutingTableEntry *route)
Delete a route.
bool RouteInput(Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, const UnicastForwardCallback &ucb, const MulticastForwardCallback &mcb, const LocalDeliverCallback &lcb, const ErrorCallback &ecb) override
Route an input packet (to be forwarded or locally delivered)
void InvalidateRoute(RipRoutingTableEntry *route)
Invalidate a route.
void Receive(Ptr< Socket > socket)
Receive RIP packets.
void NotifyInterfaceUp(uint32_t interface) override
EventId m_nextUnsolicitedUpdate
Next Unsolicited Update event.
std::list< std::pair< RipRoutingTableEntry *, EventId > >::const_iterator RoutesCI
Const Iterator for container for the network routes.
void PrintRoutingTable(Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const override
Print the Routing Table entries.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
EventId m_nextTriggeredUpdate
Next Triggered Update event.
Ptr< Ipv4 > m_ipv4
IPv4 reference.
void DoInitialize() override
Start protocol operation.
void SendRouteRequest()
Send Routing Request on all interfaces.
Time m_timeoutDelay
Delay before invalidating a route.
void AddNetworkRouteTo(Ipv4Address network, Ipv4Mask networkPrefix, Ipv4Address nextHop, uint32_t interface)
Add route to network.
std::map< Ptr< Socket >, uint32_t >::iterator SocketListI
Socket list type iterator.
Ptr< Socket > m_multicastRecvSocket
multicast receive socket
Time m_minTriggeredUpdateDelay
Min cooldown delay after a Triggered Update.
@ SPLIT_HORIZON
Split Horizon.
@ NO_SPLIT_HORIZON
No Split Horizon.
@ POISON_REVERSE
Poison Reverse Split Horizon.
Time m_unsolicitedUpdate
time between two Unsolicited Routing Updates
std::set< uint32_t > GetInterfaceExclusions() const
Get the set of interface excluded from the protocol.
Ptr< Ipv4Route > RouteOutput(Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr) override
Query routing cache for an existing route, for an outbound packet.
uint8_t GetInterfaceMetric(uint32_t interface) const
Get the metric for an interface.
void NotifyRemoveAddress(uint32_t interface, Ipv4InterfaceAddress address) override
void NotifyAddAddress(uint32_t interface, Ipv4InterfaceAddress address) override
SocketList m_unicastSocketList
list of sockets for unicast messages (socket, interface index)
Time m_garbageCollectionDelay
Delay before deleting an INVALID route.
void SetIpv4(Ptr< Ipv4 > ipv4) override
static TypeId GetTypeId()
Get the type ID.
bool m_initialized
flag to allow socket's late-creation.
void SetInterfaceExclusions(std::set< uint32_t > exceptions)
Set the set of interface excluded from the protocol.
void AddDefaultRouteTo(Ipv4Address nextHop, uint32_t interface)
Add a default route to the router through the nextHop located on interface.
Routes m_routes
the forwarding table for network.
Time m_maxTriggeredUpdateDelay
Max cooldown delay after a Triggered Update.
void SendTriggeredRouteUpdate()
Send Triggered Routing Updates on all interfaces.
void SendUnsolicitedRouteUpdate()
Send Unsolicited Routing Updates on all interfaces.
void HandleResponses(RipHeader hdr, Ipv4Address senderAddress, uint32_t incomingInterface, uint8_t hopLimit)
Handle RIP responses.
Ptr< UniformRandomVariable > m_rng
Rng stream.
void SetRouteMetric(uint8_t routeMetric)
Set the route metric.
Status_e m_status
route status
bool m_changed
route has been updated
void SetRouteStatus(Status_e status)
Set the route status.
bool IsRouteChanged() const
Get the route changed status.
Status_e GetRouteStatus() const
Get the route status.
uint8_t GetRouteMetric() const
Get the route metric.
void SetRouteTag(uint16_t routeTag)
Set the route tag.
uint16_t GetRouteTag() const
Get the route tag.
void SetRouteChanged(bool changed)
Set the route as changed.
uint8_t m_metric
route metric
virtual ~RipRoutingTableEntry()
Rip v2 Routing Table Entry (RTE) - see RFC 2453.
void SetSubnetMask(Ipv4Mask subnetMask)
Set the subnet mask.
uint32_t GetSerializedSize() const override
Get the serialized size of the packet.
void SetRouteMetric(uint32_t routeMetric)
Set the route metric.
void SetPrefix(Ipv4Address prefix)
Set the prefix.
void SetRouteTag(uint16_t routeTag)
Set the route tag.
static EventId Schedule(const Time &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
static Time GetDelayLeft(const EventId &id)
Get the remaining time until this event will execute.
void SetRecvPktInfo(bool flag)
Enable/Disable receive packet information to socket.
void SetRecvCallback(Callback< void, Ptr< Socket > > receivedData)
Notify application when new data is available to be read.
static Ptr< Socket > CreateSocket(Ptr< Node > node, TypeId tid)
This method wraps the creation of sockets that is performed on a given node by a SocketFactory specif...
virtual int Close()=0
Close a socket.
SocketErrno
Enumeration of the possible errors returned by a socket.
virtual int Bind(const Address &address)=0
Allocate a local endpoint for this socket.
void SetIpRecvTtl(bool ipv4RecvTtl)
Tells a socket to pass information about IP_TTL up the stack.
virtual int SendTo(Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0
Send data to a specified peer.
This class implements a tag that carries the socket-specific TTL of a packet to the IP layer.
void SetTtl(uint8_t ttl)
Set the tag's TTL.
uint8_t GetTtl() const
Get the tag's TTL.
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.
double GetSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
Unit
The unit to use to interpret a number representing time.
AttributeValue implementation for Time.
a unique identifier for an interface.
static TypeId LookupByName(std::string name)
Get a TypeId by name.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Ptr< const AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
#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(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.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
std::ostream & operator<<(std::ostream &os, const Angles &a)
Ptr< const AttributeChecker > MakeEnumChecker(int v, std::string n, Ts... args)
Make an EnumChecker pre-configured with a set of allowed values by name.