1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * RPC client multipathing definitions
4  *
5  * Copyright (c) 2015, 2016, Primary Data, Inc. All rights reserved.
6  *
7  * Trond Myklebust <[email protected]>
8  */
9 #ifndef _NET_SUNRPC_XPRTMULTIPATH_H
10 #define _NET_SUNRPC_XPRTMULTIPATH_H
11 
12 struct rpc_xprt_iter_ops;
13 struct rpc_sysfs_xprt_switch;
14 struct rpc_xprt_switch {
15 	spinlock_t		xps_lock;
16 	struct kref		xps_kref;
17 
18 	unsigned int		xps_id;
19 	unsigned int		xps_nxprts;
20 	unsigned int		xps_nactive;
21 	atomic_long_t		xps_queuelen;
22 	struct list_head	xps_xprt_list;
23 
24 	struct net *		xps_net;
25 
26 	const struct rpc_xprt_iter_ops *xps_iter_ops;
27 
28 	struct rpc_sysfs_xprt_switch *xps_sysfs;
29 	struct rcu_head		xps_rcu;
30 };
31 
32 struct rpc_xprt_iter {
33 	struct rpc_xprt_switch __rcu *xpi_xpswitch;
34 	struct rpc_xprt *	xpi_cursor;
35 
36 	const struct rpc_xprt_iter_ops *xpi_ops;
37 };
38 
39 
40 struct rpc_xprt_iter_ops {
41 	void (*xpi_rewind)(struct rpc_xprt_iter *);
42 	struct rpc_xprt *(*xpi_xprt)(struct rpc_xprt_iter *);
43 	struct rpc_xprt *(*xpi_next)(struct rpc_xprt_iter *);
44 };
45 
46 extern struct rpc_xprt_switch *xprt_switch_alloc(struct rpc_xprt *xprt,
47 		gfp_t gfp_flags);
48 
49 extern struct rpc_xprt_switch *xprt_switch_get(struct rpc_xprt_switch *xps);
50 extern void xprt_switch_put(struct rpc_xprt_switch *xps);
51 
52 extern void rpc_xprt_switch_set_roundrobin(struct rpc_xprt_switch *xps);
53 
54 extern void rpc_xprt_switch_add_xprt(struct rpc_xprt_switch *xps,
55 		struct rpc_xprt *xprt);
56 extern void rpc_xprt_switch_remove_xprt(struct rpc_xprt_switch *xps,
57 		struct rpc_xprt *xprt);
58 
59 extern void xprt_iter_init(struct rpc_xprt_iter *xpi,
60 		struct rpc_xprt_switch *xps);
61 
62 extern void xprt_iter_init_listall(struct rpc_xprt_iter *xpi,
63 		struct rpc_xprt_switch *xps);
64 
65 extern void xprt_iter_destroy(struct rpc_xprt_iter *xpi);
66 
67 extern struct rpc_xprt_switch *xprt_iter_xchg_switch(
68 		struct rpc_xprt_iter *xpi,
69 		struct rpc_xprt_switch *newswitch);
70 
71 extern struct rpc_xprt *xprt_iter_xprt(struct rpc_xprt_iter *xpi);
72 extern struct rpc_xprt *xprt_iter_get_xprt(struct rpc_xprt_iter *xpi);
73 extern struct rpc_xprt *xprt_iter_get_next(struct rpc_xprt_iter *xpi);
74 
75 extern bool rpc_xprt_switch_has_addr(struct rpc_xprt_switch *xps,
76 		const struct sockaddr *sap);
77 
78 extern void xprt_multipath_cleanup_ids(void);
79 
80 #endif
81