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 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/net.h>
15 #include <linux/slab.h>
16 #include <linux/skbuff.h>
17 #include <linux/poll.h>
18 #include <linux/proc_fs.h>
19 #include <linux/key-type.h>
20 #include <net/net_namespace.h>
22 #include <net/af_rxrpc.h>
23 #include "ar-internal.h"
25 MODULE_DESCRIPTION("RxRPC network protocol");
26 MODULE_AUTHOR("Red Hat, Inc.");
27 MODULE_LICENSE("GPL");
28 MODULE_ALIAS_NETPROTO(PF_RXRPC);
30 unsigned int rxrpc_debug; // = RXRPC_DEBUG_KPROTO;
31 module_param_named(debug, rxrpc_debug, uint, S_IWUSR | S_IRUGO);
32 MODULE_PARM_DESC(debug, "RxRPC debugging mask");
34 static int sysctl_rxrpc_max_qlen __read_mostly = 10;
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_UNCONNECTED) {
145 memcpy(&rx->srx, srx, sizeof(rx->srx));
147 /* Find or create a local transport endpoint to use */
148 local = rxrpc_lookup_local(&rx->srx);
150 ret = PTR_ERR(local);
155 if (srx->srx_service) {
156 write_lock_bh(&local->services_lock);
157 list_for_each_entry(prx, &local->services, listen_link) {
158 if (prx->srx.srx_service == srx->srx_service)
162 list_add_tail(&rx->listen_link, &local->services);
163 write_unlock_bh(&local->services_lock);
165 rx->sk.sk_state = RXRPC_SERVER_BOUND;
167 rx->sk.sk_state = RXRPC_CLIENT_BOUND;
170 release_sock(&rx->sk);
176 write_unlock_bh(&local->services_lock);
178 release_sock(&rx->sk);
180 _leave(" = %d", ret);
185 * set the number of pending calls permitted on a listening socket
187 static int rxrpc_listen(struct socket *sock, int backlog)
189 struct sock *sk = sock->sk;
190 struct rxrpc_sock *rx = rxrpc_sk(sk);
193 _enter("%p,%d", rx, backlog);
197 switch (rx->sk.sk_state) {
198 case RXRPC_UNCONNECTED:
199 ret = -EADDRNOTAVAIL;
201 case RXRPC_CLIENT_BOUND:
202 case RXRPC_CLIENT_CONNECTED:
206 case RXRPC_SERVER_BOUND:
207 ASSERT(rx->local != NULL);
208 sk->sk_max_ack_backlog = backlog;
209 rx->sk.sk_state = RXRPC_SERVER_LISTENING;
214 release_sock(&rx->sk);
215 _leave(" = %d", ret);
220 * find a transport by address
222 static struct rxrpc_transport *rxrpc_name_to_transport(struct socket *sock,
223 struct sockaddr *addr,
224 int addr_len, int flags,
227 struct sockaddr_rxrpc *srx = (struct sockaddr_rxrpc *) addr;
228 struct rxrpc_transport *trans;
229 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
230 struct rxrpc_peer *peer;
232 _enter("%p,%p,%d,%d", rx, addr, addr_len, flags);
234 ASSERT(rx->local != NULL);
235 ASSERT(rx->sk.sk_state > RXRPC_UNCONNECTED);
237 if (rx->srx.transport_type != srx->transport_type)
238 return ERR_PTR(-ESOCKTNOSUPPORT);
239 if (rx->srx.transport.family != srx->transport.family)
240 return ERR_PTR(-EAFNOSUPPORT);
242 /* find a remote transport endpoint from the local one */
243 peer = rxrpc_get_peer(srx, gfp);
245 return ERR_CAST(peer);
247 /* find a transport */
248 trans = rxrpc_get_transport(rx->local, peer, gfp);
249 rxrpc_put_peer(peer);
250 _leave(" = %p", trans);
255 * rxrpc_kernel_begin_call - Allow a kernel service to begin a call
256 * @sock: The socket on which to make the call
257 * @srx: The address of the peer to contact (defaults to socket setting)
258 * @key: The security context to use (defaults to socket setting)
259 * @user_call_ID: The ID to use
261 * Allow a kernel service to begin a call on the nominated socket. This just
262 * sets up all the internal tracking structures and allocates connection and
263 * call IDs as appropriate. The call to be used is returned.
265 * The default socket destination address and security may be overridden by
266 * supplying @srx and @key.
268 struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *sock,
269 struct sockaddr_rxrpc *srx,
271 unsigned long user_call_ID,
274 struct rxrpc_conn_bundle *bundle;
275 struct rxrpc_transport *trans;
276 struct rxrpc_call *call;
277 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
279 _enter(",,%x,%lx", key_serial(key), user_call_ID);
284 trans = rxrpc_name_to_transport(sock, (struct sockaddr *) srx,
285 sizeof(*srx), 0, gfp);
287 call = ERR_CAST(trans);
294 call = ERR_PTR(-ENOTCONN);
297 atomic_inc(&trans->usage);
304 if (key && !key->payload.data[0])
305 key = NULL; /* a no-security key */
307 bundle = rxrpc_get_bundle(rx, trans, key, srx->srx_service, gfp);
308 if (IS_ERR(bundle)) {
309 call = ERR_CAST(bundle);
313 call = rxrpc_get_client_call(rx, trans, bundle, user_call_ID, true,
315 rxrpc_put_bundle(trans, bundle);
317 rxrpc_put_transport(trans);
319 release_sock(&rx->sk);
320 _leave(" = %p", call);
323 EXPORT_SYMBOL(rxrpc_kernel_begin_call);
326 * rxrpc_kernel_end_call - Allow a kernel service to end a call it was using
327 * @call: The call to end
329 * Allow a kernel service to end a call it was using. The call must be
330 * complete before this is called (the call should be aborted if necessary).
332 void rxrpc_kernel_end_call(struct rxrpc_call *call)
334 _enter("%d{%d}", call->debug_id, atomic_read(&call->usage));
335 rxrpc_remove_user_ID(call->socket, call);
336 rxrpc_put_call(call);
338 EXPORT_SYMBOL(rxrpc_kernel_end_call);
341 * rxrpc_kernel_intercept_rx_messages - Intercept received RxRPC messages
342 * @sock: The socket to intercept received messages on
343 * @interceptor: The function to pass the messages to
345 * Allow a kernel service to intercept messages heading for the Rx queue on an
346 * RxRPC socket. They get passed to the specified function instead.
347 * @interceptor should free the socket buffers it is given. @interceptor is
348 * called with the socket receive queue spinlock held and softirqs disabled -
349 * this ensures that the messages will be delivered in the right order.
351 void rxrpc_kernel_intercept_rx_messages(struct socket *sock,
352 rxrpc_interceptor_t interceptor)
354 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
357 rx->interceptor = interceptor;
360 EXPORT_SYMBOL(rxrpc_kernel_intercept_rx_messages);
363 * connect an RxRPC socket
364 * - this just targets it at a specific destination; no actual connection
365 * negotiation takes place
367 static int rxrpc_connect(struct socket *sock, struct sockaddr *addr,
368 int addr_len, int flags)
370 struct sockaddr_rxrpc *srx = (struct sockaddr_rxrpc *) addr;
371 struct sock *sk = sock->sk;
372 struct rxrpc_transport *trans;
373 struct rxrpc_local *local;
374 struct rxrpc_sock *rx = rxrpc_sk(sk);
377 _enter("%p,%p,%d,%d", rx, addr, addr_len, flags);
379 ret = rxrpc_validate_address(rx, srx, addr_len);
381 _leave(" = %d [bad addr]", ret);
387 switch (rx->sk.sk_state) {
388 case RXRPC_UNCONNECTED:
389 /* find a local transport endpoint if we don't have one already */
390 ASSERTCMP(rx->local, ==, NULL);
391 rx->srx.srx_family = AF_RXRPC;
392 rx->srx.srx_service = 0;
393 rx->srx.transport_type = srx->transport_type;
394 rx->srx.transport_len = sizeof(sa_family_t);
395 rx->srx.transport.family = srx->transport.family;
396 local = rxrpc_lookup_local(&rx->srx);
398 release_sock(&rx->sk);
399 return PTR_ERR(local);
402 rx->sk.sk_state = RXRPC_CLIENT_BOUND;
403 case RXRPC_CLIENT_BOUND:
405 case RXRPC_CLIENT_CONNECTED:
406 release_sock(&rx->sk);
409 release_sock(&rx->sk);
410 return -EBUSY; /* server sockets can't connect as well */
413 trans = rxrpc_name_to_transport(sock, addr, addr_len, flags,
416 release_sock(&rx->sk);
417 _leave(" = %ld", PTR_ERR(trans));
418 return PTR_ERR(trans);
422 rx->sk.sk_state = RXRPC_CLIENT_CONNECTED;
424 release_sock(&rx->sk);
429 * send a message through an RxRPC socket
430 * - in a client this does a number of things:
431 * - finds/sets up a connection for the security specified (if any)
432 * - initiates a call (ID in control data)
433 * - ends the request phase of a call (if MSG_MORE is not set)
434 * - sends a call data packet
435 * - may send an abort (abort code in control data)
437 static int rxrpc_sendmsg(struct socket *sock, struct msghdr *m, size_t len)
439 struct rxrpc_transport *trans;
440 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
443 _enter(",{%d},,%zu", rx->sk.sk_state, len);
445 if (m->msg_flags & MSG_OOB)
449 ret = rxrpc_validate_address(rx, m->msg_name, m->msg_namelen);
451 _leave(" = %d [bad addr]", ret);
461 trans = rxrpc_name_to_transport(sock, m->msg_name,
462 m->msg_namelen, 0, GFP_KERNEL);
464 ret = PTR_ERR(trans);
471 atomic_inc(&trans->usage);
474 switch (rx->sk.sk_state) {
475 case RXRPC_SERVER_LISTENING:
477 ret = rxrpc_server_sendmsg(rx, m, len);
480 case RXRPC_SERVER_BOUND:
481 case RXRPC_CLIENT_BOUND:
486 case RXRPC_CLIENT_CONNECTED:
487 ret = rxrpc_client_sendmsg(rx, trans, m, len);
495 release_sock(&rx->sk);
497 rxrpc_put_transport(trans);
498 _leave(" = %d", ret);
503 * set RxRPC socket options
505 static int rxrpc_setsockopt(struct socket *sock, int level, int optname,
506 char __user *optval, unsigned int optlen)
508 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
509 unsigned int min_sec_level;
512 _enter(",%d,%d,,%d", level, optname, optlen);
517 if (level == SOL_RXRPC) {
519 case RXRPC_EXCLUSIVE_CONNECTION:
524 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
526 set_bit(RXRPC_SOCK_EXCLUSIVE_CONN, &rx->flags);
529 case RXRPC_SECURITY_KEY:
534 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
536 ret = rxrpc_request_key(rx, optval, optlen);
539 case RXRPC_SECURITY_KEYRING:
544 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
546 ret = rxrpc_server_keyring(rx, optval, optlen);
549 case RXRPC_MIN_SECURITY_LEVEL:
551 if (optlen != sizeof(unsigned int))
554 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
556 ret = get_user(min_sec_level,
557 (unsigned int __user *) optval);
561 if (min_sec_level > RXRPC_SECURITY_MAX)
563 rx->min_sec_level = min_sec_level;
574 release_sock(&rx->sk);
579 * permit an RxRPC socket to be polled
581 static unsigned int rxrpc_poll(struct file *file, struct socket *sock,
585 struct sock *sk = sock->sk;
587 sock_poll_wait(file, sk_sleep(sk), wait);
590 /* the socket is readable if there are any messages waiting on the Rx
592 if (!skb_queue_empty(&sk->sk_receive_queue))
593 mask |= POLLIN | POLLRDNORM;
595 /* the socket is writable if there is space to add new data to the
596 * socket; there is no guarantee that any particular call in progress
597 * on the socket may have space in the Tx ACK window */
598 if (rxrpc_writable(sk))
599 mask |= POLLOUT | POLLWRNORM;
605 * create an RxRPC socket
607 static int rxrpc_create(struct net *net, struct socket *sock, int protocol,
610 struct rxrpc_sock *rx;
613 _enter("%p,%d", sock, protocol);
615 if (!net_eq(net, &init_net))
616 return -EAFNOSUPPORT;
618 /* we support transport protocol UDP/UDP6 only */
619 if (protocol != PF_INET)
620 return -EPROTONOSUPPORT;
622 if (sock->type != SOCK_DGRAM)
623 return -ESOCKTNOSUPPORT;
625 sock->ops = &rxrpc_rpc_ops;
626 sock->state = SS_UNCONNECTED;
628 sk = sk_alloc(net, PF_RXRPC, GFP_KERNEL, &rxrpc_proto, kern);
632 sock_init_data(sock, sk);
633 sk->sk_state = RXRPC_UNCONNECTED;
634 sk->sk_write_space = rxrpc_write_space;
635 sk->sk_max_ack_backlog = sysctl_rxrpc_max_qlen;
636 sk->sk_destruct = rxrpc_sock_destructor;
639 rx->proto = protocol;
642 INIT_LIST_HEAD(&rx->listen_link);
643 INIT_LIST_HEAD(&rx->secureq);
644 INIT_LIST_HEAD(&rx->acceptq);
645 rwlock_init(&rx->call_lock);
646 memset(&rx->srx, 0, sizeof(rx->srx));
648 _leave(" = 0 [%p]", rx);
653 * RxRPC socket destructor
655 static void rxrpc_sock_destructor(struct sock *sk)
659 rxrpc_purge_queue(&sk->sk_receive_queue);
661 WARN_ON(atomic_read(&sk->sk_wmem_alloc));
662 WARN_ON(!sk_unhashed(sk));
663 WARN_ON(sk->sk_socket);
665 if (!sock_flag(sk, SOCK_DEAD)) {
666 printk("Attempt to release alive rxrpc socket: %p\n", sk);
672 * release an RxRPC socket
674 static int rxrpc_release_sock(struct sock *sk)
676 struct rxrpc_sock *rx = rxrpc_sk(sk);
678 _enter("%p{%d,%d}", sk, sk->sk_state, atomic_read(&sk->sk_refcnt));
680 /* declare the socket closed for business */
682 sk->sk_shutdown = SHUTDOWN_MASK;
684 spin_lock_bh(&sk->sk_receive_queue.lock);
685 sk->sk_state = RXRPC_CLOSE;
686 spin_unlock_bh(&sk->sk_receive_queue.lock);
688 ASSERTCMP(rx->listen_link.next, !=, LIST_POISON1);
690 if (!list_empty(&rx->listen_link)) {
691 write_lock_bh(&rx->local->services_lock);
692 list_del(&rx->listen_link);
693 write_unlock_bh(&rx->local->services_lock);
696 /* try to flush out this socket */
697 rxrpc_release_calls_on_socket(rx);
698 flush_workqueue(rxrpc_workqueue);
699 rxrpc_purge_queue(&sk->sk_receive_queue);
702 rxrpc_put_connection(rx->conn);
707 rxrpc_put_bundle(rx->trans, rx->bundle);
711 rxrpc_put_transport(rx->trans);
715 rxrpc_put_local(rx->local);
721 key_put(rx->securities);
722 rx->securities = NULL;
730 * release an RxRPC BSD socket on close() or equivalent
732 static int rxrpc_release(struct socket *sock)
734 struct sock *sk = sock->sk;
736 _enter("%p{%p}", sock, sk);
743 return rxrpc_release_sock(sk);
747 * RxRPC network protocol
749 static const struct proto_ops rxrpc_rpc_ops = {
751 .owner = THIS_MODULE,
752 .release = rxrpc_release,
754 .connect = rxrpc_connect,
755 .socketpair = sock_no_socketpair,
756 .accept = sock_no_accept,
757 .getname = sock_no_getname,
759 .ioctl = sock_no_ioctl,
760 .listen = rxrpc_listen,
761 .shutdown = sock_no_shutdown,
762 .setsockopt = rxrpc_setsockopt,
763 .getsockopt = sock_no_getsockopt,
764 .sendmsg = rxrpc_sendmsg,
765 .recvmsg = rxrpc_recvmsg,
766 .mmap = sock_no_mmap,
767 .sendpage = sock_no_sendpage,
770 static struct proto rxrpc_proto = {
772 .owner = THIS_MODULE,
773 .obj_size = sizeof(struct rxrpc_sock),
774 .max_header = sizeof(struct rxrpc_wire_header),
777 static const struct net_proto_family rxrpc_family_ops = {
779 .create = rxrpc_create,
780 .owner = THIS_MODULE,
784 * initialise and register the RxRPC protocol
786 static int __init af_rxrpc_init(void)
790 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv) > FIELD_SIZEOF(struct sk_buff, cb));
792 rxrpc_epoch = get_seconds();
795 rxrpc_call_jar = kmem_cache_create(
796 "rxrpc_call_jar", sizeof(struct rxrpc_call), 0,
797 SLAB_HWCACHE_ALIGN, NULL);
798 if (!rxrpc_call_jar) {
799 printk(KERN_NOTICE "RxRPC: Failed to allocate call jar\n");
803 rxrpc_workqueue = alloc_workqueue("krxrpcd", 0, 1);
804 if (!rxrpc_workqueue) {
805 printk(KERN_NOTICE "RxRPC: Failed to allocate work queue\n");
806 goto error_work_queue;
809 ret = rxrpc_init_security();
811 printk(KERN_CRIT "RxRPC: Cannot initialise security\n");
815 ret = proto_register(&rxrpc_proto, 1);
817 printk(KERN_CRIT "RxRPC: Cannot register protocol\n");
821 ret = sock_register(&rxrpc_family_ops);
823 printk(KERN_CRIT "RxRPC: Cannot register socket family\n");
827 ret = register_key_type(&key_type_rxrpc);
829 printk(KERN_CRIT "RxRPC: Cannot register client key type\n");
833 ret = register_key_type(&key_type_rxrpc_s);
835 printk(KERN_CRIT "RxRPC: Cannot register server key type\n");
836 goto error_key_type_s;
839 ret = rxrpc_sysctl_init();
841 printk(KERN_CRIT "RxRPC: Cannot register sysctls\n");
845 #ifdef CONFIG_PROC_FS
846 proc_create("rxrpc_calls", 0, init_net.proc_net, &rxrpc_call_seq_fops);
847 proc_create("rxrpc_conns", 0, init_net.proc_net,
848 &rxrpc_connection_seq_fops);
853 unregister_key_type(&key_type_rxrpc_s);
855 unregister_key_type(&key_type_rxrpc);
857 sock_unregister(PF_RXRPC);
859 proto_unregister(&rxrpc_proto);
861 destroy_workqueue(rxrpc_workqueue);
863 rxrpc_exit_security();
865 kmem_cache_destroy(rxrpc_call_jar);
871 * unregister the RxRPC protocol
873 static void __exit af_rxrpc_exit(void)
877 unregister_key_type(&key_type_rxrpc_s);
878 unregister_key_type(&key_type_rxrpc);
879 sock_unregister(PF_RXRPC);
880 proto_unregister(&rxrpc_proto);
881 rxrpc_destroy_all_calls();
882 rxrpc_destroy_all_connections();
883 rxrpc_destroy_all_transports();
884 rxrpc_destroy_all_peers();
885 rxrpc_destroy_all_locals();
887 ASSERTCMP(atomic_read(&rxrpc_n_skbs), ==, 0);
889 _debug("flush scheduled work");
890 flush_workqueue(rxrpc_workqueue);
891 remove_proc_entry("rxrpc_conns", init_net.proc_net);
892 remove_proc_entry("rxrpc_calls", init_net.proc_net);
893 destroy_workqueue(rxrpc_workqueue);
894 rxrpc_exit_security();
895 kmem_cache_destroy(rxrpc_call_jar);
899 module_init(af_rxrpc_init);
900 module_exit(af_rxrpc_exit);