blob: cc2df97822930264744099444ebbd9c8b2f2d61e [file] [log] [blame]
#pragma once
#include "config.h"
#include "utils.hpp"
#include "xyz/openbmc_project/Software/ActivationProgress/server.hpp"
#include "xyz/openbmc_project/Software/ExtendedVersion/server.hpp"
#include "xyz/openbmc_project/Software/RedundancyPriority/server.hpp"
#include <sdbusplus/server.hpp>
#include <xyz/openbmc_project/Association/Definitions/server.hpp>
#include <xyz/openbmc_project/Software/Activation/server.hpp>
#include <xyz/openbmc_project/Software/ActivationBlocksTransition/server.hpp>
#include <string>
namespace openpower
{
namespace software
{
namespace updater
{
using AssociationList =
std::vector<std::tuple<std::string, std::string, std::string>>;
using ActivationInherit = sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Software::server::ExtendedVersion,
sdbusplus::xyz::openbmc_project::Software::server::Activation,
sdbusplus::xyz::openbmc_project::Association::server::Definitions>;
using ActivationBlocksTransitionInherit = sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Software::server::
ActivationBlocksTransition>;
using RedundancyPriorityInherit = sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Software::server::RedundancyPriority>;
using ActivationProgressInherit = sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Software::server::ActivationProgress>;
constexpr auto applyTimeImmediate =
"xyz.openbmc_project.Software.ApplyTime.RequestedApplyTimes.Immediate";
constexpr auto applyTimeIntf = "xyz.openbmc_project.Software.ApplyTime";
constexpr auto dbusPropIntf = "org.freedesktop.DBus.Properties";
constexpr auto applyTimeObjPath = "/xyz/openbmc_project/software/apply_time";
constexpr auto applyTimeProp = "RequestedApplyTime";
constexpr auto hostStateIntf = "xyz.openbmc_project.State.Host";
constexpr auto hostStateObjPath = "/xyz/openbmc_project/state/host0";
constexpr auto hostStateRebootProp = "RequestedHostTransition";
constexpr auto hostStateRebootVal =
"xyz.openbmc_project.State.Host.Transition.Reboot";
namespace sdbusRule = sdbusplus::bus::match::rules;
class ItemUpdater;
class Activation;
class RedundancyPriority;
/** @class RedundancyPriority
* @brief OpenBMC RedundancyPriority implementation
* @details A concrete implementation for
* xyz.openbmc_project.Software.RedundancyPriority DBus API.
*/
class RedundancyPriority : public RedundancyPriorityInherit
{
public:
/** @brief Constructs RedundancyPriority.
*
* @param[in] bus - The Dbus bus object
* @param[in] path - The Dbus object path
* @param[in] parent - Parent object.
* @param[in] value - The redundancyPriority value
*/
RedundancyPriority(sdbusplus::bus::bus& bus, const std::string& path,
Activation& parent, uint8_t value) :
RedundancyPriorityInherit(bus, path.c_str(),
action::emit_interface_added),
parent(parent)
{
// Set Property
priority(value);
}
/** @brief Overloaded Priority property set function
*
* @param[in] value - uint8_t
*
* @return Success or exception thrown
*/
uint8_t priority(uint8_t value) override;
/** @brief Priority property get function
*
* @returns uint8_t - The Priority value
*/
using RedundancyPriorityInherit::priority;
/** @brief Parent Object. */
Activation& parent;
};
/** @class ActivationBlocksTransition
* @brief OpenBMC ActivationBlocksTransition implementation.
* @details A concrete implementation for
* xyz.openbmc_project.Software.ActivationBlocksTransition DBus API.
*/
class ActivationBlocksTransition : public ActivationBlocksTransitionInherit
{
public:
/** @brief Constructs ActivationBlocksTransition.
*
* @param[in] bus - The Dbus bus object
* @param[in] path - The Dbus object path
*/
ActivationBlocksTransition(sdbusplus::bus::bus& bus,
const std::string& path) :
ActivationBlocksTransitionInherit(bus, path.c_str(),
action::emit_interface_added)
{}
};
class ActivationProgress : public ActivationProgressInherit
{
public:
/** @brief Constructs ActivationProgress.
*
* @param[in] bus - The Dbus bus object
* @param[in] path - The Dbus object path
*/
ActivationProgress(sdbusplus::bus::bus& bus, const std::string& path) :
ActivationProgressInherit(bus, path.c_str(),
action::emit_interface_added)
{
progress(0);
}
};
/** @class Activation
* @brief OpenBMC activation software management implementation.
* @details A concrete implementation for
* xyz.openbmc_project.Software.Activation DBus API.
*/
class Activation : public ActivationInherit
{
public:
/** @brief Constructs Activation Software Manager
*
* @param[in] bus - The Dbus bus object
* @param[in] path - The Dbus object path
* @param[in] parent - Parent object.
* @param[in] versionId - The software version id
* @param[in] extVersion - The extended version
* @param[in] activationStatus - The status of Activation
* @param[in] assocs - Association objects
*/
Activation(sdbusplus::bus::bus& bus, const std::string& path,
ItemUpdater& parent, const std::string& versionId,
const std::string& extVersion,
sdbusplus::xyz::openbmc_project::Software::server::Activation::
Activations activationStatus,
AssociationList& assocs) :
ActivationInherit(bus, path.c_str(),
ActivationInherit::action::defer_emit),
bus(bus), path(path), parent(parent), versionId(versionId),
systemdSignals(
bus,
sdbusRule::type::signal() + sdbusRule::member("JobRemoved") +
sdbusRule::path("/org/freedesktop/systemd1") +
sdbusRule::interface("org.freedesktop.systemd1.Manager"),
std::bind(std::mem_fn(&Activation::unitStateChange), this,
std::placeholders::_1))
{
// Set Properties.
extendedVersion(extVersion);
activation(activationStatus);
associations(assocs);
// Emit deferred signal.
emit_object_added();
}
virtual ~Activation() = default;
/** @brief Overloaded requestedActivation property setter function
*
* @param[in] value - One of Activation::RequestedActivations
*
* @return Success or exception thrown
*/
RequestedActivations
requestedActivation(RequestedActivations value) override;
/**
* @brief subscribe to the systemd signals
*
* This object needs to capture when it's systemd targets complete
* so it can keep it's state updated
*
**/
void subscribeToSystemdSignals();
/**
* @brief unsubscribe from the systemd signals
*
* Once the activation process has completed successfully, we can
* safely unsubscribe from systemd signals.
*
**/
void unsubscribeFromSystemdSignals();
/** @brief Persistent sdbusplus DBus bus connection */
sdbusplus::bus::bus& bus;
/** @brief Persistent DBus object path */
std::string path;
/** @brief Parent Object. */
ItemUpdater& parent;
/** @brief Version id */
std::string versionId;
/** @brief Persistent ActivationBlocksTransition dbus object */
std::unique_ptr<ActivationBlocksTransition> activationBlocksTransition;
/** @brief Persistent ActivationProgress dbus object */
std::unique_ptr<ActivationProgress> activationProgress;
/** @brief Persistent RedundancyPriority dbus object */
std::unique_ptr<RedundancyPriority> redundancyPriority;
/** @brief Used to subscribe to dbus systemd signals **/
sdbusplus::bus::match_t systemdSignals;
/**
* @brief Determine the configured image apply time value
*
* @return true if the image apply time value is immediate
**/
bool checkApplyTimeImmediate();
/**
* @brief Reboot the Host. Called when ApplyTime is immediate.
*
* @return none
**/
void rebootHost();
protected:
/** @brief Check if systemd state change is relevant to this object
*
* Instance specific interface to handle the detected systemd state
* change
*
* @param[in] msg - Data associated with subscribed signal
*
*/
virtual void unitStateChange(sdbusplus::message::message& msg) = 0;
/**
* @brief Deletes the version from Image Manager and the
* untar image from image upload dir.
*/
void deleteImageManagerObject();
/** @brief Member function for clarity & brevity at activation start */
virtual void startActivation() = 0;
/** @brief Member function for clarity & brevity at activation end */
virtual void finishActivation() = 0;
#ifdef WANT_SIGNATURE_VERIFY
/**
* @brief Wrapper function for the signature verify function.
* Signature class verify function used for validating
* signed image. Also added additional logic to continue
* update process in lab environment by checking the
* fieldModeEnabled property.
*
* @param[in] pnorFileName - The PNOR filename in image dir
*
* @return true if successful signature validation or field
* mode is disabled.
* false for unsuccessful signature validation or
* any internal failure during the mapper call.
*/
bool validateSignature(const std::string& pnorFileName);
/**
* @brief Gets the fieldModeEnabled property value.
*
* @return fieldModeEnabled property value
* @error InternalFailure exception thrown
*/
bool fieldModeEnabled();
#endif
};
} // namespace updater
} // namespace software
} // namespace openpower