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