xlio_types.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: NVIDIA CORPORATION & AFFILIATES
 * Copyright (c) 2024-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause
 */
 
#ifndef XLIO_TYPES_H
#define XLIO_TYPES_H
 
#include <stddef.h>
#include <stdint.h>
#include <netinet/in.h>
#include <sys/socket.h>
#include <sys/time.h>
 
/*
 * Options for setsockopt()/getsockopt()
 */
#define SO_XLIO_GET_API          2800
#define SO_XLIO_RING_ALLOC_LOGIC 2810
#define SO_XLIO_SHUTDOWN_RX      2821
/*
 * Insert an 802.1Q VLAN tag to the following TX packets. Doesn't affect RX packets handling.
 * The option value is an integer of type `int` which represents the VLAN ID field of the VLAN tag.
 * The value must be non-negative number less than 4096. Value 0 disables the feature.
 * The option allows to set VLAN ID to the reserved values 1 and 0xFFF without restrictions.
 *
 * Limitations:
 *  - TCP sockets only
 *  - Incoming connections are not supported
 *  - Must be configured on a non-connected socket before calling connect() and affects the first
 *    SYN segment
 */
#define SO_XLIO_EXT_VLAN_TAG 2824
 
struct xlio_rate_limit_t {
    uint32_t rate; /* rate limit in Kbps */
    uint32_t max_burst_sz; /* maximum burst size in bytes */
    uint16_t typical_pkt_sz; /* typical packet size in bytes */
};
 
typedef enum {
    RING_LOGIC_PER_INTERFACE = 0,
    RING_LOGIC_PER_IP = 1,
    RING_LOGIC_PER_SOCKET = 10,
    RING_LOGIC_PER_USER_ID = 11,
    RING_LOGIC_PER_THREAD = 20,
    RING_LOGIC_PER_CORE = 30,
    RING_LOGIC_PER_CORE_ATTACH_THREADS = 31,
    RING_LOGIC_PER_OBJECT = 32,
    RING_LOGIC_LAST
} ring_logic_t;
 
typedef enum {
    XLIO_RING_ALLOC_MASK_RING_USER_ID = (1 << 0),
    XLIO_RING_ALLOC_MASK_RING_INGRESS = (1 << 1),
    XLIO_RING_ALLOC_MASK_RING_ENGRESS = (1 << 2),
} xlio_ring_alloc_logic_attr_comp_mask;
 
/*
 * @brief pass this struct to process by the library using setsockopt with
 * @ref SO_XLIO_RING_ALLOC_LOGIC
 *  to set the allocation logic of this FD when he requests a ring.
 *  @note ring_alloc_logic is a mandatory
 * @param comp_mask - what fields are read when processing this struct
 *  see @ref xlio_ring_alloc_logic_attr_comp_mask
 * @param ring_alloc_logic- allocation ratio to use
 * @param user_idx - when used RING_LOGIC_PER_USER_ID int @ref ring_alloc_logic
 *  this is the user id to define. This lets you define the same ring for
 *  few FD's regardless the interface\thread\core.
 * @param ingress - RX ring
 * @param engress - TX ring
 */
struct xlio_ring_alloc_logic_attr {
    uint32_t comp_mask;
    ring_logic_t ring_alloc_logic;
    uint32_t user_id;
    uint32_t ingress : 1;
    uint32_t engress : 1;
    uint32_t reserved : 30;
};
 
typedef uintptr_t xlio_poll_group_t;
 
typedef uintptr_t xlio_socket_t;
 
struct xlio_buf {
    uint64_t userdata;
};
 
 
typedef void (*xlio_memory_cb_t)(void *addr, size_t len, size_t hugepage_size);
 
enum {
    XLIO_SOCKET_EVENT_ESTABLISHED = 1,
    XLIO_SOCKET_EVENT_TERMINATED,
    XLIO_SOCKET_EVENT_CLOSED,
    XLIO_SOCKET_EVENT_ERROR,
};
 
typedef void (*xlio_socket_event_cb_t)(xlio_socket_t sock, uintptr_t userdata_sq, int event,
                                       int value);
 
typedef void (*xlio_socket_comp_cb_t)(xlio_socket_t sock, uintptr_t userdata_sq,
                                      uintptr_t userdata_op);
 
typedef void (*xlio_socket_rx_cb_t)(xlio_socket_t sock, uintptr_t userdata_sq, void *data,
                                    size_t len, struct xlio_buf *buf);
 
typedef void (*xlio_socket_accept_cb_t)(xlio_socket_t sock, xlio_socket_t parent,
                                        uintptr_t parent_userdata_sq);
 
 
struct xlio_init_attr {
    unsigned flags;
    xlio_memory_cb_t memory_cb;
 
    /* Optional external user allocator for XLIO buffers. */
    void *(*memory_alloc)(size_t);
    void (*memory_free)(void *);
};
 
 
#define XLIO_GROUP_FLAG_SAFE 0x1
#define XLIO_GROUP_FLAG_DIRTY 0x2
 
struct xlio_poll_group_attr {
    unsigned flags;
 
    xlio_socket_event_cb_t socket_event_cb;
    xlio_socket_comp_cb_t socket_comp_cb;
    xlio_socket_rx_cb_t socket_rx_cb;
    xlio_socket_accept_cb_t socket_accept_cb;
};
 
 
struct xlio_socket_attr {
    unsigned flags;
    int domain; /* AF_INET or AF_INET6 */
    xlio_poll_group_t group;
    uintptr_t userdata_sq;
};
 
 
#define XLIO_SOCKET_SEND_FLAG_FLUSH 0x1
#define XLIO_SOCKET_SEND_FLAG_INLINE 0x2
 
struct xlio_socket_send_attr {
    unsigned flags;
    uint32_t mkey;
    uintptr_t userdata_op;
};
 
 
 
#endif /* XLIO_TYPES_H */