1 /* Maintain an RxRPC server socket to do AFS communications through
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.
13 #include <net/af_rxrpc.h>
14 #include <rxrpc/packet.h>
18 static struct socket
*afs_socket
; /* my RxRPC socket */
19 static struct workqueue_struct
*afs_async_calls
;
20 static atomic_t afs_outstanding_calls
;
21 static atomic_t afs_outstanding_skbs
;
23 static void afs_wake_up_call_waiter(struct afs_call
*);
24 static int afs_wait_for_call_to_complete(struct afs_call
*);
25 static void afs_wake_up_async_call(struct afs_call
*);
26 static int afs_dont_wait_for_call_to_complete(struct afs_call
*);
27 static void afs_process_async_call(struct work_struct
*);
28 static void afs_rx_interceptor(struct sock
*, unsigned long, struct sk_buff
*);
29 static int afs_deliver_cm_op_id(struct afs_call
*, struct sk_buff
*, bool);
31 /* synchronous call management */
32 const struct afs_wait_mode afs_sync_call
= {
33 .rx_wakeup
= afs_wake_up_call_waiter
,
34 .wait
= afs_wait_for_call_to_complete
,
37 /* asynchronous call management */
38 const struct afs_wait_mode afs_async_call
= {
39 .rx_wakeup
= afs_wake_up_async_call
,
40 .wait
= afs_dont_wait_for_call_to_complete
,
43 /* asynchronous incoming call management */
44 static const struct afs_wait_mode afs_async_incoming_call
= {
45 .rx_wakeup
= afs_wake_up_async_call
,
48 /* asynchronous incoming call initial processing */
49 static const struct afs_call_type afs_RXCMxxxx
= {
51 .deliver
= afs_deliver_cm_op_id
,
52 .abort_to_error
= afs_abort_to_error
,
55 static void afs_collect_incoming_call(struct work_struct
*);
57 static struct sk_buff_head afs_incoming_calls
;
58 static DECLARE_WORK(afs_collect_incoming_call_work
, afs_collect_incoming_call
);
61 * open an RxRPC socket and bind it to be a server for callback notifications
62 * - the socket is left in blocking mode and non-blocking ops use MSG_DONTWAIT
64 int afs_open_socket(void)
66 struct sockaddr_rxrpc srx
;
67 struct socket
*socket
;
72 skb_queue_head_init(&afs_incoming_calls
);
74 afs_async_calls
= create_singlethread_workqueue("kafsd");
75 if (!afs_async_calls
) {
76 _leave(" = -ENOMEM [wq]");
80 ret
= sock_create_kern(AF_RXRPC
, SOCK_DGRAM
, PF_INET
, &socket
);
82 destroy_workqueue(afs_async_calls
);
83 _leave(" = %d [socket]", ret
);
87 socket
->sk
->sk_allocation
= GFP_NOFS
;
89 /* bind the callback manager's address to make this a server socket */
90 srx
.srx_family
= AF_RXRPC
;
91 srx
.srx_service
= CM_SERVICE
;
92 srx
.transport_type
= SOCK_DGRAM
;
93 srx
.transport_len
= sizeof(srx
.transport
.sin
);
94 srx
.transport
.sin
.sin_family
= AF_INET
;
95 srx
.transport
.sin
.sin_port
= htons(AFS_CM_PORT
);
96 memset(&srx
.transport
.sin
.sin_addr
, 0,
97 sizeof(srx
.transport
.sin
.sin_addr
));
99 ret
= kernel_bind(socket
, (struct sockaddr
*) &srx
, sizeof(srx
));
101 sock_release(socket
);
102 _leave(" = %d [bind]", ret
);
106 rxrpc_kernel_intercept_rx_messages(socket
, afs_rx_interceptor
);
114 * close the RxRPC socket AFS was using
116 void afs_close_socket(void)
120 sock_release(afs_socket
);
123 destroy_workqueue(afs_async_calls
);
125 ASSERTCMP(atomic_read(&afs_outstanding_skbs
), ==, 0);
126 ASSERTCMP(atomic_read(&afs_outstanding_calls
), ==, 0);
131 * note that the data in a socket buffer is now delivered and that the buffer
134 static void afs_data_delivered(struct sk_buff
*skb
)
137 _debug("DLVR NULL [%d]", atomic_read(&afs_outstanding_skbs
));
140 _debug("DLVR %p{%u} [%d]",
141 skb
, skb
->mark
, atomic_read(&afs_outstanding_skbs
));
142 if (atomic_dec_return(&afs_outstanding_skbs
) == -1)
144 rxrpc_kernel_data_delivered(skb
);
149 * free a socket buffer
151 static void afs_free_skb(struct sk_buff
*skb
)
154 _debug("FREE NULL [%d]", atomic_read(&afs_outstanding_skbs
));
157 _debug("FREE %p{%u} [%d]",
158 skb
, skb
->mark
, atomic_read(&afs_outstanding_skbs
));
159 if (atomic_dec_return(&afs_outstanding_skbs
) == -1)
161 rxrpc_kernel_free_skb(skb
);
168 static void afs_free_call(struct afs_call
*call
)
170 _debug("DONE %p{%s} [%d]",
171 call
, call
->type
->name
, atomic_read(&afs_outstanding_calls
));
172 if (atomic_dec_return(&afs_outstanding_calls
) == -1)
175 ASSERTCMP(call
->rxcall
, ==, NULL
);
176 ASSERT(!work_pending(&call
->async_work
));
177 ASSERT(skb_queue_empty(&call
->rx_queue
));
178 ASSERT(call
->type
->name
!= NULL
);
180 kfree(call
->request
);
185 * allocate a call with flat request and reply buffers
187 struct afs_call
*afs_alloc_flat_call(const struct afs_call_type
*type
,
188 size_t request_size
, size_t reply_size
)
190 struct afs_call
*call
;
192 call
= kzalloc(sizeof(*call
), GFP_NOFS
);
196 _debug("CALL %p{%s} [%d]",
197 call
, type
->name
, atomic_read(&afs_outstanding_calls
));
198 atomic_inc(&afs_outstanding_calls
);
201 call
->request_size
= request_size
;
202 call
->reply_max
= reply_size
;
205 call
->request
= kmalloc(request_size
, GFP_NOFS
);
211 call
->buffer
= kmalloc(reply_size
, GFP_NOFS
);
216 init_waitqueue_head(&call
->waitq
);
217 skb_queue_head_init(&call
->rx_queue
);
227 * clean up a call with flat buffer
229 void afs_flat_call_destructor(struct afs_call
*call
)
233 kfree(call
->request
);
234 call
->request
= NULL
;
240 * attach the data from a bunch of pages on an inode to a call
242 static int afs_send_pages(struct afs_call
*call
, struct msghdr
*msg
,
245 struct page
*pages
[8];
246 unsigned count
, n
, loop
, offset
, to
;
247 pgoff_t first
= call
->first
, last
= call
->last
;
252 offset
= call
->first_offset
;
253 call
->first_offset
= 0;
256 _debug("attach %lx-%lx", first
, last
);
258 count
= last
- first
+ 1;
259 if (count
> ARRAY_SIZE(pages
))
260 count
= ARRAY_SIZE(pages
);
261 n
= find_get_pages_contig(call
->mapping
, first
, count
, pages
);
262 ASSERTCMP(n
, ==, count
);
268 if (first
+ loop
>= last
)
271 msg
->msg_flags
= MSG_MORE
;
272 iov
->iov_base
= kmap(pages
[loop
]) + offset
;
273 iov
->iov_len
= to
- offset
;
276 _debug("- range %u-%u%s",
277 offset
, to
, msg
->msg_flags
? " [more]" : "");
278 msg
->msg_iov
= (struct iovec
*) iov
;
281 /* have to change the state *before* sending the last
282 * packet as RxRPC might give us the reply before it
283 * returns from sending the request */
284 if (first
+ loop
>= last
)
285 call
->state
= AFS_CALL_AWAIT_REPLY
;
286 ret
= rxrpc_kernel_send_data(call
->rxcall
, msg
,
291 } while (++loop
< count
);
294 for (loop
= 0; loop
< count
; loop
++)
295 put_page(pages
[loop
]);
298 } while (first
<= last
);
300 _leave(" = %d", ret
);
307 int afs_make_call(struct in_addr
*addr
, struct afs_call
*call
, gfp_t gfp
,
308 const struct afs_wait_mode
*wait_mode
)
310 struct sockaddr_rxrpc srx
;
311 struct rxrpc_call
*rxcall
;
316 _enter("%x,{%d},", addr
->s_addr
, ntohs(call
->port
));
318 ASSERT(call
->type
!= NULL
);
319 ASSERT(call
->type
->name
!= NULL
);
321 _debug("____MAKE %p{%s,%x} [%d]____",
322 call
, call
->type
->name
, key_serial(call
->key
),
323 atomic_read(&afs_outstanding_calls
));
325 call
->wait_mode
= wait_mode
;
326 INIT_WORK(&call
->async_work
, afs_process_async_call
);
328 memset(&srx
, 0, sizeof(srx
));
329 srx
.srx_family
= AF_RXRPC
;
330 srx
.srx_service
= call
->service_id
;
331 srx
.transport_type
= SOCK_DGRAM
;
332 srx
.transport_len
= sizeof(srx
.transport
.sin
);
333 srx
.transport
.sin
.sin_family
= AF_INET
;
334 srx
.transport
.sin
.sin_port
= call
->port
;
335 memcpy(&srx
.transport
.sin
.sin_addr
, addr
, 4);
338 rxcall
= rxrpc_kernel_begin_call(afs_socket
, &srx
, call
->key
,
339 (unsigned long) call
, gfp
);
341 if (IS_ERR(rxcall
)) {
342 ret
= PTR_ERR(rxcall
);
343 goto error_kill_call
;
346 call
->rxcall
= rxcall
;
348 /* send the request */
349 iov
[0].iov_base
= call
->request
;
350 iov
[0].iov_len
= call
->request_size
;
354 msg
.msg_iov
= (struct iovec
*) iov
;
356 msg
.msg_control
= NULL
;
357 msg
.msg_controllen
= 0;
358 msg
.msg_flags
= (call
->send_pages
? MSG_MORE
: 0);
360 /* have to change the state *before* sending the last packet as RxRPC
361 * might give us the reply before it returns from sending the
363 if (!call
->send_pages
)
364 call
->state
= AFS_CALL_AWAIT_REPLY
;
365 ret
= rxrpc_kernel_send_data(rxcall
, &msg
, call
->request_size
);
369 if (call
->send_pages
) {
370 ret
= afs_send_pages(call
, &msg
, iov
);
375 /* at this point, an async call may no longer exist as it may have
376 * already completed */
377 return wait_mode
->wait(call
);
380 rxrpc_kernel_abort_call(rxcall
, RX_USER_ABORT
);
381 rxrpc_kernel_end_call(rxcall
);
384 call
->type
->destructor(call
);
386 _leave(" = %d", ret
);
391 * handles intercepted messages that were arriving in the socket's Rx queue
392 * - called with the socket receive queue lock held to ensure message ordering
393 * - called with softirqs disabled
395 static void afs_rx_interceptor(struct sock
*sk
, unsigned long user_call_ID
,
398 struct afs_call
*call
= (struct afs_call
*) user_call_ID
;
400 _enter("%p,,%u", call
, skb
->mark
);
402 _debug("ICPT %p{%u} [%d]",
403 skb
, skb
->mark
, atomic_read(&afs_outstanding_skbs
));
405 ASSERTCMP(sk
, ==, afs_socket
->sk
);
406 atomic_inc(&afs_outstanding_skbs
);
409 /* its an incoming call for our callback service */
410 skb_queue_tail(&afs_incoming_calls
, skb
);
411 schedule_work(&afs_collect_incoming_call_work
);
413 /* route the messages directly to the appropriate call */
414 skb_queue_tail(&call
->rx_queue
, skb
);
415 call
->wait_mode
->rx_wakeup(call
);
422 * deliver messages to a call
424 static void afs_deliver_to_call(struct afs_call
*call
)
433 while ((call
->state
== AFS_CALL_AWAIT_REPLY
||
434 call
->state
== AFS_CALL_AWAIT_OP_ID
||
435 call
->state
== AFS_CALL_AWAIT_REQUEST
||
436 call
->state
== AFS_CALL_AWAIT_ACK
) &&
437 (skb
= skb_dequeue(&call
->rx_queue
))) {
439 case RXRPC_SKB_MARK_DATA
:
441 last
= rxrpc_kernel_is_data_last(skb
);
442 ret
= call
->type
->deliver(call
, skb
, last
);
446 call
->state
== AFS_CALL_AWAIT_REPLY
)
447 call
->state
= AFS_CALL_COMPLETE
;
450 abort_code
= RX_CALL_DEAD
;
453 abort_code
= RX_INVALID_OPERATION
;
456 abort_code
= RXGEN_CC_UNMARSHAL
;
457 if (call
->state
!= AFS_CALL_AWAIT_REPLY
)
458 abort_code
= RXGEN_SS_UNMARSHAL
;
460 rxrpc_kernel_abort_call(call
->rxcall
,
463 call
->state
= AFS_CALL_ERROR
;
466 afs_data_delivered(skb
);
469 case RXRPC_SKB_MARK_FINAL_ACK
:
471 call
->state
= AFS_CALL_COMPLETE
;
473 case RXRPC_SKB_MARK_BUSY
:
475 call
->error
= -EBUSY
;
476 call
->state
= AFS_CALL_BUSY
;
478 case RXRPC_SKB_MARK_REMOTE_ABORT
:
479 abort_code
= rxrpc_kernel_get_abort_code(skb
);
480 call
->error
= call
->type
->abort_to_error(abort_code
);
481 call
->state
= AFS_CALL_ABORTED
;
482 _debug("Rcv ABORT %u -> %d", abort_code
, call
->error
);
484 case RXRPC_SKB_MARK_NET_ERROR
:
485 call
->error
= -rxrpc_kernel_get_error_number(skb
);
486 call
->state
= AFS_CALL_ERROR
;
487 _debug("Rcv NET ERROR %d", call
->error
);
489 case RXRPC_SKB_MARK_LOCAL_ERROR
:
490 call
->error
= -rxrpc_kernel_get_error_number(skb
);
491 call
->state
= AFS_CALL_ERROR
;
492 _debug("Rcv LOCAL ERROR %d", call
->error
);
502 /* make sure the queue is empty if the call is done with (we might have
503 * aborted the call early because of an unmarshalling error) */
504 if (call
->state
>= AFS_CALL_COMPLETE
) {
505 while ((skb
= skb_dequeue(&call
->rx_queue
)))
507 if (call
->incoming
) {
508 rxrpc_kernel_end_call(call
->rxcall
);
510 call
->type
->destructor(call
);
519 * wait synchronously for a call to complete
521 static int afs_wait_for_call_to_complete(struct afs_call
*call
)
526 DECLARE_WAITQUEUE(myself
, current
);
530 add_wait_queue(&call
->waitq
, &myself
);
532 set_current_state(TASK_INTERRUPTIBLE
);
534 /* deliver any messages that are in the queue */
535 if (!skb_queue_empty(&call
->rx_queue
)) {
536 __set_current_state(TASK_RUNNING
);
537 afs_deliver_to_call(call
);
542 if (call
->state
>= AFS_CALL_COMPLETE
)
545 if (signal_pending(current
))
550 remove_wait_queue(&call
->waitq
, &myself
);
551 __set_current_state(TASK_RUNNING
);
554 if (call
->state
< AFS_CALL_COMPLETE
) {
555 _debug("call incomplete");
556 rxrpc_kernel_abort_call(call
->rxcall
, RX_CALL_DEAD
);
557 while ((skb
= skb_dequeue(&call
->rx_queue
)))
561 _debug("call complete");
562 rxrpc_kernel_end_call(call
->rxcall
);
564 call
->type
->destructor(call
);
566 _leave(" = %d", ret
);
571 * wake up a waiting call
573 static void afs_wake_up_call_waiter(struct afs_call
*call
)
575 wake_up(&call
->waitq
);
579 * wake up an asynchronous call
581 static void afs_wake_up_async_call(struct afs_call
*call
)
584 queue_work(afs_async_calls
, &call
->async_work
);
588 * put a call into asynchronous mode
589 * - mustn't touch the call descriptor as the call my have completed by the
592 static int afs_dont_wait_for_call_to_complete(struct afs_call
*call
)
599 * delete an asynchronous call
601 static void afs_delete_async_call(struct work_struct
*work
)
603 struct afs_call
*call
=
604 container_of(work
, struct afs_call
, async_work
);
614 * perform processing on an asynchronous call
615 * - on a multiple-thread workqueue this work item may try to run on several
616 * CPUs at the same time
618 static void afs_process_async_call(struct work_struct
*work
)
620 struct afs_call
*call
=
621 container_of(work
, struct afs_call
, async_work
);
625 if (!skb_queue_empty(&call
->rx_queue
))
626 afs_deliver_to_call(call
);
628 if (call
->state
>= AFS_CALL_COMPLETE
&& call
->wait_mode
) {
629 if (call
->wait_mode
->async_complete
)
630 call
->wait_mode
->async_complete(call
->reply
,
635 rxrpc_kernel_end_call(call
->rxcall
);
637 if (call
->type
->destructor
)
638 call
->type
->destructor(call
);
640 /* we can't just delete the call because the work item may be
642 PREPARE_WORK(&call
->async_work
, afs_delete_async_call
);
643 queue_work(afs_async_calls
, &call
->async_work
);
650 * empty a socket buffer into a flat reply buffer
652 void afs_transfer_reply(struct afs_call
*call
, struct sk_buff
*skb
)
654 size_t len
= skb
->len
;
656 if (skb_copy_bits(skb
, 0, call
->buffer
+ call
->reply_size
, len
) < 0)
658 call
->reply_size
+= len
;
662 * accept the backlog of incoming calls
664 static void afs_collect_incoming_call(struct work_struct
*work
)
666 struct rxrpc_call
*rxcall
;
667 struct afs_call
*call
= NULL
;
670 while ((skb
= skb_dequeue(&afs_incoming_calls
))) {
673 /* don't need the notification */
677 call
= kzalloc(sizeof(struct afs_call
), GFP_KERNEL
);
679 rxrpc_kernel_reject_call(afs_socket
);
683 INIT_WORK(&call
->async_work
, afs_process_async_call
);
684 call
->wait_mode
= &afs_async_incoming_call
;
685 call
->type
= &afs_RXCMxxxx
;
686 init_waitqueue_head(&call
->waitq
);
687 skb_queue_head_init(&call
->rx_queue
);
688 call
->state
= AFS_CALL_AWAIT_OP_ID
;
690 _debug("CALL %p{%s} [%d]",
691 call
, call
->type
->name
,
692 atomic_read(&afs_outstanding_calls
));
693 atomic_inc(&afs_outstanding_calls
);
696 rxcall
= rxrpc_kernel_accept_call(afs_socket
,
697 (unsigned long) call
);
698 if (!IS_ERR(rxcall
)) {
699 call
->rxcall
= rxcall
;
709 * grab the operation ID from an incoming cache manager call
711 static int afs_deliver_cm_op_id(struct afs_call
*call
, struct sk_buff
*skb
,
714 size_t len
= skb
->len
;
715 void *oibuf
= (void *) &call
->operation_ID
;
717 _enter("{%u},{%zu},%d", call
->offset
, len
, last
);
719 ASSERTCMP(call
->offset
, <, 4);
721 /* the operation ID forms the first four bytes of the request data */
722 len
= min_t(size_t, len
, 4 - call
->offset
);
723 if (skb_copy_bits(skb
, 0, oibuf
+ call
->offset
, len
) < 0)
725 if (!pskb_pull(skb
, len
))
729 if (call
->offset
< 4) {
731 _leave(" = -EBADMSG [op ID short]");
734 _leave(" = 0 [incomplete]");
738 call
->state
= AFS_CALL_AWAIT_REQUEST
;
740 /* ask the cache manager to route the call (it'll change the call type
742 if (!afs_cm_incoming_call(call
))
745 /* pass responsibility for the remainer of this message off to the
746 * cache manager op */
747 return call
->type
->deliver(call
, skb
, last
);
751 * send an empty reply
753 void afs_send_empty_reply(struct afs_call
*call
)
760 iov
[0].iov_base
= NULL
;
766 msg
.msg_control
= NULL
;
767 msg
.msg_controllen
= 0;
770 call
->state
= AFS_CALL_AWAIT_ACK
;
771 switch (rxrpc_kernel_send_data(call
->rxcall
, &msg
, 0)) {
773 _leave(" [replied]");
778 rxrpc_kernel_abort_call(call
->rxcall
, RX_USER_ABORT
);
780 rxrpc_kernel_end_call(call
->rxcall
);
782 call
->type
->destructor(call
);
790 * send a simple reply
792 void afs_send_simple_reply(struct afs_call
*call
, const void *buf
, size_t len
)
800 iov
[0].iov_base
= (void *) buf
;
801 iov
[0].iov_len
= len
;
806 msg
.msg_control
= NULL
;
807 msg
.msg_controllen
= 0;
810 call
->state
= AFS_CALL_AWAIT_ACK
;
811 n
= rxrpc_kernel_send_data(call
->rxcall
, &msg
, len
);
813 _leave(" [replied]");
818 rxrpc_kernel_abort_call(call
->rxcall
, RX_USER_ABORT
);
820 rxrpc_kernel_end_call(call
->rxcall
);
822 call
->type
->destructor(call
);
828 * extract a piece of data from the received data socket buffers
830 int afs_extract_data(struct afs_call
*call
, struct sk_buff
*skb
,
831 bool last
, void *buf
, size_t count
)
833 size_t len
= skb
->len
;
835 _enter("{%u},{%zu},%d,,%zu", call
->offset
, len
, last
, count
);
837 ASSERTCMP(call
->offset
, <, count
);
839 len
= min_t(size_t, len
, count
- call
->offset
);
840 if (skb_copy_bits(skb
, 0, buf
+ call
->offset
, len
) < 0 ||
841 !pskb_pull(skb
, len
))
845 if (call
->offset
< count
) {
847 _leave(" = -EBADMSG [%d < %zu]", call
->offset
, count
);
850 _leave(" = -EAGAIN");