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.
12 #include <linux/slab.h>
13 #include <linux/sched/signal.h>
16 #include <net/af_rxrpc.h>
20 struct workqueue_struct
*afs_async_calls
;
22 static void afs_wake_up_call_waiter(struct sock
*, struct rxrpc_call
*, unsigned long);
23 static long afs_wait_for_call_to_complete(struct afs_call
*, struct afs_addr_cursor
*);
24 static void afs_wake_up_async_call(struct sock
*, struct rxrpc_call
*, unsigned long);
25 static void afs_process_async_call(struct work_struct
*);
26 static void afs_rx_new_call(struct sock
*, struct rxrpc_call
*, unsigned long);
27 static void afs_rx_discard_new_call(struct rxrpc_call
*, unsigned long);
28 static int afs_deliver_cm_op_id(struct afs_call
*);
30 /* asynchronous incoming call initial processing */
31 static const struct afs_call_type afs_RXCMxxxx
= {
33 .deliver
= afs_deliver_cm_op_id
,
37 * open an RxRPC socket and bind it to be a server for callback notifications
38 * - the socket is left in blocking mode and non-blocking ops use MSG_DONTWAIT
40 int afs_open_socket(struct afs_net
*net
)
42 struct sockaddr_rxrpc srx
;
43 struct socket
*socket
;
48 ret
= sock_create_kern(&init_net
, AF_RXRPC
, SOCK_DGRAM
, PF_INET6
, &socket
);
52 socket
->sk
->sk_allocation
= GFP_NOFS
;
54 /* bind the callback manager's address to make this a server socket */
55 memset(&srx
, 0, sizeof(srx
));
56 srx
.srx_family
= AF_RXRPC
;
57 srx
.srx_service
= CM_SERVICE
;
58 srx
.transport_type
= SOCK_DGRAM
;
59 srx
.transport_len
= sizeof(srx
.transport
.sin6
);
60 srx
.transport
.sin6
.sin6_family
= AF_INET6
;
61 srx
.transport
.sin6
.sin6_port
= htons(AFS_CM_PORT
);
63 ret
= kernel_bind(socket
, (struct sockaddr
*) &srx
, sizeof(srx
));
67 rxrpc_kernel_new_call_notification(socket
, afs_rx_new_call
,
68 afs_rx_discard_new_call
);
70 ret
= kernel_listen(socket
, INT_MAX
);
75 afs_charge_preallocation(&net
->charge_preallocation_work
);
87 * close the RxRPC socket AFS was using
89 void afs_close_socket(struct afs_net
*net
)
93 kernel_listen(net
->socket
, 0);
94 flush_workqueue(afs_async_calls
);
96 if (net
->spare_incoming_call
) {
97 afs_put_call(net
->spare_incoming_call
);
98 net
->spare_incoming_call
= NULL
;
101 _debug("outstanding %u", atomic_read(&net
->nr_outstanding_calls
));
102 wait_on_atomic_t(&net
->nr_outstanding_calls
, atomic_t_wait
,
103 TASK_UNINTERRUPTIBLE
);
104 _debug("no outstanding calls");
106 kernel_sock_shutdown(net
->socket
, SHUT_RDWR
);
107 flush_workqueue(afs_async_calls
);
108 sock_release(net
->socket
);
117 static struct afs_call
*afs_alloc_call(struct afs_net
*net
,
118 const struct afs_call_type
*type
,
121 struct afs_call
*call
;
124 call
= kzalloc(sizeof(*call
), gfp
);
130 atomic_set(&call
->usage
, 1);
131 INIT_WORK(&call
->async_work
, afs_process_async_call
);
132 init_waitqueue_head(&call
->waitq
);
134 o
= atomic_inc_return(&net
->nr_outstanding_calls
);
135 trace_afs_call(call
, afs_call_trace_alloc
, 1, o
,
136 __builtin_return_address(0));
141 * Dispose of a reference on a call.
143 void afs_put_call(struct afs_call
*call
)
145 struct afs_net
*net
= call
->net
;
146 int n
= atomic_dec_return(&call
->usage
);
147 int o
= atomic_read(&net
->nr_outstanding_calls
);
149 trace_afs_call(call
, afs_call_trace_put
, n
+ 1, o
,
150 __builtin_return_address(0));
154 ASSERT(!work_pending(&call
->async_work
));
155 ASSERT(call
->type
->name
!= NULL
);
158 rxrpc_kernel_end_call(net
->socket
, call
->rxcall
);
161 if (call
->type
->destructor
)
162 call
->type
->destructor(call
);
164 afs_put_server(call
->net
, call
->cm_server
);
165 afs_put_cb_interest(call
->net
, call
->cbi
);
166 kfree(call
->request
);
169 o
= atomic_dec_return(&net
->nr_outstanding_calls
);
170 trace_afs_call(call
, afs_call_trace_free
, 0, o
,
171 __builtin_return_address(0));
173 wake_up_atomic_t(&net
->nr_outstanding_calls
);
178 * Queue the call for actual work. Returns 0 unconditionally for convenience.
180 int afs_queue_call_work(struct afs_call
*call
)
182 int u
= atomic_inc_return(&call
->usage
);
184 trace_afs_call(call
, afs_call_trace_work
, u
,
185 atomic_read(&call
->net
->nr_outstanding_calls
),
186 __builtin_return_address(0));
188 INIT_WORK(&call
->work
, call
->type
->work
);
190 if (!queue_work(afs_wq
, &call
->work
))
196 * allocate a call with flat request and reply buffers
198 struct afs_call
*afs_alloc_flat_call(struct afs_net
*net
,
199 const struct afs_call_type
*type
,
200 size_t request_size
, size_t reply_max
)
202 struct afs_call
*call
;
204 call
= afs_alloc_call(net
, type
, GFP_NOFS
);
209 call
->request_size
= request_size
;
210 call
->request
= kmalloc(request_size
, GFP_NOFS
);
216 call
->reply_max
= reply_max
;
217 call
->buffer
= kmalloc(reply_max
, GFP_NOFS
);
222 call
->operation_ID
= type
->op
;
223 init_waitqueue_head(&call
->waitq
);
233 * clean up a call with flat buffer
235 void afs_flat_call_destructor(struct afs_call
*call
)
239 kfree(call
->request
);
240 call
->request
= NULL
;
245 #define AFS_BVEC_MAX 8
248 * Load the given bvec with the next few pages.
250 static void afs_load_bvec(struct afs_call
*call
, struct msghdr
*msg
,
251 struct bio_vec
*bv
, pgoff_t first
, pgoff_t last
,
254 struct page
*pages
[AFS_BVEC_MAX
];
255 unsigned int nr
, n
, i
, to
, bytes
= 0;
257 nr
= min_t(pgoff_t
, last
- first
+ 1, AFS_BVEC_MAX
);
258 n
= find_get_pages_contig(call
->mapping
, first
, nr
, pages
);
259 ASSERTCMP(n
, ==, nr
);
261 msg
->msg_flags
|= MSG_MORE
;
262 for (i
= 0; i
< nr
; i
++) {
264 if (first
+ i
>= last
) {
266 msg
->msg_flags
&= ~MSG_MORE
;
268 bv
[i
].bv_page
= pages
[i
];
269 bv
[i
].bv_len
= to
- offset
;
270 bv
[i
].bv_offset
= offset
;
271 bytes
+= to
- offset
;
275 iov_iter_bvec(&msg
->msg_iter
, WRITE
| ITER_BVEC
, bv
, nr
, bytes
);
279 * Advance the AFS call state when the RxRPC call ends the transmit phase.
281 static void afs_notify_end_request_tx(struct sock
*sock
,
282 struct rxrpc_call
*rxcall
,
283 unsigned long call_user_ID
)
285 struct afs_call
*call
= (struct afs_call
*)call_user_ID
;
287 if (call
->state
== AFS_CALL_REQUESTING
)
288 call
->state
= AFS_CALL_AWAIT_REPLY
;
292 * attach the data from a bunch of pages on an inode to a call
294 static int afs_send_pages(struct afs_call
*call
, struct msghdr
*msg
)
296 struct bio_vec bv
[AFS_BVEC_MAX
];
297 unsigned int bytes
, nr
, loop
, offset
;
298 pgoff_t first
= call
->first
, last
= call
->last
;
301 offset
= call
->first_offset
;
302 call
->first_offset
= 0;
305 afs_load_bvec(call
, msg
, bv
, first
, last
, offset
);
306 trace_afs_send_pages(call
, msg
, first
, last
, offset
);
309 bytes
= msg
->msg_iter
.count
;
310 nr
= msg
->msg_iter
.nr_segs
;
312 ret
= rxrpc_kernel_send_data(call
->net
->socket
, call
->rxcall
, msg
,
313 bytes
, afs_notify_end_request_tx
);
314 for (loop
= 0; loop
< nr
; loop
++)
315 put_page(bv
[loop
].bv_page
);
320 } while (first
<= last
);
322 trace_afs_sent_pages(call
, call
->first
, last
, first
, ret
);
329 long afs_make_call(struct afs_addr_cursor
*ac
, struct afs_call
*call
,
330 gfp_t gfp
, bool async
)
332 struct sockaddr_rxrpc
*srx
= ac
->addr
;
333 struct rxrpc_call
*rxcall
;
340 _enter(",{%pISp},", &srx
->transport
);
342 ASSERT(call
->type
!= NULL
);
343 ASSERT(call
->type
->name
!= NULL
);
345 _debug("____MAKE %p{%s,%x} [%d]____",
346 call
, call
->type
->name
, key_serial(call
->key
),
347 atomic_read(&call
->net
->nr_outstanding_calls
));
351 /* Work out the length we're going to transmit. This is awkward for
352 * calls such as FS.StoreData where there's an extra injection of data
353 * after the initial fixed part.
355 tx_total_len
= call
->request_size
;
356 if (call
->send_pages
) {
357 if (call
->last
== call
->first
) {
358 tx_total_len
+= call
->last_to
- call
->first_offset
;
360 /* It looks mathematically like you should be able to
361 * combine the following lines with the ones above, but
362 * unsigned arithmetic is fun when it wraps...
364 tx_total_len
+= PAGE_SIZE
- call
->first_offset
;
365 tx_total_len
+= call
->last_to
;
366 tx_total_len
+= (call
->last
- call
->first
- 1) * PAGE_SIZE
;
371 rxcall
= rxrpc_kernel_begin_call(call
->net
->socket
, srx
, call
->key
,
375 afs_wake_up_async_call
:
376 afs_wake_up_call_waiter
),
378 if (IS_ERR(rxcall
)) {
379 ret
= PTR_ERR(rxcall
);
380 goto error_kill_call
;
383 call
->rxcall
= rxcall
;
385 /* send the request */
386 iov
[0].iov_base
= call
->request
;
387 iov
[0].iov_len
= call
->request_size
;
391 iov_iter_kvec(&msg
.msg_iter
, WRITE
| ITER_KVEC
, iov
, 1,
393 msg
.msg_control
= NULL
;
394 msg
.msg_controllen
= 0;
395 msg
.msg_flags
= MSG_WAITALL
| (call
->send_pages
? MSG_MORE
: 0);
397 ret
= rxrpc_kernel_send_data(call
->net
->socket
, rxcall
,
398 &msg
, call
->request_size
,
399 afs_notify_end_request_tx
);
403 if (call
->send_pages
) {
404 ret
= afs_send_pages(call
, &msg
);
409 /* at this point, an async call may no longer exist as it may have
410 * already completed */
414 return afs_wait_for_call_to_complete(call
, ac
);
417 call
->state
= AFS_CALL_COMPLETE
;
418 if (ret
!= -ECONNABORTED
) {
419 rxrpc_kernel_abort_call(call
->net
->socket
, rxcall
,
420 RX_USER_ABORT
, ret
, "KSD");
423 rxrpc_kernel_recv_data(call
->net
->socket
, rxcall
, NULL
,
424 0, &offset
, false, &call
->abort_code
,
426 ac
->abort_code
= call
->abort_code
;
427 ac
->responded
= true;
430 trace_afs_call_done(call
);
434 _leave(" = %d", ret
);
439 * deliver messages to a call
441 static void afs_deliver_to_call(struct afs_call
*call
)
446 _enter("%s", call
->type
->name
);
448 while (call
->state
== AFS_CALL_AWAIT_REPLY
||
449 call
->state
== AFS_CALL_AWAIT_OP_ID
||
450 call
->state
== AFS_CALL_AWAIT_REQUEST
||
451 call
->state
== AFS_CALL_AWAIT_ACK
453 if (call
->state
== AFS_CALL_AWAIT_ACK
) {
455 ret
= rxrpc_kernel_recv_data(call
->net
->socket
,
457 NULL
, 0, &offset
, false,
460 trace_afs_recv_data(call
, 0, offset
, false, ret
);
462 if (ret
== -EINPROGRESS
|| ret
== -EAGAIN
)
466 if (ret
< 0 || ret
== 1)
471 ret
= call
->type
->deliver(call
);
474 if (call
->state
== AFS_CALL_AWAIT_REPLY
)
483 abort_code
= RX_CALL_DEAD
;
484 rxrpc_kernel_abort_call(call
->net
->socket
, call
->rxcall
,
485 abort_code
, ret
, "KNC");
488 abort_code
= RXGEN_OPCODE
;
489 rxrpc_kernel_abort_call(call
->net
->socket
, call
->rxcall
,
490 abort_code
, ret
, "KIV");
496 abort_code
= RXGEN_CC_UNMARSHAL
;
497 if (call
->state
!= AFS_CALL_AWAIT_REPLY
)
498 abort_code
= RXGEN_SS_UNMARSHAL
;
499 rxrpc_kernel_abort_call(call
->net
->socket
, call
->rxcall
,
500 abort_code
, -EBADMSG
, "KUM");
506 if (call
->state
== AFS_CALL_COMPLETE
&& call
->incoming
)
515 if (call
->state
!= AFS_CALL_COMPLETE
) {
516 call
->state
= AFS_CALL_COMPLETE
;
517 trace_afs_call_done(call
);
523 * wait synchronously for a call to complete
525 static long afs_wait_for_call_to_complete(struct afs_call
*call
,
526 struct afs_addr_cursor
*ac
)
528 signed long rtt2
, timeout
;
533 DECLARE_WAITQUEUE(myself
, current
);
537 rtt
= rxrpc_kernel_get_rtt(call
->net
->socket
, call
->rxcall
);
538 rtt2
= nsecs_to_jiffies64(rtt
) * 2;
543 last_life
= rxrpc_kernel_check_life(call
->net
->socket
, call
->rxcall
);
545 add_wait_queue(&call
->waitq
, &myself
);
547 set_current_state(TASK_UNINTERRUPTIBLE
);
549 /* deliver any messages that are in the queue */
550 if (call
->state
< AFS_CALL_COMPLETE
&& call
->need_attention
) {
551 call
->need_attention
= false;
552 __set_current_state(TASK_RUNNING
);
553 afs_deliver_to_call(call
);
557 if (call
->state
== AFS_CALL_COMPLETE
)
560 life
= rxrpc_kernel_check_life(call
->net
->socket
, call
->rxcall
);
562 life
== last_life
&& signal_pending(current
))
565 if (life
!= last_life
) {
570 timeout
= schedule_timeout(timeout
);
573 remove_wait_queue(&call
->waitq
, &myself
);
574 __set_current_state(TASK_RUNNING
);
576 /* Kill off the call if it's still live. */
577 if (call
->state
< AFS_CALL_COMPLETE
) {
578 _debug("call interrupted");
579 if (rxrpc_kernel_abort_call(call
->net
->socket
, call
->rxcall
,
580 RX_USER_ABORT
, -EINTR
, "KWI")) {
581 call
->error
= -ERESTARTSYS
;
582 trace_afs_call_done(call
);
586 ac
->abort_code
= call
->abort_code
;
587 ac
->error
= call
->error
;
592 if (call
->ret_reply0
) {
593 ret
= (long)call
->reply
[0];
594 call
->reply
[0] = NULL
;
598 ac
->responded
= true;
602 _debug("call complete");
604 _leave(" = %p", (void *)ret
);
609 * wake up a waiting call
611 static void afs_wake_up_call_waiter(struct sock
*sk
, struct rxrpc_call
*rxcall
,
612 unsigned long call_user_ID
)
614 struct afs_call
*call
= (struct afs_call
*)call_user_ID
;
616 call
->need_attention
= true;
617 wake_up(&call
->waitq
);
621 * wake up an asynchronous call
623 static void afs_wake_up_async_call(struct sock
*sk
, struct rxrpc_call
*rxcall
,
624 unsigned long call_user_ID
)
626 struct afs_call
*call
= (struct afs_call
*)call_user_ID
;
629 trace_afs_notify_call(rxcall
, call
);
630 call
->need_attention
= true;
632 u
= __atomic_add_unless(&call
->usage
, 1, 0);
634 trace_afs_call(call
, afs_call_trace_wake
, u
,
635 atomic_read(&call
->net
->nr_outstanding_calls
),
636 __builtin_return_address(0));
638 if (!queue_work(afs_async_calls
, &call
->async_work
))
644 * Delete an asynchronous call. The work item carries a ref to the call struct
645 * that we need to release.
647 static void afs_delete_async_call(struct work_struct
*work
)
649 struct afs_call
*call
= container_of(work
, struct afs_call
, async_work
);
659 * Perform I/O processing on an asynchronous call. The work item carries a ref
660 * to the call struct that we either need to release or to pass on.
662 static void afs_process_async_call(struct work_struct
*work
)
664 struct afs_call
*call
= container_of(work
, struct afs_call
, async_work
);
668 if (call
->state
< AFS_CALL_COMPLETE
&& call
->need_attention
) {
669 call
->need_attention
= false;
670 afs_deliver_to_call(call
);
673 if (call
->state
== AFS_CALL_COMPLETE
) {
674 call
->reply
[0] = NULL
;
676 /* We have two refs to release - one from the alloc and one
677 * queued with the work item - and we can't just deallocate the
678 * call because the work item may be queued again.
680 call
->async_work
.func
= afs_delete_async_call
;
681 if (!queue_work(afs_async_calls
, &call
->async_work
))
689 static void afs_rx_attach(struct rxrpc_call
*rxcall
, unsigned long user_call_ID
)
691 struct afs_call
*call
= (struct afs_call
*)user_call_ID
;
693 call
->rxcall
= rxcall
;
697 * Charge the incoming call preallocation.
699 void afs_charge_preallocation(struct work_struct
*work
)
701 struct afs_net
*net
=
702 container_of(work
, struct afs_net
, charge_preallocation_work
);
703 struct afs_call
*call
= net
->spare_incoming_call
;
707 call
= afs_alloc_call(net
, &afs_RXCMxxxx
, GFP_KERNEL
);
712 call
->state
= AFS_CALL_AWAIT_OP_ID
;
713 init_waitqueue_head(&call
->waitq
);
716 if (rxrpc_kernel_charge_accept(net
->socket
,
717 afs_wake_up_async_call
,
724 net
->spare_incoming_call
= call
;
728 * Discard a preallocated call when a socket is shut down.
730 static void afs_rx_discard_new_call(struct rxrpc_call
*rxcall
,
731 unsigned long user_call_ID
)
733 struct afs_call
*call
= (struct afs_call
*)user_call_ID
;
740 * Notification of an incoming call.
742 static void afs_rx_new_call(struct sock
*sk
, struct rxrpc_call
*rxcall
,
743 unsigned long user_call_ID
)
745 struct afs_net
*net
= afs_sock2net(sk
);
747 queue_work(afs_wq
, &net
->charge_preallocation_work
);
751 * Grab the operation ID from an incoming cache manager call. The socket
752 * buffer is discarded on error or if we don't yet have sufficient data.
754 static int afs_deliver_cm_op_id(struct afs_call
*call
)
758 _enter("{%zu}", call
->offset
);
760 ASSERTCMP(call
->offset
, <, 4);
762 /* the operation ID forms the first four bytes of the request data */
763 ret
= afs_extract_data(call
, &call
->tmp
, 4, true);
767 call
->operation_ID
= ntohl(call
->tmp
);
768 call
->state
= AFS_CALL_AWAIT_REQUEST
;
771 /* ask the cache manager to route the call (it'll change the call type
773 if (!afs_cm_incoming_call(call
))
776 trace_afs_cb_call(call
);
778 /* pass responsibility for the remainer of this message off to the
779 * cache manager op */
780 return call
->type
->deliver(call
);
784 * Advance the AFS call state when an RxRPC service call ends the transmit
787 static void afs_notify_end_reply_tx(struct sock
*sock
,
788 struct rxrpc_call
*rxcall
,
789 unsigned long call_user_ID
)
791 struct afs_call
*call
= (struct afs_call
*)call_user_ID
;
793 if (call
->state
== AFS_CALL_REPLYING
)
794 call
->state
= AFS_CALL_AWAIT_ACK
;
798 * send an empty reply
800 void afs_send_empty_reply(struct afs_call
*call
)
802 struct afs_net
*net
= call
->net
;
807 rxrpc_kernel_set_tx_length(net
->socket
, call
->rxcall
, 0);
811 iov_iter_kvec(&msg
.msg_iter
, WRITE
| ITER_KVEC
, NULL
, 0, 0);
812 msg
.msg_control
= NULL
;
813 msg
.msg_controllen
= 0;
816 switch (rxrpc_kernel_send_data(net
->socket
, call
->rxcall
, &msg
, 0,
817 afs_notify_end_reply_tx
)) {
819 _leave(" [replied]");
824 rxrpc_kernel_abort_call(net
->socket
, call
->rxcall
,
825 RX_USER_ABORT
, -ENOMEM
, "KOO");
833 * send a simple reply
835 void afs_send_simple_reply(struct afs_call
*call
, const void *buf
, size_t len
)
837 struct afs_net
*net
= call
->net
;
844 rxrpc_kernel_set_tx_length(net
->socket
, call
->rxcall
, len
);
846 iov
[0].iov_base
= (void *) buf
;
847 iov
[0].iov_len
= len
;
850 iov_iter_kvec(&msg
.msg_iter
, WRITE
| ITER_KVEC
, iov
, 1, len
);
851 msg
.msg_control
= NULL
;
852 msg
.msg_controllen
= 0;
855 n
= rxrpc_kernel_send_data(net
->socket
, call
->rxcall
, &msg
, len
,
856 afs_notify_end_reply_tx
);
859 _leave(" [replied]");
865 rxrpc_kernel_abort_call(net
->socket
, call
->rxcall
,
866 RX_USER_ABORT
, -ENOMEM
, "KOO");
872 * Extract a piece of data from the received data socket buffers.
874 int afs_extract_data(struct afs_call
*call
, void *buf
, size_t count
,
877 struct afs_net
*net
= call
->net
;
880 _enter("{%s,%zu},,%zu,%d",
881 call
->type
->name
, call
->offset
, count
, want_more
);
883 ASSERTCMP(call
->offset
, <=, count
);
885 ret
= rxrpc_kernel_recv_data(net
->socket
, call
->rxcall
,
886 buf
, count
, &call
->offset
,
887 want_more
, &call
->abort_code
,
889 trace_afs_recv_data(call
, count
, call
->offset
, want_more
, ret
);
890 if (ret
== 0 || ret
== -EAGAIN
)
894 switch (call
->state
) {
895 case AFS_CALL_AWAIT_REPLY
:
896 call
->state
= AFS_CALL_COMPLETE
;
897 trace_afs_call_done(call
);
899 case AFS_CALL_AWAIT_REQUEST
:
900 call
->state
= AFS_CALL_REPLYING
;
909 call
->state
= AFS_CALL_COMPLETE
;
910 trace_afs_call_done(call
);