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>
34 #include <linux/list.h>
35 #include <linux/slab.h>
36 #include <linux/export.h>
37 #include <net/inet_hashtables.h>
42 #define RDS_CONNECTION_HASH_BITS 12
43 #define RDS_CONNECTION_HASH_ENTRIES (1 << RDS_CONNECTION_HASH_BITS)
44 #define RDS_CONNECTION_HASH_MASK (RDS_CONNECTION_HASH_ENTRIES - 1)
46 /* converting this to RCU is a chore for another day.. */
47 static DEFINE_SPINLOCK(rds_conn_lock);
48 static unsigned long rds_conn_count;
49 static struct hlist_head rds_conn_hash[RDS_CONNECTION_HASH_ENTRIES];
50 static struct kmem_cache *rds_conn_slab;
52 static struct hlist_head *rds_conn_bucket(__be32 laddr, __be32 faddr)
54 static u32 rds_hash_secret __read_mostly;
58 net_get_random_once(&rds_hash_secret, sizeof(rds_hash_secret));
60 /* Pass NULL, don't need struct net for hash */
61 hash = __inet_ehashfn(be32_to_cpu(laddr), 0,
62 be32_to_cpu(faddr), 0,
64 return &rds_conn_hash[hash & RDS_CONNECTION_HASH_MASK];
67 #define rds_conn_info_set(var, test, suffix) do { \
69 var |= RDS_INFO_CONNECTION_FLAG_##suffix; \
72 /* rcu read lock must be held or the connection spinlock */
73 static struct rds_connection *rds_conn_lookup(struct net *net,
74 struct hlist_head *head,
75 __be32 laddr, __be32 faddr,
76 struct rds_transport *trans)
78 struct rds_connection *conn, *ret = NULL;
80 hlist_for_each_entry_rcu(conn, head, c_hash_node) {
81 if (conn->c_faddr == faddr && conn->c_laddr == laddr &&
82 conn->c_trans == trans && net == rds_conn_net(conn)) {
87 rdsdebug("returning conn %p for %pI4 -> %pI4\n", ret,
93 * This is called by transports as they're bringing down a connection.
94 * It clears partial message state so that the transport can start sending
95 * and receiving over this connection again in the future. It is up to
96 * the transport to have serialized this call with its send and recv.
98 static void rds_conn_path_reset(struct rds_conn_path *cp)
100 struct rds_connection *conn = cp->cp_conn;
102 rdsdebug("connection %pI4 to %pI4 reset\n",
103 &conn->c_laddr, &conn->c_faddr);
105 rds_stats_inc(s_conn_reset);
106 rds_send_path_reset(cp);
109 /* Do not clear next_rx_seq here, else we cannot distinguish
110 * retransmitted packets from new packets, and will hand all
111 * of them to the application. That is not consistent with the
112 * reliability guarantees of RDS. */
115 static void __rds_conn_path_init(struct rds_connection *conn,
116 struct rds_conn_path *cp, bool is_outgoing)
118 spin_lock_init(&cp->cp_lock);
119 cp->cp_next_tx_seq = 1;
120 init_waitqueue_head(&cp->cp_waitq);
121 INIT_LIST_HEAD(&cp->cp_send_queue);
122 INIT_LIST_HEAD(&cp->cp_retrans);
125 atomic_set(&cp->cp_state, RDS_CONN_DOWN);
127 /* cp_outgoing is per-path. So we can only set it here
128 * for the single-path transports.
130 if (!conn->c_trans->t_mp_capable)
131 cp->cp_outgoing = (is_outgoing ? 1 : 0);
132 cp->cp_reconnect_jiffies = 0;
133 INIT_DELAYED_WORK(&cp->cp_send_w, rds_send_worker);
134 INIT_DELAYED_WORK(&cp->cp_recv_w, rds_recv_worker);
135 INIT_DELAYED_WORK(&cp->cp_conn_w, rds_connect_worker);
136 INIT_WORK(&cp->cp_down_w, rds_shutdown_worker);
137 mutex_init(&cp->cp_cm_lock);
142 * There is only every one 'conn' for a given pair of addresses in the
143 * system at a time. They contain messages to be retransmitted and so
144 * span the lifetime of the actual underlying transport connections.
146 * For now they are not garbage collected once they're created. They
147 * are torn down as the module is removed, if ever.
149 static struct rds_connection *__rds_conn_create(struct net *net,
150 __be32 laddr, __be32 faddr,
151 struct rds_transport *trans, gfp_t gfp,
154 struct rds_connection *conn, *parent = NULL;
155 struct hlist_head *head = rds_conn_bucket(laddr, faddr);
156 struct rds_transport *loop_trans;
161 conn = rds_conn_lookup(net, head, laddr, faddr, trans);
162 if (conn && conn->c_loopback && conn->c_trans != &rds_loop_transport &&
163 laddr == faddr && !is_outgoing) {
164 /* This is a looped back IB connection, and we're
165 * called by the code handling the incoming connect.
166 * We need a second connection object into which we
167 * can stick the other QP. */
169 conn = parent->c_passive;
175 conn = kmem_cache_zalloc(rds_conn_slab, gfp);
177 conn = ERR_PTR(-ENOMEM);
181 INIT_HLIST_NODE(&conn->c_hash_node);
182 conn->c_laddr = laddr;
183 conn->c_faddr = faddr;
185 rds_conn_net_set(conn, net);
187 ret = rds_cong_get_maps(conn);
189 kmem_cache_free(rds_conn_slab, conn);
195 * This is where a connection becomes loopback. If *any* RDS sockets
196 * can bind to the destination address then we'd rather the messages
197 * flow through loopback rather than either transport.
199 loop_trans = rds_trans_get_preferred(net, faddr);
201 rds_trans_put(loop_trans);
202 conn->c_loopback = 1;
203 if (is_outgoing && trans->t_prefer_loopback) {
204 /* "outgoing" connection - and the transport
205 * says it wants the connection handled by the
206 * loopback transport. This is what TCP does.
208 trans = &rds_loop_transport;
212 conn->c_trans = trans;
214 init_waitqueue_head(&conn->c_hs_waitq);
215 for (i = 0; i < RDS_MPATH_WORKERS; i++) {
216 __rds_conn_path_init(conn, &conn->c_path[i],
218 conn->c_path[i].cp_index = i;
220 ret = trans->conn_alloc(conn, gfp);
222 kmem_cache_free(rds_conn_slab, conn);
227 rdsdebug("allocated conn %p for %pI4 -> %pI4 over %s %s\n",
228 conn, &laddr, &faddr,
229 trans->t_name ? trans->t_name : "[unknown]",
230 is_outgoing ? "(outgoing)" : "");
233 * Since we ran without holding the conn lock, someone could
234 * have created the same conn (either normal or passive) in the
235 * interim. We check while holding the lock. If we won, we complete
236 * init and return our conn. If we lost, we rollback and return the
239 spin_lock_irqsave(&rds_conn_lock, flags);
241 /* Creating passive conn */
242 if (parent->c_passive) {
243 trans->conn_free(conn->c_path[0].cp_transport_data);
244 kmem_cache_free(rds_conn_slab, conn);
245 conn = parent->c_passive;
247 parent->c_passive = conn;
248 rds_cong_add_conn(conn);
252 /* Creating normal conn */
253 struct rds_connection *found;
255 found = rds_conn_lookup(net, head, laddr, faddr, trans);
257 struct rds_conn_path *cp;
260 for (i = 0; i < RDS_MPATH_WORKERS; i++) {
261 cp = &conn->c_path[i];
262 /* The ->conn_alloc invocation may have
263 * allocated resource for all paths, so all
264 * of them may have to be freed here.
266 if (cp->cp_transport_data)
267 trans->conn_free(cp->cp_transport_data);
269 kmem_cache_free(rds_conn_slab, conn);
272 conn->c_my_gen_num = rds_gen_num;
273 conn->c_peer_gen_num = 0;
274 hlist_add_head_rcu(&conn->c_hash_node, head);
275 rds_cong_add_conn(conn);
279 spin_unlock_irqrestore(&rds_conn_lock, flags);
285 struct rds_connection *rds_conn_create(struct net *net,
286 __be32 laddr, __be32 faddr,
287 struct rds_transport *trans, gfp_t gfp)
289 return __rds_conn_create(net, laddr, faddr, trans, gfp, 0);
291 EXPORT_SYMBOL_GPL(rds_conn_create);
293 struct rds_connection *rds_conn_create_outgoing(struct net *net,
294 __be32 laddr, __be32 faddr,
295 struct rds_transport *trans, gfp_t gfp)
297 return __rds_conn_create(net, laddr, faddr, trans, gfp, 1);
299 EXPORT_SYMBOL_GPL(rds_conn_create_outgoing);
301 void rds_conn_shutdown(struct rds_conn_path *cp)
303 struct rds_connection *conn = cp->cp_conn;
305 /* shut it down unless it's down already */
306 if (!rds_conn_path_transition(cp, RDS_CONN_DOWN, RDS_CONN_DOWN)) {
308 * Quiesce the connection mgmt handlers before we start tearing
309 * things down. We don't hold the mutex for the entire
310 * duration of the shutdown operation, else we may be
311 * deadlocking with the CM handler. Instead, the CM event
312 * handler is supposed to check for state DISCONNECTING
314 mutex_lock(&cp->cp_cm_lock);
315 if (!rds_conn_path_transition(cp, RDS_CONN_UP,
316 RDS_CONN_DISCONNECTING) &&
317 !rds_conn_path_transition(cp, RDS_CONN_ERROR,
318 RDS_CONN_DISCONNECTING)) {
319 rds_conn_path_error(cp,
320 "shutdown called in state %d\n",
321 atomic_read(&cp->cp_state));
322 mutex_unlock(&cp->cp_cm_lock);
325 mutex_unlock(&cp->cp_cm_lock);
327 wait_event(cp->cp_waitq,
328 !test_bit(RDS_IN_XMIT, &cp->cp_flags));
329 wait_event(cp->cp_waitq,
330 !test_bit(RDS_RECV_REFILL, &cp->cp_flags));
332 conn->c_trans->conn_path_shutdown(cp);
333 rds_conn_path_reset(cp);
335 if (!rds_conn_path_transition(cp, RDS_CONN_DISCONNECTING,
337 /* This can happen - eg when we're in the middle of tearing
338 * down the connection, and someone unloads the rds module.
339 * Quite reproduceable with loopback connections.
342 rds_conn_path_error(cp, "%s: failed to transition "
343 "to state DOWN, current state "
345 atomic_read(&cp->cp_state));
350 /* Then reconnect if it's still live.
351 * The passive side of an IB loopback connection is never added
352 * to the conn hash, so we never trigger a reconnect on this
353 * conn - the reconnect is always triggered by the active peer. */
354 cancel_delayed_work_sync(&cp->cp_conn_w);
356 if (!hlist_unhashed(&conn->c_hash_node)) {
358 rds_queue_reconnect(cp);
364 /* destroy a single rds_conn_path. rds_conn_destroy() iterates over
365 * all paths using rds_conn_path_destroy()
367 static void rds_conn_path_destroy(struct rds_conn_path *cp)
369 struct rds_message *rm, *rtmp;
371 if (!cp->cp_transport_data)
374 rds_conn_path_drop(cp);
375 flush_work(&cp->cp_down_w);
377 /* make sure lingering queued work won't try to ref the conn */
378 cancel_delayed_work_sync(&cp->cp_send_w);
379 cancel_delayed_work_sync(&cp->cp_recv_w);
381 /* tear down queued messages */
382 list_for_each_entry_safe(rm, rtmp,
385 list_del_init(&rm->m_conn_item);
386 BUG_ON(!list_empty(&rm->m_sock_item));
390 rds_message_put(cp->cp_xmit_rm);
392 cp->cp_conn->c_trans->conn_free(cp->cp_transport_data);
396 * Stop and free a connection.
398 * This can only be used in very limited circumstances. It assumes that once
399 * the conn has been shutdown that no one else is referencing the connection.
400 * We can only ensure this in the rmmod path in the current code.
402 void rds_conn_destroy(struct rds_connection *conn)
406 struct rds_conn_path *cp;
408 rdsdebug("freeing conn %p for %pI4 -> "
409 "%pI4\n", conn, &conn->c_laddr,
412 /* Ensure conn will not be scheduled for reconnect */
413 spin_lock_irq(&rds_conn_lock);
414 hlist_del_init_rcu(&conn->c_hash_node);
415 spin_unlock_irq(&rds_conn_lock);
418 /* shut the connection down */
419 for (i = 0; i < RDS_MPATH_WORKERS; i++) {
420 cp = &conn->c_path[i];
421 rds_conn_path_destroy(cp);
422 BUG_ON(!list_empty(&cp->cp_retrans));
426 * The congestion maps aren't freed up here. They're
427 * freed by rds_cong_exit() after all the connections
430 rds_cong_remove_conn(conn);
432 kmem_cache_free(rds_conn_slab, conn);
434 spin_lock_irqsave(&rds_conn_lock, flags);
436 spin_unlock_irqrestore(&rds_conn_lock, flags);
438 EXPORT_SYMBOL_GPL(rds_conn_destroy);
440 static void rds_conn_message_info(struct socket *sock, unsigned int len,
441 struct rds_info_iterator *iter,
442 struct rds_info_lengths *lens,
445 struct hlist_head *head;
446 struct list_head *list;
447 struct rds_connection *conn;
448 struct rds_message *rm;
449 unsigned int total = 0;
454 len /= sizeof(struct rds_info_message);
458 for (i = 0, head = rds_conn_hash; i < ARRAY_SIZE(rds_conn_hash);
460 hlist_for_each_entry_rcu(conn, head, c_hash_node) {
461 struct rds_conn_path *cp;
463 for (j = 0; j < RDS_MPATH_WORKERS; j++) {
464 cp = &conn->c_path[j];
466 list = &cp->cp_send_queue;
468 list = &cp->cp_retrans;
470 spin_lock_irqsave(&cp->cp_lock, flags);
472 /* XXX too lazy to maintain counts.. */
473 list_for_each_entry(rm, list, m_conn_item) {
476 rds_inc_info_copy(&rm->m_inc,
483 spin_unlock_irqrestore(&cp->cp_lock, flags);
484 if (!conn->c_trans->t_mp_capable)
492 lens->each = sizeof(struct rds_info_message);
495 static void rds_conn_message_info_send(struct socket *sock, unsigned int len,
496 struct rds_info_iterator *iter,
497 struct rds_info_lengths *lens)
499 rds_conn_message_info(sock, len, iter, lens, 1);
502 static void rds_conn_message_info_retrans(struct socket *sock,
504 struct rds_info_iterator *iter,
505 struct rds_info_lengths *lens)
507 rds_conn_message_info(sock, len, iter, lens, 0);
510 void rds_for_each_conn_info(struct socket *sock, unsigned int len,
511 struct rds_info_iterator *iter,
512 struct rds_info_lengths *lens,
513 int (*visitor)(struct rds_connection *, void *),
516 uint64_t buffer[(item_len + 7) / 8];
517 struct hlist_head *head;
518 struct rds_connection *conn;
524 lens->each = item_len;
526 for (i = 0, head = rds_conn_hash; i < ARRAY_SIZE(rds_conn_hash);
528 hlist_for_each_entry_rcu(conn, head, c_hash_node) {
530 /* XXX no c_lock usage.. */
531 if (!visitor(conn, buffer))
534 /* We copy as much as we can fit in the buffer,
535 * but we count all items so that the caller
536 * can resize the buffer. */
537 if (len >= item_len) {
538 rds_info_copy(iter, buffer, item_len);
546 EXPORT_SYMBOL_GPL(rds_for_each_conn_info);
548 void rds_walk_conn_path_info(struct socket *sock, unsigned int len,
549 struct rds_info_iterator *iter,
550 struct rds_info_lengths *lens,
551 int (*visitor)(struct rds_conn_path *, void *),
554 u64 buffer[(item_len + 7) / 8];
555 struct hlist_head *head;
556 struct rds_connection *conn;
563 lens->each = item_len;
565 for (i = 0, head = rds_conn_hash; i < ARRAY_SIZE(rds_conn_hash);
567 hlist_for_each_entry_rcu(conn, head, c_hash_node) {
568 struct rds_conn_path *cp;
570 for (j = 0; j < RDS_MPATH_WORKERS; j++) {
571 cp = &conn->c_path[j];
573 /* XXX no cp_lock usage.. */
574 if (!visitor(cp, buffer))
576 if (!conn->c_trans->t_mp_capable)
580 /* We copy as much as we can fit in the buffer,
581 * but we count all items so that the caller
582 * can resize the buffer.
584 if (len >= item_len) {
585 rds_info_copy(iter, buffer, item_len);
594 static int rds_conn_info_visitor(struct rds_conn_path *cp, void *buffer)
596 struct rds_info_connection *cinfo = buffer;
598 cinfo->next_tx_seq = cp->cp_next_tx_seq;
599 cinfo->next_rx_seq = cp->cp_next_rx_seq;
600 cinfo->laddr = cp->cp_conn->c_laddr;
601 cinfo->faddr = cp->cp_conn->c_faddr;
602 strncpy(cinfo->transport, cp->cp_conn->c_trans->t_name,
603 sizeof(cinfo->transport));
606 rds_conn_info_set(cinfo->flags, test_bit(RDS_IN_XMIT, &cp->cp_flags),
608 /* XXX Future: return the state rather than these funky bits */
609 rds_conn_info_set(cinfo->flags,
610 atomic_read(&cp->cp_state) == RDS_CONN_CONNECTING,
612 rds_conn_info_set(cinfo->flags,
613 atomic_read(&cp->cp_state) == RDS_CONN_UP,
618 static void rds_conn_info(struct socket *sock, unsigned int len,
619 struct rds_info_iterator *iter,
620 struct rds_info_lengths *lens)
622 rds_walk_conn_path_info(sock, len, iter, lens,
623 rds_conn_info_visitor,
624 sizeof(struct rds_info_connection));
627 int rds_conn_init(void)
629 rds_conn_slab = kmem_cache_create("rds_connection",
630 sizeof(struct rds_connection),
635 rds_info_register_func(RDS_INFO_CONNECTIONS, rds_conn_info);
636 rds_info_register_func(RDS_INFO_SEND_MESSAGES,
637 rds_conn_message_info_send);
638 rds_info_register_func(RDS_INFO_RETRANS_MESSAGES,
639 rds_conn_message_info_retrans);
644 void rds_conn_exit(void)
648 WARN_ON(!hlist_empty(rds_conn_hash));
650 kmem_cache_destroy(rds_conn_slab);
652 rds_info_deregister_func(RDS_INFO_CONNECTIONS, rds_conn_info);
653 rds_info_deregister_func(RDS_INFO_SEND_MESSAGES,
654 rds_conn_message_info_send);
655 rds_info_deregister_func(RDS_INFO_RETRANS_MESSAGES,
656 rds_conn_message_info_retrans);
662 void rds_conn_path_drop(struct rds_conn_path *cp)
664 atomic_set(&cp->cp_state, RDS_CONN_ERROR);
665 queue_work(rds_wq, &cp->cp_down_w);
667 EXPORT_SYMBOL_GPL(rds_conn_path_drop);
669 void rds_conn_drop(struct rds_connection *conn)
671 WARN_ON(conn->c_trans->t_mp_capable);
672 rds_conn_path_drop(&conn->c_path[0]);
674 EXPORT_SYMBOL_GPL(rds_conn_drop);
677 * If the connection is down, trigger a connect. We may have scheduled a
678 * delayed reconnect however - in this case we should not interfere.
680 void rds_conn_path_connect_if_down(struct rds_conn_path *cp)
682 if (rds_conn_path_state(cp) == RDS_CONN_DOWN &&
683 !test_and_set_bit(RDS_RECONNECT_PENDING, &cp->cp_flags))
684 queue_delayed_work(rds_wq, &cp->cp_conn_w, 0);
687 void rds_conn_connect_if_down(struct rds_connection *conn)
689 WARN_ON(conn->c_trans->t_mp_capable);
690 rds_conn_path_connect_if_down(&conn->c_path[0]);
692 EXPORT_SYMBOL_GPL(rds_conn_connect_if_down);
695 __rds_conn_path_error(struct rds_conn_path *cp, const char *fmt, ...)
703 rds_conn_path_drop(cp);