Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 3 | #include "dhcp_configuration.hpp" |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 4 | #include "ethernet_interface.hpp" |
William A. Kennington III | e056484 | 2021-10-23 16:02:22 -0700 | [diff] [blame] | 5 | #include "routing_table.hpp" |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 6 | #include "system_configuration.hpp" |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 7 | #include "vlan_interface.hpp" |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 8 | #include "xyz/openbmc_project/Network/VLAN/Create/server.hpp" |
Ratan Gupta | 5978dd1 | 2017-07-25 13:47:13 +0530 | [diff] [blame] | 9 | |
Manojkiran Eda | a879baa | 2020-06-13 14:39:08 +0530 | [diff] [blame] | 10 | #include <filesystem> |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 11 | #include <list> |
Ratan Gupta | 6811f82 | 2017-04-14 16:34:56 +0530 | [diff] [blame] | 12 | #include <memory> |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 13 | #include <sdbusplus/bus.hpp> |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 14 | #include <string> |
| 15 | #include <vector> |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 16 | #include <xyz/openbmc_project/Common/FactoryReset/server.hpp> |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 17 | |
| 18 | namespace phosphor |
| 19 | { |
| 20 | namespace network |
| 21 | { |
| 22 | |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 23 | using SystemConfPtr = std::unique_ptr<SystemConfiguration>; |
| 24 | using DHCPConfPtr = std::unique_ptr<dhcp::Configuration>; |
| 25 | |
Manojkiran Eda | a879baa | 2020-06-13 14:39:08 +0530 | [diff] [blame] | 26 | namespace fs = std::filesystem; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 27 | namespace details |
| 28 | { |
| 29 | |
Michael Tritz | 29f2fd6 | 2017-05-22 15:27:26 -0500 | [diff] [blame] | 30 | template <typename T, typename U> |
| 31 | using ServerObject = typename sdbusplus::server::object::object<T, U>; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 32 | |
Michael Tritz | 29f2fd6 | 2017-05-22 15:27:26 -0500 | [diff] [blame] | 33 | using VLANCreateIface = details::ServerObject< |
| 34 | sdbusplus::xyz::openbmc_project::Network::VLAN::server::Create, |
| 35 | sdbusplus::xyz::openbmc_project::Common::server::FactoryReset>; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 36 | |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 37 | } // namespace details |
| 38 | |
| 39 | /** @class Manager |
| 40 | * @brief OpenBMC network manager implementation. |
| 41 | */ |
| 42 | class Manager : public details::VLANCreateIface |
| 43 | { |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 44 | public: |
| 45 | Manager() = delete; |
| 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. |
| 55 | * @param[in] dir - Network Configuration directory path. |
| 56 | */ |
| 57 | Manager(sdbusplus::bus::bus& bus, const char* objPath, |
| 58 | const std::string& dir); |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 59 | |
Patrick Williams | 8173e02 | 2021-05-01 06:39:41 -0500 | [diff] [blame] | 60 | ObjectPath vlan(IntfName 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 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 66 | /** @brief Fetch the interface and the ipaddress details |
| 67 | * from the system and create the ethernet interraces |
| 68 | * dbus object. |
| 69 | */ |
Manojkiran Eda | acd6dd5 | 2019-10-15 15:00:51 +0530 | [diff] [blame] | 70 | virtual void createInterfaces(); |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 71 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 72 | /** @brief create child interface object and the system conf object. |
| 73 | */ |
| 74 | void createChildObjects(); |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 75 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 76 | /** @brief sets the network conf directory. |
| 77 | * @param[in] dirName - Absolute path of the directory. |
| 78 | */ |
| 79 | void setConfDir(const fs::path& dir); |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 80 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 81 | /** @brief gets the network conf directory. |
| 82 | */ |
| 83 | fs::path getConfDir() |
| 84 | { |
| 85 | return confDir; |
| 86 | } |
Ratan Gupta | 255d514 | 2017-08-10 09:02:08 +0530 | [diff] [blame] | 87 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 88 | /** @brief gets the system conf object. |
| 89 | * |
| 90 | */ |
| 91 | const SystemConfPtr& getSystemConf() |
| 92 | { |
| 93 | return systemConf; |
| 94 | } |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 95 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 96 | /** @brief gets the dhcp conf object. |
| 97 | * |
| 98 | */ |
| 99 | const DHCPConfPtr& getDHCPConf() |
| 100 | { |
| 101 | return dhcpConf; |
| 102 | } |
Ratan Gupta | 2b10653 | 2017-07-25 16:05:02 +0530 | [diff] [blame] | 103 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 104 | /** @brief create the default network files for each interface |
| 105 | * @detail if force param is true then forcefully create the network |
| 106 | * files otherwise if network file doesn't exist then |
| 107 | * create it. |
| 108 | * @param[in] force - forcefully create the file |
| 109 | * @return true if network file created else false |
| 110 | */ |
| 111 | bool createDefaultNetworkFiles(bool force); |
Ratan Gupta | 70c7e5b | 2017-07-12 11:41:55 +0530 | [diff] [blame] | 112 | |
Manojkiran Eda | cc099a8 | 2020-05-11 14:25:16 +0530 | [diff] [blame] | 113 | /** @brief This function gets the MAC address from the VPD and |
| 114 | * sets it on the corresponding ethernet interface during first |
| 115 | * Boot, once it sets the MAC from VPD, it creates a file named |
| 116 | * firstBoot under /var/lib to make sure we dont run this function |
| 117 | * again. |
| 118 | * |
| 119 | * @param[in] ethPair - Its a pair of ethernet interface name & the |
| 120 | * corresponding MAC Address from the VPD |
| 121 | * |
| 122 | * return - NULL |
| 123 | */ |
| 124 | void setFistBootMACOnInterface( |
| 125 | const std::pair<std::string, std::string>& ethPair); |
| 126 | |
William A. Kennington III | 56ecc78 | 2021-10-07 18:44:50 -0700 | [diff] [blame] | 127 | /** @brief Tell systemd-network to reload all of the network configurations |
| 128 | */ |
| 129 | virtual void reloadConfigs(); |
| 130 | |
Patrick Venture | d94d23e | 2019-01-07 13:05:23 -0800 | [diff] [blame] | 131 | /** @brief Returns the number of interfaces under this manager. |
| 132 | * |
| 133 | * @return the number of interfaces managed by this manager. |
| 134 | */ |
| 135 | int getInterfaceCount() |
| 136 | { |
| 137 | return interfaces.size(); |
| 138 | } |
| 139 | |
| 140 | /** @brief Does the requested interface exist under this manager? |
| 141 | * |
| 142 | * @param[in] intf - the interface name to check. |
| 143 | * @return true if found, false otherwise. |
| 144 | */ |
| 145 | bool hasInterface(const std::string& intf) |
| 146 | { |
| 147 | return (interfaces.find(intf) != interfaces.end()); |
| 148 | } |
| 149 | |
William A. Kennington III | e056484 | 2021-10-23 16:02:22 -0700 | [diff] [blame] | 150 | /** @brief Get the routing table owned by the manager |
| 151 | * |
| 152 | * @return Routing table reference. |
| 153 | */ |
| 154 | inline const auto& getRouteTable() const |
| 155 | { |
| 156 | return routeTable; |
| 157 | } |
| 158 | |
Ratan Gupta | 3529717 | 2018-11-28 18:40:16 +0530 | [diff] [blame] | 159 | protected: |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 160 | /** @brief Persistent sdbusplus DBus bus connection. */ |
| 161 | sdbusplus::bus::bus& bus; |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 162 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 163 | /** @brief Persistent map of EthernetInterface dbus objects and their names |
| 164 | */ |
| 165 | std::map<IntfName, std::shared_ptr<EthernetInterface>> interfaces; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 166 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 167 | /** @brief BMC network reset - resets network configuration for BMC. */ |
| 168 | void reset() override; |
Michael Tritz | 29f2fd6 | 2017-05-22 15:27:26 -0500 | [diff] [blame] | 169 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 170 | /** @brief Path of Object. */ |
| 171 | std::string objectPath; |
Ratan Gupta | 29b0e43 | 2017-05-25 12:51:40 +0530 | [diff] [blame] | 172 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 173 | /** @brief pointer to system conf object. */ |
| 174 | SystemConfPtr systemConf = nullptr; |
Ratan Gupta | ef85eb9 | 2017-06-15 08:57:54 +0530 | [diff] [blame] | 175 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 176 | /** @brief pointer to dhcp conf object. */ |
| 177 | DHCPConfPtr dhcpConf = nullptr; |
Ratan Gupta | d16f88c | 2017-07-11 17:47:57 +0530 | [diff] [blame] | 178 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 179 | /** @brief Network Configuration directory. */ |
| 180 | fs::path confDir; |
William A. Kennington III | e056484 | 2021-10-23 16:02:22 -0700 | [diff] [blame] | 181 | |
| 182 | /** @brief The routing table */ |
| 183 | route::Table routeTable; |
Ratan Gupta | 05eb109 | 2017-04-14 16:33:53 +0530 | [diff] [blame] | 184 | }; |
| 185 | |
| 186 | } // namespace network |
| 187 | } // namespace phosphor |