api/spec/packet.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2021-2026 Nokia
 */
 
#ifndef ODP_API_SPEC_PACKET_H_
#define ODP_API_SPEC_PACKET_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/event_types.h>
#include <odp/api/packet_types.h>
#include <odp/api/packet_io_types.h>
#include <odp/api/pool_types.h>
#include <odp/api/proto_stats_types.h>
#include <odp/api/std_types.h>
#include <odp/api/time_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
odp_event_subtype_t odp_packet_subtype(odp_packet_t packet);
 
/*
 *
 * Alloc and free
 * ********************************************************
 *
 */
 
odp_packet_t odp_packet_alloc(odp_pool_t pool, uint32_t len);
 
int odp_packet_alloc_multi(odp_pool_t pool, uint32_t len,
               odp_packet_t pkt[], int num);
 
void odp_packet_free(odp_packet_t pkt);
 
void odp_packet_free_multi(const odp_packet_t pkt[], int num);
 
void odp_packet_free_sp(const odp_packet_t pkt[], int num);
 
int odp_packet_reset(odp_packet_t pkt, uint32_t len);
 
uint32_t odp_packet_reset_max_len(odp_packet_t pkt);
 
void odp_packet_reset_meta(odp_packet_t pkt);
 
odp_packet_t odp_packet_from_event(odp_event_t ev);
 
void odp_packet_from_event_multi(odp_packet_t pkt[], const odp_event_t ev[],
                 int num);
 
odp_event_t odp_packet_to_event(odp_packet_t pkt);
 
void odp_packet_to_event_multi(const odp_packet_t pkt[], odp_event_t ev[],
                   int num);
 
int odp_packet_reass_info(odp_packet_t pkt, odp_packet_reass_info_t *info);
 
int odp_packet_reass_partial_state(odp_packet_t pkt, odp_packet_t frags[],
                   odp_packet_reass_partial_state_t *res);
 
/*
 *
 * Pointers and lengths
 * ********************************************************
 *
 */
 
void *odp_packet_head(odp_packet_t pkt);
 
uint32_t odp_packet_buf_len(odp_packet_t pkt);
 
void *odp_packet_data(odp_packet_t pkt);
 
uint32_t odp_packet_seg_len(odp_packet_t pkt);
 
void *odp_packet_data_seg_len(odp_packet_t pkt, uint32_t *seg_len);
 
uint32_t odp_packet_len(odp_packet_t pkt);
 
uint32_t odp_packet_headroom(odp_packet_t pkt);
 
uint32_t odp_packet_tailroom(odp_packet_t pkt);
 
void *odp_packet_tail(odp_packet_t pkt);
 
void *odp_packet_offset(odp_packet_t pkt, uint32_t offset, uint32_t *len,
            odp_packet_seg_t *seg);
 
void odp_packet_prefetch(odp_packet_t pkt, uint32_t offset, uint32_t len);
 
void *odp_packet_push_head(odp_packet_t pkt, uint32_t len);
 
void *odp_packet_pull_head(odp_packet_t pkt, uint32_t len);
 
void *odp_packet_push_tail(odp_packet_t pkt, uint32_t len);
 
void *odp_packet_pull_tail(odp_packet_t pkt, uint32_t len);
 
int odp_packet_extend_head(odp_packet_t *pkt, uint32_t len, void **data_ptr,
               uint32_t *seg_len);
 
int odp_packet_trunc_head(odp_packet_t *pkt, uint32_t len, void **data_ptr,
              uint32_t *seg_len);
 
int odp_packet_extend_tail(odp_packet_t *pkt, uint32_t len, void **data_ptr,
               uint32_t *seg_len);
 
int odp_packet_trunc_tail(odp_packet_t *pkt, uint32_t len, void **tail_ptr,
              uint32_t *tailroom);
 
int odp_packet_add_data(odp_packet_t *pkt, uint32_t offset, uint32_t len);
 
int odp_packet_rem_data(odp_packet_t *pkt, uint32_t offset, uint32_t len);
 
int odp_packet_align(odp_packet_t *pkt, uint32_t offset, uint32_t len,
             uint32_t align);
 
/*
 *
 * Segmentation
 * ********************************************************
 *
 */
 
int odp_packet_is_segmented(odp_packet_t pkt);
 
int odp_packet_num_segs(odp_packet_t pkt);
 
odp_packet_seg_t odp_packet_first_seg(odp_packet_t pkt);
 
odp_packet_seg_t odp_packet_last_seg(odp_packet_t pkt);
 
odp_packet_seg_t odp_packet_next_seg(odp_packet_t pkt, odp_packet_seg_t seg);
 
void *odp_packet_seg_data(odp_packet_t pkt, odp_packet_seg_t seg);
 
uint32_t odp_packet_seg_data_len(odp_packet_t pkt, odp_packet_seg_t seg);
 
int odp_packet_concat(odp_packet_t *dst, odp_packet_t src);
 
int odp_packet_split(odp_packet_t *pkt, uint32_t len, odp_packet_t *tail);
 
void *odp_packet_buf_head(odp_packet_buf_t pkt_buf);
 
