2 * net/tipc/socket.c: TIPC socket API
4 * Copyright (c) 2001-2007, Ericsson AB
5 * Copyright (c) 2004-2008, 2010-2011, 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/export.h>
43 #define SS_LISTENING -1 /* socket is listening */
44 #define SS_READY -2 /* socket is connectionless */
46 #define OVERLOAD_LIMIT_BASE 5000
47 #define CONN_TIMEOUT_DEFAULT 8000 /* default connect timeout = 8s */
52 struct tipc_portid peer_name;
53 unsigned int conn_timeout;
56 #define tipc_sk(sk) ((struct tipc_sock *)(sk))
57 #define tipc_sk_port(sk) ((struct tipc_port *)(tipc_sk(sk)->p))
59 #define tipc_rx_ready(sock) (!skb_queue_empty(&sock->sk->sk_receive_queue) || \
60 (sock->state == SS_DISCONNECTING))
62 static int backlog_rcv(struct sock *sk, struct sk_buff *skb);
63 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf);
64 static void wakeupdispatch(struct tipc_port *tport);
66 static const struct proto_ops packet_ops;
67 static const struct proto_ops stream_ops;
68 static const struct proto_ops msg_ops;
70 static struct proto tipc_proto;
72 static int sockets_enabled;
74 static atomic_t tipc_queue_size = ATOMIC_INIT(0);
77 * Revised TIPC socket locking policy:
79 * Most socket operations take the standard socket lock when they start
80 * and hold it until they finish (or until they need to sleep). Acquiring
81 * this lock grants the owner exclusive access to the fields of the socket
82 * data structures, with the exception of the backlog queue. A few socket
83 * operations can be done without taking the socket lock because they only
84 * read socket information that never changes during the life of the socket.
86 * Socket operations may acquire the lock for the associated TIPC port if they
87 * need to perform an operation on the port. If any routine needs to acquire
88 * both the socket lock and the port lock it must take the socket lock first
89 * to avoid the risk of deadlock.
91 * The dispatcher handling incoming messages cannot grab the socket lock in
92 * the standard fashion, since invoked it runs at the BH level and cannot block.
93 * Instead, it checks to see if the socket lock is currently owned by someone,
94 * and either handles the message itself or adds it to the socket's backlog
95 * queue; in the latter case the queued message is processed once the process
96 * owning the socket lock releases it.
98 * NOTE: Releasing the socket lock while an operation is sleeping overcomes
99 * the problem of a blocked socket operation preventing any other operations
100 * from occurring. However, applications must be careful if they have
101 * multiple threads trying to send (or receive) on the same socket, as these
102 * operations might interfere with each other. For example, doing a connect
103 * and a receive at the same time might allow the receive to consume the
104 * ACK message meant for the connect. While additional work could be done
105 * to try and overcome this, it doesn't seem to be worthwhile at the present.
107 * NOTE: Releasing the socket lock while an operation is sleeping also ensures
108 * that another operation that must be performed in a non-blocking manner is
109 * not delayed for very long because the lock has already been taken.
111 * NOTE: This code assumes that certain fields of a port/socket pair are
112 * constant over its lifetime; such fields can be examined without taking
113 * the socket lock and/or port lock, and do not need to be re-read even
114 * after resuming processing after waiting. These fields include:
116 * - pointer to socket sk structure (aka tipc_sock structure)
117 * - pointer to port structure
122 * advance_rx_queue - discard first buffer in socket receive queue
124 * Caller must hold socket lock
126 static void advance_rx_queue(struct sock *sk)
128 kfree_skb(__skb_dequeue(&sk->sk_receive_queue));
129 atomic_dec(&tipc_queue_size);
133 * discard_rx_queue - discard all buffers in socket receive queue
135 * Caller must hold socket lock
137 static void discard_rx_queue(struct sock *sk)
141 while ((buf = __skb_dequeue(&sk->sk_receive_queue))) {
142 atomic_dec(&tipc_queue_size);
148 * reject_rx_queue - reject all buffers in socket receive queue
150 * Caller must hold socket lock
152 static void reject_rx_queue(struct sock *sk)
156 while ((buf = __skb_dequeue(&sk->sk_receive_queue))) {
157 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
158 atomic_dec(&tipc_queue_size);
163 * tipc_create - create a TIPC socket
164 * @net: network namespace (must be default network)
165 * @sock: pre-allocated socket structure
166 * @protocol: protocol indicator (must be 0)
167 * @kern: caused by kernel or by userspace?
169 * This routine creates additional data structures used by the TIPC socket,
170 * initializes them, and links them together.
172 * Returns 0 on success, errno otherwise
174 static int tipc_create(struct net *net, struct socket *sock, int protocol,
177 const struct proto_ops *ops;
180 struct tipc_port *tp_ptr;
182 /* Validate arguments */
183 if (unlikely(protocol != 0))
184 return -EPROTONOSUPPORT;
186 switch (sock->type) {
189 state = SS_UNCONNECTED;
193 state = SS_UNCONNECTED;
204 /* Allocate socket's protocol area */
205 sk = sk_alloc(net, AF_TIPC, GFP_KERNEL, &tipc_proto);
209 /* Allocate TIPC port for socket to use */
210 tp_ptr = tipc_createport_raw(sk, &dispatch, &wakeupdispatch,
211 TIPC_LOW_IMPORTANCE);
212 if (unlikely(!tp_ptr)) {
217 /* Finish initializing socket data structures */
221 sock_init_data(sock, sk);
222 sk->sk_backlog_rcv = backlog_rcv;
223 tipc_sk(sk)->p = tp_ptr;
224 tipc_sk(sk)->conn_timeout = CONN_TIMEOUT_DEFAULT;
226 spin_unlock_bh(tp_ptr->lock);
228 if (sock->state == SS_READY) {
229 tipc_set_portunreturnable(tp_ptr->ref, 1);
230 if (sock->type == SOCK_DGRAM)
231 tipc_set_portunreliable(tp_ptr->ref, 1);
238 * release - destroy a TIPC socket
239 * @sock: socket to destroy
241 * This routine cleans up any messages that are still queued on the socket.
242 * For DGRAM and RDM socket types, all queued messages are rejected.
243 * For SEQPACKET and STREAM socket types, the first message is rejected
244 * and any others are discarded. (If the first message on a STREAM socket
245 * is partially-read, it is discarded and the next one is rejected instead.)
247 * NOTE: Rejected messages are not necessarily returned to the sender! They
248 * are returned or discarded according to the "destination droppable" setting
249 * specified for the message by the sender.
251 * Returns 0 on success, errno otherwise
253 static int release(struct socket *sock)
255 struct sock *sk = sock->sk;
256 struct tipc_port *tport;
261 * Exit if socket isn't fully initialized (occurs when a failed accept()
262 * releases a pre-allocated child socket that was never used)
267 tport = tipc_sk_port(sk);
271 * Reject all unreceived messages, except on an active connection
272 * (which disconnects locally & sends a 'FIN+' to peer)
274 while (sock->state != SS_DISCONNECTING) {
275 buf = __skb_dequeue(&sk->sk_receive_queue);
278 atomic_dec(&tipc_queue_size);
279 if (TIPC_SKB_CB(buf)->handle != 0)
282 if ((sock->state == SS_CONNECTING) ||
283 (sock->state == SS_CONNECTED)) {
284 sock->state = SS_DISCONNECTING;
285 tipc_disconnect(tport->ref);
287 tipc_reject_msg(buf, TIPC_ERR_NO_PORT);
292 * Delete TIPC port; this ensures no more messages are queued
293 * (also disconnects an active connection & sends a 'FIN-' to peer)
295 res = tipc_deleteport(tport->ref);
297 /* Discard any remaining (connection-based) messages in receive queue */
298 discard_rx_queue(sk);
300 /* Reject any messages that accumulated in backlog queue */
301 sock->state = SS_DISCONNECTING;
311 * bind - associate or disassocate TIPC name(s) with a socket
312 * @sock: socket structure
313 * @uaddr: socket address describing name(s) and desired operation
314 * @uaddr_len: size of socket address data structure
316 * Name and name sequence binding is indicated using a positive scope value;
317 * a negative scope value unbinds the specified name. Specifying no name
318 * (i.e. a socket address length of 0) unbinds all names from the socket.
320 * Returns 0 on success, errno otherwise
322 * NOTE: This routine doesn't need to take the socket lock since it doesn't
323 * access any non-constant socket information.
325 static int bind(struct socket *sock, struct sockaddr *uaddr, int uaddr_len)
327 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
328 u32 portref = tipc_sk_port(sock->sk)->ref;
330 if (unlikely(!uaddr_len))
331 return tipc_withdraw(portref, 0, NULL);
333 if (uaddr_len < sizeof(struct sockaddr_tipc))
335 if (addr->family != AF_TIPC)
336 return -EAFNOSUPPORT;
338 if (addr->addrtype == TIPC_ADDR_NAME)
339 addr->addr.nameseq.upper = addr->addr.nameseq.lower;
340 else if (addr->addrtype != TIPC_ADDR_NAMESEQ)
341 return -EAFNOSUPPORT;
343 if (addr->addr.nameseq.type < TIPC_RESERVED_TYPES)
346 return (addr->scope > 0) ?
347 tipc_publish(portref, addr->scope, &addr->addr.nameseq) :
348 tipc_withdraw(portref, -addr->scope, &addr->addr.nameseq);
352 * get_name - get port ID of socket or peer socket
353 * @sock: socket structure
354 * @uaddr: area for returned socket address
355 * @uaddr_len: area for returned length of socket address
356 * @peer: 0 = own ID, 1 = current peer ID, 2 = current/former peer ID
358 * Returns 0 on success, errno otherwise
360 * NOTE: This routine doesn't need to take the socket lock since it only
361 * accesses socket information that is unchanging (or which changes in
362 * a completely predictable manner).
364 static int get_name(struct socket *sock, struct sockaddr *uaddr,
365 int *uaddr_len, int peer)
367 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)uaddr;
368 struct tipc_sock *tsock = tipc_sk(sock->sk);
370 memset(addr, 0, sizeof(*addr));
372 if ((sock->state != SS_CONNECTED) &&
373 ((peer != 2) || (sock->state != SS_DISCONNECTING)))
375 addr->addr.id.ref = tsock->peer_name.ref;
376 addr->addr.id.node = tsock->peer_name.node;
378 addr->addr.id.ref = tsock->p->ref;
379 addr->addr.id.node = tipc_own_addr;
382 *uaddr_len = sizeof(*addr);
383 addr->addrtype = TIPC_ADDR_ID;
384 addr->family = AF_TIPC;
386 addr->addr.name.domain = 0;
392 * poll - read and possibly block on pollmask
393 * @file: file structure associated with the socket
394 * @sock: socket for which to calculate the poll bits
397 * Returns pollmask value
400 * It appears that the usual socket locking mechanisms are not useful here
401 * since the pollmask info is potentially out-of-date the moment this routine
402 * exits. TCP and other protocols seem to rely on higher level poll routines
403 * to handle any preventable race conditions, so TIPC will do the same ...
405 * TIPC sets the returned events as follows:
407 * socket state flags set
408 * ------------ ---------
409 * unconnected no read flags
412 * connecting POLLIN/POLLRDNORM if ACK/NACK in rx queue
415 * connected POLLIN/POLLRDNORM if data in rx queue
416 * POLLOUT if port is not congested
418 * disconnecting POLLIN/POLLRDNORM/POLLHUP
421 * listening POLLIN if SYN in rx queue
424 * ready POLLIN/POLLRDNORM if data in rx queue
425 * [connectionless] POLLOUT (since port cannot be congested)
427 * IMPORTANT: The fact that a read or write operation is indicated does NOT
428 * imply that the operation will succeed, merely that it should be performed
429 * and will not block.
431 static unsigned int poll(struct file *file, struct socket *sock,
434 struct sock *sk = sock->sk;
437 poll_wait(file, sk_sleep(sk), wait);
439 switch ((int)sock->state) {
442 if (!tipc_sk_port(sk)->congested)
447 if (!skb_queue_empty(&sk->sk_receive_queue))
448 mask |= (POLLIN | POLLRDNORM);
450 case SS_DISCONNECTING:
451 mask = (POLLIN | POLLRDNORM | POLLHUP);
459 * dest_name_check - verify user is permitted to send to specified port name
460 * @dest: destination address
461 * @m: descriptor for message to be sent
463 * Prevents restricted configuration commands from being issued by
464 * unauthorized users.
466 * Returns 0 if permission is granted, otherwise errno
468 static int dest_name_check(struct sockaddr_tipc *dest, struct msghdr *m)
470 struct tipc_cfg_msg_hdr hdr;
472 if (likely(dest->addr.name.name.type >= TIPC_RESERVED_TYPES))
474 if (likely(dest->addr.name.name.type == TIPC_TOP_SRV))
476 if (likely(dest->addr.name.name.type != TIPC_CFG_SRV))
479 if (!m->msg_iovlen || (m->msg_iov[0].iov_len < sizeof(hdr)))
481 if (copy_from_user(&hdr, m->msg_iov[0].iov_base, sizeof(hdr)))
483 if ((ntohs(hdr.tcm_type) & 0xC000) && (!capable(CAP_NET_ADMIN)))
490 * send_msg - send message in connectionless manner
491 * @iocb: if NULL, indicates that socket lock is already held
492 * @sock: socket structure
493 * @m: message to send
494 * @total_len: length of message
496 * Message must have an destination specified explicitly.
497 * Used for SOCK_RDM and SOCK_DGRAM messages,
498 * and for 'SYN' messages on SOCK_SEQPACKET and SOCK_STREAM connections.
499 * (Note: 'SYN+' is prohibited on SOCK_STREAM.)
501 * Returns the number of bytes sent on success, or errno otherwise
503 static int send_msg(struct kiocb *iocb, struct socket *sock,
504 struct msghdr *m, size_t total_len)
506 struct sock *sk = sock->sk;
507 struct tipc_port *tport = tipc_sk_port(sk);
508 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
514 return -EDESTADDRREQ;
515 if (unlikely((m->msg_namelen < sizeof(*dest)) ||
516 (dest->family != AF_TIPC)))
518 if ((total_len > TIPC_MAX_USER_MSG_SIZE) ||
519 (m->msg_iovlen > (unsigned int)INT_MAX))
525 needs_conn = (sock->state != SS_READY);
526 if (unlikely(needs_conn)) {
527 if (sock->state == SS_LISTENING) {
531 if (sock->state != SS_UNCONNECTED) {
535 if ((tport->published) ||
536 ((sock->type == SOCK_STREAM) && (total_len != 0))) {
540 if (dest->addrtype == TIPC_ADDR_NAME) {
541 tport->conn_type = dest->addr.name.name.type;
542 tport->conn_instance = dest->addr.name.name.instance;
545 /* Abort any pending connection attempts (very unlikely) */
549 timeout_val = sock_sndtimeo(sk, m->msg_flags & MSG_DONTWAIT);
552 if (dest->addrtype == TIPC_ADDR_NAME) {
553 res = dest_name_check(dest, m);
556 res = tipc_send2name(tport->ref,
557 &dest->addr.name.name,
558 dest->addr.name.domain,
562 } else if (dest->addrtype == TIPC_ADDR_ID) {
563 res = tipc_send2port(tport->ref,
568 } else if (dest->addrtype == TIPC_ADDR_MCAST) {
573 res = dest_name_check(dest, m);
576 res = tipc_multicast(tport->ref,
582 if (likely(res != -ELINKCONG)) {
583 if (needs_conn && (res >= 0))
584 sock->state = SS_CONNECTING;
587 if (timeout_val <= 0L) {
588 res = timeout_val ? timeout_val : -EWOULDBLOCK;
592 timeout_val = wait_event_interruptible_timeout(*sk_sleep(sk),
593 !tport->congested, timeout_val);
604 * send_packet - send a connection-oriented message
605 * @iocb: if NULL, indicates that socket lock is already held
606 * @sock: socket structure
607 * @m: message to send
608 * @total_len: length of message
610 * Used for SOCK_SEQPACKET messages and SOCK_STREAM data.
612 * Returns the number of bytes sent on success, or errno otherwise
614 static int send_packet(struct kiocb *iocb, struct socket *sock,
615 struct msghdr *m, size_t total_len)
617 struct sock *sk = sock->sk;
618 struct tipc_port *tport = tipc_sk_port(sk);
619 struct sockaddr_tipc *dest = (struct sockaddr_tipc *)m->msg_name;
623 /* Handle implied connection establishment */
625 return send_msg(iocb, sock, m, total_len);
627 if ((total_len > TIPC_MAX_USER_MSG_SIZE) ||
628 (m->msg_iovlen > (unsigned int)INT_MAX))
634 timeout_val = sock_sndtimeo(sk, m->msg_flags & MSG_DONTWAIT);
637 if (unlikely(sock->state != SS_CONNECTED)) {
638 if (sock->state == SS_DISCONNECTING)
645 res = tipc_send(tport->ref, m->msg_iovlen, m->msg_iov,
647 if (likely(res != -ELINKCONG))
649 if (timeout_val <= 0L) {
650 res = timeout_val ? timeout_val : -EWOULDBLOCK;
654 timeout_val = wait_event_interruptible_timeout(*sk_sleep(sk),
655 (!tport->congested || !tport->connected), timeout_val);
665 * send_stream - send stream-oriented data
667 * @sock: socket structure
669 * @total_len: total length of data to be sent
671 * Used for SOCK_STREAM data.
673 * Returns the number of bytes sent on success (or partial success),
674 * or errno if no data sent
676 static int send_stream(struct kiocb *iocb, struct socket *sock,
677 struct msghdr *m, size_t total_len)
679 struct sock *sk = sock->sk;
680 struct tipc_port *tport = tipc_sk_port(sk);
681 struct msghdr my_msg;
683 struct iovec *curr_iov;
685 char __user *curr_start;
694 /* Handle special cases where there is no connection */
695 if (unlikely(sock->state != SS_CONNECTED)) {
696 if (sock->state == SS_UNCONNECTED) {
697 res = send_packet(NULL, sock, m, total_len);
699 } else if (sock->state == SS_DISCONNECTING) {
708 if (unlikely(m->msg_name)) {
713 if ((total_len > (unsigned int)INT_MAX) ||
714 (m->msg_iovlen > (unsigned int)INT_MAX)) {
720 * Send each iovec entry using one or more messages
722 * Note: This algorithm is good for the most likely case
723 * (i.e. one large iovec entry), but could be improved to pass sets
724 * of small iovec entries into send_packet().
726 curr_iov = m->msg_iov;
727 curr_iovlen = m->msg_iovlen;
728 my_msg.msg_iov = &my_iov;
729 my_msg.msg_iovlen = 1;
730 my_msg.msg_flags = m->msg_flags;
731 my_msg.msg_name = NULL;
734 hdr_size = msg_hdr_sz(&tport->phdr);
736 while (curr_iovlen--) {
737 curr_start = curr_iov->iov_base;
738 curr_left = curr_iov->iov_len;
741 bytes_to_send = tport->max_pkt - hdr_size;
742 if (bytes_to_send > TIPC_MAX_USER_MSG_SIZE)
743 bytes_to_send = TIPC_MAX_USER_MSG_SIZE;
744 if (curr_left < bytes_to_send)
745 bytes_to_send = curr_left;
746 my_iov.iov_base = curr_start;
747 my_iov.iov_len = bytes_to_send;
748 res = send_packet(NULL, sock, &my_msg, bytes_to_send);
754 curr_left -= bytes_to_send;
755 curr_start += bytes_to_send;
756 bytes_sent += bytes_to_send;
768 * auto_connect - complete connection setup to a remote port
769 * @sock: socket structure
770 * @msg: peer's response message
772 * Returns 0 on success, errno otherwise
774 static int auto_connect(struct socket *sock, struct tipc_msg *msg)
776 struct tipc_sock *tsock = tipc_sk(sock->sk);
778 if (msg_errcode(msg)) {
779 sock->state = SS_DISCONNECTING;
780 return -ECONNREFUSED;
783 tsock->peer_name.ref = msg_origport(msg);
784 tsock->peer_name.node = msg_orignode(msg);
785 tipc_connect2port(tsock->p->ref, &tsock->peer_name);
786 tipc_set_portimportance(tsock->p->ref, msg_importance(msg));
787 sock->state = SS_CONNECTED;
792 * set_orig_addr - capture sender's address for received message
793 * @m: descriptor for message info
794 * @msg: received message header
796 * Note: Address is not captured if not requested by receiver.
798 static void set_orig_addr(struct msghdr *m, struct tipc_msg *msg)
800 struct sockaddr_tipc *addr = (struct sockaddr_tipc *)m->msg_name;
803 addr->family = AF_TIPC;
804 addr->addrtype = TIPC_ADDR_ID;
805 addr->addr.id.ref = msg_origport(msg);
806 addr->addr.id.node = msg_orignode(msg);
807 addr->addr.name.domain = 0; /* could leave uninitialized */
808 addr->scope = 0; /* could leave uninitialized */
809 m->msg_namelen = sizeof(struct sockaddr_tipc);
814 * anc_data_recv - optionally capture ancillary data for received message
815 * @m: descriptor for message info
816 * @msg: received message header
817 * @tport: TIPC port associated with message
819 * Note: Ancillary data is not captured if not requested by receiver.
821 * Returns 0 if successful, otherwise errno
823 static int anc_data_recv(struct msghdr *m, struct tipc_msg *msg,
824 struct tipc_port *tport)
832 if (likely(m->msg_controllen == 0))
835 /* Optionally capture errored message object(s) */
836 err = msg ? msg_errcode(msg) : 0;
839 anc_data[1] = msg_data_sz(msg);
840 res = put_cmsg(m, SOL_TIPC, TIPC_ERRINFO, 8, anc_data);
844 res = put_cmsg(m, SOL_TIPC, TIPC_RETDATA, anc_data[1],
851 /* Optionally capture message destination object */
852 dest_type = msg ? msg_type(msg) : TIPC_DIRECT_MSG;
856 anc_data[0] = msg_nametype(msg);
857 anc_data[1] = msg_namelower(msg);
858 anc_data[2] = msg_namelower(msg);
862 anc_data[0] = msg_nametype(msg);
863 anc_data[1] = msg_namelower(msg);
864 anc_data[2] = msg_nameupper(msg);
867 has_name = (tport->conn_type != 0);
868 anc_data[0] = tport->conn_type;
869 anc_data[1] = tport->conn_instance;
870 anc_data[2] = tport->conn_instance;
876 res = put_cmsg(m, SOL_TIPC, TIPC_DESTNAME, 12, anc_data);
885 * recv_msg - receive packet-oriented message
887 * @m: descriptor for message info
888 * @buf_len: total size of user buffer area
889 * @flags: receive flags
891 * Used for SOCK_DGRAM, SOCK_RDM, and SOCK_SEQPACKET messages.
892 * If the complete message doesn't fit in user area, truncate it.
894 * Returns size of returned message data, errno otherwise
896 static int recv_msg(struct kiocb *iocb, struct socket *sock,
897 struct msghdr *m, size_t buf_len, int flags)
899 struct sock *sk = sock->sk;
900 struct tipc_port *tport = tipc_sk_port(sk);
902 struct tipc_msg *msg;
908 /* Catch invalid receive requests */
909 if (unlikely(!buf_len))
914 if (unlikely(sock->state == SS_UNCONNECTED)) {
919 timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
922 /* Look for a message in receive queue; wait if necessary */
923 while (skb_queue_empty(&sk->sk_receive_queue)) {
924 if (sock->state == SS_DISCONNECTING) {
929 res = timeout ? timeout : -EWOULDBLOCK;
933 timeout = wait_event_interruptible_timeout(*sk_sleep(sk),
939 /* Look at first message in receive queue */
940 buf = skb_peek(&sk->sk_receive_queue);
942 sz = msg_data_sz(msg);
943 err = msg_errcode(msg);
945 /* Complete connection setup for an implied connect */
946 if (unlikely(sock->state == SS_CONNECTING)) {
947 res = auto_connect(sock, msg);
952 /* Discard an empty non-errored message & try again */
953 if ((!sz) && (!err)) {
954 advance_rx_queue(sk);
958 /* Capture sender's address (optional) */
959 set_orig_addr(m, msg);
961 /* Capture ancillary data (optional) */
962 res = anc_data_recv(m, msg, tport);
966 /* Capture message data (if valid) & compute return value (always) */
968 if (unlikely(buf_len < sz)) {
970 m->msg_flags |= MSG_TRUNC;
972 res = skb_copy_datagram_iovec(buf, msg_hdr_sz(msg),
978 if ((sock->state == SS_READY) ||
979 ((err == TIPC_CONN_SHUTDOWN) || m->msg_control))
985 /* Consume received message (optional) */
986 if (likely(!(flags & MSG_PEEK))) {
987 if ((sock->state != SS_READY) &&
988 (++tport->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
989 tipc_acknowledge(tport->ref, tport->conn_unacked);
990 advance_rx_queue(sk);
998 * recv_stream - receive stream-oriented data
1000 * @m: descriptor for message info
1001 * @buf_len: total size of user buffer area
1002 * @flags: receive flags
1004 * Used for SOCK_STREAM messages only. If not enough data is available
1005 * will optionally wait for more; never truncates data.
1007 * Returns size of returned message data, errno otherwise
1009 static int recv_stream(struct kiocb *iocb, struct socket *sock,
1010 struct msghdr *m, size_t buf_len, int flags)
1012 struct sock *sk = sock->sk;
1013 struct tipc_port *tport = tipc_sk_port(sk);
1014 struct sk_buff *buf;
1015 struct tipc_msg *msg;
1018 int sz_to_copy, target, needed;
1023 /* Catch invalid receive attempts */
1024 if (unlikely(!buf_len))
1029 if (unlikely((sock->state == SS_UNCONNECTED) ||
1030 (sock->state == SS_CONNECTING))) {
1035 target = sock_rcvlowat(sk, flags & MSG_WAITALL, buf_len);
1036 timeout = sock_rcvtimeo(sk, flags & MSG_DONTWAIT);
1039 /* Look for a message in receive queue; wait if necessary */
1040 while (skb_queue_empty(&sk->sk_receive_queue)) {
1041 if (sock->state == SS_DISCONNECTING) {
1045 if (timeout <= 0L) {
1046 res = timeout ? timeout : -EWOULDBLOCK;
1050 timeout = wait_event_interruptible_timeout(*sk_sleep(sk),
1051 tipc_rx_ready(sock),
1056 /* Look at first message in receive queue */
1057 buf = skb_peek(&sk->sk_receive_queue);
1059 sz = msg_data_sz(msg);
1060 err = msg_errcode(msg);
1062 /* Discard an empty non-errored message & try again */
1063 if ((!sz) && (!err)) {
1064 advance_rx_queue(sk);
1068 /* Optionally capture sender's address & ancillary data of first msg */
1069 if (sz_copied == 0) {
1070 set_orig_addr(m, msg);
1071 res = anc_data_recv(m, msg, tport);
1076 /* Capture message data (if valid) & compute return value (always) */
1078 u32 offset = (u32)(unsigned long)(TIPC_SKB_CB(buf)->handle);
1081 needed = (buf_len - sz_copied);
1082 sz_to_copy = (sz <= needed) ? sz : needed;
1084 res = skb_copy_datagram_iovec(buf, msg_hdr_sz(msg) + offset,
1085 m->msg_iov, sz_to_copy);
1089 sz_copied += sz_to_copy;
1091 if (sz_to_copy < sz) {
1092 if (!(flags & MSG_PEEK))
1093 TIPC_SKB_CB(buf)->handle =
1094 (void *)(unsigned long)(offset + sz_to_copy);
1099 goto exit; /* can't add error msg to valid data */
1101 if ((err == TIPC_CONN_SHUTDOWN) || m->msg_control)
1107 /* Consume received message (optional) */
1108 if (likely(!(flags & MSG_PEEK))) {
1109 if (unlikely(++tport->conn_unacked >= TIPC_FLOW_CONTROL_WIN))
1110 tipc_acknowledge(tport->ref, tport->conn_unacked);
1111 advance_rx_queue(sk);
1114 /* Loop around if more data is required */
1115 if ((sz_copied < buf_len) && /* didn't get all requested data */
1116 (!skb_queue_empty(&sk->sk_receive_queue) ||
1117 (sz_copied < target)) && /* and more is ready or required */
1118 (!(flags & MSG_PEEK)) && /* and aren't just peeking at data */
1119 (!err)) /* and haven't reached a FIN */
1124 return sz_copied ? sz_copied : res;
1128 * rx_queue_full - determine if receive queue can accept another message
1129 * @msg: message to be added to queue
1130 * @queue_size: current size of queue
1131 * @base: nominal maximum size of queue
1133 * Returns 1 if queue is unable to accept message, 0 otherwise
1135 static int rx_queue_full(struct tipc_msg *msg, u32 queue_size, u32 base)
1138 u32 imp = msg_importance(msg);
1140 if (imp == TIPC_LOW_IMPORTANCE)
1142 else if (imp == TIPC_MEDIUM_IMPORTANCE)
1143 threshold = base * 2;
1144 else if (imp == TIPC_HIGH_IMPORTANCE)
1145 threshold = base * 100;
1149 if (msg_connected(msg))
1152 return queue_size >= threshold;
1156 * filter_rcv - validate incoming message
1160 * Enqueues message on receive queue if acceptable; optionally handles
1161 * disconnect indication for a connected socket.
1163 * Called with socket lock already taken; port lock may also be taken.
1165 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1167 static u32 filter_rcv(struct sock *sk, struct sk_buff *buf)
1169 struct socket *sock = sk->sk_socket;
1170 struct tipc_msg *msg = buf_msg(buf);
1173 /* Reject message if it is wrong sort of message for socket */
1174 if (msg_type(msg) > TIPC_DIRECT_MSG)
1175 return TIPC_ERR_NO_PORT;
1177 if (sock->state == SS_READY) {
1178 if (msg_connected(msg))
1179 return TIPC_ERR_NO_PORT;
1182 return TIPC_ERR_NO_PORT;
1183 if (sock->state == SS_CONNECTED) {
1184 if (!msg_connected(msg) ||
1185 !tipc_port_peer_msg(tipc_sk_port(sk), msg))
1186 return TIPC_ERR_NO_PORT;
1187 } else if (sock->state == SS_CONNECTING) {
1188 if (!msg_connected(msg) && (msg_errcode(msg) == 0))
1189 return TIPC_ERR_NO_PORT;
1190 } else if (sock->state == SS_LISTENING) {
1191 if (msg_connected(msg) || msg_errcode(msg))
1192 return TIPC_ERR_NO_PORT;
1193 } else if (sock->state == SS_DISCONNECTING) {
1194 return TIPC_ERR_NO_PORT;
1195 } else /* (sock->state == SS_UNCONNECTED) */ {
1196 if (msg_connected(msg) || msg_errcode(msg))
1197 return TIPC_ERR_NO_PORT;
1201 /* Reject message if there isn't room to queue it */
1202 recv_q_len = (u32)atomic_read(&tipc_queue_size);
1203 if (unlikely(recv_q_len >= OVERLOAD_LIMIT_BASE)) {
1204 if (rx_queue_full(msg, recv_q_len, OVERLOAD_LIMIT_BASE))
1205 return TIPC_ERR_OVERLOAD;
1207 recv_q_len = skb_queue_len(&sk->sk_receive_queue);
1208 if (unlikely(recv_q_len >= (OVERLOAD_LIMIT_BASE / 2))) {
1209 if (rx_queue_full(msg, recv_q_len, OVERLOAD_LIMIT_BASE / 2))
1210 return TIPC_ERR_OVERLOAD;
1213 /* Enqueue message (finally!) */
1214 TIPC_SKB_CB(buf)->handle = 0;
1215 atomic_inc(&tipc_queue_size);
1216 __skb_queue_tail(&sk->sk_receive_queue, buf);
1218 /* Initiate connection termination for an incoming 'FIN' */
1219 if (unlikely(msg_errcode(msg) && (sock->state == SS_CONNECTED))) {
1220 sock->state = SS_DISCONNECTING;
1221 tipc_disconnect_port(tipc_sk_port(sk));
1224 if (waitqueue_active(sk_sleep(sk)))
1225 wake_up_interruptible(sk_sleep(sk));
1230 * backlog_rcv - handle incoming message from backlog queue
1234 * Caller must hold socket lock, but not port lock.
1238 static int backlog_rcv(struct sock *sk, struct sk_buff *buf)
1242 res = filter_rcv(sk, buf);
1244 tipc_reject_msg(buf, res);
1249 * dispatch - handle incoming message
1250 * @tport: TIPC port that received message
1253 * Called with port lock already taken.
1255 * Returns TIPC error status code (TIPC_OK if message is not to be rejected)
1257 static u32 dispatch(struct tipc_port *tport, struct sk_buff *buf)
1259 struct sock *sk = (struct sock *)tport->usr_handle;
1263 * Process message if socket is unlocked; otherwise add to backlog queue
1265 * This code is based on sk_receive_skb(), but must be distinct from it
1266 * since a TIPC-specific filter/reject mechanism is utilized
1269 if (!sock_owned_by_user(sk)) {
1270 res = filter_rcv(sk, buf);
1272 if (sk_add_backlog(sk, buf, sk->sk_rcvbuf))
1273 res = TIPC_ERR_OVERLOAD;
1283 * wakeupdispatch - wake up port after congestion
1284 * @tport: port to wakeup
1286 * Called with port lock already taken.
1288 static void wakeupdispatch(struct tipc_port *tport)
1290 struct sock *sk = (struct sock *)tport->usr_handle;
1292 if (waitqueue_active(sk_sleep(sk)))
1293 wake_up_interruptible(sk_sleep(sk));
1297 * connect - establish a connection to another TIPC port
1298 * @sock: socket structure
1299 * @dest: socket address for destination port
1300 * @destlen: size of socket address data structure
1301 * @flags: file-related flags associated with socket
1303 * Returns 0 on success, errno otherwise
1305 static int connect(struct socket *sock, struct sockaddr *dest, int destlen,
1308 struct sock *sk = sock->sk;
1309 struct sockaddr_tipc *dst = (struct sockaddr_tipc *)dest;
1310 struct msghdr m = {NULL,};
1311 struct sk_buff *buf;
1312 struct tipc_msg *msg;
1313 unsigned int timeout;
1318 /* For now, TIPC does not allow use of connect() with DGRAM/RDM types */
1319 if (sock->state == SS_READY) {
1324 /* For now, TIPC does not support the non-blocking form of connect() */
1325 if (flags & O_NONBLOCK) {
1330 /* Issue Posix-compliant error code if socket is in the wrong state */
1331 if (sock->state == SS_LISTENING) {
1335 if (sock->state == SS_CONNECTING) {
1339 if (sock->state != SS_UNCONNECTED) {
1345 * Reject connection attempt using multicast address
1347 * Note: send_msg() validates the rest of the address fields,
1348 * so there's no need to do it here
1350 if (dst->addrtype == TIPC_ADDR_MCAST) {
1355 /* Reject any messages already in receive queue (very unlikely) */
1356 reject_rx_queue(sk);
1358 /* Send a 'SYN-' to destination */
1360 m.msg_namelen = destlen;
1361 res = send_msg(NULL, sock, &m, 0);
1365 /* Wait until an 'ACK' or 'RST' arrives, or a timeout occurs */
1366 timeout = tipc_sk(sk)->conn_timeout;
1368 res = wait_event_interruptible_timeout(*sk_sleep(sk),
1369 (!skb_queue_empty(&sk->sk_receive_queue) ||
1370 (sock->state != SS_CONNECTING)),
1371 timeout ? (long)msecs_to_jiffies(timeout)
1372 : MAX_SCHEDULE_TIMEOUT);
1376 buf = skb_peek(&sk->sk_receive_queue);
1379 res = auto_connect(sock, msg);
1381 if (!msg_data_sz(msg))
1382 advance_rx_queue(sk);
1385 if (sock->state == SS_CONNECTED)
1388 res = -ECONNREFUSED;
1394 ; /* leave "res" unchanged */
1395 sock->state = SS_DISCONNECTING;
1404 * listen - allow socket to listen for incoming connections
1405 * @sock: socket structure
1408 * Returns 0 on success, errno otherwise
1410 static int listen(struct socket *sock, int len)
1412 struct sock *sk = sock->sk;
1417 if (sock->state != SS_UNCONNECTED)
1420 sock->state = SS_LISTENING;
1429 * accept - wait for connection request
1430 * @sock: listening socket
1431 * @newsock: new socket that is to be connected
1432 * @flags: file-related flags associated with socket
1434 * Returns 0 on success, errno otherwise
1436 static int accept(struct socket *sock, struct socket *new_sock, int flags)
1438 struct sock *sk = sock->sk;
1439 struct sk_buff *buf;
1444 if (sock->state != SS_LISTENING) {
1449 while (skb_queue_empty(&sk->sk_receive_queue)) {
1450 if (flags & O_NONBLOCK) {
1455 res = wait_event_interruptible(*sk_sleep(sk),
1456 (!skb_queue_empty(&sk->sk_receive_queue)));
1462 buf = skb_peek(&sk->sk_receive_queue);
1464 res = tipc_create(sock_net(sock->sk), new_sock, 0, 0);
1466 struct sock *new_sk = new_sock->sk;
1467 struct tipc_sock *new_tsock = tipc_sk(new_sk);
1468 struct tipc_port *new_tport = new_tsock->p;
1469 u32 new_ref = new_tport->ref;
1470 struct tipc_msg *msg = buf_msg(buf);
1475 * Reject any stray messages received by new socket
1476 * before the socket lock was taken (very, very unlikely)
1478 reject_rx_queue(new_sk);
1480 /* Connect new socket to it's peer */
1481 new_tsock->peer_name.ref = msg_origport(msg);
1482 new_tsock->peer_name.node = msg_orignode(msg);
1483 tipc_connect2port(new_ref, &new_tsock->peer_name);
1484 new_sock->state = SS_CONNECTED;
1486 tipc_set_portimportance(new_ref, msg_importance(msg));
1487 if (msg_named(msg)) {
1488 new_tport->conn_type = msg_nametype(msg);
1489 new_tport->conn_instance = msg_nameinst(msg);
1493 * Respond to 'SYN-' by discarding it & returning 'ACK'-.
1494 * Respond to 'SYN+' by queuing it on new socket.
1496 if (!msg_data_sz(msg)) {
1497 struct msghdr m = {NULL,};
1499 advance_rx_queue(sk);
1500 send_packet(NULL, new_sock, &m, 0);
1502 __skb_dequeue(&sk->sk_receive_queue);
1503 __skb_queue_head(&new_sk->sk_receive_queue, buf);
1505 release_sock(new_sk);
1513 * shutdown - shutdown socket connection
1514 * @sock: socket structure
1515 * @how: direction to close (must be SHUT_RDWR)
1517 * Terminates connection (if necessary), then purges socket's receive queue.
1519 * Returns 0 on success, errno otherwise
1521 static int shutdown(struct socket *sock, int how)
1523 struct sock *sk = sock->sk;
1524 struct tipc_port *tport = tipc_sk_port(sk);
1525 struct sk_buff *buf;
1528 if (how != SHUT_RDWR)
1533 switch (sock->state) {
1538 /* Disconnect and send a 'FIN+' or 'FIN-' message to peer */
1539 buf = __skb_dequeue(&sk->sk_receive_queue);
1541 atomic_dec(&tipc_queue_size);
1542 if (TIPC_SKB_CB(buf)->handle != 0) {
1546 tipc_disconnect(tport->ref);
1547 tipc_reject_msg(buf, TIPC_CONN_SHUTDOWN);
1549 tipc_shutdown(tport->ref);
1552 sock->state = SS_DISCONNECTING;
1556 case SS_DISCONNECTING:
1558 /* Discard any unreceived messages; wake up sleeping tasks */
1559 discard_rx_queue(sk);
1560 if (waitqueue_active(sk_sleep(sk)))
1561 wake_up_interruptible(sk_sleep(sk));
1574 * setsockopt - set socket option
1575 * @sock: socket structure
1576 * @lvl: option level
1577 * @opt: option identifier
1578 * @ov: pointer to new option value
1579 * @ol: length of option value
1581 * For stream sockets only, accepts and ignores all IPPROTO_TCP options
1582 * (to ease compatibility).
1584 * Returns 0 on success, errno otherwise
1586 static int setsockopt(struct socket *sock,
1587 int lvl, int opt, char __user *ov, unsigned int ol)
1589 struct sock *sk = sock->sk;
1590 struct tipc_port *tport = tipc_sk_port(sk);
1594 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1596 if (lvl != SOL_TIPC)
1597 return -ENOPROTOOPT;
1598 if (ol < sizeof(value))
1600 res = get_user(value, (u32 __user *)ov);
1607 case TIPC_IMPORTANCE:
1608 res = tipc_set_portimportance(tport->ref, value);
1610 case TIPC_SRC_DROPPABLE:
1611 if (sock->type != SOCK_STREAM)
1612 res = tipc_set_portunreliable(tport->ref, value);
1616 case TIPC_DEST_DROPPABLE:
1617 res = tipc_set_portunreturnable(tport->ref, value);
1619 case TIPC_CONN_TIMEOUT:
1620 tipc_sk(sk)->conn_timeout = value;
1621 /* no need to set "res", since already 0 at this point */
1633 * getsockopt - get socket option
1634 * @sock: socket structure
1635 * @lvl: option level
1636 * @opt: option identifier
1637 * @ov: receptacle for option value
1638 * @ol: receptacle for length of option value
1640 * For stream sockets only, returns 0 length result for all IPPROTO_TCP options
1641 * (to ease compatibility).
1643 * Returns 0 on success, errno otherwise
1645 static int getsockopt(struct socket *sock,
1646 int lvl, int opt, char __user *ov, int __user *ol)
1648 struct sock *sk = sock->sk;
1649 struct tipc_port *tport = tipc_sk_port(sk);
1654 if ((lvl == IPPROTO_TCP) && (sock->type == SOCK_STREAM))
1655 return put_user(0, ol);
1656 if (lvl != SOL_TIPC)
1657 return -ENOPROTOOPT;
1658 res = get_user(len, ol);
1665 case TIPC_IMPORTANCE:
1666 res = tipc_portimportance(tport->ref, &value);
1668 case TIPC_SRC_DROPPABLE:
1669 res = tipc_portunreliable(tport->ref, &value);
1671 case TIPC_DEST_DROPPABLE:
1672 res = tipc_portunreturnable(tport->ref, &value);
1674 case TIPC_CONN_TIMEOUT:
1675 value = tipc_sk(sk)->conn_timeout;
1676 /* no need to set "res", since already 0 at this point */
1678 case TIPC_NODE_RECVQ_DEPTH:
1679 value = (u32)atomic_read(&tipc_queue_size);
1681 case TIPC_SOCK_RECVQ_DEPTH:
1682 value = skb_queue_len(&sk->sk_receive_queue);
1691 return res; /* "get" failed */
1693 if (len < sizeof(value))
1696 if (copy_to_user(ov, &value, sizeof(value)))
1699 return put_user(sizeof(value), ol);
1703 * Protocol switches for the various types of TIPC sockets
1705 static const struct proto_ops msg_ops = {
1706 .owner = THIS_MODULE,
1711 .socketpair = sock_no_socketpair,
1712 .accept = sock_no_accept,
1713 .getname = get_name,
1715 .ioctl = sock_no_ioctl,
1716 .listen = sock_no_listen,
1717 .shutdown = shutdown,
1718 .setsockopt = setsockopt,
1719 .getsockopt = getsockopt,
1720 .sendmsg = send_msg,
1721 .recvmsg = recv_msg,
1722 .mmap = sock_no_mmap,
1723 .sendpage = sock_no_sendpage
1726 static const struct proto_ops packet_ops = {
1727 .owner = THIS_MODULE,
1732 .socketpair = sock_no_socketpair,
1734 .getname = get_name,
1736 .ioctl = sock_no_ioctl,
1738 .shutdown = shutdown,
1739 .setsockopt = setsockopt,
1740 .getsockopt = getsockopt,
1741 .sendmsg = send_packet,
1742 .recvmsg = recv_msg,
1743 .mmap = sock_no_mmap,
1744 .sendpage = sock_no_sendpage
1747 static const struct proto_ops stream_ops = {
1748 .owner = THIS_MODULE,
1753 .socketpair = sock_no_socketpair,
1755 .getname = get_name,
1757 .ioctl = sock_no_ioctl,
1759 .shutdown = shutdown,
1760 .setsockopt = setsockopt,
1761 .getsockopt = getsockopt,
1762 .sendmsg = send_stream,
1763 .recvmsg = recv_stream,
1764 .mmap = sock_no_mmap,
1765 .sendpage = sock_no_sendpage
1768 static const struct net_proto_family tipc_family_ops = {
1769 .owner = THIS_MODULE,
1771 .create = tipc_create
1774 static struct proto tipc_proto = {
1776 .owner = THIS_MODULE,
1777 .obj_size = sizeof(struct tipc_sock)
1781 * tipc_socket_init - initialize TIPC socket interface
1783 * Returns 0 on success, errno otherwise
1785 int tipc_socket_init(void)
1789 res = proto_register(&tipc_proto, 1);
1791 err("Failed to register TIPC protocol type\n");
1795 res = sock_register(&tipc_family_ops);
1797 err("Failed to register TIPC socket type\n");
1798 proto_unregister(&tipc_proto);
1802 sockets_enabled = 1;
1808 * tipc_socket_stop - stop TIPC socket interface
1810 void tipc_socket_stop(void)
1812 if (!sockets_enabled)
1815 sockets_enabled = 0;
1816 sock_unregister(tipc_family_ops.family);
1817 proto_unregister(&tipc_proto);