blob: edd7125d71268e29c070c5a4740f296f7c12c37c [file] [log] [blame]
Ratan Gupta05eb1092017-04-14 16:33:53 +05301#pragma once
Patrick Venture189d44e2018-07-09 12:30:59 -07002#include "dhcp_configuration.hpp"
Ratan Gupta05eb1092017-04-14 16:33:53 +05303#include "ethernet_interface.hpp"
William A. Kennington IIIe0564842021-10-23 16:02:22 -07004#include "routing_table.hpp"
Ratan Guptaef85eb92017-06-15 08:57:54 +05305#include "system_configuration.hpp"
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -07006#include "types.hpp"
Ratan Gupta5978dd12017-07-25 13:47:13 +05307#include "vlan_interface.hpp"
Patrick Venture189d44e2018-07-09 12:30:59 -07008#include "xyz/openbmc_project/Network/VLAN/Create/server.hpp"
Ratan Gupta5978dd12017-07-25 13:47:13 +05309
Manojkiran Edaa879baa2020-06-13 14:39:08 +053010#include <filesystem>
William A. Kennington III6ff633a2021-11-09 17:09:12 -080011#include <function2/function2.hpp>
Ratan Gupta6811f822017-04-14 16:34:56 +053012#include <memory>
Patrick Venture189d44e2018-07-09 12:30:59 -070013#include <sdbusplus/bus.hpp>
Ratan Gupta05eb1092017-04-14 16:33:53 +053014#include <string>
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -070015#include <string_view>
Ratan Gupta05eb1092017-04-14 16:33:53 +053016#include <vector>
Patrick Venture189d44e2018-07-09 12:30:59 -070017#include <xyz/openbmc_project/Common/FactoryReset/server.hpp>
Ratan Gupta05eb1092017-04-14 16:33:53 +053018
19namespace phosphor
20{
21namespace network
22{
23
Ratan Gupta2b106532017-07-25 16:05:02 +053024using SystemConfPtr = std::unique_ptr<SystemConfiguration>;
25using DHCPConfPtr = std::unique_ptr<dhcp::Configuration>;
26
Manojkiran Edaa879baa2020-06-13 14:39:08 +053027namespace fs = std::filesystem;
Ratan Gupta05eb1092017-04-14 16:33:53 +053028namespace details
29{
30
Michael Tritz29f2fd62017-05-22 15:27:26 -050031template <typename T, typename U>
Patrick Williamsc38b0712022-07-22 19:26:54 -050032using ServerObject = typename sdbusplus::server::object_t<T, U>;
Ratan Gupta05eb1092017-04-14 16:33:53 +053033
Michael Tritz29f2fd62017-05-22 15:27:26 -050034using VLANCreateIface = details::ServerObject<
35 sdbusplus::xyz::openbmc_project::Network::VLAN::server::Create,
36 sdbusplus::xyz::openbmc_project::Common::server::FactoryReset>;
Ratan Gupta05eb1092017-04-14 16:33:53 +053037
Ratan Gupta05eb1092017-04-14 16:33:53 +053038} // namespace details
39
40/** @class Manager
41 * @brief OpenBMC network manager implementation.
42 */
43class Manager : public details::VLANCreateIface
44{
Gunnar Mills57d9c502018-09-14 14:42:34 -050045 public:
46 Manager() = delete;
47 Manager(const Manager&) = delete;
48 Manager& operator=(const Manager&) = delete;
49 Manager(Manager&&) = delete;
50 Manager& operator=(Manager&&) = delete;
51 virtual ~Manager() = default;
Ratan Gupta05eb1092017-04-14 16:33:53 +053052
Gunnar Mills57d9c502018-09-14 14:42:34 -050053 /** @brief Constructor to put object onto bus at a dbus path.
54 * @param[in] bus - Bus to attach to.
55 * @param[in] objPath - Path to attach at.
56 * @param[in] dir - Network Configuration directory path.
57 */
Patrick Williamsc38b0712022-07-22 19:26:54 -050058 Manager(sdbusplus::bus_t& bus, const char* objPath, const std::string& dir);
Ratan Gupta05eb1092017-04-14 16:33:53 +053059
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -070060 ObjectPath vlan(std::string interfaceName, uint32_t id) override;
Ratan Gupta05eb1092017-04-14 16:33:53 +053061
Gunnar Mills57d9c502018-09-14 14:42:34 -050062 /** @brief write the network conf file with the in-memory objects.
63 */
64 void writeToConfigurationFile();
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053065
Gunnar Mills57d9c502018-09-14 14:42:34 -050066 /** @brief Fetch the interface and the ipaddress details
67 * from the system and create the ethernet interraces
68 * dbus object.
69 */
Manojkiran Edaacd6dd52019-10-15 15:00:51 +053070 virtual void createInterfaces();
Ratan Gupta29b0e432017-05-25 12:51:40 +053071
Gunnar Mills57d9c502018-09-14 14:42:34 -050072 /** @brief create child interface object and the system conf object.
73 */
74 void createChildObjects();
Ratan Guptaef85eb92017-06-15 08:57:54 +053075
Gunnar Mills57d9c502018-09-14 14:42:34 -050076 /** @brief sets the network conf directory.
77 * @param[in] dirName - Absolute path of the directory.
78 */
79 void setConfDir(const fs::path& dir);
Ratan Guptaef85eb92017-06-15 08:57:54 +053080
Gunnar Mills57d9c502018-09-14 14:42:34 -050081 /** @brief gets the network conf directory.
82 */
William A. Kennington III72131802022-10-05 02:08:36 -070083 inline const fs::path& getConfDir() const
Gunnar Mills57d9c502018-09-14 14:42:34 -050084 {
85 return confDir;
86 }
Ratan Gupta255d5142017-08-10 09:02:08 +053087
Gunnar Mills57d9c502018-09-14 14:42:34 -050088 /** @brief gets the system conf object.
89 *
90 */
William A. Kennington III72131802022-10-05 02:08:36 -070091 inline const SystemConfPtr& getSystemConf()
Gunnar Mills57d9c502018-09-14 14:42:34 -050092 {
93 return systemConf;
94 }
Ratan Gupta05eb1092017-04-14 16:33:53 +053095
Gunnar Mills57d9c502018-09-14 14:42:34 -050096 /** @brief gets the dhcp conf object.
97 *
98 */
William A. Kennington III72131802022-10-05 02:08:36 -070099 inline const DHCPConfPtr& getDHCPConf()
Gunnar Mills57d9c502018-09-14 14:42:34 -0500100 {
101 return dhcpConf;
102 }
Ratan Gupta2b106532017-07-25 16:05:02 +0530103
Gunnar Mills57d9c502018-09-14 14:42:34 -0500104 /** @brief create the default network files for each interface
Gunnar Mills57d9c502018-09-14 14:42:34 -0500105 * @return true if network file created else false
106 */
William A. Kennington III9a1d9af2021-11-09 17:51:05 -0800107 bool createDefaultNetworkFiles();
Ratan Gupta70c7e5b2017-07-12 11:41:55 +0530108
Manojkiran Edacc099a82020-05-11 14:25:16 +0530109 /** @brief This function gets the MAC address from the VPD and
110 * sets it on the corresponding ethernet interface during first
111 * Boot, once it sets the MAC from VPD, it creates a file named
112 * firstBoot under /var/lib to make sure we dont run this function
113 * again.
114 *
115 * @param[in] ethPair - Its a pair of ethernet interface name & the
116 * corresponding MAC Address from the VPD
117 *
118 * return - NULL
119 */
120 void setFistBootMACOnInterface(
121 const std::pair<std::string, std::string>& ethPair);
122
William A. Kennington IIIc7cf25f2021-11-09 16:16:59 -0800123 /** @brief Arms a timer to tell systemd-network to reload all of the network
124 * configurations
William A. Kennington III56ecc782021-10-07 18:44:50 -0700125 */
126 virtual void reloadConfigs();
127
William A. Kennington IIIc7cf25f2021-11-09 16:16:59 -0800128 /** @brief Tell systemd-network to reload all of the network configurations
129 */
130 void doReloadConfigs();
131
William A. Kennington III96444792022-10-05 15:16:22 -0700132 /** @brief Get the interfaces owned by the manager
Patrick Ventured94d23e2019-01-07 13:05:23 -0800133 *
William A. Kennington III96444792022-10-05 15:16:22 -0700134 * @return Interfaces reference.
Patrick Ventured94d23e2019-01-07 13:05:23 -0800135 */
William A. Kennington III96444792022-10-05 15:16:22 -0700136 inline const auto& getInterfaces() const
Patrick Ventured94d23e2019-01-07 13:05:23 -0800137 {
William A. Kennington III96444792022-10-05 15:16:22 -0700138 return interfaces;
Patrick Ventured94d23e2019-01-07 13:05:23 -0800139 }
140
William A. Kennington IIIe0564842021-10-23 16:02:22 -0700141 /** @brief Get the routing table owned by the manager
142 *
143 * @return Routing table reference.
144 */
145 inline const auto& getRouteTable() const
146 {
147 return routeTable;
148 }
149
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800150 /** @brief Adds a hook that runs immediately prior to reloading
151 *
152 * @param[in] hook - The hook to execute before reloading
153 */
154 inline void addReloadPreHook(fu2::unique_function<void()>&& hook)
155 {
156 reloadPreHooks.push_back(std::move(hook));
157 }
158
Ratan Gupta35297172018-11-28 18:40:16 +0530159 protected:
Gunnar Mills57d9c502018-09-14 14:42:34 -0500160 /** @brief Persistent sdbusplus DBus bus connection. */
Patrick Williamsc38b0712022-07-22 19:26:54 -0500161 sdbusplus::bus_t& bus;
Ratan Gupta29b0e432017-05-25 12:51:40 +0530162
Gunnar Mills57d9c502018-09-14 14:42:34 -0500163 /** @brief Persistent map of EthernetInterface dbus objects and their names
164 */
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -0700165 string_umap<std::unique_ptr<EthernetInterface>> interfaces;
Ratan Gupta05eb1092017-04-14 16:33:53 +0530166
Gunnar Mills57d9c502018-09-14 14:42:34 -0500167 /** @brief BMC network reset - resets network configuration for BMC. */
168 void reset() override;
Michael Tritz29f2fd62017-05-22 15:27:26 -0500169
Gunnar Mills57d9c502018-09-14 14:42:34 -0500170 /** @brief Path of Object. */
171 std::string objectPath;
Ratan Gupta29b0e432017-05-25 12:51:40 +0530172
Gunnar Mills57d9c502018-09-14 14:42:34 -0500173 /** @brief pointer to system conf object. */
174 SystemConfPtr systemConf = nullptr;
Ratan Guptaef85eb92017-06-15 08:57:54 +0530175
Gunnar Mills57d9c502018-09-14 14:42:34 -0500176 /** @brief pointer to dhcp conf object. */
177 DHCPConfPtr dhcpConf = nullptr;
Ratan Guptad16f88c2017-07-11 17:47:57 +0530178
Gunnar Mills57d9c502018-09-14 14:42:34 -0500179 /** @brief Network Configuration directory. */
180 fs::path confDir;
William A. Kennington IIIe0564842021-10-23 16:02:22 -0700181
182 /** @brief The routing table */
183 route::Table routeTable;
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800184
185 /** @brief List of hooks to execute during the next reload */
186 std::vector<fu2::unique_function<void()>> reloadPreHooks;
Ratan Gupta05eb1092017-04-14 16:33:53 +0530187};
188
189} // namespace network
190} // namespace phosphor