Staging: zram: fix up some sysfs attribute permissions
[zen-stable.git] / drivers / infiniband / core / device.c
bloba19effad0811a293b911eb29682e71711153419f
1 /*
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
13 * conditions are met:
15 * - Redistributions of source code must retain the above
16 * copyright notice, this list of conditions and the following
17 * disclaimer.
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
31 * SOFTWARE.
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/workqueue.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;
52 void * data;
55 static LIST_HEAD(device_list);
56 static LIST_HEAD(client_list);
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.
65 static DEFINE_MUTEX(device_mutex);
67 static int ib_device_check_mandatory(struct ib_device *device)
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)
94 int i;
96 for (i = 0; i < ARRAY_SIZE(mandatory_table); ++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;
104 return 0;
107 static struct ib_device *__ib_device_get_by_name(const char *name)
109 struct ib_device *device;
111 list_for_each_entry(device, &device_list, core_list)
112 if (!strncmp(name, device->name, IB_DEVICE_NAME_MAX))
113 return device;
115 return NULL;
119 static int alloc_name(char *name)
121 unsigned long *inuse;
122 char buf[IB_DEVICE_NAME_MAX];
123 struct ib_device *device;
124 int i;
126 inuse = (unsigned long *) get_zeroed_page(GFP_KERNEL);
127 if (!inuse)
128 return -ENOMEM;
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);
140 i = find_first_zero_bit(inuse, PAGE_SIZE * 8);
141 free_page((unsigned long) inuse);
142 snprintf(buf, sizeof buf, name, i);
144 if (__ib_device_get_by_name(buf))
145 return -ENFILE;
147 strlcpy(name, buf, IB_DEVICE_NAME_MAX);
148 return 0;
151 static int start_port(struct ib_device *device)
153 return (device->node_type == RDMA_NODE_IB_SWITCH) ? 0 : 1;
157 static int end_port(struct ib_device *device)
159 return (device->node_type == RDMA_NODE_IB_SWITCH) ?
160 0 : device->phys_port_cnt;
164 * ib_alloc_device - allocate an IB device struct
165 * @size:size of structure to allocate
167 * Low-level drivers should use ib_alloc_device() to allocate &struct
168 * ib_device. @size is the size of the structure to be allocated,
169 * including any private data used by the low-level driver.
170 * ib_dealloc_device() must be used to free structures allocated with
171 * ib_alloc_device().
173 struct ib_device *ib_alloc_device(size_t size)
175 BUG_ON(size < sizeof (struct ib_device));
177 return kzalloc(size, GFP_KERNEL);
179 EXPORT_SYMBOL(ib_alloc_device);
182 * ib_dealloc_device - free an IB device struct
183 * @device:structure to free
185 * Free a structure allocated with ib_alloc_device().
187 void ib_dealloc_device(struct ib_device *device)
189 if (device->reg_state == IB_DEV_UNINITIALIZED) {
190 kfree(device);
191 return;
194 BUG_ON(device->reg_state != IB_DEV_UNREGISTERED);
196 kobject_put(&device->dev.kobj);
198 EXPORT_SYMBOL(ib_dealloc_device);
200 static int add_client_context(struct ib_device *device, struct ib_client *client)
202 struct ib_client_data *context;
203 unsigned long flags;
205 context = kmalloc(sizeof *context, GFP_KERNEL);
206 if (!context) {
207 printk(KERN_WARNING "Couldn't allocate client context for %s/%s\n",
208 device->name, client->name);
209 return -ENOMEM;
212 context->client = client;
213 context->data = NULL;
215 spin_lock_irqsave(&device->client_data_lock, flags);
216 list_add(&context->list, &device->client_data_list);
217 spin_unlock_irqrestore(&device->client_data_lock, flags);
219 return 0;
222 static int read_port_table_lengths(struct ib_device *device)
224 struct ib_port_attr *tprops = NULL;
225 int num_ports, ret = -ENOMEM;
226 u8 port_index;
228 tprops = kmalloc(sizeof *tprops, GFP_KERNEL);
229 if (!tprops)
230 goto out;
232 num_ports = end_port(device) - start_port(device) + 1;
234 device->pkey_tbl_len = kmalloc(sizeof *device->pkey_tbl_len * num_ports,
235 GFP_KERNEL);
236 device->gid_tbl_len = kmalloc(sizeof *device->gid_tbl_len * num_ports,
237 GFP_KERNEL);
238 if (!device->pkey_tbl_len || !device->gid_tbl_len)
239 goto err;
241 for (port_index = 0; port_index < num_ports; ++port_index) {
242 ret = ib_query_port(device, port_index + start_port(device),
243 tprops);
244 if (ret)
245 goto err;
246 device->pkey_tbl_len[port_index] = tprops->pkey_tbl_len;
247 device->gid_tbl_len[port_index] = tprops->gid_tbl_len;
250 ret = 0;
251 goto out;
253 err:
254 kfree(device->gid_tbl_len);
255 kfree(device->pkey_tbl_len);
256 out:
257 kfree(tprops);
258 return ret;
262 * ib_register_device - Register an IB device with IB core
263 * @device:Device to register
265 * Low-level drivers use ib_register_device() to register their
266 * devices with the IB core. All registered clients will receive a
267 * callback for each device that is added. @device must be allocated
268 * with ib_alloc_device().
270 int ib_register_device(struct ib_device *device,
271 int (*port_callback)(struct ib_device *,
272 u8, struct kobject *))
274 int ret;
276 mutex_lock(&device_mutex);
278 if (strchr(device->name, '%')) {
279 ret = alloc_name(device->name);
280 if (ret)
281 goto out;
284 if (ib_device_check_mandatory(device)) {
285 ret = -EINVAL;
286 goto out;
289 INIT_LIST_HEAD(&device->event_handler_list);
290 INIT_LIST_HEAD(&device->client_data_list);
291 spin_lock_init(&device->event_handler_lock);
292 spin_lock_init(&device->client_data_lock);
294 ret = read_port_table_lengths(device);
295 if (ret) {
296 printk(KERN_WARNING "Couldn't create table lengths cache for device %s\n",
297 device->name);
298 goto out;
301 ret = ib_device_register_sysfs(device, port_callback);
302 if (ret) {
303 printk(KERN_WARNING "Couldn't register device %s with driver model\n",
304 device->name);
305 kfree(device->gid_tbl_len);
306 kfree(device->pkey_tbl_len);
307 goto out;
310 list_add_tail(&device->core_list, &device_list);
312 device->reg_state = IB_DEV_REGISTERED;
315 struct ib_client *client;
317 list_for_each_entry(client, &client_list, list)
318 if (client->add && !add_client_context(device, client))
319 client->add(device);
322 out:
323 mutex_unlock(&device_mutex);
324 return ret;
326 EXPORT_SYMBOL(ib_register_device);
329 * ib_unregister_device - Unregister an IB device
330 * @device:Device to unregister
332 * Unregister an IB device. All clients will receive a remove callback.
334 void ib_unregister_device(struct ib_device *device)
336 struct ib_client *client;
337 struct ib_client_data *context, *tmp;
338 unsigned long flags;
340 mutex_lock(&device_mutex);
342 list_for_each_entry_reverse(client, &client_list, list)
343 if (client->remove)
344 client->remove(device);
346 list_del(&device->core_list);
348 kfree(device->gid_tbl_len);
349 kfree(device->pkey_tbl_len);
351 mutex_unlock(&device_mutex);
353 ib_device_unregister_sysfs(device);
355 spin_lock_irqsave(&device->client_data_lock, flags);
356 list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
357 kfree(context);
358 spin_unlock_irqrestore(&device->client_data_lock, flags);
360 device->reg_state = IB_DEV_UNREGISTERED;
362 EXPORT_SYMBOL(ib_unregister_device);
365 * ib_register_client - Register an IB client
366 * @client:Client to register
368 * Upper level users of the IB drivers can use ib_register_client() to
369 * register callbacks for IB device addition and removal. When an IB
370 * device is added, each registered client's add method will be called
371 * (in the order the clients were registered), and when a device is
372 * removed, each client's remove method will be called (in the reverse
373 * order that clients were registered). In addition, when
374 * ib_register_client() is called, the client will receive an add
375 * callback for all devices already registered.
377 int ib_register_client(struct ib_client *client)
379 struct ib_device *device;
381 mutex_lock(&device_mutex);
383 list_add_tail(&client->list, &client_list);
384 list_for_each_entry(device, &device_list, core_list)
385 if (client->add && !add_client_context(device, client))
386 client->add(device);
388 mutex_unlock(&device_mutex);
390 return 0;
392 EXPORT_SYMBOL(ib_register_client);
395 * ib_unregister_client - Unregister an IB client
396 * @client:Client to unregister
398 * Upper level users use ib_unregister_client() to remove their client
399 * registration. When ib_unregister_client() is called, the client
400 * will receive a remove callback for each IB device still registered.
402 void ib_unregister_client(struct ib_client *client)
404 struct ib_client_data *context, *tmp;
405 struct ib_device *device;
406 unsigned long flags;
408 mutex_lock(&device_mutex);
410 list_for_each_entry(device, &device_list, core_list) {
411 if (client->remove)
412 client->remove(device);
414 spin_lock_irqsave(&device->client_data_lock, flags);
415 list_for_each_entry_safe(context, tmp, &device->client_data_list, list)
416 if (context->client == client) {
417 list_del(&context->list);
418 kfree(context);
420 spin_unlock_irqrestore(&device->client_data_lock, flags);
422 list_del(&client->list);
424 mutex_unlock(&device_mutex);
426 EXPORT_SYMBOL(ib_unregister_client);
429 * ib_get_client_data - Get IB client context
430 * @device:Device to get context for
431 * @client:Client to get context for
433 * ib_get_client_data() returns client context set with
434 * ib_set_client_data().
436 void *ib_get_client_data(struct ib_device *device, struct ib_client *client)
438 struct ib_client_data *context;
439 void *ret = NULL;
440 unsigned long flags;
442 spin_lock_irqsave(&device->client_data_lock, flags);
443 list_for_each_entry(context, &device->client_data_list, list)
444 if (context->client == client) {
445 ret = context->data;
446 break;
448 spin_unlock_irqrestore(&device->client_data_lock, flags);
450 return ret;
452 EXPORT_SYMBOL(ib_get_client_data);
455 * ib_set_client_data - Set IB client context
456 * @device:Device to set context for
457 * @client:Client to set context for
458 * @data:Context to set
460 * ib_set_client_data() sets client context that can be retrieved with
461 * ib_get_client_data().
463 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
464 void *data)
466 struct ib_client_data *context;
467 unsigned long flags;
469 spin_lock_irqsave(&device->client_data_lock, flags);
470 list_for_each_entry(context, &device->client_data_list, list)
471 if (context->client == client) {
472 context->data = data;
473 goto out;
476 printk(KERN_WARNING "No client context found for %s/%s\n",
477 device->name, client->name);
479 out:
480 spin_unlock_irqrestore(&device->client_data_lock, flags);
482 EXPORT_SYMBOL(ib_set_client_data);
485 * ib_register_event_handler - Register an IB event handler
486 * @event_handler:Handler to register
488 * ib_register_event_handler() registers an event handler that will be
489 * called back when asynchronous IB events occur (as defined in
490 * chapter 11 of the InfiniBand Architecture Specification). This
491 * callback may occur in interrupt context.
493 int ib_register_event_handler (struct ib_event_handler *event_handler)
495 unsigned long flags;
497 spin_lock_irqsave(&event_handler->device->event_handler_lock, flags);
498 list_add_tail(&event_handler->list,
499 &event_handler->device->event_handler_list);
500 spin_unlock_irqrestore(&event_handler->device->event_handler_lock, flags);
502 return 0;
504 EXPORT_SYMBOL(ib_register_event_handler);
507 * ib_unregister_event_handler - Unregister an event handler
508 * @event_handler:Handler to unregister
510 * Unregister an event handler registered with
511 * ib_register_event_handler().
513 int ib_unregister_event_handler(struct ib_event_handler *event_handler)
515 unsigned long flags;
517 spin_lock_irqsave(&event_handler->device->event_handler_lock, flags);
518 list_del(&event_handler->list);
519 spin_unlock_irqrestore(&event_handler->device->event_handler_lock, flags);
521 return 0;
523 EXPORT_SYMBOL(ib_unregister_event_handler);
526 * ib_dispatch_event - Dispatch an asynchronous event
527 * @event:Event to dispatch
529 * Low-level drivers must call ib_dispatch_event() to dispatch the
530 * event to all registered event handlers when an asynchronous event
531 * occurs.
533 void ib_dispatch_event(struct ib_event *event)
535 unsigned long flags;
536 struct ib_event_handler *handler;
538 spin_lock_irqsave(&event->device->event_handler_lock, flags);
540 list_for_each_entry(handler, &event->device->event_handler_list, list)
541 handler->handler(handler, event);
543 spin_unlock_irqrestore(&event->device->event_handler_lock, flags);
545 EXPORT_SYMBOL(ib_dispatch_event);
548 * ib_query_device - Query IB device attributes
549 * @device:Device to query
550 * @device_attr:Device attributes
552 * ib_query_device() returns the attributes of a device through the
553 * @device_attr pointer.
555 int ib_query_device(struct ib_device *device,
556 struct ib_device_attr *device_attr)
558 return device->query_device(device, device_attr);
560 EXPORT_SYMBOL(ib_query_device);
563 * ib_query_port - Query IB port attributes
564 * @device:Device to query
565 * @port_num:Port number to query
566 * @port_attr:Port attributes
568 * ib_query_port() returns the attributes of a port through the
569 * @port_attr pointer.
571 int ib_query_port(struct ib_device *device,
572 u8 port_num,
573 struct ib_port_attr *port_attr)
575 if (port_num < start_port(device) || port_num > end_port(device))
576 return -EINVAL;
578 return device->query_port(device, port_num, port_attr);
580 EXPORT_SYMBOL(ib_query_port);
583 * ib_query_gid - Get GID table entry
584 * @device:Device to query
585 * @port_num:Port number to query
586 * @index:GID table index to query
587 * @gid:Returned GID
589 * ib_query_gid() fetches the specified GID table entry.
591 int ib_query_gid(struct ib_device *device,
592 u8 port_num, int index, union ib_gid *gid)
594 return device->query_gid(device, port_num, index, gid);
596 EXPORT_SYMBOL(ib_query_gid);
599 * ib_query_pkey - Get P_Key table entry
600 * @device:Device to query
601 * @port_num:Port number to query
602 * @index:P_Key table index to query
603 * @pkey:Returned P_Key
605 * ib_query_pkey() fetches the specified P_Key table entry.
607 int ib_query_pkey(struct ib_device *device,
608 u8 port_num, u16 index, u16 *pkey)
610 return device->query_pkey(device, port_num, index, pkey);
612 EXPORT_SYMBOL(ib_query_pkey);
615 * ib_modify_device - Change IB device attributes
616 * @device:Device to modify
617 * @device_modify_mask:Mask of attributes to change
618 * @device_modify:New attribute values
620 * ib_modify_device() changes a device's attributes as specified by
621 * the @device_modify_mask and @device_modify structure.
623 int ib_modify_device(struct ib_device *device,
624 int device_modify_mask,
625 struct ib_device_modify *device_modify)
627 return device->modify_device(device, device_modify_mask,
628 device_modify);
630 EXPORT_SYMBOL(ib_modify_device);
633 * ib_modify_port - Modifies the attributes for the specified port.
634 * @device: The device to modify.
635 * @port_num: The number of the port to modify.
636 * @port_modify_mask: Mask used to specify which attributes of the port
637 * to change.
638 * @port_modify: New attribute values for the port.
640 * ib_modify_port() changes a port's attributes as specified by the
641 * @port_modify_mask and @port_modify structure.
643 int ib_modify_port(struct ib_device *device,
644 u8 port_num, int port_modify_mask,
645 struct ib_port_modify *port_modify)
647 if (port_num < start_port(device) || port_num > end_port(device))
648 return -EINVAL;
650 return device->modify_port(device, port_num, port_modify_mask,
651 port_modify);
653 EXPORT_SYMBOL(ib_modify_port);
656 * ib_find_gid - Returns the port number and GID table index where
657 * a specified GID value occurs.
658 * @device: The device to query.
659 * @gid: The GID value to search for.
660 * @port_num: The port number of the device where the GID value was found.
661 * @index: The index into the GID table where the GID was found. This
662 * parameter may be NULL.
664 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
665 u8 *port_num, u16 *index)
667 union ib_gid tmp_gid;
668 int ret, port, i;
670 for (port = start_port(device); port <= end_port(device); ++port) {
671 for (i = 0; i < device->gid_tbl_len[port - start_port(device)]; ++i) {
672 ret = ib_query_gid(device, port, i, &tmp_gid);
673 if (ret)
674 return ret;
675 if (!memcmp(&tmp_gid, gid, sizeof *gid)) {
676 *port_num = port;
677 if (index)
678 *index = i;
679 return 0;
684 return -ENOENT;
686 EXPORT_SYMBOL(ib_find_gid);
689 * ib_find_pkey - Returns the PKey table index where a specified
690 * PKey value occurs.
691 * @device: The device to query.
692 * @port_num: The port number of the device to search for the PKey.
693 * @pkey: The PKey value to search for.
694 * @index: The index into the PKey table where the PKey was found.
696 int ib_find_pkey(struct ib_device *device,
697 u8 port_num, u16 pkey, u16 *index)
699 int ret, i;
700 u16 tmp_pkey;
702 for (i = 0; i < device->pkey_tbl_len[port_num - start_port(device)]; ++i) {
703 ret = ib_query_pkey(device, port_num, i, &tmp_pkey);
704 if (ret)
705 return ret;
707 if ((pkey & 0x7fff) == (tmp_pkey & 0x7fff)) {
708 *index = i;
709 return 0;
713 return -ENOENT;
715 EXPORT_SYMBOL(ib_find_pkey);
717 static int __init ib_core_init(void)
719 int ret;
721 ret = ib_sysfs_setup();
722 if (ret)
723 printk(KERN_WARNING "Couldn't create InfiniBand device class\n");
725 ret = ib_cache_setup();
726 if (ret) {
727 printk(KERN_WARNING "Couldn't set up InfiniBand P_Key/GID cache\n");
728 ib_sysfs_cleanup();
731 return ret;
734 static void __exit ib_core_cleanup(void)
736 ib_cache_cleanup();
737 ib_sysfs_cleanup();
738 /* Make sure that any pending umem accounting work is done. */
739 flush_scheduled_work();
742 module_init(ib_core_init);
743 module_exit(ib_core_cleanup);