drivers/infiniband/core/device.c

   1 /*
   2  * Copyright (c) 2004 Topspin Communications.  All rights reserved.
   3  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   4  *
   5  * This software is available to you under a choice of one of two
   6  * licenses.  You may choose to be licensed under the terms of the GNU
   7  * General Public License (GPL) Version 2, available from the file
   8  * COPYING in the main directory of this source tree, or the
   9  * OpenIB.org BSD license below:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      - Redistributions of source code must retain the above
  16  *        copyright notice, this list of conditions and the following
  17  *        disclaimer.
  18  *
  19  *      - Redistributions in binary form must reproduce the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer in the documentation and/or other materials
  22  *        provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33
  34 #include <linux/module.h>
  35 #include <linux/string.h>
  36 #include <linux/errno.h>
  37 #include <linux/kernel.h>
  38 #include <linux/slab.h>
  39 #include <linux/init.h>
  40 #include <linux/mutex.h>
  41 #include <linux/netdevice.h>
  42 #include <linux/security.h>
  43 #include <linux/notifier.h>
  44 #include <rdma/rdma_netlink.h>
  45 #include <rdma/ib_addr.h>
  46 #include <rdma/ib_cache.h>
  47
  48 #include "core_priv.h"
  49
  50 MODULE_AUTHOR("Roland Dreier");
  51 MODULE_DESCRIPTION("core kernel InfiniBand API");
  52 MODULE_LICENSE("Dual BSD/GPL");
  53
  54 struct ib_client_data {
  55         struct list_head  list;
  56         struct ib_client *client;
  57         void *            data;
  58         /* The device or client is going down. Do not call client or device
  59          * callbacks other than remove(). */
  60         bool              going_down;
  61 };
  62
  63 struct workqueue_struct *ib_comp_wq;
  64 struct workqueue_struct *ib_wq;
  65 EXPORT_SYMBOL_GPL(ib_wq);
  66
  67 /* The device_list and client_list contain devices and clients after their
  68  * registration has completed, and the devices and clients are removed
  69  * during unregistration. */
  70 static LIST_HEAD(device_list);
  71 static LIST_HEAD(client_list);
  72
  73 /*
  74  * device_mutex and lists_rwsem protect access to both device_list and
  75  * client_list.  device_mutex protects writer access by device and client
  76  * registration / de-registration.  lists_rwsem protects reader access to
  77  * these lists.  Iterators of these lists must lock it for read, while updates
  78  * to the lists must be done with a write lock. A special case is when the
  79  * device_mutex is locked. In this case locking the lists for read access is
  80  * not necessary as the device_mutex implies it.
  81  *
  82  * lists_rwsem also protects access to the client data list.
  83  */
  84 static DEFINE_MUTEX(device_mutex);
  85 static DECLARE_RWSEM(lists_rwsem);
  86
  87 static int ib_security_change(struct notifier_block *nb, unsigned long event,
  88                               void *lsm_data);
  89 static void ib_policy_change_task(struct work_struct *work);
  90 static DECLARE_WORK(ib_policy_change_work, ib_policy_change_task);
  91
  92 static struct notifier_block ibdev_lsm_nb = {
  93         .notifier_call = ib_security_change,
  94 };
  95
  96 static int ib_device_check_mandatory(struct ib_device *device)
  97 {
  98 #define IB_MANDATORY_FUNC(x) { offsetof(struct ib_device, x), #x }
  99         static const struct {
 100                 size_t offset;
 101                 char  *name;
 102         } mandatory_table[] = {
 103                 IB_MANDATORY_FUNC(query_device),
 104                 IB_MANDATORY_FUNC(query_port),
 105                 IB_MANDATORY_FUNC(query_pkey),
 106                 IB_MANDATORY_FUNC(query_gid),
 107                 IB_MANDATORY_FUNC(alloc_pd),
 108                 IB_MANDATORY_FUNC(dealloc_pd),
 109                 IB_MANDATORY_FUNC(create_ah),
 110                 IB_MANDATORY_FUNC(destroy_ah),
 111                 IB_MANDATORY_FUNC(create_qp),
 112                 IB_MANDATORY_FUNC(modify_qp),
 113                 IB_MANDATORY_FUNC(destroy_qp),
 114                 IB_MANDATORY_FUNC(post_send),
 115                 IB_MANDATORY_FUNC(post_recv),
 116                 IB_MANDATORY_FUNC(create_cq),
 117                 IB_MANDATORY_FUNC(destroy_cq),
 118                 IB_MANDATORY_FUNC(poll_cq),
 119                 IB_MANDATORY_FUNC(req_notify_cq),
 120                 IB_MANDATORY_FUNC(get_dma_mr),
 121                 IB_MANDATORY_FUNC(dereg_mr),
 122                 IB_MANDATORY_FUNC(get_port_immutable)
 123         };
 124         int i;
 125
 126         for (i = 0; i < ARRAY_SIZE(mandatory_table); ++i) {
 127                 if (!*(void **) ((void *) device + mandatory_table[i].offset)) {
 128                         pr_warn("Device %s is missing mandatory function %s\n",
 129                                 device->name, mandatory_table[i].name);
 130                         return -EINVAL;
 131                 }
 132         }
 133
 134         return 0;
 135 }
 136
 137 static struct ib_device *__ib_device_get_by_name(const char *name)
 138 {
 139         struct ib_device *device;
 140
 141         list_for_each_entry(device, &device_list, core_list)
 142                 if (!strncmp(name, device->name, IB_DEVICE_NAME_MAX))
 143                         return device;
 144
 145         return NULL;
 146 }
 147
 148
 149 static int alloc_name(char *name)
 150 {
 151         unsigned long *inuse;
 152         char buf[IB_DEVICE_NAME_MAX];
 153         struct ib_device *device;
 154         int i;
 155
 156         inuse = (unsigned long *) get_zeroed_page(GFP_KERNEL);
 157         if (!inuse)
 158                 return -ENOMEM;
 159
 160         list_for_each_entry(device, &device_list, core_list) {
 161                 if (!sscanf(device->name, name, &i))
 162                         continue;
 163                 if (i < 0 || i >= PAGE_SIZE * 8)
 164                         continue;
 165                 snprintf(buf, sizeof buf, name, i);
 166                 if (!strncmp(buf, device->name, IB_DEVICE_NAME_MAX))
 167                         set_bit(i, inuse);
 168         }
 169
 170         i = find_first_zero_bit(inuse, PAGE_SIZE * 8);
 171         free_page((unsigned long) inuse);
 172         snprintf(buf, sizeof buf, name, i);
 173
 174         if (__ib_device_get_by_name(buf))
 175                 return -ENFILE;
 176
 177         strlcpy(name, buf, IB_DEVICE_NAME_MAX);
 178         return 0;
 179 }
 180
 181 static void ib_device_release(struct device *device)
 182 {
 183         struct ib_device *dev = container_of(device, struct ib_device, dev);
 184
 185         WARN_ON(dev->reg_state == IB_DEV_REGISTERED);
 186         if (dev->reg_state == IB_DEV_UNREGISTERED) {
 187                 /*
 188                  * In IB_DEV_UNINITIALIZED state, cache or port table
 189                  * is not even created. Free cache and port table only when
 190                  * device reaches UNREGISTERED state.
 191                  */
 192                 ib_cache_release_one(dev);
 193                 kfree(dev->port_immutable);
 194         }
 195         kfree(dev);
 196 }
 197
 198 static int ib_device_uevent(struct device *device,
 199                             struct kobj_uevent_env *env)
 200 {
 201         struct ib_device *dev = container_of(device, struct ib_device, dev);
 202
 203         if (add_uevent_var(env, "NAME=%s", dev->name))
 204                 return -ENOMEM;
 205
 206         /*
 207          * It would be nice to pass the node GUID with the event...
 208          */
 209
 210         return 0;
 211 }
 212
 213 static struct class ib_class = {
 214         .name    = "infiniband",
 215         .dev_release = ib_device_release,
 216         .dev_uevent = ib_device_uevent,
 217 };
 218
 219 /**
 220  * ib_alloc_device - allocate an IB device struct
 221  * @size:size of structure to allocate
 222  *
 223  * Low-level drivers should use ib_alloc_device() to allocate &struct
 224  * ib_device.  @size is the size of the structure to be allocated,
 225  * including any private data used by the low-level driver.
 226  * ib_dealloc_device() must be used to free structures allocated with
 227  * ib_alloc_device().
 228  */
 229 struct ib_device *ib_alloc_device(size_t size)
 230 {
 231         struct ib_device *device;
 232
 233         if (WARN_ON(size < sizeof(struct ib_device)))
 234                 return NULL;
 235
 236         device = kzalloc(size, GFP_KERNEL);
 237         if (!device)
 238                 return NULL;
 239
 240         device->dev.class = &ib_class;
 241         device_initialize(&device->dev);
 242
 243         dev_set_drvdata(&device->dev, device);
 244
 245         INIT_LIST_HEAD(&device->event_handler_list);
 246         spin_lock_init(&device->event_handler_lock);
 247         spin_lock_init(&device->client_data_lock);
 248         INIT_LIST_HEAD(&device->client_data_list);
 249         INIT_LIST_HEAD(&device->port_list);
 250
 251         return device;
 252 }
 253 EXPORT_SYMBOL(ib_alloc_device);
 254
 255 /**
 256  * ib_dealloc_device - free an IB device struct
 257  * @device:structure to free
 258  *
 259  * Free a structure allocated with ib_alloc_device().
 260  */
 261 void ib_dealloc_device(struct ib_device *device)
 262 {
 263         WARN_ON(device->reg_state != IB_DEV_UNREGISTERED &&
 264                 device->reg_state != IB_DEV_UNINITIALIZED);
 265         kobject_put(&device->dev.kobj);
 266 }
 267 EXPORT_SYMBOL(ib_dealloc_device);
 268
 269 static int add_client_context(struct ib_device *device, struct ib_client *client)
 270 {
 271         struct ib_client_data *context;
 272         unsigned long flags;
 273
 274         context = kmalloc(sizeof *context, GFP_KERNEL);
 275         if (!context)
 276                 return -ENOMEM;
 277
 278         context->client = client;
 279         context->data   = NULL;
 280         context->going_down = false;
 281
 282         down_write(&lists_rwsem);
 283         spin_lock_irqsave(&device->client_data_lock, flags);
 284         list_add(&context->list, &device->client_data_list);
 285         spin_unlock_irqrestore(&device->client_data_lock, flags);
 286         up_write(&lists_rwsem);
 287
 288         return 0;
 289 }
 290
 291 static int verify_immutable(const struct ib_device *dev, u8 port)
 292 {
 293         return WARN_ON(!rdma_cap_ib_mad(dev, port) &&
 294                             rdma_max_mad_size(dev, port) != 0);
 295 }
 296
 297 static int read_port_immutable(struct ib_device *device)
 298 {
 299         int ret;
 300         u8 start_port = rdma_start_port(device);
 301         u8 end_port = rdma_end_port(device);
 302         u8 port;
 303
 304         /**
 305          * device->port_immutable is indexed directly by the port number to make
 306          * access to this data as efficient as possible.
 307          *
 308          * Therefore port_immutable is declared as a 1 based array with
 309          * potential empty slots at the beginning.
 310          */
 311         device->port_immutable = kzalloc(sizeof(*device->port_immutable)
 312                                          * (end_port + 1),
 313                                          GFP_KERNEL);
 314         if (!device->port_immutable)
 315                 return -ENOMEM;
 316
 317         for (port = start_port; port <= end_port; ++port) {
 318                 ret = device->get_port_immutable(device, port,
 319                                                  &device->port_immutable[port]);
 320                 if (ret)
 321                         return ret;
 322
 323                 if (verify_immutable(device, port))
 324                         return -EINVAL;
 325         }
 326         return 0;
 327 }
 328
 329 void ib_get_device_fw_str(struct ib_device *dev, char *str, size_t str_len)
 330 {
 331         if (dev->get_dev_fw_str)
 332                 dev->get_dev_fw_str(dev, str, str_len);
 333         else
 334                 str[0] = '\0';
 335 }
 336 EXPORT_SYMBOL(ib_get_device_fw_str);
 337
 338 static int setup_port_pkey_list(struct ib_device *device)
 339 {
 340         int i;
 341
 342         /**
 343          * device->port_pkey_list is indexed directly by the port number,
 344          * Therefore it is declared as a 1 based array with potential empty
 345          * slots at the beginning.
 346          */
 347         device->port_pkey_list = kcalloc(rdma_end_port(device) + 1,
 348                                          sizeof(*device->port_pkey_list),
 349                                          GFP_KERNEL);
 350
 351         if (!device->port_pkey_list)
 352                 return -ENOMEM;
 353
 354         for (i = 0; i < (rdma_end_port(device) + 1); i++) {
 355                 spin_lock_init(&device->port_pkey_list[i].list_lock);
 356                 INIT_LIST_HEAD(&device->port_pkey_list[i].pkey_list);
 357         }
 358
 359         return 0;
 360 }
 361
 362 static void ib_policy_change_task(struct work_struct *work)
 363 {
 364         struct ib_device *dev;
 365
 366         down_read(&lists_rwsem);
 367         list_for_each_entry(dev, &device_list, core_list) {
 368                 int i;
 369
 370                 for (i = rdma_start_port(dev); i <= rdma_end_port(dev); i++) {
 371                         u64 sp;
 372                         int ret = ib_get_cached_subnet_prefix(dev,
 373                                                               i,
 374                                                               &sp);
 375
 376                         WARN_ONCE(ret,
 377                                   "ib_get_cached_subnet_prefix err: %d, this should never happen here\n",
 378                                   ret);
 379                         if (!ret)
 380                                 ib_security_cache_change(dev, i, sp);
 381                 }
 382         }
 383         up_read(&lists_rwsem);
 384 }
 385
 386 static int ib_security_change(struct notifier_block *nb, unsigned long event,
 387                               void *lsm_data)
 388 {
 389         if (event != LSM_POLICY_CHANGE)
 390                 return NOTIFY_DONE;
 391
 392         schedule_work(&ib_policy_change_work);
 393
 394         return NOTIFY_OK;
 395 }
 396
 397 /**
 398  * ib_register_device - Register an IB device with IB core
 399  * @device:Device to register
 400  *
 401  * Low-level drivers use ib_register_device() to register their
 402  * devices with the IB core.  All registered clients will receive a
 403  * callback for each device that is added. @device must be allocated
 404  * with ib_alloc_device().
 405  */
 406 int ib_register_device(struct ib_device *device,
 407                        int (*port_callback)(struct ib_device *,
 408                                             u8, struct kobject *))
 409 {
 410         int ret;
 411         struct ib_client *client;
 412         struct ib_udata uhw = {.outlen = 0, .inlen = 0};
 413         struct device *parent = device->dev.parent;
 414
 415         WARN_ON_ONCE(!parent);
 416         WARN_ON_ONCE(device->dma_device);
 417         if (device->dev.dma_ops) {
 418                 /*
 419                  * The caller provided custom DMA operations. Copy the
 420                  * DMA-related fields that are used by e.g. dma_alloc_coherent()
 421                  * into device->dev.
 422                  */
 423                 device->dma_device = &device->dev;
 424                 if (!device->dev.dma_mask)
 425                         device->dev.dma_mask = parent->dma_mask;
 426                 if (!device->dev.coherent_dma_mask)
 427                         device->dev.coherent_dma_mask =
 428                                 parent->coherent_dma_mask;
 429         } else {
 430                 /*
 431                  * The caller did not provide custom DMA operations. Use the
 432                  * DMA mapping operations of the parent device.
 433                  */
 434                 device->dma_device = parent;
 435         }
 436
 437         mutex_lock(&device_mutex);
 438
 439         if (strchr(device->name, '%')) {
 440                 ret = alloc_name(device->name);
 441                 if (ret)
 442                         goto out;
 443         }
 444
 445         if (ib_device_check_mandatory(device)) {
 446                 ret = -EINVAL;
 447                 goto out;
 448         }
 449
 450         ret = read_port_immutable(device);
 451         if (ret) {
 452                 pr_warn("Couldn't create per port immutable data %s\n",
 453                         device->name);
 454                 goto out;
 455         }
 456
 457         ret = setup_port_pkey_list(device);
 458         if (ret) {
 459                 pr_warn("Couldn't create per port_pkey_list\n");
 460                 goto out;
 461         }
 462
 463         ret = ib_cache_setup_one(device);
 464         if (ret) {
 465                 pr_warn("Couldn't set up InfiniBand P_Key/GID cache\n");
 466                 goto port_cleanup;
 467         }
 468
 469         ret = ib_device_register_rdmacg(device);
 470         if (ret) {
 471                 pr_warn("Couldn't register device with rdma cgroup\n");
 472                 goto cache_cleanup;
 473         }
 474
 475         memset(&device->attrs, 0, sizeof(device->attrs));
 476         ret = device->query_device(device, &device->attrs, &uhw);
 477         if (ret) {
 478                 pr_warn("Couldn't query the device attributes\n");
 479                 goto cache_cleanup;
 480         }
 481
 482         ret = ib_device_register_sysfs(device, port_callback);
 483         if (ret) {
 484                 pr_warn("Couldn't register device %s with driver model\n",
 485                         device->name);
 486                 goto cache_cleanup;
 487         }
 488
 489         device->reg_state = IB_DEV_REGISTERED;
 490
 491         list_for_each_entry(client, &client_list, list)
 492                 if (client->add && !add_client_context(device, client))
 493                         client->add(device);
 494
 495         down_write(&lists_rwsem);
 496         list_add_tail(&device->core_list, &device_list);
 497         up_write(&lists_rwsem);
 498         mutex_unlock(&device_mutex);
 499         return 0;
 500
 501 cache_cleanup:
 502         ib_cache_cleanup_one(device);
 503         ib_cache_release_one(device);
 504 port_cleanup:
 505         kfree(device->port_immutable);
 506 out:
 507         mutex_unlock(&device_mutex);
 508         return ret;
 509 }
 510 EXPORT_SYMBOL(ib_register_device);
 511
 512 /**
 513  * ib_unregister_device - Unregister an IB device
 514  * @device:Device to unregister
 515  *
 516  * Unregister an IB device.  All clients will receive a remove callback.
 517  */
 518 void ib_unregister_device(struct ib_device *device)
 519 {
 520         struct ib_client_data *context, *tmp;
 521         unsigned long flags;
 522
 523         mutex_lock(&device_mutex);
 524
 525         down_write(&lists_rwsem);
 526         list_del(&device->core_list);
 527         spin_lock_irqsave(&device->client_data_lock, flags);
 528         list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
 529                 context->going_down = true;
 530         spin_unlock_irqrestore(&device->client_data_lock, flags);
 531         downgrade_write(&lists_rwsem);
 532
 533         list_for_each_entry_safe(context, tmp, &device->client_data_list,
 534                                  list) {
 535                 if (context->client->remove)
 536                         context->client->remove(device, context->data);
 537         }
 538         up_read(&lists_rwsem);
 539
 540         ib_device_unregister_rdmacg(device);
 541         ib_device_unregister_sysfs(device);
 542
 543         mutex_unlock(&device_mutex);
 544
 545         ib_cache_cleanup_one(device);
 546
 547         ib_security_destroy_port_pkey_list(device);
 548         kfree(device->port_pkey_list);
 549
 550         down_write(&lists_rwsem);
 551         spin_lock_irqsave(&device->client_data_lock, flags);
 552         list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
 553                 kfree(context);
 554         spin_unlock_irqrestore(&device->client_data_lock, flags);
 555         up_write(&lists_rwsem);
 556
 557         device->reg_state = IB_DEV_UNREGISTERED;
 558 }
 559 EXPORT_SYMBOL(ib_unregister_device);
 560
 561 /**
 562  * ib_register_client - Register an IB client
 563  * @client:Client to register
 564  *
 565  * Upper level users of the IB drivers can use ib_register_client() to
 566  * register callbacks for IB device addition and removal.  When an IB
 567  * device is added, each registered client's add method will be called
 568  * (in the order the clients were registered), and when a device is
 569  * removed, each client's remove method will be called (in the reverse
 570  * order that clients were registered).  In addition, when
 571  * ib_register_client() is called, the client will receive an add
 572  * callback for all devices already registered.
 573  */
 574 int ib_register_client(struct ib_client *client)
 575 {
 576         struct ib_device *device;
 577
 578         mutex_lock(&device_mutex);
 579
 580         list_for_each_entry(device, &device_list, core_list)
 581                 if (client->add && !add_client_context(device, client))
 582                         client->add(device);
 583
 584         down_write(&lists_rwsem);
 585         list_add_tail(&client->list, &client_list);
 586         up_write(&lists_rwsem);
 587
 588         mutex_unlock(&device_mutex);
 589
 590         return 0;
 591 }
 592 EXPORT_SYMBOL(ib_register_client);
 593
 594 /**
 595  * ib_unregister_client - Unregister an IB client
 596  * @client:Client to unregister
 597  *
 598  * Upper level users use ib_unregister_client() to remove their client
 599  * registration.  When ib_unregister_client() is called, the client
 600  * will receive a remove callback for each IB device still registered.
 601  */
 602 void ib_unregister_client(struct ib_client *client)
 603 {
 604         struct ib_client_data *context, *tmp;
 605         struct ib_device *device;
 606         unsigned long flags;
 607
 608         mutex_lock(&device_mutex);
 609
 610         down_write(&lists_rwsem);
 611         list_del(&client->list);
 612         up_write(&lists_rwsem);
 613
 614         list_for_each_entry(device, &device_list, core_list) {
 615                 struct ib_client_data *found_context = NULL;
 616
 617                 down_write(&lists_rwsem);
 618                 spin_lock_irqsave(&device->client_data_lock, flags);
 619                 list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
 620                         if (context->client == client) {
 621                                 context->going_down = true;
 622                                 found_context = context;
 623                                 break;
 624                         }
 625                 spin_unlock_irqrestore(&device->client_data_lock, flags);
 626                 up_write(&lists_rwsem);
 627
 628                 if (client->remove)
 629                         client->remove(device, found_context ?
 630                                                found_context->data : NULL);
 631
 632                 if (!found_context) {
 633                         pr_warn("No client context found for %s/%s\n",
 634                                 device->name, client->name);
 635                         continue;
 636                 }
 637
 638                 down_write(&lists_rwsem);
 639                 spin_lock_irqsave(&device->client_data_lock, flags);
 640                 list_del(&found_context->list);
 641                 kfree(found_context);
 642                 spin_unlock_irqrestore(&device->client_data_lock, flags);
 643                 up_write(&lists_rwsem);
 644         }
 645
 646         mutex_unlock(&device_mutex);
 647 }
 648 EXPORT_SYMBOL(ib_unregister_client);
 649
 650 /**
 651  * ib_get_client_data - Get IB client context
 652  * @device:Device to get context for
 653  * @client:Client to get context for
 654  *
 655  * ib_get_client_data() returns client context set with
 656  * ib_set_client_data().
 657  */
 658 void *ib_get_client_data(struct ib_device *device, struct ib_client *client)
 659 {
 660         struct ib_client_data *context;
 661         void *ret = NULL;
 662         unsigned long flags;
 663
 664         spin_lock_irqsave(&device->client_data_lock, flags);
 665         list_for_each_entry(context, &device->client_data_list, list)
 666                 if (context->client == client) {
 667                         ret = context->data;
 668                         break;
 669                 }
 670         spin_unlock_irqrestore(&device->client_data_lock, flags);
 671
 672         return ret;
 673 }
 674 EXPORT_SYMBOL(ib_get_client_data);
 675
 676 /**
 677  * ib_set_client_data - Set IB client context
 678  * @device:Device to set context for
 679  * @client:Client to set context for
 680  * @data:Context to set
 681  *
 682  * ib_set_client_data() sets client context that can be retrieved with
 683  * ib_get_client_data().
 684  */
 685 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
 686                         void *data)
 687 {
 688         struct ib_client_data *context;
 689         unsigned long flags;
 690
 691         spin_lock_irqsave(&device->client_data_lock, flags);
 692         list_for_each_entry(context, &device->client_data_list, list)
 693                 if (context->client == client) {
 694                         context->data = data;
 695                         goto out;
 696                 }
 697
 698         pr_warn("No client context found for %s/%s\n",
 699                 device->name, client->name);
 700
 701 out:
 702         spin_unlock_irqrestore(&device->client_data_lock, flags);
 703 }
 704 EXPORT_SYMBOL(ib_set_client_data);
 705
 706 /**
 707  * ib_register_event_handler - Register an IB event handler
 708  * @event_handler:Handler to register
 709  *
 710  * ib_register_event_handler() registers an event handler that will be
 711  * called back when asynchronous IB events occur (as defined in
 712  * chapter 11 of the InfiniBand Architecture Specification).  This
 713  * callback may occur in interrupt context.
 714  */
 715 int ib_register_event_handler  (struct ib_event_handler *event_handler)
 716 {
 717         unsigned long flags;
 718
 719         spin_lock_irqsave(&event_handler->device->event_handler_lock, flags);
 720         list_add_tail(&event_handler->list,
 721                       &event_handler->device->event_handler_list);
 722         spin_unlock_irqrestore(&event_handler->device->event_handler_lock, flags);
 723
 724         return 0;
 725 }
 726 EXPORT_SYMBOL(ib_register_event_handler);
 727
 728 /**
 729  * ib_unregister_event_handler - Unregister an event handler
 730  * @event_handler:Handler to unregister
 731  *
 732  * Unregister an event handler registered with
 733  * ib_register_event_handler().
 734  */
 735 int ib_unregister_event_handler(struct ib_event_handler *event_handler)
 736 {
 737         unsigned long flags;
 738
 739         spin_lock_irqsave(&event_handler->device->event_handler_lock, flags);
 740         list_del(&event_handler->list);
 741         spin_unlock_irqrestore(&event_handler->device->event_handler_lock, flags);
 742
 743         return 0;
 744 }
 745 EXPORT_SYMBOL(ib_unregister_event_handler);
 746
 747 /**
 748  * ib_dispatch_event - Dispatch an asynchronous event
 749  * @event:Event to dispatch
 750  *
 751  * Low-level drivers must call ib_dispatch_event() to dispatch the
 752  * event to all registered event handlers when an asynchronous event
 753  * occurs.
 754  */
 755 void ib_dispatch_event(struct ib_event *event)
 756 {
 757         unsigned long flags;
 758         struct ib_event_handler *handler;
 759
 760         spin_lock_irqsave(&event->device->event_handler_lock, flags);
 761
 762         list_for_each_entry(handler, &event->device->event_handler_list, list)
 763                 handler->handler(handler, event);
 764
 765         spin_unlock_irqrestore(&event->device->event_handler_lock, flags);
 766 }
 767 EXPORT_SYMBOL(ib_dispatch_event);
 768
 769 /**
 770  * ib_query_port - Query IB port attributes
 771  * @device:Device to query
 772  * @port_num:Port number to query
 773  * @port_attr:Port attributes
 774  *
 775  * ib_query_port() returns the attributes of a port through the
 776  * @port_attr pointer.
 777  */
 778 int ib_query_port(struct ib_device *device,
 779                   u8 port_num,
 780                   struct ib_port_attr *port_attr)
 781 {
 782         union ib_gid gid;
 783         int err;
 784
 785         if (!rdma_is_port_valid(device, port_num))
 786                 return -EINVAL;
 787
 788         memset(port_attr, 0, sizeof(*port_attr));
 789         err = device->query_port(device, port_num, port_attr);
 790         if (err || port_attr->subnet_prefix)
 791                 return err;
 792
 793         if (rdma_port_get_link_layer(device, port_num) != IB_LINK_LAYER_INFINIBAND)
 794                 return 0;
 795
 796         err = ib_query_gid(device, port_num, 0, &gid, NULL);
 797         if (err)
 798                 return err;
 799
 800         port_attr->subnet_prefix = be64_to_cpu(gid.global.subnet_prefix);
 801         return 0;
 802 }
 803 EXPORT_SYMBOL(ib_query_port);
 804
 805 /**
 806  * ib_query_gid - Get GID table entry
 807  * @device:Device to query
 808  * @port_num:Port number to query
 809  * @index:GID table index to query
 810  * @gid:Returned GID
 811  * @attr: Returned GID attributes related to this GID index (only in RoCE).
 812  *   NULL means ignore.
 813  *
 814  * ib_query_gid() fetches the specified GID table entry.
 815  */
 816 int ib_query_gid(struct ib_device *device,
 817                  u8 port_num, int index, union ib_gid *gid,
 818                  struct ib_gid_attr *attr)
 819 {
 820         if (rdma_cap_roce_gid_table(device, port_num))
 821                 return ib_get_cached_gid(device, port_num, index, gid, attr);
 822
 823         if (attr)
 824                 return -EINVAL;
 825
 826         return device->query_gid(device, port_num, index, gid);
 827 }
 828 EXPORT_SYMBOL(ib_query_gid);
 829
 830 /**
 831  * ib_enum_roce_netdev - enumerate all RoCE ports
 832  * @ib_dev : IB device we want to query
 833  * @filter: Should we call the callback?
 834  * @filter_cookie: Cookie passed to filter
 835  * @cb: Callback to call for each found RoCE ports
 836  * @cookie: Cookie passed back to the callback
 837  *
 838  * Enumerates all of the physical RoCE ports of ib_dev
 839  * which are related to netdevice and calls callback() on each
 840  * device for which filter() function returns non zero.
 841  */
 842 void ib_enum_roce_netdev(struct ib_device *ib_dev,
 843                          roce_netdev_filter filter,
 844                          void *filter_cookie,
 845                          roce_netdev_callback cb,
 846                          void *cookie)
 847 {
 848         u8 port;
 849
 850         for (port = rdma_start_port(ib_dev); port <= rdma_end_port(ib_dev);
 851              port++)
 852                 if (rdma_protocol_roce(ib_dev, port)) {
 853                         struct net_device *idev = NULL;
 854
 855                         if (ib_dev->get_netdev)
 856                                 idev = ib_dev->get_netdev(ib_dev, port);
 857
 858                         if (idev &&
 859                             idev->reg_state >= NETREG_UNREGISTERED) {
 860                                 dev_put(idev);
 861                                 idev = NULL;
 862                         }
 863
 864                         if (filter(ib_dev, port, idev, filter_cookie))
 865                                 cb(ib_dev, port, idev, cookie);
 866
 867                         if (idev)
 868                                 dev_put(idev);
 869                 }
 870 }
 871
 872 /**
 873  * ib_enum_all_roce_netdevs - enumerate all RoCE devices
 874  * @filter: Should we call the callback?
 875  * @filter_cookie: Cookie passed to filter
 876  * @cb: Callback to call for each found RoCE ports
 877  * @cookie: Cookie passed back to the callback
 878  *
 879  * Enumerates all RoCE devices' physical ports which are related
 880  * to netdevices and calls callback() on each device for which
 881  * filter() function returns non zero.
 882  */
 883 void ib_enum_all_roce_netdevs(roce_netdev_filter filter,
 884                               void *filter_cookie,
 885                               roce_netdev_callback cb,
 886                               void *cookie)
 887 {
 888         struct ib_device *dev;
 889
 890         down_read(&lists_rwsem);
 891         list_for_each_entry(dev, &device_list, core_list)
 892                 ib_enum_roce_netdev(dev, filter, filter_cookie, cb, cookie);
 893         up_read(&lists_rwsem);
 894 }
 895
 896 /**
 897  * ib_query_pkey - Get P_Key table entry
 898  * @device:Device to query
 899  * @port_num:Port number to query
 900  * @index:P_Key table index to query
 901  * @pkey:Returned P_Key
 902  *
 903  * ib_query_pkey() fetches the specified P_Key table entry.
 904  */
 905 int ib_query_pkey(struct ib_device *device,
 906                   u8 port_num, u16 index, u16 *pkey)
 907 {
 908         return device->query_pkey(device, port_num, index, pkey);
 909 }
 910 EXPORT_SYMBOL(ib_query_pkey);
 911
 912 /**
 913  * ib_modify_device - Change IB device attributes
 914  * @device:Device to modify
 915  * @device_modify_mask:Mask of attributes to change
 916  * @device_modify:New attribute values
 917  *
 918  * ib_modify_device() changes a device's attributes as specified by
 919  * the @device_modify_mask and @device_modify structure.
 920  */
 921 int ib_modify_device(struct ib_device *device,
 922                      int device_modify_mask,
 923                      struct ib_device_modify *device_modify)
 924 {
 925         if (!device->modify_device)
 926                 return -ENOSYS;
 927
 928         return device->modify_device(device, device_modify_mask,
 929                                      device_modify);
 930 }
 931 EXPORT_SYMBOL(ib_modify_device);
 932
 933 /**
 934  * ib_modify_port - Modifies the attributes for the specified port.
 935  * @device: The device to modify.
 936  * @port_num: The number of the port to modify.
 937  * @port_modify_mask: Mask used to specify which attributes of the port
 938  *   to change.
 939  * @port_modify: New attribute values for the port.
 940  *
 941  * ib_modify_port() changes a port's attributes as specified by the
 942  * @port_modify_mask and @port_modify structure.
 943  */
 944 int ib_modify_port(struct ib_device *device,
 945                    u8 port_num, int port_modify_mask,
 946                    struct ib_port_modify *port_modify)
 947 {
 948         if (!device->modify_port)
 949                 return -ENOSYS;
 950
 951         if (!rdma_is_port_valid(device, port_num))
 952                 return -EINVAL;
 953
 954         return device->modify_port(device, port_num, port_modify_mask,
 955                                    port_modify);
 956 }
 957 EXPORT_SYMBOL(ib_modify_port);
 958
 959 /**
 960  * ib_find_gid - Returns the port number and GID table index where
 961  *   a specified GID value occurs.
 962  * @device: The device to query.
 963  * @gid: The GID value to search for.
 964  * @gid_type: Type of GID.
 965  * @ndev: The ndev related to the GID to search for.
 966  * @port_num: The port number of the device where the GID value was found.
 967  * @index: The index into the GID table where the GID was found.  This
 968  *   parameter may be NULL.
 969  */
 970 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
 971                 enum ib_gid_type gid_type, struct net_device *ndev,
 972                 u8 *port_num, u16 *index)
 973 {
 974         union ib_gid tmp_gid;
 975         int ret, port, i;
 976
 977         for (port = rdma_start_port(device); port <= rdma_end_port(device); ++port) {
 978                 if (rdma_cap_roce_gid_table(device, port)) {
 979                         if (!ib_find_cached_gid_by_port(device, gid, gid_type, port,
 980                                                         ndev, index)) {
 981                                 *port_num = port;
 982                                 return 0;
 983                         }
 984                 }
 985
 986                 if (gid_type != IB_GID_TYPE_IB)
 987                         continue;
 988
 989                 for (i = 0; i < device->port_immutable[port].gid_tbl_len; ++i) {
 990                         ret = ib_query_gid(device, port, i, &tmp_gid, NULL);
 991                         if (ret)
 992                                 return ret;
 993                         if (!memcmp(&tmp_gid, gid, sizeof *gid)) {
 994                                 *port_num = port;
 995                                 if (index)
 996                                         *index = i;
 997                                 return 0;
 998                         }
 999                 }
1000         }
1001
1002         return -ENOENT;
1003 }
1004 EXPORT_SYMBOL(ib_find_gid);
1005
1006 /**
1007  * ib_find_pkey - Returns the PKey table index where a specified
1008  *   PKey value occurs.
1009  * @device: The device to query.
1010  * @port_num: The port number of the device to search for the PKey.
1011  * @pkey: The PKey value to search for.
1012  * @index: The index into the PKey table where the PKey was found.
1013  */
1014 int ib_find_pkey(struct ib_device *device,
1015                  u8 port_num, u16 pkey, u16 *index)
1016 {
1017         int ret, i;
1018         u16 tmp_pkey;
1019         int partial_ix = -1;
1020
1021         for (i = 0; i < device->port_immutable[port_num].pkey_tbl_len; ++i) {
1022                 ret = ib_query_pkey(device, port_num, i, &tmp_pkey);
1023                 if (ret)
1024                         return ret;
1025                 if ((pkey & 0x7fff) == (tmp_pkey & 0x7fff)) {
1026                         /* if there is full-member pkey take it.*/
1027                         if (tmp_pkey & 0x8000) {
1028                                 *index = i;
1029                                 return 0;
1030                         }
1031                         if (partial_ix < 0)
1032                                 partial_ix = i;
1033                 }
1034         }
1035
1036         /*no full-member, if exists take the limited*/
1037         if (partial_ix >= 0) {
1038                 *index = partial_ix;
1039                 return 0;
1040         }
1041         return -ENOENT;
1042 }
1043 EXPORT_SYMBOL(ib_find_pkey);
1044
1045 /**
1046  * ib_get_net_dev_by_params() - Return the appropriate net_dev
1047  * for a received CM request
1048  * @dev:        An RDMA device on which the request has been received.
1049  * @port:       Port number on the RDMA device.
1050  * @pkey:       The Pkey the request came on.
1051  * @gid:        A GID that the net_dev uses to communicate.
1052  * @addr:       Contains the IP address that the request specified as its
1053  *              destination.
1054  */
1055 struct net_device *ib_get_net_dev_by_params(struct ib_device *dev,
1056                                             u8 port,
1057                                             u16 pkey,
1058                                             const union ib_gid *gid,
1059                                             const struct sockaddr *addr)
1060 {
1061         struct net_device *net_dev = NULL;
1062         struct ib_client_data *context;
1063
1064         if (!rdma_protocol_ib(dev, port))
1065                 return NULL;
1066
1067         down_read(&lists_rwsem);
1068
1069         list_for_each_entry(context, &dev->client_data_list, list) {
1070                 struct ib_client *client = context->client;
1071
1072                 if (context->going_down)
1073                         continue;
1074
1075                 if (client->get_net_dev_by_params) {
1076                         net_dev = client->get_net_dev_by_params(dev, port, pkey,
1077                                                                 gid, addr,
1078                                                                 context->data);
1079                         if (net_dev)
1080                                 break;
1081                 }
1082         }
1083
1084         up_read(&lists_rwsem);
1085
1086         return net_dev;
1087 }
1088 EXPORT_SYMBOL(ib_get_net_dev_by_params);
1089
1090 static struct ibnl_client_cbs ibnl_ls_cb_table[] = {
1091         [RDMA_NL_LS_OP_RESOLVE] = {
1092                 .dump = ib_nl_handle_resolve_resp,
1093                 .module = THIS_MODULE },
1094         [RDMA_NL_LS_OP_SET_TIMEOUT] = {
1095                 .dump = ib_nl_handle_set_timeout,
1096                 .module = THIS_MODULE },
1097         [RDMA_NL_LS_OP_IP_RESOLVE] = {
1098                 .dump = ib_nl_handle_ip_res_resp,
1099                 .module = THIS_MODULE },
1100 };
1101
1102 static int ib_add_ibnl_clients(void)
1103 {
1104         return ibnl_add_client(RDMA_NL_LS, ARRAY_SIZE(ibnl_ls_cb_table),
1105                                ibnl_ls_cb_table);
1106 }
1107
1108 static void ib_remove_ibnl_clients(void)
1109 {
1110         ibnl_remove_client(RDMA_NL_LS);
1111 }
1112
1113 static int __init ib_core_init(void)
1114 {
1115         int ret;
1116
1117         ib_wq = alloc_workqueue("infiniband", 0, 0);
1118         if (!ib_wq)
1119                 return -ENOMEM;
1120
1121         ib_comp_wq = alloc_workqueue("ib-comp-wq",
1122                         WQ_HIGHPRI | WQ_MEM_RECLAIM | WQ_SYSFS, 0);
1123         if (!ib_comp_wq) {
1124                 ret = -ENOMEM;
1125                 goto err;
1126         }
1127
1128         ret = class_register(&ib_class);
1129         if (ret) {
1130                 pr_warn("Couldn't create InfiniBand device class\n");
1131                 goto err_comp;
1132         }
1133
1134         ret = ibnl_init();
1135         if (ret) {
1136                 pr_warn("Couldn't init IB netlink interface\n");
1137                 goto err_sysfs;
1138         }
1139
1140         ret = addr_init();
1141         if (ret) {
1142                 pr_warn("Could't init IB address resolution\n");
1143                 goto err_ibnl;
1144         }
1145
1146         ret = ib_mad_init();
1147         if (ret) {
1148                 pr_warn("Couldn't init IB MAD\n");
1149                 goto err_addr;
1150         }
1151
1152         ret = ib_sa_init();
1153         if (ret) {
1154                 pr_warn("Couldn't init SA\n");
1155                 goto err_mad;
1156         }
1157
1158         ret = ib_add_ibnl_clients();
1159         if (ret) {
1160                 pr_warn("Couldn't register ibnl clients\n");
1161                 goto err_sa;
1162         }
1163
1164         ret = register_lsm_notifier(&ibdev_lsm_nb);
1165         if (ret) {
1166                 pr_warn("Couldn't register LSM notifier. ret %d\n", ret);
1167                 goto err_ibnl_clients;
1168         }
1169
1170         ib_cache_setup();
1171
1172         return 0;
1173
1174 err_ibnl_clients:
1175         ib_remove_ibnl_clients();
1176 err_sa:
1177         ib_sa_cleanup();
1178 err_mad:
1179         ib_mad_cleanup();
1180 err_addr:
1181         addr_cleanup();
1182 err_ibnl:
1183         ibnl_cleanup();
1184 err_sysfs:
1185         class_unregister(&ib_class);
1186 err_comp:
1187         destroy_workqueue(ib_comp_wq);
1188 err:
1189         destroy_workqueue(ib_wq);
1190         return ret;
1191 }
1192
1193 static void __exit ib_core_cleanup(void)
1194 {
1195         unregister_lsm_notifier(&ibdev_lsm_nb);
1196         ib_cache_cleanup();
1197         ib_remove_ibnl_clients();
1198         ib_sa_cleanup();
1199         ib_mad_cleanup();
1200         addr_cleanup();
1201         ibnl_cleanup();
1202         class_unregister(&ib_class);
1203         destroy_workqueue(ib_comp_wq);
1204         /* Make sure that any pending umem accounting work is done. */
1205         destroy_workqueue(ib_wq);
1206 }
1207
1208 module_init(ib_core_init);
1209 module_exit(ib_core_cleanup);