net/rds/af_rds.c

   1 /*
   2  * Copyright (c) 2006 Oracle.  All rights reserved.
   3  *
   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:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  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.
  22  *
  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
  30  * SOFTWARE.
  31  *
  32  */
  33 #include <linux/module.h>
  34 #include <linux/errno.h>
  35 #include <linux/kernel.h>
  36 #include <linux/gfp.h>
  37 #include <linux/in.h>
  38 #include <linux/poll.h>
  39 #include <net/sock.h>
  40
  41 #include "rds.h"
  42
  43 /* this is just used for stats gathering :/ */
  44 static DEFINE_SPINLOCK(rds_sock_lock);
  45 static unsigned long rds_sock_count;
  46 static LIST_HEAD(rds_sock_list);
  47 DECLARE_WAIT_QUEUE_HEAD(rds_poll_waitq);
  48
  49 /*
  50  * This is called as the final descriptor referencing this socket is closed.
  51  * We have to unbind the socket so that another socket can be bound to the
  52  * address it was using.
  53  *
  54  * We have to be careful about racing with the incoming path.  sock_orphan()
  55  * sets SOCK_DEAD and we use that as an indicator to the rx path that new
  56  * messages shouldn't be queued.
  57  */
  58 static int rds_release(struct socket *sock)
  59 {
  60         struct sock *sk = sock->sk;
  61         struct rds_sock *rs;
  62
  63         if (!sk)
  64                 goto out;
  65
  66         rs = rds_sk_to_rs(sk);
  67
  68         sock_orphan(sk);
  69         /* Note - rds_clear_recv_queue grabs rs_recv_lock, so
  70          * that ensures the recv path has completed messing
  71          * with the socket. */
  72         rds_clear_recv_queue(rs);
  73         rds_cong_remove_socket(rs);
  74
  75         /*
  76          * the binding lookup hash uses rcu, we need to
  77          * make sure we synchronize_rcu before we free our
  78          * entry
  79          */
  80         rds_remove_bound(rs);
  81         synchronize_rcu();
  82
  83         rds_send_drop_to(rs, NULL);
  84         rds_rdma_drop_keys(rs);
  85         rds_notify_queue_get(rs, NULL);
  86
  87         spin_lock_bh(&rds_sock_lock);
  88         list_del_init(&rs->rs_item);
  89         rds_sock_count--;
  90         spin_unlock_bh(&rds_sock_lock);
  91
  92         rds_trans_put(rs->rs_transport);
  93
  94         sock->sk = NULL;
  95         sock_put(sk);
  96 out:
  97         return 0;
  98 }
  99
 100 /*
 101  * Careful not to race with rds_release -> sock_orphan which clears sk_sleep.
 102  * _bh() isn't OK here, we're called from interrupt handlers.  It's probably OK
 103  * to wake the waitqueue after sk_sleep is clear as we hold a sock ref, but
 104  * this seems more conservative.
 105  * NB - normally, one would use sk_callback_lock for this, but we can
 106  * get here from interrupts, whereas the network code grabs sk_callback_lock
 107  * with _lock_bh only - so relying on sk_callback_lock introduces livelocks.
 108  */
 109 void rds_wake_sk_sleep(struct rds_sock *rs)
 110 {
 111         unsigned long flags;
 112
 113         read_lock_irqsave(&rs->rs_recv_lock, flags);
 114         __rds_wake_sk_sleep(rds_rs_to_sk(rs));
 115         read_unlock_irqrestore(&rs->rs_recv_lock, flags);
 116 }
 117
 118 static int rds_getname(struct socket *sock, struct sockaddr *uaddr,
 119                        int *uaddr_len, int peer)
 120 {
 121         struct sockaddr_in *sin = (struct sockaddr_in *)uaddr;
 122         struct rds_sock *rs = rds_sk_to_rs(sock->sk);
 123
 124         memset(sin->sin_zero, 0, sizeof(sin->sin_zero));
 125
 126         /* racey, don't care */
 127         if (peer) {
 128                 if (!rs->rs_conn_addr)
 129                         return -ENOTCONN;
 130
 131                 sin->sin_port = rs->rs_conn_port;
 132                 sin->sin_addr.s_addr = rs->rs_conn_addr;
 133         } else {
 134                 sin->sin_port = rs->rs_bound_port;
 135                 sin->sin_addr.s_addr = rs->rs_bound_addr;
 136         }
 137
 138         sin->sin_family = AF_INET;
 139
 140         *uaddr_len = sizeof(*sin);
 141         return 0;
 142 }
 143
 144 /*
 145  * RDS' poll is without a doubt the least intuitive part of the interface,
 146  * as POLLIN and POLLOUT do not behave entirely as you would expect from
 147  * a network protocol.
 148  *
 149  * POLLIN is asserted if
 150  *  -   there is data on the receive queue.
 151  *  -   to signal that a previously congested destination may have become
 152  *      uncongested
 153  *  -   A notification has been queued to the socket (this can be a congestion
 154  *      update, or a RDMA completion).
 155  *
 156  * POLLOUT is asserted if there is room on the send queue. This does not mean
 157  * however, that the next sendmsg() call will succeed. If the application tries
 158  * to send to a congested destination, the system call may still fail (and
 159  * return ENOBUFS).
 160  */
 161 static unsigned int rds_poll(struct file *file, struct socket *sock,
 162                              poll_table *wait)
 163 {
 164         struct sock *sk = sock->sk;
 165         struct rds_sock *rs = rds_sk_to_rs(sk);
 166         unsigned int mask = 0;
 167         unsigned long flags;
 168
 169         poll_wait(file, sk_sleep(sk), wait);
 170
 171         if (rs->rs_seen_congestion)
 172                 poll_wait(file, &rds_poll_waitq, wait);
 173
 174         read_lock_irqsave(&rs->rs_recv_lock, flags);
 175         if (!rs->rs_cong_monitor) {
 176                 /* When a congestion map was updated, we signal POLLIN for
 177                  * "historical" reasons. Applications can also poll for
 178                  * WRBAND instead. */
 179                 if (rds_cong_updated_since(&rs->rs_cong_track))
 180                         mask |= (POLLIN | POLLRDNORM | POLLWRBAND);
 181         } else {
 182                 spin_lock(&rs->rs_lock);
 183                 if (rs->rs_cong_notify)
 184                         mask |= (POLLIN | POLLRDNORM);
 185                 spin_unlock(&rs->rs_lock);
 186         }
 187         if (!list_empty(&rs->rs_recv_queue) ||
 188             !list_empty(&rs->rs_notify_queue))
 189                 mask |= (POLLIN | POLLRDNORM);
 190         if (rs->rs_snd_bytes < rds_sk_sndbuf(rs))
 191                 mask |= (POLLOUT | POLLWRNORM);
 192         read_unlock_irqrestore(&rs->rs_recv_lock, flags);
 193
 194         /* clear state any time we wake a seen-congested socket */
 195         if (mask)
 196                 rs->rs_seen_congestion = 0;
 197
 198         return mask;
 199 }
 200
 201 static int rds_ioctl(struct socket *sock, unsigned int cmd, unsigned long arg)
 202 {
 203         return -ENOIOCTLCMD;
 204 }
 205
 206 static int rds_cancel_sent_to(struct rds_sock *rs, char __user *optval,
 207                               int len)
 208 {
 209         struct sockaddr_in sin;
 210         int ret = 0;
 211
 212         /* racing with another thread binding seems ok here */
 213         if (rs->rs_bound_addr == 0) {
 214                 ret = -ENOTCONN; /* XXX not a great errno */
 215                 goto out;
 216         }
 217
 218         if (len < sizeof(struct sockaddr_in)) {
 219                 ret = -EINVAL;
 220                 goto out;
 221         }
 222
 223         if (copy_from_user(&sin, optval, sizeof(sin))) {
 224                 ret = -EFAULT;
 225                 goto out;
 226         }
 227
 228         rds_send_drop_to(rs, &sin);
 229 out:
 230         return ret;
 231 }
 232
 233 static int rds_set_bool_option(unsigned char *optvar, char __user *optval,
 234                                int optlen)
 235 {
 236         int value;
 237
 238         if (optlen < sizeof(int))
 239                 return -EINVAL;
 240         if (get_user(value, (int __user *) optval))
 241                 return -EFAULT;
 242         *optvar = !!value;
 243         return 0;
 244 }
 245
 246 static int rds_cong_monitor(struct rds_sock *rs, char __user *optval,
 247                             int optlen)
 248 {
 249         int ret;
 250
 251         ret = rds_set_bool_option(&rs->rs_cong_monitor, optval, optlen);
 252         if (ret == 0) {
 253                 if (rs->rs_cong_monitor) {
 254                         rds_cong_add_socket(rs);
 255                 } else {
 256                         rds_cong_remove_socket(rs);
 257                         rs->rs_cong_mask = 0;
 258                         rs->rs_cong_notify = 0;
 259                 }
 260         }
 261         return ret;
 262 }
 263
 264 static int rds_setsockopt(struct socket *sock, int level, int optname,
 265                           char __user *optval, unsigned int optlen)
 266 {
 267         struct rds_sock *rs = rds_sk_to_rs(sock->sk);
 268         int ret;
 269
 270         if (level != SOL_RDS) {
 271                 ret = -ENOPROTOOPT;
 272                 goto out;
 273         }
 274
 275         switch (optname) {
 276         case RDS_CANCEL_SENT_TO:
 277                 ret = rds_cancel_sent_to(rs, optval, optlen);
 278                 break;
 279         case RDS_GET_MR:
 280                 ret = rds_get_mr(rs, optval, optlen);
 281                 break;
 282         case RDS_GET_MR_FOR_DEST:
 283                 ret = rds_get_mr_for_dest(rs, optval, optlen);
 284                 break;
 285         case RDS_FREE_MR:
 286                 ret = rds_free_mr(rs, optval, optlen);
 287                 break;
 288         case RDS_RECVERR:
 289                 ret = rds_set_bool_option(&rs->rs_recverr, optval, optlen);
 290                 break;
 291         case RDS_CONG_MONITOR:
 292                 ret = rds_cong_monitor(rs, optval, optlen);
 293                 break;
 294         default:
 295                 ret = -ENOPROTOOPT;
 296         }
 297 out:
 298         return ret;
 299 }
 300
 301 static int rds_getsockopt(struct socket *sock, int level, int optname,
 302                           char __user *optval, int __user *optlen)
 303 {
 304         struct rds_sock *rs = rds_sk_to_rs(sock->sk);
 305         int ret = -ENOPROTOOPT, len;
 306
 307         if (level != SOL_RDS)
 308                 goto out;
 309
 310         if (get_user(len, optlen)) {
 311                 ret = -EFAULT;
 312                 goto out;
 313         }
 314
 315         switch (optname) {
 316         case RDS_INFO_FIRST ... RDS_INFO_LAST:
 317                 ret = rds_info_getsockopt(sock, optname, optval,
 318                                           optlen);
 319                 break;
 320
 321         case RDS_RECVERR:
 322                 if (len < sizeof(int))
 323                         ret = -EINVAL;
 324                 else
 325                 if (put_user(rs->rs_recverr, (int __user *) optval) ||
 326                     put_user(sizeof(int), optlen))
 327                         ret = -EFAULT;
 328                 else
 329                         ret = 0;
 330                 break;
 331         default:
 332                 break;
 333         }
 334
 335 out:
 336         return ret;
 337
 338 }
 339
 340 static int rds_connect(struct socket *sock, struct sockaddr *uaddr,
 341                        int addr_len, int flags)
 342 {
 343         struct sock *sk = sock->sk;
 344         struct sockaddr_in *sin = (struct sockaddr_in *)uaddr;
 345         struct rds_sock *rs = rds_sk_to_rs(sk);
 346         int ret = 0;
 347
 348         lock_sock(sk);
 349
 350         if (addr_len != sizeof(struct sockaddr_in)) {
 351                 ret = -EINVAL;
 352                 goto out;
 353         }
 354
 355         if (sin->sin_family != AF_INET) {
 356                 ret = -EAFNOSUPPORT;
 357                 goto out;
 358         }
 359
 360         if (sin->sin_addr.s_addr == htonl(INADDR_ANY)) {
 361                 ret = -EDESTADDRREQ;
 362                 goto out;
 363         }
 364
 365         rs->rs_conn_addr = sin->sin_addr.s_addr;
 366         rs->rs_conn_port = sin->sin_port;
 367
 368 out:
 369         release_sock(sk);
 370         return ret;
 371 }
 372
 373 static struct proto rds_proto = {
 374         .name     = "RDS",
 375         .owner    = THIS_MODULE,
 376         .obj_size = sizeof(struct rds_sock),
 377 };
 378
 379 static const struct proto_ops rds_proto_ops = {
 380         .family =       AF_RDS,
 381         .owner =        THIS_MODULE,
 382         .release =      rds_release,
 383         .bind =         rds_bind,
 384         .connect =      rds_connect,
 385         .socketpair =   sock_no_socketpair,
 386         .accept =       sock_no_accept,
 387         .getname =      rds_getname,
 388         .poll =         rds_poll,
 389         .ioctl =        rds_ioctl,
 390         .listen =       sock_no_listen,
 391         .shutdown =     sock_no_shutdown,
 392         .setsockopt =   rds_setsockopt,
 393         .getsockopt =   rds_getsockopt,
 394         .sendmsg =      rds_sendmsg,
 395         .recvmsg =      rds_recvmsg,
 396         .mmap =         sock_no_mmap,
 397         .sendpage =     sock_no_sendpage,
 398 };
 399
 400 static int __rds_create(struct socket *sock, struct sock *sk, int protocol)
 401 {
 402         struct rds_sock *rs;
 403
 404         sock_init_data(sock, sk);
 405         sock->ops               = &rds_proto_ops;
 406         sk->sk_protocol         = protocol;
 407
 408         rs = rds_sk_to_rs(sk);
 409         spin_lock_init(&rs->rs_lock);
 410         rwlock_init(&rs->rs_recv_lock);
 411         INIT_LIST_HEAD(&rs->rs_send_queue);
 412         INIT_LIST_HEAD(&rs->rs_recv_queue);
 413         INIT_LIST_HEAD(&rs->rs_notify_queue);
 414         INIT_LIST_HEAD(&rs->rs_cong_list);
 415         spin_lock_init(&rs->rs_rdma_lock);
 416         rs->rs_rdma_keys = RB_ROOT;
 417
 418         spin_lock_bh(&rds_sock_lock);
 419         list_add_tail(&rs->rs_item, &rds_sock_list);
 420         rds_sock_count++;
 421         spin_unlock_bh(&rds_sock_lock);
 422
 423         return 0;
 424 }
 425
 426 static int rds_create(struct net *net, struct socket *sock, int protocol,
 427                       int kern)
 428 {
 429         struct sock *sk;
 430
 431         if (sock->type != SOCK_SEQPACKET || protocol)
 432                 return -ESOCKTNOSUPPORT;
 433
 434         sk = sk_alloc(net, AF_RDS, GFP_ATOMIC, &rds_proto);
 435         if (!sk)
 436                 return -ENOMEM;
 437
 438         return __rds_create(sock, sk, protocol);
 439 }
 440
 441 void rds_sock_addref(struct rds_sock *rs)
 442 {
 443         sock_hold(rds_rs_to_sk(rs));
 444 }
 445
 446 void rds_sock_put(struct rds_sock *rs)
 447 {
 448         sock_put(rds_rs_to_sk(rs));
 449 }
 450
 451 static const struct net_proto_family rds_family_ops = {
 452         .family =       AF_RDS,
 453         .create =       rds_create,
 454         .owner  =       THIS_MODULE,
 455 };
 456
 457 static void rds_sock_inc_info(struct socket *sock, unsigned int len,
 458                               struct rds_info_iterator *iter,
 459                               struct rds_info_lengths *lens)
 460 {
 461         struct rds_sock *rs;
 462         struct rds_incoming *inc;
 463         unsigned int total = 0;
 464
 465         len /= sizeof(struct rds_info_message);
 466
 467         spin_lock_bh(&rds_sock_lock);
 468
 469         list_for_each_entry(rs, &rds_sock_list, rs_item) {
 470                 read_lock(&rs->rs_recv_lock);
 471
 472                 /* XXX too lazy to maintain counts.. */
 473                 list_for_each_entry(inc, &rs->rs_recv_queue, i_item) {
 474                         total++;
 475                         if (total <= len)
 476                                 rds_inc_info_copy(inc, iter, inc->i_saddr,
 477                                                   rs->rs_bound_addr, 1);
 478                 }
 479
 480                 read_unlock(&rs->rs_recv_lock);
 481         }
 482
 483         spin_unlock_bh(&rds_sock_lock);
 484
 485         lens->nr = total;
 486         lens->each = sizeof(struct rds_info_message);
 487 }
 488
 489 static void rds_sock_info(struct socket *sock, unsigned int len,
 490                           struct rds_info_iterator *iter,
 491                           struct rds_info_lengths *lens)
 492 {
 493         struct rds_info_socket sinfo;
 494         struct rds_sock *rs;
 495
 496         len /= sizeof(struct rds_info_socket);
 497
 498         spin_lock_bh(&rds_sock_lock);
 499
 500         if (len < rds_sock_count)
 501                 goto out;
 502
 503         list_for_each_entry(rs, &rds_sock_list, rs_item) {
 504                 sinfo.sndbuf = rds_sk_sndbuf(rs);
 505                 sinfo.rcvbuf = rds_sk_rcvbuf(rs);
 506                 sinfo.bound_addr = rs->rs_bound_addr;
 507                 sinfo.connected_addr = rs->rs_conn_addr;
 508                 sinfo.bound_port = rs->rs_bound_port;
 509                 sinfo.connected_port = rs->rs_conn_port;
 510                 sinfo.inum = sock_i_ino(rds_rs_to_sk(rs));
 511
 512                 rds_info_copy(iter, &sinfo, sizeof(sinfo));
 513         }
 514
 515 out:
 516         lens->nr = rds_sock_count;
 517         lens->each = sizeof(struct rds_info_socket);
 518
 519         spin_unlock_bh(&rds_sock_lock);
 520 }
 521
 522 static void rds_exit(void)
 523 {
 524         sock_unregister(rds_family_ops.family);
 525         proto_unregister(&rds_proto);
 526         rds_conn_exit();
 527         rds_cong_exit();
 528         rds_sysctl_exit();
 529         rds_threads_exit();
 530         rds_stats_exit();
 531         rds_page_exit();
 532         rds_info_deregister_func(RDS_INFO_SOCKETS, rds_sock_info);
 533         rds_info_deregister_func(RDS_INFO_RECV_MESSAGES, rds_sock_inc_info);
 534 }
 535 module_exit(rds_exit);
 536
 537 static int rds_init(void)
 538 {
 539         int ret;
 540
 541         ret = rds_conn_init();
 542         if (ret)
 543                 goto out;
 544         ret = rds_threads_init();
 545         if (ret)
 546                 goto out_conn;
 547         ret = rds_sysctl_init();
 548         if (ret)
 549                 goto out_threads;
 550         ret = rds_stats_init();
 551         if (ret)
 552                 goto out_sysctl;
 553         ret = proto_register(&rds_proto, 1);
 554         if (ret)
 555                 goto out_stats;
 556         ret = sock_register(&rds_family_ops);
 557         if (ret)
 558                 goto out_proto;
 559
 560         rds_info_register_func(RDS_INFO_SOCKETS, rds_sock_info);
 561         rds_info_register_func(RDS_INFO_RECV_MESSAGES, rds_sock_inc_info);
 562
 563         goto out;
 564
 565 out_proto:
 566         proto_unregister(&rds_proto);
 567 out_stats:
 568         rds_stats_exit();
 569 out_sysctl:
 570         rds_sysctl_exit();
 571 out_threads:
 572         rds_threads_exit();
 573 out_conn:
 574         rds_conn_exit();
 575         rds_cong_exit();
 576         rds_page_exit();
 577 out:
 578         return ret;
 579 }
 580 module_init(rds_init);
 581
 582 #define DRV_VERSION     "4.0"
 583 #define DRV_RELDATE     "Feb 12, 2009"
 584
 585 MODULE_AUTHOR("Oracle Corporation <rds-devel@oss.oracle.com>");
 586 MODULE_DESCRIPTION("RDS: Reliable Datagram Sockets"
 587                    " v" DRV_VERSION " (" DRV_RELDATE ")");
 588 MODULE_VERSION(DRV_VERSION);
 589 MODULE_LICENSE("Dual BSD/GPL");
 590 MODULE_ALIAS_NETPROTO(PF_RDS);