blob: ee83fe25fae1024e8ffc98037b42928216da49cb [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 IIId298f932022-10-17 14:31:38 -070057
Ratan Gupta8c834932017-04-14 16:30:24 +053058/** @class EthernetInterface
59 * @brief OpenBMC Ethernet Interface implementation.
60 * @details A concrete implementation for the
61 * xyz.openbmc_project.Network.EthernetInterface DBus API.
62 */
Ratan Gupta82549cc2017-04-21 08:45:23 +053063class EthernetInterface : public Ifaces
Ratan Gupta8c834932017-04-14 16:30:24 +053064{
Gunnar Mills57d9c502018-09-14 14:42:34 -050065 public:
66 EthernetInterface() = delete;
67 EthernetInterface(const EthernetInterface&) = delete;
68 EthernetInterface& operator=(const EthernetInterface&) = delete;
69 EthernetInterface(EthernetInterface&&) = delete;
70 EthernetInterface& operator=(EthernetInterface&&) = delete;
71 virtual ~EthernetInterface() = default;
Ratan Gupta8c834932017-04-14 16:30:24 +053072
Gunnar Mills57d9c502018-09-14 14:42:34 -050073 /** @brief Constructor to put object onto bus at a dbus path.
74 * @param[in] bus - Bus to attach to.
William A. Kennington IIId298f932022-10-17 14:31:38 -070075 * @param[in] manager - parent object.
76 * @param[in] info - Interface information.
77 * @param[in] objRoot - Path to attach at.
William A. Kennington IIIa520a392022-08-08 12:17:34 -070078 * @param[in] config - The parsed configuation file.
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070079 * @param[in] vlan - The id of the vlan if configured
Gunnar Mills57d9c502018-09-14 14:42:34 -050080 * @param[in] emitSignal - true if the object added signal needs to be
81 * send.
William A. Kennington III26275a32021-07-13 20:32:42 -070082 * @param[in] enabled - Override the lookup of nicEnabled
Gunnar Mills57d9c502018-09-14 14:42:34 -050083 */
William A. Kennington IIId298f932022-10-17 14:31:38 -070084 EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
William A. Kennington III454a0de2022-11-12 01:01:04 -080085 const InterfaceInfo& info, std::string_view objRoot,
86 const config::Parser& config, bool emitSignal = true,
William A. Kennington III26275a32021-07-13 20:32:42 -070087 std::optional<bool> enabled = std::nullopt);
Ratan Gupta82549cc2017-04-21 08:45:23 +053088
William A. Kennington III59e5b912022-11-02 02:49:46 -070089 /** @brief Network Manager object. */
90 Manager& manager;
91
92 /** @brief Persistent map of IPAddress dbus objects and their names */
93 std::unordered_map<IfAddr, std::unique_ptr<IPAddress>> addrs;
94
William A. Kennington III434a9432022-11-04 18:38:46 -070095 /** @brief Persistent map of Neighbor dbus objects and their names */
96 std::unordered_map<InAddrAny, std::unique_ptr<Neighbor>> staticNeighbors;
97
William A. Kennington IIId6f53402022-11-07 14:48:53 -080098 void addAddr(const AddressInfo& info);
William A. Kennington IIIbc2502c2022-11-07 16:31:54 -080099 void addStaticNeigh(const NeighborInfo& info);
William A. Kennington IIId6f53402022-11-07 14:48:53 -0800100
William A. Kennington IIId298f932022-10-17 14:31:38 -0700101 /** @brief Updates the interface information based on new InterfaceInfo */
William A. Kennington III454a0de2022-11-12 01:01:04 -0800102 void updateInfo(const InterfaceInfo& info);
William A. Kennington IIId298f932022-10-17 14:31:38 -0700103
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600104 /** @brief Function used to load the ntpservers
105 */
106 void loadNTPServers(const config::Parser& config);
107
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530108 /** @brief Function used to load the nameservers.
109 */
William A. Kennington IIIa520a392022-08-08 12:17:34 -0700110 void loadNameServers(const config::Parser& config);
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530111
Patrick Williams6aef7692021-05-01 06:39:41 -0500112 /** @brief Function to create ipAddress dbus object.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500113 * @param[in] addressType - Type of ip address.
Patrick Williams6aef7692021-05-01 06:39:41 -0500114 * @param[in] ipAddress- IP address.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500115 * @param[in] prefixLength - Length of prefix.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500116 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530117
Patrick Williams6aef7692021-05-01 06:39:41 -0500118 ObjectPath ip(IP::Protocol addressType, std::string ipAddress,
William A. Kennington IIIe25f8b42022-10-11 14:43:28 -0700119 uint8_t prefixLength, std::string) override;
Ratan Gupta8c834932017-04-14 16:30:24 +0530120
William A. Kennington III08505792019-01-30 16:00:04 -0800121 /** @brief Function to create static neighbor dbus object.
122 * @param[in] ipAddress - IP address.
123 * @param[in] macAddress - Low level MAC address.
124 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500125 ObjectPath neighbor(std::string ipAddress, std::string macAddress) override;
William A. Kennington III08505792019-01-30 16:00:04 -0800126
Gunnar Mills57d9c502018-09-14 14:42:34 -0500127 /* @brief creates the dbus object(IPaddres) given in the address list.
128 * @param[in] addrs - address list for which dbus objects needs
129 * to create.
130 */
131 void createIPAddressObjects();
Ratan Gupta29b0e432017-05-25 12:51:40 +0530132
William A. Kennington III08505792019-01-30 16:00:04 -0800133 /* @brief creates the dbus object(Neighbor) given in the neighbor list.
134 */
135 void createStaticNeighborObjects();
136
Gunnar Mills57d9c502018-09-14 14:42:34 -0500137 /** Set value of DHCPEnabled */
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700138 DHCPConf dhcpEnabled() const override;
Patrick Williams6aef7692021-05-01 06:39:41 -0500139 DHCPConf dhcpEnabled(DHCPConf value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700140 using EthernetInterfaceIntf::dhcp4;
141 bool dhcp4(bool value) override;
142 using EthernetInterfaceIntf::dhcp6;
143 bool dhcp6(bool value) override;
Ratan Gupta87c13982017-06-15 09:27:27 +0530144
William A. Kennington III59e5b912022-11-02 02:49:46 -0700145 inline bool dhcpIsEnabled(in_addr) const
146 {
147 return dhcp4();
148 }
149 inline bool dhcpIsEnabled(in6_addr) const
150 {
151 return dhcp6();
152 }
153 inline bool dhcpIsEnabled(InAddrAny addr) const
154 {
155 return std::visit([&](auto v) { return dhcpIsEnabled(v); }, addr);
156 }
157
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800158 /** Retrieve Link State */
159 bool linkUp() const override;
160
Tejas Patil2c0fc562021-08-03 19:13:46 +0530161 /** Retrieve MTU Size */
162 size_t mtu() const override;
163
164 /** Set size of MTU */
165 size_t mtu(size_t value) override;
166
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700167 /** Set value of NICEnabled */
Patrick Williams6aef7692021-05-01 06:39:41 -0500168 bool nicEnabled(bool value) override;
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700169
Gunnar Mills57d9c502018-09-14 14:42:34 -0500170 /** @brief sets the MAC address.
171 * @param[in] value - MAC address which needs to be set on the system.
172 * @returns macAddress of the interface or throws an error.
173 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500174 std::string macAddress(std::string value) override;
Ratan Guptabd303b12017-08-18 17:10:07 +0530175
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700176 /** @brief check conf file for Router Advertisements
177 *
178 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500179 bool ipv6AcceptRA(bool value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700180 using EthernetInterfaceIntf::ipv6AcceptRA;
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700181
Gunnar Mills57d9c502018-09-14 14:42:34 -0500182 /** @brief sets the NTP servers.
183 * @param[in] value - vector of NTP servers.
184 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500185 ServerList ntpServers(ServerList value) override;
Ratan Gupta497c0c92017-08-22 19:15:59 +0530186
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600187 /** @brief sets the static NTP servers.
188 * @param[in] value - vector of NTP servers.
189 */
190 ServerList staticNTPServers(ServerList value) override;
191
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530192 /** @brief sets the Static DNS/nameservers.
193 * @param[in] value - vector of DNS servers.
194 */
195
196 ServerList staticNameServers(ServerList value) override;
197
Gunnar Mills57d9c502018-09-14 14:42:34 -0500198 /** @brief create Vlan interface.
199 * @param[in] id- VLAN identifier.
200 */
William A. Kennington IIId298f932022-10-17 14:31:38 -0700201 ObjectPath createVLAN(uint16_t id);
Ratan Gupta5978dd12017-07-25 13:47:13 +0530202
Gunnar Mills57d9c502018-09-14 14:42:34 -0500203 /** @brief write the network conf file with the in-memory objects.
204 */
205 void writeConfigurationFile();
Ratan Gupta2b106532017-07-25 16:05:02 +0530206
Gunnar Mills57d9c502018-09-14 14:42:34 -0500207 /** @brief delete all dbus objects.
208 */
209 void deleteAll();
Ratan Guptae9c9b812017-09-22 17:15:37 +0530210
Ravi Tejaa5a09442020-07-17 00:57:33 -0500211 /** @brief set the default v4 gateway of the interface.
212 * @param[in] gateway - default v4 gateway of the interface.
213 */
214 std::string defaultGateway(std::string gateway) override;
215
216 /** @brief set the default v6 gateway of the interface.
217 * @param[in] gateway - default v6 gateway of the interface.
218 */
219 std::string defaultGateway6(std::string gateway) override;
220
Gunnar Mills57d9c502018-09-14 14:42:34 -0500221 using EthernetInterfaceIntf::interfaceName;
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800222 using EthernetInterfaceIntf::linkUp;
Tejas Patil2c0fc562021-08-03 19:13:46 +0530223 using EthernetInterfaceIntf::mtu;
Patrick Williams6aef7692021-05-01 06:39:41 -0500224 using EthernetInterfaceIntf::nicEnabled;
225 using MacAddressIntf::macAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530226
Ravi Tejaa5a09442020-07-17 00:57:33 -0500227 using EthernetInterfaceIntf::defaultGateway;
228 using EthernetInterfaceIntf::defaultGateway6;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530229
Gunnar Mills57d9c502018-09-14 14:42:34 -0500230 protected:
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600231 /** @brief get the NTP server list from the timsyncd dbus obj
Gunnar Mills57d9c502018-09-14 14:42:34 -0500232 *
233 */
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600234 virtual ServerList getNTPServerFromTimeSyncd();
Ratan Gupta497c0c92017-08-22 19:15:59 +0530235
Gunnar Mills57d9c502018-09-14 14:42:34 -0500236 /** @brief get the name server details from the network conf
237 *
238 */
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530239 virtual ServerList getNameServerFromResolvd();
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530240
Gunnar Mills57d9c502018-09-14 14:42:34 -0500241 /** @brief Persistent sdbusplus DBus bus connection. */
Patrick Williamsc38b0712022-07-22 19:26:54 -0500242 sdbusplus::bus_t& bus;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530243
Gunnar Mills57d9c502018-09-14 14:42:34 -0500244 /** @brief Dbus object path */
245 std::string objPath;
Ratan Gupta47722dc2017-05-26 18:32:23 +0530246
William A. Kennington III2e09d272022-10-14 17:15:00 -0700247 /** @brief Interface index */
248 unsigned ifIdx;
249
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700250 struct VlanProperties : VlanIfaces
251 {
252 VlanProperties(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
William A. Kennington III454a0de2022-11-12 01:01:04 -0800253 const InterfaceInfo& info, EthernetInterface& eth,
254 bool emitSignal = true);
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700255 void delete_() override;
256 unsigned parentIdx;
257 EthernetInterface& eth;
258 };
259 std::optional<VlanProperties> vlan;
260
Gunnar Mills57d9c502018-09-14 14:42:34 -0500261 friend class TestEthernetInterface;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700262 friend class TestNetworkManager;
Johnathan Mantey817012a2020-01-30 15:07:39 -0800263
264 private:
William A. Kennington IIId298f932022-10-17 14:31:38 -0700265 EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
William A. Kennington III454a0de2022-11-12 01:01:04 -0800266 const InterfaceInfo& info, std::string&& objPath,
William A. Kennington IIId298f932022-10-17 14:31:38 -0700267 const config::Parser& config, bool emitSignal,
268 std::optional<bool> enabled);
269
Johnathan Mantey817012a2020-01-30 15:07:39 -0800270 /** @brief Determines if the address is manually assigned
271 * @param[in] origin - The origin entry of the IP::Address
272 * @returns true/false value if the address is static
273 */
274 bool originIsManuallyAssigned(IP::AddressOrigin origin);
William A. Kennington III26275a32021-07-13 20:32:42 -0700275
276 /** @brief Determines if the NIC is enabled in systemd
277 * @returns true/false value if the NIC is enabled
278 */
279 bool queryNicEnabled() const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530280};
281
282} // namespace network
283} // namespace phosphor