2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
4 * Copyright (c) 2006 Intel Corporation. All rights reserved.
6 * This software is available to you under a choice of one of two
7 * licenses. You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
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/dma-mapping.h>
42 #include <linux/kref.h>
43 #include <linux/idr.h>
44 #include <linux/workqueue.h>
45 #include <uapi/linux/if_ether.h>
46 #include <rdma/ib_pack.h>
47 #include <rdma/ib_cache.h>
48 #include <rdma/rdma_netlink.h>
49 #include <net/netlink.h>
50 #include <uapi/rdma/ib_user_sa.h>
51 #include <rdma/ib_marshall.h>
52 #include <rdma/ib_addr.h>
53 #include <rdma/opa_addr.h>
55 #include "core_priv.h"
57 #define IB_SA_LOCAL_SVC_TIMEOUT_MIN 100
58 #define IB_SA_LOCAL_SVC_TIMEOUT_DEFAULT 2000
59 #define IB_SA_LOCAL_SVC_TIMEOUT_MAX 200000
60 #define IB_SA_CPI_MAX_RETRY_CNT 3
61 #define IB_SA_CPI_RETRY_WAIT 1000 /*msecs */
62 static int sa_local_svc_timeout_ms = IB_SA_LOCAL_SVC_TIMEOUT_DEFAULT;
71 enum rdma_class_port_info_type {
72 RDMA_CLASS_PORT_INFO_IB,
73 RDMA_CLASS_PORT_INFO_OPA
76 struct rdma_class_port_info {
77 enum rdma_class_port_info_type type;
79 struct ib_class_port_info ib;
80 struct opa_class_port_info opa;
84 struct ib_sa_classport_cache {
87 struct rdma_class_port_info data;
91 struct ib_mad_agent *agent;
92 struct ib_sa_sm_ah *sm_ah;
93 struct work_struct update_task;
94 struct ib_sa_classport_cache classport_info;
95 struct delayed_work ib_cpi_work;
96 spinlock_t classport_lock; /* protects class port info set */
101 struct ib_sa_device {
102 int start_port, end_port;
103 struct ib_event_handler event_handler;
104 struct ib_sa_port port[0];
108 void (*callback)(struct ib_sa_query *, int, struct ib_sa_mad *);
109 void (*release)(struct ib_sa_query *);
110 struct ib_sa_client *client;
111 struct ib_sa_port *port;
112 struct ib_mad_send_buf *mad_buf;
113 struct ib_sa_sm_ah *sm_ah;
116 struct list_head list; /* Local svc request list */
117 u32 seq; /* Local svc request sequence number */
118 unsigned long timeout; /* Local svc timeout */
119 u8 path_use; /* How will the pathrecord be used */
122 #define IB_SA_ENABLE_LOCAL_SERVICE 0x00000001
123 #define IB_SA_CANCEL 0x00000002
124 #define IB_SA_QUERY_OPA 0x00000004
126 struct ib_sa_service_query {
127 void (*callback)(int, struct ib_sa_service_rec *, void *);
129 struct ib_sa_query sa_query;
132 struct ib_sa_path_query {
133 void (*callback)(int, struct sa_path_rec *, void *);
135 struct ib_sa_query sa_query;
136 struct sa_path_rec *conv_pr;
139 struct ib_sa_guidinfo_query {
140 void (*callback)(int, struct ib_sa_guidinfo_rec *, void *);
142 struct ib_sa_query sa_query;
145 struct ib_sa_classport_info_query {
146 void (*callback)(void *);
148 struct ib_sa_query sa_query;
151 struct ib_sa_mcmember_query {
152 void (*callback)(int, struct ib_sa_mcmember_rec *, void *);
154 struct ib_sa_query sa_query;
157 static LIST_HEAD(ib_nl_request_list);
158 static DEFINE_SPINLOCK(ib_nl_request_lock);
159 static atomic_t ib_nl_sa_request_seq;
160 static struct workqueue_struct *ib_nl_wq;
161 static struct delayed_work ib_nl_timed_work;
162 static const struct nla_policy ib_nl_policy[LS_NLA_TYPE_MAX] = {
163 [LS_NLA_TYPE_PATH_RECORD] = {.type = NLA_BINARY,
164 .len = sizeof(struct ib_path_rec_data)},
165 [LS_NLA_TYPE_TIMEOUT] = {.type = NLA_U32},
166 [LS_NLA_TYPE_SERVICE_ID] = {.type = NLA_U64},
167 [LS_NLA_TYPE_DGID] = {.type = NLA_BINARY,
168 .len = sizeof(struct rdma_nla_ls_gid)},
169 [LS_NLA_TYPE_SGID] = {.type = NLA_BINARY,
170 .len = sizeof(struct rdma_nla_ls_gid)},
171 [LS_NLA_TYPE_TCLASS] = {.type = NLA_U8},
172 [LS_NLA_TYPE_PKEY] = {.type = NLA_U16},
173 [LS_NLA_TYPE_QOS_CLASS] = {.type = NLA_U16},
177 static void ib_sa_add_one(struct ib_device *device);
178 static void ib_sa_remove_one(struct ib_device *device, void *client_data);
180 static struct ib_client sa_client = {
182 .add = ib_sa_add_one,
183 .remove = ib_sa_remove_one
186 static DEFINE_SPINLOCK(idr_lock);
187 static DEFINE_IDR(query_idr);
189 static DEFINE_SPINLOCK(tid_lock);
192 #define PATH_REC_FIELD(field) \
193 .struct_offset_bytes = offsetof(struct sa_path_rec, field), \
194 .struct_size_bytes = sizeof((struct sa_path_rec *)0)->field, \
195 .field_name = "sa_path_rec:" #field
197 static const struct ib_field path_rec_table[] = {
198 { PATH_REC_FIELD(service_id),
202 { PATH_REC_FIELD(dgid),
206 { PATH_REC_FIELD(sgid),
210 { PATH_REC_FIELD(ib.dlid),
214 { PATH_REC_FIELD(ib.slid),
218 { PATH_REC_FIELD(ib.raw_traffic),
226 { PATH_REC_FIELD(flow_label),
230 { PATH_REC_FIELD(hop_limit),
234 { PATH_REC_FIELD(traffic_class),
238 { PATH_REC_FIELD(reversible),
242 { PATH_REC_FIELD(numb_path),
246 { PATH_REC_FIELD(pkey),
250 { PATH_REC_FIELD(qos_class),
254 { PATH_REC_FIELD(sl),
258 { PATH_REC_FIELD(mtu_selector),
262 { PATH_REC_FIELD(mtu),
266 { PATH_REC_FIELD(rate_selector),
270 { PATH_REC_FIELD(rate),
274 { PATH_REC_FIELD(packet_life_time_selector),
278 { PATH_REC_FIELD(packet_life_time),
282 { PATH_REC_FIELD(preference),
292 #define OPA_PATH_REC_FIELD(field) \
293 .struct_offset_bytes = \
294 offsetof(struct sa_path_rec, field), \
295 .struct_size_bytes = \
296 sizeof((struct sa_path_rec *)0)->field, \
297 .field_name = "sa_path_rec:" #field
299 static const struct ib_field opa_path_rec_table[] = {
300 { OPA_PATH_REC_FIELD(service_id),
304 { OPA_PATH_REC_FIELD(dgid),
308 { OPA_PATH_REC_FIELD(sgid),
312 { OPA_PATH_REC_FIELD(opa.dlid),
316 { OPA_PATH_REC_FIELD(opa.slid),
320 { OPA_PATH_REC_FIELD(opa.raw_traffic),
328 { OPA_PATH_REC_FIELD(flow_label),
332 { OPA_PATH_REC_FIELD(hop_limit),
336 { OPA_PATH_REC_FIELD(traffic_class),
340 { OPA_PATH_REC_FIELD(reversible),
344 { OPA_PATH_REC_FIELD(numb_path),
348 { OPA_PATH_REC_FIELD(pkey),
352 { OPA_PATH_REC_FIELD(opa.l2_8B),
356 { OPA_PATH_REC_FIELD(opa.l2_10B),
360 { OPA_PATH_REC_FIELD(opa.l2_9B),
364 { OPA_PATH_REC_FIELD(opa.l2_16B),
372 { OPA_PATH_REC_FIELD(opa.qos_type),
376 { OPA_PATH_REC_FIELD(opa.qos_priority),
384 { OPA_PATH_REC_FIELD(sl),
392 { OPA_PATH_REC_FIELD(mtu_selector),
396 { OPA_PATH_REC_FIELD(mtu),
400 { OPA_PATH_REC_FIELD(rate_selector),
404 { OPA_PATH_REC_FIELD(rate),
408 { OPA_PATH_REC_FIELD(packet_life_time_selector),
412 { OPA_PATH_REC_FIELD(packet_life_time),
416 { OPA_PATH_REC_FIELD(preference),
422 #define MCMEMBER_REC_FIELD(field) \
423 .struct_offset_bytes = offsetof(struct ib_sa_mcmember_rec, field), \
424 .struct_size_bytes = sizeof ((struct ib_sa_mcmember_rec *) 0)->field, \
425 .field_name = "sa_mcmember_rec:" #field
427 static const struct ib_field mcmember_rec_table[] = {
428 { MCMEMBER_REC_FIELD(mgid),
432 { MCMEMBER_REC_FIELD(port_gid),
436 { MCMEMBER_REC_FIELD(qkey),
440 { MCMEMBER_REC_FIELD(mlid),
444 { MCMEMBER_REC_FIELD(mtu_selector),
448 { MCMEMBER_REC_FIELD(mtu),
452 { MCMEMBER_REC_FIELD(traffic_class),
456 { MCMEMBER_REC_FIELD(pkey),
460 { MCMEMBER_REC_FIELD(rate_selector),
464 { MCMEMBER_REC_FIELD(rate),
468 { MCMEMBER_REC_FIELD(packet_life_time_selector),
472 { MCMEMBER_REC_FIELD(packet_life_time),
476 { MCMEMBER_REC_FIELD(sl),
480 { MCMEMBER_REC_FIELD(flow_label),
484 { MCMEMBER_REC_FIELD(hop_limit),
488 { MCMEMBER_REC_FIELD(scope),
492 { MCMEMBER_REC_FIELD(join_state),
496 { MCMEMBER_REC_FIELD(proxy_join),
506 #define SERVICE_REC_FIELD(field) \
507 .struct_offset_bytes = offsetof(struct ib_sa_service_rec, field), \
508 .struct_size_bytes = sizeof ((struct ib_sa_service_rec *) 0)->field, \
509 .field_name = "sa_service_rec:" #field
511 static const struct ib_field service_rec_table[] = {
512 { SERVICE_REC_FIELD(id),
516 { SERVICE_REC_FIELD(gid),
520 { SERVICE_REC_FIELD(pkey),
524 { SERVICE_REC_FIELD(lease),
528 { SERVICE_REC_FIELD(key),
532 { SERVICE_REC_FIELD(name),
536 { SERVICE_REC_FIELD(data8),
540 { SERVICE_REC_FIELD(data16),
544 { SERVICE_REC_FIELD(data32),
548 { SERVICE_REC_FIELD(data64),
554 #define CLASSPORTINFO_REC_FIELD(field) \
555 .struct_offset_bytes = offsetof(struct ib_class_port_info, field), \
556 .struct_size_bytes = sizeof((struct ib_class_port_info *)0)->field, \
557 .field_name = "ib_class_port_info:" #field
559 static const struct ib_field ib_classport_info_rec_table[] = {
560 { CLASSPORTINFO_REC_FIELD(base_version),
564 { CLASSPORTINFO_REC_FIELD(class_version),
568 { CLASSPORTINFO_REC_FIELD(capability_mask),
572 { CLASSPORTINFO_REC_FIELD(cap_mask2_resp_time),
576 { CLASSPORTINFO_REC_FIELD(redirect_gid),
580 { CLASSPORTINFO_REC_FIELD(redirect_tcslfl),
584 { CLASSPORTINFO_REC_FIELD(redirect_lid),
588 { CLASSPORTINFO_REC_FIELD(redirect_pkey),
593 { CLASSPORTINFO_REC_FIELD(redirect_qp),
597 { CLASSPORTINFO_REC_FIELD(redirect_qkey),
602 { CLASSPORTINFO_REC_FIELD(trap_gid),
606 { CLASSPORTINFO_REC_FIELD(trap_tcslfl),
611 { CLASSPORTINFO_REC_FIELD(trap_lid),
615 { CLASSPORTINFO_REC_FIELD(trap_pkey),
620 { CLASSPORTINFO_REC_FIELD(trap_hlqp),
624 { CLASSPORTINFO_REC_FIELD(trap_qkey),
630 #define OPA_CLASSPORTINFO_REC_FIELD(field) \
631 .struct_offset_bytes =\
632 offsetof(struct opa_class_port_info, field), \
633 .struct_size_bytes = \
634 sizeof((struct opa_class_port_info *)0)->field, \
635 .field_name = "opa_class_port_info:" #field
637 static const struct ib_field opa_classport_info_rec_table[] = {
638 { OPA_CLASSPORTINFO_REC_FIELD(base_version),
642 { OPA_CLASSPORTINFO_REC_FIELD(class_version),
646 { OPA_CLASSPORTINFO_REC_FIELD(cap_mask),
650 { OPA_CLASSPORTINFO_REC_FIELD(cap_mask2_resp_time),
654 { OPA_CLASSPORTINFO_REC_FIELD(redirect_gid),
658 { OPA_CLASSPORTINFO_REC_FIELD(redirect_tc_fl),
662 { OPA_CLASSPORTINFO_REC_FIELD(redirect_lid),
666 { OPA_CLASSPORTINFO_REC_FIELD(redirect_sl_qp),
670 { OPA_CLASSPORTINFO_REC_FIELD(redirect_qkey),
674 { OPA_CLASSPORTINFO_REC_FIELD(trap_gid),
678 { OPA_CLASSPORTINFO_REC_FIELD(trap_tc_fl),
682 { OPA_CLASSPORTINFO_REC_FIELD(trap_lid),
686 { OPA_CLASSPORTINFO_REC_FIELD(trap_hl_qp),
690 { OPA_CLASSPORTINFO_REC_FIELD(trap_qkey),
694 { OPA_CLASSPORTINFO_REC_FIELD(trap_pkey),
698 { OPA_CLASSPORTINFO_REC_FIELD(redirect_pkey),
702 { OPA_CLASSPORTINFO_REC_FIELD(trap_sl_rsvd),
712 #define GUIDINFO_REC_FIELD(field) \
713 .struct_offset_bytes = offsetof(struct ib_sa_guidinfo_rec, field), \
714 .struct_size_bytes = sizeof((struct ib_sa_guidinfo_rec *) 0)->field, \
715 .field_name = "sa_guidinfo_rec:" #field
717 static const struct ib_field guidinfo_rec_table[] = {
718 { GUIDINFO_REC_FIELD(lid),
722 { GUIDINFO_REC_FIELD(block_num),
726 { GUIDINFO_REC_FIELD(res1),
730 { GUIDINFO_REC_FIELD(res2),
734 { GUIDINFO_REC_FIELD(guid_info_list),
740 static inline void ib_sa_disable_local_svc(struct ib_sa_query *query)
742 query->flags &= ~IB_SA_ENABLE_LOCAL_SERVICE;
745 static inline int ib_sa_query_cancelled(struct ib_sa_query *query)
747 return (query->flags & IB_SA_CANCEL);
750 static void ib_nl_set_path_rec_attrs(struct sk_buff *skb,
751 struct ib_sa_query *query)
753 struct sa_path_rec *sa_rec = query->mad_buf->context[1];
754 struct ib_sa_mad *mad = query->mad_buf->mad;
755 ib_sa_comp_mask comp_mask = mad->sa_hdr.comp_mask;
758 struct rdma_ls_resolve_header *header;
760 query->mad_buf->context[1] = NULL;
762 /* Construct the family header first */
763 header = skb_put(skb, NLMSG_ALIGN(sizeof(*header)));
764 memcpy(header->device_name, query->port->agent->device->name,
766 header->port_num = query->port->port_num;
768 if ((comp_mask & IB_SA_PATH_REC_REVERSIBLE) &&
769 sa_rec->reversible != 0)
770 query->path_use = LS_RESOLVE_PATH_USE_GMP;
772 query->path_use = LS_RESOLVE_PATH_USE_UNIDIRECTIONAL;
773 header->path_use = query->path_use;
775 /* Now build the attributes */
776 if (comp_mask & IB_SA_PATH_REC_SERVICE_ID) {
777 val64 = be64_to_cpu(sa_rec->service_id);
778 nla_put(skb, RDMA_NLA_F_MANDATORY | LS_NLA_TYPE_SERVICE_ID,
779 sizeof(val64), &val64);
781 if (comp_mask & IB_SA_PATH_REC_DGID)
782 nla_put(skb, RDMA_NLA_F_MANDATORY | LS_NLA_TYPE_DGID,
783 sizeof(sa_rec->dgid), &sa_rec->dgid);
784 if (comp_mask & IB_SA_PATH_REC_SGID)
785 nla_put(skb, RDMA_NLA_F_MANDATORY | LS_NLA_TYPE_SGID,
786 sizeof(sa_rec->sgid), &sa_rec->sgid);
787 if (comp_mask & IB_SA_PATH_REC_TRAFFIC_CLASS)
788 nla_put(skb, RDMA_NLA_F_MANDATORY | LS_NLA_TYPE_TCLASS,
789 sizeof(sa_rec->traffic_class), &sa_rec->traffic_class);
791 if (comp_mask & IB_SA_PATH_REC_PKEY) {
792 val16 = be16_to_cpu(sa_rec->pkey);
793 nla_put(skb, RDMA_NLA_F_MANDATORY | LS_NLA_TYPE_PKEY,
794 sizeof(val16), &val16);
796 if (comp_mask & IB_SA_PATH_REC_QOS_CLASS) {
797 val16 = be16_to_cpu(sa_rec->qos_class);
798 nla_put(skb, RDMA_NLA_F_MANDATORY | LS_NLA_TYPE_QOS_CLASS,
799 sizeof(val16), &val16);
803 static int ib_nl_get_path_rec_attrs_len(ib_sa_comp_mask comp_mask)
807 if (comp_mask & IB_SA_PATH_REC_SERVICE_ID)
808 len += nla_total_size(sizeof(u64));
809 if (comp_mask & IB_SA_PATH_REC_DGID)
810 len += nla_total_size(sizeof(struct rdma_nla_ls_gid));
811 if (comp_mask & IB_SA_PATH_REC_SGID)
812 len += nla_total_size(sizeof(struct rdma_nla_ls_gid));
813 if (comp_mask & IB_SA_PATH_REC_TRAFFIC_CLASS)
814 len += nla_total_size(sizeof(u8));
815 if (comp_mask & IB_SA_PATH_REC_PKEY)
816 len += nla_total_size(sizeof(u16));
817 if (comp_mask & IB_SA_PATH_REC_QOS_CLASS)
818 len += nla_total_size(sizeof(u16));
821 * Make sure that at least some of the required comp_mask bits are
824 if (WARN_ON(len == 0))
827 /* Add the family header */
828 len += NLMSG_ALIGN(sizeof(struct rdma_ls_resolve_header));
833 static int ib_nl_send_msg(struct ib_sa_query *query, gfp_t gfp_mask)
835 struct sk_buff *skb = NULL;
836 struct nlmsghdr *nlh;
839 struct ib_sa_mad *mad;
842 mad = query->mad_buf->mad;
843 len = ib_nl_get_path_rec_attrs_len(mad->sa_hdr.comp_mask);
847 skb = nlmsg_new(len, gfp_mask);
851 /* Put nlmsg header only for now */
852 data = ibnl_put_msg(skb, &nlh, query->seq, 0, RDMA_NL_LS,
853 RDMA_NL_LS_OP_RESOLVE, NLM_F_REQUEST);
860 ib_nl_set_path_rec_attrs(skb, query);
862 /* Repair the nlmsg header length */
865 ret = rdma_nl_multicast(skb, RDMA_NL_GROUP_LS, gfp_mask);
874 static int ib_nl_make_request(struct ib_sa_query *query, gfp_t gfp_mask)
880 INIT_LIST_HEAD(&query->list);
881 query->seq = (u32)atomic_inc_return(&ib_nl_sa_request_seq);
883 /* Put the request on the list first.*/
884 spin_lock_irqsave(&ib_nl_request_lock, flags);
885 delay = msecs_to_jiffies(sa_local_svc_timeout_ms);
886 query->timeout = delay + jiffies;
887 list_add_tail(&query->list, &ib_nl_request_list);
888 /* Start the timeout if this is the only request */
889 if (ib_nl_request_list.next == &query->list)
890 queue_delayed_work(ib_nl_wq, &ib_nl_timed_work, delay);
891 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
893 ret = ib_nl_send_msg(query, gfp_mask);
896 /* Remove the request */
897 spin_lock_irqsave(&ib_nl_request_lock, flags);
898 list_del(&query->list);
899 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
907 static int ib_nl_cancel_request(struct ib_sa_query *query)
910 struct ib_sa_query *wait_query;
913 spin_lock_irqsave(&ib_nl_request_lock, flags);
914 list_for_each_entry(wait_query, &ib_nl_request_list, list) {
915 /* Let the timeout to take care of the callback */
916 if (query == wait_query) {
917 query->flags |= IB_SA_CANCEL;
918 query->timeout = jiffies;
919 list_move(&query->list, &ib_nl_request_list);
921 mod_delayed_work(ib_nl_wq, &ib_nl_timed_work, 1);
925 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
930 static void send_handler(struct ib_mad_agent *agent,
931 struct ib_mad_send_wc *mad_send_wc);
933 static void ib_nl_process_good_resolve_rsp(struct ib_sa_query *query,
934 const struct nlmsghdr *nlh)
936 struct ib_mad_send_wc mad_send_wc;
937 struct ib_sa_mad *mad = NULL;
938 const struct nlattr *head, *curr;
939 struct ib_path_rec_data *rec;
944 if (query->callback) {
945 head = (const struct nlattr *) nlmsg_data(nlh);
946 len = nlmsg_len(nlh);
947 switch (query->path_use) {
948 case LS_RESOLVE_PATH_USE_UNIDIRECTIONAL:
949 mask = IB_PATH_PRIMARY | IB_PATH_OUTBOUND;
952 case LS_RESOLVE_PATH_USE_ALL:
953 case LS_RESOLVE_PATH_USE_GMP:
955 mask = IB_PATH_PRIMARY | IB_PATH_GMP |
956 IB_PATH_BIDIRECTIONAL;
959 nla_for_each_attr(curr, head, len, rem) {
960 if (curr->nla_type == LS_NLA_TYPE_PATH_RECORD) {
961 rec = nla_data(curr);
963 * Get the first one. In the future, we may
964 * need to get up to 6 pathrecords.
966 if ((rec->flags & mask) == mask) {
967 mad = query->mad_buf->mad;
968 mad->mad_hdr.method |=
970 memcpy(mad->data, rec->path_rec,
971 sizeof(rec->path_rec));
977 query->callback(query, status, mad);
980 mad_send_wc.send_buf = query->mad_buf;
981 mad_send_wc.status = IB_WC_SUCCESS;
982 send_handler(query->mad_buf->mad_agent, &mad_send_wc);
985 static void ib_nl_request_timeout(struct work_struct *work)
988 struct ib_sa_query *query;
990 struct ib_mad_send_wc mad_send_wc;
993 spin_lock_irqsave(&ib_nl_request_lock, flags);
994 while (!list_empty(&ib_nl_request_list)) {
995 query = list_entry(ib_nl_request_list.next,
996 struct ib_sa_query, list);
998 if (time_after(query->timeout, jiffies)) {
999 delay = query->timeout - jiffies;
1000 if ((long)delay <= 0)
1002 queue_delayed_work(ib_nl_wq, &ib_nl_timed_work, delay);
1006 list_del(&query->list);
1007 ib_sa_disable_local_svc(query);
1008 /* Hold the lock to protect against query cancellation */
1009 if (ib_sa_query_cancelled(query))
1012 ret = ib_post_send_mad(query->mad_buf, NULL);
1014 mad_send_wc.send_buf = query->mad_buf;
1015 mad_send_wc.status = IB_WC_WR_FLUSH_ERR;
1016 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
1017 send_handler(query->port->agent, &mad_send_wc);
1018 spin_lock_irqsave(&ib_nl_request_lock, flags);
1021 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
1024 int ib_nl_handle_set_timeout(struct sk_buff *skb,
1025 struct nlmsghdr *nlh,
1026 struct netlink_ext_ack *extack)
1028 int timeout, delta, abs_delta;
1029 const struct nlattr *attr;
1030 unsigned long flags;
1031 struct ib_sa_query *query;
1033 struct nlattr *tb[LS_NLA_TYPE_MAX];
1036 if (!(nlh->nlmsg_flags & NLM_F_REQUEST) ||
1037 !(NETLINK_CB(skb).sk))
1040 ret = nla_parse(tb, LS_NLA_TYPE_MAX - 1, nlmsg_data(nlh),
1041 nlmsg_len(nlh), ib_nl_policy, NULL);
1042 attr = (const struct nlattr *)tb[LS_NLA_TYPE_TIMEOUT];
1044 goto settimeout_out;
1046 timeout = *(int *) nla_data(attr);
1047 if (timeout < IB_SA_LOCAL_SVC_TIMEOUT_MIN)
1048 timeout = IB_SA_LOCAL_SVC_TIMEOUT_MIN;
1049 if (timeout > IB_SA_LOCAL_SVC_TIMEOUT_MAX)
1050 timeout = IB_SA_LOCAL_SVC_TIMEOUT_MAX;
1052 delta = timeout - sa_local_svc_timeout_ms;
1059 spin_lock_irqsave(&ib_nl_request_lock, flags);
1060 sa_local_svc_timeout_ms = timeout;
1061 list_for_each_entry(query, &ib_nl_request_list, list) {
1062 if (delta < 0 && abs_delta > query->timeout)
1065 query->timeout += delta;
1067 /* Get the new delay from the first entry */
1069 delay = query->timeout - jiffies;
1075 mod_delayed_work(ib_nl_wq, &ib_nl_timed_work,
1076 (unsigned long)delay);
1077 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
1084 static inline int ib_nl_is_good_resolve_resp(const struct nlmsghdr *nlh)
1086 struct nlattr *tb[LS_NLA_TYPE_MAX];
1089 if (nlh->nlmsg_flags & RDMA_NL_LS_F_ERR)
1092 ret = nla_parse(tb, LS_NLA_TYPE_MAX - 1, nlmsg_data(nlh),
1093 nlmsg_len(nlh), ib_nl_policy, NULL);
1100 int ib_nl_handle_resolve_resp(struct sk_buff *skb,
1101 struct nlmsghdr *nlh,
1102 struct netlink_ext_ack *extack)
1104 unsigned long flags;
1105 struct ib_sa_query *query;
1106 struct ib_mad_send_buf *send_buf;
1107 struct ib_mad_send_wc mad_send_wc;
1111 if ((nlh->nlmsg_flags & NLM_F_REQUEST) ||
1112 !(NETLINK_CB(skb).sk))
1115 spin_lock_irqsave(&ib_nl_request_lock, flags);
1116 list_for_each_entry(query, &ib_nl_request_list, list) {
1118 * If the query is cancelled, let the timeout routine
1121 if (nlh->nlmsg_seq == query->seq) {
1122 found = !ib_sa_query_cancelled(query);
1124 list_del(&query->list);
1130 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
1134 send_buf = query->mad_buf;
1136 if (!ib_nl_is_good_resolve_resp(nlh)) {
1137 /* if the result is a failure, send out the packet via IB */
1138 ib_sa_disable_local_svc(query);
1139 ret = ib_post_send_mad(query->mad_buf, NULL);
1140 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
1142 mad_send_wc.send_buf = send_buf;
1143 mad_send_wc.status = IB_WC_GENERAL_ERR;
1144 send_handler(query->port->agent, &mad_send_wc);
1147 spin_unlock_irqrestore(&ib_nl_request_lock, flags);
1148 ib_nl_process_good_resolve_rsp(query, nlh);
1155 static void free_sm_ah(struct kref *kref)
1157 struct ib_sa_sm_ah *sm_ah = container_of(kref, struct ib_sa_sm_ah, ref);
1159 rdma_destroy_ah(sm_ah->ah);
1163 void ib_sa_register_client(struct ib_sa_client *client)
1165 atomic_set(&client->users, 1);
1166 init_completion(&client->comp);
1168 EXPORT_SYMBOL(ib_sa_register_client);
1170 void ib_sa_unregister_client(struct ib_sa_client *client)
1172 ib_sa_client_put(client);
1173 wait_for_completion(&client->comp);
1175 EXPORT_SYMBOL(ib_sa_unregister_client);
1178 * ib_sa_cancel_query - try to cancel an SA query
1179 * @id:ID of query to cancel
1180 * @query:query pointer to cancel
1182 * Try to cancel an SA query. If the id and query don't match up or
1183 * the query has already completed, nothing is done. Otherwise the
1184 * query is canceled and will complete with a status of -EINTR.
1186 void ib_sa_cancel_query(int id, struct ib_sa_query *query)
1188 unsigned long flags;
1189 struct ib_mad_agent *agent;
1190 struct ib_mad_send_buf *mad_buf;
1192 spin_lock_irqsave(&idr_lock, flags);
1193 if (idr_find(&query_idr, id) != query) {
1194 spin_unlock_irqrestore(&idr_lock, flags);
1197 agent = query->port->agent;
1198 mad_buf = query->mad_buf;
1199 spin_unlock_irqrestore(&idr_lock, flags);
1202 * If the query is still on the netlink request list, schedule
1203 * it to be cancelled by the timeout routine. Otherwise, it has been
1204 * sent to the MAD layer and has to be cancelled from there.
1206 if (!ib_nl_cancel_request(query))
1207 ib_cancel_mad(agent, mad_buf);
1209 EXPORT_SYMBOL(ib_sa_cancel_query);
1211 static u8 get_src_path_mask(struct ib_device *device, u8 port_num)
1213 struct ib_sa_device *sa_dev;
1214 struct ib_sa_port *port;
1215 unsigned long flags;
1218 sa_dev = ib_get_client_data(device, &sa_client);
1222 port = &sa_dev->port[port_num - sa_dev->start_port];
1223 spin_lock_irqsave(&port->ah_lock, flags);
1224 src_path_mask = port->sm_ah ? port->sm_ah->src_path_mask : 0x7f;
1225 spin_unlock_irqrestore(&port->ah_lock, flags);
1227 return src_path_mask;
1230 static int roce_resolve_route_from_path(struct sa_path_rec *rec,
1231 const struct ib_gid_attr *attr)
1233 struct rdma_dev_addr dev_addr = {};
1235 struct sockaddr _sockaddr;
1236 struct sockaddr_in _sockaddr_in;
1237 struct sockaddr_in6 _sockaddr_in6;
1238 } sgid_addr, dgid_addr;
1241 if (rec->roce.route_resolved)
1243 if (!attr || !attr->ndev)
1246 dev_addr.bound_dev_if = attr->ndev->ifindex;
1247 /* TODO: Use net from the ib_gid_attr once it is added to it,
1248 * until than, limit itself to init_net.
1250 dev_addr.net = &init_net;
1252 rdma_gid2ip(&sgid_addr._sockaddr, &rec->sgid);
1253 rdma_gid2ip(&dgid_addr._sockaddr, &rec->dgid);
1255 /* validate the route */
1256 ret = rdma_resolve_ip_route(&sgid_addr._sockaddr,
1257 &dgid_addr._sockaddr, &dev_addr);
1261 if ((dev_addr.network == RDMA_NETWORK_IPV4 ||
1262 dev_addr.network == RDMA_NETWORK_IPV6) &&
1263 rec->rec_type != SA_PATH_REC_TYPE_ROCE_V2)
1266 rec->roce.route_resolved = true;
1270 static int init_ah_attr_grh_fields(struct ib_device *device, u8 port_num,
1271 struct sa_path_rec *rec,
1272 struct rdma_ah_attr *ah_attr,
1273 const struct ib_gid_attr *gid_attr)
1275 enum ib_gid_type type = sa_conv_pathrec_to_gid_type(rec);
1278 gid_attr = rdma_find_gid_by_port(device, &rec->sgid, type,
1280 if (IS_ERR(gid_attr))
1281 return PTR_ERR(gid_attr);
1283 rdma_hold_gid_attr(gid_attr);
1285 rdma_move_grh_sgid_attr(ah_attr, &rec->dgid,
1286 be32_to_cpu(rec->flow_label),
1287 rec->hop_limit, rec->traffic_class,
1293 * ib_init_ah_attr_from_path - Initialize address handle attributes based on
1294 * an SA path record.
1295 * @device: Device associated ah attributes initialization.
1296 * @port_num: Port on the specified device.
1297 * @rec: path record entry to use for ah attributes initialization.
1298 * @ah_attr: address handle attributes to initialization from path record.
1299 * @sgid_attr: SGID attribute to consider during initialization.
1301 * When ib_init_ah_attr_from_path() returns success,
1302 * (a) for IB link layer it optionally contains a reference to SGID attribute
1303 * when GRH is present for IB link layer.
1304 * (b) for RoCE link layer it contains a reference to SGID attribute.
1305 * User must invoke rdma_destroy_ah_attr() to release reference to SGID
1306 * attributes which are initialized using ib_init_ah_attr_from_path().
1308 int ib_init_ah_attr_from_path(struct ib_device *device, u8 port_num,
1309 struct sa_path_rec *rec,
1310 struct rdma_ah_attr *ah_attr,
1311 const struct ib_gid_attr *gid_attr)
1315 memset(ah_attr, 0, sizeof(*ah_attr));
1316 ah_attr->type = rdma_ah_find_type(device, port_num);
1317 rdma_ah_set_sl(ah_attr, rec->sl);
1318 rdma_ah_set_port_num(ah_attr, port_num);
1319 rdma_ah_set_static_rate(ah_attr, rec->rate);
1321 if (sa_path_is_roce(rec)) {
1322 ret = roce_resolve_route_from_path(rec, gid_attr);
1326 memcpy(ah_attr->roce.dmac, sa_path_get_dmac(rec), ETH_ALEN);
1328 rdma_ah_set_dlid(ah_attr, be32_to_cpu(sa_path_get_dlid(rec)));
1329 if (sa_path_is_opa(rec) &&
1330 rdma_ah_get_dlid(ah_attr) == be16_to_cpu(IB_LID_PERMISSIVE))
1331 rdma_ah_set_make_grd(ah_attr, true);
1333 rdma_ah_set_path_bits(ah_attr,
1334 be32_to_cpu(sa_path_get_slid(rec)) &
1335 get_src_path_mask(device, port_num));
1338 if (rec->hop_limit > 0 || sa_path_is_roce(rec))
1339 ret = init_ah_attr_grh_fields(device, port_num,
1340 rec, ah_attr, gid_attr);
1343 EXPORT_SYMBOL(ib_init_ah_attr_from_path);
1345 static int alloc_mad(struct ib_sa_query *query, gfp_t gfp_mask)
1347 struct rdma_ah_attr ah_attr;
1348 unsigned long flags;
1350 spin_lock_irqsave(&query->port->ah_lock, flags);
1351 if (!query->port->sm_ah) {
1352 spin_unlock_irqrestore(&query->port->ah_lock, flags);
1355 kref_get(&query->port->sm_ah->ref);
1356 query->sm_ah = query->port->sm_ah;
1357 spin_unlock_irqrestore(&query->port->ah_lock, flags);
1360 * Always check if sm_ah has valid dlid assigned,
1361 * before querying for class port info
1363 if ((rdma_query_ah(query->sm_ah->ah, &ah_attr) < 0) ||
1364 !rdma_is_valid_unicast_lid(&ah_attr)) {
1365 kref_put(&query->sm_ah->ref, free_sm_ah);
1368 query->mad_buf = ib_create_send_mad(query->port->agent, 1,
1369 query->sm_ah->pkey_index,
1370 0, IB_MGMT_SA_HDR, IB_MGMT_SA_DATA,
1372 ((query->flags & IB_SA_QUERY_OPA) ?
1373 OPA_MGMT_BASE_VERSION :
1374 IB_MGMT_BASE_VERSION));
1375 if (IS_ERR(query->mad_buf)) {
1376 kref_put(&query->sm_ah->ref, free_sm_ah);
1380 query->mad_buf->ah = query->sm_ah->ah;
1385 static void free_mad(struct ib_sa_query *query)
1387 ib_free_send_mad(query->mad_buf);
1388 kref_put(&query->sm_ah->ref, free_sm_ah);
1391 static void init_mad(struct ib_sa_query *query, struct ib_mad_agent *agent)
1393 struct ib_sa_mad *mad = query->mad_buf->mad;
1394 unsigned long flags;
1396 memset(mad, 0, sizeof *mad);
1398 if (query->flags & IB_SA_QUERY_OPA) {
1399 mad->mad_hdr.base_version = OPA_MGMT_BASE_VERSION;
1400 mad->mad_hdr.class_version = OPA_SA_CLASS_VERSION;
1402 mad->mad_hdr.base_version = IB_MGMT_BASE_VERSION;
1403 mad->mad_hdr.class_version = IB_SA_CLASS_VERSION;
1405 mad->mad_hdr.mgmt_class = IB_MGMT_CLASS_SUBN_ADM;
1406 spin_lock_irqsave(&tid_lock, flags);
1408 cpu_to_be64(((u64) agent->hi_tid) << 32 | tid++);
1409 spin_unlock_irqrestore(&tid_lock, flags);
1412 static int send_mad(struct ib_sa_query *query, int timeout_ms, gfp_t gfp_mask)
1414 bool preload = gfpflags_allow_blocking(gfp_mask);
1415 unsigned long flags;
1419 idr_preload(gfp_mask);
1420 spin_lock_irqsave(&idr_lock, flags);
1422 id = idr_alloc(&query_idr, query, 0, 0, GFP_NOWAIT);
1424 spin_unlock_irqrestore(&idr_lock, flags);
1430 query->mad_buf->timeout_ms = timeout_ms;
1431 query->mad_buf->context[0] = query;
1434 if ((query->flags & IB_SA_ENABLE_LOCAL_SERVICE) &&
1435 (!(query->flags & IB_SA_QUERY_OPA))) {
1436 if (!rdma_nl_chk_listeners(RDMA_NL_GROUP_LS)) {
1437 if (!ib_nl_make_request(query, gfp_mask))
1440 ib_sa_disable_local_svc(query);
1443 ret = ib_post_send_mad(query->mad_buf, NULL);
1445 spin_lock_irqsave(&idr_lock, flags);
1446 idr_remove(&query_idr, id);
1447 spin_unlock_irqrestore(&idr_lock, flags);
1451 * It's not safe to dereference query any more, because the
1452 * send may already have completed and freed the query in
1455 return ret ? ret : id;
1458 void ib_sa_unpack_path(void *attribute, struct sa_path_rec *rec)
1460 ib_unpack(path_rec_table, ARRAY_SIZE(path_rec_table), attribute, rec);
1462 EXPORT_SYMBOL(ib_sa_unpack_path);
1464 void ib_sa_pack_path(struct sa_path_rec *rec, void *attribute)
1466 ib_pack(path_rec_table, ARRAY_SIZE(path_rec_table), rec, attribute);
1468 EXPORT_SYMBOL(ib_sa_pack_path);
1470 static bool ib_sa_opa_pathrecord_support(struct ib_sa_client *client,
1471 struct ib_device *device,
1474 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
1475 struct ib_sa_port *port;
1476 unsigned long flags;
1482 port = &sa_dev->port[port_num - sa_dev->start_port];
1483 spin_lock_irqsave(&port->classport_lock, flags);
1484 if (!port->classport_info.valid)
1487 if (port->classport_info.data.type == RDMA_CLASS_PORT_INFO_OPA)
1488 ret = opa_get_cpi_capmask2(&port->classport_info.data.opa) &
1489 OPA_CLASS_PORT_INFO_PR_SUPPORT;
1491 spin_unlock_irqrestore(&port->classport_lock, flags);
1495 enum opa_pr_supported {
1502 * Check if current PR query can be an OPA query.
1503 * Retuns PR_NOT_SUPPORTED if a path record query is not
1504 * possible, PR_OPA_SUPPORTED if an OPA path record query
1505 * is possible and PR_IB_SUPPORTED if an IB path record
1506 * query is possible.
1508 static int opa_pr_query_possible(struct ib_sa_client *client,
1509 struct ib_device *device,
1511 struct sa_path_rec *rec)
1513 struct ib_port_attr port_attr;
1515 if (ib_query_port(device, port_num, &port_attr))
1516 return PR_NOT_SUPPORTED;
1518 if (ib_sa_opa_pathrecord_support(client, device, port_num))
1519 return PR_OPA_SUPPORTED;
1521 if (port_attr.lid >= be16_to_cpu(IB_MULTICAST_LID_BASE))
1522 return PR_NOT_SUPPORTED;
1524 return PR_IB_SUPPORTED;
1527 static void ib_sa_path_rec_callback(struct ib_sa_query *sa_query,
1529 struct ib_sa_mad *mad)
1531 struct ib_sa_path_query *query =
1532 container_of(sa_query, struct ib_sa_path_query, sa_query);
1535 struct sa_path_rec rec;
1537 if (sa_query->flags & IB_SA_QUERY_OPA) {
1538 ib_unpack(opa_path_rec_table,
1539 ARRAY_SIZE(opa_path_rec_table),
1541 rec.rec_type = SA_PATH_REC_TYPE_OPA;
1542 query->callback(status, &rec, query->context);
1544 ib_unpack(path_rec_table,
1545 ARRAY_SIZE(path_rec_table),
1547 rec.rec_type = SA_PATH_REC_TYPE_IB;
1548 sa_path_set_dmac_zero(&rec);
1550 if (query->conv_pr) {
1551 struct sa_path_rec opa;
1553 memset(&opa, 0, sizeof(struct sa_path_rec));
1554 sa_convert_path_ib_to_opa(&opa, &rec);
1555 query->callback(status, &opa, query->context);
1557 query->callback(status, &rec, query->context);
1561 query->callback(status, NULL, query->context);
1564 static void ib_sa_path_rec_release(struct ib_sa_query *sa_query)
1566 struct ib_sa_path_query *query =
1567 container_of(sa_query, struct ib_sa_path_query, sa_query);
1569 kfree(query->conv_pr);
1574 * ib_sa_path_rec_get - Start a Path get query
1576 * @device:device to send query on
1577 * @port_num: port number to send query on
1578 * @rec:Path Record to send in query
1579 * @comp_mask:component mask to send in query
1580 * @timeout_ms:time to wait for response
1581 * @gfp_mask:GFP mask to use for internal allocations
1582 * @callback:function called when query completes, times out or is
1584 * @context:opaque user context passed to callback
1585 * @sa_query:query context, used to cancel query
1587 * Send a Path Record Get query to the SA to look up a path. The
1588 * callback function will be called when the query completes (or
1589 * fails); status is 0 for a successful response, -EINTR if the query
1590 * is canceled, -ETIMEDOUT is the query timed out, or -EIO if an error
1591 * occurred sending the query. The resp parameter of the callback is
1592 * only valid if status is 0.
1594 * If the return value of ib_sa_path_rec_get() is negative, it is an
1595 * error code. Otherwise it is a query ID that can be used to cancel
1598 int ib_sa_path_rec_get(struct ib_sa_client *client,
1599 struct ib_device *device, u8 port_num,
1600 struct sa_path_rec *rec,
1601 ib_sa_comp_mask comp_mask,
1602 int timeout_ms, gfp_t gfp_mask,
1603 void (*callback)(int status,
1604 struct sa_path_rec *resp,
1607 struct ib_sa_query **sa_query)
1609 struct ib_sa_path_query *query;
1610 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
1611 struct ib_sa_port *port;
1612 struct ib_mad_agent *agent;
1613 struct ib_sa_mad *mad;
1614 enum opa_pr_supported status;
1620 if ((rec->rec_type != SA_PATH_REC_TYPE_IB) &&
1621 (rec->rec_type != SA_PATH_REC_TYPE_OPA))
1624 port = &sa_dev->port[port_num - sa_dev->start_port];
1625 agent = port->agent;
1627 query = kzalloc(sizeof(*query), gfp_mask);
1631 query->sa_query.port = port;
1632 if (rec->rec_type == SA_PATH_REC_TYPE_OPA) {
1633 status = opa_pr_query_possible(client, device, port_num, rec);
1634 if (status == PR_NOT_SUPPORTED) {
1637 } else if (status == PR_OPA_SUPPORTED) {
1638 query->sa_query.flags |= IB_SA_QUERY_OPA;
1641 kmalloc(sizeof(*query->conv_pr), gfp_mask);
1642 if (!query->conv_pr) {
1649 ret = alloc_mad(&query->sa_query, gfp_mask);
1653 ib_sa_client_get(client);
1654 query->sa_query.client = client;
1655 query->callback = callback;
1656 query->context = context;
1658 mad = query->sa_query.mad_buf->mad;
1659 init_mad(&query->sa_query, agent);
1661 query->sa_query.callback = callback ? ib_sa_path_rec_callback : NULL;
1662 query->sa_query.release = ib_sa_path_rec_release;
1663 mad->mad_hdr.method = IB_MGMT_METHOD_GET;
1664 mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_PATH_REC);
1665 mad->sa_hdr.comp_mask = comp_mask;
1667 if (query->sa_query.flags & IB_SA_QUERY_OPA) {
1668 ib_pack(opa_path_rec_table, ARRAY_SIZE(opa_path_rec_table),
1670 } else if (query->conv_pr) {
1671 sa_convert_path_opa_to_ib(query->conv_pr, rec);
1672 ib_pack(path_rec_table, ARRAY_SIZE(path_rec_table),
1673 query->conv_pr, mad->data);
1675 ib_pack(path_rec_table, ARRAY_SIZE(path_rec_table),
1679 *sa_query = &query->sa_query;
1681 query->sa_query.flags |= IB_SA_ENABLE_LOCAL_SERVICE;
1682 query->sa_query.mad_buf->context[1] = (query->conv_pr) ?
1683 query->conv_pr : rec;
1685 ret = send_mad(&query->sa_query, timeout_ms, gfp_mask);
1693 ib_sa_client_put(query->sa_query.client);
1694 free_mad(&query->sa_query);
1696 kfree(query->conv_pr);
1701 EXPORT_SYMBOL(ib_sa_path_rec_get);
1703 static void ib_sa_service_rec_callback(struct ib_sa_query *sa_query,
1705 struct ib_sa_mad *mad)
1707 struct ib_sa_service_query *query =
1708 container_of(sa_query, struct ib_sa_service_query, sa_query);
1711 struct ib_sa_service_rec rec;
1713 ib_unpack(service_rec_table, ARRAY_SIZE(service_rec_table),
1715 query->callback(status, &rec, query->context);
1717 query->callback(status, NULL, query->context);
1720 static void ib_sa_service_rec_release(struct ib_sa_query *sa_query)
1722 kfree(container_of(sa_query, struct ib_sa_service_query, sa_query));
1726 * ib_sa_service_rec_query - Start Service Record operation
1728 * @device:device to send request on
1729 * @port_num: port number to send request on
1730 * @method:SA method - should be get, set, or delete
1731 * @rec:Service Record to send in request
1732 * @comp_mask:component mask to send in request
1733 * @timeout_ms:time to wait for response
1734 * @gfp_mask:GFP mask to use for internal allocations
1735 * @callback:function called when request completes, times out or is
1737 * @context:opaque user context passed to callback
1738 * @sa_query:request context, used to cancel request
1740 * Send a Service Record set/get/delete to the SA to register,
1741 * unregister or query a service record.
1742 * The callback function will be called when the request completes (or
1743 * fails); status is 0 for a successful response, -EINTR if the query
1744 * is canceled, -ETIMEDOUT is the query timed out, or -EIO if an error
1745 * occurred sending the query. The resp parameter of the callback is
1746 * only valid if status is 0.
1748 * If the return value of ib_sa_service_rec_query() is negative, it is an
1749 * error code. Otherwise it is a request ID that can be used to cancel
1752 int ib_sa_service_rec_query(struct ib_sa_client *client,
1753 struct ib_device *device, u8 port_num, u8 method,
1754 struct ib_sa_service_rec *rec,
1755 ib_sa_comp_mask comp_mask,
1756 int timeout_ms, gfp_t gfp_mask,
1757 void (*callback)(int status,
1758 struct ib_sa_service_rec *resp,
1761 struct ib_sa_query **sa_query)
1763 struct ib_sa_service_query *query;
1764 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
1765 struct ib_sa_port *port;
1766 struct ib_mad_agent *agent;
1767 struct ib_sa_mad *mad;
1773 port = &sa_dev->port[port_num - sa_dev->start_port];
1774 agent = port->agent;
1776 if (method != IB_MGMT_METHOD_GET &&
1777 method != IB_MGMT_METHOD_SET &&
1778 method != IB_SA_METHOD_DELETE)
1781 query = kzalloc(sizeof(*query), gfp_mask);
1785 query->sa_query.port = port;
1786 ret = alloc_mad(&query->sa_query, gfp_mask);
1790 ib_sa_client_get(client);
1791 query->sa_query.client = client;
1792 query->callback = callback;
1793 query->context = context;
1795 mad = query->sa_query.mad_buf->mad;
1796 init_mad(&query->sa_query, agent);
1798 query->sa_query.callback = callback ? ib_sa_service_rec_callback : NULL;
1799 query->sa_query.release = ib_sa_service_rec_release;
1800 mad->mad_hdr.method = method;
1801 mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_SERVICE_REC);
1802 mad->sa_hdr.comp_mask = comp_mask;
1804 ib_pack(service_rec_table, ARRAY_SIZE(service_rec_table),
1807 *sa_query = &query->sa_query;
1809 ret = send_mad(&query->sa_query, timeout_ms, gfp_mask);
1817 ib_sa_client_put(query->sa_query.client);
1818 free_mad(&query->sa_query);
1824 EXPORT_SYMBOL(ib_sa_service_rec_query);
1826 static void ib_sa_mcmember_rec_callback(struct ib_sa_query *sa_query,
1828 struct ib_sa_mad *mad)
1830 struct ib_sa_mcmember_query *query =
1831 container_of(sa_query, struct ib_sa_mcmember_query, sa_query);
1834 struct ib_sa_mcmember_rec rec;
1836 ib_unpack(mcmember_rec_table, ARRAY_SIZE(mcmember_rec_table),
1838 query->callback(status, &rec, query->context);
1840 query->callback(status, NULL, query->context);
1843 static void ib_sa_mcmember_rec_release(struct ib_sa_query *sa_query)
1845 kfree(container_of(sa_query, struct ib_sa_mcmember_query, sa_query));
1848 int ib_sa_mcmember_rec_query(struct ib_sa_client *client,
1849 struct ib_device *device, u8 port_num,
1851 struct ib_sa_mcmember_rec *rec,
1852 ib_sa_comp_mask comp_mask,
1853 int timeout_ms, gfp_t gfp_mask,
1854 void (*callback)(int status,
1855 struct ib_sa_mcmember_rec *resp,
1858 struct ib_sa_query **sa_query)
1860 struct ib_sa_mcmember_query *query;
1861 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
1862 struct ib_sa_port *port;
1863 struct ib_mad_agent *agent;
1864 struct ib_sa_mad *mad;
1870 port = &sa_dev->port[port_num - sa_dev->start_port];
1871 agent = port->agent;
1873 query = kzalloc(sizeof(*query), gfp_mask);
1877 query->sa_query.port = port;
1878 ret = alloc_mad(&query->sa_query, gfp_mask);
1882 ib_sa_client_get(client);
1883 query->sa_query.client = client;
1884 query->callback = callback;
1885 query->context = context;
1887 mad = query->sa_query.mad_buf->mad;
1888 init_mad(&query->sa_query, agent);
1890 query->sa_query.callback = callback ? ib_sa_mcmember_rec_callback : NULL;
1891 query->sa_query.release = ib_sa_mcmember_rec_release;
1892 mad->mad_hdr.method = method;
1893 mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_MC_MEMBER_REC);
1894 mad->sa_hdr.comp_mask = comp_mask;
1896 ib_pack(mcmember_rec_table, ARRAY_SIZE(mcmember_rec_table),
1899 *sa_query = &query->sa_query;
1901 ret = send_mad(&query->sa_query, timeout_ms, gfp_mask);
1909 ib_sa_client_put(query->sa_query.client);
1910 free_mad(&query->sa_query);
1917 /* Support GuidInfoRecord */
1918 static void ib_sa_guidinfo_rec_callback(struct ib_sa_query *sa_query,
1920 struct ib_sa_mad *mad)
1922 struct ib_sa_guidinfo_query *query =
1923 container_of(sa_query, struct ib_sa_guidinfo_query, sa_query);
1926 struct ib_sa_guidinfo_rec rec;
1928 ib_unpack(guidinfo_rec_table, ARRAY_SIZE(guidinfo_rec_table),
1930 query->callback(status, &rec, query->context);
1932 query->callback(status, NULL, query->context);
1935 static void ib_sa_guidinfo_rec_release(struct ib_sa_query *sa_query)
1937 kfree(container_of(sa_query, struct ib_sa_guidinfo_query, sa_query));
1940 int ib_sa_guid_info_rec_query(struct ib_sa_client *client,
1941 struct ib_device *device, u8 port_num,
1942 struct ib_sa_guidinfo_rec *rec,
1943 ib_sa_comp_mask comp_mask, u8 method,
1944 int timeout_ms, gfp_t gfp_mask,
1945 void (*callback)(int status,
1946 struct ib_sa_guidinfo_rec *resp,
1949 struct ib_sa_query **sa_query)
1951 struct ib_sa_guidinfo_query *query;
1952 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
1953 struct ib_sa_port *port;
1954 struct ib_mad_agent *agent;
1955 struct ib_sa_mad *mad;
1961 if (method != IB_MGMT_METHOD_GET &&
1962 method != IB_MGMT_METHOD_SET &&
1963 method != IB_SA_METHOD_DELETE) {
1967 port = &sa_dev->port[port_num - sa_dev->start_port];
1968 agent = port->agent;
1970 query = kzalloc(sizeof(*query), gfp_mask);
1974 query->sa_query.port = port;
1975 ret = alloc_mad(&query->sa_query, gfp_mask);
1979 ib_sa_client_get(client);
1980 query->sa_query.client = client;
1981 query->callback = callback;
1982 query->context = context;
1984 mad = query->sa_query.mad_buf->mad;
1985 init_mad(&query->sa_query, agent);
1987 query->sa_query.callback = callback ? ib_sa_guidinfo_rec_callback : NULL;
1988 query->sa_query.release = ib_sa_guidinfo_rec_release;
1990 mad->mad_hdr.method = method;
1991 mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_GUID_INFO_REC);
1992 mad->sa_hdr.comp_mask = comp_mask;
1994 ib_pack(guidinfo_rec_table, ARRAY_SIZE(guidinfo_rec_table), rec,
1997 *sa_query = &query->sa_query;
1999 ret = send_mad(&query->sa_query, timeout_ms, gfp_mask);
2007 ib_sa_client_put(query->sa_query.client);
2008 free_mad(&query->sa_query);
2014 EXPORT_SYMBOL(ib_sa_guid_info_rec_query);
2016 bool ib_sa_sendonly_fullmem_support(struct ib_sa_client *client,
2017 struct ib_device *device,
2020 struct ib_sa_device *sa_dev = ib_get_client_data(device, &sa_client);
2021 struct ib_sa_port *port;
2023 unsigned long flags;
2028 port = &sa_dev->port[port_num - sa_dev->start_port];
2030 spin_lock_irqsave(&port->classport_lock, flags);
2031 if ((port->classport_info.valid) &&
2032 (port->classport_info.data.type == RDMA_CLASS_PORT_INFO_IB))
2033 ret = ib_get_cpi_capmask2(&port->classport_info.data.ib)
2034 & IB_SA_CAP_MASK2_SENDONLY_FULL_MEM_SUPPORT;
2035 spin_unlock_irqrestore(&port->classport_lock, flags);
2038 EXPORT_SYMBOL(ib_sa_sendonly_fullmem_support);
2040 struct ib_classport_info_context {
2041 struct completion done;
2042 struct ib_sa_query *sa_query;
2045 static void ib_classportinfo_cb(void *context)
2047 struct ib_classport_info_context *cb_ctx = context;
2049 complete(&cb_ctx->done);
2052 static void ib_sa_classport_info_rec_callback(struct ib_sa_query *sa_query,
2054 struct ib_sa_mad *mad)
2056 unsigned long flags;
2057 struct ib_sa_classport_info_query *query =
2058 container_of(sa_query, struct ib_sa_classport_info_query, sa_query);
2059 struct ib_sa_classport_cache *info = &sa_query->port->classport_info;
2062 if (sa_query->flags & IB_SA_QUERY_OPA) {
2063 struct opa_class_port_info rec;
2065 ib_unpack(opa_classport_info_rec_table,
2066 ARRAY_SIZE(opa_classport_info_rec_table),
2069 spin_lock_irqsave(&sa_query->port->classport_lock,
2071 if (!status && !info->valid) {
2072 memcpy(&info->data.opa, &rec,
2073 sizeof(info->data.opa));
2076 info->data.type = RDMA_CLASS_PORT_INFO_OPA;
2078 spin_unlock_irqrestore(&sa_query->port->classport_lock,
2082 struct ib_class_port_info rec;
2084 ib_unpack(ib_classport_info_rec_table,
2085 ARRAY_SIZE(ib_classport_info_rec_table),
2088 spin_lock_irqsave(&sa_query->port->classport_lock,
2090 if (!status && !info->valid) {
2091 memcpy(&info->data.ib, &rec,
2092 sizeof(info->data.ib));
2095 info->data.type = RDMA_CLASS_PORT_INFO_IB;
2097 spin_unlock_irqrestore(&sa_query->port->classport_lock,
2101 query->callback(query->context);
2104 static void ib_sa_classport_info_rec_release(struct ib_sa_query *sa_query)
2106 kfree(container_of(sa_query, struct ib_sa_classport_info_query,
2110 static int ib_sa_classport_info_rec_query(struct ib_sa_port *port,
2112 void (*callback)(void *context),
2114 struct ib_sa_query **sa_query)
2116 struct ib_mad_agent *agent;
2117 struct ib_sa_classport_info_query *query;
2118 struct ib_sa_mad *mad;
2119 gfp_t gfp_mask = GFP_KERNEL;
2122 agent = port->agent;
2124 query = kzalloc(sizeof(*query), gfp_mask);
2128 query->sa_query.port = port;
2129 query->sa_query.flags |= rdma_cap_opa_ah(port->agent->device,
2131 IB_SA_QUERY_OPA : 0;
2132 ret = alloc_mad(&query->sa_query, gfp_mask);
2136 query->callback = callback;
2137 query->context = context;
2139 mad = query->sa_query.mad_buf->mad;
2140 init_mad(&query->sa_query, agent);
2142 query->sa_query.callback = ib_sa_classport_info_rec_callback;
2143 query->sa_query.release = ib_sa_classport_info_rec_release;
2144 mad->mad_hdr.method = IB_MGMT_METHOD_GET;
2145 mad->mad_hdr.attr_id = cpu_to_be16(IB_SA_ATTR_CLASS_PORTINFO);
2146 mad->sa_hdr.comp_mask = 0;
2147 *sa_query = &query->sa_query;
2149 ret = send_mad(&query->sa_query, timeout_ms, gfp_mask);
2157 free_mad(&query->sa_query);
2164 static void update_ib_cpi(struct work_struct *work)
2166 struct ib_sa_port *port =
2167 container_of(work, struct ib_sa_port, ib_cpi_work.work);
2168 struct ib_classport_info_context *cb_context;
2169 unsigned long flags;
2172 /* If the classport info is valid, nothing
2175 spin_lock_irqsave(&port->classport_lock, flags);
2176 if (port->classport_info.valid) {
2177 spin_unlock_irqrestore(&port->classport_lock, flags);
2180 spin_unlock_irqrestore(&port->classport_lock, flags);
2182 cb_context = kmalloc(sizeof(*cb_context), GFP_KERNEL);
2186 init_completion(&cb_context->done);
2188 ret = ib_sa_classport_info_rec_query(port, 3000,
2189 ib_classportinfo_cb, cb_context,
2190 &cb_context->sa_query);
2193 wait_for_completion(&cb_context->done);
2196 spin_lock_irqsave(&port->classport_lock, flags);
2198 /* If the classport info is still not valid, the query should have
2199 * failed for some reason. Retry issuing the query
2201 if (!port->classport_info.valid) {
2202 port->classport_info.retry_cnt++;
2203 if (port->classport_info.retry_cnt <=
2204 IB_SA_CPI_MAX_RETRY_CNT) {
2205 unsigned long delay =
2206 msecs_to_jiffies(IB_SA_CPI_RETRY_WAIT);
2208 queue_delayed_work(ib_wq, &port->ib_cpi_work, delay);
2211 spin_unlock_irqrestore(&port->classport_lock, flags);
2217 static void send_handler(struct ib_mad_agent *agent,
2218 struct ib_mad_send_wc *mad_send_wc)
2220 struct ib_sa_query *query = mad_send_wc->send_buf->context[0];
2221 unsigned long flags;
2223 if (query->callback)
2224 switch (mad_send_wc->status) {
2226 /* No callback -- already got recv */
2228 case IB_WC_RESP_TIMEOUT_ERR:
2229 query->callback(query, -ETIMEDOUT, NULL);
2231 case IB_WC_WR_FLUSH_ERR:
2232 query->callback(query, -EINTR, NULL);
2235 query->callback(query, -EIO, NULL);
2239 spin_lock_irqsave(&idr_lock, flags);
2240 idr_remove(&query_idr, query->id);
2241 spin_unlock_irqrestore(&idr_lock, flags);
2245 ib_sa_client_put(query->client);
2246 query->release(query);
2249 static void recv_handler(struct ib_mad_agent *mad_agent,
2250 struct ib_mad_send_buf *send_buf,
2251 struct ib_mad_recv_wc *mad_recv_wc)
2253 struct ib_sa_query *query;
2258 query = send_buf->context[0];
2259 if (query->callback) {
2260 if (mad_recv_wc->wc->status == IB_WC_SUCCESS)
2261 query->callback(query,
2262 mad_recv_wc->recv_buf.mad->mad_hdr.status ?
2264 (struct ib_sa_mad *) mad_recv_wc->recv_buf.mad);
2266 query->callback(query, -EIO, NULL);
2269 ib_free_recv_mad(mad_recv_wc);
2272 static void update_sm_ah(struct work_struct *work)
2274 struct ib_sa_port *port =
2275 container_of(work, struct ib_sa_port, update_task);
2276 struct ib_sa_sm_ah *new_ah;
2277 struct ib_port_attr port_attr;
2278 struct rdma_ah_attr ah_attr;
2281 if (ib_query_port(port->agent->device, port->port_num, &port_attr)) {
2282 pr_warn("Couldn't query port\n");
2286 new_ah = kmalloc(sizeof(*new_ah), GFP_KERNEL);
2290 kref_init(&new_ah->ref);
2291 new_ah->src_path_mask = (1 << port_attr.lmc) - 1;
2293 new_ah->pkey_index = 0;
2294 if (ib_find_pkey(port->agent->device, port->port_num,
2295 IB_DEFAULT_PKEY_FULL, &new_ah->pkey_index))
2296 pr_err("Couldn't find index for default PKey\n");
2298 memset(&ah_attr, 0, sizeof(ah_attr));
2299 ah_attr.type = rdma_ah_find_type(port->agent->device,
2301 rdma_ah_set_dlid(&ah_attr, port_attr.sm_lid);
2302 rdma_ah_set_sl(&ah_attr, port_attr.sm_sl);
2303 rdma_ah_set_port_num(&ah_attr, port->port_num);
2305 grh_required = rdma_is_grh_required(port->agent->device,
2309 * The OPA sm_lid of 0xFFFF needs special handling so that it can be
2310 * differentiated from a permissive LID of 0xFFFF. We set the
2311 * grh_required flag here so the SA can program the DGID in the
2312 * address handle appropriately
2314 if (ah_attr.type == RDMA_AH_ATTR_TYPE_OPA &&
2316 port_attr.sm_lid == be16_to_cpu(IB_LID_PERMISSIVE)))
2317 rdma_ah_set_make_grd(&ah_attr, true);
2319 if (ah_attr.type == RDMA_AH_ATTR_TYPE_IB && grh_required) {
2320 rdma_ah_set_ah_flags(&ah_attr, IB_AH_GRH);
2321 rdma_ah_set_subnet_prefix(&ah_attr,
2322 cpu_to_be64(port_attr.subnet_prefix));
2323 rdma_ah_set_interface_id(&ah_attr,
2324 cpu_to_be64(IB_SA_WELL_KNOWN_GUID));
2327 new_ah->ah = rdma_create_ah(port->agent->qp->pd, &ah_attr);
2328 if (IS_ERR(new_ah->ah)) {
2329 pr_warn("Couldn't create new SM AH\n");
2334 spin_lock_irq(&port->ah_lock);
2336 kref_put(&port->sm_ah->ref, free_sm_ah);
2337 port->sm_ah = new_ah;
2338 spin_unlock_irq(&port->ah_lock);
2341 static void ib_sa_event(struct ib_event_handler *handler,
2342 struct ib_event *event)
2344 if (event->event == IB_EVENT_PORT_ERR ||
2345 event->event == IB_EVENT_PORT_ACTIVE ||
2346 event->event == IB_EVENT_LID_CHANGE ||
2347 event->event == IB_EVENT_PKEY_CHANGE ||
2348 event->event == IB_EVENT_SM_CHANGE ||
2349 event->event == IB_EVENT_CLIENT_REREGISTER) {
2350 unsigned long flags;
2351 struct ib_sa_device *sa_dev =
2352 container_of(handler, typeof(*sa_dev), event_handler);
2353 u8 port_num = event->element.port_num - sa_dev->start_port;
2354 struct ib_sa_port *port = &sa_dev->port[port_num];
2356 if (!rdma_cap_ib_sa(handler->device, port->port_num))
2359 spin_lock_irqsave(&port->ah_lock, flags);
2361 kref_put(&port->sm_ah->ref, free_sm_ah);
2363 spin_unlock_irqrestore(&port->ah_lock, flags);
2365 if (event->event == IB_EVENT_SM_CHANGE ||
2366 event->event == IB_EVENT_CLIENT_REREGISTER ||
2367 event->event == IB_EVENT_LID_CHANGE ||
2368 event->event == IB_EVENT_PORT_ACTIVE) {
2369 unsigned long delay =
2370 msecs_to_jiffies(IB_SA_CPI_RETRY_WAIT);
2372 spin_lock_irqsave(&port->classport_lock, flags);
2373 port->classport_info.valid = false;
2374 port->classport_info.retry_cnt = 0;
2375 spin_unlock_irqrestore(&port->classport_lock, flags);
2376 queue_delayed_work(ib_wq,
2377 &port->ib_cpi_work, delay);
2379 queue_work(ib_wq, &sa_dev->port[port_num].update_task);
2383 static void ib_sa_add_one(struct ib_device *device)
2385 struct ib_sa_device *sa_dev;
2389 s = rdma_start_port(device);
2390 e = rdma_end_port(device);
2392 sa_dev = kzalloc(sizeof *sa_dev +
2393 (e - s + 1) * sizeof (struct ib_sa_port),
2398 sa_dev->start_port = s;
2399 sa_dev->end_port = e;
2401 for (i = 0; i <= e - s; ++i) {
2402 spin_lock_init(&sa_dev->port[i].ah_lock);
2403 if (!rdma_cap_ib_sa(device, i + 1))
2406 sa_dev->port[i].sm_ah = NULL;
2407 sa_dev->port[i].port_num = i + s;
2409 spin_lock_init(&sa_dev->port[i].classport_lock);
2410 sa_dev->port[i].classport_info.valid = false;
2412 sa_dev->port[i].agent =
2413 ib_register_mad_agent(device, i + s, IB_QPT_GSI,
2414 NULL, 0, send_handler,
2415 recv_handler, sa_dev, 0);
2416 if (IS_ERR(sa_dev->port[i].agent))
2419 INIT_WORK(&sa_dev->port[i].update_task, update_sm_ah);
2420 INIT_DELAYED_WORK(&sa_dev->port[i].ib_cpi_work,
2429 ib_set_client_data(device, &sa_client, sa_dev);
2432 * We register our event handler after everything is set up,
2433 * and then update our cached info after the event handler is
2434 * registered to avoid any problems if a port changes state
2435 * during our initialization.
2438 INIT_IB_EVENT_HANDLER(&sa_dev->event_handler, device, ib_sa_event);
2439 ib_register_event_handler(&sa_dev->event_handler);
2441 for (i = 0; i <= e - s; ++i) {
2442 if (rdma_cap_ib_sa(device, i + 1))
2443 update_sm_ah(&sa_dev->port[i].update_task);
2450 if (rdma_cap_ib_sa(device, i + 1))
2451 ib_unregister_mad_agent(sa_dev->port[i].agent);
2458 static void ib_sa_remove_one(struct ib_device *device, void *client_data)
2460 struct ib_sa_device *sa_dev = client_data;
2466 ib_unregister_event_handler(&sa_dev->event_handler);
2467 flush_workqueue(ib_wq);
2469 for (i = 0; i <= sa_dev->end_port - sa_dev->start_port; ++i) {
2470 if (rdma_cap_ib_sa(device, i + 1)) {
2471 cancel_delayed_work_sync(&sa_dev->port[i].ib_cpi_work);
2472 ib_unregister_mad_agent(sa_dev->port[i].agent);
2473 if (sa_dev->port[i].sm_ah)
2474 kref_put(&sa_dev->port[i].sm_ah->ref, free_sm_ah);
2482 int ib_sa_init(void)
2486 get_random_bytes(&tid, sizeof tid);
2488 atomic_set(&ib_nl_sa_request_seq, 0);
2490 ret = ib_register_client(&sa_client);
2492 pr_err("Couldn't register ib_sa client\n");
2498 pr_err("Couldn't initialize multicast handling\n");
2502 ib_nl_wq = alloc_ordered_workqueue("ib_nl_sa_wq", WQ_MEM_RECLAIM);
2508 INIT_DELAYED_WORK(&ib_nl_timed_work, ib_nl_request_timeout);
2515 ib_unregister_client(&sa_client);
2520 void ib_sa_cleanup(void)
2522 cancel_delayed_work(&ib_nl_timed_work);
2523 flush_workqueue(ib_nl_wq);
2524 destroy_workqueue(ib_nl_wq);
2526 ib_unregister_client(&sa_client);
2527 idr_destroy(&query_idr);