ipv4-click-routing.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010 Lalith Suresh
 *
 * 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: Lalith Suresh <suresh.lalith@gmail.com>
 */
 
#ifndef IPV4_CLICK_ROUTING_H
#define IPV4_CLICK_ROUTING_H
 
#include "ns3/ipv4-routing-protocol.h"
#include "ns3/ipv4.h"
#include "ns3/object.h"
#include "ns3/packet.h"
#include "ns3/test.h"
 
#include <map>
#include <string>
#include <sys/time.h>
#include <sys/types.h>
 
class ClickTrivialTest;
class ClickIfidFromNameTest;
class ClickIpMacAddressFromNameTest;
// These are in #include <click/simclick.h>,
// here we just need a forward declaration.
struct simclick_node;
typedef struct simclick_node simclick_node_t;
 
namespace ns3
{
 
class UniformRandomVariable;
 
class Ipv4ClickRouting : public Ipv4RoutingProtocol
{
#ifdef NS3_CLICK
  public:
    // Allow test cases to access private members
    friend class ::ClickTrivialTest;
    friend class ::ClickIfidFromNameTest;
    friend class ::ClickIpMacAddressFromNameTest;
 
    static TypeId GetTypeId();
 
    Ipv4ClickRouting();
    ~Ipv4ClickRouting() override;
 
    Ptr<UniformRandomVariable> GetRandomVariable();
 
  protected:
    void DoInitialize() override;
 
  public:
    void DoDispose() override;
 
    void SetClickFile(std::string clickfile);
 
    void SetDefines(std::map<std::string, std::string> defines);
 
    void SetNodeName(std::string name);
 
    void SetClickRoutingTableElement(std::string name);
 
    std::string ReadHandler(std::string elementName, std::string handlerName);
 
    int WriteHandler(std::string elementName, std::string handlerName, std::string writeString);
 
    void SetPromisc(int ifid);
 
  private:
    simclick_node_t* m_simNode;
 
    static std::map<simclick_node_t*, Ptr<Ipv4ClickRouting>> m_clickInstanceFromSimNode;
 
  public:
    static Ptr<Ipv4ClickRouting> GetClickInstanceFromSimNode(simclick_node_t* simnode);
 
  public:
    std::map<std::string, std::string> GetDefines();
 
    int GetInterfaceId(const char* ifname);
 
    std::string GetIpAddressFromInterfaceId(int ifid);
 
    std::string GetIpPrefixFromInterfaceId(int ifid);
 
    std::string GetMacAddressFromInterfaceId(int ifid);
 
    std::string GetNodeName();
 
    bool IsInterfaceReady(int ifid);
 
    void SetIpv4(Ptr<Ipv4> ipv4) override;
 
  private:
    void AddSimNodeToClickMapping();
 
    struct timeval GetTimevalFromNow() const;
 
    void RunClickEvent();
 
  public:
    void HandleScheduleFromClick(const struct timeval* when);
 
    void HandlePacketFromClick(int ifid, int type, const unsigned char* data, int len);
 
    void SendPacketToClick(int ifid, int type, const unsigned char* data, int len);
 
    void Send(Ptr<Packet> p, Ipv4Address src, Ipv4Address dest);
 
    void Receive(Ptr<Packet> p, Mac48Address receiverAddr, Mac48Address dest);
 
    // From Ipv4RoutingProtocol
    Ptr<Ipv4Route> RouteOutput(Ptr<Packet> p,
                               const Ipv4Header& header,
                               Ptr<NetDevice> oif,
                               Socket::SocketErrno& sockerr) override;
    bool RouteInput(Ptr<const Packet> p,
                    const Ipv4Header& header,
                    Ptr<const NetDevice> idev,
                    UnicastForwardCallback ucb,
                    MulticastForwardCallback mcb,
                    LocalDeliverCallback lcb,
                    ErrorCallback ecb) override;
    void PrintRoutingTable(Ptr<OutputStreamWrapper> stream,
                           Time::Unit unit = Time::S) const override;
    void NotifyInterfaceUp(uint32_t interface) override;
    void NotifyInterfaceDown(uint32_t interface) override;
    void NotifyAddAddress(uint32_t interface, Ipv4InterfaceAddress address) override;
    void NotifyRemoveAddress(uint32_t interface, Ipv4InterfaceAddress address) override;
 
  private:
    std::string m_clickFile;
    std::map<std::string, std::string> m_defines;
    std::string m_nodeName;
    std::string m_clickRoutingTableElement;
 
    std::map<std::string, uint32_t> m_ifaceIdFromName;
    std::map<std::string, Address> m_ifaceMacFromName;
    std::map<std::string, Ipv4Address> m_ifaceAddrFromName;
    bool m_clickInitialised;
    bool m_nonDefaultName;
 
    Ptr<Ipv4> m_ipv4;
    Ptr<UniformRandomVariable> m_random;
#endif /* NS3_CLICK */
};
 
} // namespace ns3
 
#endif /* IPV4_CLICK_ROUTING_H */