1 /* AF_RXRPC implementation
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <linux/module.h>
15 #include <linux/kernel.h>
16 #include <linux/net.h>
17 #include <linux/slab.h>
18 #include <linux/skbuff.h>
19 #include <linux/poll.h>
20 #include <linux/proc_fs.h>
21 #include <linux/key-type.h>
22 #include <net/net_namespace.h>
24 #include <net/af_rxrpc.h>
25 #include "ar-internal.h"
27 MODULE_DESCRIPTION("RxRPC network protocol");
28 MODULE_AUTHOR("Red Hat, Inc.");
29 MODULE_LICENSE("GPL");
30 MODULE_ALIAS_NETPROTO(PF_RXRPC
);
32 unsigned int rxrpc_debug
; // = RXRPC_DEBUG_KPROTO;
33 module_param_named(debug
, rxrpc_debug
, uint
, S_IWUSR
| S_IRUGO
);
34 MODULE_PARM_DESC(debug
, "RxRPC debugging mask");
36 static struct proto rxrpc_proto
;
37 static const struct proto_ops rxrpc_rpc_ops
;
39 /* local epoch for detecting local-end reset */
42 /* current debugging ID */
43 atomic_t rxrpc_debug_id
;
45 /* count of skbs currently in use */
46 atomic_t rxrpc_n_skbs
;
48 struct workqueue_struct
*rxrpc_workqueue
;
50 static void rxrpc_sock_destructor(struct sock
*);
53 * see if an RxRPC socket is currently writable
55 static inline int rxrpc_writable(struct sock
*sk
)
57 return atomic_read(&sk
->sk_wmem_alloc
) < (size_t) sk
->sk_sndbuf
;
61 * wait for write bufferage to become available
63 static void rxrpc_write_space(struct sock
*sk
)
67 if (rxrpc_writable(sk
)) {
68 struct socket_wq
*wq
= rcu_dereference(sk
->sk_wq
);
70 if (skwq_has_sleeper(wq
))
71 wake_up_interruptible(&wq
->wait
);
72 sk_wake_async(sk
, SOCK_WAKE_SPACE
, POLL_OUT
);
78 * validate an RxRPC address
80 static int rxrpc_validate_address(struct rxrpc_sock
*rx
,
81 struct sockaddr_rxrpc
*srx
,
86 if (len
< sizeof(struct sockaddr_rxrpc
))
89 if (srx
->srx_family
!= AF_RXRPC
)
92 if (srx
->transport_type
!= SOCK_DGRAM
)
93 return -ESOCKTNOSUPPORT
;
95 len
-= offsetof(struct sockaddr_rxrpc
, transport
);
96 if (srx
->transport_len
< sizeof(sa_family_t
) ||
97 srx
->transport_len
> len
)
100 if (srx
->transport
.family
!= rx
->proto
)
101 return -EAFNOSUPPORT
;
103 switch (srx
->transport
.family
) {
105 _debug("INET: %x @ %pI4",
106 ntohs(srx
->transport
.sin
.sin_port
),
107 &srx
->transport
.sin
.sin_addr
);
108 tail
= offsetof(struct sockaddr_rxrpc
, transport
.sin
.__pad
);
113 return -EAFNOSUPPORT
;
117 memset((void *)srx
+ tail
, 0, len
- tail
);
122 * bind a local address to an RxRPC socket
124 static int rxrpc_bind(struct socket
*sock
, struct sockaddr
*saddr
, int len
)
126 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*)saddr
;
127 struct sock
*sk
= sock
->sk
;
128 struct rxrpc_local
*local
;
129 struct rxrpc_sock
*rx
= rxrpc_sk(sk
), *prx
;
132 _enter("%p,%p,%d", rx
, saddr
, len
);
134 ret
= rxrpc_validate_address(rx
, srx
, len
);
140 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
) {
145 memcpy(&rx
->srx
, srx
, sizeof(rx
->srx
));
147 local
= rxrpc_lookup_local(&rx
->srx
);
149 ret
= PTR_ERR(local
);
153 if (rx
->srx
.srx_service
) {
154 write_lock_bh(&local
->services_lock
);
155 list_for_each_entry(prx
, &local
->services
, listen_link
) {
156 if (prx
->srx
.srx_service
== rx
->srx
.srx_service
)
161 list_add_tail(&rx
->listen_link
, &local
->services
);
162 write_unlock_bh(&local
->services_lock
);
164 rx
->sk
.sk_state
= RXRPC_SERVER_BOUND
;
167 rx
->sk
.sk_state
= RXRPC_CLIENT_BOUND
;
170 release_sock(&rx
->sk
);
175 write_unlock_bh(&local
->services_lock
);
176 rxrpc_put_local(local
);
179 release_sock(&rx
->sk
);
181 _leave(" = %d", ret
);
186 * set the number of pending calls permitted on a listening socket
188 static int rxrpc_listen(struct socket
*sock
, int backlog
)
190 struct sock
*sk
= sock
->sk
;
191 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
195 _enter("%p,%d", rx
, backlog
);
199 switch (rx
->sk
.sk_state
) {
201 ret
= -EADDRNOTAVAIL
;
203 case RXRPC_SERVER_BOUND
:
204 ASSERT(rx
->local
!= NULL
);
205 max
= READ_ONCE(rxrpc_max_backlog
);
207 if (backlog
== INT_MAX
)
209 else if (backlog
< 0 || backlog
> max
)
211 sk
->sk_max_ack_backlog
= backlog
;
212 rx
->sk
.sk_state
= RXRPC_SERVER_LISTENING
;
220 release_sock(&rx
->sk
);
221 _leave(" = %d", ret
);
226 * find a transport by address
228 struct rxrpc_transport
*rxrpc_name_to_transport(struct rxrpc_sock
*rx
,
229 struct sockaddr
*addr
,
230 int addr_len
, int flags
,
233 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*) addr
;
234 struct rxrpc_transport
*trans
;
235 struct rxrpc_peer
*peer
;
237 _enter("%p,%p,%d,%d", rx
, addr
, addr_len
, flags
);
239 ASSERT(rx
->local
!= NULL
);
241 if (rx
->srx
.transport_type
!= srx
->transport_type
)
242 return ERR_PTR(-ESOCKTNOSUPPORT
);
243 if (rx
->srx
.transport
.family
!= srx
->transport
.family
)
244 return ERR_PTR(-EAFNOSUPPORT
);
246 /* find a remote transport endpoint from the local one */
247 peer
= rxrpc_get_peer(srx
, gfp
);
249 return ERR_CAST(peer
);
251 /* find a transport */
252 trans
= rxrpc_get_transport(rx
->local
, peer
, gfp
);
253 rxrpc_put_peer(peer
);
254 _leave(" = %p", trans
);
259 * rxrpc_kernel_begin_call - Allow a kernel service to begin a call
260 * @sock: The socket on which to make the call
261 * @srx: The address of the peer to contact
262 * @key: The security context to use (defaults to socket setting)
263 * @user_call_ID: The ID to use
265 * Allow a kernel service to begin a call on the nominated socket. This just
266 * sets up all the internal tracking structures and allocates connection and
267 * call IDs as appropriate. The call to be used is returned.
269 * The default socket destination address and security may be overridden by
270 * supplying @srx and @key.
272 struct rxrpc_call
*rxrpc_kernel_begin_call(struct socket
*sock
,
273 struct sockaddr_rxrpc
*srx
,
275 unsigned long user_call_ID
,
278 struct rxrpc_conn_bundle
*bundle
;
279 struct rxrpc_transport
*trans
;
280 struct rxrpc_call
*call
;
281 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
283 _enter(",,%x,%lx", key_serial(key
), user_call_ID
);
287 trans
= rxrpc_name_to_transport(rx
, (struct sockaddr
*)srx
,
288 sizeof(*srx
), 0, gfp
);
290 call
= ERR_CAST(trans
);
297 if (key
&& !key
->payload
.data
[0])
298 key
= NULL
; /* a no-security key */
300 bundle
= rxrpc_get_bundle(rx
, trans
, key
, srx
->srx_service
, gfp
);
301 if (IS_ERR(bundle
)) {
302 call
= ERR_CAST(bundle
);
306 call
= rxrpc_new_client_call(rx
, trans
, bundle
, user_call_ID
, gfp
);
307 rxrpc_put_bundle(trans
, bundle
);
309 rxrpc_put_transport(trans
);
311 release_sock(&rx
->sk
);
312 _leave(" = %p", call
);
315 EXPORT_SYMBOL(rxrpc_kernel_begin_call
);
318 * rxrpc_kernel_end_call - Allow a kernel service to end a call it was using
319 * @call: The call to end
321 * Allow a kernel service to end a call it was using. The call must be
322 * complete before this is called (the call should be aborted if necessary).
324 void rxrpc_kernel_end_call(struct rxrpc_call
*call
)
326 _enter("%d{%d}", call
->debug_id
, atomic_read(&call
->usage
));
327 rxrpc_remove_user_ID(call
->socket
, call
);
328 rxrpc_put_call(call
);
330 EXPORT_SYMBOL(rxrpc_kernel_end_call
);
333 * rxrpc_kernel_intercept_rx_messages - Intercept received RxRPC messages
334 * @sock: The socket to intercept received messages on
335 * @interceptor: The function to pass the messages to
337 * Allow a kernel service to intercept messages heading for the Rx queue on an
338 * RxRPC socket. They get passed to the specified function instead.
339 * @interceptor should free the socket buffers it is given. @interceptor is
340 * called with the socket receive queue spinlock held and softirqs disabled -
341 * this ensures that the messages will be delivered in the right order.
343 void rxrpc_kernel_intercept_rx_messages(struct socket
*sock
,
344 rxrpc_interceptor_t interceptor
)
346 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
349 rx
->interceptor
= interceptor
;
352 EXPORT_SYMBOL(rxrpc_kernel_intercept_rx_messages
);
355 * connect an RxRPC socket
356 * - this just targets it at a specific destination; no actual connection
357 * negotiation takes place
359 static int rxrpc_connect(struct socket
*sock
, struct sockaddr
*addr
,
360 int addr_len
, int flags
)
362 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*)addr
;
363 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
366 _enter("%p,%p,%d,%d", rx
, addr
, addr_len
, flags
);
368 ret
= rxrpc_validate_address(rx
, srx
, addr_len
);
370 _leave(" = %d [bad addr]", ret
);
377 if (test_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
))
380 switch (rx
->sk
.sk_state
) {
382 rx
->sk
.sk_state
= RXRPC_CLIENT_UNBOUND
;
383 case RXRPC_CLIENT_UNBOUND
:
384 case RXRPC_CLIENT_BOUND
:
391 rx
->connect_srx
= *srx
;
392 set_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
);
396 release_sock(&rx
->sk
);
401 * send a message through an RxRPC socket
402 * - in a client this does a number of things:
403 * - finds/sets up a connection for the security specified (if any)
404 * - initiates a call (ID in control data)
405 * - ends the request phase of a call (if MSG_MORE is not set)
406 * - sends a call data packet
407 * - may send an abort (abort code in control data)
409 static int rxrpc_sendmsg(struct socket
*sock
, struct msghdr
*m
, size_t len
)
411 struct rxrpc_local
*local
;
412 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
415 _enter(",{%d},,%zu", rx
->sk
.sk_state
, len
);
417 if (m
->msg_flags
& MSG_OOB
)
421 ret
= rxrpc_validate_address(rx
, m
->msg_name
, m
->msg_namelen
);
423 _leave(" = %d [bad addr]", ret
);
430 switch (rx
->sk
.sk_state
) {
432 local
= rxrpc_lookup_local(&rx
->srx
);
434 ret
= PTR_ERR(local
);
439 rx
->sk
.sk_state
= RXRPC_CLIENT_UNBOUND
;
442 case RXRPC_CLIENT_UNBOUND
:
443 case RXRPC_CLIENT_BOUND
:
445 test_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
)) {
446 m
->msg_name
= &rx
->connect_srx
;
447 m
->msg_namelen
= sizeof(rx
->connect_srx
);
449 case RXRPC_SERVER_BOUND
:
450 case RXRPC_SERVER_LISTENING
:
451 ret
= rxrpc_do_sendmsg(rx
, m
, len
);
459 release_sock(&rx
->sk
);
460 _leave(" = %d", ret
);
465 * set RxRPC socket options
467 static int rxrpc_setsockopt(struct socket
*sock
, int level
, int optname
,
468 char __user
*optval
, unsigned int optlen
)
470 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
471 unsigned int min_sec_level
;
474 _enter(",%d,%d,,%d", level
, optname
, optlen
);
479 if (level
== SOL_RXRPC
) {
481 case RXRPC_EXCLUSIVE_CONNECTION
:
486 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
488 set_bit(RXRPC_SOCK_EXCLUSIVE_CONN
, &rx
->flags
);
491 case RXRPC_SECURITY_KEY
:
496 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
498 ret
= rxrpc_request_key(rx
, optval
, optlen
);
501 case RXRPC_SECURITY_KEYRING
:
506 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
508 ret
= rxrpc_server_keyring(rx
, optval
, optlen
);
511 case RXRPC_MIN_SECURITY_LEVEL
:
513 if (optlen
!= sizeof(unsigned int))
516 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
518 ret
= get_user(min_sec_level
,
519 (unsigned int __user
*) optval
);
523 if (min_sec_level
> RXRPC_SECURITY_MAX
)
525 rx
->min_sec_level
= min_sec_level
;
536 release_sock(&rx
->sk
);
541 * permit an RxRPC socket to be polled
543 static unsigned int rxrpc_poll(struct file
*file
, struct socket
*sock
,
547 struct sock
*sk
= sock
->sk
;
549 sock_poll_wait(file
, sk_sleep(sk
), wait
);
552 /* the socket is readable if there are any messages waiting on the Rx
554 if (!skb_queue_empty(&sk
->sk_receive_queue
))
555 mask
|= POLLIN
| POLLRDNORM
;
557 /* the socket is writable if there is space to add new data to the
558 * socket; there is no guarantee that any particular call in progress
559 * on the socket may have space in the Tx ACK window */
560 if (rxrpc_writable(sk
))
561 mask
|= POLLOUT
| POLLWRNORM
;
567 * create an RxRPC socket
569 static int rxrpc_create(struct net
*net
, struct socket
*sock
, int protocol
,
572 struct rxrpc_sock
*rx
;
575 _enter("%p,%d", sock
, protocol
);
577 if (!net_eq(net
, &init_net
))
578 return -EAFNOSUPPORT
;
580 /* we support transport protocol UDP/UDP6 only */
581 if (protocol
!= PF_INET
)
582 return -EPROTONOSUPPORT
;
584 if (sock
->type
!= SOCK_DGRAM
)
585 return -ESOCKTNOSUPPORT
;
587 sock
->ops
= &rxrpc_rpc_ops
;
588 sock
->state
= SS_UNCONNECTED
;
590 sk
= sk_alloc(net
, PF_RXRPC
, GFP_KERNEL
, &rxrpc_proto
, kern
);
594 sock_init_data(sock
, sk
);
595 sk
->sk_state
= RXRPC_UNBOUND
;
596 sk
->sk_write_space
= rxrpc_write_space
;
597 sk
->sk_max_ack_backlog
= 0;
598 sk
->sk_destruct
= rxrpc_sock_destructor
;
601 rx
->proto
= protocol
;
604 INIT_LIST_HEAD(&rx
->listen_link
);
605 INIT_LIST_HEAD(&rx
->secureq
);
606 INIT_LIST_HEAD(&rx
->acceptq
);
607 rwlock_init(&rx
->call_lock
);
608 memset(&rx
->srx
, 0, sizeof(rx
->srx
));
610 _leave(" = 0 [%p]", rx
);
615 * RxRPC socket destructor
617 static void rxrpc_sock_destructor(struct sock
*sk
)
621 rxrpc_purge_queue(&sk
->sk_receive_queue
);
623 WARN_ON(atomic_read(&sk
->sk_wmem_alloc
));
624 WARN_ON(!sk_unhashed(sk
));
625 WARN_ON(sk
->sk_socket
);
627 if (!sock_flag(sk
, SOCK_DEAD
)) {
628 printk("Attempt to release alive rxrpc socket: %p\n", sk
);
634 * release an RxRPC socket
636 static int rxrpc_release_sock(struct sock
*sk
)
638 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
640 _enter("%p{%d,%d}", sk
, sk
->sk_state
, atomic_read(&sk
->sk_refcnt
));
642 /* declare the socket closed for business */
644 sk
->sk_shutdown
= SHUTDOWN_MASK
;
646 spin_lock_bh(&sk
->sk_receive_queue
.lock
);
647 sk
->sk_state
= RXRPC_CLOSE
;
648 spin_unlock_bh(&sk
->sk_receive_queue
.lock
);
650 ASSERTCMP(rx
->listen_link
.next
, !=, LIST_POISON1
);
652 if (!list_empty(&rx
->listen_link
)) {
653 write_lock_bh(&rx
->local
->services_lock
);
654 list_del(&rx
->listen_link
);
655 write_unlock_bh(&rx
->local
->services_lock
);
658 /* try to flush out this socket */
659 rxrpc_release_calls_on_socket(rx
);
660 flush_workqueue(rxrpc_workqueue
);
661 rxrpc_purge_queue(&sk
->sk_receive_queue
);
664 rxrpc_put_connection(rx
->conn
);
669 rxrpc_put_local(rx
->local
);
675 key_put(rx
->securities
);
676 rx
->securities
= NULL
;
684 * release an RxRPC BSD socket on close() or equivalent
686 static int rxrpc_release(struct socket
*sock
)
688 struct sock
*sk
= sock
->sk
;
690 _enter("%p{%p}", sock
, sk
);
697 return rxrpc_release_sock(sk
);
701 * RxRPC network protocol
703 static const struct proto_ops rxrpc_rpc_ops
= {
705 .owner
= THIS_MODULE
,
706 .release
= rxrpc_release
,
708 .connect
= rxrpc_connect
,
709 .socketpair
= sock_no_socketpair
,
710 .accept
= sock_no_accept
,
711 .getname
= sock_no_getname
,
713 .ioctl
= sock_no_ioctl
,
714 .listen
= rxrpc_listen
,
715 .shutdown
= sock_no_shutdown
,
716 .setsockopt
= rxrpc_setsockopt
,
717 .getsockopt
= sock_no_getsockopt
,
718 .sendmsg
= rxrpc_sendmsg
,
719 .recvmsg
= rxrpc_recvmsg
,
720 .mmap
= sock_no_mmap
,
721 .sendpage
= sock_no_sendpage
,
724 static struct proto rxrpc_proto
= {
726 .owner
= THIS_MODULE
,
727 .obj_size
= sizeof(struct rxrpc_sock
),
728 .max_header
= sizeof(struct rxrpc_wire_header
),
731 static const struct net_proto_family rxrpc_family_ops
= {
733 .create
= rxrpc_create
,
734 .owner
= THIS_MODULE
,
738 * initialise and register the RxRPC protocol
740 static int __init
af_rxrpc_init(void)
744 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv
) > FIELD_SIZEOF(struct sk_buff
, cb
));
746 rxrpc_epoch
= get_seconds();
749 rxrpc_call_jar
= kmem_cache_create(
750 "rxrpc_call_jar", sizeof(struct rxrpc_call
), 0,
751 SLAB_HWCACHE_ALIGN
, NULL
);
752 if (!rxrpc_call_jar
) {
753 pr_notice("Failed to allocate call jar\n");
757 rxrpc_workqueue
= alloc_workqueue("krxrpcd", 0, 1);
758 if (!rxrpc_workqueue
) {
759 pr_notice("Failed to allocate work queue\n");
760 goto error_work_queue
;
763 ret
= rxrpc_init_security();
765 pr_crit("Cannot initialise security\n");
769 ret
= proto_register(&rxrpc_proto
, 1);
771 pr_crit("Cannot register protocol\n");
775 ret
= sock_register(&rxrpc_family_ops
);
777 pr_crit("Cannot register socket family\n");
781 ret
= register_key_type(&key_type_rxrpc
);
783 pr_crit("Cannot register client key type\n");
787 ret
= register_key_type(&key_type_rxrpc_s
);
789 pr_crit("Cannot register server key type\n");
790 goto error_key_type_s
;
793 ret
= rxrpc_sysctl_init();
795 pr_crit("Cannot register sysctls\n");
799 #ifdef CONFIG_PROC_FS
800 proc_create("rxrpc_calls", 0, init_net
.proc_net
, &rxrpc_call_seq_fops
);
801 proc_create("rxrpc_conns", 0, init_net
.proc_net
,
802 &rxrpc_connection_seq_fops
);
807 unregister_key_type(&key_type_rxrpc_s
);
809 unregister_key_type(&key_type_rxrpc
);
811 sock_unregister(PF_RXRPC
);
813 proto_unregister(&rxrpc_proto
);
815 destroy_workqueue(rxrpc_workqueue
);
817 rxrpc_exit_security();
819 kmem_cache_destroy(rxrpc_call_jar
);
825 * unregister the RxRPC protocol
827 static void __exit
af_rxrpc_exit(void)
831 unregister_key_type(&key_type_rxrpc_s
);
832 unregister_key_type(&key_type_rxrpc
);
833 sock_unregister(PF_RXRPC
);
834 proto_unregister(&rxrpc_proto
);
835 rxrpc_destroy_all_calls();
836 rxrpc_destroy_all_connections();
837 rxrpc_destroy_all_transports();
838 rxrpc_destroy_all_peers();
839 rxrpc_destroy_all_locals();
841 ASSERTCMP(atomic_read(&rxrpc_n_skbs
), ==, 0);
843 _debug("flush scheduled work");
844 flush_workqueue(rxrpc_workqueue
);
845 remove_proc_entry("rxrpc_conns", init_net
.proc_net
);
846 remove_proc_entry("rxrpc_calls", init_net
.proc_net
);
847 destroy_workqueue(rxrpc_workqueue
);
848 rxrpc_exit_security();
849 kmem_cache_destroy(rxrpc_call_jar
);
853 module_init(af_rxrpc_init
);
854 module_exit(af_rxrpc_exit
);