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 (!test_bit(RXRPC_CALL_DISCONNECTED, &call->flags)) {
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 (!__rxrpc_call_is_complete(call)) {
73 trace_rxrpc_timer_expired(call, jiffies);
74 rxrpc_poke_call(call, rxrpc_call_poke_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->destroyer, rxrpc_destroy_call);
152 INIT_LIST_HEAD(&call->link);
153 INIT_LIST_HEAD(&call->chan_wait_link);
154 INIT_LIST_HEAD(&call->accept_link);
155 INIT_LIST_HEAD(&call->recvmsg_link);
156 INIT_LIST_HEAD(&call->sock_link);
157 INIT_LIST_HEAD(&call->attend_link);
158 INIT_LIST_HEAD(&call->tx_sendmsg);
159 INIT_LIST_HEAD(&call->tx_buffer);
160 skb_queue_head_init(&call->recvmsg_queue);
161 skb_queue_head_init(&call->rx_oos_queue);
162 init_waitqueue_head(&call->waitq);
163 spin_lock_init(&call->notify_lock);
164 spin_lock_init(&call->tx_lock);
165 refcount_set(&call->ref, 1);
166 call->debug_id = debug_id;
167 call->tx_total_len = -1;
168 call->next_rx_timo = 20 * HZ;
169 call->next_req_timo = 1 * HZ;
170 atomic64_set(&call->ackr_window, 0x100000001ULL);
172 memset(&call->sock_node, 0xed, sizeof(call->sock_node));
174 call->rx_winsize = rxrpc_rx_window_size;
175 call->tx_winsize = 16;
177 if (RXRPC_TX_SMSS > 2190)
179 else if (RXRPC_TX_SMSS > 1095)
183 call->cong_ssthresh = RXRPC_TX_MAX_WINDOW;
186 call->rtt_avail = RXRPC_CALL_RTT_AVAIL_MASK;
187 atomic_inc(&rxnet->nr_calls);
192 * Allocate a new client call.
194 static struct rxrpc_call *rxrpc_alloc_client_call(struct rxrpc_sock *rx,
195 struct sockaddr_rxrpc *srx,
196 struct rxrpc_conn_parameters *cp,
197 struct rxrpc_call_params *p,
199 unsigned int debug_id)
201 struct rxrpc_call *call;
207 call = rxrpc_alloc_call(rx, gfp, debug_id);
209 return ERR_PTR(-ENOMEM);
210 now = ktime_get_real();
211 call->acks_latest_ts = now;
212 call->cong_tstamp = now;
213 call->dest_srx = *srx;
214 call->interruptibility = p->interruptibility;
215 call->tx_total_len = p->tx_total_len;
216 call->key = key_get(cp->key);
217 call->local = rxrpc_get_local(cp->local, rxrpc_local_get_call);
218 call->security_level = cp->security_level;
220 __set_bit(RXRPC_CALL_KERNEL, &call->flags);
222 __set_bit(RXRPC_CALL_UPGRADE, &call->flags);
224 __set_bit(RXRPC_CALL_EXCLUSIVE, &call->flags);
226 ret = rxrpc_init_client_call_security(call);
228 rxrpc_prefail_call(call, RXRPC_CALL_LOCAL_ERROR, ret);
229 rxrpc_put_call(call, rxrpc_call_put_discard_error);
233 rxrpc_set_call_state(call, RXRPC_CALL_CLIENT_AWAIT_CONN);
235 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref),
236 p->user_call_ID, rxrpc_call_new_client);
238 _leave(" = %p", call);
243 * Initiate the call ack/resend/expiry timer.
245 static void rxrpc_start_call_timer(struct rxrpc_call *call)
247 unsigned long now = jiffies;
248 unsigned long j = now + MAX_JIFFY_OFFSET;
250 call->delay_ack_at = j;
251 call->ack_lost_at = j;
254 call->keepalive_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(&rxnet->call_lock);
359 list_add_tail_rcu(&call->link, &rxnet->calls);
360 spin_unlock(&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(call, 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_prefail_call(call, RXRPC_CALL_LOCAL_ERROR, -EEXIST);
388 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref), 0,
389 rxrpc_call_see_userid_exists);
390 rxrpc_release_call(rx, call);
391 mutex_unlock(&call->user_mutex);
392 rxrpc_put_call(call, rxrpc_call_put_userid_exists);
393 _leave(" = -EEXIST");
394 return ERR_PTR(-EEXIST);
396 /* We got an error, but the call is attached to the socket and is in
397 * need of release. However, we might now race with recvmsg() when
398 * completing the call queues it. Return 0 from sys_sendmsg() and
399 * leave the error to recvmsg() to deal with.
401 error_attached_to_socket:
402 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref), ret,
403 rxrpc_call_see_connect_failed);
404 set_bit(RXRPC_CALL_DISCONNECTED, &call->flags);
405 rxrpc_prefail_call(call, RXRPC_CALL_LOCAL_ERROR, ret);
406 _leave(" = c=%08x [err]", call->debug_id);
411 * Set up an incoming call. call->conn points to the connection.
412 * This is called in BH context and isn't allowed to fail.
414 void rxrpc_incoming_call(struct rxrpc_sock *rx,
415 struct rxrpc_call *call,
418 struct rxrpc_connection *conn = call->conn;
419 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
422 _enter(",%d", call->conn->debug_id);
424 rcu_assign_pointer(call->socket, rx);
425 call->call_id = sp->hdr.callNumber;
426 call->dest_srx.srx_service = sp->hdr.serviceId;
427 call->cid = sp->hdr.cid;
428 call->cong_tstamp = skb->tstamp;
430 __set_bit(RXRPC_CALL_EXPOSED, &call->flags);
431 rxrpc_set_call_state(call, RXRPC_CALL_SERVER_SECURING);
433 spin_lock(&conn->state_lock);
435 switch (conn->state) {
436 case RXRPC_CONN_SERVICE_UNSECURED:
437 case RXRPC_CONN_SERVICE_CHALLENGING:
438 rxrpc_set_call_state(call, RXRPC_CALL_SERVER_SECURING);
440 case RXRPC_CONN_SERVICE:
441 rxrpc_set_call_state(call, RXRPC_CALL_SERVER_RECV_REQUEST);
444 case RXRPC_CONN_ABORTED:
445 rxrpc_set_call_completion(call, conn->completion,
446 conn->abort_code, conn->error);
452 rxrpc_get_call(call, rxrpc_call_get_io_thread);
454 /* Set the channel for this call. We don't get channel_lock as we're
455 * only defending against the data_ready handler (which we're called
456 * from) and the RESPONSE packet parser (which is only really
457 * interested in call_counter and can cope with a disagreement with the
460 chan = sp->hdr.cid & RXRPC_CHANNELMASK;
461 conn->channels[chan].call_counter = call->call_id;
462 conn->channels[chan].call_id = call->call_id;
463 rcu_assign_pointer(conn->channels[chan].call, call);
464 spin_unlock(&conn->state_lock);
466 spin_lock(&conn->peer->lock);
467 hlist_add_head(&call->error_link, &conn->peer->error_targets);
468 spin_unlock(&conn->peer->lock);
470 rxrpc_start_call_timer(call);
475 * Note the re-emergence of a call.
477 void rxrpc_see_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
480 int r = refcount_read(&call->ref);
482 trace_rxrpc_call(call->debug_id, r, 0, why);
486 struct rxrpc_call *rxrpc_try_get_call(struct rxrpc_call *call,
487 enum rxrpc_call_trace why)
491 if (!call || !__refcount_inc_not_zero(&call->ref, &r))
493 trace_rxrpc_call(call->debug_id, r + 1, 0, why);
498 * Note the addition of a ref on a call.
500 void rxrpc_get_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
504 __refcount_inc(&call->ref, &r);
505 trace_rxrpc_call(call->debug_id, r + 1, 0, why);
509 * Clean up the Rx skb ring.
511 static void rxrpc_cleanup_ring(struct rxrpc_call *call)
513 skb_queue_purge(&call->recvmsg_queue);
514 skb_queue_purge(&call->rx_oos_queue);
518 * Detach a call from its owning socket.
520 void rxrpc_release_call(struct rxrpc_sock *rx, struct rxrpc_call *call)
522 struct rxrpc_connection *conn = call->conn;
525 _enter("{%d,%d}", call->debug_id, refcount_read(&call->ref));
527 trace_rxrpc_call(call->debug_id, refcount_read(&call->ref),
528 call->flags, rxrpc_call_see_release);
530 if (test_and_set_bit(RXRPC_CALL_RELEASED, &call->flags))
533 rxrpc_put_call_slot(call);
535 /* Make sure we don't get any more notifications */
536 write_lock(&rx->recvmsg_lock);
538 if (!list_empty(&call->recvmsg_link)) {
539 _debug("unlinking once-pending call %p { e=%lx f=%lx }",
540 call, call->events, call->flags);
541 list_del(&call->recvmsg_link);
545 /* list_empty() must return false in rxrpc_notify_socket() */
546 call->recvmsg_link.next = NULL;
547 call->recvmsg_link.prev = NULL;
549 write_unlock(&rx->recvmsg_lock);
551 rxrpc_put_call(call, rxrpc_call_put_unnotify);
553 write_lock(&rx->call_lock);
555 if (test_and_clear_bit(RXRPC_CALL_HAS_USERID, &call->flags)) {
556 rb_erase(&call->sock_node, &rx->calls);
557 memset(&call->sock_node, 0xdd, sizeof(call->sock_node));
558 rxrpc_put_call(call, rxrpc_call_put_userid_exists);
561 list_del(&call->sock_link);
562 write_unlock(&rx->call_lock);
564 _debug("RELEASE CALL %p (%d CONN %p)", call, call->debug_id, conn);
570 * release all the calls associated with a socket
572 void rxrpc_release_calls_on_socket(struct rxrpc_sock *rx)
574 struct rxrpc_call *call;
578 while (!list_empty(&rx->to_be_accepted)) {
579 call = list_entry(rx->to_be_accepted.next,
580 struct rxrpc_call, accept_link);
581 list_del(&call->accept_link);
582 rxrpc_propose_abort(call, RX_CALL_DEAD, -ECONNRESET,
583 rxrpc_abort_call_sock_release_tba);
584 rxrpc_put_call(call, rxrpc_call_put_release_sock_tba);
587 while (!list_empty(&rx->sock_calls)) {
588 call = list_entry(rx->sock_calls.next,
589 struct rxrpc_call, sock_link);
590 rxrpc_get_call(call, rxrpc_call_get_release_sock);
591 rxrpc_propose_abort(call, RX_CALL_DEAD, -ECONNRESET,
592 rxrpc_abort_call_sock_release);
593 rxrpc_release_call(rx, call);
594 rxrpc_put_call(call, rxrpc_call_put_release_sock);
603 void rxrpc_put_call(struct rxrpc_call *call, enum rxrpc_call_trace why)
605 struct rxrpc_net *rxnet = call->rxnet;
606 unsigned int debug_id = call->debug_id;
610 ASSERT(call != NULL);
612 dead = __refcount_dec_and_test(&call->ref, &r);
613 trace_rxrpc_call(debug_id, r - 1, 0, why);
615 ASSERTCMP(__rxrpc_call_state(call), ==, RXRPC_CALL_COMPLETE);
617 if (!list_empty(&call->link)) {
618 spin_lock(&rxnet->call_lock);
619 list_del_init(&call->link);
620 spin_unlock(&rxnet->call_lock);
623 rxrpc_cleanup_call(call);
628 * Free up the call under RCU.
630 static void rxrpc_rcu_free_call(struct rcu_head *rcu)
632 struct rxrpc_call *call = container_of(rcu, struct rxrpc_call, rcu);
633 struct rxrpc_net *rxnet = READ_ONCE(call->rxnet);
635 kmem_cache_free(rxrpc_call_jar, call);
636 if (atomic_dec_and_test(&rxnet->nr_calls))
637 wake_up_var(&rxnet->nr_calls);
641 * Final call destruction - but must be done in process context.
643 static void rxrpc_destroy_call(struct work_struct *work)
645 struct rxrpc_call *call = container_of(work, struct rxrpc_call, destroyer);
646 struct rxrpc_txbuf *txb;
648 del_timer_sync(&call->timer);
650 rxrpc_cleanup_ring(call);
651 while ((txb = list_first_entry_or_null(&call->tx_sendmsg,
652 struct rxrpc_txbuf, call_link))) {
653 list_del(&txb->call_link);
654 rxrpc_put_txbuf(txb, rxrpc_txbuf_put_cleaned);
656 while ((txb = list_first_entry_or_null(&call->tx_buffer,
657 struct rxrpc_txbuf, call_link))) {
658 list_del(&txb->call_link);
659 rxrpc_put_txbuf(txb, rxrpc_txbuf_put_cleaned);
662 rxrpc_put_txbuf(call->tx_pending, rxrpc_txbuf_put_cleaned);
663 rxrpc_put_connection(call->conn, rxrpc_conn_put_call);
664 rxrpc_deactivate_bundle(call->bundle);
665 rxrpc_put_bundle(call->bundle, rxrpc_bundle_put_call);
666 rxrpc_put_peer(call->peer, rxrpc_peer_put_call);
667 rxrpc_put_local(call->local, rxrpc_local_put_call);
668 call_rcu(&call->rcu, rxrpc_rcu_free_call);
674 void rxrpc_cleanup_call(struct rxrpc_call *call)
676 memset(&call->sock_node, 0xcd, sizeof(call->sock_node));
678 ASSERTCMP(__rxrpc_call_state(call), ==, RXRPC_CALL_COMPLETE);
679 ASSERT(test_bit(RXRPC_CALL_RELEASED, &call->flags));
681 del_timer(&call->timer);
683 if (rcu_read_lock_held())
684 /* Can't use the rxrpc workqueue as we need to cancel/flush
685 * something that may be running/waiting there.
687 schedule_work(&call->destroyer);
689 rxrpc_destroy_call(&call->destroyer);
693 * Make sure that all calls are gone from a network namespace. To reach this
694 * point, any open UDP sockets in that namespace must have been closed, so any
695 * outstanding calls cannot be doing I/O.
697 void rxrpc_destroy_all_calls(struct rxrpc_net *rxnet)
699 struct rxrpc_call *call;
703 if (!list_empty(&rxnet->calls)) {
704 spin_lock(&rxnet->call_lock);
706 while (!list_empty(&rxnet->calls)) {
707 call = list_entry(rxnet->calls.next,
708 struct rxrpc_call, link);
709 _debug("Zapping call %p", call);
711 rxrpc_see_call(call, rxrpc_call_see_zap);
712 list_del_init(&call->link);
714 pr_err("Call %p still in use (%d,%s,%lx,%lx)!\n",
715 call, refcount_read(&call->ref),
716 rxrpc_call_states[__rxrpc_call_state(call)],
717 call->flags, call->events);
719 spin_unlock(&rxnet->call_lock);
721 spin_lock(&rxnet->call_lock);
724 spin_unlock(&rxnet->call_lock);
727 atomic_dec(&rxnet->nr_calls);
728 wait_var_event(&rxnet->nr_calls, !atomic_read(&rxnet->nr_calls));