2 * net/tipc/socket.c: TIPC socket API
4 * Copyright (c) 2001-2006, Ericsson AB
5 * Copyright (c) 2004-2005, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
37 #include <linux/module.h>
38 #include <linux/types.h>
39 #include <linux/net.h>
40 #include <linux/socket.h>
41 #include <linux/errno.h>
43 #include <linux/slab.h>
44 #include <linux/poll.h>
45 #include <linux/fcntl.h>
46 #include <asm/semaphore.h>
47 #include <asm/string.h>
48 #include <asm/atomic.h>
51 #include <linux/tipc.h>
52 #include <linux/tipc_config.h>
53 #include <net/tipc/tipc_msg.h>
54 #include <net/tipc/tipc_port.h>
58 #define SS_LISTENING -1 /* socket is listening */
59 #define SS_READY -2 /* socket is connectionless */
61 #define OVERLOAD_LIMIT_BASE 5000
69 #define tipc_sk(sk) ((struct tipc_sock*)sk)
71 static u32
dispatch(struct tipc_port
*tport
, struct sk_buff
*buf
);
72 static void wakeupdispatch(struct tipc_port
*tport
);
74 static struct proto_ops packet_ops
;
75 static struct proto_ops stream_ops
;
76 static struct proto_ops msg_ops
;
78 static struct proto tipc_proto
;
80 static int sockets_enabled
= 0;
82 static atomic_t tipc_queue_size
= ATOMIC_INIT(0);
86 * sock_lock(): Lock a port/socket pair. lock_sock() can
87 * not be used here, since the same lock must protect ports
88 * with non-socket interfaces.
89 * See net.c for description of locking policy.
91 static void sock_lock(struct tipc_sock
* tsock
)
93 spin_lock_bh(tsock
->p
->lock
);
97 * sock_unlock(): Unlock a port/socket pair
99 static void sock_unlock(struct tipc_sock
* tsock
)
101 spin_unlock_bh(tsock
->p
->lock
);
105 * pollmask - determine the current set of poll() events for a socket
106 * @sock: socket structure
108 * TIPC sets the returned events as follows:
109 * a) POLLRDNORM and POLLIN are set if the socket's receive queue is non-empty
110 * or if a connection-oriented socket is does not have an active connection
111 * (i.e. a read operation will not block).
112 * b) POLLOUT is set except when a socket's connection has been terminated
113 * (i.e. a write operation will not block).
114 * c) POLLHUP is set when a socket's connection has been terminated.
116 * IMPORTANT: The fact that a read or write operation will not block does NOT
117 * imply that the operation will succeed!
119 * Returns pollmask value
122 static u32
pollmask(struct socket
*sock
)
126 if ((skb_queue_len(&sock
->sk
->sk_receive_queue
) != 0) ||
127 (sock
->state
== SS_UNCONNECTED
) ||
128 (sock
->state
== SS_DISCONNECTING
))
129 mask
= (POLLRDNORM
| POLLIN
);
133 if (sock
->state
== SS_DISCONNECTING
)
143 * advance_queue - discard first buffer in queue
144 * @tsock: TIPC socket
147 static void advance_queue(struct tipc_sock
*tsock
)
150 buf_discard(skb_dequeue(&tsock
->sk
.sk_receive_queue
));
152 atomic_dec(&tipc_queue_size
);
156 * tipc_create - create a TIPC socket
157 * @sock: pre-allocated socket structure
158 * @protocol: protocol indicator (must be 0)
160 * This routine creates and attaches a 'struct sock' to the 'struct socket',
161 * then create and attaches a TIPC port to the 'struct sock' part.
163 * Returns 0 on success, errno otherwise
165 static int tipc_create(struct socket
*sock
, int protocol
)
167 struct tipc_sock
*tsock
;
168 struct tipc_port
*port
;
172 if (unlikely(protocol
!= 0))
173 return -EPROTONOSUPPORT
;
175 ref
= tipc_createport_raw(NULL
, &dispatch
, &wakeupdispatch
, TIPC_LOW_IMPORTANCE
);
179 sock
->state
= SS_UNCONNECTED
;
181 switch (sock
->type
) {
183 sock
->ops
= &stream_ops
;
186 sock
->ops
= &packet_ops
;
189 tipc_set_portunreliable(ref
, 1);
192 tipc_set_portunreturnable(ref
, 1);
193 sock
->ops
= &msg_ops
;
194 sock
->state
= SS_READY
;
197 tipc_deleteport(ref
);
201 sk
= sk_alloc(AF_TIPC
, GFP_KERNEL
, &tipc_proto
, 1);
203 tipc_deleteport(ref
);
207 sock_init_data(sock
, sk
);
208 init_waitqueue_head(sk
->sk_sleep
);
209 sk
->sk_rcvtimeo
= 8 * HZ
; /* default connect timeout = 8s */
212 port
= tipc_get_port(ref
);
215 port
->usr_handle
= tsock
;
217 init_MUTEX(&tsock
->sem
);
219 dbg("sock_create: %x\n",tsock
);
221 atomic_inc(&tipc_user_count
);
227 * release - destroy a TIPC socket
228 * @sock: socket to destroy
230 * This routine cleans up any messages that are still queued on the socket.
231 * For DGRAM and RDM socket types, all queued messages are rejected.
232 * For SEQPACKET and STREAM socket types, the first message is rejected
233 * and any others are discarded. (If the first message on a STREAM socket
234 * is partially-read, it is discarded and the next one is rejected instead.)
236 * NOTE: Rejected messages are not necessarily returned to the sender! They
237 * are returned or discarded according to the "destination droppable" setting
238 * specified for the message by the sender.
240 * Returns 0 on success, errno otherwise
243 static int release(struct socket
*sock
)
245 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
246 struct sock
*sk
= sock
->sk
;
250 dbg("sock_delete: %x\n",tsock
);
253 down_interruptible(&tsock
->sem
);
259 /* Reject unreceived messages, unless no longer connected */
261 while (sock
->state
!= SS_DISCONNECTING
) {
263 buf
= skb_dequeue(&sk
->sk_receive_queue
);
265 tsock
->p
->usr_handle
= NULL
;
269 if (TIPC_SKB_CB(buf
)->handle
!= msg_data(buf_msg(buf
)))
272 tipc_reject_msg(buf
, TIPC_ERR_NO_PORT
);
273 atomic_dec(&tipc_queue_size
);
276 /* Delete TIPC port */
278 res
= tipc_deleteport(tsock
->p
->ref
);
281 /* Discard any remaining messages */
283 while ((buf
= skb_dequeue(&sk
->sk_receive_queue
))) {
285 atomic_dec(&tipc_queue_size
);
292 atomic_dec(&tipc_user_count
);
297 * bind - associate or disassocate TIPC name(s) with a socket
298 * @sock: socket structure
299 * @uaddr: socket address describing name(s) and desired operation
300 * @uaddr_len: size of socket address data structure
302 * Name and name sequence binding is indicated using a positive scope value;
303 * a negative scope value unbinds the specified name. Specifying no name
304 * (i.e. a socket address length of 0) unbinds all names from the socket.
306 * Returns 0 on success, errno otherwise
309 static int bind(struct socket
*sock
, struct sockaddr
*uaddr
, int uaddr_len
)
311 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
312 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)uaddr
;
315 if (down_interruptible(&tsock
->sem
))
318 if (unlikely(!uaddr_len
)) {
319 res
= tipc_withdraw(tsock
->p
->ref
, 0, NULL
);
323 if (uaddr_len
< sizeof(struct sockaddr_tipc
)) {
328 if (addr
->family
!= AF_TIPC
) {
332 if (addr
->addrtype
== TIPC_ADDR_NAME
)
333 addr
->addr
.nameseq
.upper
= addr
->addr
.nameseq
.lower
;
334 else if (addr
->addrtype
!= TIPC_ADDR_NAMESEQ
) {
340 res
= tipc_publish(tsock
->p
->ref
, addr
->scope
,
341 &addr
->addr
.nameseq
);
343 res
= tipc_withdraw(tsock
->p
->ref
, -addr
->scope
,
344 &addr
->addr
.nameseq
);
351 * get_name - get port ID of socket or peer socket
352 * @sock: socket structure
353 * @uaddr: area for returned socket address
354 * @uaddr_len: area for returned length of socket address
355 * @peer: 0 to obtain socket name, 1 to obtain peer socket name
357 * Returns 0 on success, errno otherwise
360 static int get_name(struct socket
*sock
, struct sockaddr
*uaddr
,
361 int *uaddr_len
, int peer
)
363 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
364 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)uaddr
;
367 if (down_interruptible(&tsock
->sem
))
370 *uaddr_len
= sizeof(*addr
);
371 addr
->addrtype
= TIPC_ADDR_ID
;
372 addr
->family
= AF_TIPC
;
375 res
= tipc_peer(tsock
->p
->ref
, &addr
->addr
.id
);
377 res
= tipc_ownidentity(tsock
->p
->ref
, &addr
->addr
.id
);
378 addr
->addr
.name
.domain
= 0;
385 * poll - read and possibly block on pollmask
386 * @file: file structure associated with the socket
387 * @sock: socket for which to calculate the poll bits
390 * Returns the pollmask
393 static unsigned int poll(struct file
*file
, struct socket
*sock
,
396 poll_wait(file
, sock
->sk
->sk_sleep
, wait
);
397 /* NEED LOCK HERE? */
398 return pollmask(sock
);
402 * dest_name_check - verify user is permitted to send to specified port name
403 * @dest: destination address
404 * @m: descriptor for message to be sent
406 * Prevents restricted configuration commands from being issued by
407 * unauthorized users.
409 * Returns 0 if permission is granted, otherwise errno
412 static int dest_name_check(struct sockaddr_tipc
*dest
, struct msghdr
*m
)
414 struct tipc_cfg_msg_hdr hdr
;
416 if (likely(dest
->addr
.name
.name
.type
>= TIPC_RESERVED_TYPES
))
418 if (likely(dest
->addr
.name
.name
.type
== TIPC_TOP_SRV
))
421 if (likely(dest
->addr
.name
.name
.type
!= TIPC_CFG_SRV
))
424 if (copy_from_user(&hdr
, m
->msg_iov
[0].iov_base
, sizeof(hdr
)))
426 if ((ntohs(hdr
.tcm_type
) & 0xC000) && (!capable(CAP_NET_ADMIN
)))
433 * send_msg - send message in connectionless manner
435 * @sock: socket structure
436 * @m: message to send
437 * @total_len: length of message
439 * Message must have an destination specified explicitly.
440 * Used for SOCK_RDM and SOCK_DGRAM messages,
441 * and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
442 * (Note: 'SYN+' is prohibited on SOCK_STREAM.)
444 * Returns the number of bytes sent on success, or errno otherwise
447 static int send_msg(struct kiocb
*iocb
, struct socket
*sock
,
448 struct msghdr
*m
, size_t total_len
)
450 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
451 struct sockaddr_tipc
*dest
= (struct sockaddr_tipc
*)m
->msg_name
;
457 return -EDESTADDRREQ
;
458 if (unlikely((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 msghdr my_msg
;
612 struct iovec
*curr_iov
;
614 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().
640 curr_iov
= m
->msg_iov
;
641 curr_iovlen
= m
->msg_iovlen
;
642 my_msg
.msg_iov
= &my_iov
;
643 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) {
656 return bytes_sent
? bytes_sent
: res
;
658 curr_left
-= bytes_to_send
;
659 curr_start
+= bytes_to_send
;
660 bytes_sent
+= bytes_to_send
;
670 * auto_connect - complete connection setup to a remote port
671 * @sock: socket structure
672 * @tsock: TIPC-specific socket structure
673 * @msg: peer's response message
675 * Returns 0 on success, errno otherwise
678 static int auto_connect(struct socket
*sock
, struct tipc_sock
*tsock
,
679 struct tipc_msg
*msg
)
681 struct tipc_portid peer
;
683 if (msg_errcode(msg
)) {
684 sock
->state
= SS_DISCONNECTING
;
685 return -ECONNREFUSED
;
688 peer
.ref
= msg_origport(msg
);
689 peer
.node
= msg_orignode(msg
);
690 tipc_connect2port(tsock
->p
->ref
, &peer
);
691 tipc_set_portimportance(tsock
->p
->ref
, msg_importance(msg
));
692 sock
->state
= SS_CONNECTED
;
697 * set_orig_addr - capture sender's address for received message
698 * @m: descriptor for message info
699 * @msg: received message header
701 * Note: Address is not captured if not requested by receiver.
704 static void set_orig_addr(struct msghdr
*m
, struct tipc_msg
*msg
)
706 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)m
->msg_name
;
709 addr
->family
= AF_TIPC
;
710 addr
->addrtype
= TIPC_ADDR_ID
;
711 addr
->addr
.id
.ref
= msg_origport(msg
);
712 addr
->addr
.id
.node
= msg_orignode(msg
);
713 addr
->addr
.name
.domain
= 0; /* could leave uninitialized */
714 addr
->scope
= 0; /* could leave uninitialized */
715 m
->msg_namelen
= sizeof(struct sockaddr_tipc
);
720 * anc_data_recv - optionally capture ancillary data for received message
721 * @m: descriptor for message info
722 * @msg: received message header
723 * @tport: TIPC port associated with message
725 * Note: Ancillary data is not captured if not requested by receiver.
727 * Returns 0 if successful, otherwise errno
730 static int anc_data_recv(struct msghdr
*m
, struct tipc_msg
*msg
,
731 struct tipc_port
*tport
)
739 if (likely(m
->msg_controllen
== 0))
742 /* Optionally capture errored message object(s) */
744 err
= msg
? msg_errcode(msg
) : 0;
747 anc_data
[1] = msg_data_sz(msg
);
748 if ((res
= put_cmsg(m
, SOL_TIPC
, TIPC_ERRINFO
, 8, anc_data
)))
751 (res
= put_cmsg(m
, SOL_TIPC
, TIPC_RETDATA
, anc_data
[1],
756 /* Optionally capture message destination object */
758 dest_type
= msg
? msg_type(msg
) : TIPC_DIRECT_MSG
;
762 anc_data
[0] = msg_nametype(msg
);
763 anc_data
[1] = msg_namelower(msg
);
764 anc_data
[2] = msg_namelower(msg
);
768 anc_data
[0] = msg_nametype(msg
);
769 anc_data
[1] = msg_namelower(msg
);
770 anc_data
[2] = msg_nameupper(msg
);
773 has_name
= (tport
->conn_type
!= 0);
774 anc_data
[0] = tport
->conn_type
;
775 anc_data
[1] = tport
->conn_instance
;
776 anc_data
[2] = tport
->conn_instance
;
782 (res
= put_cmsg(m
, SOL_TIPC
, TIPC_DESTNAME
, 12, anc_data
)))
789 * recv_msg - receive packet-oriented message
791 * @m: descriptor for message info
792 * @buf_len: total size of user buffer area
793 * @flags: receive flags
795 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
796 * If the complete message doesn't fit in user area, truncate it.
798 * Returns size of returned message data, errno otherwise
801 static int recv_msg(struct kiocb
*iocb
, struct socket
*sock
,
802 struct msghdr
*m
, size_t buf_len
, int flags
)
804 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
806 struct tipc_msg
*msg
;
812 /* Currently doesn't support receiving into multiple iovec entries */
814 if (m
->msg_iovlen
!= 1)
817 /* Catch invalid receive attempts */
819 if (unlikely(!buf_len
))
822 if (sock
->type
== SOCK_SEQPACKET
) {
823 if (unlikely(sock
->state
== SS_UNCONNECTED
))
825 if (unlikely((sock
->state
== SS_DISCONNECTING
) &&
826 (skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0)))
830 /* Look for a message in receive queue; wait if necessary */
832 if (unlikely(down_interruptible(&tsock
->sem
)))
836 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
837 (flags
& MSG_DONTWAIT
))) {
842 if ((res
= wait_event_interruptible(
844 ((q_len
= skb_queue_len(&sock
->sk
->sk_receive_queue
)) ||
845 (sock
->state
== SS_DISCONNECTING
))) )) {
849 /* Catch attempt to receive on an already terminated connection */
850 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
857 /* Get access to first message in receive queue */
859 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
861 sz
= msg_data_sz(msg
);
862 err
= msg_errcode(msg
);
864 /* Complete connection setup for an implied connect */
866 if (unlikely(sock
->state
== SS_CONNECTING
)) {
867 if ((res
= auto_connect(sock
, tsock
, msg
)))
871 /* Discard an empty non-errored message & try again */
873 if ((!sz
) && (!err
)) {
874 advance_queue(tsock
);
878 /* Capture sender's address (optional) */
880 set_orig_addr(m
, msg
);
882 /* Capture ancillary data (optional) */
884 if ((res
= anc_data_recv(m
, msg
, tsock
->p
)))
887 /* Capture message data (if valid) & compute return value (always) */
890 if (unlikely(buf_len
< sz
)) {
892 m
->msg_flags
|= MSG_TRUNC
;
894 if (unlikely(copy_to_user(m
->msg_iov
->iov_base
, msg_data(msg
),
901 if ((sock
->state
== SS_READY
) ||
902 ((err
== TIPC_CONN_SHUTDOWN
) || m
->msg_control
))
908 /* Consume received message (optional) */
910 if (likely(!(flags
& MSG_PEEK
))) {
911 if (unlikely(++tsock
->p
->conn_unacked
>= TIPC_FLOW_CONTROL_WIN
))
912 tipc_acknowledge(tsock
->p
->ref
, tsock
->p
->conn_unacked
);
913 advance_queue(tsock
);
921 * recv_stream - receive stream-oriented data
923 * @m: descriptor for message info
924 * @buf_len: total size of user buffer area
925 * @flags: receive flags
927 * Used for SOCK_STREAM messages only. If not enough data is available
928 * will optionally wait for more; never truncates data.
930 * Returns size of returned message data, errno otherwise
933 static int recv_stream(struct kiocb
*iocb
, struct socket
*sock
,
934 struct msghdr
*m
, size_t buf_len
, int flags
)
936 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
938 struct tipc_msg
*msg
;
944 char *crs
= m
->msg_iov
->iov_base
;
945 unsigned char *buf_crs
;
949 /* Currently doesn't support receiving into multiple iovec entries */
951 if (m
->msg_iovlen
!= 1)
954 /* Catch invalid receive attempts */
956 if (unlikely(!buf_len
))
959 if (unlikely(sock
->state
== SS_DISCONNECTING
)) {
960 if (skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0)
962 } else if (unlikely(sock
->state
!= SS_CONNECTED
))
965 /* Look for a message in receive queue; wait if necessary */
967 if (unlikely(down_interruptible(&tsock
->sem
)))
971 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
972 (flags
& MSG_DONTWAIT
))) {
977 if ((res
= wait_event_interruptible(
979 ((q_len
= skb_queue_len(&sock
->sk
->sk_receive_queue
)) ||
980 (sock
->state
== SS_DISCONNECTING
))) )) {
984 /* Catch attempt to receive on an already terminated connection */
985 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
992 /* Get access to first message in receive queue */
994 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
996 sz
= msg_data_sz(msg
);
997 err
= msg_errcode(msg
);
999 /* Discard an empty non-errored message & try again */
1001 if ((!sz
) && (!err
)) {
1002 advance_queue(tsock
);
1006 /* Optionally capture sender's address & ancillary data of first msg */
1008 if (sz_copied
== 0) {
1009 set_orig_addr(m
, msg
);
1010 if ((res
= anc_data_recv(m
, msg
, tsock
->p
)))
1014 /* Capture message data (if valid) & compute return value (always) */
1017 buf_crs
= (unsigned char *)(TIPC_SKB_CB(buf
)->handle
);
1018 sz
= buf
->tail
- buf_crs
;
1020 needed
= (buf_len
- sz_copied
);
1021 sz_to_copy
= (sz
<= needed
) ? sz
: needed
;
1022 if (unlikely(copy_to_user(crs
, buf_crs
, sz_to_copy
))) {
1026 sz_copied
+= sz_to_copy
;
1028 if (sz_to_copy
< sz
) {
1029 if (!(flags
& MSG_PEEK
))
1030 TIPC_SKB_CB(buf
)->handle
= buf_crs
+ sz_to_copy
;
1037 goto exit
; /* can't add error msg to valid data */
1039 if ((err
== TIPC_CONN_SHUTDOWN
) || m
->msg_control
)
1045 /* Consume received message (optional) */
1047 if (likely(!(flags
& MSG_PEEK
))) {
1048 if (unlikely(++tsock
->p
->conn_unacked
>= TIPC_FLOW_CONTROL_WIN
))
1049 tipc_acknowledge(tsock
->p
->ref
, tsock
->p
->conn_unacked
);
1050 advance_queue(tsock
);
1053 /* Loop around if more data is required */
1055 if ((sz_copied
< buf_len
) /* didn't get all requested data */
1056 && (flags
& MSG_WAITALL
) /* ... and need to wait for more */
1057 && (!(flags
& MSG_PEEK
)) /* ... and aren't just peeking at data */
1058 && (!err
) /* ... and haven't reached a FIN */
1064 return sz_copied
? sz_copied
: res
;
1068 * queue_overloaded - test if queue overload condition exists
1069 * @queue_size: current size of queue
1070 * @base: nominal maximum size of queue
1071 * @msg: message to be added to queue
1073 * Returns 1 if queue is currently overloaded, 0 otherwise
1076 static int queue_overloaded(u32 queue_size
, u32 base
, struct tipc_msg
*msg
)
1079 u32 imp
= msg_importance(msg
);
1081 if (imp
== TIPC_LOW_IMPORTANCE
)
1083 else if (imp
== TIPC_MEDIUM_IMPORTANCE
)
1084 threshold
= base
* 2;
1085 else if (imp
== TIPC_HIGH_IMPORTANCE
)
1086 threshold
= base
* 100;
1090 if (msg_connected(msg
))
1093 return (queue_size
> threshold
);
1097 * async_disconnect - wrapper function used to disconnect port
1098 * @portref: TIPC port reference (passed as pointer-sized value)
1101 static void async_disconnect(unsigned long portref
)
1103 tipc_disconnect((u32
)portref
);
1107 * dispatch - handle arriving message
1108 * @tport: TIPC port that received message
1111 * Called with port locked. Must not take socket lock to avoid deadlock risk.
1113 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1116 static u32
dispatch(struct tipc_port
*tport
, struct sk_buff
*buf
)
1118 struct tipc_msg
*msg
= buf_msg(buf
);
1119 struct tipc_sock
*tsock
= (struct tipc_sock
*)tport
->usr_handle
;
1120 struct socket
*sock
;
1123 /* Reject message if socket is closing */
1126 return TIPC_ERR_NO_PORT
;
1128 /* Reject message if it is wrong sort of message for socket */
1131 * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1132 * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1133 * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1135 sock
= tsock
->sk
.sk_socket
;
1136 if (sock
->state
== SS_READY
) {
1137 if (msg_connected(msg
)) {
1138 msg_dbg(msg
, "dispatch filter 1\n");
1139 return TIPC_ERR_NO_PORT
;
1142 if (msg_mcast(msg
)) {
1143 msg_dbg(msg
, "dispatch filter 2\n");
1144 return TIPC_ERR_NO_PORT
;
1146 if (sock
->state
== SS_CONNECTED
) {
1147 if (!msg_connected(msg
)) {
1148 msg_dbg(msg
, "dispatch filter 3\n");
1149 return TIPC_ERR_NO_PORT
;
1152 else if (sock
->state
== SS_CONNECTING
) {
1153 if (!msg_connected(msg
) && (msg_errcode(msg
) == 0)) {
1154 msg_dbg(msg
, "dispatch filter 4\n");
1155 return TIPC_ERR_NO_PORT
;
1158 else if (sock
->state
== SS_LISTENING
) {
1159 if (msg_connected(msg
) || msg_errcode(msg
)) {
1160 msg_dbg(msg
, "dispatch filter 5\n");
1161 return TIPC_ERR_NO_PORT
;
1164 else if (sock
->state
== SS_DISCONNECTING
) {
1165 msg_dbg(msg
, "dispatch filter 6\n");
1166 return TIPC_ERR_NO_PORT
;
1168 else /* (sock->state == SS_UNCONNECTED) */ {
1169 if (msg_connected(msg
) || msg_errcode(msg
)) {
1170 msg_dbg(msg
, "dispatch filter 7\n");
1171 return TIPC_ERR_NO_PORT
;
1176 /* Reject message if there isn't room to queue it */
1178 if (unlikely((u32
)atomic_read(&tipc_queue_size
) >
1179 OVERLOAD_LIMIT_BASE
)) {
1180 if (queue_overloaded(atomic_read(&tipc_queue_size
),
1181 OVERLOAD_LIMIT_BASE
, msg
))
1182 return TIPC_ERR_OVERLOAD
;
1184 recv_q_len
= skb_queue_len(&tsock
->sk
.sk_receive_queue
);
1185 if (unlikely(recv_q_len
> (OVERLOAD_LIMIT_BASE
/ 2))) {
1186 if (queue_overloaded(recv_q_len
,
1187 OVERLOAD_LIMIT_BASE
/ 2, msg
))
1188 return TIPC_ERR_OVERLOAD
;
1191 /* Initiate connection termination for an incoming 'FIN' */
1193 if (unlikely(msg_errcode(msg
) && (sock
->state
== SS_CONNECTED
))) {
1194 sock
->state
= SS_DISCONNECTING
;
1195 /* Note: Use signal since port lock is already taken! */
1196 tipc_k_signal((Handler
)async_disconnect
, tport
->ref
);
1199 /* Enqueue message (finally!) */
1201 msg_dbg(msg
,"<DISP<: ");
1202 TIPC_SKB_CB(buf
)->handle
= msg_data(msg
);
1203 atomic_inc(&tipc_queue_size
);
1204 skb_queue_tail(&sock
->sk
->sk_receive_queue
, buf
);
1206 wake_up_interruptible(sock
->sk
->sk_sleep
);
1211 * wakeupdispatch - wake up port after congestion
1212 * @tport: port to wakeup
1214 * Called with port lock on.
1217 static void wakeupdispatch(struct tipc_port
*tport
)
1219 struct tipc_sock
*tsock
= (struct tipc_sock
*)tport
->usr_handle
;
1221 wake_up_interruptible(tsock
->sk
.sk_sleep
);
1225 * connect - establish a connection to another TIPC port
1226 * @sock: socket structure
1227 * @dest: socket address for destination port
1228 * @destlen: size of socket address data structure
1231 * Returns 0 on success, errno otherwise
1234 static int connect(struct socket
*sock
, struct sockaddr
*dest
, int destlen
,
1237 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1238 struct sockaddr_tipc
*dst
= (struct sockaddr_tipc
*)dest
;
1239 struct msghdr m
= {NULL
,};
1240 struct sk_buff
*buf
;
1241 struct tipc_msg
*msg
;
1244 /* For now, TIPC does not allow use of connect() with DGRAM or RDM types */
1246 if (sock
->state
== SS_READY
)
1249 /* Issue Posix-compliant error code if socket is in the wrong state */
1251 if (sock
->state
== SS_LISTENING
)
1253 if (sock
->state
== SS_CONNECTING
)
1255 if (sock
->state
!= SS_UNCONNECTED
)
1259 * Reject connection attempt using multicast address
1261 * Note: send_msg() validates the rest of the address fields,
1262 * so there's no need to do it here
1265 if (dst
->addrtype
== TIPC_ADDR_MCAST
)
1268 /* Send a 'SYN-' to destination */
1271 m
.msg_namelen
= destlen
;
1272 if ((res
= send_msg(NULL
, sock
, &m
, 0)) < 0) {
1273 sock
->state
= SS_DISCONNECTING
;
1277 if (down_interruptible(&tsock
->sem
))
1278 return -ERESTARTSYS
;
1280 /* Wait for destination's 'ACK' response */
1282 res
= wait_event_interruptible_timeout(*sock
->sk
->sk_sleep
,
1283 skb_queue_len(&sock
->sk
->sk_receive_queue
),
1284 sock
->sk
->sk_rcvtimeo
);
1285 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
1288 res
= auto_connect(sock
, tsock
, msg
);
1290 if (!msg_data_sz(msg
))
1291 advance_queue(tsock
);
1297 { /* leave "res" unchanged */ }
1298 sock
->state
= SS_DISCONNECTING
;
1306 * listen - allow socket to listen for incoming connections
1307 * @sock: socket structure
1310 * Returns 0 on success, errno otherwise
1313 static int listen(struct socket
*sock
, int len
)
1315 /* REQUIRES SOCKET LOCKING OF SOME SORT? */
1317 if (sock
->state
== SS_READY
)
1319 if (sock
->state
!= SS_UNCONNECTED
)
1321 sock
->state
= SS_LISTENING
;
1326 * accept - wait for connection request
1327 * @sock: listening socket
1328 * @newsock: new socket that is to be connected
1329 * @flags: file-related flags associated with socket
1331 * Returns 0 on success, errno otherwise
1334 static int accept(struct socket
*sock
, struct socket
*newsock
, int flags
)
1336 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1337 struct sk_buff
*buf
;
1340 if (sock
->state
== SS_READY
)
1342 if (sock
->state
!= SS_LISTENING
)
1345 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
1346 (flags
& O_NONBLOCK
)))
1347 return -EWOULDBLOCK
;
1349 if (down_interruptible(&tsock
->sem
))
1350 return -ERESTARTSYS
;
1352 if (wait_event_interruptible(*sock
->sk
->sk_sleep
,
1353 skb_queue_len(&sock
->sk
->sk_receive_queue
))) {
1357 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
1359 res
= tipc_create(newsock
, 0);
1361 struct tipc_sock
*new_tsock
= tipc_sk(newsock
->sk
);
1362 struct tipc_portid id
;
1363 struct tipc_msg
*msg
= buf_msg(buf
);
1364 u32 new_ref
= new_tsock
->p
->ref
;
1366 id
.ref
= msg_origport(msg
);
1367 id
.node
= msg_orignode(msg
);
1368 tipc_connect2port(new_ref
, &id
);
1369 newsock
->state
= SS_CONNECTED
;
1371 tipc_set_portimportance(new_ref
, msg_importance(msg
));
1372 if (msg_named(msg
)) {
1373 new_tsock
->p
->conn_type
= msg_nametype(msg
);
1374 new_tsock
->p
->conn_instance
= msg_nameinst(msg
);
1378 * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1379 * Respond to 'SYN+' by queuing it on new socket.
1382 msg_dbg(msg
,"<ACC<: ");
1383 if (!msg_data_sz(msg
)) {
1384 struct msghdr m
= {NULL
,};
1386 send_packet(NULL
, newsock
, &m
, 0);
1387 advance_queue(tsock
);
1390 skb_dequeue(&sock
->sk
->sk_receive_queue
);
1392 skb_queue_head(&newsock
->sk
->sk_receive_queue
, buf
);
1401 * shutdown - shutdown socket connection
1402 * @sock: socket structure
1403 * @how: direction to close (unused; always treated as read + write)
1405 * Terminates connection (if necessary), then purges socket's receive queue.
1407 * Returns 0 on success, errno otherwise
1410 static int shutdown(struct socket
*sock
, int how
)
1412 struct tipc_sock
* tsock
= tipc_sk(sock
->sk
);
1413 struct sk_buff
*buf
;
1416 /* Could return -EINVAL for an invalid "how", but why bother? */
1418 if (down_interruptible(&tsock
->sem
))
1419 return -ERESTARTSYS
;
1423 switch (sock
->state
) {
1426 /* Send 'FIN+' or 'FIN-' message to peer */
1430 if ((buf
= skb_dequeue(&sock
->sk
->sk_receive_queue
))) {
1431 atomic_dec(&tipc_queue_size
);
1432 if (TIPC_SKB_CB(buf
)->handle
!= msg_data(buf_msg(buf
))) {
1436 tipc_reject_msg(buf
, TIPC_CONN_SHUTDOWN
);
1439 tipc_shutdown(tsock
->p
->ref
);
1445 case SS_DISCONNECTING
:
1447 /* Discard any unreceived messages */
1449 while ((buf
= skb_dequeue(&sock
->sk
->sk_receive_queue
))) {
1450 atomic_dec(&tipc_queue_size
);
1453 tsock
->p
->conn_unacked
= 0;
1458 sock
->state
= SS_DISCONNECTING
;
1473 * setsockopt - set socket option
1474 * @sock: socket structure
1475 * @lvl: option level
1476 * @opt: option identifier
1477 * @ov: pointer to new option value
1478 * @ol: length of option value
1480 * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1481 * (to ease compatibility).
1483 * Returns 0 on success, errno otherwise
1486 static int setsockopt(struct socket
*sock
,
1487 int lvl
, int opt
, char __user
*ov
, int ol
)
1489 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1493 if ((lvl
== IPPROTO_TCP
) && (sock
->type
== SOCK_STREAM
))
1495 if (lvl
!= SOL_TIPC
)
1496 return -ENOPROTOOPT
;
1497 if (ol
< sizeof(value
))
1499 if ((res
= get_user(value
, (u32
*)ov
)))
1502 if (down_interruptible(&tsock
->sem
))
1503 return -ERESTARTSYS
;
1506 case TIPC_IMPORTANCE
:
1507 res
= tipc_set_portimportance(tsock
->p
->ref
, value
);
1509 case TIPC_SRC_DROPPABLE
:
1510 if (sock
->type
!= SOCK_STREAM
)
1511 res
= tipc_set_portunreliable(tsock
->p
->ref
, value
);
1515 case TIPC_DEST_DROPPABLE
:
1516 res
= tipc_set_portunreturnable(tsock
->p
->ref
, value
);
1518 case TIPC_CONN_TIMEOUT
:
1519 sock
->sk
->sk_rcvtimeo
= (value
* HZ
/ 1000);
1530 * getsockopt - get socket option
1531 * @sock: socket structure
1532 * @lvl: option level
1533 * @opt: option identifier
1534 * @ov: receptacle for option value
1535 * @ol: receptacle for length of option value
1537 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1538 * (to ease compatibility).
1540 * Returns 0 on success, errno otherwise
1543 static int getsockopt(struct socket
*sock
,
1544 int lvl
, int opt
, char __user
*ov
, int *ol
)
1546 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1551 if ((lvl
== IPPROTO_TCP
) && (sock
->type
== SOCK_STREAM
))
1552 return put_user(0, ol
);
1553 if (lvl
!= SOL_TIPC
)
1554 return -ENOPROTOOPT
;
1555 if ((res
= get_user(len
, ol
)))
1558 if (down_interruptible(&tsock
->sem
))
1559 return -ERESTARTSYS
;
1562 case TIPC_IMPORTANCE
:
1563 res
= tipc_portimportance(tsock
->p
->ref
, &value
);
1565 case TIPC_SRC_DROPPABLE
:
1566 res
= tipc_portunreliable(tsock
->p
->ref
, &value
);
1568 case TIPC_DEST_DROPPABLE
:
1569 res
= tipc_portunreturnable(tsock
->p
->ref
, &value
);
1571 case TIPC_CONN_TIMEOUT
:
1572 value
= (sock
->sk
->sk_rcvtimeo
* 1000) / HZ
;
1581 else if (len
< sizeof(value
)) {
1584 else if ((res
= copy_to_user(ov
, &value
, sizeof(value
)))) {
1585 /* couldn't return value */
1588 res
= put_user(sizeof(value
), ol
);
1596 * Placeholders for non-implemented functionality
1598 * Returns error code (POSIX-compliant where defined)
1601 static int ioctl(struct socket
*s
, u32 cmd
, unsigned long arg
)
1606 static int no_mmap(struct file
*file
, struct socket
*sock
,
1607 struct vm_area_struct
*vma
)
1611 static ssize_t
no_sendpage(struct socket
*sock
, struct page
*page
,
1612 int offset
, size_t size
, int flags
)
1617 static int no_skpair(struct socket
*s1
, struct socket
*s2
)
1623 * Protocol switches for the various types of TIPC sockets
1626 static struct proto_ops msg_ops
= {
1627 .owner
= THIS_MODULE
,
1632 .socketpair
= no_skpair
,
1634 .getname
= get_name
,
1638 .shutdown
= shutdown
,
1639 .setsockopt
= setsockopt
,
1640 .getsockopt
= getsockopt
,
1641 .sendmsg
= send_msg
,
1642 .recvmsg
= recv_msg
,
1644 .sendpage
= no_sendpage
1647 static struct proto_ops packet_ops
= {
1648 .owner
= THIS_MODULE
,
1653 .socketpair
= no_skpair
,
1655 .getname
= get_name
,
1659 .shutdown
= shutdown
,
1660 .setsockopt
= setsockopt
,
1661 .getsockopt
= getsockopt
,
1662 .sendmsg
= send_packet
,
1663 .recvmsg
= recv_msg
,
1665 .sendpage
= no_sendpage
1668 static struct proto_ops stream_ops
= {
1669 .owner
= THIS_MODULE
,
1674 .socketpair
= no_skpair
,
1676 .getname
= get_name
,
1680 .shutdown
= shutdown
,
1681 .setsockopt
= setsockopt
,
1682 .getsockopt
= getsockopt
,
1683 .sendmsg
= send_stream
,
1684 .recvmsg
= recv_stream
,
1686 .sendpage
= no_sendpage
1689 static struct net_proto_family tipc_family_ops
= {
1690 .owner
= THIS_MODULE
,
1692 .create
= tipc_create
1695 static struct proto tipc_proto
= {
1697 .owner
= THIS_MODULE
,
1698 .obj_size
= sizeof(struct tipc_sock
)
1702 * tipc_socket_init - initialize TIPC socket interface
1704 * Returns 0 on success, errno otherwise
1706 int tipc_socket_init(void)
1710 res
= proto_register(&tipc_proto
, 1);
1712 err("Failed to register TIPC protocol type\n");
1716 res
= sock_register(&tipc_family_ops
);
1718 err("Failed to register TIPC socket type\n");
1719 proto_unregister(&tipc_proto
);
1723 sockets_enabled
= 1;
1729 * tipc_socket_stop - stop TIPC socket interface
1731 void tipc_socket_stop(void)
1733 if (!sockets_enabled
)
1736 sockets_enabled
= 0;
1737 sock_unregister(tipc_family_ops
.family
);
1738 proto_unregister(&tipc_proto
);