Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/* RxRPC recvmsg() implementation
3 *
4 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
5 * Written by David Howells (dhowells@redhat.com)
6 */
7
8#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9
10#include <linux/net.h>
11#include <linux/skbuff.h>
12#include <linux/export.h>
13#include <linux/sched/signal.h>
14
15#include <net/sock.h>
16#include <net/af_rxrpc.h>
17#include "ar-internal.h"
18
19/*
20 * Post a call for attention by the socket or kernel service. Further
21 * notifications are suppressed by putting recvmsg_link on a dummy queue.
22 */
23void rxrpc_notify_socket(struct rxrpc_call *call)
24{
25 struct rxrpc_sock *rx;
26 struct sock *sk;
27
28 _enter("%d", call->debug_id);
29
30 if (!list_empty(&call->recvmsg_link))
31 return;
32
33 rcu_read_lock();
34
35 rx = rcu_dereference(call->socket);
36 sk = &rx->sk;
37 if (rx && sk->sk_state < RXRPC_CLOSE) {
38 if (call->notify_rx) {
39 spin_lock_bh(&call->notify_lock);
40 call->notify_rx(sk, call, call->user_call_ID);
41 spin_unlock_bh(&call->notify_lock);
42 } else {
43 write_lock_bh(&rx->recvmsg_lock);
44 if (list_empty(&call->recvmsg_link)) {
45 rxrpc_get_call(call, rxrpc_call_got);
46 list_add_tail(&call->recvmsg_link, &rx->recvmsg_q);
47 }
48 write_unlock_bh(&rx->recvmsg_lock);
49
50 if (!sock_flag(sk, SOCK_DEAD)) {
51 _debug("call %ps", sk->sk_data_ready);
52 sk->sk_data_ready(sk);
53 }
54 }
55 }
56
57 rcu_read_unlock();
58 _leave("");
59}
60
61/*
62 * Transition a call to the complete state.
63 */
64bool __rxrpc_set_call_completion(struct rxrpc_call *call,
65 enum rxrpc_call_completion compl,
66 u32 abort_code,
67 int error)
68{
69 if (call->state < RXRPC_CALL_COMPLETE) {
70 call->abort_code = abort_code;
71 call->error = error;
72 call->completion = compl,
73 call->state = RXRPC_CALL_COMPLETE;
74 trace_rxrpc_call_complete(call);
75 wake_up(&call->waitq);
76 rxrpc_notify_socket(call);
77 return true;
78 }
79 return false;
80}
81
82bool rxrpc_set_call_completion(struct rxrpc_call *call,
83 enum rxrpc_call_completion compl,
84 u32 abort_code,
85 int error)
86{
87 bool ret = false;
88
89 if (call->state < RXRPC_CALL_COMPLETE) {
90 write_lock_bh(&call->state_lock);
91 ret = __rxrpc_set_call_completion(call, compl, abort_code, error);
92 write_unlock_bh(&call->state_lock);
93 }
94 return ret;
95}
96
97/*
98 * Record that a call successfully completed.
99 */
100bool __rxrpc_call_completed(struct rxrpc_call *call)
101{
102 return __rxrpc_set_call_completion(call, RXRPC_CALL_SUCCEEDED, 0, 0);
103}
104
105bool rxrpc_call_completed(struct rxrpc_call *call)
106{
107 bool ret = false;
108
109 if (call->state < RXRPC_CALL_COMPLETE) {
110 write_lock_bh(&call->state_lock);
111 ret = __rxrpc_call_completed(call);
112 write_unlock_bh(&call->state_lock);
113 }
114 return ret;
115}
116
117/*
118 * Record that a call is locally aborted.
119 */
120bool __rxrpc_abort_call(const char *why, struct rxrpc_call *call,
121 rxrpc_seq_t seq, u32 abort_code, int error)
122{
123 trace_rxrpc_abort(call->debug_id, why, call->cid, call->call_id, seq,
124 abort_code, error);
125 return __rxrpc_set_call_completion(call, RXRPC_CALL_LOCALLY_ABORTED,
126 abort_code, error);
127}
128
129bool rxrpc_abort_call(const char *why, struct rxrpc_call *call,
130 rxrpc_seq_t seq, u32 abort_code, int error)
131{
132 bool ret;
133
134 write_lock_bh(&call->state_lock);
135 ret = __rxrpc_abort_call(why, call, seq, abort_code, error);
136 write_unlock_bh(&call->state_lock);
137 return ret;
138}
139
140/*
141 * Pass a call terminating message to userspace.
142 */
143static int rxrpc_recvmsg_term(struct rxrpc_call *call, struct msghdr *msg)
144{
145 u32 tmp = 0;
146 int ret;
147
148 switch (call->completion) {
149 case RXRPC_CALL_SUCCEEDED:
150 ret = 0;
151 if (rxrpc_is_service_call(call))
152 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_ACK, 0, &tmp);
153 break;
154 case RXRPC_CALL_REMOTELY_ABORTED:
155 tmp = call->abort_code;
156 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_ABORT, 4, &tmp);
157 break;
158 case RXRPC_CALL_LOCALLY_ABORTED:
159 tmp = call->abort_code;
160 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_ABORT, 4, &tmp);
161 break;
162 case RXRPC_CALL_NETWORK_ERROR:
163 tmp = -call->error;
164 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_NET_ERROR, 4, &tmp);
165 break;
166 case RXRPC_CALL_LOCAL_ERROR:
167 tmp = -call->error;
168 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_LOCAL_ERROR, 4, &tmp);
169 break;
170 default:
171 pr_err("Invalid terminal call state %u\n", call->state);
172 BUG();
173 break;
174 }
175
176 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_terminal, call->rx_hard_ack,
177 call->rx_pkt_offset, call->rx_pkt_len, ret);
178 return ret;
179}
180
181/*
182 * End the packet reception phase.
183 */
184static void rxrpc_end_rx_phase(struct rxrpc_call *call, rxrpc_serial_t serial)
185{
186 _enter("%d,%s", call->debug_id, rxrpc_call_states[call->state]);
187
188 trace_rxrpc_receive(call, rxrpc_receive_end, 0, call->rx_top);
189 ASSERTCMP(call->rx_hard_ack, ==, call->rx_top);
190
191 if (call->state == RXRPC_CALL_CLIENT_RECV_REPLY) {
192 rxrpc_propose_ACK(call, RXRPC_ACK_IDLE, serial, false, true,
193 rxrpc_propose_ack_terminal_ack);
194 //rxrpc_send_ack_packet(call, false, NULL);
195 }
196
197 write_lock_bh(&call->state_lock);
198
199 switch (call->state) {
200 case RXRPC_CALL_CLIENT_RECV_REPLY:
201 __rxrpc_call_completed(call);
202 write_unlock_bh(&call->state_lock);
203 break;
204
205 case RXRPC_CALL_SERVER_RECV_REQUEST:
206 call->tx_phase = true;
207 call->state = RXRPC_CALL_SERVER_ACK_REQUEST;
208 call->expect_req_by = jiffies + MAX_JIFFY_OFFSET;
209 write_unlock_bh(&call->state_lock);
210 rxrpc_propose_ACK(call, RXRPC_ACK_DELAY, serial, false, true,
211 rxrpc_propose_ack_processing_op);
212 break;
213 default:
214 write_unlock_bh(&call->state_lock);
215 break;
216 }
217}
218
219/*
220 * Discard a packet we've used up and advance the Rx window by one.
221 */
222static void rxrpc_rotate_rx_window(struct rxrpc_call *call)
223{
224 struct rxrpc_skb_priv *sp;
225 struct sk_buff *skb;
226 rxrpc_serial_t serial;
227 rxrpc_seq_t hard_ack, top;
228 bool last = false;
229 u8 subpacket;
230 int ix;
231
232 _enter("%d", call->debug_id);
233
234 hard_ack = call->rx_hard_ack;
235 top = smp_load_acquire(&call->rx_top);
236 ASSERT(before(hard_ack, top));
237
238 hard_ack++;
239 ix = hard_ack & RXRPC_RXTX_BUFF_MASK;
240 skb = call->rxtx_buffer[ix];
241 rxrpc_see_skb(skb, rxrpc_skb_rotated);
242 sp = rxrpc_skb(skb);
243
244 subpacket = call->rxtx_annotations[ix] & RXRPC_RX_ANNO_SUBPACKET;
245 serial = sp->hdr.serial + subpacket;
246
247 if (subpacket == sp->nr_subpackets - 1 &&
248 sp->rx_flags & RXRPC_SKB_INCL_LAST)
249 last = true;
250
251 call->rxtx_buffer[ix] = NULL;
252 call->rxtx_annotations[ix] = 0;
253 /* Barrier against rxrpc_input_data(). */
254 smp_store_release(&call->rx_hard_ack, hard_ack);
255
256 rxrpc_free_skb(skb, rxrpc_skb_freed);
257
258 trace_rxrpc_receive(call, rxrpc_receive_rotate, serial, hard_ack);
259 if (last) {
260 rxrpc_end_rx_phase(call, serial);
261 } else {
262 /* Check to see if there's an ACK that needs sending. */
263 if (after_eq(hard_ack, call->ackr_consumed + 2) ||
264 after_eq(top, call->ackr_seen + 2) ||
265 (hard_ack == top && after(hard_ack, call->ackr_consumed)))
266 rxrpc_propose_ACK(call, RXRPC_ACK_DELAY, serial,
267 true, true,
268 rxrpc_propose_ack_rotate_rx);
269 if (call->ackr_reason && call->ackr_reason != RXRPC_ACK_DELAY)
270 rxrpc_send_ack_packet(call, false, NULL);
271 }
272}
273
274/*
275 * Decrypt and verify a (sub)packet. The packet's length may be changed due to
276 * padding, but if this is the case, the packet length will be resident in the
277 * socket buffer. Note that we can't modify the master skb info as the skb may
278 * be the home to multiple subpackets.
279 */
280static int rxrpc_verify_packet(struct rxrpc_call *call, struct sk_buff *skb,
281 u8 annotation,
282 unsigned int offset, unsigned int len)
283{
284 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
285 rxrpc_seq_t seq = sp->hdr.seq;
286 u16 cksum = sp->hdr.cksum;
287 u8 subpacket = annotation & RXRPC_RX_ANNO_SUBPACKET;
288
289 _enter("");
290
291 /* For all but the head jumbo subpacket, the security checksum is in a
292 * jumbo header immediately prior to the data.
293 */
294 if (subpacket > 0) {
295 __be16 tmp;
296 if (skb_copy_bits(skb, offset - 2, &tmp, 2) < 0)
297 BUG();
298 cksum = ntohs(tmp);
299 seq += subpacket;
300 }
301
302 return call->security->verify_packet(call, skb, offset, len,
303 seq, cksum);
304}
305
306/*
307 * Locate the data within a packet. This is complicated by:
308 *
309 * (1) An skb may contain a jumbo packet - so we have to find the appropriate
310 * subpacket.
311 *
312 * (2) The (sub)packets may be encrypted and, if so, the encrypted portion
313 * contains an extra header which includes the true length of the data,
314 * excluding any encrypted padding.
315 */
316static int rxrpc_locate_data(struct rxrpc_call *call, struct sk_buff *skb,
317 u8 *_annotation,
318 unsigned int *_offset, unsigned int *_len,
319 bool *_last)
320{
321 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
322 unsigned int offset = sizeof(struct rxrpc_wire_header);
323 unsigned int len;
324 bool last = false;
325 int ret;
326 u8 annotation = *_annotation;
327 u8 subpacket = annotation & RXRPC_RX_ANNO_SUBPACKET;
328
329 /* Locate the subpacket */
330 offset += subpacket * RXRPC_JUMBO_SUBPKTLEN;
331 len = skb->len - offset;
332 if (subpacket < sp->nr_subpackets - 1)
333 len = RXRPC_JUMBO_DATALEN;
334 else if (sp->rx_flags & RXRPC_SKB_INCL_LAST)
335 last = true;
336
337 if (!(annotation & RXRPC_RX_ANNO_VERIFIED)) {
338 ret = rxrpc_verify_packet(call, skb, annotation, offset, len);
339 if (ret < 0)
340 return ret;
341 *_annotation |= RXRPC_RX_ANNO_VERIFIED;
342 }
343
344 *_offset = offset;
345 *_len = len;
346 *_last = last;
347 call->security->locate_data(call, skb, _offset, _len);
348 return 0;
349}
350
351/*
352 * Deliver messages to a call. This keeps processing packets until the buffer
353 * is filled and we find either more DATA (returns 0) or the end of the DATA
354 * (returns 1). If more packets are required, it returns -EAGAIN.
355 */
356static int rxrpc_recvmsg_data(struct socket *sock, struct rxrpc_call *call,
357 struct msghdr *msg, struct iov_iter *iter,
358 size_t len, int flags, size_t *_offset)
359{
360 struct rxrpc_skb_priv *sp;
361 struct sk_buff *skb;
362 rxrpc_serial_t serial;
363 rxrpc_seq_t hard_ack, top, seq;
364 size_t remain;
365 bool rx_pkt_last;
366 unsigned int rx_pkt_offset, rx_pkt_len;
367 int ix, copy, ret = -EAGAIN, ret2;
368
369 if (test_and_clear_bit(RXRPC_CALL_RX_UNDERRUN, &call->flags) &&
370 call->ackr_reason)
371 rxrpc_send_ack_packet(call, false, NULL);
372
373 rx_pkt_offset = call->rx_pkt_offset;
374 rx_pkt_len = call->rx_pkt_len;
375 rx_pkt_last = call->rx_pkt_last;
376
377 if (call->state >= RXRPC_CALL_SERVER_ACK_REQUEST) {
378 seq = call->rx_hard_ack;
379 ret = 1;
380 goto done;
381 }
382
383 /* Barriers against rxrpc_input_data(). */
384 hard_ack = call->rx_hard_ack;
385 seq = hard_ack + 1;
386
387 while (top = smp_load_acquire(&call->rx_top),
388 before_eq(seq, top)
389 ) {
390 ix = seq & RXRPC_RXTX_BUFF_MASK;
391 skb = call->rxtx_buffer[ix];
392 if (!skb) {
393 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_hole, seq,
394 rx_pkt_offset, rx_pkt_len, 0);
395 break;
396 }
397 smp_rmb();
398 rxrpc_see_skb(skb, rxrpc_skb_seen);
399 sp = rxrpc_skb(skb);
400
401 if (!(flags & MSG_PEEK)) {
402 serial = sp->hdr.serial;
403 serial += call->rxtx_annotations[ix] & RXRPC_RX_ANNO_SUBPACKET;
404 trace_rxrpc_receive(call, rxrpc_receive_front,
405 serial, seq);
406 }
407
408 if (msg)
409 sock_recv_timestamp(msg, sock->sk, skb);
410
411 if (rx_pkt_offset == 0) {
412 ret2 = rxrpc_locate_data(call, skb,
413 &call->rxtx_annotations[ix],
414 &rx_pkt_offset, &rx_pkt_len,
415 &rx_pkt_last);
416 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_next, seq,
417 rx_pkt_offset, rx_pkt_len, ret2);
418 if (ret2 < 0) {
419 ret = ret2;
420 goto out;
421 }
422 } else {
423 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_cont, seq,
424 rx_pkt_offset, rx_pkt_len, 0);
425 }
426
427 /* We have to handle short, empty and used-up DATA packets. */
428 remain = len - *_offset;
429 copy = rx_pkt_len;
430 if (copy > remain)
431 copy = remain;
432 if (copy > 0) {
433 ret2 = skb_copy_datagram_iter(skb, rx_pkt_offset, iter,
434 copy);
435 if (ret2 < 0) {
436 ret = ret2;
437 goto out;
438 }
439
440 /* handle piecemeal consumption of data packets */
441 rx_pkt_offset += copy;
442 rx_pkt_len -= copy;
443 *_offset += copy;
444 }
445
446 if (rx_pkt_len > 0) {
447 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_full, seq,
448 rx_pkt_offset, rx_pkt_len, 0);
449 ASSERTCMP(*_offset, ==, len);
450 ret = 0;
451 break;
452 }
453
454 /* The whole packet has been transferred. */
455 if (!(flags & MSG_PEEK))
456 rxrpc_rotate_rx_window(call);
457 rx_pkt_offset = 0;
458 rx_pkt_len = 0;
459
460 if (rx_pkt_last) {
461 ASSERTCMP(seq, ==, READ_ONCE(call->rx_top));
462 ret = 1;
463 goto out;
464 }
465
466 seq++;
467 }
468
469out:
470 if (!(flags & MSG_PEEK)) {
471 call->rx_pkt_offset = rx_pkt_offset;
472 call->rx_pkt_len = rx_pkt_len;
473 call->rx_pkt_last = rx_pkt_last;
474 }
475done:
476 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_data_return, seq,
477 rx_pkt_offset, rx_pkt_len, ret);
478 if (ret == -EAGAIN)
479 set_bit(RXRPC_CALL_RX_UNDERRUN, &call->flags);
480 return ret;
481}
482
483/*
484 * Receive a message from an RxRPC socket
485 * - we need to be careful about two or more threads calling recvmsg
486 * simultaneously
487 */
488int rxrpc_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
489 int flags)
490{
491 struct rxrpc_call *call;
492 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
493 struct list_head *l;
494 size_t copied = 0;
495 long timeo;
496 int ret;
497
498 DEFINE_WAIT(wait);
499
500 trace_rxrpc_recvmsg(NULL, rxrpc_recvmsg_enter, 0, 0, 0, 0);
501
502 if (flags & (MSG_OOB | MSG_TRUNC))
503 return -EOPNOTSUPP;
504
505 timeo = sock_rcvtimeo(&rx->sk, flags & MSG_DONTWAIT);
506
507try_again:
508 lock_sock(&rx->sk);
509
510 /* Return immediately if a client socket has no outstanding calls */
511 if (RB_EMPTY_ROOT(&rx->calls) &&
512 list_empty(&rx->recvmsg_q) &&
513 rx->sk.sk_state != RXRPC_SERVER_LISTENING) {
514 release_sock(&rx->sk);
515 return -EAGAIN;
516 }
517
518 if (list_empty(&rx->recvmsg_q)) {
519 ret = -EWOULDBLOCK;
520 if (timeo == 0) {
521 call = NULL;
522 goto error_no_call;
523 }
524
525 release_sock(&rx->sk);
526
527 /* Wait for something to happen */
528 prepare_to_wait_exclusive(sk_sleep(&rx->sk), &wait,
529 TASK_INTERRUPTIBLE);
530 ret = sock_error(&rx->sk);
531 if (ret)
532 goto wait_error;
533
534 if (list_empty(&rx->recvmsg_q)) {
535 if (signal_pending(current))
536 goto wait_interrupted;
537 trace_rxrpc_recvmsg(NULL, rxrpc_recvmsg_wait,
538 0, 0, 0, 0);
539 timeo = schedule_timeout(timeo);
540 }
541 finish_wait(sk_sleep(&rx->sk), &wait);
542 goto try_again;
543 }
544
545 /* Find the next call and dequeue it if we're not just peeking. If we
546 * do dequeue it, that comes with a ref that we will need to release.
547 */
548 write_lock_bh(&rx->recvmsg_lock);
549 l = rx->recvmsg_q.next;
550 call = list_entry(l, struct rxrpc_call, recvmsg_link);
551 if (!(flags & MSG_PEEK))
552 list_del_init(&call->recvmsg_link);
553 else
554 rxrpc_get_call(call, rxrpc_call_got);
555 write_unlock_bh(&rx->recvmsg_lock);
556
557 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_dequeue, 0, 0, 0, 0);
558
559 /* We're going to drop the socket lock, so we need to lock the call
560 * against interference by sendmsg.
561 */
562 if (!mutex_trylock(&call->user_mutex)) {
563 ret = -EWOULDBLOCK;
564 if (flags & MSG_DONTWAIT)
565 goto error_requeue_call;
566 ret = -ERESTARTSYS;
567 if (mutex_lock_interruptible(&call->user_mutex) < 0)
568 goto error_requeue_call;
569 }
570
571 release_sock(&rx->sk);
572
573 if (test_bit(RXRPC_CALL_RELEASED, &call->flags))
574 BUG();
575
576 if (test_bit(RXRPC_CALL_HAS_USERID, &call->flags)) {
577 if (flags & MSG_CMSG_COMPAT) {
578 unsigned int id32 = call->user_call_ID;
579
580 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_USER_CALL_ID,
581 sizeof(unsigned int), &id32);
582 } else {
583 unsigned long idl = call->user_call_ID;
584
585 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_USER_CALL_ID,
586 sizeof(unsigned long), &idl);
587 }
588 if (ret < 0)
589 goto error_unlock_call;
590 }
591
592 if (msg->msg_name && call->peer) {
593 struct sockaddr_rxrpc *srx = msg->msg_name;
594 size_t len = sizeof(call->peer->srx);
595
596 memcpy(msg->msg_name, &call->peer->srx, len);
597 srx->srx_service = call->service_id;
598 msg->msg_namelen = len;
599 }
600
601 switch (READ_ONCE(call->state)) {
602 case RXRPC_CALL_CLIENT_RECV_REPLY:
603 case RXRPC_CALL_SERVER_RECV_REQUEST:
604 case RXRPC_CALL_SERVER_ACK_REQUEST:
605 ret = rxrpc_recvmsg_data(sock, call, msg, &msg->msg_iter, len,
606 flags, &copied);
607 if (ret == -EAGAIN)
608 ret = 0;
609
610 if (after(call->rx_top, call->rx_hard_ack) &&
611 call->rxtx_buffer[(call->rx_hard_ack + 1) & RXRPC_RXTX_BUFF_MASK])
612 rxrpc_notify_socket(call);
613 break;
614 default:
615 ret = 0;
616 break;
617 }
618
619 if (ret < 0)
620 goto error_unlock_call;
621
622 if (call->state == RXRPC_CALL_COMPLETE) {
623 ret = rxrpc_recvmsg_term(call, msg);
624 if (ret < 0)
625 goto error_unlock_call;
626 if (!(flags & MSG_PEEK))
627 rxrpc_release_call(rx, call);
628 msg->msg_flags |= MSG_EOR;
629 ret = 1;
630 }
631
632 if (ret == 0)
633 msg->msg_flags |= MSG_MORE;
634 else
635 msg->msg_flags &= ~MSG_MORE;
636 ret = copied;
637
638error_unlock_call:
639 mutex_unlock(&call->user_mutex);
640 rxrpc_put_call(call, rxrpc_call_put);
641 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_return, 0, 0, 0, ret);
642 return ret;
643
644error_requeue_call:
645 if (!(flags & MSG_PEEK)) {
646 write_lock_bh(&rx->recvmsg_lock);
647 list_add(&call->recvmsg_link, &rx->recvmsg_q);
648 write_unlock_bh(&rx->recvmsg_lock);
649 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_requeue, 0, 0, 0, 0);
650 } else {
651 rxrpc_put_call(call, rxrpc_call_put);
652 }
653error_no_call:
654 release_sock(&rx->sk);
655error_trace:
656 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_return, 0, 0, 0, ret);
657 return ret;
658
659wait_interrupted:
660 ret = sock_intr_errno(timeo);
661wait_error:
662 finish_wait(sk_sleep(&rx->sk), &wait);
663 call = NULL;
664 goto error_trace;
665}
666
667/**
668 * rxrpc_kernel_recv_data - Allow a kernel service to receive data/info
669 * @sock: The socket that the call exists on
670 * @call: The call to send data through
671 * @iter: The buffer to receive into
672 * @want_more: True if more data is expected to be read
673 * @_abort: Where the abort code is stored if -ECONNABORTED is returned
674 * @_service: Where to store the actual service ID (may be upgraded)
675 *
676 * Allow a kernel service to receive data and pick up information about the
677 * state of a call. Returns 0 if got what was asked for and there's more
678 * available, 1 if we got what was asked for and we're at the end of the data
679 * and -EAGAIN if we need more data.
680 *
681 * Note that we may return -EAGAIN to drain empty packets at the end of the
682 * data, even if we've already copied over the requested data.
683 *
684 * *_abort should also be initialised to 0.
685 */
686int rxrpc_kernel_recv_data(struct socket *sock, struct rxrpc_call *call,
687 struct iov_iter *iter,
688 bool want_more, u32 *_abort, u16 *_service)
689{
690 size_t offset = 0;
691 int ret;
692
693 _enter("{%d,%s},%zu,%d",
694 call->debug_id, rxrpc_call_states[call->state],
695 iov_iter_count(iter), want_more);
696
697 ASSERTCMP(call->state, !=, RXRPC_CALL_SERVER_SECURING);
698
699 mutex_lock(&call->user_mutex);
700
701 switch (READ_ONCE(call->state)) {
702 case RXRPC_CALL_CLIENT_RECV_REPLY:
703 case RXRPC_CALL_SERVER_RECV_REQUEST:
704 case RXRPC_CALL_SERVER_ACK_REQUEST:
705 ret = rxrpc_recvmsg_data(sock, call, NULL, iter,
706 iov_iter_count(iter), 0,
707 &offset);
708 if (ret < 0)
709 goto out;
710
711 /* We can only reach here with a partially full buffer if we
712 * have reached the end of the data. We must otherwise have a
713 * full buffer or have been given -EAGAIN.
714 */
715 if (ret == 1) {
716 if (iov_iter_count(iter) > 0)
717 goto short_data;
718 if (!want_more)
719 goto read_phase_complete;
720 ret = 0;
721 goto out;
722 }
723
724 if (!want_more)
725 goto excess_data;
726 goto out;
727
728 case RXRPC_CALL_COMPLETE:
729 goto call_complete;
730
731 default:
732 ret = -EINPROGRESS;
733 goto out;
734 }
735
736read_phase_complete:
737 ret = 1;
738out:
739 switch (call->ackr_reason) {
740 case RXRPC_ACK_IDLE:
741 break;
742 case RXRPC_ACK_DELAY:
743 if (ret != -EAGAIN)
744 break;
745 fallthrough;
746 default:
747 rxrpc_send_ack_packet(call, false, NULL);
748 }
749
750 if (_service)
751 *_service = call->service_id;
752 mutex_unlock(&call->user_mutex);
753 _leave(" = %d [%zu,%d]", ret, iov_iter_count(iter), *_abort);
754 return ret;
755
756short_data:
757 trace_rxrpc_rx_eproto(call, 0, tracepoint_string("short_data"));
758 ret = -EBADMSG;
759 goto out;
760excess_data:
761 trace_rxrpc_rx_eproto(call, 0, tracepoint_string("excess_data"));
762 ret = -EMSGSIZE;
763 goto out;
764call_complete:
765 *_abort = call->abort_code;
766 ret = call->error;
767 if (call->completion == RXRPC_CALL_SUCCEEDED) {
768 ret = 1;
769 if (iov_iter_count(iter) > 0)
770 ret = -ECONNRESET;
771 }
772 goto out;
773}
774EXPORT_SYMBOL(rxrpc_kernel_recv_data);
775
776/**
777 * rxrpc_kernel_get_reply_time - Get timestamp on first reply packet
778 * @sock: The socket that the call exists on
779 * @call: The call to query
780 * @_ts: Where to put the timestamp
781 *
782 * Retrieve the timestamp from the first DATA packet of the reply if it is
783 * in the ring. Returns true if successful, false if not.
784 */
785bool rxrpc_kernel_get_reply_time(struct socket *sock, struct rxrpc_call *call,
786 ktime_t *_ts)
787{
788 struct sk_buff *skb;
789 rxrpc_seq_t hard_ack, top, seq;
790 bool success = false;
791
792 mutex_lock(&call->user_mutex);
793
794 if (READ_ONCE(call->state) != RXRPC_CALL_CLIENT_RECV_REPLY)
795 goto out;
796
797 hard_ack = call->rx_hard_ack;
798 if (hard_ack != 0)
799 goto out;
800
801 seq = hard_ack + 1;
802 top = smp_load_acquire(&call->rx_top);
803 if (after(seq, top))
804 goto out;
805
806 skb = call->rxtx_buffer[seq & RXRPC_RXTX_BUFF_MASK];
807 if (!skb)
808 goto out;
809
810 *_ts = skb_get_ktime(skb);
811 success = true;
812
813out:
814 mutex_unlock(&call->user_mutex);
815 return success;
816}
817EXPORT_SYMBOL(rxrpc_kernel_get_reply_time);
1/* RxRPC recvmsg() implementation
2 *
3 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
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.
10 */
11
12#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13
14#include <linux/net.h>
15#include <linux/skbuff.h>
16#include <linux/export.h>
17#include <linux/sched/signal.h>
18
19#include <net/sock.h>
20#include <net/af_rxrpc.h>
21#include "ar-internal.h"
22
23/*
24 * Post a call for attention by the socket or kernel service. Further
25 * notifications are suppressed by putting recvmsg_link on a dummy queue.
26 */
27void rxrpc_notify_socket(struct rxrpc_call *call)
28{
29 struct rxrpc_sock *rx;
30 struct sock *sk;
31
32 _enter("%d", call->debug_id);
33
34 if (!list_empty(&call->recvmsg_link))
35 return;
36
37 rcu_read_lock();
38
39 rx = rcu_dereference(call->socket);
40 sk = &rx->sk;
41 if (rx && sk->sk_state < RXRPC_CLOSE) {
42 if (call->notify_rx) {
43 spin_lock_bh(&call->notify_lock);
44 call->notify_rx(sk, call, call->user_call_ID);
45 spin_unlock_bh(&call->notify_lock);
46 } else {
47 write_lock_bh(&rx->recvmsg_lock);
48 if (list_empty(&call->recvmsg_link)) {
49 rxrpc_get_call(call, rxrpc_call_got);
50 list_add_tail(&call->recvmsg_link, &rx->recvmsg_q);
51 }
52 write_unlock_bh(&rx->recvmsg_lock);
53
54 if (!sock_flag(sk, SOCK_DEAD)) {
55 _debug("call %ps", sk->sk_data_ready);
56 sk->sk_data_ready(sk);
57 }
58 }
59 }
60
61 rcu_read_unlock();
62 _leave("");
63}
64
65/*
66 * Pass a call terminating message to userspace.
67 */
68static int rxrpc_recvmsg_term(struct rxrpc_call *call, struct msghdr *msg)
69{
70 u32 tmp = 0;
71 int ret;
72
73 switch (call->completion) {
74 case RXRPC_CALL_SUCCEEDED:
75 ret = 0;
76 if (rxrpc_is_service_call(call))
77 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_ACK, 0, &tmp);
78 break;
79 case RXRPC_CALL_REMOTELY_ABORTED:
80 tmp = call->abort_code;
81 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_ABORT, 4, &tmp);
82 break;
83 case RXRPC_CALL_LOCALLY_ABORTED:
84 tmp = call->abort_code;
85 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_ABORT, 4, &tmp);
86 break;
87 case RXRPC_CALL_NETWORK_ERROR:
88 tmp = -call->error;
89 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_NET_ERROR, 4, &tmp);
90 break;
91 case RXRPC_CALL_LOCAL_ERROR:
92 tmp = -call->error;
93 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_LOCAL_ERROR, 4, &tmp);
94 break;
95 default:
96 pr_err("Invalid terminal call state %u\n", call->state);
97 BUG();
98 break;
99 }
100
101 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_terminal, call->rx_hard_ack,
102 call->rx_pkt_offset, call->rx_pkt_len, ret);
103 return ret;
104}
105
106/*
107 * Pass back notification of a new call. The call is added to the
108 * to-be-accepted list. This means that the next call to be accepted might not
109 * be the last call seen awaiting acceptance, but unless we leave this on the
110 * front of the queue and block all other messages until someone gives us a
111 * user_ID for it, there's not a lot we can do.
112 */
113static int rxrpc_recvmsg_new_call(struct rxrpc_sock *rx,
114 struct rxrpc_call *call,
115 struct msghdr *msg, int flags)
116{
117 int tmp = 0, ret;
118
119 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_NEW_CALL, 0, &tmp);
120
121 if (ret == 0 && !(flags & MSG_PEEK)) {
122 _debug("to be accepted");
123 write_lock_bh(&rx->recvmsg_lock);
124 list_del_init(&call->recvmsg_link);
125 write_unlock_bh(&rx->recvmsg_lock);
126
127 rxrpc_get_call(call, rxrpc_call_got);
128 write_lock(&rx->call_lock);
129 list_add_tail(&call->accept_link, &rx->to_be_accepted);
130 write_unlock(&rx->call_lock);
131 }
132
133 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_to_be_accepted, 1, 0, 0, ret);
134 return ret;
135}
136
137/*
138 * End the packet reception phase.
139 */
140static void rxrpc_end_rx_phase(struct rxrpc_call *call, rxrpc_serial_t serial)
141{
142 _enter("%d,%s", call->debug_id, rxrpc_call_states[call->state]);
143
144 trace_rxrpc_receive(call, rxrpc_receive_end, 0, call->rx_top);
145 ASSERTCMP(call->rx_hard_ack, ==, call->rx_top);
146
147#if 0 // TODO: May want to transmit final ACK under some circumstances anyway
148 if (call->state == RXRPC_CALL_CLIENT_RECV_REPLY) {
149 rxrpc_propose_ACK(call, RXRPC_ACK_IDLE, 0, serial, true, false,
150 rxrpc_propose_ack_terminal_ack);
151 rxrpc_send_ack_packet(call, false, NULL);
152 }
153#endif
154
155 write_lock_bh(&call->state_lock);
156
157 switch (call->state) {
158 case RXRPC_CALL_CLIENT_RECV_REPLY:
159 __rxrpc_call_completed(call);
160 write_unlock_bh(&call->state_lock);
161 break;
162
163 case RXRPC_CALL_SERVER_RECV_REQUEST:
164 call->tx_phase = true;
165 call->state = RXRPC_CALL_SERVER_ACK_REQUEST;
166 call->expect_req_by = jiffies + MAX_JIFFY_OFFSET;
167 write_unlock_bh(&call->state_lock);
168 rxrpc_propose_ACK(call, RXRPC_ACK_DELAY, 0, serial, false, true,
169 rxrpc_propose_ack_processing_op);
170 break;
171 default:
172 write_unlock_bh(&call->state_lock);
173 break;
174 }
175}
176
177/*
178 * Discard a packet we've used up and advance the Rx window by one.
179 */
180static void rxrpc_rotate_rx_window(struct rxrpc_call *call)
181{
182 struct rxrpc_skb_priv *sp;
183 struct sk_buff *skb;
184 rxrpc_serial_t serial;
185 rxrpc_seq_t hard_ack, top;
186 u8 flags;
187 int ix;
188
189 _enter("%d", call->debug_id);
190
191 hard_ack = call->rx_hard_ack;
192 top = smp_load_acquire(&call->rx_top);
193 ASSERT(before(hard_ack, top));
194
195 hard_ack++;
196 ix = hard_ack & RXRPC_RXTX_BUFF_MASK;
197 skb = call->rxtx_buffer[ix];
198 rxrpc_see_skb(skb, rxrpc_skb_rx_rotated);
199 sp = rxrpc_skb(skb);
200 flags = sp->hdr.flags;
201 serial = sp->hdr.serial;
202 if (call->rxtx_annotations[ix] & RXRPC_RX_ANNO_JUMBO)
203 serial += (call->rxtx_annotations[ix] & RXRPC_RX_ANNO_JUMBO) - 1;
204
205 call->rxtx_buffer[ix] = NULL;
206 call->rxtx_annotations[ix] = 0;
207 /* Barrier against rxrpc_input_data(). */
208 smp_store_release(&call->rx_hard_ack, hard_ack);
209
210 rxrpc_free_skb(skb, rxrpc_skb_rx_freed);
211
212 _debug("%u,%u,%02x", hard_ack, top, flags);
213 trace_rxrpc_receive(call, rxrpc_receive_rotate, serial, hard_ack);
214 if (flags & RXRPC_LAST_PACKET) {
215 rxrpc_end_rx_phase(call, serial);
216 } else {
217 /* Check to see if there's an ACK that needs sending. */
218 if (after_eq(hard_ack, call->ackr_consumed + 2) ||
219 after_eq(top, call->ackr_seen + 2) ||
220 (hard_ack == top && after(hard_ack, call->ackr_consumed)))
221 rxrpc_propose_ACK(call, RXRPC_ACK_DELAY, 0, serial,
222 true, true,
223 rxrpc_propose_ack_rotate_rx);
224 if (call->ackr_reason && call->ackr_reason != RXRPC_ACK_DELAY)
225 rxrpc_send_ack_packet(call, false, NULL);
226 }
227}
228
229/*
230 * Decrypt and verify a (sub)packet. The packet's length may be changed due to
231 * padding, but if this is the case, the packet length will be resident in the
232 * socket buffer. Note that we can't modify the master skb info as the skb may
233 * be the home to multiple subpackets.
234 */
235static int rxrpc_verify_packet(struct rxrpc_call *call, struct sk_buff *skb,
236 u8 annotation,
237 unsigned int offset, unsigned int len)
238{
239 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
240 rxrpc_seq_t seq = sp->hdr.seq;
241 u16 cksum = sp->hdr.cksum;
242
243 _enter("");
244
245 /* For all but the head jumbo subpacket, the security checksum is in a
246 * jumbo header immediately prior to the data.
247 */
248 if ((annotation & RXRPC_RX_ANNO_JUMBO) > 1) {
249 __be16 tmp;
250 if (skb_copy_bits(skb, offset - 2, &tmp, 2) < 0)
251 BUG();
252 cksum = ntohs(tmp);
253 seq += (annotation & RXRPC_RX_ANNO_JUMBO) - 1;
254 }
255
256 return call->conn->security->verify_packet(call, skb, offset, len,
257 seq, cksum);
258}
259
260/*
261 * Locate the data within a packet. This is complicated by:
262 *
263 * (1) An skb may contain a jumbo packet - so we have to find the appropriate
264 * subpacket.
265 *
266 * (2) The (sub)packets may be encrypted and, if so, the encrypted portion
267 * contains an extra header which includes the true length of the data,
268 * excluding any encrypted padding.
269 */
270static int rxrpc_locate_data(struct rxrpc_call *call, struct sk_buff *skb,
271 u8 *_annotation,
272 unsigned int *_offset, unsigned int *_len)
273{
274 unsigned int offset = sizeof(struct rxrpc_wire_header);
275 unsigned int len;
276 int ret;
277 u8 annotation = *_annotation;
278
279 /* Locate the subpacket */
280 len = skb->len - offset;
281 if ((annotation & RXRPC_RX_ANNO_JUMBO) > 0) {
282 offset += (((annotation & RXRPC_RX_ANNO_JUMBO) - 1) *
283 RXRPC_JUMBO_SUBPKTLEN);
284 len = (annotation & RXRPC_RX_ANNO_JLAST) ?
285 skb->len - offset : RXRPC_JUMBO_SUBPKTLEN;
286 }
287
288 if (!(annotation & RXRPC_RX_ANNO_VERIFIED)) {
289 ret = rxrpc_verify_packet(call, skb, annotation, offset, len);
290 if (ret < 0)
291 return ret;
292 *_annotation |= RXRPC_RX_ANNO_VERIFIED;
293 }
294
295 *_offset = offset;
296 *_len = len;
297 call->conn->security->locate_data(call, skb, _offset, _len);
298 return 0;
299}
300
301/*
302 * Deliver messages to a call. This keeps processing packets until the buffer
303 * is filled and we find either more DATA (returns 0) or the end of the DATA
304 * (returns 1). If more packets are required, it returns -EAGAIN.
305 */
306static int rxrpc_recvmsg_data(struct socket *sock, struct rxrpc_call *call,
307 struct msghdr *msg, struct iov_iter *iter,
308 size_t len, int flags, size_t *_offset)
309{
310 struct rxrpc_skb_priv *sp;
311 struct sk_buff *skb;
312 rxrpc_seq_t hard_ack, top, seq;
313 size_t remain;
314 bool last;
315 unsigned int rx_pkt_offset, rx_pkt_len;
316 int ix, copy, ret = -EAGAIN, ret2;
317
318 rx_pkt_offset = call->rx_pkt_offset;
319 rx_pkt_len = call->rx_pkt_len;
320
321 if (call->state >= RXRPC_CALL_SERVER_ACK_REQUEST) {
322 seq = call->rx_hard_ack;
323 ret = 1;
324 goto done;
325 }
326
327 /* Barriers against rxrpc_input_data(). */
328 hard_ack = call->rx_hard_ack;
329 seq = hard_ack + 1;
330 while (top = smp_load_acquire(&call->rx_top),
331 before_eq(seq, top)
332 ) {
333 ix = seq & RXRPC_RXTX_BUFF_MASK;
334 skb = call->rxtx_buffer[ix];
335 if (!skb) {
336 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_hole, seq,
337 rx_pkt_offset, rx_pkt_len, 0);
338 break;
339 }
340 smp_rmb();
341 rxrpc_see_skb(skb, rxrpc_skb_rx_seen);
342 sp = rxrpc_skb(skb);
343
344 if (!(flags & MSG_PEEK))
345 trace_rxrpc_receive(call, rxrpc_receive_front,
346 sp->hdr.serial, seq);
347
348 if (msg)
349 sock_recv_timestamp(msg, sock->sk, skb);
350
351 if (rx_pkt_offset == 0) {
352 ret2 = rxrpc_locate_data(call, skb,
353 &call->rxtx_annotations[ix],
354 &rx_pkt_offset, &rx_pkt_len);
355 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_next, seq,
356 rx_pkt_offset, rx_pkt_len, ret2);
357 if (ret2 < 0) {
358 ret = ret2;
359 goto out;
360 }
361 } else {
362 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_cont, seq,
363 rx_pkt_offset, rx_pkt_len, 0);
364 }
365
366 /* We have to handle short, empty and used-up DATA packets. */
367 remain = len - *_offset;
368 copy = rx_pkt_len;
369 if (copy > remain)
370 copy = remain;
371 if (copy > 0) {
372 ret2 = skb_copy_datagram_iter(skb, rx_pkt_offset, iter,
373 copy);
374 if (ret2 < 0) {
375 ret = ret2;
376 goto out;
377 }
378
379 /* handle piecemeal consumption of data packets */
380 rx_pkt_offset += copy;
381 rx_pkt_len -= copy;
382 *_offset += copy;
383 }
384
385 if (rx_pkt_len > 0) {
386 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_full, seq,
387 rx_pkt_offset, rx_pkt_len, 0);
388 ASSERTCMP(*_offset, ==, len);
389 ret = 0;
390 break;
391 }
392
393 /* The whole packet has been transferred. */
394 last = sp->hdr.flags & RXRPC_LAST_PACKET;
395 if (!(flags & MSG_PEEK))
396 rxrpc_rotate_rx_window(call);
397 rx_pkt_offset = 0;
398 rx_pkt_len = 0;
399
400 if (last) {
401 ASSERTCMP(seq, ==, READ_ONCE(call->rx_top));
402 ret = 1;
403 goto out;
404 }
405
406 seq++;
407 }
408
409out:
410 if (!(flags & MSG_PEEK)) {
411 call->rx_pkt_offset = rx_pkt_offset;
412 call->rx_pkt_len = rx_pkt_len;
413 }
414done:
415 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_data_return, seq,
416 rx_pkt_offset, rx_pkt_len, ret);
417 return ret;
418}
419
420/*
421 * Receive a message from an RxRPC socket
422 * - we need to be careful about two or more threads calling recvmsg
423 * simultaneously
424 */
425int rxrpc_recvmsg(struct socket *sock, struct msghdr *msg, size_t len,
426 int flags)
427{
428 struct rxrpc_call *call;
429 struct rxrpc_sock *rx = rxrpc_sk(sock->sk);
430 struct list_head *l;
431 size_t copied = 0;
432 long timeo;
433 int ret;
434
435 DEFINE_WAIT(wait);
436
437 trace_rxrpc_recvmsg(NULL, rxrpc_recvmsg_enter, 0, 0, 0, 0);
438
439 if (flags & (MSG_OOB | MSG_TRUNC))
440 return -EOPNOTSUPP;
441
442 timeo = sock_rcvtimeo(&rx->sk, flags & MSG_DONTWAIT);
443
444try_again:
445 lock_sock(&rx->sk);
446
447 /* Return immediately if a client socket has no outstanding calls */
448 if (RB_EMPTY_ROOT(&rx->calls) &&
449 list_empty(&rx->recvmsg_q) &&
450 rx->sk.sk_state != RXRPC_SERVER_LISTENING) {
451 release_sock(&rx->sk);
452 return -ENODATA;
453 }
454
455 if (list_empty(&rx->recvmsg_q)) {
456 ret = -EWOULDBLOCK;
457 if (timeo == 0) {
458 call = NULL;
459 goto error_no_call;
460 }
461
462 release_sock(&rx->sk);
463
464 /* Wait for something to happen */
465 prepare_to_wait_exclusive(sk_sleep(&rx->sk), &wait,
466 TASK_INTERRUPTIBLE);
467 ret = sock_error(&rx->sk);
468 if (ret)
469 goto wait_error;
470
471 if (list_empty(&rx->recvmsg_q)) {
472 if (signal_pending(current))
473 goto wait_interrupted;
474 trace_rxrpc_recvmsg(NULL, rxrpc_recvmsg_wait,
475 0, 0, 0, 0);
476 timeo = schedule_timeout(timeo);
477 }
478 finish_wait(sk_sleep(&rx->sk), &wait);
479 goto try_again;
480 }
481
482 /* Find the next call and dequeue it if we're not just peeking. If we
483 * do dequeue it, that comes with a ref that we will need to release.
484 */
485 write_lock_bh(&rx->recvmsg_lock);
486 l = rx->recvmsg_q.next;
487 call = list_entry(l, struct rxrpc_call, recvmsg_link);
488 if (!(flags & MSG_PEEK))
489 list_del_init(&call->recvmsg_link);
490 else
491 rxrpc_get_call(call, rxrpc_call_got);
492 write_unlock_bh(&rx->recvmsg_lock);
493
494 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_dequeue, 0, 0, 0, 0);
495
496 /* We're going to drop the socket lock, so we need to lock the call
497 * against interference by sendmsg.
498 */
499 if (!mutex_trylock(&call->user_mutex)) {
500 ret = -EWOULDBLOCK;
501 if (flags & MSG_DONTWAIT)
502 goto error_requeue_call;
503 ret = -ERESTARTSYS;
504 if (mutex_lock_interruptible(&call->user_mutex) < 0)
505 goto error_requeue_call;
506 }
507
508 release_sock(&rx->sk);
509
510 if (test_bit(RXRPC_CALL_RELEASED, &call->flags))
511 BUG();
512
513 if (test_bit(RXRPC_CALL_HAS_USERID, &call->flags)) {
514 if (flags & MSG_CMSG_COMPAT) {
515 unsigned int id32 = call->user_call_ID;
516
517 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_USER_CALL_ID,
518 sizeof(unsigned int), &id32);
519 } else {
520 unsigned long idl = call->user_call_ID;
521
522 ret = put_cmsg(msg, SOL_RXRPC, RXRPC_USER_CALL_ID,
523 sizeof(unsigned long), &idl);
524 }
525 if (ret < 0)
526 goto error_unlock_call;
527 }
528
529 if (msg->msg_name) {
530 struct sockaddr_rxrpc *srx = msg->msg_name;
531 size_t len = sizeof(call->peer->srx);
532
533 memcpy(msg->msg_name, &call->peer->srx, len);
534 srx->srx_service = call->service_id;
535 msg->msg_namelen = len;
536 }
537
538 switch (READ_ONCE(call->state)) {
539 case RXRPC_CALL_SERVER_ACCEPTING:
540 ret = rxrpc_recvmsg_new_call(rx, call, msg, flags);
541 break;
542 case RXRPC_CALL_CLIENT_RECV_REPLY:
543 case RXRPC_CALL_SERVER_RECV_REQUEST:
544 case RXRPC_CALL_SERVER_ACK_REQUEST:
545 ret = rxrpc_recvmsg_data(sock, call, msg, &msg->msg_iter, len,
546 flags, &copied);
547 if (ret == -EAGAIN)
548 ret = 0;
549
550 if (after(call->rx_top, call->rx_hard_ack) &&
551 call->rxtx_buffer[(call->rx_hard_ack + 1) & RXRPC_RXTX_BUFF_MASK])
552 rxrpc_notify_socket(call);
553 break;
554 default:
555 ret = 0;
556 break;
557 }
558
559 if (ret < 0)
560 goto error_unlock_call;
561
562 if (call->state == RXRPC_CALL_COMPLETE) {
563 ret = rxrpc_recvmsg_term(call, msg);
564 if (ret < 0)
565 goto error_unlock_call;
566 if (!(flags & MSG_PEEK))
567 rxrpc_release_call(rx, call);
568 msg->msg_flags |= MSG_EOR;
569 ret = 1;
570 }
571
572 if (ret == 0)
573 msg->msg_flags |= MSG_MORE;
574 else
575 msg->msg_flags &= ~MSG_MORE;
576 ret = copied;
577
578error_unlock_call:
579 mutex_unlock(&call->user_mutex);
580 rxrpc_put_call(call, rxrpc_call_put);
581 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_return, 0, 0, 0, ret);
582 return ret;
583
584error_requeue_call:
585 if (!(flags & MSG_PEEK)) {
586 write_lock_bh(&rx->recvmsg_lock);
587 list_add(&call->recvmsg_link, &rx->recvmsg_q);
588 write_unlock_bh(&rx->recvmsg_lock);
589 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_requeue, 0, 0, 0, 0);
590 } else {
591 rxrpc_put_call(call, rxrpc_call_put);
592 }
593error_no_call:
594 release_sock(&rx->sk);
595 trace_rxrpc_recvmsg(call, rxrpc_recvmsg_return, 0, 0, 0, ret);
596 return ret;
597
598wait_interrupted:
599 ret = sock_intr_errno(timeo);
600wait_error:
601 finish_wait(sk_sleep(&rx->sk), &wait);
602 call = NULL;
603 goto error_no_call;
604}
605
606/**
607 * rxrpc_kernel_recv_data - Allow a kernel service to receive data/info
608 * @sock: The socket that the call exists on
609 * @call: The call to send data through
610 * @buf: The buffer to receive into
611 * @size: The size of the buffer, including data already read
612 * @_offset: The running offset into the buffer.
613 * @want_more: True if more data is expected to be read
614 * @_abort: Where the abort code is stored if -ECONNABORTED is returned
615 * @_service: Where to store the actual service ID (may be upgraded)
616 *
617 * Allow a kernel service to receive data and pick up information about the
618 * state of a call. Returns 0 if got what was asked for and there's more
619 * available, 1 if we got what was asked for and we're at the end of the data
620 * and -EAGAIN if we need more data.
621 *
622 * Note that we may return -EAGAIN to drain empty packets at the end of the
623 * data, even if we've already copied over the requested data.
624 *
625 * This function adds the amount it transfers to *_offset, so this should be
626 * precleared as appropriate. Note that the amount remaining in the buffer is
627 * taken to be size - *_offset.
628 *
629 * *_abort should also be initialised to 0.
630 */
631int rxrpc_kernel_recv_data(struct socket *sock, struct rxrpc_call *call,
632 void *buf, size_t size, size_t *_offset,
633 bool want_more, u32 *_abort, u16 *_service)
634{
635 struct iov_iter iter;
636 struct kvec iov;
637 int ret;
638
639 _enter("{%d,%s},%zu/%zu,%d",
640 call->debug_id, rxrpc_call_states[call->state],
641 *_offset, size, want_more);
642
643 ASSERTCMP(*_offset, <=, size);
644 ASSERTCMP(call->state, !=, RXRPC_CALL_SERVER_ACCEPTING);
645
646 iov.iov_base = buf + *_offset;
647 iov.iov_len = size - *_offset;
648 iov_iter_kvec(&iter, ITER_KVEC | READ, &iov, 1, size - *_offset);
649
650 mutex_lock(&call->user_mutex);
651
652 switch (READ_ONCE(call->state)) {
653 case RXRPC_CALL_CLIENT_RECV_REPLY:
654 case RXRPC_CALL_SERVER_RECV_REQUEST:
655 case RXRPC_CALL_SERVER_ACK_REQUEST:
656 ret = rxrpc_recvmsg_data(sock, call, NULL, &iter, size, 0,
657 _offset);
658 if (ret < 0)
659 goto out;
660
661 /* We can only reach here with a partially full buffer if we
662 * have reached the end of the data. We must otherwise have a
663 * full buffer or have been given -EAGAIN.
664 */
665 if (ret == 1) {
666 if (*_offset < size)
667 goto short_data;
668 if (!want_more)
669 goto read_phase_complete;
670 ret = 0;
671 goto out;
672 }
673
674 if (!want_more)
675 goto excess_data;
676 goto out;
677
678 case RXRPC_CALL_COMPLETE:
679 goto call_complete;
680
681 default:
682 ret = -EINPROGRESS;
683 goto out;
684 }
685
686read_phase_complete:
687 ret = 1;
688out:
689 if (_service)
690 *_service = call->service_id;
691 mutex_unlock(&call->user_mutex);
692 _leave(" = %d [%zu,%d]", ret, *_offset, *_abort);
693 return ret;
694
695short_data:
696 trace_rxrpc_rx_eproto(call, 0, tracepoint_string("short_data"));
697 ret = -EBADMSG;
698 goto out;
699excess_data:
700 trace_rxrpc_rx_eproto(call, 0, tracepoint_string("excess_data"));
701 ret = -EMSGSIZE;
702 goto out;
703call_complete:
704 *_abort = call->abort_code;
705 ret = call->error;
706 if (call->completion == RXRPC_CALL_SUCCEEDED) {
707 ret = 1;
708 if (size > 0)
709 ret = -ECONNRESET;
710 }
711 goto out;
712}
713EXPORT_SYMBOL(rxrpc_kernel_recv_data);