1 /* SPDX-License-Identifier: BSD-3-Clause
3 * Copyright(c) 2017 Intel Corporation.
4 * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
7 #include <rte_cryptodev.h>
9 #include <rte_telemetry.h>
10 #include "rte_security.h"
11 #include "rte_security_driver.h"
13 /* Macro to check for invalid pointers */
14 #define RTE_PTR_OR_ERR_RET(ptr, retval) do { \
19 /* Macro to check for invalid pointers chains */
20 #define RTE_PTR_CHAIN3_OR_ERR_RET(p1, p2, p3, retval, last_retval) do { \
21 RTE_PTR_OR_ERR_RET(p1, retval); \
22 RTE_PTR_OR_ERR_RET(p1->p2, retval); \
23 RTE_PTR_OR_ERR_RET(p1->p2->p3, last_retval); \
26 #define RTE_SECURITY_DYNFIELD_NAME "rte_security_dynfield_metadata"
27 int rte_security_dynfield_offset = -1;
30 rte_security_dynfield_register(void)
32 static const struct rte_mbuf_dynfield dynfield_desc = {
33 .name = RTE_SECURITY_DYNFIELD_NAME,
34 .size = sizeof(rte_security_dynfield_t),
35 .align = __alignof__(rte_security_dynfield_t),
37 rte_security_dynfield_offset =
38 rte_mbuf_dynfield_register(&dynfield_desc);
39 return rte_security_dynfield_offset;
42 struct rte_security_session *
43 rte_security_session_create(struct rte_security_ctx *instance,
44 struct rte_security_session_conf *conf,
45 struct rte_mempool *mp,
46 struct rte_mempool *priv_mp)
48 struct rte_security_session *sess = NULL;
50 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_create, NULL, NULL);
51 RTE_PTR_OR_ERR_RET(conf, NULL);
52 RTE_PTR_OR_ERR_RET(mp, NULL);
53 RTE_PTR_OR_ERR_RET(priv_mp, NULL);
55 if (rte_mempool_get(mp, (void **)&sess))
58 if (instance->ops->session_create(instance->device, conf,
60 rte_mempool_put(mp, (void *)sess);
69 rte_security_session_update(struct rte_security_ctx *instance,
70 struct rte_security_session *sess,
71 struct rte_security_session_conf *conf)
73 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_update, -EINVAL,
75 RTE_PTR_OR_ERR_RET(sess, -EINVAL);
76 RTE_PTR_OR_ERR_RET(conf, -EINVAL);
78 return instance->ops->session_update(instance->device, sess, conf);
82 rte_security_session_get_size(struct rte_security_ctx *instance)
84 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_get_size, 0, 0);
86 return instance->ops->session_get_size(instance->device);
90 rte_security_session_stats_get(struct rte_security_ctx *instance,
91 struct rte_security_session *sess,
92 struct rte_security_stats *stats)
94 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_stats_get, -EINVAL,
96 /* Parameter sess can be NULL in case of getting global statistics. */
97 RTE_PTR_OR_ERR_RET(stats, -EINVAL);
99 return instance->ops->session_stats_get(instance->device, sess, stats);
103 rte_security_session_destroy(struct rte_security_ctx *instance,
104 struct rte_security_session *sess)
108 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, session_destroy, -EINVAL,
110 RTE_PTR_OR_ERR_RET(sess, -EINVAL);
112 ret = instance->ops->session_destroy(instance->device, sess);
116 rte_mempool_put(rte_mempool_from_obj(sess), (void *)sess);
118 if (instance->sess_cnt)
119 instance->sess_cnt--;
125 __rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
126 struct rte_security_session *sess,
127 struct rte_mbuf *m, void *params)
130 RTE_PTR_OR_ERR_RET(sess, -EINVAL);
131 RTE_PTR_OR_ERR_RET(instance, -EINVAL);
132 RTE_PTR_OR_ERR_RET(instance->ops, -EINVAL);
134 RTE_FUNC_PTR_OR_ERR_RET(*instance->ops->set_pkt_metadata, -ENOTSUP);
135 return instance->ops->set_pkt_metadata(instance->device,
140 __rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md)
142 void *userdata = NULL;
145 RTE_PTR_OR_ERR_RET(instance, NULL);
146 RTE_PTR_OR_ERR_RET(instance->ops, NULL);
148 RTE_FUNC_PTR_OR_ERR_RET(*instance->ops->get_userdata, NULL);
149 if (instance->ops->get_userdata(instance->device, md, &userdata))
155 const struct rte_security_capability *
156 rte_security_capabilities_get(struct rte_security_ctx *instance)
158 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, capabilities_get, NULL, NULL);
160 return instance->ops->capabilities_get(instance->device);
163 const struct rte_security_capability *
164 rte_security_capability_get(struct rte_security_ctx *instance,
165 struct rte_security_capability_idx *idx)
167 const struct rte_security_capability *capabilities;
168 const struct rte_security_capability *capability;
171 RTE_PTR_CHAIN3_OR_ERR_RET(instance, ops, capabilities_get, NULL, NULL);
172 RTE_PTR_OR_ERR_RET(idx, NULL);
174 capabilities = instance->ops->capabilities_get(instance->device);
176 if (capabilities == NULL)
179 while ((capability = &capabilities[i++])->action
180 != RTE_SECURITY_ACTION_TYPE_NONE) {
181 if (capability->action == idx->action &&
182 capability->protocol == idx->protocol) {
183 if (idx->protocol == RTE_SECURITY_PROTOCOL_IPSEC) {
184 if (capability->ipsec.proto ==
186 capability->ipsec.mode ==
188 capability->ipsec.direction ==
189 idx->ipsec.direction)
191 } else if (idx->protocol == RTE_SECURITY_PROTOCOL_PDCP) {
192 if (capability->pdcp.domain ==
195 } else if (idx->protocol ==
196 RTE_SECURITY_PROTOCOL_DOCSIS) {
197 if (capability->docsis.direction ==
198 idx->docsis.direction)
208 security_handle_cryptodev_list(const char *cmd __rte_unused,
209 const char *params __rte_unused,
210 struct rte_tel_data *d)
214 if (rte_cryptodev_count() < 1)
217 rte_tel_data_start_array(d, RTE_TEL_INT_VAL);
218 for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++)
219 if (rte_cryptodev_is_valid_dev(dev_id) &&
220 rte_cryptodev_get_sec_ctx(dev_id))
221 rte_tel_data_add_array_int(d, dev_id);
226 #define CRYPTO_CAPS_SZ \
227 (RTE_ALIGN_CEIL(sizeof(struct rte_cryptodev_capabilities), \
228 sizeof(uint64_t)) / sizeof(uint64_t))
231 crypto_caps_array(struct rte_tel_data *d,
232 const struct rte_cryptodev_capabilities *capabilities)
234 const struct rte_cryptodev_capabilities *dev_caps;
235 uint64_t caps_val[CRYPTO_CAPS_SZ];
236 unsigned int i = 0, j;
238 rte_tel_data_start_array(d, RTE_TEL_U64_VAL);
240 while ((dev_caps = &capabilities[i++])->op !=
241 RTE_CRYPTO_OP_TYPE_UNDEFINED) {
242 memset(&caps_val, 0, CRYPTO_CAPS_SZ * sizeof(caps_val[0]));
243 rte_memcpy(caps_val, dev_caps, sizeof(capabilities[0]));
244 for (j = 0; j < CRYPTO_CAPS_SZ; j++)
245 rte_tel_data_add_array_u64(d, caps_val[j]);
251 #define SEC_CAPS_SZ \
252 (RTE_ALIGN_CEIL(sizeof(struct rte_security_capability), \
253 sizeof(uint64_t)) / sizeof(uint64_t))
256 sec_caps_array(struct rte_tel_data *d,
257 const struct rte_security_capability *capabilities)
259 const struct rte_security_capability *dev_caps;
260 uint64_t caps_val[SEC_CAPS_SZ];
261 unsigned int i = 0, j;
263 rte_tel_data_start_array(d, RTE_TEL_U64_VAL);
265 while ((dev_caps = &capabilities[i++])->action !=
266 RTE_SECURITY_ACTION_TYPE_NONE) {
267 memset(&caps_val, 0, SEC_CAPS_SZ * sizeof(caps_val[0]));
268 rte_memcpy(caps_val, dev_caps, sizeof(capabilities[0]));
269 for (j = 0; j < SEC_CAPS_SZ; j++)
270 rte_tel_data_add_array_u64(d, caps_val[j]);
276 static const struct rte_security_capability *
277 security_capability_by_index(const struct rte_security_capability *capabilities,
280 const struct rte_security_capability *dev_caps = NULL;
283 while ((dev_caps = &capabilities[i])->action !=
284 RTE_SECURITY_ACTION_TYPE_NONE) {
295 security_capabilities_from_dev_id(int dev_id, const void **caps)
297 const struct rte_security_capability *capabilities;
298 struct rte_security_ctx *sec_ctx;
300 if (rte_cryptodev_is_valid_dev(dev_id) == 0)
303 sec_ctx = (struct rte_security_ctx *)rte_cryptodev_get_sec_ctx(dev_id);
304 RTE_PTR_OR_ERR_RET(sec_ctx, -EINVAL);
306 capabilities = rte_security_capabilities_get(sec_ctx);
307 RTE_PTR_OR_ERR_RET(capabilities, -EINVAL);
309 *caps = capabilities;
314 security_handle_cryptodev_sec_caps(const char *cmd __rte_unused, const char *params,
315 struct rte_tel_data *d)
317 const struct rte_security_capability *capabilities;
318 struct rte_tel_data *sec_caps;
324 if (!params || strlen(params) == 0 || !isdigit(*params))
327 dev_id = strtoul(params, &end_param, 0);
328 if (*end_param != '\0')
329 CDEV_LOG_ERR("Extra parameters passed to command, ignoring");
331 rc = security_capabilities_from_dev_id(dev_id, (void *)&capabilities);
335 sec_caps = rte_tel_data_alloc();
336 RTE_PTR_OR_ERR_RET(sec_caps, -ENOMEM);
338 rte_tel_data_start_dict(d);
339 sec_caps_n = sec_caps_array(sec_caps, capabilities);
340 rte_tel_data_add_dict_container(d, "sec_caps", sec_caps, 0);
341 rte_tel_data_add_dict_int(d, "sec_caps_n", sec_caps_n);
347 security_handle_cryptodev_crypto_caps(const char *cmd __rte_unused, const char *params,
348 struct rte_tel_data *d)
350 const struct rte_security_capability *capabilities;
351 struct rte_tel_data *crypto_caps;
352 const char *capa_param;
358 if (!params || strlen(params) == 0 || !isdigit(*params))
361 dev_id = strtoul(params, &end_param, 0);
362 capa_param = strtok(end_param, ",");
363 if (!capa_param || strlen(capa_param) == 0 || !isdigit(*capa_param))
366 capa_id = strtoul(capa_param, &end_param, 0);
367 if (*end_param != '\0')
368 CDEV_LOG_ERR("Extra parameters passed to command, ignoring");
370 rc = security_capabilities_from_dev_id(dev_id, (void *)&capabilities);
374 capabilities = security_capability_by_index(capabilities, capa_id);
375 RTE_PTR_OR_ERR_RET(capabilities, -EINVAL);
377 crypto_caps = rte_tel_data_alloc();
378 RTE_PTR_OR_ERR_RET(crypto_caps, -ENOMEM);
380 rte_tel_data_start_dict(d);
381 crypto_caps_n = crypto_caps_array(crypto_caps, capabilities->crypto_capabilities);
383 rte_tel_data_add_dict_container(d, "crypto_caps", crypto_caps, 0);
384 rte_tel_data_add_dict_int(d, "crypto_caps_n", crypto_caps_n);
389 RTE_INIT(security_init_telemetry)
391 rte_telemetry_register_cmd("/security/cryptodev/list",
392 security_handle_cryptodev_list,
393 "Returns list of available crypto devices by IDs. No parameters.");
395 rte_telemetry_register_cmd("/security/cryptodev/sec_caps",
396 security_handle_cryptodev_sec_caps,
397 "Returns security capabilities for a cryptodev. Parameters: int dev_id");
399 rte_telemetry_register_cmd("/security/cryptodev/crypto_caps",
400 security_handle_cryptodev_crypto_caps,
401 "Returns crypto capabilities for a security capability. Parameters: int dev_id, sec_cap_id");