1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* RxRPC individual remote procedure call handling
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/slab.h>
11 #include <linux/module.h>
12 #include <linux/circ_buf.h>
13 #include <linux/spinlock_types.h>
15 #include <net/af_rxrpc.h>
16 #include "ar-internal.h"
18 const char *const rxrpc_call_states[NR__RXRPC_CALL_STATES] = {
19 [RXRPC_CALL_UNINITIALISED] = "Uninit ",
20 [RXRPC_CALL_CLIENT_AWAIT_CONN] = "ClWtConn",
21 [RXRPC_CALL_CLIENT_SEND_REQUEST] = "ClSndReq",
22 [RXRPC_CALL_CLIENT_AWAIT_REPLY] = "ClAwtRpl",
23 [RXRPC_CALL_CLIENT_RECV_REPLY] = "ClRcvRpl",
24 [RXRPC_CALL_SERVER_PREALLOC] = "SvPrealc",
25 [RXRPC_CALL_SERVER_SECURING] = "SvSecure",
26 [RXRPC_CALL_SERVER_RECV_REQUEST] = "SvRcvReq",
27 [RXRPC_CALL_SERVER_ACK_REQUEST] = "SvAckReq",
28 [RXRPC_CALL_SERVER_SEND_REPLY] = "SvSndRpl",
29 [RXRPC_CALL_SERVER_AWAIT_ACK] = "SvAwtACK",
30 [RXRPC_CALL_COMPLETE] = "Complete",
33 const char *const rxrpc_call_completions[NR__RXRPC_CALL_COMPLETIONS] = {
34 [RXRPC_CALL_SUCCEEDED] = "Complete",
35 [RXRPC_CALL_REMOTELY_ABORTED] = "RmtAbort",
36 [RXRPC_CALL_LOCALLY_ABORTED] = "LocAbort",
37 [RXRPC_CALL_LOCAL_ERROR] = "LocError",
38 [RXRPC_CALL_NETWORK_ERROR] = "NetError",
41 struct kmem_cache *rxrpc_call_jar;
43 static struct semaphore rxrpc_call_limiter =
44 __SEMAPHORE_INITIALIZER(rxrpc_call_limiter, 1000);
45 static struct semaphore rxrpc_kernel_call_limiter =
46 __SEMAPHORE_INITIALIZER(rxrpc_kernel_call_limiter, 1000);
48 void rxrpc_poke_call(struct rxrpc_call *call, enum rxrpc_call_poke_trace what)
50 struct rxrpc_local *local = call->local;
53 if (call->state < RXRPC_CALL_COMPLETE) {
54 spin_lock_bh(&local->lock);
55 busy = !list_empty(&call->attend_link);
56 trace_rxrpc_poke_call(call, busy, what);
58 rxrpc_get_call(call, rxrpc_call_get_poke);
59 list_add_tail(&call->attend_link, &local->call_attend_q);
61 spin_unlock_bh(&local->lock);
62 rxrpc_wake_up_io_thread(local);
66 static void rxrpc_call_timer_expired(struct timer_list *t)
68 struct rxrpc_call *call = from_timer(call, t, timer);
70 _enter("%d", call->debug_id);
72 if (call->state < RXRPC_CALL_COMPLETE) {
73 trace_rxrpc_timer_expired(call, jiffies);
74 rxrpc_queue_call(call, rxrpc_call_queue_timer);
78 void rxrpc_reduce_call_timer(struct rxrpc_call *call,
79 unsigned long expire_at,
81 enum rxrpc_timer_trace why)
83 trace_rxrpc_timer(call, why, now);
84 timer_reduce(&call->timer, expire_at);
87 static struct lock_class_key rxrpc_call_user_mutex_lock_class_key;
89 static void rxrpc_destroy_call(struct work_struct *);
92 * find an extant server call
93 * - called in process context with IRQs enabled
95 struct rxrpc_call *rxrpc_find_call_by_user_ID(struct rxrpc_sock *rx,
96 unsigned long user_call_ID)
98 struct rxrpc_call *call;
101 _enter("%p,%lx", rx, user_call_ID);
103 read_lock(&rx->call_lock);
105 p = rx->calls.rb_node;
107 call = rb_entry(p, struct rxrpc_call, sock_node);
109 if (user_call_ID < call->user_call_ID)
111 else if (user_call_ID > call->user_call_ID)
114 goto found_extant_call;
117 read_unlock(&rx->call_lock);
122 rxrpc_get_call(call, rxrpc_call_get_sendmsg);
123 read_unlock(&rx->call_lock);
124 _leave(" = %p [%d]", call, refcount_read(&call->ref));
129 * allocate a new call
131 struct rxrpc_call *rxrpc_alloc_call(struct rxrpc_sock *rx, gfp_t gfp,
132 unsigned int debug_id)
134 struct rxrpc_call *call;
135 struct rxrpc_net *rxnet = rxrpc_net(sock_net(&rx->sk));
137 call = kmem_cache_zalloc(rxrpc_call_jar, gfp);
141 mutex_init(&call->user_mutex);
143 /* Prevent lockdep reporting a deadlock false positive between the afs
144 * filesystem and sys_sendmsg() via the mmap sem.
146 if (rx->sk.sk_kern_sock)
147 lockdep_set_class(&call->user_mutex,
148 &rxrpc_call_user_mutex_lock_class_key);
150 timer_setup(&call->timer, rxrpc_call_timer_expired, 0);
151 INIT_WORK(&call->processor, rxrpc_process_call);
152 INIT_WORK(&call->destroyer, rxrpc_destroy_call);
153 INIT_LIST_HEAD(&call->link);
154 INIT_LIST_HEAD(&call->chan_wait_link);
155 INIT_LIST_HEAD(&call->accept_link);
156 INIT_LIST_HEAD(&call->recvmsg_link);
157 INIT_LIST_HEAD(&call->sock_link);
158 INIT_LIST_HEAD(&call->attend_link);
159 INIT_LIST_HEAD(&call->tx_sendmsg);
160 INIT_LIST_HEAD(&call->tx_buffer);
161 skb_queue_head_init(&call->recvmsg_queue);
162 skb_queue_head_init(&call->rx_oos_queue);
163 init_waitqueue_head(&call->waitq);
164 spin_lock_init(&call->notify_lock);
165 spin_lock_init(&call->tx_lock);
166 spin_lock_init(&call->acks_ack_lock);
167 rwlock_init(&call->state_lock);
168 refcount_set(&call->ref, 1);
169 call->debug_id = debug_id;
170 call->tx_total_len = -1;
171 call->next_rx_timo = 20 * HZ;
172 call->next_req_timo = 1 * HZ;
173 atomic64_set(&call->ackr_window, 0x100000001ULL);
175 memset(&call->sock_node, 0xed, sizeof(call->sock_node));
177 call->rx_winsize = rxrpc_rx_window_size;
178 call->tx_winsize = 16;
180 if (RXRPC_TX_SMSS > 2190)
182 else if (RXRPC_TX_SMSS > 1095)
186 call->cong_ssthresh = RXRPC_TX_MAX_WINDOW;
189 call->rtt_avail = RXRPC_CALL_RTT_AVAIL_MASK;
190 atomic_inc(&rxnet->nr_calls);
195 * Allocate a new client call.
197 static struct rxrpc_call *rxrpc_alloc_client_call(struct rxrpc_sock *rx,
198 struct sockaddr_rxrpc *srx,
199 struct rxrpc_conn_parameters *cp,
200 struct rxrpc_call_params *p,
202 unsigned int debug_id)
204 struct rxrpc_call *call;
210 call = rxrpc_alloc_call(rx, gfp, debug_id);
212 return ERR_PTR(-ENOMEM);
213 now = ktime_get_real();
214 call->acks_latest_ts = now;
215 call->cong_tstamp = now;
216 call->state = RXRPC_CALL_CLIENT_AWAIT_CONN;
217 call->dest_srx = *srx;
218 call->interruptibility = p->interruptibility;
219 call->tx_total_len = p->tx_total_len;
220 call->key = key_get(cp->key);
221 call->local = rxrpc_get_local(cp->local, rxrpc_local_get_call);
223 __set_bit(RXRPC_CALL_KERNEL, &call->flags);
225 __set_bit(RXRPC_CALL_UPGRADE, &call->flags);
227 __set_bit(RXRPC_CALL_EXCLUSIVE, &call->flags);
229 ret = rxrpc_init_client_call_security(call);
231 __rxrpc_set_call_completion(call, RXRPC_CALL_LOCAL_ERROR, 0, ret);
232 rxrpc_put_call(call, rxrpc_call_put_discard_error);
236 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref),
237 p->user_call_ID, rxrpc_call_new_client);
239 _leave(" = %p", call);
244 * Initiate the call ack/resend/expiry timer.
246 static void rxrpc_start_call_timer(struct rxrpc_call *call)
248 unsigned long now = jiffies;
249 unsigned long j = now + MAX_JIFFY_OFFSET;
251 call->delay_ack_at = j;
252 call->ack_lost_at = j;
255 call->expect_rx_by = j;
256 call->expect_req_by = j;
257 call->expect_term_by = j;
258 call->timer.expires = now;
262 * Wait for a call slot to become available.
264 static struct semaphore *rxrpc_get_call_slot(struct rxrpc_call_params *p, gfp_t gfp)
266 struct semaphore *limiter = &rxrpc_call_limiter;
269 limiter = &rxrpc_kernel_call_limiter;
270 if (p->interruptibility == RXRPC_UNINTERRUPTIBLE) {
274 return down_interruptible(limiter) < 0 ? NULL : limiter;
278 * Release a call slot.
280 static void rxrpc_put_call_slot(struct rxrpc_call *call)
282 struct semaphore *limiter = &rxrpc_call_limiter;
284 if (test_bit(RXRPC_CALL_KERNEL, &call->flags))
285 limiter = &rxrpc_kernel_call_limiter;
290 * Set up a call for the given parameters.
291 * - Called with the socket lock held, which it must release.
292 * - If it returns a call, the call's lock will need releasing by the caller.
294 struct rxrpc_call *rxrpc_new_client_call(struct rxrpc_sock *rx,
295 struct rxrpc_conn_parameters *cp,
296 struct sockaddr_rxrpc *srx,
297 struct rxrpc_call_params *p,
299 unsigned int debug_id)
300 __releases(&rx->sk.sk_lock.slock)
301 __acquires(&call->user_mutex)
303 struct rxrpc_call *call, *xcall;
304 struct rxrpc_net *rxnet;
305 struct semaphore *limiter;
306 struct rb_node *parent, **pp;
309 _enter("%p,%lx", rx, p->user_call_ID);
311 limiter = rxrpc_get_call_slot(p, gfp);
313 release_sock(&rx->sk);
314 return ERR_PTR(-ERESTARTSYS);
317 call = rxrpc_alloc_client_call(rx, srx, cp, p, gfp, debug_id);
319 release_sock(&rx->sk);
321 _leave(" = %ld", PTR_ERR(call));
325 /* We need to protect a partially set up call against the user as we
326 * will be acting outside the socket lock.
328 mutex_lock(&call->user_mutex);
330 /* Publish the call, even though it is incompletely set up as yet */
331 write_lock(&rx->call_lock);
333 pp = &rx->calls.rb_node;
337 xcall = rb_entry(parent, struct rxrpc_call, sock_node);
339 if (p->user_call_ID < xcall->user_call_ID)
340 pp = &(*pp)->rb_left;
341 else if (p->user_call_ID > xcall->user_call_ID)
342 pp = &(*pp)->rb_right;
344 goto error_dup_user_ID;
347 rcu_assign_pointer(call->socket, rx);
348 call->user_call_ID = p->user_call_ID;
349 __set_bit(RXRPC_CALL_HAS_USERID, &call->flags);
350 rxrpc_get_call(call, rxrpc_call_get_userid);
351 rb_link_node(&call->sock_node, parent, pp);
352 rb_insert_color(&call->sock_node, &rx->calls);
353 list_add(&call->sock_link, &rx->sock_calls);
355 write_unlock(&rx->call_lock);
358 spin_lock_bh(&rxnet->call_lock);
359 list_add_tail_rcu(&call->link, &rxnet->calls);
360 spin_unlock_bh(&rxnet->call_lock);
362 /* From this point on, the call is protected by its own lock. */
363 release_sock(&rx->sk);
365 /* Set up or get a connection record and set the protocol parameters,
366 * including channel number and call ID.
368 ret = rxrpc_connect_call(rx, call, cp, srx, gfp);
370 goto error_attached_to_socket;
372 rxrpc_see_call(call, rxrpc_call_see_connected);
374 rxrpc_start_call_timer(call);
376 _leave(" = %p [new]", call);
379 /* We unexpectedly found the user ID in the list after taking
380 * the call_lock. This shouldn't happen unless the user races
381 * with itself and tries to add the same user ID twice at the
382 * same time in different threads.
385 write_unlock(&rx->call_lock);
386 release_sock(&rx->sk);
387 __rxrpc_set_call_completion(call, RXRPC_CALL_LOCAL_ERROR,
388 RX_CALL_DEAD, -EEXIST);
389 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref), 0,
390 rxrpc_call_see_userid_exists);
391 rxrpc_release_call(rx, call);
392 mutex_unlock(&call->user_mutex);
393 rxrpc_put_call(call, rxrpc_call_put_userid_exists);
394 _leave(" = -EEXIST");
395 return ERR_PTR(-EEXIST);
397 /* We got an error, but the call is attached to the socket and is in
398 * need of release. However, we might now race with recvmsg() when
399 * completing the call queues it. Return 0 from sys_sendmsg() and
400 * leave the error to recvmsg() to deal with.
402 error_attached_to_socket:
403 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref), ret,
404 rxrpc_call_see_connect_failed);
405 set_bit(RXRPC_CALL_DISCONNECTED, &call->flags);
406 __rxrpc_set_call_completion(call, RXRPC_CALL_LOCAL_ERROR,
408 _leave(" = c=%08x [err]", call->debug_id);
413 * Set up an incoming call. call->conn points to the connection.
414 * This is called in BH context and isn't allowed to fail.
416 void rxrpc_incoming_call(struct rxrpc_sock *rx,
417 struct rxrpc_call *call,
420 struct rxrpc_connection *conn = call->conn;
421 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
424 _enter(",%d", call->conn->debug_id);
426 rcu_assign_pointer(call->socket, rx);
427 call->call_id = sp->hdr.callNumber;
428 call->dest_srx.srx_service = sp->hdr.serviceId;
429 call->cid = sp->hdr.cid;
430 call->state = RXRPC_CALL_SERVER_SECURING;
431 call->cong_tstamp = skb->tstamp;
433 /* Set the channel for this call. We don't get channel_lock as we're
434 * only defending against the data_ready handler (which we're called
435 * from) and the RESPONSE packet parser (which is only really
436 * interested in call_counter and can cope with a disagreement with the
439 chan = sp->hdr.cid & RXRPC_CHANNELMASK;
440 conn->channels[chan].call_counter = call->call_id;
441 conn->channels[chan].call_id = call->call_id;
442 rcu_assign_pointer(conn->channels[chan].call, call);
444 spin_lock(&conn->peer->lock);
445 hlist_add_head_rcu(&call->error_link, &conn->peer->error_targets);
446 spin_unlock(&conn->peer->lock);
448 rxrpc_start_call_timer(call);
453 * Queue a call's work processor.
455 void rxrpc_queue_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
457 if (rxrpc_queue_work(&call->processor))
458 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref), 0, why);
462 * Note the re-emergence of a call.
464 void rxrpc_see_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
467 int r = refcount_read(&call->ref);
469 trace_rxrpc_call(call->debug_id, r, 0, why);
473 bool rxrpc_try_get_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
477 if (!__refcount_inc_not_zero(&call->ref, &r))
479 trace_rxrpc_call(call->debug_id, r + 1, 0, why);
484 * Note the addition of a ref on a call.
486 void rxrpc_get_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
490 __refcount_inc(&call->ref, &r);
491 trace_rxrpc_call(call->debug_id, r + 1, 0, why);
495 * Clean up the Rx skb ring.
497 static void rxrpc_cleanup_ring(struct rxrpc_call *call)
499 skb_queue_purge(&call->recvmsg_queue);
500 skb_queue_purge(&call->rx_oos_queue);
504 * Detach a call from its owning socket.
506 void rxrpc_release_call(struct rxrpc_sock *rx, struct rxrpc_call *call)
508 struct rxrpc_connection *conn = call->conn;
511 _enter("{%d,%d}", call->debug_id, refcount_read(&call->ref));
513 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref),
514 call->flags, rxrpc_call_see_release);
516 ASSERTCMP(call->state, ==, RXRPC_CALL_COMPLETE);
518 if (test_and_set_bit(RXRPC_CALL_RELEASED, &call->flags))
521 rxrpc_put_call_slot(call);
522 del_timer_sync(&call->timer);
524 /* Make sure we don't get any more notifications */
525 write_lock_bh(&rx->recvmsg_lock);
527 if (!list_empty(&call->recvmsg_link)) {
528 _debug("unlinking once-pending call %p { e=%lx f=%lx }",
529 call, call->events, call->flags);
530 list_del(&call->recvmsg_link);
534 /* list_empty() must return false in rxrpc_notify_socket() */
535 call->recvmsg_link.next = NULL;
536 call->recvmsg_link.prev = NULL;
538 write_unlock_bh(&rx->recvmsg_lock);
540 rxrpc_put_call(call, rxrpc_call_put_unnotify);
542 write_lock(&rx->call_lock);
544 if (test_and_clear_bit(RXRPC_CALL_HAS_USERID, &call->flags)) {
545 rb_erase(&call->sock_node, &rx->calls);
546 memset(&call->sock_node, 0xdd, sizeof(call->sock_node));
547 rxrpc_put_call(call, rxrpc_call_put_userid_exists);
550 list_del(&call->sock_link);
551 write_unlock(&rx->call_lock);
553 _debug("RELEASE CALL %p (%d CONN %p)", call, call->debug_id, conn);
555 if (conn && !test_bit(RXRPC_CALL_DISCONNECTED, &call->flags))
556 rxrpc_disconnect_call(call);
558 call->security->free_call_crypto(call);
563 * release all the calls associated with a socket
565 void rxrpc_release_calls_on_socket(struct rxrpc_sock *rx)
567 struct rxrpc_call *call;
571 while (!list_empty(&rx->to_be_accepted)) {
572 call = list_entry(rx->to_be_accepted.next,
573 struct rxrpc_call, accept_link);
574 list_del(&call->accept_link);
575 rxrpc_abort_call("SKR", call, 0, RX_CALL_DEAD, -ECONNRESET);
576 rxrpc_put_call(call, rxrpc_call_put_release_sock_tba);
579 while (!list_empty(&rx->sock_calls)) {
580 call = list_entry(rx->sock_calls.next,
581 struct rxrpc_call, sock_link);
582 rxrpc_get_call(call, rxrpc_call_get_release_sock);
583 rxrpc_abort_call("SKT", call, 0, RX_CALL_DEAD, -ECONNRESET);
584 rxrpc_send_abort_packet(call);
585 rxrpc_release_call(rx, call);
586 rxrpc_put_call(call, rxrpc_call_put_release_sock);
595 void rxrpc_put_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
597 struct rxrpc_net *rxnet = call->rxnet;
598 unsigned int debug_id = call->debug_id;
602 ASSERT(call != NULL);
604 dead = __refcount_dec_and_test(&call->ref, &r);
605 trace_rxrpc_call(debug_id, r - 1, 0, why);
607 ASSERTCMP(call->state, ==, RXRPC_CALL_COMPLETE);
609 if (!list_empty(&call->link)) {
610 spin_lock_bh(&rxnet->call_lock);
611 list_del_init(&call->link);
612 spin_unlock_bh(&rxnet->call_lock);
615 rxrpc_cleanup_call(call);
620 * Free up the call under RCU.
622 static void rxrpc_rcu_free_call(struct rcu_head *rcu)
624 struct rxrpc_call *call = container_of(rcu, struct rxrpc_call, rcu);
625 struct rxrpc_net *rxnet = READ_ONCE(call->rxnet);
627 kmem_cache_free(rxrpc_call_jar, call);
628 if (atomic_dec_and_test(&rxnet->nr_calls))
629 wake_up_var(&rxnet->nr_calls);
633 * Final call destruction - but must be done in process context.
635 static void rxrpc_destroy_call(struct work_struct *work)
637 struct rxrpc_call *call = container_of(work, struct rxrpc_call, destroyer);
638 struct rxrpc_txbuf *txb;
640 del_timer_sync(&call->timer);
641 cancel_work_sync(&call->processor); /* The processor may restart the timer */
642 del_timer_sync(&call->timer);
644 rxrpc_cleanup_ring(call);
645 while ((txb = list_first_entry_or_null(&call->tx_sendmsg,
646 struct rxrpc_txbuf, call_link))) {
647 list_del(&txb->call_link);
648 rxrpc_put_txbuf(txb, rxrpc_txbuf_put_cleaned);
650 while ((txb = list_first_entry_or_null(&call->tx_buffer,
651 struct rxrpc_txbuf, call_link))) {
652 list_del(&txb->call_link);
653 rxrpc_put_txbuf(txb, rxrpc_txbuf_put_cleaned);
655 rxrpc_put_txbuf(call->tx_pending, rxrpc_txbuf_put_cleaned);
656 rxrpc_free_skb(call->acks_soft_tbl, rxrpc_skb_put_ack);
657 rxrpc_put_connection(call->conn, rxrpc_conn_put_call);
658 rxrpc_put_peer(call->peer, rxrpc_peer_put_call);
659 rxrpc_put_local(call->local, rxrpc_local_put_call);
660 call_rcu(&call->rcu, rxrpc_rcu_free_call);
666 void rxrpc_cleanup_call(struct rxrpc_call *call)
668 memset(&call->sock_node, 0xcd, sizeof(call->sock_node));
670 ASSERTCMP(call->state, ==, RXRPC_CALL_COMPLETE);
671 ASSERT(test_bit(RXRPC_CALL_RELEASED, &call->flags));
673 del_timer_sync(&call->timer);
674 cancel_work(&call->processor);
676 if (rcu_read_lock_held() || work_busy(&call->processor))
677 /* Can't use the rxrpc workqueue as we need to cancel/flush
678 * something that may be running/waiting there.
680 schedule_work(&call->destroyer);
682 rxrpc_destroy_call(&call->destroyer);
686 * Make sure that all calls are gone from a network namespace. To reach this
687 * point, any open UDP sockets in that namespace must have been closed, so any
688 * outstanding calls cannot be doing I/O.
690 void rxrpc_destroy_all_calls(struct rxrpc_net *rxnet)
692 struct rxrpc_call *call;
696 if (!list_empty(&rxnet->calls)) {
697 spin_lock_bh(&rxnet->call_lock);
699 while (!list_empty(&rxnet->calls)) {
700 call = list_entry(rxnet->calls.next,
701 struct rxrpc_call, link);
702 _debug("Zapping call %p", call);
704 rxrpc_see_call(call, rxrpc_call_see_zap);
705 list_del_init(&call->link);
707 pr_err("Call %p still in use (%d,%s,%lx,%lx)!\n",
708 call, refcount_read(&call->ref),
709 rxrpc_call_states[call->state],
710 call->flags, call->events);
712 spin_unlock_bh(&rxnet->call_lock);
714 spin_lock_bh(&rxnet->call_lock);
717 spin_unlock_bh(&rxnet->call_lock);
720 atomic_dec(&rxnet->nr_calls);
721 wait_var_event(&rxnet->nr_calls, !atomic_read(&rxnet->nr_calls));