| /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| /* |
| * Copyright (c) 2014-2017, 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/>. |
| */ |
| |
| #include "ethernet-factory.hpp" |
| #include "generic-link-service.hpp" |
| #include "multicast-ethernet-transport.hpp" |
| #include <boost/range/adaptors.hpp> |
| #include <boost/range/algorithm/copy.hpp> |
| |
| namespace nfd { |
| namespace face { |
| |
| NFD_LOG_INIT("EthernetFactory"); |
| NFD_REGISTER_PROTOCOL_FACTORY(EthernetFactory); |
| |
| const std::string& |
| EthernetFactory::getId() |
| { |
| static std::string id("ether"); |
| return id; |
| } |
| |
| EthernetFactory::EthernetFactory(const CtorParams& params) |
| : ProtocolFactory(params) |
| { |
| } |
| |
| void |
| EthernetFactory::processConfig(OptionalConfigSection configSection, |
| FaceSystem::ConfigContext& context) |
| { |
| // ether |
| // { |
| // listen yes |
| // idle_timeout 600 |
| // mcast yes |
| // mcast_group 01:00:5E:00:17:AA |
| // mcast_ad_hoc no |
| // whitelist |
| // { |
| // * |
| // } |
| // blacklist |
| // { |
| // } |
| // } |
| |
| bool wantListen = true; |
| uint32_t idleTimeout = 600; |
| MulticastConfig mcastConfig; |
| |
| if (configSection) { |
| // face_system.ether.mcast defaults to 'yes' but only if face_system.ether section is present |
| mcastConfig.isEnabled = true; |
| |
| for (const auto& pair : *configSection) { |
| const std::string& key = pair.first; |
| const ConfigSection& value = pair.second; |
| |
| if (key == "listen") { |
| wantListen = ConfigFile::parseYesNo(pair, "face_system.ether"); |
| } |
| else if (key == "idle_timeout") { |
| idleTimeout = ConfigFile::parseNumber<uint32_t>(pair, "face_system.ether"); |
| } |
| else if (key == "mcast") { |
| mcastConfig.isEnabled = ConfigFile::parseYesNo(pair, "face_system.ether"); |
| } |
| else if (key == "mcast_group") { |
| const std::string& valueStr = value.get_value<std::string>(); |
| mcastConfig.group = ethernet::Address::fromString(valueStr); |
| if (mcastConfig.group.isNull()) { |
| BOOST_THROW_EXCEPTION(ConfigFile::Error("face_system.ether.mcast_group: '" + |
| valueStr + "' cannot be parsed as an Ethernet address")); |
| } |
| else if (!mcastConfig.group.isMulticast()) { |
| BOOST_THROW_EXCEPTION(ConfigFile::Error("face_system.ether.mcast_group: '" + |
| valueStr + "' is not a multicast address")); |
| } |
| } |
| else if (key == "mcast_ad_hoc") { |
| bool wantAdHoc = ConfigFile::parseYesNo(pair, "face_system.ether"); |
| mcastConfig.linkType = wantAdHoc ? ndn::nfd::LINK_TYPE_AD_HOC : ndn::nfd::LINK_TYPE_MULTI_ACCESS; |
| } |
| else if (key == "whitelist") { |
| mcastConfig.netifPredicate.parseWhitelist(value); |
| } |
| else if (key == "blacklist") { |
| mcastConfig.netifPredicate.parseBlacklist(value); |
| } |
| else { |
| BOOST_THROW_EXCEPTION(ConfigFile::Error("Unrecognized option face_system.ether." + key)); |
| } |
| } |
| } |
| |
| if (!context.isDryRun) { |
| if (configSection) { |
| providedSchemes.insert("ether"); |
| |
| // determine the interfaces on which channels should be created |
| auto netifs = context.listNetifs() | |
| boost::adaptors::transformed([] (const NetworkInterfaceInfo& nii) { return nii.asNetworkInterface(); }) | |
| boost::adaptors::filtered([] (const shared_ptr<const ndn::net::NetworkInterface>& netif) { |
| return netif->isUp() && !netif->isLoopback(); |
| }); |
| |
| // create channels |
| for (const auto& netif : netifs) { |
| auto channel = this->createChannel(netif, time::seconds(idleTimeout)); |
| if (wantListen && !channel->isListening()) { |
| try { |
| channel->listen(this->addFace, nullptr); |
| } |
| catch (const EthernetChannel::Error& e) { |
| NFD_LOG_WARN("Cannot listen on " << netif->getName() << ": " << e.what()); |
| } |
| } |
| } |
| } |
| else if (!m_channels.empty()) { |
| NFD_LOG_WARN("Cannot disable dev channels after initialization"); |
| } |
| |
| if (m_mcastConfig.isEnabled != mcastConfig.isEnabled) { |
| if (mcastConfig.isEnabled) { |
| NFD_LOG_INFO("enabling multicast on " << mcastConfig.group); |
| } |
| else { |
| NFD_LOG_INFO("disabling multicast"); |
| } |
| } |
| else if (mcastConfig.isEnabled) { |
| if (m_mcastConfig.linkType != mcastConfig.linkType && !m_mcastFaces.empty()) { |
| NFD_LOG_WARN("Cannot change ad hoc setting on existing faces"); |
| } |
| if (m_mcastConfig.group != mcastConfig.group) { |
| NFD_LOG_INFO("changing multicast group from " << m_mcastConfig.group << |
| " to " << mcastConfig.group); |
| } |
| if (m_mcastConfig.netifPredicate != mcastConfig.netifPredicate) { |
| NFD_LOG_INFO("changing whitelist/blacklist"); |
| } |
| } |
| |
| // Even if there's no configuration change, we still need to re-apply configuration because |
| // netifs may have changed. |
| m_mcastConfig = mcastConfig; |
| this->applyConfig(context); |
| } |
| } |
| |
| void |
| EthernetFactory::createFace(const FaceUri& remoteUri, |
| const ndn::optional<FaceUri>& localUri, |
| ndn::nfd::FacePersistency persistency, |
| bool wantLocalFieldsEnabled, |
| const FaceCreatedCallback& onCreated, |
| const FaceCreationFailedCallback& onFailure) |
| { |
| BOOST_ASSERT(remoteUri.isCanonical()); |
| |
| if (!localUri || localUri->getScheme() != "dev") { |
| NFD_LOG_TRACE("Cannot create unicast Ethernet face without dev:// LocalUri"); |
| onFailure(406, "Creation of unicast Ethernet faces requires a LocalUri with dev:// scheme"); |
| return; |
| } |
| BOOST_ASSERT(localUri->isCanonical()); |
| |
| if (persistency == ndn::nfd::FACE_PERSISTENCY_ON_DEMAND) { |
| NFD_LOG_TRACE("createFace does not support FACE_PERSISTENCY_ON_DEMAND"); |
| onFailure(406, "Outgoing Ethernet faces do not support on-demand persistency"); |
| return; |
| } |
| |
| ethernet::Address remoteEndpoint(ethernet::Address::fromString(remoteUri.getHost())); |
| std::string localEndpoint(localUri->getHost()); |
| |
| if (remoteEndpoint.isMulticast()) { |
| NFD_LOG_TRACE("createFace does not support multicast faces"); |
| onFailure(406, "Cannot create multicast Ethernet faces"); |
| return; |
| } |
| |
| if (wantLocalFieldsEnabled) { |
| // Ethernet faces are never local |
| NFD_LOG_TRACE("createFace cannot create non-local face with local fields enabled"); |
| onFailure(406, "Local fields can only be enabled on faces with local scope"); |
| return; |
| } |
| |
| for (const auto& i : m_channels) { |
| if (i.first == localEndpoint) { |
| i.second->connect(remoteEndpoint, persistency, onCreated, onFailure); |
| return; |
| } |
| } |
| |
| NFD_LOG_TRACE("No channels available to connect to " << remoteEndpoint); |
| onFailure(504, "No channels available to connect"); |
| } |
| |
| shared_ptr<EthernetChannel> |
| EthernetFactory::createChannel(const shared_ptr<const ndn::net::NetworkInterface>& localEndpoint, |
| time::nanoseconds idleTimeout) |
| { |
| auto it = m_channels.find(localEndpoint->getName()); |
| if (it != m_channels.end()) |
| return it->second; |
| |
| auto channel = std::make_shared<EthernetChannel>(localEndpoint, idleTimeout); |
| m_channels[localEndpoint->getName()] = channel; |
| |
| return channel; |
| } |
| |
| std::vector<shared_ptr<const Channel>> |
| EthernetFactory::getChannels() const |
| { |
| return getChannelsFromMap(m_channels); |
| } |
| |
| shared_ptr<Face> |
| EthernetFactory::createMulticastFace(const ndn::net::NetworkInterface& netif, |
| const ethernet::Address& address) |
| { |
| BOOST_ASSERT(address.isMulticast()); |
| |
| auto key = std::make_pair(netif.getName(), address); |
| auto found = m_mcastFaces.find(key); |
| if (found != m_mcastFaces.end()) { |
| return found->second; |
| } |
| |
| GenericLinkService::Options opts; |
| opts.allowFragmentation = true; |
| opts.allowReassembly = true; |
| |
| auto linkService = make_unique<GenericLinkService>(opts); |
| auto transport = make_unique<MulticastEthernetTransport>(netif, address, m_mcastConfig.linkType); |
| auto face = make_shared<Face>(std::move(linkService), std::move(transport)); |
| |
| m_mcastFaces[key] = face; |
| connectFaceClosedSignal(*face, [this, key] { m_mcastFaces.erase(key); }); |
| |
| return face; |
| } |
| |
| void |
| EthernetFactory::applyConfig(const FaceSystem::ConfigContext& context) |
| { |
| // collect old faces |
| std::set<shared_ptr<Face>> oldFaces; |
| boost::copy(m_mcastFaces | boost::adaptors::map_values, |
| std::inserter(oldFaces, oldFaces.end())); |
| |
| if (m_mcastConfig.isEnabled) { |
| // determine interfaces on which faces should be created or retained |
| auto capableNetifs = context.listNetifs() | |
| boost::adaptors::transformed([] (const NetworkInterfaceInfo& nii) { return nii.asNetworkInterface(); }) | |
| boost::adaptors::filtered([this] (const shared_ptr<const ndn::net::NetworkInterface>& netif) { |
| return netif->isUp() && netif->canMulticast() && m_mcastConfig.netifPredicate(*netif); |
| }); |
| |
| // create faces |
| for (const auto& netif : capableNetifs) { |
| shared_ptr<Face> face; |
| try { |
| face = this->createMulticastFace(*netif, m_mcastConfig.group); |
| } |
| catch (const EthernetTransport::Error& e) { |
| NFD_LOG_WARN("Cannot create Ethernet multicast face on " << netif->getName() << ": " << e.what()); |
| continue; |
| } |
| |
| if (face->getId() == face::INVALID_FACEID) { |
| // new face: register with forwarding |
| this->addFace(face); |
| } |
| else { |
| // existing face: don't destroy |
| oldFaces.erase(face); |
| } |
| } |
| } |
| |
| // destroy old faces that are not needed in new configuration |
| for (const auto& face : oldFaces) { |
| face->close(); |
| } |
| } |
| |
| } // namespace face |
| } // namespace nfd |