path: root/platform/linux-dpdk/include/odp_packet_internal.h

/* Copyright (c) 2014-2018, Linaro Limited
 * Copyright (c) 2021-2022, Nokia
 * All rights reserved.
 *
 * SPDX-License-Identifier:     BSD-3-Clause
 */

/**
 * @file
 *
 * ODP packet descriptor - implementation internal
 */

#ifndef ODP_PACKET_INTERNAL_H_
#define ODP_PACKET_INTERNAL_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <odp/api/align.h>
#include <odp/api/debug.h>
#include <odp/api/ipsec.h>
#include <odp/api/packet.h>
#include <odp/api/plat/packet_inline_types.h>
#include <odp/api/packet_io.h>
#include <odp/api/crypto.h>
#include <odp/api/comp.h>
#include <odp/api/std.h>

#include <odp_config_internal.h>
#include <odp_debug_internal.h>
#include <odp_event_internal.h>
#include <odp_pool_internal.h>

#include <protocols/eth.h>
#include <string.h>

#include <rte_config.h>
#if defined(__clang__)
#undef RTE_TOOLCHAIN_GCC
#endif
#include <rte_mbuf.h>
#include <rte_memory.h>
/* ppc64 rte_memcpy.h (included through rte_mbuf.h) may define vector */
#if defined(__PPC64__) && defined(vector)
	#undef vector
#endif

ODP_STATIC_ASSERT(sizeof(_odp_packet_input_flags_t) == sizeof(uint64_t),
		  "INPUT_FLAGS_SIZE_ERROR");

ODP_STATIC_ASSERT(sizeof(_odp_packet_flags_t) == sizeof(uint32_t),
		  "PACKET_FLAGS_SIZE_ERROR");

/* Maximum number of segments per packet */
#define PKT_MAX_SEGS 60

ODP_STATIC_ASSERT(PKT_MAX_SEGS < 256, "Maximum of 255 segments supported");

ODP_STATIC_ASSERT(CONFIG_PACKET_SEG_LEN_MIN >= 256, "Segment size must be a minimum of 256 bytes");

ODP_STATIC_ASSERT(CONFIG_PACKET_MAX_SEG_LEN <= UINT16_MAX, "Segment size must fit in uint16_t");

/* We can't enforce tailroom reservation for received packets */
ODP_STATIC_ASSERT(CONFIG_PACKET_TAILROOM == 0, "Tailroom has to be 0, DPDK doesn't support this");

/**
 * Packet output flags
 */
typedef union {
	/* All output flags */
	uint32_t all;

	struct {
		/** adjustment for traffic mgr */
		uint32_t shaper_len_adj:8;

		/* Bitfield flags for each output option */
		uint32_t l3_chksum_set:1; /**< L3 chksum bit is valid */
		uint32_t l3_chksum:1;     /**< L3 chksum override */
		uint32_t l4_chksum_set:1; /**< L3 chksum bit is valid */
		uint32_t l4_chksum:1;     /**< L4 chksum override  */
	};
} output_flags_t;

ODP_STATIC_ASSERT(sizeof(output_flags_t) == sizeof(uint32_t),
		  "OUTPUT_FLAGS_SIZE_ERROR");

/**
 * Packet parser metadata
 */
typedef struct {
	/* Packet input flags */
	_odp_packet_input_flags_t  input_flags;

	/* Other flags */
	_odp_packet_flags_t        flags;

	 /* offset to L2 hdr, e.g. Eth */
	uint16_t l2_offset;

	/* offset to L3 hdr, e.g. IPv4, IPv6 */
	uint16_t l3_offset;

	/* offset to L4 hdr (TCP, UDP, SCTP, also ICMP) */
	uint16_t l4_offset;
} packet_parser_t;

/**
 * Internal Packet header
 *
 * To optimize fast path performance this struct is not initialized to zero in
 * packet_init(). Because of this any new fields added must be reviewed for
 * initialization requirements.
 */
typedef struct odp_packet_hdr_t {
	/* Common event header */
	_odp_event_hdr_t event_hdr;

	packet_parser_t p;

	odp_pktio_t input;

	/* Timestamp value */
	odp_time_t timestamp;

	/* Used as classifier destination queue, in IPsec inline input
	 * processing and as Tx completion event queue. */
	odp_queue_t dst_queue;

	/* User area pointer */
	void *uarea_addr;

	/* User context pointer */
	const void *user_ptr;

	/* Classifier mark */
	uint16_t cls_mark;

	/* Classifier handle index */
	uint16_t cos;

	/* Offset to payload start */
	uint16_t payload_offset;

	/* Max payload size in a LSO segment */
	uint16_t lso_max_payload;

	/* Packet aging drop timeout before enqueue. Once enqueued holds the maximum age (time of
	 * request + requested drop timeout). */
	uint64_t tx_aging_ns;

	/* LSO profile index */
	uint8_t lso_profile_idx;

	/* Event subtype */
	int8_t subtype;

	union {
		struct {
			/* Result for crypto packet op */
			odp_crypto_packet_result_t crypto_op_result;

			/* Context for IPsec */
			odp_ipsec_packet_result_t ipsec_ctx;
		};

		/* Result for comp packet op */
		odp_comp_packet_result_t comp_op_result;
	};

	/* Temp storage for digest */
#define PACKET_DIGEST_MAX 64
	uint8_t crypto_digest_buf[PACKET_DIGEST_MAX];

	/* Temp storage for AAD */
#define PACKET_AAD_MAX 32
	uint8_t crypto_aad_buf[PACKET_AAD_MAX];
} odp_packet_hdr_t __rte_cache_aligned;

