IPSEC operation result for a packet. More...

#include <ipsec_types.h>

Collaboration diagram for odp_ipsec_packet_result_t:

Data Fields
odp_ipsec_op_status_t	status
	IPSEC operation status. More...

odp_ipsec_op_flag_t	flag
	IPSEC operation flags.

odp_ipsec_sa_t	sa
	IPSEC SA that was used to create the packet. More...

struct {
uint8_t * ptr
	Points to the first byte of retained outer headers. More...

uint32_t len
	Outer header length in bytes.

}	outer_hdr
	Packet outer header status before inbound inline processing. More...

uint32_t	orig_ip_len
	Total IP length of the original ESP or AH packet before IPsec decapsulation. More...

Detailed Description

IPSEC operation result for a packet.

Examples: ipsec_api/odp_ipsec.c, odp_ipsec.c, and odp_ipsecfwd.c.

Definition at line 1388 of file api/spec/ipsec_types.h.

Field Documentation

◆ status

odp_ipsec_op_status_t odp_ipsec_packet_result_t::status

IPSEC operation status.

Use this to check if IPSEC operation reported any errors or warnings (e.g. status.all != ODP_IPSEC_OK).

Examples: ipsec_api/odp_ipsec.c, odp_ipsec.c, and odp_ipsecfwd.c.

Definition at line 1392 of file api/spec/ipsec_types.h.

◆ sa

odp_ipsec_sa_t odp_ipsec_packet_result_t::sa

IPSEC SA that was used to create the packet.

Operation updates this SA handle value, when SA look up is performed as part of the operation and the look up is successful. Operation status code indicates if the look up failed. Otherwise, the SA provided by the application is copied here.

Definition at line 1404 of file api/spec/ipsec_types.h.

◆ ptr

uint8_t* odp_ipsec_packet_result_t::ptr

Points to the first byte of retained outer headers.

These headers are stored in a contiquous, per packet, implementation specific memory space. Since the memory space may overlap with e.g. packet head/tailroom, the content becomes invalid if packet data storage is modified in any way. The memory space may not be shareable to other threads.

Definition at line 1418 of file api/spec/ipsec_types.h.

◆

struct { ... } odp_ipsec_packet_result_t::outer_hdr

Packet outer header status before inbound inline processing.

This is valid only when outer headers are retained (see odp_ipsec_inbound_config_t) and flag.inline_mode is set.

◆ orig_ip_len

uint32_t odp_ipsec_packet_result_t::orig_ip_len

Total IP length of the original ESP or AH packet before IPsec decapsulation.

This is valid only for inbound inline and async processed packets. Zero value means that the length information is not available.

If the result packet was reassembled from multiple IPsec protected packets, this is the sum of the lengths of all the involved IPsec packets.

Definition at line 1433 of file api/spec/ipsec_types.h.

The documentation for this struct was generated from the following file:

api/spec/ipsec_types.h