uint32_t odp_packet_buf_size(odp_packet_buf_t pkt_buf);
 
uint32_t odp_packet_buf_data_offset(odp_packet_buf_t pkt_buf);
 
uint32_t odp_packet_buf_data_len(odp_packet_buf_t pkt_buf);
 
void odp_packet_buf_data_set(odp_packet_buf_t pkt_buf, uint32_t data_offset, uint32_t data_len);
 
odp_packet_buf_t odp_packet_buf_from_head(odp_pool_t pool, void *head);
 
uint32_t odp_packet_disassemble(odp_packet_t pkt, odp_packet_buf_t pkt_buf[], uint32_t num);
 
odp_packet_t odp_packet_reassemble(odp_pool_t pool, odp_packet_buf_t pkt_buf[], uint32_t num);
 
/*
 *
 * References
 * ********************************************************
 *
 */
 
odp_packet_t odp_packet_ref_static(odp_packet_t pkt);
 
odp_packet_t odp_packet_ref(odp_packet_t pkt, uint32_t offset);
 
odp_packet_t odp_packet_ref_pkt(odp_packet_t pkt, uint32_t offset,
                odp_packet_t hdr);
 
int odp_packet_has_ref(odp_packet_t pkt);
 
int odp_packet_is_referencing(odp_packet_t pkt);
 
/*
 *
 * Copy
 * ********************************************************
 *
 */
 
odp_packet_t odp_packet_copy(odp_packet_t pkt, odp_pool_t pool);
 
odp_packet_t odp_packet_copy_part(odp_packet_t pkt, uint32_t offset,
                  uint32_t len, odp_pool_t pool);
 
int odp_packet_copy_to_mem(odp_packet_t pkt, uint32_t offset,
               uint32_t len, void *dst);
 
int odp_packet_copy_from_mem(odp_packet_t pkt, uint32_t offset,
                 uint32_t len, const void *src);
 
int odp_packet_copy_from_pkt(odp_packet_t dst, uint32_t dst_offset,
                 odp_packet_t src, uint32_t src_offset,
                 uint32_t len);
 
int odp_packet_copy_data(odp_packet_t pkt, uint32_t dst_offset,
             uint32_t src_offset, uint32_t len);
 
int odp_packet_move_data(odp_packet_t pkt, uint32_t dst_offset,
             uint32_t src_offset, uint32_t len);
 
/*
 *
 * Meta-data
 * ********************************************************
 *
 */
 
int odp_packet_parse(odp_packet_t pkt, uint32_t offset,
             const odp_packet_parse_param_t *param);
 
int odp_packet_parse_multi(const odp_packet_t pkt[], const uint32_t offset[],
               int num, const odp_packet_parse_param_t *param);
 
void odp_packet_parse_result(odp_packet_t pkt,
                 odp_packet_parse_result_t *result);
 
void odp_packet_parse_result_multi(const odp_packet_t pkt[],
                   odp_packet_parse_result_t *result[],
                   int num);
 
odp_pool_t odp_packet_pool(odp_packet_t pkt);
 
odp_pktio_t odp_packet_input(odp_packet_t pkt);
 
void odp_packet_input_set(odp_packet_t pkt, odp_pktio_t pktio);
 
int odp_packet_input_index(odp_packet_t pkt);
 
void *odp_packet_user_ptr(odp_packet_t pkt);
 
void odp_packet_user_ptr_set(odp_packet_t pkt, const void *user_ptr);
 
void *odp_packet_user_area(odp_packet_t pkt);
 
uint32_t odp_packet_user_area_size(odp_packet_t pkt);
 
int odp_packet_user_flag(odp_packet_t pkt);
 
void odp_packet_user_flag_set(odp_packet_t pkt, int val);
 
void *odp_packet_l2_ptr(odp_packet_t pkt, uint32_t *len);
 
uint32_t odp_packet_l2_offset(odp_packet_t pkt);
 
int odp_packet_l2_offset_set(odp_packet_t pkt, uint32_t offset);
 
void *odp_packet_l3_ptr(odp_packet_t pkt, uint32_t *len);
 
uint32_t odp_packet_l3_offset(odp_packet_t pkt);
 
int odp_packet_l3_offset_set(odp_packet_t pkt, uint32_t offset);
 
void *odp_packet_l4_ptr(odp_packet_t pkt, uint32_t *len);
 
uint32_t odp_packet_l4_offset(odp_packet_t pkt);
 
int odp_packet_l4_offset_set(odp_packet_t pkt, uint32_t offset);
 
odp_proto_l2_type_t odp_packet_l2_type(odp_packet_t pkt);
 
odp_proto_l3_type_t odp_packet_l3_type(odp_packet_t pkt);
 
odp_proto_l4_type_t odp_packet_l4_type(odp_packet_t pkt);
 
odp_packet_chksum_status_t odp_packet_l3_chksum_status(odp_packet_t pkt);
 
odp_packet_chksum_status_t odp_packet_l4_chksum_status(odp_packet_t pkt);
 
void odp_packet_l3_chksum_insert(odp_packet_t pkt, int insert);
 
