1 #pragma once 2 3 #include "types.hpp" 4 #include "property_change_listener.hpp" 5 6 #include <sdbusplus/bus.hpp> 7 #include <sdbusplus/bus/match.hpp> 8 9 #include <set> 10 #include <string> 11 12 namespace phosphor 13 { 14 namespace time 15 { 16 17 /** @class Manager 18 * @brief The manager to handle OpenBMC time. 19 * @details It registers various time related settings and properties signals 20 * on DBus and handle the changes. 21 * For certain properties it also notifies the changed events to listeners. 22 */ 23 class Manager 24 { 25 public: 26 friend class TestManager; 27 28 explicit Manager(sdbusplus::bus::bus& bus); 29 Manager(const Manager&) = delete; 30 Manager& operator=(const Manager&) = delete; 31 Manager(Manager&&) = delete; 32 Manager& operator=(Manager&&) = delete; 33 34 /** @brief Add a listener that will be called 35 * when property is changed 36 **/ 37 void addListener(PropertyChangeListner* listener); 38 39 private: 40 /** @brief Persistent sdbusplus DBus connection */ 41 sdbusplus::bus::bus& bus; 42 43 /** @brief The match of settings property change */ 44 sdbusplus::bus::match::match propertyChangeMatch; 45 46 /** @brief The match of pgood change */ 47 sdbusplus::bus::match::match pgoodChangeMatch; 48 49 /** @brief The container to hold all the listeners */ 50 std::set<PropertyChangeListner*> listeners; 51 52 /** @brief The value to indicate if host is on */ 53 bool hostOn = false; 54 55 /** @brief The requested time mode when host is on*/ 56 std::string requestedMode; 57 58 /** @brief The requested time owner when host is on*/ 59 std::string requestedOwner; 60 61 /** @brief The current time mode */ 62 Mode timeMode; 63 64 /** @brief The current time owner */ 65 Owner timeOwner; 66 67 /** @brief Restore saved settings */ 68 void restoreSettings(); 69 70 /** @brief Check if host is on and update hostOn variable */ 71 void checkHostOn(); 72 73 /** @brief Check if use_dhcp_ntp is used and update NTP setting */ 74 void checkDhcpNtp(); 75 76 /** @brief Get setting from settingsd service 77 * 78 * @param[in] setting - The string of the setting 79 * 80 * @return The setting value in string 81 */ 82 std::string getSettings(const char* setting) const; 83 84 /** @brief Set current time mode from the time mode string 85 * 86 * @param[in] mode - The string of time mode 87 * 88 * @return - true if the mode is updated 89 * false if it's the same as before 90 */ 91 bool setCurrentTimeMode(const std::string& mode); 92 93 /** @brief Set current time owner from the time owner string 94 * 95 * @param[in] owner - The string of time owner 96 * 97 * @return - true if the owner is updated 98 * false if it's the same as before 99 */ 100 bool setCurrentTimeOwner(const std::string& owner); 101 102 /** @brief Called on time mode is changed 103 * 104 * Notify listeners that time mode is changed and update ntp setting 105 * 106 * @param[in] mode - The string of time mode 107 */ 108 void onTimeModeChanged(const std::string& mode); 109 110 /** @brief Called on time owner is changed 111 * 112 * Notify listeners that time owner is changed 113 */ 114 void onTimeOwnerChanged(); 115 116 /** @brief Notified on settings property changed 117 * 118 * @param[in] key - The name of property that is changed 119 * @param[in] value - The value of the property 120 */ 121 void onPropertyChanged(const std::string& key, 122 const std::string& value); 123 124 /** @brief Notified on pgood has changed 125 * 126 * @param[in] pgood - The changed pgood value 127 */ 128 void onPgoodChanged(bool pgood); 129 130 /** @brief Set the property as requested time mode/owner 131 * 132 * @param[in] key - The property name 133 * @param[in] value - The property value 134 */ 135 void setPropertyAsRequested(const std::string& key, 136 const std::string& value); 137 138 /** @brief Set the current mode to user requested one 139 * if conditions allow it 140 * 141 * @param[in] mode - The string of time mode 142 */ 143 void setRequestedMode(const std::string& mode); 144 145 /** @brief Set the current owner to user requested one 146 * if conditions allow it 147 * 148 * @param[in] owner - The string of time owner 149 */ 150 void setRequestedOwner(const std::string& owner); 151 152 /** @brief Update the NTP setting to systemd time service 153 * 154 * @param[in] value - The time mode value, e.g. "NTP" or "MANUAL" 155 */ 156 void updateNtpSetting(const std::string& value); 157 158 /** @brief Update dhcp_ntp setting to OpenBMC network service 159 * 160 * @param[in] value - The use_dhcp_ntp value, e.g. "yes" or "no" 161 */ 162 void updateDhcpNtpSetting(const std::string& useDhcpNtp); 163 164 /** @brief The static function called on settings property changed 165 * 166 * @param[in] msg - Data associated with subscribed signal 167 * @param[in] userData - Pointer to this object instance 168 * @param[out] retError - Not used but required with signal API 169 */ 170 static int onPropertyChanged(sd_bus_message* msg, 171 void* userData, 172 sd_bus_error* retError); 173 174 /** @brief Notified on pgood has changed 175 * 176 * @param[in] msg - Data associated with subscribed signal 177 * @param[in] userData - Pointer to this object instance 178 * @param[out] retError - Not used but required with signal API 179 */ 180 static int onPgoodChanged(sd_bus_message* msg, 181 void* userData, 182 sd_bus_error* retError); 183 184 /** @brief The string of time mode property */ 185 static constexpr auto PROPERTY_TIME_MODE = "time_mode"; 186 187 /** @brief The string of time owner property */ 188 static constexpr auto PROPERTY_TIME_OWNER = "time_owner"; 189 190 /** @brief The string of use dhcp ntp property */ 191 static constexpr auto PROPERTY_DHCP_NTP = "use_dhcp_ntp"; 192 193 using Updater = std::function<void(const std::string&)>; 194 195 /** @brief Map the property string to functions that shall 196 * be called when the property is changed 197 */ 198 const std::map<std::string, Updater> propertyUpdaters = 199 { 200 {PROPERTY_TIME_MODE, std::bind(&Manager::setCurrentTimeMode, 201 this, std::placeholders::_1)}, 202 {PROPERTY_TIME_OWNER, std::bind(&Manager::setCurrentTimeOwner, 203 this, std::placeholders::_1)} 204 }; 205 206 /** @brief The properties that manager shall notify the 207 * listeners when changed 208 */ 209 static const std::set<std::string> managedProperties; 210 211 /** @brief The map that maps the string to Owners */ 212 static const std::map<std::string, Owner> ownerMap; 213 214 /** @brief The file name of saved time mode */ 215 static constexpr auto modeFile = "/var/lib/obmc/saved_time_mode"; 216 217 /** @brief The file name of saved time owner */ 218 static constexpr auto ownerFile = "/var/lib/obmc/saved_time_owner"; 219 }; 220 221 } 222 } 223