A Discrete-Event Network Simulator
Go to the documentation of this file.
1 // -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*-
2 //
3 // Copyright (c) 2008 University of Washington
4 //
5 // This program is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License version 2 as
7 // published by the Free Software Foundation;
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 //
18 //
23 #include <list>
24 #include <stdint.h>
25 #include "ns3/ipv4-address.h"
26 #include "ns3/ipv4-header.h"
27 #include "ns3/ptr.h"
28 #include "ns3/ipv4.h"
29 #include "ns3/ipv4-routing-protocol.h"
30 #include "ns3/random-variable-stream.h"
32 namespace ns3 {
34 class Packet;
35 class NetDevice;
36 class Ipv4Interface;
37 class Ipv4Address;
38 class Ipv4Header;
39 class Ipv4RoutingTableEntry;
40 class Ipv4MulticastRoutingTableEntry;
41 class Node;
72 {
73 public:
78  static TypeId GetTypeId (void);
88  virtual ~Ipv4GlobalRouting ();
90  // These methods inherited from base class
91  virtual Ptr<Ipv4Route> RouteOutput (Ptr<Packet> p, const Ipv4Header &header, Ptr<NetDevice> oif, Socket::SocketErrno &sockerr);
93  virtual bool RouteInput (Ptr<const Packet> p, const Ipv4Header &header, Ptr<const NetDevice> idev,
96  virtual void NotifyInterfaceUp (uint32_t interface);
97  virtual void NotifyInterfaceDown (uint32_t interface);
98  virtual void NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address);
99  virtual void NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address);
100  virtual void SetIpv4 (Ptr<Ipv4> ipv4);
101  virtual void PrintRoutingTable (Ptr<OutputStreamWrapper> stream) const;
113  void AddHostRouteTo (Ipv4Address dest,
114  Ipv4Address nextHop,
115  uint32_t interface);
125  void AddHostRouteTo (Ipv4Address dest,
126  uint32_t interface);
139  void AddNetworkRouteTo (Ipv4Address network,
140  Ipv4Mask networkMask,
141  Ipv4Address nextHop,
142  uint32_t interface);
154  void AddNetworkRouteTo (Ipv4Address network,
155  Ipv4Mask networkMask,
156  uint32_t interface);
167  void AddASExternalRouteTo (Ipv4Address network,
168  Ipv4Mask networkMask,
169  Ipv4Address nextHop,
170  uint32_t interface);
179  uint32_t GetNRoutes (void) const;
201  Ipv4RoutingTableEntry *GetRoute (uint32_t i) const;
219  void RemoveRoute (uint32_t i);
229  int64_t AssignStreams (int64_t stream);
231 protected:
232  void DoDispose (void);
234 private:
243  typedef std::list<Ipv4RoutingTableEntry *> HostRoutes;
245  typedef std::list<Ipv4RoutingTableEntry *>::const_iterator HostRoutesCI;
247  typedef std::list<Ipv4RoutingTableEntry *>::iterator HostRoutesI;
250  typedef std::list<Ipv4RoutingTableEntry *> NetworkRoutes;
252  typedef std::list<Ipv4RoutingTableEntry *>::const_iterator NetworkRoutesCI;
254  typedef std::list<Ipv4RoutingTableEntry *>::iterator NetworkRoutesI;
257  typedef std::list<Ipv4RoutingTableEntry *> ASExternalRoutes;
259  typedef std::list<Ipv4RoutingTableEntry *>::const_iterator ASExternalRoutesCI;
261  typedef std::list<Ipv4RoutingTableEntry *>::iterator ASExternalRoutesI;
271  HostRoutes m_hostRoutes;
272  NetworkRoutes m_networkRoutes;
273  ASExternalRoutes m_ASexternalRoutes;
276 };
278 } // Namespace ns3
280 #endif /* IPV4_GLOBAL_ROUTING_H */
std::list< Ipv4RoutingTableEntry * >::iterator HostRoutesI
iterator of container of Ipv4RoutingTableEntry (routes to hosts)
virtual void NotifyInterfaceUp(uint32_t interface)
Enumeration of the possible errors returned by a socket.
Definition: socket.h:82
void DoDispose(void)
Destructor implementation.
Callback template class.
Definition: callback.h:1176
Construct an empty Ipv4GlobalRouting routing protocol,.
a class to represent an Ipv4 address mask
Definition: ipv4-address.h:257
virtual void PrintRoutingTable(Ptr< OutputStreamWrapper > stream) const
Print the Routing Table entries.
virtual bool RouteInput(Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
Route an input packet (to be forwarded or locally delivered)
virtual void NotifyInterfaceDown(uint32_t interface)
void RemoveRoute(uint32_t i)
Remove a route from the global unicast routing table.
Ipv4RoutingTableEntry * GetRoute(uint32_t i) const
Get a route from the global unicast routing table.
std::list< Ipv4RoutingTableEntry * > HostRoutes
container of Ipv4RoutingTableEntry (routes to hosts)
std::list< Ipv4RoutingTableEntry * >::const_iterator ASExternalRoutesCI
const iterator of container of Ipv4RoutingTableEntry (routes to external AS)
ASExternalRoutes m_ASexternalRoutes
External routes imported.
Packet header for IPv4.
Definition: ipv4-header.h:33
HostRoutes m_hostRoutes
Routes to hosts.
Ptr< UniformRandomVariable > m_rand
A uniform random number generator for randomly routing packets among ECMP.
A record of an IPv4 routing table entry for Ipv4GlobalRouting and Ipv4StaticRouting.
Ptr< Ipv4 > m_ipv4
associated IPv4 instance
bool m_respondToInterfaceEvents
Set to true if this interface should respond to interface events by globallly recomputing routes...
Global routing protocol for IPv4 stacks.
std::list< Ipv4RoutingTableEntry * >::const_iterator NetworkRoutesCI
const iterator of container of Ipv4RoutingTableEntry (routes to networks)
bool m_randomEcmpRouting
Set to true if packets are randomly routed among ECMP; set to false for using only one route consiste...
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Ptr< Ipv4Route > LookupGlobal(Ipv4Address dest, Ptr< NetDevice > oif=0)
Lookup in the forwarding table for destination.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::list< Ipv4RoutingTableEntry * >::const_iterator HostRoutesCI
const iterator of container of Ipv4RoutingTableEntry (routes to hosts)
virtual Ptr< Ipv4Route > RouteOutput(Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
Query routing cache for an existing route, for an outbound packet.
std::list< Ipv4RoutingTableEntry * >::iterator ASExternalRoutesI
iterator of container of Ipv4RoutingTableEntry (routes to external AS)
void AddNetworkRouteTo(Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
Add a network route to the global routing table.
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
std::list< Ipv4RoutingTableEntry * >::iterator NetworkRoutesI
iterator of container of Ipv4RoutingTableEntry (routes to networks)
a class to store IPv4 address information on an interface
std::list< Ipv4RoutingTableEntry * > NetworkRoutes
container of Ipv4RoutingTableEntry (routes to networks)
virtual void SetIpv4(Ptr< Ipv4 > ipv4)
Abstract base class for IPv4 routing protocols.
NetworkRoutes m_networkRoutes
Routes to networks.
tuple address
Definition: first.py:37
static TypeId GetTypeId(void)
Get the type ID.
std::list< Ipv4RoutingTableEntry * > ASExternalRoutes
container of Ipv4RoutingTableEntry (routes to external AS)
a unique identifier for an interface.
Definition: type-id.h:58
virtual void NotifyAddAddress(uint32_t interface, Ipv4InterfaceAddress address)
uint32_t GetNRoutes(void) const
Get the number of individual unicast routes that have been added to the routing table.
void AddASExternalRouteTo(Ipv4Address network, Ipv4Mask networkMask, Ipv4Address nextHop, uint32_t interface)
Add an external route to the global routing table.
virtual void NotifyRemoveAddress(uint32_t interface, Ipv4InterfaceAddress address)
void AddHostRouteTo(Ipv4Address dest, Ipv4Address nextHop, uint32_t interface)
Add a host route to the global routing table.