rte_security_driver.h(3)

📦 version 26.03, in nixos 26.05, nixpkgs unstable

🎀 rte_security_driver.h 🎀

ok so bestie, this is the rte_security_driver.h page from the DPDK library-functions manual — it's the security driver header, and honestly it's giving "backstage pass to the crypto/eth device ops table" energy. no cap, every single typedef here is a function pointer a PMD is supposed to fill in. let's get into it 💖

✨ SYNOPSIS ✨

#include <rte_compat.h>
#include 'rte_security.h'

🫶 Data Structures

  • struct rte_security_ctx
  • struct rte_security_ops

🌸 Macros

#define SECURITY_GET_SESS_PRIV(s)

🦋 Typedefs

typedef int(*security_session_create_t) (void *device, struct
    rte_security_session_conf *conf, struct rte_security_session *sess)
typedef int(*security_session_destroy_t) (void *device, struct
    rte_security_session *sess)
typedef int(*security_session_update_t) (void *device, struct
    rte_security_session *sess, struct rte_security_session_conf *conf)
typedef int(*security_macsec_sc_create_t) (void *device, struct
    rte_security_macsec_sc *conf)
typedef int(*security_macsec_sc_destroy_t) (void *device, uint16_t
    sc_id, enum rte_security_macsec_direction dir)
typedef int(*security_macsec_sa_create_t) (void *device, struct
    rte_security_macsec_sa *conf)
typedef int(*security_macsec_sa_destroy_t) (void *device, uint16_t
    sa_id, enum rte_security_macsec_direction dir)
typedef unsigned int(*security_session_get_size) (void *device)
typedef int(*security_session_stats_get_t) (void *device, struct
    rte_security_session *sess, struct rte_security_stats *stats)
typedef int(*security_macsec_sc_stats_get_t) (void *device, uint16_t
    sc_id, enum rte_security_macsec_direction dir, struct
    rte_security_macsec_sc_stats *stats)
typedef int(*security_macsec_sa_stats_get_t) (void *device, uint16_t
    sa_id, enum rte_security_macsec_direction dir, struct
    rte_security_macsec_sa_stats *stats)
typedef int(*security_set_pkt_metadata_t) (void *device, struct
    rte_security_session *sess, struct rte_mbuf *mb, void *params)
typedef const struct rte_security_capability *(*
    security_capabilities_get_t) (void *device)
typedef int(*security_rx_inject_configure) (void *device, uint16_t
    port_id, bool enable)
typedef uint16_t(*security_inb_pkt_rx_inject) (void *device, struct
    rte_mbuf **pkts, struct rte_security_session **sess, uint16_t
    nb_pkts)

💅 Detailed Description 💅

RTE Security Common Definitions — literally the whole point of this file. 🫶

Definition in file rte_security_driver.h.

🍓 Macro Definition Documentation 🍓

#define SECURITY_GET_SESS_PRIV( s)

Value:

((void *)(((struct rte_security_session *)s)->driver_priv_data))

Helper macro to get driver private data. that's it, that's the whole macro — it reaches into your session and yoinks out driver_priv_data as a void *. iconic behaviour tbh ✨

Definition at line 66 of file rte_security_driver.h.

⭐ Typedef Documentation ⭐

security_session_create_t

typedef int(* security_session_create_t) (void *device, struct
    rte_security_session_conf *conf, struct rte_security_session *sess)

Configure a security session on a device. this is the moment your driver actually sets up the session, bestie 💖

Parameters

  • device — Crypto/eth device pointer
  • conf — Security session configuration
  • sess — Pointer to Security private session structure

Returns

  • Returns 0 if private session structure have been created successfully.
  • Returns -EINVAL if input parameters are invalid.
  • Returns -ENOTSUP if crypto device does not support the crypto transform.
Definition at line 83 of file rte_security_driver.h.

security_session_destroy_t

typedef int(* security_session_destroy_t) (void *device, struct
    rte_security_session *sess)

