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/random.h>
20 #include <linux/poll.h>
21 #include <linux/proc_fs.h>
22 #include <linux/key-type.h>
23 #include <net/net_namespace.h>
25 #include <net/af_rxrpc.h>
26 #define CREATE_TRACE_POINTS
27 #include "ar-internal.h"
29 MODULE_DESCRIPTION("RxRPC network protocol");
30 MODULE_AUTHOR("Red Hat, Inc.");
31 MODULE_LICENSE("GPL");
32 MODULE_ALIAS_NETPROTO(PF_RXRPC
);
34 unsigned int rxrpc_debug
; // = RXRPC_DEBUG_KPROTO;
35 module_param_named(debug
, rxrpc_debug
, uint
, S_IWUSR
| S_IRUGO
);
36 MODULE_PARM_DESC(debug
, "RxRPC debugging mask");
38 static struct proto rxrpc_proto
;
39 static const struct proto_ops rxrpc_rpc_ops
;
41 /* local epoch for detecting local-end reset */
44 /* current debugging ID */
45 atomic_t rxrpc_debug_id
;
47 /* count of skbs currently in use */
48 atomic_t rxrpc_n_skbs
;
50 struct workqueue_struct
*rxrpc_workqueue
;
52 static void rxrpc_sock_destructor(struct sock
*);
55 * see if an RxRPC socket is currently writable
57 static inline int rxrpc_writable(struct sock
*sk
)
59 return atomic_read(&sk
->sk_wmem_alloc
) < (size_t) sk
->sk_sndbuf
;
63 * wait for write bufferage to become available
65 static void rxrpc_write_space(struct sock
*sk
)
69 if (rxrpc_writable(sk
)) {
70 struct socket_wq
*wq
= rcu_dereference(sk
->sk_wq
);
72 if (skwq_has_sleeper(wq
))
73 wake_up_interruptible(&wq
->wait
);
74 sk_wake_async(sk
, SOCK_WAKE_SPACE
, POLL_OUT
);
80 * validate an RxRPC address
82 static int rxrpc_validate_address(struct rxrpc_sock
*rx
,
83 struct sockaddr_rxrpc
*srx
,
88 if (len
< sizeof(struct sockaddr_rxrpc
))
91 if (srx
->srx_family
!= AF_RXRPC
)
94 if (srx
->transport_type
!= SOCK_DGRAM
)
95 return -ESOCKTNOSUPPORT
;
97 len
-= offsetof(struct sockaddr_rxrpc
, transport
);
98 if (srx
->transport_len
< sizeof(sa_family_t
) ||
99 srx
->transport_len
> len
)
102 if (srx
->transport
.family
!= rx
->family
)
103 return -EAFNOSUPPORT
;
105 switch (srx
->transport
.family
) {
107 if (srx
->transport_len
< sizeof(struct sockaddr_in
))
109 _debug("INET: %x @ %pI4",
110 ntohs(srx
->transport
.sin
.sin_port
),
111 &srx
->transport
.sin
.sin_addr
);
112 tail
= offsetof(struct sockaddr_rxrpc
, transport
.sin
.__pad
);
117 return -EAFNOSUPPORT
;
121 memset((void *)srx
+ tail
, 0, len
- tail
);
126 * bind a local address to an RxRPC socket
128 static int rxrpc_bind(struct socket
*sock
, struct sockaddr
*saddr
, int len
)
130 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*)saddr
;
131 struct sock
*sk
= sock
->sk
;
132 struct rxrpc_local
*local
;
133 struct rxrpc_sock
*rx
= rxrpc_sk(sk
), *prx
;
136 _enter("%p,%p,%d", rx
, saddr
, len
);
138 ret
= rxrpc_validate_address(rx
, srx
, len
);
144 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
) {
149 memcpy(&rx
->srx
, srx
, sizeof(rx
->srx
));
151 local
= rxrpc_lookup_local(&rx
->srx
);
153 ret
= PTR_ERR(local
);
157 if (rx
->srx
.srx_service
) {
158 write_lock(&local
->services_lock
);
159 hlist_for_each_entry(prx
, &local
->services
, listen_link
) {
160 if (prx
->srx
.srx_service
== rx
->srx
.srx_service
)
165 hlist_add_head_rcu(&rx
->listen_link
, &local
->services
);
166 write_unlock(&local
->services_lock
);
168 rx
->sk
.sk_state
= RXRPC_SERVER_BOUND
;
171 rx
->sk
.sk_state
= RXRPC_CLIENT_BOUND
;
174 release_sock(&rx
->sk
);
179 write_unlock(&local
->services_lock
);
180 rxrpc_put_local(local
);
183 release_sock(&rx
->sk
);
185 _leave(" = %d", ret
);
190 * set the number of pending calls permitted on a listening socket
192 static int rxrpc_listen(struct socket
*sock
, int backlog
)
194 struct sock
*sk
= sock
->sk
;
195 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
196 unsigned int max
, old
;
199 _enter("%p,%d", rx
, backlog
);
203 switch (rx
->sk
.sk_state
) {
205 ret
= -EADDRNOTAVAIL
;
207 case RXRPC_SERVER_BOUND
:
208 ASSERT(rx
->local
!= NULL
);
209 max
= READ_ONCE(rxrpc_max_backlog
);
211 if (backlog
== INT_MAX
)
213 else if (backlog
< 0 || backlog
> max
)
215 old
= sk
->sk_max_ack_backlog
;
216 sk
->sk_max_ack_backlog
= backlog
;
217 ret
= rxrpc_service_prealloc(rx
, GFP_KERNEL
);
219 rx
->sk
.sk_state
= RXRPC_SERVER_LISTENING
;
221 sk
->sk_max_ack_backlog
= old
;
228 release_sock(&rx
->sk
);
229 _leave(" = %d", ret
);
234 * rxrpc_kernel_begin_call - Allow a kernel service to begin a call
235 * @sock: The socket on which to make the call
236 * @srx: The address of the peer to contact
237 * @key: The security context to use (defaults to socket setting)
238 * @user_call_ID: The ID to use
239 * @gfp: The allocation constraints
240 * @notify_rx: Where to send notifications instead of socket queue
242 * Allow a kernel service to begin a call on the nominated socket. This just
243 * sets up all the internal tracking structures and allocates connection and
244 * call IDs as appropriate. The call to be used is returned.
246 * The default socket destination address and security may be overridden by
247 * supplying @srx and @key.
249 struct rxrpc_call
*rxrpc_kernel_begin_call(struct socket
*sock
,
250 struct sockaddr_rxrpc
*srx
,
252 unsigned long user_call_ID
,
254 rxrpc_notify_rx_t notify_rx
)
256 struct rxrpc_conn_parameters cp
;
257 struct rxrpc_call
*call
;
258 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
261 _enter(",,%x,%lx", key_serial(key
), user_call_ID
);
263 ret
= rxrpc_validate_address(rx
, srx
, sizeof(*srx
));
271 if (key
&& !key
->payload
.data
[0])
272 key
= NULL
; /* a no-security key */
274 memset(&cp
, 0, sizeof(cp
));
275 cp
.local
= rx
->local
;
277 cp
.security_level
= 0;
278 cp
.exclusive
= false;
279 cp
.service_id
= srx
->srx_service
;
280 call
= rxrpc_new_client_call(rx
, &cp
, srx
, user_call_ID
, gfp
);
282 call
->notify_rx
= notify_rx
;
284 release_sock(&rx
->sk
);
285 _leave(" = %p", call
);
288 EXPORT_SYMBOL(rxrpc_kernel_begin_call
);
291 * rxrpc_kernel_end_call - Allow a kernel service to end a call it was using
292 * @sock: The socket the call is on
293 * @call: The call to end
295 * Allow a kernel service to end a call it was using. The call must be
296 * complete before this is called (the call should be aborted if necessary).
298 void rxrpc_kernel_end_call(struct socket
*sock
, struct rxrpc_call
*call
)
300 _enter("%d{%d}", call
->debug_id
, atomic_read(&call
->usage
));
301 rxrpc_release_call(rxrpc_sk(sock
->sk
), call
);
302 rxrpc_put_call(call
, rxrpc_call_put
);
304 EXPORT_SYMBOL(rxrpc_kernel_end_call
);
307 * rxrpc_kernel_new_call_notification - Get notifications of new calls
308 * @sock: The socket to intercept received messages on
309 * @notify_new_call: Function to be called when new calls appear
310 * @discard_new_call: Function to discard preallocated calls
312 * Allow a kernel service to be given notifications about new calls.
314 void rxrpc_kernel_new_call_notification(
316 rxrpc_notify_new_call_t notify_new_call
,
317 rxrpc_discard_new_call_t discard_new_call
)
319 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
321 rx
->notify_new_call
= notify_new_call
;
322 rx
->discard_new_call
= discard_new_call
;
324 EXPORT_SYMBOL(rxrpc_kernel_new_call_notification
);
327 * connect an RxRPC socket
328 * - this just targets it at a specific destination; no actual connection
329 * negotiation takes place
331 static int rxrpc_connect(struct socket
*sock
, struct sockaddr
*addr
,
332 int addr_len
, int flags
)
334 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*)addr
;
335 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
338 _enter("%p,%p,%d,%d", rx
, addr
, addr_len
, flags
);
340 ret
= rxrpc_validate_address(rx
, srx
, addr_len
);
342 _leave(" = %d [bad addr]", ret
);
349 if (test_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
))
352 switch (rx
->sk
.sk_state
) {
354 rx
->sk
.sk_state
= RXRPC_CLIENT_UNBOUND
;
355 case RXRPC_CLIENT_UNBOUND
:
356 case RXRPC_CLIENT_BOUND
:
363 rx
->connect_srx
= *srx
;
364 set_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
);
368 release_sock(&rx
->sk
);
373 * send a message through an RxRPC socket
374 * - in a client this does a number of things:
375 * - finds/sets up a connection for the security specified (if any)
376 * - initiates a call (ID in control data)
377 * - ends the request phase of a call (if MSG_MORE is not set)
378 * - sends a call data packet
379 * - may send an abort (abort code in control data)
381 static int rxrpc_sendmsg(struct socket
*sock
, struct msghdr
*m
, size_t len
)
383 struct rxrpc_local
*local
;
384 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
387 _enter(",{%d},,%zu", rx
->sk
.sk_state
, len
);
389 if (m
->msg_flags
& MSG_OOB
)
393 ret
= rxrpc_validate_address(rx
, m
->msg_name
, m
->msg_namelen
);
395 _leave(" = %d [bad addr]", ret
);
402 switch (rx
->sk
.sk_state
) {
404 local
= rxrpc_lookup_local(&rx
->srx
);
406 ret
= PTR_ERR(local
);
411 rx
->sk
.sk_state
= RXRPC_CLIENT_UNBOUND
;
414 case RXRPC_CLIENT_UNBOUND
:
415 case RXRPC_CLIENT_BOUND
:
417 test_bit(RXRPC_SOCK_CONNECTED
, &rx
->flags
)) {
418 m
->msg_name
= &rx
->connect_srx
;
419 m
->msg_namelen
= sizeof(rx
->connect_srx
);
421 case RXRPC_SERVER_BOUND
:
422 case RXRPC_SERVER_LISTENING
:
423 ret
= rxrpc_do_sendmsg(rx
, m
, len
);
431 release_sock(&rx
->sk
);
432 _leave(" = %d", ret
);
437 * set RxRPC socket options
439 static int rxrpc_setsockopt(struct socket
*sock
, int level
, int optname
,
440 char __user
*optval
, unsigned int optlen
)
442 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
443 unsigned int min_sec_level
;
446 _enter(",%d,%d,,%d", level
, optname
, optlen
);
451 if (level
== SOL_RXRPC
) {
453 case RXRPC_EXCLUSIVE_CONNECTION
:
458 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
460 rx
->exclusive
= true;
463 case RXRPC_SECURITY_KEY
:
468 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
470 ret
= rxrpc_request_key(rx
, optval
, optlen
);
473 case RXRPC_SECURITY_KEYRING
:
478 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
480 ret
= rxrpc_server_keyring(rx
, optval
, optlen
);
483 case RXRPC_MIN_SECURITY_LEVEL
:
485 if (optlen
!= sizeof(unsigned int))
488 if (rx
->sk
.sk_state
!= RXRPC_UNBOUND
)
490 ret
= get_user(min_sec_level
,
491 (unsigned int __user
*) optval
);
495 if (min_sec_level
> RXRPC_SECURITY_MAX
)
497 rx
->min_sec_level
= min_sec_level
;
508 release_sock(&rx
->sk
);
513 * permit an RxRPC socket to be polled
515 static unsigned int rxrpc_poll(struct file
*file
, struct socket
*sock
,
518 struct sock
*sk
= sock
->sk
;
519 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
522 sock_poll_wait(file
, sk_sleep(sk
), wait
);
525 /* the socket is readable if there are any messages waiting on the Rx
527 if (!list_empty(&rx
->recvmsg_q
))
528 mask
|= POLLIN
| POLLRDNORM
;
530 /* the socket is writable if there is space to add new data to the
531 * socket; there is no guarantee that any particular call in progress
532 * on the socket may have space in the Tx ACK window */
533 if (rxrpc_writable(sk
))
534 mask
|= POLLOUT
| POLLWRNORM
;
540 * create an RxRPC socket
542 static int rxrpc_create(struct net
*net
, struct socket
*sock
, int protocol
,
545 struct rxrpc_sock
*rx
;
548 _enter("%p,%d", sock
, protocol
);
550 if (!net_eq(net
, &init_net
))
551 return -EAFNOSUPPORT
;
553 /* we support transport protocol UDP/UDP6 only */
554 if (protocol
!= PF_INET
)
555 return -EPROTONOSUPPORT
;
557 if (sock
->type
!= SOCK_DGRAM
)
558 return -ESOCKTNOSUPPORT
;
560 sock
->ops
= &rxrpc_rpc_ops
;
561 sock
->state
= SS_UNCONNECTED
;
563 sk
= sk_alloc(net
, PF_RXRPC
, GFP_KERNEL
, &rxrpc_proto
, kern
);
567 sock_init_data(sock
, sk
);
568 sock_set_flag(sk
, SOCK_RCU_FREE
);
569 sk
->sk_state
= RXRPC_UNBOUND
;
570 sk
->sk_write_space
= rxrpc_write_space
;
571 sk
->sk_max_ack_backlog
= 0;
572 sk
->sk_destruct
= rxrpc_sock_destructor
;
575 rx
->family
= protocol
;
578 INIT_HLIST_NODE(&rx
->listen_link
);
579 spin_lock_init(&rx
->incoming_lock
);
580 INIT_LIST_HEAD(&rx
->sock_calls
);
581 INIT_LIST_HEAD(&rx
->to_be_accepted
);
582 INIT_LIST_HEAD(&rx
->recvmsg_q
);
583 rwlock_init(&rx
->recvmsg_lock
);
584 rwlock_init(&rx
->call_lock
);
585 memset(&rx
->srx
, 0, sizeof(rx
->srx
));
587 _leave(" = 0 [%p]", rx
);
592 * Kill all the calls on a socket and shut it down.
594 static int rxrpc_shutdown(struct socket
*sock
, int flags
)
596 struct sock
*sk
= sock
->sk
;
597 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
600 _enter("%p,%d", sk
, flags
);
602 if (flags
!= SHUT_RDWR
)
604 if (sk
->sk_state
== RXRPC_CLOSE
)
609 spin_lock_bh(&sk
->sk_receive_queue
.lock
);
610 if (sk
->sk_state
< RXRPC_CLOSE
) {
611 sk
->sk_state
= RXRPC_CLOSE
;
612 sk
->sk_shutdown
= SHUTDOWN_MASK
;
616 spin_unlock_bh(&sk
->sk_receive_queue
.lock
);
618 rxrpc_discard_prealloc(rx
);
625 * RxRPC socket destructor
627 static void rxrpc_sock_destructor(struct sock
*sk
)
631 rxrpc_purge_queue(&sk
->sk_receive_queue
);
633 WARN_ON(atomic_read(&sk
->sk_wmem_alloc
));
634 WARN_ON(!sk_unhashed(sk
));
635 WARN_ON(sk
->sk_socket
);
637 if (!sock_flag(sk
, SOCK_DEAD
)) {
638 printk("Attempt to release alive rxrpc socket: %p\n", sk
);
644 * release an RxRPC socket
646 static int rxrpc_release_sock(struct sock
*sk
)
648 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
650 _enter("%p{%d,%d}", sk
, sk
->sk_state
, atomic_read(&sk
->sk_refcnt
));
652 /* declare the socket closed for business */
654 sk
->sk_shutdown
= SHUTDOWN_MASK
;
656 spin_lock_bh(&sk
->sk_receive_queue
.lock
);
657 sk
->sk_state
= RXRPC_CLOSE
;
658 spin_unlock_bh(&sk
->sk_receive_queue
.lock
);
660 ASSERTCMP(rx
->listen_link
.next
, !=, LIST_POISON1
);
662 if (!hlist_unhashed(&rx
->listen_link
)) {
663 write_lock(&rx
->local
->services_lock
);
664 hlist_del_rcu(&rx
->listen_link
);
665 write_unlock(&rx
->local
->services_lock
);
668 /* try to flush out this socket */
669 rxrpc_discard_prealloc(rx
);
670 rxrpc_release_calls_on_socket(rx
);
671 flush_workqueue(rxrpc_workqueue
);
672 rxrpc_purge_queue(&sk
->sk_receive_queue
);
674 rxrpc_put_local(rx
->local
);
678 key_put(rx
->securities
);
679 rx
->securities
= NULL
;
687 * release an RxRPC BSD socket on close() or equivalent
689 static int rxrpc_release(struct socket
*sock
)
691 struct sock
*sk
= sock
->sk
;
693 _enter("%p{%p}", sock
, sk
);
700 return rxrpc_release_sock(sk
);
704 * RxRPC network protocol
706 static const struct proto_ops rxrpc_rpc_ops
= {
708 .owner
= THIS_MODULE
,
709 .release
= rxrpc_release
,
711 .connect
= rxrpc_connect
,
712 .socketpair
= sock_no_socketpair
,
713 .accept
= sock_no_accept
,
714 .getname
= sock_no_getname
,
716 .ioctl
= sock_no_ioctl
,
717 .listen
= rxrpc_listen
,
718 .shutdown
= rxrpc_shutdown
,
719 .setsockopt
= rxrpc_setsockopt
,
720 .getsockopt
= sock_no_getsockopt
,
721 .sendmsg
= rxrpc_sendmsg
,
722 .recvmsg
= rxrpc_recvmsg
,
723 .mmap
= sock_no_mmap
,
724 .sendpage
= sock_no_sendpage
,
727 static struct proto rxrpc_proto
= {
729 .owner
= THIS_MODULE
,
730 .obj_size
= sizeof(struct rxrpc_sock
),
731 .max_header
= sizeof(struct rxrpc_wire_header
),
734 static const struct net_proto_family rxrpc_family_ops
= {
736 .create
= rxrpc_create
,
737 .owner
= THIS_MODULE
,
741 * initialise and register the RxRPC protocol
743 static int __init
af_rxrpc_init(void)
747 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv
) > FIELD_SIZEOF(struct sk_buff
, cb
));
749 get_random_bytes(&rxrpc_epoch
, sizeof(rxrpc_epoch
));
750 rxrpc_epoch
|= RXRPC_RANDOM_EPOCH
;
751 get_random_bytes(&rxrpc_client_conn_ids
.cur
,
752 sizeof(rxrpc_client_conn_ids
.cur
));
753 rxrpc_client_conn_ids
.cur
&= 0x3fffffff;
754 if (rxrpc_client_conn_ids
.cur
== 0)
755 rxrpc_client_conn_ids
.cur
= 1;
758 rxrpc_call_jar
= kmem_cache_create(
759 "rxrpc_call_jar", sizeof(struct rxrpc_call
), 0,
760 SLAB_HWCACHE_ALIGN
, NULL
);
761 if (!rxrpc_call_jar
) {
762 pr_notice("Failed to allocate call jar\n");
766 rxrpc_workqueue
= alloc_workqueue("krxrpcd", 0, 1);
767 if (!rxrpc_workqueue
) {
768 pr_notice("Failed to allocate work queue\n");
769 goto error_work_queue
;
772 ret
= rxrpc_init_security();
774 pr_crit("Cannot initialise security\n");
778 ret
= proto_register(&rxrpc_proto
, 1);
780 pr_crit("Cannot register protocol\n");
784 ret
= sock_register(&rxrpc_family_ops
);
786 pr_crit("Cannot register socket family\n");
790 ret
= register_key_type(&key_type_rxrpc
);
792 pr_crit("Cannot register client key type\n");
796 ret
= register_key_type(&key_type_rxrpc_s
);
798 pr_crit("Cannot register server key type\n");
799 goto error_key_type_s
;
802 ret
= rxrpc_sysctl_init();
804 pr_crit("Cannot register sysctls\n");
808 #ifdef CONFIG_PROC_FS
809 proc_create("rxrpc_calls", 0, init_net
.proc_net
, &rxrpc_call_seq_fops
);
810 proc_create("rxrpc_conns", 0, init_net
.proc_net
,
811 &rxrpc_connection_seq_fops
);
816 unregister_key_type(&key_type_rxrpc_s
);
818 unregister_key_type(&key_type_rxrpc
);
820 sock_unregister(PF_RXRPC
);
822 proto_unregister(&rxrpc_proto
);
824 rxrpc_exit_security();
826 destroy_workqueue(rxrpc_workqueue
);
828 kmem_cache_destroy(rxrpc_call_jar
);
834 * unregister the RxRPC protocol
836 static void __exit
af_rxrpc_exit(void)
840 unregister_key_type(&key_type_rxrpc_s
);
841 unregister_key_type(&key_type_rxrpc
);
842 sock_unregister(PF_RXRPC
);
843 proto_unregister(&rxrpc_proto
);
844 rxrpc_destroy_all_calls();
845 rxrpc_destroy_all_connections();
846 ASSERTCMP(atomic_read(&rxrpc_n_skbs
), ==, 0);
847 rxrpc_destroy_all_locals();
849 remove_proc_entry("rxrpc_conns", init_net
.proc_net
);
850 remove_proc_entry("rxrpc_calls", init_net
.proc_net
);
851 destroy_workqueue(rxrpc_workqueue
);
852 rxrpc_exit_security();
853 kmem_cache_destroy(rxrpc_call_jar
);
857 module_init(af_rxrpc_init
);
858 module_exit(af_rxrpc_exit
);