2018-06-05 12:48:08 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
|
2018-01-28 17:17:20 +08:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _RDMA_RESTRACK_H_
|
|
|
|
#define _RDMA_RESTRACK_H_
|
|
|
|
|
|
|
|
#include <linux/typecheck.h>
|
|
|
|
#include <linux/rwsem.h>
|
|
|
|
#include <linux/sched.h>
|
|
|
|
#include <linux/kref.h>
|
|
|
|
#include <linux/completion.h>
|
2018-03-02 05:57:44 +08:00
|
|
|
#include <linux/sched/task.h>
|
2018-05-03 23:41:42 +08:00
|
|
|
#include <uapi/rdma/rdma_netlink.h>
|
2018-01-28 17:17:20 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* enum rdma_restrack_type - HW objects to track
|
|
|
|
*/
|
|
|
|
enum rdma_restrack_type {
|
|
|
|
/**
|
|
|
|
* @RDMA_RESTRACK_PD: Protection domain (PD)
|
|
|
|
*/
|
|
|
|
RDMA_RESTRACK_PD,
|
|
|
|
/**
|
|
|
|
* @RDMA_RESTRACK_CQ: Completion queue (CQ)
|
|
|
|
*/
|
|
|
|
RDMA_RESTRACK_CQ,
|
|
|
|
/**
|
|
|
|
* @RDMA_RESTRACK_QP: Queue pair (QP)
|
|
|
|
*/
|
|
|
|
RDMA_RESTRACK_QP,
|
2018-03-02 05:57:44 +08:00
|
|
|
/**
|
|
|
|
* @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
|
|
|
|
*/
|
|
|
|
RDMA_RESTRACK_CM_ID,
|
2018-03-02 05:58:13 +08:00
|
|
|
/**
|
|
|
|
* @RDMA_RESTRACK_MR: Memory Region (MR)
|
|
|
|
*/
|
|
|
|
RDMA_RESTRACK_MR,
|
2018-01-28 17:17:20 +08:00
|
|
|
/**
|
|
|
|
* @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
|
|
|
|
*/
|
|
|
|
RDMA_RESTRACK_MAX
|
|
|
|
};
|
|
|
|
|
|
|
|
#define RDMA_RESTRACK_HASH_BITS 8
|
RDMA/nldev: add driver-specific resource tracking
Each driver can register a "fill entry" function with the restrack core.
This function will be called when filling out a resource, allowing the
driver to add driver-specific details. The details consist of a
nltable of nested attributes, that are in the form of <key, [print-type],
value> tuples. Both key and value attributes are mandatory. The key
nlattr must be a string, and the value nlattr can be one of the driver
attributes that are generic, but typed, allowing the attributes to be
validated. Currently the driver nlattr types include string, s32,
u32, s64, and u64. The print-type nlattr allows a driver to specify
an alternative display format for user tools displaying the attribute.
For example, a u32 attribute will default to "%u", but a print-type
attribute can be included for it to be displayed in hex. This allows
the user tool to print the number in the format desired by the driver
driver.
More attrs can be defined as they become needed by drivers.
Signed-off-by: Steve Wise <swise@opengridcomputing.com>
Reviewed-by: Leon Romanovsky <leonro@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2018-05-03 23:41:30 +08:00
|
|
|
struct rdma_restrack_entry;
|
|
|
|
|
2018-01-28 17:17:20 +08:00
|
|
|
/**
|
|
|
|
* struct rdma_restrack_root - main resource tracking management
|
|
|
|
* entity, per-device
|
|
|
|
*/
|
|
|
|
struct rdma_restrack_root {
|
|
|
|
/*
|
|
|
|
* @rwsem: Read/write lock to protect lists
|
|
|
|
*/
|
|
|
|
struct rw_semaphore rwsem;
|
|
|
|
/**
|
|
|
|
* @hash: global database for all resources per-device
|
|
|
|
*/
|
|
|
|
DECLARE_HASHTABLE(hash, RDMA_RESTRACK_HASH_BITS);
|
RDMA/nldev: add driver-specific resource tracking
Each driver can register a "fill entry" function with the restrack core.
This function will be called when filling out a resource, allowing the
driver to add driver-specific details. The details consist of a
nltable of nested attributes, that are in the form of <key, [print-type],
value> tuples. Both key and value attributes are mandatory. The key
nlattr must be a string, and the value nlattr can be one of the driver
attributes that are generic, but typed, allowing the attributes to be
validated. Currently the driver nlattr types include string, s32,
u32, s64, and u64. The print-type nlattr allows a driver to specify
an alternative display format for user tools displaying the attribute.
For example, a u32 attribute will default to "%u", but a print-type
attribute can be included for it to be displayed in hex. This allows
the user tool to print the number in the format desired by the driver
driver.
More attrs can be defined as they become needed by drivers.
Signed-off-by: Steve Wise <swise@opengridcomputing.com>
Reviewed-by: Leon Romanovsky <leonro@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2018-05-03 23:41:30 +08:00
|
|
|
/**
|
|
|
|
* @fill_res_entry: driver-specific fill function
|
|
|
|
*
|
|
|
|
* Allows rdma drivers to add their own restrack attributes.
|
|
|
|
*/
|
|
|
|
int (*fill_res_entry)(struct sk_buff *msg,
|
|
|
|
struct rdma_restrack_entry *entry);
|
2018-01-28 17:17:20 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* struct rdma_restrack_entry - metadata per-entry
|
|
|
|
*/
|
|
|
|
struct rdma_restrack_entry {
|
|
|
|
/**
|
|
|
|
* @valid: validity indicator
|
|
|
|
*
|
|
|
|
* The entries are filled during rdma_restrack_add,
|
|
|
|
* can be attempted to be free during rdma_restrack_del.
|
|
|
|
*
|
|
|
|
* As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
|
|
|
|
*/
|
|
|
|
bool valid;
|
|
|
|
/*
|
|
|
|
* @kref: Protect destroy of the resource
|
|
|
|
*/
|
|
|
|
struct kref kref;
|
|
|
|
/*
|
|
|
|
* @comp: Signal that all consumers of resource are completed their work
|
|
|
|
*/
|
|
|
|
struct completion comp;
|
|
|
|
/**
|
|
|
|
* @task: owner of resource tracking entity
|
|
|
|
*
|
|
|
|
* There are two types of entities: created by user and created
|
|
|
|
* by kernel.
|
|
|
|
*
|
|
|
|
* This is relevant for the entities created by users.
|
|
|
|
* For the entities created by kernel, this pointer will be NULL.
|
|
|
|
*/
|
|
|
|
struct task_struct *task;
|
|
|
|
/**
|
|
|
|
* @kern_name: name of owner for the kernel created entities.
|
|
|
|
*/
|
|
|
|
const char *kern_name;
|
|
|
|
/**
|
|
|
|
* @node: hash table entry
|
|
|
|
*/
|
|
|
|
struct hlist_node node;
|
|
|
|
/**
|
|
|
|
* @type: various objects in restrack database
|
|
|
|
*/
|
|
|
|
enum rdma_restrack_type type;
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_init() - initialize resource tracking
|
|
|
|
* @res: resource tracking root
|
|
|
|
*/
|
|
|
|
void rdma_restrack_init(struct rdma_restrack_root *res);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_clean() - clean resource tracking
|
|
|
|
* @res: resource tracking root
|
|
|
|
*/
|
|
|
|
void rdma_restrack_clean(struct rdma_restrack_root *res);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_count() - the current usage of specific object
|
|
|
|
* @res: resource entry
|
|
|
|
* @type: actual type of object to operate
|
|
|
|
* @ns: PID namespace
|
|
|
|
*/
|
|
|
|
int rdma_restrack_count(struct rdma_restrack_root *res,
|
|
|
|
enum rdma_restrack_type type,
|
|
|
|
struct pid_namespace *ns);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_add() - add object to the reource tracking database
|
|
|
|
* @res: resource entry
|
|
|
|
*/
|
|
|
|
void rdma_restrack_add(struct rdma_restrack_entry *res);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_del() - delete object from the reource tracking database
|
|
|
|
* @res: resource entry
|
|
|
|
* @type: actual type of object to operate
|
|
|
|
*/
|
|
|
|
void rdma_restrack_del(struct rdma_restrack_entry *res);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_is_kernel_res() - check the owner of resource
|
|
|
|
* @res: resource entry
|
|
|
|
*/
|
|
|
|
static inline bool rdma_is_kernel_res(struct rdma_restrack_entry *res)
|
|
|
|
{
|
|
|
|
return !res->task;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_get() - grab to protect resource from release
|
|
|
|
* @res: resource entry
|
|
|
|
*/
|
|
|
|
int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
|
|
|
|
|
|
|
|
/**
|
2018-03-21 23:12:42 +08:00
|
|
|
* rdma_restrack_put() - release resource
|
2018-01-28 17:17:20 +08:00
|
|
|
* @res: resource entry
|
|
|
|
*/
|
|
|
|
int rdma_restrack_put(struct rdma_restrack_entry *res);
|
2018-03-02 05:57:44 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* rdma_restrack_set_task() - set the task for this resource
|
|
|
|
* @res: resource entry
|
2018-10-02 16:48:02 +08:00
|
|
|
* @caller: kernel name, the current task will be used if the caller is NULL.
|
2018-03-02 05:57:44 +08:00
|
|
|
*/
|
2018-10-02 16:48:01 +08:00
|
|
|
void rdma_restrack_set_task(struct rdma_restrack_entry *res,
|
2018-10-02 16:48:02 +08:00
|
|
|
const char *caller);
|
2018-03-02 05:57:44 +08:00
|
|
|
|
2018-05-03 23:41:42 +08:00
|
|
|
/*
|
|
|
|
* Helper functions for rdma drivers when filling out
|
|
|
|
* nldev driver attributes.
|
|
|
|
*/
|
|
|
|
int rdma_nl_put_driver_u32(struct sk_buff *msg, const char *name, u32 value);
|
|
|
|
int rdma_nl_put_driver_u32_hex(struct sk_buff *msg, const char *name,
|
|
|
|
u32 value);
|
|
|
|
int rdma_nl_put_driver_u64(struct sk_buff *msg, const char *name, u64 value);
|
|
|
|
int rdma_nl_put_driver_u64_hex(struct sk_buff *msg, const char *name,
|
|
|
|
u64 value);
|
2018-01-28 17:17:20 +08:00
|
|
|
#endif /* _RDMA_RESTRACK_H_ */
|