blob: 490c4bc9b4fcf7cf4cba7101684e41968ee3bc98 [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 III9ede1b72022-11-21 01:59:28 -080014#include <stdplus/pinned.hpp>
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080015#include <stdplus/zstring_view.hpp>
Ratan Gupta05eb1092017-04-14 16:33:53 +053016#include <string>
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -070017#include <string_view>
Ratan Gupta05eb1092017-04-14 16:33:53 +053018#include <vector>
Patrick Venture189d44e2018-07-09 12:30:59 -070019#include <xyz/openbmc_project/Common/FactoryReset/server.hpp>
Ratan Gupta05eb1092017-04-14 16:33:53 +053020
21namespace phosphor
22{
23namespace network
24{
25
William A. Kennington III5b179382022-11-15 15:23:26 -080026using ManagerIface = sdbusplus::server::object_t<
Michael Tritz29f2fd62017-05-22 15:27:26 -050027 sdbusplus::xyz::openbmc_project::Network::VLAN::server::Create,
28 sdbusplus::xyz::openbmc_project::Common::server::FactoryReset>;
Ratan Gupta05eb1092017-04-14 16:33:53 +053029
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080030class DelayedExecutor
31{
32 public:
33 virtual ~DelayedExecutor() = default;
34
35 virtual void schedule() = 0;
36 virtual void setCallback(fu2::unique_function<void()>&& cb) = 0;
37};
38
Ratan Gupta05eb1092017-04-14 16:33:53 +053039/** @class Manager
40 * @brief OpenBMC network manager implementation.
41 */
William A. Kennington III5b179382022-11-15 15:23:26 -080042class Manager : public ManagerIface
Ratan Gupta05eb1092017-04-14 16:33:53 +053043{
Gunnar Mills57d9c502018-09-14 14:42:34 -050044 public:
Gunnar Mills57d9c502018-09-14 14:42:34 -050045 Manager(Manager&&) = delete;
46 Manager& operator=(Manager&&) = delete;
Ratan Gupta05eb1092017-04-14 16:33:53 +053047
Gunnar Mills57d9c502018-09-14 14:42:34 -050048 /** @brief Constructor to put object onto bus at a dbus path.
49 * @param[in] bus - Bus to attach to.
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080050 * @param[in] reload - The executor for reloading configs
Gunnar Mills57d9c502018-09-14 14:42:34 -050051 * @param[in] objPath - Path to attach at.
William A. Kennington IIIbe3bd2f2022-10-11 14:11:27 -070052 * @param[in] confDir - Network Configuration directory path.
Gunnar Mills57d9c502018-09-14 14:42:34 -050053 */
William A. Kennington III9ede1b72022-11-21 01:59:28 -080054 Manager(stdplus::PinnedRef<sdbusplus::bus_t> bus, DelayedExecutor& reload,
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -080055 stdplus::zstring_view objPath,
William A. Kennington III5b179382022-11-15 15:23:26 -080056 const std::filesystem::path& confDir);
Ratan Gupta05eb1092017-04-14 16:33:53 +053057
William A. Kennington IIIdd9ef812022-10-05 02:08:02 -070058 ObjectPath vlan(std::string interfaceName, uint32_t id) override;
Ratan Gupta05eb1092017-04-14 16:33:53 +053059
Gunnar Mills57d9c502018-09-14 14:42:34 -050060 /** @brief write the network conf file with the in-memory objects.
61 */
62 void writeToConfigurationFile();
Ratan Gupta4f1c18b2017-05-25 12:59:35 +053063
William A. Kennington III80d29012022-11-12 02:31:40 -080064 /** @brief Adds a single interface to the interface map */
William A. Kennington III0813a242022-11-12 18:07:11 -080065 void addInterface(const InterfaceInfo& info);
66 void removeInterface(const InterfaceInfo& info);
William A. Kennington III80d29012022-11-12 02:31:40 -080067
William A. Kennington IIIed5ff472022-11-12 16:24:02 -080068 /** @brief Add / remove an address to the interface or queue */
69 void addAddress(const AddressInfo& info);
70 void removeAddress(const AddressInfo& info);
71
72 /** @brief Add / remove a neighbor to the interface or queue */
73 void addNeighbor(const NeighborInfo& info);
74 void removeNeighbor(const NeighborInfo& info);
75
76 /** @brief Add / remove default gateway for interface */
77 void addDefGw(unsigned ifidx, InAddrAny addr);
78 void removeDefGw(unsigned ifidx, InAddrAny addr);
79
Gunnar Mills57d9c502018-09-14 14:42:34 -050080 /** @brief gets the network conf directory.
81 */
William A. Kennington III5b179382022-11-15 15:23:26 -080082 inline const auto& getConfDir() const
Gunnar Mills57d9c502018-09-14 14:42:34 -050083 {
84 return confDir;
85 }
Ratan Gupta255d5142017-08-10 09:02:08 +053086
Gunnar Mills57d9c502018-09-14 14:42:34 -050087 /** @brief gets the system conf object.
88 *
89 */
William A. Kennington III5b179382022-11-15 15:23:26 -080090 inline auto& getSystemConf()
Gunnar Mills57d9c502018-09-14 14:42:34 -050091 {
William A. Kennington III5b179382022-11-15 15:23:26 -080092 return *systemConf;
Gunnar Mills57d9c502018-09-14 14:42:34 -050093 }
Ratan Gupta05eb1092017-04-14 16:33:53 +053094
Gunnar Mills57d9c502018-09-14 14:42:34 -050095 /** @brief gets the dhcp conf object.
96 *
97 */
William A. Kennington III5b179382022-11-15 15:23:26 -080098 inline auto& getDHCPConf()
Gunnar Mills57d9c502018-09-14 14:42:34 -050099 {
William A. Kennington III5b179382022-11-15 15:23:26 -0800100 return *dhcpConf;
Gunnar Mills57d9c502018-09-14 14:42:34 -0500101 }
Ratan Gupta2b106532017-07-25 16:05:02 +0530102
William A. Kennington IIIc7cf25f2021-11-09 16:16:59 -0800103 /** @brief Arms a timer to tell systemd-network to reload all of the network
104 * configurations
William A. Kennington III56ecc782021-10-07 18:44:50 -0700105 */
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -0800106 inline void reloadConfigs()
107 {
108 reload.schedule();
109 }
William A. Kennington IIIc7cf25f2021-11-09 16:16:59 -0800110
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700111 /** @brief Persistent map of EthernetInterface dbus objects and their names
Patrick Ventured94d23e2019-01-07 13:05:23 -0800112 */
William A. Kennington III09f3a4a2022-10-25 02:59:16 -0700113 string_umap<std::unique_ptr<EthernetInterface>> interfaces;
William A. Kennington III67b09da2022-10-31 14:09:53 -0700114 std::unordered_map<unsigned, EthernetInterface*> interfacesByIdx;
William A. Kennington III93f5c6d2022-11-17 16:23:44 -0800115 std::unordered_set<unsigned> ignoredIntf;
Patrick Ventured94d23e2019-01-07 13:05:23 -0800116
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800117 /** @brief Adds a hook that runs immediately prior to reloading
118 *
119 * @param[in] hook - The hook to execute before reloading
120 */
121 inline void addReloadPreHook(fu2::unique_function<void()>&& hook)
122 {
123 reloadPreHooks.push_back(std::move(hook));
124 }
William A. Kennington IIIde4668a2022-11-17 16:02:30 -0800125 inline void addReloadPostHook(fu2::unique_function<void()>&& hook)
126 {
127 reloadPostHooks.push_back(std::move(hook));
128 }
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800129
Ratan Gupta35297172018-11-28 18:40:16 +0530130 protected:
William A. Kennington IIIde70ccf2022-11-20 17:18:01 -0800131 /** @brief Handle to the object used to trigger reloads of networkd. */
132 DelayedExecutor& reload;
133
Gunnar Mills57d9c502018-09-14 14:42:34 -0500134 /** @brief Persistent sdbusplus DBus bus connection. */
William A. Kennington III9ede1b72022-11-21 01:59:28 -0800135 stdplus::PinnedRef<sdbusplus::bus_t> bus;
Ratan Gupta29b0e432017-05-25 12:51:40 +0530136
Gunnar Mills57d9c502018-09-14 14:42:34 -0500137 /** @brief BMC network reset - resets network configuration for BMC. */
138 void reset() override;
Michael Tritz29f2fd62017-05-22 15:27:26 -0500139
Gunnar Mills57d9c502018-09-14 14:42:34 -0500140 /** @brief Path of Object. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800141 sdbusplus::message::object_path objPath;
Ratan Gupta29b0e432017-05-25 12:51:40 +0530142
Gunnar Mills57d9c502018-09-14 14:42:34 -0500143 /** @brief pointer to system conf object. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800144 std::unique_ptr<SystemConfiguration> systemConf = nullptr;
Ratan Guptaef85eb92017-06-15 08:57:54 +0530145
Gunnar Mills57d9c502018-09-14 14:42:34 -0500146 /** @brief pointer to dhcp conf object. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800147 std::unique_ptr<dhcp::Configuration> dhcpConf = nullptr;
Ratan Guptad16f88c2017-07-11 17:47:57 +0530148
Gunnar Mills57d9c502018-09-14 14:42:34 -0500149 /** @brief Network Configuration directory. */
William A. Kennington III5b179382022-11-15 15:23:26 -0800150 std::filesystem::path confDir;
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800151
William A. Kennington III80d29012022-11-12 02:31:40 -0800152 /** @brief Map of interface info for undiscovered interfaces */
William A. Kennington III2fb0c872022-11-15 19:35:39 -0800153 std::unordered_map<unsigned, AllIntfInfo> intfInfo;
William A. Kennington III80d29012022-11-12 02:31:40 -0800154
155 /** @brief Map of enabled interfaces */
156 std::unordered_map<unsigned, bool> systemdNetworkdEnabled;
157 sdbusplus::bus::match_t systemdNetworkdEnabledMatch;
158
William A. Kennington III6ff633a2021-11-09 17:09:12 -0800159 /** @brief List of hooks to execute during the next reload */
160 std::vector<fu2::unique_function<void()>> reloadPreHooks;
William A. Kennington IIIde4668a2022-11-17 16:02:30 -0800161 std::vector<fu2::unique_function<void()>> reloadPostHooks;
William A. Kennington III80d29012022-11-12 02:31:40 -0800162
163 /** @brief Handles the recipt of an adminstrative state string */
164 void handleAdminState(std::string_view state, unsigned ifidx);
William A. Kennington III0813a242022-11-12 18:07:11 -0800165
166 /** @brief Creates the interface in the maps */
William A. Kennington III2fb0c872022-11-15 19:35:39 -0800167 void createInterface(const AllIntfInfo& info, bool enabled);
Ratan Gupta05eb1092017-04-14 16:33:53 +0530168};
169
170} // namespace network
171} // namespace phosphor