Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 3 | #include "types.hpp" |
Ratan Gupta | 8804feb | 2017-05-25 10:49:57 +0530 | [diff] [blame] | 4 | #include "util.hpp" |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 5 | |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 6 | #include "xyz/openbmc_project/Network/EthernetInterface/server.hpp" |
Ratan Gupta | 1caa230 | 2017-07-10 10:30:13 +0530 | [diff] [blame] | 7 | #include "xyz/openbmc_project/Network/MACAddress/server.hpp" |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 8 | #include "xyz/openbmc_project/Network/IP/Create/server.hpp" |
Ratan Gupta | e9c9b81 | 2017-09-22 17:15:37 +0530 | [diff] [blame] | 9 | #include "xyz/openbmc_project/Collection/DeleteAll/server.hpp" |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 10 | |
| 11 | #include <sdbusplus/bus.hpp> |
| 12 | #include <sdbusplus/server/object.hpp> |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 13 | #include <string> |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 14 | #include <experimental/filesystem> |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 15 | |
| 16 | namespace phosphor |
| 17 | { |
| 18 | namespace network |
| 19 | { |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 20 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 21 | using Ifaces = |
| 22 | sdbusplus::server::object::object< |
| 23 | sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface, |
Ratan Gupta | 1caa230 | 2017-07-10 10:30:13 +0530 | [diff] [blame] | 24 | sdbusplus::xyz::openbmc_project::Network::server::MACAddress, |
Ratan Gupta | e9c9b81 | 2017-09-22 17:15:37 +0530 | [diff] [blame] | 25 | sdbusplus::xyz::openbmc_project::Network::IP::server::Create, |
| 26 | sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 27 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 28 | using IP = sdbusplus::xyz::openbmc_project::Network::server::IP; |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 29 | |
| 30 | using EthernetInterfaceIntf = |
| 31 | sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface; |
Ratan Gupta | bd303b1 | 2017-08-18 17:10:07 +0530 | [diff] [blame] | 32 | using MacAddressIntf = |
| 33 | sdbusplus::xyz::openbmc_project::Network::server::MACAddress; |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 34 | |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 35 | namespace fs = std::experimental::filesystem; |
| 36 | |
Ratan Gupta | 4f1c18b | 2017-05-25 12:59:35 +0530 | [diff] [blame] | 37 | class Manager; // forward declaration of network manager. |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 38 | |
Ratan Gupta | 47722dc | 2017-05-26 18:32:23 +0530 | [diff] [blame] | 39 | class TestEthernetInterface; |
| 40 | |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 41 | class VlanInterface; |
| 42 | |
| 43 | class IPAddress; |
| 44 | |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 45 | using LinkSpeed = uint16_t; |
| 46 | using DuplexMode = uint8_t; |
| 47 | using Autoneg = uint8_t; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 48 | using VlanId = uint32_t; |
| 49 | using InterfaceName = std::string; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 50 | using InterfaceInfo = std::tuple<LinkSpeed, DuplexMode, Autoneg>; |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 51 | using AddressMap = std::map<std::string, std::shared_ptr<IPAddress>>; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 52 | using VlanInterfaceMap = std::map<InterfaceName, std::unique_ptr<VlanInterface>>; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 53 | |
| 54 | /** @class EthernetInterface |
| 55 | * @brief OpenBMC Ethernet Interface implementation. |
| 56 | * @details A concrete implementation for the |
| 57 | * xyz.openbmc_project.Network.EthernetInterface DBus API. |
| 58 | */ |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 59 | class EthernetInterface : public Ifaces |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 60 | { |
| 61 | public: |
| 62 | EthernetInterface() = delete; |
| 63 | EthernetInterface(const EthernetInterface&) = delete; |
| 64 | EthernetInterface& operator=(const EthernetInterface&) = delete; |
| 65 | EthernetInterface(EthernetInterface&&) = delete; |
| 66 | EthernetInterface& operator=(EthernetInterface&&) = delete; |
| 67 | virtual ~EthernetInterface() = default; |
| 68 | |
| 69 | /** @brief Constructor to put object onto bus at a dbus path. |
| 70 | * @param[in] bus - Bus to attach to. |
| 71 | * @param[in] objPath - Path to attach at. |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 72 | * @param[in] dhcpEnabled - is dhcp enabled(true/false). |
Ratan Gupta | 4f1c18b | 2017-05-25 12:59:35 +0530 | [diff] [blame] | 73 | * @param[in] parent - parent object. |
Ratan Gupta | 3d3e4fc | 2017-07-25 13:38:19 +0530 | [diff] [blame] | 74 | * @param[in] emitSignal - true if the object added signal needs to be |
| 75 | * send. |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 76 | */ |
| 77 | EthernetInterface(sdbusplus::bus::bus& bus, |
Ratan Gupta | 91a99cc | 2017-04-14 16:32:09 +0530 | [diff] [blame] | 78 | const std::string& objPath, |
Ratan Gupta | 4f1c18b | 2017-05-25 12:59:35 +0530 | [diff] [blame] | 79 | bool dhcpEnabled, |
Ratan Gupta | 3d3e4fc | 2017-07-25 13:38:19 +0530 | [diff] [blame] | 80 | Manager& parent, |
| 81 | bool emitSignal = true); |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 82 | |
| 83 | /** @brief Function to create ipaddress dbus object. |
| 84 | * @param[in] addressType - Type of ip address. |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 85 | * @param[in] ipaddress- IP address. |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 86 | * @param[in] prefixLength - Length of prefix. |
| 87 | * @param[in] gateway - Gateway ip address. |
| 88 | */ |
| 89 | |
| 90 | void iP(IP::Protocol addressType, |
| 91 | std::string ipaddress, |
| 92 | uint8_t prefixLength, |
| 93 | std::string gateway) override; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 94 | |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 95 | /* @brief delete the dbus object of the given ipaddress. |
| 96 | * @param[in] ipaddress - IP address. |
Ratan Gupta | 2eff84f | 2017-04-20 19:19:15 +0530 | [diff] [blame] | 97 | */ |
Ratan Gupta | 2eff84f | 2017-04-20 19:19:15 +0530 | [diff] [blame] | 98 | void deleteObject(const std::string& ipaddress); |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 99 | |
Ratan Gupta | bc88629 | 2017-07-25 18:29:57 +0530 | [diff] [blame] | 100 | /* @brief delete the vlan dbus object of the given interface. |
| 101 | * Also deletes the device file and the network file. |
| 102 | * @param[in] interface - VLAN Interface. |
| 103 | */ |
| 104 | void deleteVLANObject(const std::string& interface); |
| 105 | |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 106 | /* @brief creates the dbus object(IPaddres) given in the address list. |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 107 | * @param[in] addrs - address list for which dbus objects needs |
| 108 | * to create. |
| 109 | */ |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 110 | void createIPAddressObjects(); |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 111 | |
| 112 | /* @brief Gets all the ip addresses. |
| 113 | * @returns the list of ipaddress. |
| 114 | */ |
| 115 | const AddressMap& getAddresses() const { return addrs; } |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 116 | |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 117 | /** Set value of DHCPEnabled */ |
| 118 | bool dHCPEnabled(bool value) override; |
| 119 | |
Ratan Gupta | bd303b1 | 2017-08-18 17:10:07 +0530 | [diff] [blame] | 120 | /** @brief sets the MAC address. |
| 121 | * @param[in] value - MAC address which needs to be set on the system. |
| 122 | * @returns macAddress of the interface. |
| 123 | */ |
| 124 | std::string mACAddress(std::string value) override; |
| 125 | |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 126 | /** @brief create Vlan interface. |
| 127 | * @param[in] id- VLAN identifier. |
| 128 | */ |
| 129 | void createVLAN(VlanId id); |
| 130 | |
Ratan Gupta | 92bc2fe | 2017-07-26 22:40:21 +0530 | [diff] [blame] | 131 | /** @brief load the vlan info from the system |
| 132 | * and creates the ip address dbus objects. |
| 133 | * @param[in] vlanID- VLAN identifier. |
| 134 | */ |
| 135 | void loadVLAN(VlanId vlanID); |
| 136 | |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 137 | /** @brief write the network conf file with the in-memory objects. |
| 138 | */ |
| 139 | void writeConfigurationFile(); |
| 140 | |
Ratan Gupta | e9c9b81 | 2017-09-22 17:15:37 +0530 | [diff] [blame] | 141 | /** @brief delete all dbus objects. |
| 142 | */ |
| 143 | void deleteAll(); |
| 144 | |
Ratan Gupta | 87c1398 | 2017-06-15 09:27:27 +0530 | [diff] [blame] | 145 | using EthernetInterfaceIntf::dHCPEnabled; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 146 | using EthernetInterfaceIntf::interfaceName; |
Ratan Gupta | bd303b1 | 2017-08-18 17:10:07 +0530 | [diff] [blame] | 147 | using MacAddressIntf::mACAddress; |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 148 | |
Ratan Gupta | 3d3e4fc | 2017-07-25 13:38:19 +0530 | [diff] [blame] | 149 | protected: |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 150 | /** @brief get the info of the ethernet interface. |
| 151 | * @return tuple having the link speed,autonegotiation,duplexmode . |
| 152 | */ |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 153 | InterfaceInfo getInterfaceInfo() const; |
| 154 | |
Ratan Gupta | e9c9b81 | 2017-09-22 17:15:37 +0530 | [diff] [blame] | 155 | /* @brief delete the vlan interface from system. |
| 156 | * @param[in] interface - vlan Interface. |
| 157 | */ |
| 158 | void deleteVLANFromSystem(const std::string& interface); |
| 159 | |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 160 | /** @brief get the mac address of the interface. |
Ratan Gupta | da7d3af | 2017-08-13 17:49:56 +0530 | [diff] [blame] | 161 | * @param[in] interfaceName - Network interface name. |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 162 | * @return macaddress on success |
| 163 | */ |
| 164 | |
Ratan Gupta | da7d3af | 2017-08-13 17:49:56 +0530 | [diff] [blame] | 165 | std::string getMACAddress(const std::string& interfaceName) const; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 166 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 167 | /** @brief construct the ip address dbus object path. |
| 168 | * @param[in] addressType - Type of ip address. |
Ratan Gupta | 65e5abe | 2017-05-23 13:20:44 +0530 | [diff] [blame] | 169 | * @param[in] ipaddress - IP address. |
| 170 | * @param[in] prefixLength - Length of prefix. |
| 171 | * @param[in] gateway - Gateway addess. |
| 172 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 173 | * @return path of the address object. |
| 174 | */ |
| 175 | |
Ratan Gupta | 65e5abe | 2017-05-23 13:20:44 +0530 | [diff] [blame] | 176 | std::string generateObjectPath(IP::Protocol addressType, |
| 177 | const std::string& ipaddress, |
| 178 | uint8_t prefixLength, |
| 179 | const std::string& gateway) const; |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 180 | |
Ratan Gupta | 65e5abe | 2017-05-23 13:20:44 +0530 | [diff] [blame] | 181 | /** @brief generates the id by doing hash of ipaddress, |
| 182 | * prefixlength and the gateway. |
| 183 | * @param[in] ipaddress - IP address. |
| 184 | * @param[in] prefixLength - Length of prefix. |
| 185 | * @param[in] gateway - Gateway addess. |
| 186 | * @return hash string. |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 187 | */ |
| 188 | |
Ratan Gupta | 65e5abe | 2017-05-23 13:20:44 +0530 | [diff] [blame] | 189 | static std::string generateId(const std::string& ipaddress, |
| 190 | uint8_t prefixLength, |
| 191 | const std::string& gateway); |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 192 | |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 193 | /** @brief write the dhcp section **/ |
| 194 | void writeDHCPSection(std::fstream& stream);; |
| 195 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 196 | /** @brief Persistent sdbusplus DBus bus connection. */ |
| 197 | sdbusplus::bus::bus& bus; |
| 198 | |
Ratan Gupta | 4f1c18b | 2017-05-25 12:59:35 +0530 | [diff] [blame] | 199 | /** @brief Network Manager object. */ |
| 200 | Manager& manager; |
| 201 | |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 202 | /** @brief Persistent map of IPAddress dbus objects and their names */ |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 203 | AddressMap addrs; |
Ratan Gupta | 82549cc | 2017-04-21 08:45:23 +0530 | [diff] [blame] | 204 | |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 205 | /** @brief Persistent map of VLAN interface dbus objects and their names */ |
| 206 | VlanInterfaceMap vlanInterfaces; |
| 207 | |
Ratan Gupta | 47722dc | 2017-05-26 18:32:23 +0530 | [diff] [blame] | 208 | /** @brief Dbus object path */ |
| 209 | std::string objPath; |
| 210 | |
| 211 | friend class TestEthernetInterface; |
Ratan Gupta | 8c83493 | 2017-04-14 16:30:24 +0530 | [diff] [blame] | 212 | }; |
| 213 | |
| 214 | } // namespace network |
| 215 | } // namespace phosphor |