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/slab.h>
36 #include <linux/module.h>
38 #include <net/net_namespace.h>
39 #include <net/netns/generic.h>
44 /* only for info exporting */
45 static DEFINE_SPINLOCK(rds_tcp_tc_list_lock);
46 static LIST_HEAD(rds_tcp_tc_list);
47 static unsigned int rds_tcp_tc_count;
49 /* Track rds_tcp_connection structs so they can be cleaned up */
50 static DEFINE_SPINLOCK(rds_tcp_conn_lock);
51 static LIST_HEAD(rds_tcp_conn_list);
52 static atomic_t rds_tcp_unloading = ATOMIC_INIT(0);
54 static struct kmem_cache *rds_tcp_conn_slab;
56 static int rds_tcp_skbuf_handler(struct ctl_table *ctl, int write,
57 void __user *buffer, size_t *lenp,
60 static int rds_tcp_min_sndbuf = SOCK_MIN_SNDBUF;
61 static int rds_tcp_min_rcvbuf = SOCK_MIN_RCVBUF;
63 static struct ctl_table rds_tcp_sysctl_table[] = {
64 #define RDS_TCP_SNDBUF 0
66 .procname = "rds_tcp_sndbuf",
67 /* data is per-net pointer */
68 .maxlen = sizeof(int),
70 .proc_handler = rds_tcp_skbuf_handler,
71 .extra1 = &rds_tcp_min_sndbuf,
73 #define RDS_TCP_RCVBUF 1
75 .procname = "rds_tcp_rcvbuf",
76 /* data is per-net pointer */
77 .maxlen = sizeof(int),
79 .proc_handler = rds_tcp_skbuf_handler,
80 .extra1 = &rds_tcp_min_rcvbuf,
85 /* doing it this way avoids calling tcp_sk() */
86 void rds_tcp_nonagle(struct socket *sock)
90 kernel_setsockopt(sock, SOL_TCP, TCP_NODELAY, (void *)&val,
94 u32 rds_tcp_write_seq(struct rds_tcp_connection *tc)
96 /* seq# of the last byte of data in tcp send buffer */
97 return tcp_sk(tc->t_sock->sk)->write_seq;
100 u32 rds_tcp_snd_una(struct rds_tcp_connection *tc)
102 return tcp_sk(tc->t_sock->sk)->snd_una;
105 void rds_tcp_restore_callbacks(struct socket *sock,
106 struct rds_tcp_connection *tc)
108 rdsdebug("restoring sock %p callbacks from tc %p\n", sock, tc);
109 write_lock_bh(&sock->sk->sk_callback_lock);
111 /* done under the callback_lock to serialize with write_space */
112 spin_lock(&rds_tcp_tc_list_lock);
113 list_del_init(&tc->t_list_item);
115 spin_unlock(&rds_tcp_tc_list_lock);
119 sock->sk->sk_write_space = tc->t_orig_write_space;
120 sock->sk->sk_data_ready = tc->t_orig_data_ready;
121 sock->sk->sk_state_change = tc->t_orig_state_change;
122 sock->sk->sk_user_data = NULL;
124 write_unlock_bh(&sock->sk->sk_callback_lock);
128 * rds_tcp_reset_callbacks() switches the to the new sock and
129 * returns the existing tc->t_sock.
131 * The only functions that set tc->t_sock are rds_tcp_set_callbacks
132 * and rds_tcp_reset_callbacks. Send and receive trust that
133 * it is set. The absence of RDS_CONN_UP bit protects those paths
134 * from being called while it isn't set.
136 void rds_tcp_reset_callbacks(struct socket *sock,
137 struct rds_conn_path *cp)
139 struct rds_tcp_connection *tc = cp->cp_transport_data;
140 struct socket *osock = tc->t_sock;
145 /* Need to resolve a duelling SYN between peers.
146 * We have an outstanding SYN to this peer, which may
147 * potentially have transitioned to the RDS_CONN_UP state,
148 * so we must quiesce any send threads before resetting
149 * cp_transport_data. We quiesce these threads by setting
150 * cp_state to something other than RDS_CONN_UP, and then
151 * waiting for any existing threads in rds_send_xmit to
152 * complete release_in_xmit(). (Subsequent threads entering
153 * rds_send_xmit() will bail on !rds_conn_up().
155 * However an incoming syn-ack at this point would end up
156 * marking the conn as RDS_CONN_UP, and would again permit
157 * rds_send_xmi() threads through, so ideally we would
158 * synchronize on RDS_CONN_UP after lock_sock(), but cannot
159 * do that: waiting on !RDS_IN_XMIT after lock_sock() may
160 * end up deadlocking with tcp_sendmsg(), and the RDS_IN_XMIT
161 * would not get set. As a result, we set c_state to
162 * RDS_CONN_RESETTTING, to ensure that rds_tcp_state_change
163 * cannot mark rds_conn_path_up() in the window before lock_sock()
165 atomic_set(&cp->cp_state, RDS_CONN_RESETTING);
166 wait_event(cp->cp_waitq, !test_bit(RDS_IN_XMIT, &cp->cp_flags));
167 lock_sock(osock->sk);
168 /* reset receive side state for rds_tcp_data_recv() for osock */
169 cancel_delayed_work_sync(&cp->cp_send_w);
170 cancel_delayed_work_sync(&cp->cp_recv_w);
172 rds_inc_put(&tc->t_tinc->ti_inc);
175 tc->t_tinc_hdr_rem = sizeof(struct rds_header);
176 tc->t_tinc_data_rem = 0;
177 rds_tcp_restore_callbacks(osock, tc);
178 release_sock(osock->sk);
181 rds_send_path_reset(cp);
183 rds_tcp_set_callbacks(sock, cp);
184 release_sock(sock->sk);
187 /* Add tc to rds_tcp_tc_list and set tc->t_sock. See comments
188 * above rds_tcp_reset_callbacks for notes about synchronization
191 void rds_tcp_set_callbacks(struct socket *sock, struct rds_conn_path *cp)
193 struct rds_tcp_connection *tc = cp->cp_transport_data;
195 rdsdebug("setting sock %p callbacks to tc %p\n", sock, tc);
196 write_lock_bh(&sock->sk->sk_callback_lock);
198 /* done under the callback_lock to serialize with write_space */
199 spin_lock(&rds_tcp_tc_list_lock);
200 list_add_tail(&tc->t_list_item, &rds_tcp_tc_list);
202 spin_unlock(&rds_tcp_tc_list_lock);
204 /* accepted sockets need our listen data ready undone */
205 if (sock->sk->sk_data_ready == rds_tcp_listen_data_ready)
206 sock->sk->sk_data_ready = sock->sk->sk_user_data;
210 tc->t_orig_data_ready = sock->sk->sk_data_ready;
211 tc->t_orig_write_space = sock->sk->sk_write_space;
212 tc->t_orig_state_change = sock->sk->sk_state_change;
214 sock->sk->sk_user_data = cp;
215 sock->sk->sk_data_ready = rds_tcp_data_ready;
216 sock->sk->sk_write_space = rds_tcp_write_space;
217 sock->sk->sk_state_change = rds_tcp_state_change;
219 write_unlock_bh(&sock->sk->sk_callback_lock);
222 static void rds_tcp_tc_info(struct socket *rds_sock, unsigned int len,
223 struct rds_info_iterator *iter,
224 struct rds_info_lengths *lens)
226 struct rds_info_tcp_socket tsinfo;
227 struct rds_tcp_connection *tc;
229 struct sockaddr_in sin;
233 spin_lock_irqsave(&rds_tcp_tc_list_lock, flags);
235 if (len / sizeof(tsinfo) < rds_tcp_tc_count)
238 list_for_each_entry(tc, &rds_tcp_tc_list, t_list_item) {
242 sock->ops->getname(sock, (struct sockaddr *)&sin,
244 tsinfo.local_addr = sin.sin_addr.s_addr;
245 tsinfo.local_port = sin.sin_port;
246 sock->ops->getname(sock, (struct sockaddr *)&sin,
248 tsinfo.peer_addr = sin.sin_addr.s_addr;
249 tsinfo.peer_port = sin.sin_port;
252 tsinfo.hdr_rem = tc->t_tinc_hdr_rem;
253 tsinfo.data_rem = tc->t_tinc_data_rem;
254 tsinfo.last_sent_nxt = tc->t_last_sent_nxt;
255 tsinfo.last_expected_una = tc->t_last_expected_una;
256 tsinfo.last_seen_una = tc->t_last_seen_una;
258 rds_info_copy(iter, &tsinfo, sizeof(tsinfo));
262 lens->nr = rds_tcp_tc_count;
263 lens->each = sizeof(tsinfo);
265 spin_unlock_irqrestore(&rds_tcp_tc_list_lock, flags);
268 static int rds_tcp_laddr_check(struct net *net, __be32 addr)
270 if (inet_addr_type(net, addr) == RTN_LOCAL)
272 return -EADDRNOTAVAIL;
275 static void rds_tcp_conn_free(void *arg)
277 struct rds_tcp_connection *tc = arg;
279 rdsdebug("freeing tc %p\n", tc);
281 spin_lock_bh(&rds_tcp_conn_lock);
282 if (!tc->t_tcp_node_detached)
283 list_del(&tc->t_tcp_node);
284 spin_unlock_bh(&rds_tcp_conn_lock);
286 kmem_cache_free(rds_tcp_conn_slab, tc);
289 static int rds_tcp_conn_alloc(struct rds_connection *conn, gfp_t gfp)
291 struct rds_tcp_connection *tc;
295 for (i = 0; i < RDS_MPATH_WORKERS; i++) {
296 tc = kmem_cache_alloc(rds_tcp_conn_slab, gfp);
301 mutex_init(&tc->t_conn_path_lock);
304 tc->t_tinc_hdr_rem = sizeof(struct rds_header);
305 tc->t_tinc_data_rem = 0;
307 conn->c_path[i].cp_transport_data = tc;
308 tc->t_cpath = &conn->c_path[i];
309 tc->t_tcp_node_detached = true;
311 rdsdebug("rds_conn_path [%d] tc %p\n", i,
312 conn->c_path[i].cp_transport_data);
314 spin_lock_bh(&rds_tcp_conn_lock);
315 for (i = 0; i < RDS_MPATH_WORKERS; i++) {
316 tc = conn->c_path[i].cp_transport_data;
317 tc->t_tcp_node_detached = false;
318 list_add_tail(&tc->t_tcp_node, &rds_tcp_conn_list);
320 spin_unlock_bh(&rds_tcp_conn_lock);
323 for (j = 0; j < i; j++)
324 rds_tcp_conn_free(conn->c_path[j].cp_transport_data);
329 static bool list_has_conn(struct list_head *list, struct rds_connection *conn)
331 struct rds_tcp_connection *tc, *_tc;
333 list_for_each_entry_safe(tc, _tc, list, t_tcp_node) {
334 if (tc->t_cpath->cp_conn == conn)
340 static void rds_tcp_set_unloading(void)
342 atomic_set(&rds_tcp_unloading, 1);
345 static bool rds_tcp_is_unloading(struct rds_connection *conn)
347 return atomic_read(&rds_tcp_unloading) != 0;
350 static void rds_tcp_destroy_conns(void)
352 struct rds_tcp_connection *tc, *_tc;
355 /* avoid calling conn_destroy with irqs off */
356 spin_lock_irq(&rds_tcp_conn_lock);
357 list_for_each_entry_safe(tc, _tc, &rds_tcp_conn_list, t_tcp_node) {
358 if (!list_has_conn(&tmp_list, tc->t_cpath->cp_conn))
359 list_move_tail(&tc->t_tcp_node, &tmp_list);
361 spin_unlock_irq(&rds_tcp_conn_lock);
363 list_for_each_entry_safe(tc, _tc, &tmp_list, t_tcp_node)
364 rds_conn_destroy(tc->t_cpath->cp_conn);
367 static void rds_tcp_exit(void);
369 struct rds_transport rds_tcp_transport = {
370 .laddr_check = rds_tcp_laddr_check,
371 .xmit_path_prepare = rds_tcp_xmit_path_prepare,
372 .xmit_path_complete = rds_tcp_xmit_path_complete,
373 .xmit = rds_tcp_xmit,
374 .recv_path = rds_tcp_recv_path,
375 .conn_alloc = rds_tcp_conn_alloc,
376 .conn_free = rds_tcp_conn_free,
377 .conn_path_connect = rds_tcp_conn_path_connect,
378 .conn_path_shutdown = rds_tcp_conn_path_shutdown,
379 .inc_copy_to_user = rds_tcp_inc_copy_to_user,
380 .inc_free = rds_tcp_inc_free,
381 .stats_info_copy = rds_tcp_stats_info_copy,
382 .exit = rds_tcp_exit,
383 .t_owner = THIS_MODULE,
385 .t_type = RDS_TRANS_TCP,
386 .t_prefer_loopback = 1,
388 .t_unloading = rds_tcp_is_unloading,
391 static unsigned int rds_tcp_netid;
393 /* per-network namespace private data for this module */
395 struct socket *rds_tcp_listen_sock;
396 struct work_struct rds_tcp_accept_w;
397 struct ctl_table_header *rds_tcp_sysctl;
398 struct ctl_table *ctl_table;
403 /* All module specific customizations to the RDS-TCP socket should be done in
404 * rds_tcp_tune() and applied after socket creation.
406 void rds_tcp_tune(struct socket *sock)
408 struct sock *sk = sock->sk;
409 struct net *net = sock_net(sk);
410 struct rds_tcp_net *rtn = net_generic(net, rds_tcp_netid);
412 rds_tcp_nonagle(sock);
414 if (rtn->sndbuf_size > 0) {
415 sk->sk_sndbuf = rtn->sndbuf_size;
416 sk->sk_userlocks |= SOCK_SNDBUF_LOCK;
418 if (rtn->rcvbuf_size > 0) {
419 sk->sk_sndbuf = rtn->rcvbuf_size;
420 sk->sk_userlocks |= SOCK_RCVBUF_LOCK;
425 static void rds_tcp_accept_worker(struct work_struct *work)
427 struct rds_tcp_net *rtn = container_of(work,
431 while (rds_tcp_accept_one(rtn->rds_tcp_listen_sock) == 0)
435 void rds_tcp_accept_work(struct sock *sk)
437 struct net *net = sock_net(sk);
438 struct rds_tcp_net *rtn = net_generic(net, rds_tcp_netid);
440 queue_work(rds_wq, &rtn->rds_tcp_accept_w);
443 static __net_init int rds_tcp_init_net(struct net *net)
445 struct rds_tcp_net *rtn = net_generic(net, rds_tcp_netid);
446 struct ctl_table *tbl;
449 memset(rtn, 0, sizeof(*rtn));
451 /* {snd, rcv}buf_size default to 0, which implies we let the
452 * stack pick the value, and permit auto-tuning of buffer size.
454 if (net == &init_net) {
455 tbl = rds_tcp_sysctl_table;
457 tbl = kmemdup(rds_tcp_sysctl_table,
458 sizeof(rds_tcp_sysctl_table), GFP_KERNEL);
460 pr_warn("could not set allocate syctl table\n");
463 rtn->ctl_table = tbl;
465 tbl[RDS_TCP_SNDBUF].data = &rtn->sndbuf_size;
466 tbl[RDS_TCP_RCVBUF].data = &rtn->rcvbuf_size;
467 rtn->rds_tcp_sysctl = register_net_sysctl(net, "net/rds/tcp", tbl);
468 if (!rtn->rds_tcp_sysctl) {
469 pr_warn("could not register sysctl\n");
473 rtn->rds_tcp_listen_sock = rds_tcp_listen_init(net);
474 if (!rtn->rds_tcp_listen_sock) {
475 pr_warn("could not set up listen sock\n");
476 unregister_net_sysctl_table(rtn->rds_tcp_sysctl);
477 rtn->rds_tcp_sysctl = NULL;
481 INIT_WORK(&rtn->rds_tcp_accept_w, rds_tcp_accept_worker);
485 if (net != &init_net)
490 static void __net_exit rds_tcp_exit_net(struct net *net)
492 struct rds_tcp_net *rtn = net_generic(net, rds_tcp_netid);
494 if (rtn->rds_tcp_sysctl)
495 unregister_net_sysctl_table(rtn->rds_tcp_sysctl);
497 if (net != &init_net && rtn->ctl_table)
498 kfree(rtn->ctl_table);
500 /* If rds_tcp_exit_net() is called as a result of netns deletion,
501 * the rds_tcp_kill_sock() device notifier would already have cleaned
502 * up the listen socket, thus there is no work to do in this function.
504 * If rds_tcp_exit_net() is called as a result of module unload,
505 * i.e., due to rds_tcp_exit() -> unregister_pernet_subsys(), then
506 * we do need to clean up the listen socket here.
508 if (rtn->rds_tcp_listen_sock) {
509 struct socket *lsock = rtn->rds_tcp_listen_sock;
511 rtn->rds_tcp_listen_sock = NULL;
512 rds_tcp_listen_stop(lsock, &rtn->rds_tcp_accept_w);
516 static struct pernet_operations rds_tcp_net_ops = {
517 .init = rds_tcp_init_net,
518 .exit = rds_tcp_exit_net,
519 .id = &rds_tcp_netid,
520 .size = sizeof(struct rds_tcp_net),
523 static void rds_tcp_kill_sock(struct net *net)
525 struct rds_tcp_connection *tc, *_tc;
527 struct rds_tcp_net *rtn = net_generic(net, rds_tcp_netid);
528 struct socket *lsock = rtn->rds_tcp_listen_sock;
530 rtn->rds_tcp_listen_sock = NULL;
531 rds_tcp_listen_stop(lsock, &rtn->rds_tcp_accept_w);
532 spin_lock_bh(&rds_tcp_conn_lock);
533 list_for_each_entry_safe(tc, _tc, &rds_tcp_conn_list, t_tcp_node) {
534 struct net *c_net = read_pnet(&tc->t_cpath->cp_conn->c_net);
536 if (net != c_net || !tc->t_sock)
538 if (!list_has_conn(&tmp_list, tc->t_cpath->cp_conn)) {
539 list_move_tail(&tc->t_tcp_node, &tmp_list);
541 list_del(&tc->t_tcp_node);
542 tc->t_tcp_node_detached = true;
545 spin_unlock_bh(&rds_tcp_conn_lock);
546 list_for_each_entry_safe(tc, _tc, &tmp_list, t_tcp_node)
547 rds_conn_destroy(tc->t_cpath->cp_conn);
550 void *rds_tcp_listen_sock_def_readable(struct net *net)
552 struct rds_tcp_net *rtn = net_generic(net, rds_tcp_netid);
553 struct socket *lsock = rtn->rds_tcp_listen_sock;
558 return lsock->sk->sk_user_data;
561 static int rds_tcp_dev_event(struct notifier_block *this,
562 unsigned long event, void *ptr)
564 struct net_device *dev = netdev_notifier_info_to_dev(ptr);
566 /* rds-tcp registers as a pernet subys, so the ->exit will only
567 * get invoked after network acitivity has quiesced. We need to
568 * clean up all sockets to quiesce network activity, and use
569 * the unregistration of the per-net loopback device as a trigger
570 * to start that cleanup.
572 if (event == NETDEV_UNREGISTER_FINAL &&
573 dev->ifindex == LOOPBACK_IFINDEX)
574 rds_tcp_kill_sock(dev_net(dev));
579 static struct notifier_block rds_tcp_dev_notifier = {
580 .notifier_call = rds_tcp_dev_event,
581 .priority = -10, /* must be called after other network notifiers */
584 /* when sysctl is used to modify some kernel socket parameters,this
585 * function resets the RDS connections in that netns so that we can
586 * restart with new parameters. The assumption is that such reset
587 * events are few and far-between.
589 static void rds_tcp_sysctl_reset(struct net *net)
591 struct rds_tcp_connection *tc, *_tc;
593 spin_lock_bh(&rds_tcp_conn_lock);
594 list_for_each_entry_safe(tc, _tc, &rds_tcp_conn_list, t_tcp_node) {
595 struct net *c_net = read_pnet(&tc->t_cpath->cp_conn->c_net);
597 if (net != c_net || !tc->t_sock)
600 /* reconnect with new parameters */
601 rds_conn_path_drop(tc->t_cpath, false);
603 spin_unlock_bh(&rds_tcp_conn_lock);
606 static int rds_tcp_skbuf_handler(struct ctl_table *ctl, int write,
607 void __user *buffer, size_t *lenp,
610 struct net *net = current->nsproxy->net_ns;
613 err = proc_dointvec_minmax(ctl, write, buffer, lenp, fpos);
615 pr_warn("Invalid input. Must be >= %d\n",
616 *(int *)(ctl->extra1));
620 rds_tcp_sysctl_reset(net);
624 static void rds_tcp_exit(void)
626 rds_tcp_set_unloading();
628 rds_info_deregister_func(RDS_INFO_TCP_SOCKETS, rds_tcp_tc_info);
629 unregister_pernet_subsys(&rds_tcp_net_ops);
630 if (unregister_netdevice_notifier(&rds_tcp_dev_notifier))
631 pr_warn("could not unregister rds_tcp_dev_notifier\n");
632 rds_tcp_destroy_conns();
633 rds_trans_unregister(&rds_tcp_transport);
635 kmem_cache_destroy(rds_tcp_conn_slab);
637 module_exit(rds_tcp_exit);
639 static int rds_tcp_init(void)
643 rds_tcp_conn_slab = kmem_cache_create("rds_tcp_connection",
644 sizeof(struct rds_tcp_connection),
646 if (!rds_tcp_conn_slab) {
651 ret = rds_tcp_recv_init();
655 ret = register_pernet_subsys(&rds_tcp_net_ops);
659 ret = register_netdevice_notifier(&rds_tcp_dev_notifier);
661 pr_warn("could not register rds_tcp_dev_notifier\n");
665 rds_trans_register(&rds_tcp_transport);
667 rds_info_register_func(RDS_INFO_TCP_SOCKETS, rds_tcp_tc_info);
672 unregister_pernet_subsys(&rds_tcp_net_ops);
676 kmem_cache_destroy(rds_tcp_conn_slab);
680 module_init(rds_tcp_init);
682 MODULE_AUTHOR("Oracle Corporation <rds-devel@oss.oracle.com>");
683 MODULE_DESCRIPTION("RDS: TCP transport");
684 MODULE_LICENSE("Dual BSD/GPL");