Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 1 | #pragma once |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 2 | #include "dhcp_configuration.hpp" |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 3 | #include "ethernet_interface.hpp" |
William A. Kennington III | e056484 | 2021-10-23 16:02:22 -0700 | [diff] [blame] | 4 | #include "routing_table.hpp" |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 5 | #include "system_configuration.hpp" |
William A. Kennington III | dd9ef81 | 2022-10-05 02:08:02 -0700 | [diff] [blame] | 6 | #include "types.hpp" |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 7 | #include "xyz/openbmc_project/Network/VLAN/Create/server.hpp" |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 8 | |
Manojkiran Eda | a879baa | 2020-06-13 14:39:08 +0530 | [diff] [blame] | 9 | #include <filesystem> |
William A. Kennington III | 6ff633a | 2021-11-09 17:09:12 -0800 | [diff] [blame] | 10 | #include <function2/function2.hpp> |
Ratan Gupta | 6811f82 | 2017-04-14 16:34:56 +0530 | [diff] [blame] | 11 | #include <memory> |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 12 | #include <sdbusplus/bus.hpp> |
William A. Kennington III | 80d2901 | 2022-11-12 02:31:40 -0800 | [diff] [blame^] | 13 | #include <sdbusplus/bus/match.hpp> |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 14 | #include <string> |
William A. Kennington III | dd9ef81 | 2022-10-05 02:08:02 -0700 | [diff] [blame] | 15 | #include <string_view> |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 16 | #include <vector> |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 17 | #include <xyz/openbmc_project/Common/FactoryReset/server.hpp> |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 18 | |
| 19 | namespace phosphor |
| 20 | { |
| 21 | namespace network |
| 22 | { |
| 23 | |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 24 | using SystemConfPtr = std::unique_ptr<SystemConfiguration>; |
| 25 | using DHCPConfPtr = std::unique_ptr<dhcp::Configuration>; |
| 26 | |
Manojkiran Eda | a879baa | 2020-06-13 14:39:08 +0530 | [diff] [blame] | 27 | namespace fs = std::filesystem; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 28 | namespace details |
| 29 | { |
| 30 | |
Michael Tritz | 29f2fd6 | 2017-05-22 15:27:26 -0500 | [diff] [blame] | 31 | template <typename T, typename U> |
Patrick Williams | c38b071 | 2022-07-22 19:26:54 -0500 | [diff] [blame] | 32 | using ServerObject = typename sdbusplus::server::object_t<T, U>; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 33 | |
Michael Tritz | 29f2fd6 | 2017-05-22 15:27:26 -0500 | [diff] [blame] | 34 | using VLANCreateIface = details::ServerObject< |
| 35 | sdbusplus::xyz::openbmc_project::Network::VLAN::server::Create, |
| 36 | sdbusplus::xyz::openbmc_project::Common::server::FactoryReset>; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 37 | |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 38 | } // namespace details |
| 39 | |
| 40 | /** @class Manager |
| 41 | * @brief OpenBMC network manager implementation. |
| 42 | */ |
| 43 | class Manager : public details::VLANCreateIface |
| 44 | { |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 45 | public: |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 46 | Manager(const Manager&) = delete; |
| 47 | Manager& operator=(const Manager&) = delete; |
| 48 | Manager(Manager&&) = delete; |
| 49 | Manager& operator=(Manager&&) = delete; |
| 50 | virtual ~Manager() = default; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 51 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 52 | /** @brief Constructor to put object onto bus at a dbus path. |
| 53 | * @param[in] bus - Bus to attach to. |
| 54 | * @param[in] objPath - Path to attach at. |
William A. Kennington III | be3bd2f | 2022-10-11 14:11:27 -0700 | [diff] [blame] | 55 | * @param[in] confDir - Network Configuration directory path. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 56 | */ |
William A. Kennington III | be3bd2f | 2022-10-11 14:11:27 -0700 | [diff] [blame] | 57 | Manager(sdbusplus::bus_t& bus, const char* objPath, |
| 58 | const fs::path& confDir); |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 59 | |
William A. Kennington III | dd9ef81 | 2022-10-05 02:08:02 -0700 | [diff] [blame] | 60 | ObjectPath vlan(std::string interfaceName, uint32_t id) override; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 61 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 62 | /** @brief write the network conf file with the in-memory objects. |
| 63 | */ |
| 64 | void writeToConfigurationFile(); |
Ratan Gupta | 4f1c18b | 2017-05-25 12:59:35 +0530 | [diff] [blame] | 65 | |
William A. Kennington III | 80d2901 | 2022-11-12 02:31:40 -0800 | [diff] [blame^] | 66 | /** @brief Adds a single interface to the interface map */ |
| 67 | void addInterface(InterfaceInfo& info, bool enabled); |
| 68 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 69 | /** @brief Fetch the interface and the ipaddress details |
| 70 | * from the system and create the ethernet interraces |
| 71 | * dbus object. |
| 72 | */ |
Manojkiran Eda | acd6dd5 | 2019-10-15 15:00:51 +0530 | [diff] [blame] | 73 | virtual void createInterfaces(); |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 74 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 75 | /** @brief create child interface object and the system conf object. |
| 76 | */ |
| 77 | void createChildObjects(); |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 78 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 79 | /** @brief sets the network conf directory. |
| 80 | * @param[in] dirName - Absolute path of the directory. |
| 81 | */ |
| 82 | void setConfDir(const fs::path& dir); |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 83 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 84 | /** @brief gets the network conf directory. |
| 85 | */ |
William A. Kennington III | 7213180 | 2022-10-05 02:08:36 -0700 | [diff] [blame] | 86 | inline const fs::path& getConfDir() const |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 87 | { |
| 88 | return confDir; |
| 89 | } |
Ratan Gupta | 255d514 | 2017-08-10 09:02:08 +0530 | [diff] [blame] | 90 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 91 | /** @brief gets the system conf object. |
| 92 | * |
| 93 | */ |
William A. Kennington III | 7213180 | 2022-10-05 02:08:36 -0700 | [diff] [blame] | 94 | inline const SystemConfPtr& getSystemConf() |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 95 | { |
| 96 | return systemConf; |
| 97 | } |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 98 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 99 | /** @brief gets the dhcp conf object. |
| 100 | * |
| 101 | */ |
William A. Kennington III | 7213180 | 2022-10-05 02:08:36 -0700 | [diff] [blame] | 102 | inline const DHCPConfPtr& getDHCPConf() |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 103 | { |
| 104 | return dhcpConf; |
| 105 | } |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 106 | |
Manojkiran Eda | cc099a8 | 2020-05-11 14:25:16 +0530 | [diff] [blame] | 107 | /** @brief This function gets the MAC address from the VPD and |
| 108 | * sets it on the corresponding ethernet interface during first |
| 109 | * Boot, once it sets the MAC from VPD, it creates a file named |
| 110 | * firstBoot under /var/lib to make sure we dont run this function |
| 111 | * again. |
| 112 | * |
| 113 | * @param[in] ethPair - Its a pair of ethernet interface name & the |
| 114 | * corresponding MAC Address from the VPD |
| 115 | * |
| 116 | * return - NULL |
| 117 | */ |
| 118 | void setFistBootMACOnInterface( |
| 119 | const std::pair<std::string, std::string>& ethPair); |
| 120 | |
William A. Kennington III | c7cf25f | 2021-11-09 16:16:59 -0800 | [diff] [blame] | 121 | /** @brief Arms a timer to tell systemd-network to reload all of the network |
| 122 | * configurations |
William A. Kennington III | 56ecc78 | 2021-10-07 18:44:50 -0700 | [diff] [blame] | 123 | */ |
William A. Kennington III | 85dc57a | 2022-11-07 16:53:24 -0800 | [diff] [blame] | 124 | virtual void reloadConfigsNoRefresh(); |
William A. Kennington III | 56ecc78 | 2021-10-07 18:44:50 -0700 | [diff] [blame] | 125 | virtual void reloadConfigs(); |
| 126 | |
William A. Kennington III | c7cf25f | 2021-11-09 16:16:59 -0800 | [diff] [blame] | 127 | /** @brief Tell systemd-network to reload all of the network configurations |
| 128 | */ |
| 129 | void doReloadConfigs(); |
| 130 | |
William A. Kennington III | 09f3a4a | 2022-10-25 02:59:16 -0700 | [diff] [blame] | 131 | /** @brief Persistent map of EthernetInterface dbus objects and their names |
Patrick Venture | d94d23e | 2019-01-07 13:05:23 -0800 | [diff] [blame] | 132 | */ |
William A. Kennington III | 09f3a4a | 2022-10-25 02:59:16 -0700 | [diff] [blame] | 133 | string_umap<std::unique_ptr<EthernetInterface>> interfaces; |
William A. Kennington III | 67b09da | 2022-10-31 14:09:53 -0700 | [diff] [blame] | 134 | std::unordered_map<unsigned, EthernetInterface*> interfacesByIdx; |
Patrick Venture | d94d23e | 2019-01-07 13:05:23 -0800 | [diff] [blame] | 135 | |
William A. Kennington III | e056484 | 2021-10-23 16:02:22 -0700 | [diff] [blame] | 136 | /** @brief Get the routing table owned by the manager |
| 137 | * |
| 138 | * @return Routing table reference. |
| 139 | */ |
| 140 | inline const auto& getRouteTable() const |
| 141 | { |
| 142 | return routeTable; |
| 143 | } |
| 144 | |
William A. Kennington III | 6ff633a | 2021-11-09 17:09:12 -0800 | [diff] [blame] | 145 | /** @brief Adds a hook that runs immediately prior to reloading |
| 146 | * |
| 147 | * @param[in] hook - The hook to execute before reloading |
| 148 | */ |
| 149 | inline void addReloadPreHook(fu2::unique_function<void()>&& hook) |
| 150 | { |
| 151 | reloadPreHooks.push_back(std::move(hook)); |
| 152 | } |
| 153 | |
Ratan Gupta | 3529717 | 2018-11-28 18:40:16 +0530 | [diff] [blame] | 154 | protected: |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 155 | /** @brief Persistent sdbusplus DBus bus connection. */ |
Patrick Williams | c38b071 | 2022-07-22 19:26:54 -0500 | [diff] [blame] | 156 | sdbusplus::bus_t& bus; |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 157 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 158 | /** @brief BMC network reset - resets network configuration for BMC. */ |
| 159 | void reset() override; |
Michael Tritz | 29f2fd6 | 2017-05-22 15:27:26 -0500 | [diff] [blame] | 160 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 161 | /** @brief Path of Object. */ |
| 162 | std::string objectPath; |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 163 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 164 | /** @brief pointer to system conf object. */ |
| 165 | SystemConfPtr systemConf = nullptr; |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 166 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 167 | /** @brief pointer to dhcp conf object. */ |
| 168 | DHCPConfPtr dhcpConf = nullptr; |
Ratan Gupta | d16f88c | 2017-07-11 17:47:57 +0530 | [diff] [blame] | 169 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 170 | /** @brief Network Configuration directory. */ |
| 171 | fs::path confDir; |
William A. Kennington III | e056484 | 2021-10-23 16:02:22 -0700 | [diff] [blame] | 172 | |
| 173 | /** @brief The routing table */ |
| 174 | route::Table routeTable; |
William A. Kennington III | 6ff633a | 2021-11-09 17:09:12 -0800 | [diff] [blame] | 175 | |
William A. Kennington III | 80d2901 | 2022-11-12 02:31:40 -0800 | [diff] [blame^] | 176 | /** @brief Map of interface info for undiscovered interfaces */ |
| 177 | std::unordered_map<unsigned, InterfaceInfo> undiscoveredIntfInfo; |
| 178 | |
| 179 | /** @brief Map of enabled interfaces */ |
| 180 | std::unordered_map<unsigned, bool> systemdNetworkdEnabled; |
| 181 | sdbusplus::bus::match_t systemdNetworkdEnabledMatch; |
| 182 | |
William A. Kennington III | 6ff633a | 2021-11-09 17:09:12 -0800 | [diff] [blame] | 183 | /** @brief List of hooks to execute during the next reload */ |
| 184 | std::vector<fu2::unique_function<void()>> reloadPreHooks; |
William A. Kennington III | 80d2901 | 2022-11-12 02:31:40 -0800 | [diff] [blame^] | 185 | |
| 186 | /** @brief Handles the recipt of an adminstrative state string */ |
| 187 | void handleAdminState(std::string_view state, unsigned ifidx); |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 188 | }; |
| 189 | |
| 190 | } // namespace network |
| 191 | } // namespace phosphor |