blob: 804d4920dab52d9c327499640b093dba528a07bb [file] [log] [blame]
Ratan Gupta8804feb2017-05-25 10:49:57 +05301#pragma once
2
Ratan Gupta068a8cf2017-07-11 19:18:29 +05303#include "config.h"
Gunnar Mills57d9c502018-09-14 14:42:34 -05004
Alvin Wang38a63c32019-08-29 22:56:46 +08005#include "ethernet_interface.hpp"
Ratan Gupta3681a502017-06-17 19:20:04 +05306#include "types.hpp"
Patrick Venture189d44e2018-07-09 12:30:59 -07007
William A. Kennington III4966e962019-04-08 01:58:10 -07008#include <netinet/ether.h>
Patrick Venture189d44e2018-07-09 12:30:59 -07009#include <unistd.h>
10
William A. Kennington III4966e962019-04-08 01:58:10 -070011#include <cstring>
William A. Kennington III7b9e8bd2019-04-23 19:31:31 -070012#include <optional>
Patrick Venture189d44e2018-07-09 12:30:59 -070013#include <sdbusplus/bus.hpp>
William A. Kennington IIId27410f2019-01-30 17:15:43 -080014#include <string>
William A. Kennington IIIa00b1c32019-02-01 18:57:17 -080015#include <string_view>
Johnathan Mantey817012a2020-01-30 15:07:39 -080016#include <xyz/openbmc_project/Network/EthernetInterface/server.hpp>
Ratan Gupta8804feb2017-05-25 10:49:57 +053017
18namespace phosphor
19{
20namespace network
21{
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050022
Johnathan Mantey817012a2020-01-30 15:07:39 -080023using EthernetInterfaceIntf =
24 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface;
25
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050026constexpr auto IPV4_MIN_PREFIX_LENGTH = 1;
27constexpr auto IPV4_MAX_PREFIX_LENGTH = 32;
John Wang4d94ecd2021-04-07 17:37:03 +080028constexpr auto IPV6_MAX_PREFIX_LENGTH = 128;
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050029constexpr auto IPV4_PREFIX = "169.254";
30constexpr auto IPV6_PREFIX = "fe80";
31
Ratan Guptabd303b12017-08-18 17:10:07 +053032namespace mac_address
33{
34
Ratan Guptabd303b12017-08-18 17:10:07 +053035/** @brief gets the MAC address from the Inventory.
36 * @param[in] bus - DBUS Bus Object.
Alvin Wang38a63c32019-08-29 22:56:46 +080037 * @param[in] intfName - Interface name
Ratan Guptabd303b12017-08-18 17:10:07 +053038 */
Alvin Wang38a63c32019-08-29 22:56:46 +080039ether_addr getfromInventory(sdbusplus::bus::bus& bus,
40 const std::string& intfName);
William A. Kennington III1137a972019-04-20 20:49:58 -070041
42/** @brief Converts the given mac address into byte form
43 * @param[in] str - The mac address in human readable form
44 * @returns A mac address in network byte order
45 * @throws std::runtime_error for bad mac
46 */
William A. Kennington III1c776022022-01-05 14:12:16 -080047ether_addr fromString(const char* str);
48inline ether_addr fromString(const std::string& str)
49{
50 return fromString(str.c_str());
51}
Ratan Guptabd303b12017-08-18 17:10:07 +053052
William A. Kennington IIId27410f2019-01-30 17:15:43 -080053/** @brief Converts the given mac address bytes into a string
William A. Kennington III1137a972019-04-20 20:49:58 -070054 * @param[in] mac - The mac address
William A. Kennington IIId27410f2019-01-30 17:15:43 -080055 * @returns A valid mac address string
56 */
William A. Kennington III6ca08d82019-04-20 16:04:18 -070057std::string toString(const ether_addr& mac);
William A. Kennington IIId27410f2019-01-30 17:15:43 -080058
William A. Kennington III1137a972019-04-20 20:49:58 -070059/** @brief Determines if the mac address is empty
60 * @param[in] mac - The mac address
61 * @return True if 00:00:00:00:00:00
Ratan Guptabd303b12017-08-18 17:10:07 +053062 */
William A. Kennington III1137a972019-04-20 20:49:58 -070063bool isEmpty(const ether_addr& mac);
Ratan Guptabd303b12017-08-18 17:10:07 +053064
William A. Kennington III1137a972019-04-20 20:49:58 -070065/** @brief Determines if the mac address is a multicast address
66 * @param[in] mac - The mac address
67 * @return True if multicast bit is set
68 */
69bool isMulticast(const ether_addr& mac);
70
71/** @brief Determines if the mac address is a unicast address
72 * @param[in] mac - The mac address
73 * @return True if not multicast or empty
74 */
75bool isUnicast(const ether_addr& mac);
76
Gunnar Mills57d9c502018-09-14 14:42:34 -050077} // namespace mac_address
Ratan Gupta8804feb2017-05-25 10:49:57 +053078
Ratan Gupta497c0c92017-08-22 19:15:59 +053079constexpr auto networkdService = "systemd-networkd.service";
80constexpr auto timeSynchdService = "systemd-timesyncd.service";
81
Ratan Gupta8804feb2017-05-25 10:49:57 +053082/* @brief converts the given subnet into prefix notation.
83 * @param[in] addressFamily - IP address family(AF_INET/AF_INET6).
84 * @param[in] mask - Subnet Mask.
85 * @returns prefix.
86 */
87uint8_t toCidr(int addressFamily, const std::string& mask);
88
William A. Kennington IIIa00b1c32019-02-01 18:57:17 -080089/* @brief converts a sockaddr for the specified address family into
90 * a type_safe InAddrAny.
91 * @param[in] addressFamily - The address family of the buf
92 * @param[in] buf - The network byte order address
93 */
94InAddrAny addrFromBuf(int addressFamily, std::string_view buf);
95
William A. Kennington III5058f572019-01-30 17:18:14 -080096/* @brief converts the ip bytes into a string representation
97 * @param[in] addr - input ip address to convert.
98 * @returns String representation of the ip.
99 */
100std::string toString(const InAddrAny& addr);
Alexander Filippov983da552021-02-08 15:26:54 +0300101std::string toString(const struct in_addr& addr);
102std::string toString(const struct in6_addr& addr);
William A. Kennington III5058f572019-01-30 17:18:14 -0800103
Ratan Gupta8804feb2017-05-25 10:49:57 +0530104/* @brief converts the prefix into subnetmask.
105 * @param[in] addressFamily - IP address family(AF_INET/AF_INET6).
106 * @param[in] prefix - prefix length.
107 * @returns subnet mask.
108 */
109std::string toMask(int addressFamily, uint8_t prefix);
110
111/* @brief checks that the given ip address is link local or not.
112 * @param[in] address - IP address.
113 * @returns true if it is linklocal otherwise false.
114 */
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -0500115bool isLinkLocalIP(const std::string& address);
116
117/* @brief checks that the given ip address valid or not.
118 * @param[in] addressFamily - IP address family(AF_INET/AF_INET6).
119 * @param[in] address - IP address.
120 * @returns true if it is valid otherwise false.
121 */
122bool isValidIP(int addressFamily, const std::string& address);
123
124/* @brief checks that the given prefix is valid or not.
125 * @param[in] addressFamily - IP address family(AF_INET/AF_INET6).
126 * @param[in] prefix - prefix length.
127 * @returns true if it is valid otherwise false.
128 */
129bool isValidPrefix(int addressFamily, uint8_t prefixLength);
Ratan Gupta8804feb2017-05-25 10:49:57 +0530130
Ratan Guptafd4b0f02017-09-16 06:01:24 +0530131/** @brief Gets the map of interface and the associated
132 * address.
133 * @returns map of interface and the address.
Ratan Gupta3681a502017-06-17 19:20:04 +0530134 */
135IntfAddrMap getInterfaceAddrs();
136
Ratan Guptafd4b0f02017-09-16 06:01:24 +0530137/** @brief Get all the interfaces from the system.
138 * @returns list of interface names.
139 */
140InterfaceList getInterfaces();
141
Ratan Guptabc886292017-07-25 18:29:57 +0530142/** @brief Delete the given interface.
143 * @param[in] intf - interface name.
144 */
145void deleteInterface(const std::string& intf);
146
William A. Kennington III7b9e8bd2019-04-23 19:31:31 -0700147/** @brief Converts the interface name into a u-boot environment
148 * variable that would hold its ethernet address.
149 *
150 * @param[in] intf - interface name
151 * @return The name of th environment key
152 */
153std::optional<std::string> interfaceToUbootEthAddr(const char* intf);
154
Ratan Gupta56187e72017-08-13 09:40:14 +0530155/** @brief read the DHCP value from the configuration file
156 * @param[in] confDir - Network configuration directory.
157 * @param[in] intf - Interface name.
158 */
Johnathan Mantey817012a2020-01-30 15:07:39 -0800159EthernetInterfaceIntf::DHCPConf getDHCPValue(const std::string& confDir,
160 const std::string& intf);
Ratan Guptabc886292017-07-25 18:29:57 +0530161
Ratan Guptabd303b12017-08-18 17:10:07 +0530162namespace internal
163{
164
165/* @brief runs the given command in child process.
166 * @param[in] path - path of the binary file which needs to be execeuted.
167 * @param[in] args - arguments of the command.
168 */
169void executeCommandinChildProcess(const char* path, char** args);
170
Lei YU307554e2021-03-18 14:56:50 +0800171/** @brief Get ignored interfaces from environment */
William A. Kennington IIIee5b2c92021-04-28 02:31:28 -0700172std::string_view getIgnoredInterfacesEnv();
Lei YU307554e2021-03-18 14:56:50 +0800173
174/** @brief Parse the comma separated interface names */
William A. Kennington IIIee5b2c92021-04-28 02:31:28 -0700175std::set<std::string_view> parseInterfaces(std::string_view interfaces);
Lei YU307554e2021-03-18 14:56:50 +0800176
177/** @brief Get the ignored interfaces */
William A. Kennington IIIee5b2c92021-04-28 02:31:28 -0700178const std::set<std::string_view>& getIgnoredInterfaces();
Lei YU307554e2021-03-18 14:56:50 +0800179
Ratan Guptabd303b12017-08-18 17:10:07 +0530180} // namespace internal
181
182/* @brief runs the given command in child process.
183 * @param[in] path -path of the binary file which needs to be execeuted.
184 * @param[in] tArgs - arguments of the command.
185 */
Gunnar Mills57d9c502018-09-14 14:42:34 -0500186template <typename... ArgTypes>
Ratan Guptabd303b12017-08-18 17:10:07 +0530187void execute(const char* path, ArgTypes&&... tArgs)
188{
William A. Kennington III0420c6a2019-06-27 14:38:17 -0700189 using expandType = char*[];
Ratan Guptabd303b12017-08-18 17:10:07 +0530190
Gunnar Mills57d9c502018-09-14 14:42:34 -0500191 expandType args = {const_cast<char*>(tArgs)..., nullptr};
Ratan Guptabd303b12017-08-18 17:10:07 +0530192
193 internal::executeCommandinChildProcess(path, args);
194}
195
Gunnar Mills57d9c502018-09-14 14:42:34 -0500196} // namespace network
Ratan Gupta8804feb2017-05-25 10:49:57 +0530197
198class Descriptor
199{
Gunnar Mills57d9c502018-09-14 14:42:34 -0500200 private:
201 /** default value */
202 int fd = -1;
Ratan Gupta8804feb2017-05-25 10:49:57 +0530203
Gunnar Mills57d9c502018-09-14 14:42:34 -0500204 public:
205 Descriptor() = default;
206 Descriptor(const Descriptor&) = delete;
207 Descriptor& operator=(const Descriptor&) = delete;
208 Descriptor(Descriptor&&) = delete;
209 Descriptor& operator=(Descriptor&&) = delete;
Ratan Gupta8804feb2017-05-25 10:49:57 +0530210
Gunnar Mills57d9c502018-09-14 14:42:34 -0500211 explicit Descriptor(int fd) : fd(fd)
212 {
213 }
Ratan Gupta8804feb2017-05-25 10:49:57 +0530214
Gunnar Mills57d9c502018-09-14 14:42:34 -0500215 /* @brief sets the internal file descriptor with the given descriptor
216 * and closes the old descriptor.
217 * @param[in] descriptor - File/Socket descriptor.
218 */
219 void set(int descriptor)
220 {
221 // same descriptor given
222 if (fd == descriptor)
Ratan Gupta0f9dc1b2017-09-03 17:57:50 +0530223 {
Gunnar Mills57d9c502018-09-14 14:42:34 -0500224 return;
Ratan Gupta0f9dc1b2017-09-03 17:57:50 +0530225 }
226
Gunnar Mills57d9c502018-09-14 14:42:34 -0500227 // close the old descriptor
228 if (fd >= 0)
Ratan Gupta8804feb2017-05-25 10:49:57 +0530229 {
Gunnar Mills57d9c502018-09-14 14:42:34 -0500230 close(fd);
Ratan Gupta8804feb2017-05-25 10:49:57 +0530231 }
232
Gunnar Mills57d9c502018-09-14 14:42:34 -0500233 fd = descriptor;
234 }
235
236 ~Descriptor()
237 {
238 if (fd >= 0)
Ratan Gupta8804feb2017-05-25 10:49:57 +0530239 {
Gunnar Mills57d9c502018-09-14 14:42:34 -0500240 close(fd);
Ratan Gupta8804feb2017-05-25 10:49:57 +0530241 }
Gunnar Mills57d9c502018-09-14 14:42:34 -0500242 }
243
244 int operator()() const
245 {
246 return fd;
247 }
Ratan Gupta8804feb2017-05-25 10:49:57 +0530248};
249
Gunnar Mills57d9c502018-09-14 14:42:34 -0500250} // namespace phosphor