Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Manojkiran Eda | a879baa | 2020-06-13 14:39:08 +0530 | [diff] [blame] | 3 | #include <filesystem> |
William A. Kennington III | e21a5cf | 2022-08-09 12:19:14 -0700 | [diff] [blame] | 4 | #include <functional> |
William A. Kennington III | 150753f | 2022-08-05 15:20:54 -0700 | [diff] [blame] | 5 | #include <optional> |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 6 | #include <ostream> |
Patrick Venture | 189d44e | 2018-07-09 12:30:59 -0700 | [diff] [blame] | 7 | #include <string> |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 8 | #include <string_view> |
Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 9 | #include <unordered_map> |
| 10 | #include <vector> |
Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 11 | |
| 12 | namespace phosphor |
| 13 | { |
| 14 | namespace network |
| 15 | { |
| 16 | namespace config |
| 17 | { |
| 18 | |
William A. Kennington III | 150753f | 2022-08-05 15:20:54 -0700 | [diff] [blame] | 19 | /** @brief Compare in (case insensitive) vs expected (sensitive) */ |
| 20 | bool icaseeq(std::string_view in, std::string_view expected) noexcept; |
| 21 | /** @brief Turns a systemd bool string into a c++ bool */ |
| 22 | std::optional<bool> parseBool(std::string_view in) noexcept; |
| 23 | |
William A. Kennington III | a520a39 | 2022-08-08 12:17:34 -0700 | [diff] [blame] | 24 | namespace fs = std::filesystem; |
| 25 | |
| 26 | fs::path pathForIntfConf(const fs::path& dir, std::string_view intf); |
| 27 | fs::path pathForIntfDev(const fs::path& dir, std::string_view intf); |
| 28 | |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 29 | template <typename T, typename Check> |
| 30 | class Checked |
| 31 | { |
| 32 | public: |
| 33 | struct unchecked |
Patrick Williams | 89d734b | 2023-05-10 07:50:25 -0500 | [diff] [blame] | 34 | {}; |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 35 | |
| 36 | template <typename... Args> |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 37 | constexpr Checked(Args&&... args) : t(conCheck(std::forward<Args>(args)...)) |
Patrick Williams | 89d734b | 2023-05-10 07:50:25 -0500 | [diff] [blame] | 38 | {} |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 39 | |
| 40 | template <typename... Args> |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 41 | constexpr Checked(unchecked, Args&&... args) : |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 42 | t(std::forward<Args>(args)...) |
Patrick Williams | 89d734b | 2023-05-10 07:50:25 -0500 | [diff] [blame] | 43 | {} |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 44 | |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 45 | constexpr const T& get() const noexcept |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 46 | { |
| 47 | return t; |
| 48 | } |
| 49 | |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 50 | constexpr operator const T&() const noexcept |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 51 | { |
| 52 | return t; |
| 53 | } |
| 54 | |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 55 | constexpr bool operator==(const auto& rhs) const noexcept |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 56 | { |
| 57 | return t == rhs; |
| 58 | } |
| 59 | |
| 60 | private: |
| 61 | T t; |
| 62 | |
| 63 | template <typename... Args> |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 64 | static constexpr T conCheck(Args&&... args) |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 65 | { |
| 66 | T t(std::forward<Args>(args)...); |
| 67 | Check{}(t); |
| 68 | return t; |
| 69 | } |
| 70 | }; |
| 71 | |
| 72 | template <typename T, typename Check> |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 73 | constexpr bool operator==(const auto& lhs, |
| 74 | const Checked<T, Check>& rhs) noexcept |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 75 | { |
| 76 | return lhs == rhs.get(); |
| 77 | } |
| 78 | |
| 79 | template <typename T, typename Check> |
William A. Kennington III | f55b7d8 | 2022-10-25 14:21:46 -0700 | [diff] [blame] | 80 | inline std::ostream& operator<<(std::ostream& s, const Checked<T, Check>& rhs) |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 81 | { |
| 82 | return s << rhs.get(); |
| 83 | } |
| 84 | |
| 85 | struct KeyCheck |
| 86 | { |
William A. Kennington III | be3bd2f | 2022-10-11 14:11:27 -0700 | [diff] [blame] | 87 | void operator()(std::string_view s); |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 88 | }; |
| 89 | struct SectionCheck |
| 90 | { |
William A. Kennington III | be3bd2f | 2022-10-11 14:11:27 -0700 | [diff] [blame] | 91 | void operator()(std::string_view s); |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 92 | }; |
| 93 | struct ValueCheck |
| 94 | { |
William A. Kennington III | be3bd2f | 2022-10-11 14:11:27 -0700 | [diff] [blame] | 95 | void operator()(std::string_view s); |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 96 | }; |
| 97 | |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 98 | struct string_hash : public std::hash<std::string_view> |
| 99 | { |
| 100 | using is_transparent = void; |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 101 | |
| 102 | template <typename T> |
| 103 | inline size_t operator()(const Checked<std::string, T>& t) const |
| 104 | { |
| 105 | return static_cast<const std::hash<std::string_view>&>(*this)(t.get()); |
| 106 | } |
| 107 | template <typename T> |
| 108 | inline size_t operator()(const T& t) const |
| 109 | { |
| 110 | return static_cast<const std::hash<std::string_view>&>(*this)(t); |
| 111 | } |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 112 | }; |
| 113 | |
William A. Kennington III | 0dd0937 | 2022-08-18 14:57:07 -0700 | [diff] [blame] | 114 | using Key = Checked<std::string, KeyCheck>; |
| 115 | using Section = Checked<std::string, SectionCheck>; |
| 116 | using Value = Checked<std::string, ValueCheck>; |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 117 | using ValueList = std::vector<Value>; |
| 118 | using KeyValuesMap = |
| 119 | std::unordered_map<Key, ValueList, string_hash, std::equal_to<>>; |
William A. Kennington III | e21a5cf | 2022-08-09 12:19:14 -0700 | [diff] [blame] | 120 | using KeyValuesMapList = std::vector<KeyValuesMap>; |
| 121 | using SectionMapInt = |
| 122 | std::unordered_map<Section, KeyValuesMapList, string_hash, std::equal_to<>>; |
| 123 | |
| 124 | class SectionMap : public SectionMapInt |
| 125 | { |
| 126 | public: |
| 127 | const std::string* getLastValueString(std::string_view section, |
| 128 | std::string_view key) const noexcept; |
| 129 | inline auto getValues(std::string_view section, std::string_view key, |
| 130 | auto&& conv) const |
| 131 | { |
| 132 | std::vector<std::invoke_result_t<decltype(conv), const Value&>> values; |
| 133 | auto sit = find(section); |
| 134 | if (sit == end()) |
| 135 | { |
| 136 | return values; |
| 137 | } |
| 138 | for (const auto& secv : sit->second) |
| 139 | { |
| 140 | auto kit = secv.find(key); |
| 141 | if (kit == secv.end()) |
| 142 | { |
| 143 | continue; |
| 144 | } |
| 145 | for (auto v : kit->second) |
| 146 | { |
| 147 | values.push_back(conv(v)); |
| 148 | } |
| 149 | } |
| 150 | return values; |
| 151 | } |
| 152 | std::vector<std::string> getValueStrings(std::string_view section, |
| 153 | std::string_view key) const; |
| 154 | }; |
Ratan Gupta | c27170a | 2017-11-22 15:44:42 +0530 | [diff] [blame] | 155 | |
Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 156 | class Parser |
| 157 | { |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 158 | public: |
William A. Kennington III | 34bb3e2 | 2022-08-18 15:17:22 -0700 | [diff] [blame] | 159 | SectionMap map; |
| 160 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 161 | Parser() = default; |
Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 162 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 163 | /** @brief Constructor |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 164 | * @param[in] filename - Absolute path of the file which will be parsed. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 165 | */ |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 166 | Parser(const fs::path& filename); |
Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 167 | |
William A. Kennington III | 301e8ad | 2022-11-15 15:45:32 -0800 | [diff] [blame] | 168 | /** @brief Determine if the loaded file exists */ |
| 169 | inline bool getFileExists() const noexcept |
| 170 | { |
| 171 | return fileExists; |
| 172 | } |
| 173 | |
William A. Kennington III | bc52d93 | 2022-08-18 16:34:02 -0700 | [diff] [blame] | 174 | /** @brief Determine if there were warnings parsing the file |
| 175 | * @return The number of parsing issues in the file |
| 176 | */ |
| 177 | inline const std::vector<std::string>& getWarnings() const noexcept |
| 178 | { |
| 179 | return warnings; |
| 180 | } |
| 181 | |
William A. Kennington III | a520a39 | 2022-08-08 12:17:34 -0700 | [diff] [blame] | 182 | /** @brief Get the filename last parsed successfully |
| 183 | * @return file path |
| 184 | */ |
| 185 | inline const fs::path& getFilename() const noexcept |
| 186 | { |
| 187 | return filename; |
| 188 | } |
| 189 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 190 | /** @brief Set the file name and parse it. |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 191 | * @param[in] filename - Absolute path of the file. |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 192 | */ |
William A. Kennington III | 25511a1 | 2022-08-04 16:32:28 -0700 | [diff] [blame] | 193 | void setFile(const fs::path& filename); |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 194 | |
William A. Kennington III | 409f1a6 | 2022-08-11 15:44:37 -0700 | [diff] [blame] | 195 | /** @brief Write the current config to a file */ |
| 196 | void writeFile() const; |
| 197 | void writeFile(const fs::path& filename); |
| 198 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 199 | private: |
William A. Kennington III | 301e8ad | 2022-11-15 15:45:32 -0800 | [diff] [blame] | 200 | bool fileExists = false; |
William A. Kennington III | a520a39 | 2022-08-08 12:17:34 -0700 | [diff] [blame] | 201 | fs::path filename; |
William A. Kennington III | bc52d93 | 2022-08-18 16:34:02 -0700 | [diff] [blame] | 202 | std::vector<std::string> warnings; |
Ratan Gupta | ed123a3 | 2017-06-15 09:07:31 +0530 | [diff] [blame] | 203 | }; |
| 204 | |
Gunnar Mills | 57d9c50 | 2018-09-14 14:42:34 -0500 | [diff] [blame] | 205 | } // namespace config |
| 206 | } // namespace network |
| 207 | } // namespace phosphor |