blob: ce72a625ffe431c7abda37e54d3e483ad259adf5 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
* Washington University in St. Louis,
* Beijing Institute of Technology,
* The University of Memphis
*
* This file is part of NFD (Named Data Networking Forwarding Daemon).
* See AUTHORS.md for complete list of NFD authors and contributors.
*
* NFD is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* NFD 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
* NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef NFD_DAEMON_FACE_ETHERNET_FACE_HPP
#define NFD_DAEMON_FACE_ETHERNET_FACE_HPP
#include "common.hpp"
#include "face.hpp"
#include "ndnlp-partial-message-store.hpp"
#include "ndnlp-slicer.hpp"
#include "core/network-interface.hpp"
#include <unordered_map>
#ifndef HAVE_LIBPCAP
#error "Cannot include this file when libpcap is not available"
#endif
// forward declarations
struct pcap;
typedef pcap pcap_t;
struct pcap_pkthdr;
namespace nfd {
/**
* @brief Implementation of Face abstraction that uses raw
* Ethernet frames as underlying transport mechanism
*/
class EthernetFace : public Face
{
public:
/**
* @brief EthernetFace-related error
*/
struct Error : public Face::Error
{
Error(const std::string& what) : Face::Error(what) {}
};
EthernetFace(const shared_ptr<boost::asio::posix::stream_descriptor>& socket,
const NetworkInterfaceInfo& interface,
const ethernet::Address& address);
virtual
~EthernetFace();
/// send an Interest
virtual void
sendInterest(const Interest& interest);
/// send a Data
virtual void
sendData(const Data& data);
/**
* @brief Closes the face
*
* This terminates all communication on the face and triggers the onFail() event.
*/
virtual void
close();
private:
/**
* @brief Allocates and initializes a libpcap context for live capture
*/
void
pcapInit();
/**
* @brief Installs a BPF filter on the receiving socket
*
* @param filterString string containing the source BPF program
*/
void
setPacketFilter(const char* filterString);
/**
* @brief Enables receiving frames addressed to our MAC multicast group
*
* @return true if successful, false otherwise
*/
bool
joinMulticastGroup();
/**
* @brief Sends the specified TLV block on the network wrapped in an Ethernet frame
*/
void
sendPacket(const ndn::Block& block);
/**
* @brief Receive callback
*/
void
handleRead(const boost::system::error_code& error, size_t nBytesRead);
PUBLIC_WITH_TESTS_ELSE_PRIVATE:
/**
* @brief Processes an incoming frame as captured by libpcap
*
* @param header pointer to capture metadata
* @param packet pointer to the received frame, including the link-layer header
*/
void
processIncomingPacket(const pcap_pkthdr* header, const uint8_t* packet);
private:
/**
* @brief Handles errors encountered by Boost.Asio on the receive path
*/
void
processErrorCode(const boost::system::error_code& error);
/**
* @brief Returns the MTU of the underlying network interface
*/
size_t
getInterfaceMtu() const;
private:
struct Reassembler
{
unique_ptr<ndnlp::PartialMessageStore> pms;
EventId expireEvent;
};
unique_ptr<pcap_t, void(*)(pcap_t*)> m_pcap;
shared_ptr<boost::asio::posix::stream_descriptor> m_socket;
#if defined(__linux__)
int m_interfaceIndex;
#endif
std::string m_interfaceName;
ethernet::Address m_srcAddress;
ethernet::Address m_destAddress;
size_t m_interfaceMtu;
unique_ptr<ndnlp::Slicer> m_slicer;
std::unordered_map<ethernet::Address, Reassembler> m_reassemblers;
static const time::nanoseconds REASSEMBLER_LIFETIME;
};
} // namespace nfd
#endif // NFD_DAEMON_FACE_ETHERNET_FACE_HPP