1 /* AF_RXRPC implementation
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
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/net.h>
14 #include <linux/slab.h>
15 #include <linux/skbuff.h>
16 #include <linux/poll.h>
17 #include <linux/proc_fs.h>
18 #include <linux/key-type.h>
19 #include <net/net_namespace.h>
21 #include <net/af_rxrpc.h>
22 #include "ar-internal.h"
24 MODULE_DESCRIPTION("RxRPC network protocol");
25 MODULE_AUTHOR("Red Hat, Inc.");
26 MODULE_LICENSE("GPL");
27 MODULE_ALIAS_NETPROTO(PF_RXRPC);
29 unsigned rxrpc_debug; // = RXRPC_DEBUG_KPROTO;
30 module_param_named(debug, rxrpc_debug, uint, S_IWUSR | S_IRUGO);
31 MODULE_PARM_DESC(debug, "RxRPC debugging mask");
33 static int sysctl_rxrpc_max_qlen __read_mostly = 10;
35 static struct proto rxrpc_proto;
36 static const struct proto_ops rxrpc_rpc_ops;
38 /* local epoch for detecting local-end reset */
41 /* current debugging ID */
42 atomic_t rxrpc_debug_id;
44 /* count of skbs currently in use */
45 atomic_t rxrpc_n_skbs;
47 struct workqueue_struct *rxrpc_workqueue;
49 static void rxrpc_sock_destructor(struct sock *);
52 * see if an RxRPC socket is currently writable
54 static inline int rxrpc_writable(struct sock *sk)
56 return atomic_read(&sk->sk_wmem_alloc) < (size_t) sk->sk_sndbuf;
60 * wait for write bufferage to become available
62 static void rxrpc_write_space(struct sock *sk)
66 if (rxrpc_writable(sk)) {
67 struct socket_wq *wq = rcu_dereference(sk->sk_wq);
69 if (wq_has_sleeper(wq))
70 wake_up_interruptible(&wq->wait);
71 sk_wake_async(sk, SOCK_WAKE_SPACE, POLL_OUT);
77 * validate an RxRPC address
79 static int rxrpc_validate_address(struct rxrpc_sock *rx,
80 struct sockaddr_rxrpc *srx,
83 if (len < sizeof(struct sockaddr_rxrpc))
86 if (srx->srx_family != AF_RXRPC)
89 if (srx->transport_type != SOCK_DGRAM)
90 return -ESOCKTNOSUPPORT;
92 len -= offsetof(struct sockaddr_rxrpc, transport);
93 if (srx->transport_len < sizeof(sa_family_t) ||
94 srx->transport_len > len)
97 if (srx->transport.family != rx->proto)
100 switch (srx->transport.family) {
102 _debug("INET: %x @ %pI4",
103 ntohs(srx->transport.sin.sin_port),
104 &srx->transport.sin.sin_addr);
105 if (srx->transport_len > 8)
106 memset((void *)&srx->transport + 8, 0,
107 srx->transport_len - 8);
112 return -EAFNOSUPPORT;
119 * bind a local address to an RxRPC socket
121 static int rxrpc_bind(struct socket *sock, struct sockaddr *saddr, int len)
123 struct sockaddr_rxrpc *srx = (struct sockaddr_rxrpc *) saddr;
124 struct sock *sk = sock->sk;
125 struct rxrpc_local *local;
126 struct rxrpc_sock *rx = rxrpc_sk(sk), *prx;
130 _enter("%p,%p,%d", rx, saddr, len);
132 ret = rxrpc_validate_address(rx, srx, len);
138 if (rx->sk.sk_state != RXRPC_UNCONNECTED) {
143 memcpy(&rx->srx, srx, sizeof(rx->srx));
145 /* find a local transport endpoint if we don't have one already */
146 local = rxrpc_lookup_local(&rx->srx);
148 ret = PTR_ERR(local);
153 if (srx->srx_service) {
154 service_id = htons(srx->srx_service);
155 write_lock_bh(&local->services_lock);
156 list_for_each_entry(prx, &local->services, listen_link) {
157 if (prx->service_id == service_id)
161 rx->service_id = service_id;
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);
280 _enter(",,%x,%lx", key_serial(key), user_call_ID);
285 trans = rxrpc_name_to_transport(sock, (struct sockaddr *) srx,
286 sizeof(*srx), 0, gfp);
288 call = ERR_CAST(trans);
295 call = ERR_PTR(-ENOTCONN);
298 atomic_inc(&trans->usage);
301 service_id = rx->service_id;
303 service_id = htons(srx->srx_service);
307 if (key && !key->payload.data)
308 key = NULL; /* a no-security key */
310 bundle = rxrpc_get_bundle(rx, trans, key, service_id, gfp);
311 if (IS_ERR(bundle)) {
312 call = ERR_CAST(bundle);
316 call = rxrpc_get_client_call(rx, trans, bundle, user_call_ID, true,
318 rxrpc_put_bundle(trans, bundle);
320 rxrpc_put_transport(trans);
322 release_sock(&rx->sk);
323 _leave(" = %p", call);
327 EXPORT_SYMBOL(rxrpc_kernel_begin_call);
330 * rxrpc_kernel_end_call - Allow a kernel service to end a call it was using
331 * @call: The call to end
333 * Allow a kernel service to end a call it was using. The call must be
334 * complete before this is called (the call should be aborted if necessary).
336 void rxrpc_kernel_end_call(struct rxrpc_call *call)
338 _enter("%d{%d}", call->debug_id, atomic_read(&call->usage));
339 rxrpc_remove_user_ID(call->socket, call);
340 rxrpc_put_call(call);
343 EXPORT_SYMBOL(rxrpc_kernel_end_call);
346 * rxrpc_kernel_intercept_rx_messages - Intercept received RxRPC messages
347 * @sock: The socket to intercept received messages on
348 * @interceptor: The function to pass the messages to
350 * Allow a kernel service to intercept messages heading for the Rx queue on an
351 * RxRPC socket. They get passed to the specified function instead.
352 * @interceptor should free the socket buffers it is given. @interceptor is
353 * called with the socket receive queue spinlock held and softirqs disabled -
354 * this ensures that the messages will be delivered in the right order.
356 void rxrpc_kernel_intercept_rx_messages(struct socket *sock,
357 rxrpc_interceptor_t interceptor)
359 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
362 rx->interceptor = interceptor;
365 EXPORT_SYMBOL(rxrpc_kernel_intercept_rx_messages);
368 * connect an RxRPC socket
369 * - this just targets it at a specific destination; no actual connection
370 * negotiation takes place
372 static int rxrpc_connect(struct socket *sock, struct sockaddr *addr,
373 int addr_len, int flags)
375 struct sockaddr_rxrpc *srx = (struct sockaddr_rxrpc *) addr;
376 struct sock *sk = sock->sk;
377 struct rxrpc_transport *trans;
378 struct rxrpc_local *local;
379 struct rxrpc_sock *rx = rxrpc_sk(sk);
382 _enter("%p,%p,%d,%d", rx, addr, addr_len, flags);
384 ret = rxrpc_validate_address(rx, srx, addr_len);
386 _leave(" = %d [bad addr]", ret);
392 switch (rx->sk.sk_state) {
393 case RXRPC_UNCONNECTED:
394 /* find a local transport endpoint if we don't have one already */
395 ASSERTCMP(rx->local, ==, NULL);
396 rx->srx.srx_family = AF_RXRPC;
397 rx->srx.srx_service = 0;
398 rx->srx.transport_type = srx->transport_type;
399 rx->srx.transport_len = sizeof(sa_family_t);
400 rx->srx.transport.family = srx->transport.family;
401 local = rxrpc_lookup_local(&rx->srx);
403 release_sock(&rx->sk);
404 return PTR_ERR(local);
407 rx->sk.sk_state = RXRPC_CLIENT_BOUND;
408 case RXRPC_CLIENT_BOUND:
410 case RXRPC_CLIENT_CONNECTED:
411 release_sock(&rx->sk);
414 release_sock(&rx->sk);
415 return -EBUSY; /* server sockets can't connect as well */
418 trans = rxrpc_name_to_transport(sock, addr, addr_len, flags,
421 release_sock(&rx->sk);
422 _leave(" = %ld", PTR_ERR(trans));
423 return PTR_ERR(trans);
427 rx->service_id = htons(srx->srx_service);
428 rx->sk.sk_state = RXRPC_CLIENT_CONNECTED;
430 release_sock(&rx->sk);
435 * send a message through an RxRPC socket
436 * - in a client this does a number of things:
437 * - finds/sets up a connection for the security specified (if any)
438 * - initiates a call (ID in control data)
439 * - ends the request phase of a call (if MSG_MORE is not set)
440 * - sends a call data packet
441 * - may send an abort (abort code in control data)
443 static int rxrpc_sendmsg(struct kiocb *iocb, struct socket *sock,
444 struct msghdr *m, size_t len)
446 struct rxrpc_transport *trans;
447 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
450 _enter(",{%d},,%zu", rx->sk.sk_state, len);
452 if (m->msg_flags & MSG_OOB)
456 ret = rxrpc_validate_address(rx, m->msg_name, m->msg_namelen);
458 _leave(" = %d [bad addr]", ret);
468 trans = rxrpc_name_to_transport(sock, m->msg_name,
469 m->msg_namelen, 0, GFP_KERNEL);
471 ret = PTR_ERR(trans);
478 atomic_inc(&trans->usage);
481 switch (rx->sk.sk_state) {
482 case RXRPC_SERVER_LISTENING:
484 ret = rxrpc_server_sendmsg(iocb, rx, m, len);
487 case RXRPC_SERVER_BOUND:
488 case RXRPC_CLIENT_BOUND:
493 case RXRPC_CLIENT_CONNECTED:
494 ret = rxrpc_client_sendmsg(iocb, rx, trans, m, len);
502 release_sock(&rx->sk);
504 rxrpc_put_transport(trans);
505 _leave(" = %d", ret);
510 * set RxRPC socket options
512 static int rxrpc_setsockopt(struct socket *sock, int level, int optname,
513 char __user *optval, unsigned int optlen)
515 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
516 unsigned min_sec_level;
519 _enter(",%d,%d,,%d", level, optname, optlen);
524 if (level == SOL_RXRPC) {
526 case RXRPC_EXCLUSIVE_CONNECTION:
531 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
533 set_bit(RXRPC_SOCK_EXCLUSIVE_CONN, &rx->flags);
536 case RXRPC_SECURITY_KEY:
541 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
543 ret = rxrpc_request_key(rx, optval, optlen);
546 case RXRPC_SECURITY_KEYRING:
551 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
553 ret = rxrpc_server_keyring(rx, optval, optlen);
556 case RXRPC_MIN_SECURITY_LEVEL:
558 if (optlen != sizeof(unsigned))
561 if (rx->sk.sk_state != RXRPC_UNCONNECTED)
563 ret = get_user(min_sec_level,
564 (unsigned __user *) optval);
568 if (min_sec_level > RXRPC_SECURITY_MAX)
570 rx->min_sec_level = min_sec_level;
581 release_sock(&rx->sk);
586 * permit an RxRPC socket to be polled
588 static unsigned int rxrpc_poll(struct file *file, struct socket *sock,
592 struct sock *sk = sock->sk;
594 sock_poll_wait(file, sk_sleep(sk), wait);
597 /* the socket is readable if there are any messages waiting on the Rx
599 if (!skb_queue_empty(&sk->sk_receive_queue))
600 mask |= POLLIN | POLLRDNORM;
602 /* the socket is writable if there is space to add new data to the
603 * socket; there is no guarantee that any particular call in progress
604 * on the socket may have space in the Tx ACK window */
605 if (rxrpc_writable(sk))
606 mask |= POLLOUT | POLLWRNORM;
612 * create an RxRPC socket
614 static int rxrpc_create(struct net *net, struct socket *sock, int protocol,
617 struct rxrpc_sock *rx;
620 _enter("%p,%d", sock, protocol);
622 if (!net_eq(net, &init_net))
623 return -EAFNOSUPPORT;
625 /* we support transport protocol UDP only */
626 if (protocol != PF_INET)
627 return -EPROTONOSUPPORT;
629 if (sock->type != SOCK_DGRAM)
630 return -ESOCKTNOSUPPORT;
632 sock->ops = &rxrpc_rpc_ops;
633 sock->state = SS_UNCONNECTED;
635 sk = sk_alloc(net, PF_RXRPC, GFP_KERNEL, &rxrpc_proto);
639 sock_init_data(sock, sk);
640 sk->sk_state = RXRPC_UNCONNECTED;
641 sk->sk_write_space = rxrpc_write_space;
642 sk->sk_max_ack_backlog = sysctl_rxrpc_max_qlen;
643 sk->sk_destruct = rxrpc_sock_destructor;
646 rx->proto = protocol;
649 INIT_LIST_HEAD(&rx->listen_link);
650 INIT_LIST_HEAD(&rx->secureq);
651 INIT_LIST_HEAD(&rx->acceptq);
652 rwlock_init(&rx->call_lock);
653 memset(&rx->srx, 0, sizeof(rx->srx));
655 _leave(" = 0 [%p]", rx);
660 * RxRPC socket destructor
662 static void rxrpc_sock_destructor(struct sock *sk)
666 rxrpc_purge_queue(&sk->sk_receive_queue);
668 WARN_ON(atomic_read(&sk->sk_wmem_alloc));
669 WARN_ON(!sk_unhashed(sk));
670 WARN_ON(sk->sk_socket);
672 if (!sock_flag(sk, SOCK_DEAD)) {
673 printk("Attempt to release alive rxrpc socket: %p\n", sk);
679 * release an RxRPC socket
681 static int rxrpc_release_sock(struct sock *sk)
683 struct rxrpc_sock *rx = rxrpc_sk(sk);
685 _enter("%p{%d,%d}", sk, sk->sk_state, atomic_read(&sk->sk_refcnt));
687 /* declare the socket closed for business */
689 sk->sk_shutdown = SHUTDOWN_MASK;
691 spin_lock_bh(&sk->sk_receive_queue.lock);
692 sk->sk_state = RXRPC_CLOSE;
693 spin_unlock_bh(&sk->sk_receive_queue.lock);
695 ASSERTCMP(rx->listen_link.next, !=, LIST_POISON1);
697 if (!list_empty(&rx->listen_link)) {
698 write_lock_bh(&rx->local->services_lock);
699 list_del(&rx->listen_link);
700 write_unlock_bh(&rx->local->services_lock);
703 /* try to flush out this socket */
704 rxrpc_release_calls_on_socket(rx);
705 flush_workqueue(rxrpc_workqueue);
706 rxrpc_purge_queue(&sk->sk_receive_queue);
709 rxrpc_put_connection(rx->conn);
714 rxrpc_put_bundle(rx->trans, rx->bundle);
718 rxrpc_put_transport(rx->trans);
722 rxrpc_put_local(rx->local);
728 key_put(rx->securities);
729 rx->securities = NULL;
737 * release an RxRPC BSD socket on close() or equivalent
739 static int rxrpc_release(struct socket *sock)
741 struct sock *sk = sock->sk;
743 _enter("%p{%p}", sock, sk);
750 return rxrpc_release_sock(sk);
754 * RxRPC network protocol
756 static const struct proto_ops rxrpc_rpc_ops = {
758 .owner = THIS_MODULE,
759 .release = rxrpc_release,
761 .connect = rxrpc_connect,
762 .socketpair = sock_no_socketpair,
763 .accept = sock_no_accept,
764 .getname = sock_no_getname,
766 .ioctl = sock_no_ioctl,
767 .listen = rxrpc_listen,
768 .shutdown = sock_no_shutdown,
769 .setsockopt = rxrpc_setsockopt,
770 .getsockopt = sock_no_getsockopt,
771 .sendmsg = rxrpc_sendmsg,
772 .recvmsg = rxrpc_recvmsg,
773 .mmap = sock_no_mmap,
774 .sendpage = sock_no_sendpage,
777 static struct proto rxrpc_proto = {
779 .owner = THIS_MODULE,
780 .obj_size = sizeof(struct rxrpc_sock),
781 .max_header = sizeof(struct rxrpc_header),
784 static const struct net_proto_family rxrpc_family_ops = {
786 .create = rxrpc_create,
787 .owner = THIS_MODULE,
791 * initialise and register the RxRPC protocol
793 static int __init af_rxrpc_init(void)
795 struct sk_buff *dummy_skb;
798 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv) > sizeof(dummy_skb->cb));
800 rxrpc_epoch = htonl(get_seconds());
803 rxrpc_call_jar = kmem_cache_create(
804 "rxrpc_call_jar", sizeof(struct rxrpc_call), 0,
805 SLAB_HWCACHE_ALIGN, NULL);
806 if (!rxrpc_call_jar) {
807 printk(KERN_NOTICE "RxRPC: Failed to allocate call jar\n");
811 rxrpc_workqueue = create_workqueue("krxrpcd");
812 if (!rxrpc_workqueue) {
813 printk(KERN_NOTICE "RxRPC: Failed to allocate work queue\n");
814 goto error_work_queue;
817 ret = proto_register(&rxrpc_proto, 1);
819 printk(KERN_CRIT "RxRPC: Cannot register protocol\n");
823 ret = sock_register(&rxrpc_family_ops);
825 printk(KERN_CRIT "RxRPC: Cannot register socket family\n");
829 ret = register_key_type(&key_type_rxrpc);
831 printk(KERN_CRIT "RxRPC: Cannot register client key type\n");
835 ret = register_key_type(&key_type_rxrpc_s);
837 printk(KERN_CRIT "RxRPC: Cannot register server key type\n");
838 goto error_key_type_s;
841 #ifdef CONFIG_PROC_FS
842 proc_net_fops_create(&init_net, "rxrpc_calls", 0, &rxrpc_call_seq_fops);
843 proc_net_fops_create(&init_net, "rxrpc_conns", 0, &rxrpc_connection_seq_fops);
848 unregister_key_type(&key_type_rxrpc);
850 sock_unregister(PF_RXRPC);
852 proto_unregister(&rxrpc_proto);
854 destroy_workqueue(rxrpc_workqueue);
856 kmem_cache_destroy(rxrpc_call_jar);
862 * unregister the RxRPC protocol
864 static void __exit af_rxrpc_exit(void)
867 unregister_key_type(&key_type_rxrpc_s);
868 unregister_key_type(&key_type_rxrpc);
869 sock_unregister(PF_RXRPC);
870 proto_unregister(&rxrpc_proto);
871 rxrpc_destroy_all_calls();
872 rxrpc_destroy_all_connections();
873 rxrpc_destroy_all_transports();
874 rxrpc_destroy_all_peers();
875 rxrpc_destroy_all_locals();
877 ASSERTCMP(atomic_read(&rxrpc_n_skbs), ==, 0);
879 _debug("flush scheduled work");
880 flush_workqueue(rxrpc_workqueue);
881 proc_net_remove(&init_net, "rxrpc_conns");
882 proc_net_remove(&init_net, "rxrpc_calls");
883 destroy_workqueue(rxrpc_workqueue);
884 kmem_cache_destroy(rxrpc_call_jar);
888 module_init(af_rxrpc_init);
889 module_exit(af_rxrpc_exit);