xref: /freebsd/contrib/ofed/opensm/opensm/osm_sa_sw_info_record.c (revision 87181516ef48be852d5e5fee53c6e0dbfc62f21e)
1 /*
2  * Copyright (c) 2004-2009 Voltaire, Inc. All rights reserved.
3  * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved.
4  * Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
5  * Copyright (c) 2013 Oracle and/or its affiliates. All rights reserved.
6  *
7  * This software is available to you under a choice of one of two
8  * licenses.  You may choose to be licensed under the terms of the GNU
9  * General Public License (GPL) Version 2, available from the file
10  * COPYING in the main directory of this source tree, or the
11  * OpenIB.org BSD license below:
12  *
13  *     Redistribution and use in source and binary forms, with or
14  *     without modification, are permitted provided that the following
15  *     conditions are met:
16  *
17  *      - Redistributions of source code must retain the above
18  *        copyright notice, this list of conditions and the following
19  *        disclaimer.
20  *
21  *      - Redistributions in binary form must reproduce the above
22  *        copyright notice, this list of conditions and the following
23  *        disclaimer in the documentation and/or other materials
24  *        provided with the distribution.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33  * SOFTWARE.
34  *
35  */
36 
37 /*
38  * Abstract:
39  *    Implementation of osm_sir_rcv_t.
40  * This object represents the SwitchInfo Receiver object.
41  * This object is part of the opensm family of objects.
42  */
43 
44 #if HAVE_CONFIG_H
45 #  include <config.h>
46 #endif				/* HAVE_CONFIG_H */
47 
48 #include <string.h>
49 #include <iba/ib_types.h>
50 #include <complib/cl_debug.h>
51 #include <complib/cl_qlist.h>
52 #include <opensm/osm_file_ids.h>
53 #define FILE_ID OSM_FILE_SA_SW_INFO_RECORD_C
54 #include <vendor/osm_vendor_api.h>
55 #include <opensm/osm_node.h>
56 #include <opensm/osm_helper.h>
57 #include <opensm/osm_pkey.h>
58 #include <opensm/osm_sa.h>
59 
60 #define SA_SIR_RESP_SIZE SA_ITEM_RESP_SIZE(swinfo_rec)
61 
62 typedef struct osm_sir_search_ctxt {
63 	const ib_switch_info_record_t *p_rcvd_rec;
64 	ib_net64_t comp_mask;
65 	cl_qlist_t *p_list;
66 	osm_sa_t *sa;
67 	const osm_physp_t *p_req_physp;
68 } osm_sir_search_ctxt_t;
69 
sir_rcv_new_sir(IN osm_sa_t * sa,IN const osm_switch_t * p_sw,IN cl_qlist_t * p_list,IN ib_net16_t lid)70 static ib_api_status_t sir_rcv_new_sir(IN osm_sa_t * sa,
71 				       IN const osm_switch_t * p_sw,
72 				       IN cl_qlist_t * p_list,
73 				       IN ib_net16_t lid)
74 {
75 	osm_sa_item_t *p_rec_item;
76 	ib_api_status_t status = IB_SUCCESS;
77 
78 	OSM_LOG_ENTER(sa->p_log);
79 
80 	p_rec_item = malloc(SA_SIR_RESP_SIZE);
81 	if (p_rec_item == NULL) {
82 		OSM_LOG(sa->p_log, OSM_LOG_ERROR, "ERR 5308: "
83 			"rec_item alloc failed\n");
84 		status = IB_INSUFFICIENT_RESOURCES;
85 		goto Exit;
86 	}
87 
88 	OSM_LOG(sa->p_log, OSM_LOG_DEBUG,
89 		"New SwitchInfoRecord: lid %u\n", cl_ntoh16(lid));
90 
91 	memset(p_rec_item, 0, SA_SIR_RESP_SIZE);
92 
93 	p_rec_item->resp.swinfo_rec.lid = lid;
94 	p_rec_item->resp.swinfo_rec.switch_info = p_sw->switch_info;
95 
96 	cl_qlist_insert_tail(p_list, &p_rec_item->list_item);
97 
98 Exit:
99 	OSM_LOG_EXIT(sa->p_log);
100 	return status;
101 }
102 
sir_rcv_create_sir(IN osm_sa_t * sa,IN const osm_switch_t * p_sw,IN cl_qlist_t * p_list,IN ib_net16_t match_lid,IN const osm_physp_t * p_req_physp)103 static void sir_rcv_create_sir(IN osm_sa_t * sa, IN const osm_switch_t * p_sw,
104 			       IN cl_qlist_t * p_list, IN ib_net16_t match_lid,
105 			       IN const osm_physp_t * p_req_physp)
106 {
107 	osm_port_t *p_port;
108 	const osm_physp_t *p_physp;
109 	uint16_t match_lid_ho;
110 	ib_net16_t min_lid_ho;
111 	ib_net16_t max_lid_ho;
112 
113 	OSM_LOG_ENTER(sa->p_log);
114 
115 	OSM_LOG(sa->p_log, OSM_LOG_DEBUG,
116 		"Looking for SwitchInfoRecord with LID: %u\n",
117 		cl_ntoh16(match_lid));
118 
119 	/* In switches, the port guid is the node guid. */
120 	p_port =
121 	    osm_get_port_by_guid(sa->p_subn, p_sw->p_node->node_info.port_guid);
122 	if (!p_port) {
123 		OSM_LOG(sa->p_log, OSM_LOG_ERROR, "ERR 530A: "
124 			"Failed to find Port by Node Guid:0x%016" PRIx64
125 			"\n", cl_ntoh64(p_sw->p_node->node_info.node_guid));
126 		goto Exit;
127 	}
128 
129 	/* check that the requester physp and the current physp are under
130 	   the same partition. */
131 	p_physp = p_port->p_physp;
132 	if (!p_physp) {
133 		OSM_LOG(sa->p_log, OSM_LOG_ERROR, "ERR 530B: "
134 			"Failed to find default physical Port by Node Guid:0x%016"
135 			PRIx64 "\n",
136 			cl_ntoh64(p_sw->p_node->node_info.node_guid));
137 		goto Exit;
138 	}
139 	if (!osm_physp_share_pkey(sa->p_log, p_req_physp, p_physp,
140 				  sa->p_subn->opt.allow_both_pkeys))
141 		goto Exit;
142 
143 	/* get the port 0 of the switch */
144 	osm_port_get_lid_range_ho(p_port, &min_lid_ho, &max_lid_ho);
145 
146 	match_lid_ho = cl_ntoh16(match_lid);
147 	if (match_lid_ho) {
148 		/*
149 		   We validate that the lid belongs to this switch.
150 		 */
151 		OSM_LOG(sa->p_log, OSM_LOG_DEBUG,
152 			"Comparing LID: %u <= %u <= %u\n",
153 			min_lid_ho, match_lid_ho, max_lid_ho);
154 
155 		if (match_lid_ho < min_lid_ho || match_lid_ho > max_lid_ho)
156 			goto Exit;
157 
158 	}
159 
160 	sir_rcv_new_sir(sa, p_sw, p_list, osm_port_get_base_lid(p_port));
161 
162 Exit:
163 	OSM_LOG_EXIT(sa->p_log);
164 }
165 
sir_rcv_by_comp_mask(IN cl_map_item_t * p_map_item,IN void * cxt)166 static void sir_rcv_by_comp_mask(IN cl_map_item_t * p_map_item, IN void *cxt)
167 {
168 	const osm_sir_search_ctxt_t *p_ctxt = cxt;
169 	const osm_switch_t *p_sw = (osm_switch_t *) p_map_item;
170 	const ib_switch_info_record_t *const p_rcvd_rec = p_ctxt->p_rcvd_rec;
171 	const osm_physp_t *const p_req_physp = p_ctxt->p_req_physp;
172 	osm_sa_t *sa = p_ctxt->sa;
173 	ib_net64_t const comp_mask = p_ctxt->comp_mask;
174 	ib_net16_t match_lid = 0;
175 
176 	OSM_LOG_ENTER(p_ctxt->sa->p_log);
177 
178 	osm_dump_switch_info_v2(p_ctxt->sa->p_log, &p_sw->switch_info,
179 			        FILE_ID, OSM_LOG_VERBOSE);
180 
181 	if (comp_mask & IB_SWIR_COMPMASK_LID) {
182 		match_lid = p_rcvd_rec->lid;
183 		if (!match_lid)
184 			goto Exit;
185 	}
186 
187 	sir_rcv_create_sir(sa, p_sw, p_ctxt->p_list, match_lid, p_req_physp);
188 
189 Exit:
190 	OSM_LOG_EXIT(p_ctxt->sa->p_log);
191 }
192 
osm_sir_rcv_process(IN void * ctx,IN void * data)193 void osm_sir_rcv_process(IN void *ctx, IN void *data)
194 {
195 	osm_sa_t *sa = ctx;
196 	osm_madw_t *p_madw = data;
197 	const ib_sa_mad_t *sad_mad;
198 	const ib_switch_info_record_t *p_rcvd_rec;
199 	cl_qlist_t rec_list;
200 	osm_sir_search_ctxt_t context;
201 	osm_physp_t *p_req_physp;
202 
203 	CL_ASSERT(sa);
204 
205 	OSM_LOG_ENTER(sa->p_log);
206 
207 	CL_ASSERT(p_madw);
208 
209 	sad_mad = osm_madw_get_sa_mad_ptr(p_madw);
210 	p_rcvd_rec =
211 	    (ib_switch_info_record_t *) ib_sa_mad_get_payload_ptr(sad_mad);
212 
213 	CL_ASSERT(sad_mad->attr_id == IB_MAD_ATTR_SWITCH_INFO_RECORD);
214 
215 	/* we only support SubnAdmGet and SubnAdmGetTable methods */
216 	if (sad_mad->method != IB_MAD_METHOD_GET &&
217 	    sad_mad->method != IB_MAD_METHOD_GETTABLE) {
218 		OSM_LOG(sa->p_log, OSM_LOG_ERROR, "ERR 5305: "
219 			"Unsupported Method (%s) for SwitchInfoRecord request\n",
220 			ib_get_sa_method_str(sad_mad->method));
221 		osm_sa_send_error(sa, p_madw, IB_MAD_STATUS_UNSUP_METHOD_ATTR);
222 		goto Exit;
223 	}
224 
225 	cl_plock_acquire(sa->p_lock);
226 
227 	/* update the requester physical port */
228 	p_req_physp = osm_get_physp_by_mad_addr(sa->p_log, sa->p_subn,
229 						osm_madw_get_mad_addr_ptr
230 						(p_madw));
231 	if (p_req_physp == NULL) {
232 		cl_plock_release(sa->p_lock);
233 		OSM_LOG(sa->p_log, OSM_LOG_ERROR, "ERR 5304: "
234 			"Cannot find requester physical port\n");
235 		goto Exit;
236 	}
237 
238 	if (OSM_LOG_IS_ACTIVE_V2(sa->p_log, OSM_LOG_DEBUG)) {
239 		OSM_LOG(sa->p_log, OSM_LOG_DEBUG,
240 			"Requester port GUID 0x%" PRIx64 "\n",
241 			cl_ntoh64(osm_physp_get_port_guid(p_req_physp)));
242 		osm_dump_switch_info_record_v2(sa->p_log, p_rcvd_rec,
243 					       FILE_ID, OSM_LOG_DEBUG);
244 	}
245 
246 	cl_qlist_init(&rec_list);
247 
248 	context.p_rcvd_rec = p_rcvd_rec;
249 	context.p_list = &rec_list;
250 	context.comp_mask = sad_mad->comp_mask;
251 	context.sa = sa;
252 	context.p_req_physp = p_req_physp;
253 
254 	/* Go over all switches */
255 	cl_qmap_apply_func(&sa->p_subn->sw_guid_tbl, sir_rcv_by_comp_mask,
256 			   &context);
257 
258 	cl_plock_release(sa->p_lock);
259 
260 	osm_sa_respond(sa, p_madw, sizeof(ib_switch_info_record_t), &rec_list);
261 
262 Exit:
263 	OSM_LOG_EXIT(sa->p_log);
264 }
265