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/net.h>
14 #include <linux/skbuff.h>
15 #include <linux/poll.h>
16 #include <linux/proc_fs.h>
18 #include <net/af_rxrpc.h>
19 #include "ar-internal.h"
21 MODULE_DESCRIPTION("RxRPC network protocol");
22 MODULE_AUTHOR("Red Hat, Inc.");
23 MODULE_LICENSE("GPL");
24 MODULE_ALIAS_NETPROTO(PF_RXRPC
);
26 unsigned rxrpc_debug
; // = RXRPC_DEBUG_KPROTO;
27 module_param_named(debug
, rxrpc_debug
, uint
, S_IWUSR
| S_IRUGO
);
28 MODULE_PARM_DESC(rxrpc_debug
, "RxRPC debugging mask");
30 static int sysctl_rxrpc_max_qlen __read_mostly
= 10;
32 static struct proto rxrpc_proto
;
33 static const struct proto_ops rxrpc_rpc_ops
;
35 /* local epoch for detecting local-end reset */
38 /* current debugging ID */
39 atomic_t rxrpc_debug_id
;
41 /* count of skbs currently in use */
42 atomic_t rxrpc_n_skbs
;
44 static void rxrpc_sock_destructor(struct sock
*);
47 * see if an RxRPC socket is currently writable
49 static inline int rxrpc_writable(struct sock
*sk
)
51 return atomic_read(&sk
->sk_wmem_alloc
) < (size_t) sk
->sk_sndbuf
;
55 * wait for write bufferage to become available
57 static void rxrpc_write_space(struct sock
*sk
)
60 read_lock(&sk
->sk_callback_lock
);
61 if (rxrpc_writable(sk
)) {
62 if (sk
->sk_sleep
&& waitqueue_active(sk
->sk_sleep
))
63 wake_up_interruptible(sk
->sk_sleep
);
64 sk_wake_async(sk
, 2, POLL_OUT
);
66 read_unlock(&sk
->sk_callback_lock
);
70 * validate an RxRPC address
72 static int rxrpc_validate_address(struct rxrpc_sock
*rx
,
73 struct sockaddr_rxrpc
*srx
,
76 if (len
< sizeof(struct sockaddr_rxrpc
))
79 if (srx
->srx_family
!= AF_RXRPC
)
82 if (srx
->transport_type
!= SOCK_DGRAM
)
83 return -ESOCKTNOSUPPORT
;
85 len
-= offsetof(struct sockaddr_rxrpc
, transport
);
86 if (srx
->transport_len
< sizeof(sa_family_t
) ||
87 srx
->transport_len
> len
)
90 if (srx
->transport
.family
!= rx
->proto
)
93 switch (srx
->transport
.family
) {
95 _debug("INET: %x @ %u.%u.%u.%u",
96 ntohs(srx
->transport
.sin
.sin_port
),
97 NIPQUAD(srx
->transport
.sin
.sin_addr
));
98 if (srx
->transport_len
> 8)
99 memset((void *)&srx
->transport
+ 8, 0,
100 srx
->transport_len
- 8);
105 return -EAFNOSUPPORT
;
112 * bind a local address to an RxRPC socket
114 static int rxrpc_bind(struct socket
*sock
, struct sockaddr
*saddr
, int len
)
116 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*) saddr
;
117 struct sock
*sk
= sock
->sk
;
118 struct rxrpc_local
*local
;
119 struct rxrpc_sock
*rx
= rxrpc_sk(sk
), *prx
;
123 _enter("%p,%p,%d", rx
, saddr
, len
);
125 ret
= rxrpc_validate_address(rx
, srx
, len
);
131 if (rx
->sk
.sk_state
!= RXRPC_UNCONNECTED
) {
136 memcpy(&rx
->srx
, srx
, sizeof(rx
->srx
));
138 /* find a local transport endpoint if we don't have one already */
139 local
= rxrpc_lookup_local(&rx
->srx
);
141 ret
= PTR_ERR(local
);
146 if (srx
->srx_service
) {
147 service_id
= htons(srx
->srx_service
);
148 write_lock_bh(&local
->services_lock
);
149 list_for_each_entry(prx
, &local
->services
, listen_link
) {
150 if (prx
->service_id
== service_id
)
154 rx
->service_id
= service_id
;
155 list_add_tail(&rx
->listen_link
, &local
->services
);
156 write_unlock_bh(&local
->services_lock
);
158 rx
->sk
.sk_state
= RXRPC_SERVER_BOUND
;
160 rx
->sk
.sk_state
= RXRPC_CLIENT_BOUND
;
163 release_sock(&rx
->sk
);
169 write_unlock_bh(&local
->services_lock
);
171 release_sock(&rx
->sk
);
173 _leave(" = %d", ret
);
178 * set the number of pending calls permitted on a listening socket
180 static int rxrpc_listen(struct socket
*sock
, int backlog
)
182 struct sock
*sk
= sock
->sk
;
183 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
186 _enter("%p,%d", rx
, backlog
);
190 switch (rx
->sk
.sk_state
) {
191 case RXRPC_UNCONNECTED
:
192 ret
= -EADDRNOTAVAIL
;
194 case RXRPC_CLIENT_BOUND
:
195 case RXRPC_CLIENT_CONNECTED
:
199 case RXRPC_SERVER_BOUND
:
200 ASSERT(rx
->local
!= NULL
);
201 sk
->sk_max_ack_backlog
= backlog
;
202 rx
->sk
.sk_state
= RXRPC_SERVER_LISTENING
;
207 release_sock(&rx
->sk
);
208 _leave(" = %d", ret
);
213 * find a transport by address
215 static struct rxrpc_transport
*rxrpc_name_to_transport(struct socket
*sock
,
216 struct sockaddr
*addr
,
217 int addr_len
, int flags
)
219 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*) addr
;
220 struct rxrpc_transport
*trans
;
221 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
222 struct rxrpc_peer
*peer
;
224 _enter("%p,%p,%d,%d", rx
, addr
, addr_len
, flags
);
226 ASSERT(rx
->local
!= NULL
);
227 ASSERT(rx
->sk
.sk_state
> RXRPC_UNCONNECTED
);
229 if (rx
->srx
.transport_type
!= srx
->transport_type
)
230 return ERR_PTR(-ESOCKTNOSUPPORT
);
231 if (rx
->srx
.transport
.family
!= srx
->transport
.family
)
232 return ERR_PTR(-EAFNOSUPPORT
);
234 /* find a remote transport endpoint from the local one */
235 peer
= rxrpc_get_peer(srx
, GFP_KERNEL
);
237 return ERR_PTR(PTR_ERR(peer
));
239 /* find a transport */
240 trans
= rxrpc_get_transport(rx
->local
, peer
, GFP_KERNEL
);
241 rxrpc_put_peer(peer
);
242 _leave(" = %p", trans
);
247 * connect an RxRPC socket
248 * - this just targets it at a specific destination; no actual connection
249 * negotiation takes place
251 static int rxrpc_connect(struct socket
*sock
, struct sockaddr
*addr
,
252 int addr_len
, int flags
)
254 struct sockaddr_rxrpc
*srx
= (struct sockaddr_rxrpc
*) addr
;
255 struct sock
*sk
= sock
->sk
;
256 struct rxrpc_transport
*trans
;
257 struct rxrpc_local
*local
;
258 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
261 _enter("%p,%p,%d,%d", rx
, addr
, addr_len
, flags
);
263 ret
= rxrpc_validate_address(rx
, srx
, addr_len
);
265 _leave(" = %d [bad addr]", ret
);
271 switch (rx
->sk
.sk_state
) {
272 case RXRPC_UNCONNECTED
:
273 /* find a local transport endpoint if we don't have one already */
274 ASSERTCMP(rx
->local
, ==, NULL
);
275 rx
->srx
.srx_family
= AF_RXRPC
;
276 rx
->srx
.srx_service
= 0;
277 rx
->srx
.transport_type
= srx
->transport_type
;
278 rx
->srx
.transport_len
= sizeof(sa_family_t
);
279 rx
->srx
.transport
.family
= srx
->transport
.family
;
280 local
= rxrpc_lookup_local(&rx
->srx
);
282 release_sock(&rx
->sk
);
283 return PTR_ERR(local
);
286 rx
->sk
.sk_state
= RXRPC_CLIENT_BOUND
;
287 case RXRPC_CLIENT_BOUND
:
289 case RXRPC_CLIENT_CONNECTED
:
290 release_sock(&rx
->sk
);
293 release_sock(&rx
->sk
);
294 return -EBUSY
; /* server sockets can't connect as well */
297 trans
= rxrpc_name_to_transport(sock
, addr
, addr_len
, flags
);
299 release_sock(&rx
->sk
);
300 _leave(" = %ld", PTR_ERR(trans
));
301 return PTR_ERR(trans
);
305 rx
->service_id
= htons(srx
->srx_service
);
306 rx
->sk
.sk_state
= RXRPC_CLIENT_CONNECTED
;
308 release_sock(&rx
->sk
);
313 * send a message through an RxRPC socket
314 * - in a client this does a number of things:
315 * - finds/sets up a connection for the security specified (if any)
316 * - initiates a call (ID in control data)
317 * - ends the request phase of a call (if MSG_MORE is not set)
318 * - sends a call data packet
319 * - may send an abort (abort code in control data)
321 static int rxrpc_sendmsg(struct kiocb
*iocb
, struct socket
*sock
,
322 struct msghdr
*m
, size_t len
)
324 struct rxrpc_transport
*trans
;
325 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
328 _enter(",{%d},,%zu", rx
->sk
.sk_state
, len
);
330 if (m
->msg_flags
& MSG_OOB
)
334 ret
= rxrpc_validate_address(rx
, m
->msg_name
, m
->msg_namelen
);
336 _leave(" = %d [bad addr]", ret
);
346 trans
= rxrpc_name_to_transport(sock
, m
->msg_name
,
349 ret
= PTR_ERR(trans
);
356 atomic_inc(&trans
->usage
);
359 switch (rx
->sk
.sk_state
) {
360 case RXRPC_SERVER_LISTENING
:
362 ret
= rxrpc_server_sendmsg(iocb
, rx
, m
, len
);
365 case RXRPC_SERVER_BOUND
:
366 case RXRPC_CLIENT_BOUND
:
371 case RXRPC_CLIENT_CONNECTED
:
372 ret
= rxrpc_client_sendmsg(iocb
, rx
, trans
, m
, len
);
380 release_sock(&rx
->sk
);
382 rxrpc_put_transport(trans
);
383 _leave(" = %d", ret
);
388 * set RxRPC socket options
390 static int rxrpc_setsockopt(struct socket
*sock
, int level
, int optname
,
391 char __user
*optval
, int optlen
)
393 struct rxrpc_sock
*rx
= rxrpc_sk(sock
->sk
);
394 unsigned min_sec_level
;
397 _enter(",%d,%d,,%d", level
, optname
, optlen
);
402 if (level
== SOL_RXRPC
) {
404 case RXRPC_EXCLUSIVE_CONNECTION
:
409 if (rx
->sk
.sk_state
!= RXRPC_UNCONNECTED
)
411 set_bit(RXRPC_SOCK_EXCLUSIVE_CONN
, &rx
->flags
);
414 case RXRPC_SECURITY_KEY
:
419 if (rx
->sk
.sk_state
!= RXRPC_UNCONNECTED
)
421 ret
= rxrpc_request_key(rx
, optval
, optlen
);
424 case RXRPC_SECURITY_KEYRING
:
429 if (rx
->sk
.sk_state
!= RXRPC_UNCONNECTED
)
431 ret
= rxrpc_server_keyring(rx
, optval
, optlen
);
434 case RXRPC_MIN_SECURITY_LEVEL
:
436 if (optlen
!= sizeof(unsigned))
439 if (rx
->sk
.sk_state
!= RXRPC_UNCONNECTED
)
441 ret
= get_user(min_sec_level
,
442 (unsigned __user
*) optval
);
446 if (min_sec_level
> RXRPC_SECURITY_MAX
)
448 rx
->min_sec_level
= min_sec_level
;
459 release_sock(&rx
->sk
);
464 * permit an RxRPC socket to be polled
466 static unsigned int rxrpc_poll(struct file
*file
, struct socket
*sock
,
470 struct sock
*sk
= sock
->sk
;
472 poll_wait(file
, sk
->sk_sleep
, wait
);
475 /* the socket is readable if there are any messages waiting on the Rx
477 if (!skb_queue_empty(&sk
->sk_receive_queue
))
478 mask
|= POLLIN
| POLLRDNORM
;
480 /* the socket is writable if there is space to add new data to the
481 * socket; there is no guarantee that any particular call in progress
482 * on the socket may have space in the Tx ACK window */
483 if (rxrpc_writable(sk
))
484 mask
|= POLLOUT
| POLLWRNORM
;
490 * create an RxRPC socket
492 static int rxrpc_create(struct socket
*sock
, int protocol
)
494 struct rxrpc_sock
*rx
;
497 _enter("%p,%d", sock
, protocol
);
499 /* we support transport protocol UDP only */
500 if (protocol
!= PF_INET
)
501 return -EPROTONOSUPPORT
;
503 if (sock
->type
!= SOCK_DGRAM
)
504 return -ESOCKTNOSUPPORT
;
506 sock
->ops
= &rxrpc_rpc_ops
;
507 sock
->state
= SS_UNCONNECTED
;
509 sk
= sk_alloc(PF_RXRPC
, GFP_KERNEL
, &rxrpc_proto
, 1);
513 sock_init_data(sock
, sk
);
514 sk
->sk_state
= RXRPC_UNCONNECTED
;
515 sk
->sk_write_space
= rxrpc_write_space
;
516 sk
->sk_max_ack_backlog
= sysctl_rxrpc_max_qlen
;
517 sk
->sk_destruct
= rxrpc_sock_destructor
;
520 rx
->proto
= protocol
;
523 INIT_LIST_HEAD(&rx
->listen_link
);
524 INIT_LIST_HEAD(&rx
->secureq
);
525 INIT_LIST_HEAD(&rx
->acceptq
);
526 rwlock_init(&rx
->call_lock
);
527 memset(&rx
->srx
, 0, sizeof(rx
->srx
));
529 _leave(" = 0 [%p]", rx
);
534 * RxRPC socket destructor
536 static void rxrpc_sock_destructor(struct sock
*sk
)
540 rxrpc_purge_queue(&sk
->sk_receive_queue
);
542 BUG_TRAP(!atomic_read(&sk
->sk_wmem_alloc
));
543 BUG_TRAP(sk_unhashed(sk
));
544 BUG_TRAP(!sk
->sk_socket
);
546 if (!sock_flag(sk
, SOCK_DEAD
)) {
547 printk("Attempt to release alive rxrpc socket: %p\n", sk
);
553 * release an RxRPC socket
555 static int rxrpc_release_sock(struct sock
*sk
)
557 struct rxrpc_sock
*rx
= rxrpc_sk(sk
);
559 _enter("%p{%d,%d}", sk
, sk
->sk_state
, atomic_read(&sk
->sk_refcnt
));
561 /* declare the socket closed for business */
563 sk
->sk_shutdown
= SHUTDOWN_MASK
;
565 spin_lock_bh(&sk
->sk_receive_queue
.lock
);
566 sk
->sk_state
= RXRPC_CLOSE
;
567 spin_unlock_bh(&sk
->sk_receive_queue
.lock
);
569 ASSERTCMP(rx
->listen_link
.next
, !=, LIST_POISON1
);
571 if (!list_empty(&rx
->listen_link
)) {
572 write_lock_bh(&rx
->local
->services_lock
);
573 list_del(&rx
->listen_link
);
574 write_unlock_bh(&rx
->local
->services_lock
);
577 /* try to flush out this socket */
578 rxrpc_release_calls_on_socket(rx
);
579 flush_scheduled_work();
580 rxrpc_purge_queue(&sk
->sk_receive_queue
);
583 rxrpc_put_connection(rx
->conn
);
588 rxrpc_put_bundle(rx
->trans
, rx
->bundle
);
592 rxrpc_put_transport(rx
->trans
);
596 rxrpc_put_local(rx
->local
);
602 key_put(rx
->securities
);
603 rx
->securities
= NULL
;
611 * release an RxRPC BSD socket on close() or equivalent
613 static int rxrpc_release(struct socket
*sock
)
615 struct sock
*sk
= sock
->sk
;
617 _enter("%p{%p}", sock
, sk
);
624 return rxrpc_release_sock(sk
);
628 * RxRPC network protocol
630 static const struct proto_ops rxrpc_rpc_ops
= {
632 .owner
= THIS_MODULE
,
633 .release
= rxrpc_release
,
635 .connect
= rxrpc_connect
,
636 .socketpair
= sock_no_socketpair
,
637 .accept
= sock_no_accept
,
638 .getname
= sock_no_getname
,
640 .ioctl
= sock_no_ioctl
,
641 .listen
= rxrpc_listen
,
642 .shutdown
= sock_no_shutdown
,
643 .setsockopt
= rxrpc_setsockopt
,
644 .getsockopt
= sock_no_getsockopt
,
645 .sendmsg
= rxrpc_sendmsg
,
646 .recvmsg
= rxrpc_recvmsg
,
647 .mmap
= sock_no_mmap
,
648 .sendpage
= sock_no_sendpage
,
651 static struct proto rxrpc_proto
= {
653 .owner
= THIS_MODULE
,
654 .obj_size
= sizeof(struct rxrpc_sock
),
655 .max_header
= sizeof(struct rxrpc_header
),
658 static struct net_proto_family rxrpc_family_ops
= {
660 .create
= rxrpc_create
,
661 .owner
= THIS_MODULE
,
665 * initialise and register the RxRPC protocol
667 static int __init
af_rxrpc_init(void)
669 struct sk_buff
*dummy_skb
;
672 BUILD_BUG_ON(sizeof(struct rxrpc_skb_priv
) > sizeof(dummy_skb
->cb
));
674 rxrpc_epoch
= htonl(xtime
.tv_sec
);
676 rxrpc_call_jar
= kmem_cache_create(
677 "rxrpc_call_jar", sizeof(struct rxrpc_call
), 0,
678 SLAB_HWCACHE_ALIGN
, NULL
, NULL
);
679 if (!rxrpc_call_jar
) {
680 printk(KERN_NOTICE
"RxRPC: Failed to allocate call jar\n");
685 ret
= proto_register(&rxrpc_proto
, 1);
687 printk(KERN_CRIT
"RxRPC: Cannot register protocol\n");
691 ret
= sock_register(&rxrpc_family_ops
);
693 printk(KERN_CRIT
"RxRPC: Cannot register socket family\n");
697 ret
= register_key_type(&key_type_rxrpc
);
699 printk(KERN_CRIT
"RxRPC: Cannot register client key type\n");
703 ret
= register_key_type(&key_type_rxrpc_s
);
705 printk(KERN_CRIT
"RxRPC: Cannot register server key type\n");
706 goto error_key_type_s
;
709 #ifdef CONFIG_PROC_FS
710 proc_net_fops_create("rxrpc_calls", 0, &rxrpc_call_seq_fops
);
711 proc_net_fops_create("rxrpc_conns", 0, &rxrpc_connection_seq_fops
);
716 unregister_key_type(&key_type_rxrpc
);
718 sock_unregister(PF_RXRPC
);
720 proto_unregister(&rxrpc_proto
);
722 kmem_cache_destroy(rxrpc_call_jar
);
728 * unregister the RxRPC protocol
730 static void __exit
af_rxrpc_exit(void)
733 unregister_key_type(&key_type_rxrpc_s
);
734 unregister_key_type(&key_type_rxrpc
);
735 sock_unregister(PF_RXRPC
);
736 proto_unregister(&rxrpc_proto
);
737 rxrpc_destroy_all_calls();
738 rxrpc_destroy_all_connections();
739 rxrpc_destroy_all_transports();
740 rxrpc_destroy_all_peers();
741 rxrpc_destroy_all_locals();
743 ASSERTCMP(atomic_read(&rxrpc_n_skbs
), ==, 0);
745 _debug("flush scheduled work");
746 flush_scheduled_work();
747 proc_net_remove("rxrpc_conns");
748 proc_net_remove("rxrpc_calls");
749 kmem_cache_destroy(rxrpc_call_jar
);
753 module_init(af_rxrpc_init
);
754 module_exit(af_rxrpc_exit
);