xref: /openbmc/phosphor-ipmi-flash/tools/handler.hpp (revision 3f596287)

#pragma once

#include "interface.hpp"

#include <ipmiblob/blob_interface.hpp>
#include <stdplus/function_view.hpp>

#include <string>

namespace host_tool
{

class UpdateHandlerInterface
{
  public:
    virtual ~UpdateHandlerInterface() = default;

    /**
     * Check if the goal firmware is listed in the blob_list and that the
     * handler's supported data type is available.
     *
     * @param[in] goalFirmware - the firmware to check /flash/image
     * /flash/tarball, etc.
     */
    virtual bool checkAvailable(const std::string& goalFirmware) = 0;

    /**
     * Send the file contents at path to the blob id, target.
     *
     * @param[in] target - the blob id
     * @param[in] path - the source file path
     */
    virtual void sendFile(const std::string& target,
                          const std::string& path) = 0;

    /**
     * Trigger verification.
     *
     * @param[in] target - the verification blob id (may support multiple in the
     * future.
     * @param[in] ignoreStatus - determines whether to ignore the verification
     * status.
     * @return true if verified, false if verification errors.
     */
    virtual bool verifyFile(const std::string& target, bool ignoreStatus) = 0;

    /**
     * Read the active firmware version.
     *
     * @param[in] versionBlob - the version blob id within the version handler.
     * @return firmware version
     */
    virtual std::vector<uint8_t>
        readVersion(const std::string& versionBlob) = 0;

    /**
     * Cleanup the artifacts by triggering this action.
     */
    virtual void cleanArtifacts() = 0;
};

/** Object that actually handles the update itself. */
class UpdateHandler : public UpdateHandlerInterface
{
  public:
    UpdateHandler(ipmiblob::BlobInterface* blob, DataInterface* handler) :
        blob(blob), handler(handler)
    {}

    ~UpdateHandler() = default;

    bool checkAvailable(const std::string& goalFirmware) override;

    /**
     * @throw ToolException on failure.
     */
    void sendFile(const std::string& target, const std::string& path) override;

    /**
     * @throw ToolException on failure (TODO: throw on timeout.)
     */
    bool verifyFile(const std::string& target, bool ignoreStatus) override;

    std::vector<uint8_t> readVersion(const std::string& versionBlob) override;

    void cleanArtifacts() override;

  private:
    ipmiblob::BlobInterface* blob;
    DataInterface* handler;

    /**
     * @throw ToolException on failure.
     */
    void retrySendFile(const std::string& target, const std::string& path);

    /**
     * @throw ToolException on failure (TODO: throw on timeout.)
     */
    void retryVerifyFile(const std::string& target, bool ignoreStatus);

    /**
     * @throw ToolException on failure.
     */
    std::vector<uint8_t> retryReadVersion(const std::string& versionBlob);

    /**
     * @throw ToolException on failure.
     */
    std::vector<uint8_t>
        retryIfFailed(stdplus::function_view<std::vector<uint8_t>()> callback);
};

} // namespace host_tool