blob: f53edb3754bc4fe5203794dc444bc328dafc9c38 [file] [log] [blame]
David Howells651350d2007-04-26 15:50:17 -07001/* RxRPC kernel service interface definitions
David Howells17926a72007-04-26 15:48:28 -07002 *
David Howells651350d2007-04-26 15:50:17 -07003 * Copyright (C) 2007 Red Hat, Inc. All Rights Reserved.
David Howells17926a72007-04-26 15:48:28 -07004 * 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#ifndef _NET_RXRPC_H
13#define _NET_RXRPC_H
14
15#include <linux/rxrpc.h>
16
David Howells4de48af2016-08-30 12:00:48 +010017struct key;
18struct sock;
19struct socket;
David Howells651350d2007-04-26 15:50:17 -070020struct rxrpc_call;
21
David Howellsc038a582017-08-29 10:19:01 +010022/*
23 * Call completion condition (state == RXRPC_CALL_COMPLETE).
24 */
25enum rxrpc_call_completion {
26 RXRPC_CALL_SUCCEEDED, /* - Normal termination */
27 RXRPC_CALL_REMOTELY_ABORTED, /* - call aborted by peer */
28 RXRPC_CALL_LOCALLY_ABORTED, /* - call aborted locally on error or close */
29 RXRPC_CALL_LOCAL_ERROR, /* - call failed due to local error */
30 RXRPC_CALL_NETWORK_ERROR, /* - call terminated by network error */
31 NR__RXRPC_CALL_COMPLETIONS
32};
33
David Howellsa25e21f2018-03-27 23:03:00 +010034/*
35 * Debug ID counter for tracing.
36 */
37extern atomic_t rxrpc_debug_id;
38
David Howellsd0016482016-08-30 20:42:14 +010039typedef void (*rxrpc_notify_rx_t)(struct sock *, struct rxrpc_call *,
40 unsigned long);
David Howellse8332512017-08-29 10:18:56 +010041typedef void (*rxrpc_notify_end_tx_t)(struct sock *, struct rxrpc_call *,
42 unsigned long);
David Howells00e90712016-09-08 11:10:12 +010043typedef void (*rxrpc_notify_new_call_t)(struct sock *, struct rxrpc_call *,
44 unsigned long);
45typedef void (*rxrpc_discard_new_call_t)(struct rxrpc_call *, unsigned long);
46typedef void (*rxrpc_user_attach_call_t)(struct rxrpc_call *, unsigned long);
David Howells651350d2007-04-26 15:50:17 -070047
David Howellsd0016482016-08-30 20:42:14 +010048void rxrpc_kernel_new_call_notification(struct socket *,
David Howells00e90712016-09-08 11:10:12 +010049 rxrpc_notify_new_call_t,
50 rxrpc_discard_new_call_t);
Joe Perchescd2cf632013-07-31 17:31:34 -070051struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *,
52 struct sockaddr_rxrpc *,
53 struct key *,
54 unsigned long,
David Howellse754eba2017-06-07 12:40:03 +010055 s64,
David Howellsd0016482016-08-30 20:42:14 +010056 gfp_t,
David Howellsa68f4a22017-10-18 11:36:39 +010057 rxrpc_notify_rx_t,
David Howellsa25e21f2018-03-27 23:03:00 +010058 bool,
59 unsigned int);
David Howells4de48af2016-08-30 12:00:48 +010060int rxrpc_kernel_send_data(struct socket *, struct rxrpc_call *,
David Howellse8332512017-08-29 10:18:56 +010061 struct msghdr *, size_t,
62 rxrpc_notify_end_tx_t);
David Howellsd0016482016-08-30 20:42:14 +010063int rxrpc_kernel_recv_data(struct socket *, struct rxrpc_call *,
David Howellseb9950e2018-08-03 17:06:56 +010064 struct iov_iter *, bool, u32 *, u16 *);
David Howells84a4c092017-04-06 10:11:59 +010065bool rxrpc_kernel_abort_call(struct socket *, struct rxrpc_call *,
David Howells5a429762016-09-06 22:19:51 +010066 u32, int, const char *);
David Howells4de48af2016-08-30 12:00:48 +010067void rxrpc_kernel_end_call(struct socket *, struct rxrpc_call *);
David Howells8324f0b2016-08-30 09:49:29 +010068void rxrpc_kernel_get_peer(struct socket *, struct rxrpc_call *,
69 struct sockaddr_rxrpc *);
David Howellsf4d15fb2017-10-18 11:07:31 +010070u64 rxrpc_kernel_get_rtt(struct socket *, struct rxrpc_call *);
David Howells00e90712016-09-08 11:10:12 +010071int rxrpc_kernel_charge_accept(struct socket *, rxrpc_notify_rx_t,
David Howellsa25e21f2018-03-27 23:03:00 +010072 rxrpc_user_attach_call_t, unsigned long, gfp_t,
73 unsigned int);
David Howellse754eba2017-06-07 12:40:03 +010074void rxrpc_kernel_set_tx_length(struct socket *, struct rxrpc_call *, s64);
David Howellsc038a582017-08-29 10:19:01 +010075int rxrpc_kernel_retry_call(struct socket *, struct rxrpc_call *,
76 struct sockaddr_rxrpc *, struct key *);
77int rxrpc_kernel_check_call(struct socket *, struct rxrpc_call *,
78 enum rxrpc_call_completion *, u32 *);
David Howellsf4d15fb2017-10-18 11:07:31 +010079u32 rxrpc_kernel_check_life(struct socket *, struct rxrpc_call *);
David Howells651350d2007-04-26 15:50:17 -070080
David Howells17926a72007-04-26 15:48:28 -070081#endif /* _NET_RXRPC_H */