x86/speculation/mds: Fix documentation typo
[linux/fpc-iii.git] / net / rxrpc / af_rxrpc.c
blob2a32f60652d82042a637d270efcbc197691cb549
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>
24 #include <net/sock.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 /* current debugging ID */
42 atomic_t rxrpc_debug_id;
44 /* count of skbs currently in use */
45 atomic_t rxrpc_n_tx_skbs, rxrpc_n_rx_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 refcount_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)
64 _enter("%p", sk);
65 rcu_read_lock();
66 if (rxrpc_writable(sk)) {
67 struct socket_wq *wq = rcu_dereference(sk->sk_wq);
69 if (skwq_has_sleeper(wq))
70 wake_up_interruptible(&wq->wait);
71 sk_wake_async(sk, SOCK_WAKE_SPACE, POLL_OUT);
73 rcu_read_unlock();
77 * validate an RxRPC address
79 static int rxrpc_validate_address(struct rxrpc_sock *rx,
80 struct sockaddr_rxrpc *srx,
81 int len)
83 unsigned int tail;
85 if (len < sizeof(struct sockaddr_rxrpc))
86 return -EINVAL;
88 if (srx->srx_family != AF_RXRPC)
89 return -EAFNOSUPPORT;
91 if (srx->transport_type != SOCK_DGRAM)
92 return -ESOCKTNOSUPPORT;
94 len -= offsetof(struct sockaddr_rxrpc, transport);
95 if (srx->transport_len < sizeof(sa_family_t) ||
96 srx->transport_len > len)
97 return -EINVAL;
99 if (srx->transport.family != rx->family)
100 return -EAFNOSUPPORT;
102 switch (srx->transport.family) {
103 case AF_INET:
104 if (srx->transport_len < sizeof(struct sockaddr_in))
105 return -EINVAL;
106 tail = offsetof(struct sockaddr_rxrpc, transport.sin.__pad);
107 break;
109 #ifdef CONFIG_AF_RXRPC_IPV6
110 case AF_INET6:
111 if (srx->transport_len < sizeof(struct sockaddr_in6))
112 return -EINVAL;
113 tail = offsetof(struct sockaddr_rxrpc, transport) +
114 sizeof(struct sockaddr_in6);
115 break;
116 #endif
118 default:
119 return -EAFNOSUPPORT;
122 if (tail < len)
123 memset((void *)srx + tail, 0, len - tail);
124 _debug("INET: %pISp", &srx->transport);
125 return 0;
129 * bind a local address to an RxRPC socket
131 static int rxrpc_bind(struct socket *sock, struct sockaddr *saddr, int len)
133 struct sockaddr_rxrpc *srx = (struct sockaddr_rxrpc *)saddr;
134 struct rxrpc_local *local;
135 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
136 u16 service_id = srx->srx_service;
137 int ret;
139 _enter("%p,%p,%d", rx, saddr, len);
141 ret = rxrpc_validate_address(rx, srx, len);
142 if (ret < 0)
143 goto error;
145 lock_sock(&rx->sk);
147 switch (rx->sk.sk_state) {
148 case RXRPC_UNBOUND:
149 rx->srx = *srx;
150 local = rxrpc_lookup_local(sock_net(&rx->sk), &rx->srx);
151 if (IS_ERR(local)) {
152 ret = PTR_ERR(local);
153 goto error_unlock;
156 if (service_id) {
157 write_lock(&local->services_lock);
158 if (rcu_access_pointer(local->service))
159 goto service_in_use;
160 rx->local = local;
161 rcu_assign_pointer(local->service, rx);
162 write_unlock(&local->services_lock);
164 rx->sk.sk_state = RXRPC_SERVER_BOUND;
165 } else {
166 rx->local = local;
167 rx->sk.sk_state = RXRPC_CLIENT_BOUND;
169 break;
171 case RXRPC_SERVER_BOUND:
172 ret = -EINVAL;
173 if (service_id == 0)
174 goto error_unlock;
175 ret = -EADDRINUSE;
176 if (service_id == rx->srx.srx_service)
177 goto error_unlock;
178 ret = -EINVAL;
179 srx->srx_service = rx->srx.srx_service;
180 if (memcmp(srx, &rx->srx, sizeof(*srx)) != 0)
181 goto error_unlock;
182 rx->second_service = service_id;
183 rx->sk.sk_state = RXRPC_SERVER_BOUND2;
184 break;
186 default:
187 ret = -EINVAL;
188 goto error_unlock;
191 release_sock(&rx->sk);
192 _leave(" = 0");
193 return 0;
195 service_in_use:
196 write_unlock(&local->services_lock);
197 rxrpc_put_local(local);
198 ret = -EADDRINUSE;
199 error_unlock:
200 release_sock(&rx->sk);
201 error:
202 _leave(" = %d", ret);
203 return ret;
207 * set the number of pending calls permitted on a listening socket
209 static int rxrpc_listen(struct socket *sock, int backlog)
211 struct sock *sk = sock->sk;
212 struct rxrpc_sock *rx = rxrpc_sk(sk);
213 unsigned int max, old;
214 int ret;
216 _enter("%p,%d", rx, backlog);
218 lock_sock(&rx->sk);
220 switch (rx->sk.sk_state) {
221 case RXRPC_UNBOUND:
222 ret = -EADDRNOTAVAIL;
223 break;
224 case RXRPC_SERVER_BOUND:
225 case RXRPC_SERVER_BOUND2:
226 ASSERT(rx->local != NULL);
227 max = READ_ONCE(rxrpc_max_backlog);
228 ret = -EINVAL;
229 if (backlog == INT_MAX)
230 backlog = max;
231 else if (backlog < 0 || backlog > max)
232 break;
233 old = sk->sk_max_ack_backlog;
234 sk->sk_max_ack_backlog = backlog;
235 ret = rxrpc_service_prealloc(rx, GFP_KERNEL);
236 if (ret == 0)
237 rx->sk.sk_state = RXRPC_SERVER_LISTENING;
238 else
239 sk->sk_max_ack_backlog = old;
240 break;
241 case RXRPC_SERVER_LISTENING:
242 if (backlog == 0) {
243 rx->sk.sk_state = RXRPC_SERVER_LISTEN_DISABLED;
244 sk->sk_max_ack_backlog = 0;
245 rxrpc_discard_prealloc(rx);
246 ret = 0;
247 break;
249 default:
250 ret = -EBUSY;
251 break;
254 release_sock(&rx->sk);
255 _leave(" = %d", ret);
256 return ret;
260 * rxrpc_kernel_begin_call - Allow a kernel service to begin a call
261 * @sock: The socket on which to make the call
262 * @srx: The address of the peer to contact
263 * @key: The security context to use (defaults to socket setting)
264 * @user_call_ID: The ID to use
265 * @tx_total_len: Total length of data to transmit during the call (or -1)
266 * @gfp: The allocation constraints
267 * @notify_rx: Where to send notifications instead of socket queue
269 * Allow a kernel service to begin a call on the nominated socket. This just
270 * sets up all the internal tracking structures and allocates connection and
271 * call IDs as appropriate. The call to be used is returned.
273 * The default socket destination address and security may be overridden by
274 * supplying @srx and @key.
276 struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *sock,
277 struct sockaddr_rxrpc *srx,
278 struct key *key,
279 unsigned long user_call_ID,
280 s64 tx_total_len,
281 gfp_t gfp,
282 rxrpc_notify_rx_t notify_rx)
284 struct rxrpc_conn_parameters cp;
285 struct rxrpc_call *call;
286 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
287 int ret;
289 _enter(",,%x,%lx", key_serial(key), user_call_ID);
291 ret = rxrpc_validate_address(rx, srx, sizeof(*srx));
292 if (ret < 0)
293 return ERR_PTR(ret);
295 lock_sock(&rx->sk);
297 if (!key)
298 key = rx->key;
299 if (key && !key->payload.data[0])
300 key = NULL; /* a no-security key */
302 memset(&cp, 0, sizeof(cp));
303 cp.local = rx->local;
304 cp.key = key;
305 cp.security_level = rx->min_sec_level;
306 cp.exclusive = false;
307 cp.service_id = srx->srx_service;
308 call = rxrpc_new_client_call(rx, &cp, srx, user_call_ID, tx_total_len,
309 gfp);
310 /* The socket has been unlocked. */
311 if (!IS_ERR(call)) {
312 call->notify_rx = notify_rx;
313 mutex_unlock(&call->user_mutex);
316 _leave(" = %p", call);
317 return call;
319 EXPORT_SYMBOL(rxrpc_kernel_begin_call);
322 * rxrpc_kernel_end_call - Allow a kernel service to end a call it was using
323 * @sock: The socket the call is on
324 * @call: The call to end
326 * Allow a kernel service to end a call it was using. The call must be
327 * complete before this is called (the call should be aborted if necessary).
329 void rxrpc_kernel_end_call(struct socket *sock, struct rxrpc_call *call)
331 _enter("%d{%d}", call->debug_id, atomic_read(&call->usage));
333 mutex_lock(&call->user_mutex);
334 rxrpc_release_call(rxrpc_sk(sock->sk), call);
335 mutex_unlock(&call->user_mutex);
336 rxrpc_put_call(call, rxrpc_call_put_kernel);
338 EXPORT_SYMBOL(rxrpc_kernel_end_call);
341 * rxrpc_kernel_check_call - Check a call's state
342 * @sock: The socket the call is on
343 * @call: The call to check
344 * @_compl: Where to store the completion state
345 * @_abort_code: Where to store any abort code
347 * Allow a kernel service to query the state of a call and find out the manner
348 * of its termination if it has completed. Returns -EINPROGRESS if the call is
349 * still going, 0 if the call finished successfully, -ECONNABORTED if the call
350 * was aborted and an appropriate error if the call failed in some other way.
352 int rxrpc_kernel_check_call(struct socket *sock, struct rxrpc_call *call,
353 enum rxrpc_call_completion *_compl, u32 *_abort_code)
355 if (call->state != RXRPC_CALL_COMPLETE)
356 return -EINPROGRESS;
357 smp_rmb();
358 *_compl = call->completion;
359 *_abort_code = call->abort_code;
360 return call->error;
362 EXPORT_SYMBOL(rxrpc_kernel_check_call);
365 * rxrpc_kernel_retry_call - Allow a kernel service to retry a call
366 * @sock: The socket the call is on
367 * @call: The call to retry
368 * @srx: The address of the peer to contact
369 * @key: The security context to use (defaults to socket setting)
371 * Allow a kernel service to try resending a client call that failed due to a
372 * network error to a new address. The Tx queue is maintained intact, thereby
373 * relieving the need to re-encrypt any request data that has already been
374 * buffered.
376 int rxrpc_kernel_retry_call(struct socket *sock, struct rxrpc_call *call,
377 struct sockaddr_rxrpc *srx, struct key *key)
379 struct rxrpc_conn_parameters cp;
380 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
381 int ret;
383 _enter("%d{%d}", call->debug_id, atomic_read(&call->usage));
385 if (!key)
386 key = rx->key;
387 if (key && !key->payload.data[0])
388 key = NULL; /* a no-security key */
390 memset(&cp, 0, sizeof(cp));
391 cp.local = rx->local;
392 cp.key = key;
393 cp.security_level = 0;
394 cp.exclusive = false;
395 cp.service_id = srx->srx_service;
397 mutex_lock(&call->user_mutex);
399 ret = rxrpc_prepare_call_for_retry(rx, call);
400 if (ret == 0)
401 ret = rxrpc_retry_client_call(rx, call, &cp, srx, GFP_KERNEL);
403 mutex_unlock(&call->user_mutex);
404 _leave(" = %d", ret);
405 return ret;
407 EXPORT_SYMBOL(rxrpc_kernel_retry_call);
410 * rxrpc_kernel_new_call_notification - Get notifications of new calls
411 * @sock: The socket to intercept received messages on
412 * @notify_new_call: Function to be called when new calls appear
413 * @discard_new_call: Function to discard preallocated calls
415 * Allow a kernel service to be given notifications about new calls.
417 void rxrpc_kernel_new_call_notification(
418 struct socket *sock,
419 rxrpc_notify_new_call_t notify_new_call,
420 rxrpc_discard_new_call_t discard_new_call)
422 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
424 rx->notify_new_call = notify_new_call;
425 rx->discard_new_call = discard_new_call;
427 EXPORT_SYMBOL(rxrpc_kernel_new_call_notification);
430 * connect an RxRPC socket
431 * - this just targets it at a specific destination; no actual connection
432 * negotiation takes place
434 static int rxrpc_connect(struct socket *sock, struct sockaddr *addr,
435 int addr_len, int flags)
437 struct sockaddr_rxrpc *srx = (struct sockaddr_rxrpc *)addr;
438 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
439 int ret;
441 _enter("%p,%p,%d,%d", rx, addr, addr_len, flags);
443 ret = rxrpc_validate_address(rx, srx, addr_len);
444 if (ret < 0) {
445 _leave(" = %d [bad addr]", ret);
446 return ret;
449 lock_sock(&rx->sk);
451 ret = -EISCONN;
452 if (test_bit(RXRPC_SOCK_CONNECTED, &rx->flags))
453 goto error;
455 switch (rx->sk.sk_state) {
456 case RXRPC_UNBOUND:
457 rx->sk.sk_state = RXRPC_CLIENT_UNBOUND;
458 case RXRPC_CLIENT_UNBOUND:
459 case RXRPC_CLIENT_BOUND:
460 break;
461 default:
462 ret = -EBUSY;
463 goto error;
466 rx->connect_srx = *srx;
467 set_bit(RXRPC_SOCK_CONNECTED, &rx->flags);
468 ret = 0;
470 error:
471 release_sock(&rx->sk);
472 return ret;
476 * send a message through an RxRPC socket
477 * - in a client this does a number of things:
478 * - finds/sets up a connection for the security specified (if any)
479 * - initiates a call (ID in control data)
480 * - ends the request phase of a call (if MSG_MORE is not set)
481 * - sends a call data packet
482 * - may send an abort (abort code in control data)
484 static int rxrpc_sendmsg(struct socket *sock, struct msghdr *m, size_t len)
486 struct rxrpc_local *local;
487 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
488 int ret;
490 _enter(",{%d},,%zu", rx->sk.sk_state, len);
492 if (m->msg_flags & MSG_OOB)
493 return -EOPNOTSUPP;
495 if (m->msg_name) {
496 ret = rxrpc_validate_address(rx, m->msg_name, m->msg_namelen);
497 if (ret < 0) {
498 _leave(" = %d [bad addr]", ret);
499 return ret;
503 lock_sock(&rx->sk);
505 switch (rx->sk.sk_state) {
506 case RXRPC_UNBOUND:
507 rx->srx.srx_family = AF_RXRPC;
508 rx->srx.srx_service = 0;
509 rx->srx.transport_type = SOCK_DGRAM;
510 rx->srx.transport.family = rx->family;
511 switch (rx->family) {
512 case AF_INET:
513 rx->srx.transport_len = sizeof(struct sockaddr_in);
514 break;
515 #ifdef CONFIG_AF_RXRPC_IPV6
516 case AF_INET6:
517 rx->srx.transport_len = sizeof(struct sockaddr_in6);
518 break;
519 #endif
520 default:
521 ret = -EAFNOSUPPORT;
522 goto error_unlock;
524 local = rxrpc_lookup_local(sock_net(sock->sk), &rx->srx);
525 if (IS_ERR(local)) {
526 ret = PTR_ERR(local);
527 goto error_unlock;
530 rx->local = local;
531 rx->sk.sk_state = RXRPC_CLIENT_UNBOUND;
532 /* Fall through */
534 case RXRPC_CLIENT_UNBOUND:
535 case RXRPC_CLIENT_BOUND:
536 if (!m->msg_name &&
537 test_bit(RXRPC_SOCK_CONNECTED, &rx->flags)) {
538 m->msg_name = &rx->connect_srx;
539 m->msg_namelen = sizeof(rx->connect_srx);
541 case RXRPC_SERVER_BOUND:
542 case RXRPC_SERVER_LISTENING:
543 ret = rxrpc_do_sendmsg(rx, m, len);
544 /* The socket has been unlocked */
545 goto out;
546 default:
547 ret = -EINVAL;
548 goto error_unlock;
551 error_unlock:
552 release_sock(&rx->sk);
553 out:
554 _leave(" = %d", ret);
555 return ret;
559 * set RxRPC socket options
561 static int rxrpc_setsockopt(struct socket *sock, int level, int optname,
562 char __user *optval, unsigned int optlen)
564 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
565 unsigned int min_sec_level;
566 u16 service_upgrade[2];
567 int ret;
569 _enter(",%d,%d,,%d", level, optname, optlen);
571 lock_sock(&rx->sk);
572 ret = -EOPNOTSUPP;
574 if (level == SOL_RXRPC) {
575 switch (optname) {
576 case RXRPC_EXCLUSIVE_CONNECTION:
577 ret = -EINVAL;
578 if (optlen != 0)
579 goto error;
580 ret = -EISCONN;
581 if (rx->sk.sk_state != RXRPC_UNBOUND)
582 goto error;
583 rx->exclusive = true;
584 goto success;
586 case RXRPC_SECURITY_KEY:
587 ret = -EINVAL;
588 if (rx->key)
589 goto error;
590 ret = -EISCONN;
591 if (rx->sk.sk_state != RXRPC_UNBOUND)
592 goto error;
593 ret = rxrpc_request_key(rx, optval, optlen);
594 goto error;
596 case RXRPC_SECURITY_KEYRING:
597 ret = -EINVAL;
598 if (rx->key)
599 goto error;
600 ret = -EISCONN;
601 if (rx->sk.sk_state != RXRPC_UNBOUND)
602 goto error;
603 ret = rxrpc_server_keyring(rx, optval, optlen);
604 goto error;
606 case RXRPC_MIN_SECURITY_LEVEL:
607 ret = -EINVAL;
608 if (optlen != sizeof(unsigned int))
609 goto error;
610 ret = -EISCONN;
611 if (rx->sk.sk_state != RXRPC_UNBOUND)
612 goto error;
613 ret = get_user(min_sec_level,
614 (unsigned int __user *) optval);
615 if (ret < 0)
616 goto error;
617 ret = -EINVAL;
618 if (min_sec_level > RXRPC_SECURITY_MAX)
619 goto error;
620 rx->min_sec_level = min_sec_level;
621 goto success;
623 case RXRPC_UPGRADEABLE_SERVICE:
624 ret = -EINVAL;
625 if (optlen != sizeof(service_upgrade) ||
626 rx->service_upgrade.from != 0)
627 goto error;
628 ret = -EISCONN;
629 if (rx->sk.sk_state != RXRPC_SERVER_BOUND2)
630 goto error;
631 ret = -EFAULT;
632 if (copy_from_user(service_upgrade, optval,
633 sizeof(service_upgrade)) != 0)
634 goto error;
635 ret = -EINVAL;
636 if ((service_upgrade[0] != rx->srx.srx_service ||
637 service_upgrade[1] != rx->second_service) &&
638 (service_upgrade[0] != rx->second_service ||
639 service_upgrade[1] != rx->srx.srx_service))
640 goto error;
641 rx->service_upgrade.from = service_upgrade[0];
642 rx->service_upgrade.to = service_upgrade[1];
643 goto success;
645 default:
646 break;
650 success:
651 ret = 0;
652 error:
653 release_sock(&rx->sk);
654 return ret;
658 * Get socket options.
660 static int rxrpc_getsockopt(struct socket *sock, int level, int optname,
661 char __user *optval, int __user *_optlen)
663 int optlen;
665 if (level != SOL_RXRPC)
666 return -EOPNOTSUPP;
668 if (get_user(optlen, _optlen))
669 return -EFAULT;
671 switch (optname) {
672 case RXRPC_SUPPORTED_CMSG:
673 if (optlen < sizeof(int))
674 return -ETOOSMALL;
675 if (put_user(RXRPC__SUPPORTED - 1, (int __user *)optval) ||
676 put_user(sizeof(int), _optlen))
677 return -EFAULT;
678 return 0;
680 default:
681 return -EOPNOTSUPP;
686 * permit an RxRPC socket to be polled
688 static unsigned int rxrpc_poll(struct file *file, struct socket *sock,
689 poll_table *wait)
691 struct sock *sk = sock->sk;
692 struct rxrpc_sock *rx = rxrpc_sk(sk);
693 unsigned int mask;
695 sock_poll_wait(file, sk_sleep(sk), wait);
696 mask = 0;
698 /* the socket is readable if there are any messages waiting on the Rx
699 * queue */
700 if (!list_empty(&rx->recvmsg_q))
701 mask |= POLLIN | POLLRDNORM;
703 /* the socket is writable if there is space to add new data to the
704 * socket; there is no guarantee that any particular call in progress
705 * on the socket may have space in the Tx ACK window */
706 if (rxrpc_writable(sk))
707 mask |= POLLOUT | POLLWRNORM;
709 return mask;
713 * create an RxRPC socket
715 static int rxrpc_create(struct net *net, struct socket *sock, int protocol,
716 int kern)
718 struct rxrpc_sock *rx;
719 struct sock *sk;
721 _enter("%p,%d", sock, protocol);
723 /* we support transport protocol UDP/UDP6 only */
724 if (protocol != PF_INET &&
725 IS_ENABLED(CONFIG_AF_RXRPC_IPV6) && protocol != PF_INET6)
726 return -EPROTONOSUPPORT;
728 if (sock->type != SOCK_DGRAM)
729 return -ESOCKTNOSUPPORT;
731 sock->ops = &rxrpc_rpc_ops;
732 sock->state = SS_UNCONNECTED;
734 sk = sk_alloc(net, PF_RXRPC, GFP_KERNEL, &rxrpc_proto, kern);
735 if (!sk)
736 return -ENOMEM;
738 sock_init_data(sock, sk);
739 sock_set_flag(sk, SOCK_RCU_FREE);
740 sk->sk_state = RXRPC_UNBOUND;
741 sk->sk_write_space = rxrpc_write_space;
742 sk->sk_max_ack_backlog = 0;
743 sk->sk_destruct = rxrpc_sock_destructor;
745 rx = rxrpc_sk(sk);
746 rx->family = protocol;
747 rx->calls = RB_ROOT;
749 spin_lock_init(&rx->incoming_lock);
750 INIT_LIST_HEAD(&rx->sock_calls);
751 INIT_LIST_HEAD(&rx->to_be_accepted);
752 INIT_LIST_HEAD(&rx->recvmsg_q);
753 rwlock_init(&rx->recvmsg_lock);
754 rwlock_init(&rx->call_lock);
755 memset(&rx->srx, 0, sizeof(rx->srx));
757 _leave(" = 0 [%p]", rx);
758 return 0;
762 * Kill all the calls on a socket and shut it down.
764 static int rxrpc_shutdown(struct socket *sock, int flags)
766 struct sock *sk = sock->sk;
767 struct rxrpc_sock *rx = rxrpc_sk(sk);
768 int ret = 0;
770 _enter("%p,%d", sk, flags);
772 if (flags != SHUT_RDWR)
773 return -EOPNOTSUPP;
774 if (sk->sk_state == RXRPC_CLOSE)
775 return -ESHUTDOWN;
777 lock_sock(sk);
779 spin_lock_bh(&sk->sk_receive_queue.lock);
780 if (sk->sk_state < RXRPC_CLOSE) {
781 sk->sk_state = RXRPC_CLOSE;
782 sk->sk_shutdown = SHUTDOWN_MASK;
783 } else {
784 ret = -ESHUTDOWN;
786 spin_unlock_bh(&sk->sk_receive_queue.lock);
788 rxrpc_discard_prealloc(rx);
790 release_sock(sk);
791 return ret;
795 * RxRPC socket destructor
797 static void rxrpc_sock_destructor(struct sock *sk)
799 _enter("%p", sk);
801 rxrpc_purge_queue(&sk->sk_receive_queue);
803 WARN_ON(refcount_read(&sk->sk_wmem_alloc));
804 WARN_ON(!sk_unhashed(sk));
805 WARN_ON(sk->sk_socket);
807 if (!sock_flag(sk, SOCK_DEAD)) {
808 printk("Attempt to release alive rxrpc socket: %p\n", sk);
809 return;
814 * release an RxRPC socket
816 static int rxrpc_release_sock(struct sock *sk)
818 struct rxrpc_sock *rx = rxrpc_sk(sk);
820 _enter("%p{%d,%d}", sk, sk->sk_state, refcount_read(&sk->sk_refcnt));
822 /* declare the socket closed for business */
823 sock_orphan(sk);
824 sk->sk_shutdown = SHUTDOWN_MASK;
826 /* We want to kill off all connections from a service socket
827 * as fast as possible because we can't share these; client
828 * sockets, on the other hand, can share an endpoint.
830 switch (sk->sk_state) {
831 case RXRPC_SERVER_BOUND:
832 case RXRPC_SERVER_BOUND2:
833 case RXRPC_SERVER_LISTENING:
834 case RXRPC_SERVER_LISTEN_DISABLED:
835 rx->local->service_closed = true;
836 break;
839 spin_lock_bh(&sk->sk_receive_queue.lock);
840 sk->sk_state = RXRPC_CLOSE;
841 spin_unlock_bh(&sk->sk_receive_queue.lock);
843 if (rx->local && rcu_access_pointer(rx->local->service) == rx) {
844 write_lock(&rx->local->services_lock);
845 rcu_assign_pointer(rx->local->service, NULL);
846 write_unlock(&rx->local->services_lock);
849 /* try to flush out this socket */
850 rxrpc_discard_prealloc(rx);
851 rxrpc_release_calls_on_socket(rx);
852 flush_workqueue(rxrpc_workqueue);
853 rxrpc_purge_queue(&sk->sk_receive_queue);
855 rxrpc_put_local(rx->local);
856 rx->local = NULL;
857 key_put(rx->key);
858 rx->key = NULL;
859 key_put(rx->securities);
860 rx->securities = NULL;
861 sock_put(sk);
863 _leave(" = 0");
864 return 0;
868 * release an RxRPC BSD socket on close() or equivalent
870 static int rxrpc_release(struct socket *sock)
872 struct sock *sk = sock->sk;
874 _enter("%p{%p}", sock, sk);
876 if (!sk)
877 return 0;
879 sock->sk = NULL;
881 return rxrpc_release_sock(sk);
885 * RxRPC network protocol
887 static const struct proto_ops rxrpc_rpc_ops = {
888 .family = PF_RXRPC,
889 .owner = THIS_MODULE,
890 .release = rxrpc_release,
891 .bind = rxrpc_bind,
892 .connect = rxrpc_connect,
893 .socketpair = sock_no_socketpair,
894 .accept = sock_no_accept,
895 .getname = sock_no_getname,
896 .poll = rxrpc_poll,
897 .ioctl = sock_no_ioctl,
898 .listen = rxrpc_listen,
899 .shutdown = rxrpc_shutdown,
900 .setsockopt = rxrpc_setsockopt,
901 .getsockopt = rxrpc_getsockopt,
902 .sendmsg = rxrpc_sendmsg,
903 .recvmsg = rxrpc_recvmsg,
904 .mmap = sock_no_mmap,
905 .sendpage = sock_no_sendpage,
908 static struct proto rxrpc_proto = {
909 .name = "RXRPC",
910 .owner = THIS_MODULE,
911 .obj_size = sizeof(struct rxrpc_sock),
912 .max_header = sizeof(struct rxrpc_wire_header),
915 static const struct net_proto_family rxrpc_family_ops = {
916 .family = PF_RXRPC,
917 .create = rxrpc_create,
918 .owner = THIS_MODULE,
922 * initialise and register the RxRPC protocol
924 static int __init af_rxrpc_init(void)
926 int ret = -1;
927 unsigned int tmp;
929 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv) > FIELD_SIZEOF(struct sk_buff, cb));
931 get_random_bytes(&tmp, sizeof(tmp));
932 tmp &= 0x3fffffff;
933 if (tmp == 0)
934 tmp = 1;
935 idr_set_cursor(&rxrpc_client_conn_ids, tmp);
937 ret = -ENOMEM;
938 rxrpc_call_jar = kmem_cache_create(
939 "rxrpc_call_jar", sizeof(struct rxrpc_call), 0,
940 SLAB_HWCACHE_ALIGN, NULL);
941 if (!rxrpc_call_jar) {
942 pr_notice("Failed to allocate call jar\n");
943 goto error_call_jar;
946 rxrpc_workqueue = alloc_workqueue("krxrpcd", 0, 1);
947 if (!rxrpc_workqueue) {
948 pr_notice("Failed to allocate work queue\n");
949 goto error_work_queue;
952 ret = rxrpc_init_security();
953 if (ret < 0) {
954 pr_crit("Cannot initialise security\n");
955 goto error_security;
958 ret = register_pernet_subsys(&rxrpc_net_ops);
959 if (ret)
960 goto error_pernet;
962 ret = proto_register(&rxrpc_proto, 1);
963 if (ret < 0) {
964 pr_crit("Cannot register protocol\n");
965 goto error_proto;
968 ret = sock_register(&rxrpc_family_ops);
969 if (ret < 0) {
970 pr_crit("Cannot register socket family\n");
971 goto error_sock;
974 ret = register_key_type(&key_type_rxrpc);
975 if (ret < 0) {
976 pr_crit("Cannot register client key type\n");
977 goto error_key_type;
980 ret = register_key_type(&key_type_rxrpc_s);
981 if (ret < 0) {
982 pr_crit("Cannot register server key type\n");
983 goto error_key_type_s;
986 ret = rxrpc_sysctl_init();
987 if (ret < 0) {
988 pr_crit("Cannot register sysctls\n");
989 goto error_sysctls;
992 return 0;
994 error_sysctls:
995 unregister_key_type(&key_type_rxrpc_s);
996 error_key_type_s:
997 unregister_key_type(&key_type_rxrpc);
998 error_key_type:
999 sock_unregister(PF_RXRPC);
1000 error_sock:
1001 proto_unregister(&rxrpc_proto);
1002 error_proto:
1003 unregister_pernet_subsys(&rxrpc_net_ops);
1004 error_pernet:
1005 rxrpc_exit_security();
1006 error_security:
1007 destroy_workqueue(rxrpc_workqueue);
1008 error_work_queue:
1009 kmem_cache_destroy(rxrpc_call_jar);
1010 error_call_jar:
1011 return ret;
1015 * unregister the RxRPC protocol
1017 static void __exit af_rxrpc_exit(void)
1019 _enter("");
1020 rxrpc_sysctl_exit();
1021 unregister_key_type(&key_type_rxrpc_s);
1022 unregister_key_type(&key_type_rxrpc);
1023 sock_unregister(PF_RXRPC);
1024 proto_unregister(&rxrpc_proto);
1025 unregister_pernet_subsys(&rxrpc_net_ops);
1026 ASSERTCMP(atomic_read(&rxrpc_n_tx_skbs), ==, 0);
1027 ASSERTCMP(atomic_read(&rxrpc_n_rx_skbs), ==, 0);
1029 /* Make sure the local and peer records pinned by any dying connections
1030 * are released.
1032 rcu_barrier();
1033 rxrpc_destroy_client_conn_ids();
1035 destroy_workqueue(rxrpc_workqueue);
1036 rxrpc_exit_security();
1037 kmem_cache_destroy(rxrpc_call_jar);
1038 _leave("");
1041 module_init(af_rxrpc_init);
1042 module_exit(af_rxrpc_exit);