blob: 5c088bdf57f474872fd69b5e18431617c7a3cb02 [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
Ratan Gupta8c834932017-04-14 16:30:24 +05306#include "xyz/openbmc_project/Network/EthernetInterface/server.hpp"
Ratan Gupta1caa2302017-07-10 10:30:13 +05307#include "xyz/openbmc_project/Network/MACAddress/server.hpp"
Ratan Gupta82549cc2017-04-21 08:45:23 +05308#include "xyz/openbmc_project/Network/IP/Create/server.hpp"
Ratan Guptae9c9b812017-09-22 17:15:37 +05309#include "xyz/openbmc_project/Collection/DeleteAll/server.hpp"
Ratan Gupta8c834932017-04-14 16:30:24 +053010
11#include <sdbusplus/bus.hpp>
12#include <sdbusplus/server/object.hpp>
Ratan Gupta8c834932017-04-14 16:30:24 +053013#include <string>
Ratan Gupta5978dd12017-07-25 13:47:13 +053014#include <experimental/filesystem>
Ratan Gupta8c834932017-04-14 16:30:24 +053015
16namespace phosphor
17{
18namespace network
19{
Ratan Gupta8c834932017-04-14 16:30:24 +053020
Ratan Gupta82549cc2017-04-21 08:45:23 +053021using Ifaces =
22 sdbusplus::server::object::object<
23 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface,
Ratan Gupta1caa2302017-07-10 10:30:13 +053024 sdbusplus::xyz::openbmc_project::Network::server::MACAddress,
Ratan Guptae9c9b812017-09-22 17:15:37 +053025 sdbusplus::xyz::openbmc_project::Network::IP::server::Create,
26 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>;
36
Ratan Gupta5978dd12017-07-25 13:47:13 +053037namespace fs = std::experimental::filesystem;
38
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053039class Manager; // forward declaration of network manager.
Ratan Gupta8c834932017-04-14 16:30:24 +053040
Ratan Gupta47722dc2017-05-26 18:32:23 +053041class TestEthernetInterface;
42
Ratan Gupta5978dd12017-07-25 13:47:13 +053043class VlanInterface;
44
45class IPAddress;
46
Ratan Gupta8c834932017-04-14 16:30:24 +053047using LinkSpeed = uint16_t;
48using DuplexMode = uint8_t;
49using Autoneg = uint8_t;
Ratan Gupta5978dd12017-07-25 13:47:13 +053050using VlanId = uint32_t;
51using InterfaceName = std::string;
Ratan Gupta8c834932017-04-14 16:30:24 +053052using InterfaceInfo = std::tuple<LinkSpeed, DuplexMode, Autoneg>;
Ratan Gupta29b0e432017-05-25 12:51:40 +053053using AddressMap = std::map<std::string, std::shared_ptr<IPAddress>>;
Ratan Gupta5978dd12017-07-25 13:47:13 +053054using VlanInterfaceMap = std::map<InterfaceName, std::unique_ptr<VlanInterface>>;
Ratan Gupta8c834932017-04-14 16:30:24 +053055
56/** @class EthernetInterface
57 * @brief OpenBMC Ethernet Interface implementation.
58 * @details A concrete implementation for the
59 * xyz.openbmc_project.Network.EthernetInterface DBus API.
60 */
Ratan Gupta82549cc2017-04-21 08:45:23 +053061class EthernetInterface : public Ifaces
Ratan Gupta8c834932017-04-14 16:30:24 +053062{
63 public:
64 EthernetInterface() = delete;
65 EthernetInterface(const EthernetInterface&) = delete;
66 EthernetInterface& operator=(const EthernetInterface&) = delete;
67 EthernetInterface(EthernetInterface&&) = delete;
68 EthernetInterface& operator=(EthernetInterface&&) = delete;
69 virtual ~EthernetInterface() = default;
70
71 /** @brief Constructor to put object onto bus at a dbus path.
72 * @param[in] bus - Bus to attach to.
73 * @param[in] objPath - Path to attach at.
Ratan Gupta8c834932017-04-14 16:30:24 +053074 * @param[in] dhcpEnabled - is dhcp enabled(true/false).
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053075 * @param[in] parent - parent object.
Ratan Gupta3d3e4fc2017-07-25 13:38:19 +053076 * @param[in] emitSignal - true if the object added signal needs to be
77 * send.
Ratan Gupta8c834932017-04-14 16:30:24 +053078 */
79 EthernetInterface(sdbusplus::bus::bus& bus,
Ratan Gupta91a99cc2017-04-14 16:32:09 +053080 const std::string& objPath,
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053081 bool dhcpEnabled,
Ratan Gupta3d3e4fc2017-07-25 13:38:19 +053082 Manager& parent,
83 bool emitSignal = true);
Ratan Gupta82549cc2017-04-21 08:45:23 +053084
85 /** @brief Function to create ipaddress dbus object.
86 * @param[in] addressType - Type of ip address.
Ratan Gupta29b0e432017-05-25 12:51:40 +053087 * @param[in] ipaddress- IP address.
Ratan Gupta82549cc2017-04-21 08:45:23 +053088 * @param[in] prefixLength - Length of prefix.
89 * @param[in] gateway - Gateway ip address.
90 */
91
92 void iP(IP::Protocol addressType,
93 std::string ipaddress,
94 uint8_t prefixLength,
95 std::string gateway) override;
Ratan Gupta8c834932017-04-14 16:30:24 +053096
Ratan Gupta29b0e432017-05-25 12:51:40 +053097 /* @brief delete the dbus object of the given ipaddress.
98 * @param[in] ipaddress - IP address.
Ratan Gupta2eff84f2017-04-20 19:19:15 +053099 */
Ratan Gupta2eff84f2017-04-20 19:19:15 +0530100 void deleteObject(const std::string& ipaddress);
Ratan Gupta8c834932017-04-14 16:30:24 +0530101
Ratan Guptabc886292017-07-25 18:29:57 +0530102 /* @brief delete the vlan dbus object of the given interface.
103 * Also deletes the device file and the network file.
104 * @param[in] interface - VLAN Interface.
105 */
106 void deleteVLANObject(const std::string& interface);
107
Ratan Gupta87c13982017-06-15 09:27:27 +0530108 /* @brief creates the dbus object(IPaddres) given in the address list.
Ratan Gupta29b0e432017-05-25 12:51:40 +0530109 * @param[in] addrs - address list for which dbus objects needs
110 * to create.
111 */
Ratan Gupta87c13982017-06-15 09:27:27 +0530112 void createIPAddressObjects();
Ratan Gupta29b0e432017-05-25 12:51:40 +0530113
114 /* @brief Gets all the ip addresses.
115 * @returns the list of ipaddress.
116 */
117 const AddressMap& getAddresses() const { return addrs; }
Ratan Gupta8c834932017-04-14 16:30:24 +0530118
Ratan Gupta87c13982017-06-15 09:27:27 +0530119 /** Set value of DHCPEnabled */
120 bool dHCPEnabled(bool value) override;
121
Ratan Guptabd303b12017-08-18 17:10:07 +0530122 /** @brief sets the MAC address.
123 * @param[in] value - MAC address which needs to be set on the system.
124 * @returns macAddress of the interface.
125 */
126 std::string mACAddress(std::string value) override;
127
Ratan Gupta497c0c92017-08-22 19:15:59 +0530128 /** @brief sets the NTP servers.
129 * @param[in] value - vector of NTP servers.
130 */
131 ServerList nTPServers(ServerList value) override;
132
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530133 /** @brief sets the DNS/nameservers.
134 * @param[in] value - vector of DNS servers.
135 */
136 ServerList nameservers(ServerList value) override;
137
Ratan Gupta5978dd12017-07-25 13:47:13 +0530138 /** @brief create Vlan interface.
139 * @param[in] id- VLAN identifier.
140 */
141 void createVLAN(VlanId id);
142
Ratan Gupta92bc2fe2017-07-26 22:40:21 +0530143 /** @brief load the vlan info from the system
144 * and creates the ip address dbus objects.
145 * @param[in] vlanID- VLAN identifier.
146 */
147 void loadVLAN(VlanId vlanID);
148
Ratan Gupta2b106532017-07-25 16:05:02 +0530149 /** @brief write the network conf file with the in-memory objects.
150 */
151 void writeConfigurationFile();
152
Ratan Guptae9c9b812017-09-22 17:15:37 +0530153 /** @brief delete all dbus objects.
154 */
155 void deleteAll();
156
Ratan Gupta87c13982017-06-15 09:27:27 +0530157 using EthernetInterfaceIntf::dHCPEnabled;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530158 using EthernetInterfaceIntf::interfaceName;
Ratan Guptabd303b12017-08-18 17:10:07 +0530159 using MacAddressIntf::mACAddress;
Ratan Gupta5978dd12017-07-25 13:47:13 +0530160
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530161 /** @brief Absolute path of the resolv conf file */
162 static constexpr auto resolvConfFile = "/etc/resolv.conf";
163
Ratan Gupta3d3e4fc2017-07-25 13:38:19 +0530164 protected:
Ratan Gupta8c834932017-04-14 16:30:24 +0530165 /** @brief get the info of the ethernet interface.
166 * @return tuple having the link speed,autonegotiation,duplexmode .
167 */
Ratan Gupta8c834932017-04-14 16:30:24 +0530168 InterfaceInfo getInterfaceInfo() const;
169
Ratan Guptae9c9b812017-09-22 17:15:37 +0530170 /* @brief delete the vlan interface from system.
171 * @param[in] interface - vlan Interface.
172 */
173 void deleteVLANFromSystem(const std::string& interface);
174
Ratan Gupta8c834932017-04-14 16:30:24 +0530175 /** @brief get the mac address of the interface.
Ratan Guptada7d3af2017-08-13 17:49:56 +0530176 * @param[in] interfaceName - Network interface name.
Ratan Gupta8c834932017-04-14 16:30:24 +0530177 * @return macaddress on success
178 */
179
Ratan Guptada7d3af2017-08-13 17:49:56 +0530180 std::string getMACAddress(const std::string& interfaceName) const;
Ratan Gupta8c834932017-04-14 16:30:24 +0530181
Ratan Gupta82549cc2017-04-21 08:45:23 +0530182 /** @brief construct the ip address dbus object path.
183 * @param[in] addressType - Type of ip address.
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530184 * @param[in] ipaddress - IP address.
185 * @param[in] prefixLength - Length of prefix.
186 * @param[in] gateway - Gateway addess.
187
Ratan Gupta82549cc2017-04-21 08:45:23 +0530188 * @return path of the address object.
189 */
190
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530191 std::string generateObjectPath(IP::Protocol addressType,
192 const std::string& ipaddress,
193 uint8_t prefixLength,
194 const std::string& gateway) const;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530195
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530196 /** @brief generates the id by doing hash of ipaddress,
197 * prefixlength and the gateway.
198 * @param[in] ipaddress - IP address.
199 * @param[in] prefixLength - Length of prefix.
200 * @param[in] gateway - Gateway addess.
201 * @return hash string.
Ratan Gupta82549cc2017-04-21 08:45:23 +0530202 */
203
Ratan Gupta65e5abe2017-05-23 13:20:44 +0530204 static std::string generateId(const std::string& ipaddress,
205 uint8_t prefixLength,
206 const std::string& gateway);
Ratan Gupta82549cc2017-04-21 08:45:23 +0530207
Ratan Gupta2b106532017-07-25 16:05:02 +0530208 /** @brief write the dhcp section **/
209 void writeDHCPSection(std::fstream& stream);;
210
Ratan Gupta497c0c92017-08-22 19:15:59 +0530211 /** @brief get the NTP server list from the network conf
212 *
213 */
214 ServerList getNTPServersFromConf();
215
Ratan Gupta6dec390f2017-08-20 15:28:12 +0530216 /** @brief write the DNS entries to resolver file.
217 * @param[in] dnsList - DNS server list which needs to be written.
218 * @param[in] file - File to write the name server entries to.
219 */
220 void writeDNSEntries(const ServerList& dnsList,
221 const std::string& file);
222
223 /** @brief get the name server details from the network conf
224 *
225 */
226 ServerList getNameServerFromConf();
227
Ratan Gupta82549cc2017-04-21 08:45:23 +0530228 /** @brief Persistent sdbusplus DBus bus connection. */
229 sdbusplus::bus::bus& bus;
230
Ratan Gupta4f1c18b2017-05-25 12:59:35 +0530231 /** @brief Network Manager object. */
232 Manager& manager;
233
Ratan Gupta82549cc2017-04-21 08:45:23 +0530234 /** @brief Persistent map of IPAddress dbus objects and their names */
Ratan Gupta29b0e432017-05-25 12:51:40 +0530235 AddressMap addrs;
Ratan Gupta82549cc2017-04-21 08:45:23 +0530236
Ratan Gupta5978dd12017-07-25 13:47:13 +0530237 /** @brief Persistent map of VLAN interface dbus objects and their names */
238 VlanInterfaceMap vlanInterfaces;
239
Ratan Gupta47722dc2017-05-26 18:32:23 +0530240 /** @brief Dbus object path */
241 std::string objPath;
242
243 friend class TestEthernetInterface;
Ratan Gupta8c834932017-04-14 16:30:24 +0530244};
245
246} // namespace network
247} // namespace phosphor