blob: 462937f46735f76c20a11cf90c21e6221cbed5cf [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 IIId298f932022-10-17 14:31:38 -070094 /** @brief Updates the interface information based on new InterfaceInfo */
William A. Kennington IIIfd862be2022-10-09 18:40:55 -070095 void updateInfo(const system::InterfaceInfo& info);
William A. Kennington IIId298f932022-10-17 14:31:38 -070096
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -060097 /** @brief Function used to load the ntpservers
98 */
99 void loadNTPServers(const config::Parser& config);
100
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530101 /** @brief Function used to load the nameservers.
102 */
William A. Kennington IIIa520a392022-08-08 12:17:34 -0700103 void loadNameServers(const config::Parser& config);
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530104
Patrick Williams6aef7692021-05-01 06:39:41 -0500105 /** @brief Function to create ipAddress dbus object.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500106 * @param[in] addressType - Type of ip address.
Patrick Williams6aef7692021-05-01 06:39:41 -0500107 * @param[in] ipAddress- IP address.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500108 * @param[in] prefixLength - Length of prefix.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500109 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530110
Patrick Williams6aef7692021-05-01 06:39:41 -0500111 ObjectPath ip(IP::Protocol addressType, std::string ipAddress,
William A. Kennington IIIe25f8b42022-10-11 14:43:28 -0700112 uint8_t prefixLength, std::string) override;
Ratan Gupta8c834932017-04-14 16:30:24 +0530113
William A. Kennington III08505792019-01-30 16:00:04 -0800114 /** @brief Function to create static neighbor dbus object.
115 * @param[in] ipAddress - IP address.
116 * @param[in] macAddress - Low level MAC address.
117 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500118 ObjectPath neighbor(std::string ipAddress, std::string macAddress) override;
William A. Kennington III08505792019-01-30 16:00:04 -0800119
Patrick Williams6aef7692021-05-01 06:39:41 -0500120 /* @brief delete the dbus object of the given ipAddress.
121 * @param[in] ipAddress - IP address.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500122 */
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -0700123 void deleteObject(std::string_view ipAddress);
Ratan Gupta8c834932017-04-14 16:30:24 +0530124
Patrick Williams6aef7692021-05-01 06:39:41 -0500125 /* @brief delete the dbus object of the given ipAddress.
126 * @param[in] ipAddress - IP address.
William A. Kennington III08505792019-01-30 16:00:04 -0800127 */
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -0700128 void deleteStaticNeighborObject(std::string_view ipAddress);
William A. Kennington III08505792019-01-30 16:00:04 -0800129
Gunnar Mills57d9c502018-09-14 14:42:34 -0500130 /* @brief creates the dbus object(IPaddres) given in the address list.
131 * @param[in] addrs - address list for which dbus objects needs
132 * to create.
133 */
134 void createIPAddressObjects();
Ratan Gupta29b0e432017-05-25 12:51:40 +0530135
William A. Kennington III08505792019-01-30 16:00:04 -0800136 /* @brief creates the dbus object(Neighbor) given in the neighbor list.
137 */
138 void createStaticNeighborObjects();
139
Gunnar Mills57d9c502018-09-14 14:42:34 -0500140 /* @brief Gets all the ip addresses.
Patrick Williams6aef7692021-05-01 06:39:41 -0500141 * @returns the list of ipAddress.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500142 */
William A. Kennington III9a20a6e2022-10-05 13:41:12 -0700143 inline const auto& getAddresses() const
Gunnar Mills57d9c502018-09-14 14:42:34 -0500144 {
145 return addrs;
146 }
Ratan Gupta8c834932017-04-14 16:30:24 +0530147
William A. Kennington III08505792019-01-30 16:00:04 -0800148 /* @brief Gets all the static neighbor entries.
149 * @returns Static neighbor map.
150 */
William A. Kennington III9a20a6e2022-10-05 13:41:12 -0700151 inline const auto& getStaticNeighbors() const
William A. Kennington III08505792019-01-30 16:00:04 -0800152 {
153 return staticNeighbors;
154 }
155
Gunnar Mills57d9c502018-09-14 14:42:34 -0500156 /** Set value of DHCPEnabled */
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700157 DHCPConf dhcpEnabled() const override;
Patrick Williams6aef7692021-05-01 06:39:41 -0500158 DHCPConf dhcpEnabled(DHCPConf value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700159 using EthernetInterfaceIntf::dhcp4;
160 bool dhcp4(bool value) override;
161 using EthernetInterfaceIntf::dhcp6;
162 bool dhcp6(bool value) override;
Ratan Gupta87c13982017-06-15 09:27:27 +0530163
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800164 /** Retrieve Link State */
165 bool linkUp() const override;
166
Tejas Patil2c0fc562021-08-03 19:13:46 +0530167 /** Retrieve MTU Size */
168 size_t mtu() const override;
169
170 /** Set size of MTU */
171 size_t mtu(size_t value) override;
172
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700173 /** Set value of NICEnabled */
Patrick Williams6aef7692021-05-01 06:39:41 -0500174 bool nicEnabled(bool value) override;
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700175
Gunnar Mills57d9c502018-09-14 14:42:34 -0500176 /** @brief sets the MAC address.
177 * @param[in] value - MAC address which needs to be set on the system.
178 * @returns macAddress of the interface or throws an error.
179 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500180 std::string macAddress(std::string value) override;
Ratan Guptabd303b12017-08-18 17:10:07 +0530181
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700182 /** @brief check conf file for Router Advertisements
183 *
184 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500185 bool ipv6AcceptRA(bool value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700186 using EthernetInterfaceIntf::ipv6AcceptRA;
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700187
Gunnar Mills57d9c502018-09-14 14:42:34 -0500188 /** @brief sets the NTP servers.
189 * @param[in] value - vector of NTP servers.
190 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500191 ServerList ntpServers(ServerList value) override;
Ratan Gupta497c0c92017-08-22 19:15:59 +0530192
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600193 /** @brief sets the static NTP servers.
194 * @param[in] value - vector of NTP servers.
195 */
196 ServerList staticNTPServers(ServerList value) override;
197
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530198 /** @brief sets the Static DNS/nameservers.
199 * @param[in] value - vector of DNS servers.
200 */
201
202 ServerList staticNameServers(ServerList value) override;
203
Gunnar Mills57d9c502018-09-14 14:42:34 -0500204 /** @brief create Vlan interface.
205 * @param[in] id- VLAN identifier.
206 */
William A. Kennington IIId298f932022-10-17 14:31:38 -0700207 ObjectPath createVLAN(uint16_t id);
Ratan Gupta5978dd12017-07-25 13:47:13 +0530208
Gunnar Mills57d9c502018-09-14 14:42:34 -0500209 /** @brief write the network conf file with the in-memory objects.
210 */
211 void writeConfigurationFile();
Ratan Gupta2b106532017-07-25 16:05:02 +0530212
Gunnar Mills57d9c502018-09-14 14:42:34 -0500213 /** @brief delete all dbus objects.
214 */
215 void deleteAll();
Ratan Guptae9c9b812017-09-22 17:15:37 +0530216
Ravi Tejaa5a09442020-07-17 00:57:33 -0500217 /** @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 Mills57d9c502018-09-14 14:42:34 -0500227 using EthernetInterfaceIntf::interfaceName;
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800228 using EthernetInterfaceIntf::linkUp;
Tejas Patil2c0fc562021-08-03 19:13:46 +0530229 using EthernetInterfaceIntf::mtu;
Patrick Williams6aef7692021-05-01 06:39:41 -0500230 using EthernetInterfaceIntf::nicEnabled;
231 using MacAddressIntf::macAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530232
Ravi Tejaa5a09442020-07-17 00:57:33 -0500233 using EthernetInterfaceIntf::defaultGateway;
234 using EthernetInterfaceIntf::defaultGateway6;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530235
Gunnar Mills57d9c502018-09-14 14:42:34 -0500236 protected:
Gunnar Mills57d9c502018-09-14 14:42:34 -0500237 /** @brief construct the ip address dbus object path.
238 * @param[in] addressType - Type of ip address.
Patrick Williams6aef7692021-05-01 06:39:41 -0500239 * @param[in] ipAddress - IP address.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500240 * @param[in] prefixLength - Length of prefix.
Lei YU34027572021-08-11 15:23:52 +0800241 * @param[in] origin - The origin entry of the IP::Address
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530242
Gunnar Mills57d9c502018-09-14 14:42:34 -0500243 * @return path of the address object.
244 */
Gunnar Mills57d9c502018-09-14 14:42:34 -0500245 std::string generateObjectPath(IP::Protocol addressType,
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -0700246 std::string_view ipAddress,
Gunnar Mills57d9c502018-09-14 14:42:34 -0500247 uint8_t prefixLength,
Lei YU34027572021-08-11 15:23:52 +0800248 IP::AddressOrigin origin) const;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530249
William A. Kennington III08505792019-01-30 16:00:04 -0800250 std::string
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -0700251 generateStaticNeighborObjectPath(std::string_view ipAddress,
252 std::string_view macAddress) const;
William A. Kennington III08505792019-01-30 16:00:04 -0800253
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600254 /** @brief get the NTP server list from the timsyncd dbus obj
Gunnar Mills57d9c502018-09-14 14:42:34 -0500255 *
256 */
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600257 virtual ServerList getNTPServerFromTimeSyncd();
Ratan Gupta497c0c92017-08-22 19:15:59 +0530258
Gunnar Mills57d9c502018-09-14 14:42:34 -0500259 /** @brief get the name server details from the network conf
260 *
261 */
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530262 virtual ServerList getNameServerFromResolvd();
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530263
Gunnar Mills57d9c502018-09-14 14:42:34 -0500264 /** @brief Persistent sdbusplus DBus bus connection. */
Patrick Williamsc38b0712022-07-22 19:26:54 -0500265 sdbusplus::bus_t& bus;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530266
Gunnar Mills57d9c502018-09-14 14:42:34 -0500267 /** @brief Network Manager object. */
268 Manager& manager;
Ratan Gupta4f1c18b2017-05-25 12:59:35 +0530269
Gunnar Mills57d9c502018-09-14 14:42:34 -0500270 /** @brief Persistent map of IPAddress dbus objects and their names */
William A. Kennington III9a20a6e2022-10-05 13:41:12 -0700271 string_umap<std::unique_ptr<IPAddress>> addrs;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530272
William A. Kennington III08505792019-01-30 16:00:04 -0800273 /** @brief Persistent map of Neighbor dbus objects and their names */
William A. Kennington III9a20a6e2022-10-05 13:41:12 -0700274 string_umap<std::unique_ptr<Neighbor>> staticNeighbors;
William A. Kennington III08505792019-01-30 16:00:04 -0800275
Gunnar Mills57d9c502018-09-14 14:42:34 -0500276 /** @brief Dbus object path */
277 std::string objPath;
Ratan Gupta47722dc2017-05-26 18:32:23 +0530278
William A. Kennington III2e09d272022-10-14 17:15:00 -0700279 /** @brief Interface index */
280 unsigned ifIdx;
281
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700282 struct VlanProperties : VlanIfaces
283 {
284 VlanProperties(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
285 const system::InterfaceInfo& info,
286 EthernetInterface& eth, bool emitSignal = true);
287 void delete_() override;
288 unsigned parentIdx;
289 EthernetInterface& eth;
290 };
291 std::optional<VlanProperties> vlan;
292
Gunnar Mills57d9c502018-09-14 14:42:34 -0500293 friend class TestEthernetInterface;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700294 friend class TestNetworkManager;
Johnathan Mantey817012a2020-01-30 15:07:39 -0800295
296 private:
William A. Kennington IIId298f932022-10-17 14:31:38 -0700297 EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
William A. Kennington IIIfd862be2022-10-09 18:40:55 -0700298 const system::InterfaceInfo& info, std::string&& objPath,
William A. Kennington IIId298f932022-10-17 14:31:38 -0700299 const config::Parser& config, bool emitSignal,
300 std::optional<bool> enabled);
301
Johnathan Mantey817012a2020-01-30 15:07:39 -0800302 /** @brief Determines if DHCP is active for the IP::Protocol supplied.
303 * @param[in] protocol - Either IPv4 or IPv6
Johnathan Mantey817012a2020-01-30 15:07:39 -0800304 * @returns true/false value if DHCP is active for the input protocol
305 */
William A. Kennington III24957b92021-12-03 13:59:19 -0800306 bool dhcpIsEnabled(IP::Protocol protocol);
Johnathan Mantey817012a2020-01-30 15:07:39 -0800307
Johnathan Mantey817012a2020-01-30 15:07:39 -0800308 /** @brief Determines if the address is manually assigned
309 * @param[in] origin - The origin entry of the IP::Address
310 * @returns true/false value if the address is static
311 */
312 bool originIsManuallyAssigned(IP::AddressOrigin origin);
William A. Kennington III26275a32021-07-13 20:32:42 -0700313
314 /** @brief Determines if the NIC is enabled in systemd
315 * @returns true/false value if the NIC is enabled
316 */
317 bool queryNicEnabled() const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530318};
319
320} // namespace network
321} // namespace phosphor