xref: /openbmc/bmcweb/features/redfish/include/utils/sw_utils.hpp (revision 40e9b92ec19acffb46f83a6e55b18974da5d708e)

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors
#pragma once
#include "async_resp.hpp"
#include "dbus_utility.hpp"
#include "error_messages.hpp"
#include "generated/enums/resource.hpp"
#include "http/utility.hpp"
#include "utils/dbus_utils.hpp"

#include <boost/system/error_code.hpp>
#include <boost/url/format.hpp>
#include <sdbusplus/asio/property.hpp>
#include <sdbusplus/unpack_properties.hpp>

#include <algorithm>
#include <array>
#include <optional>
#include <ranges>
#include <string>
#include <string_view>
#include <vector>

namespace redfish
{
namespace sw_util
{
/* @brief String that indicates a bios software instance */
constexpr const char* biosPurpose =
    "xyz.openbmc_project.Software.Version.VersionPurpose.Host";

/* @brief String that indicates a BMC software instance */
constexpr const char* bmcPurpose =
    "xyz.openbmc_project.Software.Version.VersionPurpose.BMC";

inline std::optional<sdbusplus::message::object_path>
    getFunctionalSoftwarePath(const std::string& swType)
{
    if (swType == bmcPurpose)
    {
        if constexpr (BMCWEB_REDFISH_UPDATESERVICE_USE_DBUS)
        {
            return sdbusplus::message::object_path(
                "/xyz/openbmc_project/software/bmc/functional");
        }
        else
        {
            return sdbusplus::message::object_path(
                "/xyz/openbmc_project/software/functional");
        }
    }
    else if (swType == biosPurpose)
    {
        if constexpr (BMCWEB_REDFISH_UPDATESERVICE_USE_DBUS)
        {
            return sdbusplus::message::object_path(
                "/xyz/openbmc_project/software/bios/functional");
        }
        else
        {
            return sdbusplus::message::object_path(
                "/xyz/openbmc_project/software/functional");
        }
    }
    else
    {
        BMCWEB_LOG_ERROR("No valid software path");
        return std::nullopt;
    }
}

inline void afterGetProperties(
    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
    const std::string& swId, bool runningImage,
    const std::string& swVersionPurpose,
    const std::string& activeVersionPropName, bool populateLinkToImages,
    const boost::system::error_code& ec,
    const dbus::utility::DBusPropertiesMap& propertiesList)
{
    if (ec)
    {
        BMCWEB_LOG_ERROR("error_code = {}", ec);
        BMCWEB_LOG_ERROR("error msg = {}", ec.message());
        // Have seen the code update app delete the
        // D-Bus object, during code update, between
        // the call to mapper and here. Just leave
        // these properties off if resource not
        // found.
        if (ec.value() == EBADR)
        {
            return;
        }
        messages::internalError(asyncResp->res);
        return;
    }
    // example propertiesList
    // a{sv} 2 "Version" s
    // "IBM-witherspoon-OP9-v2.0.10-2.22" "Purpose"
    // s
    // "xyz.openbmc_project.Software.Version.VersionPurpose.Host"
    const std::string* version = nullptr;
    const std::string* swInvPurpose = nullptr;

    const bool success = sdbusplus::unpackPropertiesNoThrow(
        dbus_utils::UnpackErrorPrinter(), propertiesList, "Purpose",
        swInvPurpose, "Version", version);

    if (!success)
    {
        messages::internalError(asyncResp->res);
        return;
    }

    if (version == nullptr || version->empty())
    {
        messages::internalError(asyncResp->res);
        return;
    }
    if (swInvPurpose == nullptr || *swInvPurpose != swVersionPurpose)
    {
        // Not purpose we're looking for
        return;
    }

    BMCWEB_LOG_DEBUG("Image ID: {}", swId);
    BMCWEB_LOG_DEBUG("Running image: {}", runningImage);
    BMCWEB_LOG_DEBUG("Image purpose: {}", *swInvPurpose);

    if (populateLinkToImages)
    {
        nlohmann::json& softwareImageMembers =
            asyncResp->res.jsonValue["Links"]["SoftwareImages"];
        // Firmware images are at
        // /redfish/v1/UpdateService/FirmwareInventory/<Id>
        // e.g. .../FirmwareInventory/82d3ec86
        nlohmann::json::object_t member;
        member["@odata.id"] = boost::urls::format(
            "/redfish/v1/UpdateService/FirmwareInventory/{}", swId);
        softwareImageMembers.emplace_back(std::move(member));
        asyncResp->res.jsonValue["Links"]["SoftwareImages@odata.count"] =
            softwareImageMembers.size();

        if (runningImage)
        {
            nlohmann::json::object_t runningMember;
            runningMember["@odata.id"] = boost::urls::format(
                "/redfish/v1/UpdateService/FirmwareInventory/{}", swId);
            // Create the link to the running image
            asyncResp->res.jsonValue["Links"]["ActiveSoftwareImage"] =
                std::move(runningMember);
        }
    }
    if (!activeVersionPropName.empty() && runningImage)
    {
        asyncResp->res.jsonValue[activeVersionPropName] = *version;
    }
}

inline void afterGetSubtree(
    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
    const std::string& swVersionPurpose,
    const std::string& activeVersionPropName, bool populateLinkToImages,
    const std::vector<std::string>& functionalSwIds,
    const boost::system::error_code& ec,
    const dbus::utility::MapperGetSubTreeResponse& subtree)
{
    if (ec)
    {
        BMCWEB_LOG_ERROR("error_code = {}", ec);
        BMCWEB_LOG_ERROR("error msg = {}", ec.message());
        messages::internalError(asyncResp->res);
        return;
    }

    BMCWEB_LOG_DEBUG("Found {} images", subtree.size());

    for (const std::pair<
             std::string,
             std::vector<std::pair<std::string, std::vector<std::string>>>>&
             obj : subtree)
    {
        sdbusplus::message::object_path path(obj.first);
        std::string swId = path.filename();
        if (swId.empty())
        {
            messages::internalError(asyncResp->res);
            BMCWEB_LOG_ERROR("Invalid software ID");

            return;
        }

        bool runningImage = false;
        // Look at Ids from
        // /xyz/openbmc_project/software/functional
        // to determine if this is
        // a running image
        if (std::ranges::find(functionalSwIds, swId) != functionalSwIds.end())
        {
            runningImage = true;
        }

        // Now grab its version
        // info
        dbus::utility::getAllProperties(
            *crow::connections::systemBus, obj.second[0].first, obj.first,
            "xyz.openbmc_project.Software.Version",
            [asyncResp, swId, runningImage, swVersionPurpose,
             activeVersionPropName, populateLinkToImages](
                const boost::system::error_code& ec3,
                const dbus::utility::DBusPropertiesMap& propertiesList) {
                afterGetProperties(asyncResp, swId, runningImage,
                                   swVersionPurpose, activeVersionPropName,
                                   populateLinkToImages, ec3, propertiesList);
            });
    }
}

inline void afterAssociatedEndpoints(
    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
    const std::string& swVersionPurpose,
    const std::string& activeVersionPropName, bool populateLinkToImages,
    const boost::system::error_code& ec,
    const dbus::utility::MapperEndPoints& functionalSw)
{
    BMCWEB_LOG_DEBUG("populateSoftwareInformation enter");
    if (ec)
    {
        BMCWEB_LOG_DEBUG("error_code = {}", ec);
        BMCWEB_LOG_DEBUG("error msg = {}", ec.message());
        // No functional software for this swVersionPurpose, so just
        return;
    }

    if (functionalSw.empty())
    {
        // Could keep going and try to populate SoftwareImages
        // but something is seriously wrong, so just fail
        BMCWEB_LOG_ERROR("Zero functional software in system");
        messages::internalError(asyncResp->res);
        return;
    }

    std::vector<std::string> functionalSwIds;
    // example functionalSw:
    // v as 2 "/xyz/openbmc_project/software/ace821ef"
    //        "/xyz/openbmc_project/software/230fb078"
    for (const auto& sw : functionalSw)
    {
        sdbusplus::message::object_path path(sw);
        std::string leaf = path.filename();
        if (leaf.empty())
        {
            continue;
        }

        functionalSwIds.push_back(leaf);
    }

    constexpr std::array<std::string_view, 1> interfaces = {
        "xyz.openbmc_project.Software.Version"};
    dbus::utility::getSubTree(
        "/xyz/openbmc_project/software", 0, interfaces,
        [asyncResp, swVersionPurpose, activeVersionPropName,
         populateLinkToImages, functionalSwIds](
            const boost::system::error_code& ec2,
            const dbus::utility::MapperGetSubTreeResponse& subtree) {
            afterGetSubtree(asyncResp, swVersionPurpose, activeVersionPropName,
                            populateLinkToImages, functionalSwIds, ec2,
                            subtree);
        });
}

/**
 * @brief Populate the running software version and image links
 *
 * @param[i,o] asyncResp             Async response object
 * @param[i]   swVersionPurpose  Indicates what target to look for
 * @param[i]   activeVersionPropName  Index in asyncResp->res.jsonValue to write
 * the running software version to
 * @param[i]   populateLinkToImages  Populate asyncResp->res "Links"
 * "ActiveSoftwareImage" with a link to the running software image and
 * "SoftwareImages" with a link to the all its software images
 *
 * @return void
 */
inline void populateSoftwareInformation(
    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
    const std::string& swVersionPurpose,
    const std::string& activeVersionPropName, const bool populateLinkToImages)
{
    auto swPath = getFunctionalSoftwarePath(swVersionPurpose);
    if (!swPath)
    {
        BMCWEB_LOG_ERROR("Invalid software type");
        messages::internalError(asyncResp->res);
        return;
    }
    // Used later to determine running (known on Redfish as active) Sw images
    dbus::utility::getAssociationEndPoints(
        swPath.value().str,
        [asyncResp, swVersionPurpose, activeVersionPropName,
         populateLinkToImages](
            const boost::system::error_code& ec,
            const dbus::utility::MapperEndPoints& functionalSw) {
            afterAssociatedEndpoints(asyncResp, swVersionPurpose,
                                     activeVersionPropName,
                                     populateLinkToImages, ec, functionalSw);
        });
}

/**
 * @brief Translate input swState to Redfish state
 *
 * This function will return the corresponding Redfish state
 *
 * @param[i]   swState  The OpenBMC software state
 *
 * @return The corresponding Redfish state
 */
inline resource::State getRedfishSwState(const std::string& swState)
{
    if (swState == "xyz.openbmc_project.Software.Activation.Activations.Active")
    {
        return resource::State::Enabled;
    }
    if (swState == "xyz.openbmc_project.Software.Activation."
                   "Activations.Activating")
    {
        return resource::State::Updating;
    }
    if (swState == "xyz.openbmc_project.Software.Activation."
                   "Activations.StandbySpare")
    {
        return resource::State::StandbySpare;
    }
    BMCWEB_LOG_DEBUG("Default sw state {} to Disabled", swState);
    return resource::State::Disabled;
}

/**
 * @brief Translate input swState to Redfish health state
 *
 * This function will return the corresponding Redfish health state
 *
 * @param[i]   swState  The OpenBMC software state
 *
 * @return The corresponding Redfish health state
 */
inline std::string getRedfishSwHealth(const std::string& swState)
{
    if ((swState ==
         "xyz.openbmc_project.Software.Activation.Activations.Active") ||
        (swState == "xyz.openbmc_project.Software.Activation.Activations."
                    "Activating") ||
        (swState ==
         "xyz.openbmc_project.Software.Activation.Activations.Ready"))
    {
        return "OK";
    }
    BMCWEB_LOG_DEBUG("Sw state {} to Warning", swState);
    return "Warning";
}

/**
 * @brief Put status of input swId into json response
 *
 * This function will put the appropriate Redfish state of the input
 * software id to ["Status"]["State"] within the json response
 *
 * @param[i,o] asyncResp    Async response object
 * @param[i]   swId     The software ID to get status for
 * @param[i]   dbusSvc  The dbus service implementing the software object
 *
 * @return void
 */
inline void getSwStatus(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
                        const std::shared_ptr<std::string>& swId,
                        const std::string& dbusSvc)
{
    BMCWEB_LOG_DEBUG("getSwStatus: swId {} svc {}", *swId, dbusSvc);

    dbus::utility::getAllProperties(
        dbusSvc, "/xyz/openbmc_project/software/" + *swId,
        "xyz.openbmc_project.Software.Activation",
        [asyncResp,
         swId](const boost::system::error_code& ec,
               const dbus::utility::DBusPropertiesMap& propertiesList) {
            if (ec)
            {
                // not all swtypes are updateable, this is ok
                asyncResp->res.jsonValue["Status"]["State"] =
                    resource::State::Enabled;
                return;
            }

            const std::string* swInvActivation = nullptr;

            const bool success = sdbusplus::unpackPropertiesNoThrow(
                dbus_utils::UnpackErrorPrinter(), propertiesList, "Activation",
                swInvActivation);

            if (!success)
            {
                messages::internalError(asyncResp->res);
                return;
            }

            if (swInvActivation == nullptr)
            {
                messages::internalError(asyncResp->res);
                return;
            }

            BMCWEB_LOG_DEBUG("getSwStatus: Activation {}", *swInvActivation);
            asyncResp->res.jsonValue["Status"]["State"] =
                getRedfishSwState(*swInvActivation);
            asyncResp->res.jsonValue["Status"]["Health"] =
                getRedfishSwHealth(*swInvActivation);
        });
}

inline void handleUpdateableEndpoints(
    const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
    const std::shared_ptr<std::string>& swId,
    const boost::system::error_code& ec,
    const dbus::utility::MapperEndPoints& objPaths)
{
    if (ec)
    {
        BMCWEB_LOG_DEBUG(" error_code = {} error msg =  {}", ec, ec.message());
        // System can exist with no updateable software,
        // so don't throw error here.
        return;
    }
    sdbusplus::message::object_path reqSwObjPath(
        "/xyz/openbmc_project/software");
    reqSwObjPath = reqSwObjPath / *swId;

    if (std::ranges::find(objPaths, reqSwObjPath.str) != objPaths.end())
    {
        asyncResp->res.jsonValue["Updateable"] = true;
        return;
    }
}

inline void
    handleUpdateableObject(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
                           const boost::system::error_code& ec,
                           const dbus::utility::MapperGetObject& objectInfo)
{
    if (ec)
    {
        BMCWEB_LOG_DEBUG(" error_code = {} error msg =  {}", ec, ec.message());
        // System can exist with no updateable software,
        // so don't throw error here.
        return;
    }
    if (objectInfo.empty())
    {
        BMCWEB_LOG_DEBUG("No updateable software found");
        // System can exist with no updateable software,
        // so don't throw error here.
        return;
    }
    asyncResp->res.jsonValue["Updateable"] = true;
}

/**
 * @brief Updates programmable status of input swId into json response
 *
 * This function checks whether software inventory component
 * can be programmable or not and fill's the "Updatable"
 * Property.
 *
 * @param[i,o] asyncResp  Async response object
 * @param[i]   swId       The software ID
 */
inline void
    getSwUpdatableStatus(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
                         const std::shared_ptr<std::string>& swId)
{
    if constexpr (BMCWEB_REDFISH_UPDATESERVICE_USE_DBUS)
    {
        sdbusplus::message::object_path swObjectPath(
            "/xyz/openbmc_project/software");
        swObjectPath = swObjectPath / *swId;
        constexpr std::array<std::string_view, 1> interfaces = {
            "xyz.openbmc_project.Software.Update"};
        dbus::utility::getDbusObject(
            swObjectPath.str, interfaces,
            std::bind_front(handleUpdateableObject, asyncResp));
    }
    else
    {
        dbus::utility::getAssociationEndPoints(
            "/xyz/openbmc_project/software/updateable",
            std::bind_front(handleUpdateableEndpoints, asyncResp, swId));
    }
}

} // namespace sw_util
} // namespace redfish