xref: /openbmc/phosphor-networkd/src/ethernet_interface.hpp (revision 59e5b91d9784274d1d99b4c10e939c38606efacc)
1 #pragma once
2 #include "ipaddress.hpp"
3 #include "neighbor.hpp"
4 #include "types.hpp"
5 #include "xyz/openbmc_project/Network/IP/Create/server.hpp"
6 #include "xyz/openbmc_project/Network/Neighbor/CreateStatic/server.hpp"
7 
8 #include <optional>
9 #include <sdbusplus/bus.hpp>
10 #include <sdbusplus/server/object.hpp>
11 #include <stdplus/zstring_view.hpp>
12 #include <string>
13 #include <vector>
14 #include <xyz/openbmc_project/Collection/DeleteAll/server.hpp>
15 #include <xyz/openbmc_project/Network/EthernetInterface/server.hpp>
16 #include <xyz/openbmc_project/Network/MACAddress/server.hpp>
17 #include <xyz/openbmc_project/Network/VLAN/server.hpp>
18 #include <xyz/openbmc_project/Object/Delete/server.hpp>
19 
20 namespace phosphor
21 {
22 namespace network
23 {
24 
25 using Ifaces = sdbusplus::server::object_t<
26     sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface,
27     sdbusplus::xyz::openbmc_project::Network::server::MACAddress,
28     sdbusplus::xyz::openbmc_project::Network::IP::server::Create,
29     sdbusplus::xyz::openbmc_project::Network::Neighbor::server::CreateStatic,
30     sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
31 
32 using VlanIfaces = sdbusplus::server::object_t<
33     sdbusplus::xyz::openbmc_project::Object::server::Delete,
34     sdbusplus::xyz::openbmc_project::Network::server::VLAN>;
35 
36 using VlanIntf = sdbusplus::xyz::openbmc_project::Network::server::VLAN;
37 
38 using IP = sdbusplus::xyz::openbmc_project::Network::server::IP;
39 
40 using EthernetInterfaceIntf =
41     sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface;
42 using MacAddressIntf =
43     sdbusplus::xyz::openbmc_project::Network::server::MACAddress;
44 
45 using ServerList = std::vector<std::string>;
46 using ObjectPath = sdbusplus::message::object_path;
47 
48 class Manager;
49 
50 class TestEthernetInterface;
51 class TestNetworkManager;
52 
53 namespace config
54 {
55 class Parser;
56 }
57 namespace system
58 {
59 struct InterfaceInfo;
60 };
61 
62 /** @class EthernetInterface
63  *  @brief OpenBMC Ethernet Interface implementation.
64  *  @details A concrete implementation for the
65  *  xyz.openbmc_project.Network.EthernetInterface DBus API.
66  */
67 class EthernetInterface : public Ifaces
68 {
69   public:
70     EthernetInterface() = delete;
71     EthernetInterface(const EthernetInterface&) = delete;
72     EthernetInterface& operator=(const EthernetInterface&) = delete;
73     EthernetInterface(EthernetInterface&&) = delete;
74     EthernetInterface& operator=(EthernetInterface&&) = delete;
75     virtual ~EthernetInterface() = default;
76 
77     /** @brief Constructor to put object onto bus at a dbus path.
78      *  @param[in] bus - Bus to attach to.
79      *  @param[in] manager - parent object.
80      *  @param[in] info - Interface information.
81      *  @param[in] objRoot - Path to attach at.
82      *  @param[in] config - The parsed configuation file.
83      *  @param[in] vlan - The id of the vlan if configured
84      *  @param[in] emitSignal - true if the object added signal needs to be
85      *                          send.
86      *  @param[in] enabled - Override the lookup of nicEnabled
87      */
88     EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
89                       const system::InterfaceInfo& info,
90                       std::string_view objRoot, const config::Parser& config,
91                       bool emitSignal = true,
92                       std::optional<bool> enabled = std::nullopt);
93 
94     /** @brief Network Manager object. */
95     Manager& manager;
96 
97     /** @brief Persistent map of IPAddress dbus objects and their names */
98     std::unordered_map<IfAddr, std::unique_ptr<IPAddress>> addrs;
99 
100     /** @brief Updates the interface information based on new InterfaceInfo */
101     void updateInfo(const system::InterfaceInfo& info);
102 
103     /** @brief Function used to load the ntpservers
104      */
105     void loadNTPServers(const config::Parser& config);
106 
107     /** @brief Function used to load the nameservers.
108      */
109     void loadNameServers(const config::Parser& config);
110 
111     /** @brief Function to create ipAddress dbus object.
112      *  @param[in] addressType - Type of ip address.
113      *  @param[in] ipAddress- IP address.
114      *  @param[in] prefixLength - Length of prefix.
115      */
116 
117     ObjectPath ip(IP::Protocol addressType, std::string ipAddress,
118                   uint8_t prefixLength, std::string) override;
119 
120     /** @brief Function to create static neighbor dbus object.
121      *  @param[in] ipAddress - IP address.
122      *  @param[in] macAddress - Low level MAC address.
123      */
124     ObjectPath neighbor(std::string ipAddress, std::string macAddress) override;
125 
126     /* @brief delete the dbus object of the given ipAddress.
127      * @param[in] ipAddress - IP address.
128      */
129     void deleteStaticNeighborObject(std::string_view ipAddress);
130 
131     /* @brief creates the dbus object(IPaddres) given in the address list.
132      * @param[in] addrs - address list for which dbus objects needs
133      *                    to create.
134      */
135     void createIPAddressObjects();
136 
137     /* @brief creates the dbus object(Neighbor) given in the neighbor list.
138      */
139     void createStaticNeighborObjects();
140 
141     /* @brief Gets all the static neighbor entries.
142      * @returns Static neighbor map.
143      */
144     inline const auto& getStaticNeighbors() const
145     {
146         return staticNeighbors;
147     }
148 
149     /** Set value of DHCPEnabled */
150     DHCPConf dhcpEnabled() const override;
151     DHCPConf dhcpEnabled(DHCPConf value) override;
152     using EthernetInterfaceIntf::dhcp4;
153     bool dhcp4(bool value) override;
154     using EthernetInterfaceIntf::dhcp6;
155     bool dhcp6(bool value) override;
156 
157     inline bool dhcpIsEnabled(in_addr) const
158     {
159         return dhcp4();
160     }
161     inline bool dhcpIsEnabled(in6_addr) const
162     {
163         return dhcp6();
164     }
165     inline bool dhcpIsEnabled(InAddrAny addr) const
166     {
167         return std::visit([&](auto v) { return dhcpIsEnabled(v); }, addr);
168     }
169 
170     /** Retrieve Link State */
171     bool linkUp() const override;
172 
173     /** Retrieve MTU Size */
174     size_t mtu() const override;
175 
176     /** Set size of MTU */
177     size_t mtu(size_t value) override;
178 
179     /** Set value of NICEnabled */
180     bool nicEnabled(bool value) override;
181 
182     /** @brief sets the MAC address.
183      *  @param[in] value - MAC address which needs to be set on the system.
184      *  @returns macAddress of the interface or throws an error.
185      */
186     std::string macAddress(std::string value) override;
187 
188     /** @brief check conf file for Router Advertisements
189      *
190      */
191     bool ipv6AcceptRA(bool value) override;
192     using EthernetInterfaceIntf::ipv6AcceptRA;
193 
194     /** @brief sets the NTP servers.
195      *  @param[in] value - vector of NTP servers.
196      */
197     ServerList ntpServers(ServerList value) override;
198 
199     /** @brief sets the static NTP servers.
200      *  @param[in] value - vector of NTP servers.
201      */
202     ServerList staticNTPServers(ServerList value) override;
203 
204     /** @brief sets the Static DNS/nameservers.
205      *  @param[in] value - vector of DNS servers.
206      */
207 
208     ServerList staticNameServers(ServerList value) override;
209 
210     /** @brief create Vlan interface.
211      *  @param[in] id- VLAN identifier.
212      */
213     ObjectPath createVLAN(uint16_t id);
214 
215     /** @brief write the network conf file with the in-memory objects.
216      */
217     void writeConfigurationFile();
218 
219     /** @brief delete all dbus objects.
220      */
221     void deleteAll();
222 
223     /** @brief set the default v4 gateway of the interface.
224      *  @param[in] gateway - default v4 gateway of the interface.
225      */
226     std::string defaultGateway(std::string gateway) override;
227 
228     /** @brief set the default v6 gateway of the interface.
229      *  @param[in] gateway - default v6 gateway of the interface.
230      */
231     std::string defaultGateway6(std::string gateway) override;
232 
233     using EthernetInterfaceIntf::interfaceName;
234     using EthernetInterfaceIntf::linkUp;
235     using EthernetInterfaceIntf::mtu;
236     using EthernetInterfaceIntf::nicEnabled;
237     using MacAddressIntf::macAddress;
238 
239     using EthernetInterfaceIntf::defaultGateway;
240     using EthernetInterfaceIntf::defaultGateway6;
241 
242   protected:
243     /** @brief construct the ip address dbus object path.
244      *  @param[in] addressType - Type of ip address.
245      *  @param[in] ipAddress - IP address.
246      *  @param[in] prefixLength - Length of prefix.
247      *  @param[in] origin - The origin entry of the IP::Address
248 
249      *  @return path of the address object.
250      */
251     std::string generateObjectPath(IP::Protocol addressType,
252                                    std::string_view ipAddress,
253                                    uint8_t prefixLength,
254                                    IP::AddressOrigin origin) const;
255 
256     std::string
257         generateStaticNeighborObjectPath(std::string_view ipAddress,
258                                          std::string_view macAddress) const;
259 
260     /** @brief get the NTP server list from the timsyncd dbus obj
261      *
262      */
263     virtual ServerList getNTPServerFromTimeSyncd();
264 
265     /** @brief get the name server details from the network conf
266      *
267      */
268     virtual ServerList getNameServerFromResolvd();
269 
270     /** @brief Persistent sdbusplus DBus bus connection. */
271     sdbusplus::bus_t& bus;
272 
273     /** @brief Persistent map of Neighbor dbus objects and their names */
274     string_umap<std::unique_ptr<Neighbor>> staticNeighbors;
275 
276     /** @brief Dbus object path */
277     std::string objPath;
278 
279     /** @brief Interface index */
280     unsigned ifIdx;
281 
282     struct VlanProperties : VlanIfaces
283     {
284         VlanProperties(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
285                        const system::InterfaceInfo& info,
286                        EthernetInterface& eth, bool emitSignal = true);
287         void delete_() override;
288         unsigned parentIdx;
289         EthernetInterface& eth;
290     };
291     std::optional<VlanProperties> vlan;
292 
293     friend class TestEthernetInterface;
294     friend class TestNetworkManager;
295 
296   private:
297     EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
298                       const system::InterfaceInfo& info, std::string&& objPath,
299                       const config::Parser& config, bool emitSignal,
300                       std::optional<bool> enabled);
301 
302     /** @brief Determines if the address is manually assigned
303      *  @param[in] origin - The origin entry of the IP::Address
304      *  @returns true/false value if the address is static
305      */
306     bool originIsManuallyAssigned(IP::AddressOrigin origin);
307 
308     /** @brief Determines if the NIC is enabled in systemd
309      *  @returns true/false value if the NIC is enabled
310      */
311     bool queryNicEnabled() const;
312 };
313 
314 } // namespace network
315 } // namespace phosphor
316