1 /* Maintain an RxRPC server socket to do AFS communications through
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/slab.h>
13 #include <linux/sched/signal.h>
16 #include <net/af_rxrpc.h>
17 #include <rxrpc/packet.h>
21 struct socket *afs_socket; /* my RxRPC socket */
22 static struct workqueue_struct *afs_async_calls;
23 static struct afs_call *afs_spare_incoming_call;
24 atomic_t afs_outstanding_calls;
26 static void afs_wake_up_call_waiter(struct sock *, struct rxrpc_call *, unsigned long);
27 static int afs_wait_for_call_to_complete(struct afs_call *);
28 static void afs_wake_up_async_call(struct sock *, struct rxrpc_call *, unsigned long);
29 static void afs_process_async_call(struct work_struct *);
30 static void afs_rx_new_call(struct sock *, struct rxrpc_call *, unsigned long);
31 static void afs_rx_discard_new_call(struct rxrpc_call *, unsigned long);
32 static int afs_deliver_cm_op_id(struct afs_call *);
34 /* asynchronous incoming call initial processing */
35 static const struct afs_call_type afs_RXCMxxxx = {
37 .deliver = afs_deliver_cm_op_id,
38 .abort_to_error = afs_abort_to_error,
41 static void afs_charge_preallocation(struct work_struct *);
43 static DECLARE_WORK(afs_charge_preallocation_work, afs_charge_preallocation);
45 static int afs_wait_atomic_t(atomic_t *p)
52 * open an RxRPC socket and bind it to be a server for callback notifications
53 * - the socket is left in blocking mode and non-blocking ops use MSG_DONTWAIT
55 int afs_open_socket(void)
57 struct sockaddr_rxrpc srx;
58 struct socket *socket;
64 afs_async_calls = alloc_workqueue("kafsd", WQ_MEM_RECLAIM, 0);
68 ret = sock_create_kern(&init_net, AF_RXRPC, SOCK_DGRAM, PF_INET, &socket);
72 socket->sk->sk_allocation = GFP_NOFS;
74 /* bind the callback manager's address to make this a server socket */
75 srx.srx_family = AF_RXRPC;
76 srx.srx_service = CM_SERVICE;
77 srx.transport_type = SOCK_DGRAM;
78 srx.transport_len = sizeof(srx.transport.sin);
79 srx.transport.sin.sin_family = AF_INET;
80 srx.transport.sin.sin_port = htons(AFS_CM_PORT);
81 memset(&srx.transport.sin.sin_addr, 0,
82 sizeof(srx.transport.sin.sin_addr));
84 ret = kernel_bind(socket, (struct sockaddr *) &srx, sizeof(srx));
88 rxrpc_kernel_new_call_notification(socket, afs_rx_new_call,
89 afs_rx_discard_new_call);
91 ret = kernel_listen(socket, INT_MAX);
96 afs_charge_preallocation(NULL);
101 sock_release(socket);
103 destroy_workqueue(afs_async_calls);
105 _leave(" = %d", ret);
110 * close the RxRPC socket AFS was using
112 void afs_close_socket(void)
116 kernel_listen(afs_socket, 0);
117 flush_workqueue(afs_async_calls);
119 if (afs_spare_incoming_call) {
120 afs_put_call(afs_spare_incoming_call);
121 afs_spare_incoming_call = NULL;
124 _debug("outstanding %u", atomic_read(&afs_outstanding_calls));
125 wait_on_atomic_t(&afs_outstanding_calls, afs_wait_atomic_t,
126 TASK_UNINTERRUPTIBLE);
127 _debug("no outstanding calls");
129 kernel_sock_shutdown(afs_socket, SHUT_RDWR);
130 flush_workqueue(afs_async_calls);
131 sock_release(afs_socket);
134 destroy_workqueue(afs_async_calls);
141 static struct afs_call *afs_alloc_call(const struct afs_call_type *type,
144 struct afs_call *call;
147 call = kzalloc(sizeof(*call), gfp);
152 atomic_set(&call->usage, 1);
153 INIT_WORK(&call->async_work, afs_process_async_call);
154 init_waitqueue_head(&call->waitq);
156 o = atomic_inc_return(&afs_outstanding_calls);
157 trace_afs_call(call, afs_call_trace_alloc, 1, o,
158 __builtin_return_address(0));
163 * Dispose of a reference on a call.
165 void afs_put_call(struct afs_call *call)
167 int n = atomic_dec_return(&call->usage);
168 int o = atomic_read(&afs_outstanding_calls);
170 trace_afs_call(call, afs_call_trace_put, n + 1, o,
171 __builtin_return_address(0));
175 ASSERT(!work_pending(&call->async_work));
176 ASSERT(call->type->name != NULL);
179 rxrpc_kernel_end_call(afs_socket, call->rxcall);
182 if (call->type->destructor)
183 call->type->destructor(call);
185 kfree(call->request);
188 o = atomic_dec_return(&afs_outstanding_calls);
189 trace_afs_call(call, afs_call_trace_free, 0, o,
190 __builtin_return_address(0));
192 wake_up_atomic_t(&afs_outstanding_calls);
197 * Queue the call for actual work. Returns 0 unconditionally for convenience.
199 int afs_queue_call_work(struct afs_call *call)
201 int u = atomic_inc_return(&call->usage);
203 trace_afs_call(call, afs_call_trace_work, u,
204 atomic_read(&afs_outstanding_calls),
205 __builtin_return_address(0));
207 INIT_WORK(&call->work, call->type->work);
209 if (!queue_work(afs_wq, &call->work))
215 * allocate a call with flat request and reply buffers
217 struct afs_call *afs_alloc_flat_call(const struct afs_call_type *type,
218 size_t request_size, size_t reply_max)
220 struct afs_call *call;
222 call = afs_alloc_call(type, GFP_NOFS);
227 call->request_size = request_size;
228 call->request = kmalloc(request_size, GFP_NOFS);
234 call->reply_max = reply_max;
235 call->buffer = kmalloc(reply_max, GFP_NOFS);
240 init_waitqueue_head(&call->waitq);
250 * clean up a call with flat buffer
252 void afs_flat_call_destructor(struct afs_call *call)
256 kfree(call->request);
257 call->request = NULL;
263 * attach the data from a bunch of pages on an inode to a call
265 static int afs_send_pages(struct afs_call *call, struct msghdr *msg)
267 struct page *pages[8];
268 unsigned count, n, loop, offset, to;
269 pgoff_t first = call->first, last = call->last;
274 offset = call->first_offset;
275 call->first_offset = 0;
278 _debug("attach %lx-%lx", first, last);
280 count = last - first + 1;
281 if (count > ARRAY_SIZE(pages))
282 count = ARRAY_SIZE(pages);
283 n = find_get_pages_contig(call->mapping, first, count, pages);
284 ASSERTCMP(n, ==, count);
288 struct bio_vec bvec = {.bv_page = pages[loop],
289 .bv_offset = offset};
292 if (first + loop >= last)
295 msg->msg_flags = MSG_MORE;
296 bvec.bv_len = to - offset;
299 _debug("- range %u-%u%s",
300 offset, to, msg->msg_flags ? " [more]" : "");
301 iov_iter_bvec(&msg->msg_iter, WRITE | ITER_BVEC,
302 &bvec, 1, to - offset);
304 /* have to change the state *before* sending the last
305 * packet as RxRPC might give us the reply before it
306 * returns from sending the request */
307 if (first + loop >= last)
308 call->state = AFS_CALL_AWAIT_REPLY;
309 ret = rxrpc_kernel_send_data(afs_socket, call->rxcall,
313 } while (++loop < count);
316 for (loop = 0; loop < count; loop++)
317 put_page(pages[loop]);
320 } while (first <= last);
322 _leave(" = %d", ret);
329 int afs_make_call(struct in_addr *addr, struct afs_call *call, gfp_t gfp,
332 struct sockaddr_rxrpc srx;
333 struct rxrpc_call *rxcall;
338 _enter("%x,{%d},", addr->s_addr, ntohs(call->port));
340 ASSERT(call->type != NULL);
341 ASSERT(call->type->name != NULL);
343 _debug("____MAKE %p{%s,%x} [%d]____",
344 call, call->type->name, key_serial(call->key),
345 atomic_read(&afs_outstanding_calls));
349 memset(&srx, 0, sizeof(srx));
350 srx.srx_family = AF_RXRPC;
351 srx.srx_service = call->service_id;
352 srx.transport_type = SOCK_DGRAM;
353 srx.transport_len = sizeof(srx.transport.sin);
354 srx.transport.sin.sin_family = AF_INET;
355 srx.transport.sin.sin_port = call->port;
356 memcpy(&srx.transport.sin.sin_addr, addr, 4);
359 rxcall = rxrpc_kernel_begin_call(afs_socket, &srx, call->key,
360 (unsigned long) call, gfp,
362 afs_wake_up_async_call :
363 afs_wake_up_call_waiter));
365 if (IS_ERR(rxcall)) {
366 ret = PTR_ERR(rxcall);
367 goto error_kill_call;
370 call->rxcall = rxcall;
372 /* send the request */
373 iov[0].iov_base = call->request;
374 iov[0].iov_len = call->request_size;
378 iov_iter_kvec(&msg.msg_iter, WRITE | ITER_KVEC, iov, 1,
380 msg.msg_control = NULL;
381 msg.msg_controllen = 0;
382 msg.msg_flags = (call->send_pages ? MSG_MORE : 0);
384 /* have to change the state *before* sending the last packet as RxRPC
385 * might give us the reply before it returns from sending the
387 if (!call->send_pages)
388 call->state = AFS_CALL_AWAIT_REPLY;
389 ret = rxrpc_kernel_send_data(afs_socket, rxcall,
390 &msg, call->request_size);
394 if (call->send_pages) {
395 ret = afs_send_pages(call, &msg);
400 /* at this point, an async call may no longer exist as it may have
401 * already completed */
405 return afs_wait_for_call_to_complete(call);
408 rxrpc_kernel_abort_call(afs_socket, rxcall, RX_USER_ABORT, -ret, "KSD");
411 _leave(" = %d", ret);
416 * deliver messages to a call
418 static void afs_deliver_to_call(struct afs_call *call)
423 _enter("%s", call->type->name);
425 while (call->state == AFS_CALL_AWAIT_REPLY ||
426 call->state == AFS_CALL_AWAIT_OP_ID ||
427 call->state == AFS_CALL_AWAIT_REQUEST ||
428 call->state == AFS_CALL_AWAIT_ACK
430 if (call->state == AFS_CALL_AWAIT_ACK) {
432 ret = rxrpc_kernel_recv_data(afs_socket, call->rxcall,
433 NULL, 0, &offset, false,
435 trace_afs_recv_data(call, 0, offset, false, ret);
437 if (ret == -EINPROGRESS || ret == -EAGAIN)
439 if (ret == 1 || ret < 0) {
440 call->state = AFS_CALL_COMPLETE;
446 ret = call->type->deliver(call);
449 if (call->state == AFS_CALL_AWAIT_REPLY)
450 call->state = AFS_CALL_COMPLETE;
456 abort_code = RX_CALL_DEAD;
457 rxrpc_kernel_abort_call(afs_socket, call->rxcall,
458 abort_code, -ret, "KNC");
461 abort_code = RX_INVALID_OPERATION;
462 rxrpc_kernel_abort_call(afs_socket, call->rxcall,
463 abort_code, -ret, "KIV");
469 abort_code = RXGEN_CC_UNMARSHAL;
470 if (call->state != AFS_CALL_AWAIT_REPLY)
471 abort_code = RXGEN_SS_UNMARSHAL;
472 rxrpc_kernel_abort_call(afs_socket, call->rxcall,
473 abort_code, EBADMSG, "KUM");
479 if (call->state == AFS_CALL_COMPLETE && call->incoming)
487 call->state = AFS_CALL_COMPLETE;
492 * wait synchronously for a call to complete
494 static int afs_wait_for_call_to_complete(struct afs_call *call)
496 const char *abort_why;
499 DECLARE_WAITQUEUE(myself, current);
503 add_wait_queue(&call->waitq, &myself);
505 set_current_state(TASK_INTERRUPTIBLE);
507 /* deliver any messages that are in the queue */
508 if (call->state < AFS_CALL_COMPLETE && call->need_attention) {
509 call->need_attention = false;
510 __set_current_state(TASK_RUNNING);
511 afs_deliver_to_call(call);
517 if (call->state == AFS_CALL_COMPLETE)
521 if (signal_pending(current))
526 remove_wait_queue(&call->waitq, &myself);
527 __set_current_state(TASK_RUNNING);
530 if (call->state < AFS_CALL_COMPLETE) {
531 _debug("call incomplete");
532 rxrpc_kernel_abort_call(afs_socket, call->rxcall,
533 RX_CALL_DEAD, -ret, abort_why);
536 _debug("call complete");
538 _leave(" = %d", ret);
543 * wake up a waiting call
545 static void afs_wake_up_call_waiter(struct sock *sk, struct rxrpc_call *rxcall,
546 unsigned long call_user_ID)
548 struct afs_call *call = (struct afs_call *)call_user_ID;
550 call->need_attention = true;
551 wake_up(&call->waitq);
555 * wake up an asynchronous call
557 static void afs_wake_up_async_call(struct sock *sk, struct rxrpc_call *rxcall,
558 unsigned long call_user_ID)
560 struct afs_call *call = (struct afs_call *)call_user_ID;
563 trace_afs_notify_call(rxcall, call);
564 call->need_attention = true;
566 u = __atomic_add_unless(&call->usage, 1, 0);
568 trace_afs_call(call, afs_call_trace_wake, u,
569 atomic_read(&afs_outstanding_calls),
570 __builtin_return_address(0));
572 if (!queue_work(afs_async_calls, &call->async_work))
578 * Delete an asynchronous call. The work item carries a ref to the call struct
579 * that we need to release.
581 static void afs_delete_async_call(struct work_struct *work)
583 struct afs_call *call = container_of(work, struct afs_call, async_work);
593 * Perform I/O processing on an asynchronous call. The work item carries a ref
594 * to the call struct that we either need to release or to pass on.
596 static void afs_process_async_call(struct work_struct *work)
598 struct afs_call *call = container_of(work, struct afs_call, async_work);
602 if (call->state < AFS_CALL_COMPLETE && call->need_attention) {
603 call->need_attention = false;
604 afs_deliver_to_call(call);
607 if (call->state == AFS_CALL_COMPLETE) {
610 /* We have two refs to release - one from the alloc and one
611 * queued with the work item - and we can't just deallocate the
612 * call because the work item may be queued again.
614 call->async_work.func = afs_delete_async_call;
615 if (!queue_work(afs_async_calls, &call->async_work))
623 static void afs_rx_attach(struct rxrpc_call *rxcall, unsigned long user_call_ID)
625 struct afs_call *call = (struct afs_call *)user_call_ID;
627 call->rxcall = rxcall;
631 * Charge the incoming call preallocation.
633 static void afs_charge_preallocation(struct work_struct *work)
635 struct afs_call *call = afs_spare_incoming_call;
639 call = afs_alloc_call(&afs_RXCMxxxx, GFP_KERNEL);
644 call->state = AFS_CALL_AWAIT_OP_ID;
645 init_waitqueue_head(&call->waitq);
648 if (rxrpc_kernel_charge_accept(afs_socket,
649 afs_wake_up_async_call,
656 afs_spare_incoming_call = call;
660 * Discard a preallocated call when a socket is shut down.
662 static void afs_rx_discard_new_call(struct rxrpc_call *rxcall,
663 unsigned long user_call_ID)
665 struct afs_call *call = (struct afs_call *)user_call_ID;
672 * Notification of an incoming call.
674 static void afs_rx_new_call(struct sock *sk, struct rxrpc_call *rxcall,
675 unsigned long user_call_ID)
677 queue_work(afs_wq, &afs_charge_preallocation_work);
681 * Grab the operation ID from an incoming cache manager call. The socket
682 * buffer is discarded on error or if we don't yet have sufficient data.
684 static int afs_deliver_cm_op_id(struct afs_call *call)
688 _enter("{%zu}", call->offset);
690 ASSERTCMP(call->offset, <, 4);
692 /* the operation ID forms the first four bytes of the request data */
693 ret = afs_extract_data(call, &call->tmp, 4, true);
697 call->operation_ID = ntohl(call->tmp);
698 call->state = AFS_CALL_AWAIT_REQUEST;
701 /* ask the cache manager to route the call (it'll change the call type
703 if (!afs_cm_incoming_call(call))
706 trace_afs_cb_call(call);
708 /* pass responsibility for the remainer of this message off to the
709 * cache manager op */
710 return call->type->deliver(call);
714 * send an empty reply
716 void afs_send_empty_reply(struct afs_call *call)
724 iov_iter_kvec(&msg.msg_iter, WRITE | ITER_KVEC, NULL, 0, 0);
725 msg.msg_control = NULL;
726 msg.msg_controllen = 0;
729 call->state = AFS_CALL_AWAIT_ACK;
730 switch (rxrpc_kernel_send_data(afs_socket, call->rxcall, &msg, 0)) {
732 _leave(" [replied]");
737 rxrpc_kernel_abort_call(afs_socket, call->rxcall,
738 RX_USER_ABORT, ENOMEM, "KOO");
746 * send a simple reply
748 void afs_send_simple_reply(struct afs_call *call, const void *buf, size_t len)
756 iov[0].iov_base = (void *) buf;
757 iov[0].iov_len = len;
760 iov_iter_kvec(&msg.msg_iter, WRITE | ITER_KVEC, iov, 1, len);
761 msg.msg_control = NULL;
762 msg.msg_controllen = 0;
765 call->state = AFS_CALL_AWAIT_ACK;
766 n = rxrpc_kernel_send_data(afs_socket, call->rxcall, &msg, len);
769 _leave(" [replied]");
775 rxrpc_kernel_abort_call(afs_socket, call->rxcall,
776 RX_USER_ABORT, ENOMEM, "KOO");
782 * Extract a piece of data from the received data socket buffers.
784 int afs_extract_data(struct afs_call *call, void *buf, size_t count,
789 _enter("{%s,%zu},,%zu,%d",
790 call->type->name, call->offset, count, want_more);
792 ASSERTCMP(call->offset, <=, count);
794 ret = rxrpc_kernel_recv_data(afs_socket, call->rxcall,
795 buf, count, &call->offset,
796 want_more, &call->abort_code);
797 trace_afs_recv_data(call, count, call->offset, want_more, ret);
798 if (ret == 0 || ret == -EAGAIN)
802 switch (call->state) {
803 case AFS_CALL_AWAIT_REPLY:
804 call->state = AFS_CALL_COMPLETE;
806 case AFS_CALL_AWAIT_REQUEST:
807 call->state = AFS_CALL_REPLYING;
815 if (ret == -ECONNABORTED)
816 call->error = call->type->abort_to_error(call->abort_code);
819 call->state = AFS_CALL_COMPLETE;