Synchronize NTP settings with systemd-timedated
Bmcweb get/set the "NTP settings" on phosphor-settings.
phosphor-time-manager and phosphor-settings are responsible to sync the
settings with systemd-timedated. So the services like bmcweb and ipmid
will only have to get/set the property on phosphor-settings.
However, in order to avoid a race condition issue with NTP set, bmcweb
now directly uses systemd instead of routing through phosphor-settings.
As a result, there may be differences in the "NTP settings" between
phosphor-setttings and systemd-timedated. To address this, this commit
adds a match to monitor time sync method changes on systemd-timedated
and updates it to phosphor-settings.
Tested:
```
1. Get current NTP setting:
busctl get-property org.freedesktop.timedate1 /org/freedesktop/timedate1 org.freedesktop.timedate1 NTP
b true
busctl get-property xyz.openbmc_project.Settings /xyz/openbmc_project/time/sync_method xyz.openbmc_project.Time.Synchronization TimeSyncMethod -j
{
"type" : "s",
"data" : "xyz.openbmc_project.Time.Synchronization.Method.NTP"
}
2. Call method in systemd timedate, to change NTP setting:
busctl call org.freedesktop.timedate1 /org/freedesktop/timedate1 org.freedesktop.timedate1 SetNTP bb false false
journal log:
phosphor-time-manager[28150]: Time mode has been changed to xyz.openbmc_project.Time.Synchronization.Method.Manual
phosphor-time-manager[28150]: NTP property changed in systemd time service, update to phosphor-settings.
phosphor-time-manager[28150]: NTP mode is already the same, skip setting to systemd time service again.
3. Get NTP setting again, NTP in phosphor-settings is synced with systemd-timedated:
busctl get-property org.freedesktop.timedate1 /org/freedesktop/timedate1 org.freedesktop.timedate1 NTP
b false
busctl get-property xyz.openbmc_project.Settings /xyz/openbmc_project/time/sync_method xyz.openbmc_project.Time.Synchronization TimeSyncMethod -j
{
"type" : "s",
"data" : "xyz.openbmc_project.Time.Synchronization.Method.Manual"
}
4. Set property in phosphor-settings, to change NTP setting:
busctl set-property xyz.openbmc_project.Settings /xyz/openbmc_project/time/sync_method xyz.openbmc_project.Time.Synchronization TimeSyncMethod s "xyz.openbmc_project.Time.Synchronization.Method.NTP"
journal log:
phosphor-time-manager[28150]: Updated NTP setting: True
phosphor-time-manager[28150]: Time mode has been changed to xyz.openbmc_project.Time.Synchronization.Method.NTP
phosphor-time-manager[28150]: NTP property changed in phosphor-settings, update to systemd time service.
phosphor-time-manager[28150]: NTP mode is already the same, skip setting to phosphor-settings again.
5. Get NTP setting again, NTP in phosphor-settings is synced with systemd-timedated:
busctl get-property org.freedesktop.timedate1 /org/freedesktop/timedate1 org.freedesktop.timedate1 NTP
b true
busctl get-property xyz.openbmc_project.Settings /xyz/openbmc_project/time/sync_method xyz.openbmc_project.Time.Synchronization TimeSyncMethod -j
{
"type" : "s",
"data" : "xyz.openbmc_project.Time.Synchronization.Method.NTP"
}
```
Signed-off-by: Jason Zhu <zhujiesen@bytedance.com>
Change-Id: I192d2257569f46aa0f5473331595c5242d816964
diff --git a/manager.hpp b/manager.hpp
index e8c28e9..263dbfb 100644
--- a/manager.hpp
+++ b/manager.hpp
@@ -48,6 +48,9 @@
/** @brief Persistent sdbusplus DBus connection */
sdbusplus::bus_t& bus;
+ /** @brief The match of systemd timedate property change */
+ std::vector<sdbusplus::bus::match_t> timedateMatches;
+
/** @brief The match of settings property change */
std::vector<sdbusplus::bus::match_t> settingsMatches;
@@ -85,6 +88,14 @@
*/
void onTimeModeChanged(const std::string& mode);
+ /** @brief Callback to handle change in NTP
+ *
+ * @param[in] msg - sdbusplus dbusmessage
+ *
+ * @return 0 on success, < 0 on failure.
+ */
+ int onTimedateChanged(sdbusplus::message_t& msg);
+
/** @brief Callback to handle change in a setting
*
* @param[in] msg - sdbusplus dbusmessage
@@ -97,8 +108,12 @@
*
* @param[in] key - The name of property that is changed
* @param[in] value - The value of the property
+ * @param[in] forceSet - true: Force sync NTP Settings to systemd time
+ * service, only be used during initialization
+ * false: This is default value
*/
- void onPropertyChanged(const std::string& key, const std::string& value);
+ void onPropertyChanged(const std::string& key, const std::string& value,
+ bool forceSet = false);
/** @brief Update the NTP setting to systemd time service
*