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/socket.h>
14 #include <linux/in6.h>
16 #include <linux/sunrpc/msg_prot.h>
17 #include <linux/sunrpc/sched.h>
18 #include <linux/sunrpc/xprt.h>
19 #include <linux/sunrpc/auth.h>
20 #include <linux/sunrpc/stats.h>
21 #include <linux/sunrpc/xdr.h>
22 #include <linux/sunrpc/timer.h>
23 #include <asm/signal.h>
24 #include <linux/path.h>
30 * The high-level client handle
33 struct kref cl_kref
; /* Number of references */
34 struct list_head cl_clients
; /* Global list of clients */
35 struct list_head cl_tasks
; /* List of tasks */
36 spinlock_t cl_lock
; /* spinlock */
37 struct rpc_xprt
* cl_xprt
; /* transport */
38 struct rpc_procinfo
* cl_procinfo
; /* procedure info */
39 u32 cl_prog
, /* RPC program number */
40 cl_vers
, /* RPC version number */
41 cl_maxproc
; /* max procedure number */
43 char * cl_server
; /* server machine name */
44 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
];
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 struct rpc_program
* cl_program
;
64 char cl_inline_name
[32];
65 char *cl_principal
; /* target to authenticate to */
69 * General RPC program info
71 #define RPC_MAXVERSION 4
73 char * name
; /* protocol name */
74 u32 number
; /* program number */
75 unsigned int nrvers
; /* number of versions */
76 struct rpc_version
** version
; /* version array */
77 struct rpc_stat
* stats
; /* statistics */
78 char * pipe_dir_name
; /* path to rpc_pipefs dir */
82 u32 number
; /* version number */
83 unsigned int nrprocs
; /* number of procs */
84 struct rpc_procinfo
* procs
; /* procedure array */
88 * Procedure information
91 u32 p_proc
; /* RPC procedure number */
92 kxdrproc_t p_encode
; /* XDR encode function */
93 kxdrproc_t p_decode
; /* XDR decode function */
94 unsigned int p_arglen
; /* argument hdr length (u32) */
95 unsigned int p_replen
; /* reply hdr length (u32) */
96 unsigned int p_count
; /* call count */
97 unsigned int p_timer
; /* Which RTT timer to use */
98 u32 p_statidx
; /* Which procedure to account */
99 char * p_name
; /* name of procedure */
104 struct rpc_create_args
{
106 struct sockaddr
*address
;
108 struct sockaddr
*saddress
;
109 const struct rpc_timeout
*timeout
;
111 struct rpc_program
*program
;
112 u32 prognumber
; /* overrides program->number */
114 rpc_authflavor_t authflavor
;
119 /* Values for "flags" field */
120 #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
121 #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
122 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
123 #define RPC_CLNT_CREATE_NOPING (1UL << 4)
124 #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
125 #define RPC_CLNT_CREATE_QUIET (1UL << 6)
127 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
);
128 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*,
129 struct rpc_program
*, u32
);
130 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*);
131 void rpc_shutdown_client(struct rpc_clnt
*);
132 void rpc_release_client(struct rpc_clnt
*);
134 int rpcb_register(u32
, u32
, int, unsigned short);
135 int rpcb_v4_register(const u32 program
, const u32 version
,
136 const struct sockaddr
*address
,
138 int rpcb_getport_sync(struct sockaddr_in
*, u32
, u32
, int);
139 void rpcb_getport_async(struct rpc_task
*);
141 void rpc_call_start(struct rpc_task
*);
142 int rpc_call_async(struct rpc_clnt
*clnt
,
143 const struct rpc_message
*msg
, int flags
,
144 const struct rpc_call_ops
*tk_ops
,
146 int rpc_call_sync(struct rpc_clnt
*clnt
,
147 const struct rpc_message
*msg
, int flags
);
148 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
,
150 void rpc_restart_call_prepare(struct rpc_task
*);
151 void rpc_restart_call(struct rpc_task
*);
152 void rpc_setbufsize(struct rpc_clnt
*, unsigned int, unsigned int);
153 size_t rpc_max_payload(struct rpc_clnt
*);
154 void rpc_force_rebind(struct rpc_clnt
*);
155 size_t rpc_peeraddr(struct rpc_clnt
*, struct sockaddr
*, size_t);
156 const char *rpc_peeraddr2str(struct rpc_clnt
*, enum rpc_display_format_t
);
158 size_t rpc_ntop(const struct sockaddr
*, char *, const size_t);
159 size_t rpc_pton(const char *, const size_t,
160 struct sockaddr
*, const size_t);
161 char * rpc_sockaddr2uaddr(const struct sockaddr
*);
162 size_t rpc_uaddr2sockaddr(const char *, const size_t,
163 struct sockaddr
*, const size_t);
165 static inline unsigned short rpc_get_port(const struct sockaddr
*sap
)
167 switch (sap
->sa_family
) {
169 return ntohs(((struct sockaddr_in
*)sap
)->sin_port
);
171 return ntohs(((struct sockaddr_in6
*)sap
)->sin6_port
);
176 static inline void rpc_set_port(struct sockaddr
*sap
,
177 const unsigned short port
)
179 switch (sap
->sa_family
) {
181 ((struct sockaddr_in
*)sap
)->sin_port
= htons(port
);
184 ((struct sockaddr_in6
*)sap
)->sin6_port
= htons(port
);
189 #define IPV6_SCOPE_DELIMITER '%'
190 #define IPV6_SCOPE_ID_LEN sizeof("%nnnnnnnnnn")
192 static inline bool __rpc_cmp_addr4(const struct sockaddr
*sap1
,
193 const struct sockaddr
*sap2
)
195 const struct sockaddr_in
*sin1
= (const struct sockaddr_in
*)sap1
;
196 const struct sockaddr_in
*sin2
= (const struct sockaddr_in
*)sap2
;
198 return sin1
->sin_addr
.s_addr
== sin2
->sin_addr
.s_addr
;
201 static inline bool __rpc_copy_addr4(struct sockaddr
*dst
,
202 const struct sockaddr
*src
)
204 const struct sockaddr_in
*ssin
= (struct sockaddr_in
*) src
;
205 struct sockaddr_in
*dsin
= (struct sockaddr_in
*) dst
;
207 dsin
->sin_family
= ssin
->sin_family
;
208 dsin
->sin_addr
.s_addr
= ssin
->sin_addr
.s_addr
;
212 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
213 static inline bool __rpc_cmp_addr6(const struct sockaddr
*sap1
,
214 const struct sockaddr
*sap2
)
216 const struct sockaddr_in6
*sin1
= (const struct sockaddr_in6
*)sap1
;
217 const struct sockaddr_in6
*sin2
= (const struct sockaddr_in6
*)sap2
;
218 return ipv6_addr_equal(&sin1
->sin6_addr
, &sin2
->sin6_addr
);
221 static inline bool __rpc_copy_addr6(struct sockaddr
*dst
,
222 const struct sockaddr
*src
)
224 const struct sockaddr_in6
*ssin6
= (const struct sockaddr_in6
*) src
;
225 struct sockaddr_in6
*dsin6
= (struct sockaddr_in6
*) dst
;
227 dsin6
->sin6_family
= ssin6
->sin6_family
;
228 ipv6_addr_copy(&dsin6
->sin6_addr
, &ssin6
->sin6_addr
);
231 #else /* !(CONFIG_IPV6 || CONFIG_IPV6_MODULE) */
232 static inline bool __rpc_cmp_addr6(const struct sockaddr
*sap1
,
233 const struct sockaddr
*sap2
)
238 static inline bool __rpc_copy_addr6(struct sockaddr
*dst
,
239 const struct sockaddr
*src
)
243 #endif /* !(CONFIG_IPV6 || CONFIG_IPV6_MODULE) */
246 * rpc_cmp_addr - compare the address portion of two sockaddrs.
247 * @sap1: first sockaddr
248 * @sap2: second sockaddr
250 * Just compares the family and address portion. Ignores port, scope, etc.
251 * Returns true if the addrs are equal, false if they aren't.
253 static inline bool rpc_cmp_addr(const struct sockaddr
*sap1
,
254 const struct sockaddr
*sap2
)
256 if (sap1
->sa_family
== sap2
->sa_family
) {
257 switch (sap1
->sa_family
) {
259 return __rpc_cmp_addr4(sap1
, sap2
);
261 return __rpc_cmp_addr6(sap1
, sap2
);
268 * rpc_copy_addr - copy the address portion of one sockaddr to another
269 * @dst: destination sockaddr
270 * @src: source sockaddr
272 * Just copies the address portion and family. Ignores port, scope, etc.
273 * Caller is responsible for making certain that dst is large enough to hold
274 * the address in src. Returns true if address family is supported. Returns
277 static inline bool rpc_copy_addr(struct sockaddr
*dst
,
278 const struct sockaddr
*src
)
280 switch (src
->sa_family
) {
282 return __rpc_copy_addr4(dst
, src
);
284 return __rpc_copy_addr6(dst
, src
);
290 * rpc_get_scope_id - return scopeid for a given sockaddr
291 * @sa: sockaddr to get scopeid from
293 * Returns the value of the sin6_scope_id for AF_INET6 addrs, or 0 if
294 * not an AF_INET6 address.
296 static inline u32
rpc_get_scope_id(const struct sockaddr
*sa
)
298 if (sa
->sa_family
!= AF_INET6
)
301 return ((struct sockaddr_in6
*) sa
)->sin6_scope_id
;
304 #endif /* __KERNEL__ */
305 #endif /* _LINUX_SUNRPC_CLNT_H */