blob: 5551950e14ace9ba8d06be6eeeca92bf6a4550ec [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
Gunnar Mills57d9c502018-09-14 14:42:34 -0500130 /* @brief Gets all the ip addresses.
131 * @returns the list of ipaddress.
132 */
133 const AddressMap& getAddresses() const
134 {
135 return addrs;
136 }
Ratan Gupta8c834932017-04-14 16:30:24 +0530137
William A. Kennington III08505792019-01-30 16:00:04 -0800138 /* @brief Gets all the static neighbor entries.
139 * @returns Static neighbor map.
140 */
141 const NeighborMap& getStaticNeighbors() const
142 {
143 return staticNeighbors;
144 }
145
Gunnar Mills57d9c502018-09-14 14:42:34 -0500146 /** Set value of DHCPEnabled */
147 bool dHCPEnabled(bool value) override;
Ratan Gupta87c13982017-06-15 09:27:27 +0530148
Gunnar Mills57d9c502018-09-14 14:42:34 -0500149 /** @brief sets the MAC address.
150 * @param[in] value - MAC address which needs to be set on the system.
151 * @returns macAddress of the interface or throws an error.
152 */
153 std::string mACAddress(std::string value) override;
Ratan Guptabd303b12017-08-18 17:10:07 +0530154
Gunnar Mills57d9c502018-09-14 14:42:34 -0500155 /** @brief sets the NTP servers.
156 * @param[in] value - vector of NTP servers.
157 */
158 ServerList nTPServers(ServerList value) override;
Ratan Gupta497c0c92017-08-22 19:15:59 +0530159
Gunnar Mills57d9c502018-09-14 14:42:34 -0500160 /** @brief sets the DNS/nameservers.
161 * @param[in] value - vector of DNS servers.
162 */
163 ServerList nameservers(ServerList value) override;
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530164
Gunnar Mills57d9c502018-09-14 14:42:34 -0500165 /** @brief create Vlan interface.
166 * @param[in] id- VLAN identifier.
167 */
William A. Kennington IIIf4b4ff82019-04-09 19:06:52 -0700168 ObjectPath createVLAN(VlanId id);
Ratan Gupta5978dd12017-07-25 13:47:13 +0530169
Gunnar Mills57d9c502018-09-14 14:42:34 -0500170 /** @brief load the vlan info from the system
171 * and creates the ip address dbus objects.
172 * @param[in] vlanID- VLAN identifier.
173 */
174 void loadVLAN(VlanId vlanID);
Ratan Gupta92bc2fe2017-07-26 22:40:21 +0530175
Gunnar Mills57d9c502018-09-14 14:42:34 -0500176 /** @brief write the network conf file with the in-memory objects.
177 */
178 void writeConfigurationFile();
Ratan Gupta2b106532017-07-25 16:05:02 +0530179
Gunnar Mills57d9c502018-09-14 14:42:34 -0500180 /** @brief delete all dbus objects.
181 */
182 void deleteAll();
Ratan Guptae9c9b812017-09-22 17:15:37 +0530183
Gunnar Mills57d9c502018-09-14 14:42:34 -0500184 using EthernetInterfaceIntf::dHCPEnabled;
185 using EthernetInterfaceIntf::interfaceName;
186 using MacAddressIntf::mACAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530187
Gunnar Mills57d9c502018-09-14 14:42:34 -0500188 /** @brief Absolute path of the resolv conf file */
189 static constexpr auto resolvConfFile = "/etc/resolv.conf";
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530190
Gunnar Mills57d9c502018-09-14 14:42:34 -0500191 protected:
192 /** @brief get the info of the ethernet interface.
193 * @return tuple having the link speed,autonegotiation,duplexmode .
194 */
195 InterfaceInfo getInterfaceInfo() const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530196
Gunnar Mills57d9c502018-09-14 14:42:34 -0500197 /* @brief delete the vlan interface from system.
198 * @param[in] interface - vlan Interface.
199 */
200 void deleteVLANFromSystem(const std::string& interface);
Ratan Guptae9c9b812017-09-22 17:15:37 +0530201
Gunnar Mills57d9c502018-09-14 14:42:34 -0500202 /** @brief get the mac address of the interface.
203 * @param[in] interfaceName - Network interface name.
204 * @return macaddress on success
205 */
Ratan Gupta8c834932017-04-14 16:30:24 +0530206
Gunnar Mills57d9c502018-09-14 14:42:34 -0500207 std::string getMACAddress(const std::string& interfaceName) const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530208
Gunnar Mills57d9c502018-09-14 14:42:34 -0500209 /** @brief construct the ip address dbus object path.
210 * @param[in] addressType - Type of ip address.
211 * @param[in] ipaddress - IP address.
212 * @param[in] prefixLength - Length of prefix.
213 * @param[in] gateway - Gateway address.
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530214
Gunnar Mills57d9c502018-09-14 14:42:34 -0500215 * @return path of the address object.
216 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530217
Gunnar Mills57d9c502018-09-14 14:42:34 -0500218 std::string generateObjectPath(IP::Protocol addressType,
219 const std::string& ipaddress,
220 uint8_t prefixLength,
221 const std::string& gateway) const;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530222
William A. Kennington III08505792019-01-30 16:00:04 -0800223 std::string
224 generateStaticNeighborObjectPath(const std::string& iPAddress,
225 const std::string& mACAddress) const;
226
Gunnar Mills57d9c502018-09-14 14:42:34 -0500227 /** @brief generates the id by doing hash of ipaddress,
228 * prefixlength and the gateway.
229 * @param[in] ipaddress - IP address.
230 * @param[in] prefixLength - Length of prefix.
231 * @param[in] gateway - Gateway address.
232 * @return hash string.
233 */
Ratan Gupta82549cc2017-04-21 08:45:23 +0530234
Gunnar Mills57d9c502018-09-14 14:42:34 -0500235 static std::string generateId(const std::string& ipaddress,
236 uint8_t prefixLength,
237 const std::string& gateway);
Ratan Gupta82549cc2017-04-21 08:45:23 +0530238
William A. Kennington III08505792019-01-30 16:00:04 -0800239 /** @brief generates the id by doing hash of ipaddress
240 * and the mac address.
241 * @param[in] iPAddress - IP address.
242 * @param[in] mACAddress - Gateway address.
243 * @return hash string.
244 */
245 static std::string generateNeighborId(const std::string& iPAddress,
246 const std::string& mACAddress);
247
Gunnar Mills57d9c502018-09-14 14:42:34 -0500248 /** @brief write the dhcp section **/
249 void writeDHCPSection(std::fstream& stream);
Ratan Gupta2b106532017-07-25 16:05:02 +0530250
Gunnar Mills57d9c502018-09-14 14:42:34 -0500251 /** @brief get the NTP server list from the network conf
252 *
253 */
254 ServerList getNTPServersFromConf();
Ratan Gupta497c0c92017-08-22 19:15:59 +0530255
Gunnar Mills57d9c502018-09-14 14:42:34 -0500256 /** @brief write the DNS entries to resolver file.
257 * @param[in] dnsList - DNS server list which needs to be written.
258 * @param[in] file - File to write the name server entries to.
259 */
260 void writeDNSEntries(const ServerList& dnsList, const std::string& file);
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530261
Gunnar Mills57d9c502018-09-14 14:42:34 -0500262 /** @brief get the name server details from the network conf
263 *
264 */
265 ServerList getNameServerFromConf();
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530266
Gunnar Mills57d9c502018-09-14 14:42:34 -0500267 /** @brief Persistent sdbusplus DBus bus connection. */
268 sdbusplus::bus::bus& bus;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530269
Gunnar Mills57d9c502018-09-14 14:42:34 -0500270 /** @brief Network Manager object. */
271 Manager& manager;
Ratan Gupta4f1c18b2017-05-25 12:59:35 +0530272
Gunnar Mills57d9c502018-09-14 14:42:34 -0500273 /** @brief Persistent map of IPAddress dbus objects and their names */
274 AddressMap addrs;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530275
William A. Kennington III08505792019-01-30 16:00:04 -0800276 /** @brief Persistent map of Neighbor dbus objects and their names */
277 NeighborMap staticNeighbors;
278
Gunnar Mills57d9c502018-09-14 14:42:34 -0500279 /** @brief Persistent map of VLAN interface dbus objects and their names */
280 VlanInterfaceMap vlanInterfaces;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530281
Gunnar Mills57d9c502018-09-14 14:42:34 -0500282 /** @brief Dbus object path */
283 std::string objPath;
Ratan Gupta47722dc2017-05-26 18:32:23 +0530284
Gunnar Mills57d9c502018-09-14 14:42:34 -0500285 friend class TestEthernetInterface;
Ratan Gupta8c834932017-04-14 16:30:24 +0530286};
287
288} // namespace network
289} // namespace phosphor