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 ((sock->type != SOCK_STREAM) &&
173 (sock->type != SOCK_SEQPACKET) &&
174 (sock->type != SOCK_DGRAM) &&
175 (sock->type != SOCK_RDM))
178 if (unlikely(protocol != 0))
179 return -EPROTONOSUPPORT;
181 ref = tipc_createport_raw(NULL, &dispatch, &wakeupdispatch, TIPC_LOW_IMPORTANCE);
185 sock->state = SS_UNCONNECTED;
187 switch (sock->type) {
189 sock->ops = &stream_ops;
192 sock->ops = &packet_ops;
195 tipc_set_portunreliable(ref, 1);
198 tipc_set_portunreturnable(ref, 1);
199 sock->ops = &msg_ops;
200 sock->state = SS_READY;
204 sk = sk_alloc(AF_TIPC, GFP_KERNEL, &tipc_proto, 1);
206 tipc_deleteport(ref);
210 sock_init_data(sock, sk);
211 init_waitqueue_head(sk->sk_sleep);
212 sk->sk_rcvtimeo = 8 * HZ; /* default connect timeout = 8s */
215 port = tipc_get_port(ref);
218 port->usr_handle = tsock;
220 init_MUTEX(&tsock->sem);
222 dbg("sock_create: %x\n",tsock);
224 atomic_inc(&tipc_user_count);
230 * release - destroy a TIPC socket
231 * @sock: socket to destroy
233 * This routine cleans up any messages that are still queued on the socket.
234 * For DGRAM and RDM socket types, all queued messages are rejected.
235 * For SEQPACKET and STREAM socket types, the first message is rejected
236 * and any others are discarded. (If the first message on a STREAM socket
237 * is partially-read, it is discarded and the next one is rejected instead.)
239 * NOTE: Rejected messages are not necessarily returned to the sender! They
240 * are returned or discarded according to the "destination droppable" setting
241 * specified for the message by the sender.
243 * Returns 0 on success, errno otherwise
246 static int release(struct socket *sock)
248 struct tipc_sock *tsock = tipc_sk(sock->sk);
249 struct sock *sk = sock->sk;
253 dbg("sock_delete: %x\n",tsock);
256 down_interruptible(&tsock->sem);
262 /* Reject unreceived messages, unless no longer connected */
264 while (sock->state != SS_DISCONNECTING) {
266 buf = skb_dequeue(&sk->sk_receive_queue);
268 tsock->p->usr_handle = NULL;
272 if (TIPC_SKB_CB(buf)->handle != msg_data(buf_msg(buf)))
275 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
276 atomic_dec(&tipc_queue_size);
279 /* Delete TIPC port */
281 res = tipc_deleteport(tsock->p->ref);
284 /* Discard any remaining messages */
286 while ((buf = skb_dequeue(&sk->sk_receive_queue))) {
288 atomic_dec(&tipc_queue_size);
295 atomic_dec(&tipc_user_count);
300 * bind - associate or disassocate TIPC name(s) with a socket
301 * @sock: socket structure
302 * @uaddr: socket address describing name(s) and desired operation
303 * @uaddr_len: size of socket address data structure
305 * Name and name sequence binding is indicated using a positive scope value;
306 * a negative scope value unbinds the specified name. Specifying no name
307 * (i.e. a socket address length of 0) unbinds all names from the socket.
309 * Returns 0 on success, errno otherwise
312 static int bind(struct socket *sock, struct sockaddr *uaddr, int uaddr_len)
314 struct tipc_sock *tsock = tipc_sk(sock->sk);
315 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
318 if (down_interruptible(&tsock->sem))
321 if (unlikely(!uaddr_len)) {
322 res = tipc_withdraw(tsock->p->ref, 0, NULL);
326 if (uaddr_len < sizeof(struct sockaddr_tipc)) {
331 if (addr->family != AF_TIPC) {
335 if (addr->addrtype == TIPC_ADDR_NAME)
336 addr->addr.nameseq.upper = addr->addr.nameseq.lower;
337 else if (addr->addrtype != TIPC_ADDR_NAMESEQ) {
343 res = tipc_publish(tsock->p->ref, addr->scope,
344 &addr->addr.nameseq);
346 res = tipc_withdraw(tsock->p->ref, -addr->scope,
347 &addr->addr.nameseq);
354 * get_name - get port ID of socket or peer socket
355 * @sock: socket structure
356 * @uaddr: area for returned socket address
357 * @uaddr_len: area for returned length of socket address
358 * @peer: 0 to obtain socket name, 1 to obtain peer socket name
360 * Returns 0 on success, errno otherwise
363 static int get_name(struct socket *sock, struct sockaddr *uaddr,
364 int *uaddr_len, int peer)
366 struct tipc_sock *tsock = tipc_sk(sock->sk);
367 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
370 if (down_interruptible(&tsock->sem))
373 *uaddr_len = sizeof(*addr);
374 addr->addrtype = TIPC_ADDR_ID;
375 addr->family = AF_TIPC;
378 res = tipc_peer(tsock->p->ref, &addr->addr.id);
380 res = tipc_ownidentity(tsock->p->ref, &addr->addr.id);
381 addr->addr.name.domain = 0;
388 * poll - read and possibly block on pollmask
389 * @file: file structure associated with the socket
390 * @sock: socket for which to calculate the poll bits
393 * Returns the pollmask
396 static unsigned int poll(struct file *file, struct socket *sock,
399 poll_wait(file, sock->sk->sk_sleep, wait);
400 /* NEED LOCK HERE? */
401 return pollmask(sock);
405 * dest_name_check - verify user is permitted to send to specified port name
406 * @dest: destination address
407 * @m: descriptor for message to be sent
409 * Prevents restricted configuration commands from being issued by
410 * unauthorized users.
412 * Returns 0 if permission is granted, otherwise errno
415 static int dest_name_check(struct sockaddr_tipc *dest, struct msghdr *m)
417 struct tipc_cfg_msg_hdr hdr;
419 if (likely(dest->addr.name.name.type >= TIPC_RESERVED_TYPES))
421 if (likely(dest->addr.name.name.type == TIPC_TOP_SRV))
424 if (likely(dest->addr.name.name.type != TIPC_CFG_SRV))
427 if (copy_from_user(&hdr, m->msg_iov[0].iov_base, sizeof(hdr)))
429 if ((ntohs(hdr.tcm_type) & 0xC000) && (!capable(CAP_NET_ADMIN)))
436 * send_msg - send message in connectionless manner
438 * @sock: socket structure
439 * @m: message to send
440 * @total_len: length of message
442 * Message must have an destination specified explicitly.
443 * Used for SOCK_RDM and SOCK_DGRAM messages,
444 * and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
445 * (Note: 'SYN+' is prohibited on SOCK_STREAM.)
447 * Returns the number of bytes sent on success, or errno otherwise
450 static int send_msg(struct kiocb *iocb, struct socket *sock,
451 struct msghdr *m, size_t total_len)
453 struct tipc_sock *tsock = tipc_sk(sock->sk);
454 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
460 return -EDESTADDRREQ;
461 if (unlikely(dest->family != AF_TIPC))
464 needs_conn = (sock->state != SS_READY);
465 if (unlikely(needs_conn)) {
466 if (sock->state == SS_LISTENING)
468 if (sock->state != SS_UNCONNECTED)
470 if ((tsock->p->published) ||
471 ((sock->type == SOCK_STREAM) && (total_len != 0)))
473 if (dest->addrtype == TIPC_ADDR_NAME) {
474 tsock->p->conn_type = dest->addr.name.name.type;
475 tsock->p->conn_instance = dest->addr.name.name.instance;
479 if (down_interruptible(&tsock->sem))
484 /* Abort any pending connection attempts (very unlikely) */
486 while ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
487 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
488 atomic_dec(&tipc_queue_size);
491 sock->state = SS_CONNECTING;
495 if (dest->addrtype == TIPC_ADDR_NAME) {
496 if ((res = dest_name_check(dest, m)))
498 res = tipc_send2name(tsock->p->ref,
499 &dest->addr.name.name,
500 dest->addr.name.domain,
504 else if (dest->addrtype == TIPC_ADDR_ID) {
505 res = tipc_send2port(tsock->p->ref,
510 else if (dest->addrtype == TIPC_ADDR_MCAST) {
515 if ((res = dest_name_check(dest, m)))
517 res = tipc_multicast(tsock->p->ref,
523 if (likely(res != -ELINKCONG)) {
528 if (m->msg_flags & MSG_DONTWAIT) {
532 if (wait_event_interruptible(*sock->sk->sk_sleep,
533 !tsock->p->congested)) {
541 * send_packet - send a connection-oriented message
543 * @sock: socket structure
544 * @m: message to send
545 * @total_len: length of message
547 * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
549 * Returns the number of bytes sent on success, or errno otherwise
552 static int send_packet(struct kiocb *iocb, struct socket *sock,
553 struct msghdr *m, size_t total_len)
555 struct tipc_sock *tsock = tipc_sk(sock->sk);
556 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
559 /* Handle implied connection establishment */
562 return send_msg(iocb, sock, m, total_len);
564 if (down_interruptible(&tsock->sem)) {
568 if (unlikely(sock->state != SS_CONNECTED)) {
569 if (sock->state == SS_DISCONNECTING)
577 res = tipc_send(tsock->p->ref, m->msg_iovlen, m->msg_iov);
578 if (likely(res != -ELINKCONG)) {
583 if (m->msg_flags & MSG_DONTWAIT) {
587 if (wait_event_interruptible(*sock->sk->sk_sleep,
588 !tsock->p->congested)) {
596 * send_stream - send stream-oriented data
598 * @sock: socket structure
600 * @total_len: total length of data to be sent
602 * Used for SOCK_STREAM data.
604 * Returns the number of bytes sent on success, or errno otherwise
608 static int send_stream(struct kiocb *iocb, struct socket *sock,
609 struct msghdr *m, size_t total_len)
611 struct msghdr my_msg;
613 struct iovec *curr_iov;
615 char __user *curr_start;
620 if (likely(total_len <= TIPC_MAX_USER_MSG_SIZE))
621 return send_packet(iocb, sock, m, total_len);
623 /* Can only send large data streams if already connected */
625 if (unlikely(sock->state != SS_CONNECTED)) {
626 if (sock->state == SS_DISCONNECTING)
633 * Send each iovec entry using one or more messages
635 * Note: This algorithm is good for the most likely case
636 * (i.e. one large iovec entry), but could be improved to pass sets
637 * of small iovec entries into send_packet().
641 curr_iov = my_msg.msg_iov;
642 curr_iovlen = my_msg.msg_iovlen;
643 my_msg.msg_iov = &my_iov;
644 my_msg.msg_iovlen = 1;
646 while (curr_iovlen--) {
647 curr_start = curr_iov->iov_base;
648 curr_left = curr_iov->iov_len;
651 bytes_to_send = (curr_left < TIPC_MAX_USER_MSG_SIZE)
652 ? curr_left : TIPC_MAX_USER_MSG_SIZE;
653 my_iov.iov_base = curr_start;
654 my_iov.iov_len = bytes_to_send;
655 if ((res = send_packet(iocb, sock, &my_msg, 0)) < 0)
657 curr_left -= bytes_to_send;
658 curr_start += bytes_to_send;
668 * auto_connect - complete connection setup to a remote port
669 * @sock: socket structure
670 * @tsock: TIPC-specific socket structure
671 * @msg: peer's response message
673 * Returns 0 on success, errno otherwise
676 static int auto_connect(struct socket *sock, struct tipc_sock *tsock,
677 struct tipc_msg *msg)
679 struct tipc_portid peer;
681 if (msg_errcode(msg)) {
682 sock->state = SS_DISCONNECTING;
683 return -ECONNREFUSED;
686 peer.ref = msg_origport(msg);
687 peer.node = msg_orignode(msg);
688 tipc_connect2port(tsock->p->ref, &peer);
689 tipc_set_portimportance(tsock->p->ref, msg_importance(msg));
690 sock->state = SS_CONNECTED;
695 * set_orig_addr - capture sender's address for received message
696 * @m: descriptor for message info
697 * @msg: received message header
699 * Note: Address is not captured if not requested by receiver.
702 static void set_orig_addr(struct msghdr *m, struct tipc_msg *msg)
704 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)m->msg_name;
707 addr->family = AF_TIPC;
708 addr->addrtype = TIPC_ADDR_ID;
709 addr->addr.id.ref = msg_origport(msg);
710 addr->addr.id.node = msg_orignode(msg);
711 addr->addr.name.domain = 0; /* could leave uninitialized */
712 addr->scope = 0; /* could leave uninitialized */
713 m->msg_namelen = sizeof(struct sockaddr_tipc);
718 * anc_data_recv - optionally capture ancillary data for received message
719 * @m: descriptor for message info
720 * @msg: received message header
721 * @tport: TIPC port associated with message
723 * Note: Ancillary data is not captured if not requested by receiver.
725 * Returns 0 if successful, otherwise errno
728 static int anc_data_recv(struct msghdr *m, struct tipc_msg *msg,
729 struct tipc_port *tport)
736 if (likely(m->msg_controllen == 0))
739 /* Optionally capture errored message object(s) */
741 err = msg ? msg_errcode(msg) : 0;
744 anc_data[1] = msg_data_sz(msg);
745 if ((res = put_cmsg(m, SOL_SOCKET, TIPC_ERRINFO, 8, anc_data)))
748 (res = put_cmsg(m, SOL_SOCKET, TIPC_RETDATA, anc_data[1],
753 /* Optionally capture message destination object */
755 dest_type = msg ? msg_type(msg) : TIPC_DIRECT_MSG;
758 anc_data[0] = msg_nametype(msg);
759 anc_data[1] = msg_namelower(msg);
760 anc_data[2] = msg_namelower(msg);
763 anc_data[0] = msg_nametype(msg);
764 anc_data[1] = msg_namelower(msg);
765 anc_data[2] = msg_nameupper(msg);
768 anc_data[0] = tport->conn_type;
769 anc_data[1] = tport->conn_instance;
770 anc_data[2] = tport->conn_instance;
776 (res = put_cmsg(m, SOL_SOCKET, TIPC_DESTNAME, 12, anc_data)))
783 * recv_msg - receive packet-oriented message
785 * @m: descriptor for message info
786 * @buf_len: total size of user buffer area
787 * @flags: receive flags
789 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
790 * If the complete message doesn't fit in user area, truncate it.
792 * Returns size of returned message data, errno otherwise
795 static int recv_msg(struct kiocb *iocb, struct socket *sock,
796 struct msghdr *m, size_t buf_len, int flags)
798 struct tipc_sock *tsock = tipc_sk(sock->sk);
800 struct tipc_msg *msg;
806 /* Currently doesn't support receiving into multiple iovec entries */
808 if (m->msg_iovlen != 1)
811 /* Catch invalid receive attempts */
813 if (unlikely(!buf_len))
816 if (sock->type == SOCK_SEQPACKET) {
817 if (unlikely(sock->state == SS_UNCONNECTED))
819 if (unlikely((sock->state == SS_DISCONNECTING) &&
820 (skb_queue_len(&sock->sk->sk_receive_queue) == 0)))
824 /* Look for a message in receive queue; wait if necessary */
826 if (unlikely(down_interruptible(&tsock->sem)))
830 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
831 (flags & MSG_DONTWAIT))) {
836 if ((res = wait_event_interruptible(
838 ((q_len = skb_queue_len(&sock->sk->sk_receive_queue)) ||
839 (sock->state == SS_DISCONNECTING))) )) {
843 /* Catch attempt to receive on an already terminated connection */
844 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
851 /* Get access to first message in receive queue */
853 buf = skb_peek(&sock->sk->sk_receive_queue);
855 sz = msg_data_sz(msg);
856 err = msg_errcode(msg);
858 /* Complete connection setup for an implied connect */
860 if (unlikely(sock->state == SS_CONNECTING)) {
861 if ((res = auto_connect(sock, tsock, msg)))
865 /* Discard an empty non-errored message & try again */
867 if ((!sz) && (!err)) {
868 advance_queue(tsock);
872 /* Capture sender's address (optional) */
874 set_orig_addr(m, msg);
876 /* Capture ancillary data (optional) */
878 if ((res = anc_data_recv(m, msg, tsock->p)))
881 /* Capture message data (if valid) & compute return value (always) */
884 if (unlikely(buf_len < sz)) {
886 m->msg_flags |= MSG_TRUNC;
888 if (unlikely(copy_to_user(m->msg_iov->iov_base, msg_data(msg),
895 if ((sock->state == SS_READY) ||
896 ((err == TIPC_CONN_SHUTDOWN) || m->msg_control))
902 /* Consume received message (optional) */
904 if (likely(!(flags & MSG_PEEK))) {
905 if (unlikely(++tsock->p->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
906 tipc_acknowledge(tsock->p->ref, tsock->p->conn_unacked);
907 advance_queue(tsock);
915 * recv_stream - receive stream-oriented data
917 * @m: descriptor for message info
918 * @buf_len: total size of user buffer area
919 * @flags: receive flags
921 * Used for SOCK_STREAM messages only. If not enough data is available
922 * will optionally wait for more; never truncates data.
924 * Returns size of returned message data, errno otherwise
927 static int recv_stream(struct kiocb *iocb, struct socket *sock,
928 struct msghdr *m, size_t buf_len, int flags)
930 struct tipc_sock *tsock = tipc_sk(sock->sk);
932 struct tipc_msg *msg;
938 char *crs = m->msg_iov->iov_base;
939 unsigned char *buf_crs;
943 /* Currently doesn't support receiving into multiple iovec entries */
945 if (m->msg_iovlen != 1)
948 /* Catch invalid receive attempts */
950 if (unlikely(!buf_len))
953 if (unlikely(sock->state == SS_DISCONNECTING)) {
954 if (skb_queue_len(&sock->sk->sk_receive_queue) == 0)
956 } else if (unlikely(sock->state != SS_CONNECTED))
959 /* Look for a message in receive queue; wait if necessary */
961 if (unlikely(down_interruptible(&tsock->sem)))
965 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
966 (flags & MSG_DONTWAIT))) {
967 res = (sz_copied == 0) ? -EWOULDBLOCK : 0;
971 if ((res = wait_event_interruptible(
973 ((q_len = skb_queue_len(&sock->sk->sk_receive_queue)) ||
974 (sock->state == SS_DISCONNECTING))) )) {
978 /* Catch attempt to receive on an already terminated connection */
979 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
986 /* Get access to first message in receive queue */
988 buf = skb_peek(&sock->sk->sk_receive_queue);
990 sz = msg_data_sz(msg);
991 err = msg_errcode(msg);
993 /* Discard an empty non-errored message & try again */
995 if ((!sz) && (!err)) {
996 advance_queue(tsock);
1000 /* Optionally capture sender's address & ancillary data of first msg */
1002 if (sz_copied == 0) {
1003 set_orig_addr(m, msg);
1004 if ((res = anc_data_recv(m, msg, tsock->p)))
1008 /* Capture message data (if valid) & compute return value (always) */
1011 buf_crs = (unsigned char *)(TIPC_SKB_CB(buf)->handle);
1012 sz = buf->tail - buf_crs;
1014 needed = (buf_len - sz_copied);
1015 sz_to_copy = (sz <= needed) ? sz : needed;
1016 if (unlikely(copy_to_user(crs, buf_crs, sz_to_copy))) {
1020 sz_copied += sz_to_copy;
1022 if (sz_to_copy < sz) {
1023 if (!(flags & MSG_PEEK))
1024 TIPC_SKB_CB(buf)->handle = buf_crs + sz_to_copy;
1031 goto exit; /* can't add error msg to valid data */
1033 if ((err == TIPC_CONN_SHUTDOWN) || m->msg_control)
1039 /* Consume received message (optional) */
1041 if (likely(!(flags & MSG_PEEK))) {
1042 if (unlikely(++tsock->p->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1043 tipc_acknowledge(tsock->p->ref, tsock->p->conn_unacked);
1044 advance_queue(tsock);
1047 /* Loop around if more data is required */
1049 if ((sz_copied < buf_len) /* didn't get all requested data */
1050 && (flags & MSG_WAITALL) /* ... and need to wait for more */
1051 && (!(flags & MSG_PEEK)) /* ... and aren't just peeking at data */
1052 && (!err) /* ... and haven't reached a FIN */
1058 return res ? res : sz_copied;
1062 * queue_overloaded - test if queue overload condition exists
1063 * @queue_size: current size of queue
1064 * @base: nominal maximum size of queue
1065 * @msg: message to be added to queue
1067 * Returns 1 if queue is currently overloaded, 0 otherwise
1070 static int queue_overloaded(u32 queue_size, u32 base, struct tipc_msg *msg)
1073 u32 imp = msg_importance(msg);
1075 if (imp == TIPC_LOW_IMPORTANCE)
1077 else if (imp == TIPC_MEDIUM_IMPORTANCE)
1078 threshold = base * 2;
1079 else if (imp == TIPC_HIGH_IMPORTANCE)
1080 threshold = base * 100;
1084 if (msg_connected(msg))
1087 return (queue_size > threshold);
1091 * async_disconnect - wrapper function used to disconnect port
1092 * @portref: TIPC port reference (passed as pointer-sized value)
1095 static void async_disconnect(unsigned long portref)
1097 tipc_disconnect((u32)portref);
1101 * dispatch - handle arriving message
1102 * @tport: TIPC port that received message
1105 * Called with port locked. Must not take socket lock to avoid deadlock risk.
1107 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1110 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf)
1112 struct tipc_msg *msg = buf_msg(buf);
1113 struct tipc_sock *tsock = (struct tipc_sock *)tport->usr_handle;
1114 struct socket *sock;
1117 /* Reject message if socket is closing */
1120 return TIPC_ERR_NO_PORT;
1122 /* Reject message if it is wrong sort of message for socket */
1125 * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1126 * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1127 * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1129 sock = tsock->sk.sk_socket;
1130 if (sock->state == SS_READY) {
1131 if (msg_connected(msg)) {
1132 msg_dbg(msg, "dispatch filter 1\n");
1133 return TIPC_ERR_NO_PORT;
1136 if (msg_mcast(msg)) {
1137 msg_dbg(msg, "dispatch filter 2\n");
1138 return TIPC_ERR_NO_PORT;
1140 if (sock->state == SS_CONNECTED) {
1141 if (!msg_connected(msg)) {
1142 msg_dbg(msg, "dispatch filter 3\n");
1143 return TIPC_ERR_NO_PORT;
1146 else if (sock->state == SS_CONNECTING) {
1147 if (!msg_connected(msg) && (msg_errcode(msg) == 0)) {
1148 msg_dbg(msg, "dispatch filter 4\n");
1149 return TIPC_ERR_NO_PORT;
1152 else if (sock->state == SS_LISTENING) {
1153 if (msg_connected(msg) || msg_errcode(msg)) {
1154 msg_dbg(msg, "dispatch filter 5\n");
1155 return TIPC_ERR_NO_PORT;
1158 else if (sock->state == SS_DISCONNECTING) {
1159 msg_dbg(msg, "dispatch filter 6\n");
1160 return TIPC_ERR_NO_PORT;
1162 else /* (sock->state == SS_UNCONNECTED) */ {
1163 if (msg_connected(msg) || msg_errcode(msg)) {
1164 msg_dbg(msg, "dispatch filter 7\n");
1165 return TIPC_ERR_NO_PORT;
1170 /* Reject message if there isn't room to queue it */
1172 if (unlikely((u32)atomic_read(&tipc_queue_size) >
1173 OVERLOAD_LIMIT_BASE)) {
1174 if (queue_overloaded(atomic_read(&tipc_queue_size),
1175 OVERLOAD_LIMIT_BASE, msg))
1176 return TIPC_ERR_OVERLOAD;
1178 recv_q_len = skb_queue_len(&tsock->sk.sk_receive_queue);
1179 if (unlikely(recv_q_len > (OVERLOAD_LIMIT_BASE / 2))) {
1180 if (queue_overloaded(recv_q_len,
1181 OVERLOAD_LIMIT_BASE / 2, msg))
1182 return TIPC_ERR_OVERLOAD;
1185 /* Initiate connection termination for an incoming 'FIN' */
1187 if (unlikely(msg_errcode(msg) && (sock->state == SS_CONNECTED))) {
1188 sock->state = SS_DISCONNECTING;
1189 /* Note: Use signal since port lock is already taken! */
1190 tipc_k_signal((Handler)async_disconnect, tport->ref);
1193 /* Enqueue message (finally!) */
1195 msg_dbg(msg,"<DISP<: ");
1196 TIPC_SKB_CB(buf)->handle = msg_data(msg);
1197 atomic_inc(&tipc_queue_size);
1198 skb_queue_tail(&sock->sk->sk_receive_queue, buf);
1200 wake_up_interruptible(sock->sk->sk_sleep);
1205 * wakeupdispatch - wake up port after congestion
1206 * @tport: port to wakeup
1208 * Called with port lock on.
1211 static void wakeupdispatch(struct tipc_port *tport)
1213 struct tipc_sock *tsock = (struct tipc_sock *)tport->usr_handle;
1215 wake_up_interruptible(tsock->sk.sk_sleep);
1219 * connect - establish a connection to another TIPC port
1220 * @sock: socket structure
1221 * @dest: socket address for destination port
1222 * @destlen: size of socket address data structure
1225 * Returns 0 on success, errno otherwise
1228 static int connect(struct socket *sock, struct sockaddr *dest, int destlen,
1231 struct tipc_sock *tsock = tipc_sk(sock->sk);
1232 struct sockaddr_tipc *dst = (struct sockaddr_tipc *)dest;
1233 struct msghdr m = {NULL,};
1234 struct sk_buff *buf;
1235 struct tipc_msg *msg;
1238 /* For now, TIPC does not allow use of connect() with DGRAM or RDM types */
1240 if (sock->state == SS_READY)
1243 /* MOVE THE REST OF THIS ERROR CHECKING TO send_msg()? */
1244 if (sock->state == SS_LISTENING)
1246 if (sock->state == SS_CONNECTING)
1248 if (sock->state != SS_UNCONNECTED)
1251 if ((destlen < sizeof(*dst)) || (dst->family != AF_TIPC) ||
1252 ((dst->addrtype != TIPC_ADDR_NAME) && (dst->addrtype != TIPC_ADDR_ID)))
1255 /* Send a 'SYN-' to destination */
1258 if ((res = send_msg(NULL, sock, &m, 0)) < 0) {
1259 sock->state = SS_DISCONNECTING;
1263 if (down_interruptible(&tsock->sem))
1264 return -ERESTARTSYS;
1266 /* Wait for destination's 'ACK' response */
1268 res = wait_event_interruptible_timeout(*sock->sk->sk_sleep,
1269 skb_queue_len(&sock->sk->sk_receive_queue),
1270 sock->sk->sk_rcvtimeo);
1271 buf = skb_peek(&sock->sk->sk_receive_queue);
1274 res = auto_connect(sock, tsock, msg);
1276 if (!msg_data_sz(msg))
1277 advance_queue(tsock);
1283 { /* leave "res" unchanged */ }
1284 sock->state = SS_DISCONNECTING;
1292 * listen - allow socket to listen for incoming connections
1293 * @sock: socket structure
1296 * Returns 0 on success, errno otherwise
1299 static int listen(struct socket *sock, int len)
1301 /* REQUIRES SOCKET LOCKING OF SOME SORT? */
1303 if (sock->state == SS_READY)
1305 if (sock->state != SS_UNCONNECTED)
1307 sock->state = SS_LISTENING;
1312 * accept - wait for connection request
1313 * @sock: listening socket
1314 * @newsock: new socket that is to be connected
1315 * @flags: file-related flags associated with socket
1317 * Returns 0 on success, errno otherwise
1320 static int accept(struct socket *sock, struct socket *newsock, int flags)
1322 struct tipc_sock *tsock = tipc_sk(sock->sk);
1323 struct sk_buff *buf;
1326 if (sock->state == SS_READY)
1328 if (sock->state != SS_LISTENING)
1331 if (unlikely((skb_queue_len(&sock->sk->sk_receive_queue) == 0) &&
1332 (flags & O_NONBLOCK)))
1333 return -EWOULDBLOCK;
1335 if (down_interruptible(&tsock->sem))
1336 return -ERESTARTSYS;
1338 if (wait_event_interruptible(*sock->sk->sk_sleep,
1339 skb_queue_len(&sock->sk->sk_receive_queue))) {
1343 buf = skb_peek(&sock->sk->sk_receive_queue);
1345 res = tipc_create(newsock, 0);
1347 struct tipc_sock *new_tsock = tipc_sk(newsock->sk);
1348 struct tipc_portid id;
1349 struct tipc_msg *msg = buf_msg(buf);
1350 u32 new_ref = new_tsock->p->ref;
1352 id.ref = msg_origport(msg);
1353 id.node = msg_orignode(msg);
1354 tipc_connect2port(new_ref, &id);
1355 newsock->state = SS_CONNECTED;
1357 tipc_set_portimportance(new_ref, msg_importance(msg));
1358 if (msg_named(msg)) {
1359 new_tsock->p->conn_type = msg_nametype(msg);
1360 new_tsock->p->conn_instance = msg_nameinst(msg);
1364 * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1365 * Respond to 'SYN+' by queuing it on new socket.
1368 msg_dbg(msg,"<ACC<: ");
1369 if (!msg_data_sz(msg)) {
1370 struct msghdr m = {NULL,};
1372 send_packet(NULL, newsock, &m, 0);
1373 advance_queue(tsock);
1376 skb_dequeue(&sock->sk->sk_receive_queue);
1378 skb_queue_head(&newsock->sk->sk_receive_queue, buf);
1387 * shutdown - shutdown socket connection
1388 * @sock: socket structure
1389 * @how: direction to close (unused; always treated as read + write)
1391 * Terminates connection (if necessary), then purges socket's receive queue.
1393 * Returns 0 on success, errno otherwise
1396 static int shutdown(struct socket *sock, int how)
1398 struct tipc_sock* tsock = tipc_sk(sock->sk);
1399 struct sk_buff *buf;
1402 /* Could return -EINVAL for an invalid "how", but why bother? */
1404 if (down_interruptible(&tsock->sem))
1405 return -ERESTARTSYS;
1409 switch (sock->state) {
1412 /* Send 'FIN+' or 'FIN-' message to peer */
1416 if ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
1417 atomic_dec(&tipc_queue_size);
1418 if (TIPC_SKB_CB(buf)->handle != msg_data(buf_msg(buf))) {
1422 tipc_reject_msg(buf, TIPC_CONN_SHUTDOWN);
1425 tipc_shutdown(tsock->p->ref);
1431 case SS_DISCONNECTING:
1433 /* Discard any unreceived messages */
1435 while ((buf = skb_dequeue(&sock->sk->sk_receive_queue))) {
1436 atomic_dec(&tipc_queue_size);
1439 tsock->p->conn_unacked = 0;
1444 sock->state = SS_DISCONNECTING;
1459 * setsockopt - set socket option
1460 * @sock: socket structure
1461 * @lvl: option level
1462 * @opt: option identifier
1463 * @ov: pointer to new option value
1464 * @ol: length of option value
1466 * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1467 * (to ease compatibility).
1469 * Returns 0 on success, errno otherwise
1472 static int setsockopt(struct socket *sock,
1473 int lvl, int opt, char __user *ov, int ol)
1475 struct tipc_sock *tsock = tipc_sk(sock->sk);
1479 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1481 if (lvl != SOL_TIPC)
1482 return -ENOPROTOOPT;
1483 if (ol < sizeof(value))
1485 if ((res = get_user(value, (u32 *)ov)))
1488 if (down_interruptible(&tsock->sem))
1489 return -ERESTARTSYS;
1492 case TIPC_IMPORTANCE:
1493 res = tipc_set_portimportance(tsock->p->ref, value);
1495 case TIPC_SRC_DROPPABLE:
1496 if (sock->type != SOCK_STREAM)
1497 res = tipc_set_portunreliable(tsock->p->ref, value);
1501 case TIPC_DEST_DROPPABLE:
1502 res = tipc_set_portunreturnable(tsock->p->ref, value);
1504 case TIPC_CONN_TIMEOUT:
1505 sock->sk->sk_rcvtimeo = (value * HZ / 1000);
1516 * getsockopt - get socket option
1517 * @sock: socket structure
1518 * @lvl: option level
1519 * @opt: option identifier
1520 * @ov: receptacle for option value
1521 * @ol: receptacle for length of option value
1523 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1524 * (to ease compatibility).
1526 * Returns 0 on success, errno otherwise
1529 static int getsockopt(struct socket *sock,
1530 int lvl, int opt, char __user *ov, int *ol)
1532 struct tipc_sock *tsock = tipc_sk(sock->sk);
1537 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1538 return put_user(0, ol);
1539 if (lvl != SOL_TIPC)
1540 return -ENOPROTOOPT;
1541 if ((res = get_user(len, ol)))
1544 if (down_interruptible(&tsock->sem))
1545 return -ERESTARTSYS;
1548 case TIPC_IMPORTANCE:
1549 res = tipc_portimportance(tsock->p->ref, &value);
1551 case TIPC_SRC_DROPPABLE:
1552 res = tipc_portunreliable(tsock->p->ref, &value);
1554 case TIPC_DEST_DROPPABLE:
1555 res = tipc_portunreturnable(tsock->p->ref, &value);
1557 case TIPC_CONN_TIMEOUT:
1558 value = (sock->sk->sk_rcvtimeo * 1000) / HZ;
1567 else if (len < sizeof(value)) {
1570 else if ((res = copy_to_user(ov, &value, sizeof(value)))) {
1571 /* couldn't return value */
1574 res = put_user(sizeof(value), ol);
1582 * Placeholders for non-implemented functionality
1584 * Returns error code (POSIX-compliant where defined)
1587 static int ioctl(struct socket *s, u32 cmd, unsigned long arg)
1592 static int no_mmap(struct file *file, struct socket *sock,
1593 struct vm_area_struct *vma)
1597 static ssize_t no_sendpage(struct socket *sock, struct page *page,
1598 int offset, size_t size, int flags)
1603 static int no_skpair(struct socket *s1, struct socket *s2)
1609 * Protocol switches for the various types of TIPC sockets
1612 static struct proto_ops msg_ops = {
1613 .owner = THIS_MODULE,
1618 .socketpair = no_skpair,
1620 .getname = get_name,
1624 .shutdown = shutdown,
1625 .setsockopt = setsockopt,
1626 .getsockopt = getsockopt,
1627 .sendmsg = send_msg,
1628 .recvmsg = recv_msg,
1630 .sendpage = no_sendpage
1633 static struct proto_ops packet_ops = {
1634 .owner = THIS_MODULE,
1639 .socketpair = no_skpair,
1641 .getname = get_name,
1645 .shutdown = shutdown,
1646 .setsockopt = setsockopt,
1647 .getsockopt = getsockopt,
1648 .sendmsg = send_packet,
1649 .recvmsg = recv_msg,
1651 .sendpage = no_sendpage
1654 static struct proto_ops stream_ops = {
1655 .owner = THIS_MODULE,
1660 .socketpair = no_skpair,
1662 .getname = get_name,
1666 .shutdown = shutdown,
1667 .setsockopt = setsockopt,
1668 .getsockopt = getsockopt,
1669 .sendmsg = send_stream,
1670 .recvmsg = recv_stream,
1672 .sendpage = no_sendpage
1675 static struct net_proto_family tipc_family_ops = {
1676 .owner = THIS_MODULE,
1678 .create = tipc_create
1681 static struct proto tipc_proto = {
1683 .owner = THIS_MODULE,
1684 .obj_size = sizeof(struct tipc_sock)
1688 * tipc_socket_init - initialize TIPC socket interface
1690 * Returns 0 on success, errno otherwise
1692 int tipc_socket_init(void)
1696 res = proto_register(&tipc_proto, 1);
1698 err("Failed to register TIPC protocol type\n");
1702 res = sock_register(&tipc_family_ops);
1704 err("Failed to register TIPC socket type\n");
1705 proto_unregister(&tipc_proto);
1709 sockets_enabled = 1;
1715 * tipc_socket_stop - stop TIPC socket interface
1717 void tipc_socket_stop(void)
1719 if (!sockets_enabled)
1722 sockets_enabled = 0;
1723 sock_unregister(tipc_family_ops.family);
1724 proto_unregister(&tipc_proto);