blob: 7f3771e2d29f63dcfd94247c54d39ca0b4192382 [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
8#include <sdbusplus/bus.hpp>
9#include <sdbusplus/server/object.hpp>
William A. Kennington III9ede1b72022-11-21 01:59:28 -080010#include <stdplus/pinned.hpp>
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -070011#include <stdplus/zstring_view.hpp>
Patrick Venture189d44e2018-07-09 12:30:59 -070012#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>
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070015#include <xyz/openbmc_project/Network/VLAN/server.hpp>
16#include <xyz/openbmc_project/Object/Delete/server.hpp>
Ratan Gupta8c834932017-04-14 16:30:24 +053017
Patrick Williams89d734b2023-05-10 07:50:25 -050018#include <optional>
19#include <string>
20#include <vector>
21
Ratan Gupta8c834932017-04-14 16:30:24 +053022namespace phosphor
23{
24namespace network
25{
Ratan Gupta8c834932017-04-14 16:30:24 +053026
Patrick Williamsc38b0712022-07-22 19:26:54 -050027using Ifaces = sdbusplus::server::object_t<
Gunnar Mills57d9c502018-09-14 14:42:34 -050028 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface,
29 sdbusplus::xyz::openbmc_project::Network::server::MACAddress,
30 sdbusplus::xyz::openbmc_project::Network::IP::server::Create,
William A. Kennington III08505792019-01-30 16:00:04 -080031 sdbusplus::xyz::openbmc_project::Network::Neighbor::server::CreateStatic,
Gunnar Mills57d9c502018-09-14 14:42:34 -050032 sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
Ratan Gupta8c834932017-04-14 16:30:24 +053033
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070034using VlanIfaces = sdbusplus::server::object_t<
35 sdbusplus::xyz::openbmc_project::Object::server::Delete,
36 sdbusplus::xyz::openbmc_project::Network::server::VLAN>;
37
38using VlanIntf = sdbusplus::xyz::openbmc_project::Network::server::VLAN;
39
Ratan Gupta82549cc2017-04-21 08:45:23 +053040using IP = sdbusplus::xyz::openbmc_project::Network::server::IP;
Ratan Gupta87c13982017-06-15 09:27:27 +053041
42using EthernetInterfaceIntf =
43 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface;
Ratan Guptabd303b12017-08-18 17:10:07 +053044using MacAddressIntf =
45 sdbusplus::xyz::openbmc_project::Network::server::MACAddress;
Ratan Gupta87c13982017-06-15 09:27:27 +053046
Ratan Gupta497c0c92017-08-22 19:15:59 +053047using ServerList = std::vector<std::string>;
raviteja-bce379562019-03-28 05:59:36 -050048using ObjectPath = sdbusplus::message::object_path;
Ratan Gupta497c0c92017-08-22 19:15:59 +053049
William A. Kennington III9a20a6e2022-10-05 13:41:12 -070050class Manager;
Ratan Gupta8c834932017-04-14 16:30:24 +053051
Ratan Gupta47722dc2017-05-26 18:32:23 +053052class TestEthernetInterface;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070053class TestNetworkManager;
Ratan Gupta5978dd12017-07-25 13:47:13 +053054
William A. Kennington III95530ec2022-08-19 01:44:39 -070055namespace config
56{
57class Parser;
58}
William A. Kennington IIId298f932022-10-17 14:31:38 -070059
Ratan Gupta8c834932017-04-14 16:30:24 +053060/** @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 Gupta82549cc2017-04-21 08:45:23 +053065class EthernetInterface : public Ifaces
Ratan Gupta8c834932017-04-14 16:30:24 +053066{
Gunnar Mills57d9c502018-09-14 14:42:34 -050067 public:
Gunnar Mills57d9c502018-09-14 14:42:34 -050068 EthernetInterface(EthernetInterface&&) = delete;
69 EthernetInterface& operator=(EthernetInterface&&) = delete;
Ratan Gupta8c834932017-04-14 16:30:24 +053070
Gunnar Mills57d9c502018-09-14 14:42:34 -050071 /** @brief Constructor to put object onto bus at a dbus path.
72 * @param[in] bus - Bus to attach to.
William A. Kennington IIId298f932022-10-17 14:31:38 -070073 * @param[in] manager - parent object.
74 * @param[in] info - Interface information.
75 * @param[in] objRoot - Path to attach at.
William A. Kennington IIIa520a392022-08-08 12:17:34 -070076 * @param[in] config - The parsed configuation file.
William A. Kennington III09f3a4a2022-10-25 02:59:16 -070077 * @param[in] vlan - The id of the vlan if configured
William A. Kennington III80d29012022-11-12 02:31:40 -080078 * @param[in] enabled - Determine if systemd-networkd is managing this link
Gunnar Mills57d9c502018-09-14 14:42:34 -050079 */
William A. Kennington III9ede1b72022-11-21 01:59:28 -080080 EthernetInterface(stdplus::PinnedRef<sdbusplus::bus_t> bus,
81 stdplus::PinnedRef<Manager> manager,
William A. Kennington III13d665c2022-11-15 20:34:40 -080082 const AllIntfInfo& info, std::string_view objRoot,
William A. Kennington IIIb6452542022-11-15 18:09:12 -080083 const config::Parser& config, bool enabled);
Ratan Gupta82549cc2017-04-21 08:45:23 +053084
William A. Kennington III59e5b912022-11-02 02:49:46 -070085 /** @brief Network Manager object. */
William A. Kennington III9ede1b72022-11-21 01:59:28 -080086 stdplus::PinnedRef<Manager> manager;
William A. Kennington III59e5b912022-11-02 02:49:46 -070087
88 /** @brief Persistent map of IPAddress dbus objects and their names */
William A. Kennington III9b2a20d2023-06-17 14:05:48 -070089 std::unordered_map<stdplus::SubnetAny, std::unique_ptr<IPAddress>> addrs;
William A. Kennington III59e5b912022-11-02 02:49:46 -070090
William A. Kennington III434a9432022-11-04 18:38:46 -070091 /** @brief Persistent map of Neighbor dbus objects and their names */
William A. Kennington III9b2a20d2023-06-17 14:05:48 -070092 std::unordered_map<stdplus::InAnyAddr, std::unique_ptr<Neighbor>>
93 staticNeighbors;
William A. Kennington III434a9432022-11-04 18:38:46 -070094
William A. Kennington IIId6f53402022-11-07 14:48:53 -080095 void addAddr(const AddressInfo& info);
William A. Kennington IIIbc2502c2022-11-07 16:31:54 -080096 void addStaticNeigh(const NeighborInfo& info);
William A. Kennington IIId6f53402022-11-07 14:48:53 -080097
William A. Kennington IIId298f932022-10-17 14:31:38 -070098 /** @brief Updates the interface information based on new InterfaceInfo */
William A. Kennington IIId99e6db2022-11-15 20:39:45 -080099 void updateInfo(const InterfaceInfo& info, bool skipSignal = false);
William A. Kennington IIId298f932022-10-17 14:31:38 -0700100
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600101 /** @brief Function used to load the ntpservers
102 */
103 void loadNTPServers(const config::Parser& config);
104
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530105 /** @brief Function used to load the nameservers.
106 */
William A. Kennington IIIa520a392022-08-08 12:17:34 -0700107 void loadNameServers(const config::Parser& config);
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530108
Patrick Williams6aef7692021-05-01 06:39:41 -0500109 /** @brief Function to create ipAddress dbus object.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500110 * @param[in] addressType - Type of ip address.
Patrick Williams6aef7692021-05-01 06:39:41 -0500111 * @param[in] ipAddress- IP address.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500112 * @param[in] prefixLength - Length of prefix.
Gunnar Mills57d9c502018-09-14 14:42:34 -0500113 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530114
Patrick Williams6aef7692021-05-01 06:39:41 -0500115 ObjectPath ip(IP::Protocol addressType, std::string ipAddress,
William A. Kennington IIIe25f8b42022-10-11 14:43:28 -0700116 uint8_t prefixLength, std::string) override;
Ratan Gupta8c834932017-04-14 16:30:24 +0530117
William A. Kennington III08505792019-01-30 16:00:04 -0800118 /** @brief Function to create static neighbor dbus object.
119 * @param[in] ipAddress - IP address.
120 * @param[in] macAddress - Low level MAC address.
121 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500122 ObjectPath neighbor(std::string ipAddress, std::string macAddress) override;
William A. Kennington III08505792019-01-30 16:00:04 -0800123
Gunnar Mills57d9c502018-09-14 14:42:34 -0500124 /** Set value of DHCPEnabled */
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700125 DHCPConf dhcpEnabled() const override;
Patrick Williams6aef7692021-05-01 06:39:41 -0500126 DHCPConf dhcpEnabled(DHCPConf value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700127 using EthernetInterfaceIntf::dhcp4;
128 bool dhcp4(bool value) override;
129 using EthernetInterfaceIntf::dhcp6;
130 bool dhcp6(bool value) override;
Ratan Gupta87c13982017-06-15 09:27:27 +0530131
William A. Kennington III9b2a20d2023-06-17 14:05:48 -0700132 inline bool dhcpIsEnabled(stdplus::In4Addr) const
William A. Kennington III59e5b912022-11-02 02:49:46 -0700133 {
134 return dhcp4();
135 }
William A. Kennington III9b2a20d2023-06-17 14:05:48 -0700136 inline bool dhcpIsEnabled(stdplus::In6Addr) const
William A. Kennington III59e5b912022-11-02 02:49:46 -0700137 {
138 return dhcp6();
139 }
William A. Kennington III9b2a20d2023-06-17 14:05:48 -0700140 inline bool dhcpIsEnabled(stdplus::InAnyAddr addr) const
William A. Kennington III59e5b912022-11-02 02:49:46 -0700141 {
142 return std::visit([&](auto v) { return dhcpIsEnabled(v); }, addr);
143 }
144
Tejas Patil2c0fc562021-08-03 19:13:46 +0530145 /** Set size of MTU */
146 size_t mtu(size_t value) override;
147
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700148 /** Set value of NICEnabled */
Patrick Williams6aef7692021-05-01 06:39:41 -0500149 bool nicEnabled(bool value) override;
Johnathan Manteyd0679f92019-10-29 16:20:28 -0700150
Gunnar Mills57d9c502018-09-14 14:42:34 -0500151 /** @brief sets the MAC address.
152 * @param[in] value - MAC address which needs to be set on the system.
153 * @returns macAddress of the interface or throws an error.
154 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500155 std::string macAddress(std::string value) override;
Ratan Guptabd303b12017-08-18 17:10:07 +0530156
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700157 /** @brief check conf file for Router Advertisements
158 *
159 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500160 bool ipv6AcceptRA(bool value) override;
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700161 using EthernetInterfaceIntf::ipv6AcceptRA;
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700162
Gunnar Mills57d9c502018-09-14 14:42:34 -0500163 /** @brief sets the NTP servers.
164 * @param[in] value - vector of NTP servers.
165 */
Patrick Williams6aef7692021-05-01 06:39:41 -0500166 ServerList ntpServers(ServerList value) override;
Ratan Gupta497c0c92017-08-22 19:15:59 +0530167
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600168 /** @brief sets the static NTP servers.
169 * @param[in] value - vector of NTP servers.
170 */
171 ServerList staticNTPServers(ServerList value) override;
172
Ravi Teja4f8b9a02023-09-06 13:41:52 -0500173 /** @brief Get value of nameservers */
174 ServerList nameservers() const override;
175
Manojkiran Edaacd6dd52019-10-15 15:00:51 +0530176 /** @brief sets the Static DNS/nameservers.
177 * @param[in] value - vector of DNS servers.
178 */
179
180 ServerList staticNameServers(ServerList value) override;
181
Gunnar Mills57d9c502018-09-14 14:42:34 -0500182 /** @brief create Vlan interface.
183 * @param[in] id- VLAN identifier.
184 */
William A. Kennington IIId298f932022-10-17 14:31:38 -0700185 ObjectPath createVLAN(uint16_t id);
Ratan Gupta5978dd12017-07-25 13:47:13 +0530186
Gunnar Mills57d9c502018-09-14 14:42:34 -0500187 /** @brief write the network conf file with the in-memory objects.
188 */
189 void writeConfigurationFile();
Ratan Gupta2b106532017-07-25 16:05:02 +0530190
Gunnar Mills57d9c502018-09-14 14:42:34 -0500191 /** @brief delete all dbus objects.
192 */
William A. Kennington IIIaf77f822023-06-23 02:17:20 -0700193 void deleteAll() override;
Ratan Guptae9c9b812017-09-22 17:15:37 +0530194
Ravi Tejaa5a09442020-07-17 00:57:33 -0500195 /** @brief set the default v4 gateway of the interface.
196 * @param[in] gateway - default v4 gateway of the interface.
197 */
198 std::string defaultGateway(std::string gateway) override;
199
200 /** @brief set the default v6 gateway of the interface.
201 * @param[in] gateway - default v6 gateway of the interface.
202 */
203 std::string defaultGateway6(std::string gateway) override;
204
Gunnar Mills57d9c502018-09-14 14:42:34 -0500205 using EthernetInterfaceIntf::interfaceName;
Johnathan Manteyfaa72e52020-01-08 10:38:58 -0800206 using EthernetInterfaceIntf::linkUp;
Tejas Patil2c0fc562021-08-03 19:13:46 +0530207 using EthernetInterfaceIntf::mtu;
Patrick Williams6aef7692021-05-01 06:39:41 -0500208 using EthernetInterfaceIntf::nicEnabled;
209 using MacAddressIntf::macAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530210
Ravi Tejaa5a09442020-07-17 00:57:33 -0500211 using EthernetInterfaceIntf::defaultGateway;
212 using EthernetInterfaceIntf::defaultGateway6;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530213
Gunnar Mills57d9c502018-09-14 14:42:34 -0500214 protected:
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600215 /** @brief get the NTP server list from the timsyncd dbus obj
Gunnar Mills57d9c502018-09-14 14:42:34 -0500216 *
217 */
Asmitha Karunanithi003b8b72022-01-06 04:17:59 -0600218 virtual ServerList getNTPServerFromTimeSyncd();
Ratan Gupta497c0c92017-08-22 19:15:59 +0530219
Gunnar Mills57d9c502018-09-14 14:42:34 -0500220 /** @brief get the name server details from the network conf
221 *
222 */
Ravi Teja4f8b9a02023-09-06 13:41:52 -0500223 virtual ServerList getNameServerFromResolvd() const;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530224
Gunnar Mills57d9c502018-09-14 14:42:34 -0500225 /** @brief Persistent sdbusplus DBus bus connection. */
William A. Kennington III9ede1b72022-11-21 01:59:28 -0800226 stdplus::PinnedRef<sdbusplus::bus_t> bus;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530227
Gunnar Mills57d9c502018-09-14 14:42:34 -0500228 /** @brief Dbus object path */
229 std::string objPath;
Ratan Gupta47722dc2017-05-26 18:32:23 +0530230
William A. Kennington III2e09d272022-10-14 17:15:00 -0700231 /** @brief Interface index */
232 unsigned ifIdx;
233
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700234 struct VlanProperties : VlanIfaces
235 {
236 VlanProperties(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
William A. Kennington III9ede1b72022-11-21 01:59:28 -0800237 const InterfaceInfo& info,
238 stdplus::PinnedRef<EthernetInterface> eth);
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700239 void delete_() override;
240 unsigned parentIdx;
William A. Kennington III9ede1b72022-11-21 01:59:28 -0800241 stdplus::PinnedRef<EthernetInterface> eth;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700242 };
243 std::optional<VlanProperties> vlan;
244
Gunnar Mills57d9c502018-09-14 14:42:34 -0500245 friend class TestEthernetInterface;
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700246 friend class TestNetworkManager;
Johnathan Mantey817012a2020-01-30 15:07:39 -0800247
248 private:
William A. Kennington III9ede1b72022-11-21 01:59:28 -0800249 EthernetInterface(stdplus::PinnedRef<sdbusplus::bus_t> bus,
250 stdplus::PinnedRef<Manager> manager,
William A. Kennington III13d665c2022-11-15 20:34:40 -0800251 const AllIntfInfo& info, std::string&& objPath,
William A. Kennington IIIb6452542022-11-15 18:09:12 -0800252 const config::Parser& config, bool enabled);
William A. Kennington IIId298f932022-10-17 14:31:38 -0700253
Johnathan Mantey817012a2020-01-30 15:07:39 -0800254 /** @brief Determines if the address is manually assigned
255 * @param[in] origin - The origin entry of the IP::Address
256 * @returns true/false value if the address is static
257 */
258 bool originIsManuallyAssigned(IP::AddressOrigin origin);
Ratan Gupta8c834932017-04-14 16:30:24 +0530259};
260
261} // namespace network
262} // namespace phosphor