dpa_common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022-2024 NVIDIA CORPORATION AND AFFILIATES.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of
 *       conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *     * Neither the name of the NVIDIA CORPORATION nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written
 *       permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TOR (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
 
#ifndef DPA_COMMON_H_
#define DPA_COMMON_H_
 
#include <stdlib.h>
#include <unistd.h>
 
#include <doca_dev.h>
#include <doca_dpa.h>
#include <doca_error.h>
#include <doca_log.h>
#include <doca_types.h>
#include <doca_argp.h>
#include <doca_sync_event.h>
#include <doca_mmap.h>
#include <doca_rdma.h>
#include <doca_ctx.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SLEEP(SECONDS) for (int i = 0; i < 1 + SECONDS * 30000; i++)
 
#define DEVICE_DEFAULT_NAME "NOT_SET"
 
#define SYNC_EVENT_MASK_FFS (0xFFFFFFFFFFFFFFFF)
 
#define RDMA_DEVICE_DEFAULT_GID_INDEX (1)
 
#define RDMA_DEFAULT_BUF_LIST_LEN (1)
 
#define DPA_RESOURCES_PATH_MAX_SIZE 1024
 
#define DPA_APP_KEY_MAX_SIZE 1024
 
struct dpa_resources {
    struct doca_dev *pf_doca_device;   
    struct doca_dpa *pf_dpa_ctx;       
    struct doca_dev *rdma_doca_device; 
    struct doca_dpa *rdma_dpa_ctx; 
    doca_dpa_dev_t rdma_dpa_ctx_handle;   
    struct doca_dpa_eu_affinity **affinities; 
    uint32_t num_affinities;          
};
 
struct dpa_config {
    char pf_device_name[DOCA_DEVINFO_IBDEV_NAME_SIZE];    
    char rdma_device_name[DOCA_DEVINFO_IBDEV_NAME_SIZE];  
    char dpa_resources_file[DPA_RESOURCES_PATH_MAX_SIZE]; 
    char dpa_app_key[DPA_APP_KEY_MAX_SIZE];           
};
 
struct dpa_thread_obj {
    struct doca_dpa *doca_dpa;         
    doca_dpa_func_t *func;             
    uint64_t arg;                  
    doca_dpa_dev_uintptr_t tls_dev_ptr;    
    struct doca_dpa_thread *thread;        
    struct doca_dpa_eu_affinity *affinity; 
};
 
struct dpa_completion_obj {
    struct doca_dpa *doca_dpa;        
    unsigned int queue_size;          
    struct doca_dpa_thread *thread;       
    struct doca_dpa_completion *dpa_comp; 
    doca_dpa_dev_completion_t handle;     
};
 
struct dpa_notification_completion_obj {
    struct doca_dpa *doca_dpa;                  
    struct doca_dpa_thread *thread;                 
    struct doca_dpa_notification_completion *notification_comp; 
    doca_dpa_dev_notification_completion_t handle; 
};
 
struct dpa_rdma_obj {
    struct doca_dev *doca_device;         
    struct doca_dpa *doca_dpa;        
    uint32_t permissions;             
    uint32_t buf_list_len;            
    uint32_t recv_queue_size;         
    uint32_t max_connections_count;       
    uint32_t gid_index;           
    struct doca_dpa_completion *dpa_comp;     
    struct doca_rdma *rdma;           
    struct doca_ctx *rdma_as_ctx;         
    doca_dpa_dev_rdma_t dpa_rdma;         
    const void *connection_details;       
    size_t conn_det_len;              
    struct doca_rdma_connection *connection;  
    uint32_t connection_id;           
    bool second_connection_needed;        
    const void *connection2_details;      
    size_t conn2_det_len;             
    struct doca_rdma_connection *connection2; 
    uint32_t connection2_id;          
};
 
enum mmap_type {
    MMAP_TYPE_CPU,
    MMAP_TYPE_DPA,
};
 
struct doca_mmap_obj {
    enum mmap_type mmap_type;        
    struct doca_dev *doca_device;        
    struct doca_dpa *doca_dpa;       
    uint32_t permissions;            
    void *memrange_addr;             
    size_t memrange_len;             
    struct doca_mmap *mmap;          
    doca_dpa_dev_mmap_t dpa_mmap_handle; 
    const void *rdma_export;         
    size_t export_len;           
};
 
doca_error_t register_dpa_params(void);
 
doca_error_t create_doca_dpa_wait_sync_event(struct doca_dpa *doca_dpa,
                         struct doca_dev *doca_device,
                         struct doca_sync_event **wait_event);
 
doca_error_t create_doca_dpa_completion_sync_event(struct doca_dpa *doca_dpa,
                           struct doca_dev *doca_device,
                           struct doca_sync_event **comp_event,
                           doca_dpa_dev_sync_event_t *handle);
 
doca_error_t create_doca_dpa_kernel_sync_event(struct doca_dpa *doca_dpa, struct doca_sync_event **kernel_event);
 
doca_error_t create_doca_remote_net_sync_event(struct doca_dev *doca_device, struct doca_sync_event **remote_net_event);
 
doca_error_t export_doca_remote_net_sync_event_to_dpa(struct doca_dev *doca_device,
                              struct doca_dpa *doca_dpa,
                              struct doca_sync_event *remote_net_event,
                              struct doca_sync_event_remote_net **remote_net_exported_event,
                              doca_dpa_dev_sync_event_remote_net_t *remote_net_event_dpa_handle);
 
doca_error_t allocate_dpa_resources(struct dpa_config *cfg, struct dpa_resources *resources);
 
doca_error_t destroy_dpa_resources(struct dpa_resources *resources);
 
doca_error_t dpa_thread_obj_init(struct dpa_thread_obj *dpa_thread_obj);
 
doca_error_t dpa_thread_obj_destroy(struct dpa_thread_obj *dpa_thread_obj);
 
doca_error_t dpa_completion_obj_init(struct dpa_completion_obj *dpa_completion_obj);
 
doca_error_t dpa_completion_obj_destroy(struct dpa_completion_obj *dpa_completion_obj);
 
doca_error_t dpa_notification_completion_obj_init(struct dpa_notification_completion_obj *notification_completion_obj);
 
doca_error_t dpa_notification_completion_obj_destroy(
    struct dpa_notification_completion_obj *notification_completion_obj);
 
doca_error_t dpa_rdma_obj_init(struct dpa_rdma_obj *dpa_rdma_obj);
 
doca_error_t dpa_rdma_obj_start(struct dpa_rdma_obj *dpa_rdma_obj);
 
doca_error_t dpa_rdma_obj_destroy(struct dpa_rdma_obj *dpa_rdma_obj);
 
doca_error_t doca_mmap_obj_init(struct doca_mmap_obj *doca_mmap_obj);
 
doca_error_t doca_mmap_obj_destroy(struct doca_mmap_obj *doca_mmap_obj);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DPA_COMMON_H_ */