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