include/rdma/restrack.h

   1 /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
   2 /*
   3  * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
   4  */
   5
   6 #ifndef _RDMA_RESTRACK_H_
   7 #define _RDMA_RESTRACK_H_
   8
   9 #include <linux/typecheck.h>
  10 #include <linux/rwsem.h>
  11 #include <linux/sched.h>
  12 #include <linux/kref.h>
  13 #include <linux/completion.h>
  14 #include <linux/sched/task.h>
  15 #include <uapi/rdma/rdma_netlink.h>
  16
  17 /**
  18  * enum rdma_restrack_type - HW objects to track
  19  */
  20 enum rdma_restrack_type {
  21         /**
  22          * @RDMA_RESTRACK_PD: Protection domain (PD)
  23          */
  24         RDMA_RESTRACK_PD,
  25         /**
  26          * @RDMA_RESTRACK_CQ: Completion queue (CQ)
  27          */
  28         RDMA_RESTRACK_CQ,
  29         /**
  30          * @RDMA_RESTRACK_QP: Queue pair (QP)
  31          */
  32         RDMA_RESTRACK_QP,
  33         /**
  34          * @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
  35          */
  36         RDMA_RESTRACK_CM_ID,
  37         /**
  38          * @RDMA_RESTRACK_MR: Memory Region (MR)
  39          */
  40         RDMA_RESTRACK_MR,
  41         /**
  42          * @RDMA_RESTRACK_CTX: Verbs contexts (CTX)
  43          */
  44         RDMA_RESTRACK_CTX,
  45         /**
  46          * @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
  47          */
  48         RDMA_RESTRACK_MAX
  49 };
  50
  51 #define RDMA_RESTRACK_HASH_BITS 8
  52 struct rdma_restrack_entry;
  53
  54 /**
  55  * struct rdma_restrack_root - main resource tracking management
  56  * entity, per-device
  57  */
  58 struct rdma_restrack_root {
  59         /*
  60          * @rwsem: Read/write lock to protect lists
  61          */
  62         struct rw_semaphore     rwsem;
  63         /**
  64          * @hash: global database for all resources per-device
  65          */
  66         DECLARE_HASHTABLE(hash, RDMA_RESTRACK_HASH_BITS);
  67         /**
  68          * @fill_res_entry: driver-specific fill function
  69          *
  70          * Allows rdma drivers to add their own restrack attributes.
  71          */
  72         int (*fill_res_entry)(struct sk_buff *msg,
  73                               struct rdma_restrack_entry *entry);
  74 };
  75
  76 /**
  77  * struct rdma_restrack_entry - metadata per-entry
  78  */
  79 struct rdma_restrack_entry {
  80         /**
  81          * @valid: validity indicator
  82          *
  83          * The entries are filled during rdma_restrack_add,
  84          * can be attempted to be free during rdma_restrack_del.
  85          *
  86          * As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
  87          */
  88         bool                    valid;
  89         /*
  90          * @kref: Protect destroy of the resource
  91          */
  92         struct kref             kref;
  93         /*
  94          * @comp: Signal that all consumers of resource are completed their work
  95          */
  96         struct completion       comp;
  97         /**
  98          * @task: owner of resource tracking entity
  99          *
 100          * There are two types of entities: created by user and created
 101          * by kernel.
 102          *
 103          * This is relevant for the entities created by users.
 104          * For the entities created by kernel, this pointer will be NULL.
 105          */
 106         struct task_struct      *task;
 107         /**
 108          * @kern_name: name of owner for the kernel created entities.
 109          */
 110         const char              *kern_name;
 111         /**
 112          * @node: hash table entry
 113          */
 114         struct hlist_node       node;
 115         /**
 116          * @type: various objects in restrack database
 117          */
 118         enum rdma_restrack_type type;
 119 };
 120
 121 /**
 122  * rdma_restrack_init() - initialize resource tracking
 123  * @res:  resource tracking root
 124  */
 125 void rdma_restrack_init(struct rdma_restrack_root *res);
 126
 127 /**
 128  * rdma_restrack_clean() - clean resource tracking
 129  * @res:  resource tracking root
 130  */
 131 void rdma_restrack_clean(struct rdma_restrack_root *res);
 132
 133 /**
 134  * rdma_restrack_count() - the current usage of specific object
 135  * @res:  resource entry
 136  * @type: actual type of object to operate
 137  * @ns:   PID namespace
 138  */
 139 int rdma_restrack_count(struct rdma_restrack_root *res,
 140                         enum rdma_restrack_type type,
 141                         struct pid_namespace *ns);
 142
 143 /**
 144  * rdma_restrack_add() - add object to the reource tracking database
 145  * @res:  resource entry
 146  */
 147 void rdma_restrack_add(struct rdma_restrack_entry *res);
 148
 149 /**
 150  * rdma_restrack_del() - delete object from the reource tracking database
 151  * @res:  resource entry
 152  * @type: actual type of object to operate
 153  */
 154 void rdma_restrack_del(struct rdma_restrack_entry *res);
 155
 156 /**
 157  * rdma_is_kernel_res() - check the owner of resource
 158  * @res:  resource entry
 159  */
 160 static inline bool rdma_is_kernel_res(struct rdma_restrack_entry *res)
 161 {
 162         return !res->task;
 163 }
 164
 165 /**
 166  * rdma_restrack_get() - grab to protect resource from release
 167  * @res:  resource entry
 168  */
 169 int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
 170
 171 /**
 172  * rdma_restrack_put() - release resource
 173  * @res:  resource entry
 174  */
 175 int rdma_restrack_put(struct rdma_restrack_entry *res);
 176
 177 /**
 178  * rdma_restrack_set_task() - set the task for this resource
 179  * @res:  resource entry
 180  * @caller: kernel name, the current task will be used if the caller is NULL.
 181  */
 182 void rdma_restrack_set_task(struct rdma_restrack_entry *res,
 183                             const char *caller);
 184
 185 /*
 186  * Helper functions for rdma drivers when filling out
 187  * nldev driver attributes.
 188  */
 189 int rdma_nl_put_driver_u32(struct sk_buff *msg, const char *name, u32 value);
 190 int rdma_nl_put_driver_u32_hex(struct sk_buff *msg, const char *name,
 191                                u32 value);
 192 int rdma_nl_put_driver_u64(struct sk_buff *msg, const char *name, u64 value);
 193 int rdma_nl_put_driver_u64_hex(struct sk_buff *msg, const char *name,
 194                                u64 value);
 195 #endif /* _RDMA_RESTRACK_H_ */