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>
42 #include "core_priv.h"
44 MODULE_AUTHOR("Roland Dreier");
45 MODULE_DESCRIPTION("core kernel InfiniBand API");
46 MODULE_LICENSE("Dual BSD/GPL");
48 struct ib_client_data
{
49 struct list_head list
;
50 struct ib_client
*client
;
54 struct workqueue_struct
*ib_wq
;
55 EXPORT_SYMBOL_GPL(ib_wq
);
57 static LIST_HEAD(device_list
);
58 static LIST_HEAD(client_list
);
61 * device_mutex protects access to both device_list and client_list.
62 * There's no real point to using multiple locks or something fancier
63 * like an rwsem: we always access both lists, and we're always
64 * modifying one list or the other list. In any case this is not a
65 * hot path so there's no point in trying to optimize.
67 static DEFINE_MUTEX(device_mutex
);
69 static int ib_device_check_mandatory(struct ib_device
*device
)
71 #define IB_MANDATORY_FUNC(x) { offsetof(struct ib_device, x), #x }
75 } mandatory_table
[] = {
76 IB_MANDATORY_FUNC(query_device
),
77 IB_MANDATORY_FUNC(query_port
),
78 IB_MANDATORY_FUNC(query_pkey
),
79 IB_MANDATORY_FUNC(query_gid
),
80 IB_MANDATORY_FUNC(alloc_pd
),
81 IB_MANDATORY_FUNC(dealloc_pd
),
82 IB_MANDATORY_FUNC(create_ah
),
83 IB_MANDATORY_FUNC(destroy_ah
),
84 IB_MANDATORY_FUNC(create_qp
),
85 IB_MANDATORY_FUNC(modify_qp
),
86 IB_MANDATORY_FUNC(destroy_qp
),
87 IB_MANDATORY_FUNC(post_send
),
88 IB_MANDATORY_FUNC(post_recv
),
89 IB_MANDATORY_FUNC(create_cq
),
90 IB_MANDATORY_FUNC(destroy_cq
),
91 IB_MANDATORY_FUNC(poll_cq
),
92 IB_MANDATORY_FUNC(req_notify_cq
),
93 IB_MANDATORY_FUNC(get_dma_mr
),
94 IB_MANDATORY_FUNC(dereg_mr
)
98 for (i
= 0; i
< ARRAY_SIZE(mandatory_table
); ++i
) {
99 if (!*(void **) ((void *) device
+ mandatory_table
[i
].offset
)) {
100 printk(KERN_WARNING
"Device %s is missing mandatory function %s\n",
101 device
->name
, mandatory_table
[i
].name
);
109 static struct ib_device
*__ib_device_get_by_name(const char *name
)
111 struct ib_device
*device
;
113 list_for_each_entry(device
, &device_list
, core_list
)
114 if (!strncmp(name
, device
->name
, IB_DEVICE_NAME_MAX
))
121 static int alloc_name(char *name
)
123 unsigned long *inuse
;
124 char buf
[IB_DEVICE_NAME_MAX
];
125 struct ib_device
*device
;
128 inuse
= (unsigned long *) get_zeroed_page(GFP_KERNEL
);
132 list_for_each_entry(device
, &device_list
, core_list
) {
133 if (!sscanf(device
->name
, name
, &i
))
135 if (i
< 0 || i
>= PAGE_SIZE
* 8)
137 snprintf(buf
, sizeof buf
, name
, i
);
138 if (!strncmp(buf
, device
->name
, IB_DEVICE_NAME_MAX
))
142 i
= find_first_zero_bit(inuse
, PAGE_SIZE
* 8);
143 free_page((unsigned long) inuse
);
144 snprintf(buf
, sizeof buf
, name
, i
);
146 if (__ib_device_get_by_name(buf
))
149 strlcpy(name
, buf
, IB_DEVICE_NAME_MAX
);
153 static int start_port(struct ib_device
*device
)
155 return (device
->node_type
== RDMA_NODE_IB_SWITCH
) ? 0 : 1;
159 static int end_port(struct ib_device
*device
)
161 return (device
->node_type
== RDMA_NODE_IB_SWITCH
) ?
162 0 : device
->phys_port_cnt
;
166 * ib_alloc_device - allocate an IB device struct
167 * @size:size of structure to allocate
169 * Low-level drivers should use ib_alloc_device() to allocate &struct
170 * ib_device. @size is the size of the structure to be allocated,
171 * including any private data used by the low-level driver.
172 * ib_dealloc_device() must be used to free structures allocated with
175 struct ib_device
*ib_alloc_device(size_t size
)
177 BUG_ON(size
< sizeof (struct ib_device
));
179 return kzalloc(size
, GFP_KERNEL
);
181 EXPORT_SYMBOL(ib_alloc_device
);
184 * ib_dealloc_device - free an IB device struct
185 * @device:structure to free
187 * Free a structure allocated with ib_alloc_device().
189 void ib_dealloc_device(struct ib_device
*device
)
191 if (device
->reg_state
== IB_DEV_UNINITIALIZED
) {
196 BUG_ON(device
->reg_state
!= IB_DEV_UNREGISTERED
);
198 kobject_put(&device
->dev
.kobj
);
200 EXPORT_SYMBOL(ib_dealloc_device
);
202 static int add_client_context(struct ib_device
*device
, struct ib_client
*client
)
204 struct ib_client_data
*context
;
207 context
= kmalloc(sizeof *context
, GFP_KERNEL
);
209 printk(KERN_WARNING
"Couldn't allocate client context for %s/%s\n",
210 device
->name
, client
->name
);
214 context
->client
= client
;
215 context
->data
= NULL
;
217 spin_lock_irqsave(&device
->client_data_lock
, flags
);
218 list_add(&context
->list
, &device
->client_data_list
);
219 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
224 static int read_port_table_lengths(struct ib_device
*device
)
226 struct ib_port_attr
*tprops
= NULL
;
227 int num_ports
, ret
= -ENOMEM
;
230 tprops
= kmalloc(sizeof *tprops
, GFP_KERNEL
);
234 num_ports
= end_port(device
) - start_port(device
) + 1;
236 device
->pkey_tbl_len
= kmalloc(sizeof *device
->pkey_tbl_len
* num_ports
,
238 device
->gid_tbl_len
= kmalloc(sizeof *device
->gid_tbl_len
* num_ports
,
240 if (!device
->pkey_tbl_len
|| !device
->gid_tbl_len
)
243 for (port_index
= 0; port_index
< num_ports
; ++port_index
) {
244 ret
= ib_query_port(device
, port_index
+ start_port(device
),
248 device
->pkey_tbl_len
[port_index
] = tprops
->pkey_tbl_len
;
249 device
->gid_tbl_len
[port_index
] = tprops
->gid_tbl_len
;
256 kfree(device
->gid_tbl_len
);
257 kfree(device
->pkey_tbl_len
);
264 * ib_register_device - Register an IB device with IB core
265 * @device:Device to register
267 * Low-level drivers use ib_register_device() to register their
268 * devices with the IB core. All registered clients will receive a
269 * callback for each device that is added. @device must be allocated
270 * with ib_alloc_device().
272 int ib_register_device(struct ib_device
*device
,
273 int (*port_callback
)(struct ib_device
*,
274 u8
, struct kobject
*))
278 mutex_lock(&device_mutex
);
280 if (strchr(device
->name
, '%')) {
281 ret
= alloc_name(device
->name
);
286 if (ib_device_check_mandatory(device
)) {
291 INIT_LIST_HEAD(&device
->event_handler_list
);
292 INIT_LIST_HEAD(&device
->client_data_list
);
293 spin_lock_init(&device
->event_handler_lock
);
294 spin_lock_init(&device
->client_data_lock
);
296 ret
= read_port_table_lengths(device
);
298 printk(KERN_WARNING
"Couldn't create table lengths cache for device %s\n",
303 ret
= ib_device_register_sysfs(device
, port_callback
);
305 printk(KERN_WARNING
"Couldn't register device %s with driver model\n",
307 kfree(device
->gid_tbl_len
);
308 kfree(device
->pkey_tbl_len
);
312 list_add_tail(&device
->core_list
, &device_list
);
314 device
->reg_state
= IB_DEV_REGISTERED
;
317 struct ib_client
*client
;
319 list_for_each_entry(client
, &client_list
, list
)
320 if (client
->add
&& !add_client_context(device
, client
))
325 mutex_unlock(&device_mutex
);
328 EXPORT_SYMBOL(ib_register_device
);
331 * ib_unregister_device - Unregister an IB device
332 * @device:Device to unregister
334 * Unregister an IB device. All clients will receive a remove callback.
336 void ib_unregister_device(struct ib_device
*device
)
338 struct ib_client
*client
;
339 struct ib_client_data
*context
, *tmp
;
342 mutex_lock(&device_mutex
);
344 list_for_each_entry_reverse(client
, &client_list
, list
)
346 client
->remove(device
);
348 list_del(&device
->core_list
);
350 kfree(device
->gid_tbl_len
);
351 kfree(device
->pkey_tbl_len
);
353 mutex_unlock(&device_mutex
);
355 ib_device_unregister_sysfs(device
);
357 spin_lock_irqsave(&device
->client_data_lock
, flags
);
358 list_for_each_entry_safe(context
, tmp
, &device
->client_data_list
, list
)
360 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
362 device
->reg_state
= IB_DEV_UNREGISTERED
;
364 EXPORT_SYMBOL(ib_unregister_device
);
367 * ib_register_client - Register an IB client
368 * @client:Client to register
370 * Upper level users of the IB drivers can use ib_register_client() to
371 * register callbacks for IB device addition and removal. When an IB
372 * device is added, each registered client's add method will be called
373 * (in the order the clients were registered), and when a device is
374 * removed, each client's remove method will be called (in the reverse
375 * order that clients were registered). In addition, when
376 * ib_register_client() is called, the client will receive an add
377 * callback for all devices already registered.
379 int ib_register_client(struct ib_client
*client
)
381 struct ib_device
*device
;
383 mutex_lock(&device_mutex
);
385 list_add_tail(&client
->list
, &client_list
);
386 list_for_each_entry(device
, &device_list
, core_list
)
387 if (client
->add
&& !add_client_context(device
, client
))
390 mutex_unlock(&device_mutex
);
394 EXPORT_SYMBOL(ib_register_client
);
397 * ib_unregister_client - Unregister an IB client
398 * @client:Client to unregister
400 * Upper level users use ib_unregister_client() to remove their client
401 * registration. When ib_unregister_client() is called, the client
402 * will receive a remove callback for each IB device still registered.
404 void ib_unregister_client(struct ib_client
*client
)
406 struct ib_client_data
*context
, *tmp
;
407 struct ib_device
*device
;
410 mutex_lock(&device_mutex
);
412 list_for_each_entry(device
, &device_list
, core_list
) {
414 client
->remove(device
);
416 spin_lock_irqsave(&device
->client_data_lock
, flags
);
417 list_for_each_entry_safe(context
, tmp
, &device
->client_data_list
, list
)
418 if (context
->client
== client
) {
419 list_del(&context
->list
);
422 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
424 list_del(&client
->list
);
426 mutex_unlock(&device_mutex
);
428 EXPORT_SYMBOL(ib_unregister_client
);
431 * ib_get_client_data - Get IB client context
432 * @device:Device to get context for
433 * @client:Client to get context for
435 * ib_get_client_data() returns client context set with
436 * ib_set_client_data().
438 void *ib_get_client_data(struct ib_device
*device
, struct ib_client
*client
)
440 struct ib_client_data
*context
;
444 spin_lock_irqsave(&device
->client_data_lock
, flags
);
445 list_for_each_entry(context
, &device
->client_data_list
, list
)
446 if (context
->client
== client
) {
450 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
454 EXPORT_SYMBOL(ib_get_client_data
);
457 * ib_set_client_data - Set IB client context
458 * @device:Device to set context for
459 * @client:Client to set context for
460 * @data:Context to set
462 * ib_set_client_data() sets client context that can be retrieved with
463 * ib_get_client_data().
465 void ib_set_client_data(struct ib_device
*device
, struct ib_client
*client
,
468 struct ib_client_data
*context
;
471 spin_lock_irqsave(&device
->client_data_lock
, flags
);
472 list_for_each_entry(context
, &device
->client_data_list
, list
)
473 if (context
->client
== client
) {
474 context
->data
= data
;
478 printk(KERN_WARNING
"No client context found for %s/%s\n",
479 device
->name
, client
->name
);
482 spin_unlock_irqrestore(&device
->client_data_lock
, flags
);
484 EXPORT_SYMBOL(ib_set_client_data
);
487 * ib_register_event_handler - Register an IB event handler
488 * @event_handler:Handler to register
490 * ib_register_event_handler() registers an event handler that will be
491 * called back when asynchronous IB events occur (as defined in
492 * chapter 11 of the InfiniBand Architecture Specification). This
493 * callback may occur in interrupt context.
495 int ib_register_event_handler (struct ib_event_handler
*event_handler
)
499 spin_lock_irqsave(&event_handler
->device
->event_handler_lock
, flags
);
500 list_add_tail(&event_handler
->list
,
501 &event_handler
->device
->event_handler_list
);
502 spin_unlock_irqrestore(&event_handler
->device
->event_handler_lock
, flags
);
506 EXPORT_SYMBOL(ib_register_event_handler
);
509 * ib_unregister_event_handler - Unregister an event handler
510 * @event_handler:Handler to unregister
512 * Unregister an event handler registered with
513 * ib_register_event_handler().
515 int ib_unregister_event_handler(struct ib_event_handler
*event_handler
)
519 spin_lock_irqsave(&event_handler
->device
->event_handler_lock
, flags
);
520 list_del(&event_handler
->list
);
521 spin_unlock_irqrestore(&event_handler
->device
->event_handler_lock
, flags
);
525 EXPORT_SYMBOL(ib_unregister_event_handler
);
528 * ib_dispatch_event - Dispatch an asynchronous event
529 * @event:Event to dispatch
531 * Low-level drivers must call ib_dispatch_event() to dispatch the
532 * event to all registered event handlers when an asynchronous event
535 void ib_dispatch_event(struct ib_event
*event
)
538 struct ib_event_handler
*handler
;
540 spin_lock_irqsave(&event
->device
->event_handler_lock
, flags
);
542 list_for_each_entry(handler
, &event
->device
->event_handler_list
, list
)
543 handler
->handler(handler
, event
);
545 spin_unlock_irqrestore(&event
->device
->event_handler_lock
, flags
);
547 EXPORT_SYMBOL(ib_dispatch_event
);
550 * ib_query_device - Query IB device attributes
551 * @device:Device to query
552 * @device_attr:Device attributes
554 * ib_query_device() returns the attributes of a device through the
555 * @device_attr pointer.
557 int ib_query_device(struct ib_device
*device
,
558 struct ib_device_attr
*device_attr
)
560 return device
->query_device(device
, device_attr
);
562 EXPORT_SYMBOL(ib_query_device
);
565 * ib_query_port - Query IB port attributes
566 * @device:Device to query
567 * @port_num:Port number to query
568 * @port_attr:Port attributes
570 * ib_query_port() returns the attributes of a port through the
571 * @port_attr pointer.
573 int ib_query_port(struct ib_device
*device
,
575 struct ib_port_attr
*port_attr
)
577 if (port_num
< start_port(device
) || port_num
> end_port(device
))
580 return device
->query_port(device
, port_num
, port_attr
);
582 EXPORT_SYMBOL(ib_query_port
);
585 * ib_query_gid - Get GID table entry
586 * @device:Device to query
587 * @port_num:Port number to query
588 * @index:GID table index to query
591 * ib_query_gid() fetches the specified GID table entry.
593 int ib_query_gid(struct ib_device
*device
,
594 u8 port_num
, int index
, union ib_gid
*gid
)
596 return device
->query_gid(device
, port_num
, index
, gid
);
598 EXPORT_SYMBOL(ib_query_gid
);
601 * ib_query_pkey - Get P_Key table entry
602 * @device:Device to query
603 * @port_num:Port number to query
604 * @index:P_Key table index to query
605 * @pkey:Returned P_Key
607 * ib_query_pkey() fetches the specified P_Key table entry.
609 int ib_query_pkey(struct ib_device
*device
,
610 u8 port_num
, u16 index
, u16
*pkey
)
612 return device
->query_pkey(device
, port_num
, index
, pkey
);
614 EXPORT_SYMBOL(ib_query_pkey
);
617 * ib_modify_device - Change IB device attributes
618 * @device:Device to modify
619 * @device_modify_mask:Mask of attributes to change
620 * @device_modify:New attribute values
622 * ib_modify_device() changes a device's attributes as specified by
623 * the @device_modify_mask and @device_modify structure.
625 int ib_modify_device(struct ib_device
*device
,
626 int device_modify_mask
,
627 struct ib_device_modify
*device_modify
)
629 return device
->modify_device(device
, device_modify_mask
,
632 EXPORT_SYMBOL(ib_modify_device
);
635 * ib_modify_port - Modifies the attributes for the specified port.
636 * @device: The device to modify.
637 * @port_num: The number of the port to modify.
638 * @port_modify_mask: Mask used to specify which attributes of the port
640 * @port_modify: New attribute values for the port.
642 * ib_modify_port() changes a port's attributes as specified by the
643 * @port_modify_mask and @port_modify structure.
645 int ib_modify_port(struct ib_device
*device
,
646 u8 port_num
, int port_modify_mask
,
647 struct ib_port_modify
*port_modify
)
649 if (port_num
< start_port(device
) || port_num
> end_port(device
))
652 return device
->modify_port(device
, port_num
, port_modify_mask
,
655 EXPORT_SYMBOL(ib_modify_port
);
658 * ib_find_gid - Returns the port number and GID table index where
659 * a specified GID value occurs.
660 * @device: The device to query.
661 * @gid: The GID value to search for.
662 * @port_num: The port number of the device where the GID value was found.
663 * @index: The index into the GID table where the GID was found. This
664 * parameter may be NULL.
666 int ib_find_gid(struct ib_device
*device
, union ib_gid
*gid
,
667 u8
*port_num
, u16
*index
)
669 union ib_gid tmp_gid
;
672 for (port
= start_port(device
); port
<= end_port(device
); ++port
) {
673 for (i
= 0; i
< device
->gid_tbl_len
[port
- start_port(device
)]; ++i
) {
674 ret
= ib_query_gid(device
, port
, i
, &tmp_gid
);
677 if (!memcmp(&tmp_gid
, gid
, sizeof *gid
)) {
688 EXPORT_SYMBOL(ib_find_gid
);
691 * ib_find_pkey - Returns the PKey table index where a specified
693 * @device: The device to query.
694 * @port_num: The port number of the device to search for the PKey.
695 * @pkey: The PKey value to search for.
696 * @index: The index into the PKey table where the PKey was found.
698 int ib_find_pkey(struct ib_device
*device
,
699 u8 port_num
, u16 pkey
, u16
*index
)
704 for (i
= 0; i
< device
->pkey_tbl_len
[port_num
- start_port(device
)]; ++i
) {
705 ret
= ib_query_pkey(device
, port_num
, i
, &tmp_pkey
);
709 if ((pkey
& 0x7fff) == (tmp_pkey
& 0x7fff)) {
717 EXPORT_SYMBOL(ib_find_pkey
);
719 static int __init
ib_core_init(void)
723 ib_wq
= alloc_workqueue("infiniband", 0, 0);
727 ret
= ib_sysfs_setup();
729 printk(KERN_WARNING
"Couldn't create InfiniBand device class\n");
731 ret
= ib_cache_setup();
733 printk(KERN_WARNING
"Couldn't set up InfiniBand P_Key/GID cache\n");
735 destroy_workqueue(ib_wq
);
741 static void __exit
ib_core_cleanup(void)
745 /* Make sure that any pending umem accounting work is done. */
746 destroy_workqueue(ib_wq
);
749 module_init(ib_core_init
);
750 module_exit(ib_core_cleanup
);