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  * $Id: device.c 1349 2004-12-16 21:09:43Z roland $
  34  */
  35
  36 #include <linux/module.h>
  37 #include <linux/string.h>
  38 #include <linux/errno.h>
  39 #include <linux/slab.h>
  40 #include <linux/init.h>
  41 #include <linux/mutex.h>
  42
  43 #include "core_priv.h"
  44
  45 MODULE_AUTHOR("Roland Dreier");
  46 MODULE_DESCRIPTION("core kernel InfiniBand API");
  47 MODULE_LICENSE("Dual BSD/GPL");
  48
  49 struct ib_client_data {
  50         struct list_head  list;
  51         struct ib_client *client;
  52         void *            data;
  53 };
  54
  55 static LIST_HEAD(device_list);
  56 static LIST_HEAD(client_list);
  57
  58 /*
  59  * device_mutex protects access to both device_list and client_list.
  60  * There's no real point to using multiple locks or something fancier
  61  * like an rwsem: we always access both lists, and we're always
  62  * modifying one list or the other list.  In any case this is not a
  63  * hot path so there's no point in trying to optimize.
  64  */
  65 static DEFINE_MUTEX(device_mutex);
  66
  67 static int ib_device_check_mandatory(struct ib_device *device)
  68 {
  69 #define IB_MANDATORY_FUNC(x) { offsetof(struct ib_device, x), #x }
  70         static const struct {
  71                 size_t offset;
  72                 char  *name;
  73         } mandatory_table[] = {
  74                 IB_MANDATORY_FUNC(query_device),
  75                 IB_MANDATORY_FUNC(query_port),
  76                 IB_MANDATORY_FUNC(query_pkey),
  77                 IB_MANDATORY_FUNC(query_gid),
  78                 IB_MANDATORY_FUNC(alloc_pd),
  79                 IB_MANDATORY_FUNC(dealloc_pd),
  80                 IB_MANDATORY_FUNC(create_ah),
  81                 IB_MANDATORY_FUNC(destroy_ah),
  82                 IB_MANDATORY_FUNC(create_qp),
  83                 IB_MANDATORY_FUNC(modify_qp),
  84                 IB_MANDATORY_FUNC(destroy_qp),
  85                 IB_MANDATORY_FUNC(post_send),
  86                 IB_MANDATORY_FUNC(post_recv),
  87                 IB_MANDATORY_FUNC(create_cq),
  88                 IB_MANDATORY_FUNC(destroy_cq),
  89                 IB_MANDATORY_FUNC(poll_cq),
  90                 IB_MANDATORY_FUNC(req_notify_cq),
  91                 IB_MANDATORY_FUNC(get_dma_mr),
  92                 IB_MANDATORY_FUNC(dereg_mr)
  93         };
  94         int i;
  95
  96         for (i = 0; i < sizeof mandatory_table / sizeof mandatory_table[0]; ++i) {
  97                 if (!*(void **) ((void *) device + mandatory_table[i].offset)) {
  98                         printk(KERN_WARNING "Device %s is missing mandatory function %s\n",
  99                                device->name, mandatory_table[i].name);
 100                         return -EINVAL;
 101                 }
 102         }
 103
 104         return 0;
 105 }
 106
 107 static struct ib_device *__ib_device_get_by_name(const char *name)
 108 {
 109         struct ib_device *device;
 110
 111         list_for_each_entry(device, &device_list, core_list)
 112                 if (!strncmp(name, device->name, IB_DEVICE_NAME_MAX))
 113                         return device;
 114
 115         return NULL;
 116 }
 117
 118
 119 static int alloc_name(char *name)
 120 {
 121         long *inuse;
 122         char buf[IB_DEVICE_NAME_MAX];
 123         struct ib_device *device;
 124         int i;
 125
 126         inuse = (long *) get_zeroed_page(GFP_KERNEL);
 127         if (!inuse)
 128                 return -ENOMEM;
 129
 130         list_for_each_entry(device, &device_list, core_list) {
 131                 if (!sscanf(device->name, name, &i))
 132                         continue;
 133                 if (i < 0 || i >= PAGE_SIZE * 8)
 134                         continue;
 135                 snprintf(buf, sizeof buf, name, i);
 136                 if (!strncmp(buf, device->name, IB_DEVICE_NAME_MAX))
 137                         set_bit(i, inuse);
 138         }
 139
 140         i = find_first_zero_bit(inuse, PAGE_SIZE * 8);
 141         free_page((unsigned long) inuse);
 142         snprintf(buf, sizeof buf, name, i);
 143
 144         if (__ib_device_get_by_name(buf))
 145                 return -ENFILE;
 146
 147         strlcpy(name, buf, IB_DEVICE_NAME_MAX);
 148         return 0;
 149 }
 150
 151 /**
 152  * ib_alloc_device - allocate an IB device struct
 153  * @size:size of structure to allocate
 154  *
 155  * Low-level drivers should use ib_alloc_device() to allocate &struct
 156  * ib_device.  @size is the size of the structure to be allocated,
 157  * including any private data used by the low-level driver.
 158  * ib_dealloc_device() must be used to free structures allocated with
 159  * ib_alloc_device().
 160  */
 161 struct ib_device *ib_alloc_device(size_t size)
 162 {
 163         BUG_ON(size < sizeof (struct ib_device));
 164
 165         return kzalloc(size, GFP_KERNEL);
 166 }
 167 EXPORT_SYMBOL(ib_alloc_device);
 168
 169 /**
 170  * ib_dealloc_device - free an IB device struct
 171  * @device:structure to free
 172  *
 173  * Free a structure allocated with ib_alloc_device().
 174  */
 175 void ib_dealloc_device(struct ib_device *device)
 176 {
 177         if (device->reg_state == IB_DEV_UNINITIALIZED) {
 178                 kfree(device);
 179                 return;
 180         }
 181
 182         BUG_ON(device->reg_state != IB_DEV_UNREGISTERED);
 183
 184         ib_device_unregister_sysfs(device);
 185 }
 186 EXPORT_SYMBOL(ib_dealloc_device);
 187
 188 static int add_client_context(struct ib_device *device, struct ib_client *client)
 189 {
 190         struct ib_client_data *context;
 191         unsigned long flags;
 192
 193         context = kmalloc(sizeof *context, GFP_KERNEL);
 194         if (!context) {
 195                 printk(KERN_WARNING "Couldn't allocate client context for %s/%s\n",
 196                        device->name, client->name);
 197                 return -ENOMEM;
 198         }
 199
 200         context->client = client;
 201         context->data   = NULL;
 202
 203         spin_lock_irqsave(&device->client_data_lock, flags);
 204         list_add(&context->list, &device->client_data_list);
 205         spin_unlock_irqrestore(&device->client_data_lock, flags);
 206
 207         return 0;
 208 }
 209
 210 /**
 211  * ib_register_device - Register an IB device with IB core
 212  * @device:Device to register
 213  *
 214  * Low-level drivers use ib_register_device() to register their
 215  * devices with the IB core.  All registered clients will receive a
 216  * callback for each device that is added. @device must be allocated
 217  * with ib_alloc_device().
 218  */
 219 int ib_register_device(struct ib_device *device)
 220 {
 221         int ret;
 222
 223         mutex_lock(&device_mutex);
 224
 225         if (strchr(device->name, '%')) {
 226                 ret = alloc_name(device->name);
 227                 if (ret)
 228                         goto out;
 229         }
 230
 231         if (ib_device_check_mandatory(device)) {
 232                 ret = -EINVAL;
 233                 goto out;
 234         }
 235
 236         INIT_LIST_HEAD(&device->event_handler_list);
 237         INIT_LIST_HEAD(&device->client_data_list);
 238         spin_lock_init(&device->event_handler_lock);
 239         spin_lock_init(&device->client_data_lock);
 240
 241         ret = ib_device_register_sysfs(device);
 242         if (ret) {
 243                 printk(KERN_WARNING "Couldn't register device %s with driver model\n",
 244                        device->name);
 245                 goto out;
 246         }
 247
 248         list_add_tail(&device->core_list, &device_list);
 249
 250         device->reg_state = IB_DEV_REGISTERED;
 251
 252         {
 253                 struct ib_client *client;
 254
 255                 list_for_each_entry(client, &client_list, list)
 256                         if (client->add && !add_client_context(device, client))
 257                                 client->add(device);
 258         }
 259
 260  out:
 261         mutex_unlock(&device_mutex);
 262         return ret;
 263 }
 264 EXPORT_SYMBOL(ib_register_device);
 265
 266 /**
 267  * ib_unregister_device - Unregister an IB device
 268  * @device:Device to unregister
 269  *
 270  * Unregister an IB device.  All clients will receive a remove callback.
 271  */
 272 void ib_unregister_device(struct ib_device *device)
 273 {
 274         struct ib_client *client;
 275         struct ib_client_data *context, *tmp;
 276         unsigned long flags;
 277
 278         mutex_lock(&device_mutex);
 279
 280         list_for_each_entry_reverse(client, &client_list, list)
 281                 if (client->remove)
 282                         client->remove(device);
 283
 284         list_del(&device->core_list);
 285
 286         mutex_unlock(&device_mutex);
 287
 288         spin_lock_irqsave(&device->client_data_lock, flags);
 289         list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
 290                 kfree(context);
 291         spin_unlock_irqrestore(&device->client_data_lock, flags);
 292
 293         device->reg_state = IB_DEV_UNREGISTERED;
 294 }
 295 EXPORT_SYMBOL(ib_unregister_device);
 296
 297 /**
 298  * ib_register_client - Register an IB client
 299  * @client:Client to register
 300  *
 301  * Upper level users of the IB drivers can use ib_register_client() to
 302  * register callbacks for IB device addition and removal.  When an IB
 303  * device is added, each registered client's add method will be called
 304  * (in the order the clients were registered), and when a device is
 305  * removed, each client's remove method will be called (in the reverse
 306  * order that clients were registered).  In addition, when
 307  * ib_register_client() is called, the client will receive an add
 308  * callback for all devices already registered.
 309  */
 310 int ib_register_client(struct ib_client *client)
 311 {
 312         struct ib_device *device;
 313
 314         mutex_lock(&device_mutex);
 315
 316         list_add_tail(&client->list, &client_list);
 317         list_for_each_entry(device, &device_list, core_list)
 318                 if (client->add && !add_client_context(device, client))
 319                         client->add(device);
 320
 321         mutex_unlock(&device_mutex);
 322
 323         return 0;
 324 }
 325 EXPORT_SYMBOL(ib_register_client);
 326
 327 /**
 328  * ib_unregister_client - Unregister an IB client
 329  * @client:Client to unregister
 330  *
 331  * Upper level users use ib_unregister_client() to remove their client
 332  * registration.  When ib_unregister_client() is called, the client
 333  * will receive a remove callback for each IB device still registered.
 334  */
 335 void ib_unregister_client(struct ib_client *client)
 336 {
 337         struct ib_client_data *context, *tmp;
 338         struct ib_device *device;
 339         unsigned long flags;
 340
 341         mutex_lock(&device_mutex);
 342
 343         list_for_each_entry(device, &device_list, core_list) {
 344                 if (client->remove)
 345                         client->remove(device);
 346
 347                 spin_lock_irqsave(&device->client_data_lock, flags);
 348                 list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
 349                         if (context->client == client) {
 350                                 list_del(&context->list);
 351                                 kfree(context);
 352                         }
 353                 spin_unlock_irqrestore(&device->client_data_lock, flags);
 354         }
 355         list_del(&client->list);
 356
 357         mutex_unlock(&device_mutex);
 358 }
 359 EXPORT_SYMBOL(ib_unregister_client);
 360
 361 /**
 362  * ib_get_client_data - Get IB client context
 363  * @device:Device to get context for
 364  * @client:Client to get context for
 365  *
 366  * ib_get_client_data() returns client context set with
 367  * ib_set_client_data().
 368  */
 369 void *ib_get_client_data(struct ib_device *device, struct ib_client *client)
 370 {
 371         struct ib_client_data *context;
 372         void *ret = NULL;
 373         unsigned long flags;
 374
 375         spin_lock_irqsave(&device->client_data_lock, flags);
 376         list_for_each_entry(context, &device->client_data_list, list)
 377                 if (context->client == client) {
 378                         ret = context->data;
 379                         break;
 380                 }
 381         spin_unlock_irqrestore(&device->client_data_lock, flags);
 382
 383         return ret;
 384 }
 385 EXPORT_SYMBOL(ib_get_client_data);
 386
 387 /**
 388  * ib_set_client_data - Set IB client context
 389  * @device:Device to set context for
 390  * @client:Client to set context for
 391  * @data:Context to set
 392  *
 393  * ib_set_client_data() sets client context that can be retrieved with
 394  * ib_get_client_data().
 395  */
 396 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
 397                         void *data)
 398 {
 399         struct ib_client_data *context;
 400         unsigned long flags;
 401
 402         spin_lock_irqsave(&device->client_data_lock, flags);
 403         list_for_each_entry(context, &device->client_data_list, list)
 404                 if (context->client == client) {
 405                         context->data = data;
 406                         goto out;
 407                 }
 408
 409         printk(KERN_WARNING "No client context found for %s/%s\n",
 410                device->name, client->name);
 411
 412 out:
 413         spin_unlock_irqrestore(&device->client_data_lock, flags);
 414 }
 415 EXPORT_SYMBOL(ib_set_client_data);
 416
 417 /**
 418  * ib_register_event_handler - Register an IB event handler
 419  * @event_handler:Handler to register
 420  *
 421  * ib_register_event_handler() registers an event handler that will be
 422  * called back when asynchronous IB events occur (as defined in
 423  * chapter 11 of the InfiniBand Architecture Specification).  This
 424  * callback may occur in interrupt context.
 425  */
 426 int ib_register_event_handler  (struct ib_event_handler *event_handler)
 427 {
 428         unsigned long flags;
 429
 430         spin_lock_irqsave(&event_handler->device->event_handler_lock, flags);
 431         list_add_tail(&event_handler->list,
 432                       &event_handler->device->event_handler_list);
 433         spin_unlock_irqrestore(&event_handler->device->event_handler_lock, flags);
 434
 435         return 0;
 436 }
 437 EXPORT_SYMBOL(ib_register_event_handler);
 438
 439 /**
 440  * ib_unregister_event_handler - Unregister an event handler
 441  * @event_handler:Handler to unregister
 442  *
 443  * Unregister an event handler registered with
 444  * ib_register_event_handler().
 445  */
 446 int ib_unregister_event_handler(struct ib_event_handler *event_handler)
 447 {
 448         unsigned long flags;
 449
 450         spin_lock_irqsave(&event_handler->device->event_handler_lock, flags);
 451         list_del(&event_handler->list);
 452         spin_unlock_irqrestore(&event_handler->device->event_handler_lock, flags);
 453
 454         return 0;
 455 }
 456 EXPORT_SYMBOL(ib_unregister_event_handler);
 457
 458 /**
 459  * ib_dispatch_event - Dispatch an asynchronous event
 460  * @event:Event to dispatch
 461  *
 462  * Low-level drivers must call ib_dispatch_event() to dispatch the
 463  * event to all registered event handlers when an asynchronous event
 464  * occurs.
 465  */
 466 void ib_dispatch_event(struct ib_event *event)
 467 {
 468         unsigned long flags;
 469         struct ib_event_handler *handler;
 470
 471         spin_lock_irqsave(&event->device->event_handler_lock, flags);
 472
 473         list_for_each_entry(handler, &event->device->event_handler_list, list)
 474                 handler->handler(handler, event);
 475
 476         spin_unlock_irqrestore(&event->device->event_handler_lock, flags);
 477 }
 478 EXPORT_SYMBOL(ib_dispatch_event);
 479
 480 /**
 481  * ib_query_device - Query IB device attributes
 482  * @device:Device to query
 483  * @device_attr:Device attributes
 484  *
 485  * ib_query_device() returns the attributes of a device through the
 486  * @device_attr pointer.
 487  */
 488 int ib_query_device(struct ib_device *device,
 489                     struct ib_device_attr *device_attr)
 490 {
 491         return device->query_device(device, device_attr);
 492 }
 493 EXPORT_SYMBOL(ib_query_device);
 494
 495 /**
 496  * ib_query_port - Query IB port attributes
 497  * @device:Device to query
 498  * @port_num:Port number to query
 499  * @port_attr:Port attributes
 500  *
 501  * ib_query_port() returns the attributes of a port through the
 502  * @port_attr pointer.
 503  */
 504 int ib_query_port(struct ib_device *device,
 505                   u8 port_num,
 506                   struct ib_port_attr *port_attr)
 507 {
 508         if (device->node_type == RDMA_NODE_IB_SWITCH) {
 509                 if (port_num)
 510                         return -EINVAL;
 511         } else if (port_num < 1 || port_num > device->phys_port_cnt)
 512                 return -EINVAL;
 513
 514         return device->query_port(device, port_num, port_attr);
 515 }
 516 EXPORT_SYMBOL(ib_query_port);
 517
 518 /**
 519  * ib_query_gid - Get GID table entry
 520  * @device:Device to query
 521  * @port_num:Port number to query
 522  * @index:GID table index to query
 523  * @gid:Returned GID
 524  *
 525  * ib_query_gid() fetches the specified GID table entry.
 526  */
 527 int ib_query_gid(struct ib_device *device,
 528                  u8 port_num, int index, union ib_gid *gid)
 529 {
 530         return device->query_gid(device, port_num, index, gid);
 531 }
 532 EXPORT_SYMBOL(ib_query_gid);
 533
 534 /**
 535  * ib_query_pkey - Get P_Key table entry
 536  * @device:Device to query
 537  * @port_num:Port number to query
 538  * @index:P_Key table index to query
 539  * @pkey:Returned P_Key
 540  *
 541  * ib_query_pkey() fetches the specified P_Key table entry.
 542  */
 543 int ib_query_pkey(struct ib_device *device,
 544                   u8 port_num, u16 index, u16 *pkey)
 545 {
 546         return device->query_pkey(device, port_num, index, pkey);
 547 }
 548 EXPORT_SYMBOL(ib_query_pkey);
 549
 550 /**
 551  * ib_modify_device - Change IB device attributes
 552  * @device:Device to modify
 553  * @device_modify_mask:Mask of attributes to change
 554  * @device_modify:New attribute values
 555  *
 556  * ib_modify_device() changes a device's attributes as specified by
 557  * the @device_modify_mask and @device_modify structure.
 558  */
 559 int ib_modify_device(struct ib_device *device,
 560                      int device_modify_mask,
 561                      struct ib_device_modify *device_modify)
 562 {
 563         return device->modify_device(device, device_modify_mask,
 564                                      device_modify);
 565 }
 566 EXPORT_SYMBOL(ib_modify_device);
 567
 568 /**
 569  * ib_modify_port - Modifies the attributes for the specified port.
 570  * @device: The device to modify.
 571  * @port_num: The number of the port to modify.
 572  * @port_modify_mask: Mask used to specify which attributes of the port
 573  *   to change.
 574  * @port_modify: New attribute values for the port.
 575  *
 576  * ib_modify_port() changes a port's attributes as specified by the
 577  * @port_modify_mask and @port_modify structure.
 578  */
 579 int ib_modify_port(struct ib_device *device,
 580                    u8 port_num, int port_modify_mask,
 581                    struct ib_port_modify *port_modify)
 582 {
 583         if (device->node_type == RDMA_NODE_IB_SWITCH) {
 584                 if (port_num)
 585                         return -EINVAL;
 586         } else if (port_num < 1 || port_num > device->phys_port_cnt)
 587                 return -EINVAL;
 588
 589         return device->modify_port(device, port_num, port_modify_mask,
 590                                    port_modify);
 591 }
 592 EXPORT_SYMBOL(ib_modify_port);
 593
 594 static int __init ib_core_init(void)
 595 {
 596         int ret;
 597
 598         ret = ib_sysfs_setup();
 599         if (ret)
 600                 printk(KERN_WARNING "Couldn't create InfiniBand device class\n");
 601
 602         ret = ib_cache_setup();
 603         if (ret) {
 604                 printk(KERN_WARNING "Couldn't set up InfiniBand P_Key/GID cache\n");
 605                 ib_sysfs_cleanup();
 606         }
 607
 608         return ret;
 609 }
 610
 611 static void __exit ib_core_cleanup(void)
 612 {
 613         ib_cache_cleanup();
 614         ib_sysfs_cleanup();
 615 }
 616
 617 module_init(ib_core_init);
 618 module_exit(ib_core_cleanup);