ofswitch13-controller.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 University of Campinas (Unicamp)
 *
 * 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: Luciano Jerez Chaves <ljerezchaves@gmail.com>
 */
 
#ifndef OFSWITCH13_CONTROLLER_H
#define OFSWITCH13_CONTROLLER_H
 
#include "ofswitch13-interface.h"
#include "ofswitch13-socket-handler.h"
 
#include <ns3/application.h>
#include <ns3/socket.h>
 
#include <string>
 
namespace ns3
{
 
class OFSwitch13Controller : public Application
{
  protected:
    class RemoteSwitch : public SimpleRefCount<RemoteSwitch>
    {
        friend class OFSwitch13Controller;
 
      public:
        RemoteSwitch();
 
        Ipv4Address GetIpv4() const;
 
        uint16_t GetPort() const;
 
        uint64_t GetDpId() const;
 
      private:
        Ptr<OFSwitch13SocketHandler> m_handler; 
        Address m_address;                      
        Ptr<OFSwitch13Controller> m_ctrlApp;    
        uint64_t m_dpId;                        
        enum ofp_controller_role m_role; 
 
        //\{
        uint32_t m_nBuffers;     
        uint8_t m_nTables;       
        uint8_t m_auxiliaryId;   
        uint32_t m_capabilities; 
                                 //\}
 
    }; // class RemoteSwitch
 
    struct EchoInfo
    {
        friend class OFSwitch13Controller;
 
      public:
        EchoInfo(Ptr<const RemoteSwitch> swtch);
 
        Time GetRtt() const;
 
      private:
        bool m_waiting;                  
        Time m_send;                     
        Time m_recv;                     
        Ptr<const RemoteSwitch> m_swtch; 
    };
 
    struct BarrierInfo
    {
        friend class OFSwitch13Controller;
 
      public:
        BarrierInfo(Ptr<const RemoteSwitch> swtch);
 
      private:
        bool m_waiting;                  
        Ptr<const RemoteSwitch> m_swtch; 
    };
 
  private:
    class PendingCommands : public SimpleRefCount<PendingCommands>
    {
        friend class OFSwitch13Controller;
 
      public:
        PendingCommands();
 
      private:
        std::queue<std::string> m_queue; 
    };
 
  public:
    OFSwitch13Controller();           
    ~OFSwitch13Controller() override; 
 
    static TypeId GetTypeId();
 
    void DoDispose() override;
 
    int DpctlExecute(uint64_t dpId, const std::string textCmd);
 
    static void DpctlSendAndPrint(struct vconn* vconn,
                                  struct ofl_msg_header* msg);
 
  protected:
    // inherited from Application
    void StartApplication() override;
    void StopApplication() override;
 
    uint32_t GetNextXid();
 
    virtual void HandshakeSuccessful(Ptr<const RemoteSwitch> swtch);
 
    Ptr<const RemoteSwitch> GetRemoteSwitch(uint64_t dpId) const;
 
    int SendToSwitch(Ptr<const RemoteSwitch> swtch,
                     struct ofl_msg_header* msg,
                     uint32_t xid = 0);
 
    void SendEchoRequest(Ptr<const RemoteSwitch> swtch, size_t payloadSize = 0);
 
    void SendBarrierRequest(Ptr<const RemoteSwitch> swtch);
 
    //\{
    ofl_err HandleEchoRequest(struct ofl_msg_echo* msg,
                              Ptr<const RemoteSwitch> swtch,
                              uint32_t xid);
 
    ofl_err HandleEchoReply(struct ofl_msg_echo* msg,
                            Ptr<const RemoteSwitch> swtch,
                            uint32_t xid);
 
    ofl_err HandleBarrierReply(struct ofl_msg_header* msg,
                               Ptr<const RemoteSwitch> swtch,
                               uint32_t xid);
 
    ofl_err HandleHello(struct ofl_msg_header* msg,
                        Ptr<const RemoteSwitch> swtch,
                        uint32_t xid);
 
    ofl_err HandleFeaturesReply(struct ofl_msg_features_reply* msg,
                                Ptr<RemoteSwitch> swtch,
                                uint32_t xid);
 
    virtual ofl_err HandlePacketIn(struct ofl_msg_packet_in* msg,
                                   Ptr<const RemoteSwitch> swtch,
                                   uint32_t xid);
 
    virtual ofl_err HandleError(struct ofl_msg_error* msg,
                                Ptr<const RemoteSwitch> swtch,
                                uint32_t xid);
 
    virtual ofl_err HandleGetConfigReply(struct ofl_msg_get_config_reply* msg,
                                         Ptr<const RemoteSwitch> swtch,
                                         uint32_t xid);
 
    virtual ofl_err HandleFlowRemoved(struct ofl_msg_flow_removed* msg,
                                      Ptr<const RemoteSwitch> swtch,
                                      uint32_t xid);
 
    virtual ofl_err HandlePortStatus(struct ofl_msg_port_status* msg,
                                     Ptr<const RemoteSwitch> swtch,
                                     uint32_t xid);
 
    virtual ofl_err HandleAsyncReply(struct ofl_msg_async_config* msg,
                                     Ptr<const RemoteSwitch> swtch,
                                     uint32_t xid);
 
    virtual ofl_err HandleMultipartReply(
        struct ofl_msg_multipart_reply_header* msg,
        Ptr<const RemoteSwitch> swtch,
        uint32_t xid);
 
    virtual ofl_err HandleRoleReply(struct ofl_msg_role_request* msg,
                                    Ptr<const RemoteSwitch> swtch,
                                    uint32_t xid);
 
    virtual ofl_err HandleQueueGetConfigReply(
        struct ofl_msg_queue_get_config_reply* msg,
        Ptr<const RemoteSwitch> swtch,
        uint32_t xid);
    //\}
 
  private:
    ofl_err HandleSwitchMsg(struct ofl_msg_header* msg,
                            Ptr<RemoteSwitch> swtch,
                            uint32_t xid);
 
    void ReceiveFromSwitch(Ptr<Packet> packet, Address from);
 
    Ptr<RemoteSwitch> GetRemoteSwitch(Address address);
 
    //\{
    bool SocketRequest(Ptr<Socket> socket, const Address& from);
 
    void SocketAccept(Ptr<Socket> socket, const Address& from);
 
    void SocketPeerClose(Ptr<Socket> socket);
 
    void SocketPeerError(Ptr<Socket> socket);
    //\}
 
    typedef std::map<uint32_t, EchoInfo> EchoMsgMap_t;
 
    typedef std::map<uint32_t, BarrierInfo> BarrierMsgMap_t;
 
    typedef std::map<uint64_t, Ptr<PendingCommands>> DpIdCmdMap_t;
 
    typedef std::map<Address, Ptr<RemoteSwitch>> AddrSwMap_t;
 
    typedef std::map<uint64_t, Ptr<RemoteSwitch>> DpIdSwMap_t;
 
    uint32_t m_xid;             
    uint16_t m_port;            
    Ptr<Socket> m_serverSocket; 
 
    EchoMsgMap_t m_echoMap;       
    BarrierMsgMap_t m_barrierMap; 
    DpIdCmdMap_t m_commandsMap;   
    AddrSwMap_t m_addrSwMap;      
    DpIdSwMap_t m_dpIdSwMap;      
};
 
} // namespace ns3
#endif /* OFSWITCH13_CONTROLLER_H */