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                 memset(&addr->addr, 0, sizeof(addr->addr));
 833                 addr->addr.id.ref = msg_origport(msg);
 834                 addr->addr.id.node = msg_orignode(msg);
 835                 addr->addr.name.domain = 0;     /* could leave uninitialized */
 836                 addr->scope = 0;                /* could leave uninitialized */
 837                 m->msg_namelen = sizeof(struct sockaddr_tipc);
 838         }
 839 }
 840
 841 /**
 842  * anc_data_recv - optionally capture ancillary data for received message
 843  * @m: descriptor for message info
 844  * @msg: received message header
 845  * @tport: TIPC port associated with message
 846  *
 847  * Note: Ancillary data is not captured if not requested by receiver.
 848  *
 849  * Returns 0 if successful, otherwise errno
 850  */
 851
 852 static int anc_data_recv(struct msghdr *m, struct tipc_msg *msg,
 853                                 struct tipc_port *tport)
 854 {
 855         u32 anc_data[3];
 856         u32 err;
 857         u32 dest_type;
 858         int has_name;
 859         int res;
 860
 861         if (likely(m->msg_controllen == 0))
 862                 return 0;
 863
 864         /* Optionally capture errored message object(s) */
 865
 866         err = msg ? msg_errcode(msg) : 0;
 867         if (unlikely(err)) {
 868                 anc_data[0] = err;
 869                 anc_data[1] = msg_data_sz(msg);
 870                 res = put_cmsg(m, SOL_TIPC, TIPC_ERRINFO, 8, anc_data);
 871                 if (res)
 872                         return res;
 873                 if (anc_data[1]) {
 874                         res = put_cmsg(m, SOL_TIPC, TIPC_RETDATA, anc_data[1],
 875                                        msg_data(msg));
 876                         if (res)
 877                                 return res;
 878                 }
 879         }
 880
 881         /* Optionally capture message destination object */
 882
 883         dest_type = msg ? msg_type(msg) : TIPC_DIRECT_MSG;
 884         switch (dest_type) {
 885         case TIPC_NAMED_MSG:
 886                 has_name = 1;
 887                 anc_data[0] = msg_nametype(msg);
 888                 anc_data[1] = msg_namelower(msg);
 889                 anc_data[2] = msg_namelower(msg);
 890                 break;
 891         case TIPC_MCAST_MSG:
 892                 has_name = 1;
 893                 anc_data[0] = msg_nametype(msg);
 894                 anc_data[1] = msg_namelower(msg);
 895                 anc_data[2] = msg_nameupper(msg);
 896                 break;
 897         case TIPC_CONN_MSG:
 898                 has_name = (tport->conn_type != 0);
 899                 anc_data[0] = tport->conn_type;
 900                 anc_data[1] = tport->conn_instance;
 901                 anc_data[2] = tport->conn_instance;
 902                 break;
 903         default:
 904                 has_name = 0;
 905         }
 906         if (has_name) {
 907                 res = put_cmsg(m, SOL_TIPC, TIPC_DESTNAME, 12, anc_data);
 908                 if (res)
 909                         return res;
 910         }
 911
 912         return 0;
 913 }
 914
 915 /**
 916  * recv_msg - receive packet-oriented message
 917  * @iocb: (unused)
 918  * @m: descriptor for message info
 919  * @buf_len: total size of user buffer area
 920  * @flags: receive flags
 921  *
 922  * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
 923  * If the complete message doesn't fit in user area, truncate it.
 924  *
 925  * Returns size of returned message data, errno otherwise
 926  */
 927
 928 static int recv_msg(struct kiocb *iocb, struct socket *sock,
 929                     struct msghdr *m, size_t buf_len, int flags)
 930 {
 931         struct sock *sk = sock->sk;
 932         struct tipc_port *tport = tipc_sk_port(sk);
 933         struct sk_buff *buf;
 934         struct tipc_msg *msg;
 935         long timeout;
 936         unsigned int sz;
 937         u32 err;
 938         int res;
 939
 940         /* Catch invalid receive requests */
 941
 942         if (unlikely(!buf_len))
 943                 return -EINVAL;
 944
 945         lock_sock(sk);
 946
 947         if (unlikely(sock->state == SS_UNCONNECTED)) {
 948                 res = -ENOTCONN;
 949                 goto exit;
 950         }
 951
 952         /* will be updated in set_orig_addr() if needed */
 953         m->msg_namelen = 0;
 954
 955         timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
 956 restart:
 957
 958         /* Look for a message in receive queue; wait if necessary */
 959
 960         while (skb_queue_empty(&sk->sk_receive_queue)) {
 961                 if (sock->state == SS_DISCONNECTING) {
 962                         res = -ENOTCONN;
 963                         goto exit;
 964                 }
 965                 if (timeout <= 0L) {
 966                         res = timeout ? timeout : -EWOULDBLOCK;
 967                         goto exit;
 968                 }
 969                 release_sock(sk);
 970                 timeout = wait_event_interruptible_timeout(*sk_sleep(sk),
 971                                                            tipc_rx_ready(sock),
 972                                                            timeout);
 973                 lock_sock(sk);
 974         }
 975
 976         /* Look at first message in receive queue */
 977
 978         buf = skb_peek(&sk->sk_receive_queue);
 979         msg = buf_msg(buf);
 980         sz = msg_data_sz(msg);
 981         err = msg_errcode(msg);
 982
 983         /* Complete connection setup for an implied connect */
 984
 985         if (unlikely(sock->state == SS_CONNECTING)) {
 986                 res = auto_connect(sock, msg);
 987                 if (res)
 988                         goto exit;
 989         }
 990
 991         /* Discard an empty non-errored message & try again */
 992
 993         if ((!sz) && (!err)) {
 994                 advance_rx_queue(sk);
 995                 goto restart;
 996         }
 997
 998         /* Capture sender's address (optional) */
 999
1000         set_orig_addr(m, msg);
1001
1002         /* Capture ancillary data (optional) */
1003
1004         res = anc_data_recv(m, msg, tport);
1005         if (res)
1006                 goto exit;
1007
1008         /* Capture message data (if valid) & compute return value (always) */
1009
1010         if (!err) {
1011                 if (unlikely(buf_len < sz)) {
1012                         sz = buf_len;
1013                         m->msg_flags |= MSG_TRUNC;
1014                 }
1015                 res = skb_copy_datagram_iovec(buf, msg_hdr_sz(msg),
1016                                               m->msg_iov, sz);
1017                 if (res)
1018                         goto exit;
1019                 res = sz;
1020         } else {
1021                 if ((sock->state == SS_READY) ||
1022                     ((err == TIPC_CONN_SHUTDOWN) || m->msg_control))
1023                         res = 0;
1024                 else
1025                         res = -ECONNRESET;
1026         }
1027
1028         /* Consume received message (optional) */
1029
1030         if (likely(!(flags & MSG_PEEK))) {
1031                 if ((sock->state != SS_READY) &&
1032                     (++tport->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1033                         tipc_acknowledge(tport->ref, tport->conn_unacked);
1034                 advance_rx_queue(sk);
1035         }
1036 exit:
1037         release_sock(sk);
1038         return res;
1039 }
1040
1041 /**
1042  * recv_stream - receive stream-oriented data
1043  * @iocb: (unused)
1044  * @m: descriptor for message info
1045  * @buf_len: total size of user buffer area
1046  * @flags: receive flags
1047  *
1048  * Used for SOCK_STREAM messages only.  If not enough data is available
1049  * will optionally wait for more; never truncates data.
1050  *
1051  * Returns size of returned message data, errno otherwise
1052  */
1053
1054 static int recv_stream(struct kiocb *iocb, struct socket *sock,
1055                        struct msghdr *m, size_t buf_len, int flags)
1056 {
1057         struct sock *sk = sock->sk;
1058         struct tipc_port *tport = tipc_sk_port(sk);
1059         struct sk_buff *buf;
1060         struct tipc_msg *msg;
1061         long timeout;
1062         unsigned int sz;
1063         int sz_to_copy, target, needed;
1064         int sz_copied = 0;
1065         u32 err;
1066         int res = 0;
1067
1068         /* Catch invalid receive attempts */
1069
1070         if (unlikely(!buf_len))
1071                 return -EINVAL;
1072
1073         lock_sock(sk);
1074
1075         if (unlikely((sock->state == SS_UNCONNECTED) ||
1076                      (sock->state == SS_CONNECTING))) {
1077                 res = -ENOTCONN;
1078                 goto exit;
1079         }
1080
1081         /* will be updated in set_orig_addr() if needed */
1082         m->msg_namelen = 0;
1083
1084         target = sock_rcvlowat(sk, flags & MSG_WAITALL, buf_len);
1085         timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
1086 restart:
1087
1088         /* Look for a message in receive queue; wait if necessary */
1089
1090         while (skb_queue_empty(&sk->sk_receive_queue)) {
1091                 if (sock->state == SS_DISCONNECTING) {
1092                         res = -ENOTCONN;
1093                         goto exit;
1094                 }
1095                 if (timeout <= 0L) {
1096                         res = timeout ? timeout : -EWOULDBLOCK;
1097                         goto exit;
1098                 }
1099                 release_sock(sk);
1100                 timeout = wait_event_interruptible_timeout(*sk_sleep(sk),
1101                                                            tipc_rx_ready(sock),
1102                                                            timeout);
1103                 lock_sock(sk);
1104         }
1105
1106         /* Look at first message in receive queue */
1107
1108         buf = skb_peek(&sk->sk_receive_queue);
1109         msg = buf_msg(buf);
1110         sz = msg_data_sz(msg);
1111         err = msg_errcode(msg);
1112
1113         /* Discard an empty non-errored message & try again */
1114
1115         if ((!sz) && (!err)) {
1116                 advance_rx_queue(sk);
1117                 goto restart;
1118         }
1119
1120         /* Optionally capture sender's address & ancillary data of first msg */
1121
1122         if (sz_copied == 0) {
1123                 set_orig_addr(m, msg);
1124                 res = anc_data_recv(m, msg, tport);
1125                 if (res)
1126                         goto exit;
1127         }
1128
1129         /* Capture message data (if valid) & compute return value (always) */
1130
1131         if (!err) {
1132                 u32 offset = (u32)(unsigned long)(TIPC_SKB_CB(buf)->handle);
1133
1134                 sz -= offset;
1135                 needed = (buf_len - sz_copied);
1136                 sz_to_copy = (sz <= needed) ? sz : needed;
1137
1138                 res = skb_copy_datagram_iovec(buf, msg_hdr_sz(msg) + offset,
1139                                               m->msg_iov, sz_to_copy);
1140                 if (res)
1141                         goto exit;
1142
1143                 sz_copied += sz_to_copy;
1144
1145                 if (sz_to_copy < sz) {
1146                         if (!(flags & MSG_PEEK))
1147                                 TIPC_SKB_CB(buf)->handle =
1148                                 (void *)(unsigned long)(offset + sz_to_copy);
1149                         goto exit;
1150                 }
1151         } else {
1152                 if (sz_copied != 0)
1153                         goto exit; /* can't add error msg to valid data */
1154
1155                 if ((err == TIPC_CONN_SHUTDOWN) || m->msg_control)
1156                         res = 0;
1157                 else
1158                         res = -ECONNRESET;
1159         }
1160
1161         /* Consume received message (optional) */
1162
1163         if (likely(!(flags & MSG_PEEK))) {
1164                 if (unlikely(++tport->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1165                         tipc_acknowledge(tport->ref, tport->conn_unacked);
1166                 advance_rx_queue(sk);
1167         }
1168
1169         /* Loop around if more data is required */
1170
1171         if ((sz_copied < buf_len) &&    /* didn't get all requested data */
1172             (!skb_queue_empty(&sk->sk_receive_queue) ||
1173             (sz_copied < target)) &&    /* and more is ready or required */
1174             (!(flags & MSG_PEEK)) &&    /* and aren't just peeking at data */
1175             (!err))                     /* and haven't reached a FIN */
1176                 goto restart;
1177
1178 exit:
1179         release_sock(sk);
1180         return sz_copied ? sz_copied : res;
1181 }
1182
1183 /**
1184  * rx_queue_full - determine if receive queue can accept another message
1185  * @msg: message to be added to queue
1186  * @queue_size: current size of queue
1187  * @base: nominal maximum size of queue
1188  *
1189  * Returns 1 if queue is unable to accept message, 0 otherwise
1190  */
1191
1192 static int rx_queue_full(struct tipc_msg *msg, u32 queue_size, u32 base)
1193 {
1194         u32 threshold;
1195         u32 imp = msg_importance(msg);
1196
1197         if (imp == TIPC_LOW_IMPORTANCE)
1198                 threshold = base;
1199         else if (imp == TIPC_MEDIUM_IMPORTANCE)
1200                 threshold = base * 2;
1201         else if (imp == TIPC_HIGH_IMPORTANCE)
1202                 threshold = base * 100;
1203         else
1204                 return 0;
1205
1206         if (msg_connected(msg))
1207                 threshold *= 4;
1208
1209         return queue_size >= threshold;
1210 }
1211
1212 /**
1213  * filter_rcv - validate incoming message
1214  * @sk: socket
1215  * @buf: message
1216  *
1217  * Enqueues message on receive queue if acceptable; optionally handles
1218  * disconnect indication for a connected socket.
1219  *
1220  * Called with socket lock already taken; port lock may also be taken.
1221  *
1222  * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1223  */
1224
1225 static u32 filter_rcv(struct sock *sk, struct sk_buff *buf)
1226 {
1227         struct socket *sock = sk->sk_socket;
1228         struct tipc_msg *msg = buf_msg(buf);
1229         u32 recv_q_len;
1230
1231         /* Reject message if it is wrong sort of message for socket */
1232
1233         /*
1234          * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1235          * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1236          * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1237          */
1238
1239         if (sock->state == SS_READY) {
1240                 if (msg_connected(msg))
1241                         return TIPC_ERR_NO_PORT;
1242         } else {
1243                 if (msg_mcast(msg))
1244                         return TIPC_ERR_NO_PORT;
1245                 if (sock->state == SS_CONNECTED) {
1246                         if (!msg_connected(msg))
1247                                 return TIPC_ERR_NO_PORT;
1248                 } else if (sock->state == SS_CONNECTING) {
1249                         if (!msg_connected(msg) && (msg_errcode(msg) == 0))
1250                                 return TIPC_ERR_NO_PORT;
1251                 } else if (sock->state == SS_LISTENING) {
1252                         if (msg_connected(msg) || msg_errcode(msg))
1253                                 return TIPC_ERR_NO_PORT;
1254                 } else if (sock->state == SS_DISCONNECTING) {
1255                         return TIPC_ERR_NO_PORT;
1256                 } else /* (sock->state == SS_UNCONNECTED) */ {
1257                         if (msg_connected(msg) || msg_errcode(msg))
1258                                 return TIPC_ERR_NO_PORT;
1259                 }
1260         }
1261
1262         /* Reject message if there isn't room to queue it */
1263
1264         recv_q_len = (u32)atomic_read(&tipc_queue_size);
1265         if (unlikely(recv_q_len >= OVERLOAD_LIMIT_BASE)) {
1266                 if (rx_queue_full(msg, recv_q_len, OVERLOAD_LIMIT_BASE))
1267                         return TIPC_ERR_OVERLOAD;
1268         }
1269         recv_q_len = skb_queue_len(&sk->sk_receive_queue);
1270         if (unlikely(recv_q_len >= (OVERLOAD_LIMIT_BASE / 2))) {
1271                 if (rx_queue_full(msg, recv_q_len, OVERLOAD_LIMIT_BASE / 2))
1272                         return TIPC_ERR_OVERLOAD;
1273         }
1274
1275         /* Enqueue message (finally!) */
1276
1277         TIPC_SKB_CB(buf)->handle = 0;
1278         atomic_inc(&tipc_queue_size);
1279         __skb_queue_tail(&sk->sk_receive_queue, buf);
1280
1281         /* Initiate connection termination for an incoming 'FIN' */
1282
1283         if (unlikely(msg_errcode(msg) && (sock->state == SS_CONNECTED))) {
1284                 sock->state = SS_DISCONNECTING;
1285                 tipc_disconnect_port(tipc_sk_port(sk));
1286         }
1287
1288         if (waitqueue_active(sk_sleep(sk)))
1289                 wake_up_interruptible(sk_sleep(sk));
1290         return TIPC_OK;
1291 }
1292
1293 /**
1294  * backlog_rcv - handle incoming message from backlog queue
1295  * @sk: socket
1296  * @buf: message
1297  *
1298  * Caller must hold socket lock, but not port lock.
1299  *
1300  * Returns 0
1301  */
1302
1303 static int backlog_rcv(struct sock *sk, struct sk_buff *buf)
1304 {
1305         u32 res;
1306
1307         res = filter_rcv(sk, buf);
1308         if (res)
1309                 tipc_reject_msg(buf, res);
1310         return 0;
1311 }
1312
1313 /**
1314  * dispatch - handle incoming message
1315  * @tport: TIPC port that received message
1316  * @buf: message
1317  *
1318  * Called with port lock already taken.
1319  *
1320  * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1321  */
1322
1323 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf)
1324 {
1325         struct sock *sk = (struct sock *)tport->usr_handle;
1326         u32 res;
1327
1328         /*
1329          * Process message if socket is unlocked; otherwise add to backlog queue
1330          *
1331          * This code is based on sk_receive_skb(), but must be distinct from it
1332          * since a TIPC-specific filter/reject mechanism is utilized
1333          */
1334
1335         bh_lock_sock(sk);
1336         if (!sock_owned_by_user(sk)) {
1337                 res = filter_rcv(sk, buf);
1338         } else {
1339                 if (sk_add_backlog(sk, buf))
1340                         res = TIPC_ERR_OVERLOAD;
1341                 else
1342                         res = TIPC_OK;
1343         }
1344         bh_unlock_sock(sk);
1345
1346         return res;
1347 }
1348
1349 /**
1350  * wakeupdispatch - wake up port after congestion
1351  * @tport: port to wakeup
1352  *
1353  * Called with port lock already taken.
1354  */
1355
1356 static void wakeupdispatch(struct tipc_port *tport)
1357 {
1358         struct sock *sk = (struct sock *)tport->usr_handle;
1359
1360         if (waitqueue_active(sk_sleep(sk)))
1361                 wake_up_interruptible(sk_sleep(sk));
1362 }
1363
1364 /**
1365  * connect - establish a connection to another TIPC port
1366  * @sock: socket structure
1367  * @dest: socket address for destination port
1368  * @destlen: size of socket address data structure
1369  * @flags: file-related flags associated with socket
1370  *
1371  * Returns 0 on success, errno otherwise
1372  */
1373
1374 static int connect(struct socket *sock, struct sockaddr *dest, int destlen,
1375                    int flags)
1376 {
1377         struct sock *sk = sock->sk;
1378         struct sockaddr_tipc *dst = (struct sockaddr_tipc *)dest;
1379         struct msghdr m = {NULL,};
1380         struct sk_buff *buf;
1381         struct tipc_msg *msg;
1382         unsigned int timeout;
1383         int res;
1384
1385         lock_sock(sk);
1386
1387         /* For now, TIPC does not allow use of connect() with DGRAM/RDM types */
1388
1389         if (sock->state == SS_READY) {
1390                 res = -EOPNOTSUPP;
1391                 goto exit;
1392         }
1393
1394         /* For now, TIPC does not support the non-blocking form of connect() */
1395
1396         if (flags & O_NONBLOCK) {
1397                 res = -EOPNOTSUPP;
1398                 goto exit;
1399         }
1400
1401         /* Issue Posix-compliant error code if socket is in the wrong state */
1402
1403         if (sock->state == SS_LISTENING) {
1404                 res = -EOPNOTSUPP;
1405                 goto exit;
1406         }
1407         if (sock->state == SS_CONNECTING) {
1408                 res = -EALREADY;
1409                 goto exit;
1410         }
1411         if (sock->state != SS_UNCONNECTED) {
1412                 res = -EISCONN;
1413                 goto exit;
1414         }
1415
1416         /*
1417          * Reject connection attempt using multicast address
1418          *
1419          * Note: send_msg() validates the rest of the address fields,
1420          *       so there's no need to do it here
1421          */
1422
1423         if (dst->addrtype == TIPC_ADDR_MCAST) {
1424                 res = -EINVAL;
1425                 goto exit;
1426         }
1427
1428         /* Reject any messages already in receive queue (very unlikely) */
1429
1430         reject_rx_queue(sk);
1431
1432         /* Send a 'SYN-' to destination */
1433
1434         m.msg_name = dest;
1435         m.msg_namelen = destlen;
1436         res = send_msg(NULL, sock, &m, 0);
1437         if (res < 0)
1438                 goto exit;
1439
1440         /* Wait until an 'ACK' or 'RST' arrives, or a timeout occurs */
1441
1442         timeout = tipc_sk(sk)->conn_timeout;
1443         release_sock(sk);
1444         res = wait_event_interruptible_timeout(*sk_sleep(sk),
1445                         (!skb_queue_empty(&sk->sk_receive_queue) ||
1446                         (sock->state != SS_CONNECTING)),
1447                         timeout ? (long)msecs_to_jiffies(timeout)
1448                                 : MAX_SCHEDULE_TIMEOUT);
1449         lock_sock(sk);
1450
1451         if (res > 0) {
1452                 buf = skb_peek(&sk->sk_receive_queue);
1453                 if (buf != NULL) {
1454                         msg = buf_msg(buf);
1455                         res = auto_connect(sock, msg);
1456                         if (!res) {
1457                                 if (!msg_data_sz(msg))
1458                                         advance_rx_queue(sk);
1459                         }
1460                 } else {
1461                         if (sock->state == SS_CONNECTED)
1462                                 res = -EISCONN;
1463                         else
1464                                 res = -ECONNREFUSED;
1465                 }
1466         } else {
1467                 if (res == 0)
1468                         res = -ETIMEDOUT;
1469                 else
1470                         ; /* leave "res" unchanged */
1471                 sock->state = SS_DISCONNECTING;
1472         }
1473
1474 exit:
1475         release_sock(sk);
1476         return res;
1477 }
1478
1479 /**
1480  * listen - allow socket to listen for incoming connections
1481  * @sock: socket structure
1482  * @len: (unused)
1483  *
1484  * Returns 0 on success, errno otherwise
1485  */
1486
1487 static int listen(struct socket *sock, int len)
1488 {
1489         struct sock *sk = sock->sk;
1490         int res;
1491
1492         lock_sock(sk);
1493
1494         if (sock->state != SS_UNCONNECTED)
1495                 res = -EINVAL;
1496         else {
1497                 sock->state = SS_LISTENING;
1498                 res = 0;
1499         }
1500
1501         release_sock(sk);
1502         return res;
1503 }
1504
1505 /**
1506  * accept - wait for connection request
1507  * @sock: listening socket
1508  * @newsock: new socket that is to be connected
1509  * @flags: file-related flags associated with socket
1510  *
1511  * Returns 0 on success, errno otherwise
1512  */
1513
1514 static int accept(struct socket *sock, struct socket *new_sock, int flags)
1515 {
1516         struct sock *sk = sock->sk;
1517         struct sk_buff *buf;
1518         int res;
1519
1520         lock_sock(sk);
1521
1522         if (sock->state != SS_LISTENING) {
1523                 res = -EINVAL;
1524                 goto exit;
1525         }
1526
1527         while (skb_queue_empty(&sk->sk_receive_queue)) {
1528                 if (flags & O_NONBLOCK) {
1529                         res = -EWOULDBLOCK;
1530                         goto exit;
1531                 }
1532                 release_sock(sk);
1533                 res = wait_event_interruptible(*sk_sleep(sk),
1534                                 (!skb_queue_empty(&sk->sk_receive_queue)));
1535                 lock_sock(sk);
1536                 if (res)
1537                         goto exit;
1538         }
1539
1540         buf = skb_peek(&sk->sk_receive_queue);
1541
1542         res = tipc_create(sock_net(sock->sk), new_sock, 0, 0);
1543         if (!res) {
1544                 struct sock *new_sk = new_sock->sk;
1545                 struct tipc_sock *new_tsock = tipc_sk(new_sk);
1546                 struct tipc_port *new_tport = new_tsock->p;
1547                 u32 new_ref = new_tport->ref;
1548                 struct tipc_msg *msg = buf_msg(buf);
1549
1550                 lock_sock(new_sk);
1551
1552                 /*
1553                  * Reject any stray messages received by new socket
1554                  * before the socket lock was taken (very, very unlikely)
1555                  */
1556
1557                 reject_rx_queue(new_sk);
1558
1559                 /* Connect new socket to it's peer */
1560
1561                 new_tsock->peer_name.ref = msg_origport(msg);
1562                 new_tsock->peer_name.node = msg_orignode(msg);
1563                 tipc_connect2port(new_ref, &new_tsock->peer_name);
1564                 new_sock->state = SS_CONNECTED;
1565
1566                 tipc_set_portimportance(new_ref, msg_importance(msg));
1567                 if (msg_named(msg)) {
1568                         new_tport->conn_type = msg_nametype(msg);
1569                         new_tport->conn_instance = msg_nameinst(msg);
1570                 }
1571
1572                 /*
1573                  * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1574                  * Respond to 'SYN+' by queuing it on new socket.
1575                  */
1576
1577                 if (!msg_data_sz(msg)) {
1578                         struct msghdr m = {NULL,};
1579
1580                         advance_rx_queue(sk);
1581                         send_packet(NULL, new_sock, &m, 0);
1582                 } else {
1583                         __skb_dequeue(&sk->sk_receive_queue);
1584                         __skb_queue_head(&new_sk->sk_receive_queue, buf);
1585                 }
1586                 release_sock(new_sk);
1587         }
1588 exit:
1589         release_sock(sk);
1590         return res;
1591 }
1592
1593 /**
1594  * shutdown - shutdown socket connection
1595  * @sock: socket structure
1596  * @how: direction to close (must be SHUT_RDWR)
1597  *
1598  * Terminates connection (if necessary), then purges socket's receive queue.
1599  *
1600  * Returns 0 on success, errno otherwise
1601  */
1602
1603 static int shutdown(struct socket *sock, int how)
1604 {
1605         struct sock *sk = sock->sk;
1606         struct tipc_port *tport = tipc_sk_port(sk);
1607         struct sk_buff *buf;
1608         int res;
1609
1610         if (how != SHUT_RDWR)
1611                 return -EINVAL;
1612
1613         lock_sock(sk);
1614
1615         switch (sock->state) {
1616         case SS_CONNECTING:
1617         case SS_CONNECTED:
1618
1619                 /* Disconnect and send a 'FIN+' or 'FIN-' message to peer */
1620 restart:
1621                 buf = __skb_dequeue(&sk->sk_receive_queue);
1622                 if (buf) {
1623                         atomic_dec(&tipc_queue_size);
1624                         if (TIPC_SKB_CB(buf)->handle != 0) {
1625                                 buf_discard(buf);
1626                                 goto restart;
1627                         }
1628                         tipc_disconnect(tport->ref);
1629                         tipc_reject_msg(buf, TIPC_CONN_SHUTDOWN);
1630                 } else {
1631                         tipc_shutdown(tport->ref);
1632                 }
1633
1634                 sock->state = SS_DISCONNECTING;
1635
1636                 /* fall through */
1637
1638         case SS_DISCONNECTING:
1639
1640                 /* Discard any unreceived messages; wake up sleeping tasks */
1641
1642                 discard_rx_queue(sk);
1643                 if (waitqueue_active(sk_sleep(sk)))
1644                         wake_up_interruptible(sk_sleep(sk));
1645                 res = 0;
1646                 break;
1647
1648         default:
1649                 res = -ENOTCONN;
1650         }
1651
1652         release_sock(sk);
1653         return res;
1654 }
1655
1656 /**
1657  * setsockopt - set socket option
1658  * @sock: socket structure
1659  * @lvl: option level
1660  * @opt: option identifier
1661  * @ov: pointer to new option value
1662  * @ol: length of option value
1663  *
1664  * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1665  * (to ease compatibility).
1666  *
1667  * Returns 0 on success, errno otherwise
1668  */
1669
1670 static int setsockopt(struct socket *sock,
1671                       int lvl, int opt, char __user *ov, unsigned int ol)
1672 {
1673         struct sock *sk = sock->sk;
1674         struct tipc_port *tport = tipc_sk_port(sk);
1675         u32 value;
1676         int res;
1677
1678         if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1679                 return 0;
1680         if (lvl != SOL_TIPC)
1681                 return -ENOPROTOOPT;
1682         if (ol < sizeof(value))
1683                 return -EINVAL;
1684         res = get_user(value, (u32 __user *)ov);
1685         if (res)
1686                 return res;
1687
1688         lock_sock(sk);
1689
1690         switch (opt) {
1691         case TIPC_IMPORTANCE:
1692                 res = tipc_set_portimportance(tport->ref, value);
1693                 break;
1694         case TIPC_SRC_DROPPABLE:
1695                 if (sock->type != SOCK_STREAM)
1696                         res = tipc_set_portunreliable(tport->ref, value);
1697                 else
1698                         res = -ENOPROTOOPT;
1699                 break;
1700         case TIPC_DEST_DROPPABLE:
1701                 res = tipc_set_portunreturnable(tport->ref, value);
1702                 break;
1703         case TIPC_CONN_TIMEOUT:
1704                 tipc_sk(sk)->conn_timeout = value;
1705                 /* no need to set "res", since already 0 at this point */
1706                 break;
1707         default:
1708                 res = -EINVAL;
1709         }
1710
1711         release_sock(sk);
1712
1713         return res;
1714 }
1715
1716 /**
1717  * getsockopt - get socket option
1718  * @sock: socket structure
1719  * @lvl: option level
1720  * @opt: option identifier
1721  * @ov: receptacle for option value
1722  * @ol: receptacle for length of option value
1723  *
1724  * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1725  * (to ease compatibility).
1726  *
1727  * Returns 0 on success, errno otherwise
1728  */
1729
1730 static int getsockopt(struct socket *sock,
1731                       int lvl, int opt, char __user *ov, int __user *ol)
1732 {
1733         struct sock *sk = sock->sk;
1734         struct tipc_port *tport = tipc_sk_port(sk);
1735         int len;
1736         u32 value;
1737         int res;
1738
1739         if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1740                 return put_user(0, ol);
1741         if (lvl != SOL_TIPC)
1742                 return -ENOPROTOOPT;
1743         res = get_user(len, ol);
1744         if (res)
1745                 return res;
1746
1747         lock_sock(sk);
1748
1749         switch (opt) {
1750         case TIPC_IMPORTANCE:
1751                 res = tipc_portimportance(tport->ref, &value);
1752                 break;
1753         case TIPC_SRC_DROPPABLE:
1754                 res = tipc_portunreliable(tport->ref, &value);
1755                 break;
1756         case TIPC_DEST_DROPPABLE:
1757                 res = tipc_portunreturnable(tport->ref, &value);
1758                 break;
1759         case TIPC_CONN_TIMEOUT:
1760                 value = tipc_sk(sk)->conn_timeout;
1761                 /* no need to set "res", since already 0 at this point */
1762                 break;
1763         case TIPC_NODE_RECVQ_DEPTH:
1764                 value = (u32)atomic_read(&tipc_queue_size);
1765                 break;
1766         case TIPC_SOCK_RECVQ_DEPTH:
1767                 value = skb_queue_len(&sk->sk_receive_queue);
1768                 break;
1769         default:
1770                 res = -EINVAL;
1771         }
1772
1773         release_sock(sk);
1774
1775         if (res)
1776                 return res;     /* "get" failed */
1777
1778         if (len < sizeof(value))
1779                 return -EINVAL;
1780
1781         if (copy_to_user(ov, &value, sizeof(value)))
1782                 return -EFAULT;
1783
1784         return put_user(sizeof(value), ol);
1785 }
1786
1787 /**
1788  * Protocol switches for the various types of TIPC sockets
1789  */
1790
1791 static const struct proto_ops msg_ops = {
1792         .owner          = THIS_MODULE,
1793         .family         = AF_TIPC,
1794         .release        = release,
1795         .bind           = bind,
1796         .connect        = connect,
1797         .socketpair     = sock_no_socketpair,
1798         .accept         = sock_no_accept,
1799         .getname        = get_name,
1800         .poll           = poll,
1801         .ioctl          = sock_no_ioctl,
1802         .listen         = sock_no_listen,
1803         .shutdown       = shutdown,
1804         .setsockopt     = setsockopt,
1805         .getsockopt     = getsockopt,
1806         .sendmsg        = send_msg,
1807         .recvmsg        = recv_msg,
1808         .mmap           = sock_no_mmap,
1809         .sendpage       = sock_no_sendpage
1810 };
1811
1812 static const struct proto_ops packet_ops = {
1813         .owner          = THIS_MODULE,
1814         .family         = AF_TIPC,
1815         .release        = release,
1816         .bind           = bind,
1817         .connect        = connect,
1818         .socketpair     = sock_no_socketpair,
1819         .accept         = accept,
1820         .getname        = get_name,
1821         .poll           = poll,
1822         .ioctl          = sock_no_ioctl,
1823         .listen         = listen,
1824         .shutdown       = shutdown,
1825         .setsockopt     = setsockopt,
1826         .getsockopt     = getsockopt,
1827         .sendmsg        = send_packet,
1828         .recvmsg        = recv_msg,
1829         .mmap           = sock_no_mmap,
1830         .sendpage       = sock_no_sendpage
1831 };
1832
1833 static const struct proto_ops stream_ops = {
1834         .owner          = THIS_MODULE,
1835         .family         = AF_TIPC,
1836         .release        = release,
1837         .bind           = bind,
1838         .connect        = connect,
1839         .socketpair     = sock_no_socketpair,
1840         .accept         = accept,
1841         .getname        = get_name,
1842         .poll           = poll,
1843         .ioctl          = sock_no_ioctl,
1844         .listen         = listen,
1845         .shutdown       = shutdown,
1846         .setsockopt     = setsockopt,
1847         .getsockopt     = getsockopt,
1848         .sendmsg        = send_stream,
1849         .recvmsg        = recv_stream,
1850         .mmap           = sock_no_mmap,
1851         .sendpage       = sock_no_sendpage
1852 };
1853
1854 static const struct net_proto_family tipc_family_ops = {
1855         .owner          = THIS_MODULE,
1856         .family         = AF_TIPC,
1857         .create         = tipc_create
1858 };
1859
1860 static struct proto tipc_proto = {
1861         .name           = "TIPC",
1862         .owner          = THIS_MODULE,
1863         .obj_size       = sizeof(struct tipc_sock)
1864 };
1865
1866 /**
1867  * tipc_socket_init - initialize TIPC socket interface
1868  *
1869  * Returns 0 on success, errno otherwise
1870  */
1871 int tipc_socket_init(void)
1872 {
1873         int res;
1874
1875         res = proto_register(&tipc_proto, 1);
1876         if (res) {
1877                 err("Failed to register TIPC protocol type\n");
1878                 goto out;
1879         }
1880
1881         res = sock_register(&tipc_family_ops);
1882         if (res) {
1883                 err("Failed to register TIPC socket type\n");
1884                 proto_unregister(&tipc_proto);
1885                 goto out;
1886         }
1887
1888         sockets_enabled = 1;
1889  out:
1890         return res;
1891 }
1892
1893 /**
1894  * tipc_socket_stop - stop TIPC socket interface
1895  */
1896
1897 void tipc_socket_stop(void)
1898 {
1899         if (!sockets_enabled)
1900                 return;
1901
1902         sockets_enabled = 0;
1903         sock_unregister(tipc_family_ops.family);
1904         proto_unregister(&tipc_proto);
1905 }
1906