rte_pdcp_entity_conf(3)

πŸ’– rte_pdcp_entity_conf β€” a whole vibe πŸ’–

okay bestie, welcome to the rte_pdcp_entity_conf(3) page from the DPDK library functions manual 🫢 this one's a struct, and yes it's giving main character energy because it's literally the blueprint you hand over when you want a PDCP entity to exist.


✨ NAME ✨

rte_pdcp_entity_conf β€” the configuration struct ✨


🌸 SYNOPSIS 🌸

#include <rte_pdcp.h>

πŸŽ€ Data Fields πŸŽ€

struct rte_security_pdcp_xform pdcp_xfrm
struct rte_crypto_sym_xform * crypto_xfrm
struct rte_mempool * sess_mpool
struct rte_mempool * cop_pool
struct rte_mempool * ctrl_pdu_pool
uint32_t sn
bool is_slrb
bool en_sec_offload
uint8_t dev_id
bool reverse_iv_direction
bool status_report_required
bool out_of_order_delivery
struct rte_pdcp_t_reordering t_reordering

πŸ¦‹ Detailed Description πŸ¦‹

so basically πŸ’… this struct is the PDCP entity configuration, and you use it for establishing an entity. like, that's its whole purpose. no notes.

it lives at Definition at line 118 of file rte_pdcp.h. 🫢


πŸ‘‘ Field Documentation πŸ‘‘

πŸ’œ struct rte_security_pdcp_xform pdcp_xfrm

the PDCP transform for the entity, bestie β€” it's the security transform, and yes it's important.

Definition at line 120 of file rte_pdcp.h.

🌈 struct rte_crypto_sym_xform* crypto_xfrm

the crypto transform that applies to this entity ✨

Definition at line 122 of file rte_pdcp.h.

πŸ“ struct rte_mempool* sess_mpool

mempool for the crypto symmetric session. yep, that's the pool you're pulling session memory from.

Definition at line 124 of file rte_pdcp.h.

🧚 struct rte_mempool* cop_pool

crypto op pool πŸ’… the pool where crypto ops hang out.

Definition at line 126 of file rte_pdcp.h.

πŸŽ€ struct rte_mempool* ctrl_pdu_pool

the mbuf pool you use for allocating control PDUs. that's the one. no cap.

Definition at line 128 of file rte_pdcp.h.

⭐ uint32_t sn

the sequence number value to be used 🌟 and here's the tea: the 32 bit count value that's used for the first packet gets derived based on HFN (rte_security_pdcp_xform.hfn) and SN. so the two of them are working together, periodt.

Definition at line 134 of file rte_pdcp.h.

πŸ¦‹ bool is_slrb

indicates whether the PDCP entity belongs to a Side Link Radio Bearer πŸ’« it's a yes or no kind of situation.

Definition at line 136 of file rte_pdcp.h.

πŸ’€ bool en_sec_offload

enable security offload on the device you specified. let the device do the security work πŸ”₯

Definition at line 138 of file rte_pdcp.h.

🌸 bool en_sec_offload… wait no, uint8_t dev_id 🌸

okay not me almost duplicating a field, embarrassing πŸ™ˆ this one is uint8_t dev_id β€” the device on which the security/crypto session needs to be created. that's the whole thing.

Definition at line 140 of file rte_pdcp.h.

πŸ’œ bool reverse_iv_direction

reverse the direction during IV generation ✨ and lowkey the fun part: this can be used to simulate UE crypto processing. cute, right?

Definition at line 145 of file rte_pdcp.h.

🌟 bool status_report_required

status report required β€” and yes, it's specified in TS 38.331 πŸ“Ž

here's the longer version because it actually matters: if the PDCP entity is configured to send a PDCP status report, the upper layer application may request a receiving PDCP entity to generate a PDCP status report using rte_pdcp_control_pdu_create. and in addition, PDCP status reports may be generated during operations such as entity re-establishment. so it's not just the one path, iykyk.

Definition at line 155 of file rte_pdcp.h.

🧚 bool out_of_order_delivery

enable out of order delivery 🫢 let those packets arrive however they want.

Definition at line 157 of file rte_pdcp.h.

πŸŽ€ struct rte_pdcp_t_reordering t_reordering

the t-Reordering timer configuration ⏳ that's it, that's the field.

Definition at line 159 of file rte_pdcp.h.


πŸ’… Author πŸ’…

generated automatically by Doxygen for DPDK from the source code. iconic behaviour honestly, letting the robot write the docs πŸ‘‘


ok and that's the whole page bestie!! every single field, every single line reference, nothing skipped πŸ’– go forth and configure ur entities responsibly πŸ¦‹βœ¨

this was rte_pdcp_entity_conf(3) from DPDK Version 25.11.3 β€” mwah, slay, bye πŸŽ€πŸ‘‘

πŸ“¦ where this page comes from