Free driver private session data. bye bestie, clean up after yourself 🧹

Parameters

  • device — Crypto/eth device pointer
  • sess — Security session structure
Definition at line 93 of file rte_security_driver.h.

security_session_update_t

typedef int(* security_session_update_t) (void *device, struct
    rte_security_session *sess, struct rte_security_session_conf *conf)

Update driver private session data. glow-up for your session params 💫

Parameters

  • device — Crypto/eth device pointer
  • sess — Pointer to Security private session structure
  • conf — Security session configuration

Returns

  • Returns 0 if private session structure have been updated successfully.
  • Returns -EINVAL if input parameters are invalid.
  • Returns -ENOTSUP if crypto device does not support the crypto transform.
Definition at line 108 of file rte_security_driver.h.

security_macsec_sc_create_t

typedef int(* security_macsec_sc_create_t) (void *device, struct
    rte_security_macsec_sc *conf)

Configure a MACsec secure channel (SC) on a device. MACsec era, we're so here for it 🔥

Parameters

  • device — Crypto/eth device pointer
  • conf — MACsec SC configuration params

Returns

  • positive sc_id if SC is created successfully.
  • -EINVAL if input parameters are invalid.
  • -ENOTSUP if device does not support MACsec.
  • -ENOMEM if the SC cannot be created.
Definition at line 124 of file rte_security_driver.h.

security_macsec_sc_destroy_t

typedef int(* security_macsec_sc_destroy_t) (void *device, uint16_t
    sc_id, enum rte_security_macsec_direction dir)

Free MACsec secure channel (SC). yeet that SC 🗑️

Parameters

  • device — Crypto/eth device pointer
  • sc_id — MACsec SC ID
  • dir — Direction of SC
Definition at line 133 of file rte_security_driver.h.

security_macsec_sa_create_t

typedef int(* security_macsec_sa_create_t) (void *device, struct
    rte_security_macsec_sa *conf)

Configure a MACsec security Association (SA) on a device. SA creation, main character energy 👑

Parameters

  • device — Crypto/eth device pointer
  • conf — MACsec SA configuration params

Returns

  • positive sa_id if SA is created successfully.
  • -EINVAL if input parameters are invalid.
  • -ENOTSUP if device does not support MACsec.
  • -ENOMEM if the SA cannot be created.
Definition at line 148 of file rte_security_driver.h.

security_macsec_sa_destroy_t

typedef int(* security_macsec_sa_destroy_t) (void *device, uint16_t
    sa_id, enum rte_security_macsec_direction dir)

Free MACsec security association (SA). say bye 👋

Parameters

  • device — Crypto/eth device pointer
  • sa_id — MACsec SA ID
  • dir — Direction of SA
Definition at line 157 of file rte_security_driver.h.

security_session_get_size

typedef unsigned int(* security_session_get_size) (void *device)

Get the size of a security session. how much room does this thing need, asking for a friend 📏

Parameters

  • device — Crypto/eth device pointer

Returns

  • On success returns the size of the session structure for device
  • On failure returns 0
Definition at line 169 of file rte_security_driver.h.

security_session_stats_get_t

typedef int(* security_session_stats_get_t) (void *device, struct
    rte_security_session *sess, struct rte_security_stats *stats)

Get stats from the PMD. numbers! we love numbers 📊

Parameters

  • device — Crypto/eth device pointer
  • sess — Pointer to Security private session structure
  • stats — Security stats of the driver

Returns

  • Returns 0 if private session structure have been updated successfully.
  • Returns -EINVAL if session parameters are invalid.
Definition at line 182 of file rte_security_driver.h.

security_macsec_sc_stats_get_t

typedef int(* security_macsec_sc_stats_get_t) (void *device, uint16_t
    sc_id, enum rte_security_macsec_direction dir, struct
    rte_security_macsec_sc_stats *stats)

Get MACsec secure channel stats from the PMD. SC-flavoured stats, slay 💅

