common/utils.hpp - openbmc/pldm - Gitiles

 #pragma once

 #include "libpldm/base.h"
 #include "libpldm/bios.h"
 #include "libpldm/platform.h"

 #include "types.hpp"

 #include <stdint.h>
 #include <systemd/sd-bus.h>
 #include <unistd.h>

 #include <nlohmann/json.hpp>
 #include <sdbusplus/server.hpp>
 #include <xyz/openbmc_project/Logging/Entry/server.hpp>

 #include <exception>
 #include <filesystem>
 #include <iostream>
 #include <string>
 #include <variant>
 #include <vector>

 namespace pldm
 {
 namespace utils
 {

 namespace fs = std::filesystem;
 using Json = nlohmann::json;

 /** @struct CustomFD
  *
  *  RAII wrapper for file descriptor.
  */
 struct CustomFD
 {
     CustomFD(const CustomFD&) = delete;
     CustomFD& operator=(const CustomFD&) = delete;
     CustomFD(CustomFD&&) = delete;
     CustomFD& operator=(CustomFD&&) = delete;

     CustomFD(int fd) : fd(fd)
     {}

     ~CustomFD()
     {
         if (fd >= 0)
         {
             close(fd);
         }
     }

     int operator()() const
     {
         return fd;
     }

   private:
     int fd = -1;
 };

 /** @brief Calculate the pad for PLDM data
  *
  *  @param[in] data - Length of the data
  *  @return - uint8_t - number of pad bytes
  */
 uint8_t getNumPadBytes(uint32_t data);

 /** @brief Convert uint64 to date
  *
  *  @param[in] data - time date of uint64
  *  @param[out] year - year number in dec
  *  @param[out] month - month number in dec
  *  @param[out] day - day of the month in dec
  *  @param[out] hour - number of hours in dec
  *  @param[out] min - number of minutes in dec
  *  @param[out] sec - number of seconds in dec
  *  @return true if decode success, false if decode faild
  */
 bool uintToDate(uint64_t data, uint16_t* year, uint8_t* month, uint8_t* day,
                 uint8_t* hour, uint8_t* min, uint8_t* sec);

 /** @brief Convert effecter data to structure of set_effecter_state_field
  *
  *  @param[in] effecterData - the date of effecter
  *  @param[in] effecterCount - the number of individual sets of effecter
  *                              information
  *  @return[out] parse success and get a valid set_effecter_state_field
  *               structure, return nullopt means parse failed
  */
 std::optional<std::vector<set_effecter_state_field>>
     parseEffecterData(const std::vector<uint8_t>& effecterData,
                       uint8_t effecterCount);

 /**
  *  @brief creates an error log
  *  @param[in] errorMsg - the error message
  */
 void reportError(const char* errorMsg);

 /** @brief Convert any Decimal number to BCD
  *
  *  @tparam[in] decimal - Decimal number
  *  @return Corresponding BCD number
  */
 template <typename T>
 T decimalToBcd(T decimal)
 {
     T bcd = 0;
     T rem = 0;
     auto cnt = 0;

     while (decimal)
     {
         rem = decimal % 10;
         bcd = bcd + (rem << cnt);
         decimal = decimal / 10;
         cnt += 4;
     }

     return bcd;
 }

 constexpr auto dbusProperties = "org.freedesktop.DBus.Properties";
 constexpr auto mapperService = "xyz.openbmc_project.ObjectMapper";

 struct DBusMapping
 {
     std::string objectPath;   //!< D-Bus object path
     std::string interface;    //!< D-Bus interface
     std::string propertyName; //!< D-Bus property name
     std::string propertyType; //!< D-Bus property type
 };

 using PropertyValue =
     std::variant<bool, uint8_t, int16_t, uint16_t, int32_t, uint32_t, int64_t,
                  uint64_t, double, std::string>;
 using DbusProp = std::string;
 using DbusChangedProps = std::map<DbusProp, PropertyValue>;
 using DBusInterfaceAdded = std::vector<
     std::pair<pldm::dbus::Interface,
               std::vector<std::pair<pldm::dbus::Property,
                                     std::variant<pldm::dbus::Property>>>>>;

 /**
  * @brief The interface for DBusHandler
  */
 class DBusHandlerInterface
 {
   public:
     virtual ~DBusHandlerInterface() = default;

     virtual std::string getService(const char* path,
                                    const char* interface) const = 0;

     virtual void setDbusProperty(const DBusMapping& dBusMap,
                                  const PropertyValue& value) const = 0;

     virtual PropertyValue
         getDbusPropertyVariant(const char* objPath, const char* dbusProp,
                                const char* dbusInterface) const = 0;
 };

 /**
  *  @class DBusHandler
  *
  *  Wrapper class to handle the D-Bus calls
  *
  *  This class contains the APIs to handle the D-Bus calls
  *  to cater the request from pldm requester.
  *  A class is created to mock the apis in the test cases
  */
 class DBusHandler : public DBusHandlerInterface
 {
   public:
     /** @brief Get the bus connection. */
     static auto& getBus()
     {
         static auto bus = sdbusplus::bus::new_default();
         return bus;
     }

     /**
      *  @brief Get the DBUS Service name for the input dbus path
      *
      *  @param[in] path - DBUS object path
      *  @param[in] interface - DBUS Interface
      *
      *  @return std::string - the dbus service name
      *
      *  @throw sdbusplus::exception::SdBusError when it fails
      */
     std::string getService(const char* path,
                            const char* interface) const override;

     /** @brief Get property(type: variant) from the requested dbus
      *
      *  @param[in] objPath - The Dbus object path
      *  @param[in] dbusProp - The property name to get
      *  @param[in] dbusInterface - The Dbus interface
      *
      *  @return The value of the property(type: variant)
      *
      *  @throw sdbusplus::exception::SdBusError when it fails
      */
     PropertyValue
         getDbusPropertyVariant(const char* objPath, const char* dbusProp,
                                const char* dbusInterface) const override;

     /** @brief The template function to get property from the requested dbus
      *         path
      *
      *  @tparam Property - Excepted type of the property on dbus
      *
      *  @param[in] objPath - The Dbus object path
      *  @param[in] dbusProp - The property name to get
      *  @param[in] dbusInterface - The Dbus interface
      *
      *  @return The value of the property
      *
      *  @throw sdbusplus::exception::SdBusError when dbus request fails
      *         std::bad_variant_access when \p Property and property on dbus do
      *         not match
      */
     template <typename Property>
     auto getDbusProperty(const char* objPath, const char* dbusProp,
                          const char* dbusInterface)
     {
         auto VariantValue =
             getDbusPropertyVariant(objPath, dbusProp, dbusInterface);
         return std::get<Property>(VariantValue);
     }

     /** @brief Set Dbus property
      *
      *  @param[in] dBusMap - Object path, property name, interface and property
      *                       type for the D-Bus object
      *  @param[in] value - The value to be set
      *
      *  @throw sdbusplus::exception::SdBusError when it fails
      */
     void setDbusProperty(const DBusMapping& dBusMap,
                          const PropertyValue& value) const override;
 };

 /** @brief Fetch parent D-Bus object based on pathname
  *
  *  @param[in] dbusObj - child D-Bus object
  *
  *  @return std::string - the parent D-Bus object path
  */
 inline std::string findParent(const std::string& dbusObj)
 {
     fs::path p(dbusObj);
     return p.parent_path().string();
 }

 /** @brief Read (static) MCTP EID of host firmware from a file
  *
  *  @return uint8_t - MCTP EID
  */
 uint8_t readHostEID();

 /** @brief Convert a value in the JSON to a D-Bus property value
  *
  *  @param[in] type - type of the D-Bus property
  *  @param[in] value - value in the JSON file
  *
  *  @return PropertyValue - the D-Bus property value
  */
 PropertyValue jsonEntryToDbusVal(std::string_view type,
                                  const nlohmann::json& value);

 /** @brief Find State Effecter PDR
  *  @param[in] tid - PLDM terminus ID.
  *  @param[in] entityID - entity that can be associated with PLDM State set.
  *  @param[in] stateSetId - value that identifies PLDM State set.
  *  @param[in] repo - pointer to BMC's primary PDR repo.
  *  @return array[array[uint8_t]] - StateEffecterPDRs
  */
 std::vector<std::vector<uint8_t>> findStateEffecterPDR(uint8_t tid,
                                                        uint16_t entityID,
                                                        uint16_t stateSetId,
                                                        const pldm_pdr* repo);
 /** @brief Find State Sensor PDR
  *  @param[in] tid - PLDM terminus ID.
  *  @param[in] entityID - entity that can be associated with PLDM State set.
  *  @param[in] stateSetId - value that identifies PLDM State set.
  *  @param[in] repo - pointer to BMC's primary PDR repo.
  *  @return array[array[uint8_t]] - StateSensorPDRs
  */
 std::vector<std::vector<uint8_t>> findStateSensorPDR(uint8_t tid,
                                                      uint16_t entityID,
                                                      uint16_t stateSetId,
                                                      const pldm_pdr* repo);

 /** @brief Find sensor id from a state sensor PDR
  *
  *  @param[in] pdrRepo - PDR repository
  *  @param[in] tid - terminus id
  *  @param[in] entityType - entity type
  *  @param[in] entityInstance - entity instance number
  *  @param[in] containerId - container id
  *  @param[in] stateSetId - state set id
  *
  *  @return uint16_t - the sensor id
  */
 uint16_t findStateSensorId(const pldm_pdr* pdrRepo, uint8_t tid,
                            uint16_t entityType, uint16_t entityInstance,
                            uint16_t containerId, uint16_t stateSetId);

 /** @brief Find effecter id from a state effecter pdr
  *  @param[in] pdrRepo - PDR repository
  *  @param[in] entityType - entity type
  *  @param[in] entityInstance - entity instance number
  *  @param[in] containerId - container id
  *  @param[in] stateSetId - state set id
  *  @param[in] localOrRemote - true for checking local repo and false for remote
  *                             repo
  *
  *  @return uint16_t - the effecter id
  */
 uint16_t findStateEffecterId(const pldm_pdr* pdrRepo, uint16_t entityType,
                              uint16_t entityInstance, uint16_t containerId,
                              uint16_t stateSetId, bool localOrRemote);

 /** @brief Emit the sensor event signal
  *
  *	@param[in] tid - the terminus id
  *  @param[in] sensorId - sensorID value of the sensor
  *  @param[in] sensorOffset - Identifies which state sensor within a
  * composite state sensor the event is being returned for
  *  @param[in] eventState - The event state value from the state change that
  * triggered the event message
  *  @param[in] previousEventState - The event state value for the state from
  * which the present event state was entered.
  *  @return PLDM completion code
  */
 int emitStateSensorEventSignal(uint8_t tid, uint16_t sensorId,
                                uint8_t sensorOffset, uint8_t eventState,
                                uint8_t previousEventState);

 } // namespace utils
 } // namespace pldm
	#pragma once

	#include "libpldm/base.h"
	#include "libpldm/bios.h"
	#include "libpldm/platform.h"

	#include "types.hpp"

	#include <stdint.h>
	#include <systemd/sd-bus.h>
	#include <unistd.h>

	#include <nlohmann/json.hpp>
	#include <sdbusplus/server.hpp>
	#include <xyz/openbmc_project/Logging/Entry/server.hpp>

	#include <exception>
	#include <filesystem>
	#include <iostream>
	#include <string>
	#include <variant>
	#include <vector>

	namespace pldm
	{
	namespace utils
	{

	namespace fs = std::filesystem;
	using Json = nlohmann::json;

	/** @struct CustomFD
	*
	* RAII wrapper for file descriptor.
	*/
	struct CustomFD
	{
	CustomFD(const CustomFD&) = delete;
	CustomFD& operator=(const CustomFD&) = delete;
	CustomFD(CustomFD&&) = delete;
	CustomFD& operator=(CustomFD&&) = delete;

	CustomFD(int fd) : fd(fd)
	{}

	~CustomFD()
	{
	if (fd >= 0)
	{
	close(fd);
	}
	}

	int operator()() const
	{
	return fd;
	}

	private:
	int fd = -1;
	};

	/** @brief Calculate the pad for PLDM data
	*
	* @param[in] data - Length of the data
	* @return - uint8_t - number of pad bytes
	*/
	uint8_t getNumPadBytes(uint32_t data);

	/** @brief Convert uint64 to date
	*
	* @param[in] data - time date of uint64
	* @param[out] year - year number in dec
	* @param[out] month - month number in dec
	* @param[out] day - day of the month in dec
	* @param[out] hour - number of hours in dec
	* @param[out] min - number of minutes in dec
	* @param[out] sec - number of seconds in dec
	* @return true if decode success, false if decode faild
	*/
	bool uintToDate(uint64_t data, uint16_t* year, uint8_t* month, uint8_t* day,
	uint8_t* hour, uint8_t* min, uint8_t* sec);

	/** @brief Convert effecter data to structure of set_effecter_state_field
	*
	* @param[in] effecterData - the date of effecter
	* @param[in] effecterCount - the number of individual sets of effecter
	* information
	* @return[out] parse success and get a valid set_effecter_state_field
	* structure, return nullopt means parse failed
	*/
	std::optional<std::vector<set_effecter_state_field>>
	parseEffecterData(const std::vector<uint8_t>& effecterData,
	uint8_t effecterCount);

	/**
	* @brief creates an error log
	* @param[in] errorMsg - the error message
	*/
	void reportError(const char* errorMsg);

	/** @brief Convert any Decimal number to BCD
	*
	* @tparam[in] decimal - Decimal number
	* @return Corresponding BCD number
	*/
	template <typename T>
	T decimalToBcd(T decimal)
	{
	T bcd = 0;
	T rem = 0;
	auto cnt = 0;

	while (decimal)
	{
	rem = decimal % 10;
	bcd = bcd + (rem << cnt);
	decimal = decimal / 10;
	cnt += 4;
	}

	return bcd;
	}

	constexpr auto dbusProperties = "org.freedesktop.DBus.Properties";
	constexpr auto mapperService = "xyz.openbmc_project.ObjectMapper";

	struct DBusMapping
	{
	std::string objectPath; //!< D-Bus object path
	std::string interface; //!< D-Bus interface
	std::string propertyName; //!< D-Bus property name
	std::string propertyType; //!< D-Bus property type
	};

	using PropertyValue =
	std::variant<bool, uint8_t, int16_t, uint16_t, int32_t, uint32_t, int64_t,
	uint64_t, double, std::string>;
	using DbusProp = std::string;
	using DbusChangedProps = std::map<DbusProp, PropertyValue>;
	using DBusInterfaceAdded = std::vector<
	std::pair<pldm::dbus::Interface,
	std::vector<std::pair<pldm::dbus::Property,
	std::variant<pldm::dbus::Property>>>>>;

	/**
	* @brief The interface for DBusHandler
	*/
	class DBusHandlerInterface
	{
	public:
	virtual ~DBusHandlerInterface() = default;

	virtual std::string getService(const char* path,
	const char* interface) const = 0;

	virtual void setDbusProperty(const DBusMapping& dBusMap,
	const PropertyValue& value) const = 0;

	virtual PropertyValue
	getDbusPropertyVariant(const char* objPath, const char* dbusProp,
	const char* dbusInterface) const = 0;
	};

	/**
	* @class DBusHandler
	*
	* Wrapper class to handle the D-Bus calls
	*
	* This class contains the APIs to handle the D-Bus calls
	* to cater the request from pldm requester.
	* A class is created to mock the apis in the test cases
	*/
	class DBusHandler : public DBusHandlerInterface
	{
	public:
	/** @brief Get the bus connection. */
	static auto& getBus()
	{
	static auto bus = sdbusplus::bus::new_default();
	return bus;
	}

	/**
	* @brief Get the DBUS Service name for the input dbus path
	*
	* @param[in] path - DBUS object path
	* @param[in] interface - DBUS Interface
	*
	* @return std::string - the dbus service name
	*
	* @throw sdbusplus::exception::SdBusError when it fails
	*/
	std::string getService(const char* path,
	const char* interface) const override;

	/** @brief Get property(type: variant) from the requested dbus
	*
	* @param[in] objPath - The Dbus object path
	* @param[in] dbusProp - The property name to get
	* @param[in] dbusInterface - The Dbus interface
	*
	* @return The value of the property(type: variant)
	*
	* @throw sdbusplus::exception::SdBusError when it fails
	*/
	PropertyValue
	getDbusPropertyVariant(const char* objPath, const char* dbusProp,
	const char* dbusInterface) const override;

	/** @brief The template function to get property from the requested dbus
	* path
	*
	* @tparam Property - Excepted type of the property on dbus
	*
	* @param[in] objPath - The Dbus object path
	* @param[in] dbusProp - The property name to get
	* @param[in] dbusInterface - The Dbus interface
	*
	* @return The value of the property
	*
	* @throw sdbusplus::exception::SdBusError when dbus request fails
	* std::bad_variant_access when \p Property and property on dbus do
	* not match
	*/
	template <typename Property>
	auto getDbusProperty(const char* objPath, const char* dbusProp,
	const char* dbusInterface)
	{
	auto VariantValue =
	getDbusPropertyVariant(objPath, dbusProp, dbusInterface);
	return std::get<Property>(VariantValue);
	}

	/** @brief Set Dbus property
	*
	* @param[in] dBusMap - Object path, property name, interface and property
	* type for the D-Bus object
	* @param[in] value - The value to be set
	*
	* @throw sdbusplus::exception::SdBusError when it fails
	*/
	void setDbusProperty(const DBusMapping& dBusMap,
	const PropertyValue& value) const override;
	};

	/** @brief Fetch parent D-Bus object based on pathname
	*
	* @param[in] dbusObj - child D-Bus object
	*
	* @return std::string - the parent D-Bus object path
	*/
	inline std::string findParent(const std::string& dbusObj)
	{
	fs::path p(dbusObj);
	return p.parent_path().string();
	}

	/** @brief Read (static) MCTP EID of host firmware from a file
	*
	* @return uint8_t - MCTP EID
	*/
	uint8_t readHostEID();

	/** @brief Convert a value in the JSON to a D-Bus property value
	*
	* @param[in] type - type of the D-Bus property
	* @param[in] value - value in the JSON file
	*
	* @return PropertyValue - the D-Bus property value
	*/
	PropertyValue jsonEntryToDbusVal(std::string_view type,
	const nlohmann::json& value);

	/** @brief Find State Effecter PDR
	* @param[in] tid - PLDM terminus ID.
	* @param[in] entityID - entity that can be associated with PLDM State set.
	* @param[in] stateSetId - value that identifies PLDM State set.
	* @param[in] repo - pointer to BMC's primary PDR repo.
	* @return array[array[uint8_t]] - StateEffecterPDRs
	*/
	std::vector<std::vector<uint8_t>> findStateEffecterPDR(uint8_t tid,
	uint16_t entityID,
	uint16_t stateSetId,
	const pldm_pdr* repo);
	/** @brief Find State Sensor PDR
	* @param[in] tid - PLDM terminus ID.
	* @param[in] entityID - entity that can be associated with PLDM State set.
	* @param[in] stateSetId - value that identifies PLDM State set.
	* @param[in] repo - pointer to BMC's primary PDR repo.
	* @return array[array[uint8_t]] - StateSensorPDRs
	*/
	std::vector<std::vector<uint8_t>> findStateSensorPDR(uint8_t tid,
	uint16_t entityID,
	uint16_t stateSetId,
	const pldm_pdr* repo);

	/** @brief Find sensor id from a state sensor PDR
	*
	* @param[in] pdrRepo - PDR repository
	* @param[in] tid - terminus id
	* @param[in] entityType - entity type
	* @param[in] entityInstance - entity instance number
	* @param[in] containerId - container id
	* @param[in] stateSetId - state set id
	*
	* @return uint16_t - the sensor id
	*/
	uint16_t findStateSensorId(const pldm_pdr* pdrRepo, uint8_t tid,
	uint16_t entityType, uint16_t entityInstance,
	uint16_t containerId, uint16_t stateSetId);

	/** @brief Find effecter id from a state effecter pdr
	* @param[in] pdrRepo - PDR repository
	* @param[in] entityType - entity type
	* @param[in] entityInstance - entity instance number
	* @param[in] containerId - container id
	* @param[in] stateSetId - state set id
	* @param[in] localOrRemote - true for checking local repo and false for remote
	* repo
	*
	* @return uint16_t - the effecter id
	*/
	uint16_t findStateEffecterId(const pldm_pdr* pdrRepo, uint16_t entityType,
	uint16_t entityInstance, uint16_t containerId,
	uint16_t stateSetId, bool localOrRemote);

	/** @brief Emit the sensor event signal
	*
	* @param[in] tid - the terminus id
	* @param[in] sensorId - sensorID value of the sensor
	* @param[in] sensorOffset - Identifies which state sensor within a
	* composite state sensor the event is being returned for
	* @param[in] eventState - The event state value from the state change that
	* triggered the event message
	* @param[in] previousEventState - The event state value for the state from
	* which the present event state was entered.
	* @return PLDM completion code
	*/
	int emitStateSensorEventSignal(uint8_t tid, uint16_t sensorId,
	uint8_t sensorOffset, uint8_t eventState,
	uint8_t previousEventState);

	} // namespace utils
	} // namespace pldm