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: (unused)
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)))
475 if (down_interruptible(&tsock
->sem
))
480 /* Abort any pending connection attempts (very unlikely) */
482 while ((buf
= skb_dequeue(&sock
->sk
->sk_receive_queue
))) {
483 tipc_reject_msg(buf
, TIPC_ERR_NO_PORT
);
484 atomic_dec(&tipc_queue_size
);
487 sock
->state
= SS_CONNECTING
;
491 if (dest
->addrtype
== TIPC_ADDR_NAME
) {
492 if ((res
= dest_name_check(dest
, m
)))
494 res
= tipc_send2name(tsock
->p
->ref
,
495 &dest
->addr
.name
.name
,
496 dest
->addr
.name
.domain
,
500 else if (dest
->addrtype
== TIPC_ADDR_ID
) {
501 res
= tipc_send2port(tsock
->p
->ref
,
506 else if (dest
->addrtype
== TIPC_ADDR_MCAST
) {
511 if ((res
= dest_name_check(dest
, m
)))
513 res
= tipc_multicast(tsock
->p
->ref
,
519 if (likely(res
!= -ELINKCONG
)) {
524 if (m
->msg_flags
& MSG_DONTWAIT
) {
528 if (wait_event_interruptible(*sock
->sk
->sk_sleep
,
529 !tsock
->p
->congested
)) {
537 * send_packet - send a connection-oriented message
539 * @sock: socket structure
540 * @m: message to send
541 * @total_len: (unused)
543 * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
545 * Returns the number of bytes sent on success, or errno otherwise
548 static int send_packet(struct kiocb
*iocb
, struct socket
*sock
,
549 struct msghdr
*m
, size_t total_len
)
551 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
552 struct sockaddr_tipc
*dest
= (struct sockaddr_tipc
*)m
->msg_name
;
555 /* Handle implied connection establishment */
558 return send_msg(iocb
, sock
, m
, total_len
);
560 if (down_interruptible(&tsock
->sem
)) {
564 if (unlikely(sock
->state
!= SS_CONNECTED
)) {
565 if (sock
->state
== SS_DISCONNECTING
)
573 res
= tipc_send(tsock
->p
->ref
, m
->msg_iovlen
, m
->msg_iov
);
574 if (likely(res
!= -ELINKCONG
)) {
579 if (m
->msg_flags
& MSG_DONTWAIT
) {
583 if (wait_event_interruptible(*sock
->sk
->sk_sleep
,
584 !tsock
->p
->congested
)) {
592 * send_stream - send stream-oriented data
594 * @sock: socket structure
596 * @total_len: total length of data to be sent
598 * Used for SOCK_STREAM data.
600 * Returns the number of bytes sent on success, or errno otherwise
604 static int send_stream(struct kiocb
*iocb
, struct socket
*sock
,
605 struct msghdr
*m
, size_t total_len
)
607 struct msghdr my_msg
;
609 struct iovec
*curr_iov
;
611 char __user
*curr_start
;
616 if (likely(total_len
<= TIPC_MAX_USER_MSG_SIZE
))
617 return send_packet(iocb
, sock
, m
, total_len
);
619 /* Can only send large data streams if already connected */
621 if (unlikely(sock
->state
!= SS_CONNECTED
)) {
622 if (sock
->state
== SS_DISCONNECTING
)
629 * Send each iovec entry using one or more messages
631 * Note: This algorithm is good for the most likely case
632 * (i.e. one large iovec entry), but could be improved to pass sets
633 * of small iovec entries into send_packet().
637 curr_iov
= my_msg
.msg_iov
;
638 curr_iovlen
= my_msg
.msg_iovlen
;
639 my_msg
.msg_iov
= &my_iov
;
640 my_msg
.msg_iovlen
= 1;
642 while (curr_iovlen
--) {
643 curr_start
= curr_iov
->iov_base
;
644 curr_left
= curr_iov
->iov_len
;
647 bytes_to_send
= (curr_left
< TIPC_MAX_USER_MSG_SIZE
)
648 ? curr_left
: TIPC_MAX_USER_MSG_SIZE
;
649 my_iov
.iov_base
= curr_start
;
650 my_iov
.iov_len
= bytes_to_send
;
651 if ((res
= send_packet(iocb
, sock
, &my_msg
, 0)) < 0)
653 curr_left
-= bytes_to_send
;
654 curr_start
+= bytes_to_send
;
664 * auto_connect - complete connection setup to a remote port
665 * @sock: socket structure
666 * @tsock: TIPC-specific socket structure
667 * @msg: peer's response message
669 * Returns 0 on success, errno otherwise
672 static int auto_connect(struct socket
*sock
, struct tipc_sock
*tsock
,
673 struct tipc_msg
*msg
)
675 struct tipc_portid peer
;
677 if (msg_errcode(msg
)) {
678 sock
->state
= SS_DISCONNECTING
;
679 return -ECONNREFUSED
;
682 peer
.ref
= msg_origport(msg
);
683 peer
.node
= msg_orignode(msg
);
684 tipc_connect2port(tsock
->p
->ref
, &peer
);
685 tipc_set_portimportance(tsock
->p
->ref
, msg_importance(msg
));
686 sock
->state
= SS_CONNECTED
;
691 * set_orig_addr - capture sender's address for received message
692 * @m: descriptor for message info
693 * @msg: received message header
695 * Note: Address is not captured if not requested by receiver.
698 static void set_orig_addr(struct msghdr
*m
, struct tipc_msg
*msg
)
700 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)m
->msg_name
;
703 addr
->family
= AF_TIPC
;
704 addr
->addrtype
= TIPC_ADDR_ID
;
705 addr
->addr
.id
.ref
= msg_origport(msg
);
706 addr
->addr
.id
.node
= msg_orignode(msg
);
707 addr
->addr
.name
.domain
= 0; /* could leave uninitialized */
708 addr
->scope
= 0; /* could leave uninitialized */
709 m
->msg_namelen
= sizeof(struct sockaddr_tipc
);
714 * anc_data_recv - optionally capture ancillary data for received message
715 * @m: descriptor for message info
716 * @msg: received message header
717 * @tport: TIPC port associated with message
719 * Note: Ancillary data is not captured if not requested by receiver.
721 * Returns 0 if successful, otherwise errno
724 static int anc_data_recv(struct msghdr
*m
, struct tipc_msg
*msg
,
725 struct tipc_port
*tport
)
732 if (likely(m
->msg_controllen
== 0))
735 /* Optionally capture errored message object(s) */
737 err
= msg
? msg_errcode(msg
) : 0;
740 anc_data
[1] = msg_data_sz(msg
);
741 if ((res
= put_cmsg(m
, SOL_SOCKET
, TIPC_ERRINFO
, 8, anc_data
)))
744 (res
= put_cmsg(m
, SOL_SOCKET
, TIPC_RETDATA
, anc_data
[1],
749 /* Optionally capture message destination object */
751 dest_type
= msg
? msg_type(msg
) : TIPC_DIRECT_MSG
;
754 anc_data
[0] = msg_nametype(msg
);
755 anc_data
[1] = msg_namelower(msg
);
756 anc_data
[2] = msg_namelower(msg
);
759 anc_data
[0] = msg_nametype(msg
);
760 anc_data
[1] = msg_namelower(msg
);
761 anc_data
[2] = msg_nameupper(msg
);
764 anc_data
[0] = tport
->conn_type
;
765 anc_data
[1] = tport
->conn_instance
;
766 anc_data
[2] = tport
->conn_instance
;
772 (res
= put_cmsg(m
, SOL_SOCKET
, TIPC_DESTNAME
, 12, anc_data
)))
779 * recv_msg - receive packet-oriented message
781 * @m: descriptor for message info
782 * @buf_len: total size of user buffer area
783 * @flags: receive flags
785 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
786 * If the complete message doesn't fit in user area, truncate it.
788 * Returns size of returned message data, errno otherwise
791 static int recv_msg(struct kiocb
*iocb
, struct socket
*sock
,
792 struct msghdr
*m
, size_t buf_len
, int flags
)
794 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
796 struct tipc_msg
*msg
;
802 /* Currently doesn't support receiving into multiple iovec entries */
804 if (m
->msg_iovlen
!= 1)
807 /* Catch invalid receive attempts */
809 if (unlikely(!buf_len
))
812 if (sock
->type
== SOCK_SEQPACKET
) {
813 if (unlikely(sock
->state
== SS_UNCONNECTED
))
815 if (unlikely((sock
->state
== SS_DISCONNECTING
) &&
816 (skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0)))
820 /* Look for a message in receive queue; wait if necessary */
822 if (unlikely(down_interruptible(&tsock
->sem
)))
826 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
827 (flags
& MSG_DONTWAIT
))) {
832 if ((res
= wait_event_interruptible(
834 ((q_len
= skb_queue_len(&sock
->sk
->sk_receive_queue
)) ||
835 (sock
->state
== SS_DISCONNECTING
))) )) {
839 /* Catch attempt to receive on an already terminated connection */
840 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
847 /* Get access to first message in receive queue */
849 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
851 sz
= msg_data_sz(msg
);
852 err
= msg_errcode(msg
);
854 /* Complete connection setup for an implied connect */
856 if (unlikely(sock
->state
== SS_CONNECTING
)) {
857 if ((res
= auto_connect(sock
, tsock
, msg
)))
861 /* Discard an empty non-errored message & try again */
863 if ((!sz
) && (!err
)) {
864 advance_queue(tsock
);
868 /* Capture sender's address (optional) */
870 set_orig_addr(m
, msg
);
872 /* Capture ancillary data (optional) */
874 if ((res
= anc_data_recv(m
, msg
, tsock
->p
)))
877 /* Capture message data (if valid) & compute return value (always) */
880 if (unlikely(buf_len
< sz
)) {
882 m
->msg_flags
|= MSG_TRUNC
;
884 if (unlikely(copy_to_user(m
->msg_iov
->iov_base
, msg_data(msg
),
891 if ((sock
->state
== SS_READY
) ||
892 ((err
== TIPC_CONN_SHUTDOWN
) || m
->msg_control
))
898 /* Consume received message (optional) */
900 if (likely(!(flags
& MSG_PEEK
))) {
901 if (unlikely(++tsock
->p
->conn_unacked
>= TIPC_FLOW_CONTROL_WIN
))
902 tipc_acknowledge(tsock
->p
->ref
, tsock
->p
->conn_unacked
);
903 advance_queue(tsock
);
911 * recv_stream - receive stream-oriented data
913 * @m: descriptor for message info
914 * @buf_len: total size of user buffer area
915 * @flags: receive flags
917 * Used for SOCK_STREAM messages only. If not enough data is available
918 * will optionally wait for more; never truncates data.
920 * Returns size of returned message data, errno otherwise
923 static int recv_stream(struct kiocb
*iocb
, struct socket
*sock
,
924 struct msghdr
*m
, size_t buf_len
, int flags
)
926 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
928 struct tipc_msg
*msg
;
934 char *crs
= m
->msg_iov
->iov_base
;
935 unsigned char *buf_crs
;
939 /* Currently doesn't support receiving into multiple iovec entries */
941 if (m
->msg_iovlen
!= 1)
944 /* Catch invalid receive attempts */
946 if (unlikely(!buf_len
))
949 if (unlikely(sock
->state
== SS_DISCONNECTING
)) {
950 if (skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0)
952 } else if (unlikely(sock
->state
!= SS_CONNECTED
))
955 /* Look for a message in receive queue; wait if necessary */
957 if (unlikely(down_interruptible(&tsock
->sem
)))
961 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
962 (flags
& MSG_DONTWAIT
))) {
963 res
= (sz_copied
== 0) ? -EWOULDBLOCK
: 0;
967 if ((res
= wait_event_interruptible(
969 ((q_len
= skb_queue_len(&sock
->sk
->sk_receive_queue
)) ||
970 (sock
->state
== SS_DISCONNECTING
))) )) {
974 /* Catch attempt to receive on an already terminated connection */
975 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
982 /* Get access to first message in receive queue */
984 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
986 sz
= msg_data_sz(msg
);
987 err
= msg_errcode(msg
);
989 /* Discard an empty non-errored message & try again */
991 if ((!sz
) && (!err
)) {
992 advance_queue(tsock
);
996 /* Optionally capture sender's address & ancillary data of first msg */
998 if (sz_copied
== 0) {
999 set_orig_addr(m
, msg
);
1000 if ((res
= anc_data_recv(m
, msg
, tsock
->p
)))
1004 /* Capture message data (if valid) & compute return value (always) */
1007 buf_crs
= (unsigned char *)(TIPC_SKB_CB(buf
)->handle
);
1008 sz
= buf
->tail
- buf_crs
;
1010 needed
= (buf_len
- sz_copied
);
1011 sz_to_copy
= (sz
<= needed
) ? sz
: needed
;
1012 if (unlikely(copy_to_user(crs
, buf_crs
, sz_to_copy
))) {
1016 sz_copied
+= sz_to_copy
;
1018 if (sz_to_copy
< sz
) {
1019 if (!(flags
& MSG_PEEK
))
1020 TIPC_SKB_CB(buf
)->handle
= buf_crs
+ sz_to_copy
;
1027 goto exit
; /* can't add error msg to valid data */
1029 if ((err
== TIPC_CONN_SHUTDOWN
) || m
->msg_control
)
1035 /* Consume received message (optional) */
1037 if (likely(!(flags
& MSG_PEEK
))) {
1038 if (unlikely(++tsock
->p
->conn_unacked
>= TIPC_FLOW_CONTROL_WIN
))
1039 tipc_acknowledge(tsock
->p
->ref
, tsock
->p
->conn_unacked
);
1040 advance_queue(tsock
);
1043 /* Loop around if more data is required */
1045 if ((sz_copied
< buf_len
) /* didn't get all requested data */
1046 && (flags
& MSG_WAITALL
) /* ... and need to wait for more */
1047 && (!(flags
& MSG_PEEK
)) /* ... and aren't just peeking at data */
1048 && (!err
) /* ... and haven't reached a FIN */
1054 return res
? res
: sz_copied
;
1058 * queue_overloaded - test if queue overload condition exists
1059 * @queue_size: current size of queue
1060 * @base: nominal maximum size of queue
1061 * @msg: message to be added to queue
1063 * Returns 1 if queue is currently overloaded, 0 otherwise
1066 static int queue_overloaded(u32 queue_size
, u32 base
, struct tipc_msg
*msg
)
1069 u32 imp
= msg_importance(msg
);
1071 if (imp
== TIPC_LOW_IMPORTANCE
)
1073 else if (imp
== TIPC_MEDIUM_IMPORTANCE
)
1074 threshold
= base
* 2;
1075 else if (imp
== TIPC_HIGH_IMPORTANCE
)
1076 threshold
= base
* 100;
1080 if (msg_connected(msg
))
1083 return (queue_size
> threshold
);
1087 * async_disconnect - wrapper function used to disconnect port
1088 * @portref: TIPC port reference (passed as pointer-sized value)
1091 static void async_disconnect(unsigned long portref
)
1093 tipc_disconnect((u32
)portref
);
1097 * dispatch - handle arriving message
1098 * @tport: TIPC port that received message
1101 * Called with port locked. Must not take socket lock to avoid deadlock risk.
1103 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1106 static u32
dispatch(struct tipc_port
*tport
, struct sk_buff
*buf
)
1108 struct tipc_msg
*msg
= buf_msg(buf
);
1109 struct tipc_sock
*tsock
= (struct tipc_sock
*)tport
->usr_handle
;
1110 struct socket
*sock
;
1113 /* Reject message if socket is closing */
1116 return TIPC_ERR_NO_PORT
;
1118 /* Reject message if it is wrong sort of message for socket */
1121 * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1122 * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1123 * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1125 sock
= tsock
->sk
.sk_socket
;
1126 if (sock
->state
== SS_READY
) {
1127 if (msg_connected(msg
)) {
1128 msg_dbg(msg
, "dispatch filter 1\n");
1129 return TIPC_ERR_NO_PORT
;
1132 if (msg_mcast(msg
)) {
1133 msg_dbg(msg
, "dispatch filter 2\n");
1134 return TIPC_ERR_NO_PORT
;
1136 if (sock
->state
== SS_CONNECTED
) {
1137 if (!msg_connected(msg
)) {
1138 msg_dbg(msg
, "dispatch filter 3\n");
1139 return TIPC_ERR_NO_PORT
;
1142 else if (sock
->state
== SS_CONNECTING
) {
1143 if (!msg_connected(msg
) && (msg_errcode(msg
) == 0)) {
1144 msg_dbg(msg
, "dispatch filter 4\n");
1145 return TIPC_ERR_NO_PORT
;
1148 else if (sock
->state
== SS_LISTENING
) {
1149 if (msg_connected(msg
) || msg_errcode(msg
)) {
1150 msg_dbg(msg
, "dispatch filter 5\n");
1151 return TIPC_ERR_NO_PORT
;
1154 else if (sock
->state
== SS_DISCONNECTING
) {
1155 msg_dbg(msg
, "dispatch filter 6\n");
1156 return TIPC_ERR_NO_PORT
;
1158 else /* (sock->state == SS_UNCONNECTED) */ {
1159 if (msg_connected(msg
) || msg_errcode(msg
)) {
1160 msg_dbg(msg
, "dispatch filter 7\n");
1161 return TIPC_ERR_NO_PORT
;
1166 /* Reject message if there isn't room to queue it */
1168 if (unlikely((u32
)atomic_read(&tipc_queue_size
) >
1169 OVERLOAD_LIMIT_BASE
)) {
1170 if (queue_overloaded(atomic_read(&tipc_queue_size
),
1171 OVERLOAD_LIMIT_BASE
, msg
))
1172 return TIPC_ERR_OVERLOAD
;
1174 recv_q_len
= skb_queue_len(&tsock
->sk
.sk_receive_queue
);
1175 if (unlikely(recv_q_len
> (OVERLOAD_LIMIT_BASE
/ 2))) {
1176 if (queue_overloaded(recv_q_len
,
1177 OVERLOAD_LIMIT_BASE
/ 2, msg
))
1178 return TIPC_ERR_OVERLOAD
;
1181 /* Initiate connection termination for an incoming 'FIN' */
1183 if (unlikely(msg_errcode(msg
) && (sock
->state
== SS_CONNECTED
))) {
1184 sock
->state
= SS_DISCONNECTING
;
1185 /* Note: Use signal since port lock is already taken! */
1186 tipc_k_signal((Handler
)async_disconnect
, tport
->ref
);
1189 /* Enqueue message (finally!) */
1191 msg_dbg(msg
,"<DISP<: ");
1192 TIPC_SKB_CB(buf
)->handle
= msg_data(msg
);
1193 atomic_inc(&tipc_queue_size
);
1194 skb_queue_tail(&sock
->sk
->sk_receive_queue
, buf
);
1196 wake_up_interruptible(sock
->sk
->sk_sleep
);
1201 * wakeupdispatch - wake up port after congestion
1202 * @tport: port to wakeup
1204 * Called with port lock on.
1207 static void wakeupdispatch(struct tipc_port
*tport
)
1209 struct tipc_sock
*tsock
= (struct tipc_sock
*)tport
->usr_handle
;
1211 wake_up_interruptible(tsock
->sk
.sk_sleep
);
1215 * connect - establish a connection to another TIPC port
1216 * @sock: socket structure
1217 * @dest: socket address for destination port
1218 * @destlen: size of socket address data structure
1221 * Returns 0 on success, errno otherwise
1224 static int connect(struct socket
*sock
, struct sockaddr
*dest
, int destlen
,
1227 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1228 struct sockaddr_tipc
*dst
= (struct sockaddr_tipc
*)dest
;
1229 struct msghdr m
= {NULL
,};
1230 struct sk_buff
*buf
;
1231 struct tipc_msg
*msg
;
1234 /* For now, TIPC does not allow use of connect() with DGRAM or RDM types */
1236 if (sock
->state
== SS_READY
)
1239 /* MOVE THE REST OF THIS ERROR CHECKING TO send_msg()? */
1240 if (sock
->state
== SS_LISTENING
)
1242 if (sock
->state
== SS_CONNECTING
)
1244 if (sock
->state
!= SS_UNCONNECTED
)
1247 if ((dst
->family
!= AF_TIPC
) ||
1248 ((dst
->addrtype
!= TIPC_ADDR_NAME
) && (dst
->addrtype
!= TIPC_ADDR_ID
)))
1251 /* Send a 'SYN-' to destination */
1254 if ((res
= send_msg(NULL
, sock
, &m
, 0)) < 0) {
1255 sock
->state
= SS_DISCONNECTING
;
1259 if (down_interruptible(&tsock
->sem
))
1260 return -ERESTARTSYS
;
1262 /* Wait for destination's 'ACK' response */
1264 res
= wait_event_interruptible_timeout(*sock
->sk
->sk_sleep
,
1265 skb_queue_len(&sock
->sk
->sk_receive_queue
),
1266 sock
->sk
->sk_rcvtimeo
);
1267 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
1270 res
= auto_connect(sock
, tsock
, msg
);
1272 if (dst
->addrtype
== TIPC_ADDR_NAME
) {
1273 tsock
->p
->conn_type
= dst
->addr
.name
.name
.type
;
1274 tsock
->p
->conn_instance
= dst
->addr
.name
.name
.instance
;
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 (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
, int lvl
, int opt
, char *ov
, int ol
)
1474 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1478 if ((lvl
== IPPROTO_TCP
) && (sock
->type
== SOCK_STREAM
))
1480 if (lvl
!= SOL_TIPC
)
1481 return -ENOPROTOOPT
;
1482 if (ol
< sizeof(value
))
1484 if ((res
= get_user(value
, (u32
*)ov
)))
1487 if (down_interruptible(&tsock
->sem
))
1488 return -ERESTARTSYS
;
1491 case TIPC_IMPORTANCE
:
1492 res
= tipc_set_portimportance(tsock
->p
->ref
, value
);
1494 case TIPC_SRC_DROPPABLE
:
1495 if (sock
->type
!= SOCK_STREAM
)
1496 res
= tipc_set_portunreliable(tsock
->p
->ref
, value
);
1500 case TIPC_DEST_DROPPABLE
:
1501 res
= tipc_set_portunreturnable(tsock
->p
->ref
, value
);
1503 case TIPC_CONN_TIMEOUT
:
1504 sock
->sk
->sk_rcvtimeo
= (value
* HZ
/ 1000);
1515 * getsockopt - get socket option
1516 * @sock: socket structure
1517 * @lvl: option level
1518 * @opt: option identifier
1519 * @ov: receptacle for option value
1520 * @ol: receptacle for length of option value
1522 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1523 * (to ease compatibility).
1525 * Returns 0 on success, errno otherwise
1528 static int getsockopt(struct socket
*sock
, int lvl
, int opt
, char *ov
, int *ol
)
1530 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1535 if ((lvl
== IPPROTO_TCP
) && (sock
->type
== SOCK_STREAM
))
1536 return put_user(0, ol
);
1537 if (lvl
!= SOL_TIPC
)
1538 return -ENOPROTOOPT
;
1539 if ((res
= get_user(len
, ol
)))
1542 if (down_interruptible(&tsock
->sem
))
1543 return -ERESTARTSYS
;
1546 case TIPC_IMPORTANCE
:
1547 res
= tipc_portimportance(tsock
->p
->ref
, &value
);
1549 case TIPC_SRC_DROPPABLE
:
1550 res
= tipc_portunreliable(tsock
->p
->ref
, &value
);
1552 case TIPC_DEST_DROPPABLE
:
1553 res
= tipc_portunreturnable(tsock
->p
->ref
, &value
);
1555 case TIPC_CONN_TIMEOUT
:
1556 value
= (sock
->sk
->sk_rcvtimeo
* 1000) / HZ
;
1565 else if (len
< sizeof(value
)) {
1568 else if ((res
= copy_to_user(ov
, &value
, sizeof(value
)))) {
1569 /* couldn't return value */
1572 res
= put_user(sizeof(value
), ol
);
1580 * Placeholders for non-implemented functionality
1582 * Returns error code (POSIX-compliant where defined)
1585 static int ioctl(struct socket
*s
, u32 cmd
, unsigned long arg
)
1590 static int no_mmap(struct file
*file
, struct socket
*sock
,
1591 struct vm_area_struct
*vma
)
1595 static ssize_t
no_sendpage(struct socket
*sock
, struct page
*page
,
1596 int offset
, size_t size
, int flags
)
1601 static int no_skpair(struct socket
*s1
, struct socket
*s2
)
1607 * Protocol switches for the various types of TIPC sockets
1610 static struct proto_ops msg_ops
= {
1611 .owner
= THIS_MODULE
,
1616 .socketpair
= no_skpair
,
1618 .getname
= get_name
,
1622 .shutdown
= shutdown
,
1623 .setsockopt
= setsockopt
,
1624 .getsockopt
= getsockopt
,
1625 .sendmsg
= send_msg
,
1626 .recvmsg
= recv_msg
,
1628 .sendpage
= no_sendpage
1631 static struct proto_ops packet_ops
= {
1632 .owner
= THIS_MODULE
,
1637 .socketpair
= no_skpair
,
1639 .getname
= get_name
,
1643 .shutdown
= shutdown
,
1644 .setsockopt
= setsockopt
,
1645 .getsockopt
= getsockopt
,
1646 .sendmsg
= send_packet
,
1647 .recvmsg
= recv_msg
,
1649 .sendpage
= no_sendpage
1652 static struct proto_ops stream_ops
= {
1653 .owner
= THIS_MODULE
,
1658 .socketpair
= no_skpair
,
1660 .getname
= get_name
,
1664 .shutdown
= shutdown
,
1665 .setsockopt
= setsockopt
,
1666 .getsockopt
= getsockopt
,
1667 .sendmsg
= send_stream
,
1668 .recvmsg
= recv_stream
,
1670 .sendpage
= no_sendpage
1673 static struct net_proto_family tipc_family_ops
= {
1674 .owner
= THIS_MODULE
,
1676 .create
= tipc_create
1679 static struct proto tipc_proto
= {
1681 .owner
= THIS_MODULE
,
1682 .obj_size
= sizeof(struct tipc_sock
)
1686 * tipc_socket_init - initialize TIPC socket interface
1688 * Returns 0 on success, errno otherwise
1690 int tipc_socket_init(void)
1694 res
= proto_register(&tipc_proto
, 1);
1696 err("Failed to register TIPC protocol type\n");
1700 res
= sock_register(&tipc_family_ops
);
1702 err("Failed to register TIPC socket type\n");
1703 proto_unregister(&tipc_proto
);
1707 sockets_enabled
= 1;
1713 * tipc_socket_stop - stop TIPC socket interface
1715 void tipc_socket_stop(void)
1717 if (!sockets_enabled
)
1720 sockets_enabled
= 0;
1721 sock_unregister(tipc_family_ops
.family
);
1722 proto_unregister(&tipc_proto
);