unicast-udp-transport.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2023, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
27 #include "udp-protocol.hpp"
28 #include "common/global.hpp"
29 
30 #ifdef __linux__
31 #include <cerrno> // for errno
32 #include <cstring> // for std::strerror()
33 #include <netinet/in.h> // for IP_MTU_DISCOVER and IP_PMTUDISC_DONT
34 #include <sys/socket.h> // for setsockopt()
35 #endif
36 
37 namespace nfd::face {
38 
39 namespace ip = boost::asio::ip;
40 
41 NFD_LOG_MEMBER_INIT_SPECIALIZED((DatagramTransport<ip::udp, Unicast>), UnicastUdpTransport);
42 
44  ndn::nfd::FacePersistency persistency,
45  time::nanoseconds idleTimeout)
46  : DatagramTransport(std::move(socket))
47  , m_idleTimeout(idleTimeout)
48 {
49  this->setLocalUri(FaceUri(m_socket.local_endpoint()));
50  this->setRemoteUri(FaceUri(m_socket.remote_endpoint()));
51  this->setScope(ndn::nfd::FACE_SCOPE_NON_LOCAL);
52  this->setPersistency(persistency);
53  this->setLinkType(ndn::nfd::LINK_TYPE_POINT_TO_POINT);
54  this->setMtu(udp::computeMtu(m_socket.local_endpoint()));
55 
56  NFD_LOG_FACE_DEBUG("Creating transport");
57 
58 #ifdef __linux__
59  //
60  // By default, Linux does path MTU discovery on IPv4 sockets,
61  // and sets the DF (Don't Fragment) flag on datagrams smaller
62  // than the interface MTU. However this does not work for us,
63  // because we cannot properly respond to ICMP "packet too big"
64  // messages by fragmenting the packet at the application level,
65  // since we want to rely on IP for fragmentation and reassembly.
66  //
67  // Therefore, we disable PMTU discovery, which prevents the kernel
68  // from setting the DF flag on outgoing datagrams, and thus allows
69  // routers along the path to perform fragmentation as needed.
70  //
71  const int value = IP_PMTUDISC_DONT;
72  if (::setsockopt(m_socket.native_handle(), IPPROTO_IP,
73  IP_MTU_DISCOVER, &value, sizeof(value)) < 0) {
74  NFD_LOG_FACE_WARN("Failed to disable path MTU discovery: " << std::strerror(errno));
75  }
76 #endif
77 
78  if (getPersistency() == ndn::nfd::FACE_PERSISTENCY_ON_DEMAND &&
79  m_idleTimeout > time::nanoseconds::zero()) {
80  scheduleClosureWhenIdle();
81  }
82 }
83 
84 bool
85 UnicastUdpTransport::canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const
86 {
87  return true;
88 }
89 
90 void
91 UnicastUdpTransport::afterChangePersistency(ndn::nfd::FacePersistency oldPersistency)
92 {
93  if (getPersistency() == ndn::nfd::FACE_PERSISTENCY_ON_DEMAND &&
94  m_idleTimeout > time::nanoseconds::zero()) {
95  scheduleClosureWhenIdle();
96  }
97  else {
98  m_closeIfIdleEvent.cancel();
99  setExpirationTime(time::steady_clock::time_point::max());
100  }
101 }
102 
103 void
104 UnicastUdpTransport::scheduleClosureWhenIdle()
105 {
106  m_closeIfIdleEvent = getScheduler().schedule(m_idleTimeout, [this] {
107  if (!hasRecentlyReceived()) {
108  NFD_LOG_FACE_INFO("Closing due to inactivity");
109  this->close();
110  }
111  else {
113  scheduleClosureWhenIdle();
114  }
115  });
116  setExpirationTime(time::steady_clock::now() + m_idleTimeout);
117 }
118 
119 } // namespace nfd::face
Implements a Transport for datagram-based protocols.
void setScope(ndn::nfd::FaceScope scope) noexcept
Definition: transport.hpp:355
void setPersistency(ndn::nfd::FacePersistency newPersistency)
Changes the persistency setting of the transport.
Definition: transport.cpp:152
ndn::nfd::FacePersistency getPersistency() const noexcept
Returns the current persistency setting of the transport.
Definition: transport.hpp:236
void setMtu(ssize_t mtu) noexcept
Definition: transport.cpp:114
void setExpirationTime(const time::steady_clock::time_point &expirationTime) noexcept
Definition: transport.hpp:386
void setLocalUri(const FaceUri &uri) noexcept
Definition: transport.hpp:343
void setLinkType(ndn::nfd::LinkType linkType) noexcept
Definition: transport.hpp:361
void setRemoteUri(const FaceUri &uri) noexcept
Definition: transport.hpp:349
void close()
Request the transport to be closed.
Definition: transport.cpp:67
UnicastUdpTransport(boost::asio::ip::udp::socket &&socket, ndn::nfd::FacePersistency persistency, time::nanoseconds idleTimeout)
void afterChangePersistency(ndn::nfd::FacePersistency oldPersistency) final
Invoked after the persistency has been changed.
bool canChangePersistencyToImpl(ndn::nfd::FacePersistency newPersistency) const final
Invoked by canChangePersistencyTo to perform the check.
#define NFD_LOG_FACE_DEBUG(msg)
Log a message at DEBUG level.
#define NFD_LOG_FACE_INFO(msg)
Log a message at INFO level.
#define NFD_LOG_FACE_WARN(msg)
Log a message at WARN level.
#define NFD_LOG_MEMBER_INIT_SPECIALIZED(cls, name)
Definition: logger.hpp:35
ssize_t computeMtu(const Endpoint &localEndpoint)
Computes the maximum payload size in a UDP packet.
ndn::Scheduler & getScheduler()
Returns the global Scheduler instance for the calling thread.
Definition: global.cpp:45