xref: /linux/include/net/af_rxrpc.h (revision 95f28190aa012b18eab14799b905b6db3cf31529)
1 /* RxRPC kernel service interface definitions
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 #ifndef _NET_RXRPC_H
13 #define _NET_RXRPC_H
14 
15 #include <linux/rxrpc.h>
16 
17 struct key;
18 struct sock;
19 struct socket;
20 struct rxrpc_call;
21 
22 /*
23  * Call completion condition (state == RXRPC_CALL_COMPLETE).
24  */
25 enum 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 
34 typedef void (*rxrpc_notify_rx_t)(struct sock *, struct rxrpc_call *,
35 				  unsigned long);
36 typedef void (*rxrpc_notify_end_tx_t)(struct sock *, struct rxrpc_call *,
37 				      unsigned long);
38 typedef void (*rxrpc_notify_new_call_t)(struct sock *, struct rxrpc_call *,
39 					unsigned long);
40 typedef void (*rxrpc_discard_new_call_t)(struct rxrpc_call *, unsigned long);
41 typedef void (*rxrpc_user_attach_call_t)(struct rxrpc_call *, unsigned long);
42 
43 void rxrpc_kernel_new_call_notification(struct socket *,
44 					rxrpc_notify_new_call_t,
45 					rxrpc_discard_new_call_t);
46 struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *,
47 					   struct sockaddr_rxrpc *,
48 					   struct key *,
49 					   unsigned long,
50 					   s64,
51 					   gfp_t,
52 					   rxrpc_notify_rx_t,
53 					   bool);
54 int rxrpc_kernel_send_data(struct socket *, struct rxrpc_call *,
55 			   struct msghdr *, size_t,
56 			   rxrpc_notify_end_tx_t);
57 int rxrpc_kernel_recv_data(struct socket *, struct rxrpc_call *,
58 			   void *, size_t, size_t *, bool, u32 *, u16 *);
59 bool rxrpc_kernel_abort_call(struct socket *, struct rxrpc_call *,
60 			     u32, int, const char *);
61 void rxrpc_kernel_end_call(struct socket *, struct rxrpc_call *);
62 void rxrpc_kernel_get_peer(struct socket *, struct rxrpc_call *,
63 			   struct sockaddr_rxrpc *);
64 u64 rxrpc_kernel_get_rtt(struct socket *, struct rxrpc_call *);
65 int rxrpc_kernel_charge_accept(struct socket *, rxrpc_notify_rx_t,
66 			       rxrpc_user_attach_call_t, unsigned long, gfp_t);
67 void rxrpc_kernel_set_tx_length(struct socket *, struct rxrpc_call *, s64);
68 int rxrpc_kernel_retry_call(struct socket *, struct rxrpc_call *,
69 			    struct sockaddr_rxrpc *, struct key *);
70 int rxrpc_kernel_check_call(struct socket *, struct rxrpc_call *,
71 			    enum rxrpc_call_completion *, u32 *);
72 u32 rxrpc_kernel_check_life(struct socket *, struct rxrpc_call *);
73 
74 #endif /* _NET_RXRPC_H */
75