xref: /openbmc/linux/include/linux/sunrpc/clnt.h (revision c4d324c4)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *  linux/include/linux/sunrpc/clnt.h
4  *
5  *  Declarations for the high-level RPC client interface
6  *
7  *  Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
8  */
9 
10 #ifndef _LINUX_SUNRPC_CLNT_H
11 #define _LINUX_SUNRPC_CLNT_H
12 
13 #include <linux/types.h>
14 #include <linux/socket.h>
15 #include <linux/in.h>
16 #include <linux/in6.h>
17 #include <linux/refcount.h>
18 
19 #include <linux/sunrpc/msg_prot.h>
20 #include <linux/sunrpc/sched.h>
21 #include <linux/sunrpc/xprt.h>
22 #include <linux/sunrpc/auth.h>
23 #include <linux/sunrpc/stats.h>
24 #include <linux/sunrpc/xdr.h>
25 #include <linux/sunrpc/timer.h>
26 #include <linux/sunrpc/rpc_pipe_fs.h>
27 #include <asm/signal.h>
28 #include <linux/path.h>
29 #include <net/ipv6.h>
30 #include <linux/sunrpc/xprtmultipath.h>
31 
32 struct rpc_inode;
33 struct rpc_sysfs_client {
34 	struct kobject kobject;
35 	struct net *net;
36 	struct rpc_clnt *clnt;
37 	struct rpc_xprt_switch *xprt_switch;
38 };
39 
40 
41 /*
42  * The high-level client handle
43  */
44 struct rpc_clnt {
45 	refcount_t		cl_count;	/* Number of references */
46 	unsigned int		cl_clid;	/* client id */
47 	struct list_head	cl_clients;	/* Global list of clients */
48 	struct list_head	cl_tasks;	/* List of tasks */
49 	atomic_t		cl_pid;		/* task PID counter */
50 	spinlock_t		cl_lock;	/* spinlock */
51 	struct rpc_xprt __rcu *	cl_xprt;	/* transport */
52 	const struct rpc_procinfo *cl_procinfo;	/* procedure info */
53 	u32			cl_prog,	/* RPC program number */
54 				cl_vers,	/* RPC version number */
55 				cl_maxproc;	/* max procedure number */
56 
57 	struct rpc_auth *	cl_auth;	/* authenticator */
58 	struct rpc_stat *	cl_stats;	/* per-program statistics */
59 	struct rpc_iostats *	cl_metrics;	/* per-client statistics */
60 
61 	unsigned int		cl_softrtry : 1,/* soft timeouts */
62 				cl_softerr  : 1,/* Timeouts return errors */
63 				cl_discrtry : 1,/* disconnect before retry */
64 				cl_noretranstimeo: 1,/* No retransmit timeouts */
65 				cl_autobind : 1,/* use getport() */
66 				cl_chatty   : 1,/* be verbose */
67 				cl_shutdown : 1;/* rpc immediate -EIO */
68 	struct xprtsec_parms	cl_xprtsec;	/* transport security policy */
69 
70 	struct rpc_rtt *	cl_rtt;		/* RTO estimator data */
71 	const struct rpc_timeout *cl_timeout;	/* Timeout strategy */
72 
73 	atomic_t		cl_swapper;	/* swapfile count */
74 	int			cl_nodelen;	/* nodename length */
75 	char 			cl_nodename[UNX_MAXNODENAME+1];
76 	struct rpc_pipe_dir_head cl_pipedir_objects;
77 	struct rpc_clnt *	cl_parent;	/* Points to parent of clones */
78 	struct rpc_rtt		cl_rtt_default;
79 	struct rpc_timeout	cl_timeout_default;
80 	const struct rpc_program *cl_program;
81 	const char *		cl_principal;	/* use for machine cred */
82 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
83 	struct dentry		*cl_debugfs;	/* debugfs directory */
84 #endif
85 	struct rpc_sysfs_client *cl_sysfs;	/* sysfs directory */
86 	/* cl_work is only needed after cl_xpi is no longer used,
87 	 * and that are of similar size
88 	 */
89 	union {
90 		struct rpc_xprt_iter	cl_xpi;
91 		struct work_struct	cl_work;
92 	};
93 	const struct cred	*cl_cred;
94 	unsigned int		cl_max_connect; /* max number of transports not to the same IP */
95 	struct super_block *pipefs_sb;
96 };
97 
98 /*
99  * General RPC program info
100  */
101 #define RPC_MAXVERSION		4
102 struct rpc_program {
103 	const char *		name;		/* protocol name */
104 	u32			number;		/* program number */
105 	unsigned int		nrvers;		/* number of versions */
106 	const struct rpc_version **	version;	/* version array */
107 	struct rpc_stat *	stats;		/* statistics */
108 	const char *		pipe_dir_name;	/* path to rpc_pipefs dir */
109 };
110 
111 struct rpc_version {
112 	u32			number;		/* version number */
113 	unsigned int		nrprocs;	/* number of procs */
114 	const struct rpc_procinfo *procs;	/* procedure array */
115 	unsigned int		*counts;	/* call counts */
116 };
117 
118 /*
119  * Procedure information
120  */
121 struct rpc_procinfo {
122 	u32			p_proc;		/* RPC procedure number */
123 	kxdreproc_t		p_encode;	/* XDR encode function */
124 	kxdrdproc_t		p_decode;	/* XDR decode function */
125 	unsigned int		p_arglen;	/* argument hdr length (u32) */
126 	unsigned int		p_replen;	/* reply hdr length (u32) */
127 	unsigned int		p_timer;	/* Which RTT timer to use */
128 	u32			p_statidx;	/* Which procedure to account */
129 	const char *		p_name;		/* name of procedure */
130 };
131 
132 struct rpc_create_args {
133 	struct net		*net;
134 	int			protocol;
135 	struct sockaddr		*address;
136 	size_t			addrsize;
137 	struct sockaddr		*saddress;
138 	const struct rpc_timeout *timeout;
139 	const char		*servername;
140 	const char		*nodename;
141 	const struct rpc_program *program;
142 	struct rpc_stat		*stats;
143 	u32			prognumber;	/* overrides program->number */
144 	u32			version;
145 	rpc_authflavor_t	authflavor;
146 	u32			nconnect;
147 	unsigned long		flags;
148 	char			*client_name;
149 	struct svc_xprt		*bc_xprt;	/* NFSv4.1 backchannel */
150 	const struct cred	*cred;
151 	unsigned int		max_connect;
152 	struct xprtsec_parms	xprtsec;
153 	unsigned long		connect_timeout;
154 	unsigned long		reconnect_timeout;
155 };
156 
157 struct rpc_add_xprt_test {
158 	void (*add_xprt_test)(struct rpc_clnt *clnt,
159 		struct rpc_xprt *xprt,
160 		void *calldata);
161 	void *data;
162 };
163 
164 /* Values for "flags" field */
165 #define RPC_CLNT_CREATE_HARDRTRY	(1UL << 0)
166 #define RPC_CLNT_CREATE_AUTOBIND	(1UL << 2)
167 #define RPC_CLNT_CREATE_NONPRIVPORT	(1UL << 3)
168 #define RPC_CLNT_CREATE_NOPING		(1UL << 4)
169 #define RPC_CLNT_CREATE_DISCRTRY	(1UL << 5)
170 #define RPC_CLNT_CREATE_QUIET		(1UL << 6)
171 #define RPC_CLNT_CREATE_INFINITE_SLOTS	(1UL << 7)
172 #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT	(1UL << 8)
173 #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT	(1UL << 9)
174 #define RPC_CLNT_CREATE_SOFTERR		(1UL << 10)
175 #define RPC_CLNT_CREATE_REUSEPORT	(1UL << 11)
176 #define RPC_CLNT_CREATE_CONNECTED	(1UL << 12)
177 
178 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
179 struct rpc_clnt	*rpc_bind_new_program(struct rpc_clnt *,
180 				const struct rpc_program *, u32);
181 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
182 struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
183 				rpc_authflavor_t);
184 int		rpc_switch_client_transport(struct rpc_clnt *,
185 				struct xprt_create *,
186 				const struct rpc_timeout *);
187 
188 void		rpc_shutdown_client(struct rpc_clnt *);
189 void		rpc_release_client(struct rpc_clnt *);
190 void		rpc_task_release_transport(struct rpc_task *);
191 void		rpc_task_release_client(struct rpc_task *);
192 struct rpc_xprt	*rpc_task_get_xprt(struct rpc_clnt *clnt,
193 		struct rpc_xprt *xprt);
194 
195 int		rpcb_create_local(struct net *);
196 void		rpcb_put_local(struct net *);
197 int		rpcb_register(struct net *, u32, u32, int, unsigned short);
198 int		rpcb_v4_register(struct net *net, const u32 program,
199 				 const u32 version,
200 				 const struct sockaddr *address,
201 				 const char *netid);
202 void		rpcb_getport_async(struct rpc_task *);
203 
204 void rpc_prepare_reply_pages(struct rpc_rqst *req, struct page **pages,
205 			     unsigned int base, unsigned int len,
206 			     unsigned int hdrsize);
207 void		rpc_call_start(struct rpc_task *);
208 int		rpc_call_async(struct rpc_clnt *clnt,
209 			       const struct rpc_message *msg, int flags,
210 			       const struct rpc_call_ops *tk_ops,
211 			       void *calldata);
212 int		rpc_call_sync(struct rpc_clnt *clnt,
213 			      const struct rpc_message *msg, int flags);
214 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
215 			       int flags);
216 int		rpc_restart_call_prepare(struct rpc_task *);
217 int		rpc_restart_call(struct rpc_task *);
218 void		rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
219 struct net *	rpc_net_ns(struct rpc_clnt *);
220 size_t		rpc_max_payload(struct rpc_clnt *);
221 size_t		rpc_max_bc_payload(struct rpc_clnt *);
222 unsigned int	rpc_num_bc_slots(struct rpc_clnt *);
223 void		rpc_force_rebind(struct rpc_clnt *);
224 size_t		rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
225 const char	*rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
226 int		rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
227 
228 int 		rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
229 			int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
230 			void *data);
231 
232 int 		rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
233 			struct rpc_xprt_switch *xps,
234 			struct rpc_xprt *xprt,
235 			void *dummy);
236 int		rpc_clnt_add_xprt(struct rpc_clnt *, struct xprt_create *,
237 			int (*setup)(struct rpc_clnt *,
238 				struct rpc_xprt_switch *,
239 				struct rpc_xprt *,
240 				void *),
241 			void *data);
242 void		rpc_set_connect_timeout(struct rpc_clnt *clnt,
243 			unsigned long connect_timeout,
244 			unsigned long reconnect_timeout);
245 
246 int		rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt *,
247 			struct rpc_xprt_switch *,
248 			struct rpc_xprt *,
249 			void *);
250 void		rpc_clnt_manage_trunked_xprts(struct rpc_clnt *);
251 void		rpc_clnt_probe_trunked_xprts(struct rpc_clnt *,
252 			struct rpc_add_xprt_test *);
253 
254 const char *rpc_proc_name(const struct rpc_task *task);
255 
256 void rpc_clnt_xprt_switch_put(struct rpc_clnt *);
257 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt *, struct rpc_xprt *);
258 void rpc_clnt_xprt_switch_remove_xprt(struct rpc_clnt *, struct rpc_xprt *);
259 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt *clnt,
260 			const struct sockaddr *sap);
261 void rpc_clnt_xprt_set_online(struct rpc_clnt *clnt, struct rpc_xprt *xprt);
262 void rpc_clnt_disconnect(struct rpc_clnt *clnt);
263 void rpc_cleanup_clids(void);
264 
rpc_reply_expected(struct rpc_task * task)265 static inline int rpc_reply_expected(struct rpc_task *task)
266 {
267 	return (task->tk_msg.rpc_proc != NULL) &&
268 		(task->tk_msg.rpc_proc->p_decode != NULL);
269 }
270 
rpc_task_close_connection(struct rpc_task * task)271 static inline void rpc_task_close_connection(struct rpc_task *task)
272 {
273 	if (task->tk_xprt)
274 		xprt_force_disconnect(task->tk_xprt);
275 }
276 #endif /* _LINUX_SUNRPC_CLNT_H */
277