2 * net/tipc/socket.c: TIPC socket API
4 * Copyright (c) 2001-2007, Ericsson AB
5 * Copyright (c) 2004-2007, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
37 #include <linux/module.h>
38 #include <linux/types.h>
39 #include <linux/net.h>
40 #include <linux/socket.h>
41 #include <linux/errno.h>
43 #include <linux/slab.h>
44 #include <linux/poll.h>
45 #include <linux/fcntl.h>
46 #include <linux/mutex.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
62 #define CONN_TIMEOUT_DEFAULT 8000 /* default connect timeout = 8s */
70 #define tipc_sk(sk) ((struct tipc_sock*)sk)
72 static u32
dispatch(struct tipc_port
*tport
, struct sk_buff
*buf
);
73 static void wakeupdispatch(struct tipc_port
*tport
);
75 static const struct proto_ops packet_ops
;
76 static const struct proto_ops stream_ops
;
77 static const struct proto_ops msg_ops
;
79 static struct proto tipc_proto
;
81 static int sockets_enabled
= 0;
83 static atomic_t tipc_queue_size
= ATOMIC_INIT(0);
87 * sock_lock(): Lock a port/socket pair. lock_sock() can
88 * not be used here, since the same lock must protect ports
89 * with non-socket interfaces.
90 * See net.c for description of locking policy.
92 static void sock_lock(struct tipc_sock
* tsock
)
94 spin_lock_bh(tsock
->p
->lock
);
98 * sock_unlock(): Unlock a port/socket pair
100 static void sock_unlock(struct tipc_sock
* tsock
)
102 spin_unlock_bh(tsock
->p
->lock
);
106 * advance_queue - discard first buffer in queue
107 * @tsock: TIPC socket
110 static void advance_queue(struct tipc_sock
*tsock
)
113 buf_discard(skb_dequeue(&tsock
->sk
.sk_receive_queue
));
115 atomic_dec(&tipc_queue_size
);
119 * tipc_create - create a TIPC socket
120 * @sock: pre-allocated socket structure
121 * @protocol: protocol indicator (must be 0)
123 * This routine creates and attaches a 'struct sock' to the 'struct socket',
124 * then create and attaches a TIPC port to the 'struct sock' part.
126 * Returns 0 on success, errno otherwise
128 static int tipc_create(struct net
*net
, struct socket
*sock
, int protocol
)
130 struct tipc_sock
*tsock
;
131 struct tipc_port
*port
;
135 if (net
!= &init_net
)
136 return -EAFNOSUPPORT
;
138 if (unlikely(protocol
!= 0))
139 return -EPROTONOSUPPORT
;
141 ref
= tipc_createport_raw(NULL
, &dispatch
, &wakeupdispatch
, TIPC_LOW_IMPORTANCE
);
145 sock
->state
= SS_UNCONNECTED
;
147 switch (sock
->type
) {
149 sock
->ops
= &stream_ops
;
152 sock
->ops
= &packet_ops
;
155 tipc_set_portunreliable(ref
, 1);
158 tipc_set_portunreturnable(ref
, 1);
159 sock
->ops
= &msg_ops
;
160 sock
->state
= SS_READY
;
163 tipc_deleteport(ref
);
167 sk
= sk_alloc(net
, AF_TIPC
, GFP_KERNEL
, &tipc_proto
);
169 tipc_deleteport(ref
);
173 sock_init_data(sock
, sk
);
174 sk
->sk_rcvtimeo
= msecs_to_jiffies(CONN_TIMEOUT_DEFAULT
);
177 port
= tipc_get_port(ref
);
180 port
->usr_handle
= tsock
;
182 mutex_init(&tsock
->lock
);
184 dbg("sock_create: %x\n",tsock
);
186 atomic_inc(&tipc_user_count
);
192 * release - destroy a TIPC socket
193 * @sock: socket to destroy
195 * This routine cleans up any messages that are still queued on the socket.
196 * For DGRAM and RDM socket types, all queued messages are rejected.
197 * For SEQPACKET and STREAM socket types, the first message is rejected
198 * and any others are discarded. (If the first message on a STREAM socket
199 * is partially-read, it is discarded and the next one is rejected instead.)
201 * NOTE: Rejected messages are not necessarily returned to the sender! They
202 * are returned or discarded according to the "destination droppable" setting
203 * specified for the message by the sender.
205 * Returns 0 on success, errno otherwise
208 static int release(struct socket
*sock
)
210 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
211 struct sock
*sk
= sock
->sk
;
215 dbg("sock_delete: %x\n",tsock
);
218 mutex_lock(&tsock
->lock
);
220 mutex_unlock(&tsock
->lock
);
224 /* Reject unreceived messages, unless no longer connected */
226 while (sock
->state
!= SS_DISCONNECTING
) {
228 buf
= skb_dequeue(&sk
->sk_receive_queue
);
230 tsock
->p
->usr_handle
= NULL
;
234 if (TIPC_SKB_CB(buf
)->handle
!= msg_data(buf_msg(buf
)))
237 tipc_reject_msg(buf
, TIPC_ERR_NO_PORT
);
238 atomic_dec(&tipc_queue_size
);
241 /* Delete TIPC port */
243 res
= tipc_deleteport(tsock
->p
->ref
);
246 /* Discard any remaining messages */
248 while ((buf
= skb_dequeue(&sk
->sk_receive_queue
))) {
250 atomic_dec(&tipc_queue_size
);
253 mutex_unlock(&tsock
->lock
);
257 atomic_dec(&tipc_user_count
);
262 * bind - associate or disassocate TIPC name(s) with a socket
263 * @sock: socket structure
264 * @uaddr: socket address describing name(s) and desired operation
265 * @uaddr_len: size of socket address data structure
267 * Name and name sequence binding is indicated using a positive scope value;
268 * a negative scope value unbinds the specified name. Specifying no name
269 * (i.e. a socket address length of 0) unbinds all names from the socket.
271 * Returns 0 on success, errno otherwise
274 static int bind(struct socket
*sock
, struct sockaddr
*uaddr
, int uaddr_len
)
276 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
277 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)uaddr
;
280 if (mutex_lock_interruptible(&tsock
->lock
))
283 if (unlikely(!uaddr_len
)) {
284 res
= tipc_withdraw(tsock
->p
->ref
, 0, NULL
);
288 if (uaddr_len
< sizeof(struct sockaddr_tipc
)) {
293 if (addr
->family
!= AF_TIPC
) {
297 if (addr
->addrtype
== TIPC_ADDR_NAME
)
298 addr
->addr
.nameseq
.upper
= addr
->addr
.nameseq
.lower
;
299 else if (addr
->addrtype
!= TIPC_ADDR_NAMESEQ
) {
305 res
= tipc_publish(tsock
->p
->ref
, addr
->scope
,
306 &addr
->addr
.nameseq
);
308 res
= tipc_withdraw(tsock
->p
->ref
, -addr
->scope
,
309 &addr
->addr
.nameseq
);
311 mutex_unlock(&tsock
->lock
);
316 * get_name - get port ID of socket or peer socket
317 * @sock: socket structure
318 * @uaddr: area for returned socket address
319 * @uaddr_len: area for returned length of socket address
320 * @peer: 0 to obtain socket name, 1 to obtain peer socket name
322 * Returns 0 on success, errno otherwise
325 static int get_name(struct socket
*sock
, struct sockaddr
*uaddr
,
326 int *uaddr_len
, int peer
)
328 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
329 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)uaddr
;
332 if (mutex_lock_interruptible(&tsock
->lock
))
335 *uaddr_len
= sizeof(*addr
);
336 addr
->addrtype
= TIPC_ADDR_ID
;
337 addr
->family
= AF_TIPC
;
340 res
= tipc_peer(tsock
->p
->ref
, &addr
->addr
.id
);
342 res
= tipc_ownidentity(tsock
->p
->ref
, &addr
->addr
.id
);
343 addr
->addr
.name
.domain
= 0;
345 mutex_unlock(&tsock
->lock
);
350 * poll - read and possibly block on pollmask
351 * @file: file structure associated with the socket
352 * @sock: socket for which to calculate the poll bits
355 * Returns pollmask value
358 * It appears that the usual socket locking mechanisms are not useful here
359 * since the pollmask info is potentially out-of-date the moment this routine
360 * exits. TCP and other protocols seem to rely on higher level poll routines
361 * to handle any preventable race conditions, so TIPC will do the same ...
363 * TIPC sets the returned events as follows:
364 * a) POLLRDNORM and POLLIN are set if the socket's receive queue is non-empty
365 * or if a connection-oriented socket is does not have an active connection
366 * (i.e. a read operation will not block).
367 * b) POLLOUT is set except when a socket's connection has been terminated
368 * (i.e. a write operation will not block).
369 * c) POLLHUP is set when a socket's connection has been terminated.
371 * IMPORTANT: The fact that a read or write operation will not block does NOT
372 * imply that the operation will succeed!
375 static unsigned int poll(struct file
*file
, struct socket
*sock
,
378 struct sock
*sk
= sock
->sk
;
381 poll_wait(file
, sk
->sk_sleep
, wait
);
383 if (!skb_queue_empty(&sk
->sk_receive_queue
) ||
384 (sock
->state
== SS_UNCONNECTED
) ||
385 (sock
->state
== SS_DISCONNECTING
))
386 mask
= (POLLRDNORM
| POLLIN
);
390 if (sock
->state
== SS_DISCONNECTING
)
399 * dest_name_check - verify user is permitted to send to specified port name
400 * @dest: destination address
401 * @m: descriptor for message to be sent
403 * Prevents restricted configuration commands from being issued by
404 * unauthorized users.
406 * Returns 0 if permission is granted, otherwise errno
409 static int dest_name_check(struct sockaddr_tipc
*dest
, struct msghdr
*m
)
411 struct tipc_cfg_msg_hdr hdr
;
413 if (likely(dest
->addr
.name
.name
.type
>= TIPC_RESERVED_TYPES
))
415 if (likely(dest
->addr
.name
.name
.type
== TIPC_TOP_SRV
))
418 if (likely(dest
->addr
.name
.name
.type
!= TIPC_CFG_SRV
))
421 if (copy_from_user(&hdr
, m
->msg_iov
[0].iov_base
, sizeof(hdr
)))
423 if ((ntohs(hdr
.tcm_type
) & 0xC000) && (!capable(CAP_NET_ADMIN
)))
430 * send_msg - send message in connectionless manner
432 * @sock: socket structure
433 * @m: message to send
434 * @total_len: length of message
436 * Message must have an destination specified explicitly.
437 * Used for SOCK_RDM and SOCK_DGRAM messages,
438 * and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
439 * (Note: 'SYN+' is prohibited on SOCK_STREAM.)
441 * Returns the number of bytes sent on success, or errno otherwise
444 static int send_msg(struct kiocb
*iocb
, struct socket
*sock
,
445 struct msghdr
*m
, size_t total_len
)
447 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
448 struct sockaddr_tipc
*dest
= (struct sockaddr_tipc
*)m
->msg_name
;
454 return -EDESTADDRREQ
;
455 if (unlikely((m
->msg_namelen
< sizeof(*dest
)) ||
456 (dest
->family
!= AF_TIPC
)))
459 needs_conn
= (sock
->state
!= SS_READY
);
460 if (unlikely(needs_conn
)) {
461 if (sock
->state
== SS_LISTENING
)
463 if (sock
->state
!= SS_UNCONNECTED
)
465 if ((tsock
->p
->published
) ||
466 ((sock
->type
== SOCK_STREAM
) && (total_len
!= 0)))
468 if (dest
->addrtype
== TIPC_ADDR_NAME
) {
469 tsock
->p
->conn_type
= dest
->addr
.name
.name
.type
;
470 tsock
->p
->conn_instance
= dest
->addr
.name
.name
.instance
;
474 if (mutex_lock_interruptible(&tsock
->lock
))
479 /* Abort any pending connection attempts (very unlikely) */
481 while ((buf
= skb_dequeue(&sock
->sk
->sk_receive_queue
))) {
482 tipc_reject_msg(buf
, TIPC_ERR_NO_PORT
);
483 atomic_dec(&tipc_queue_size
);
486 sock
->state
= SS_CONNECTING
;
490 if (dest
->addrtype
== TIPC_ADDR_NAME
) {
491 if ((res
= dest_name_check(dest
, m
)))
493 res
= tipc_send2name(tsock
->p
->ref
,
494 &dest
->addr
.name
.name
,
495 dest
->addr
.name
.domain
,
499 else if (dest
->addrtype
== TIPC_ADDR_ID
) {
500 res
= tipc_send2port(tsock
->p
->ref
,
505 else if (dest
->addrtype
== TIPC_ADDR_MCAST
) {
510 if ((res
= dest_name_check(dest
, m
)))
512 res
= tipc_multicast(tsock
->p
->ref
,
518 if (likely(res
!= -ELINKCONG
)) {
520 mutex_unlock(&tsock
->lock
);
523 if (m
->msg_flags
& MSG_DONTWAIT
) {
527 if (wait_event_interruptible(*sock
->sk
->sk_sleep
,
528 !tsock
->p
->congested
)) {
536 * send_packet - send a connection-oriented message
538 * @sock: socket structure
539 * @m: message to send
540 * @total_len: length of message
542 * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
544 * Returns the number of bytes sent on success, or errno otherwise
547 static int send_packet(struct kiocb
*iocb
, struct socket
*sock
,
548 struct msghdr
*m
, size_t total_len
)
550 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
551 struct sockaddr_tipc
*dest
= (struct sockaddr_tipc
*)m
->msg_name
;
554 /* Handle implied connection establishment */
557 return send_msg(iocb
, sock
, m
, total_len
);
559 if (mutex_lock_interruptible(&tsock
->lock
)) {
564 if (unlikely(sock
->state
!= SS_CONNECTED
)) {
565 if (sock
->state
== SS_DISCONNECTING
)
572 res
= tipc_send(tsock
->p
->ref
, m
->msg_iovlen
, m
->msg_iov
);
573 if (likely(res
!= -ELINKCONG
)) {
575 mutex_unlock(&tsock
->lock
);
578 if (m
->msg_flags
& MSG_DONTWAIT
) {
582 if (wait_event_interruptible(*sock
->sk
->sk_sleep
,
583 !tsock
->p
->congested
)) {
591 * send_stream - send stream-oriented data
593 * @sock: socket structure
595 * @total_len: total length of data to be sent
597 * Used for SOCK_STREAM data.
599 * Returns the number of bytes sent on success (or partial success),
600 * or errno if no data sent
604 static int send_stream(struct kiocb
*iocb
, struct socket
*sock
,
605 struct msghdr
*m
, size_t total_len
)
607 struct tipc_port
*tport
;
608 struct msghdr my_msg
;
610 struct iovec
*curr_iov
;
612 char __user
*curr_start
;
619 /* Handle special cases where there is no connection */
621 if (unlikely(sock
->state
!= SS_CONNECTED
)) {
622 if (sock
->state
== SS_UNCONNECTED
)
623 return send_packet(iocb
, sock
, m
, total_len
);
624 else if (sock
->state
== SS_DISCONNECTING
)
630 if (unlikely(m
->msg_name
))
634 * Send each iovec entry using one or more messages
636 * Note: This algorithm is good for the most likely case
637 * (i.e. one large iovec entry), but could be improved to pass sets
638 * of small iovec entries into send_packet().
641 curr_iov
= m
->msg_iov
;
642 curr_iovlen
= m
->msg_iovlen
;
643 my_msg
.msg_iov
= &my_iov
;
644 my_msg
.msg_iovlen
= 1;
645 my_msg
.msg_flags
= m
->msg_flags
;
646 my_msg
.msg_name
= NULL
;
649 tport
= tipc_sk(sock
->sk
)->p
;
650 hdr_size
= msg_hdr_sz(&tport
->phdr
);
652 while (curr_iovlen
--) {
653 curr_start
= curr_iov
->iov_base
;
654 curr_left
= curr_iov
->iov_len
;
657 bytes_to_send
= tport
->max_pkt
- hdr_size
;
658 if (bytes_to_send
> TIPC_MAX_USER_MSG_SIZE
)
659 bytes_to_send
= TIPC_MAX_USER_MSG_SIZE
;
660 if (curr_left
< bytes_to_send
)
661 bytes_to_send
= curr_left
;
662 my_iov
.iov_base
= curr_start
;
663 my_iov
.iov_len
= bytes_to_send
;
664 if ((res
= send_packet(iocb
, sock
, &my_msg
, 0)) < 0) {
669 curr_left
-= bytes_to_send
;
670 curr_start
+= bytes_to_send
;
671 bytes_sent
+= bytes_to_send
;
681 * auto_connect - complete connection setup to a remote port
682 * @sock: socket structure
683 * @tsock: TIPC-specific socket structure
684 * @msg: peer's response message
686 * Returns 0 on success, errno otherwise
689 static int auto_connect(struct socket
*sock
, struct tipc_sock
*tsock
,
690 struct tipc_msg
*msg
)
692 struct tipc_portid peer
;
694 if (msg_errcode(msg
)) {
695 sock
->state
= SS_DISCONNECTING
;
696 return -ECONNREFUSED
;
699 peer
.ref
= msg_origport(msg
);
700 peer
.node
= msg_orignode(msg
);
701 tipc_connect2port(tsock
->p
->ref
, &peer
);
702 tipc_set_portimportance(tsock
->p
->ref
, msg_importance(msg
));
703 sock
->state
= SS_CONNECTED
;
708 * set_orig_addr - capture sender's address for received message
709 * @m: descriptor for message info
710 * @msg: received message header
712 * Note: Address is not captured if not requested by receiver.
715 static void set_orig_addr(struct msghdr
*m
, struct tipc_msg
*msg
)
717 struct sockaddr_tipc
*addr
= (struct sockaddr_tipc
*)m
->msg_name
;
720 addr
->family
= AF_TIPC
;
721 addr
->addrtype
= TIPC_ADDR_ID
;
722 addr
->addr
.id
.ref
= msg_origport(msg
);
723 addr
->addr
.id
.node
= msg_orignode(msg
);
724 addr
->addr
.name
.domain
= 0; /* could leave uninitialized */
725 addr
->scope
= 0; /* could leave uninitialized */
726 m
->msg_namelen
= sizeof(struct sockaddr_tipc
);
731 * anc_data_recv - optionally capture ancillary data for received message
732 * @m: descriptor for message info
733 * @msg: received message header
734 * @tport: TIPC port associated with message
736 * Note: Ancillary data is not captured if not requested by receiver.
738 * Returns 0 if successful, otherwise errno
741 static int anc_data_recv(struct msghdr
*m
, struct tipc_msg
*msg
,
742 struct tipc_port
*tport
)
750 if (likely(m
->msg_controllen
== 0))
753 /* Optionally capture errored message object(s) */
755 err
= msg
? msg_errcode(msg
) : 0;
758 anc_data
[1] = msg_data_sz(msg
);
759 if ((res
= put_cmsg(m
, SOL_TIPC
, TIPC_ERRINFO
, 8, anc_data
)))
762 (res
= put_cmsg(m
, SOL_TIPC
, TIPC_RETDATA
, anc_data
[1],
767 /* Optionally capture message destination object */
769 dest_type
= msg
? msg_type(msg
) : TIPC_DIRECT_MSG
;
773 anc_data
[0] = msg_nametype(msg
);
774 anc_data
[1] = msg_namelower(msg
);
775 anc_data
[2] = msg_namelower(msg
);
779 anc_data
[0] = msg_nametype(msg
);
780 anc_data
[1] = msg_namelower(msg
);
781 anc_data
[2] = msg_nameupper(msg
);
784 has_name
= (tport
->conn_type
!= 0);
785 anc_data
[0] = tport
->conn_type
;
786 anc_data
[1] = tport
->conn_instance
;
787 anc_data
[2] = tport
->conn_instance
;
793 (res
= put_cmsg(m
, SOL_TIPC
, TIPC_DESTNAME
, 12, anc_data
)))
800 * recv_msg - receive packet-oriented message
802 * @m: descriptor for message info
803 * @buf_len: total size of user buffer area
804 * @flags: receive flags
806 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
807 * If the complete message doesn't fit in user area, truncate it.
809 * Returns size of returned message data, errno otherwise
812 static int recv_msg(struct kiocb
*iocb
, struct socket
*sock
,
813 struct msghdr
*m
, size_t buf_len
, int flags
)
815 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
817 struct tipc_msg
*msg
;
823 /* Currently doesn't support receiving into multiple iovec entries */
825 if (m
->msg_iovlen
!= 1)
828 /* Catch invalid receive attempts */
830 if (unlikely(!buf_len
))
833 if (sock
->type
== SOCK_SEQPACKET
) {
834 if (unlikely(sock
->state
== SS_UNCONNECTED
))
836 if (unlikely((sock
->state
== SS_DISCONNECTING
) &&
837 (skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0)))
841 /* Look for a message in receive queue; wait if necessary */
843 if (unlikely(mutex_lock_interruptible(&tsock
->lock
)))
847 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
848 (flags
& MSG_DONTWAIT
))) {
853 if ((res
= wait_event_interruptible(
855 ((q_len
= skb_queue_len(&sock
->sk
->sk_receive_queue
)) ||
856 (sock
->state
== SS_DISCONNECTING
))) )) {
860 /* Catch attempt to receive on an already terminated connection */
861 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
868 /* Get access to first message in receive queue */
870 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
872 sz
= msg_data_sz(msg
);
873 err
= msg_errcode(msg
);
875 /* Complete connection setup for an implied connect */
877 if (unlikely(sock
->state
== SS_CONNECTING
)) {
878 if ((res
= auto_connect(sock
, tsock
, msg
)))
882 /* Discard an empty non-errored message & try again */
884 if ((!sz
) && (!err
)) {
885 advance_queue(tsock
);
889 /* Capture sender's address (optional) */
891 set_orig_addr(m
, msg
);
893 /* Capture ancillary data (optional) */
895 if ((res
= anc_data_recv(m
, msg
, tsock
->p
)))
898 /* Capture message data (if valid) & compute return value (always) */
901 if (unlikely(buf_len
< sz
)) {
903 m
->msg_flags
|= MSG_TRUNC
;
905 if (unlikely(copy_to_user(m
->msg_iov
->iov_base
, msg_data(msg
),
912 if ((sock
->state
== SS_READY
) ||
913 ((err
== TIPC_CONN_SHUTDOWN
) || m
->msg_control
))
919 /* Consume received message (optional) */
921 if (likely(!(flags
& MSG_PEEK
))) {
922 if ((sock
->state
!= SS_READY
) &&
923 (++tsock
->p
->conn_unacked
>= TIPC_FLOW_CONTROL_WIN
))
924 tipc_acknowledge(tsock
->p
->ref
, tsock
->p
->conn_unacked
);
925 advance_queue(tsock
);
928 mutex_unlock(&tsock
->lock
);
933 * recv_stream - receive stream-oriented data
935 * @m: descriptor for message info
936 * @buf_len: total size of user buffer area
937 * @flags: receive flags
939 * Used for SOCK_STREAM messages only. If not enough data is available
940 * will optionally wait for more; never truncates data.
942 * Returns size of returned message data, errno otherwise
945 static int recv_stream(struct kiocb
*iocb
, struct socket
*sock
,
946 struct msghdr
*m
, size_t buf_len
, int flags
)
948 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
950 struct tipc_msg
*msg
;
956 char __user
*crs
= m
->msg_iov
->iov_base
;
957 unsigned char *buf_crs
;
961 /* Currently doesn't support receiving into multiple iovec entries */
963 if (m
->msg_iovlen
!= 1)
966 /* Catch invalid receive attempts */
968 if (unlikely(!buf_len
))
971 if (unlikely(sock
->state
== SS_DISCONNECTING
)) {
972 if (skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0)
974 } else if (unlikely(sock
->state
!= SS_CONNECTED
))
977 /* Look for a message in receive queue; wait if necessary */
979 if (unlikely(mutex_lock_interruptible(&tsock
->lock
)))
983 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
984 (flags
& MSG_DONTWAIT
))) {
989 if ((res
= wait_event_interruptible(
991 ((q_len
= skb_queue_len(&sock
->sk
->sk_receive_queue
)) ||
992 (sock
->state
== SS_DISCONNECTING
))) )) {
996 /* Catch attempt to receive on an already terminated connection */
997 /* [THIS CHECK MAY OVERLAP WITH AN EARLIER CHECK] */
1004 /* Get access to first message in receive queue */
1006 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
1008 sz
= msg_data_sz(msg
);
1009 err
= msg_errcode(msg
);
1011 /* Discard an empty non-errored message & try again */
1013 if ((!sz
) && (!err
)) {
1014 advance_queue(tsock
);
1018 /* Optionally capture sender's address & ancillary data of first msg */
1020 if (sz_copied
== 0) {
1021 set_orig_addr(m
, msg
);
1022 if ((res
= anc_data_recv(m
, msg
, tsock
->p
)))
1026 /* Capture message data (if valid) & compute return value (always) */
1029 buf_crs
= (unsigned char *)(TIPC_SKB_CB(buf
)->handle
);
1030 sz
= (unsigned char *)msg
+ msg_size(msg
) - buf_crs
;
1032 needed
= (buf_len
- sz_copied
);
1033 sz_to_copy
= (sz
<= needed
) ? sz
: needed
;
1034 if (unlikely(copy_to_user(crs
, buf_crs
, sz_to_copy
))) {
1038 sz_copied
+= sz_to_copy
;
1040 if (sz_to_copy
< sz
) {
1041 if (!(flags
& MSG_PEEK
))
1042 TIPC_SKB_CB(buf
)->handle
= buf_crs
+ sz_to_copy
;
1049 goto exit
; /* can't add error msg to valid data */
1051 if ((err
== TIPC_CONN_SHUTDOWN
) || m
->msg_control
)
1057 /* Consume received message (optional) */
1059 if (likely(!(flags
& MSG_PEEK
))) {
1060 if (unlikely(++tsock
->p
->conn_unacked
>= TIPC_FLOW_CONTROL_WIN
))
1061 tipc_acknowledge(tsock
->p
->ref
, tsock
->p
->conn_unacked
);
1062 advance_queue(tsock
);
1065 /* Loop around if more data is required */
1067 if ((sz_copied
< buf_len
) /* didn't get all requested data */
1068 && (!skb_queue_empty(&sock
->sk
->sk_receive_queue
) ||
1069 (flags
& MSG_WAITALL
))
1070 /* ... and more is ready or required */
1071 && (!(flags
& MSG_PEEK
)) /* ... and aren't just peeking at data */
1072 && (!err
) /* ... and haven't reached a FIN */
1077 mutex_unlock(&tsock
->lock
);
1078 return sz_copied
? sz_copied
: res
;
1082 * queue_overloaded - test if queue overload condition exists
1083 * @queue_size: current size of queue
1084 * @base: nominal maximum size of queue
1085 * @msg: message to be added to queue
1087 * Returns 1 if queue is currently overloaded, 0 otherwise
1090 static int queue_overloaded(u32 queue_size
, u32 base
, struct tipc_msg
*msg
)
1093 u32 imp
= msg_importance(msg
);
1095 if (imp
== TIPC_LOW_IMPORTANCE
)
1097 else if (imp
== TIPC_MEDIUM_IMPORTANCE
)
1098 threshold
= base
* 2;
1099 else if (imp
== TIPC_HIGH_IMPORTANCE
)
1100 threshold
= base
* 100;
1104 if (msg_connected(msg
))
1107 return (queue_size
> threshold
);
1111 * async_disconnect - wrapper function used to disconnect port
1112 * @portref: TIPC port reference (passed as pointer-sized value)
1115 static void async_disconnect(unsigned long portref
)
1117 tipc_disconnect((u32
)portref
);
1121 * dispatch - handle arriving message
1122 * @tport: TIPC port that received message
1125 * Called with port locked. Must not take socket lock to avoid deadlock risk.
1127 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1130 static u32
dispatch(struct tipc_port
*tport
, struct sk_buff
*buf
)
1132 struct tipc_msg
*msg
= buf_msg(buf
);
1133 struct tipc_sock
*tsock
= (struct tipc_sock
*)tport
->usr_handle
;
1134 struct socket
*sock
;
1137 /* Reject message if socket is closing */
1140 return TIPC_ERR_NO_PORT
;
1142 /* Reject message if it is wrong sort of message for socket */
1145 * WOULD IT BE BETTER TO JUST DISCARD THESE MESSAGES INSTEAD?
1146 * "NO PORT" ISN'T REALLY THE RIGHT ERROR CODE, AND THERE MAY
1147 * BE SECURITY IMPLICATIONS INHERENT IN REJECTING INVALID TRAFFIC
1149 sock
= tsock
->sk
.sk_socket
;
1150 if (sock
->state
== SS_READY
) {
1151 if (msg_connected(msg
)) {
1152 msg_dbg(msg
, "dispatch filter 1\n");
1153 return TIPC_ERR_NO_PORT
;
1156 if (msg_mcast(msg
)) {
1157 msg_dbg(msg
, "dispatch filter 2\n");
1158 return TIPC_ERR_NO_PORT
;
1160 if (sock
->state
== SS_CONNECTED
) {
1161 if (!msg_connected(msg
)) {
1162 msg_dbg(msg
, "dispatch filter 3\n");
1163 return TIPC_ERR_NO_PORT
;
1166 else if (sock
->state
== SS_CONNECTING
) {
1167 if (!msg_connected(msg
) && (msg_errcode(msg
) == 0)) {
1168 msg_dbg(msg
, "dispatch filter 4\n");
1169 return TIPC_ERR_NO_PORT
;
1172 else if (sock
->state
== SS_LISTENING
) {
1173 if (msg_connected(msg
) || msg_errcode(msg
)) {
1174 msg_dbg(msg
, "dispatch filter 5\n");
1175 return TIPC_ERR_NO_PORT
;
1178 else if (sock
->state
== SS_DISCONNECTING
) {
1179 msg_dbg(msg
, "dispatch filter 6\n");
1180 return TIPC_ERR_NO_PORT
;
1182 else /* (sock->state == SS_UNCONNECTED) */ {
1183 if (msg_connected(msg
) || msg_errcode(msg
)) {
1184 msg_dbg(msg
, "dispatch filter 7\n");
1185 return TIPC_ERR_NO_PORT
;
1190 /* Reject message if there isn't room to queue it */
1192 if (unlikely((u32
)atomic_read(&tipc_queue_size
) >
1193 OVERLOAD_LIMIT_BASE
)) {
1194 if (queue_overloaded(atomic_read(&tipc_queue_size
),
1195 OVERLOAD_LIMIT_BASE
, msg
))
1196 return TIPC_ERR_OVERLOAD
;
1198 recv_q_len
= skb_queue_len(&tsock
->sk
.sk_receive_queue
);
1199 if (unlikely(recv_q_len
> (OVERLOAD_LIMIT_BASE
/ 2))) {
1200 if (queue_overloaded(recv_q_len
,
1201 OVERLOAD_LIMIT_BASE
/ 2, msg
))
1202 return TIPC_ERR_OVERLOAD
;
1205 /* Initiate connection termination for an incoming 'FIN' */
1207 if (unlikely(msg_errcode(msg
) && (sock
->state
== SS_CONNECTED
))) {
1208 sock
->state
= SS_DISCONNECTING
;
1209 /* Note: Use signal since port lock is already taken! */
1210 tipc_k_signal((Handler
)async_disconnect
, tport
->ref
);
1213 /* Enqueue message (finally!) */
1215 msg_dbg(msg
,"<DISP<: ");
1216 TIPC_SKB_CB(buf
)->handle
= msg_data(msg
);
1217 atomic_inc(&tipc_queue_size
);
1218 skb_queue_tail(&sock
->sk
->sk_receive_queue
, buf
);
1220 if (waitqueue_active(sock
->sk
->sk_sleep
))
1221 wake_up_interruptible(sock
->sk
->sk_sleep
);
1226 * wakeupdispatch - wake up port after congestion
1227 * @tport: port to wakeup
1229 * Called with port lock on.
1232 static void wakeupdispatch(struct tipc_port
*tport
)
1234 struct tipc_sock
*tsock
= (struct tipc_sock
*)tport
->usr_handle
;
1236 if (waitqueue_active(tsock
->sk
.sk_sleep
))
1237 wake_up_interruptible(tsock
->sk
.sk_sleep
);
1241 * connect - establish a connection to another TIPC port
1242 * @sock: socket structure
1243 * @dest: socket address for destination port
1244 * @destlen: size of socket address data structure
1247 * Returns 0 on success, errno otherwise
1250 static int connect(struct socket
*sock
, struct sockaddr
*dest
, int destlen
,
1253 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1254 struct sockaddr_tipc
*dst
= (struct sockaddr_tipc
*)dest
;
1255 struct msghdr m
= {NULL
,};
1256 struct sk_buff
*buf
;
1257 struct tipc_msg
*msg
;
1260 /* For now, TIPC does not allow use of connect() with DGRAM or RDM types */
1262 if (sock
->state
== SS_READY
)
1265 /* Issue Posix-compliant error code if socket is in the wrong state */
1267 if (sock
->state
== SS_LISTENING
)
1269 if (sock
->state
== SS_CONNECTING
)
1271 if (sock
->state
!= SS_UNCONNECTED
)
1275 * Reject connection attempt using multicast address
1277 * Note: send_msg() validates the rest of the address fields,
1278 * so there's no need to do it here
1281 if (dst
->addrtype
== TIPC_ADDR_MCAST
)
1284 /* Send a 'SYN-' to destination */
1287 m
.msg_namelen
= destlen
;
1288 if ((res
= send_msg(NULL
, sock
, &m
, 0)) < 0) {
1289 sock
->state
= SS_DISCONNECTING
;
1293 if (mutex_lock_interruptible(&tsock
->lock
))
1294 return -ERESTARTSYS
;
1296 /* Wait for destination's 'ACK' response */
1298 res
= wait_event_interruptible_timeout(*sock
->sk
->sk_sleep
,
1299 skb_queue_len(&sock
->sk
->sk_receive_queue
),
1300 sock
->sk
->sk_rcvtimeo
);
1301 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
1304 res
= auto_connect(sock
, tsock
, msg
);
1306 if (!msg_data_sz(msg
))
1307 advance_queue(tsock
);
1313 { /* leave "res" unchanged */ }
1314 sock
->state
= SS_DISCONNECTING
;
1317 mutex_unlock(&tsock
->lock
);
1322 * listen - allow socket to listen for incoming connections
1323 * @sock: socket structure
1326 * Returns 0 on success, errno otherwise
1329 static int listen(struct socket
*sock
, int len
)
1331 /* REQUIRES SOCKET LOCKING OF SOME SORT? */
1333 if (sock
->state
== SS_READY
)
1335 if (sock
->state
!= SS_UNCONNECTED
)
1337 sock
->state
= SS_LISTENING
;
1342 * accept - wait for connection request
1343 * @sock: listening socket
1344 * @newsock: new socket that is to be connected
1345 * @flags: file-related flags associated with socket
1347 * Returns 0 on success, errno otherwise
1350 static int accept(struct socket
*sock
, struct socket
*newsock
, int flags
)
1352 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1353 struct sk_buff
*buf
;
1356 if (sock
->state
== SS_READY
)
1358 if (sock
->state
!= SS_LISTENING
)
1361 if (unlikely((skb_queue_len(&sock
->sk
->sk_receive_queue
) == 0) &&
1362 (flags
& O_NONBLOCK
)))
1363 return -EWOULDBLOCK
;
1365 if (mutex_lock_interruptible(&tsock
->lock
))
1366 return -ERESTARTSYS
;
1368 if (wait_event_interruptible(*sock
->sk
->sk_sleep
,
1369 skb_queue_len(&sock
->sk
->sk_receive_queue
))) {
1373 buf
= skb_peek(&sock
->sk
->sk_receive_queue
);
1375 res
= tipc_create(sock_net(sock
->sk
), newsock
, 0);
1377 struct tipc_sock
*new_tsock
= tipc_sk(newsock
->sk
);
1378 struct tipc_portid id
;
1379 struct tipc_msg
*msg
= buf_msg(buf
);
1380 u32 new_ref
= new_tsock
->p
->ref
;
1382 id
.ref
= msg_origport(msg
);
1383 id
.node
= msg_orignode(msg
);
1384 tipc_connect2port(new_ref
, &id
);
1385 newsock
->state
= SS_CONNECTED
;
1387 tipc_set_portimportance(new_ref
, msg_importance(msg
));
1388 if (msg_named(msg
)) {
1389 new_tsock
->p
->conn_type
= msg_nametype(msg
);
1390 new_tsock
->p
->conn_instance
= msg_nameinst(msg
);
1394 * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1395 * Respond to 'SYN+' by queuing it on new socket.
1398 msg_dbg(msg
,"<ACC<: ");
1399 if (!msg_data_sz(msg
)) {
1400 struct msghdr m
= {NULL
,};
1402 send_packet(NULL
, newsock
, &m
, 0);
1403 advance_queue(tsock
);
1406 skb_dequeue(&sock
->sk
->sk_receive_queue
);
1408 skb_queue_head(&newsock
->sk
->sk_receive_queue
, buf
);
1412 mutex_unlock(&tsock
->lock
);
1417 * shutdown - shutdown socket connection
1418 * @sock: socket structure
1419 * @how: direction to close (must be SHUT_RDWR)
1421 * Terminates connection (if necessary), then purges socket's receive queue.
1423 * Returns 0 on success, errno otherwise
1426 static int shutdown(struct socket
*sock
, int how
)
1428 struct tipc_sock
* tsock
= tipc_sk(sock
->sk
);
1429 struct sk_buff
*buf
;
1432 if (how
!= SHUT_RDWR
)
1435 if (mutex_lock_interruptible(&tsock
->lock
))
1436 return -ERESTARTSYS
;
1440 switch (sock
->state
) {
1443 /* Send 'FIN+' or 'FIN-' message to peer */
1447 if ((buf
= skb_dequeue(&sock
->sk
->sk_receive_queue
))) {
1448 atomic_dec(&tipc_queue_size
);
1449 if (TIPC_SKB_CB(buf
)->handle
!= msg_data(buf_msg(buf
))) {
1453 tipc_reject_msg(buf
, TIPC_CONN_SHUTDOWN
);
1456 tipc_shutdown(tsock
->p
->ref
);
1462 case SS_DISCONNECTING
:
1464 /* Discard any unreceived messages */
1466 while ((buf
= skb_dequeue(&sock
->sk
->sk_receive_queue
))) {
1467 atomic_dec(&tipc_queue_size
);
1470 tsock
->p
->conn_unacked
= 0;
1475 sock
->state
= SS_DISCONNECTING
;
1485 mutex_unlock(&tsock
->lock
);
1490 * setsockopt - set socket option
1491 * @sock: socket structure
1492 * @lvl: option level
1493 * @opt: option identifier
1494 * @ov: pointer to new option value
1495 * @ol: length of option value
1497 * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1498 * (to ease compatibility).
1500 * Returns 0 on success, errno otherwise
1503 static int setsockopt(struct socket
*sock
,
1504 int lvl
, int opt
, char __user
*ov
, int ol
)
1506 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1510 if ((lvl
== IPPROTO_TCP
) && (sock
->type
== SOCK_STREAM
))
1512 if (lvl
!= SOL_TIPC
)
1513 return -ENOPROTOOPT
;
1514 if (ol
< sizeof(value
))
1516 if ((res
= get_user(value
, (u32 __user
*)ov
)))
1519 if (mutex_lock_interruptible(&tsock
->lock
))
1520 return -ERESTARTSYS
;
1523 case TIPC_IMPORTANCE
:
1524 res
= tipc_set_portimportance(tsock
->p
->ref
, value
);
1526 case TIPC_SRC_DROPPABLE
:
1527 if (sock
->type
!= SOCK_STREAM
)
1528 res
= tipc_set_portunreliable(tsock
->p
->ref
, value
);
1532 case TIPC_DEST_DROPPABLE
:
1533 res
= tipc_set_portunreturnable(tsock
->p
->ref
, value
);
1535 case TIPC_CONN_TIMEOUT
:
1536 sock
->sk
->sk_rcvtimeo
= msecs_to_jiffies(value
);
1542 mutex_unlock(&tsock
->lock
);
1547 * getsockopt - get socket option
1548 * @sock: socket structure
1549 * @lvl: option level
1550 * @opt: option identifier
1551 * @ov: receptacle for option value
1552 * @ol: receptacle for length of option value
1554 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1555 * (to ease compatibility).
1557 * Returns 0 on success, errno otherwise
1560 static int getsockopt(struct socket
*sock
,
1561 int lvl
, int opt
, char __user
*ov
, int __user
*ol
)
1563 struct tipc_sock
*tsock
= tipc_sk(sock
->sk
);
1568 if ((lvl
== IPPROTO_TCP
) && (sock
->type
== SOCK_STREAM
))
1569 return put_user(0, ol
);
1570 if (lvl
!= SOL_TIPC
)
1571 return -ENOPROTOOPT
;
1572 if ((res
= get_user(len
, ol
)))
1575 if (mutex_lock_interruptible(&tsock
->lock
))
1576 return -ERESTARTSYS
;
1579 case TIPC_IMPORTANCE
:
1580 res
= tipc_portimportance(tsock
->p
->ref
, &value
);
1582 case TIPC_SRC_DROPPABLE
:
1583 res
= tipc_portunreliable(tsock
->p
->ref
, &value
);
1585 case TIPC_DEST_DROPPABLE
:
1586 res
= tipc_portunreturnable(tsock
->p
->ref
, &value
);
1588 case TIPC_CONN_TIMEOUT
:
1589 value
= jiffies_to_msecs(sock
->sk
->sk_rcvtimeo
);
1598 else if (len
< sizeof(value
)) {
1601 else if ((res
= copy_to_user(ov
, &value
, sizeof(value
)))) {
1602 /* couldn't return value */
1605 res
= put_user(sizeof(value
), ol
);
1608 mutex_unlock(&tsock
->lock
);
1613 * Protocol switches for the various types of TIPC sockets
1616 static const struct proto_ops msg_ops
= {
1617 .owner
= THIS_MODULE
,
1622 .socketpair
= sock_no_socketpair
,
1624 .getname
= get_name
,
1626 .ioctl
= sock_no_ioctl
,
1628 .shutdown
= shutdown
,
1629 .setsockopt
= setsockopt
,
1630 .getsockopt
= getsockopt
,
1631 .sendmsg
= send_msg
,
1632 .recvmsg
= recv_msg
,
1633 .mmap
= sock_no_mmap
,
1634 .sendpage
= sock_no_sendpage
1637 static const struct proto_ops packet_ops
= {
1638 .owner
= THIS_MODULE
,
1643 .socketpair
= sock_no_socketpair
,
1645 .getname
= get_name
,
1647 .ioctl
= sock_no_ioctl
,
1649 .shutdown
= shutdown
,
1650 .setsockopt
= setsockopt
,
1651 .getsockopt
= getsockopt
,
1652 .sendmsg
= send_packet
,
1653 .recvmsg
= recv_msg
,
1654 .mmap
= sock_no_mmap
,
1655 .sendpage
= sock_no_sendpage
1658 static const struct proto_ops stream_ops
= {
1659 .owner
= THIS_MODULE
,
1664 .socketpair
= sock_no_socketpair
,
1666 .getname
= get_name
,
1668 .ioctl
= sock_no_ioctl
,
1670 .shutdown
= shutdown
,
1671 .setsockopt
= setsockopt
,
1672 .getsockopt
= getsockopt
,
1673 .sendmsg
= send_stream
,
1674 .recvmsg
= recv_stream
,
1675 .mmap
= sock_no_mmap
,
1676 .sendpage
= sock_no_sendpage
1679 static const struct net_proto_family tipc_family_ops
= {
1680 .owner
= THIS_MODULE
,
1682 .create
= tipc_create
1685 static struct proto tipc_proto
= {
1687 .owner
= THIS_MODULE
,
1688 .obj_size
= sizeof(struct tipc_sock
)
1692 * tipc_socket_init - initialize TIPC socket interface
1694 * Returns 0 on success, errno otherwise
1696 int tipc_socket_init(void)
1700 res
= proto_register(&tipc_proto
, 1);
1702 err("Failed to register TIPC protocol type\n");
1706 res
= sock_register(&tipc_family_ops
);
1708 err("Failed to register TIPC socket type\n");
1709 proto_unregister(&tipc_proto
);
1713 sockets_enabled
= 1;
1719 * tipc_socket_stop - stop TIPC socket interface
1721 void tipc_socket_stop(void)
1723 if (!sockets_enabled
)
1726 sockets_enabled
= 0;
1727 sock_unregister(tipc_family_ops
.family
);
1728 proto_unregister(&tipc_proto
);