2 * linux/include/linux/sunrpc/clnt.h
4 * Declarations for the high-level RPC client interface
6 * Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
9 #ifndef _LINUX_SUNRPC_CLNT_H
10 #define _LINUX_SUNRPC_CLNT_H
12 #include <linux/types.h>
13 #include <linux/socket.h>
15 #include <linux/in6.h>
17 #include <linux/sunrpc/msg_prot.h>
18 #include <linux/sunrpc/sched.h>
19 #include <linux/sunrpc/xprt.h>
20 #include <linux/sunrpc/auth.h>
21 #include <linux/sunrpc/stats.h>
22 #include <linux/sunrpc/xdr.h>
23 #include <linux/sunrpc/timer.h>
24 #include <asm/signal.h>
25 #include <linux/path.h>
31 * The high-level client handle
34 atomic_t cl_count; /* Number of references */
35 struct list_head cl_clients; /* Global list of clients */
36 struct list_head cl_tasks; /* List of tasks */
37 spinlock_t cl_lock; /* spinlock */
38 struct rpc_xprt __rcu * cl_xprt; /* transport */
39 struct rpc_procinfo * cl_procinfo; /* procedure info */
40 u32 cl_prog, /* RPC program number */
41 cl_vers, /* RPC version number */
42 cl_maxproc; /* max procedure number */
44 const char * cl_protname; /* protocol name */
45 struct rpc_auth * cl_auth; /* authenticator */
46 struct rpc_stat * cl_stats; /* per-program statistics */
47 struct rpc_iostats * cl_metrics; /* per-client statistics */
49 unsigned int cl_softrtry : 1,/* soft timeouts */
50 cl_discrtry : 1,/* disconnect before retry */
51 cl_autobind : 1,/* use getport() */
52 cl_chatty : 1;/* be verbose */
54 struct rpc_rtt * cl_rtt; /* RTO estimator data */
55 const struct rpc_timeout *cl_timeout; /* Timeout strategy */
57 int cl_nodelen; /* nodename length */
58 char cl_nodename[UNX_MAXNODENAME];
59 struct dentry * cl_dentry;
60 struct rpc_clnt * cl_parent; /* Points to parent of clones */
61 struct rpc_rtt cl_rtt_default;
62 struct rpc_timeout cl_timeout_default;
63 const struct rpc_program *cl_program;
64 char *cl_principal; /* target to authenticate to */
68 * General RPC program info
70 #define RPC_MAXVERSION 4
72 const char * name; /* protocol name */
73 u32 number; /* program number */
74 unsigned int nrvers; /* number of versions */
75 const struct rpc_version ** version; /* version array */
76 struct rpc_stat * stats; /* statistics */
77 const char * pipe_dir_name; /* path to rpc_pipefs dir */
81 u32 number; /* version number */
82 unsigned int nrprocs; /* number of procs */
83 struct rpc_procinfo * procs; /* procedure array */
87 * Procedure information
90 u32 p_proc; /* RPC procedure number */
91 kxdreproc_t p_encode; /* XDR encode function */
92 kxdrdproc_t p_decode; /* XDR decode function */
93 unsigned int p_arglen; /* argument hdr length (u32) */
94 unsigned int p_replen; /* reply hdr length (u32) */
95 unsigned int p_count; /* call count */
96 unsigned int p_timer; /* Which RTT timer to use */
97 u32 p_statidx; /* Which procedure to account */
98 const char * p_name; /* name of procedure */
103 struct rpc_create_args {
106 struct sockaddr *address;
108 struct sockaddr *saddress;
109 const struct rpc_timeout *timeout;
110 const char *servername;
111 const struct rpc_program *program;
112 u32 prognumber; /* overrides program->number */
114 rpc_authflavor_t authflavor;
117 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
120 /* Values for "flags" field */
121 #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
122 #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
123 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
124 #define RPC_CLNT_CREATE_NOPING (1UL << 4)
125 #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
126 #define RPC_CLNT_CREATE_QUIET (1UL << 6)
128 struct rpc_clnt *rpc_create(struct rpc_create_args *args);
129 struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
130 const struct rpc_program *, u32);
131 void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
132 struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
133 void rpc_shutdown_client(struct rpc_clnt *);
134 void rpc_release_client(struct rpc_clnt *);
135 void rpc_task_release_client(struct rpc_task *);
137 int rpcb_create_local(struct net *);
138 void rpcb_put_local(struct net *);
139 int rpcb_register(struct net *, u32, u32, int, unsigned short);
140 int rpcb_v4_register(struct net *net, const u32 program,
142 const struct sockaddr *address,
144 void rpcb_getport_async(struct rpc_task *);
146 void rpc_call_start(struct rpc_task *);
147 int rpc_call_async(struct rpc_clnt *clnt,
148 const struct rpc_message *msg, int flags,
149 const struct rpc_call_ops *tk_ops,
151 int rpc_call_sync(struct rpc_clnt *clnt,
152 const struct rpc_message *msg, int flags);
153 struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
155 int rpc_restart_call_prepare(struct rpc_task *);
156 int rpc_restart_call(struct rpc_task *);
157 void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
158 int rpc_protocol(struct rpc_clnt *);
159 struct net * rpc_net_ns(struct rpc_clnt *);
160 size_t rpc_max_payload(struct rpc_clnt *);
161 void rpc_force_rebind(struct rpc_clnt *);
162 size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
163 const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
164 int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
166 size_t rpc_ntop(const struct sockaddr *, char *, const size_t);
167 size_t rpc_pton(struct net *, const char *, const size_t,
168 struct sockaddr *, const size_t);
169 char * rpc_sockaddr2uaddr(const struct sockaddr *, gfp_t);
170 size_t rpc_uaddr2sockaddr(struct net *, const char *, const size_t,
171 struct sockaddr *, const size_t);
173 static inline unsigned short rpc_get_port(const struct sockaddr *sap)
175 switch (sap->sa_family) {
177 return ntohs(((struct sockaddr_in *)sap)->sin_port);
179 return ntohs(((struct sockaddr_in6 *)sap)->sin6_port);
184 static inline void rpc_set_port(struct sockaddr *sap,
185 const unsigned short port)
187 switch (sap->sa_family) {
189 ((struct sockaddr_in *)sap)->sin_port = htons(port);
192 ((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
197 #define IPV6_SCOPE_DELIMITER '%'
198 #define IPV6_SCOPE_ID_LEN sizeof("%nnnnnnnnnn")
200 static inline bool __rpc_cmp_addr4(const struct sockaddr *sap1,
201 const struct sockaddr *sap2)
203 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
204 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
206 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
209 static inline bool __rpc_copy_addr4(struct sockaddr *dst,
210 const struct sockaddr *src)
212 const struct sockaddr_in *ssin = (struct sockaddr_in *) src;
213 struct sockaddr_in *dsin = (struct sockaddr_in *) dst;
215 dsin->sin_family = ssin->sin_family;
216 dsin->sin_addr.s_addr = ssin->sin_addr.s_addr;
220 #if IS_ENABLED(CONFIG_IPV6)
221 static inline bool __rpc_cmp_addr6(const struct sockaddr *sap1,
222 const struct sockaddr *sap2)
224 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
225 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
227 if (!ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr))
229 else if (ipv6_addr_type(&sin1->sin6_addr) & IPV6_ADDR_LINKLOCAL)
230 return sin1->sin6_scope_id == sin2->sin6_scope_id;
235 static inline bool __rpc_copy_addr6(struct sockaddr *dst,
236 const struct sockaddr *src)
238 const struct sockaddr_in6 *ssin6 = (const struct sockaddr_in6 *) src;
239 struct sockaddr_in6 *dsin6 = (struct sockaddr_in6 *) dst;
241 dsin6->sin6_family = ssin6->sin6_family;
242 dsin6->sin6_addr = ssin6->sin6_addr;
245 #else /* !(IS_ENABLED(CONFIG_IPV6) */
246 static inline bool __rpc_cmp_addr6(const struct sockaddr *sap1,
247 const struct sockaddr *sap2)
252 static inline bool __rpc_copy_addr6(struct sockaddr *dst,
253 const struct sockaddr *src)
257 #endif /* !(IS_ENABLED(CONFIG_IPV6) */
260 * rpc_cmp_addr - compare the address portion of two sockaddrs.
261 * @sap1: first sockaddr
262 * @sap2: second sockaddr
264 * Just compares the family and address portion. Ignores port, scope, etc.
265 * Returns true if the addrs are equal, false if they aren't.
267 static inline bool rpc_cmp_addr(const struct sockaddr *sap1,
268 const struct sockaddr *sap2)
270 if (sap1->sa_family == sap2->sa_family) {
271 switch (sap1->sa_family) {
273 return __rpc_cmp_addr4(sap1, sap2);
275 return __rpc_cmp_addr6(sap1, sap2);
282 * rpc_copy_addr - copy the address portion of one sockaddr to another
283 * @dst: destination sockaddr
284 * @src: source sockaddr
286 * Just copies the address portion and family. Ignores port, scope, etc.
287 * Caller is responsible for making certain that dst is large enough to hold
288 * the address in src. Returns true if address family is supported. Returns
291 static inline bool rpc_copy_addr(struct sockaddr *dst,
292 const struct sockaddr *src)
294 switch (src->sa_family) {
296 return __rpc_copy_addr4(dst, src);
298 return __rpc_copy_addr6(dst, src);
304 * rpc_get_scope_id - return scopeid for a given sockaddr
305 * @sa: sockaddr to get scopeid from
307 * Returns the value of the sin6_scope_id for AF_INET6 addrs, or 0 if
308 * not an AF_INET6 address.
310 static inline u32 rpc_get_scope_id(const struct sockaddr *sa)
312 if (sa->sa_family != AF_INET6)
315 return ((struct sockaddr_in6 *) sa)->sin6_scope_id;
318 #endif /* __KERNEL__ */
319 #endif /* _LINUX_SUNRPC_CLNT_H */