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 
58 /** @class EthernetInterface
59  *  @brief OpenBMC Ethernet Interface implementation.
60  *  @details A concrete implementation for the
61  *  xyz.openbmc_project.Network.EthernetInterface DBus API.
62  */
63 class EthernetInterface : public Ifaces
64 {
65   public:
66     EthernetInterface() = delete;
67     EthernetInterface(const EthernetInterface&) = delete;
68     EthernetInterface& operator=(const EthernetInterface&) = delete;
69     EthernetInterface(EthernetInterface&&) = delete;
70     EthernetInterface& operator=(EthernetInterface&&) = delete;
71     virtual ~EthernetInterface() = default;
72 
73     /** @brief Constructor to put object onto bus at a dbus path.
74      *  @param[in] bus - Bus to attach to.
75      *  @param[in] manager - parent object.
76      *  @param[in] info - Interface information.
77      *  @param[in] objRoot - Path to attach at.
78      *  @param[in] config - The parsed configuation file.
79      *  @param[in] vlan - The id of the vlan if configured
80      *  @param[in] enabled - Determine if systemd-networkd is managing this link
81      */
82     EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
83                       const AllIntfInfo& info, std::string_view objRoot,
84                       const config::Parser& config, bool enabled);
85 
86     /** @brief Network Manager object. */
87     Manager& manager;
88 
89     /** @brief Persistent map of IPAddress dbus objects and their names */
90     std::unordered_map<IfAddr, std::unique_ptr<IPAddress>> addrs;
91 
92     /** @brief Persistent map of Neighbor dbus objects and their names */
93     std::unordered_map<InAddrAny, std::unique_ptr<Neighbor>> staticNeighbors;
94 
95     void addAddr(const AddressInfo& info);
96     void addStaticNeigh(const NeighborInfo& info);
97 
98     /** @brief Updates the interface information based on new InterfaceInfo */
99     void updateInfo(const InterfaceInfo& info, bool skipSignal = false);
100 
101     /** @brief Function used to load the ntpservers
102      */
103     void loadNTPServers(const config::Parser& config);
104 
105     /** @brief Function used to load the nameservers.
106      */
107     void loadNameServers(const config::Parser& config);
108 
109     /** @brief Function to create ipAddress dbus object.
110      *  @param[in] addressType - Type of ip address.
111      *  @param[in] ipAddress- IP address.
112      *  @param[in] prefixLength - Length of prefix.
113      */
114 
115     ObjectPath ip(IP::Protocol addressType, std::string ipAddress,
116                   uint8_t prefixLength, std::string) override;
117 
118     /** @brief Function to create static neighbor dbus object.
119      *  @param[in] ipAddress - IP address.
120      *  @param[in] macAddress - Low level MAC address.
121      */
122     ObjectPath neighbor(std::string ipAddress, std::string macAddress) override;
123 
124     /** Set value of DHCPEnabled */
125     DHCPConf dhcpEnabled() const override;
126     DHCPConf dhcpEnabled(DHCPConf value) override;
127     using EthernetInterfaceIntf::dhcp4;
128     bool dhcp4(bool value) override;
129     using EthernetInterfaceIntf::dhcp6;
130     bool dhcp6(bool value) override;
131 
132     inline bool dhcpIsEnabled(in_addr) const
133     {
134         return dhcp4();
135     }
136     inline bool dhcpIsEnabled(in6_addr) const
137     {
138         return dhcp6();
139     }
140     inline bool dhcpIsEnabled(InAddrAny addr) const
141     {
142         return std::visit([&](auto v) { return dhcpIsEnabled(v); }, addr);
143     }
144 
145     /** Set size of MTU */
146     size_t mtu(size_t value) override;
147 
148     /** Set value of NICEnabled */
149     bool nicEnabled(bool value) override;
150 
151     /** @brief sets the MAC address.
152      *  @param[in] value - MAC address which needs to be set on the system.
153      *  @returns macAddress of the interface or throws an error.
154      */
155     std::string macAddress(std::string value) override;
156 
157     /** @brief check conf file for Router Advertisements
158      *
159      */
160     bool ipv6AcceptRA(bool value) override;
161     using EthernetInterfaceIntf::ipv6AcceptRA;
162 
163     /** @brief sets the NTP servers.
164      *  @param[in] value - vector of NTP servers.
165      */
166     ServerList ntpServers(ServerList value) override;
167 
168     /** @brief sets the static NTP servers.
169      *  @param[in] value - vector of NTP servers.
170      */
171     ServerList staticNTPServers(ServerList value) override;
172 
173     /** @brief sets the Static DNS/nameservers.
174      *  @param[in] value - vector of DNS servers.
175      */
176 
177     ServerList staticNameServers(ServerList value) override;
178 
179     /** @brief create Vlan interface.
180      *  @param[in] id- VLAN identifier.
181      */
182     ObjectPath createVLAN(uint16_t id);
183 
184     /** @brief write the network conf file with the in-memory objects.
185      */
186     void writeConfigurationFile();
187 
188     /** @brief delete all dbus objects.
189      */
190     void deleteAll();
191 
192     /** @brief set the default v4 gateway of the interface.
193      *  @param[in] gateway - default v4 gateway of the interface.
194      */
195     std::string defaultGateway(std::string gateway) override;
196 
197     /** @brief set the default v6 gateway of the interface.
198      *  @param[in] gateway - default v6 gateway of the interface.
199      */
200     std::string defaultGateway6(std::string gateway) override;
201 
202     using EthernetInterfaceIntf::interfaceName;
203     using EthernetInterfaceIntf::linkUp;
204     using EthernetInterfaceIntf::mtu;
205     using EthernetInterfaceIntf::nicEnabled;
206     using MacAddressIntf::macAddress;
207 
208     using EthernetInterfaceIntf::defaultGateway;
209     using EthernetInterfaceIntf::defaultGateway6;
210 
211   protected:
212     /** @brief get the NTP server list from the timsyncd dbus obj
213      *
214      */
215     virtual ServerList getNTPServerFromTimeSyncd();
216 
217     /** @brief get the name server details from the network conf
218      *
219      */
220     virtual ServerList getNameServerFromResolvd();
221 
222     /** @brief Persistent sdbusplus DBus bus connection. */
223     sdbusplus::bus_t& bus;
224 
225     /** @brief Dbus object path */
226     std::string objPath;
227 
228     /** @brief Interface index */
229     unsigned ifIdx;
230 
231     struct VlanProperties : VlanIfaces
232     {
233         VlanProperties(sdbusplus::bus_t& bus, stdplus::const_zstring objPath,
234                        const InterfaceInfo& info, EthernetInterface& eth);
235         void delete_() override;
236         unsigned parentIdx;
237         EthernetInterface& eth;
238     };
239     std::optional<VlanProperties> vlan;
240 
241     friend class TestEthernetInterface;
242     friend class TestNetworkManager;
243 
244   private:
245     EthernetInterface(sdbusplus::bus_t& bus, Manager& manager,
246                       const AllIntfInfo& info, std::string&& objPath,
247                       const config::Parser& config, bool enabled);
248 
249     /** @brief Determines if the address is manually assigned
250      *  @param[in] origin - The origin entry of the IP::Address
251      *  @returns true/false value if the address is static
252      */
253     bool originIsManuallyAssigned(IP::AddressOrigin origin);
254 };
255 
256 } // namespace network
257 } // namespace phosphor
258