blob: ea9d767ad28b2215dabeb90386d3ba2ce5ff39b1 [file] [log] [blame]
Ratan Gupta8804feb2017-05-25 10:49:57 +05301#pragma once
Ratan Gupta3681a502017-06-17 19:20:04 +05302#include "types.hpp"
Patrick Venture189d44e2018-07-09 12:30:59 -07003
William A. Kennington IIIfd862be2022-10-09 18:40:55 -07004#include <net/ethernet.h>
William A. Kennington IIIe5a48ab2019-04-22 03:55:23 -07005#include <netinet/in.h>
Patrick Venture189d44e2018-07-09 12:30:59 -07006#include <unistd.h>
7
William A. Kennington III4966e962019-04-08 01:58:10 -07008#include <cstring>
William A. Kennington IIIa520a392022-08-08 12:17:34 -07009#include <filesystem>
William A. Kennington III7b9e8bd2019-04-23 19:31:31 -070010#include <optional>
Patrick Venture189d44e2018-07-09 12:30:59 -070011#include <sdbusplus/bus.hpp>
William A. Kennington III69f45542022-09-24 23:28:14 -070012#include <stdplus/zstring.hpp>
William A. Kennington IIId27410f2019-01-30 17:15:43 -080013#include <string>
William A. Kennington IIIa00b1c32019-02-01 18:57:17 -080014#include <string_view>
William A. Kennington III95530ec2022-08-19 01:44:39 -070015#include <unordered_set>
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{
William A. Kennington III20efa792022-10-04 17:19:08 -070022namespace config
23{
24class Parser;
25}
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050026
Johnathan Mantey817012a2020-01-30 15:07:39 -080027using EthernetInterfaceIntf =
28 sdbusplus::xyz::openbmc_project::Network::server::EthernetInterface;
29
Ratan Guptabd303b12017-08-18 17:10:07 +053030namespace mac_address
31{
32
Ratan Guptabd303b12017-08-18 17:10:07 +053033/** @brief gets the MAC address from the Inventory.
34 * @param[in] bus - DBUS Bus Object.
Alvin Wang38a63c32019-08-29 22:56:46 +080035 * @param[in] intfName - Interface name
Ratan Guptabd303b12017-08-18 17:10:07 +053036 */
Patrick Williamsc38b0712022-07-22 19:26:54 -050037ether_addr getfromInventory(sdbusplus::bus_t& bus, const std::string& intfName);
William A. Kennington III1137a972019-04-20 20:49:58 -070038
William A. Kennington III1137a972019-04-20 20:49:58 -070039/** @brief Determines if the mac address is empty
40 * @param[in] mac - The mac address
41 * @return True if 00:00:00:00:00:00
Ratan Guptabd303b12017-08-18 17:10:07 +053042 */
William A. Kennington III1137a972019-04-20 20:49:58 -070043bool isEmpty(const ether_addr& mac);
Ratan Guptabd303b12017-08-18 17:10:07 +053044
William A. Kennington III1137a972019-04-20 20:49:58 -070045/** @brief Determines if the mac address is a multicast address
46 * @param[in] mac - The mac address
47 * @return True if multicast bit is set
48 */
49bool isMulticast(const ether_addr& mac);
50
51/** @brief Determines if the mac address is a unicast address
52 * @param[in] mac - The mac address
53 * @return True if not multicast or empty
54 */
55bool isUnicast(const ether_addr& mac);
56
Gunnar Mills57d9c502018-09-14 14:42:34 -050057} // namespace mac_address
Ratan Gupta8804feb2017-05-25 10:49:57 +053058
William A. Kennington IIIe5a48ab2019-04-22 03:55:23 -070059template <int family>
60struct FamilyTraits
61{
62};
63
64template <>
65struct FamilyTraits<AF_INET>
66{
67 using addr = in_addr;
68};
69
70template <>
71struct FamilyTraits<AF_INET6>
72{
73 using addr = in6_addr;
74};
75
William A. Kennington IIIa00b1c32019-02-01 18:57:17 -080076/* @brief converts a sockaddr for the specified address family into
77 * a type_safe InAddrAny.
William A. Kennington III97b5dc62022-10-07 14:01:29 -070078 * @param[in] family - The address family of the buf
William A. Kennington IIIa00b1c32019-02-01 18:57:17 -080079 * @param[in] buf - The network byte order address
80 */
William A. Kennington III97b5dc62022-10-07 14:01:29 -070081template <int family>
82typename FamilyTraits<family>::addr addrFromBuf(std::string_view buf);
83InAddrAny addrFromBuf(int family, std::string_view buf);
William A. Kennington IIIa00b1c32019-02-01 18:57:17 -080084
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050085/* @brief checks that the given ip address valid or not.
William A. Kennington III9f228302022-10-07 14:02:49 -070086 * @param[in] family - IP address family(AF_INET/AF_INET6).
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050087 * @param[in] address - IP address.
88 * @returns true if it is valid otherwise false.
89 */
William A. Kennington III9f228302022-10-07 14:02:49 -070090bool isValidIP(int family, stdplus::const_zstring address) noexcept;
William A. Kennington IIIff12acb2022-10-07 19:06:56 -070091bool isValidIP(stdplus::const_zstring address) noexcept;
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050092
93/* @brief checks that the given prefix is valid or not.
William A. Kennington IIIe5a48ab2019-04-22 03:55:23 -070094 * @param[in] family - IP address family(AF_INET/AF_INET6).
Nagaraju Goruganti66b974d2017-10-03 08:43:08 -050095 * @param[in] prefix - prefix length.
96 * @returns true if it is valid otherwise false.
97 */
William A. Kennington IIIe5a48ab2019-04-22 03:55:23 -070098template <int family>
99constexpr bool isValidPrefix(uint8_t prefix) noexcept
100{
101 return prefix <= sizeof(typename FamilyTraits<family>::addr) * 8;
102}
103bool isValidPrefix(int family, uint8_t prefixLength);
Ratan Gupta8804feb2017-05-25 10:49:57 +0530104
Ratan Guptabc886292017-07-25 18:29:57 +0530105/** @brief Delete the given interface.
106 * @param[in] intf - interface name.
107 */
William A. Kennington III69f45542022-09-24 23:28:14 -0700108void deleteInterface(stdplus::const_zstring intf);
Ratan Guptabc886292017-07-25 18:29:57 +0530109
William A. Kennington III7b9e8bd2019-04-23 19:31:31 -0700110/** @brief Converts the interface name into a u-boot environment
111 * variable that would hold its ethernet address.
112 *
113 * @param[in] intf - interface name
114 * @return The name of th environment key
115 */
William A. Kennington III69f45542022-09-24 23:28:14 -0700116std::optional<std::string> interfaceToUbootEthAddr(std::string_view intf);
William A. Kennington III7b9e8bd2019-04-23 19:31:31 -0700117
William A. Kennington IIIa520a392022-08-08 12:17:34 -0700118/** @brief read the IPv6AcceptRA value from the configuration file
119 * @param[in] config - The parsed configuration.
Ratan Gupta56187e72017-08-13 09:40:14 +0530120 */
William A. Kennington IIIa520a392022-08-08 12:17:34 -0700121bool getIPv6AcceptRA(const config::Parser& config);
122
123/** @brief read the DHCP value from the configuration file
124 * @param[in] config - The parsed configuration.
125 */
William A. Kennington III8060c0d2022-08-18 19:19:34 -0700126struct DHCPVal
127{
128 bool v4, v6;
129};
130DHCPVal getDHCPValue(const config::Parser& config);
Ratan Guptabc886292017-07-25 18:29:57 +0530131
William A. Kennington IIIe94c9ff2022-08-18 20:12:27 -0700132/** @brief Read a boolean DHCP property from a conf file
133 * @param[in] config - The parsed configuration.
134 * @param[in] key - The property name.
135 */
136bool getDHCPProp(const config::Parser& config, std::string_view key);
137
Ratan Guptabd303b12017-08-18 17:10:07 +0530138namespace internal
139{
140
141/* @brief runs the given command in child process.
142 * @param[in] path - path of the binary file which needs to be execeuted.
143 * @param[in] args - arguments of the command.
144 */
William A. Kennington III69f45542022-09-24 23:28:14 -0700145void executeCommandinChildProcess(stdplus::const_zstring path, char** args);
Ratan Guptabd303b12017-08-18 17:10:07 +0530146
Lei YU307554e2021-03-18 14:56:50 +0800147/** @brief Get ignored interfaces from environment */
William A. Kennington IIIee5b2c92021-04-28 02:31:28 -0700148std::string_view getIgnoredInterfacesEnv();
Lei YU307554e2021-03-18 14:56:50 +0800149
150/** @brief Parse the comma separated interface names */
William A. Kennington III95530ec2022-08-19 01:44:39 -0700151std::unordered_set<std::string_view>
152 parseInterfaces(std::string_view interfaces);
Lei YU307554e2021-03-18 14:56:50 +0800153
154/** @brief Get the ignored interfaces */
William A. Kennington III95530ec2022-08-19 01:44:39 -0700155const std::unordered_set<std::string_view>& getIgnoredInterfaces();
Lei YU307554e2021-03-18 14:56:50 +0800156
Ratan Guptabd303b12017-08-18 17:10:07 +0530157} // namespace internal
158
159/* @brief runs the given command in child process.
160 * @param[in] path -path of the binary file which needs to be execeuted.
161 * @param[in] tArgs - arguments of the command.
162 */
Gunnar Mills57d9c502018-09-14 14:42:34 -0500163template <typename... ArgTypes>
William A. Kennington III69f45542022-09-24 23:28:14 -0700164void execute(stdplus::const_zstring path, ArgTypes&&... tArgs)
Ratan Guptabd303b12017-08-18 17:10:07 +0530165{
William A. Kennington III0420c6a2019-06-27 14:38:17 -0700166 using expandType = char*[];
Ratan Guptabd303b12017-08-18 17:10:07 +0530167
Gunnar Mills57d9c502018-09-14 14:42:34 -0500168 expandType args = {const_cast<char*>(tArgs)..., nullptr};
Ratan Guptabd303b12017-08-18 17:10:07 +0530169
170 internal::executeCommandinChildProcess(path, args);
171}
172
Gunnar Mills57d9c502018-09-14 14:42:34 -0500173} // namespace network
Ratan Gupta8804feb2017-05-25 10:49:57 +0530174
Gunnar Mills57d9c502018-09-14 14:42:34 -0500175} // namespace phosphor