blob: e48fddbd70d0e18f57713b9e11b7e54ee04dcd38 [file] [log] [blame]
Ratan Gupta8c834932017-04-14 16:30:24 +05301#pragma once
2
Ratan Gupta82549cc2017-04-21 08:45:23 +05303#include "types.hpp"
Ratan Gupta8804feb2017-05-25 10:49:57 +05304#include "util.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
Patrick Venture189d44e2018-07-09 12:30:59 -07008#include <experimental/filesystem>
Ratan Gupta8c834932017-04-14 16:30:24 +05309#include <sdbusplus/bus.hpp>
10#include <sdbusplus/server/object.hpp>
Ratan Gupta8c834932017-04-14 16:30:24 +053011#include <string>
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>
Ratan Gupta8c834932017-04-14 16:30:24 +053015
16namespace phosphor
17{
18namespace network
19{
Ratan Gupta8c834932017-04-14 16:30:24 +053020
Gunnar Mills57d9c502018-09-14 14:42:34 -050021using Ifaces = sdbusplus::server::object::object<
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 III08505792019-01-30 16:00:04 -080025 sdbusplus::xyz::openbmc_project::Network::Neighbor::server::CreateStatic,
Gunnar Mills57d9c502018-09-14 14:42:34 -050026 sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
Ratan Gupta8c834932017-04-14 16:30:24 +053027
Ratan Gupta82549cc2017-04-21 08:45:23 +053028using IP = sdbusplus::xyz::openbmc_project::Network::server::IP;
Ratan Gupta87c13982017-06-15 09:27:27 +053029
30using EthernetInterfaceIntf =
31 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface;
Ratan Guptabd303b12017-08-18 17:10:07 +053032using MacAddressIntf =
33 sdbusplus::xyz::openbmc_project::Network::server::MACAddress;
Ratan Gupta87c13982017-06-15 09:27:27 +053034
Ratan Gupta497c0c92017-08-22 19:15:59 +053035using ServerList = std::vector<std::string>;
raviteja-bce379562019-03-28 05:59:36 -050036using ObjectPath = sdbusplus::message::object_path;
Ratan Gupta497c0c92017-08-22 19:15:59 +053037
Ratan Gupta5978dd12017-07-25 13:47:13 +053038namespace fs = std::experimental::filesystem;
39
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053040class Manager; // forward declaration of network manager.
Ratan Gupta8c834932017-04-14 16:30:24 +053041
Ratan Gupta47722dc2017-05-26 18:32:23 +053042class TestEthernetInterface;
43
Ratan Gupta5978dd12017-07-25 13:47:13 +053044class VlanInterface;
45
46class IPAddress;
47
William A. Kennington III08505792019-01-30 16:00:04 -080048class Neighbor;
49
Ratan Gupta8c834932017-04-14 16:30:24 +053050using LinkSpeed = uint16_t;
51using DuplexMode = uint8_t;
52using Autoneg = uint8_t;
Ratan Gupta5978dd12017-07-25 13:47:13 +053053using VlanId = uint32_t;
54using InterfaceName = std::string;
Ratan Gupta8c834932017-04-14 16:30:24 +053055using InterfaceInfo = std::tuple<LinkSpeed, DuplexMode, Autoneg>;
Ratan Gupta29b0e432017-05-25 12:51:40 +053056using AddressMap = std::map<std::string, std::shared_ptr<IPAddress>>;
William A. Kennington III08505792019-01-30 16:00:04 -080057using NeighborMap = std::map<std::string, std::shared_ptr<Neighbor>>;
Gunnar Mills57d9c502018-09-14 14:42:34 -050058using VlanInterfaceMap =
59 std::map<InterfaceName, std::unique_ptr<VlanInterface>>;
Ratan Gupta8c834932017-04-14 16:30:24 +053060
61/** @class EthernetInterface
62 * @brief OpenBMC Ethernet Interface implementation.
63 * @details A concrete implementation for the
64 * xyz.openbmc_project.Network.EthernetInterface DBus API.
65 */
Ratan Gupta82549cc2017-04-21 08:45:23 +053066class EthernetInterface : public Ifaces
Ratan Gupta8c834932017-04-14 16:30:24 +053067{
Gunnar Mills57d9c502018-09-14 14:42:34 -050068 public:
69 EthernetInterface() = delete;
70 EthernetInterface(const EthernetInterface&) = delete;
71 EthernetInterface& operator=(const EthernetInterface&) = delete;
72 EthernetInterface(EthernetInterface&&) = delete;
73 EthernetInterface& operator=(EthernetInterface&&) = delete;
74 virtual ~EthernetInterface() = default;
Ratan Gupta8c834932017-04-14 16:30:24 +053075
Gunnar Mills57d9c502018-09-14 14:42:34 -050076 /** @brief Constructor to put object onto bus at a dbus path.
77 * @param[in] bus - Bus to attach to.
78 * @param[in] objPath - Path to attach at.
79 * @param[in] dhcpEnabled - is dhcp enabled(true/false).
80 * @param[in] parent - parent object.
81 * @param[in] emitSignal - true if the object added signal needs to be
82 * send.
83 */
84 EthernetInterface(sdbusplus::bus::bus& bus, const std::string& objPath,
85 bool dhcpEnabled, Manager& parent,
86 bool emitSignal = true);
Ratan Gupta82549cc2017-04-21 08:45:23 +053087
Gunnar Mills57d9c502018-09-14 14:42:34 -050088 /** @brief Function to create ipaddress dbus object.
89 * @param[in] addressType - Type of ip address.
90 * @param[in] ipaddress- IP address.
91 * @param[in] prefixLength - Length of prefix.
92 * @param[in] gateway - Gateway ip address.
93 */
Ratan Gupta82549cc2017-04-21 08:45:23 +053094
raviteja-bce379562019-03-28 05:59:36 -050095 ObjectPath iP(IP::Protocol addressType, std::string ipaddress,
96 uint8_t prefixLength, std::string gateway) override;
Ratan Gupta8c834932017-04-14 16:30:24 +053097
William A. Kennington III08505792019-01-30 16:00:04 -080098 /** @brief Function to create static neighbor dbus object.
99 * @param[in] ipAddress - IP address.
100 * @param[in] macAddress - Low level MAC address.
101 */
102 ObjectPath neighbor(std::string iPAddress, std::string mACAddress) override;
103
Gunnar Mills57d9c502018-09-14 14:42:34 -0500104 /* @brief delete the dbus object of the given ipaddress.
105 * @param[in] ipaddress - IP address.
106 */
107 void deleteObject(const std::string& ipaddress);
Ratan Gupta8c834932017-04-14 16:30:24 +0530108
William A. Kennington III08505792019-01-30 16:00:04 -0800109 /* @brief delete the dbus object of the given ipaddress.
110 * @param[in] ipaddress - IP address.
111 */
112 void deleteStaticNeighborObject(const std::string& ipAddress);
113
Gunnar Mills57d9c502018-09-14 14:42:34 -0500114 /* @brief delete the vlan dbus object of the given interface.
115 * Also deletes the device file and the network file.
116 * @param[in] interface - VLAN Interface.
117 */
118 void deleteVLANObject(const std::string& interface);
Ratan Guptabc886292017-07-25 18:29:57 +0530119
Gunnar Mills57d9c502018-09-14 14:42:34 -0500120 /* @brief creates the dbus object(IPaddres) given in the address list.
121 * @param[in] addrs - address list for which dbus objects needs
122 * to create.
123 */
124 void createIPAddressObjects();
Ratan Gupta29b0e432017-05-25 12:51:40 +0530125
William A. Kennington III08505792019-01-30 16:00:04 -0800126 /* @brief creates the dbus object(Neighbor) given in the neighbor list.
127 */
128 void createStaticNeighborObjects();
129
William A. Kennington IIId7946a72019-04-19 14:24:09 -0700130 /* @brief Gets the index of the interface on the system
131 */
132 unsigned ifIndex() const;
133
Gunnar Mills57d9c502018-09-14 14:42:34 -0500134 /* @brief Gets all the ip addresses.
135 * @returns the list of ipaddress.
136 */
137 const AddressMap& getAddresses() const
138 {
139 return addrs;
140 }
Ratan Gupta8c834932017-04-14 16:30:24 +0530141
William A. Kennington III08505792019-01-30 16:00:04 -0800142 /* @brief Gets all the static neighbor entries.
143 * @returns Static neighbor map.
144 */
145 const NeighborMap& getStaticNeighbors() const
146 {
147 return staticNeighbors;
148 }
149
Gunnar Mills57d9c502018-09-14 14:42:34 -0500150 /** Set value of DHCPEnabled */
151 bool dHCPEnabled(bool value) override;
Ratan Gupta87c13982017-06-15 09:27:27 +0530152
Gunnar Mills57d9c502018-09-14 14:42:34 -0500153 /** @brief sets the MAC address.
154 * @param[in] value - MAC address which needs to be set on the system.
155 * @returns macAddress of the interface or throws an error.
156 */
157 std::string mACAddress(std::string value) override;
Ratan Guptabd303b12017-08-18 17:10:07 +0530158
Johnathan Mantey5b023f52019-06-24 16:06:37 -0700159 /** @brief get the IPv6AcceptRA flag from the network configuration file
160 *
161 */
162 bool getIPv6AcceptRAFromConf();
163
164 /** @brief check conf file for Router Advertisements
165 *
166 */
167 bool iPv6AcceptRA(bool value) override;
168
Gunnar Mills57d9c502018-09-14 14:42:34 -0500169 /** @brief sets the NTP servers.
170 * @param[in] value - vector of NTP servers.
171 */
172 ServerList nTPServers(ServerList value) override;
Ratan Gupta497c0c92017-08-22 19:15:59 +0530173
Gunnar Mills57d9c502018-09-14 14:42:34 -0500174 /** @brief sets the DNS/nameservers.
175 * @param[in] value - vector of DNS servers.
176 */
177 ServerList nameservers(ServerList value) override;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530178
Gunnar Mills57d9c502018-09-14 14:42:34 -0500179 /** @brief create Vlan interface.
180 * @param[in] id- VLAN identifier.
181 */
William A. Kennington IIIf4b4ff82019-04-09 19:06:52 -0700182 ObjectPath createVLAN(VlanId id);
Ratan Gupta5978dd12017-07-25 13:47:13 +0530183
Gunnar Mills57d9c502018-09-14 14:42:34 -0500184 /** @brief load the vlan info from the system
185 * and creates the ip address dbus objects.
186 * @param[in] vlanID- VLAN identifier.
187 */
188 void loadVLAN(VlanId vlanID);
Ratan Gupta92bc2fe2017-07-26 22:40:21 +0530189
Gunnar Mills57d9c502018-09-14 14:42:34 -0500190 /** @brief write the network conf file with the in-memory objects.
191 */
192 void writeConfigurationFile();
Ratan Gupta2b106532017-07-25 16:05:02 +0530193
Gunnar Mills57d9c502018-09-14 14:42:34 -0500194 /** @brief delete all dbus objects.
195 */
196 void deleteAll();
Ratan Guptae9c9b812017-09-22 17:15:37 +0530197
Gunnar Mills57d9c502018-09-14 14:42:34 -0500198 using EthernetInterfaceIntf::dHCPEnabled;
199 using EthernetInterfaceIntf::interfaceName;
200 using MacAddressIntf::mACAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530201
Gunnar Mills57d9c502018-09-14 14:42:34 -0500202 /** @brief Absolute path of the resolv conf file */
203 static constexpr auto resolvConfFile = "/etc/resolv.conf";
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530204
Gunnar Mills57d9c502018-09-14 14:42:34 -0500205 protected:
206 /** @brief get the info of the ethernet interface.
207 * @return tuple having the link speed,autonegotiation,duplexmode .
208 */
209 InterfaceInfo getInterfaceInfo() const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530210
Gunnar Mills57d9c502018-09-14 14:42:34 -0500211 /* @brief delete the vlan interface from system.
212 * @param[in] interface - vlan Interface.
213 */
214 void deleteVLANFromSystem(const std::string& interface);
Ratan Guptae9c9b812017-09-22 17:15:37 +0530215
Gunnar Mills57d9c502018-09-14 14:42:34 -0500216 /** @brief get the mac address of the interface.
217 * @param[in] interfaceName - Network interface name.
218 * @return macaddress on success
219 */
Ratan Gupta8c834932017-04-14 16:30:24 +0530220
Gunnar Mills57d9c502018-09-14 14:42:34 -0500221 std::string getMACAddress(const std::string& interfaceName) const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530222
Gunnar Mills57d9c502018-09-14 14:42:34 -0500223 /** @brief construct the ip address dbus object path.
224 * @param[in] addressType - Type of ip address.
225 * @param[in] ipaddress - IP address.
226 * @param[in] prefixLength - Length of prefix.
227 * @param[in] gateway - Gateway address.
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530228
Gunnar Mills57d9c502018-09-14 14:42:34 -0500229 * @return path of the address object.
230 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530231
Gunnar Mills57d9c502018-09-14 14:42:34 -0500232 std::string generateObjectPath(IP::Protocol addressType,
233 const std::string& ipaddress,
234 uint8_t prefixLength,
235 const std::string& gateway) const;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530236
William A. Kennington III08505792019-01-30 16:00:04 -0800237 std::string
238 generateStaticNeighborObjectPath(const std::string& iPAddress,
239 const std::string& mACAddress) const;
240
Gunnar Mills57d9c502018-09-14 14:42:34 -0500241 /** @brief generates the id by doing hash of ipaddress,
242 * prefixlength and the gateway.
243 * @param[in] ipaddress - IP address.
244 * @param[in] prefixLength - Length of prefix.
245 * @param[in] gateway - Gateway address.
246 * @return hash string.
247 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530248
Gunnar Mills57d9c502018-09-14 14:42:34 -0500249 static std::string generateId(const std::string& ipaddress,
250 uint8_t prefixLength,
251 const std::string& gateway);
Ratan Gupta82549cc2017-04-21 08:45:23 +0530252
William A. Kennington III08505792019-01-30 16:00:04 -0800253 /** @brief generates the id by doing hash of ipaddress
254 * and the mac address.
255 * @param[in] iPAddress - IP address.
256 * @param[in] mACAddress - Gateway address.
257 * @return hash string.
258 */
259 static std::string generateNeighborId(const std::string& iPAddress,
260 const std::string& mACAddress);
261
Gunnar Mills57d9c502018-09-14 14:42:34 -0500262 /** @brief write the dhcp section **/
263 void writeDHCPSection(std::fstream& stream);
Ratan Gupta2b106532017-07-25 16:05:02 +0530264
Gunnar Mills57d9c502018-09-14 14:42:34 -0500265 /** @brief get the NTP server list from the network conf
266 *
267 */
268 ServerList getNTPServersFromConf();
Ratan Gupta497c0c92017-08-22 19:15:59 +0530269
Gunnar Mills57d9c502018-09-14 14:42:34 -0500270 /** @brief write the DNS entries to resolver file.
271 * @param[in] dnsList - DNS server list which needs to be written.
272 * @param[in] file - File to write the name server entries to.
273 */
274 void writeDNSEntries(const ServerList& dnsList, const std::string& file);
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530275
Gunnar Mills57d9c502018-09-14 14:42:34 -0500276 /** @brief get the name server details from the network conf
277 *
278 */
279 ServerList getNameServerFromConf();
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530280
Gunnar Mills57d9c502018-09-14 14:42:34 -0500281 /** @brief Persistent sdbusplus DBus bus connection. */
282 sdbusplus::bus::bus& bus;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530283
Gunnar Mills57d9c502018-09-14 14:42:34 -0500284 /** @brief Network Manager object. */
285 Manager& manager;
Ratan Gupta4f1c18b2017-05-25 12:59:35 +0530286
Gunnar Mills57d9c502018-09-14 14:42:34 -0500287 /** @brief Persistent map of IPAddress dbus objects and their names */
288 AddressMap addrs;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530289
William A. Kennington III08505792019-01-30 16:00:04 -0800290 /** @brief Persistent map of Neighbor dbus objects and their names */
291 NeighborMap staticNeighbors;
292
Gunnar Mills57d9c502018-09-14 14:42:34 -0500293 /** @brief Persistent map of VLAN interface dbus objects and their names */
294 VlanInterfaceMap vlanInterfaces;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530295
Gunnar Mills57d9c502018-09-14 14:42:34 -0500296 /** @brief Dbus object path */
297 std::string objPath;
Ratan Gupta47722dc2017-05-26 18:32:23 +0530298
Gunnar Mills57d9c502018-09-14 14:42:34 -0500299 friend class TestEthernetInterface;
Ratan Gupta8c834932017-04-14 16:30:24 +0530300};
301
302} // namespace network
303} // namespace phosphor