Netlink.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2016 Sky UK
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
 * File:   Netlink.h
 *
 */
#ifndef NETLINK_H
#define NETLINK_H
 
#include <DobbyRdkPluginUtils.h>
 
#include <string>
#include <mutex>
#include <memory>
#include <array>
#include <list>
 
#include <arpa/inet.h>
 
struct nl_sock;
 
class NlLink;
 
 
// -----------------------------------------------------------------------------
class Netlink
{
public:
    Netlink();
    ~Netlink();
 
public:
    bool isValid() const;
 
public:
    bool ifaceUp(const std::string& ifaceName);
    bool ifaceDown(const std::string& ifaceName);
 
    bool ifaceIsUp(const std::string& ifaceName) const;
    bool ifaceExists(const std::string& ifaceName) const;
 
    bool setIfaceAddress(const std::string& ifaceName,
                         const in_addr_t address, const in_addr_t netmask);
    bool setIfaceAddress(const std::string& ifaceName,
                         const struct in6_addr address, const int netmask);
 
    bool setIfaceForwarding(const std::string& ifaceName, bool enable);
    bool setIfaceForwarding6(const std::shared_ptr<DobbyRdkPluginUtils> &utils,
                             const std::string& ifaceName, bool enable);
 
    bool setIfaceRouteLocalNet(const std::string& ifaceName, bool enable);
 
    bool setIfaceAcceptRa(const std::shared_ptr<DobbyRdkPluginUtils> &utils,
                          const std::string& ifaceName, int value);
 
    bool setIfaceMAC(const std::string& ifaceName,
                     const std::array<uint8_t, 6>& address);
    std::array<uint8_t, 6> getIfaceMAC(const std::string& ifaceName);
 
    struct BridgePortDetails
    {
        int index;
        char name[16];
        uint8_t mac[6];
    };
 
    std::list<BridgePortDetails> getAttachedIfaces(const std::string& bridgeName);
 
public:
    bool createBridge(const std::string& bridgeName);
    bool destroyBridge(const std::string& bridgeName);
 
    bool addIfaceToBridge(const std::string& bridgeName,
                          const std::string& ifaceName);
    bool delIfaceFromBridge(const std::string& bridgeName,
                            const std::string& ifaceName);
 
public:
    std::string createVeth(const std::string& peerVethName,
                           pid_t peerPid,
                           std::vector<std::string> &takenVeths);
    bool checkVeth(const std::string& vethName);
 
public:
    bool addRoute(const std::string& iface, const in_addr_t destination,
                  const in_addr_t netmask, const in_addr_t gateway);
    bool addRoute(const std::string& iface, const struct in6_addr destination,
                  const int netmask, const struct in6_addr gateway);
 
    bool addArpEntry(const std::string &iface, in_addr_t address,
                     const std::array<uint8_t, 6> &mac);
 
    bool delArpEntry(const std::string &iface, in_addr_t address);
 
private:
    bool applyChangesToLink(const std::string& ifaceName,
                            const NlLink& changes);
 
    bool setLinkAddress(const NlLink& link,
                        const in_addr_t address, const in_addr_t netmask);
    bool setLinkAddress(const NlLink& link,
                        const struct in6_addr address, const int netmask);
 
    bool setIfaceConfig(const std::string& ifaceName, const unsigned int configId,
                        const uint32_t value);
 
 
    std::string getAvailableVethName(const int startIndex) const;
 
private:
    struct nl_sock* mSocket;
    int mSysClassNetDirFd;
    mutable std::mutex mLock;
};
 
 
#endif // !defined(NETLINK_H)