2 * net/tipc/socket.c: TIPC socket API
4 * Copyright (c) 2001-2006, Ericsson AB
5 * Copyright (c) 2004-2005, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
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.
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.
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.
37 #include <linux/module.h>
38 #include <linux/types.h>
39 #include <linux/net.h>
40 #include <linux/socket.h>
41 #include <linux/errno.h>
43 #include <linux/slab.h>
44 #include <linux/poll.h>
45 #include <linux/fcntl.h>
46 #include <asm/semaphore.h>
47 #include <asm/string.h>
48 #include <asm/atomic.h>
51 #include <linux/tipc.h>
52 #include <linux/tipc_config.h>
53 #include <net/tipc/tipc_msg.h>
54 #include <net/tipc/tipc_port.h>
58 #define SS_LISTENING -1 /* socket is listening */
59 #define SS_READY -2 /* socket is connectionless */
61 #define OVERLOAD_LIMIT_BASE 5000
69 #define tipc_sk(sk) ((struct tipc_sock*)sk)
71 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf);
72 static void wakeupdispatch(struct tipc_port *tport);
74 static struct proto_ops packet_ops;
75 static struct proto_ops stream_ops;
76 static struct proto_ops msg_ops;
78 static struct proto tipc_proto;
80 static int sockets_enabled = 0;
82 static atomic_t tipc_queue_size = ATOMIC_INIT(0);
86 * sock_lock(): Lock a port/socket pair. lock_sock() can
87 * not be used here, since the same lock must protect ports
88 * with non-socket interfaces.
89 * See net.c for description of locking policy.
91 static void sock_lock(struct tipc_sock* tsock)
93 spin_lock_bh(tsock->p->lock);
97 * sock_unlock(): Unlock a port/socket pair
99 static void sock_unlock(struct tipc_sock* tsock)
101 spin_unlock_bh(tsock->p->lock);
105 * pollmask - determine the current set of poll() events for a socket
106 * @sock: socket structure
108 * TIPC sets the returned events as follows:
109 * a) POLLRDNORM and POLLIN are set if the socket's receive queue is non-empty
110 * or if a connection-oriented socket is does not have an active connection
111 * (i.e. a read operation will not block).
112 * b) POLLOUT is set except when a socket's connection has been terminated
113 * (i.e. a write operation will not block).
114 * c) POLLHUP is set when a socket's connection has been terminated.
116 * IMPORTANT: The fact that a read or write operation will not block does NOT
117 * imply that the operation will succeed!
119 * Returns pollmask value
122 static u32 pollmask(struct socket *sock)
126 if ((skb_queue_len(&sock->sk->sk_receive_queue) != 0) ||
127 (sock->state == SS_UNCONNECTED) ||
128 (sock->state == SS_DISCONNECTING))
129 mask = (POLLRDNORM | POLLIN);
133 if (sock->state == SS_DISCONNECTING)
143 * advance_queue - discard first buffer in queue
144 * @tsock: TIPC socket
147 static void advance_queue(struct tipc_sock *tsock)
150 buf_discard(skb_dequeue(&tsock->sk.sk_receive_queue));
152 atomic_dec(&tipc_queue_size);
156 * tipc_create - create a TIPC socket
157 * @sock: pre-allocated socket structure
158 * @protocol: protocol indicator (must be 0)
160 * This routine creates and attaches a 'struct sock' to the 'struct socket',
161 * then create and attaches a TIPC port to the 'struct sock' part.
163 * Returns 0 on success, errno otherwise
165 static int tipc_create(struct socket *sock, int protocol)
167 struct tipc_sock *tsock;
168 struct tipc_port *port;
172 if (unlikely(protocol != 0))
173 return -EPROTONOSUPPORT;
175 ref = tipc_createport_raw(NULL, &dispatch, &wakeupdispatch, TIPC_LOW_IMPORTANCE);
179 sock->state = SS_UNCONNECTED;
181 switch (sock->type) {
183 sock->ops = &stream_ops;
186 sock->ops = &packet_ops;
189 tipc_set_portunreliable(ref, 1);
192 tipc_set_portunreturnable(ref, 1);
193 sock->ops = &msg_ops;
194 sock->state = SS_READY;
197 tipc_deleteport(ref);
201 sk = sk_alloc(AF_TIPC, GFP_KERNEL, &tipc_proto, 1);
203 tipc_deleteport(ref);
207 sock_init_data(sock, sk);
208 init_waitqueue_head(sk->sk_sleep);
209 sk->sk_rcvtimeo = 8 * HZ; /* default connect timeout = 8s */
212 port = tipc_get_port(ref);
215 port->usr_handle = tsock;
217 init_MUTEX(&tsock->sem);
219 dbg("sock_create: %x\n",tsock);
221 atomic_inc(&tipc_user_count);
227 * release - destroy a TIPC socket
228 * @sock: socket to destroy
230 * This routine cleans up any messages that are still queued on the socket.
231 * For DGRAM and RDM socket types, all queued messages are rejected.
232 * For SEQPACKET and STREAM socket types, the first message is rejected
233 * and any others are discarded. (If the first message on a STREAM socket
234 * is partially-read, it is discarded and the next one is rejected instead.)
236 * NOTE: Rejected messages are not necessarily returned to the sender! They
237 * are returned or discarded according to the "destination droppable" setting
238 * specified for the message by the sender.
240 * Returns 0 on success, errno otherwise
243 static int release(struct socket *sock)
245 struct tipc_sock *tsock = tipc_sk(sock->sk);
246 struct sock *sk = sock->sk;
250 dbg("sock_delete: %x\n",tsock);
253 down_interruptible(&tsock->sem);
259 /* Reject unreceived messages, unless no longer connected */
261 while (sock->state != SS_DISCONNECTING) {
263 buf = skb_dequeue(&sk->sk_receive_queue);
265 tsock->p->usr_handle = NULL;
269 if (TIPC_SKB_CB(buf)->handle != msg_data(buf_msg(buf)))
272 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
273 atomic_dec(&tipc_queue_size);
276 /* Delete TIPC port */
278 res = tipc_deleteport(tsock->p->ref);
281 /* Discard any remaining messages */
283 while ((buf = skb_dequeue(&sk->sk_receive_queue))) {
285 atomic_dec(&tipc_queue_size);
292 atomic_dec(&tipc_user_count);
297 * bind - associate or disassocate TIPC name(s) with a socket
298 * @sock: socket structure
299 * @uaddr: socket address describing name(s) and desired operation
300 * @uaddr_len: size of socket address data structure
302 * Name and name sequence binding is indicated using a positive scope value;
303 * a negative scope value unbinds the specified name. Specifying no name
304 * (i.e. a socket address length of 0) unbinds all names from the socket.
306 * Returns 0 on success, errno otherwise
309 static int bind(struct socket *sock, struct sockaddr *uaddr, int uaddr_len)
311 struct tipc_sock *tsock = tipc_sk(sock->sk);
312 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
315 if (down_interruptible(&tsock->sem))
318 if (unlikely(!uaddr_len)) {
319 res = tipc_withdraw(tsock->p->ref, 0, NULL);
323 if (uaddr_len < sizeof(struct sockaddr_tipc)) {
328 if (addr->family != AF_TIPC) {
332 if (addr->addrtype == TIPC_ADDR_NAME)
333 addr->addr.nameseq.upper = addr->addr.nameseq.lower;
334 else if (addr->addrtype != TIPC_ADDR_NAMESEQ) {
340 res = tipc_publish(tsock->p->ref, addr->scope,
341 &addr->addr.nameseq);
343 res = tipc_withdraw(tsock->p->ref, -addr->scope,
344 &addr->addr.nameseq);
351 * get_name - get port ID of socket or peer socket
352 * @sock: socket structure
353 * @uaddr: area for returned socket address
354 * @uaddr_len: area for returned length of socket address
355 * @peer: 0 to obtain socket name, 1 to obtain peer socket name
357 * Returns 0 on success, errno otherwise
360 static int get_name(struct socket *sock, struct sockaddr *uaddr,
361 int *uaddr_len, int peer)
363 struct tipc_sock *tsock = tipc_sk(sock->sk);
364 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
367 if (down_interruptible(&tsock->sem))
370 *uaddr_len = sizeof(*addr);
371 addr->addrtype = TIPC_ADDR_ID;
372 addr->family = AF_TIPC;
375 res = tipc_peer(tsock->p->ref, &addr->addr.id);
377 res = tipc_ownidentity(tsock->p->ref, &addr->addr.id);
378 addr->addr.name.domain = 0;
385 * poll - read and possibly block on pollmask
386 * @file: file structure associated with the socket
387 * @sock: socket for which to calculate the poll bits
390 * Returns the pollmask
393 static unsigned int poll(struct file *file, struct socket *sock,
396 poll_wait(file, sock->sk->sk_sleep, wait);
397 /* NEED LOCK HERE? */
398 return pollmask(sock);
402 * dest_name_check - verify user is permitted to send to specified port name
403 * @dest: destination address
404 * @m: descriptor for message to be sent
406 * Prevents restricted configuration commands from being issued by
407 * unauthorized users.
409 * Returns 0 if permission is granted, otherwise errno
412 static int dest_name_check(struct sockaddr_tipc *dest, struct msghdr *m)
414 struct tipc_cfg_msg_hdr hdr;
416 if (likely(dest->addr.name.name.type >= TIPC_RESERVED_TYPES))
418 if (likely(dest->addr.name.name.type == TIPC_TOP_SRV))
421 if (likely(dest->addr.name.name.type != TIPC_CFG_SRV))
424 if (copy_from_user(&hdr, m->msg_iov[0].iov_base, sizeof(hdr)))
426 if ((ntohs(hdr.tcm_type) & 0xC000) && (!capable(CAP_NET_ADMIN)))
433 * send_msg - send message in connectionless manner
435 * @sock: socket structure
436 * @m: message to send
437 * @total_len: length of message
439 * Message must have an destination specified explicitly.
440 * Used for SOCK_RDM and SOCK_DGRAM messages,
441 * and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
442 * (Note: 'SYN+' is prohibited on SOCK_STREAM.)
444 * Returns the number of bytes sent on success, or errno otherwise
447 static int send_msg(struct kiocb *iocb, struct socket *sock,
448 struct msghdr *m, size_t total_len)
450 struct tipc_sock *tsock = tipc_sk(sock->sk);
451 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
457 return -EDESTADDRREQ;
458 if (unlikely(dest->family != AF_TIPC))
461 needs_conn = (sock->state != SS_READY);
462 if (unlikely(needs_conn)) {
463 if (sock->state == SS_LISTENING)
465 if (sock->state != SS_UNCONNECTED)
467 if ((tsock->p->published) ||
468 ((sock->type == SOCK_STREAM) && (total_len != 0)))
470 if (dest->addrtype == TIPC_ADDR_NAME) {
471 tsock->p->conn_type = dest->addr.name.name.type;
472 tsock->p->conn_instance = dest->addr.name.name.instance;
476 if (down_interruptible(&tsock->sem))
481 /* Abort any pending connection attempts (very unlikely) */
483 while ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
484 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
485 atomic_dec(&tipc_queue_size);
488 sock->state = SS_CONNECTING;
492 if (dest->addrtype == TIPC_ADDR_NAME) {
493 if ((res = dest_name_check(dest, m)))
495 res = tipc_send2name(tsock->p->ref,
496 &dest->addr.name.name,
497 dest->addr.name.domain,
501 else if (dest->addrtype == TIPC_ADDR_ID) {
502 res = tipc_send2port(tsock->p->ref,
507 else if (dest->addrtype == TIPC_ADDR_MCAST) {
512 if ((res = dest_name_check(dest, m)))
514 res = tipc_multicast(tsock->p->ref,
520 if (likely(res != -ELINKCONG)) {
525 if (m->msg_flags & MSG_DONTWAIT) {
529 if (wait_event_interruptible(*sock->sk->sk_sleep,
530 !tsock->p->congested)) {
538 * send_packet - send a connection-oriented message
540 * @sock: socket structure
541 * @m: message to send
542 * @total_len: length of message
544 * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
546 * Returns the number of bytes sent on success, or errno otherwise
549 static int send_packet(struct kiocb *iocb, struct socket *sock,
550 struct msghdr *m, size_t total_len)
552 struct tipc_sock *tsock = tipc_sk(sock->sk);
553 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
556 /* Handle implied connection establishment */
559 return send_msg(iocb, sock, m, total_len);
561 if (down_interruptible(&tsock->sem)) {
566 if (unlikely(sock->state != SS_CONNECTED)) {
567 if (sock->state == SS_DISCONNECTING)
574 res = tipc_send(tsock->p->ref, m->msg_iovlen, m->msg_iov);
575 if (likely(res != -ELINKCONG)) {
580 if (m->msg_flags & MSG_DONTWAIT) {
584 if (wait_event_interruptible(*sock->sk->sk_sleep,
585 !tsock->p->congested)) {
593 * send_stream - send stream-oriented data
595 * @sock: socket structure
597 * @total_len: total length of data to be sent
599 * Used for SOCK_STREAM data.
601 * Returns the number of bytes sent on success (or partial success),
602 * or errno if no data sent
606 static int send_stream(struct kiocb *iocb, struct socket *sock,
607 struct msghdr *m, size_t total_len)
609 struct msghdr my_msg;
611 struct iovec *curr_iov;
613 char __user *curr_start;
619 if (likely(total_len <= TIPC_MAX_USER_MSG_SIZE))
620 return send_packet(iocb, sock, m, total_len);
622 /* Can only send large data streams if already connected */
624 if (unlikely(sock->state != SS_CONNECTED)) {
625 if (sock->state == SS_DISCONNECTING)
632 * Send each iovec entry using one or more messages
634 * Note: This algorithm is good for the most likely case
635 * (i.e. one large iovec entry), but could be improved to pass sets
636 * of small iovec entries into send_packet().
639 curr_iov = m->msg_iov;
640 curr_iovlen = m->msg_iovlen;
641 my_msg.msg_iov = &my_iov;
642 my_msg.msg_iovlen = 1;
645 while (curr_iovlen--) {
646 curr_start = curr_iov->iov_base;
647 curr_left = curr_iov->iov_len;
650 bytes_to_send = (curr_left < TIPC_MAX_USER_MSG_SIZE)
651 ? curr_left : TIPC_MAX_USER_MSG_SIZE;
652 my_iov.iov_base = curr_start;
653 my_iov.iov_len = bytes_to_send;
654 if ((res = send_packet(iocb, sock, &my_msg, 0)) < 0) {
655 return bytes_sent ? bytes_sent : res;
657 curr_left -= bytes_to_send;
658 curr_start += bytes_to_send;
659 bytes_sent += bytes_to_send;
669 * auto_connect - complete connection setup to a remote port
670 * @sock: socket structure
671 * @tsock: TIPC-specific socket structure
672 * @msg: peer's response message
674 * Returns 0 on success, errno otherwise
677 static int auto_connect(struct socket *sock, struct tipc_sock *tsock,
678 struct tipc_msg *msg)
680 struct tipc_portid peer;
682 if (msg_errcode(msg)) {
683 sock->state = SS_DISCONNECTING;
684 return -ECONNREFUSED;
687 peer.ref = msg_origport(msg);
688 peer.node = msg_orignode(msg);
689 tipc_connect2port(tsock->p->ref, &peer);
690 tipc_set_portimportance(tsock->p->ref, msg_importance(msg));
691 sock->state = SS_CONNECTED;
696 * set_orig_addr - capture sender's address for received message
697 * @m: descriptor for message info
698 * @msg: received message header
700 * Note: Address is not captured if not requested by receiver.
703 static void set_orig_addr(struct msghdr *m, struct tipc_msg *msg)
705 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)m->msg_name;
708 addr->family = AF_TIPC;
709 addr->addrtype = TIPC_ADDR_ID;
710 addr->addr.id.ref = msg_origport(msg);
711 addr->addr.id.node = msg_orignode(msg);
712 addr->addr.name.domain = 0; /* could leave uninitialized */
713 addr->scope = 0; /* could leave uninitialized */
714 m->msg_namelen = sizeof(struct sockaddr_tipc);
719 * anc_data_recv - optionally capture ancillary data for received message
720 * @m: descriptor for message info
721 * @msg: received message header
722 * @tport: TIPC port associated with message
724 * Note: Ancillary data is not captured if not requested by receiver.
726 * Returns 0 if successful, otherwise errno
729 static int anc_data_recv(struct msghdr *m, struct tipc_msg *msg,
730 struct tipc_port *tport)
738 if (likely(m->msg_controllen == 0))
741 /* Optionally capture errored message object(s) */
743 err = msg ? msg_errcode(msg) : 0;
746 anc_data[1] = msg_data_sz(msg);
747 if ((res = put_cmsg(m, SOL_SOCKET, TIPC_ERRINFO, 8, anc_data)))
750 (res = put_cmsg(m, SOL_SOCKET, TIPC_RETDATA, anc_data[1],
755 /* Optionally capture message destination object */
757 dest_type = msg ? msg_type(msg) : TIPC_DIRECT_MSG;
761 anc_data[0] = msg_nametype(msg);
762 anc_data[1] = msg_namelower(msg);
763 anc_data[2] = msg_namelower(msg);
767 anc_data[0] = msg_nametype(msg);
768 anc_data[1] = msg_namelower(msg);
769 anc_data[2] = msg_nameupper(msg);
772 has_name = (tport->conn_type != 0);
773 anc_data[0] = tport->conn_type;
774 anc_data[1] = tport->conn_instance;
775 anc_data[2] = tport->conn_instance;
781 (res = put_cmsg(m, SOL_SOCKET, TIPC_DESTNAME, 12, anc_data)))
788 * recv_msg - receive packet-oriented message
790 * @m: descriptor for message info
791 * @buf_len: total size of user buffer area
792 * @flags: receive flags
794 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
795 * If the complete message doesn't fit in user area, truncate it.
797 * Returns size of returned message data, errno otherwise
800 static int recv_msg(struct kiocb *iocb, struct socket *sock,
801 struct msghdr *m, size_t buf_len, int flags)
803 struct tipc_sock *tsock = tipc_sk(sock->sk);
805 struct tipc_msg *msg;
811 /* Currently doesn't support receiving into multiple iovec entries */
813 if (m->msg_iovlen != 1)
816 /* Catch invalid receive attempts */
818 if (unlikely(!buf_len))
821 if (sock->type == SOCK_SEQPACKET) {
822 if (unlikely(sock->state == SS_UNCONNECTED))
824 if (unlikely((sock->state == SS_DISCONNECTING) &&
825 (skb_queue_len(&sock->sk->sk_receive_queue) == 0)))
829 /* Look for a message in receive queue; wait if necessary */
831 if (unlikely(down_interruptible(&tsock->sem)))
835 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
836 (flags & MSG_DONTWAIT))) {
841 if ((res = wait_event_interruptible(
843 ((q_len = skb_queue_len(&sock->sk->sk_receive_queue)) ||
844 (sock->state == SS_DISCONNECTING))) )) {
848 /* Catch attempt to receive on an already terminated connection */
849 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
856 /* Get access to first message in receive queue */
858 buf = skb_peek(&sock->sk->sk_receive_queue);
860 sz = msg_data_sz(msg);
861 err = msg_errcode(msg);
863 /* Complete connection setup for an implied connect */
865 if (unlikely(sock->state == SS_CONNECTING)) {
866 if ((res = auto_connect(sock, tsock, msg)))
870 /* Discard an empty non-errored message & try again */
872 if ((!sz) && (!err)) {
873 advance_queue(tsock);
877 /* Capture sender's address (optional) */
879 set_orig_addr(m, msg);
881 /* Capture ancillary data (optional) */
883 if ((res = anc_data_recv(m, msg, tsock->p)))
886 /* Capture message data (if valid) & compute return value (always) */
889 if (unlikely(buf_len < sz)) {
891 m->msg_flags |= MSG_TRUNC;
893 if (unlikely(copy_to_user(m->msg_iov->iov_base, msg_data(msg),
900 if ((sock->state == SS_READY) ||
901 ((err == TIPC_CONN_SHUTDOWN) || m->msg_control))
907 /* Consume received message (optional) */
909 if (likely(!(flags & MSG_PEEK))) {
910 if (unlikely(++tsock->p->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
911 tipc_acknowledge(tsock->p->ref, tsock->p->conn_unacked);
912 advance_queue(tsock);
920 * recv_stream - receive stream-oriented data
922 * @m: descriptor for message info
923 * @buf_len: total size of user buffer area
924 * @flags: receive flags
926 * Used for SOCK_STREAM messages only. If not enough data is available
927 * will optionally wait for more; never truncates data.
929 * Returns size of returned message data, errno otherwise
932 static int recv_stream(struct kiocb *iocb, struct socket *sock,
933 struct msghdr *m, size_t buf_len, int flags)
935 struct tipc_sock *tsock = tipc_sk(sock->sk);
937 struct tipc_msg *msg;
943 char *crs = m->msg_iov->iov_base;
944 unsigned char *buf_crs;
948 /* Currently doesn't support receiving into multiple iovec entries */
950 if (m->msg_iovlen != 1)
953 /* Catch invalid receive attempts */
955 if (unlikely(!buf_len))
958 if (unlikely(sock->state == SS_DISCONNECTING)) {
959 if (skb_queue_len(&sock->sk->sk_receive_queue) == 0)
961 } else if (unlikely(sock->state != SS_CONNECTED))
964 /* Look for a message in receive queue; wait if necessary */
966 if (unlikely(down_interruptible(&tsock->sem)))
970 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
971 (flags & MSG_DONTWAIT))) {
972 res = (sz_copied == 0) ? -EWOULDBLOCK : 0;
976 if ((res = wait_event_interruptible(
978 ((q_len = skb_queue_len(&sock->sk->sk_receive_queue)) ||
979 (sock->state == SS_DISCONNECTING))) )) {
983 /* Catch attempt to receive on an already terminated connection */
984 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
991 /* Get access to first message in receive queue */
993 buf = skb_peek(&sock->sk->sk_receive_queue);
995 sz = msg_data_sz(msg);
996 err = msg_errcode(msg);
998 /* Discard an empty non-errored message & try again */
1000 if ((!sz) && (!err)) {
1001 advance_queue(tsock);
1005 /* Optionally capture sender's address & ancillary data of first msg */
1007 if (sz_copied == 0) {
1008 set_orig_addr(m, msg);
1009 if ((res = anc_data_recv(m, msg, tsock->p)))
1013 /* Capture message data (if valid) & compute return value (always) */
1016 buf_crs = (unsigned char *)(TIPC_SKB_CB(buf)->handle);
1017 sz = buf->tail - buf_crs;
1019 needed = (buf_len - sz_copied);
1020 sz_to_copy = (sz <= needed) ? sz : needed;
1021 if (unlikely(copy_to_user(crs, buf_crs, sz_to_copy))) {
1025 sz_copied += sz_to_copy;
1027 if (sz_to_copy < sz) {
1028 if (!(flags & MSG_PEEK))
1029 TIPC_SKB_CB(buf)->handle = buf_crs + sz_to_copy;
1036 goto exit; /* can't add error msg to valid data */
1038 if ((err == TIPC_CONN_SHUTDOWN) || m->msg_control)
1044 /* Consume received message (optional) */
1046 if (likely(!(flags & MSG_PEEK))) {
1047 if (unlikely(++tsock->p->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1048 tipc_acknowledge(tsock->p->ref, tsock->p->conn_unacked);
1049 advance_queue(tsock);
1052 /* Loop around if more data is required */
1054 if ((sz_copied < buf_len) /* didn't get all requested data */
1055 && (flags & MSG_WAITALL) /* ... and need to wait for more */
1056 && (!(flags & MSG_PEEK)) /* ... and aren't just peeking at data */
1057 && (!err) /* ... and haven't reached a FIN */
1063 return res ? res : sz_copied;
1067 * queue_overloaded - test if queue overload condition exists
1068 * @queue_size: current size of queue
1069 * @base: nominal maximum size of queue
1070 * @msg: message to be added to queue
1072 * Returns 1 if queue is currently overloaded, 0 otherwise
1075 static int queue_overloaded(u32 queue_size, u32 base, struct tipc_msg *msg)
1078 u32 imp = msg_importance(msg);
1080 if (imp == TIPC_LOW_IMPORTANCE)
1082 else if (imp == TIPC_MEDIUM_IMPORTANCE)
1083 threshold = base * 2;
1084 else if (imp == TIPC_HIGH_IMPORTANCE)
1085 threshold = base * 100;
1089 if (msg_connected(msg))
1092 return (queue_size > threshold);
1096 * async_disconnect - wrapper function used to disconnect port
1097 * @portref: TIPC port reference (passed as pointer-sized value)
1100 static void async_disconnect(unsigned long portref)
1102 tipc_disconnect((u32)portref);
1106 * dispatch - handle arriving message
1107 * @tport: TIPC port that received message
1110 * Called with port locked. Must not take socket lock to avoid deadlock risk.
1112 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1115 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf)
1117 struct tipc_msg *msg = buf_msg(buf);
1118 struct tipc_sock *tsock = (struct tipc_sock *)tport->usr_handle;
1119 struct socket *sock;
1122 /* Reject message if socket is closing */
1125 return TIPC_ERR_NO_PORT;
1127 /* Reject message if it is wrong sort of message for socket */
1130 * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1131 * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1132 * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1134 sock = tsock->sk.sk_socket;
1135 if (sock->state == SS_READY) {
1136 if (msg_connected(msg)) {
1137 msg_dbg(msg, "dispatch filter 1\n");
1138 return TIPC_ERR_NO_PORT;
1141 if (msg_mcast(msg)) {
1142 msg_dbg(msg, "dispatch filter 2\n");
1143 return TIPC_ERR_NO_PORT;
1145 if (sock->state == SS_CONNECTED) {
1146 if (!msg_connected(msg)) {
1147 msg_dbg(msg, "dispatch filter 3\n");
1148 return TIPC_ERR_NO_PORT;
1151 else if (sock->state == SS_CONNECTING) {
1152 if (!msg_connected(msg) && (msg_errcode(msg) == 0)) {
1153 msg_dbg(msg, "dispatch filter 4\n");
1154 return TIPC_ERR_NO_PORT;
1157 else if (sock->state == SS_LISTENING) {
1158 if (msg_connected(msg) || msg_errcode(msg)) {
1159 msg_dbg(msg, "dispatch filter 5\n");
1160 return TIPC_ERR_NO_PORT;
1163 else if (sock->state == SS_DISCONNECTING) {
1164 msg_dbg(msg, "dispatch filter 6\n");
1165 return TIPC_ERR_NO_PORT;
1167 else /* (sock->state == SS_UNCONNECTED) */ {
1168 if (msg_connected(msg) || msg_errcode(msg)) {
1169 msg_dbg(msg, "dispatch filter 7\n");
1170 return TIPC_ERR_NO_PORT;
1175 /* Reject message if there isn't room to queue it */
1177 if (unlikely((u32)atomic_read(&tipc_queue_size) >
1178 OVERLOAD_LIMIT_BASE)) {
1179 if (queue_overloaded(atomic_read(&tipc_queue_size),
1180 OVERLOAD_LIMIT_BASE, msg))
1181 return TIPC_ERR_OVERLOAD;
1183 recv_q_len = skb_queue_len(&tsock->sk.sk_receive_queue);
1184 if (unlikely(recv_q_len > (OVERLOAD_LIMIT_BASE / 2))) {
1185 if (queue_overloaded(recv_q_len,
1186 OVERLOAD_LIMIT_BASE / 2, msg))
1187 return TIPC_ERR_OVERLOAD;
1190 /* Initiate connection termination for an incoming 'FIN' */
1192 if (unlikely(msg_errcode(msg) && (sock->state == SS_CONNECTED))) {
1193 sock->state = SS_DISCONNECTING;
1194 /* Note: Use signal since port lock is already taken! */
1195 tipc_k_signal((Handler)async_disconnect, tport->ref);
1198 /* Enqueue message (finally!) */
1200 msg_dbg(msg,"<DISP<: ");
1201 TIPC_SKB_CB(buf)->handle = msg_data(msg);
1202 atomic_inc(&tipc_queue_size);
1203 skb_queue_tail(&sock->sk->sk_receive_queue, buf);
1205 wake_up_interruptible(sock->sk->sk_sleep);
1210 * wakeupdispatch - wake up port after congestion
1211 * @tport: port to wakeup
1213 * Called with port lock on.
1216 static void wakeupdispatch(struct tipc_port *tport)
1218 struct tipc_sock *tsock = (struct tipc_sock *)tport->usr_handle;
1220 wake_up_interruptible(tsock->sk.sk_sleep);
1224 * connect - establish a connection to another TIPC port
1225 * @sock: socket structure
1226 * @dest: socket address for destination port
1227 * @destlen: size of socket address data structure
1230 * Returns 0 on success, errno otherwise
1233 static int connect(struct socket *sock, struct sockaddr *dest, int destlen,
1236 struct tipc_sock *tsock = tipc_sk(sock->sk);
1237 struct sockaddr_tipc *dst = (struct sockaddr_tipc *)dest;
1238 struct msghdr m = {NULL,};
1239 struct sk_buff *buf;
1240 struct tipc_msg *msg;
1243 /* For now, TIPC does not allow use of connect() with DGRAM or RDM types */
1245 if (sock->state == SS_READY)
1248 /* MOVE THE REST OF THIS ERROR CHECKING TO send_msg()? */
1249 if (sock->state == SS_LISTENING)
1251 if (sock->state == SS_CONNECTING)
1253 if (sock->state != SS_UNCONNECTED)
1256 if ((destlen < sizeof(*dst)) || (dst->family != AF_TIPC) ||
1257 ((dst->addrtype != TIPC_ADDR_NAME) && (dst->addrtype != TIPC_ADDR_ID)))
1260 /* Send a 'SYN-' to destination */
1263 if ((res = send_msg(NULL, sock, &m, 0)) < 0) {
1264 sock->state = SS_DISCONNECTING;
1268 if (down_interruptible(&tsock->sem))
1269 return -ERESTARTSYS;
1271 /* Wait for destination's 'ACK' response */
1273 res = wait_event_interruptible_timeout(*sock->sk->sk_sleep,
1274 skb_queue_len(&sock->sk->sk_receive_queue),
1275 sock->sk->sk_rcvtimeo);
1276 buf = skb_peek(&sock->sk->sk_receive_queue);
1279 res = auto_connect(sock, tsock, msg);
1281 if (!msg_data_sz(msg))
1282 advance_queue(tsock);
1288 { /* leave "res" unchanged */ }
1289 sock->state = SS_DISCONNECTING;
1297 * listen - allow socket to listen for incoming connections
1298 * @sock: socket structure
1301 * Returns 0 on success, errno otherwise
1304 static int listen(struct socket *sock, int len)
1306 /* REQUIRES SOCKET LOCKING OF SOME SORT? */
1308 if (sock->state == SS_READY)
1310 if (sock->state != SS_UNCONNECTED)
1312 sock->state = SS_LISTENING;
1317 * accept - wait for connection request
1318 * @sock: listening socket
1319 * @newsock: new socket that is to be connected
1320 * @flags: file-related flags associated with socket
1322 * Returns 0 on success, errno otherwise
1325 static int accept(struct socket *sock, struct socket *newsock, int flags)
1327 struct tipc_sock *tsock = tipc_sk(sock->sk);
1328 struct sk_buff *buf;
1331 if (sock->state == SS_READY)
1333 if (sock->state != SS_LISTENING)
1336 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
1337 (flags & O_NONBLOCK)))
1338 return -EWOULDBLOCK;
1340 if (down_interruptible(&tsock->sem))
1341 return -ERESTARTSYS;
1343 if (wait_event_interruptible(*sock->sk->sk_sleep,
1344 skb_queue_len(&sock->sk->sk_receive_queue))) {
1348 buf = skb_peek(&sock->sk->sk_receive_queue);
1350 res = tipc_create(newsock, 0);
1352 struct tipc_sock *new_tsock = tipc_sk(newsock->sk);
1353 struct tipc_portid id;
1354 struct tipc_msg *msg = buf_msg(buf);
1355 u32 new_ref = new_tsock->p->ref;
1357 id.ref = msg_origport(msg);
1358 id.node = msg_orignode(msg);
1359 tipc_connect2port(new_ref, &id);
1360 newsock->state = SS_CONNECTED;
1362 tipc_set_portimportance(new_ref, msg_importance(msg));
1363 if (msg_named(msg)) {
1364 new_tsock->p->conn_type = msg_nametype(msg);
1365 new_tsock->p->conn_instance = msg_nameinst(msg);
1369 * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1370 * Respond to 'SYN+' by queuing it on new socket.
1373 msg_dbg(msg,"<ACC<: ");
1374 if (!msg_data_sz(msg)) {
1375 struct msghdr m = {NULL,};
1377 send_packet(NULL, newsock, &m, 0);
1378 advance_queue(tsock);
1381 skb_dequeue(&sock->sk->sk_receive_queue);
1383 skb_queue_head(&newsock->sk->sk_receive_queue, buf);
1392 * shutdown - shutdown socket connection
1393 * @sock: socket structure
1394 * @how: direction to close (unused; always treated as read + write)
1396 * Terminates connection (if necessary), then purges socket's receive queue.
1398 * Returns 0 on success, errno otherwise
1401 static int shutdown(struct socket *sock, int how)
1403 struct tipc_sock* tsock = tipc_sk(sock->sk);
1404 struct sk_buff *buf;
1407 /* Could return -EINVAL for an invalid "how", but why bother? */
1409 if (down_interruptible(&tsock->sem))
1410 return -ERESTARTSYS;
1414 switch (sock->state) {
1417 /* Send 'FIN+' or 'FIN-' message to peer */
1421 if ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
1422 atomic_dec(&tipc_queue_size);
1423 if (TIPC_SKB_CB(buf)->handle != msg_data(buf_msg(buf))) {
1427 tipc_reject_msg(buf, TIPC_CONN_SHUTDOWN);
1430 tipc_shutdown(tsock->p->ref);
1436 case SS_DISCONNECTING:
1438 /* Discard any unreceived messages */
1440 while ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
1441 atomic_dec(&tipc_queue_size);
1444 tsock->p->conn_unacked = 0;
1449 sock->state = SS_DISCONNECTING;
1464 * setsockopt - set socket option
1465 * @sock: socket structure
1466 * @lvl: option level
1467 * @opt: option identifier
1468 * @ov: pointer to new option value
1469 * @ol: length of option value
1471 * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1472 * (to ease compatibility).
1474 * Returns 0 on success, errno otherwise
1477 static int setsockopt(struct socket *sock,
1478 int lvl, int opt, char __user *ov, int ol)
1480 struct tipc_sock *tsock = tipc_sk(sock->sk);
1484 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1486 if (lvl != SOL_TIPC)
1487 return -ENOPROTOOPT;
1488 if (ol < sizeof(value))
1490 if ((res = get_user(value, (u32 *)ov)))
1493 if (down_interruptible(&tsock->sem))
1494 return -ERESTARTSYS;
1497 case TIPC_IMPORTANCE:
1498 res = tipc_set_portimportance(tsock->p->ref, value);
1500 case TIPC_SRC_DROPPABLE:
1501 if (sock->type != SOCK_STREAM)
1502 res = tipc_set_portunreliable(tsock->p->ref, value);
1506 case TIPC_DEST_DROPPABLE:
1507 res = tipc_set_portunreturnable(tsock->p->ref, value);
1509 case TIPC_CONN_TIMEOUT:
1510 sock->sk->sk_rcvtimeo = (value * HZ / 1000);
1521 * getsockopt - get socket option
1522 * @sock: socket structure
1523 * @lvl: option level
1524 * @opt: option identifier
1525 * @ov: receptacle for option value
1526 * @ol: receptacle for length of option value
1528 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1529 * (to ease compatibility).
1531 * Returns 0 on success, errno otherwise
1534 static int getsockopt(struct socket *sock,
1535 int lvl, int opt, char __user *ov, int *ol)
1537 struct tipc_sock *tsock = tipc_sk(sock->sk);
1542 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1543 return put_user(0, ol);
1544 if (lvl != SOL_TIPC)
1545 return -ENOPROTOOPT;
1546 if ((res = get_user(len, ol)))
1549 if (down_interruptible(&tsock->sem))
1550 return -ERESTARTSYS;
1553 case TIPC_IMPORTANCE:
1554 res = tipc_portimportance(tsock->p->ref, &value);
1556 case TIPC_SRC_DROPPABLE:
1557 res = tipc_portunreliable(tsock->p->ref, &value);
1559 case TIPC_DEST_DROPPABLE:
1560 res = tipc_portunreturnable(tsock->p->ref, &value);
1562 case TIPC_CONN_TIMEOUT:
1563 value = (sock->sk->sk_rcvtimeo * 1000) / HZ;
1572 else if (len < sizeof(value)) {
1575 else if ((res = copy_to_user(ov, &value, sizeof(value)))) {
1576 /* couldn't return value */
1579 res = put_user(sizeof(value), ol);
1587 * Placeholders for non-implemented functionality
1589 * Returns error code (POSIX-compliant where defined)
1592 static int ioctl(struct socket *s, u32 cmd, unsigned long arg)
1597 static int no_mmap(struct file *file, struct socket *sock,
1598 struct vm_area_struct *vma)
1602 static ssize_t no_sendpage(struct socket *sock, struct page *page,
1603 int offset, size_t size, int flags)
1608 static int no_skpair(struct socket *s1, struct socket *s2)
1614 * Protocol switches for the various types of TIPC sockets
1617 static struct proto_ops msg_ops = {
1618 .owner = THIS_MODULE,
1623 .socketpair = no_skpair,
1625 .getname = get_name,
1629 .shutdown = shutdown,
1630 .setsockopt = setsockopt,
1631 .getsockopt = getsockopt,
1632 .sendmsg = send_msg,
1633 .recvmsg = recv_msg,
1635 .sendpage = no_sendpage
1638 static struct proto_ops packet_ops = {
1639 .owner = THIS_MODULE,
1644 .socketpair = no_skpair,
1646 .getname = get_name,
1650 .shutdown = shutdown,
1651 .setsockopt = setsockopt,
1652 .getsockopt = getsockopt,
1653 .sendmsg = send_packet,
1654 .recvmsg = recv_msg,
1656 .sendpage = no_sendpage
1659 static struct proto_ops stream_ops = {
1660 .owner = THIS_MODULE,
1665 .socketpair = no_skpair,
1667 .getname = get_name,
1671 .shutdown = shutdown,
1672 .setsockopt = setsockopt,
1673 .getsockopt = getsockopt,
1674 .sendmsg = send_stream,
1675 .recvmsg = recv_stream,
1677 .sendpage = no_sendpage
1680 static struct net_proto_family tipc_family_ops = {
1681 .owner = THIS_MODULE,
1683 .create = tipc_create
1686 static struct proto tipc_proto = {
1688 .owner = THIS_MODULE,
1689 .obj_size = sizeof(struct tipc_sock)
1693 * tipc_socket_init - initialize TIPC socket interface
1695 * Returns 0 on success, errno otherwise
1697 int tipc_socket_init(void)
1701 res = proto_register(&tipc_proto, 1);
1703 err("Failed to register TIPC protocol type\n");
1707 res = sock_register(&tipc_family_ops);
1709 err("Failed to register TIPC socket type\n");
1710 proto_unregister(&tipc_proto);
1714 sockets_enabled = 1;
1720 * tipc_socket_stop - stop TIPC socket interface
1722 void tipc_socket_stop(void)
1724 if (!sockets_enabled)
1727 sockets_enabled = 0;
1728 sock_unregister(tipc_family_ops.family);
1729 proto_unregister(&tipc_proto);