drivers/infiniband/core/core_priv.h

   1 /*
   2  * Copyright (c) 2004 Topspin Communications.  All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and/or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef _CORE_PRIV_H
  34 #define _CORE_PRIV_H
  35
  36 #include <linux/list.h>
  37 #include <linux/spinlock.h>
  38 #include <linux/cgroup_rdma.h>
  39 #include <net/net_namespace.h>
  40 #include <net/netns/generic.h>
  41
  42 #include <rdma/ib_verbs.h>
  43 #include <rdma/opa_addr.h>
  44 #include <rdma/ib_mad.h>
  45 #include <rdma/restrack.h>
  46 #include "mad_priv.h"
  47 #include "restrack.h"
  48
  49 /* Total number of ports combined across all struct ib_devices's */
  50 #define RDMA_MAX_PORTS 8192
  51
  52 struct pkey_index_qp_list {
  53         struct list_head    pkey_index_list;
  54         u16                 pkey_index;
  55         /* Lock to hold while iterating the qp_list. */
  56         spinlock_t          qp_list_lock;
  57         struct list_head    qp_list;
  58 };
  59
  60 /**
  61  * struct rdma_dev_net - rdma net namespace metadata for a net
  62  * @nl_sock:    Pointer to netlink socket
  63  * @net:        Pointer to owner net namespace
  64  * @id:         xarray id to identify the net namespace.
  65  */
  66 struct rdma_dev_net {
  67         struct sock *nl_sock;
  68         possible_net_t net;
  69         u32 id;
  70 };
  71
  72 extern const struct attribute_group ib_dev_attr_group;
  73 extern bool ib_devices_shared_netns;
  74 extern unsigned int rdma_dev_net_id;
  75
  76 static inline struct rdma_dev_net *rdma_net_to_dev_net(struct net *net)
  77 {
  78         return net_generic(net, rdma_dev_net_id);
  79 }
  80
  81 int ib_device_rename(struct ib_device *ibdev, const char *name);
  82 int ib_device_set_dim(struct ib_device *ibdev, u8 use_dim);
  83
  84 typedef void (*roce_netdev_callback)(struct ib_device *device, u32 port,
  85               struct net_device *idev, void *cookie);
  86
  87 typedef bool (*roce_netdev_filter)(struct ib_device *device, u32 port,
  88                                    struct net_device *idev, void *cookie);
  89
  90 struct net_device *ib_device_get_netdev(struct ib_device *ib_dev,
  91                                         u32 port);
  92
  93 void ib_enum_roce_netdev(struct ib_device *ib_dev,
  94                          roce_netdev_filter filter,
  95                          void *filter_cookie,
  96                          roce_netdev_callback cb,
  97                          void *cookie);
  98 void ib_enum_all_roce_netdevs(roce_netdev_filter filter,
  99                               void *filter_cookie,
 100                               roce_netdev_callback cb,
 101                               void *cookie);
 102
 103 typedef int (*nldev_callback)(struct ib_device *device,
 104                               struct sk_buff *skb,
 105                               struct netlink_callback *cb,
 106                               unsigned int idx);
 107
 108 int ib_enum_all_devs(nldev_callback nldev_cb, struct sk_buff *skb,
 109                      struct netlink_callback *cb);
 110
 111 struct ib_client_nl_info {
 112         struct sk_buff *nl_msg;
 113         struct device *cdev;
 114         u32 port;
 115         u64 abi;
 116 };
 117 int ib_get_client_nl_info(struct ib_device *ibdev, const char *client_name,
 118                           struct ib_client_nl_info *res);
 119
 120 enum ib_cache_gid_default_mode {
 121         IB_CACHE_GID_DEFAULT_MODE_SET,
 122         IB_CACHE_GID_DEFAULT_MODE_DELETE
 123 };
 124
 125 int ib_cache_gid_parse_type_str(const char *buf);
 126
 127 const char *ib_cache_gid_type_str(enum ib_gid_type gid_type);
 128
 129 void ib_cache_gid_set_default_gid(struct ib_device *ib_dev, u32 port,
 130                                   struct net_device *ndev,
 131                                   unsigned long gid_type_mask,
 132                                   enum ib_cache_gid_default_mode mode);
 133
 134 int ib_cache_gid_add(struct ib_device *ib_dev, u32 port,
 135                      union ib_gid *gid, struct ib_gid_attr *attr);
 136
 137 int ib_cache_gid_del(struct ib_device *ib_dev, u32 port,
 138                      union ib_gid *gid, struct ib_gid_attr *attr);
 139
 140 int ib_cache_gid_del_all_netdev_gids(struct ib_device *ib_dev, u32 port,
 141                                      struct net_device *ndev);
 142
 143 int roce_gid_mgmt_init(void);
 144 void roce_gid_mgmt_cleanup(void);
 145
 146 unsigned long roce_gid_type_mask_support(struct ib_device *ib_dev, u32 port);
 147
 148 int ib_cache_setup_one(struct ib_device *device);
 149 void ib_cache_cleanup_one(struct ib_device *device);
 150 void ib_cache_release_one(struct ib_device *device);
 151 void ib_dispatch_event_clients(struct ib_event *event);
 152
 153 #ifdef CONFIG_CGROUP_RDMA
 154 void ib_device_register_rdmacg(struct ib_device *device);
 155 void ib_device_unregister_rdmacg(struct ib_device *device);
 156
 157 int ib_rdmacg_try_charge(struct ib_rdmacg_object *cg_obj,
 158                          struct ib_device *device,
 159                          enum rdmacg_resource_type resource_index);
 160
 161 void ib_rdmacg_uncharge(struct ib_rdmacg_object *cg_obj,
 162                         struct ib_device *device,
 163                         enum rdmacg_resource_type resource_index);
 164 #else
 165 static inline void ib_device_register_rdmacg(struct ib_device *device)
 166 {
 167 }
 168
 169 static inline void ib_device_unregister_rdmacg(struct ib_device *device)
 170 {
 171 }
 172
 173 static inline int ib_rdmacg_try_charge(struct ib_rdmacg_object *cg_obj,
 174                                        struct ib_device *device,
 175                                        enum rdmacg_resource_type resource_index)
 176 {
 177         return 0;
 178 }
 179
 180 static inline void ib_rdmacg_uncharge(struct ib_rdmacg_object *cg_obj,
 181                                       struct ib_device *device,
 182                                       enum rdmacg_resource_type resource_index)
 183 {
 184 }
 185 #endif
 186
 187 static inline bool rdma_is_upper_dev_rcu(struct net_device *dev,
 188                                          struct net_device *upper)
 189 {
 190         return netdev_has_upper_dev_all_rcu(dev, upper);
 191 }
 192
 193 int addr_init(void);
 194 void addr_cleanup(void);
 195
 196 int ib_mad_init(void);
 197 void ib_mad_cleanup(void);
 198
 199 int ib_sa_init(void);
 200 void ib_sa_cleanup(void);
 201
 202 void rdma_nl_init(void);
 203 void rdma_nl_exit(void);
 204
 205 int ib_nl_handle_resolve_resp(struct sk_buff *skb,
 206                               struct nlmsghdr *nlh,
 207                               struct netlink_ext_ack *extack);
 208 int ib_nl_handle_set_timeout(struct sk_buff *skb,
 209                              struct nlmsghdr *nlh,
 210                              struct netlink_ext_ack *extack);
 211 int ib_nl_handle_ip_res_resp(struct sk_buff *skb,
 212                              struct nlmsghdr *nlh,
 213                              struct netlink_ext_ack *extack);
 214
 215 void ib_get_cached_subnet_prefix(struct ib_device *device,
 216                                 u32 port_num,
 217                                 u64 *sn_pfx);
 218
 219 #ifdef CONFIG_SECURITY_INFINIBAND
 220 void ib_security_release_port_pkey_list(struct ib_device *device);
 221
 222 void ib_security_cache_change(struct ib_device *device,
 223                               u32 port_num,
 224                               u64 subnet_prefix);
 225
 226 int ib_security_modify_qp(struct ib_qp *qp,
 227                           struct ib_qp_attr *qp_attr,
 228                           int qp_attr_mask,
 229                           struct ib_udata *udata);
 230
 231 int ib_create_qp_security(struct ib_qp *qp, struct ib_device *dev);
 232 void ib_destroy_qp_security_begin(struct ib_qp_security *sec);
 233 void ib_destroy_qp_security_abort(struct ib_qp_security *sec);
 234 void ib_destroy_qp_security_end(struct ib_qp_security *sec);
 235 int ib_open_shared_qp_security(struct ib_qp *qp, struct ib_device *dev);
 236 void ib_close_shared_qp_security(struct ib_qp_security *sec);
 237 int ib_mad_agent_security_setup(struct ib_mad_agent *agent,
 238                                 enum ib_qp_type qp_type);
 239 void ib_mad_agent_security_cleanup(struct ib_mad_agent *agent);
 240 int ib_mad_enforce_security(struct ib_mad_agent_private *map, u16 pkey_index);
 241 void ib_mad_agent_security_change(void);
 242 #else
 243 static inline void ib_security_release_port_pkey_list(struct ib_device *device)
 244 {
 245 }
 246
 247 static inline void ib_security_cache_change(struct ib_device *device,
 248                                             u32 port_num,
 249                                             u64 subnet_prefix)
 250 {
 251 }
 252
 253 static inline int ib_security_modify_qp(struct ib_qp *qp,
 254                                         struct ib_qp_attr *qp_attr,
 255                                         int qp_attr_mask,
 256                                         struct ib_udata *udata)
 257 {
 258         return qp->device->ops.modify_qp(qp->real_qp,
 259                                          qp_attr,
 260                                          qp_attr_mask,
 261                                          udata);
 262 }
 263
 264 static inline int ib_create_qp_security(struct ib_qp *qp,
 265                                         struct ib_device *dev)
 266 {
 267         return 0;
 268 }
 269
 270 static inline void ib_destroy_qp_security_begin(struct ib_qp_security *sec)
 271 {
 272 }
 273
 274 static inline void ib_destroy_qp_security_abort(struct ib_qp_security *sec)
 275 {
 276 }
 277
 278 static inline void ib_destroy_qp_security_end(struct ib_qp_security *sec)
 279 {
 280 }
 281
 282 static inline int ib_open_shared_qp_security(struct ib_qp *qp,
 283                                              struct ib_device *dev)
 284 {
 285         return 0;
 286 }
 287
 288 static inline void ib_close_shared_qp_security(struct ib_qp_security *sec)
 289 {
 290 }
 291
 292 static inline int ib_mad_agent_security_setup(struct ib_mad_agent *agent,
 293                                               enum ib_qp_type qp_type)
 294 {
 295         return 0;
 296 }
 297
 298 static inline void ib_mad_agent_security_cleanup(struct ib_mad_agent *agent)
 299 {
 300 }
 301
 302 static inline int ib_mad_enforce_security(struct ib_mad_agent_private *map,
 303                                           u16 pkey_index)
 304 {
 305         return 0;
 306 }
 307
 308 static inline void ib_mad_agent_security_change(void)
 309 {
 310 }
 311 #endif
 312
 313 struct ib_device *ib_device_get_by_index(const struct net *net, u32 index);
 314
 315 /* RDMA device netlink */
 316 void nldev_init(void);
 317 void nldev_exit(void);
 318
 319 struct ib_qp *ib_create_qp_user(struct ib_device *dev, struct ib_pd *pd,
 320                                 struct ib_qp_init_attr *attr,
 321                                 struct ib_udata *udata,
 322                                 struct ib_uqp_object *uobj, const char *caller);
 323
 324 void ib_qp_usecnt_inc(struct ib_qp *qp);
 325 void ib_qp_usecnt_dec(struct ib_qp *qp);
 326
 327 struct rdma_dev_addr;
 328
 329 int rdma_addr_find_l2_eth_by_grh(const union ib_gid *sgid,
 330                                  const union ib_gid *dgid,
 331                                  u8 *dmac, const struct ib_gid_attr *sgid_attr,
 332                                  int *hoplimit);
 333 void rdma_copy_src_l2_addr(struct rdma_dev_addr *dev_addr,
 334                            const struct net_device *dev);
 335
 336 struct sa_path_rec;
 337 int roce_resolve_route_from_path(struct sa_path_rec *rec,
 338                                  const struct ib_gid_attr *attr);
 339
 340 struct net_device *rdma_read_gid_attr_ndev_rcu(const struct ib_gid_attr *attr);
 341
 342 void ib_free_port_attrs(struct ib_core_device *coredev);
 343 int ib_setup_port_attrs(struct ib_core_device *coredev);
 344 struct rdma_hw_stats *ib_get_hw_stats_port(struct ib_device *ibdev, u32 port_num);
 345 void ib_device_release_hw_stats(struct hw_stats_device_data *data);
 346 int ib_setup_device_attrs(struct ib_device *ibdev);
 347
 348 int rdma_compatdev_set(u8 enable);
 349
 350 int ib_port_register_client_groups(struct ib_device *ibdev, u32 port_num,
 351                                    const struct attribute_group **groups);
 352 void ib_port_unregister_client_groups(struct ib_device *ibdev, u32 port_num,
 353                                      const struct attribute_group **groups);
 354
 355 int ib_device_set_netns_put(struct sk_buff *skb,
 356                             struct ib_device *dev, u32 ns_fd);
 357
 358 int rdma_nl_net_init(struct rdma_dev_net *rnet);
 359 void rdma_nl_net_exit(struct rdma_dev_net *rnet);
 360
 361 struct rdma_umap_priv {
 362         struct vm_area_struct *vma;
 363         struct list_head list;
 364         struct rdma_user_mmap_entry *entry;
 365 };
 366
 367 void rdma_umap_priv_init(struct rdma_umap_priv *priv,
 368                          struct vm_area_struct *vma,
 369                          struct rdma_user_mmap_entry *entry);
 370
 371 void ib_cq_pool_cleanup(struct ib_device *dev);
 372
 373 bool rdma_nl_get_privileged_qkey(void);
 374 #endif /* _CORE_PRIV_H */