doca_urom_plugin.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023-2024 NVIDIA CORPORATION & AFFILIATES, ALL RIGHTS RESERVED.
 *
 * This software product is a proprietary product of NVIDIA CORPORATION &
 * AFFILIATES (the "Company") and all right, title, and interest in and to the
 * software product, including all associated intellectual property rights, are
 * and shall remain exclusively with the Company.
 *
 * This software product is governed by the End User License Agreement
 * provided with the software product.
 *
 */
 
#ifndef DOCA_UROM_PLUGIN_H_
#define DOCA_UROM_PLUGIN_H_
 
#include <limits.h>
 
#include <ucs/datastruct/list.h>
 
#include <doca_error.h>
#include <doca_compat.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DOCA_UROM_PLUGIN_NAME_MAX_LEN 48 
struct urom_worker_ctx;
 
struct doca_urom_service_plugin_info {
    uint64_t id;                     
    uint64_t version;                
    char plugin_name[DOCA_UROM_PLUGIN_NAME_MAX_LEN]; 
};
 
struct urom_worker_cmd {
    uint64_t type;         
    uint64_t urom_context; 
    uint64_t len;          
    uint8_t plugin_cmd[];  
};
 
/* Suppress clang compilation warning on flexible-array-extensions plugin_cmd[]
 * is a flexible-array-extensions at it is at the end  of the struct urom_worker_cmd.
 * It declared last in every struct that instantiate it so this warning is just
 * too strict here.
 */
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wflexible-array-extensions"
#endif
 
struct urom_worker_cmd_desc {
    ucs_list_link_t entry;         
    uint64_t dest_id;          
    struct urom_worker_cmd worker_cmd; 
};
 
struct urom_worker_notify {
    uint64_t type;      
    uint64_t urom_context;  
    uint64_t len;       
    doca_error_t status;    
    uint32_t reserved;  
    uint8_t plugin_notif[]; 
};
 
struct urom_worker_notif_desc {
    ucs_list_link_t entry;          
    uint64_t dest_id;           
    struct urom_worker_notify worker_notif; 
};
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
struct urom_plugin_iface {
    DOCA_STRUCT_START;
 
    doca_error_t (*open)(struct urom_worker_ctx *ctx);
 
    void (*close)(struct urom_worker_ctx *ctx);
 
    doca_error_t (*addr)(struct urom_worker_ctx *ctx, void *addr, size_t *addr_len);
 
    doca_error_t (*worker_cmd)(struct urom_worker_ctx *ctx, ucs_list_link_t *cmd_list);
 
    doca_error_t (*progress)(struct urom_worker_ctx *ctx, ucs_list_link_t *notif_list);
 
    doca_error_t (*notif_pack)(struct urom_worker_notify *notif, size_t *packed_notif_len, void *packed_notif);
};
 
struct urom_domain_lookups_iface {
    doca_error_t (*addr_lookup)(struct urom_worker_ctx *ctx, uint64_t domain_id, void **addr);
 
    doca_error_t (*seg_lookup)(struct urom_worker_ctx *ctx, uint64_t domain_id, uint64_t va, int *seg);
 
    doca_error_t (*memh_lookup)(struct urom_worker_ctx *ctx, uint64_t domain_id, int seg, size_t *len, void **memh);
 
    doca_error_t (*mkey_lookup)(struct urom_worker_ctx *ctx, uint64_t domain_id, int seg, size_t *len, void **rkey);
};
 
struct urom_worker_ctx {
    struct urom_plugin_iface iface;            
    struct urom_domain_lookups_iface domain_iface; 
    void *plugin_ctx;                  
};
 
static inline doca_error_t doca_urom_worker_domain_addr_lookup(struct urom_worker_ctx *ctx,
                                   uint64_t domain_id,
                                   void **addr)
{
    return ctx->domain_iface.addr_lookup(ctx, domain_id, addr);
}
 
static inline doca_error_t doca_urom_worker_domain_seg_lookup(struct urom_worker_ctx *ctx,
                                  uint64_t domain_id,
                                  uint64_t va,
                                  int *seg)
{
    return ctx->domain_iface.seg_lookup(ctx, domain_id, va, seg);
}
 
static inline doca_error_t doca_urom_worker_domain_memh_lookup(struct urom_worker_ctx *ctx,
                                   uint64_t domain_id,
                                   int seg,
                                   size_t *len,
                                   void **memh)
{
    return ctx->domain_iface.memh_lookup(ctx, domain_id, seg, len, memh);
}
 
static inline doca_error_t doca_urom_worker_domain_mkey_lookup(struct urom_worker_ctx *ctx,
                                   uint64_t domain_id,
                                   int seg,
                                   size_t *len,
                                   void **rkey)
{
    return ctx->domain_iface.mkey_lookup(ctx, domain_id, seg, len, rkey);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* DOCA_UROM_PLUGIN_H_ */