net/tipc/socket.c

   1 /*
   2  * net/tipc/socket.c: TIPC socket API
   3  *
   4  * Copyright (c) 2001-2007, Ericsson AB
   5  * Copyright (c) 2004-2008, 2010-2011, Wind River Systems
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the names of the copyright holders nor the names of its
  17  *    contributors may be used to endorse or promote products derived from
  18  *    this software without specific prior written permission.
  19  *
  20  * Alternatively, this software may be distributed under the terms of the
  21  * GNU General Public License ("GPL") version 2 as published by the Free
  22  * Software Foundation.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  28  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  31  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  32  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  33  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  34  * POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #include <linux/export.h>
  38 #include <net/sock.h>
  39
  40 #include "core.h"
  41 #include "port.h"
  42
  43 #define SS_LISTENING    -1      /* socket is listening */
  44 #define SS_READY        -2      /* socket is connectionless */
  45
  46 #define OVERLOAD_LIMIT_BASE     5000
  47 #define CONN_TIMEOUT_DEFAULT    8000    /* default connect timeout = 8s */
  48
  49 struct tipc_sock {
  50         struct sock sk;
  51         struct tipc_port *p;
  52         struct tipc_portid peer_name;
  53         unsigned int conn_timeout;
  54 };
  55
  56 #define tipc_sk(sk) ((struct tipc_sock *)(sk))
  57 #define tipc_sk_port(sk) ((struct tipc_port *)(tipc_sk(sk)->p))
  58
  59 #define tipc_rx_ready(sock) (!skb_queue_empty(&sock->sk->sk_receive_queue) || \
  60                         (sock->state == SS_DISCONNECTING))
  61
  62 static int backlog_rcv(struct sock *sk, struct sk_buff *skb);
  63 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf);
  64 static void wakeupdispatch(struct tipc_port *tport);
  65
  66 static const struct proto_ops packet_ops;
  67 static const struct proto_ops stream_ops;
  68 static const struct proto_ops msg_ops;
  69
  70 static struct proto tipc_proto;
  71
  72 static int sockets_enabled;
  73
  74 static atomic_t tipc_queue_size = ATOMIC_INIT(0);
  75
  76 /*
  77  * Revised TIPC socket locking policy:
  78  *
  79  * Most socket operations take the standard socket lock when they start
  80  * and hold it until they finish (or until they need to sleep).  Acquiring
  81  * this lock grants the owner exclusive access to the fields of the socket
  82  * data structures, with the exception of the backlog queue.  A few socket
  83  * operations can be done without taking the socket lock because they only
  84  * read socket information that never changes during the life of the socket.
  85  *
  86  * Socket operations may acquire the lock for the associated TIPC port if they
  87  * need to perform an operation on the port.  If any routine needs to acquire
  88  * both the socket lock and the port lock it must take the socket lock first
  89  * to avoid the risk of deadlock.
  90  *
  91  * The dispatcher handling incoming messages cannot grab the socket lock in
  92  * the standard fashion, since invoked it runs at the BH level and cannot block.
  93  * Instead, it checks to see if the socket lock is currently owned by someone,
  94  * and either handles the message itself or adds it to the socket's backlog
  95  * queue; in the latter case the queued message is processed once the process
  96  * owning the socket lock releases it.
  97  *
  98  * NOTE: Releasing the socket lock while an operation is sleeping overcomes
  99  * the problem of a blocked socket operation preventing any other operations
 100  * from occurring.  However, applications must be careful if they have
 101  * multiple threads trying to send (or receive) on the same socket, as these
 102  * operations might interfere with each other.  For example, doing a connect
 103  * and a receive at the same time might allow the receive to consume the
 104  * ACK message meant for the connect.  While additional work could be done
 105  * to try and overcome this, it doesn't seem to be worthwhile at the present.
 106  *
 107  * NOTE: Releasing the socket lock while an operation is sleeping also ensures
 108  * that another operation that must be performed in a non-blocking manner is
 109  * not delayed for very long because the lock has already been taken.
 110  *
 111  * NOTE: This code assumes that certain fields of a port/socket pair are
 112  * constant over its lifetime; such fields can be examined without taking
 113  * the socket lock and/or port lock, and do not need to be re-read even
 114  * after resuming processing after waiting.  These fields include:
 115  *   - socket type
 116  *   - pointer to socket sk structure (aka tipc_sock structure)
 117  *   - pointer to port structure
 118  *   - port reference
 119  */
 120
 121 /**
 122  * advance_rx_queue - discard first buffer in socket receive queue
 123  *
 124  * Caller must hold socket lock
 125  */
 126
 127 static void advance_rx_queue(struct sock *sk)
 128 {
 129         buf_discard(__skb_dequeue(&sk->sk_receive_queue));
 130         atomic_dec(&tipc_queue_size);
 131 }
 132
 133 /**
 134  * discard_rx_queue - discard all buffers in socket receive queue
 135  *
 136  * Caller must hold socket lock
 137  */
 138
 139 static void discard_rx_queue(struct sock *sk)
 140 {
 141         struct sk_buff *buf;
 142
 143         while ((buf = __skb_dequeue(&sk->sk_receive_queue))) {
 144                 atomic_dec(&tipc_queue_size);
 145                 buf_discard(buf);
 146         }
 147 }
 148
 149 /**
 150  * reject_rx_queue - reject all buffers in socket receive queue
 151  *
 152  * Caller must hold socket lock
 153  */
 154
 155 static void reject_rx_queue(struct sock *sk)
 156 {
 157         struct sk_buff *buf;
 158
 159         while ((buf = __skb_dequeue(&sk->sk_receive_queue))) {
 160                 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
 161                 atomic_dec(&tipc_queue_size);
 162         }
 163 }
 164
 165 /**
 166  * tipc_create - create a TIPC socket
 167  * @net: network namespace (must be default network)
 168  * @sock: pre-allocated socket structure
 169  * @protocol: protocol indicator (must be 0)
 170  * @kern: caused by kernel or by userspace?
 171  *
 172  * This routine creates additional data structures used by the TIPC socket,
 173  * initializes them, and links them together.
 174  *
 175  * Returns 0 on success, errno otherwise
 176  */
 177
 178 static int tipc_create(struct net *net, struct socket *sock, int protocol,
 179                        int kern)
 180 {
 181         const struct proto_ops *ops;
 182         socket_state state;
 183         struct sock *sk;
 184         struct tipc_port *tp_ptr;
 185
 186         /* Validate arguments */
 187
 188         if (!net_eq(net, &init_net))
 189                 return -EAFNOSUPPORT;
 190
 191         if (unlikely(protocol != 0))
 192                 return -EPROTONOSUPPORT;
 193
 194         switch (sock->type) {
 195         case SOCK_STREAM:
 196                 ops = &stream_ops;
 197                 state = SS_UNCONNECTED;
 198                 break;
 199         case SOCK_SEQPACKET:
 200                 ops = &packet_ops;
 201                 state = SS_UNCONNECTED;
 202                 break;
 203         case SOCK_DGRAM:
 204         case SOCK_RDM:
 205                 ops = &msg_ops;
 206                 state = SS_READY;
 207                 break;
 208         default:
 209                 return -EPROTOTYPE;
 210         }
 211
 212         /* Allocate socket's protocol area */
 213
 214         sk = sk_alloc(net, AF_TIPC, GFP_KERNEL, &tipc_proto);
 215         if (sk == NULL)
 216                 return -ENOMEM;
 217
 218         /* Allocate TIPC port for socket to use */
 219
 220         tp_ptr = tipc_createport_raw(sk, &dispatch, &wakeupdispatch,
 221                                      TIPC_LOW_IMPORTANCE);
 222         if (unlikely(!tp_ptr)) {
 223                 sk_free(sk);
 224                 return -ENOMEM;
 225         }
 226
 227         /* Finish initializing socket data structures */
 228
 229         sock->ops = ops;
 230         sock->state = state;
 231
 232         sock_init_data(sock, sk);
 233         sk->sk_backlog_rcv = backlog_rcv;
 234         tipc_sk(sk)->p = tp_ptr;
 235         tipc_sk(sk)->conn_timeout = CONN_TIMEOUT_DEFAULT;
 236
 237         spin_unlock_bh(tp_ptr->lock);
 238
 239         if (sock->state == SS_READY) {
 240                 tipc_set_portunreturnable(tp_ptr->ref, 1);
 241                 if (sock->type == SOCK_DGRAM)
 242                         tipc_set_portunreliable(tp_ptr->ref, 1);
 243         }
 244
 245         return 0;
 246 }
 247
 248 /**
 249  * release - destroy a TIPC socket
 250  * @sock: socket to destroy
 251  *
 252  * This routine cleans up any messages that are still queued on the socket.
 253  * For DGRAM and RDM socket types, all queued messages are rejected.
 254  * For SEQPACKET and STREAM socket types, the first message is rejected
 255  * and any others are discarded.  (If the first message on a STREAM socket
 256  * is partially-read, it is discarded and the next one is rejected instead.)
 257  *
 258  * NOTE: Rejected messages are not necessarily returned to the sender!  They
 259  * are returned or discarded according to the "destination droppable" setting
 260  * specified for the message by the sender.
 261  *
 262  * Returns 0 on success, errno otherwise
 263  */
 264
 265 static int release(struct socket *sock)
 266 {
 267         struct sock *sk = sock->sk;
 268         struct tipc_port *tport;
 269         struct sk_buff *buf;
 270         int res;
 271
 272         /*
 273          * Exit if socket isn't fully initialized (occurs when a failed accept()
 274          * releases a pre-allocated child socket that was never used)
 275          */
 276
 277         if (sk == NULL)
 278                 return 0;
 279
 280         tport = tipc_sk_port(sk);
 281         lock_sock(sk);
 282
 283         /*
 284          * Reject all unreceived messages, except on an active connection
 285          * (which disconnects locally & sends a 'FIN+' to peer)
 286          */
 287
 288         while (sock->state != SS_DISCONNECTING) {
 289                 buf = __skb_dequeue(&sk->sk_receive_queue);
 290                 if (buf == NULL)
 291                         break;
 292                 atomic_dec(&tipc_queue_size);
 293                 if (TIPC_SKB_CB(buf)->handle != 0)
 294                         buf_discard(buf);
 295                 else {
 296                         if ((sock->state == SS_CONNECTING) ||
 297                             (sock->state == SS_CONNECTED)) {
 298                                 sock->state = SS_DISCONNECTING;
 299                                 tipc_disconnect(tport->ref);
 300                         }
 301                         tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
 302                 }
 303         }
 304
 305         /*
 306          * Delete TIPC port; this ensures no more messages are queued
 307          * (also disconnects an active connection & sends a 'FIN-' to peer)
 308          */
 309
 310         res = tipc_deleteport(tport->ref);
 311
 312         /* Discard any remaining (connection-based) messages in receive queue */
 313
 314         discard_rx_queue(sk);
 315
 316         /* Reject any messages that accumulated in backlog queue */
 317
 318         sock->state = SS_DISCONNECTING;
 319         release_sock(sk);
 320
 321         sock_put(sk);
 322         sock->sk = NULL;
 323
 324         return res;
 325 }
 326
 327 /**
 328  * bind - associate or disassocate TIPC name(s) with a socket
 329  * @sock: socket structure
 330  * @uaddr: socket address describing name(s) and desired operation
 331  * @uaddr_len: size of socket address data structure
 332  *
 333  * Name and name sequence binding is indicated using a positive scope value;
 334  * a negative scope value unbinds the specified name.  Specifying no name
 335  * (i.e. a socket address length of 0) unbinds all names from the socket.
 336  *
 337  * Returns 0 on success, errno otherwise
 338  *
 339  * NOTE: This routine doesn't need to take the socket lock since it doesn't
 340  *       access any non-constant socket information.
 341  */
 342
 343 static int bind(struct socket *sock, struct sockaddr *uaddr, int uaddr_len)
 344 {
 345         struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
 346         u32 portref = tipc_sk_port(sock->sk)->ref;
 347
 348         if (unlikely(!uaddr_len))
 349                 return tipc_withdraw(portref, 0, NULL);
 350
 351         if (uaddr_len < sizeof(struct sockaddr_tipc))
 352                 return -EINVAL;
 353         if (addr->family != AF_TIPC)
 354                 return -EAFNOSUPPORT;
 355
 356         if (addr->addrtype == TIPC_ADDR_NAME)
 357                 addr->addr.nameseq.upper = addr->addr.nameseq.lower;
 358         else if (addr->addrtype != TIPC_ADDR_NAMESEQ)
 359                 return -EAFNOSUPPORT;
 360
 361         return (addr->scope > 0) ?
 362                 tipc_publish(portref, addr->scope, &addr->addr.nameseq) :
 363                 tipc_withdraw(portref, -addr->scope, &addr->addr.nameseq);
 364 }
 365
 366 /**
 367  * get_name - get port ID of socket or peer socket
 368  * @sock: socket structure
 369  * @uaddr: area for returned socket address
 370  * @uaddr_len: area for returned length of socket address
 371  * @peer: 0 = own ID, 1 = current peer ID, 2 = current/former peer ID
 372  *
 373  * Returns 0 on success, errno otherwise
 374  *
 375  * NOTE: This routine doesn't need to take the socket lock since it only
 376  *       accesses socket information that is unchanging (or which changes in
 377  *       a completely predictable manner).
 378  */
 379
 380 static int get_name(struct socket *sock, struct sockaddr *uaddr,
 381                     int *uaddr_len, int peer)
 382 {
 383         struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
 384         struct tipc_sock *tsock = tipc_sk(sock->sk);
 385
 386         memset(addr, 0, sizeof(*addr));
 387         if (peer) {
 388                 if ((sock->state != SS_CONNECTED) &&
 389                         ((peer != 2) || (sock->state != SS_DISCONNECTING)))
 390                         return -ENOTCONN;
 391                 addr->addr.id.ref = tsock->peer_name.ref;
 392                 addr->addr.id.node = tsock->peer_name.node;
 393         } else {
 394                 addr->addr.id.ref = tsock->p->ref;
 395                 addr->addr.id.node = tipc_own_addr;
 396         }
 397
 398         *uaddr_len = sizeof(*addr);
 399         addr->addrtype = TIPC_ADDR_ID;
 400         addr->family = AF_TIPC;
 401         addr->scope = 0;
 402         addr->addr.name.domain = 0;
 403
 404         return 0;
 405 }
 406
 407 /**
 408  * poll - read and possibly block on pollmask
 409  * @file: file structure associated with the socket
 410  * @sock: socket for which to calculate the poll bits
 411  * @wait: ???
 412  *
 413  * Returns pollmask value
 414  *
 415  * COMMENTARY:
 416  * It appears that the usual socket locking mechanisms are not useful here
 417  * since the pollmask info is potentially out-of-date the moment this routine
 418  * exits.  TCP and other protocols seem to rely on higher level poll routines
 419  * to handle any preventable race conditions, so TIPC will do the same ...
 420  *
 421  * TIPC sets the returned events as follows:
 422  *
 423  * socket state         flags set
 424  * ------------         ---------
 425  * unconnected          no read flags
 426  *                      no write flags
 427  *
 428  * connecting           POLLIN/POLLRDNORM if ACK/NACK in rx queue
 429  *                      no write flags
 430  *
 431  * connected            POLLIN/POLLRDNORM if data in rx queue
 432  *                      POLLOUT if port is not congested
 433  *
 434  * disconnecting        POLLIN/POLLRDNORM/POLLHUP
 435  *                      no write flags
 436  *
 437  * listening            POLLIN if SYN in rx queue
 438  *                      no write flags
 439  *
 440  * ready                POLLIN/POLLRDNORM if data in rx queue
 441  * [connectionless]     POLLOUT (since port cannot be congested)
 442  *
 443  * IMPORTANT: The fact that a read or write operation is indicated does NOT
 444  * imply that the operation will succeed, merely that it should be performed
 445  * and will not block.
 446  */
 447
 448 static unsigned int poll(struct file *file, struct socket *sock,
 449                          poll_table *wait)
 450 {
 451         struct sock *sk = sock->sk;
 452         u32 mask = 0;
 453
 454         poll_wait(file, sk_sleep(sk), wait);
 455
 456         switch ((int)sock->state) {
 457         case SS_READY:
 458         case SS_CONNECTED:
 459                 if (!tipc_sk_port(sk)->congested)
 460                         mask |= POLLOUT;
 461                 /* fall thru' */
 462         case SS_CONNECTING:
 463         case SS_LISTENING:
 464                 if (!skb_queue_empty(&sk->sk_receive_queue))
 465                         mask |= (POLLIN | POLLRDNORM);
 466                 break;
 467         case SS_DISCONNECTING:
 468                 mask = (POLLIN | POLLRDNORM | POLLHUP);
 469                 break;
 470         }
 471
 472         return mask;
 473 }
 474
 475 /**
 476  * dest_name_check - verify user is permitted to send to specified port name
 477  * @dest: destination address
 478  * @m: descriptor for message to be sent
 479  *
 480  * Prevents restricted configuration commands from being issued by
 481  * unauthorized users.
 482  *
 483  * Returns 0 if permission is granted, otherwise errno
 484  */
 485
 486 static int dest_name_check(struct sockaddr_tipc *dest, struct msghdr *m)
 487 {
 488         struct tipc_cfg_msg_hdr hdr;
 489
 490         if (likely(dest->addr.name.name.type >= TIPC_RESERVED_TYPES))
 491                 return 0;
 492         if (likely(dest->addr.name.name.type == TIPC_TOP_SRV))
 493                 return 0;
 494         if (likely(dest->addr.name.name.type != TIPC_CFG_SRV))
 495                 return -EACCES;
 496
 497         if (!m->msg_iovlen || (m->msg_iov[0].iov_len < sizeof(hdr)))
 498                 return -EMSGSIZE;
 499         if (copy_from_user(&hdr, m->msg_iov[0].iov_base, sizeof(hdr)))
 500                 return -EFAULT;
 501         if ((ntohs(hdr.tcm_type) & 0xC000) && (!capable(CAP_NET_ADMIN)))
 502                 return -EACCES;
 503
 504         return 0;
 505 }
 506
 507 /**
 508  * send_msg - send message in connectionless manner
 509  * @iocb: if NULL, indicates that socket lock is already held
 510  * @sock: socket structure
 511  * @m: message to send
 512  * @total_len: length of message
 513  *
 514  * Message must have an destination specified explicitly.
 515  * Used for SOCK_RDM and SOCK_DGRAM messages,
 516  * and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
 517  * (Note: 'SYN+' is prohibited on SOCK_STREAM.)
 518  *
 519  * Returns the number of bytes sent on success, or errno otherwise
 520  */
 521
 522 static int send_msg(struct kiocb *iocb, struct socket *sock,
 523                     struct msghdr *m, size_t total_len)
 524 {
 525         struct sock *sk = sock->sk;
 526         struct tipc_port *tport = tipc_sk_port(sk);
 527         struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
 528         int needs_conn;
 529         long timeout_val;
 530         int res = -EINVAL;
 531
 532         if (unlikely(!dest))
 533                 return -EDESTADDRREQ;
 534         if (unlikely((m->msg_namelen < sizeof(*dest)) ||
 535                      (dest->family != AF_TIPC)))
 536                 return -EINVAL;
 537         if ((total_len > TIPC_MAX_USER_MSG_SIZE) ||
 538             (m->msg_iovlen > (unsigned)INT_MAX))
 539                 return -EMSGSIZE;
 540
 541         if (iocb)
 542                 lock_sock(sk);
 543
 544         needs_conn = (sock->state != SS_READY);
 545         if (unlikely(needs_conn)) {
 546                 if (sock->state == SS_LISTENING) {
 547                         res = -EPIPE;
 548                         goto exit;
 549                 }
 550                 if (sock->state != SS_UNCONNECTED) {
 551                         res = -EISCONN;
 552                         goto exit;
 553                 }
 554                 if ((tport->published) ||
 555                     ((sock->type == SOCK_STREAM) && (total_len != 0))) {
 556                         res = -EOPNOTSUPP;
 557                         goto exit;
 558                 }
 559                 if (dest->addrtype == TIPC_ADDR_NAME) {
 560                         tport->conn_type = dest->addr.name.name.type;
 561                         tport->conn_instance = dest->addr.name.name.instance;
 562                 }
 563
 564                 /* Abort any pending connection attempts (very unlikely) */
 565
 566                 reject_rx_queue(sk);
 567         }
 568
 569         timeout_val = sock_sndtimeo(sk, m->msg_flags & MSG_DONTWAIT);
 570
 571         do {
 572                 if (dest->addrtype == TIPC_ADDR_NAME) {
 573                         res = dest_name_check(dest, m);
 574                         if (res)
 575                                 break;
 576                         res = tipc_send2name(tport->ref,
 577                                              &dest->addr.name.name,
 578                                              dest->addr.name.domain,
 579                                              m->msg_iovlen,
 580                                              m->msg_iov,
 581                                              total_len);
 582                 } else if (dest->addrtype == TIPC_ADDR_ID) {
 583                         res = tipc_send2port(tport->ref,
 584                                              &dest->addr.id,
 585                                              m->msg_iovlen,
 586                                              m->msg_iov,
 587                                              total_len);
 588                 } else if (dest->addrtype == TIPC_ADDR_MCAST) {
 589                         if (needs_conn) {
 590                                 res = -EOPNOTSUPP;
 591                                 break;
 592                         }
 593                         res = dest_name_check(dest, m);
 594                         if (res)
 595                                 break;
 596                         res = tipc_multicast(tport->ref,
 597                                              &dest->addr.nameseq,
 598                                              m->msg_iovlen,
 599                                              m->msg_iov,
 600                                              total_len);
 601                 }
 602                 if (likely(res != -ELINKCONG)) {
 603                         if (needs_conn && (res >= 0))
 604                                 sock->state = SS_CONNECTING;
 605                         break;
 606                 }
 607                 if (timeout_val <= 0L) {
 608                         res = timeout_val ? timeout_val : -EWOULDBLOCK;
 609                         break;
 610                 }
 611                 release_sock(sk);
 612                 timeout_val = wait_event_interruptible_timeout(*sk_sleep(sk),
 613                                                !tport->congested, timeout_val);
 614                 lock_sock(sk);
 615         } while (1);
 616
 617 exit:
 618         if (iocb)
 619                 release_sock(sk);
 620         return res;
 621 }
 622
 623 /**
 624  * send_packet - send a connection-oriented message
 625  * @iocb: if NULL, indicates that socket lock is already held
 626  * @sock: socket structure
 627  * @m: message to send
 628  * @total_len: length of message
 629  *
 630  * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
 631  *
 632  * Returns the number of bytes sent on success, or errno otherwise
 633  */
 634
 635 static int send_packet(struct kiocb *iocb, struct socket *sock,
 636                        struct msghdr *m, size_t total_len)
 637 {
 638         struct sock *sk = sock->sk;
 639         struct tipc_port *tport = tipc_sk_port(sk);
 640         struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
 641         long timeout_val;
 642         int res;
 643
 644         /* Handle implied connection establishment */
 645
 646         if (unlikely(dest))
 647                 return send_msg(iocb, sock, m, total_len);
 648
 649         if ((total_len > TIPC_MAX_USER_MSG_SIZE) ||
 650             (m->msg_iovlen > (unsigned)INT_MAX))
 651                 return -EMSGSIZE;
 652
 653         if (iocb)
 654                 lock_sock(sk);
 655
 656         timeout_val = sock_sndtimeo(sk, m->msg_flags & MSG_DONTWAIT);
 657
 658         do {
 659                 if (unlikely(sock->state != SS_CONNECTED)) {
 660                         if (sock->state == SS_DISCONNECTING)
 661                                 res = -EPIPE;
 662                         else
 663                                 res = -ENOTCONN;
 664                         break;
 665                 }
 666
 667                 res = tipc_send(tport->ref, m->msg_iovlen, m->msg_iov,
 668                                 total_len);
 669                 if (likely(res != -ELINKCONG))
 670                         break;
 671                 if (timeout_val <= 0L) {
 672                         res = timeout_val ? timeout_val : -EWOULDBLOCK;
 673                         break;
 674                 }
 675                 release_sock(sk);
 676                 timeout_val = wait_event_interruptible_timeout(*sk_sleep(sk),
 677                         (!tport->congested || !tport->connected), timeout_val);
 678                 lock_sock(sk);
 679         } while (1);
 680
 681         if (iocb)
 682                 release_sock(sk);
 683         return res;
 684 }
 685
 686 /**
 687  * send_stream - send stream-oriented data
 688  * @iocb: (unused)
 689  * @sock: socket structure
 690  * @m: data to send
 691  * @total_len: total length of data to be sent
 692  *
 693  * Used for SOCK_STREAM data.
 694  *
 695  * Returns the number of bytes sent on success (or partial success),
 696  * or errno if no data sent
 697  */
 698
 699 static int send_stream(struct kiocb *iocb, struct socket *sock,
 700                        struct msghdr *m, size_t total_len)
 701 {
 702         struct sock *sk = sock->sk;
 703         struct tipc_port *tport = tipc_sk_port(sk);
 704         struct msghdr my_msg;
 705         struct iovec my_iov;
 706         struct iovec *curr_iov;
 707         int curr_iovlen;
 708         char __user *curr_start;
 709         u32 hdr_size;
 710         int curr_left;
 711         int bytes_to_send;
 712         int bytes_sent;
 713         int res;
 714
 715         lock_sock(sk);
 716
 717         /* Handle special cases where there is no connection */
 718
 719         if (unlikely(sock->state != SS_CONNECTED)) {
 720                 if (sock->state == SS_UNCONNECTED) {
 721                         res = send_packet(NULL, sock, m, total_len);
 722                         goto exit;
 723                 } else if (sock->state == SS_DISCONNECTING) {
 724                         res = -EPIPE;
 725                         goto exit;
 726                 } else {
 727                         res = -ENOTCONN;
 728                         goto exit;
 729                 }
 730         }
 731
 732         if (unlikely(m->msg_name)) {
 733                 res = -EISCONN;
 734                 goto exit;
 735         }
 736
 737         if ((total_len > (unsigned)INT_MAX) ||
 738             (m->msg_iovlen > (unsigned)INT_MAX)) {
 739                 res = -EMSGSIZE;
 740                 goto exit;
 741         }
 742
 743         /*
 744          * Send each iovec entry using one or more messages
 745          *
 746          * Note: This algorithm is good for the most likely case
 747          * (i.e. one large iovec entry), but could be improved to pass sets
 748          * of small iovec entries into send_packet().
 749          */
 750
 751         curr_iov = m->msg_iov;
 752         curr_iovlen = m->msg_iovlen;
 753         my_msg.msg_iov = &my_iov;
 754         my_msg.msg_iovlen = 1;
 755         my_msg.msg_flags = m->msg_flags;
 756         my_msg.msg_name = NULL;
 757         bytes_sent = 0;
 758
 759         hdr_size = msg_hdr_sz(&tport->phdr);
 760
 761         while (curr_iovlen--) {
 762                 curr_start = curr_iov->iov_base;
 763                 curr_left = curr_iov->iov_len;
 764
 765                 while (curr_left) {
 766                         bytes_to_send = tport->max_pkt - hdr_size;
 767                         if (bytes_to_send > TIPC_MAX_USER_MSG_SIZE)
 768                                 bytes_to_send = TIPC_MAX_USER_MSG_SIZE;
 769                         if (curr_left < bytes_to_send)
 770                                 bytes_to_send = curr_left;
 771                         my_iov.iov_base = curr_start;
 772                         my_iov.iov_len = bytes_to_send;
 773                         res = send_packet(NULL, sock, &my_msg, bytes_to_send);
 774                         if (res < 0) {
 775                                 if (bytes_sent)
 776                                         res = bytes_sent;
 777                                 goto exit;
 778                         }
 779                         curr_left -= bytes_to_send;
 780                         curr_start += bytes_to_send;
 781                         bytes_sent += bytes_to_send;
 782                 }
 783
 784                 curr_iov++;
 785         }
 786         res = bytes_sent;
 787 exit:
 788         release_sock(sk);
 789         return res;
 790 }
 791
 792 /**
 793  * auto_connect - complete connection setup to a remote port
 794  * @sock: socket structure
 795  * @msg: peer's response message
 796  *
 797  * Returns 0 on success, errno otherwise
 798  */
 799
 800 static int auto_connect(struct socket *sock, struct tipc_msg *msg)
 801 {
 802         struct tipc_sock *tsock = tipc_sk(sock->sk);
 803
 804         if (msg_errcode(msg)) {
 805                 sock->state = SS_DISCONNECTING;
 806                 return -ECONNREFUSED;
 807         }
 808
 809         tsock->peer_name.ref = msg_origport(msg);
 810         tsock->peer_name.node = msg_orignode(msg);
 811         tipc_connect2port(tsock->p->ref, &tsock->peer_name);
 812         tipc_set_portimportance(tsock->p->ref, msg_importance(msg));
 813         sock->state = SS_CONNECTED;
 814         return 0;
 815 }
 816
 817 /**
 818  * set_orig_addr - capture sender's address for received message
 819  * @m: descriptor for message info
 820  * @msg: received message header
 821  *
 822  * Note: Address is not captured if not requested by receiver.
 823  */
 824
 825 static void set_orig_addr(struct msghdr *m, struct tipc_msg *msg)
 826 {
 827         struct sockaddr_tipc *addr = (struct sockaddr_tipc *)m->msg_name;
 828
 829         if (addr) {
 830                 addr->family = AF_TIPC;
 831                 addr->addrtype = TIPC_ADDR_ID;
 832                 addr->addr.id.ref = msg_origport(msg);
 833                 addr->addr.id.node = msg_orignode(msg);
 834                 addr->addr.name.domain = 0;     /* could leave uninitialized */
 835                 addr->scope = 0;                /* could leave uninitialized */
 836                 m->msg_namelen = sizeof(struct sockaddr_tipc);
 837         }
 838 }
 839
 840 /**
 841  * anc_data_recv - optionally capture ancillary data for received message
 842  * @m: descriptor for message info
 843  * @msg: received message header
 844  * @tport: TIPC port associated with message
 845  *
 846  * Note: Ancillary data is not captured if not requested by receiver.
 847  *
 848  * Returns 0 if successful, otherwise errno
 849  */
 850
 851 static int anc_data_recv(struct msghdr *m, struct tipc_msg *msg,
 852                                 struct tipc_port *tport)
 853 {
 854         u32 anc_data[3];
 855         u32 err;
 856         u32 dest_type;
 857         int has_name;
 858         int res;
 859
 860         if (likely(m->msg_controllen == 0))
 861                 return 0;
 862
 863         /* Optionally capture errored message object(s) */
 864
 865         err = msg ? msg_errcode(msg) : 0;
 866         if (unlikely(err)) {
 867                 anc_data[0] = err;
 868                 anc_data[1] = msg_data_sz(msg);
 869                 res = put_cmsg(m, SOL_TIPC, TIPC_ERRINFO, 8, anc_data);
 870                 if (res)
 871                         return res;
 872                 if (anc_data[1]) {
 873                         res = put_cmsg(m, SOL_TIPC, TIPC_RETDATA, anc_data[1],
 874                                        msg_data(msg));
 875                         if (res)
 876                                 return res;
 877                 }
 878         }
 879
 880         /* Optionally capture message destination object */
 881
 882         dest_type = msg ? msg_type(msg) : TIPC_DIRECT_MSG;
 883         switch (dest_type) {
 884         case TIPC_NAMED_MSG:
 885                 has_name = 1;
 886                 anc_data[0] = msg_nametype(msg);
 887                 anc_data[1] = msg_namelower(msg);
 888                 anc_data[2] = msg_namelower(msg);
 889                 break;
 890         case TIPC_MCAST_MSG:
 891                 has_name = 1;
 892                 anc_data[0] = msg_nametype(msg);
 893                 anc_data[1] = msg_namelower(msg);
 894                 anc_data[2] = msg_nameupper(msg);
 895                 break;
 896         case TIPC_CONN_MSG:
 897                 has_name = (tport->conn_type != 0);
 898                 anc_data[0] = tport->conn_type;
 899                 anc_data[1] = tport->conn_instance;
 900                 anc_data[2] = tport->conn_instance;
 901                 break;
 902         default:
 903                 has_name = 0;
 904         }
 905         if (has_name) {
 906                 res = put_cmsg(m, SOL_TIPC, TIPC_DESTNAME, 12, anc_data);
 907                 if (res)
 908                         return res;
 909         }
 910
 911         return 0;
 912 }
 913
 914 /**
 915  * recv_msg - receive packet-oriented message
 916  * @iocb: (unused)
 917  * @m: descriptor for message info
 918  * @buf_len: total size of user buffer area
 919  * @flags: receive flags
 920  *
 921  * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
 922  * If the complete message doesn't fit in user area, truncate it.
 923  *
 924  * Returns size of returned message data, errno otherwise
 925  */
 926
 927 static int recv_msg(struct kiocb *iocb, struct socket *sock,
 928                     struct msghdr *m, size_t buf_len, int flags)
 929 {
 930         struct sock *sk = sock->sk;
 931         struct tipc_port *tport = tipc_sk_port(sk);
 932         struct sk_buff *buf;
 933         struct tipc_msg *msg;
 934         long timeout;
 935         unsigned int sz;
 936         u32 err;
 937         int res;
 938
 939         /* Catch invalid receive requests */
 940
 941         if (unlikely(!buf_len))
 942                 return -EINVAL;
 943
 944         lock_sock(sk);
 945
 946         if (unlikely(sock->state == SS_UNCONNECTED)) {
 947                 res = -ENOTCONN;
 948                 goto exit;
 949         }
 950
 951         timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
 952 restart:
 953
 954         /* Look for a message in receive queue; wait if necessary */
 955
 956         while (skb_queue_empty(&sk->sk_receive_queue)) {
 957                 if (sock->state == SS_DISCONNECTING) {
 958                         res = -ENOTCONN;
 959                         goto exit;
 960                 }
 961                 if (timeout <= 0L) {
 962                         res = timeout ? timeout : -EWOULDBLOCK;
 963                         goto exit;
 964                 }
 965                 release_sock(sk);
 966                 timeout = wait_event_interruptible_timeout(*sk_sleep(sk),
 967                                                            tipc_rx_ready(sock),
 968                                                            timeout);
 969                 lock_sock(sk);
 970         }
 971
 972         /* Look at first message in receive queue */
 973
 974         buf = skb_peek(&sk->sk_receive_queue);
 975         msg = buf_msg(buf);
 976         sz = msg_data_sz(msg);
 977         err = msg_errcode(msg);
 978
 979         /* Complete connection setup for an implied connect */
 980
 981         if (unlikely(sock->state == SS_CONNECTING)) {
 982                 res = auto_connect(sock, msg);
 983                 if (res)
 984                         goto exit;
 985         }
 986
 987         /* Discard an empty non-errored message & try again */
 988
 989         if ((!sz) && (!err)) {
 990                 advance_rx_queue(sk);
 991                 goto restart;
 992         }
 993
 994         /* Capture sender's address (optional) */
 995
 996         set_orig_addr(m, msg);
 997
 998         /* Capture ancillary data (optional) */
 999
1000         res = anc_data_recv(m, msg, tport);
1001         if (res)
1002                 goto exit;
1003
1004         /* Capture message data (if valid) & compute return value (always) */
1005
1006         if (!err) {
1007                 if (unlikely(buf_len < sz)) {
1008                         sz = buf_len;
1009                         m->msg_flags |= MSG_TRUNC;
1010                 }
1011                 res = skb_copy_datagram_iovec(buf, msg_hdr_sz(msg),
1012                                               m->msg_iov, sz);
1013                 if (res)
1014                         goto exit;
1015                 res = sz;
1016         } else {
1017                 if ((sock->state == SS_READY) ||
1018                     ((err == TIPC_CONN_SHUTDOWN) || m->msg_control))
1019                         res = 0;
1020                 else
1021                         res = -ECONNRESET;
1022         }
1023
1024         /* Consume received message (optional) */
1025
1026         if (likely(!(flags & MSG_PEEK))) {
1027                 if ((sock->state != SS_READY) &&
1028                     (++tport->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1029                         tipc_acknowledge(tport->ref, tport->conn_unacked);
1030                 advance_rx_queue(sk);
1031         }
1032 exit:
1033         release_sock(sk);
1034         return res;
1035 }
1036
1037 /**
1038  * recv_stream - receive stream-oriented data
1039  * @iocb: (unused)
1040  * @m: descriptor for message info
1041  * @buf_len: total size of user buffer area
1042  * @flags: receive flags
1043  *
1044  * Used for SOCK_STREAM messages only.  If not enough data is available
1045  * will optionally wait for more; never truncates data.
1046  *
1047  * Returns size of returned message data, errno otherwise
1048  */
1049
1050 static int recv_stream(struct kiocb *iocb, struct socket *sock,
1051                        struct msghdr *m, size_t buf_len, int flags)
1052 {
1053         struct sock *sk = sock->sk;
1054         struct tipc_port *tport = tipc_sk_port(sk);
1055         struct sk_buff *buf;
1056         struct tipc_msg *msg;
1057         long timeout;
1058         unsigned int sz;
1059         int sz_to_copy, target, needed;
1060         int sz_copied = 0;
1061         u32 err;
1062         int res = 0;
1063
1064         /* Catch invalid receive attempts */
1065
1066         if (unlikely(!buf_len))
1067                 return -EINVAL;
1068
1069         lock_sock(sk);
1070
1071         if (unlikely((sock->state == SS_UNCONNECTED) ||
1072                      (sock->state == SS_CONNECTING))) {
1073                 res = -ENOTCONN;
1074                 goto exit;
1075         }
1076
1077         target = sock_rcvlowat(sk, flags & MSG_WAITALL, buf_len);
1078         timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
1079 restart:
1080
1081         /* Look for a message in receive queue; wait if necessary */
1082
1083         while (skb_queue_empty(&sk->sk_receive_queue)) {
1084                 if (sock->state == SS_DISCONNECTING) {
1085                         res = -ENOTCONN;
1086                         goto exit;
1087                 }
1088                 if (timeout <= 0L) {
1089                         res = timeout ? timeout : -EWOULDBLOCK;
1090                         goto exit;
1091                 }
1092                 release_sock(sk);
1093                 timeout = wait_event_interruptible_timeout(*sk_sleep(sk),
1094                                                            tipc_rx_ready(sock),
1095                                                            timeout);
1096                 lock_sock(sk);
1097         }
1098
1099         /* Look at first message in receive queue */
1100
1101         buf = skb_peek(&sk->sk_receive_queue);
1102         msg = buf_msg(buf);
1103         sz = msg_data_sz(msg);
1104         err = msg_errcode(msg);
1105
1106         /* Discard an empty non-errored message & try again */
1107
1108         if ((!sz) && (!err)) {
1109                 advance_rx_queue(sk);
1110                 goto restart;
1111         }
1112
1113         /* Optionally capture sender's address & ancillary data of first msg */
1114
1115         if (sz_copied == 0) {
1116                 set_orig_addr(m, msg);
1117                 res = anc_data_recv(m, msg, tport);
1118                 if (res)
1119                         goto exit;
1120         }
1121
1122         /* Capture message data (if valid) & compute return value (always) */
1123
1124         if (!err) {
1125                 u32 offset = (u32)(unsigned long)(TIPC_SKB_CB(buf)->handle);
1126
1127                 sz -= offset;
1128                 needed = (buf_len - sz_copied);
1129                 sz_to_copy = (sz <= needed) ? sz : needed;
1130
1131                 res = skb_copy_datagram_iovec(buf, msg_hdr_sz(msg) + offset,
1132                                               m->msg_iov, sz_to_copy);
1133                 if (res)
1134                         goto exit;
1135
1136                 sz_copied += sz_to_copy;
1137
1138                 if (sz_to_copy < sz) {
1139                         if (!(flags & MSG_PEEK))
1140                                 TIPC_SKB_CB(buf)->handle =
1141                                 (void *)(unsigned long)(offset + sz_to_copy);
1142                         goto exit;
1143                 }
1144         } else {
1145                 if (sz_copied != 0)
1146                         goto exit; /* can't add error msg to valid data */
1147
1148                 if ((err == TIPC_CONN_SHUTDOWN) || m->msg_control)
1149                         res = 0;
1150                 else
1151                         res = -ECONNRESET;
1152         }
1153
1154         /* Consume received message (optional) */
1155
1156         if (likely(!(flags & MSG_PEEK))) {
1157                 if (unlikely(++tport->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1158                         tipc_acknowledge(tport->ref, tport->conn_unacked);
1159                 advance_rx_queue(sk);
1160         }
1161
1162         /* Loop around if more data is required */
1163
1164         if ((sz_copied < buf_len) &&    /* didn't get all requested data */
1165             (!skb_queue_empty(&sk->sk_receive_queue) ||
1166             (sz_copied < target)) &&    /* and more is ready or required */
1167             (!(flags & MSG_PEEK)) &&    /* and aren't just peeking at data */
1168             (!err))                     /* and haven't reached a FIN */
1169                 goto restart;
1170
1171 exit:
1172         release_sock(sk);
1173         return sz_copied ? sz_copied : res;
1174 }
1175
1176 /**
1177  * rx_queue_full - determine if receive queue can accept another message
1178  * @msg: message to be added to queue
1179  * @queue_size: current size of queue
1180  * @base: nominal maximum size of queue
1181  *
1182  * Returns 1 if queue is unable to accept message, 0 otherwise
1183  */
1184
1185 static int rx_queue_full(struct tipc_msg *msg, u32 queue_size, u32 base)
1186 {
1187         u32 threshold;
1188         u32 imp = msg_importance(msg);
1189
1190         if (imp == TIPC_LOW_IMPORTANCE)
1191                 threshold = base;
1192         else if (imp == TIPC_MEDIUM_IMPORTANCE)
1193                 threshold = base * 2;
1194         else if (imp == TIPC_HIGH_IMPORTANCE)
1195                 threshold = base * 100;
1196         else
1197                 return 0;
1198
1199         if (msg_connected(msg))
1200                 threshold *= 4;
1201
1202         return queue_size >= threshold;
1203 }
1204
1205 /**
1206  * filter_rcv - validate incoming message
1207  * @sk: socket
1208  * @buf: message
1209  *
1210  * Enqueues message on receive queue if acceptable; optionally handles
1211  * disconnect indication for a connected socket.
1212  *
1213  * Called with socket lock already taken; port lock may also be taken.
1214  *
1215  * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1216  */
1217
1218 static u32 filter_rcv(struct sock *sk, struct sk_buff *buf)
1219 {
1220         struct socket *sock = sk->sk_socket;
1221         struct tipc_msg *msg = buf_msg(buf);
1222         u32 recv_q_len;
1223
1224         /* Reject message if it is wrong sort of message for socket */
1225
1226         /*
1227          * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1228          * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1229          * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1230          */
1231
1232         if (sock->state == SS_READY) {
1233                 if (msg_connected(msg))
1234                         return TIPC_ERR_NO_PORT;
1235         } else {
1236                 if (msg_mcast(msg))
1237                         return TIPC_ERR_NO_PORT;
1238                 if (sock->state == SS_CONNECTED) {
1239                         if (!msg_connected(msg))
1240                                 return TIPC_ERR_NO_PORT;
1241                 } else if (sock->state == SS_CONNECTING) {
1242                         if (!msg_connected(msg) && (msg_errcode(msg) == 0))
1243                                 return TIPC_ERR_NO_PORT;
1244                 } else if (sock->state == SS_LISTENING) {
1245                         if (msg_connected(msg) || msg_errcode(msg))
1246                                 return TIPC_ERR_NO_PORT;
1247                 } else if (sock->state == SS_DISCONNECTING) {
1248                         return TIPC_ERR_NO_PORT;
1249                 } else /* (sock->state == SS_UNCONNECTED) */ {
1250                         if (msg_connected(msg) || msg_errcode(msg))
1251                                 return TIPC_ERR_NO_PORT;
1252                 }
1253         }
1254
1255         /* Reject message if there isn't room to queue it */
1256
1257         recv_q_len = (u32)atomic_read(&tipc_queue_size);
1258         if (unlikely(recv_q_len >= OVERLOAD_LIMIT_BASE)) {
1259                 if (rx_queue_full(msg, recv_q_len, OVERLOAD_LIMIT_BASE))
1260                         return TIPC_ERR_OVERLOAD;
1261         }
1262         recv_q_len = skb_queue_len(&sk->sk_receive_queue);
1263         if (unlikely(recv_q_len >= (OVERLOAD_LIMIT_BASE / 2))) {
1264                 if (rx_queue_full(msg, recv_q_len, OVERLOAD_LIMIT_BASE / 2))
1265                         return TIPC_ERR_OVERLOAD;
1266         }
1267
1268         /* Enqueue message (finally!) */
1269
1270         TIPC_SKB_CB(buf)->handle = 0;
1271         atomic_inc(&tipc_queue_size);
1272         __skb_queue_tail(&sk->sk_receive_queue, buf);
1273
1274         /* Initiate connection termination for an incoming 'FIN' */
1275
1276         if (unlikely(msg_errcode(msg) && (sock->state == SS_CONNECTED))) {
1277                 sock->state = SS_DISCONNECTING;
1278                 tipc_disconnect_port(tipc_sk_port(sk));
1279         }
1280
1281         if (waitqueue_active(sk_sleep(sk)))
1282                 wake_up_interruptible(sk_sleep(sk));
1283         return TIPC_OK;
1284 }
1285
1286 /**
1287  * backlog_rcv - handle incoming message from backlog queue
1288  * @sk: socket
1289  * @buf: message
1290  *
1291  * Caller must hold socket lock, but not port lock.
1292  *
1293  * Returns 0
1294  */
1295
1296 static int backlog_rcv(struct sock *sk, struct sk_buff *buf)
1297 {
1298         u32 res;
1299
1300         res = filter_rcv(sk, buf);
1301         if (res)
1302                 tipc_reject_msg(buf, res);
1303         return 0;
1304 }
1305
1306 /**
1307  * dispatch - handle incoming message
1308  * @tport: TIPC port that received message
1309  * @buf: message
1310  *
1311  * Called with port lock already taken.
1312  *
1313  * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1314  */
1315
1316 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf)
1317 {
1318         struct sock *sk = (struct sock *)tport->usr_handle;
1319         u32 res;
1320
1321         /*
1322          * Process message if socket is unlocked; otherwise add to backlog queue
1323          *
1324          * This code is based on sk_receive_skb(), but must be distinct from it
1325          * since a TIPC-specific filter/reject mechanism is utilized
1326          */
1327
1328         bh_lock_sock(sk);
1329         if (!sock_owned_by_user(sk)) {
1330                 res = filter_rcv(sk, buf);
1331         } else {
1332                 if (sk_add_backlog(sk, buf))
1333                         res = TIPC_ERR_OVERLOAD;
1334                 else
1335                         res = TIPC_OK;
1336         }
1337         bh_unlock_sock(sk);
1338
1339         return res;
1340 }
1341
1342 /**
1343  * wakeupdispatch - wake up port after congestion
1344  * @tport: port to wakeup
1345  *
1346  * Called with port lock already taken.
1347  */
1348
1349 static void wakeupdispatch(struct tipc_port *tport)
1350 {
1351         struct sock *sk = (struct sock *)tport->usr_handle;
1352
1353         if (waitqueue_active(sk_sleep(sk)))
1354                 wake_up_interruptible(sk_sleep(sk));
1355 }
1356
1357 /**
1358  * connect - establish a connection to another TIPC port
1359  * @sock: socket structure
1360  * @dest: socket address for destination port
1361  * @destlen: size of socket address data structure
1362  * @flags: file-related flags associated with socket
1363  *
1364  * Returns 0 on success, errno otherwise
1365  */
1366
1367 static int connect(struct socket *sock, struct sockaddr *dest, int destlen,
1368                    int flags)
1369 {
1370         struct sock *sk = sock->sk;
1371         struct sockaddr_tipc *dst = (struct sockaddr_tipc *)dest;
1372         struct msghdr m = {NULL,};
1373         struct sk_buff *buf;
1374         struct tipc_msg *msg;
1375         unsigned int timeout;
1376         int res;
1377
1378         lock_sock(sk);
1379
1380         /* For now, TIPC does not allow use of connect() with DGRAM/RDM types */
1381
1382         if (sock->state == SS_READY) {
1383                 res = -EOPNOTSUPP;
1384                 goto exit;
1385         }
1386
1387         /* For now, TIPC does not support the non-blocking form of connect() */
1388
1389         if (flags & O_NONBLOCK) {
1390                 res = -EOPNOTSUPP;
1391                 goto exit;
1392         }
1393
1394         /* Issue Posix-compliant error code if socket is in the wrong state */
1395
1396         if (sock->state == SS_LISTENING) {
1397                 res = -EOPNOTSUPP;
1398                 goto exit;
1399         }
1400         if (sock->state == SS_CONNECTING) {
1401                 res = -EALREADY;
1402                 goto exit;
1403         }
1404         if (sock->state != SS_UNCONNECTED) {
1405                 res = -EISCONN;
1406                 goto exit;
1407         }
1408
1409         /*
1410          * Reject connection attempt using multicast address
1411          *
1412          * Note: send_msg() validates the rest of the address fields,
1413          *       so there's no need to do it here
1414          */
1415
1416         if (dst->addrtype == TIPC_ADDR_MCAST) {
1417                 res = -EINVAL;
1418                 goto exit;
1419         }
1420
1421         /* Reject any messages already in receive queue (very unlikely) */
1422
1423         reject_rx_queue(sk);
1424
1425         /* Send a 'SYN-' to destination */
1426
1427         m.msg_name = dest;
1428         m.msg_namelen = destlen;
1429         res = send_msg(NULL, sock, &m, 0);
1430         if (res < 0)
1431                 goto exit;
1432
1433         /* Wait until an 'ACK' or 'RST' arrives, or a timeout occurs */
1434
1435         timeout = tipc_sk(sk)->conn_timeout;
1436         release_sock(sk);
1437         res = wait_event_interruptible_timeout(*sk_sleep(sk),
1438                         (!skb_queue_empty(&sk->sk_receive_queue) ||
1439                         (sock->state != SS_CONNECTING)),
1440                         timeout ? (long)msecs_to_jiffies(timeout)
1441                                 : MAX_SCHEDULE_TIMEOUT);
1442         lock_sock(sk);
1443
1444         if (res > 0) {
1445                 buf = skb_peek(&sk->sk_receive_queue);
1446                 if (buf != NULL) {
1447                         msg = buf_msg(buf);
1448                         res = auto_connect(sock, msg);
1449                         if (!res) {
1450                                 if (!msg_data_sz(msg))
1451                                         advance_rx_queue(sk);
1452                         }
1453                 } else {
1454                         if (sock->state == SS_CONNECTED)
1455                                 res = -EISCONN;
1456                         else
1457                                 res = -ECONNREFUSED;
1458                 }
1459         } else {
1460                 if (res == 0)
1461                         res = -ETIMEDOUT;
1462                 else
1463                         ; /* leave "res" unchanged */
1464                 sock->state = SS_DISCONNECTING;
1465         }
1466
1467 exit:
1468         release_sock(sk);
1469         return res;
1470 }
1471
1472 /**
1473  * listen - allow socket to listen for incoming connections
1474  * @sock: socket structure
1475  * @len: (unused)
1476  *
1477  * Returns 0 on success, errno otherwise
1478  */
1479
1480 static int listen(struct socket *sock, int len)
1481 {
1482         struct sock *sk = sock->sk;
1483         int res;
1484
1485         lock_sock(sk);
1486
1487         if (sock->state != SS_UNCONNECTED)
1488                 res = -EINVAL;
1489         else {
1490                 sock->state = SS_LISTENING;
1491                 res = 0;
1492         }
1493
1494         release_sock(sk);
1495         return res;
1496 }
1497
1498 /**
1499  * accept - wait for connection request
1500  * @sock: listening socket
1501  * @newsock: new socket that is to be connected
1502  * @flags: file-related flags associated with socket
1503  *
1504  * Returns 0 on success, errno otherwise
1505  */
1506
1507 static int accept(struct socket *sock, struct socket *new_sock, int flags)
1508 {
1509         struct sock *sk = sock->sk;
1510         struct sk_buff *buf;
1511         int res;
1512
1513         lock_sock(sk);
1514
1515         if (sock->state != SS_LISTENING) {
1516                 res = -EINVAL;
1517                 goto exit;
1518         }
1519
1520         while (skb_queue_empty(&sk->sk_receive_queue)) {
1521                 if (flags & O_NONBLOCK) {
1522                         res = -EWOULDBLOCK;
1523                         goto exit;
1524                 }
1525                 release_sock(sk);
1526                 res = wait_event_interruptible(*sk_sleep(sk),
1527                                 (!skb_queue_empty(&sk->sk_receive_queue)));
1528                 lock_sock(sk);
1529                 if (res)
1530                         goto exit;
1531         }
1532
1533         buf = skb_peek(&sk->sk_receive_queue);
1534
1535         res = tipc_create(sock_net(sock->sk), new_sock, 0, 0);
1536         if (!res) {
1537                 struct sock *new_sk = new_sock->sk;
1538                 struct tipc_sock *new_tsock = tipc_sk(new_sk);
1539                 struct tipc_port *new_tport = new_tsock->p;
1540                 u32 new_ref = new_tport->ref;
1541                 struct tipc_msg *msg = buf_msg(buf);
1542
1543                 lock_sock(new_sk);
1544
1545                 /*
1546                  * Reject any stray messages received by new socket
1547                  * before the socket lock was taken (very, very unlikely)
1548                  */
1549
1550                 reject_rx_queue(new_sk);
1551
1552                 /* Connect new socket to it's peer */
1553
1554                 new_tsock->peer_name.ref = msg_origport(msg);
1555                 new_tsock->peer_name.node = msg_orignode(msg);
1556                 tipc_connect2port(new_ref, &new_tsock->peer_name);
1557                 new_sock->state = SS_CONNECTED;
1558
1559                 tipc_set_portimportance(new_ref, msg_importance(msg));
1560                 if (msg_named(msg)) {
1561                         new_tport->conn_type = msg_nametype(msg);
1562                         new_tport->conn_instance = msg_nameinst(msg);
1563                 }
1564
1565                 /*
1566                  * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1567                  * Respond to 'SYN+' by queuing it on new socket.
1568                  */
1569
1570                 if (!msg_data_sz(msg)) {
1571                         struct msghdr m = {NULL,};
1572
1573                         advance_rx_queue(sk);
1574                         send_packet(NULL, new_sock, &m, 0);
1575                 } else {
1576                         __skb_dequeue(&sk->sk_receive_queue);
1577                         __skb_queue_head(&new_sk->sk_receive_queue, buf);
1578                 }
1579                 release_sock(new_sk);
1580         }
1581 exit:
1582         release_sock(sk);
1583         return res;
1584 }
1585
1586 /**
1587  * shutdown - shutdown socket connection
1588  * @sock: socket structure
1589  * @how: direction to close (must be SHUT_RDWR)
1590  *
1591  * Terminates connection (if necessary), then purges socket's receive queue.
1592  *
1593  * Returns 0 on success, errno otherwise
1594  */
1595
1596 static int shutdown(struct socket *sock, int how)
1597 {
1598         struct sock *sk = sock->sk;
1599         struct tipc_port *tport = tipc_sk_port(sk);
1600         struct sk_buff *buf;
1601         int res;
1602
1603         if (how != SHUT_RDWR)
1604                 return -EINVAL;
1605
1606         lock_sock(sk);
1607
1608         switch (sock->state) {
1609         case SS_CONNECTING:
1610         case SS_CONNECTED:
1611
1612                 /* Disconnect and send a 'FIN+' or 'FIN-' message to peer */
1613 restart:
1614                 buf = __skb_dequeue(&sk->sk_receive_queue);
1615                 if (buf) {
1616                         atomic_dec(&tipc_queue_size);
1617                         if (TIPC_SKB_CB(buf)->handle != 0) {
1618                                 buf_discard(buf);
1619                                 goto restart;
1620                         }
1621                         tipc_disconnect(tport->ref);
1622                         tipc_reject_msg(buf, TIPC_CONN_SHUTDOWN);
1623                 } else {
1624                         tipc_shutdown(tport->ref);
1625                 }
1626
1627                 sock->state = SS_DISCONNECTING;
1628
1629                 /* fall through */
1630
1631         case SS_DISCONNECTING:
1632
1633                 /* Discard any unreceived messages; wake up sleeping tasks */
1634
1635                 discard_rx_queue(sk);
1636                 if (waitqueue_active(sk_sleep(sk)))
1637                         wake_up_interruptible(sk_sleep(sk));
1638                 res = 0;
1639                 break;
1640
1641         default:
1642                 res = -ENOTCONN;
1643         }
1644
1645         release_sock(sk);
1646         return res;
1647 }
1648
1649 /**
1650  * setsockopt - set socket option
1651  * @sock: socket structure
1652  * @lvl: option level
1653  * @opt: option identifier
1654  * @ov: pointer to new option value
1655  * @ol: length of option value
1656  *
1657  * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1658  * (to ease compatibility).
1659  *
1660  * Returns 0 on success, errno otherwise
1661  */
1662
1663 static int setsockopt(struct socket *sock,
1664                       int lvl, int opt, char __user *ov, unsigned int ol)
1665 {
1666         struct sock *sk = sock->sk;
1667         struct tipc_port *tport = tipc_sk_port(sk);
1668         u32 value;
1669         int res;
1670
1671         if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1672                 return 0;
1673         if (lvl != SOL_TIPC)
1674                 return -ENOPROTOOPT;
1675         if (ol < sizeof(value))
1676                 return -EINVAL;
1677         res = get_user(value, (u32 __user *)ov);
1678         if (res)
1679                 return res;
1680
1681         lock_sock(sk);
1682
1683         switch (opt) {
1684         case TIPC_IMPORTANCE:
1685                 res = tipc_set_portimportance(tport->ref, value);
1686                 break;
1687         case TIPC_SRC_DROPPABLE:
1688                 if (sock->type != SOCK_STREAM)
1689                         res = tipc_set_portunreliable(tport->ref, value);
1690                 else
1691                         res = -ENOPROTOOPT;
1692                 break;
1693         case TIPC_DEST_DROPPABLE:
1694                 res = tipc_set_portunreturnable(tport->ref, value);
1695                 break;
1696         case TIPC_CONN_TIMEOUT:
1697                 tipc_sk(sk)->conn_timeout = value;
1698                 /* no need to set "res", since already 0 at this point */
1699                 break;
1700         default:
1701                 res = -EINVAL;
1702         }
1703
1704         release_sock(sk);
1705
1706         return res;
1707 }
1708
1709 /**
1710  * getsockopt - get socket option
1711  * @sock: socket structure
1712  * @lvl: option level
1713  * @opt: option identifier
1714  * @ov: receptacle for option value
1715  * @ol: receptacle for length of option value
1716  *
1717  * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1718  * (to ease compatibility).
1719  *
1720  * Returns 0 on success, errno otherwise
1721  */
1722
1723 static int getsockopt(struct socket *sock,
1724                       int lvl, int opt, char __user *ov, int __user *ol)
1725 {
1726         struct sock *sk = sock->sk;
1727         struct tipc_port *tport = tipc_sk_port(sk);
1728         int len;
1729         u32 value;
1730         int res;
1731
1732         if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1733                 return put_user(0, ol);
1734         if (lvl != SOL_TIPC)
1735                 return -ENOPROTOOPT;
1736         res = get_user(len, ol);
1737         if (res)
1738                 return res;
1739
1740         lock_sock(sk);
1741
1742         switch (opt) {
1743         case TIPC_IMPORTANCE:
1744                 res = tipc_portimportance(tport->ref, &value);
1745                 break;
1746         case TIPC_SRC_DROPPABLE:
1747                 res = tipc_portunreliable(tport->ref, &value);
1748                 break;
1749         case TIPC_DEST_DROPPABLE:
1750                 res = tipc_portunreturnable(tport->ref, &value);
1751                 break;
1752         case TIPC_CONN_TIMEOUT:
1753                 value = tipc_sk(sk)->conn_timeout;
1754                 /* no need to set "res", since already 0 at this point */
1755                 break;
1756         case TIPC_NODE_RECVQ_DEPTH:
1757                 value = (u32)atomic_read(&tipc_queue_size);
1758                 break;
1759         case TIPC_SOCK_RECVQ_DEPTH:
1760                 value = skb_queue_len(&sk->sk_receive_queue);
1761                 break;
1762         default:
1763                 res = -EINVAL;
1764         }
1765
1766         release_sock(sk);
1767
1768         if (res)
1769                 return res;     /* "get" failed */
1770
1771         if (len < sizeof(value))
1772                 return -EINVAL;
1773
1774         if (copy_to_user(ov, &value, sizeof(value)))
1775                 return -EFAULT;
1776
1777         return put_user(sizeof(value), ol);
1778 }
1779
1780 /**
1781  * Protocol switches for the various types of TIPC sockets
1782  */
1783
1784 static const struct proto_ops msg_ops = {
1785         .owner          = THIS_MODULE,
1786         .family         = AF_TIPC,
1787         .release        = release,
1788         .bind           = bind,
1789         .connect        = connect,
1790         .socketpair     = sock_no_socketpair,
1791         .accept         = sock_no_accept,
1792         .getname        = get_name,
1793         .poll           = poll,
1794         .ioctl          = sock_no_ioctl,
1795         .listen         = sock_no_listen,
1796         .shutdown       = shutdown,
1797         .setsockopt     = setsockopt,
1798         .getsockopt     = getsockopt,
1799         .sendmsg        = send_msg,
1800         .recvmsg        = recv_msg,
1801         .mmap           = sock_no_mmap,
1802         .sendpage       = sock_no_sendpage
1803 };
1804
1805 static const struct proto_ops packet_ops = {
1806         .owner          = THIS_MODULE,
1807         .family         = AF_TIPC,
1808         .release        = release,
1809         .bind           = bind,
1810         .connect        = connect,
1811         .socketpair     = sock_no_socketpair,
1812         .accept         = accept,
1813         .getname        = get_name,
1814         .poll           = poll,
1815         .ioctl          = sock_no_ioctl,
1816         .listen         = listen,
1817         .shutdown       = shutdown,
1818         .setsockopt     = setsockopt,
1819         .getsockopt     = getsockopt,
1820         .sendmsg        = send_packet,
1821         .recvmsg        = recv_msg,
1822         .mmap           = sock_no_mmap,
1823         .sendpage       = sock_no_sendpage
1824 };
1825
1826 static const struct proto_ops stream_ops = {
1827         .owner          = THIS_MODULE,
1828         .family         = AF_TIPC,
1829         .release        = release,
1830         .bind           = bind,
1831         .connect        = connect,
1832         .socketpair     = sock_no_socketpair,
1833         .accept         = accept,
1834         .getname        = get_name,
1835         .poll           = poll,
1836         .ioctl          = sock_no_ioctl,
1837         .listen         = listen,
1838         .shutdown       = shutdown,
1839         .setsockopt     = setsockopt,
1840         .getsockopt     = getsockopt,
1841         .sendmsg        = send_stream,
1842         .recvmsg        = recv_stream,
1843         .mmap           = sock_no_mmap,
1844         .sendpage       = sock_no_sendpage
1845 };
1846
1847 static const struct net_proto_family tipc_family_ops = {
1848         .owner          = THIS_MODULE,
1849         .family         = AF_TIPC,
1850         .create         = tipc_create
1851 };
1852
1853 static struct proto tipc_proto = {
1854         .name           = "TIPC",
1855         .owner          = THIS_MODULE,
1856         .obj_size       = sizeof(struct tipc_sock)
1857 };
1858
1859 /**
1860  * tipc_socket_init - initialize TIPC socket interface
1861  *
1862  * Returns 0 on success, errno otherwise
1863  */
1864 int tipc_socket_init(void)
1865 {
1866         int res;
1867
1868         res = proto_register(&tipc_proto, 1);
1869         if (res) {
1870                 err("Failed to register TIPC protocol type\n");
1871                 goto out;
1872         }
1873
1874         res = sock_register(&tipc_family_ops);
1875         if (res) {
1876                 err("Failed to register TIPC socket type\n");
1877                 proto_unregister(&tipc_proto);
1878                 goto out;
1879         }
1880
1881         sockets_enabled = 1;
1882  out:
1883         return res;
1884 }
1885
1886 /**
1887  * tipc_socket_stop - stop TIPC socket interface
1888  */
1889
1890 void tipc_socket_stop(void)
1891 {
1892         if (!sockets_enabled)
1893                 return;
1894
1895         sockets_enabled = 0;
1896         sock_unregister(tipc_family_ops.family);
1897         proto_unregister(&tipc_proto);
1898 }
1899