blob: 890a837a2572ca75c4f1a4b4d82e439884b9bbd7 [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"
Ratan Guptaef85eb92017-06-15 08:57:54 +05304#include "system_configuration.hpp"
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -07005#include "types.hpp"
Patrick Venture189d44e2018-07-09 12:30:59 -07006#include "xyz/openbmc_project/Network/VLAN/Create/server.hpp"
Ratan Gupta5978dd12017-07-25 13:47:13 +05307
Manojkiran Edaa879baa2020-06-13 14:39:08 +05308#include <filesystem>
William A. Kennington III6ff633a2021-11-09 17:09:12 -08009#include <function2/function2.hpp>
Ratan Gupta6811f822017-04-14 16:34:56 +053010#include <memory>
Patrick Venture189d44e2018-07-09 12:30:59 -070011#include <sdbusplus/bus.hpp>
William A. Kennington III80d29012022-11-12 02:31:40 -080012#include <sdbusplus/bus/match.hpp>
William A. Kennington III5b179382022-11-15 15:23:26 -080013#include <sdbusplus/message/native_types.hpp>
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080014#include <stdplus/zstring_view.hpp>
Ratan Gupta05eb1092017-04-14 16:33:53 +053015#include <string>
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -070016#include <string_view>
Ratan Gupta05eb1092017-04-14 16:33:53 +053017#include <vector>
Patrick Venture189d44e2018-07-09 12:30:59 -070018#include <xyz/openbmc_project/Common/FactoryReset/server.hpp>
Ratan Gupta05eb1092017-04-14 16:33:53 +053019
20namespace phosphor
21{
22namespace network
23{
24
William A. Kennington III5b179382022-11-15 15:23:26 -080025using ManagerIface = sdbusplus::server::object_t<
Michael Tritz29f2fd62017-05-22 15:27:26 -050026 sdbusplus::xyz::openbmc_project::Network::VLAN::server::Create,
27 sdbusplus::xyz::openbmc_project::Common::server::FactoryReset>;
Ratan Gupta05eb1092017-04-14 16:33:53 +053028
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080029class DelayedExecutor
30{
31 public:
32 virtual ~DelayedExecutor() = default;
33
34 virtual void schedule() = 0;
35 virtual void setCallback(fu2::unique_function<void()>&& cb) = 0;
36};
37
Ratan Gupta05eb1092017-04-14 16:33:53 +053038/** @class Manager
39 * @brief OpenBMC network manager implementation.
40 */
William A. Kennington III5b179382022-11-15 15:23:26 -080041class Manager : public ManagerIface
Ratan Gupta05eb1092017-04-14 16:33:53 +053042{
Gunnar Mills57d9c502018-09-14 14:42:34 -050043 public:
Gunnar Mills57d9c502018-09-14 14:42:34 -050044 Manager(const Manager&) = delete;
45 Manager& operator=(const Manager&) = delete;
46 Manager(Manager&&) = delete;
47 Manager& operator=(Manager&&) = delete;
Ratan Gupta05eb1092017-04-14 16:33:53 +053048
Gunnar Mills57d9c502018-09-14 14:42:34 -050049 /** @brief Constructor to put object onto bus at a dbus path.
50 * @param[in] bus - Bus to attach to.
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080051 * @param[in] reload - The executor for reloading configs
Gunnar Mills57d9c502018-09-14 14:42:34 -050052 * @param[in] objPath - Path to attach at.
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -070053 * @param[in] confDir - Network Configuration directory path.
Gunnar Mills57d9c502018-09-14 14:42:34 -050054 */
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080055 Manager(sdbusplus::bus_t& bus, DelayedExecutor& reload,
56 stdplus::zstring_view objPath,
William A. Kennington III5b179382022-11-15 15:23:26 -080057 const std::filesystem::path& confDir);
Ratan Gupta05eb1092017-04-14 16:33:53 +053058
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -070059 ObjectPath vlan(std::string interfaceName, uint32_t id) override;
Ratan Gupta05eb1092017-04-14 16:33:53 +053060
Gunnar Mills57d9c502018-09-14 14:42:34 -050061 /** @brief write the network conf file with the in-memory objects.
62 */
63 void writeToConfigurationFile();
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053064
William A. Kennington III80d29012022-11-12 02:31:40 -080065 /** @brief Adds a single interface to the interface map */
William A. Kennington III0813a242022-11-12 18:07:11 -080066 void addInterface(const InterfaceInfo& info);
67 void removeInterface(const InterfaceInfo& info);
William A. Kennington III80d29012022-11-12 02:31:40 -080068
William A. Kennington IIIed5ff472022-11-12 16:24:02 -080069 /** @brief Add / remove an address to the interface or queue */
70 void addAddress(const AddressInfo& info);
71 void removeAddress(const AddressInfo& info);
72
73 /** @brief Add / remove a neighbor to the interface or queue */
74 void addNeighbor(const NeighborInfo& info);
75 void removeNeighbor(const NeighborInfo& info);
76
77 /** @brief Add / remove default gateway for interface */
78 void addDefGw(unsigned ifidx, InAddrAny addr);
79 void removeDefGw(unsigned ifidx, InAddrAny addr);
80
Gunnar Mills57d9c502018-09-14 14:42:34 -050081 /** @brief gets the network conf directory.
82 */
William A. Kennington III5b179382022-11-15 15:23:26 -080083 inline const auto& 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 III5b179382022-11-15 15:23:26 -080091 inline auto& getSystemConf()
Gunnar Mills57d9c502018-09-14 14:42:34 -050092 {
William A. Kennington III5b179382022-11-15 15:23:26 -080093 return *systemConf;
Gunnar Mills57d9c502018-09-14 14:42:34 -050094 }
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 III5b179382022-11-15 15:23:26 -080099 inline auto& getDHCPConf()
Gunnar Mills57d9c502018-09-14 14:42:34 -0500100 {
William A. Kennington III5b179382022-11-15 15:23:26 -0800101 return *dhcpConf;
Gunnar Mills57d9c502018-09-14 14:42:34 -0500102 }
Ratan Gupta2b106532017-07-25 16:05:02 +0530103
William A. Kennington IIIc7cf25f2021-11-09 16:16:59 -0800104 /** @brief Arms a timer to tell systemd-network to reload all of the network
105 * configurations
William A. Kennington III56ecc782021-10-07 18:44:50 -0700106 */
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -0800107 inline void reloadConfigs()
108 {
109 reload.schedule();
110 }
William A. Kennington IIIc7cf25f2021-11-09 16:16:59 -0800111
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700112 /** @brief Persistent map of EthernetInterface dbus objects and their names
Patrick Ventured94d23e2019-01-07 13:05:23 -0800113 */
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700114 string_umap<std::unique_ptr<EthernetInterface>> interfaces;
William A. Kennington III67b09da2022-10-31 14:09:53 -0700115 std::unordered_map<unsigned, EthernetInterface*> interfacesByIdx;
William A. Kennington III93f5c6d2022-11-17 16:23:44 -0800116 std::unordered_set<unsigned> ignoredIntf;
Patrick Ventured94d23e2019-01-07 13:05:23 -0800117
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800118 /** @brief Adds a hook that runs immediately prior to reloading
119 *
120 * @param[in] hook - The hook to execute before reloading
121 */
122 inline void addReloadPreHook(fu2::unique_function<void()>&& hook)
123 {
124 reloadPreHooks.push_back(std::move(hook));
125 }
William A. Kennington IIIde4668a2022-11-17 16:02:30 -0800126 inline void addReloadPostHook(fu2::unique_function<void()>&& hook)
127 {
128 reloadPostHooks.push_back(std::move(hook));
129 }
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800130
Ratan Gupta35297172018-11-28 18:40:16 +0530131 protected:
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -0800132 /** @brief Handle to the object used to trigger reloads of networkd. */
133 DelayedExecutor& reload;
134
Gunnar Mills57d9c502018-09-14 14:42:34 -0500135 /** @brief Persistent sdbusplus DBus bus connection. */
Patrick Williamsc38b0712022-07-22 19:26:54 -0500136 sdbusplus::bus_t& bus;
Ratan Gupta29b0e432017-05-25 12:51:40 +0530137
Gunnar Mills57d9c502018-09-14 14:42:34 -0500138 /** @brief BMC network reset - resets network configuration for BMC. */
139 void reset() override;
Michael Tritz29f2fd62017-05-22 15:27:26 -0500140
Gunnar Mills57d9c502018-09-14 14:42:34 -0500141 /** @brief Path of Object. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800142 sdbusplus::message::object_path objPath;
Ratan Gupta29b0e432017-05-25 12:51:40 +0530143
Gunnar Mills57d9c502018-09-14 14:42:34 -0500144 /** @brief pointer to system conf object. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800145 std::unique_ptr<SystemConfiguration> systemConf = nullptr;
Ratan Guptaef85eb92017-06-15 08:57:54 +0530146
Gunnar Mills57d9c502018-09-14 14:42:34 -0500147 /** @brief pointer to dhcp conf object. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800148 std::unique_ptr<dhcp::Configuration> dhcpConf = nullptr;
Ratan Guptad16f88c2017-07-11 17:47:57 +0530149
Gunnar Mills57d9c502018-09-14 14:42:34 -0500150 /** @brief Network Configuration directory. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800151 std::filesystem::path confDir;
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800152
William A. Kennington III80d29012022-11-12 02:31:40 -0800153 /** @brief Map of interface info for undiscovered interfaces */
William A. Kennington III2fb0c872022-11-15 19:35:39 -0800154 std::unordered_map<unsigned, AllIntfInfo> intfInfo;
William A. Kennington III80d29012022-11-12 02:31:40 -0800155
156 /** @brief Map of enabled interfaces */
157 std::unordered_map<unsigned, bool> systemdNetworkdEnabled;
158 sdbusplus::bus::match_t systemdNetworkdEnabledMatch;
159
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800160 /** @brief List of hooks to execute during the next reload */
161 std::vector<fu2::unique_function<void()>> reloadPreHooks;
William A. Kennington IIIde4668a2022-11-17 16:02:30 -0800162 std::vector<fu2::unique_function<void()>> reloadPostHooks;
William A. Kennington III80d29012022-11-12 02:31:40 -0800163
164 /** @brief Handles the recipt of an adminstrative state string */
165 void handleAdminState(std::string_view state, unsigned ifidx);
William A. Kennington III0813a242022-11-12 18:07:11 -0800166
167 /** @brief Creates the interface in the maps */
William A. Kennington III2fb0c872022-11-15 19:35:39 -0800168 void createInterface(const AllIntfInfo& info, bool enabled);
Ratan Gupta05eb1092017-04-14 16:33:53 +0530169};
170
171} // namespace network
172} // namespace phosphor