2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 * $Id: sa_query.c 1389 2004-12-27 22:56:47Z roland $
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/err.h>
38 #include <linux/random.h>
39 #include <linux/spinlock.h>
40 #include <linux/slab.h>
41 #include <linux/pci.h>
42 #include <linux/dma-mapping.h>
43 #include <linux/kref.h>
44 #include <linux/idr.h>
49 MODULE_AUTHOR("Roland Dreier");
50 MODULE_DESCRIPTION("InfiniBand subnet administration query support");
51 MODULE_LICENSE("Dual BSD/GPL");
54 * These two structures must be packed because they have 64-bit fields
55 * that are only 32-bit aligned. 64-bit architectures will lay them
56 * out wrong otherwise. (And unfortunately they are sent on the wire
57 * so we can't change the layout)
63 ib_sa_comp_mask comp_mask;
64 } __attribute__ ((packed));
67 struct ib_mad_hdr mad_hdr;
68 struct ib_rmpp_hdr rmpp_hdr;
69 struct ib_sa_hdr sa_hdr;
71 } __attribute__ ((packed));
79 struct ib_mad_agent *agent;
80 struct ib_sa_sm_ah *sm_ah;
81 struct work_struct update_task;
87 int start_port, end_port;
88 struct ib_event_handler event_handler;
89 struct ib_sa_port port[0];
93 void (*callback)(struct ib_sa_query *, int, struct ib_sa_mad *);
94 void (*release)(struct ib_sa_query *);
95 struct ib_sa_port *port;
96 struct ib_sa_mad *mad;
97 struct ib_sa_sm_ah *sm_ah;
98 DECLARE_PCI_UNMAP_ADDR(mapping)
102 struct ib_sa_path_query {
103 void (*callback)(int, struct ib_sa_path_rec *, void *);
105 struct ib_sa_query sa_query;
108 struct ib_sa_mcmember_query {
109 void (*callback)(int, struct ib_sa_mcmember_rec *, void *);
111 struct ib_sa_query sa_query;
114 static void ib_sa_add_one(struct ib_device *device);
115 static void ib_sa_remove_one(struct ib_device *device);
117 static struct ib_client sa_client = {
119 .add = ib_sa_add_one,
120 .remove = ib_sa_remove_one
123 static spinlock_t idr_lock;
124 static DEFINE_IDR(query_idr);
126 static spinlock_t tid_lock;
130 IB_SA_ATTR_CLASS_PORTINFO = 0x01,
131 IB_SA_ATTR_NOTICE = 0x02,
132 IB_SA_ATTR_INFORM_INFO = 0x03,
133 IB_SA_ATTR_NODE_REC = 0x11,
134 IB_SA_ATTR_PORT_INFO_REC = 0x12,
135 IB_SA_ATTR_SL2VL_REC = 0x13,
136 IB_SA_ATTR_SWITCH_REC = 0x14,
137 IB_SA_ATTR_LINEAR_FDB_REC = 0x15,
138 IB_SA_ATTR_RANDOM_FDB_REC = 0x16,
139 IB_SA_ATTR_MCAST_FDB_REC = 0x17,
140 IB_SA_ATTR_SM_INFO_REC = 0x18,
141 IB_SA_ATTR_LINK_REC = 0x20,
142 IB_SA_ATTR_GUID_INFO_REC = 0x30,
143 IB_SA_ATTR_SERVICE_REC = 0x31,
144 IB_SA_ATTR_PARTITION_REC = 0x33,
145 IB_SA_ATTR_RANGE_REC = 0x34,
146 IB_SA_ATTR_PATH_REC = 0x35,
147 IB_SA_ATTR_VL_ARB_REC = 0x36,
148 IB_SA_ATTR_MC_GROUP_REC = 0x37,
149 IB_SA_ATTR_MC_MEMBER_REC = 0x38,
150 IB_SA_ATTR_TRACE_REC = 0x39,
151 IB_SA_ATTR_MULTI_PATH_REC = 0x3a,
152 IB_SA_ATTR_SERVICE_ASSOC_REC = 0x3b
155 #define PATH_REC_FIELD(field) \
156 .struct_offset_bytes = offsetof(struct ib_sa_path_rec, field), \
157 .struct_size_bytes = sizeof ((struct ib_sa_path_rec *) 0)->field, \
158 .field_name = "sa_path_rec:" #field
160 static const struct ib_field path_rec_table[] = {
169 { PATH_REC_FIELD(dgid),
173 { PATH_REC_FIELD(sgid),
177 { PATH_REC_FIELD(dlid),
181 { PATH_REC_FIELD(slid),
185 { PATH_REC_FIELD(raw_traffic),
193 { PATH_REC_FIELD(flow_label),
197 { PATH_REC_FIELD(hop_limit),
201 { PATH_REC_FIELD(traffic_class),
205 { PATH_REC_FIELD(reversible),
209 { PATH_REC_FIELD(numb_path),
213 { PATH_REC_FIELD(pkey),
221 { PATH_REC_FIELD(sl),
225 { PATH_REC_FIELD(mtu_selector),
229 { PATH_REC_FIELD(mtu),
233 { PATH_REC_FIELD(rate_selector),
237 { PATH_REC_FIELD(rate),
241 { PATH_REC_FIELD(packet_life_time_selector),
245 { PATH_REC_FIELD(packet_life_time),
249 { PATH_REC_FIELD(preference),
259 #define MCMEMBER_REC_FIELD(field) \
260 .struct_offset_bytes = offsetof(struct ib_sa_mcmember_rec, field), \
261 .struct_size_bytes = sizeof ((struct ib_sa_mcmember_rec *) 0)->field, \
262 .field_name = "sa_mcmember_rec:" #field
264 static const struct ib_field mcmember_rec_table[] = {
265 { MCMEMBER_REC_FIELD(mgid),
269 { MCMEMBER_REC_FIELD(port_gid),
273 { MCMEMBER_REC_FIELD(qkey),
277 { MCMEMBER_REC_FIELD(mlid),
281 { MCMEMBER_REC_FIELD(mtu_selector),
285 { MCMEMBER_REC_FIELD(mtu),
289 { MCMEMBER_REC_FIELD(traffic_class),
293 { MCMEMBER_REC_FIELD(pkey),
297 { MCMEMBER_REC_FIELD(rate_selector),
301 { MCMEMBER_REC_FIELD(rate),
305 { MCMEMBER_REC_FIELD(packet_life_time_selector),
309 { MCMEMBER_REC_FIELD(packet_life_time),
313 { MCMEMBER_REC_FIELD(sl),
317 { MCMEMBER_REC_FIELD(flow_label),
321 { MCMEMBER_REC_FIELD(hop_limit),
325 { MCMEMBER_REC_FIELD(scope),
329 { MCMEMBER_REC_FIELD(join_state),
333 { MCMEMBER_REC_FIELD(proxy_join),
343 static void free_sm_ah(struct kref *kref)
345 struct ib_sa_sm_ah *sm_ah = container_of(kref, struct ib_sa_sm_ah, ref);
347 ib_destroy_ah(sm_ah->ah);
351 static void update_sm_ah(void *port_ptr)
353 struct ib_sa_port *port = port_ptr;
354 struct ib_sa_sm_ah *new_ah, *old_ah;
355 struct ib_port_attr port_attr;
356 struct ib_ah_attr ah_attr;
358 if (ib_query_port(port->agent->device, port->port_num, &port_attr)) {
359 printk(KERN_WARNING "Couldn't query port\n");
363 new_ah = kmalloc(sizeof *new_ah, GFP_KERNEL);
365 printk(KERN_WARNING "Couldn't allocate new SM AH\n");
369 kref_init(&new_ah->ref);
371 memset(&ah_attr, 0, sizeof ah_attr);
372 ah_attr.dlid = port_attr.sm_lid;
373 ah_attr.sl = port_attr.sm_sl;
374 ah_attr.port_num = port->port_num;
376 new_ah->ah = ib_create_ah(port->agent->qp->pd, &ah_attr);
377 if (IS_ERR(new_ah->ah)) {
378 printk(KERN_WARNING "Couldn't create new SM AH\n");
383 spin_lock_irq(&port->ah_lock);
384 old_ah = port->sm_ah;
385 port->sm_ah = new_ah;
386 spin_unlock_irq(&port->ah_lock);
389 kref_put(&old_ah->ref, free_sm_ah);
392 static void ib_sa_event(struct ib_event_handler *handler, struct ib_event *event)
394 if (event->event == IB_EVENT_PORT_ERR ||
395 event->event == IB_EVENT_PORT_ACTIVE ||
396 event->event == IB_EVENT_LID_CHANGE ||
397 event->event == IB_EVENT_PKEY_CHANGE ||
398 event->event == IB_EVENT_SM_CHANGE) {
399 struct ib_sa_device *sa_dev =
400 ib_get_client_data(event->device, &sa_client);
402 schedule_work(&sa_dev->port[event->element.port_num -
403 sa_dev->start_port].update_task);
408 * ib_sa_cancel_query - try to cancel an SA query
409 * @id:ID of query to cancel
410 * @query:query pointer to cancel
412 * Try to cancel an SA query. If the id and query don't match up or
413 * the query has already completed, nothing is done. Otherwise the
414 * query is canceled and will complete with a status of -EINTR.
416 void ib_sa_cancel_query(int id, struct ib_sa_query *query)
419 struct ib_mad_agent *agent;
421 spin_lock_irqsave(&idr_lock, flags);
422 if (idr_find(&query_idr, id) != query) {
423 spin_unlock_irqrestore(&idr_lock, flags);
426 agent = query->port->agent;
427 spin_unlock_irqrestore(&idr_lock, flags);
429 ib_cancel_mad(agent, id);
431 EXPORT_SYMBOL(ib_sa_cancel_query);
433 static void init_mad(struct ib_sa_mad *mad, struct ib_mad_agent *agent)
437 memset(mad, 0, sizeof *mad);
439 mad->mad_hdr.base_version = IB_MGMT_BASE_VERSION;
440 mad->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
441 mad->mad_hdr.class_version = IB_SA_CLASS_VERSION;
443 spin_lock_irqsave(&tid_lock, flags);
445 cpu_to_be64(((u64) agent->hi_tid) << 32 | tid++);
446 spin_unlock_irqrestore(&tid_lock, flags);
449 static int send_mad(struct ib_sa_query *query, int timeout_ms)
451 struct ib_sa_port *port = query->port;
454 struct ib_sge gather_list;
455 struct ib_send_wr *bad_wr, wr = {
456 .opcode = IB_WR_SEND,
457 .sg_list = &gather_list,
459 .send_flags = IB_SEND_SIGNALED,
462 .mad_hdr = &query->mad->mad_hdr,
464 .remote_qkey = IB_QP1_QKEY,
465 .timeout_ms = timeout_ms,
472 if (!idr_pre_get(&query_idr, GFP_ATOMIC))
474 spin_lock_irqsave(&idr_lock, flags);
475 ret = idr_get_new(&query_idr, query, &query->id);
476 spin_unlock_irqrestore(&idr_lock, flags);
482 wr.wr_id = query->id;
484 spin_lock_irqsave(&port->ah_lock, flags);
485 kref_get(&port->sm_ah->ref);
486 query->sm_ah = port->sm_ah;
487 wr.wr.ud.ah = port->sm_ah->ah;
488 spin_unlock_irqrestore(&port->ah_lock, flags);
490 gather_list.addr = dma_map_single(port->agent->device->dma_device,
492 sizeof (struct ib_sa_mad),
494 gather_list.length = sizeof (struct ib_sa_mad);
495 gather_list.lkey = port->agent->mr->lkey;
496 pci_unmap_addr_set(query, mapping, gather_list.addr);
498 ret = ib_post_send_mad(port->agent, &wr, &bad_wr);
500 dma_unmap_single(port->agent->device->dma_device,
501 pci_unmap_addr(query, mapping),
502 sizeof (struct ib_sa_mad),
504 kref_put(&query->sm_ah->ref, free_sm_ah);
505 spin_lock_irqsave(&idr_lock, flags);
506 idr_remove(&query_idr, query->id);
507 spin_unlock_irqrestore(&idr_lock, flags);
511 * It's not safe to dereference query any more, because the
512 * send may already have completed and freed the query in
513 * another context. So use wr.wr_id, which has a copy of the
516 return ret ? ret : wr.wr_id;
519 static void ib_sa_path_rec_callback(struct ib_sa_query *sa_query,
521 struct ib_sa_mad *mad)
523 struct ib_sa_path_query *query =
524 container_of(sa_query, struct ib_sa_path_query, sa_query);
527 struct ib_sa_path_rec rec;
529 ib_unpack(path_rec_table, ARRAY_SIZE(path_rec_table),
531 query->callback(status, &rec, query->context);
533 query->callback(status, NULL, query->context);
536 static void ib_sa_path_rec_release(struct ib_sa_query *sa_query)
538 kfree(sa_query->mad);
539 kfree(container_of(sa_query, struct ib_sa_path_query, sa_query));
543 * ib_sa_path_rec_get - Start a Path get query
544 * @device:device to send query on
545 * @port_num: port number to send query on
546 * @rec:Path Record to send in query
547 * @comp_mask:component mask to send in query
548 * @timeout_ms:time to wait for response
549 * @gfp_mask:GFP mask to use for internal allocations
550 * @callback:function called when query completes, times out or is
552 * @context:opaque user context passed to callback
553 * @sa_query:query context, used to cancel query
555 * Send a Path Record Get query to the SA to look up a path. The
556 * callback function will be called when the query completes (or
557 * fails); status is 0 for a successful response, -EINTR if the query
558 * is canceled, -ETIMEDOUT is the query timed out, or -EIO if an error
559 * occurred sending the query. The resp parameter of the callback is
560 * only valid if status is 0.
562 * If the return value of ib_sa_path_rec_get() is negative, it is an
563 * error code. Otherwise it is a query ID that can be used to cancel
566 int ib_sa_path_rec_get(struct ib_device *device, u8 port_num,
567 struct ib_sa_path_rec *rec,
568 ib_sa_comp_mask comp_mask,
569 int timeout_ms, int gfp_mask,
570 void (*callback)(int status,
571 struct ib_sa_path_rec *resp,
574 struct ib_sa_query **sa_query)
576 struct ib_sa_path_query *query;
577 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
578 struct ib_sa_port *port = &sa_dev->port[port_num - sa_dev->start_port];
579 struct ib_mad_agent *agent = port->agent;
582 query = kmalloc(sizeof *query, gfp_mask);
585 query->sa_query.mad = kmalloc(sizeof *query->sa_query.mad, gfp_mask);
586 if (!query->sa_query.mad) {
591 query->callback = callback;
592 query->context = context;
594 init_mad(query->sa_query.mad, agent);
596 query->sa_query.callback = callback ? ib_sa_path_rec_callback : NULL;
597 query->sa_query.release = ib_sa_path_rec_release;
598 query->sa_query.port = port;
599 query->sa_query.mad->mad_hdr.method = IB_MGMT_METHOD_GET;
600 query->sa_query.mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_PATH_REC);
601 query->sa_query.mad->sa_hdr.comp_mask = comp_mask;
603 ib_pack(path_rec_table, ARRAY_SIZE(path_rec_table),
604 rec, query->sa_query.mad->data);
606 *sa_query = &query->sa_query;
608 ret = send_mad(&query->sa_query, timeout_ms);
611 kfree(query->sa_query.mad);
617 EXPORT_SYMBOL(ib_sa_path_rec_get);
619 static void ib_sa_mcmember_rec_callback(struct ib_sa_query *sa_query,
621 struct ib_sa_mad *mad)
623 struct ib_sa_mcmember_query *query =
624 container_of(sa_query, struct ib_sa_mcmember_query, sa_query);
627 struct ib_sa_mcmember_rec rec;
629 ib_unpack(mcmember_rec_table, ARRAY_SIZE(mcmember_rec_table),
631 query->callback(status, &rec, query->context);
633 query->callback(status, NULL, query->context);
636 static void ib_sa_mcmember_rec_release(struct ib_sa_query *sa_query)
638 kfree(sa_query->mad);
639 kfree(container_of(sa_query, struct ib_sa_mcmember_query, sa_query));
642 int ib_sa_mcmember_rec_query(struct ib_device *device, u8 port_num,
644 struct ib_sa_mcmember_rec *rec,
645 ib_sa_comp_mask comp_mask,
646 int timeout_ms, int gfp_mask,
647 void (*callback)(int status,
648 struct ib_sa_mcmember_rec *resp,
651 struct ib_sa_query **sa_query)
653 struct ib_sa_mcmember_query *query;
654 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
655 struct ib_sa_port *port = &sa_dev->port[port_num - sa_dev->start_port];
656 struct ib_mad_agent *agent = port->agent;
659 query = kmalloc(sizeof *query, gfp_mask);
662 query->sa_query.mad = kmalloc(sizeof *query->sa_query.mad, gfp_mask);
663 if (!query->sa_query.mad) {
668 query->callback = callback;
669 query->context = context;
671 init_mad(query->sa_query.mad, agent);
673 query->sa_query.callback = callback ? ib_sa_mcmember_rec_callback : NULL;
674 query->sa_query.release = ib_sa_mcmember_rec_release;
675 query->sa_query.port = port;
676 query->sa_query.mad->mad_hdr.method = method;
677 query->sa_query.mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_MC_MEMBER_REC);
678 query->sa_query.mad->sa_hdr.comp_mask = comp_mask;
680 ib_pack(mcmember_rec_table, ARRAY_SIZE(mcmember_rec_table),
681 rec, query->sa_query.mad->data);
683 *sa_query = &query->sa_query;
685 ret = send_mad(&query->sa_query, timeout_ms);
688 kfree(query->sa_query.mad);
694 EXPORT_SYMBOL(ib_sa_mcmember_rec_query);
696 static void send_handler(struct ib_mad_agent *agent,
697 struct ib_mad_send_wc *mad_send_wc)
699 struct ib_sa_query *query;
702 spin_lock_irqsave(&idr_lock, flags);
703 query = idr_find(&query_idr, mad_send_wc->wr_id);
704 spin_unlock_irqrestore(&idr_lock, flags);
710 switch (mad_send_wc->status) {
712 /* No callback -- already got recv */
714 case IB_WC_RESP_TIMEOUT_ERR:
715 query->callback(query, -ETIMEDOUT, NULL);
717 case IB_WC_WR_FLUSH_ERR:
718 query->callback(query, -EINTR, NULL);
721 query->callback(query, -EIO, NULL);
725 dma_unmap_single(agent->device->dma_device,
726 pci_unmap_addr(query, mapping),
727 sizeof (struct ib_sa_mad),
729 kref_put(&query->sm_ah->ref, free_sm_ah);
731 query->release(query);
733 spin_lock_irqsave(&idr_lock, flags);
734 idr_remove(&query_idr, mad_send_wc->wr_id);
735 spin_unlock_irqrestore(&idr_lock, flags);
738 static void recv_handler(struct ib_mad_agent *mad_agent,
739 struct ib_mad_recv_wc *mad_recv_wc)
741 struct ib_sa_query *query;
744 spin_lock_irqsave(&idr_lock, flags);
745 query = idr_find(&query_idr, mad_recv_wc->wc->wr_id);
746 spin_unlock_irqrestore(&idr_lock, flags);
748 if (query && query->callback) {
749 if (mad_recv_wc->wc->status == IB_WC_SUCCESS)
750 query->callback(query,
751 mad_recv_wc->recv_buf.mad->mad_hdr.status ?
753 (struct ib_sa_mad *) mad_recv_wc->recv_buf.mad);
755 query->callback(query, -EIO, NULL);
758 ib_free_recv_mad(mad_recv_wc);
761 static void ib_sa_add_one(struct ib_device *device)
763 struct ib_sa_device *sa_dev;
766 if (device->node_type == IB_NODE_SWITCH)
770 e = device->phys_port_cnt;
773 sa_dev = kmalloc(sizeof *sa_dev +
774 (e - s + 1) * sizeof (struct ib_sa_port),
779 sa_dev->start_port = s;
780 sa_dev->end_port = e;
782 for (i = 0; i <= e - s; ++i) {
783 sa_dev->port[i].sm_ah = NULL;
784 sa_dev->port[i].port_num = i + s;
785 spin_lock_init(&sa_dev->port[i].ah_lock);
787 sa_dev->port[i].agent =
788 ib_register_mad_agent(device, i + s, IB_QPT_GSI,
789 NULL, 0, send_handler,
790 recv_handler, sa_dev);
791 if (IS_ERR(sa_dev->port[i].agent))
794 INIT_WORK(&sa_dev->port[i].update_task,
795 update_sm_ah, &sa_dev->port[i]);
798 ib_set_client_data(device, &sa_client, sa_dev);
801 * We register our event handler after everything is set up,
802 * and then update our cached info after the event handler is
803 * registered to avoid any problems if a port changes state
804 * during our initialization.
807 INIT_IB_EVENT_HANDLER(&sa_dev->event_handler, device, ib_sa_event);
808 if (ib_register_event_handler(&sa_dev->event_handler))
811 for (i = 0; i <= e - s; ++i)
812 update_sm_ah(&sa_dev->port[i]);
818 ib_unregister_mad_agent(sa_dev->port[i].agent);
825 static void ib_sa_remove_one(struct ib_device *device)
827 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
833 ib_unregister_event_handler(&sa_dev->event_handler);
835 for (i = 0; i <= sa_dev->end_port - sa_dev->start_port; ++i) {
836 ib_unregister_mad_agent(sa_dev->port[i].agent);
837 kref_put(&sa_dev->port[i].sm_ah->ref, free_sm_ah);
843 static int __init ib_sa_init(void)
847 spin_lock_init(&idr_lock);
848 spin_lock_init(&tid_lock);
850 get_random_bytes(&tid, sizeof tid);
852 ret = ib_register_client(&sa_client);
854 printk(KERN_ERR "Couldn't register ib_sa client\n");
859 static void __exit ib_sa_cleanup(void)
861 ib_unregister_client(&sa_client);
864 module_init(ib_sa_init);
865 module_exit(ib_sa_cleanup);