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 * Propose an abort to be made in the I/O thread.
23 bool rxrpc_propose_abort(struct rxrpc_call *call, s32 abort_code, int error,
24 enum rxrpc_abort_reason why)
26 _enter("{%d},%d,%d,%u", call->debug_id, abort_code, error, why);
28 if (!call->send_abort && !rxrpc_call_is_complete(call)) {
29 call->send_abort_why = why;
30 call->send_abort_err = error;
31 call->send_abort_seq = 0;
32 /* Request abort locklessly vs rxrpc_input_call_event(). */
33 smp_store_release(&call->send_abort, abort_code);
34 rxrpc_poke_call(call, rxrpc_call_poke_abort);
42 * Return true if there's sufficient Tx queue space.
44 static bool rxrpc_check_tx_space(struct rxrpc_call *call, rxrpc_seq_t *_tx_win)
47 *_tx_win = call->tx_bottom;
48 return call->tx_prepared - call->tx_bottom < 256;
52 * Wait for space to appear in the Tx queue or a signal to occur.
54 static int rxrpc_wait_for_tx_window_intr(struct rxrpc_sock *rx,
55 struct rxrpc_call *call,
59 set_current_state(TASK_INTERRUPTIBLE);
60 if (rxrpc_check_tx_space(call, NULL))
63 if (rxrpc_call_is_complete(call))
66 if (signal_pending(current))
67 return sock_intr_errno(*timeo);
69 trace_rxrpc_txqueue(call, rxrpc_txqueue_wait);
70 *timeo = schedule_timeout(*timeo);
75 * Wait for space to appear in the Tx queue uninterruptibly, but with
76 * a timeout of 2*RTT if no progress was made and a signal occurred.
78 static int rxrpc_wait_for_tx_window_waitall(struct rxrpc_sock *rx,
79 struct rxrpc_call *call)
81 rxrpc_seq_t tx_start, tx_win;
82 signed long rtt, timeout;
84 rtt = READ_ONCE(call->peer->srtt_us) >> 3;
85 rtt = usecs_to_jiffies(rtt) * 2;
90 tx_start = smp_load_acquire(&call->acks_hard_ack);
93 set_current_state(TASK_UNINTERRUPTIBLE);
95 if (rxrpc_check_tx_space(call, &tx_win))
98 if (rxrpc_call_is_complete(call))
102 tx_win == tx_start && signal_pending(current))
105 if (tx_win != tx_start) {
110 trace_rxrpc_txqueue(call, rxrpc_txqueue_wait);
111 timeout = schedule_timeout(timeout);
116 * Wait for space to appear in the Tx queue uninterruptibly.
118 static int rxrpc_wait_for_tx_window_nonintr(struct rxrpc_sock *rx,
119 struct rxrpc_call *call,
123 set_current_state(TASK_UNINTERRUPTIBLE);
124 if (rxrpc_check_tx_space(call, NULL))
127 if (rxrpc_call_is_complete(call))
130 trace_rxrpc_txqueue(call, rxrpc_txqueue_wait);
131 *timeo = schedule_timeout(*timeo);
136 * wait for space to appear in the transmit/ACK window
137 * - caller holds the socket locked
139 static int rxrpc_wait_for_tx_window(struct rxrpc_sock *rx,
140 struct rxrpc_call *call,
144 DECLARE_WAITQUEUE(myself, current);
147 _enter(",{%u,%u,%u,%u}",
148 call->tx_bottom, call->acks_hard_ack, call->tx_top, call->tx_winsize);
150 add_wait_queue(&call->waitq, &myself);
152 switch (call->interruptibility) {
153 case RXRPC_INTERRUPTIBLE:
155 ret = rxrpc_wait_for_tx_window_waitall(rx, call);
157 ret = rxrpc_wait_for_tx_window_intr(rx, call, timeo);
159 case RXRPC_PREINTERRUPTIBLE:
160 case RXRPC_UNINTERRUPTIBLE:
162 ret = rxrpc_wait_for_tx_window_nonintr(rx, call, timeo);
166 remove_wait_queue(&call->waitq, &myself);
167 set_current_state(TASK_RUNNING);
168 _leave(" = %d", ret);
173 * Notify the owner of the call that the transmit phase is ended and the last
174 * packet has been queued.
176 static void rxrpc_notify_end_tx(struct rxrpc_sock *rx, struct rxrpc_call *call,
177 rxrpc_notify_end_tx_t notify_end_tx)
180 notify_end_tx(&rx->sk, call, call->user_call_ID);
184 * Queue a DATA packet for transmission, set the resend timeout and send
185 * the packet immediately. Returns the error from rxrpc_send_data_packet()
186 * in case the caller wants to do something with it.
188 static void rxrpc_queue_packet(struct rxrpc_sock *rx, struct rxrpc_call *call,
189 struct rxrpc_txbuf *txb,
190 rxrpc_notify_end_tx_t notify_end_tx)
192 rxrpc_seq_t seq = txb->seq;
193 bool last = test_bit(RXRPC_TXBUF_LAST, &txb->flags), poke;
195 rxrpc_inc_stat(call->rxnet, stat_tx_data);
197 ASSERTCMP(txb->seq, ==, call->tx_prepared + 1);
199 /* We have to set the timestamp before queueing as the retransmit
200 * algorithm can see the packet as soon as we queue it.
202 txb->last_sent = ktime_get_real();
205 trace_rxrpc_txqueue(call, rxrpc_txqueue_queue_last);
207 trace_rxrpc_txqueue(call, rxrpc_txqueue_queue);
209 /* Add the packet to the call's output buffer */
210 spin_lock(&call->tx_lock);
211 poke = list_empty(&call->tx_sendmsg);
212 list_add_tail(&txb->call_link, &call->tx_sendmsg);
213 call->tx_prepared = seq;
215 rxrpc_notify_end_tx(rx, call, notify_end_tx);
216 spin_unlock(&call->tx_lock);
219 rxrpc_poke_call(call, rxrpc_call_poke_start);
223 * send data through a socket
224 * - must be called in process context
225 * - The caller holds the call user access mutex, but not the socket lock.
227 static int rxrpc_send_data(struct rxrpc_sock *rx,
228 struct rxrpc_call *call,
229 struct msghdr *msg, size_t len,
230 rxrpc_notify_end_tx_t notify_end_tx,
233 struct rxrpc_txbuf *txb;
234 struct sock *sk = &rx->sk;
235 enum rxrpc_call_state state;
237 bool more = msg->msg_flags & MSG_MORE;
240 timeo = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
242 /* this should be in poll */
243 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
247 if (sk->sk_shutdown & SEND_SHUTDOWN)
249 state = rxrpc_call_state(call);
251 if (state >= RXRPC_CALL_COMPLETE)
254 if (state != RXRPC_CALL_CLIENT_SEND_REQUEST &&
255 state != RXRPC_CALL_SERVER_ACK_REQUEST &&
256 state != RXRPC_CALL_SERVER_SEND_REPLY) {
257 /* Request phase complete for this client call */
258 trace_rxrpc_abort(call->debug_id, rxrpc_sendmsg_late_send,
259 call->cid, call->call_id, call->rx_consumed,
265 if (call->tx_total_len != -1) {
266 if (len - copied > call->tx_total_len)
268 if (!more && len - copied != call->tx_total_len)
272 txb = call->tx_pending;
273 call->tx_pending = NULL;
275 rxrpc_see_txbuf(txb, rxrpc_txbuf_see_send_more);
279 size_t remain, bufsize, chunk, offset;
283 if (!rxrpc_check_tx_space(call, NULL))
286 /* Work out the maximum size of a packet. Assume that
287 * the security header is going to be in the padded
288 * region (enc blocksize), but the trailer is not.
290 remain = more ? INT_MAX : msg_data_left(msg);
291 ret = call->conn->security->how_much_data(call, remain,
292 &bufsize, &chunk, &offset);
296 _debug("SIZE: %zu/%zu @%zu", chunk, bufsize, offset);
298 /* create a buffer that we can retain until it's ACK'd */
300 txb = rxrpc_alloc_txbuf(call, RXRPC_PACKET_TYPE_DATA,
305 txb->offset = offset;
306 txb->space -= offset;
307 txb->space = min_t(size_t, chunk, txb->space);
312 /* append next segment of data to the current buffer */
313 if (msg_data_left(msg) > 0) {
314 size_t copy = min_t(size_t, txb->space, msg_data_left(msg));
316 _debug("add %zu", copy);
317 if (!copy_from_iter_full(txb->data + txb->offset, copy,
325 if (call->tx_total_len != -1)
326 call->tx_total_len -= copy;
329 /* check for the far side aborting the call or a network error
331 if (rxrpc_call_is_complete(call))
332 goto call_terminated;
334 /* add the packet to the send queue if it's now full */
336 (msg_data_left(msg) == 0 && !more)) {
337 if (msg_data_left(msg) == 0 && !more) {
338 txb->wire.flags |= RXRPC_LAST_PACKET;
339 __set_bit(RXRPC_TXBUF_LAST, &txb->flags);
341 else if (call->tx_top - call->acks_hard_ack <
343 txb->wire.flags |= RXRPC_MORE_PACKETS;
345 ret = call->security->secure_packet(call, txb);
349 rxrpc_queue_packet(rx, call, txb, notify_end_tx);
352 } while (msg_data_left(msg) > 0);
356 if (rxrpc_call_is_complete(call) &&
360 call->tx_pending = txb;
361 _leave(" = %d", ret);
365 rxrpc_put_txbuf(txb, rxrpc_txbuf_put_send_aborted);
366 _leave(" = %d", call->error);
380 if (msg->msg_flags & MSG_DONTWAIT)
382 mutex_unlock(&call->user_mutex);
383 *_dropped_lock = true;
384 ret = rxrpc_wait_for_tx_window(rx, call, &timeo,
385 msg->msg_flags & MSG_WAITALL);
388 if (call->interruptibility == RXRPC_INTERRUPTIBLE) {
389 if (mutex_lock_interruptible(&call->user_mutex) < 0) {
390 ret = sock_intr_errno(timeo);
394 mutex_lock(&call->user_mutex);
396 *_dropped_lock = false;
401 * extract control messages from the sendmsg() control buffer
403 static int rxrpc_sendmsg_cmsg(struct msghdr *msg, struct rxrpc_send_params *p)
405 struct cmsghdr *cmsg;
406 bool got_user_ID = false;
409 if (msg->msg_controllen == 0)
412 for_each_cmsghdr(cmsg, msg) {
413 if (!CMSG_OK(msg, cmsg))
416 len = cmsg->cmsg_len - sizeof(struct cmsghdr);
417 _debug("CMSG %d, %d, %d",
418 cmsg->cmsg_level, cmsg->cmsg_type, len);
420 if (cmsg->cmsg_level != SOL_RXRPC)
423 switch (cmsg->cmsg_type) {
424 case RXRPC_USER_CALL_ID:
425 if (msg->msg_flags & MSG_CMSG_COMPAT) {
426 if (len != sizeof(u32))
428 p->call.user_call_ID = *(u32 *)CMSG_DATA(cmsg);
430 if (len != sizeof(unsigned long))
432 p->call.user_call_ID = *(unsigned long *)
439 if (p->command != RXRPC_CMD_SEND_DATA)
441 p->command = RXRPC_CMD_SEND_ABORT;
442 if (len != sizeof(p->abort_code))
444 p->abort_code = *(unsigned int *)CMSG_DATA(cmsg);
445 if (p->abort_code == 0)
449 case RXRPC_CHARGE_ACCEPT:
450 if (p->command != RXRPC_CMD_SEND_DATA)
452 p->command = RXRPC_CMD_CHARGE_ACCEPT;
457 case RXRPC_EXCLUSIVE_CALL:
463 case RXRPC_UPGRADE_SERVICE:
469 case RXRPC_TX_LENGTH:
470 if (p->call.tx_total_len != -1 || len != sizeof(__s64))
472 p->call.tx_total_len = *(__s64 *)CMSG_DATA(cmsg);
473 if (p->call.tx_total_len < 0)
477 case RXRPC_SET_CALL_TIMEOUT:
478 if (len & 3 || len < 4 || len > 12)
480 memcpy(&p->call.timeouts, CMSG_DATA(cmsg), len);
481 p->call.nr_timeouts = len / 4;
482 if (p->call.timeouts.hard > INT_MAX / HZ)
484 if (p->call.nr_timeouts >= 2 && p->call.timeouts.idle > 60 * 60 * 1000)
486 if (p->call.nr_timeouts >= 3 && p->call.timeouts.normal > 60 * 60 * 1000)
497 if (p->call.tx_total_len != -1 && p->command != RXRPC_CMD_SEND_DATA)
504 * Create a new client call for sendmsg().
505 * - Called with the socket lock held, which it must release.
506 * - If it returns a call, the call's lock will need releasing by the caller.
508 static struct rxrpc_call *
509 rxrpc_new_client_call_for_sendmsg(struct rxrpc_sock *rx, struct msghdr *msg,
510 struct rxrpc_send_params *p)
511 __releases(&rx->sk.sk_lock.slock)
512 __acquires(&call->user_mutex)
514 struct rxrpc_conn_parameters cp;
515 struct rxrpc_call *call;
518 DECLARE_SOCKADDR(struct sockaddr_rxrpc *, srx, msg->msg_name);
522 if (!msg->msg_name) {
523 release_sock(&rx->sk);
524 return ERR_PTR(-EDESTADDRREQ);
528 if (key && !rx->key->payload.data[0])
531 memset(&cp, 0, sizeof(cp));
532 cp.local = rx->local;
534 cp.security_level = rx->min_sec_level;
535 cp.exclusive = rx->exclusive | p->exclusive;
536 cp.upgrade = p->upgrade;
537 cp.service_id = srx->srx_service;
538 call = rxrpc_new_client_call(rx, &cp, srx, &p->call, GFP_KERNEL,
539 atomic_inc_return(&rxrpc_debug_id));
540 /* The socket is now unlocked */
542 _leave(" = %p\n", call);
547 * send a message forming part of a client call through an RxRPC socket
548 * - caller holds the socket locked
549 * - the socket may be either a client socket or a server socket
551 int rxrpc_do_sendmsg(struct rxrpc_sock *rx, struct msghdr *msg, size_t len)
552 __releases(&rx->sk.sk_lock.slock)
554 struct rxrpc_call *call;
555 unsigned long now, j;
556 bool dropped_lock = false;
559 struct rxrpc_send_params p = {
560 .call.tx_total_len = -1,
561 .call.user_call_ID = 0,
562 .call.nr_timeouts = 0,
563 .call.interruptibility = RXRPC_INTERRUPTIBLE,
565 .command = RXRPC_CMD_SEND_DATA,
572 ret = rxrpc_sendmsg_cmsg(msg, &p);
574 goto error_release_sock;
576 if (p.command == RXRPC_CMD_CHARGE_ACCEPT) {
578 if (rx->sk.sk_state != RXRPC_SERVER_LISTENING)
579 goto error_release_sock;
580 ret = rxrpc_user_charge_accept(rx, p.call.user_call_ID);
581 goto error_release_sock;
584 call = rxrpc_find_call_by_user_ID(rx, p.call.user_call_ID);
587 if (p.command != RXRPC_CMD_SEND_DATA)
588 goto error_release_sock;
589 call = rxrpc_new_client_call_for_sendmsg(rx, msg, &p);
590 /* The socket is now unlocked... */
592 return PTR_ERR(call);
593 /* ... and we have the call lock. */
595 if (rxrpc_call_is_complete(call))
598 switch (rxrpc_call_state(call)) {
599 case RXRPC_CALL_UNINITIALISED:
600 case RXRPC_CALL_CLIENT_AWAIT_CONN:
601 case RXRPC_CALL_SERVER_PREALLOC:
602 case RXRPC_CALL_SERVER_SECURING:
603 rxrpc_put_call(call, rxrpc_call_put_sendmsg);
605 goto error_release_sock;
610 ret = mutex_lock_interruptible(&call->user_mutex);
611 release_sock(&rx->sk);
617 if (p.call.tx_total_len != -1) {
619 if (call->tx_total_len != -1 ||
623 call->tx_total_len = p.call.tx_total_len;
627 switch (p.call.nr_timeouts) {
629 j = msecs_to_jiffies(p.call.timeouts.normal);
630 if (p.call.timeouts.normal > 0 && j == 0)
632 WRITE_ONCE(call->next_rx_timo, j);
635 j = msecs_to_jiffies(p.call.timeouts.idle);
636 if (p.call.timeouts.idle > 0 && j == 0)
638 WRITE_ONCE(call->next_req_timo, j);
641 if (p.call.timeouts.hard > 0) {
642 j = msecs_to_jiffies(p.call.timeouts.hard);
645 WRITE_ONCE(call->expect_term_by, j);
646 rxrpc_reduce_call_timer(call, j, now,
647 rxrpc_timer_set_for_hard);
652 if (rxrpc_call_is_complete(call)) {
653 /* it's too late for this call */
655 } else if (p.command == RXRPC_CMD_SEND_ABORT) {
656 rxrpc_propose_abort(call, p.abort_code, -ECONNABORTED,
657 rxrpc_abort_call_sendmsg);
659 } else if (p.command != RXRPC_CMD_SEND_DATA) {
662 ret = rxrpc_send_data(rx, call, msg, len, NULL, &dropped_lock);
667 mutex_unlock(&call->user_mutex);
669 rxrpc_put_call(call, rxrpc_call_put_sendmsg);
670 _leave(" = %d", ret);
674 release_sock(&rx->sk);
679 * rxrpc_kernel_send_data - Allow a kernel service to send data on a call
680 * @sock: The socket the call is on
681 * @call: The call to send data through
682 * @msg: The data to send
683 * @len: The amount of data to send
684 * @notify_end_tx: Notification that the last packet is queued.
686 * Allow a kernel service to send data on a call. The call must be in an state
687 * appropriate to sending data. No control data should be supplied in @msg,
688 * nor should an address be supplied. MSG_MORE should be flagged if there's
689 * more data to come, otherwise this data will end the transmission phase.
691 int rxrpc_kernel_send_data(struct socket *sock, struct rxrpc_call *call,
692 struct msghdr *msg, size_t len,
693 rxrpc_notify_end_tx_t notify_end_tx)
695 bool dropped_lock = false;
698 _enter("{%d},", call->debug_id);
700 ASSERTCMP(msg->msg_name, ==, NULL);
701 ASSERTCMP(msg->msg_control, ==, NULL);
703 mutex_lock(&call->user_mutex);
705 ret = rxrpc_send_data(rxrpc_sk(sock->sk), call, msg, len,
706 notify_end_tx, &dropped_lock);
707 if (ret == -ESHUTDOWN)
711 mutex_unlock(&call->user_mutex);
712 _leave(" = %d", ret);
715 EXPORT_SYMBOL(rxrpc_kernel_send_data);
718 * rxrpc_kernel_abort_call - Allow a kernel service to abort a call
719 * @sock: The socket the call is on
720 * @call: The call to be aborted
721 * @abort_code: The abort code to stick into the ABORT packet
722 * @error: Local error value
723 * @why: Indication as to why.
725 * Allow a kernel service to abort a call, if it's still in an abortable state
726 * and return true if the call was aborted, false if it was already complete.
728 bool rxrpc_kernel_abort_call(struct socket *sock, struct rxrpc_call *call,
729 u32 abort_code, int error, enum rxrpc_abort_reason why)
733 _enter("{%d},%d,%d,%u", call->debug_id, abort_code, error, why);
735 mutex_lock(&call->user_mutex);
736 aborted = rxrpc_propose_abort(call, abort_code, error, why);
737 mutex_unlock(&call->user_mutex);
740 EXPORT_SYMBOL(rxrpc_kernel_abort_call);
743 * rxrpc_kernel_set_tx_length - Set the total Tx length on a call
744 * @sock: The socket the call is on
745 * @call: The call to be informed
746 * @tx_total_len: The amount of data to be transmitted for this call
748 * Allow a kernel service to set the total transmit length on a call. This
749 * allows buffer-to-packet encrypt-and-copy to be performed.
751 * This function is primarily for use for setting the reply length since the
752 * request length can be set when beginning the call.
754 void rxrpc_kernel_set_tx_length(struct socket *sock, struct rxrpc_call *call,
757 WARN_ON(call->tx_total_len != -1);
758 call->tx_total_len = tx_total_len;
760 EXPORT_SYMBOL(rxrpc_kernel_set_tx_length);