1 #pragma once 2 #include "types.hpp" 3 4 #include <netinet/ether.h> 5 #include <netinet/in.h> 6 #include <unistd.h> 7 8 #include <cstring> 9 #include <filesystem> 10 #include <optional> 11 #include <sdbusplus/bus.hpp> 12 #include <stdplus/zstring.hpp> 13 #include <string> 14 #include <string_view> 15 #include <unordered_set> 16 #include <xyz/openbmc_project/Network/EthernetInterface/server.hpp> 17 18 namespace phosphor 19 { 20 namespace network 21 { 22 namespace config 23 { 24 class Parser; 25 } 26 27 using EthernetInterfaceIntf = 28 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface; 29 30 namespace mac_address 31 { 32 33 /** @brief gets the MAC address from the Inventory. 34 * @param[in] bus - DBUS Bus Object. 35 * @param[in] intfName - Interface name 36 */ 37 ether_addr getfromInventory(sdbusplus::bus_t& bus, const std::string& intfName); 38 39 /** @brief Converts the given mac address into byte form 40 * @param[in] str - The mac address in human readable form 41 * @returns A mac address in network byte order 42 * @throws std::runtime_error for bad mac 43 */ 44 ether_addr fromString(std::string_view str); 45 46 /** @brief Converts the given mac address bytes into a string 47 * @param[in] mac - The mac address 48 * @returns A valid mac address string 49 */ 50 std::string toString(const ether_addr& mac); 51 52 /** @brief Determines if the mac address is empty 53 * @param[in] mac - The mac address 54 * @return True if 00:00:00:00:00:00 55 */ 56 bool isEmpty(const ether_addr& mac); 57 58 /** @brief Determines if the mac address is a multicast address 59 * @param[in] mac - The mac address 60 * @return True if multicast bit is set 61 */ 62 bool isMulticast(const ether_addr& mac); 63 64 /** @brief Determines if the mac address is a unicast address 65 * @param[in] mac - The mac address 66 * @return True if not multicast or empty 67 */ 68 bool isUnicast(const ether_addr& mac); 69 70 } // namespace mac_address 71 72 template <int family> 73 struct FamilyTraits 74 { 75 }; 76 77 template <> 78 struct FamilyTraits<AF_INET> 79 { 80 using addr = in_addr; 81 static constexpr std::size_t strlen = INET_ADDRSTRLEN; 82 }; 83 84 template <> 85 struct FamilyTraits<AF_INET6> 86 { 87 using addr = in6_addr; 88 static constexpr std::size_t strlen = INET6_ADDRSTRLEN; 89 }; 90 91 template <typename Addr> 92 struct AddrToFamily 93 { 94 }; 95 96 template <> 97 struct AddrToFamily<in_addr> 98 { 99 static constexpr int value = AF_INET; 100 }; 101 102 template <> 103 struct AddrToFamily<in6_addr> 104 { 105 static constexpr int value = AF_INET6; 106 }; 107 108 /* @brief converts a sockaddr for the specified address family into 109 * a type_safe InAddrAny. 110 * @param[in] family - The address family of the buf 111 * @param[in] buf - The network byte order address 112 */ 113 template <int family> 114 typename FamilyTraits<family>::addr addrFromBuf(std::string_view buf); 115 InAddrAny addrFromBuf(int family, std::string_view buf); 116 117 /* @brief converts the ip bytes into a string representation 118 * @param[in] addr - input ip address to convert. 119 * @returns String representation of the ip. 120 */ 121 template <typename Addr> 122 std::string toString(const Addr& addr); 123 std::string toString(const InAddrAny& addr); 124 125 /* @brief checks that the given ip address valid or not. 126 * @param[in] family - IP address family(AF_INET/AF_INET6). 127 * @param[in] address - IP address. 128 * @returns true if it is valid otherwise false. 129 */ 130 bool isValidIP(int family, stdplus::const_zstring address) noexcept; 131 bool isValidIP(stdplus::const_zstring address) noexcept; 132 133 /* @brief checks that the given prefix is valid or not. 134 * @param[in] family - IP address family(AF_INET/AF_INET6). 135 * @param[in] prefix - prefix length. 136 * @returns true if it is valid otherwise false. 137 */ 138 template <int family> 139 constexpr bool isValidPrefix(uint8_t prefix) noexcept 140 { 141 return prefix <= sizeof(typename FamilyTraits<family>::addr) * 8; 142 } 143 bool isValidPrefix(int family, uint8_t prefixLength); 144 145 /** @brief Get all the interfaces from the system. 146 * @returns list of interface names. 147 */ 148 string_uset getSystemInterfaces(); 149 150 /** @brief Delete the given interface. 151 * @param[in] intf - interface name. 152 */ 153 void deleteInterface(stdplus::const_zstring intf); 154 155 /** @brief Converts the interface name into a u-boot environment 156 * variable that would hold its ethernet address. 157 * 158 * @param[in] intf - interface name 159 * @return The name of th environment key 160 */ 161 std::optional<std::string> interfaceToUbootEthAddr(std::string_view intf); 162 163 /** @brief read the IPv6AcceptRA value from the configuration file 164 * @param[in] config - The parsed configuration. 165 */ 166 bool getIPv6AcceptRA(const config::Parser& config); 167 168 /** @brief read the DHCP value from the configuration file 169 * @param[in] config - The parsed configuration. 170 */ 171 struct DHCPVal 172 { 173 bool v4, v6; 174 }; 175 DHCPVal getDHCPValue(const config::Parser& config); 176 177 /** @brief Read a boolean DHCP property from a conf file 178 * @param[in] config - The parsed configuration. 179 * @param[in] key - The property name. 180 */ 181 bool getDHCPProp(const config::Parser& config, std::string_view key); 182 183 namespace internal 184 { 185 186 /* @brief runs the given command in child process. 187 * @param[in] path - path of the binary file which needs to be execeuted. 188 * @param[in] args - arguments of the command. 189 */ 190 void executeCommandinChildProcess(stdplus::const_zstring path, char** args); 191 192 /** @brief Get ignored interfaces from environment */ 193 std::string_view getIgnoredInterfacesEnv(); 194 195 /** @brief Parse the comma separated interface names */ 196 std::unordered_set<std::string_view> 197 parseInterfaces(std::string_view interfaces); 198 199 /** @brief Get the ignored interfaces */ 200 const std::unordered_set<std::string_view>& getIgnoredInterfaces(); 201 202 } // namespace internal 203 204 /* @brief runs the given command in child process. 205 * @param[in] path -path of the binary file which needs to be execeuted. 206 * @param[in] tArgs - arguments of the command. 207 */ 208 template <typename... ArgTypes> 209 void execute(stdplus::const_zstring path, ArgTypes&&... tArgs) 210 { 211 using expandType = char*[]; 212 213 expandType args = {const_cast<char*>(tArgs)..., nullptr}; 214 215 internal::executeCommandinChildProcess(path, args); 216 } 217 218 } // namespace network 219 220 } // namespace phosphor 221