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 constexpr auto networkdService = "systemd-networkd.service"; 73 constexpr auto timeSynchdService = "systemd-timesyncd.service"; 74 75 template <int family> 76 struct FamilyTraits 77 { 78 }; 79 80 template <> 81 struct FamilyTraits<AF_INET> 82 { 83 using addr = in_addr; 84 }; 85 86 template <> 87 struct FamilyTraits<AF_INET6> 88 { 89 using addr = in6_addr; 90 }; 91 92 /* @brief converts a sockaddr for the specified address family into 93 * a type_safe InAddrAny. 94 * @param[in] family - The address family of the buf 95 * @param[in] buf - The network byte order address 96 */ 97 template <int family> 98 typename FamilyTraits<family>::addr addrFromBuf(std::string_view buf); 99 InAddrAny addrFromBuf(int family, std::string_view buf); 100 101 /* @brief converts the ip bytes into a string representation 102 * @param[in] addr - input ip address to convert. 103 * @returns String representation of the ip. 104 */ 105 std::string toString(const InAddrAny& addr); 106 std::string toString(const struct in_addr& addr); 107 std::string toString(const struct in6_addr& addr); 108 109 /* @brief checks that the given ip address valid or not. 110 * @param[in] family - IP address family(AF_INET/AF_INET6). 111 * @param[in] address - IP address. 112 * @returns true if it is valid otherwise false. 113 */ 114 bool isValidIP(int family, stdplus::const_zstring address) noexcept; 115 116 /* @brief checks that the given prefix is valid or not. 117 * @param[in] family - IP address family(AF_INET/AF_INET6). 118 * @param[in] prefix - prefix length. 119 * @returns true if it is valid otherwise false. 120 */ 121 template <int family> 122 constexpr bool isValidPrefix(uint8_t prefix) noexcept 123 { 124 return prefix <= sizeof(typename FamilyTraits<family>::addr) * 8; 125 } 126 bool isValidPrefix(int family, uint8_t prefixLength); 127 128 /** @brief Get all the interfaces from the system. 129 * @returns list of interface names. 130 */ 131 InterfaceList getInterfaces(); 132 133 /** @brief Delete the given interface. 134 * @param[in] intf - interface name. 135 */ 136 void deleteInterface(stdplus::const_zstring intf); 137 138 /** @brief Converts the interface name into a u-boot environment 139 * variable that would hold its ethernet address. 140 * 141 * @param[in] intf - interface name 142 * @return The name of th environment key 143 */ 144 std::optional<std::string> interfaceToUbootEthAddr(std::string_view intf); 145 146 /** @brief read the IPv6AcceptRA value from the configuration file 147 * @param[in] config - The parsed configuration. 148 */ 149 bool getIPv6AcceptRA(const config::Parser& config); 150 151 /** @brief read the DHCP value from the configuration file 152 * @param[in] config - The parsed configuration. 153 */ 154 struct DHCPVal 155 { 156 bool v4, v6; 157 }; 158 DHCPVal getDHCPValue(const config::Parser& config); 159 160 /** @brief Read a boolean DHCP property from a conf file 161 * @param[in] config - The parsed configuration. 162 * @param[in] key - The property name. 163 */ 164 bool getDHCPProp(const config::Parser& config, std::string_view key); 165 166 namespace internal 167 { 168 169 /* @brief runs the given command in child process. 170 * @param[in] path - path of the binary file which needs to be execeuted. 171 * @param[in] args - arguments of the command. 172 */ 173 void executeCommandinChildProcess(stdplus::const_zstring path, char** args); 174 175 /** @brief Get ignored interfaces from environment */ 176 std::string_view getIgnoredInterfacesEnv(); 177 178 /** @brief Parse the comma separated interface names */ 179 std::unordered_set<std::string_view> 180 parseInterfaces(std::string_view interfaces); 181 182 /** @brief Get the ignored interfaces */ 183 const std::unordered_set<std::string_view>& getIgnoredInterfaces(); 184 185 } // namespace internal 186 187 /* @brief runs the given command in child process. 188 * @param[in] path -path of the binary file which needs to be execeuted. 189 * @param[in] tArgs - arguments of the command. 190 */ 191 template <typename... ArgTypes> 192 void execute(stdplus::const_zstring path, ArgTypes&&... tArgs) 193 { 194 using expandType = char*[]; 195 196 expandType args = {const_cast<char*>(tArgs)..., nullptr}; 197 198 internal::executeCommandinChildProcess(path, args); 199 } 200 201 } // namespace network 202 203 } // namespace phosphor 204