1 /* AF_RXRPC sendmsg() implementation.
3 * Copyright (C) 2007, 2016 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public Licence
8 * as published by the Free Software Foundation; either version
9 * 2 of the Licence, or (at your option) any later version.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
14 #include <linux/net.h>
15 #include <linux/gfp.h>
16 #include <linux/skbuff.h>
17 #include <linux/export.h>
19 #include <net/af_rxrpc.h>
20 #include "ar-internal.h"
23 RXRPC_CMD_SEND_DATA, /* send data message */
24 RXRPC_CMD_SEND_ABORT, /* request abort generation */
25 RXRPC_CMD_ACCEPT, /* [server] accept incoming call */
26 RXRPC_CMD_REJECT_BUSY, /* [server] reject a call as busy */
30 * wait for space to appear in the transmit/ACK window
31 * - caller holds the socket locked
33 static int rxrpc_wait_for_tx_window(struct rxrpc_sock *rx,
34 struct rxrpc_call *call,
37 DECLARE_WAITQUEUE(myself, current);
41 call->tx_hard_ack, call->tx_top, call->tx_winsize);
43 add_wait_queue(&call->waitq, &myself);
46 set_current_state(TASK_INTERRUPTIBLE);
48 if (call->tx_top - call->tx_hard_ack < call->tx_winsize)
50 if (call->state >= RXRPC_CALL_COMPLETE) {
54 if (signal_pending(current)) {
55 ret = sock_intr_errno(*timeo);
59 trace_rxrpc_transmit(call, rxrpc_transmit_wait);
60 release_sock(&rx->sk);
61 *timeo = schedule_timeout(*timeo);
65 remove_wait_queue(&call->waitq, &myself);
66 set_current_state(TASK_RUNNING);
72 * Schedule an instant Tx resend.
74 static inline void rxrpc_instant_resend(struct rxrpc_call *call, int ix)
76 spin_lock_bh(&call->lock);
78 if (call->state < RXRPC_CALL_COMPLETE) {
79 call->rxtx_annotations[ix] = RXRPC_TX_ANNO_RETRANS;
80 if (!test_and_set_bit(RXRPC_CALL_EV_RESEND, &call->events))
81 rxrpc_queue_call(call);
84 spin_unlock_bh(&call->lock);
88 * Queue a DATA packet for transmission, set the resend timeout and send the
91 static void rxrpc_queue_packet(struct rxrpc_call *call, struct sk_buff *skb,
94 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
95 rxrpc_seq_t seq = sp->hdr.seq;
98 _net("queue skb %p [%d]", skb, seq);
100 ASSERTCMP(seq, ==, call->tx_top + 1);
102 ix = seq & RXRPC_RXTX_BUFF_MASK;
103 rxrpc_get_skb(skb, rxrpc_skb_tx_got);
104 call->rxtx_annotations[ix] = RXRPC_TX_ANNO_UNACK;
106 call->rxtx_buffer[ix] = skb;
109 set_bit(RXRPC_CALL_TX_LAST, &call->flags);
110 trace_rxrpc_transmit(call, rxrpc_transmit_queue_last);
111 } else if (sp->hdr.flags & RXRPC_REQUEST_ACK) {
112 trace_rxrpc_transmit(call, rxrpc_transmit_queue_reqack);
114 trace_rxrpc_transmit(call, rxrpc_transmit_queue);
117 if (last || call->state == RXRPC_CALL_SERVER_ACK_REQUEST) {
118 _debug("________awaiting reply/ACK__________");
119 write_lock_bh(&call->state_lock);
120 switch (call->state) {
121 case RXRPC_CALL_CLIENT_SEND_REQUEST:
122 call->state = RXRPC_CALL_CLIENT_AWAIT_REPLY;
124 case RXRPC_CALL_SERVER_ACK_REQUEST:
125 call->state = RXRPC_CALL_SERVER_SEND_REPLY;
128 case RXRPC_CALL_SERVER_SEND_REPLY:
129 call->state = RXRPC_CALL_SERVER_AWAIT_ACK;
134 write_unlock_bh(&call->state_lock);
137 _proto("Tx DATA %%%u { #%u }", sp->hdr.serial, sp->hdr.seq);
139 if (seq == 1 && rxrpc_is_client_call(call))
140 rxrpc_expose_client_call(call);
142 sp->resend_at = jiffies + rxrpc_resend_timeout;
143 ret = rxrpc_send_data_packet(call->conn, skb);
145 _debug("need instant resend %d", ret);
146 rxrpc_instant_resend(call, ix);
149 rxrpc_free_skb(skb, rxrpc_skb_tx_freed);
154 * Convert a host-endian header into a network-endian header.
156 static void rxrpc_insert_header(struct sk_buff *skb)
158 struct rxrpc_wire_header whdr;
159 struct rxrpc_skb_priv *sp = rxrpc_skb(skb);
161 whdr.epoch = htonl(sp->hdr.epoch);
162 whdr.cid = htonl(sp->hdr.cid);
163 whdr.callNumber = htonl(sp->hdr.callNumber);
164 whdr.seq = htonl(sp->hdr.seq);
165 whdr.serial = htonl(sp->hdr.serial);
166 whdr.type = sp->hdr.type;
167 whdr.flags = sp->hdr.flags;
168 whdr.userStatus = sp->hdr.userStatus;
169 whdr.securityIndex = sp->hdr.securityIndex;
170 whdr._rsvd = htons(sp->hdr._rsvd);
171 whdr.serviceId = htons(sp->hdr.serviceId);
173 memcpy(skb->head, &whdr, sizeof(whdr));
177 * send data through a socket
178 * - must be called in process context
179 * - caller holds the socket locked
181 static int rxrpc_send_data(struct rxrpc_sock *rx,
182 struct rxrpc_call *call,
183 struct msghdr *msg, size_t len)
185 struct rxrpc_skb_priv *sp;
187 struct sock *sk = &rx->sk;
192 timeo = sock_sndtimeo(sk, msg->msg_flags & MSG_DONTWAIT);
194 /* this should be in poll */
195 sk_clear_bit(SOCKWQ_ASYNC_NOSPACE, sk);
197 if (sk->sk_err || (sk->sk_shutdown & SEND_SHUTDOWN))
200 more = msg->msg_flags & MSG_MORE;
202 skb = call->tx_pending;
203 call->tx_pending = NULL;
204 rxrpc_see_skb(skb, rxrpc_skb_tx_seen);
209 size_t size, chunk, max, space;
213 if (call->tx_top - call->tx_hard_ack >=
216 if (msg->msg_flags & MSG_DONTWAIT)
218 ret = rxrpc_wait_for_tx_window(rx, call,
224 max = RXRPC_JUMBO_DATALEN;
225 max -= call->conn->security_size;
226 max &= ~(call->conn->size_align - 1UL);
229 if (chunk > msg_data_left(msg) && !more)
230 chunk = msg_data_left(msg);
232 space = chunk + call->conn->size_align;
233 space &= ~(call->conn->size_align - 1UL);
235 size = space + call->conn->header_size;
237 _debug("SIZE: %zu/%zu/%zu", chunk, space, size);
239 /* create a buffer that we can retain until it's ACK'd */
240 skb = sock_alloc_send_skb(
241 sk, size, msg->msg_flags & MSG_DONTWAIT, &ret);
245 rxrpc_new_skb(skb, rxrpc_skb_tx_new);
247 _debug("ALLOC SEND %p", skb);
249 ASSERTCMP(skb->mark, ==, 0);
251 _debug("HS: %u", call->conn->header_size);
252 skb_reserve(skb, call->conn->header_size);
253 skb->len += call->conn->header_size;
257 if (sp->remain > skb_tailroom(skb))
258 sp->remain = skb_tailroom(skb);
260 _net("skb: hr %d, tr %d, hl %d, rm %d",
266 skb->ip_summed = CHECKSUM_UNNECESSARY;
272 /* append next segment of data to the current buffer */
273 if (msg_data_left(msg) > 0) {
274 int copy = skb_tailroom(skb);
275 ASSERTCMP(copy, >, 0);
276 if (copy > msg_data_left(msg))
277 copy = msg_data_left(msg);
278 if (copy > sp->remain)
282 ret = skb_add_data(skb, &msg->msg_iter, copy);
291 /* check for the far side aborting the call or a network error
293 if (call->state == RXRPC_CALL_COMPLETE)
294 goto call_terminated;
296 /* add the packet to the send queue if it's now full */
297 if (sp->remain <= 0 ||
298 (msg_data_left(msg) == 0 && !more)) {
299 struct rxrpc_connection *conn = call->conn;
303 /* pad out if we're using security */
304 if (conn->security_ix) {
305 pad = conn->security_size + skb->mark;
306 pad = conn->size_align - pad;
307 pad &= conn->size_align - 1;
308 _debug("pad %zu", pad);
310 memset(skb_put(skb, pad), 0, pad);
313 seq = call->tx_top + 1;
315 sp->hdr.epoch = conn->proto.epoch;
316 sp->hdr.cid = call->cid;
317 sp->hdr.callNumber = call->call_id;
319 sp->hdr.serial = atomic_inc_return(&conn->serial);
320 sp->hdr.type = RXRPC_PACKET_TYPE_DATA;
321 sp->hdr.userStatus = 0;
322 sp->hdr.securityIndex = call->security_ix;
324 sp->hdr.serviceId = call->service_id;
326 sp->hdr.flags = conn->out_clientflag;
327 if (msg_data_left(msg) == 0 && !more)
328 sp->hdr.flags |= RXRPC_LAST_PACKET;
329 else if (call->tx_top - call->tx_hard_ack <
331 sp->hdr.flags |= RXRPC_MORE_PACKETS;
333 sp->hdr.flags |= RXRPC_REQUEST_ACK;
335 ret = conn->security->secure_packet(
336 call, skb, skb->mark,
337 skb->head + sizeof(struct rxrpc_wire_header));
341 rxrpc_insert_header(skb);
342 rxrpc_queue_packet(call, skb, !msg_data_left(msg) && !more);
345 } while (msg_data_left(msg) > 0);
350 call->tx_pending = skb;
351 _leave(" = %d", ret);
355 rxrpc_free_skb(skb, rxrpc_skb_tx_freed);
356 _leave(" = %d", -call->error);
370 * extract control messages from the sendmsg() control buffer
372 static int rxrpc_sendmsg_cmsg(struct msghdr *msg,
373 unsigned long *user_call_ID,
374 enum rxrpc_command *command,
378 struct cmsghdr *cmsg;
379 bool got_user_ID = false;
382 *command = RXRPC_CMD_SEND_DATA;
384 if (msg->msg_controllen == 0)
387 for_each_cmsghdr(cmsg, msg) {
388 if (!CMSG_OK(msg, cmsg))
391 len = cmsg->cmsg_len - CMSG_ALIGN(sizeof(struct cmsghdr));
392 _debug("CMSG %d, %d, %d",
393 cmsg->cmsg_level, cmsg->cmsg_type, len);
395 if (cmsg->cmsg_level != SOL_RXRPC)
398 switch (cmsg->cmsg_type) {
399 case RXRPC_USER_CALL_ID:
400 if (msg->msg_flags & MSG_CMSG_COMPAT) {
401 if (len != sizeof(u32))
403 *user_call_ID = *(u32 *) CMSG_DATA(cmsg);
405 if (len != sizeof(unsigned long))
407 *user_call_ID = *(unsigned long *)
410 _debug("User Call ID %lx", *user_call_ID);
415 if (*command != RXRPC_CMD_SEND_DATA)
417 *command = RXRPC_CMD_SEND_ABORT;
418 if (len != sizeof(*abort_code))
420 *abort_code = *(unsigned int *) CMSG_DATA(cmsg);
421 _debug("Abort %x", *abort_code);
422 if (*abort_code == 0)
427 if (*command != RXRPC_CMD_SEND_DATA)
429 *command = RXRPC_CMD_ACCEPT;
434 case RXRPC_EXCLUSIVE_CALL:
451 * Create a new client call for sendmsg().
453 static struct rxrpc_call *
454 rxrpc_new_client_call_for_sendmsg(struct rxrpc_sock *rx, struct msghdr *msg,
455 unsigned long user_call_ID, bool exclusive)
457 struct rxrpc_conn_parameters cp;
458 struct rxrpc_call *call;
461 DECLARE_SOCKADDR(struct sockaddr_rxrpc *, srx, msg->msg_name);
466 return ERR_PTR(-EDESTADDRREQ);
469 if (key && !rx->key->payload.data[0])
472 memset(&cp, 0, sizeof(cp));
473 cp.local = rx->local;
475 cp.security_level = rx->min_sec_level;
476 cp.exclusive = rx->exclusive | exclusive;
477 cp.service_id = srx->srx_service;
478 call = rxrpc_new_client_call(rx, &cp, srx, user_call_ID, GFP_KERNEL);
480 _leave(" = %p\n", call);
485 * send a message forming part of a client call through an RxRPC socket
486 * - caller holds the socket locked
487 * - the socket may be either a client socket or a server socket
489 int rxrpc_do_sendmsg(struct rxrpc_sock *rx, struct msghdr *msg, size_t len)
491 enum rxrpc_command cmd;
492 struct rxrpc_call *call;
493 unsigned long user_call_ID = 0;
494 bool exclusive = false;
500 ret = rxrpc_sendmsg_cmsg(msg, &user_call_ID, &cmd, &abort_code,
505 if (cmd == RXRPC_CMD_ACCEPT) {
506 if (rx->sk.sk_state != RXRPC_SERVER_LISTENING)
508 call = rxrpc_accept_call(rx, user_call_ID, NULL);
510 return PTR_ERR(call);
511 rxrpc_put_call(call, rxrpc_call_put);
515 call = rxrpc_find_call_by_user_ID(rx, user_call_ID);
517 if (cmd != RXRPC_CMD_SEND_DATA)
519 call = rxrpc_new_client_call_for_sendmsg(rx, msg, user_call_ID,
522 return PTR_ERR(call);
525 _debug("CALL %d USR %lx ST %d on CONN %p",
526 call->debug_id, call->user_call_ID, call->state, call->conn);
528 if (call->state >= RXRPC_CALL_COMPLETE) {
529 /* it's too late for this call */
531 } else if (cmd == RXRPC_CMD_SEND_ABORT) {
533 if (rxrpc_abort_call("CMD", call, 0, abort_code, ECONNABORTED))
534 ret = rxrpc_send_call_packet(call,
535 RXRPC_PACKET_TYPE_ABORT);
536 } else if (cmd != RXRPC_CMD_SEND_DATA) {
538 } else if (rxrpc_is_client_call(call) &&
539 call->state != RXRPC_CALL_CLIENT_SEND_REQUEST) {
540 /* request phase complete for this client call */
542 } else if (rxrpc_is_service_call(call) &&
543 call->state != RXRPC_CALL_SERVER_ACK_REQUEST &&
544 call->state != RXRPC_CALL_SERVER_SEND_REPLY) {
545 /* Reply phase not begun or not complete for service call. */
548 ret = rxrpc_send_data(rx, call, msg, len);
551 rxrpc_put_call(call, rxrpc_call_put);
552 _leave(" = %d", ret);
557 * rxrpc_kernel_send_data - Allow a kernel service to send data on a call
558 * @sock: The socket the call is on
559 * @call: The call to send data through
560 * @msg: The data to send
561 * @len: The amount of data to send
563 * Allow a kernel service to send data on a call. The call must be in an state
564 * appropriate to sending data. No control data should be supplied in @msg,
565 * nor should an address be supplied. MSG_MORE should be flagged if there's
566 * more data to come, otherwise this data will end the transmission phase.
568 int rxrpc_kernel_send_data(struct socket *sock, struct rxrpc_call *call,
569 struct msghdr *msg, size_t len)
573 _enter("{%d,%s},", call->debug_id, rxrpc_call_states[call->state]);
575 ASSERTCMP(msg->msg_name, ==, NULL);
576 ASSERTCMP(msg->msg_control, ==, NULL);
580 _debug("CALL %d USR %lx ST %d on CONN %p",
581 call->debug_id, call->user_call_ID, call->state, call->conn);
583 if (call->state >= RXRPC_CALL_COMPLETE) {
584 ret = -ESHUTDOWN; /* it's too late for this call */
585 } else if (call->state != RXRPC_CALL_CLIENT_SEND_REQUEST &&
586 call->state != RXRPC_CALL_SERVER_ACK_REQUEST &&
587 call->state != RXRPC_CALL_SERVER_SEND_REPLY) {
588 ret = -EPROTO; /* request phase complete for this client call */
590 ret = rxrpc_send_data(rxrpc_sk(sock->sk), call, msg, len);
593 release_sock(sock->sk);
594 _leave(" = %d", ret);
597 EXPORT_SYMBOL(rxrpc_kernel_send_data);
600 * rxrpc_kernel_abort_call - Allow a kernel service to abort a call
601 * @sock: The socket the call is on
602 * @call: The call to be aborted
603 * @abort_code: The abort code to stick into the ABORT packet
604 * @error: Local error value
605 * @why: 3-char string indicating why.
607 * Allow a kernel service to abort a call, if it's still in an abortable state.
609 void rxrpc_kernel_abort_call(struct socket *sock, struct rxrpc_call *call,
610 u32 abort_code, int error, const char *why)
612 _enter("{%d},%d,%d,%s", call->debug_id, abort_code, error, why);
616 if (rxrpc_abort_call(why, call, 0, abort_code, error))
617 rxrpc_send_call_packet(call, RXRPC_PACKET_TYPE_ABORT);
619 release_sock(sock->sk);
623 EXPORT_SYMBOL(rxrpc_kernel_abort_call);