ndn-cxx/net/impl/network-monitor-impl-netlink.hpp

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2023 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library 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 Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 *
 * @author Davide Pesavento <davide.pesavento@lip6.fr>
 */

#ifndef NDN_CXX_NET_NETWORK_MONITOR_IMPL_NETLINK_HPP
#define NDN_CXX_NET_NETWORK_MONITOR_IMPL_NETLINK_HPP

#include "ndn-cxx/detail/config.hpp"
#include "ndn-cxx/net/network-monitor.hpp"

#ifndef NDN_CXX_HAVE_NETLINK
#error "This file should not be included ..."
#endif

#include "ndn-cxx/net/impl/netlink-socket.hpp"

#include <map>

namespace ndn::net {

class NetworkMonitorImplNetlink final : public NetworkMonitorImpl
{
public:
  /**
   * \brief Initialize netlink socket and start enumerating interfaces.
   */
  explicit
  NetworkMonitorImplNetlink(boost::asio::io_service& io);

  uint32_t
  getCapabilities() const final
  {
    return NetworkMonitor::CAP_ENUM |
           NetworkMonitor::CAP_IF_ADD_REMOVE |
           NetworkMonitor::CAP_STATE_CHANGE |
           NetworkMonitor::CAP_MTU_CHANGE |
           NetworkMonitor::CAP_ADDR_ADD_REMOVE;
  }

  shared_ptr<const NetworkInterface>
  getNetworkInterface(const std::string& ifname) const final;

  std::vector<shared_ptr<const NetworkInterface>>
  listNetworkInterfaces() const final;

private:
  void
  enumerateLinks();

  void
  enumerateAddrs();

  void
  enumerateRoutes();

  void
  parseRtnlMessage(const NetlinkMessage& nlmsg);

  void
  parseLinkMessage(const NetlinkMessage& nlmsg);

  void
  parseAddressMessage(const NetlinkMessage& nlmsg);

  void
  parseRouteMessage(const NetlinkMessage& nlmsg);

  void
  parseDoneMessage(const NetlinkMessage& nlmsg);

  void
  parseErrorMessage(const NetlinkMessage& nlmsg);

private:
  std::map<int, shared_ptr<NetworkInterface>> m_interfaces; ///< ifindex => interface
  RtnlSocket m_rtnlSocket; ///< rtnetlink socket
  GenlSocket m_genlSocket; ///< generic netlink socket to communicate with nl80211

  enum {
    ENUMERATION_NOT_STARTED,
    ENUMERATING_LINKS,    ///< a dump of all links (RTM_GETLINK) is in progress
    ENUMERATING_ADDRS,    ///< a dump of all addresses (RTM_GETADDR) is in progress
    ENUMERATING_ROUTES,   ///< a dump of all routes (RTM_GETROUTE) is in progress (unimplemented)
    ENUMERATION_COMPLETE,
  } m_phase = ENUMERATION_NOT_STARTED;
};

} // namespace ndn::net

#endif // NDN_CXX_NET_NETWORK_MONITOR_IMPL_NETLINK_HPP