blob: fc7e782d237460412827ccc0fb72acf2855d9b8b [file] [log] [blame]
Rashmica Guptac1b66f42022-12-09 16:24:45 +11001#include "libpldm/requester/pldm.h"
Andrew Jeffery9c766792022-08-10 23:12:49 +09302#include "base.h"
Rashmica Guptac1b66f42022-12-09 16:24:45 +11003#include "libpldm/transport.h"
Andrew Jeffery9c766792022-08-10 23:12:49 +09304
Manojkiran Eda9a8e4972022-11-28 16:38:21 +05305#include <bits/types/struct_iovec.h>
Andrew Jeffery4e1ba8a2023-06-29 10:48:33 +09306#include <fcntl.h>
Rashmica Guptac1b66f42022-12-09 16:24:45 +11007#include <stdbool.h>
Andrew Jeffery9c766792022-08-10 23:12:49 +09308#include <stdlib.h>
Manojkiran Eda9a8e4972022-11-28 16:38:21 +05309#include <string.h>
Andrew Jeffery9c766792022-08-10 23:12:49 +093010#include <sys/socket.h>
Andrew Jeffery9c766792022-08-10 23:12:49 +093011#include <sys/un.h>
12#include <unistd.h>
13
Rashmica Guptac1b66f42022-12-09 16:24:45 +110014/* Temporary for old api */
15#include "libpldm/transport/mctp-demux.h"
16extern int
17pldm_transport_mctp_demux_get_socket_fd(struct pldm_transport_mctp_demux *ctx);
18extern struct pldm_transport_mctp_demux *
19pldm_transport_mctp_demux_init_with_fd(int mctp_fd);
20
21/* --- old APIS written in terms of the new API -- */
22/*
23 * pldm_open returns the file descriptor to the MCTP socket, which needs to
24 * persist over api calls (so a consumer can poll it for incoming messages).
25 * So we need a global variable to store the transport struct
26 */
27static struct pldm_transport_mctp_demux *open_transport;
Andrew Jeffery9c766792022-08-10 23:12:49 +093028
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +093029LIBPLDM_ABI_STABLE
Andrew Jeffery319304f2023-04-05 13:53:18 +093030pldm_requester_rc_t pldm_open(void)
Andrew Jeffery9c766792022-08-10 23:12:49 +093031{
Andrew Jeffery4e1ba8a2023-06-29 10:48:33 +093032 int fd = PLDM_REQUESTER_OPEN_FAIL;
Andrew Jeffery9c766792022-08-10 23:12:49 +093033
Rashmica Guptac1b66f42022-12-09 16:24:45 +110034 if (open_transport) {
Rashmica Gupta39f88322023-05-12 15:54:12 +100035 fd = pldm_transport_mctp_demux_get_socket_fd(open_transport);
Andrew Jeffery4e1ba8a2023-06-29 10:48:33 +093036
37 /* If someone has externally issued close() on fd then we need to start again. Use
38 * `fcntl(..., F_GETFD)` to test whether fd is valid. */
39 if (fd < 0 || fcntl(fd, F_GETFD) < 0) {
40 pldm_close();
41 }
Andrew Jeffery9c766792022-08-10 23:12:49 +093042 }
43
Andrew Jeffery4e1ba8a2023-06-29 10:48:33 +093044 /* We retest open_transport as it may have been set to NULL by pldm_close() above. */
45 if (!open_transport) {
46 struct pldm_transport_mctp_demux *demux = NULL;
47
48 if (pldm_transport_mctp_demux_init(&demux) < 0) {
49 return PLDM_REQUESTER_OPEN_FAIL;
50 }
51
52 open_transport = demux;
53
54 fd = pldm_transport_mctp_demux_get_socket_fd(open_transport);
Andrew Jeffery9c766792022-08-10 23:12:49 +093055 }
Rashmica Guptac1b66f42022-12-09 16:24:45 +110056
Andrew Jeffery9c766792022-08-10 23:12:49 +093057 return fd;
58}
59
Rashmica Guptac1b66f42022-12-09 16:24:45 +110060/* This macro does the setup and teardown required for the old API to use the
61 * new API. Since the setup/teardown logic is the same for all four send/recv
62 * functions, it makes sense to only define it once. */
Rashmica Gupta0411b712023-05-30 16:43:08 +100063#define PLDM_REQ_FN(eid, fd, fn, rc, ...) \
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093064 do { \
65 struct pldm_transport_mctp_demux *demux; \
66 bool using_open_transport = false; \
Rashmica Guptad10c6b02023-07-24 13:09:48 +100067 pldm_tid_t tid = eid; \
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093068 struct pldm_transport *ctx; \
Rashmica Guptac1b66f42022-12-09 16:24:45 +110069 /* The fd can be for a socket we opened or one the consumer \
Andrew Jeffery37dd6a32023-05-12 16:04:06 +093070 * opened. */ \
71 if (open_transport && \
72 mctp_fd == pldm_transport_mctp_demux_get_socket_fd( \
73 open_transport)) { \
74 using_open_transport = true; \
75 demux = open_transport; \
76 } else { \
77 demux = pldm_transport_mctp_demux_init_with_fd(fd); \
78 if (!demux) { \
79 rc = PLDM_REQUESTER_OPEN_FAIL; \
80 goto transport_out; \
81 } \
82 } \
83 ctx = pldm_transport_mctp_demux_core(demux); \
84 rc = pldm_transport_mctp_demux_map_tid(demux, tid, eid); \
85 if (rc) { \
86 rc = PLDM_REQUESTER_OPEN_FAIL; \
87 goto transport_out; \
88 } \
89 rc = fn(ctx, tid, __VA_ARGS__); \
90 transport_out: \
91 if (!using_open_transport) { \
92 pldm_transport_mctp_demux_destroy(demux); \
93 } \
Rashmica Gupta0411b712023-05-30 16:43:08 +100094 break; \
Rashmica Guptac1b66f42022-12-09 16:24:45 +110095 } while (0)
Andrew Jeffery9c766792022-08-10 23:12:49 +093096
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +093097LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +093098pldm_requester_rc_t pldm_recv_any(mctp_eid_t eid, int mctp_fd,
99 uint8_t **pldm_resp_msg, size_t *resp_msg_len)
100{
Rashmica Gupta0411b712023-05-30 16:43:08 +1000101 pldm_requester_rc_t rc = 0;
102 PLDM_REQ_FN(eid, mctp_fd, pldm_transport_recv_msg, rc,
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100103 (void **)pldm_resp_msg, resp_msg_len);
Rashmica Gupta0411b712023-05-30 16:43:08 +1000104 struct pldm_msg_hdr *hdr = (struct pldm_msg_hdr *)(*pldm_resp_msg);
105 if (rc != PLDM_REQUESTER_SUCCESS) {
106 return rc;
107 }
108 if (hdr && (hdr->request || hdr->datagram)) {
109 free(*pldm_resp_msg);
110 *pldm_resp_msg = NULL;
111 return PLDM_REQUESTER_NOT_RESP_MSG;
112 }
113 uint8_t pldm_cc = 0;
114 if (*resp_msg_len < (sizeof(struct pldm_msg_hdr) + sizeof(pldm_cc))) {
115 free(*pldm_resp_msg);
116 *pldm_resp_msg = NULL;
117 return PLDM_REQUESTER_RESP_MSG_TOO_SMALL;
118 }
119 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930120}
121
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930122LIBPLDM_ABI_STABLE
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100123pldm_requester_rc_t pldm_recv(mctp_eid_t eid, int mctp_fd,
124 __attribute__((unused)) uint8_t instance_id,
Andrew Jeffery9c766792022-08-10 23:12:49 +0930125 uint8_t **pldm_resp_msg, size_t *resp_msg_len)
126{
127 pldm_requester_rc_t rc =
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930128 pldm_recv_any(eid, mctp_fd, pldm_resp_msg, resp_msg_len);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930129 struct pldm_msg_hdr *hdr = (struct pldm_msg_hdr *)(*pldm_resp_msg);
Rashmica Guptaa3035932023-06-17 12:52:51 +1000130 if (rc == PLDM_REQUESTER_SUCCESS && hdr &&
131 hdr->instance_id != instance_id) {
Andrew Jeffery9c766792022-08-10 23:12:49 +0930132 free(*pldm_resp_msg);
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100133 *pldm_resp_msg = NULL;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930134 return PLDM_REQUESTER_INSTANCE_ID_MISMATCH;
135 }
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100136 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930137}
138
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930139LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930140pldm_requester_rc_t pldm_send_recv(mctp_eid_t eid, int mctp_fd,
141 const uint8_t *pldm_req_msg,
142 size_t req_msg_len, uint8_t **pldm_resp_msg,
143 size_t *resp_msg_len)
144{
Rashmica Gupta0411b712023-05-30 16:43:08 +1000145 pldm_requester_rc_t rc = 0;
146 struct pldm_msg_hdr *hdr = (struct pldm_msg_hdr *)pldm_req_msg;
147 if (hdr && !hdr->request) {
148 return PLDM_REQUESTER_NOT_REQ_MSG;
149 }
150 PLDM_REQ_FN(eid, mctp_fd, pldm_transport_send_recv_msg, rc,
151 pldm_req_msg, req_msg_len, (void **)pldm_resp_msg,
152 resp_msg_len);
153 if (rc != PLDM_REQUESTER_SUCCESS) {
154 return rc;
155 }
Thu Nguyen43a79852023-07-17 16:22:11 +0700156 hdr = (struct pldm_msg_hdr *)(*pldm_resp_msg);
Rashmica Gupta0411b712023-05-30 16:43:08 +1000157 if (hdr && (hdr->request || hdr->datagram)) {
158 free(*pldm_resp_msg);
159 *pldm_resp_msg = NULL;
160 return PLDM_REQUESTER_NOT_RESP_MSG;
161 }
162 return rc;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930163}
164
Andrew Jeffery9d2a1c62023-06-05 13:02:16 +0930165LIBPLDM_ABI_STABLE
Andrew Jeffery9c766792022-08-10 23:12:49 +0930166pldm_requester_rc_t pldm_send(mctp_eid_t eid, int mctp_fd,
167 const uint8_t *pldm_req_msg, size_t req_msg_len)
168{
Rashmica Gupta0411b712023-05-30 16:43:08 +1000169 pldm_requester_rc_t rc = 0;
170 struct pldm_msg_hdr *hdr = (struct pldm_msg_hdr *)pldm_req_msg;
171 if (!hdr->request) {
172 return PLDM_REQUESTER_NOT_REQ_MSG;
173 }
174 PLDM_REQ_FN(eid, mctp_fd, pldm_transport_send_msg, rc,
175 (void *)pldm_req_msg, req_msg_len);
176 return rc;
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100177}
Andrew Jeffery9c766792022-08-10 23:12:49 +0930178
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100179/* Adding this here for completeness in the case we can't smoothly
180 * transition apps over to the new api */
Andrew Jeffery986df2a2023-06-29 11:15:22 +0930181LIBPLDM_ABI_TESTING
Andrew Jeffery37dd6a32023-05-12 16:04:06 +0930182void pldm_close(void)
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100183{
184 if (open_transport) {
185 pldm_transport_mctp_demux_destroy(open_transport);
Andrew Jeffery9c766792022-08-10 23:12:49 +0930186 }
Rashmica Guptac1b66f42022-12-09 16:24:45 +1100187 open_transport = NULL;
Andrew Jeffery9c766792022-08-10 23:12:49 +0930188}