/**
 * Return the packet header
 */
static inline odp_packet_hdr_t *packet_hdr(odp_packet_t pkt)
{
	return (odp_packet_hdr_t *)(uintptr_t)pkt;
}

static inline odp_packet_t packet_handle(odp_packet_hdr_t *pkt_hdr)
{
	return (odp_packet_t)pkt_hdr;
}

static inline _odp_event_hdr_t *packet_to_event_hdr(odp_packet_t pkt)
{
	return (_odp_event_hdr_t *)(uintptr_t)&packet_hdr(pkt)->event_hdr;
}

static inline odp_packet_t packet_from_event_hdr(_odp_event_hdr_t *event_hdr)
{
	return (odp_packet_t)(uintptr_t)event_hdr;
}

static inline struct rte_mbuf *pkt_to_mbuf(odp_packet_t  pkt)
{
	return (struct rte_mbuf *)(uintptr_t)pkt;
}

static inline void packet_subtype_set(odp_packet_t pkt, int ev)
{
	packet_hdr(pkt)->subtype = ev;
}

/**
 * Initialize ODP headers
 */
static inline void packet_init(odp_packet_hdr_t *pkt_hdr, odp_pktio_t input)
{
	/* Clear all flags. Resets also return value of cls_mark, user_ptr, etc. */
	pkt_hdr->p.input_flags.all = 0;
	pkt_hdr->p.flags.all_flags = 0;

	pkt_hdr->p.l2_offset        = 0;
	pkt_hdr->p.l3_offset        = ODP_PACKET_OFFSET_INVALID;
	pkt_hdr->p.l4_offset        = ODP_PACKET_OFFSET_INVALID;

	if (odp_unlikely(pkt_hdr->subtype != ODP_EVENT_PACKET_BASIC))
		pkt_hdr->subtype = ODP_EVENT_PACKET_BASIC;

	pkt_hdr->input = input;
}

/**
 * Check if copying packet metadata between pools is possible
 *
 * @retval  0 when possible without user area copy
 * @retval >0 when possible with user area copy
 * @retval <0 when not possible
 */
static inline int _odp_packet_copy_md_possible(odp_pool_t dst_pool,
					       odp_pool_t src_pool)
{
	const pool_t *src_hdr;
	const pool_t *dst_hdr;

	if (src_pool == dst_pool)
		return 0;

	src_hdr = pool_entry_from_hdl(src_pool);
	dst_hdr = pool_entry_from_hdl(dst_pool);

	if (dst_hdr->params.pkt.uarea_size < src_hdr->params.pkt.uarea_size)
		return -1;

	return 1;
}

/**
 * Copy packet metadata
 *
 * This function is assumed to never fail. Use _odp_packet_copy_md_possible() to
 * check beforehand that copying packet metadata between source and destination
 * packet pools is possible.
 *
 * @param      uarea_copy  Copy user area data. If false, user area pointers
 *                         are swapped between the packet headers (allowed
 *                         only when packets are from the same pool).
 */