Parameters

  • device — Crypto/eth device pointer
  • sc_id — secure channel ID created by rte_security_macsec_sc_create()
  • dir — direction of SC
  • stats — SC stats of the driver

Returns

  • 0 if success.
  • -EINVAL if sc_id or device is invalid.
Definition at line 198 of file rte_security_driver.h.

security_macsec_sa_stats_get_t

typedef int(* security_macsec_sa_stats_get_t) (void *device, uint16_t
    sa_id, enum rte_security_macsec_direction dir, struct
    rte_security_macsec_sa_stats *stats)

Get MACsec SA stats from the PMD. same vibe, SA edition 🌈

Parameters

  • device — Crypto/eth device pointer
  • sa_id — secure channel ID created by rte_security_macsec_sc_create()
  • dir — direction of SA
  • stats — SC stats of the driver

Returns

  • 0 if success.
  • -EINVAL if sa_id or device is invalid.
Definition at line 214 of file rte_security_driver.h.

security_set_pkt_metadata_t

typedef int(* security_set_pkt_metadata_t) (void *device, struct
    rte_security_session *sess, struct rte_mbuf *mb, void *params)

Update the mbuf with provided metadata. little sticker on the packet, iykyk 🏷️

Parameters

  • device — Crypto/eth device pointer
  • sess — Security session structure
  • mb — Packet buffer
  • params — Metadata

Returns

  • Returns 0 if metadata updated successfully.
  • Returns -ve value for errors.
Definition at line 243 of file rte_security_driver.h.

security_capabilities_get_t

typedef const struct rte_security_capability *(*
    security_capabilities_get_t) (void *device)

Get security capabilities of the device. what can this thing even do? vibe check 🦋

Parameters

  • device — crypto/eth device pointer

Returns

  • Returns rte_security_capability pointer on success.
  • Returns NULL on error.
Definition at line 243 of file rte_security_driver.h.

security_rx_inject_configure

typedef int(* security_rx_inject_configure) (void *device, uint16_t
    port_id, bool enable)

Configure security device to inject packets to an ethdev port. wiring two devices together, matchmaker behaviour 💘

Parameters

  • device — Crypto/eth device pointer
  • port_id — Port identifier of the ethernet device to which packets need to be injected.
  • enable — Flag to enable and disable connection between a security device and an ethdev port.

Returns

  • 0 if successful.
  • -EINVAL if context NULL or port_id is invalid.
  • -EBUSY if devices are not in stopped state.
  • -ENOTSUP if security device does not support injecting to the ethdev port.
Definition at line 273 of file rte_security_driver.h.

security_inb_pkt_rx_inject

typedef uint16_t(* security_inb_pkt_rx_inject) (void *device, struct
    rte_mbuf **pkts, struct rte_security_session **sess, uint16_t
    nb_pkts)

Perform security processing of packets and inject the processed packet to ethdev Rx.

Rx inject would behave similarly to ethdev loopback but with the additional security processing. so like loopback, but make it secure ✨

Parameters

  • device — Crypto/eth device pointer
  • pkts — The address of an array of nb_pkts pointers to rte_mbuf structures which contain the packets.
  • sess — The address of an array of nb_pkts pointers to rte_security_session structures corresponding to each packet.
  • nb_pkts — The maximum number of packets to process.

Returns

The number of packets successfully injected to ethdev Rx. The return value can be less than the value of the nb_pkts parameter when the PMD internal queues have been filled up.

Definition at line 295 of file rte_security_driver.h.

🌸 Author 🌸

Generated automatically by Doxygen for DPDK from the source code. (yes bestie, a robot wrote the original — we stan a machine-generated queen 🤖💖)

ok that's the whole page fr fr — no options skipped, no typedefs ghosted, every line number and every -EINVAL intact 🫶 this was rte_security_driver.h(3) from the DPDK manual, Version 26.03.0, and it's dated with that same version, so… go forth and configure your security sessions, periodt 💅🎀🦋

📦 where this page comes from