2 * Copyright (c) 2006 Oracle. 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
33 #include <linux/kernel.h>
36 #include <linux/netdevice.h>
37 #include <linux/inetdevice.h>
38 #include <linux/if_arp.h>
39 #include <linux/delay.h>
40 #include <linux/slab.h>
41 #include <linux/module.h>
43 #include "rds_single_path.h"
48 static unsigned int rds_ib_mr_1m_pool_size
= RDS_MR_1M_POOL_SIZE
;
49 static unsigned int rds_ib_mr_8k_pool_size
= RDS_MR_8K_POOL_SIZE
;
50 unsigned int rds_ib_retry_count
= RDS_IB_DEFAULT_RETRY_COUNT
;
51 static atomic_t rds_ib_unloading
;
53 module_param(rds_ib_mr_1m_pool_size
, int, 0444);
54 MODULE_PARM_DESC(rds_ib_mr_1m_pool_size
, " Max number of 1M mr per HCA");
55 module_param(rds_ib_mr_8k_pool_size
, int, 0444);
56 MODULE_PARM_DESC(rds_ib_mr_8k_pool_size
, " Max number of 8K mr per HCA");
57 module_param(rds_ib_retry_count
, int, 0444);
58 MODULE_PARM_DESC(rds_ib_retry_count
, " Number of hw retries before reporting an error");
61 * we have a clumsy combination of RCU and a rwsem protecting this list
62 * because it is used both in the get_mr fast path and while blocking in
63 * the FMR flushing path.
65 DECLARE_RWSEM(rds_ib_devices_lock
);
66 struct list_head rds_ib_devices
;
68 /* NOTE: if also grabbing ibdev lock, grab this first */
69 DEFINE_SPINLOCK(ib_nodev_conns_lock
);
70 LIST_HEAD(ib_nodev_conns
);
72 static void rds_ib_nodev_connect(void)
74 struct rds_ib_connection
*ic
;
76 spin_lock(&ib_nodev_conns_lock
);
77 list_for_each_entry(ic
, &ib_nodev_conns
, ib_node
)
78 rds_conn_connect_if_down(ic
->conn
);
79 spin_unlock(&ib_nodev_conns_lock
);
82 static void rds_ib_dev_shutdown(struct rds_ib_device
*rds_ibdev
)
84 struct rds_ib_connection
*ic
;
87 spin_lock_irqsave(&rds_ibdev
->spinlock
, flags
);
88 list_for_each_entry(ic
, &rds_ibdev
->conn_list
, ib_node
)
89 rds_conn_drop(ic
->conn
);
90 spin_unlock_irqrestore(&rds_ibdev
->spinlock
, flags
);
94 * rds_ib_destroy_mr_pool() blocks on a few things and mrs drop references
95 * from interrupt context so we push freing off into a work struct in krdsd.
97 static void rds_ib_dev_free(struct work_struct
*work
)
99 struct rds_ib_ipaddr
*i_ipaddr
, *i_next
;
100 struct rds_ib_device
*rds_ibdev
= container_of(work
,
101 struct rds_ib_device
, free_work
);
103 if (rds_ibdev
->mr_8k_pool
)
104 rds_ib_destroy_mr_pool(rds_ibdev
->mr_8k_pool
);
105 if (rds_ibdev
->mr_1m_pool
)
106 rds_ib_destroy_mr_pool(rds_ibdev
->mr_1m_pool
);
108 ib_dealloc_pd(rds_ibdev
->pd
);
110 list_for_each_entry_safe(i_ipaddr
, i_next
, &rds_ibdev
->ipaddr_list
, list
) {
111 list_del(&i_ipaddr
->list
);
115 kfree(rds_ibdev
->vector_load
);
120 void rds_ib_dev_put(struct rds_ib_device
*rds_ibdev
)
122 BUG_ON(refcount_read(&rds_ibdev
->refcount
) == 0);
123 if (refcount_dec_and_test(&rds_ibdev
->refcount
))
124 queue_work(rds_wq
, &rds_ibdev
->free_work
);
127 static void rds_ib_add_one(struct ib_device
*device
)
129 struct rds_ib_device
*rds_ibdev
;
130 bool has_fr
, has_fmr
;
132 /* Only handle IB (no iWARP) devices */
133 if (device
->node_type
!= RDMA_NODE_IB_CA
)
136 rds_ibdev
= kzalloc_node(sizeof(struct rds_ib_device
), GFP_KERNEL
,
137 ibdev_to_node(device
));
141 spin_lock_init(&rds_ibdev
->spinlock
);
142 refcount_set(&rds_ibdev
->refcount
, 1);
143 INIT_WORK(&rds_ibdev
->free_work
, rds_ib_dev_free
);
145 rds_ibdev
->max_wrs
= device
->attrs
.max_qp_wr
;
146 rds_ibdev
->max_sge
= min(device
->attrs
.max_sge
, RDS_IB_MAX_SGE
);
148 has_fr
= (device
->attrs
.device_cap_flags
&
149 IB_DEVICE_MEM_MGT_EXTENSIONS
);
150 has_fmr
= (device
->alloc_fmr
&& device
->dealloc_fmr
&&
151 device
->map_phys_fmr
&& device
->unmap_fmr
);
152 rds_ibdev
->use_fastreg
= (has_fr
&& !has_fmr
);
154 rds_ibdev
->fmr_max_remaps
= device
->attrs
.max_map_per_fmr
?: 32;
155 rds_ibdev
->max_1m_mrs
= device
->attrs
.max_mr
?
156 min_t(unsigned int, (device
->attrs
.max_mr
/ 2),
157 rds_ib_mr_1m_pool_size
) : rds_ib_mr_1m_pool_size
;
159 rds_ibdev
->max_8k_mrs
= device
->attrs
.max_mr
?
160 min_t(unsigned int, ((device
->attrs
.max_mr
/ 2) * RDS_MR_8K_SCALE
),
161 rds_ib_mr_8k_pool_size
) : rds_ib_mr_8k_pool_size
;
163 rds_ibdev
->max_initiator_depth
= device
->attrs
.max_qp_init_rd_atom
;
164 rds_ibdev
->max_responder_resources
= device
->attrs
.max_qp_rd_atom
;
166 rds_ibdev
->vector_load
= kzalloc(sizeof(int) * device
->num_comp_vectors
,
168 if (!rds_ibdev
->vector_load
) {
169 pr_err("RDS/IB: %s failed to allocate vector memory\n",
174 rds_ibdev
->dev
= device
;
175 rds_ibdev
->pd
= ib_alloc_pd(device
, 0);
176 if (IS_ERR(rds_ibdev
->pd
)) {
177 rds_ibdev
->pd
= NULL
;
181 rds_ibdev
->mr_1m_pool
=
182 rds_ib_create_mr_pool(rds_ibdev
, RDS_IB_MR_1M_POOL
);
183 if (IS_ERR(rds_ibdev
->mr_1m_pool
)) {
184 rds_ibdev
->mr_1m_pool
= NULL
;
188 rds_ibdev
->mr_8k_pool
=
189 rds_ib_create_mr_pool(rds_ibdev
, RDS_IB_MR_8K_POOL
);
190 if (IS_ERR(rds_ibdev
->mr_8k_pool
)) {
191 rds_ibdev
->mr_8k_pool
= NULL
;
195 rdsdebug("RDS/IB: max_mr = %d, max_wrs = %d, max_sge = %d, fmr_max_remaps = %d, max_1m_mrs = %d, max_8k_mrs = %d\n",
196 device
->attrs
.max_fmr
, rds_ibdev
->max_wrs
, rds_ibdev
->max_sge
,
197 rds_ibdev
->fmr_max_remaps
, rds_ibdev
->max_1m_mrs
,
198 rds_ibdev
->max_8k_mrs
);
200 pr_info("RDS/IB: %s: %s supported and preferred\n",
202 rds_ibdev
->use_fastreg
? "FRMR" : "FMR");
204 INIT_LIST_HEAD(&rds_ibdev
->ipaddr_list
);
205 INIT_LIST_HEAD(&rds_ibdev
->conn_list
);
207 down_write(&rds_ib_devices_lock
);
208 list_add_tail_rcu(&rds_ibdev
->list
, &rds_ib_devices
);
209 up_write(&rds_ib_devices_lock
);
210 refcount_inc(&rds_ibdev
->refcount
);
212 ib_set_client_data(device
, &rds_ib_client
, rds_ibdev
);
213 refcount_inc(&rds_ibdev
->refcount
);
215 rds_ib_nodev_connect();
218 rds_ib_dev_put(rds_ibdev
);
222 * New connections use this to find the device to associate with the
223 * connection. It's not in the fast path so we're not concerned about the
224 * performance of the IB call. (As of this writing, it uses an interrupt
225 * blocking spinlock to serialize walking a per-device list of all registered
228 * RCU is used to handle incoming connections racing with device teardown.
229 * Rather than use a lock to serialize removal from the client_data and
230 * getting a new reference, we use an RCU grace period. The destruction
231 * path removes the device from client_data and then waits for all RCU
234 * A new connection can get NULL from this if its arriving on a
235 * device that is in the process of being removed.
237 struct rds_ib_device
*rds_ib_get_client_data(struct ib_device
*device
)
239 struct rds_ib_device
*rds_ibdev
;
242 rds_ibdev
= ib_get_client_data(device
, &rds_ib_client
);
244 refcount_inc(&rds_ibdev
->refcount
);
250 * The IB stack is letting us know that a device is going away. This can
251 * happen if the underlying HCA driver is removed or if PCI hotplug is removing
252 * the pci function, for example.
254 * This can be called at any time and can be racing with any other RDS path.
256 static void rds_ib_remove_one(struct ib_device
*device
, void *client_data
)
258 struct rds_ib_device
*rds_ibdev
= client_data
;
263 rds_ib_dev_shutdown(rds_ibdev
);
265 /* stop connection attempts from getting a reference to this device. */
266 ib_set_client_data(device
, &rds_ib_client
, NULL
);
268 down_write(&rds_ib_devices_lock
);
269 list_del_rcu(&rds_ibdev
->list
);
270 up_write(&rds_ib_devices_lock
);
273 * This synchronize rcu is waiting for readers of both the ib
274 * client data and the devices list to finish before we drop
275 * both of those references.
278 rds_ib_dev_put(rds_ibdev
);
279 rds_ib_dev_put(rds_ibdev
);
282 struct ib_client rds_ib_client
= {
284 .add
= rds_ib_add_one
,
285 .remove
= rds_ib_remove_one
288 static int rds_ib_conn_info_visitor(struct rds_connection
*conn
,
291 struct rds_info_rdma_connection
*iinfo
= buffer
;
292 struct rds_ib_connection
*ic
;
294 /* We will only ever look at IB transports */
295 if (conn
->c_trans
!= &rds_ib_transport
)
298 iinfo
->src_addr
= conn
->c_laddr
;
299 iinfo
->dst_addr
= conn
->c_faddr
;
301 memset(&iinfo
->src_gid
, 0, sizeof(iinfo
->src_gid
));
302 memset(&iinfo
->dst_gid
, 0, sizeof(iinfo
->dst_gid
));
303 if (rds_conn_state(conn
) == RDS_CONN_UP
) {
304 struct rds_ib_device
*rds_ibdev
;
306 ic
= conn
->c_transport_data
;
308 rdma_read_gids(ic
->i_cm_id
, (union ib_gid
*)&iinfo
->src_gid
,
309 (union ib_gid
*)&iinfo
->dst_gid
);
311 rds_ibdev
= ic
->rds_ibdev
;
312 iinfo
->max_send_wr
= ic
->i_send_ring
.w_nr
;
313 iinfo
->max_recv_wr
= ic
->i_recv_ring
.w_nr
;
314 iinfo
->max_send_sge
= rds_ibdev
->max_sge
;
315 rds_ib_get_mr_info(rds_ibdev
, iinfo
);
320 static void rds_ib_ic_info(struct socket
*sock
, unsigned int len
,
321 struct rds_info_iterator
*iter
,
322 struct rds_info_lengths
*lens
)
324 rds_for_each_conn_info(sock
, len
, iter
, lens
,
325 rds_ib_conn_info_visitor
,
326 sizeof(struct rds_info_rdma_connection
));
331 * Early RDS/IB was built to only bind to an address if there is an IPoIB
332 * device with that address set.
334 * If it were me, I'd advocate for something more flexible. Sending and
335 * receiving should be device-agnostic. Transports would try and maintain
336 * connections between peers who have messages queued. Userspace would be
337 * allowed to influence which paths have priority. We could call userspace
338 * asserting this policy "routing".
340 static int rds_ib_laddr_check(struct net
*net
, __be32 addr
)
343 struct rdma_cm_id
*cm_id
;
344 struct sockaddr_in sin
;
346 /* Create a CMA ID and try to bind it. This catches both
347 * IB and iWARP capable NICs.
349 cm_id
= rdma_create_id(&init_net
, rds_rdma_cm_event_handler
,
350 NULL
, RDMA_PS_TCP
, IB_QPT_RC
);
352 return PTR_ERR(cm_id
);
354 memset(&sin
, 0, sizeof(sin
));
355 sin
.sin_family
= AF_INET
;
356 sin
.sin_addr
.s_addr
= addr
;
358 /* rdma_bind_addr will only succeed for IB & iWARP devices */
359 ret
= rdma_bind_addr(cm_id
, (struct sockaddr
*)&sin
);
360 /* due to this, we will claim to support iWARP devices unless we
362 if (ret
|| !cm_id
->device
||
363 cm_id
->device
->node_type
!= RDMA_NODE_IB_CA
)
364 ret
= -EADDRNOTAVAIL
;
366 rdsdebug("addr %pI4 ret %d node type %d\n",
368 cm_id
->device
? cm_id
->device
->node_type
: -1);
370 rdma_destroy_id(cm_id
);
375 static void rds_ib_unregister_client(void)
377 ib_unregister_client(&rds_ib_client
);
378 /* wait for rds_ib_dev_free() to complete */
379 flush_workqueue(rds_wq
);
382 static void rds_ib_set_unloading(void)
384 atomic_set(&rds_ib_unloading
, 1);
387 static bool rds_ib_is_unloading(struct rds_connection
*conn
)
389 struct rds_conn_path
*cp
= &conn
->c_path
[0];
391 return (test_bit(RDS_DESTROY_PENDING
, &cp
->cp_flags
) ||
392 atomic_read(&rds_ib_unloading
) != 0);
395 void rds_ib_exit(void)
397 rds_ib_set_unloading();
399 rds_info_deregister_func(RDS_INFO_IB_CONNECTIONS
, rds_ib_ic_info
);
400 rds_ib_unregister_client();
401 rds_ib_destroy_nodev_conns();
402 rds_ib_sysctl_exit();
404 rds_trans_unregister(&rds_ib_transport
);
408 struct rds_transport rds_ib_transport
= {
409 .laddr_check
= rds_ib_laddr_check
,
410 .xmit_path_complete
= rds_ib_xmit_path_complete
,
412 .xmit_rdma
= rds_ib_xmit_rdma
,
413 .xmit_atomic
= rds_ib_xmit_atomic
,
414 .recv_path
= rds_ib_recv_path
,
415 .conn_alloc
= rds_ib_conn_alloc
,
416 .conn_free
= rds_ib_conn_free
,
417 .conn_path_connect
= rds_ib_conn_path_connect
,
418 .conn_path_shutdown
= rds_ib_conn_path_shutdown
,
419 .inc_copy_to_user
= rds_ib_inc_copy_to_user
,
420 .inc_free
= rds_ib_inc_free
,
421 .cm_initiate_connect
= rds_ib_cm_initiate_connect
,
422 .cm_handle_connect
= rds_ib_cm_handle_connect
,
423 .cm_connect_complete
= rds_ib_cm_connect_complete
,
424 .stats_info_copy
= rds_ib_stats_info_copy
,
426 .get_mr
= rds_ib_get_mr
,
427 .sync_mr
= rds_ib_sync_mr
,
428 .free_mr
= rds_ib_free_mr
,
429 .flush_mrs
= rds_ib_flush_mrs
,
430 .t_owner
= THIS_MODULE
,
431 .t_name
= "infiniband",
432 .t_unloading
= rds_ib_is_unloading
,
433 .t_type
= RDS_TRANS_IB
436 int rds_ib_init(void)
440 INIT_LIST_HEAD(&rds_ib_devices
);
442 ret
= rds_ib_mr_init();
446 ret
= ib_register_client(&rds_ib_client
);
450 ret
= rds_ib_sysctl_init();
454 ret
= rds_ib_recv_init();
458 rds_trans_register(&rds_ib_transport
);
460 rds_info_register_func(RDS_INFO_IB_CONNECTIONS
, rds_ib_ic_info
);
465 rds_ib_sysctl_exit();
467 rds_ib_unregister_client();
474 MODULE_LICENSE("GPL");