blob: eb299f306908ed4168d453f655c0d1febfb53ba5 [file] [log] [blame]
Pavithra Barithaya51efaf82020-04-02 02:42:27 -05001#pragma once
2
Andrew Jeffery2abbce72023-10-18 10:17:35 +10303#include "common/instance_id.hpp"
Deepak Kodihallid130e1a2020-06-17 05:55:32 -05004#include "common/types.hpp"
5#include "common/utils.hpp"
Pavithra Barithaya3aec9972020-12-14 01:55:44 -06006#include "libpldmresponder/event_parser.hpp"
Sagar Srinivas3687e2b2023-04-10 05:08:28 -05007#include "libpldmresponder/oem_handler.hpp"
Tom Josephb4268602020-04-17 17:20:45 +05308#include "libpldmresponder/pdr_utils.hpp"
Tom Joseph74f27c72021-05-16 07:58:53 -07009#include "requester/handler.hpp"
Kamalkumar Patel4e69d252024-05-10 08:48:03 -050010#include "utils.hpp"
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050011
George Liuc453e162022-12-21 17:16:23 +080012#include <libpldm/base.h>
13#include <libpldm/platform.h>
14
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050015#include <sdeventplus/event.hpp>
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -050016#include <sdeventplus/source/event.hpp>
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050017
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -050018#include <deque>
George Liudf9a6d32020-12-22 16:27:16 +080019#include <filesystem>
George Liu6492f522020-06-16 10:34:05 +080020#include <map>
21#include <memory>
22#include <vector>
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050023
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050024namespace pldm
25{
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -050026// vector which would hold the PDR record handle data returned by
27// pldmPDRRepositoryChgEvent event data
28using ChangeEntry = uint32_t;
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -050029using PDRRecordHandles = std::deque<ChangeEntry>;
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -050030
Tom Josephb4268602020-04-17 17:20:45 +053031/** @struct SensorEntry
32 *
33 * SensorEntry is a unique key which maps a sensorEventType request in the
34 * PlatformEventMessage command to a host sensor PDR. This struct is a key
35 * in a std::map, so implemented operator==and operator<.
36 */
37struct SensorEntry
38{
39 pdr::TerminusID terminusID;
40 pdr::SensorID sensorID;
41
42 bool operator==(const SensorEntry& e) const
43 {
44 return ((terminusID == e.terminusID) && (sensorID == e.sensorID));
45 }
46
47 bool operator<(const SensorEntry& e) const
48 {
49 return ((terminusID < e.terminusID) ||
50 ((terminusID == e.terminusID) && (sensorID < e.sensorID)));
51 }
52};
53
54using HostStateSensorMap = std::map<SensorEntry, pdr::SensorInfo>;
Sampa Misra868c8792020-05-26 03:12:13 -050055using PDRList = std::vector<std::vector<uint8_t>>;
Tom Josephb4268602020-04-17 17:20:45 +053056
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050057/** @class HostPDRHandler
58 * @brief This class can fetch and process PDRs from host firmware
59 * @details Provides an API to fetch PDRs from the host firmware. Upon
60 * receiving the PDRs, they are stored into the BMC's primary PDR repo.
61 * Adjustments are made to entity association PDRs received from the host,
62 * because they need to be assimilated into the BMC's entity association
63 * tree. A PLDM event containing the record handles of the updated entity
64 * association PDRs is sent to the host.
65 */
66class HostPDRHandler
67{
68 public:
69 HostPDRHandler() = delete;
70 HostPDRHandler(const HostPDRHandler&) = delete;
71 HostPDRHandler(HostPDRHandler&&) = delete;
72 HostPDRHandler& operator=(const HostPDRHandler&) = delete;
73 HostPDRHandler& operator=(HostPDRHandler&&) = delete;
74 ~HostPDRHandler() = default;
75
Manojkiran Eda60e1fe92021-10-08 15:58:16 +053076 using TerminusInfo =
77 std::tuple<pdr::TerminusID, pdr::EID, pdr::TerminusValidity>;
78 using TLPDRMap = std::map<pdr::TerminusHandle, TerminusInfo>;
Sampa Misra868c8792020-05-26 03:12:13 -050079
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050080 /** @brief Constructor
81 * @param[in] mctp_fd - fd of MCTP communications socket
82 * @param[in] mctp_eid - MCTP EID of host firmware
83 * @param[in] event - reference of main event loop of pldmd
84 * @param[in] repo - pointer to BMC's primary PDR repo
Pavithra Barithaya3aec9972020-12-14 01:55:44 -060085 * @param[in] eventsJsonDir - directory path which has the config JSONs
Tom Joseph74f27c72021-05-16 07:58:53 -070086 * @param[in] entityTree - Pointer to BMC and Host entity association tree
87 * @param[in] bmcEntityTree - pointer to BMC's entity association tree
Andrew Jefferya330b2f2023-05-04 14:55:37 +093088 * @param[in] instanceIdDb - reference to an InstanceIdDb object
Tom Joseph74f27c72021-05-16 07:58:53 -070089 * @param[in] handler - PLDM request handler
Kamalkumar Pateleb43d6c2024-05-01 06:11:31 -050090 * @param[in] oemUtilsHandler - pointer oem utils handler
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050091 */
Tom Joseph74f27c72021-05-16 07:58:53 -070092 explicit HostPDRHandler(
93 int mctp_fd, uint8_t mctp_eid, sdeventplus::Event& event,
94 pldm_pdr* repo, const std::string& eventsJsonsDir,
95 pldm_entity_association_tree* entityTree,
Brad Bishop5079ac42021-08-19 18:35:06 -040096 pldm_entity_association_tree* bmcEntityTree,
Andrew Jefferya330b2f2023-05-04 14:55:37 +093097 pldm::InstanceIdDb& instanceIdDb,
George Liua881c172021-06-21 18:28:11 +080098 pldm::requester::Handler<pldm::requester::Request>* handler);
Pavithra Barithaya51efaf82020-04-02 02:42:27 -050099
100 /** @brief fetch PDRs from host firmware. See @class.
101 * @param[in] recordHandles - list of record handles pointing to host's
102 * PDRs that need to be fetched.
103 */
Pavithra Barithayae8beb892020-04-14 23:24:25 -0500104
Deepak Kodihalli7246e0c2020-07-08 06:40:18 -0500105 void fetchPDR(PDRRecordHandles&& recordHandles);
Pavithra Barithaya51efaf82020-04-02 02:42:27 -0500106
Pavithra Barithayae8beb892020-04-14 23:24:25 -0500107 /** @brief Send a PLDM event to host firmware containing a list of record
108 * handles of PDRs that the host firmware has to fetch.
109 * @param[in] pdrTypes - list of PDR types that need to be looked up in the
110 * BMC repo
111 * @param[in] eventDataFormat - format for PDRRepositoryChgEvent in DSP0248
112 */
113 void sendPDRRepositoryChgEvent(std::vector<uint8_t>&& pdrTypes,
114 uint8_t eventDataFormat);
115
Tom Josephb4268602020-04-17 17:20:45 +0530116 /** @brief Lookup host sensor info corresponding to requested SensorEntry
117 *
118 * @param[in] entry - TerminusID and SensorID
119 *
Manojkiran Eda2576aec2024-06-17 12:05:17 +0530120 * @return SensorInfo corresponding to the input parameter SensorEntry
Tom Josephb4268602020-04-17 17:20:45 +0530121 * throw std::out_of_range exception if not found
122 */
123 const pdr::SensorInfo& lookupSensorInfo(const SensorEntry& entry) const
124 {
125 return sensorMap.at(entry);
126 }
127
Pavithra Barithaya3aec9972020-12-14 01:55:44 -0600128 /** @brief Handles state sensor event
129 *
130 * @param[in] entry - state sensor entry
131 * @param[in] state - event state
132 *
133 * @return PLDM completion code
134 */
Brad Bishop5079ac42021-08-19 18:35:06 -0400135 int handleStateSensorEvent(
136 const pldm::responder::events::StateSensorEntry& entry,
137 pdr::EventState state);
Pavithra Barithaya3aec9972020-12-14 01:55:44 -0600138
Sampa Misra868c8792020-05-26 03:12:13 -0500139 /** @brief Parse state sensor PDRs and populate the sensorMap lookup data
140 * structure
141 *
142 * @param[in] stateSensorPDRs - host state sensor PDRs
Sampa Misra868c8792020-05-26 03:12:13 -0500143 *
144 */
Manojkiran Eda60e1fe92021-10-08 15:58:16 +0530145 void parseStateSensorPDRs(const PDRList& stateSensorPDRs);
Sampa Misra868c8792020-05-26 03:12:13 -0500146
Sampa Misrac0c79482021-06-02 08:01:54 -0500147 /** @brief this function sends a GetPDR request to Host firmware.
148 * And processes the PDRs based on type
149 *
150 * @param[in] - nextRecordHandle - the next record handle to ask for
151 */
152 void getHostPDR(uint32_t nextRecordHandle = 0);
153
Sampa Misraf9ba8c12021-08-06 00:33:47 -0500154 /** @brief set the Host firmware condition when pldmd starts
sampmisr6decfc12021-03-02 11:07:36 +0530155 */
Sampa Misraf9ba8c12021-08-06 00:33:47 -0500156 void setHostFirmwareCondition();
sampmisr6decfc12021-03-02 11:07:36 +0530157
Pavithra Barithaya4f2538a2021-03-05 07:32:15 -0600158 /** @brief set HostSensorStates when pldmd starts or restarts
159 * and updates the D-Bus property
160 * @param[in] stateSensorPDRs - host state sensor PDRs
Pavithra Barithaya4f2538a2021-03-05 07:32:15 -0600161 */
Manojkiran Eda60e1fe92021-10-08 15:58:16 +0530162 void setHostSensorState(const PDRList& stateSensorPDRs);
Pavithra Barithaya4f2538a2021-03-05 07:32:15 -0600163
Pavithra Barithayaae5c97e2022-08-29 02:57:59 -0500164 /** @brief whether we received PLDM_RECORDS_MODIFIED event data operation
165 * from host
166 */
167 bool isHostPdrModified = false;
168
sampmisr6decfc12021-03-02 11:07:36 +0530169 /** @brief check whether Host is running when pldmd starts
170 */
171 bool isHostUp();
172
George Liua881c172021-06-21 18:28:11 +0800173 /* @brief Method to set the oem platform handler in host pdr handler class
174 *
175 * @param[in] handler - oem platform handler
176 */
177 inline void
178 setOemPlatformHandler(pldm::responder::oem_platform::Handler* handler)
179 {
180 oemPlatformHandler = handler;
181 }
182
Kamalkumar Pateleb43d6c2024-05-01 06:11:31 -0500183 /* @brief Method to set the oem utils handler in host pdr handler class
184 *
185 * @param[in] handler - oem utils handler
186 */
187 inline void setOemUtilsHandler(pldm::responder::oem_utils::Handler* handler)
188 {
189 oemUtilsHandler = handler;
190 }
191
Manojkiran Eda60e1fe92021-10-08 15:58:16 +0530192 /** @brief map that captures various terminus information **/
193 TLPDRMap tlPDRInfo;
194
sampmisr6decfc12021-03-02 11:07:36 +0530195 private:
196 /** @brief deferred function to fetch PDR from Host, scheduled to work on
197 * the event loop. The PDR exchg with the host is async.
198 * @param[in] source - sdeventplus event source
199 */
200 void _fetchPDR(sdeventplus::source::EventBase& source);
201
Deepak Kodihalli87514cc2020-04-16 09:08:38 -0500202 /** @brief Merge host firmware's entity association PDRs into BMC's
203 * @details A merge operation involves adding a pldm_entity under the
204 * appropriate parent, and updating container ids.
205 * @param[in] pdr - entity association pdr
Sagar Srinivas3687e2b2023-04-10 05:08:28 -0500206 * @param[in] size - size of input PDR record in bytes
207 * @param[in] record_handle - record handle of the PDR
Deepak Kodihalli87514cc2020-04-16 09:08:38 -0500208 */
Sagar Srinivas3687e2b2023-04-10 05:08:28 -0500209 void
210 mergeEntityAssociations(const std::vector<uint8_t>& pdr,
211 [[maybe_unused]] const uint32_t& size,
212 [[maybe_unused]] const uint32_t& record_handle);
Deepak Kodihalli87514cc2020-04-16 09:08:38 -0500213
Sampa Misrac0c79482021-06-02 08:01:54 -0500214 /** @brief process the Host's PDR and add to BMC's PDR repo
215 * @param[in] eid - MCTP id of Host
216 * @param[in] response - response from Host for GetPDR
217 * @param[in] respMsgLen - response message length
218 */
219 void processHostPDRs(mctp_eid_t eid, const pldm_msg* response,
220 size_t respMsgLen);
221
222 /** @brief send PDR Repo change after merging Host's PDR to BMC PDR repo
223 * @param[in] source - sdeventplus event source
224 */
225 void _processPDRRepoChgEvent(sdeventplus::source::EventBase& source);
226
227 /** @brief fetch the next PDR based on the record handle sent by Host
228 * @param[in] nextRecordHandle - next record handle
229 * @param[in] source - sdeventplus event source
230 */
231 void _processFetchPDREvent(uint32_t nextRecordHandle,
232 sdeventplus::source::EventBase& source);
233
George Liu682ee182020-12-25 15:24:33 +0800234 /** @brief Get FRU record table metadata by remote PLDM terminus
235 *
236 * @param[out] uint16_t - total table records
237 */
238 void getFRURecordTableMetadataByRemote(const PDRList& fruRecordSetPDRs);
239
240 /** @brief Set Location Code in the dbus objects
241 *
242 * @param[in] fruRecordSetPDRs - the Fru Record set PDR's
243 * @param[in] fruRecordData - the Fru Record Data
244 */
245
246 void setFRUDataOnDBus(
247 const PDRList& fruRecordSetPDRs,
248 const std::vector<responder::pdr_utils::FruRecordDataFormat>&
249 fruRecordData);
250
251 /** @brief Get FRU record table by remote PLDM terminus
252 *
253 * @param[in] fruRecordSetPDRs - the Fru Record set PDR's
254 * @param[in] totalTableRecords - the Number of total table records
255 * @return
256 */
257 void getFRURecordTableByRemote(const PDRList& fruRecordSetPDRs,
258 uint16_t totalTableRecords);
259
260 /** @brief Create Dbus objects by remote PLDM entity Fru PDRs
261 *
262 * @param[in] fruRecordSetPDRs - fru record set pdr
263 *
264 * @ return
265 */
266 void createDbusObjects(const PDRList& fruRecordSetPDRs);
267
268 /** @brief Get FRU Record Set Identifier from FRU Record data Format
269 * @param[in] fruRecordSetPDRs - fru record set pdr
270 * @param[in] entity - PLDM entity information
271 * @return
272 */
273 std::optional<uint16_t> getRSI(const PDRList& fruRecordSetPDRs,
274 const pldm_entity& entity);
275
Pavithra Barithaya51efaf82020-04-02 02:42:27 -0500276 /** @brief fd of MCTP communications socket */
277 int mctp_fd;
278 /** @brief MCTP EID of host firmware */
279 uint8_t mctp_eid;
280 /** @brief reference of main event loop of pldmd, primarily used to schedule
281 * work.
282 */
283 sdeventplus::Event& event;
284 /** @brief pointer to BMC's primary PDR repo, host PDRs are added here */
285 pldm_pdr* repo;
Pavithra Barithaya3aec9972020-12-14 01:55:44 -0600286
Brad Bishop5079ac42021-08-19 18:35:06 -0400287 pldm::responder::events::StateSensorHandler stateSensorHandler;
Sampa Misrac073a202021-05-08 10:56:05 -0500288 /** @brief Pointer to BMC's and Host's entity association tree */
Deepak Kodihalli87514cc2020-04-16 09:08:38 -0500289 pldm_entity_association_tree* entityTree;
Sampa Misrac073a202021-05-08 10:56:05 -0500290
291 /** @brief Pointer to BMC's entity association tree */
292 pldm_entity_association_tree* bmcEntityTree;
293
Andrew Jefferya330b2f2023-05-04 14:55:37 +0930294 /** @brief reference to Instance ID database object, used to obtain PLDM
295 * instance IDs
Pavithra Barithaya51efaf82020-04-02 02:42:27 -0500296 */
Andrew Jefferya330b2f2023-05-04 14:55:37 +0930297 pldm::InstanceIdDb& instanceIdDb;
Tom Joseph74f27c72021-05-16 07:58:53 -0700298
299 /** @brief PLDM request handler */
Sampa Misrac0c79482021-06-02 08:01:54 -0500300 pldm::requester::Handler<pldm::requester::Request>* handler;
Tom Joseph74f27c72021-05-16 07:58:53 -0700301
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500302 /** @brief sdeventplus event source */
303 std::unique_ptr<sdeventplus::source::Defer> pdrFetchEvent;
Sampa Misrac0c79482021-06-02 08:01:54 -0500304 std::unique_ptr<sdeventplus::source::Defer> deferredFetchPDREvent;
305 std::unique_ptr<sdeventplus::source::Defer> deferredPDRRepoChgEvent;
306
Deepak Kodihalli8cb6f662020-04-10 02:55:43 -0500307 /** @brief list of PDR record handles pointing to host's PDRs */
308 PDRRecordHandles pdrRecordHandles;
Deepak Kodihalli87514cc2020-04-16 09:08:38 -0500309 /** @brief maps an entity type to parent pldm_entity from the BMC's entity
310 * association tree
311 */
Pavithra Barithayaae5c97e2022-08-29 02:57:59 -0500312
313 /** @brief list of PDR record handles modified pointing to host PDRs */
314 PDRRecordHandles modifiedPDRRecordHandles;
315
Deepak Kodihalli6b1d1ca2020-04-27 07:24:51 -0500316 /** @brief D-Bus property changed signal match */
Patrick Williams84b790c2022-07-22 19:26:56 -0500317 std::unique_ptr<sdbusplus::bus::match_t> hostOffMatch;
Tom Josephb4268602020-04-17 17:20:45 +0530318
319 /** @brief sensorMap is a lookup data structure that is build from the
320 * hostPDR that speeds up the lookup of <TerminusID, SensorID> in
321 * PlatformEventMessage command request.
322 */
323 HostStateSensorMap sensorMap;
sampmisr6decfc12021-03-02 11:07:36 +0530324
325 /** @brief whether response received from Host */
326 bool responseReceived;
George Liuacf2c8c2021-05-10 14:08:52 +0800327
328 /** @brief variable that captures if the first entity association PDR
329 * from host is merged into the BMC tree
330 */
331 bool mergedHostParents;
332
George Liudf9a6d32020-12-22 16:27:16 +0800333 /** @brief maps an object path to pldm_entity from the BMC's entity
334 * association tree
335 */
Kamalkumar Patel7d427f12024-05-16 03:44:00 -0500336 pldm::utils::ObjectPathMaps objPathMap;
George Liudf9a6d32020-12-22 16:27:16 +0800337
338 /** @brief maps an entity name to map, maps to entity name to pldm_entity
339 */
Kamalkumar Patel7d427f12024-05-16 03:44:00 -0500340 pldm::utils::EntityAssociations entityAssociations;
George Liu682ee182020-12-25 15:24:33 +0800341
342 /** @brief the vector of FRU Record Data Format
343 */
344 std::vector<responder::pdr_utils::FruRecordDataFormat> fruRecordData;
345
Sagar Srinivas3687e2b2023-04-10 05:08:28 -0500346 /** @OEM platform handler */
George Liua881c172021-06-21 18:28:11 +0800347 pldm::responder::oem_platform::Handler* oemPlatformHandler = nullptr;
Kamalkumar Patel516122e2024-05-07 04:39:32 -0500348
349 /** @brief entityID and entity name is only loaded once
350 */
Kamalkumar Patel7d427f12024-05-16 03:44:00 -0500351 pldm::utils::EntityMaps entityMaps;
Kamalkumar Pateleb43d6c2024-05-01 06:11:31 -0500352
353 /** @OEM Utils handler */
354 pldm::responder::oem_utils::Handler* oemUtilsHandler;
Pavithra Barithaya51efaf82020-04-02 02:42:27 -0500355};
356
357} // namespace pldm