2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
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:
11 * Redistribution and use in source and binary forms, with or
12 * without modification, are permitted provided that the following
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
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.
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
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 <rdma/rdma_netlink.h>
43 #include "core_priv.h"
45 MODULE_AUTHOR("Roland Dreier");
46 MODULE_DESCRIPTION("core kernel InfiniBand API");
47 MODULE_LICENSE("Dual BSD/GPL");
49 struct ib_client_data
{
50 struct list_head list
;
51 struct ib_client
*client
;
55 struct workqueue_struct
*ib_wq
;
56 EXPORT_SYMBOL_GPL(ib_wq
);
58 static LIST_HEAD(device_list
);
59 static LIST_HEAD(client_list
);
62 * device_mutex protects access to both device_list and client_list.
63 * There's no real point to using multiple locks or something fancier
64 * like an rwsem: we always access both lists, and we're always
65 * modifying one list or the other list. In any case this is not a
66 * hot path so there's no point in trying to optimize.
68 static DEFINE_MUTEX(device_mutex
);
70 static int ib_device_check_mandatory(struct ib_device
*device
)
72 #define IB_MANDATORY_FUNC(x) { offsetof(struct ib_device, x), #x }
76 } mandatory_table
[] = {
77 IB_MANDATORY_FUNC(query_device
),
78 IB_MANDATORY_FUNC(query_port
),
79 IB_MANDATORY_FUNC(query_pkey
),
80 IB_MANDATORY_FUNC(query_gid
),
81 IB_MANDATORY_FUNC(alloc_pd
),
82 IB_MANDATORY_FUNC(dealloc_pd
),
83 IB_MANDATORY_FUNC(create_ah
),
84 IB_MANDATORY_FUNC(destroy_ah
),
85 IB_MANDATORY_FUNC(create_qp
),
86 IB_MANDATORY_FUNC(modify_qp
),
87 IB_MANDATORY_FUNC(destroy_qp
),
88 IB_MANDATORY_FUNC(post_send
),
89 IB_MANDATORY_FUNC(post_recv
),
90 IB_MANDATORY_FUNC(create_cq
),
91 IB_MANDATORY_FUNC(destroy_cq
),
92 IB_MANDATORY_FUNC(poll_cq
),
93 IB_MANDATORY_FUNC(req_notify_cq
),
94 IB_MANDATORY_FUNC(get_dma_mr
),
95 IB_MANDATORY_FUNC(dereg_mr
)
99 for (i
= 0; i
< ARRAY_SIZE(mandatory_table
); ++i
) {
100 if (!*(void **) ((void *) device
+ mandatory_table
[i
].offset
)) {
101 printk(KERN_WARNING
"Device %s is missing mandatory function %s\n",
102 device
->name
, mandatory_table
[i
].name
);
110 static struct ib_device
*__ib_device_get_by_name(const char *name
)
112 struct ib_device
*device
;
114 list_for_each_entry(device
, &device_list
, core_list
)
115 if (!strncmp(name
, device
->name
, IB_DEVICE_NAME_MAX
))
122 static int alloc_name(char *name
)
124 unsigned long *inuse
;
125 char buf
[IB_DEVICE_NAME_MAX
];
126 struct ib_device
*device
;
129 inuse
= (unsigned long *) get_zeroed_page(GFP_KERNEL
);
133 list_for_each_entry(device
, &device_list
, core_list
) {
134 if (!sscanf(device
->name
, name
, &i
))
136 if (i
< 0 || i
>= PAGE_SIZE
* 8)
138 snprintf(buf
, sizeof buf
, name
, i
);
139 if (!strncmp(buf
, device
->name
, IB_DEVICE_NAME_MAX
))
143 i
= find_first_zero_bit(inuse
, PAGE_SIZE
* 8);
144 free_page((unsigned long) inuse
);
145 snprintf(buf
, sizeof buf
, name
, i
);
147 if (__ib_device_get_by_name(buf
))
150 strlcpy(name
, buf
, IB_DEVICE_NAME_MAX
);
154 static int start_port(struct ib_device
*device
)
156 return (device
->node_type
== RDMA_NODE_IB_SWITCH
) ? 0 : 1;
160 static int end_port(struct ib_device
*device
)
162 return (device
->node_type
== RDMA_NODE_IB_SWITCH
) ?
163 0 : device
->phys_port_cnt
;
167 * ib_alloc_device - allocate an IB device struct
168 * @size:size of structure to allocate
170 * Low-level drivers should use ib_alloc_device() to allocate &struct
171 * ib_device. @size is the size of the structure to be allocated,
172 * including any private data used by the low-level driver.
173 * ib_dealloc_device() must be used to free structures allocated with
176 struct ib_device
*ib_alloc_device(size_t size
)
178 BUG_ON(size
< sizeof (struct ib_device
));
180 return kzalloc(size
, GFP_KERNEL
);
182 EXPORT_SYMBOL(ib_alloc_device
);
185 * ib_dealloc_device - free an IB device struct
186 * @device:structure to free
188 * Free a structure allocated with ib_alloc_device().
190 void ib_dealloc_device(struct ib_device
*device
)
192 if (device
->reg_state
== IB_DEV_UNINITIALIZED
) {
197 BUG_ON(device
->reg_state
!= IB_DEV_UNREGISTERED
);
199 kobject_put(&device
->dev
.kobj
);
201 EXPORT_SYMBOL(ib_dealloc_device
);
203 static int add_client_context(struct ib_device
*device
, struct ib_client
*client
)
205 struct ib_client_data
*context
;
208 context
= kmalloc(sizeof *context
, GFP_KERNEL
);
210 printk(KERN_WARNING
"Couldn't allocate client context for %s/%s\n",
211 device
->name
, client
->name
);
215 context
->client
= client
;
216 context
->data
= NULL
;
218 spin_lock_irqsave(&device
->client_data_lock
, flags
);
219 list_add(&context
->list
, &device
->client_data_list
);
220 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
225 static int read_port_table_lengths(struct ib_device
*device
)
227 struct ib_port_attr
*tprops
= NULL
;
228 int num_ports
, ret
= -ENOMEM
;
231 tprops
= kmalloc(sizeof *tprops
, GFP_KERNEL
);
235 num_ports
= end_port(device
) - start_port(device
) + 1;
237 device
->pkey_tbl_len
= kmalloc(sizeof *device
->pkey_tbl_len
* num_ports
,
239 device
->gid_tbl_len
= kmalloc(sizeof *device
->gid_tbl_len
* num_ports
,
241 if (!device
->pkey_tbl_len
|| !device
->gid_tbl_len
)
244 for (port_index
= 0; port_index
< num_ports
; ++port_index
) {
245 ret
= ib_query_port(device
, port_index
+ start_port(device
),
249 device
->pkey_tbl_len
[port_index
] = tprops
->pkey_tbl_len
;
250 device
->gid_tbl_len
[port_index
] = tprops
->gid_tbl_len
;
257 kfree(device
->gid_tbl_len
);
258 kfree(device
->pkey_tbl_len
);
265 * ib_register_device - Register an IB device with IB core
266 * @device:Device to register
268 * Low-level drivers use ib_register_device() to register their
269 * devices with the IB core. All registered clients will receive a
270 * callback for each device that is added. @device must be allocated
271 * with ib_alloc_device().
273 int ib_register_device(struct ib_device
*device
,
274 int (*port_callback
)(struct ib_device
*,
275 u8
, struct kobject
*))
279 mutex_lock(&device_mutex
);
281 if (strchr(device
->name
, '%')) {
282 ret
= alloc_name(device
->name
);
287 if (ib_device_check_mandatory(device
)) {
292 INIT_LIST_HEAD(&device
->event_handler_list
);
293 INIT_LIST_HEAD(&device
->client_data_list
);
294 spin_lock_init(&device
->event_handler_lock
);
295 spin_lock_init(&device
->client_data_lock
);
297 ret
= read_port_table_lengths(device
);
299 printk(KERN_WARNING
"Couldn't create table lengths cache for device %s\n",
304 ret
= ib_device_register_sysfs(device
, port_callback
);
306 printk(KERN_WARNING
"Couldn't register device %s with driver model\n",
308 kfree(device
->gid_tbl_len
);
309 kfree(device
->pkey_tbl_len
);
313 list_add_tail(&device
->core_list
, &device_list
);
315 device
->reg_state
= IB_DEV_REGISTERED
;
318 struct ib_client
*client
;
320 list_for_each_entry(client
, &client_list
, list
)
321 if (client
->add
&& !add_client_context(device
, client
))
326 mutex_unlock(&device_mutex
);
329 EXPORT_SYMBOL(ib_register_device
);
332 * ib_unregister_device - Unregister an IB device
333 * @device:Device to unregister
335 * Unregister an IB device. All clients will receive a remove callback.
337 void ib_unregister_device(struct ib_device
*device
)
339 struct ib_client
*client
;
340 struct ib_client_data
*context
, *tmp
;
343 mutex_lock(&device_mutex
);
345 list_for_each_entry_reverse(client
, &client_list
, list
)
347 client
->remove(device
);
349 list_del(&device
->core_list
);
351 kfree(device
->gid_tbl_len
);
352 kfree(device
->pkey_tbl_len
);
354 mutex_unlock(&device_mutex
);
356 ib_device_unregister_sysfs(device
);
358 spin_lock_irqsave(&device
->client_data_lock
, flags
);
359 list_for_each_entry_safe(context
, tmp
, &device
->client_data_list
, list
)
361 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
363 device
->reg_state
= IB_DEV_UNREGISTERED
;
365 EXPORT_SYMBOL(ib_unregister_device
);
368 * ib_register_client - Register an IB client
369 * @client:Client to register
371 * Upper level users of the IB drivers can use ib_register_client() to
372 * register callbacks for IB device addition and removal. When an IB
373 * device is added, each registered client's add method will be called
374 * (in the order the clients were registered), and when a device is
375 * removed, each client's remove method will be called (in the reverse
376 * order that clients were registered). In addition, when
377 * ib_register_client() is called, the client will receive an add
378 * callback for all devices already registered.
380 int ib_register_client(struct ib_client
*client
)
382 struct ib_device
*device
;
384 mutex_lock(&device_mutex
);
386 list_add_tail(&client
->list
, &client_list
);
387 list_for_each_entry(device
, &device_list
, core_list
)
388 if (client
->add
&& !add_client_context(device
, client
))
391 mutex_unlock(&device_mutex
);
395 EXPORT_SYMBOL(ib_register_client
);
398 * ib_unregister_client - Unregister an IB client
399 * @client:Client to unregister
401 * Upper level users use ib_unregister_client() to remove their client
402 * registration. When ib_unregister_client() is called, the client
403 * will receive a remove callback for each IB device still registered.
405 void ib_unregister_client(struct ib_client
*client
)
407 struct ib_client_data
*context
, *tmp
;
408 struct ib_device
*device
;
411 mutex_lock(&device_mutex
);
413 list_for_each_entry(device
, &device_list
, core_list
) {
415 client
->remove(device
);
417 spin_lock_irqsave(&device
->client_data_lock
, flags
);
418 list_for_each_entry_safe(context
, tmp
, &device
->client_data_list
, list
)
419 if (context
->client
== client
) {
420 list_del(&context
->list
);
423 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
425 list_del(&client
->list
);
427 mutex_unlock(&device_mutex
);
429 EXPORT_SYMBOL(ib_unregister_client
);
432 * ib_get_client_data - Get IB client context
433 * @device:Device to get context for
434 * @client:Client to get context for
436 * ib_get_client_data() returns client context set with
437 * ib_set_client_data().
439 void *ib_get_client_data(struct ib_device
*device
, struct ib_client
*client
)
441 struct ib_client_data
*context
;
445 spin_lock_irqsave(&device
->client_data_lock
, flags
);
446 list_for_each_entry(context
, &device
->client_data_list
, list
)
447 if (context
->client
== client
) {
451 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
455 EXPORT_SYMBOL(ib_get_client_data
);
458 * ib_set_client_data - Set IB client context
459 * @device:Device to set context for
460 * @client:Client to set context for
461 * @data:Context to set
463 * ib_set_client_data() sets client context that can be retrieved with
464 * ib_get_client_data().
466 void ib_set_client_data(struct ib_device
*device
, struct ib_client
*client
,
469 struct ib_client_data
*context
;
472 spin_lock_irqsave(&device
->client_data_lock
, flags
);
473 list_for_each_entry(context
, &device
->client_data_list
, list
)
474 if (context
->client
== client
) {
475 context
->data
= data
;
479 printk(KERN_WARNING
"No client context found for %s/%s\n",
480 device
->name
, client
->name
);
483 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
485 EXPORT_SYMBOL(ib_set_client_data
);
488 * ib_register_event_handler - Register an IB event handler
489 * @event_handler:Handler to register
491 * ib_register_event_handler() registers an event handler that will be
492 * called back when asynchronous IB events occur (as defined in
493 * chapter 11 of the InfiniBand Architecture Specification). This
494 * callback may occur in interrupt context.
496 int ib_register_event_handler (struct ib_event_handler
*event_handler
)
500 spin_lock_irqsave(&event_handler
->device
->event_handler_lock
, flags
);
501 list_add_tail(&event_handler
->list
,
502 &event_handler
->device
->event_handler_list
);
503 spin_unlock_irqrestore(&event_handler
->device
->event_handler_lock
, flags
);
507 EXPORT_SYMBOL(ib_register_event_handler
);
510 * ib_unregister_event_handler - Unregister an event handler
511 * @event_handler:Handler to unregister
513 * Unregister an event handler registered with
514 * ib_register_event_handler().
516 int ib_unregister_event_handler(struct ib_event_handler
*event_handler
)
520 spin_lock_irqsave(&event_handler
->device
->event_handler_lock
, flags
);
521 list_del(&event_handler
->list
);
522 spin_unlock_irqrestore(&event_handler
->device
->event_handler_lock
, flags
);
526 EXPORT_SYMBOL(ib_unregister_event_handler
);
529 * ib_dispatch_event - Dispatch an asynchronous event
530 * @event:Event to dispatch
532 * Low-level drivers must call ib_dispatch_event() to dispatch the
533 * event to all registered event handlers when an asynchronous event
536 void ib_dispatch_event(struct ib_event
*event
)
539 struct ib_event_handler
*handler
;
541 spin_lock_irqsave(&event
->device
->event_handler_lock
, flags
);
543 list_for_each_entry(handler
, &event
->device
->event_handler_list
, list
)
544 handler
->handler(handler
, event
);
546 spin_unlock_irqrestore(&event
->device
->event_handler_lock
, flags
);
548 EXPORT_SYMBOL(ib_dispatch_event
);
551 * ib_query_device - Query IB device attributes
552 * @device:Device to query
553 * @device_attr:Device attributes
555 * ib_query_device() returns the attributes of a device through the
556 * @device_attr pointer.
558 int ib_query_device(struct ib_device
*device
,
559 struct ib_device_attr
*device_attr
)
561 return device
->query_device(device
, device_attr
);
563 EXPORT_SYMBOL(ib_query_device
);
566 * ib_query_port - Query IB port attributes
567 * @device:Device to query
568 * @port_num:Port number to query
569 * @port_attr:Port attributes
571 * ib_query_port() returns the attributes of a port through the
572 * @port_attr pointer.
574 int ib_query_port(struct ib_device
*device
,
576 struct ib_port_attr
*port_attr
)
578 if (port_num
< start_port(device
) || port_num
> end_port(device
))
581 return device
->query_port(device
, port_num
, port_attr
);
583 EXPORT_SYMBOL(ib_query_port
);
586 * ib_query_gid - Get GID table entry
587 * @device:Device to query
588 * @port_num:Port number to query
589 * @index:GID table index to query
592 * ib_query_gid() fetches the specified GID table entry.
594 int ib_query_gid(struct ib_device
*device
,
595 u8 port_num
, int index
, union ib_gid
*gid
)
597 return device
->query_gid(device
, port_num
, index
, gid
);
599 EXPORT_SYMBOL(ib_query_gid
);
602 * ib_query_pkey - Get P_Key table entry
603 * @device:Device to query
604 * @port_num:Port number to query
605 * @index:P_Key table index to query
606 * @pkey:Returned P_Key
608 * ib_query_pkey() fetches the specified P_Key table entry.
610 int ib_query_pkey(struct ib_device
*device
,
611 u8 port_num
, u16 index
, u16
*pkey
)
613 return device
->query_pkey(device
, port_num
, index
, pkey
);
615 EXPORT_SYMBOL(ib_query_pkey
);
618 * ib_modify_device - Change IB device attributes
619 * @device:Device to modify
620 * @device_modify_mask:Mask of attributes to change
621 * @device_modify:New attribute values
623 * ib_modify_device() changes a device's attributes as specified by
624 * the @device_modify_mask and @device_modify structure.
626 int ib_modify_device(struct ib_device
*device
,
627 int device_modify_mask
,
628 struct ib_device_modify
*device_modify
)
630 if (!device
->modify_device
)
633 return device
->modify_device(device
, device_modify_mask
,
636 EXPORT_SYMBOL(ib_modify_device
);
639 * ib_modify_port - Modifies the attributes for the specified port.
640 * @device: The device to modify.
641 * @port_num: The number of the port to modify.
642 * @port_modify_mask: Mask used to specify which attributes of the port
644 * @port_modify: New attribute values for the port.
646 * ib_modify_port() changes a port's attributes as specified by the
647 * @port_modify_mask and @port_modify structure.
649 int ib_modify_port(struct ib_device
*device
,
650 u8 port_num
, int port_modify_mask
,
651 struct ib_port_modify
*port_modify
)
653 if (!device
->modify_port
)
656 if (port_num
< start_port(device
) || port_num
> end_port(device
))
659 return device
->modify_port(device
, port_num
, port_modify_mask
,
662 EXPORT_SYMBOL(ib_modify_port
);
665 * ib_find_gid - Returns the port number and GID table index where
666 * a specified GID value occurs.
667 * @device: The device to query.
668 * @gid: The GID value to search for.
669 * @port_num: The port number of the device where the GID value was found.
670 * @index: The index into the GID table where the GID was found. This
671 * parameter may be NULL.
673 int ib_find_gid(struct ib_device
*device
, union ib_gid
*gid
,
674 u8
*port_num
, u16
*index
)
676 union ib_gid tmp_gid
;
679 for (port
= start_port(device
); port
<= end_port(device
); ++port
) {
680 for (i
= 0; i
< device
->gid_tbl_len
[port
- start_port(device
)]; ++i
) {
681 ret
= ib_query_gid(device
, port
, i
, &tmp_gid
);
684 if (!memcmp(&tmp_gid
, gid
, sizeof *gid
)) {
695 EXPORT_SYMBOL(ib_find_gid
);
698 * ib_find_pkey - Returns the PKey table index where a specified
700 * @device: The device to query.
701 * @port_num: The port number of the device to search for the PKey.
702 * @pkey: The PKey value to search for.
703 * @index: The index into the PKey table where the PKey was found.
705 int ib_find_pkey(struct ib_device
*device
,
706 u8 port_num
, u16 pkey
, u16
*index
)
711 for (i
= 0; i
< device
->pkey_tbl_len
[port_num
- start_port(device
)]; ++i
) {
712 ret
= ib_query_pkey(device
, port_num
, i
, &tmp_pkey
);
716 if ((pkey
& 0x7fff) == (tmp_pkey
& 0x7fff)) {
724 EXPORT_SYMBOL(ib_find_pkey
);
726 static int __init
ib_core_init(void)
730 ib_wq
= alloc_workqueue("infiniband", 0, 0);
734 ret
= ib_sysfs_setup();
736 printk(KERN_WARNING
"Couldn't create InfiniBand device class\n");
742 printk(KERN_WARNING
"Couldn't init IB netlink interface\n");
746 ret
= ib_cache_setup();
748 printk(KERN_WARNING
"Couldn't set up InfiniBand P_Key/GID cache\n");
761 destroy_workqueue(ib_wq
);
765 static void __exit
ib_core_cleanup(void)
770 /* Make sure that any pending umem accounting work is done. */
771 destroy_workqueue(ib_wq
);
774 module_init(ib_core_init
);
775 module_exit(ib_core_cleanup
);