1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* AF_RXRPC sendmsg() implementation.
4 * Copyright (C) 2007, 2016 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/net.h>
11 #include <linux/gfp.h>
12 #include <linux/skbuff.h>
13 #include <linux/export.h>
14 #include <linux/sched/signal.h>
17 #include <net/af_rxrpc.h>
18 #include "ar-internal.h"
21 * Return true if there's sufficient Tx queue space.
23 static bool rxrpc_check_tx_space(struct rxrpc_call *call, rxrpc_seq_t *_tx_win)
25 unsigned int win_size =
26 min_t(unsigned int, call->tx_winsize,
27 call->cong_cwnd + call->cong_extra);
28 rxrpc_seq_t tx_win = READ_ONCE(call->tx_hard_ack);
32 return call->tx_top - tx_win < win_size;
36 * Wait for space to appear in the Tx queue or a signal to occur.
38 static int rxrpc_wait_for_tx_window_intr(struct rxrpc_sock *rx,
39 struct rxrpc_call *call,
43 set_current_state(TASK_INTERRUPTIBLE);
44 if (rxrpc_check_tx_space(call, NULL))
47 if (call->state >= RXRPC_CALL_COMPLETE)
50 if (signal_pending(current))
51 return sock_intr_errno(*timeo);
53 trace_rxrpc_transmit(call, rxrpc_transmit_wait);
54 *timeo = schedule_timeout(*timeo);
59 * Wait for space to appear in the Tx queue uninterruptibly, but with
60 * a timeout of 2*RTT if no progress was made and a signal occurred.
62 static int rxrpc_wait_for_tx_window_waitall(struct rxrpc_sock *rx,
63 struct rxrpc_call *call)
65 rxrpc_seq_t tx_start, tx_win;
66 signed long rtt, timeout;
68 rtt = READ_ONCE(call->peer->srtt_us) >> 3;
69 rtt = usecs_to_jiffies(rtt) * 2;
74 tx_start = READ_ONCE(call->tx_hard_ack);
77 set_current_state(TASK_UNINTERRUPTIBLE);
79 tx_win = READ_ONCE(call->tx_hard_ack);
80 if (rxrpc_check_tx_space(call, &tx_win))
83 if (call->state >= RXRPC_CALL_COMPLETE)
87 tx_win == tx_start && signal_pending(current))
90 if (tx_win != tx_start) {
95 trace_rxrpc_transmit(call, rxrpc_transmit_wait);
96 timeout = schedule_timeout(timeout);
101 * Wait for space to appear in the Tx queue uninterruptibly.
103 static int rxrpc_wait_for_tx_window_nonintr(struct rxrpc_sock *rx,
104 struct rxrpc_call *call,
108 set_current_state(TASK_UNINTERRUPTIBLE);
109 if (rxrpc_check_tx_space(call, NULL))
112 if (call->state >= RXRPC_CALL_COMPLETE)
115 trace_rxrpc_transmit(call, rxrpc_transmit_wait);
116 *timeo = schedule_timeout(*timeo);
121 * wait for space to appear in the transmit/ACK window
122 * - caller holds the socket locked
124 static int rxrpc_wait_for_tx_window(struct rxrpc_sock *rx,
125 struct rxrpc_call *call,
129 DECLARE_WAITQUEUE(myself, current);
132 _enter(",{%u,%u,%u}",
133 call->tx_hard_ack, call->tx_top, call->tx_winsize);
135 add_wait_queue(&call->waitq, &myself);
137 switch (call->interruptibility) {
138 case RXRPC_INTERRUPTIBLE:
140 ret = rxrpc_wait_for_tx_window_waitall(rx, call);
142 ret = rxrpc_wait_for_tx_window_intr(rx, call, timeo);
144 case RXRPC_PREINTERRUPTIBLE:
145 case RXRPC_UNINTERRUPTIBLE:
147 ret = rxrpc_wait_for_tx_window_nonintr(rx, call, timeo);
151 remove_wait_queue(&call->waitq, &myself);
152 set_current_state(TASK_RUNNING);
153 _leave(" = %d", ret);
158 * Schedule an instant Tx resend.
160 static inline void rxrpc_instant_resend(struct rxrpc_call *call, int ix)
162 spin_lock_bh(&call->lock);
164 if (call->state < RXRPC_CALL_COMPLETE) {
165 call->rxtx_annotations[ix] =
166 (call->rxtx_annotations[ix] & RXRPC_TX_ANNO_LAST) |
167 RXRPC_TX_ANNO_RETRANS;
168 if (!test_and_set_bit(RXRPC_CALL_EV_RESEND, &call->events))
169 rxrpc_queue_call(call);
172 spin_unlock_bh(&call->lock);
176 * Notify the owner of the call that the transmit phase is ended and the last
177 * packet has been queued.
179 static void rxrpc_notify_end_tx(struct rxrpc_sock *rx, struct rxrpc_call *call,
180 rxrpc_notify_end_tx_t notify_end_tx)
183 notify_end_tx(&rx->sk, call, call->user_call_ID);
187 * Queue a DATA packet for transmission, set the resend timeout and send
188 * the packet immediately. Returns the error from rxrpc_send_data_packet()
189 * in case the caller wants to do something with it.
191 static int rxrpc_queue_packet(struct rxrpc_sock *rx, struct rxrpc_call *call,
192 struct sk_buff *skb, bool last,
193 rxrpc_notify_end_tx_t notify_end_tx)
195 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
197 rxrpc_seq_t seq = sp->hdr.seq;
199 u8 annotation = RXRPC_TX_ANNO_UNACK;
201 _net("queue skb %p [%d]", skb, seq);
203 rxrpc_inc_stat(call->rxnet, stat_tx_data);
205 ASSERTCMP(seq, ==, call->tx_top + 1);
208 annotation |= RXRPC_TX_ANNO_LAST;
210 /* We have to set the timestamp before queueing as the retransmit
211 * algorithm can see the packet as soon as we queue it.
213 skb->tstamp = ktime_get_real();
215 ix = seq & RXRPC_RXTX_BUFF_MASK;
216 rxrpc_get_skb(skb, rxrpc_skb_got);
217 call->rxtx_annotations[ix] = annotation;
219 call->rxtx_buffer[ix] = skb;
222 trace_rxrpc_transmit(call, rxrpc_transmit_queue_last);
224 trace_rxrpc_transmit(call, rxrpc_transmit_queue);
226 if (last || call->state == RXRPC_CALL_SERVER_ACK_REQUEST) {
227 _debug("________awaiting reply/ACK__________");
228 write_lock_bh(&call->state_lock);
229 switch (call->state) {
230 case RXRPC_CALL_CLIENT_SEND_REQUEST:
231 call->state = RXRPC_CALL_CLIENT_AWAIT_REPLY;
232 rxrpc_notify_end_tx(rx, call, notify_end_tx);
234 case RXRPC_CALL_SERVER_ACK_REQUEST:
235 call->state = RXRPC_CALL_SERVER_SEND_REPLY;
237 WRITE_ONCE(call->delay_ack_at, now + MAX_JIFFY_OFFSET);
238 if (call->ackr_reason == RXRPC_ACK_DELAY)
239 call->ackr_reason = 0;
240 trace_rxrpc_timer(call, rxrpc_timer_init_for_send_reply, now);
244 case RXRPC_CALL_SERVER_SEND_REPLY:
245 call->state = RXRPC_CALL_SERVER_AWAIT_ACK;
246 rxrpc_notify_end_tx(rx, call, notify_end_tx);
251 write_unlock_bh(&call->state_lock);
254 if (seq == 1 && rxrpc_is_client_call(call))
255 rxrpc_expose_client_call(call);
257 ret = rxrpc_send_data_packet(call, skb, false);
263 rxrpc_set_call_completion(call, RXRPC_CALL_LOCAL_ERROR,
267 _debug("need instant resend %d", ret);
268 rxrpc_instant_resend(call, ix);
270 unsigned long now = jiffies;
271 unsigned long resend_at = now + call->peer->rto_j;
273 WRITE_ONCE(call->resend_at, resend_at);
274 rxrpc_reduce_call_timer(call, resend_at, now,
275 rxrpc_timer_set_for_send);
279 rxrpc_free_skb(skb, rxrpc_skb_freed);
280 _leave(" = %d", ret);
285 * send data through a socket
286 * - must be called in process context
287 * - The caller holds the call user access mutex, but not the socket lock.
289 static int rxrpc_send_data(struct rxrpc_sock *rx,
290 struct rxrpc_call *call,
291 struct msghdr *msg, size_t len,
292 rxrpc_notify_end_tx_t notify_end_tx,
295 struct rxrpc_skb_priv *sp;
297 struct sock *sk = &rx->sk;
298 enum rxrpc_call_state state;
300 bool more = msg->msg_flags & MSG_MORE;
303 timeo = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
305 /* this should be in poll */
306 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
310 if (sk->sk_shutdown & SEND_SHUTDOWN)
312 state = READ_ONCE(call->state);
314 if (state >= RXRPC_CALL_COMPLETE)
317 if (state != RXRPC_CALL_CLIENT_SEND_REQUEST &&
318 state != RXRPC_CALL_SERVER_ACK_REQUEST &&
319 state != RXRPC_CALL_SERVER_SEND_REPLY)
323 if (call->tx_total_len != -1) {
324 if (len - copied > call->tx_total_len)
326 if (!more && len - copied != call->tx_total_len)
330 skb = call->tx_pending;
331 call->tx_pending = NULL;
332 rxrpc_see_skb(skb, rxrpc_skb_seen);
335 rxrpc_transmit_ack_packets(call->peer->local);
338 size_t remain, bufsize, chunk, offset;
342 if (!rxrpc_check_tx_space(call, NULL))
345 /* Work out the maximum size of a packet. Assume that
346 * the security header is going to be in the padded
347 * region (enc blocksize), but the trailer is not.
349 remain = more ? INT_MAX : msg_data_left(msg);
350 ret = call->conn->security->how_much_data(call, remain,
351 &bufsize, &chunk, &offset);
355 _debug("SIZE: %zu/%zu @%zu", chunk, bufsize, offset);
357 /* create a buffer that we can retain until it's ACK'd */
358 skb = sock_alloc_send_skb(
359 sk, bufsize, msg->msg_flags & MSG_DONTWAIT, &ret);
364 rxrpc_new_skb(skb, rxrpc_skb_new);
366 _debug("ALLOC SEND %p", skb);
368 ASSERTCMP(skb->mark, ==, 0);
370 __skb_put(skb, offset);
373 if (sp->remain > skb_tailroom(skb))
374 sp->remain = skb_tailroom(skb);
376 _net("skb: hr %d, tr %d, hl %d, rm %d",
382 skb->ip_summed = CHECKSUM_UNNECESSARY;
388 /* append next segment of data to the current buffer */
389 if (msg_data_left(msg) > 0) {
390 int copy = skb_tailroom(skb);
391 ASSERTCMP(copy, >, 0);
392 if (copy > msg_data_left(msg))
393 copy = msg_data_left(msg);
394 if (copy > sp->remain)
398 ret = skb_add_data(skb, &msg->msg_iter, copy);
405 if (call->tx_total_len != -1)
406 call->tx_total_len -= copy;
409 /* check for the far side aborting the call or a network error
411 if (call->state == RXRPC_CALL_COMPLETE)
412 goto call_terminated;
414 /* add the packet to the send queue if it's now full */
415 if (sp->remain <= 0 ||
416 (msg_data_left(msg) == 0 && !more)) {
417 struct rxrpc_connection *conn = call->conn;
420 seq = call->tx_top + 1;
424 sp->hdr.flags = conn->out_clientflag;
426 if (msg_data_left(msg) == 0 && !more)
427 sp->hdr.flags |= RXRPC_LAST_PACKET;
428 else if (call->tx_top - call->tx_hard_ack <
430 sp->hdr.flags |= RXRPC_MORE_PACKETS;
432 ret = call->security->secure_packet(call, skb, skb->mark);
436 ret = rxrpc_queue_packet(rx, call, skb,
437 !msg_data_left(msg) && !more,
439 /* Should check for failure here */
442 } while (msg_data_left(msg) > 0);
446 if (READ_ONCE(call->state) == RXRPC_CALL_COMPLETE) {
447 read_lock_bh(&call->state_lock);
450 read_unlock_bh(&call->state_lock);
453 call->tx_pending = skb;
454 _leave(" = %d", ret);
458 rxrpc_free_skb(skb, rxrpc_skb_freed);
459 _leave(" = %d", call->error);
473 if (msg->msg_flags & MSG_DONTWAIT)
475 mutex_unlock(&call->user_mutex);
476 *_dropped_lock = true;
477 ret = rxrpc_wait_for_tx_window(rx, call, &timeo,
478 msg->msg_flags & MSG_WAITALL);
481 if (call->interruptibility == RXRPC_INTERRUPTIBLE) {
482 if (mutex_lock_interruptible(&call->user_mutex) < 0) {
483 ret = sock_intr_errno(timeo);
487 mutex_lock(&call->user_mutex);
489 *_dropped_lock = false;
494 * extract control messages from the sendmsg() control buffer
496 static int rxrpc_sendmsg_cmsg(struct msghdr *msg, struct rxrpc_send_params *p)
498 struct cmsghdr *cmsg;
499 bool got_user_ID = false;
502 if (msg->msg_controllen == 0)
505 for_each_cmsghdr(cmsg, msg) {
506 if (!CMSG_OK(msg, cmsg))
509 len = cmsg->cmsg_len - sizeof(struct cmsghdr);
510 _debug("CMSG %d, %d, %d",
511 cmsg->cmsg_level, cmsg->cmsg_type, len);
513 if (cmsg->cmsg_level != SOL_RXRPC)
516 switch (cmsg->cmsg_type) {
517 case RXRPC_USER_CALL_ID:
518 if (msg->msg_flags & MSG_CMSG_COMPAT) {
519 if (len != sizeof(u32))
521 p->call.user_call_ID = *(u32 *)CMSG_DATA(cmsg);
523 if (len != sizeof(unsigned long))
525 p->call.user_call_ID = *(unsigned long *)
532 if (p->command != RXRPC_CMD_SEND_DATA)
534 p->command = RXRPC_CMD_SEND_ABORT;
535 if (len != sizeof(p->abort_code))
537 p->abort_code = *(unsigned int *)CMSG_DATA(cmsg);
538 if (p->abort_code == 0)
542 case RXRPC_CHARGE_ACCEPT:
543 if (p->command != RXRPC_CMD_SEND_DATA)
545 p->command = RXRPC_CMD_CHARGE_ACCEPT;
550 case RXRPC_EXCLUSIVE_CALL:
556 case RXRPC_UPGRADE_SERVICE:
562 case RXRPC_TX_LENGTH:
563 if (p->call.tx_total_len != -1 || len != sizeof(__s64))
565 p->call.tx_total_len = *(__s64 *)CMSG_DATA(cmsg);
566 if (p->call.tx_total_len < 0)
570 case RXRPC_SET_CALL_TIMEOUT:
571 if (len & 3 || len < 4 || len > 12)
573 memcpy(&p->call.timeouts, CMSG_DATA(cmsg), len);
574 p->call.nr_timeouts = len / 4;
575 if (p->call.timeouts.hard > INT_MAX / HZ)
577 if (p->call.nr_timeouts >= 2 && p->call.timeouts.idle > 60 * 60 * 1000)
579 if (p->call.nr_timeouts >= 3 && p->call.timeouts.normal > 60 * 60 * 1000)
590 if (p->call.tx_total_len != -1 && p->command != RXRPC_CMD_SEND_DATA)
597 * Create a new client call for sendmsg().
598 * - Called with the socket lock held, which it must release.
599 * - If it returns a call, the call's lock will need releasing by the caller.
601 static struct rxrpc_call *
602 rxrpc_new_client_call_for_sendmsg(struct rxrpc_sock *rx, struct msghdr *msg,
603 struct rxrpc_send_params *p)
604 __releases(&rx->sk.sk_lock.slock)
605 __acquires(&call->user_mutex)
607 struct rxrpc_conn_parameters cp;
608 struct rxrpc_call *call;
611 DECLARE_SOCKADDR(struct sockaddr_rxrpc *, srx, msg->msg_name);
615 if (!msg->msg_name) {
616 release_sock(&rx->sk);
617 return ERR_PTR(-EDESTADDRREQ);
621 if (key && !rx->key->payload.data[0])
624 memset(&cp, 0, sizeof(cp));
625 cp.local = rx->local;
627 cp.security_level = rx->min_sec_level;
628 cp.exclusive = rx->exclusive | p->exclusive;
629 cp.upgrade = p->upgrade;
630 cp.service_id = srx->srx_service;
631 call = rxrpc_new_client_call(rx, &cp, srx, &p->call, GFP_KERNEL,
632 atomic_inc_return(&rxrpc_debug_id));
633 /* The socket is now unlocked */
635 rxrpc_put_peer(cp.peer);
636 _leave(" = %p\n", call);
641 * send a message forming part of a client call through an RxRPC socket
642 * - caller holds the socket locked
643 * - the socket may be either a client socket or a server socket
645 int rxrpc_do_sendmsg(struct rxrpc_sock *rx, struct msghdr *msg, size_t len)
646 __releases(&rx->sk.sk_lock.slock)
647 __releases(&call->user_mutex)
649 enum rxrpc_call_state state;
650 struct rxrpc_call *call;
651 unsigned long now, j;
652 bool dropped_lock = false;
655 struct rxrpc_send_params p = {
656 .call.tx_total_len = -1,
657 .call.user_call_ID = 0,
658 .call.nr_timeouts = 0,
659 .call.interruptibility = RXRPC_INTERRUPTIBLE,
661 .command = RXRPC_CMD_SEND_DATA,
668 ret = rxrpc_sendmsg_cmsg(msg, &p);
670 goto error_release_sock;
672 if (p.command == RXRPC_CMD_CHARGE_ACCEPT) {
674 if (rx->sk.sk_state != RXRPC_SERVER_LISTENING)
675 goto error_release_sock;
676 ret = rxrpc_user_charge_accept(rx, p.call.user_call_ID);
677 goto error_release_sock;
680 call = rxrpc_find_call_by_user_ID(rx, p.call.user_call_ID);
683 if (p.command != RXRPC_CMD_SEND_DATA)
684 goto error_release_sock;
685 call = rxrpc_new_client_call_for_sendmsg(rx, msg, &p);
686 /* The socket is now unlocked... */
688 return PTR_ERR(call);
689 /* ... and we have the call lock. */
691 if (READ_ONCE(call->state) == RXRPC_CALL_COMPLETE)
694 switch (READ_ONCE(call->state)) {
695 case RXRPC_CALL_UNINITIALISED:
696 case RXRPC_CALL_CLIENT_AWAIT_CONN:
697 case RXRPC_CALL_SERVER_PREALLOC:
698 case RXRPC_CALL_SERVER_SECURING:
699 rxrpc_put_call(call, rxrpc_call_put);
701 goto error_release_sock;
706 ret = mutex_lock_interruptible(&call->user_mutex);
707 release_sock(&rx->sk);
713 if (p.call.tx_total_len != -1) {
715 if (call->tx_total_len != -1 ||
719 call->tx_total_len = p.call.tx_total_len;
723 switch (p.call.nr_timeouts) {
725 j = msecs_to_jiffies(p.call.timeouts.normal);
726 if (p.call.timeouts.normal > 0 && j == 0)
728 WRITE_ONCE(call->next_rx_timo, j);
731 j = msecs_to_jiffies(p.call.timeouts.idle);
732 if (p.call.timeouts.idle > 0 && j == 0)
734 WRITE_ONCE(call->next_req_timo, j);
737 if (p.call.timeouts.hard > 0) {
738 j = msecs_to_jiffies(p.call.timeouts.hard);
741 WRITE_ONCE(call->expect_term_by, j);
742 rxrpc_reduce_call_timer(call, j, now,
743 rxrpc_timer_set_for_hard);
748 state = READ_ONCE(call->state);
749 _debug("CALL %d USR %lx ST %d on CONN %p",
750 call->debug_id, call->user_call_ID, state, call->conn);
752 if (state >= RXRPC_CALL_COMPLETE) {
753 /* it's too late for this call */
755 } else if (p.command == RXRPC_CMD_SEND_ABORT) {
757 if (rxrpc_abort_call("CMD", call, 0, p.abort_code, -ECONNABORTED))
758 ret = rxrpc_send_abort_packet(call);
759 } else if (p.command != RXRPC_CMD_SEND_DATA) {
762 ret = rxrpc_send_data(rx, call, msg, len, NULL, &dropped_lock);
767 mutex_unlock(&call->user_mutex);
769 rxrpc_put_call(call, rxrpc_call_put);
770 _leave(" = %d", ret);
774 release_sock(&rx->sk);
779 * rxrpc_kernel_send_data - Allow a kernel service to send data on a call
780 * @sock: The socket the call is on
781 * @call: The call to send data through
782 * @msg: The data to send
783 * @len: The amount of data to send
784 * @notify_end_tx: Notification that the last packet is queued.
786 * Allow a kernel service to send data on a call. The call must be in an state
787 * appropriate to sending data. No control data should be supplied in @msg,
788 * nor should an address be supplied. MSG_MORE should be flagged if there's
789 * more data to come, otherwise this data will end the transmission phase.
791 int rxrpc_kernel_send_data(struct socket *sock, struct rxrpc_call *call,
792 struct msghdr *msg, size_t len,
793 rxrpc_notify_end_tx_t notify_end_tx)
795 bool dropped_lock = false;
798 _enter("{%d,%s},", call->debug_id, rxrpc_call_states[call->state]);
800 ASSERTCMP(msg->msg_name, ==, NULL);
801 ASSERTCMP(msg->msg_control, ==, NULL);
803 mutex_lock(&call->user_mutex);
805 _debug("CALL %d USR %lx ST %d on CONN %p",
806 call->debug_id, call->user_call_ID, call->state, call->conn);
808 switch (READ_ONCE(call->state)) {
809 case RXRPC_CALL_CLIENT_SEND_REQUEST:
810 case RXRPC_CALL_SERVER_ACK_REQUEST:
811 case RXRPC_CALL_SERVER_SEND_REPLY:
812 ret = rxrpc_send_data(rxrpc_sk(sock->sk), call, msg, len,
813 notify_end_tx, &dropped_lock);
815 case RXRPC_CALL_COMPLETE:
816 read_lock_bh(&call->state_lock);
818 read_unlock_bh(&call->state_lock);
821 /* Request phase complete for this client call */
822 trace_rxrpc_rx_eproto(call, 0, tracepoint_string("late_send"));
828 mutex_unlock(&call->user_mutex);
829 _leave(" = %d", ret);
832 EXPORT_SYMBOL(rxrpc_kernel_send_data);
835 * rxrpc_kernel_abort_call - Allow a kernel service to abort a call
836 * @sock: The socket the call is on
837 * @call: The call to be aborted
838 * @abort_code: The abort code to stick into the ABORT packet
839 * @error: Local error value
840 * @why: 3-char string indicating why.
842 * Allow a kernel service to abort a call, if it's still in an abortable state
843 * and return true if the call was aborted, false if it was already complete.
845 bool rxrpc_kernel_abort_call(struct socket *sock, struct rxrpc_call *call,
846 u32 abort_code, int error, const char *why)
850 _enter("{%d},%d,%d,%s", call->debug_id, abort_code, error, why);
852 mutex_lock(&call->user_mutex);
854 aborted = rxrpc_abort_call(why, call, 0, abort_code, error);
856 rxrpc_send_abort_packet(call);
858 mutex_unlock(&call->user_mutex);
861 EXPORT_SYMBOL(rxrpc_kernel_abort_call);
864 * rxrpc_kernel_set_tx_length - Set the total Tx length on a call
865 * @sock: The socket the call is on
866 * @call: The call to be informed
867 * @tx_total_len: The amount of data to be transmitted for this call
869 * Allow a kernel service to set the total transmit length on a call. This
870 * allows buffer-to-packet encrypt-and-copy to be performed.
872 * This function is primarily for use for setting the reply length since the
873 * request length can be set when beginning the call.
875 void rxrpc_kernel_set_tx_length(struct socket *sock, struct rxrpc_call *call,
878 WARN_ON(call->tx_total_len != -1);
879 call->tx_total_len = tx_total_len;
881 EXPORT_SYMBOL(rxrpc_kernel_set_tx_length);