ifconfig_set_netlink_socket.hh

// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// vim:set sts=4 ts=8:

// Copyright (c) 2001-2011 XORP, Inc and Others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
// 
// 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. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
// 
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net

// $XORP: xorp/fea/data_plane/ifconfig/ifconfig_set_netlink_socket.hh,v 1.14 2008/12/18 02:06:57 abittau Exp $

#ifndef __FEA_DATA_PLANE_IFCONFIG_IFCONFIG_SET_NETLINK_SOCKET_HH__
#define __FEA_DATA_PLANE_IFCONFIG_IFCONFIG_SET_NETLINK_SOCKET_HH__

#include <xorp_config.h>

#ifdef HAVE_NETLINK_SOCKETS

#include "fea/ifconfig_set.hh"
#include "fea/data_plane/control_socket/netlink_socket.hh"


class IfConfigSetNetlinkSocket : public IfConfigSet,
                 public NetlinkSocket {
public:
    IfConfigSetNetlinkSocket(FeaDataPlaneManager& fea_data_plane_manager);

    virtual ~IfConfigSetNetlinkSocket();

    virtual int start(string& error_msg);

    virtual int stop(string& error_msg);

private:
    virtual bool is_discard_emulated(const IfTreeInterface& i) const;

    virtual bool is_unreachable_emulated(const IfTreeInterface& i) const;

    virtual int config_begin(string& error_msg);

    virtual int config_end(string& error_msg);

    virtual int config_interface_begin(const IfTreeInterface* pulled_ifp,
                       IfTreeInterface& config_iface,
                       string& error_msg);

    virtual int config_interface_end(const IfTreeInterface* pulled_ifp,
                     const IfTreeInterface& config_iface,
                     string& error_msg);

    virtual int config_vif_begin(const IfTreeInterface* pulled_ifp,
                 const IfTreeVif* pulled_vifp,
                 const IfTreeInterface& config_iface,
                 const IfTreeVif& config_vif,
                 string& error_msg);

    virtual int config_vif_end(const IfTreeInterface* pulled_ifp,
                   const IfTreeVif* pulled_vifp,
                   const IfTreeInterface& config_iface,
                   const IfTreeVif& config_vif,
                   string& error_msg);

    virtual int config_add_address(const IfTreeInterface* pulled_ifp,
                   const IfTreeVif* pulled_vifp,
                   const IfTreeAddr4* pulled_addrp,
                   const IfTreeInterface& config_iface,
                   const IfTreeVif& config_vif,
                   const IfTreeAddr4& config_addr,
                   string& error_msg);

    virtual int config_delete_address(const IfTreeInterface* pulled_ifp,
                      const IfTreeVif* pulled_vifp,
                      const IfTreeAddr4* pulled_addrp,
                      const IfTreeInterface& config_iface,
                      const IfTreeVif& config_vif,
                      const IfTreeAddr4& config_addr,
                      string& error_msg);

    virtual int config_add_address(const IfTreeInterface* pulled_ifp,
                   const IfTreeVif* pulled_vifp,
                   const IfTreeAddr6* pulled_addrp,
                   const IfTreeInterface& config_iface,
                   const IfTreeVif& config_vif,
                   const IfTreeAddr6& config_addr,
                   string& error_msg);

    virtual int config_delete_address(const IfTreeInterface* pulled_ifp,
                      const IfTreeVif* pulled_vifp,
                      const IfTreeAddr6* pulled_addrp,
                      const IfTreeInterface& config_iface,
                      const IfTreeVif& config_vif,
                      const IfTreeAddr6& config_addr,
                      string& error_msg);

    int set_interface_status(const string& ifname,
                 uint32_t if_index,
                 uint32_t interface_flags,
                 bool is_enabled,
                 string& error_msg);

    void wait_interface_status(const IfTreeInterface* ifp, bool is_enabled);

    int set_interface_mac_address(const string& ifname, uint32_t if_index,
                  const Mac& mac, string& error_msg);

    int set_interface_mtu(const string& ifname, uint32_t if_index,
              uint32_t mtu, string& error_msg);

    int add_addr(const string& ifname, const string& vifname,
         uint32_t if_index, const IPvX& addr, uint32_t prefix_len,
         bool is_broadcast, const IPvX& broadcast_addr,
         bool is_point_to_point, const IPvX& endpoint_addr,
         string& error_msg);

    int delete_addr(const string& ifname, const string& vifname,
            uint32_t if_index, const IPvX& addr, uint32_t prefix_len,
            string& error_msg);

    NetlinkSocketReader _ns_reader;
};

#endif
#endif // __FEA_DATA_PLANE_IFCONFIG_IFCONFIG_SET_NETLINK_SOCKET_HH__