global-router-interface.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright 2007 University of Washington
 * 
 * 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
 *
 * Authors:  Craig Dowell (craigdo@ee.washington.edu)
 *           Tom Henderson (tomhend@u.washington.edu)
 */

#ifndef GLOBAL_ROUTER_INTERFACE_H
#define GLOBAL_ROUTER_INTERFACE_H

#include <stdint.h>
#include <list>
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/node.h"
#include "ns3/channel.h"
#include "ns3/ipv4-address.h"
#include "ns3/net-device-container.h"
#include "ns3/bridge-net-device.h"
#include "ns3/global-route-manager.h"
#include "ns3/ipv4-routing-table-entry.h"

namespace ns3 {

class GlobalRouter;
class Ipv4GlobalRouting;

class GlobalRoutingLinkRecord
{
public:
  friend class GlobalRoutingLSA;
  enum LinkType {
    Unknown = 0,        
    PointToPoint,       
    TransitNetwork,     
    StubNetwork,        
    VirtualLink         
  };

  GlobalRoutingLinkRecord ();

  GlobalRoutingLinkRecord (
    LinkType    linkType, 
    Ipv4Address linkId, 
    Ipv4Address linkData, 
    uint16_t    metric);

  ~GlobalRoutingLinkRecord ();

  Ipv4Address GetLinkId (void) const;

  void SetLinkId (Ipv4Address addr);

  Ipv4Address GetLinkData (void) const;

  void SetLinkData (Ipv4Address addr);

  LinkType GetLinkType (void) const;

  void SetLinkType (LinkType linkType);

  uint16_t GetMetric (void) const;

  void SetMetric (uint16_t metric);

private:
  Ipv4Address m_linkId;

  Ipv4Address m_linkData;    // for links to RouterLSA, 

  LinkType m_linkType;

  uint16_t m_metric;
};

class GlobalRoutingLSA
{
public:
  enum LSType {
    Unknown = 0,        
    RouterLSA,
    NetworkLSA,
    SummaryLSA,
    SummaryLSA_ASBR,
    ASExternalLSAs
  };
  enum SPFStatus {
    LSA_SPF_NOT_EXPLORED = 0,   
    LSA_SPF_CANDIDATE,          
    LSA_SPF_IN_SPFTREE          
  };
  GlobalRoutingLSA();

  GlobalRoutingLSA(SPFStatus status, Ipv4Address linkStateId, 
                   Ipv4Address advertisingRtr);

  GlobalRoutingLSA (GlobalRoutingLSA& lsa);

  ~GlobalRoutingLSA();

  GlobalRoutingLSA& operator= (const GlobalRoutingLSA& lsa);

  void CopyLinkRecords (const GlobalRoutingLSA& lsa);

  uint32_t AddLinkRecord (GlobalRoutingLinkRecord* lr);

  uint32_t GetNLinkRecords (void) const;

  GlobalRoutingLinkRecord* GetLinkRecord (uint32_t n) const;

  void ClearLinkRecords (void);

  bool IsEmpty (void) const;

  void Print (std::ostream &os) const;

  LSType GetLSType (void) const;
  void SetLSType (LSType typ);

  Ipv4Address GetLinkStateId (void) const;

  void SetLinkStateId (Ipv4Address addr);

  Ipv4Address GetAdvertisingRouter (void) const;

  void SetAdvertisingRouter (Ipv4Address  rtr);

  void SetNetworkLSANetworkMask (Ipv4Mask mask);

  Ipv4Mask GetNetworkLSANetworkMask (void) const;

  uint32_t AddAttachedRouter (Ipv4Address addr);

  uint32_t GetNAttachedRouters (void) const;

  Ipv4Address GetAttachedRouter (uint32_t n) const;

  SPFStatus GetStatus (void) const;

  void SetStatus (SPFStatus status);

  Ptr<Node> GetNode (void) const;

  void SetNode (Ptr<Node> node);

private:
  LSType m_lsType;
  Ipv4Address  m_linkStateId;

  Ipv4Address  m_advertisingRtr;

  typedef std::list<GlobalRoutingLinkRecord*> ListOfLinkRecords_t;

  ListOfLinkRecords_t m_linkRecords;

  Ipv4Mask m_networkLSANetworkMask;

  typedef std::list<Ipv4Address> ListOfAttachedRouters_t;

  ListOfAttachedRouters_t m_attachedRouters;

  SPFStatus m_status;
  uint32_t m_node_id;
};

std::ostream& operator<< (std::ostream& os, GlobalRoutingLSA& lsa);

class GlobalRouter : public Object
{
public:
  static TypeId GetTypeId (void);

  GlobalRouter ();


  void SetRoutingProtocol (Ptr<Ipv4GlobalRouting> routing);
  Ptr<Ipv4GlobalRouting> GetRoutingProtocol (void);

  Ipv4Address GetRouterId (void) const;

  uint32_t DiscoverLSAs (void);

  uint32_t GetNumLSAs (void) const;

  bool GetLSA (uint32_t n, GlobalRoutingLSA &lsa) const;

  void InjectRoute (Ipv4Address network, Ipv4Mask networkMask);

  uint32_t GetNInjectedRoutes (void);

  Ipv4RoutingTableEntry *GetInjectedRoute (uint32_t i);

  void RemoveInjectedRoute (uint32_t i);

  bool WithdrawRoute (Ipv4Address network, Ipv4Mask networkMask);

private:
  virtual ~GlobalRouter ();
  void ClearLSAs (void);

  Ptr<NetDevice> GetAdjacent (Ptr<NetDevice> nd, Ptr<Channel> ch) const;
  bool FindInterfaceForDevice (Ptr<Node> node, Ptr<NetDevice> nd, uint32_t &index) const;
  Ipv4Address FindDesignatedRouterForLink (Ptr<NetDevice> ndLocal, bool allowRecursion) const;
  bool AnotherRouterOnLink (Ptr<NetDevice> nd, bool allowRecursion) const;
  void ProcessBroadcastLink (Ptr<NetDevice> nd, GlobalRoutingLSA *pLSA, NetDeviceContainer &c);
  void ProcessSingleBroadcastLink (Ptr<NetDevice> nd, GlobalRoutingLSA *pLSA, NetDeviceContainer &c);
  void ProcessBridgedBroadcastLink (Ptr<NetDevice> nd, GlobalRoutingLSA *pLSA, NetDeviceContainer &c);

  void ProcessPointToPointLink (Ptr<NetDevice> ndLocal, GlobalRoutingLSA *pLSA);
  void BuildNetworkLSAs (NetDeviceContainer c);
  Ptr<BridgeNetDevice> NetDeviceIsBridged (Ptr<NetDevice> nd) const;


  typedef std::list<GlobalRoutingLSA*> ListOfLSAs_t;
  ListOfLSAs_t m_LSAs;

  Ipv4Address m_routerId;
  Ptr<Ipv4GlobalRouting> m_routingProtocol;

  typedef std::list<Ipv4RoutingTableEntry *> InjectedRoutes;
  typedef std::list<Ipv4RoutingTableEntry *>::const_iterator InjectedRoutesCI;
  typedef std::list<Ipv4RoutingTableEntry *>::iterator InjectedRoutesI;
  InjectedRoutes m_injectedRoutes; // Routes we are exporting

  // inherited from Object
  virtual void DoDispose (void);

  GlobalRouter (GlobalRouter& sr);

  GlobalRouter& operator= (GlobalRouter& sr);
};

} // namespace ns3

#endif /* GLOBAL_ROUTER_INTERFACE_H */