rte_buffer.h

Go to the documentation of this file.

#ifndef RTE_COMMON_BUFFER_H
#define RTE_COMMON_BUFFER_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct rte_buffer_s
{
    void   *data;      
    size_t  capacity;  
    size_t  length;    
} rte_buffer_t;

typedef struct rte_const_buffer_s
{
    const void *data;    
    size_t      length;  
} rte_const_buffer_t;

rte_status_t rte_buffer_init(rte_buffer_t *buf, void *storage, size_t capacity);

rte_status_t rte_buffer_clear(rte_buffer_t *buf);

rte_status_t rte_buffer_set_length(rte_buffer_t *buf, size_t length);

rte_status_t rte_buffer_copy_in(rte_buffer_t *buf, const void *src, size_t src_len);

rte_status_t rte_buffer_copy_out(const rte_buffer_t *buf,
                                    void *dest,
                                    size_t dest_capacity,
                                    size_t *out_copied);

rte_status_t rte_buffer_as_const(const rte_buffer_t *buf, rte_const_buffer_t *out_view);

bool rte_buffer_is_valid(const rte_buffer_t *buf);
 
/*
 * Endianness-safe multi-byte access (ADR-006 section 2.5). Byte order is
 * always explicit at the call site (_le / _be suffix) - there is no
 * default/"network order" variant. write_* functions append at buf's
 * current length and advance it, like rte_buffer_copy_in(); read_*
 * functions take an explicit offset and do not mutate the buffer, like
 * rte_buffer_copy_out().
 */

rte_status_t rte_buffer_write_u16_le(rte_buffer_t *buf, uint16_t value);
rte_status_t rte_buffer_write_u16_be(rte_buffer_t *buf, uint16_t value);
rte_status_t rte_buffer_write_u32_le(rte_buffer_t *buf, uint32_t value);
rte_status_t rte_buffer_write_u32_be(rte_buffer_t *buf, uint32_t value);
rte_status_t rte_buffer_write_u64_le(rte_buffer_t *buf, uint64_t value);
rte_status_t rte_buffer_write_u64_be(rte_buffer_t *buf, uint64_t value);

rte_status_t rte_buffer_read_u16_le(const rte_buffer_t *buf, size_t offset, uint16_t *out_value);
rte_status_t rte_buffer_read_u16_be(const rte_buffer_t *buf, size_t offset, uint16_t *out_value);
rte_status_t rte_buffer_read_u32_le(const rte_buffer_t *buf, size_t offset, uint32_t *out_value);
rte_status_t rte_buffer_read_u32_be(const rte_buffer_t *buf, size_t offset, uint32_t *out_value);
rte_status_t rte_buffer_read_u64_le(const rte_buffer_t *buf, size_t offset, uint64_t *out_value);
rte_status_t rte_buffer_read_u64_be(const rte_buffer_t *buf, size_t offset, uint64_t *out_value);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_COMMON_BUFFER_H */
 /* BUFFER */