blob: ff178863d4e6a69bf9d148da12fc9af396456e65 [file] [log] [blame]
Tom Joseph74f27c72021-05-16 07:58:53 -07001#pragma once
2
Manojkiran Edaef773052021-07-29 09:29:28 +05303#include "common/flight_recorder.hpp"
Rashmica Gupta1ed5f7a2023-05-22 13:56:42 +10004#include "common/transport.hpp"
Tom Joseph74f27c72021-05-16 07:58:53 -07005#include "common/types.hpp"
Tom Josephe5268cd2021-09-07 13:04:03 +05306#include "common/utils.hpp"
Tom Joseph74f27c72021-05-16 07:58:53 -07007
George Liuc453e162022-12-21 17:16:23 +08008#include <libpldm/base.h>
Manojkiran Eda9fffea22021-10-27 16:03:27 +05309#include <sys/socket.h>
10
Riya Dixit49cfb132023-03-02 04:26:53 -060011#include <phosphor-logging/lg2.hpp>
Tom Joseph74f27c72021-05-16 07:58:53 -070012#include <sdbusplus/timer.hpp>
13#include <sdeventplus/event.hpp>
14
15#include <chrono>
16#include <functional>
17#include <iostream>
18
Riya Dixit49cfb132023-03-02 04:26:53 -060019PHOSPHOR_LOG2_USING;
20
Tom Joseph74f27c72021-05-16 07:58:53 -070021namespace pldm
22{
Tom Joseph74f27c72021-05-16 07:58:53 -070023namespace requester
24{
Tom Joseph74f27c72021-05-16 07:58:53 -070025/** @class RequestRetryTimer
26 *
27 * The abstract base class for implementing the PLDM request retry logic. This
28 * class handles number of times the PLDM request needs to be retried if the
29 * response is not received and the time to wait between each retry. It
30 * provides APIs to start and stop the request flow.
31 */
32class RequestRetryTimer
33{
34 public:
35 RequestRetryTimer() = delete;
36 RequestRetryTimer(const RequestRetryTimer&) = delete;
Pavithra Barithayaa7dbca52023-07-07 04:19:37 -050037 RequestRetryTimer(RequestRetryTimer&&) = delete;
Tom Joseph74f27c72021-05-16 07:58:53 -070038 RequestRetryTimer& operator=(const RequestRetryTimer&) = delete;
Pavithra Barithayaa7dbca52023-07-07 04:19:37 -050039 RequestRetryTimer& operator=(RequestRetryTimer&&) = delete;
Tom Joseph74f27c72021-05-16 07:58:53 -070040 virtual ~RequestRetryTimer() = default;
41
42 /** @brief Constructor
43 *
44 * @param[in] event - reference to PLDM daemon's main event loop
45 * @param[in] numRetries - number of request retries
46 * @param[in] timeout - time to wait between each retry in milliseconds
47 */
48 explicit RequestRetryTimer(sdeventplus::Event& event, uint8_t numRetries,
Brad Bishop5079ac42021-08-19 18:35:06 -040049 std::chrono::milliseconds timeout) :
Tom Joseph74f27c72021-05-16 07:58:53 -070050
51 event(event),
52 numRetries(numRetries), timeout(timeout),
53 timer(event.get(), std::bind_front(&RequestRetryTimer::callback, this))
54 {}
55
56 /** @brief Starts the request flow and arms the timer for request retries
57 *
58 * @return return PLDM_SUCCESS on success and PLDM_ERROR otherwise
59 */
60 int start()
61 {
62 auto rc = send();
Tom Josepha5ed6582021-06-17 22:08:47 -070063 if (rc)
Tom Joseph74f27c72021-05-16 07:58:53 -070064 {
65 return rc;
66 }
67
68 try
69 {
70 if (numRetries)
71 {
Brad Bishop5079ac42021-08-19 18:35:06 -040072 timer.start(duration_cast<std::chrono::microseconds>(timeout),
73 true);
Tom Joseph74f27c72021-05-16 07:58:53 -070074 }
75 }
76 catch (const std::runtime_error& e)
77 {
Riya Dixit087a7512024-04-06 14:28:08 -050078 error("Failed to start the request timer, error - {ERROR}", "ERROR",
79 e);
Tom Joseph74f27c72021-05-16 07:58:53 -070080 return PLDM_ERROR;
81 }
82
83 return PLDM_SUCCESS;
84 }
85
86 /** @brief Stops the timer and no further request retries happen */
87 void stop()
88 {
89 auto rc = timer.stop();
90 if (rc)
91 {
Riya Dixit087a7512024-04-06 14:28:08 -050092 error("Failed to stop the request timer, response code '{RC}'",
93 "RC", static_cast<int>(rc));
Tom Joseph74f27c72021-05-16 07:58:53 -070094 }
95 }
96
97 protected:
98 sdeventplus::Event& event; //!< reference to PLDM daemon's main event loop
99 uint8_t numRetries; //!< number of request retries
Brad Bishop5079ac42021-08-19 18:35:06 -0400100 std::chrono::milliseconds
Patrick Williams35535cf2023-12-05 12:45:02 -0600101 timeout; //!< time to wait between each retry in milliseconds
102 sdbusplus::Timer timer; //!< manages starting timers and handling timeouts
Tom Joseph74f27c72021-05-16 07:58:53 -0700103
104 /** @brief Sends the PLDM request message
105 *
106 * @return return PLDM_SUCCESS on success and PLDM_ERROR otherwise
107 */
108 virtual int send() const = 0;
109
110 /** @brief Callback function invoked when the timeout happens */
111 void callback()
112 {
113 if (numRetries--)
114 {
115 send();
116 }
117 else
118 {
119 stop();
120 }
121 }
122};
123
124/** @class Request
125 *
126 * The concrete implementation of RequestIntf. This class implements the send()
127 * to send the PLDM request message over MCTP socket.
128 * This class encapsulates the PLDM request message, the number of times the
129 * request needs to retried if the response is not received and the amount of
130 * time to wait between each retry. It provides APIs to start and stop the
131 * request flow.
132 */
133class Request final : public RequestRetryTimer
134{
135 public:
136 Request() = delete;
137 Request(const Request&) = delete;
Pavithra Barithayaa7dbca52023-07-07 04:19:37 -0500138 Request(Request&&) = delete;
Tom Joseph74f27c72021-05-16 07:58:53 -0700139 Request& operator=(const Request&) = delete;
Pavithra Barithayaa7dbca52023-07-07 04:19:37 -0500140 Request& operator=(Request&&) = delete;
Tom Joseph74f27c72021-05-16 07:58:53 -0700141 ~Request() = default;
142
143 /** @brief Constructor
144 *
Rashmica Gupta1ed5f7a2023-05-22 13:56:42 +1000145 * @param[in] pldm_transport - PLDM transport object
Tom Joseph74f27c72021-05-16 07:58:53 -0700146 * @param[in] eid - endpoint ID of the remote MCTP endpoint
Manojkiran Eda9fffea22021-10-27 16:03:27 +0530147 * @param[in] currrentSendbuffSize - the current send buffer size
Tom Joseph74f27c72021-05-16 07:58:53 -0700148 * @param[in] event - reference to PLDM daemon's main event loop
149 * @param[in] requestMsg - PLDM request message
150 * @param[in] numRetries - number of request retries
151 * @param[in] timeout - time to wait between each retry in milliseconds
Tom Josephe5268cd2021-09-07 13:04:03 +0530152 * @param[in] verbose - verbose tracing flag
Tom Joseph74f27c72021-05-16 07:58:53 -0700153 */
Rashmica Gupta1ed5f7a2023-05-22 13:56:42 +1000154 explicit Request(PldmTransport* pldmTransport, mctp_eid_t eid,
155 sdeventplus::Event& event, pldm::Request&& requestMsg,
156 uint8_t numRetries, std::chrono::milliseconds timeout,
Manojkiran Eda9fffea22021-10-27 16:03:27 +0530157 bool verbose) :
Tom Joseph74f27c72021-05-16 07:58:53 -0700158 RequestRetryTimer(event, numRetries, timeout),
Rashmica Gupta1ed5f7a2023-05-22 13:56:42 +1000159 pldmTransport(pldmTransport), eid(eid),
160 requestMsg(std::move(requestMsg)), verbose(verbose)
Tom Joseph74f27c72021-05-16 07:58:53 -0700161 {}
162
163 private:
Rashmica Gupta1ed5f7a2023-05-22 13:56:42 +1000164 PldmTransport* pldmTransport; //!< PLDM transport
165 mctp_eid_t eid; //!< endpoint ID of the remote MCTP endpoint
166 pldm::Request requestMsg; //!< PLDM request message
167 bool verbose; //!< verbose tracing flag
Tom Joseph74f27c72021-05-16 07:58:53 -0700168
169 /** @brief Sends the PLDM request message on the socket
170 *
171 * @return return PLDM_SUCCESS on success and PLDM_ERROR otherwise
172 */
173 int send() const
174 {
Tom Josephe5268cd2021-09-07 13:04:03 +0530175 if (verbose)
176 {
177 pldm::utils::printBuffer(pldm::utils::Tx, requestMsg);
178 }
Manojkiran Edaef773052021-07-29 09:29:28 +0530179 pldm::flightrecorder::FlightRecorder::GetInstance().saveRecord(
180 requestMsg, true);
Rashmica Gupta1ed5f7a2023-05-22 13:56:42 +1000181 const struct pldm_msg_hdr* hdr =
182 (struct pldm_msg_hdr*)(requestMsg.data());
183 if (!hdr->request)
184 {
185 return PLDM_REQUESTER_NOT_REQ_MSG;
186 }
187
188 if (pldmTransport == nullptr)
189 {
190 error("Invalid transport: Unable to send PLDM request");
191 return PLDM_ERROR;
192 }
193
194 auto rc = pldmTransport->sendMsg(static_cast<pldm_tid_t>(eid),
195 requestMsg.data(), requestMsg.size());
Tom Joseph74f27c72021-05-16 07:58:53 -0700196 if (rc < 0)
197 {
Riya Dixit087a7512024-04-06 14:28:08 -0500198 error(
199 "Failed to send pldmTransport message, response code '{RC}' and error - {ERROR}",
200 "RC", static_cast<int>(rc), "ERROR", errno);
Tom Joseph74f27c72021-05-16 07:58:53 -0700201 return PLDM_ERROR;
202 }
203 return PLDM_SUCCESS;
204 }
205};
206
207} // namespace requester
208
Sampa Misrac0c79482021-06-02 08:01:54 -0500209} // namespace pldm