void odp_packet_l4_chksum_insert(odp_packet_t pkt, int insert);
 
uint16_t odp_packet_ones_comp(odp_packet_t pkt, odp_packet_data_range_t *range);
 
uint32_t odp_packet_flow_hash(odp_packet_t pkt);
 
void odp_packet_flow_hash_set(odp_packet_t pkt, uint32_t flow_hash);
 
odp_time_t odp_packet_ts(odp_packet_t pkt);
 
void odp_packet_ts_set(odp_packet_t pkt, odp_time_t timestamp);
 
void odp_packet_ts_request(odp_packet_t pkt, int enable);
 
odp_packet_color_t odp_packet_color(odp_packet_t pkt);
 
void odp_packet_color_set(odp_packet_t pkt, odp_packet_color_t color);
 
odp_bool_t odp_packet_drop_eligible(odp_packet_t pkt);
 
void odp_packet_drop_eligible_set(odp_packet_t pkt, odp_bool_t status);
 
int8_t odp_packet_shaper_len_adjust(odp_packet_t pkt);
 
void odp_packet_shaper_len_adjust_set(odp_packet_t pkt, int8_t adj);
 
uint64_t odp_packet_cls_mark(odp_packet_t pkt);
 
int odp_packet_lso_request(odp_packet_t pkt, const odp_packet_lso_opt_t *lso_opt);
 
void odp_packet_lso_request_clr(odp_packet_t pkt);
 
int odp_packet_has_lso_request(odp_packet_t pkt);
 
uint32_t odp_packet_payload_offset(odp_packet_t pkt);
 
int odp_packet_payload_offset_set(odp_packet_t pkt, uint32_t offset);
 
void odp_packet_aging_tmo_set(odp_packet_t pkt, uint64_t tmo_ns);
 
uint64_t odp_packet_aging_tmo(odp_packet_t pkt);
 
int odp_packet_tx_compl_request(odp_packet_t pkt, const odp_packet_tx_compl_opt_t *opt);
 
int odp_packet_has_tx_compl_request(odp_packet_t pkt);
 
void odp_packet_free_ctrl_set(odp_packet_t pkt, odp_packet_free_ctrl_t ctrl);
 
odp_packet_free_ctrl_t odp_packet_free_ctrl(odp_packet_t pkt);
 
void odp_packet_proto_stats_request(odp_packet_t pkt, odp_packet_proto_stats_opt_t *opt);
 
odp_proto_stats_t odp_packet_proto_stats(odp_packet_t pkt);
 
/*
 *
 * Packet vector handling routines
 * ********************************************************
 *
 */
 
odp_packet_vector_t odp_packet_vector_from_event(odp_event_t ev);
 
odp_event_t odp_packet_vector_to_event(odp_packet_vector_t pktv);
 
odp_packet_vector_t odp_packet_vector_alloc(odp_pool_t pool);
 
void odp_packet_vector_free(odp_packet_vector_t pktv);
 
uint32_t odp_packet_vector_tbl(odp_packet_vector_t pktv, odp_packet_t **pkt_tbl);
 
uint32_t odp_packet_vector_size(odp_packet_vector_t pktv);
 
void odp_packet_vector_size_set(odp_packet_vector_t pktv, uint32_t size);
 
void *odp_packet_vector_user_area(odp_packet_vector_t pktv);
 
int odp_packet_vector_user_flag(odp_packet_vector_t pktv);
 
void odp_packet_vector_user_flag_set(odp_packet_vector_t pktv, int val);
 
int odp_packet_vector_valid(odp_packet_vector_t pktv);
 
odp_pool_t odp_packet_vector_pool(odp_packet_vector_t pktv);
 
void odp_packet_vector_print(odp_packet_vector_t pktv);
 
uint64_t odp_packet_vector_to_u64(odp_packet_vector_t pktv);
 
odp_packet_reass_status_t odp_packet_reass_status(odp_packet_t pkt);
 
/*
 *
 * Packet Tx completion event handling routines
 * ********************************************************
 */
 
odp_packet_tx_compl_t odp_packet_tx_compl_from_event(odp_event_t ev);
 
odp_event_t odp_packet_tx_compl_to_event(odp_packet_tx_compl_t tx_compl);
 
void odp_packet_tx_compl_free(odp_packet_tx_compl_t tx_compl);
 
void *odp_packet_tx_compl_user_ptr(odp_packet_tx_compl_t tx_compl);
 
int odp_packet_tx_compl_done(odp_pktio_t pktio, uint32_t compl_id);
 
/*
 *
 * Debugging
 * ********************************************************
 *
 */
 
void odp_packet_print(odp_packet_t pkt);
 
void odp_packet_print_data(odp_packet_t pkt, uint32_t offset, uint32_t len);
 
int odp_packet_is_valid(odp_packet_t pkt);
 
uint64_t odp_packet_to_u64(odp_packet_t pkt);
 
uint64_t odp_packet_seg_to_u64(odp_packet_seg_t seg);
 
uint64_t odp_packet_tx_compl_to_u64(odp_packet_tx_compl_t tx_compl);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif