2 * net/tipc/socket.c: TIPC socket API
4 * Copyright (c) 2001-2007, Ericsson AB
5 * Copyright (c) 2004-2007, 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((m->msg_namelen < sizeof(*dest)) ||
459 (dest->family != AF_TIPC)))
462 needs_conn = (sock->state != SS_READY);
463 if (unlikely(needs_conn)) {
464 if (sock->state == SS_LISTENING)
466 if (sock->state != SS_UNCONNECTED)
468 if ((tsock->p->published) ||
469 ((sock->type == SOCK_STREAM) && (total_len != 0)))
471 if (dest->addrtype == TIPC_ADDR_NAME) {
472 tsock->p->conn_type = dest->addr.name.name.type;
473 tsock->p->conn_instance = dest->addr.name.name.instance;
477 if (down_interruptible(&tsock->sem))
482 /* Abort any pending connection attempts (very unlikely) */
484 while ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
485 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
486 atomic_dec(&tipc_queue_size);
489 sock->state = SS_CONNECTING;
493 if (dest->addrtype == TIPC_ADDR_NAME) {
494 if ((res = dest_name_check(dest, m)))
496 res = tipc_send2name(tsock->p->ref,
497 &dest->addr.name.name,
498 dest->addr.name.domain,
502 else if (dest->addrtype == TIPC_ADDR_ID) {
503 res = tipc_send2port(tsock->p->ref,
508 else if (dest->addrtype == TIPC_ADDR_MCAST) {
513 if ((res = dest_name_check(dest, m)))
515 res = tipc_multicast(tsock->p->ref,
521 if (likely(res != -ELINKCONG)) {
526 if (m->msg_flags & MSG_DONTWAIT) {
530 if (wait_event_interruptible(*sock->sk->sk_sleep,
531 !tsock->p->congested)) {
539 * send_packet - send a connection-oriented message
541 * @sock: socket structure
542 * @m: message to send
543 * @total_len: length of message
545 * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
547 * Returns the number of bytes sent on success, or errno otherwise
550 static int send_packet(struct kiocb *iocb, struct socket *sock,
551 struct msghdr *m, size_t total_len)
553 struct tipc_sock *tsock = tipc_sk(sock->sk);
554 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
557 /* Handle implied connection establishment */
560 return send_msg(iocb, sock, m, total_len);
562 if (down_interruptible(&tsock->sem)) {
567 if (unlikely(sock->state != SS_CONNECTED)) {
568 if (sock->state == SS_DISCONNECTING)
575 res = tipc_send(tsock->p->ref, m->msg_iovlen, m->msg_iov);
576 if (likely(res != -ELINKCONG)) {
581 if (m->msg_flags & MSG_DONTWAIT) {
585 if (wait_event_interruptible(*sock->sk->sk_sleep,
586 !tsock->p->congested)) {
594 * send_stream - send stream-oriented data
596 * @sock: socket structure
598 * @total_len: total length of data to be sent
600 * Used for SOCK_STREAM data.
602 * Returns the number of bytes sent on success (or partial success),
603 * or errno if no data sent
607 static int send_stream(struct kiocb *iocb, struct socket *sock,
608 struct msghdr *m, size_t total_len)
610 struct tipc_port *tport;
611 struct msghdr my_msg;
613 struct iovec *curr_iov;
615 char __user *curr_start;
622 /* Handle special cases where there is no connection */
624 if (unlikely(sock->state != SS_CONNECTED)) {
625 if (sock->state == SS_UNCONNECTED)
626 return send_packet(iocb, sock, m, total_len);
627 else if (sock->state == SS_DISCONNECTING)
633 if (unlikely(m->msg_name))
637 * Send each iovec entry using one or more messages
639 * Note: This algorithm is good for the most likely case
640 * (i.e. one large iovec entry), but could be improved to pass sets
641 * of small iovec entries into send_packet().
644 curr_iov = m->msg_iov;
645 curr_iovlen = m->msg_iovlen;
646 my_msg.msg_iov = &my_iov;
647 my_msg.msg_iovlen = 1;
648 my_msg.msg_flags = m->msg_flags;
649 my_msg.msg_name = NULL;
652 tport = tipc_sk(sock->sk)->p;
653 hdr_size = msg_hdr_sz(&tport->phdr);
655 while (curr_iovlen--) {
656 curr_start = curr_iov->iov_base;
657 curr_left = curr_iov->iov_len;
660 bytes_to_send = tport->max_pkt - hdr_size;
661 if (bytes_to_send > TIPC_MAX_USER_MSG_SIZE)
662 bytes_to_send = TIPC_MAX_USER_MSG_SIZE;
663 if (curr_left < bytes_to_send)
664 bytes_to_send = curr_left;
665 my_iov.iov_base = curr_start;
666 my_iov.iov_len = bytes_to_send;
667 if ((res = send_packet(iocb, sock, &my_msg, 0)) < 0) {
672 curr_left -= bytes_to_send;
673 curr_start += bytes_to_send;
674 bytes_sent += bytes_to_send;
684 * auto_connect - complete connection setup to a remote port
685 * @sock: socket structure
686 * @tsock: TIPC-specific socket structure
687 * @msg: peer's response message
689 * Returns 0 on success, errno otherwise
692 static int auto_connect(struct socket *sock, struct tipc_sock *tsock,
693 struct tipc_msg *msg)
695 struct tipc_portid peer;
697 if (msg_errcode(msg)) {
698 sock->state = SS_DISCONNECTING;
699 return -ECONNREFUSED;
702 peer.ref = msg_origport(msg);
703 peer.node = msg_orignode(msg);
704 tipc_connect2port(tsock->p->ref, &peer);
705 tipc_set_portimportance(tsock->p->ref, msg_importance(msg));
706 sock->state = SS_CONNECTED;
711 * set_orig_addr - capture sender's address for received message
712 * @m: descriptor for message info
713 * @msg: received message header
715 * Note: Address is not captured if not requested by receiver.
718 static void set_orig_addr(struct msghdr *m, struct tipc_msg *msg)
720 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)m->msg_name;
723 addr->family = AF_TIPC;
724 addr->addrtype = TIPC_ADDR_ID;
725 addr->addr.id.ref = msg_origport(msg);
726 addr->addr.id.node = msg_orignode(msg);
727 addr->addr.name.domain = 0; /* could leave uninitialized */
728 addr->scope = 0; /* could leave uninitialized */
729 m->msg_namelen = sizeof(struct sockaddr_tipc);
734 * anc_data_recv - optionally capture ancillary data for received message
735 * @m: descriptor for message info
736 * @msg: received message header
737 * @tport: TIPC port associated with message
739 * Note: Ancillary data is not captured if not requested by receiver.
741 * Returns 0 if successful, otherwise errno
744 static int anc_data_recv(struct msghdr *m, struct tipc_msg *msg,
745 struct tipc_port *tport)
753 if (likely(m->msg_controllen == 0))
756 /* Optionally capture errored message object(s) */
758 err = msg ? msg_errcode(msg) : 0;
761 anc_data[1] = msg_data_sz(msg);
762 if ((res = put_cmsg(m, SOL_TIPC, TIPC_ERRINFO, 8, anc_data)))
765 (res = put_cmsg(m, SOL_TIPC, TIPC_RETDATA, anc_data[1],
770 /* Optionally capture message destination object */
772 dest_type = msg ? msg_type(msg) : TIPC_DIRECT_MSG;
776 anc_data[0] = msg_nametype(msg);
777 anc_data[1] = msg_namelower(msg);
778 anc_data[2] = msg_namelower(msg);
782 anc_data[0] = msg_nametype(msg);
783 anc_data[1] = msg_namelower(msg);
784 anc_data[2] = msg_nameupper(msg);
787 has_name = (tport->conn_type != 0);
788 anc_data[0] = tport->conn_type;
789 anc_data[1] = tport->conn_instance;
790 anc_data[2] = tport->conn_instance;
796 (res = put_cmsg(m, SOL_TIPC, TIPC_DESTNAME, 12, anc_data)))
803 * recv_msg - receive packet-oriented message
805 * @m: descriptor for message info
806 * @buf_len: total size of user buffer area
807 * @flags: receive flags
809 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
810 * If the complete message doesn't fit in user area, truncate it.
812 * Returns size of returned message data, errno otherwise
815 static int recv_msg(struct kiocb *iocb, struct socket *sock,
816 struct msghdr *m, size_t buf_len, int flags)
818 struct tipc_sock *tsock = tipc_sk(sock->sk);
820 struct tipc_msg *msg;
826 /* Currently doesn't support receiving into multiple iovec entries */
828 if (m->msg_iovlen != 1)
831 /* Catch invalid receive attempts */
833 if (unlikely(!buf_len))
836 if (sock->type == SOCK_SEQPACKET) {
837 if (unlikely(sock->state == SS_UNCONNECTED))
839 if (unlikely((sock->state == SS_DISCONNECTING) &&
840 (skb_queue_len(&sock->sk->sk_receive_queue) == 0)))
844 /* Look for a message in receive queue; wait if necessary */
846 if (unlikely(down_interruptible(&tsock->sem)))
850 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
851 (flags & MSG_DONTWAIT))) {
856 if ((res = wait_event_interruptible(
858 ((q_len = skb_queue_len(&sock->sk->sk_receive_queue)) ||
859 (sock->state == SS_DISCONNECTING))) )) {
863 /* Catch attempt to receive on an already terminated connection */
864 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
871 /* Get access to first message in receive queue */
873 buf = skb_peek(&sock->sk->sk_receive_queue);
875 sz = msg_data_sz(msg);
876 err = msg_errcode(msg);
878 /* Complete connection setup for an implied connect */
880 if (unlikely(sock->state == SS_CONNECTING)) {
881 if ((res = auto_connect(sock, tsock, msg)))
885 /* Discard an empty non-errored message & try again */
887 if ((!sz) && (!err)) {
888 advance_queue(tsock);
892 /* Capture sender's address (optional) */
894 set_orig_addr(m, msg);
896 /* Capture ancillary data (optional) */
898 if ((res = anc_data_recv(m, msg, tsock->p)))
901 /* Capture message data (if valid) & compute return value (always) */
904 if (unlikely(buf_len < sz)) {
906 m->msg_flags |= MSG_TRUNC;
908 if (unlikely(copy_to_user(m->msg_iov->iov_base, msg_data(msg),
915 if ((sock->state == SS_READY) ||
916 ((err == TIPC_CONN_SHUTDOWN) || m->msg_control))
922 /* Consume received message (optional) */
924 if (likely(!(flags & MSG_PEEK))) {
925 if (unlikely(++tsock->p->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
926 tipc_acknowledge(tsock->p->ref, tsock->p->conn_unacked);
927 advance_queue(tsock);
935 * recv_stream - receive stream-oriented data
937 * @m: descriptor for message info
938 * @buf_len: total size of user buffer area
939 * @flags: receive flags
941 * Used for SOCK_STREAM messages only. If not enough data is available
942 * will optionally wait for more; never truncates data.
944 * Returns size of returned message data, errno otherwise
947 static int recv_stream(struct kiocb *iocb, struct socket *sock,
948 struct msghdr *m, size_t buf_len, int flags)
950 struct tipc_sock *tsock = tipc_sk(sock->sk);
952 struct tipc_msg *msg;
958 char __user *crs = m->msg_iov->iov_base;
959 unsigned char *buf_crs;
963 /* Currently doesn't support receiving into multiple iovec entries */
965 if (m->msg_iovlen != 1)
968 /* Catch invalid receive attempts */
970 if (unlikely(!buf_len))
973 if (unlikely(sock->state == SS_DISCONNECTING)) {
974 if (skb_queue_len(&sock->sk->sk_receive_queue) == 0)
976 } else if (unlikely(sock->state != SS_CONNECTED))
979 /* Look for a message in receive queue; wait if necessary */
981 if (unlikely(down_interruptible(&tsock->sem)))
985 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
986 (flags & MSG_DONTWAIT))) {
991 if ((res = wait_event_interruptible(
993 ((q_len = skb_queue_len(&sock->sk->sk_receive_queue)) ||
994 (sock->state == SS_DISCONNECTING))) )) {
998 /* Catch attempt to receive on an already terminated connection */
999 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
1006 /* Get access to first message in receive queue */
1008 buf = skb_peek(&sock->sk->sk_receive_queue);
1010 sz = msg_data_sz(msg);
1011 err = msg_errcode(msg);
1013 /* Discard an empty non-errored message & try again */
1015 if ((!sz) && (!err)) {
1016 advance_queue(tsock);
1020 /* Optionally capture sender's address & ancillary data of first msg */
1022 if (sz_copied == 0) {
1023 set_orig_addr(m, msg);
1024 if ((res = anc_data_recv(m, msg, tsock->p)))
1028 /* Capture message data (if valid) & compute return value (always) */
1031 buf_crs = (unsigned char *)(TIPC_SKB_CB(buf)->handle);
1032 sz = skb_tail_pointer(buf) - buf_crs;
1034 needed = (buf_len - sz_copied);
1035 sz_to_copy = (sz <= needed) ? sz : needed;
1036 if (unlikely(copy_to_user(crs, buf_crs, sz_to_copy))) {
1040 sz_copied += sz_to_copy;
1042 if (sz_to_copy < sz) {
1043 if (!(flags & MSG_PEEK))
1044 TIPC_SKB_CB(buf)->handle = buf_crs + sz_to_copy;
1051 goto exit; /* can't add error msg to valid data */
1053 if ((err == TIPC_CONN_SHUTDOWN) || m->msg_control)
1059 /* Consume received message (optional) */
1061 if (likely(!(flags & MSG_PEEK))) {
1062 if (unlikely(++tsock->p->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1063 tipc_acknowledge(tsock->p->ref, tsock->p->conn_unacked);
1064 advance_queue(tsock);
1067 /* Loop around if more data is required */
1069 if ((sz_copied < buf_len) /* didn't get all requested data */
1070 && (flags & MSG_WAITALL) /* ... and need to wait for more */
1071 && (!(flags & MSG_PEEK)) /* ... and aren't just peeking at data */
1072 && (!err) /* ... and haven't reached a FIN */
1078 return sz_copied ? sz_copied : res;
1082 * queue_overloaded - test if queue overload condition exists
1083 * @queue_size: current size of queue
1084 * @base: nominal maximum size of queue
1085 * @msg: message to be added to queue
1087 * Returns 1 if queue is currently overloaded, 0 otherwise
1090 static int queue_overloaded(u32 queue_size, u32 base, struct tipc_msg *msg)
1093 u32 imp = msg_importance(msg);
1095 if (imp == TIPC_LOW_IMPORTANCE)
1097 else if (imp == TIPC_MEDIUM_IMPORTANCE)
1098 threshold = base * 2;
1099 else if (imp == TIPC_HIGH_IMPORTANCE)
1100 threshold = base * 100;
1104 if (msg_connected(msg))
1107 return (queue_size > threshold);
1111 * async_disconnect - wrapper function used to disconnect port
1112 * @portref: TIPC port reference (passed as pointer-sized value)
1115 static void async_disconnect(unsigned long portref)
1117 tipc_disconnect((u32)portref);
1121 * dispatch - handle arriving message
1122 * @tport: TIPC port that received message
1125 * Called with port locked. Must not take socket lock to avoid deadlock risk.
1127 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1130 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf)
1132 struct tipc_msg *msg = buf_msg(buf);
1133 struct tipc_sock *tsock = (struct tipc_sock *)tport->usr_handle;
1134 struct socket *sock;
1137 /* Reject message if socket is closing */
1140 return TIPC_ERR_NO_PORT;
1142 /* Reject message if it is wrong sort of message for socket */
1145 * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1146 * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1147 * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1149 sock = tsock->sk.sk_socket;
1150 if (sock->state == SS_READY) {
1151 if (msg_connected(msg)) {
1152 msg_dbg(msg, "dispatch filter 1\n");
1153 return TIPC_ERR_NO_PORT;
1156 if (msg_mcast(msg)) {
1157 msg_dbg(msg, "dispatch filter 2\n");
1158 return TIPC_ERR_NO_PORT;
1160 if (sock->state == SS_CONNECTED) {
1161 if (!msg_connected(msg)) {
1162 msg_dbg(msg, "dispatch filter 3\n");
1163 return TIPC_ERR_NO_PORT;
1166 else if (sock->state == SS_CONNECTING) {
1167 if (!msg_connected(msg) && (msg_errcode(msg) == 0)) {
1168 msg_dbg(msg, "dispatch filter 4\n");
1169 return TIPC_ERR_NO_PORT;
1172 else if (sock->state == SS_LISTENING) {
1173 if (msg_connected(msg) || msg_errcode(msg)) {
1174 msg_dbg(msg, "dispatch filter 5\n");
1175 return TIPC_ERR_NO_PORT;
1178 else if (sock->state == SS_DISCONNECTING) {
1179 msg_dbg(msg, "dispatch filter 6\n");
1180 return TIPC_ERR_NO_PORT;
1182 else /* (sock->state == SS_UNCONNECTED) */ {
1183 if (msg_connected(msg) || msg_errcode(msg)) {
1184 msg_dbg(msg, "dispatch filter 7\n");
1185 return TIPC_ERR_NO_PORT;
1190 /* Reject message if there isn't room to queue it */
1192 if (unlikely((u32)atomic_read(&tipc_queue_size) >
1193 OVERLOAD_LIMIT_BASE)) {
1194 if (queue_overloaded(atomic_read(&tipc_queue_size),
1195 OVERLOAD_LIMIT_BASE, msg))
1196 return TIPC_ERR_OVERLOAD;
1198 recv_q_len = skb_queue_len(&tsock->sk.sk_receive_queue);
1199 if (unlikely(recv_q_len > (OVERLOAD_LIMIT_BASE / 2))) {
1200 if (queue_overloaded(recv_q_len,
1201 OVERLOAD_LIMIT_BASE / 2, msg))
1202 return TIPC_ERR_OVERLOAD;
1205 /* Initiate connection termination for an incoming 'FIN' */
1207 if (unlikely(msg_errcode(msg) && (sock->state == SS_CONNECTED))) {
1208 sock->state = SS_DISCONNECTING;
1209 /* Note: Use signal since port lock is already taken! */
1210 tipc_k_signal((Handler)async_disconnect, tport->ref);
1213 /* Enqueue message (finally!) */
1215 msg_dbg(msg,"<DISP<: ");
1216 TIPC_SKB_CB(buf)->handle = msg_data(msg);
1217 atomic_inc(&tipc_queue_size);
1218 skb_queue_tail(&sock->sk->sk_receive_queue, buf);
1220 if (waitqueue_active(sock->sk->sk_sleep))
1221 wake_up_interruptible(sock->sk->sk_sleep);
1226 * wakeupdispatch - wake up port after congestion
1227 * @tport: port to wakeup
1229 * Called with port lock on.
1232 static void wakeupdispatch(struct tipc_port *tport)
1234 struct tipc_sock *tsock = (struct tipc_sock *)tport->usr_handle;
1236 if (waitqueue_active(tsock->sk.sk_sleep))
1237 wake_up_interruptible(tsock->sk.sk_sleep);
1241 * connect - establish a connection to another TIPC port
1242 * @sock: socket structure
1243 * @dest: socket address for destination port
1244 * @destlen: size of socket address data structure
1247 * Returns 0 on success, errno otherwise
1250 static int connect(struct socket *sock, struct sockaddr *dest, int destlen,
1253 struct tipc_sock *tsock = tipc_sk(sock->sk);
1254 struct sockaddr_tipc *dst = (struct sockaddr_tipc *)dest;
1255 struct msghdr m = {NULL,};
1256 struct sk_buff *buf;
1257 struct tipc_msg *msg;
1260 /* For now, TIPC does not allow use of connect() with DGRAM or RDM types */
1262 if (sock->state == SS_READY)
1265 /* Issue Posix-compliant error code if socket is in the wrong state */
1267 if (sock->state == SS_LISTENING)
1269 if (sock->state == SS_CONNECTING)
1271 if (sock->state != SS_UNCONNECTED)
1275 * Reject connection attempt using multicast address
1277 * Note: send_msg() validates the rest of the address fields,
1278 * so there's no need to do it here
1281 if (dst->addrtype == TIPC_ADDR_MCAST)
1284 /* Send a 'SYN-' to destination */
1287 m.msg_namelen = destlen;
1288 if ((res = send_msg(NULL, sock, &m, 0)) < 0) {
1289 sock->state = SS_DISCONNECTING;
1293 if (down_interruptible(&tsock->sem))
1294 return -ERESTARTSYS;
1296 /* Wait for destination's 'ACK' response */
1298 res = wait_event_interruptible_timeout(*sock->sk->sk_sleep,
1299 skb_queue_len(&sock->sk->sk_receive_queue),
1300 sock->sk->sk_rcvtimeo);
1301 buf = skb_peek(&sock->sk->sk_receive_queue);
1304 res = auto_connect(sock, tsock, msg);
1306 if (!msg_data_sz(msg))
1307 advance_queue(tsock);
1313 { /* leave "res" unchanged */ }
1314 sock->state = SS_DISCONNECTING;
1322 * listen - allow socket to listen for incoming connections
1323 * @sock: socket structure
1326 * Returns 0 on success, errno otherwise
1329 static int listen(struct socket *sock, int len)
1331 /* REQUIRES SOCKET LOCKING OF SOME SORT? */
1333 if (sock->state == SS_READY)
1335 if (sock->state != SS_UNCONNECTED)
1337 sock->state = SS_LISTENING;
1342 * accept - wait for connection request
1343 * @sock: listening socket
1344 * @newsock: new socket that is to be connected
1345 * @flags: file-related flags associated with socket
1347 * Returns 0 on success, errno otherwise
1350 static int accept(struct socket *sock, struct socket *newsock, int flags)
1352 struct tipc_sock *tsock = tipc_sk(sock->sk);
1353 struct sk_buff *buf;
1356 if (sock->state == SS_READY)
1358 if (sock->state != SS_LISTENING)
1361 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
1362 (flags & O_NONBLOCK)))
1363 return -EWOULDBLOCK;
1365 if (down_interruptible(&tsock->sem))
1366 return -ERESTARTSYS;
1368 if (wait_event_interruptible(*sock->sk->sk_sleep,
1369 skb_queue_len(&sock->sk->sk_receive_queue))) {
1373 buf = skb_peek(&sock->sk->sk_receive_queue);
1375 res = tipc_create(newsock, 0);
1377 struct tipc_sock *new_tsock = tipc_sk(newsock->sk);
1378 struct tipc_portid id;
1379 struct tipc_msg *msg = buf_msg(buf);
1380 u32 new_ref = new_tsock->p->ref;
1382 id.ref = msg_origport(msg);
1383 id.node = msg_orignode(msg);
1384 tipc_connect2port(new_ref, &id);
1385 newsock->state = SS_CONNECTED;
1387 tipc_set_portimportance(new_ref, msg_importance(msg));
1388 if (msg_named(msg)) {
1389 new_tsock->p->conn_type = msg_nametype(msg);
1390 new_tsock->p->conn_instance = msg_nameinst(msg);
1394 * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1395 * Respond to 'SYN+' by queuing it on new socket.
1398 msg_dbg(msg,"<ACC<: ");
1399 if (!msg_data_sz(msg)) {
1400 struct msghdr m = {NULL,};
1402 send_packet(NULL, newsock, &m, 0);
1403 advance_queue(tsock);
1406 skb_dequeue(&sock->sk->sk_receive_queue);
1408 skb_queue_head(&newsock->sk->sk_receive_queue, buf);
1417 * shutdown - shutdown socket connection
1418 * @sock: socket structure
1419 * @how: direction to close (unused; always treated as read + write)
1421 * Terminates connection (if necessary), then purges socket's receive queue.
1423 * Returns 0 on success, errno otherwise
1426 static int shutdown(struct socket *sock, int how)
1428 struct tipc_sock* tsock = tipc_sk(sock->sk);
1429 struct sk_buff *buf;
1432 /* Could return -EINVAL for an invalid "how", but why bother? */
1434 if (down_interruptible(&tsock->sem))
1435 return -ERESTARTSYS;
1439 switch (sock->state) {
1442 /* Send 'FIN+' or 'FIN-' message to peer */
1446 if ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
1447 atomic_dec(&tipc_queue_size);
1448 if (TIPC_SKB_CB(buf)->handle != msg_data(buf_msg(buf))) {
1452 tipc_reject_msg(buf, TIPC_CONN_SHUTDOWN);
1455 tipc_shutdown(tsock->p->ref);
1461 case SS_DISCONNECTING:
1463 /* Discard any unreceived messages */
1465 while ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
1466 atomic_dec(&tipc_queue_size);
1469 tsock->p->conn_unacked = 0;
1474 sock->state = SS_DISCONNECTING;
1489 * setsockopt - set socket option
1490 * @sock: socket structure
1491 * @lvl: option level
1492 * @opt: option identifier
1493 * @ov: pointer to new option value
1494 * @ol: length of option value
1496 * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1497 * (to ease compatibility).
1499 * Returns 0 on success, errno otherwise
1502 static int setsockopt(struct socket *sock,
1503 int lvl, int opt, char __user *ov, int ol)
1505 struct tipc_sock *tsock = tipc_sk(sock->sk);
1509 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1511 if (lvl != SOL_TIPC)
1512 return -ENOPROTOOPT;
1513 if (ol < sizeof(value))
1515 if ((res = get_user(value, (u32 __user *)ov)))
1518 if (down_interruptible(&tsock->sem))
1519 return -ERESTARTSYS;
1522 case TIPC_IMPORTANCE:
1523 res = tipc_set_portimportance(tsock->p->ref, value);
1525 case TIPC_SRC_DROPPABLE:
1526 if (sock->type != SOCK_STREAM)
1527 res = tipc_set_portunreliable(tsock->p->ref, value);
1531 case TIPC_DEST_DROPPABLE:
1532 res = tipc_set_portunreturnable(tsock->p->ref, value);
1534 case TIPC_CONN_TIMEOUT:
1535 sock->sk->sk_rcvtimeo = (value * HZ / 1000);
1546 * getsockopt - get socket option
1547 * @sock: socket structure
1548 * @lvl: option level
1549 * @opt: option identifier
1550 * @ov: receptacle for option value
1551 * @ol: receptacle for length of option value
1553 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1554 * (to ease compatibility).
1556 * Returns 0 on success, errno otherwise
1559 static int getsockopt(struct socket *sock,
1560 int lvl, int opt, char __user *ov, int __user *ol)
1562 struct tipc_sock *tsock = tipc_sk(sock->sk);
1567 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1568 return put_user(0, ol);
1569 if (lvl != SOL_TIPC)
1570 return -ENOPROTOOPT;
1571 if ((res = get_user(len, ol)))
1574 if (down_interruptible(&tsock->sem))
1575 return -ERESTARTSYS;
1578 case TIPC_IMPORTANCE:
1579 res = tipc_portimportance(tsock->p->ref, &value);
1581 case TIPC_SRC_DROPPABLE:
1582 res = tipc_portunreliable(tsock->p->ref, &value);
1584 case TIPC_DEST_DROPPABLE:
1585 res = tipc_portunreturnable(tsock->p->ref, &value);
1587 case TIPC_CONN_TIMEOUT:
1588 value = (sock->sk->sk_rcvtimeo * 1000) / HZ;
1597 else if (len < sizeof(value)) {
1600 else if ((res = copy_to_user(ov, &value, sizeof(value)))) {
1601 /* couldn't return value */
1604 res = put_user(sizeof(value), ol);
1612 * Protocol switches for the various types of TIPC sockets
1615 static struct proto_ops msg_ops = {
1616 .owner = THIS_MODULE,
1621 .socketpair = sock_no_socketpair,
1623 .getname = get_name,
1625 .ioctl = sock_no_ioctl,
1627 .shutdown = shutdown,
1628 .setsockopt = setsockopt,
1629 .getsockopt = getsockopt,
1630 .sendmsg = send_msg,
1631 .recvmsg = recv_msg,
1632 .mmap = sock_no_mmap,
1633 .sendpage = sock_no_sendpage
1636 static struct proto_ops packet_ops = {
1637 .owner = THIS_MODULE,
1642 .socketpair = sock_no_socketpair,
1644 .getname = get_name,
1646 .ioctl = sock_no_ioctl,
1648 .shutdown = shutdown,
1649 .setsockopt = setsockopt,
1650 .getsockopt = getsockopt,
1651 .sendmsg = send_packet,
1652 .recvmsg = recv_msg,
1653 .mmap = sock_no_mmap,
1654 .sendpage = sock_no_sendpage
1657 static struct proto_ops stream_ops = {
1658 .owner = THIS_MODULE,
1663 .socketpair = sock_no_socketpair,
1665 .getname = get_name,
1667 .ioctl = sock_no_ioctl,
1669 .shutdown = shutdown,
1670 .setsockopt = setsockopt,
1671 .getsockopt = getsockopt,
1672 .sendmsg = send_stream,
1673 .recvmsg = recv_stream,
1674 .mmap = sock_no_mmap,
1675 .sendpage = sock_no_sendpage
1678 static struct net_proto_family tipc_family_ops = {
1679 .owner = THIS_MODULE,
1681 .create = tipc_create
1684 static struct proto tipc_proto = {
1686 .owner = THIS_MODULE,
1687 .obj_size = sizeof(struct tipc_sock)
1691 * tipc_socket_init - initialize TIPC socket interface
1693 * Returns 0 on success, errno otherwise
1695 int tipc_socket_init(void)
1699 res = proto_register(&tipc_proto, 1);
1701 err("Failed to register TIPC protocol type\n");
1705 res = sock_register(&tipc_family_ops);
1707 err("Failed to register TIPC socket type\n");
1708 proto_unregister(&tipc_proto);
1712 sockets_enabled = 1;
1718 * tipc_socket_stop - stop TIPC socket interface
1720 void tipc_socket_stop(void)
1722 if (!sockets_enabled)
1725 sockets_enabled = 0;
1726 sock_unregister(tipc_family_ops.family);
1727 proto_unregister(&tipc_proto);