hw/rdma/rdma_backend.h

   1 /*
   2  *  RDMA device: Definitions of Backend Device functions
   3  *
   4  * Copyright (C) 2018 Oracle
   5  * Copyright (C) 2018 Red Hat Inc
   6  *
   7  * Authors:
   8  *     Yuval Shaia <[email protected]>
   9  *     Marcel Apfelbaum <[email protected]>
  10  *
  11  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  12  * See the COPYING file in the top-level directory.
  13  *
  14  */
  15
  16 #ifndef RDMA_BACKEND_H
  17 #define RDMA_BACKEND_H
  18
  19 #include "qapi/error.h"
  20 #include "chardev/char-fe.h"
  21
  22 #include "rdma_rm_defs.h"
  23 #include "rdma_backend_defs.h"
  24
  25 /* Add definition for QP0 and QP1 as there is no userspace enums for them */
  26 enum ibv_special_qp_type {
  27     IBV_QPT_SMI = 0,
  28     IBV_QPT_GSI = 1,
  29 };
  30
  31 static inline union ibv_gid *rdma_backend_gid(RdmaBackendDev *dev)
  32 {
  33     return &dev->gid;
  34 }
  35
  36 static inline uint32_t rdma_backend_qpn(const RdmaBackendQP *qp)
  37 {
  38     return qp->ibqp ? qp->ibqp->qp_num : 1;
  39 }
  40
  41 static inline uint32_t rdma_backend_mr_lkey(const RdmaBackendMR *mr)
  42 {
  43     return mr->ibmr ? mr->ibmr->lkey : 0;
  44 }
  45
  46 static inline uint32_t rdma_backend_mr_rkey(const RdmaBackendMR *mr)
  47 {
  48     return mr->ibmr ? mr->ibmr->rkey : 0;
  49 }
  50
  51 int rdma_backend_init(RdmaBackendDev *backend_dev, PCIDevice *pdev,
  52                       RdmaDeviceResources *rdma_dev_res,
  53                       const char *backend_device_name, uint8_t port_num,
  54                       uint8_t backend_gid_idx, struct ibv_device_attr *dev_attr,
  55                       CharBackend *mad_chr_be, Error **errp);
  56 void rdma_backend_fini(RdmaBackendDev *backend_dev);
  57 void rdma_backend_start(RdmaBackendDev *backend_dev);
  58 void rdma_backend_stop(RdmaBackendDev *backend_dev);
  59 void rdma_backend_register_comp_handler(void (*handler)(int status,
  60                                         unsigned int vendor_err, void *ctx));
  61 void rdma_backend_unregister_comp_handler(void);
  62
  63 int rdma_backend_query_port(RdmaBackendDev *backend_dev,
  64                             struct ibv_port_attr *port_attr);
  65 int rdma_backend_create_pd(RdmaBackendDev *backend_dev, RdmaBackendPD *pd);
  66 void rdma_backend_destroy_pd(RdmaBackendPD *pd);
  67
  68 int rdma_backend_create_mr(RdmaBackendMR *mr, RdmaBackendPD *pd, void *addr,
  69                            size_t length, int access);
  70 void rdma_backend_destroy_mr(RdmaBackendMR *mr);
  71
  72 int rdma_backend_create_cq(RdmaBackendDev *backend_dev, RdmaBackendCQ *cq,
  73                            int cqe);
  74 void rdma_backend_destroy_cq(RdmaBackendCQ *cq);
  75 void rdma_backend_poll_cq(RdmaDeviceResources *rdma_dev_res, RdmaBackendCQ *cq);
  76
  77 int rdma_backend_create_qp(RdmaBackendQP *qp, uint8_t qp_type,
  78                            RdmaBackendPD *pd, RdmaBackendCQ *scq,
  79                            RdmaBackendCQ *rcq, uint32_t max_send_wr,
  80                            uint32_t max_recv_wr, uint32_t max_send_sge,
  81                            uint32_t max_recv_sge);
  82 int rdma_backend_qp_state_init(RdmaBackendDev *backend_dev, RdmaBackendQP *qp,
  83                                uint8_t qp_type, uint32_t qkey);
  84 int rdma_backend_qp_state_rtr(RdmaBackendDev *backend_dev, RdmaBackendQP *qp,
  85                               uint8_t qp_type, union ibv_gid *dgid,
  86                               uint32_t dqpn, uint32_t rq_psn, uint32_t qkey,
  87                               bool use_qkey);
  88 int rdma_backend_qp_state_rts(RdmaBackendQP *qp, uint8_t qp_type,
  89                               uint32_t sq_psn, uint32_t qkey, bool use_qkey);
  90 int rdma_backend_query_qp(RdmaBackendQP *qp, struct ibv_qp_attr *attr,
  91                           int attr_mask, struct ibv_qp_init_attr *init_attr);
  92 void rdma_backend_destroy_qp(RdmaBackendQP *qp);
  93
  94 void rdma_backend_post_send(RdmaBackendDev *backend_dev,
  95                             RdmaBackendQP *qp, uint8_t qp_type,
  96                             struct ibv_sge *sge, uint32_t num_sge,
  97                             union ibv_gid *dgid, uint32_t dqpn, uint32_t dqkey,
  98                             void *ctx);
  99 void rdma_backend_post_recv(RdmaBackendDev *backend_dev,
 100                             RdmaDeviceResources *rdma_dev_res,
 101                             RdmaBackendQP *qp, uint8_t qp_type,
 102                             struct ibv_sge *sge, uint32_t num_sge, void *ctx);
 103
 104 #endif