static inline void _odp_packet_copy_md(odp_packet_hdr_t *dst_hdr,
				       odp_packet_hdr_t *src_hdr,
				       odp_bool_t uarea_copy)
{
	dst_hdr->input = src_hdr->input;
	dst_hdr->dst_queue = src_hdr->dst_queue;
	dst_hdr->cos = src_hdr->cos;
	dst_hdr->cls_mark = src_hdr->cls_mark;
	dst_hdr->user_ptr = src_hdr->user_ptr;

	dst_hdr->event_hdr.mb.port = src_hdr->event_hdr.mb.port;
	dst_hdr->event_hdr.mb.ol_flags = src_hdr->event_hdr.mb.ol_flags;
	dst_hdr->event_hdr.mb.packet_type = src_hdr->event_hdr.mb.packet_type;
	dst_hdr->event_hdr.mb.vlan_tci = src_hdr->event_hdr.mb.vlan_tci;
	dst_hdr->event_hdr.mb.hash.rss = src_hdr->event_hdr.mb.hash.rss;
	dst_hdr->event_hdr.mb.hash = src_hdr->event_hdr.mb.hash;
	dst_hdr->event_hdr.mb.vlan_tci_outer = src_hdr->event_hdr.mb.vlan_tci_outer;
	dst_hdr->event_hdr.mb.tx_offload = src_hdr->event_hdr.mb.tx_offload;

	if (src_hdr->p.input_flags.timestamp)
		dst_hdr->timestamp = src_hdr->timestamp;

	if (src_hdr->p.flags.lso) {
		dst_hdr->lso_max_payload = src_hdr->lso_max_payload;
		dst_hdr->lso_profile_idx = src_hdr->lso_profile_idx;
	}

	if (src_hdr->p.flags.payload_off)
		dst_hdr->payload_offset = src_hdr->payload_offset;

	dst_hdr->p = src_hdr->p;

	if (src_hdr->uarea_addr) {
		if (uarea_copy) {
			const pool_t *src_pool = src_hdr->event_hdr.pool_ptr;
			const pool_t *dst_pool = dst_hdr->event_hdr.pool_ptr;
			const uint32_t src_uarea_size = src_pool->params.pkt.uarea_size;
			const uint32_t dst_uarea_size = dst_pool->params.pkt.uarea_size;

			ODP_ASSERT(dst_hdr->uarea_addr != NULL);
			ODP_ASSERT(dst_uarea_size >= src_uarea_size);

			memcpy(dst_hdr->uarea_addr, src_hdr->uarea_addr, src_uarea_size);
		} else {
			void *src_uarea = src_hdr->uarea_addr;

			/* If user area exists, packets should always be from the same pool, so
			 * user area pointers can simply be swapped. */
			ODP_ASSERT(dst_hdr->event_hdr.pool_ptr == src_hdr->event_hdr.pool_ptr);

			src_hdr->uarea_addr = dst_hdr->uarea_addr;
			dst_hdr->uarea_addr = src_uarea;
		}
	}
}

static inline void _odp_packet_copy_cls_md(odp_packet_hdr_t *dst_hdr,
					   odp_packet_hdr_t *src_hdr)
{
	dst_hdr->p = src_hdr->p;
	dst_hdr->dst_queue = src_hdr->dst_queue;
	dst_hdr->cos = src_hdr->cos;
	dst_hdr->cls_mark  = src_hdr->cls_mark;
}

static inline uint32_t packet_len(odp_packet_hdr_t *pkt_hdr)
{
	return rte_pktmbuf_pkt_len(&pkt_hdr->event_hdr.mb);
}

static inline void packet_set_len(odp_packet_hdr_t *pkt_hdr, uint32_t len)
{
	rte_pktmbuf_pkt_len(&pkt_hdr->event_hdr.mb) = len;
}

/* Reset parser metadata for a new parse */
static inline void packet_parse_reset(odp_packet_hdr_t *pkt_hdr, int all)
{
	/* Reset parser metadata before new parse */
	pkt_hdr->p.input_flags.all  = 0;
	pkt_hdr->p.l2_offset        = ODP_PACKET_OFFSET_INVALID;
	pkt_hdr->p.l3_offset        = ODP_PACKET_OFFSET_INVALID;
	pkt_hdr->p.l4_offset        = ODP_PACKET_OFFSET_INVALID;

	if (all)
		pkt_hdr->p.flags.all_flags = 0;
	else /* Keep user ptr and pktout flags */
		pkt_hdr->p.flags.all.error = 0;
}

static inline int packet_hdr_has_l2(odp_packet_hdr_t *pkt_hdr)
{
	return pkt_hdr->p.input_flags.l2;
}

static inline void packet_hdr_has_l2_set(odp_packet_hdr_t *pkt_hdr, int val)
{
	pkt_hdr->p.input_flags.l2 = val;
}

static inline int packet_hdr_has_eth(odp_packet_hdr_t *pkt_hdr)
{
	return pkt_hdr->p.input_flags.eth;
}

static inline int packet_hdr_has_ipv6(odp_packet_hdr_t *pkt_hdr)
{
	return pkt_hdr->p.input_flags.ipv6;
}

static inline void packet_set_ts(odp_packet_hdr_t *pkt_hdr, odp_time_t *ts)
{
	if (ts != NULL) {
		pkt_hdr->timestamp = *ts;
		pkt_hdr->p.input_flags.timestamp = 1;
	}
}

int _odp_packet_set_data(odp_packet_t pkt, uint32_t offset,
			 uint8_t c, uint32_t len);

int _odp_packet_cmp_data(odp_packet_t pkt, uint32_t offset,
			 const void *s, uint32_t len);

int _odp_packet_ipv4_chksum_insert(odp_packet_t pkt);
int _odp_packet_tcp_chksum_insert(odp_packet_t pkt);
int _odp_packet_udp_chksum_insert(odp_packet_t pkt);
int _odp_packet_sctp_chksum_insert(odp_packet_t pkt);

int _odp_packet_l4_chksum(odp_packet_hdr_t *pkt_hdr,
			  odp_proto_chksums_t chksums, uint64_t l4_part_sum);

#ifdef __cplusplus
}
#endif

#endif