Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 1 | #pragma once |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 2 | #include "ipaddress.hpp" |
| 3 | #include "neighbor.hpp" |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 4 | #include "types.hpp" |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 5 | #include "xyz/openbmc_project/Network/IP/Create/server.hpp" |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 6 | #include "xyz/openbmc_project/Network/Neighbor/CreateStatic/server.hpp" |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 7 | |
| 8 | #include <sdbusplus/bus.hpp> |
| 9 | #include <sdbusplus/server/object.hpp> |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 10 | #include <string> |
William A. Kennington III | 95530ec | 2022-08-19 01:44:39 -0700 | [diff] [blame] | 11 | #include <vector> |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 12 | #include <xyz/openbmc_project/Collection/DeleteAll/server.hpp> |
| 13 | #include <xyz/openbmc_project/Network/EthernetInterface/server.hpp> |
| 14 | #include <xyz/openbmc_project/Network/MACAddress/server.hpp> |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 15 | |
| 16 | namespace phosphor |
| 17 | { |
| 18 | namespace network |
| 19 | { |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 20 | |
Patrick Williams | c38b071 | 2022-07-22 19:26:54 -0500 | [diff] [blame] | 21 | using Ifaces = sdbusplus::server::object_t< |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 22 | sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface, |
| 23 | sdbusplus::xyz::openbmc_project::Network::server::MACAddress, |
| 24 | sdbusplus::xyz::openbmc_project::Network::IP::server::Create, |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 25 | sdbusplus::xyz::openbmc_project::Network::Neighbor::server::CreateStatic, |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 26 | sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 27 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 28 | using IP = sdbusplus::xyz::openbmc_project::Network::server::IP; |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 29 | |
| 30 | using EthernetInterfaceIntf = |
| 31 | sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface; |
Ratan Gupta | bd303b1 | 2017-08-18 17:10:07 +0530 | [diff] [blame] | 32 | using MacAddressIntf = |
| 33 | sdbusplus::xyz::openbmc_project::Network::server::MACAddress; |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 34 | |
Ratan Gupta | 497c0c9 | 2017-08-22 19:15:59 +0530 | [diff] [blame] | 35 | using ServerList = std::vector<std::string>; |
raviteja-b | ce37956 | 2019-03-28 05:59:36 -0500 | [diff] [blame] | 36 | using ObjectPath = sdbusplus::message::object_path; |
Ratan Gupta | 497c0c9 | 2017-08-22 19:15:59 +0530 | [diff] [blame] | 37 | |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 38 | class Manager; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 39 | |
Ratan Gupta | 47722dc | 2017-05-26 18:32:23 +0530 | [diff] [blame] | 40 | class TestEthernetInterface; |
| 41 | |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 42 | class VlanInterface; |
| 43 | |
William A. Kennington III | 95530ec | 2022-08-19 01:44:39 -0700 | [diff] [blame] | 44 | namespace config |
| 45 | { |
| 46 | class Parser; |
| 47 | } |
| 48 | |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 49 | using LinkSpeed = uint16_t; |
| 50 | using DuplexMode = uint8_t; |
| 51 | using Autoneg = uint8_t; |
Johnathan Mantey | faa72e5 | 2020-01-08 10:38:58 -0800 | [diff] [blame] | 52 | using LinkUp = bool; |
Johnathan Mantey | d0679f9 | 2019-10-29 16:20:28 -0700 | [diff] [blame] | 53 | using NICEnabled = bool; |
Tejas Patil | 2c0fc56 | 2021-08-03 19:13:46 +0530 | [diff] [blame] | 54 | using MTU = size_t; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 55 | using VlanId = uint32_t; |
| 56 | using InterfaceName = std::string; |
Johnathan Mantey | d0679f9 | 2019-10-29 16:20:28 -0700 | [diff] [blame] | 57 | using InterfaceInfo = |
Tejas Patil | 2c0fc56 | 2021-08-03 19:13:46 +0530 | [diff] [blame] | 58 | std::tuple<LinkSpeed, DuplexMode, Autoneg, LinkUp, NICEnabled, MTU>; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 59 | |
| 60 | /** @class EthernetInterface |
| 61 | * @brief OpenBMC Ethernet Interface implementation. |
| 62 | * @details A concrete implementation for the |
| 63 | * xyz.openbmc_project.Network.EthernetInterface DBus API. |
| 64 | */ |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 65 | class EthernetInterface : public Ifaces |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 66 | { |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 67 | public: |
| 68 | EthernetInterface() = delete; |
| 69 | EthernetInterface(const EthernetInterface&) = delete; |
| 70 | EthernetInterface& operator=(const EthernetInterface&) = delete; |
| 71 | EthernetInterface(EthernetInterface&&) = delete; |
| 72 | EthernetInterface& operator=(EthernetInterface&&) = delete; |
| 73 | virtual ~EthernetInterface() = default; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 74 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 75 | /** @brief Constructor to put object onto bus at a dbus path. |
| 76 | * @param[in] bus - Bus to attach to. |
| 77 | * @param[in] objPath - Path to attach at. |
William A. Kennington III | a520a39 | 2022-08-08 12:17:34 -0700 | [diff] [blame] | 78 | * @param[in] config - The parsed configuation file. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 79 | * @param[in] parent - parent object. |
| 80 | * @param[in] emitSignal - true if the object added signal needs to be |
| 81 | * send. |
William A. Kennington III | 26275a3 | 2021-07-13 20:32:42 -0700 | [diff] [blame] | 82 | * @param[in] enabled - Override the lookup of nicEnabled |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 83 | */ |
Patrick Williams | c38b071 | 2022-07-22 19:26:54 -0500 | [diff] [blame] | 84 | EthernetInterface(sdbusplus::bus_t& bus, const std::string& objPath, |
William A. Kennington III | 0caf221 | 2022-08-18 18:15:51 -0700 | [diff] [blame] | 85 | const config::Parser& config, Manager& parent, |
| 86 | bool emitSignal = true, |
William A. Kennington III | 26275a3 | 2021-07-13 20:32:42 -0700 | [diff] [blame] | 87 | std::optional<bool> enabled = std::nullopt); |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 88 | |
Manojkiran Eda | acd6dd5 | 2019-10-15 15:00:51 +0530 | [diff] [blame] | 89 | /** @brief Function used to load the nameservers. |
| 90 | */ |
William A. Kennington III | a520a39 | 2022-08-08 12:17:34 -0700 | [diff] [blame] | 91 | void loadNameServers(const config::Parser& config); |
Manojkiran Eda | acd6dd5 | 2019-10-15 15:00:51 +0530 | [diff] [blame] | 92 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 93 | /** @brief Function to create ipAddress dbus object. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 94 | * @param[in] addressType - Type of ip address. |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 95 | * @param[in] ipAddress- IP address. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 96 | * @param[in] prefixLength - Length of prefix. |
| 97 | * @param[in] gateway - Gateway ip address. |
| 98 | */ |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 99 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 100 | ObjectPath ip(IP::Protocol addressType, std::string ipAddress, |
raviteja-b | ce37956 | 2019-03-28 05:59:36 -0500 | [diff] [blame] | 101 | uint8_t prefixLength, std::string gateway) override; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 102 | |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 103 | /** @brief Function to create static neighbor dbus object. |
| 104 | * @param[in] ipAddress - IP address. |
| 105 | * @param[in] macAddress - Low level MAC address. |
| 106 | */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 107 | ObjectPath neighbor(std::string ipAddress, std::string macAddress) override; |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 108 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 109 | /* @brief delete the dbus object of the given ipAddress. |
| 110 | * @param[in] ipAddress - IP address. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 111 | */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 112 | void deleteObject(const std::string& ipAddress); |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 113 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 114 | /* @brief delete the dbus object of the given ipAddress. |
| 115 | * @param[in] ipAddress - IP address. |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 116 | */ |
| 117 | void deleteStaticNeighborObject(const std::string& ipAddress); |
| 118 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 119 | /* @brief delete the vlan dbus object of the given interface. |
| 120 | * Also deletes the device file and the network file. |
| 121 | * @param[in] interface - VLAN Interface. |
| 122 | */ |
| 123 | void deleteVLANObject(const std::string& interface); |
Ratan Gupta | bc88629 | 2017-07-25 18:29:57 +0530 | [diff] [blame] | 124 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 125 | /* @brief creates the dbus object(IPaddres) given in the address list. |
| 126 | * @param[in] addrs - address list for which dbus objects needs |
| 127 | * to create. |
| 128 | */ |
| 129 | void createIPAddressObjects(); |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 130 | |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 131 | /* @brief creates the dbus object(Neighbor) given in the neighbor list. |
| 132 | */ |
| 133 | void createStaticNeighborObjects(); |
| 134 | |
William A. Kennington III | d7946a7 | 2019-04-19 14:24:09 -0700 | [diff] [blame] | 135 | /* @brief Gets the index of the interface on the system |
| 136 | */ |
| 137 | unsigned ifIndex() const; |
| 138 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 139 | /* @brief Gets all the ip addresses. |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 140 | * @returns the list of ipAddress. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 141 | */ |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 142 | inline const auto& getAddresses() const |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 143 | { |
| 144 | return addrs; |
| 145 | } |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 146 | |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 147 | /* @brief Gets all the static neighbor entries. |
| 148 | * @returns Static neighbor map. |
| 149 | */ |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 150 | inline const auto& getStaticNeighbors() const |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 151 | { |
| 152 | return staticNeighbors; |
| 153 | } |
| 154 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 155 | /** Set value of DHCPEnabled */ |
William A. Kennington III | 8060c0d | 2022-08-18 19:19:34 -0700 | [diff] [blame] | 156 | DHCPConf dhcpEnabled() const override; |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 157 | DHCPConf dhcpEnabled(DHCPConf value) override; |
William A. Kennington III | 8060c0d | 2022-08-18 19:19:34 -0700 | [diff] [blame] | 158 | using EthernetInterfaceIntf::dhcp4; |
| 159 | bool dhcp4(bool value) override; |
| 160 | using EthernetInterfaceIntf::dhcp6; |
| 161 | bool dhcp6(bool value) override; |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 162 | |
Johnathan Mantey | faa72e5 | 2020-01-08 10:38:58 -0800 | [diff] [blame] | 163 | /** Retrieve Link State */ |
| 164 | bool linkUp() const override; |
| 165 | |
Tejas Patil | 2c0fc56 | 2021-08-03 19:13:46 +0530 | [diff] [blame] | 166 | /** Retrieve MTU Size */ |
| 167 | size_t mtu() const override; |
| 168 | |
| 169 | /** Set size of MTU */ |
| 170 | size_t mtu(size_t value) override; |
| 171 | |
Johnathan Mantey | d0679f9 | 2019-10-29 16:20:28 -0700 | [diff] [blame] | 172 | /** Set value of NICEnabled */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 173 | bool nicEnabled(bool value) override; |
Johnathan Mantey | d0679f9 | 2019-10-29 16:20:28 -0700 | [diff] [blame] | 174 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 175 | /** @brief sets the MAC address. |
| 176 | * @param[in] value - MAC address which needs to be set on the system. |
| 177 | * @returns macAddress of the interface or throws an error. |
| 178 | */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 179 | std::string macAddress(std::string value) override; |
Ratan Gupta | bd303b1 | 2017-08-18 17:10:07 +0530 | [diff] [blame] | 180 | |
Johnathan Mantey | 5b023f5 | 2019-06-24 16:06:37 -0700 | [diff] [blame] | 181 | /** @brief check conf file for Router Advertisements |
| 182 | * |
| 183 | */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 184 | bool ipv6AcceptRA(bool value) override; |
William A. Kennington III | 8060c0d | 2022-08-18 19:19:34 -0700 | [diff] [blame] | 185 | using EthernetInterfaceIntf::ipv6AcceptRA; |
Johnathan Mantey | 5b023f5 | 2019-06-24 16:06:37 -0700 | [diff] [blame] | 186 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 187 | /** @brief sets the NTP servers. |
| 188 | * @param[in] value - vector of NTP servers. |
| 189 | */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 190 | ServerList ntpServers(ServerList value) override; |
Ratan Gupta | 497c0c9 | 2017-08-22 19:15:59 +0530 | [diff] [blame] | 191 | |
Manojkiran Eda | acd6dd5 | 2019-10-15 15:00:51 +0530 | [diff] [blame] | 192 | /** @brief sets the Static DNS/nameservers. |
| 193 | * @param[in] value - vector of DNS servers. |
| 194 | */ |
| 195 | |
| 196 | ServerList staticNameServers(ServerList value) override; |
| 197 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 198 | /** @brief create Vlan interface. |
| 199 | * @param[in] id- VLAN identifier. |
| 200 | */ |
William A. Kennington III | f4b4ff8 | 2019-04-09 19:06:52 -0700 | [diff] [blame] | 201 | ObjectPath createVLAN(VlanId id); |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 202 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 203 | /** @brief load the vlan info from the system |
| 204 | * and creates the ip address dbus objects. |
| 205 | * @param[in] vlanID- VLAN identifier. |
| 206 | */ |
| 207 | void loadVLAN(VlanId vlanID); |
Ratan Gupta | 92bc2fe | 2017-07-26 22:40:21 +0530 | [diff] [blame] | 208 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 209 | /** @brief write the network conf file with the in-memory objects. |
| 210 | */ |
| 211 | void writeConfigurationFile(); |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 212 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 213 | /** @brief delete all dbus objects. |
| 214 | */ |
| 215 | void deleteAll(); |
Ratan Gupta | e9c9b81 | 2017-09-22 17:15:37 +0530 | [diff] [blame] | 216 | |
Ravi Teja | a5a0944 | 2020-07-17 00:57:33 -0500 | [diff] [blame] | 217 | /** @brief set the default v4 gateway of the interface. |
| 218 | * @param[in] gateway - default v4 gateway of the interface. |
| 219 | */ |
| 220 | std::string defaultGateway(std::string gateway) override; |
| 221 | |
| 222 | /** @brief set the default v6 gateway of the interface. |
| 223 | * @param[in] gateway - default v6 gateway of the interface. |
| 224 | */ |
| 225 | std::string defaultGateway6(std::string gateway) override; |
| 226 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 227 | using EthernetInterfaceIntf::interfaceName; |
Johnathan Mantey | faa72e5 | 2020-01-08 10:38:58 -0800 | [diff] [blame] | 228 | using EthernetInterfaceIntf::linkUp; |
Tejas Patil | 2c0fc56 | 2021-08-03 19:13:46 +0530 | [diff] [blame] | 229 | using EthernetInterfaceIntf::mtu; |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 230 | using EthernetInterfaceIntf::nicEnabled; |
| 231 | using MacAddressIntf::macAddress; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 232 | |
Ravi Teja | a5a0944 | 2020-07-17 00:57:33 -0500 | [diff] [blame] | 233 | using EthernetInterfaceIntf::defaultGateway; |
| 234 | using EthernetInterfaceIntf::defaultGateway6; |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 235 | /** @brief Absolute path of the resolv conf file */ |
| 236 | static constexpr auto resolvConfFile = "/etc/resolv.conf"; |
Ratan Gupta | 6dec390 | 2017-08-20 15:28:12 +0530 | [diff] [blame] | 237 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 238 | protected: |
| 239 | /** @brief get the info of the ethernet interface. |
| 240 | * @return tuple having the link speed,autonegotiation,duplexmode . |
| 241 | */ |
| 242 | InterfaceInfo getInterfaceInfo() const; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 243 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 244 | /* @brief delete the vlan interface from system. |
| 245 | * @param[in] interface - vlan Interface. |
| 246 | */ |
| 247 | void deleteVLANFromSystem(const std::string& interface); |
Ratan Gupta | e9c9b81 | 2017-09-22 17:15:37 +0530 | [diff] [blame] | 248 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 249 | /** @brief get the mac address of the interface. |
| 250 | * @param[in] interfaceName - Network interface name. |
| 251 | * @return macaddress on success |
| 252 | */ |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 253 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 254 | std::string getMACAddress(const std::string& interfaceName) const; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 255 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 256 | /** @brief construct the ip address dbus object path. |
| 257 | * @param[in] addressType - Type of ip address. |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 258 | * @param[in] ipAddress - IP address. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 259 | * @param[in] prefixLength - Length of prefix. |
| 260 | * @param[in] gateway - Gateway address. |
Lei YU | 3402757 | 2021-08-11 15:23:52 +0800 | [diff] [blame] | 261 | * @param[in] origin - The origin entry of the IP::Address |
Ratan Gupta | 65e5abe | 2017-05-23 13:20:44 +0530 | [diff] [blame] | 262 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 263 | * @return path of the address object. |
| 264 | */ |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 265 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 266 | std::string generateObjectPath(IP::Protocol addressType, |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 267 | const std::string& ipAddress, |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 268 | uint8_t prefixLength, |
Lei YU | 3402757 | 2021-08-11 15:23:52 +0800 | [diff] [blame] | 269 | const std::string& gateway, |
| 270 | IP::AddressOrigin origin) const; |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 271 | |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 272 | std::string |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 273 | generateStaticNeighborObjectPath(const std::string& ipAddress, |
| 274 | const std::string& macAddress) const; |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 275 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 276 | /** @brief generates the id by doing hash of ipAddress, |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 277 | * prefixlength and the gateway. |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 278 | * @param[in] ipAddress - IP address. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 279 | * @param[in] prefixLength - Length of prefix. |
| 280 | * @param[in] gateway - Gateway address. |
Lei YU | 3402757 | 2021-08-11 15:23:52 +0800 | [diff] [blame] | 281 | * @param[in] origin - The string of the address origin |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 282 | * @return hash string. |
| 283 | */ |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 284 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 285 | static std::string generateId(const std::string& ipAddress, |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 286 | uint8_t prefixLength, |
Lei YU | 3402757 | 2021-08-11 15:23:52 +0800 | [diff] [blame] | 287 | const std::string& gateway, |
| 288 | const std::string& origin); |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 289 | |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 290 | /** @brief generates the id by doing hash of ipAddress |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 291 | * and the mac address. |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 292 | * @param[in] ipAddress - IP address. |
| 293 | * @param[in] macAddress - Gateway address. |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 294 | * @return hash string. |
| 295 | */ |
Patrick Williams | 6aef769 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 296 | static std::string generateNeighborId(const std::string& ipAddress, |
| 297 | const std::string& macAddress); |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 298 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 299 | /** @brief get the NTP server list from the network conf |
| 300 | * |
| 301 | */ |
| 302 | ServerList getNTPServersFromConf(); |
Ratan Gupta | 497c0c9 | 2017-08-22 19:15:59 +0530 | [diff] [blame] | 303 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 304 | /** @brief get the name server details from the network conf |
| 305 | * |
| 306 | */ |
Manojkiran Eda | acd6dd5 | 2019-10-15 15:00:51 +0530 | [diff] [blame] | 307 | virtual ServerList getNameServerFromResolvd(); |
Ratan Gupta | 6dec390 | 2017-08-20 15:28:12 +0530 | [diff] [blame] | 308 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 309 | /** @brief Persistent sdbusplus DBus bus connection. */ |
Patrick Williams | c38b071 | 2022-07-22 19:26:54 -0500 | [diff] [blame] | 310 | sdbusplus::bus_t& bus; |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 311 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 312 | /** @brief Network Manager object. */ |
| 313 | Manager& manager; |
Ratan Gupta | 4f1c18b | 2017-05-25 12:59:35 +0530 | [diff] [blame] | 314 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 315 | /** @brief Persistent map of IPAddress dbus objects and their names */ |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 316 | string_umap<std::unique_ptr<IPAddress>> addrs; |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 317 | |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 318 | /** @brief Persistent map of Neighbor dbus objects and their names */ |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 319 | string_umap<std::unique_ptr<Neighbor>> staticNeighbors; |
William A. Kennington III | 0850579 | 2019-01-30 16:00:04 -0800 | [diff] [blame] | 320 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 321 | /** @brief Persistent map of VLAN interface dbus objects and their names */ |
William A. Kennington III | 9a20a6e | 2022-10-05 13:41:12 -0700 | [diff] [blame] | 322 | string_umap<std::unique_ptr<VlanInterface>> vlanInterfaces; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 323 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 324 | /** @brief Dbus object path */ |
| 325 | std::string objPath; |
Ratan Gupta | 47722dc | 2017-05-26 18:32:23 +0530 | [diff] [blame] | 326 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 327 | friend class TestEthernetInterface; |
Johnathan Mantey | 817012a | 2020-01-30 15:07:39 -0800 | [diff] [blame] | 328 | |
| 329 | private: |
| 330 | /** @brief Determines if DHCP is active for the IP::Protocol supplied. |
| 331 | * @param[in] protocol - Either IPv4 or IPv6 |
Johnathan Mantey | 817012a | 2020-01-30 15:07:39 -0800 | [diff] [blame] | 332 | * @returns true/false value if DHCP is active for the input protocol |
| 333 | */ |
William A. Kennington III | 24957b9 | 2021-12-03 13:59:19 -0800 | [diff] [blame] | 334 | bool dhcpIsEnabled(IP::Protocol protocol); |
Johnathan Mantey | 817012a | 2020-01-30 15:07:39 -0800 | [diff] [blame] | 335 | |
Johnathan Mantey | 817012a | 2020-01-30 15:07:39 -0800 | [diff] [blame] | 336 | /** @brief Determines if the address is manually assigned |
| 337 | * @param[in] origin - The origin entry of the IP::Address |
| 338 | * @returns true/false value if the address is static |
| 339 | */ |
| 340 | bool originIsManuallyAssigned(IP::AddressOrigin origin); |
William A. Kennington III | 26275a3 | 2021-07-13 20:32:42 -0700 | [diff] [blame] | 341 | |
| 342 | /** @brief Determines if the NIC is enabled in systemd |
| 343 | * @returns true/false value if the NIC is enabled |
| 344 | */ |
| 345 | bool queryNicEnabled() const; |
William A. Kennington III | a520a39 | 2022-08-08 12:17:34 -0700 | [diff] [blame] | 346 | |
| 347 | std::string vlanIntfName(VlanId id) const; |
| 348 | std::string vlanObjPath(VlanId id) const; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 349 | }; |
| 350 | |
| 351 | } // namespace network |
| 352 | } // namespace phosphor |