blob: fcb45f6e5a0ab387a1f1015dcf08e9207569a898 [file] [log] [blame]
Ratan Gupta8c834932017-04-14 16:30:24 +05301#pragma once
William A. Kennington III9a20a6e2022-10-05 13:41:12 -07002#include "ipaddress.hpp"
3#include "neighbor.hpp"
Ratan Gupta82549cc2017-04-21 08:45:23 +05304#include "types.hpp"
Ratan Gupta82549cc2017-04-21 08:45:23 +05305#include "xyz/openbmc_project/Network/IP/Create/server.hpp"
William A. Kennington III08505792019-01-30 16:00:04 -08006#include "xyz/openbmc_project/Network/Neighbor/CreateStatic/server.hpp"
Ratan Gupta8c834932017-04-14 16:30:24 +05307
William A. Kennington IIId298f932022-10-17 14:31:38 -07008#include <optional>
Ratan Gupta8c834932017-04-14 16:30:24 +05309#include <sdbusplus/bus.hpp>
10#include <sdbusplus/server/object.hpp>
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -070011#include <stdplus/zstring_view.hpp>
Ratan Gupta8c834932017-04-14 16:30:24 +053012#include <string>
William A. Kennington III95530ec2022-08-19 01:44:39 -070013#include <vector>
Patrick Venture189d44e2018-07-09 12:30:59 -070014#include <xyz/openbmc_project/Collection/DeleteAll/server.hpp>
15#include <xyz/openbmc_project/Network/EthernetInterface/server.hpp>
16#include <xyz/openbmc_project/Network/MACAddress/server.hpp>
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070017#include <xyz/openbmc_project/Network/VLAN/server.hpp>
18#include <xyz/openbmc_project/Object/Delete/server.hpp>
Ratan Gupta8c834932017-04-14 16:30:24 +053019
20namespace phosphor
21{
22namespace network
23{
Ratan Gupta8c834932017-04-14 16:30:24 +053024
Patrick Williamsc38b0712022-07-22 19:26:54 -050025using Ifaces = sdbusplus::server::object_t<
Gunnar Mills57d9c502018-09-14 14:42:34 -050026 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface,
27 sdbusplus::xyz::openbmc_project::Network::server::MACAddress,
28 sdbusplus::xyz::openbmc_project::Network::IP::server::Create,
William A. Kennington III08505792019-01-30 16:00:04 -080029 sdbusplus::xyz::openbmc_project::Network::Neighbor::server::CreateStatic,
Gunnar Mills57d9c502018-09-14 14:42:34 -050030 sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
Ratan Gupta8c834932017-04-14 16:30:24 +053031
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070032using VlanIfaces = sdbusplus::server::object_t<
33 sdbusplus::xyz::openbmc_project::Object::server::Delete,
34 sdbusplus::xyz::openbmc_project::Network::server::VLAN>;
35
36using VlanIntf = sdbusplus::xyz::openbmc_project::Network::server::VLAN;
37
Ratan Gupta82549cc2017-04-21 08:45:23 +053038using IP = sdbusplus::xyz::openbmc_project::Network::server::IP;
Ratan Gupta87c13982017-06-15 09:27:27 +053039
40using EthernetInterfaceIntf =
41 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface;
Ratan Guptabd303b12017-08-18 17:10:07 +053042using MacAddressIntf =
43 sdbusplus::xyz::openbmc_project::Network::server::MACAddress;
Ratan Gupta87c13982017-06-15 09:27:27 +053044
Ratan Gupta497c0c92017-08-22 19:15:59 +053045using ServerList = std::vector<std::string>;
raviteja-bce379562019-03-28 05:59:36 -050046using ObjectPath = sdbusplus::message::object_path;
Ratan Gupta497c0c92017-08-22 19:15:59 +053047
William A. Kennington III9a20a6e2022-10-05 13:41:12 -070048class Manager;
Ratan Gupta8c834932017-04-14 16:30:24 +053049
Ratan Gupta47722dc2017-05-26 18:32:23 +053050class TestEthernetInterface;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070051class TestNetworkManager;
Ratan Gupta5978dd12017-07-25 13:47:13 +053052
William A. Kennington III95530ec2022-08-19 01:44:39 -070053namespace config
54{
55class Parser;
56}
William A. Kennington IIIfd862be2022-10-09 18:40:55 -070057namespace system
William A. Kennington IIId298f932022-10-17 14:31:38 -070058{
William A. Kennington IIIfd862be2022-10-09 18:40:55 -070059struct InterfaceInfo;
William A. Kennington IIId298f932022-10-17 14:31:38 -070060};
61
Ratan Gupta8c834932017-04-14 16:30:24 +053062/** @class EthernetInterface
63 * @brief OpenBMC Ethernet Interface implementation.
64 * @details A concrete implementation for the
65 * xyz.openbmc_project.Network.EthernetInterface DBus API.
66 */
Ratan Gupta82549cc2017-04-21 08:45:23 +053067class EthernetInterface : public Ifaces
Ratan Gupta8c834932017-04-14 16:30:24 +053068{
Gunnar Mills57d9c502018-09-14 14:42:34 -050069 public:
70 EthernetInterface() = delete;
71 EthernetInterface(const EthernetInterface&) = delete;
72 EthernetInterface& operator=(const EthernetInterface&) = delete;
73 EthernetInterface(EthernetInterface&&) = delete;
74 EthernetInterface& operator=(EthernetInterface&&) = delete;
75 virtual ~EthernetInterface() = default;
Ratan Gupta8c834932017-04-14 16:30:24 +053076
Gunnar Mills57d9c502018-09-14 14:42:34 -050077 /** @brief Constructor to put object onto bus at a dbus path.
78 * @param[in] bus - Bus to attach to.
William A. Kennington IIId298f932022-10-17 14:31:38 -070079 * @param[in] manager - parent object.
80 * @param[in] info - Interface information.
81 * @param[in] objRoot - Path to attach at.
William A. Kennington IIIa520a392022-08-08 12:17:34 -070082 * @param[in] config - The parsed configuation file.
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070083 * @param[in] vlan - The id of the vlan if configured
Gunnar Mills57d9c502018-09-14 14:42:34 -050084 * @param[in] emitSignal - true if the object added signal needs to be
85 * send.
William A. Kennington III26275a32021-07-13 20:32:42 -070086 * @param[in] enabled - Override the lookup of nicEnabled
Gunnar Mills57d9c502018-09-14 14:42:34 -050087 */
William A. Kennington IIId298f932022-10-17 14:31:38 -070088 EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
William A. Kennington IIIfd862be2022-10-09 18:40:55 -070089 const system::InterfaceInfo& info,
90 std::string_view objRoot, const config::Parser& config,
91 bool emitSignal = true,
William A. Kennington III26275a32021-07-13 20:32:42 -070092 std::optional<bool> enabled = std::nullopt);
Ratan Gupta82549cc2017-04-21 08:45:23 +053093
William A. Kennington III59e5b912022-11-02 02:49:46 -070094 /** @brief Network Manager object. */
95 Manager& manager;
96
97 /** @brief Persistent map of IPAddress dbus objects and their names */
98 std::unordered_map<IfAddr, std::unique_ptr<IPAddress>> addrs;
99
William A. Kennington III434a9432022-11-04 18:38:46 -0700100 /** @brief Persistent map of Neighbor dbus objects and their names */
101 std::unordered_map<InAddrAny, std::unique_ptr<Neighbor>> staticNeighbors;
102
William A. Kennington IIId6f53402022-11-07 14:48:53 -0800103 void addAddr(const AddressInfo& info);
William A. Kennington IIIbc2502c2022-11-07 16:31:54 -0800104 void addStaticNeigh(const NeighborInfo& info);
William A. Kennington IIId6f53402022-11-07 14:48:53 -0800105
William A. Kennington IIId298f932022-10-17 14:31:38 -0700106 /** @brief Updates the interface information based on new InterfaceInfo */
William A. Kennington IIIfd862be2022-10-09 18:40:55 -0700107 void updateInfo(const system::InterfaceInfo& info);
William A. Kennington IIId298f932022-10-17 14:31:38 -0700108
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600109 /** @brief Function used to load the ntpservers
110 */
111 void loadNTPServers(const config::Parser& config);
112
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530113 /** @brief Function used to load the nameservers.
114 */
William A. Kennington IIIa520a392022-08-08 12:17:34 -0700115 void loadNameServers(const config::Parser& config);
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530116
Patrick Williams6aef7692021-05-01 06:39:41 -0500117 /** @brief Function to create ipAddress dbus object.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500118 * @param[in] addressType - Type of ip address.
Patrick Williams6aef7692021-05-01 06:39:41 -0500119 * @param[in] ipAddress- IP address.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500120 * @param[in] prefixLength - Length of prefix.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500121 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530122
Patrick Williams6aef7692021-05-01 06:39:41 -0500123 ObjectPath ip(IP::Protocol addressType, std::string ipAddress,
William A. Kennington IIIe25f8b42022-10-11 14:43:28 -0700124 uint8_t prefixLength, std::string) override;
Ratan Gupta8c834932017-04-14 16:30:24 +0530125
William A. Kennington III08505792019-01-30 16:00:04 -0800126 /** @brief Function to create static neighbor dbus object.
127 * @param[in] ipAddress - IP address.
128 * @param[in] macAddress - Low level MAC address.
129 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500130 ObjectPath neighbor(std::string ipAddress, std::string macAddress) override;
William A. Kennington III08505792019-01-30 16:00:04 -0800131
Gunnar Mills57d9c502018-09-14 14:42:34 -0500132 /* @brief creates the dbus object(IPaddres) given in the address list.
133 * @param[in] addrs - address list for which dbus objects needs
134 * to create.
135 */
136 void createIPAddressObjects();
Ratan Gupta29b0e432017-05-25 12:51:40 +0530137
William A. Kennington III08505792019-01-30 16:00:04 -0800138 /* @brief creates the dbus object(Neighbor) given in the neighbor list.
139 */
140 void createStaticNeighborObjects();
141
Gunnar Mills57d9c502018-09-14 14:42:34 -0500142 /** Set value of DHCPEnabled */
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700143 DHCPConf dhcpEnabled() const override;
Patrick Williams6aef7692021-05-01 06:39:41 -0500144 DHCPConf dhcpEnabled(DHCPConf value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700145 using EthernetInterfaceIntf::dhcp4;
146 bool dhcp4(bool value) override;
147 using EthernetInterfaceIntf::dhcp6;
148 bool dhcp6(bool value) override;
Ratan Gupta87c13982017-06-15 09:27:27 +0530149
William A. Kennington III59e5b912022-11-02 02:49:46 -0700150 inline bool dhcpIsEnabled(in_addr) const
151 {
152 return dhcp4();
153 }
154 inline bool dhcpIsEnabled(in6_addr) const
155 {
156 return dhcp6();
157 }
158 inline bool dhcpIsEnabled(InAddrAny addr) const
159 {
160 return std::visit([&](auto v) { return dhcpIsEnabled(v); }, addr);
161 }
162
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800163 /** Retrieve Link State */
164 bool linkUp() const override;
165
Tejas Patil2c0fc562021-08-03 19:13:46 +0530166 /** 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 Manteyd0679f92019-10-29 16:20:28 -0700172 /** Set value of NICEnabled */
Patrick Williams6aef7692021-05-01 06:39:41 -0500173 bool nicEnabled(bool value) override;
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700174
Gunnar Mills57d9c502018-09-14 14:42:34 -0500175 /** @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 Williams6aef7692021-05-01 06:39:41 -0500179 std::string macAddress(std::string value) override;
Ratan Guptabd303b12017-08-18 17:10:07 +0530180
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700181 /** @brief check conf file for Router Advertisements
182 *
183 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500184 bool ipv6AcceptRA(bool value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700185 using EthernetInterfaceIntf::ipv6AcceptRA;
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700186
Gunnar Mills57d9c502018-09-14 14:42:34 -0500187 /** @brief sets the NTP servers.
188 * @param[in] value - vector of NTP servers.
189 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500190 ServerList ntpServers(ServerList value) override;
Ratan Gupta497c0c92017-08-22 19:15:59 +0530191
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600192 /** @brief sets the static NTP servers.
193 * @param[in] value - vector of NTP servers.
194 */
195 ServerList staticNTPServers(ServerList value) override;
196
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530197 /** @brief sets the Static DNS/nameservers.
198 * @param[in] value - vector of DNS servers.
199 */
200
201 ServerList staticNameServers(ServerList value) override;
202
Gunnar Mills57d9c502018-09-14 14:42:34 -0500203 /** @brief create Vlan interface.
204 * @param[in] id- VLAN identifier.
205 */
William A. Kennington IIId298f932022-10-17 14:31:38 -0700206 ObjectPath createVLAN(uint16_t id);
Ratan Gupta5978dd12017-07-25 13:47:13 +0530207
Gunnar Mills57d9c502018-09-14 14:42:34 -0500208 /** @brief write the network conf file with the in-memory objects.
209 */
210 void writeConfigurationFile();
Ratan Gupta2b106532017-07-25 16:05:02 +0530211
Gunnar Mills57d9c502018-09-14 14:42:34 -0500212 /** @brief delete all dbus objects.
213 */
214 void deleteAll();
Ratan Guptae9c9b812017-09-22 17:15:37 +0530215
Ravi Tejaa5a09442020-07-17 00:57:33 -0500216 /** @brief set the default v4 gateway of the interface.
217 * @param[in] gateway - default v4 gateway of the interface.
218 */
219 std::string defaultGateway(std::string gateway) override;
220
221 /** @brief set the default v6 gateway of the interface.
222 * @param[in] gateway - default v6 gateway of the interface.
223 */
224 std::string defaultGateway6(std::string gateway) override;
225
Gunnar Mills57d9c502018-09-14 14:42:34 -0500226 using EthernetInterfaceIntf::interfaceName;
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800227 using EthernetInterfaceIntf::linkUp;
Tejas Patil2c0fc562021-08-03 19:13:46 +0530228 using EthernetInterfaceIntf::mtu;
Patrick Williams6aef7692021-05-01 06:39:41 -0500229 using EthernetInterfaceIntf::nicEnabled;
230 using MacAddressIntf::macAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530231
Ravi Tejaa5a09442020-07-17 00:57:33 -0500232 using EthernetInterfaceIntf::defaultGateway;
233 using EthernetInterfaceIntf::defaultGateway6;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530234
Gunnar Mills57d9c502018-09-14 14:42:34 -0500235 protected:
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600236 /** @brief get the NTP server list from the timsyncd dbus obj
Gunnar Mills57d9c502018-09-14 14:42:34 -0500237 *
238 */
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600239 virtual ServerList getNTPServerFromTimeSyncd();
Ratan Gupta497c0c92017-08-22 19:15:59 +0530240
Gunnar Mills57d9c502018-09-14 14:42:34 -0500241 /** @brief get the name server details from the network conf
242 *
243 */
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530244 virtual ServerList getNameServerFromResolvd();
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530245
Gunnar Mills57d9c502018-09-14 14:42:34 -0500246 /** @brief Persistent sdbusplus DBus bus connection. */
Patrick Williamsc38b0712022-07-22 19:26:54 -0500247 sdbusplus::bus_t& bus;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530248
Gunnar Mills57d9c502018-09-14 14:42:34 -0500249 /** @brief Dbus object path */
250 std::string objPath;
Ratan Gupta47722dc2017-05-26 18:32:23 +0530251
William A. Kennington III2e09d272022-10-14 17:15:00 -0700252 /** @brief Interface index */
253 unsigned ifIdx;
254
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700255 struct VlanProperties : VlanIfaces
256 {
257 VlanProperties(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
258 const system::InterfaceInfo& info,
259 EthernetInterface& eth, bool emitSignal = true);
260 void delete_() override;
261 unsigned parentIdx;
262 EthernetInterface& eth;
263 };
264 std::optional<VlanProperties> vlan;
265
Gunnar Mills57d9c502018-09-14 14:42:34 -0500266 friend class TestEthernetInterface;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700267 friend class TestNetworkManager;
Johnathan Mantey817012a2020-01-30 15:07:39 -0800268
269 private:
William A. Kennington IIId298f932022-10-17 14:31:38 -0700270 EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
William A. Kennington IIIfd862be2022-10-09 18:40:55 -0700271 const system::InterfaceInfo& info, std::string&& objPath,
William A. Kennington IIId298f932022-10-17 14:31:38 -0700272 const config::Parser& config, bool emitSignal,
273 std::optional<bool> enabled);
274
Johnathan Mantey817012a2020-01-30 15:07:39 -0800275 /** @brief Determines if the address is manually assigned
276 * @param[in] origin - The origin entry of the IP::Address
277 * @returns true/false value if the address is static
278 */
279 bool originIsManuallyAssigned(IP::AddressOrigin origin);
William A. Kennington III26275a32021-07-13 20:32:42 -0700280
281 /** @brief Determines if the NIC is enabled in systemd
282 * @returns true/false value if the NIC is enabled
283 */
284 bool queryNicEnabled() const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530285};
286
287} // namespace network
288} // namespace phosphor