xref: /openbmc/linux/include/net/af_rxrpc.h (revision 2c6467d2)
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 #include <linux/ktime.h>
17 
18 struct key;
19 struct sock;
20 struct socket;
21 struct rxrpc_call;
22 
23 /*
24  * Call completion condition (state == RXRPC_CALL_COMPLETE).
25  */
26 enum rxrpc_call_completion {
27 	RXRPC_CALL_SUCCEEDED,		/* - Normal termination */
28 	RXRPC_CALL_REMOTELY_ABORTED,	/* - call aborted by peer */
29 	RXRPC_CALL_LOCALLY_ABORTED,	/* - call aborted locally on error or close */
30 	RXRPC_CALL_LOCAL_ERROR,		/* - call failed due to local error */
31 	RXRPC_CALL_NETWORK_ERROR,	/* - call terminated by network error */
32 	NR__RXRPC_CALL_COMPLETIONS
33 };
34 
35 /*
36  * Debug ID counter for tracing.
37  */
38 extern atomic_t rxrpc_debug_id;
39 
40 typedef void (*rxrpc_notify_rx_t)(struct sock *, struct rxrpc_call *,
41 				  unsigned long);
42 typedef void (*rxrpc_notify_end_tx_t)(struct sock *, struct rxrpc_call *,
43 				      unsigned long);
44 typedef void (*rxrpc_notify_new_call_t)(struct sock *, struct rxrpc_call *,
45 					unsigned long);
46 typedef void (*rxrpc_discard_new_call_t)(struct rxrpc_call *, unsigned long);
47 typedef void (*rxrpc_user_attach_call_t)(struct rxrpc_call *, unsigned long);
48 
49 void rxrpc_kernel_new_call_notification(struct socket *,
50 					rxrpc_notify_new_call_t,
51 					rxrpc_discard_new_call_t);
52 struct rxrpc_call *rxrpc_kernel_begin_call(struct socket *,
53 					   struct sockaddr_rxrpc *,
54 					   struct key *,
55 					   unsigned long,
56 					   s64,
57 					   gfp_t,
58 					   rxrpc_notify_rx_t,
59 					   bool,
60 					   unsigned int);
61 int rxrpc_kernel_send_data(struct socket *, struct rxrpc_call *,
62 			   struct msghdr *, size_t,
63 			   rxrpc_notify_end_tx_t);
64 int rxrpc_kernel_recv_data(struct socket *, struct rxrpc_call *,
65 			   struct iov_iter *, bool, u32 *, u16 *);
66 bool rxrpc_kernel_abort_call(struct socket *, struct rxrpc_call *,
67 			     u32, int, const char *);
68 void rxrpc_kernel_end_call(struct socket *, struct rxrpc_call *);
69 void rxrpc_kernel_get_peer(struct socket *, struct rxrpc_call *,
70 			   struct sockaddr_rxrpc *);
71 u64 rxrpc_kernel_get_rtt(struct socket *, struct rxrpc_call *);
72 int rxrpc_kernel_charge_accept(struct socket *, rxrpc_notify_rx_t,
73 			       rxrpc_user_attach_call_t, unsigned long, gfp_t,
74 			       unsigned int);
75 void rxrpc_kernel_set_tx_length(struct socket *, struct rxrpc_call *, s64);
76 int rxrpc_kernel_retry_call(struct socket *, struct rxrpc_call *,
77 			    struct sockaddr_rxrpc *, struct key *);
78 int rxrpc_kernel_check_call(struct socket *, struct rxrpc_call *,
79 			    enum rxrpc_call_completion *, u32 *);
80 u32 rxrpc_kernel_check_life(const struct socket *, const struct rxrpc_call *);
81 void rxrpc_kernel_probe_life(struct socket *, struct rxrpc_call *);
82 u32 rxrpc_kernel_get_epoch(struct socket *, struct rxrpc_call *);
83 bool rxrpc_kernel_get_reply_time(struct socket *, struct rxrpc_call *,
84 				 ktime_t *);
85 
86 #endif /* _NET_RXRPC_H */
87