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 #define CREATE_TRACE_POINTS
26 #include "ar-internal.h"
28 MODULE_DESCRIPTION("RxRPC network protocol");
29 MODULE_AUTHOR("Red Hat, Inc.");
30 MODULE_LICENSE("GPL");
31 MODULE_ALIAS_NETPROTO(PF_RXRPC
);
33 unsigned int rxrpc_debug
; // = RXRPC_DEBUG_KPROTO;
34 module_param_named(debug
, rxrpc_debug
, uint
, S_IWUSR
| S_IRUGO
);
35 MODULE_PARM_DESC(debug
, "RxRPC debugging mask");
37 static struct proto rxrpc_proto
;
38 static const struct proto_ops rxrpc_rpc_ops
;
40 /* local epoch for detecting local-end reset */
43 /* current debugging ID */
44 atomic_t rxrpc_debug_id
;
46 /* count of skbs currently in use */
47 atomic_t rxrpc_n_skbs
;
49 struct workqueue_struct
*rxrpc_workqueue
;
51 static void rxrpc_sock_destructor(struct sock
*);
54 * see if an RxRPC socket is currently writable
56 static inline int rxrpc_writable(struct sock
*sk
)
58 return atomic_read(&sk
->sk_wmem_alloc
) < (size_t) sk
->sk_sndbuf
;
62 * wait for write bufferage to become available
64 static void rxrpc_write_space(struct sock
*sk
)
68 if (rxrpc_writable(sk
)) {
69 struct socket_wq
*wq
= rcu_dereference(sk
->sk_wq
);
71 if (skwq_has_sleeper(wq
))
72 wake_up_interruptible(&wq
->wait
);
73 sk_wake_async(sk
, SOCK_WAKE_SPACE
, POLL_OUT
);
79 * validate an RxRPC address
81 static int rxrpc_validate_address(struct rxrpc_sock
*rx
,
82 struct sockaddr_rxrpc
*srx
,
87 if (len
< sizeof(struct sockaddr_rxrpc
))
90 if (srx
->srx_family
!= AF_RXRPC
)
93 if (srx
->transport_type
!= SOCK_DGRAM
)
94 return -ESOCKTNOSUPPORT
;
96 len
-= offsetof(struct sockaddr_rxrpc
, transport
);
97 if (srx
->transport_len
< sizeof(sa_family_t
) ||
98 srx
->transport_len
> len
)
101 if (srx
->transport
.family
!= rx
->family
)
102 return -EAFNOSUPPORT
;
104 switch (srx
->transport
.family
) {
106 if (srx
->transport_len
< sizeof(struct sockaddr_in
))
108 _debug("INET: %x @ %pI4",
109 ntohs(srx
->transport
.sin
.sin_port
),
110 &srx
->transport
.sin
.sin_addr
);
111 tail
= offsetof(struct sockaddr_rxrpc
, transport
.sin
.__pad
);
116 return -EAFNOSUPPORT
;
120 memset((void *)srx
+ tail
, 0, len
- tail
);
125 * bind a local address to an RxRPC socket
127 static int rxrpc_bind(struct socket
*sock
, struct sockaddr
*saddr
, int len
)
129 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*)saddr
;
130 struct sock
*sk
= sock
->sk
;
131 struct rxrpc_local
*local
;
132 struct rxrpc_sock
*rx
= rxrpc_sk(sk
), *prx
;
135 _enter("%p,%p,%d", rx
, saddr
, len
);
137 ret
= rxrpc_validate_address(rx
, srx
, len
);
143 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
) {
148 memcpy(&rx
->srx
, srx
, sizeof(rx
->srx
));
150 local
= rxrpc_lookup_local(&rx
->srx
);
152 ret
= PTR_ERR(local
);
156 if (rx
->srx
.srx_service
) {
157 write_lock_bh(&local
->services_lock
);
158 list_for_each_entry(prx
, &local
->services
, listen_link
) {
159 if (prx
->srx
.srx_service
== rx
->srx
.srx_service
)
164 list_add_tail(&rx
->listen_link
, &local
->services
);
165 write_unlock_bh(&local
->services_lock
);
167 rx
->sk
.sk_state
= RXRPC_SERVER_BOUND
;
170 rx
->sk
.sk_state
= RXRPC_CLIENT_BOUND
;
173 release_sock(&rx
->sk
);
178 write_unlock_bh(&local
->services_lock
);
179 rxrpc_put_local(local
);
182 release_sock(&rx
->sk
);
184 _leave(" = %d", ret
);
189 * set the number of pending calls permitted on a listening socket
191 static int rxrpc_listen(struct socket
*sock
, int backlog
)
193 struct sock
*sk
= sock
->sk
;
194 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
198 _enter("%p,%d", rx
, backlog
);
202 switch (rx
->sk
.sk_state
) {
204 ret
= -EADDRNOTAVAIL
;
206 case RXRPC_SERVER_BOUND
:
207 ASSERT(rx
->local
!= NULL
);
208 max
= READ_ONCE(rxrpc_max_backlog
);
210 if (backlog
== INT_MAX
)
212 else if (backlog
< 0 || backlog
> max
)
214 sk
->sk_max_ack_backlog
= backlog
;
215 rx
->sk
.sk_state
= RXRPC_SERVER_LISTENING
;
223 release_sock(&rx
->sk
);
224 _leave(" = %d", ret
);
229 * rxrpc_kernel_begin_call - Allow a kernel service to begin a call
230 * @sock: The socket on which to make the call
231 * @srx: The address of the peer to contact
232 * @key: The security context to use (defaults to socket setting)
233 * @user_call_ID: The ID to use
235 * Allow a kernel service to begin a call on the nominated socket. This just
236 * sets up all the internal tracking structures and allocates connection and
237 * call IDs as appropriate. The call to be used is returned.
239 * The default socket destination address and security may be overridden by
240 * supplying @srx and @key.
242 struct rxrpc_call
*rxrpc_kernel_begin_call(struct socket
*sock
,
243 struct sockaddr_rxrpc
*srx
,
245 unsigned long user_call_ID
,
248 struct rxrpc_conn_parameters cp
;
249 struct rxrpc_call
*call
;
250 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
253 _enter(",,%x,%lx", key_serial(key
), user_call_ID
);
255 ret
= rxrpc_validate_address(rx
, srx
, sizeof(*srx
));
263 if (key
&& !key
->payload
.data
[0])
264 key
= NULL
; /* a no-security key */
266 memset(&cp
, 0, sizeof(cp
));
267 cp
.local
= rx
->local
;
269 cp
.security_level
= 0;
270 cp
.exclusive
= false;
271 cp
.service_id
= srx
->srx_service
;
272 call
= rxrpc_new_client_call(rx
, &cp
, srx
, user_call_ID
, gfp
);
274 release_sock(&rx
->sk
);
275 _leave(" = %p", call
);
278 EXPORT_SYMBOL(rxrpc_kernel_begin_call
);
281 * rxrpc_kernel_end_call - Allow a kernel service to end a call it was using
282 * @sock: The socket the call is on
283 * @call: The call to end
285 * Allow a kernel service to end a call it was using. The call must be
286 * complete before this is called (the call should be aborted if necessary).
288 void rxrpc_kernel_end_call(struct socket
*sock
, struct rxrpc_call
*call
)
290 _enter("%d{%d}", call
->debug_id
, atomic_read(&call
->usage
));
291 rxrpc_remove_user_ID(rxrpc_sk(sock
->sk
), call
);
292 rxrpc_put_call(call
);
294 EXPORT_SYMBOL(rxrpc_kernel_end_call
);
297 * rxrpc_kernel_intercept_rx_messages - Intercept received RxRPC messages
298 * @sock: The socket to intercept received messages on
299 * @interceptor: The function to pass the messages to
301 * Allow a kernel service to intercept messages heading for the Rx queue on an
302 * RxRPC socket. They get passed to the specified function instead.
303 * @interceptor should free the socket buffers it is given. @interceptor is
304 * called with the socket receive queue spinlock held and softirqs disabled -
305 * this ensures that the messages will be delivered in the right order.
307 void rxrpc_kernel_intercept_rx_messages(struct socket
*sock
,
308 rxrpc_interceptor_t interceptor
)
310 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
313 rx
->interceptor
= interceptor
;
316 EXPORT_SYMBOL(rxrpc_kernel_intercept_rx_messages
);
319 * connect an RxRPC socket
320 * - this just targets it at a specific destination; no actual connection
321 * negotiation takes place
323 static int rxrpc_connect(struct socket
*sock
, struct sockaddr
*addr
,
324 int addr_len
, int flags
)
326 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*)addr
;
327 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
330 _enter("%p,%p,%d,%d", rx
, addr
, addr_len
, flags
);
332 ret
= rxrpc_validate_address(rx
, srx
, addr_len
);
334 _leave(" = %d [bad addr]", ret
);
341 if (test_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
))
344 switch (rx
->sk
.sk_state
) {
346 rx
->sk
.sk_state
= RXRPC_CLIENT_UNBOUND
;
347 case RXRPC_CLIENT_UNBOUND
:
348 case RXRPC_CLIENT_BOUND
:
355 rx
->connect_srx
= *srx
;
356 set_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
);
360 release_sock(&rx
->sk
);
365 * send a message through an RxRPC socket
366 * - in a client this does a number of things:
367 * - finds/sets up a connection for the security specified (if any)
368 * - initiates a call (ID in control data)
369 * - ends the request phase of a call (if MSG_MORE is not set)
370 * - sends a call data packet
371 * - may send an abort (abort code in control data)
373 static int rxrpc_sendmsg(struct socket
*sock
, struct msghdr
*m
, size_t len
)
375 struct rxrpc_local
*local
;
376 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
379 _enter(",{%d},,%zu", rx
->sk
.sk_state
, len
);
381 if (m
->msg_flags
& MSG_OOB
)
385 ret
= rxrpc_validate_address(rx
, m
->msg_name
, m
->msg_namelen
);
387 _leave(" = %d [bad addr]", ret
);
394 switch (rx
->sk
.sk_state
) {
396 local
= rxrpc_lookup_local(&rx
->srx
);
398 ret
= PTR_ERR(local
);
403 rx
->sk
.sk_state
= RXRPC_CLIENT_UNBOUND
;
406 case RXRPC_CLIENT_UNBOUND
:
407 case RXRPC_CLIENT_BOUND
:
409 test_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
)) {
410 m
->msg_name
= &rx
->connect_srx
;
411 m
->msg_namelen
= sizeof(rx
->connect_srx
);
413 case RXRPC_SERVER_BOUND
:
414 case RXRPC_SERVER_LISTENING
:
415 ret
= rxrpc_do_sendmsg(rx
, m
, len
);
423 release_sock(&rx
->sk
);
424 _leave(" = %d", ret
);
429 * set RxRPC socket options
431 static int rxrpc_setsockopt(struct socket
*sock
, int level
, int optname
,
432 char __user
*optval
, unsigned int optlen
)
434 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
435 unsigned int min_sec_level
;
438 _enter(",%d,%d,,%d", level
, optname
, optlen
);
443 if (level
== SOL_RXRPC
) {
445 case RXRPC_EXCLUSIVE_CONNECTION
:
450 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
452 rx
->exclusive
= true;
455 case RXRPC_SECURITY_KEY
:
460 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
462 ret
= rxrpc_request_key(rx
, optval
, optlen
);
465 case RXRPC_SECURITY_KEYRING
:
470 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
472 ret
= rxrpc_server_keyring(rx
, optval
, optlen
);
475 case RXRPC_MIN_SECURITY_LEVEL
:
477 if (optlen
!= sizeof(unsigned int))
480 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
482 ret
= get_user(min_sec_level
,
483 (unsigned int __user
*) optval
);
487 if (min_sec_level
> RXRPC_SECURITY_MAX
)
489 rx
->min_sec_level
= min_sec_level
;
500 release_sock(&rx
->sk
);
505 * permit an RxRPC socket to be polled
507 static unsigned int rxrpc_poll(struct file
*file
, struct socket
*sock
,
511 struct sock
*sk
= sock
->sk
;
513 sock_poll_wait(file
, sk_sleep(sk
), wait
);
516 /* the socket is readable if there are any messages waiting on the Rx
518 if (!skb_queue_empty(&sk
->sk_receive_queue
))
519 mask
|= POLLIN
| POLLRDNORM
;
521 /* the socket is writable if there is space to add new data to the
522 * socket; there is no guarantee that any particular call in progress
523 * on the socket may have space in the Tx ACK window */
524 if (rxrpc_writable(sk
))
525 mask
|= POLLOUT
| POLLWRNORM
;
531 * create an RxRPC socket
533 static int rxrpc_create(struct net
*net
, struct socket
*sock
, int protocol
,
536 struct rxrpc_sock
*rx
;
539 _enter("%p,%d", sock
, protocol
);
541 if (!net_eq(net
, &init_net
))
542 return -EAFNOSUPPORT
;
544 /* we support transport protocol UDP/UDP6 only */
545 if (protocol
!= PF_INET
)
546 return -EPROTONOSUPPORT
;
548 if (sock
->type
!= SOCK_DGRAM
)
549 return -ESOCKTNOSUPPORT
;
551 sock
->ops
= &rxrpc_rpc_ops
;
552 sock
->state
= SS_UNCONNECTED
;
554 sk
= sk_alloc(net
, PF_RXRPC
, GFP_KERNEL
, &rxrpc_proto
, kern
);
558 sock_init_data(sock
, sk
);
559 sk
->sk_state
= RXRPC_UNBOUND
;
560 sk
->sk_write_space
= rxrpc_write_space
;
561 sk
->sk_max_ack_backlog
= 0;
562 sk
->sk_destruct
= rxrpc_sock_destructor
;
565 rx
->family
= protocol
;
568 INIT_LIST_HEAD(&rx
->listen_link
);
569 INIT_LIST_HEAD(&rx
->secureq
);
570 INIT_LIST_HEAD(&rx
->acceptq
);
571 rwlock_init(&rx
->call_lock
);
572 memset(&rx
->srx
, 0, sizeof(rx
->srx
));
574 _leave(" = 0 [%p]", rx
);
579 * RxRPC socket destructor
581 static void rxrpc_sock_destructor(struct sock
*sk
)
585 rxrpc_purge_queue(&sk
->sk_receive_queue
);
587 WARN_ON(atomic_read(&sk
->sk_wmem_alloc
));
588 WARN_ON(!sk_unhashed(sk
));
589 WARN_ON(sk
->sk_socket
);
591 if (!sock_flag(sk
, SOCK_DEAD
)) {
592 printk("Attempt to release alive rxrpc socket: %p\n", sk
);
598 * release an RxRPC socket
600 static int rxrpc_release_sock(struct sock
*sk
)
602 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
604 _enter("%p{%d,%d}", sk
, sk
->sk_state
, atomic_read(&sk
->sk_refcnt
));
606 /* declare the socket closed for business */
608 sk
->sk_shutdown
= SHUTDOWN_MASK
;
610 spin_lock_bh(&sk
->sk_receive_queue
.lock
);
611 sk
->sk_state
= RXRPC_CLOSE
;
612 spin_unlock_bh(&sk
->sk_receive_queue
.lock
);
614 ASSERTCMP(rx
->listen_link
.next
, !=, LIST_POISON1
);
616 if (!list_empty(&rx
->listen_link
)) {
617 write_lock_bh(&rx
->local
->services_lock
);
618 list_del(&rx
->listen_link
);
619 write_unlock_bh(&rx
->local
->services_lock
);
622 /* try to flush out this socket */
623 rxrpc_release_calls_on_socket(rx
);
624 flush_workqueue(rxrpc_workqueue
);
625 rxrpc_purge_queue(&sk
->sk_receive_queue
);
627 rxrpc_put_local(rx
->local
);
631 key_put(rx
->securities
);
632 rx
->securities
= NULL
;
640 * release an RxRPC BSD socket on close() or equivalent
642 static int rxrpc_release(struct socket
*sock
)
644 struct sock
*sk
= sock
->sk
;
646 _enter("%p{%p}", sock
, sk
);
653 return rxrpc_release_sock(sk
);
657 * RxRPC network protocol
659 static const struct proto_ops rxrpc_rpc_ops
= {
661 .owner
= THIS_MODULE
,
662 .release
= rxrpc_release
,
664 .connect
= rxrpc_connect
,
665 .socketpair
= sock_no_socketpair
,
666 .accept
= sock_no_accept
,
667 .getname
= sock_no_getname
,
669 .ioctl
= sock_no_ioctl
,
670 .listen
= rxrpc_listen
,
671 .shutdown
= sock_no_shutdown
,
672 .setsockopt
= rxrpc_setsockopt
,
673 .getsockopt
= sock_no_getsockopt
,
674 .sendmsg
= rxrpc_sendmsg
,
675 .recvmsg
= rxrpc_recvmsg
,
676 .mmap
= sock_no_mmap
,
677 .sendpage
= sock_no_sendpage
,
680 static struct proto rxrpc_proto
= {
682 .owner
= THIS_MODULE
,
683 .obj_size
= sizeof(struct rxrpc_sock
),
684 .max_header
= sizeof(struct rxrpc_wire_header
),
687 static const struct net_proto_family rxrpc_family_ops
= {
689 .create
= rxrpc_create
,
690 .owner
= THIS_MODULE
,
694 * initialise and register the RxRPC protocol
696 static int __init
af_rxrpc_init(void)
700 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv
) > FIELD_SIZEOF(struct sk_buff
, cb
));
702 rxrpc_epoch
= get_seconds();
705 rxrpc_call_jar
= kmem_cache_create(
706 "rxrpc_call_jar", sizeof(struct rxrpc_call
), 0,
707 SLAB_HWCACHE_ALIGN
, NULL
);
708 if (!rxrpc_call_jar
) {
709 pr_notice("Failed to allocate call jar\n");
713 rxrpc_workqueue
= alloc_workqueue("krxrpcd", 0, 1);
714 if (!rxrpc_workqueue
) {
715 pr_notice("Failed to allocate work queue\n");
716 goto error_work_queue
;
719 ret
= rxrpc_init_security();
721 pr_crit("Cannot initialise security\n");
725 ret
= proto_register(&rxrpc_proto
, 1);
727 pr_crit("Cannot register protocol\n");
731 ret
= sock_register(&rxrpc_family_ops
);
733 pr_crit("Cannot register socket family\n");
737 ret
= register_key_type(&key_type_rxrpc
);
739 pr_crit("Cannot register client key type\n");
743 ret
= register_key_type(&key_type_rxrpc_s
);
745 pr_crit("Cannot register server key type\n");
746 goto error_key_type_s
;
749 ret
= rxrpc_sysctl_init();
751 pr_crit("Cannot register sysctls\n");
755 #ifdef CONFIG_PROC_FS
756 proc_create("rxrpc_calls", 0, init_net
.proc_net
, &rxrpc_call_seq_fops
);
757 proc_create("rxrpc_conns", 0, init_net
.proc_net
,
758 &rxrpc_connection_seq_fops
);
763 unregister_key_type(&key_type_rxrpc_s
);
765 unregister_key_type(&key_type_rxrpc
);
767 sock_unregister(PF_RXRPC
);
769 proto_unregister(&rxrpc_proto
);
771 rxrpc_exit_security();
773 destroy_workqueue(rxrpc_workqueue
);
775 kmem_cache_destroy(rxrpc_call_jar
);
781 * unregister the RxRPC protocol
783 static void __exit
af_rxrpc_exit(void)
787 unregister_key_type(&key_type_rxrpc_s
);
788 unregister_key_type(&key_type_rxrpc
);
789 sock_unregister(PF_RXRPC
);
790 proto_unregister(&rxrpc_proto
);
791 rxrpc_destroy_all_calls();
792 rxrpc_destroy_all_connections();
793 ASSERTCMP(atomic_read(&rxrpc_n_skbs
), ==, 0);
794 rxrpc_destroy_all_locals();
796 remove_proc_entry("rxrpc_conns", init_net
.proc_net
);
797 remove_proc_entry("rxrpc_calls", init_net
.proc_net
);
798 destroy_workqueue(rxrpc_workqueue
);
799 rxrpc_exit_security();
800 kmem_cache_destroy(rxrpc_call_jar
);
804 module_init(af_rxrpc_init
);
805 module_exit(af_rxrpc_exit
);