manager.cpp - openbmc/phosphor-time-manager - Gitiles

 #include "manager.hpp"
 #include "utils.hpp"

 #include <phosphor-logging/elog.hpp>
 #include <phosphor-logging/elog-errors.hpp>
 #include <phosphor-logging/log.hpp>
 #include <xyz/openbmc_project/Common/error.hpp>

 namespace rules = sdbusplus::bus::match::rules;

 namespace // anonymous
 {
 constexpr auto SETTINGS_PATH = "/org/openbmc/settings/host0";
 constexpr auto SETTINGS_INTERFACE = "org.openbmc.settings.Host";

 // TODO: Use new settings in xyz.openbmc_project
 const auto MATCH_PROPERTY_CHANGE =
     rules::type::signal() +
     rules::member("PropertiesChanged") +
     rules::path("/org/openbmc/settings/host0") +
     rules::interface("org.freedesktop.DBus.Properties");

 const auto MATCH_PGOOD_CHANGE =
     rules::type::signal() +
     rules::member("PropertiesChanged") +
     rules::path("/org/openbmc/control/power0") +
     rules::interface("org.freedesktop.DBus.Properties");

 constexpr auto POWER_PATH = "/org/openbmc/control/power0";
 constexpr auto POWER_INTERFACE = "org.openbmc.control.Power";
 constexpr auto PGOOD_STR = "pgood";

 constexpr auto SYSTEMD_TIME_SERVICE = "org.freedesktop.timedate1";
 constexpr auto SYSTEMD_TIME_PATH = "/org/freedesktop/timedate1";
 constexpr auto SYSTEMD_TIME_INTERFACE = "org.freedesktop.timedate1";
 constexpr auto METHOD_SET_NTP = "SetNTP";

 constexpr auto OBMC_NETWORK_PATH = "/org/openbmc/NetworkManager/Interface";
 constexpr auto OBMC_NETWORK_INTERFACE = "org.openbmc.NetworkManager";
 constexpr auto METHOD_UPDATE_USE_NTP = "UpdateUseNtpField";
 }

 namespace phosphor
 {
 namespace time
 {

 using namespace phosphor::logging;

 const std::set<std::string>
 Manager::managedProperties = {PROPERTY_TIME_MODE, PROPERTY_TIME_OWNER};

 Manager::Manager(sdbusplus::bus::bus& bus)
     : bus(bus),
       propertyChangeMatch(bus, MATCH_PROPERTY_CHANGE, onPropertyChanged, this),
       pgoodChangeMatch(bus, MATCH_PGOOD_CHANGE, onPgoodChanged, this)
 {
     using namespace sdbusplus::bus::match::rules;
     settingsMatches.emplace_back(
         bus,
         propertiesChanged(settings.timeOwner, settings::timeOwnerIntf),
         std::bind(std::mem_fn(&Manager::onSettingsChanged),
                   this, std::placeholders::_1));
     settingsMatches.emplace_back(
         bus,
         propertiesChanged(settings.timeSyncMethod, settings::timeSyncIntf),
         std::bind(std::mem_fn(&Manager::onSettingsChanged),
           this, std::placeholders::_1));

     checkHostOn();

     // Restore settings from persistent storage
     restoreSettings();

     // Check the settings daemon to process the new settings
     auto mode = getSetting(settings.timeSyncMethod.c_str(),
                            settings::timeSyncIntf,
                            PROPERTY_TIME_MODE);
     auto owner = getSetting(settings.timeOwner.c_str(),
                             settings::timeOwnerIntf,
                             PROPERTY_TIME_OWNER);

     onPropertyChanged(PROPERTY_TIME_MODE, mode);
     onPropertyChanged(PROPERTY_TIME_OWNER, owner);

     checkDhcpNtp();
 }

 void Manager::addListener(PropertyChangeListner* listener)
 {
     // Notify listener about the initial value
     listener->onModeChanged(timeMode);
     listener->onOwnerChanged(timeOwner);

     listeners.insert(listener);
 }

 void Manager::restoreSettings()
 {
     auto mode = utils::readData<std::string>(modeFile);
     if (!mode.empty())
     {
         timeMode = utils::strToMode(mode);
     }
     auto owner = utils::readData<std::string>(ownerFile);
     if (!owner.empty())
     {
         timeOwner = utils::strToOwner(owner);
     }
 }

 void Manager::checkHostOn()
 {
     std::string powerService = utils::getService(bus,
                                                  POWER_PATH,
                                                  POWER_INTERFACE);

     int pgood = utils::getProperty<int>(bus,
                                         powerService.c_str(),
                                         POWER_PATH,
                                         POWER_INTERFACE,
                                         PGOOD_STR);
     hostOn = static_cast<bool>(pgood);
 }

 void Manager::checkDhcpNtp()
 {
     std::string useDhcpNtp = getSettings(PROPERTY_DHCP_NTP);
     updateDhcpNtpSetting(useDhcpNtp);
 }

 void Manager::onPropertyChanged(const std::string& key,
                                 const std::string& value)
 {
     if (hostOn)
     {
         // If host is on, set the values as requested time mode/owner.
         // And when host becomes off, notify the listners.
         setPropertyAsRequested(key, value);
     }
     else
     {
         // If host is off, notify listners
         if (key == PROPERTY_TIME_MODE)
         {
             setCurrentTimeMode(value);
             onTimeModeChanged(value);
         }
         else if (key == PROPERTY_TIME_OWNER)
         {
             setCurrentTimeOwner(value);
             onTimeOwnerChanged();
         }
     }
 }

 int Manager::onPropertyChanged(sd_bus_message* msg,
                                void* userData,
                                sd_bus_error* retError)
 {
     using properties = std::map < std::string,
           sdbusplus::message::variant<std::string> >;
     auto m = sdbusplus::message::message(msg);
     // message type: sa{sv}as
     std::string ignore;
     properties props;
     m.read(ignore, props);
     auto manager = static_cast<Manager*>(userData);
     for (const auto& item : props)
     {
         if (managedProperties.find(item.first) != managedProperties.end())
         {
             // For managed properties, notify listeners
             manager->onPropertyChanged(
                 item.first, item.second.get<std::string>());
         }
         else if (item.first == PROPERTY_DHCP_NTP)
         {
             // For other manager interested properties, handle specifically
             manager->updateDhcpNtpSetting(item.second.get<std::string>());
         }
     }
     return 0;
 }

 int Manager::onSettingsChanged(sdbusplus::message::message& msg)
 {
     using Interface = std::string;
     using Property = std::string;
     using Value = std::string;
     using Properties = std::map<Property, sdbusplus::message::variant<Value>>;

     Interface interface;
     Properties properties;

     msg.read(interface, properties);

     for(const auto& p : properties)
     {
         onPropertyChanged(p.first, p.second.get<std::string>());
     }

     return 0;
 }

 void Manager::setPropertyAsRequested(const std::string& key,
                                      const std::string& value)
 {
     if (key == PROPERTY_TIME_MODE)
     {
         setRequestedMode(value);
     }
     else if (key == PROPERTY_TIME_OWNER)
     {
         setRequestedOwner(value);
     }
     else
     {
         // The key shall be already the supported one
         using InvalidArgumentError =
             sdbusplus::xyz::openbmc_project::Common::Error::InvalidArgument;
         using namespace xyz::openbmc_project::Common;
         elog<InvalidArgumentError>(
             InvalidArgument::ARGUMENT_NAME(key.c_str()),
             InvalidArgument::ARGUMENT_VALUE(value.c_str()));
     }
 }

 void Manager::setRequestedMode(const std::string& mode)
 {
     requestedMode = mode;
 }

 void Manager::setRequestedOwner(const std::string& owner)
 {
     requestedOwner = owner;
 }

 void Manager::updateNtpSetting(const std::string& value)
 {
     bool isNtp =
         (value == "xyz.openbmc_project.Time.Synchronization.Method.NTP");
     auto method = bus.new_method_call(SYSTEMD_TIME_SERVICE,
                                       SYSTEMD_TIME_PATH,
                                       SYSTEMD_TIME_INTERFACE,
                                       METHOD_SET_NTP);
     method.append(isNtp, false); // isNtp: 'true/false' means Enable/Disable
                                  // 'false' meaning no policy-kit

     if (bus.call(method))
     {
         log<level::INFO>("Updated NTP setting",
                          entry("ENABLED:%d", isNtp));
     }
     else
     {
         log<level::ERR>("Failed to update NTP setting");
     }
 }

 void Manager::updateDhcpNtpSetting(const std::string& useDhcpNtp)
 {
     std::string networkService = utils::getService(bus,
                                                    OBMC_NETWORK_PATH,
                                                    OBMC_NETWORK_INTERFACE);

     auto method = bus.new_method_call(networkService.c_str(),
                                       OBMC_NETWORK_PATH,
                                       OBMC_NETWORK_INTERFACE,
                                       METHOD_UPDATE_USE_NTP);
     method.append(useDhcpNtp);

     if (bus.call(method))
     {
         log<level::INFO>("Updated use ntp field",
                          entry("USENTPFIELD:%s", useDhcpNtp.c_str()));
     }
     else
     {
         log<level::ERR>("Failed to update UseNtpField");
     }
 }

 void Manager::onPgoodChanged(bool pgood)
 {
     hostOn = pgood;
     if (hostOn)
     {
         return;
     }
     if (!requestedMode.empty())
     {
         if (setCurrentTimeMode(requestedMode))
         {
             onTimeModeChanged(requestedMode);
         }
         setRequestedMode({}); // Clear requested mode
     }
     if (!requestedOwner.empty())
     {
         if (setCurrentTimeOwner(requestedOwner))
         {
             onTimeOwnerChanged();
         }
         setRequestedOwner({}); // Clear requested owner
     }
 }

 int Manager::onPgoodChanged(sd_bus_message* msg,
                             void* userData,
                             sd_bus_error* retError)
 {
     using properties = std::map < std::string,
           sdbusplus::message::variant<int> >;
     auto m = sdbusplus::message::message(msg);
     // message type: sa{sv}as
     std::string ignore;
     properties props;
     m.read(ignore, props);
     for (const auto& item : props)
     {
         if (item.first == PGOOD_STR)
         {
             static_cast<Manager*>(userData)
                 ->onPgoodChanged(static_cast<bool>(item.second.get<int>()));
         }
     }
     return 0;
 }

 bool Manager::setCurrentTimeMode(const std::string& mode)
 {
     auto newMode = utils::strToMode(mode);
     if (newMode != timeMode)
     {
         log<level::INFO>("Time mode is changed",
                          entry("MODE=%s", mode.c_str()));
         timeMode = newMode;
         utils::writeData(modeFile, mode);
         return true;
     }
     else
     {
         return false;
     }
 }

 bool Manager::setCurrentTimeOwner(const std::string& owner)
 {
     auto newOwner = utils::strToOwner(owner);
     if (newOwner != timeOwner)
     {
         log<level::INFO>("Time owner is changed",
                          entry("OWNER=%s", owner.c_str()));
         timeOwner = newOwner;
         utils::writeData(ownerFile, owner);
         return true;
     }
     else
     {
         return false;
     }
 }

 void Manager::onTimeModeChanged(const std::string& mode)
 {
     for (const auto listener : listeners)
     {
         listener->onModeChanged(timeMode);
     }
     // When time_mode is updated, update the NTP setting
     updateNtpSetting(mode);
 }

 void Manager::onTimeOwnerChanged()
 {
     for (const auto& listener : listeners)
     {
         listener->onOwnerChanged(timeOwner);
     }
 }

 // TODO: This function is here only for use_dhcp_ntp.
 // When use_dhcp_ntp is transferred to new settings daemon,
 // this function can be removed.
 std::string Manager::getSettings(const char* setting) const
 {
     std::string settingsService = utils::getService(bus,
                                                     SETTINGS_PATH,
                                                     SETTINGS_INTERFACE);

     return utils::getProperty<std::string>(bus,
                                            settingsService.c_str(),
                                            SETTINGS_PATH,
                                            SETTINGS_INTERFACE,
                                            setting);
 }

 std::string Manager::getSetting(const char* path,
                                 const char* interface,
                                 const char* setting) const
 {
     std::string settingManager = utils::getService(bus, path, interface);
     return utils::getProperty<std::string>(bus,
                                            settingManager.c_str(),
                                            path,
                                            interface,
                                            setting);
 }

 }
 }
	#include "manager.hpp"
	#include "utils.hpp"

	#include <phosphor-logging/elog.hpp>
	#include <phosphor-logging/elog-errors.hpp>
	#include <phosphor-logging/log.hpp>
	#include <xyz/openbmc_project/Common/error.hpp>

	namespace rules = sdbusplus::bus::match::rules;

	namespace // anonymous
	{
	constexpr auto SETTINGS_PATH = "/org/openbmc/settings/host0";
	constexpr auto SETTINGS_INTERFACE = "org.openbmc.settings.Host";

	// TODO: Use new settings in xyz.openbmc_project
	const auto MATCH_PROPERTY_CHANGE =
	rules::type::signal() +
	rules::member("PropertiesChanged") +
	rules::path("/org/openbmc/settings/host0") +
	rules::interface("org.freedesktop.DBus.Properties");

	const auto MATCH_PGOOD_CHANGE =
	rules::type::signal() +
	rules::member("PropertiesChanged") +
	rules::path("/org/openbmc/control/power0") +
	rules::interface("org.freedesktop.DBus.Properties");

	constexpr auto POWER_PATH = "/org/openbmc/control/power0";
	constexpr auto POWER_INTERFACE = "org.openbmc.control.Power";
	constexpr auto PGOOD_STR = "pgood";

	constexpr auto SYSTEMD_TIME_SERVICE = "org.freedesktop.timedate1";
	constexpr auto SYSTEMD_TIME_PATH = "/org/freedesktop/timedate1";
	constexpr auto SYSTEMD_TIME_INTERFACE = "org.freedesktop.timedate1";
	constexpr auto METHOD_SET_NTP = "SetNTP";

	constexpr auto OBMC_NETWORK_PATH = "/org/openbmc/NetworkManager/Interface";
	constexpr auto OBMC_NETWORK_INTERFACE = "org.openbmc.NetworkManager";
	constexpr auto METHOD_UPDATE_USE_NTP = "UpdateUseNtpField";
	}

	namespace phosphor
	{
	namespace time
	{

	using namespace phosphor::logging;

	const std::set<std::string>
	Manager::managedProperties = {PROPERTY_TIME_MODE, PROPERTY_TIME_OWNER};

	Manager::Manager(sdbusplus::bus::bus& bus)
	: bus(bus),
	propertyChangeMatch(bus, MATCH_PROPERTY_CHANGE, onPropertyChanged, this),
	pgoodChangeMatch(bus, MATCH_PGOOD_CHANGE, onPgoodChanged, this)
	{
	using namespace sdbusplus::bus::match::rules;
	settingsMatches.emplace_back(
	bus,
	propertiesChanged(settings.timeOwner, settings::timeOwnerIntf),
	std::bind(std::mem_fn(&Manager::onSettingsChanged),
	this, std::placeholders::_1));
	settingsMatches.emplace_back(
	bus,
	propertiesChanged(settings.timeSyncMethod, settings::timeSyncIntf),
	std::bind(std::mem_fn(&Manager::onSettingsChanged),
	this, std::placeholders::_1));

	checkHostOn();

	// Restore settings from persistent storage
	restoreSettings();

	// Check the settings daemon to process the new settings
	auto mode = getSetting(settings.timeSyncMethod.c_str(),
	settings::timeSyncIntf,
	PROPERTY_TIME_MODE);
	auto owner = getSetting(settings.timeOwner.c_str(),
	settings::timeOwnerIntf,
	PROPERTY_TIME_OWNER);

	onPropertyChanged(PROPERTY_TIME_MODE, mode);
	onPropertyChanged(PROPERTY_TIME_OWNER, owner);

	checkDhcpNtp();
	}

	void Manager::addListener(PropertyChangeListner* listener)
	{
	// Notify listener about the initial value
	listener->onModeChanged(timeMode);
	listener->onOwnerChanged(timeOwner);

	listeners.insert(listener);
	}

	void Manager::restoreSettings()
	{
	auto mode = utils::readData<std::string>(modeFile);
	if (!mode.empty())
	{
	timeMode = utils::strToMode(mode);
	}
	auto owner = utils::readData<std::string>(ownerFile);
	if (!owner.empty())
	{
	timeOwner = utils::strToOwner(owner);
	}
	}

	void Manager::checkHostOn()
	{
	std::string powerService = utils::getService(bus,
	POWER_PATH,
	POWER_INTERFACE);

	int pgood = utils::getProperty<int>(bus,
	powerService.c_str(),
	POWER_PATH,
	POWER_INTERFACE,
	PGOOD_STR);
	hostOn = static_cast<bool>(pgood);
	}

	void Manager::checkDhcpNtp()
	{
	std::string useDhcpNtp = getSettings(PROPERTY_DHCP_NTP);
	updateDhcpNtpSetting(useDhcpNtp);
	}

	void Manager::onPropertyChanged(const std::string& key,
	const std::string& value)
	{
	if (hostOn)
	{
	// If host is on, set the values as requested time mode/owner.
	// And when host becomes off, notify the listners.
	setPropertyAsRequested(key, value);
	}
	else
	{
	// If host is off, notify listners
	if (key == PROPERTY_TIME_MODE)
	{
	setCurrentTimeMode(value);
	onTimeModeChanged(value);
	}
	else if (key == PROPERTY_TIME_OWNER)
	{
	setCurrentTimeOwner(value);
	onTimeOwnerChanged();
	}
	}
	}

	int Manager::onPropertyChanged(sd_bus_message* msg,
	void* userData,
	sd_bus_error* retError)
	{
	using properties = std::map < std::string,
	sdbusplus::message::variant<std::string> >;
	auto m = sdbusplus::message::message(msg);
	// message type: sa{sv}as
	std::string ignore;
	properties props;
	m.read(ignore, props);
	auto manager = static_cast<Manager*>(userData);
	for (const auto& item : props)
	{
	if (managedProperties.find(item.first) != managedProperties.end())
	{
	// For managed properties, notify listeners
	manager->onPropertyChanged(
	item.first, item.second.get<std::string>());
	}
	else if (item.first == PROPERTY_DHCP_NTP)
	{
	// For other manager interested properties, handle specifically
	manager->updateDhcpNtpSetting(item.second.get<std::string>());
	}
	}
	return 0;
	}

	int Manager::onSettingsChanged(sdbusplus::message::message& msg)
	{
	using Interface = std::string;
	using Property = std::string;
	using Value = std::string;
	using Properties = std::map<Property, sdbusplus::message::variant<Value>>;

	Interface interface;
	Properties properties;

	msg.read(interface, properties);

	for(const auto& p : properties)
	{
	onPropertyChanged(p.first, p.second.get<std::string>());
	}

	return 0;
	}

	void Manager::setPropertyAsRequested(const std::string& key,
	const std::string& value)
	{
	if (key == PROPERTY_TIME_MODE)
	{
	setRequestedMode(value);
	}
	else if (key == PROPERTY_TIME_OWNER)
	{
	setRequestedOwner(value);
	}
	else
	{
	// The key shall be already the supported one
	using InvalidArgumentError =
	sdbusplus::xyz::openbmc_project::Common::Error::InvalidArgument;
	using namespace xyz::openbmc_project::Common;
	elog<InvalidArgumentError>(
	InvalidArgument::ARGUMENT_NAME(key.c_str()),
	InvalidArgument::ARGUMENT_VALUE(value.c_str()));
	}
	}

	void Manager::setRequestedMode(const std::string& mode)
	{
	requestedMode = mode;
	}

	void Manager::setRequestedOwner(const std::string& owner)
	{
	requestedOwner = owner;
	}

	void Manager::updateNtpSetting(const std::string& value)
	{
	bool isNtp =
	(value == "xyz.openbmc_project.Time.Synchronization.Method.NTP");
	auto method = bus.new_method_call(SYSTEMD_TIME_SERVICE,
	SYSTEMD_TIME_PATH,
	SYSTEMD_TIME_INTERFACE,
	METHOD_SET_NTP);
	method.append(isNtp, false); // isNtp: 'true/false' means Enable/Disable
	// 'false' meaning no policy-kit

	if (bus.call(method))
	{
	log<level::INFO>("Updated NTP setting",
	entry("ENABLED:%d", isNtp));
	}
	else
	{
	log<level::ERR>("Failed to update NTP setting");
	}
	}

	void Manager::updateDhcpNtpSetting(const std::string& useDhcpNtp)
	{
	std::string networkService = utils::getService(bus,
	OBMC_NETWORK_PATH,
	OBMC_NETWORK_INTERFACE);

	auto method = bus.new_method_call(networkService.c_str(),
	OBMC_NETWORK_PATH,
	OBMC_NETWORK_INTERFACE,
	METHOD_UPDATE_USE_NTP);
	method.append(useDhcpNtp);

	if (bus.call(method))
	{
	log<level::INFO>("Updated use ntp field",
	entry("USENTPFIELD:%s", useDhcpNtp.c_str()));
	}
	else
	{
	log<level::ERR>("Failed to update UseNtpField");
	}
	}

	void Manager::onPgoodChanged(bool pgood)
	{
	hostOn = pgood;
	if (hostOn)
	{
	return;
	}
	if (!requestedMode.empty())
	{
	if (setCurrentTimeMode(requestedMode))
	{
	onTimeModeChanged(requestedMode);
	}
	setRequestedMode({}); // Clear requested mode
	}
	if (!requestedOwner.empty())
	{
	if (setCurrentTimeOwner(requestedOwner))
	{
	onTimeOwnerChanged();
	}
	setRequestedOwner({}); // Clear requested owner
	}
	}

	int Manager::onPgoodChanged(sd_bus_message* msg,
	void* userData,
	sd_bus_error* retError)
	{
	using properties = std::map < std::string,
	sdbusplus::message::variant<int> >;
	auto m = sdbusplus::message::message(msg);
	// message type: sa{sv}as
	std::string ignore;
	properties props;
	m.read(ignore, props);
	for (const auto& item : props)
	{
	if (item.first == PGOOD_STR)
	{
	static_cast<Manager*>(userData)
	->onPgoodChanged(static_cast<bool>(item.second.get<int>()));
	}
	}
	return 0;
	}

	bool Manager::setCurrentTimeMode(const std::string& mode)
	{
	auto newMode = utils::strToMode(mode);
	if (newMode != timeMode)
	{
	log<level::INFO>("Time mode is changed",
	entry("MODE=%s", mode.c_str()));
	timeMode = newMode;
	utils::writeData(modeFile, mode);
	return true;
	}
	else
	{
	return false;
	}
	}

	bool Manager::setCurrentTimeOwner(const std::string& owner)
	{
	auto newOwner = utils::strToOwner(owner);
	if (newOwner != timeOwner)
	{
	log<level::INFO>("Time owner is changed",
	entry("OWNER=%s", owner.c_str()));
	timeOwner = newOwner;
	utils::writeData(ownerFile, owner);
	return true;
	}
	else
	{
	return false;
	}
	}

	void Manager::onTimeModeChanged(const std::string& mode)
	{
	for (const auto listener : listeners)
	{
	listener->onModeChanged(timeMode);
	}
	// When time_mode is updated, update the NTP setting
	updateNtpSetting(mode);
	}

	void Manager::onTimeOwnerChanged()
	{
	for (const auto& listener : listeners)
	{
	listener->onOwnerChanged(timeOwner);
	}
	}

	// TODO: This function is here only for use_dhcp_ntp.
	// When use_dhcp_ntp is transferred to new settings daemon,
	// this function can be removed.
	std::string Manager::getSettings(const char* setting) const
	{
	std::string settingsService = utils::getService(bus,
	SETTINGS_PATH,
	SETTINGS_INTERFACE);

	return utils::getProperty<std::string>(bus,
	settingsService.c_str(),
	SETTINGS_PATH,
	SETTINGS_INTERFACE,
	setting);
	}

	std::string Manager::getSetting(const char* path,
	const char* interface,
	const char* setting) const
	{
	std::string settingManager = utils::getService(bus, path, interface);
	return utils::getProperty<std::string>(bus,
	settingManager.c_str(),
	path,
	interface,
	setting);
	}

	}
	}