1 /* SPDX-License-Identifier: GPL-2.0 */
3 * linux/include/linux/sunrpc/clnt.h
5 * Declarations for the high-level RPC client interface
7 * Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
10 #ifndef _LINUX_SUNRPC_CLNT_H
11 #define _LINUX_SUNRPC_CLNT_H
13 #include <linux/types.h>
14 #include <linux/socket.h>
16 #include <linux/in6.h>
18 #include <linux/sunrpc/msg_prot.h>
19 #include <linux/sunrpc/sched.h>
20 #include <linux/sunrpc/xprt.h>
21 #include <linux/sunrpc/auth.h>
22 #include <linux/sunrpc/stats.h>
23 #include <linux/sunrpc/xdr.h>
24 #include <linux/sunrpc/timer.h>
25 #include <linux/sunrpc/rpc_pipe_fs.h>
26 #include <asm/signal.h>
27 #include <linux/path.h>
29 #include <linux/sunrpc/xprtmultipath.h>
34 * The high-level client handle
37 atomic_t cl_count
; /* Number of references */
38 unsigned int cl_clid
; /* client id */
39 struct list_head cl_clients
; /* Global list of clients */
40 struct list_head cl_tasks
; /* List of tasks */
41 spinlock_t cl_lock
; /* spinlock */
42 struct rpc_xprt __rcu
* cl_xprt
; /* transport */
43 const struct rpc_procinfo
*cl_procinfo
; /* procedure info */
44 u32 cl_prog
, /* RPC program number */
45 cl_vers
, /* RPC version number */
46 cl_maxproc
; /* max procedure number */
48 struct rpc_auth
* cl_auth
; /* authenticator */
49 struct rpc_stat
* cl_stats
; /* per-program statistics */
50 struct rpc_iostats
* cl_metrics
; /* per-client statistics */
52 unsigned int cl_softrtry
: 1,/* soft timeouts */
53 cl_softerr
: 1,/* Timeouts return errors */
54 cl_discrtry
: 1,/* disconnect before retry */
55 cl_noretranstimeo
: 1,/* No retransmit timeouts */
56 cl_autobind
: 1,/* use getport() */
57 cl_chatty
: 1;/* be verbose */
59 struct rpc_rtt
* cl_rtt
; /* RTO estimator data */
60 const struct rpc_timeout
*cl_timeout
; /* Timeout strategy */
62 atomic_t cl_swapper
; /* swapfile count */
63 int cl_nodelen
; /* nodename length */
64 char cl_nodename
[UNX_MAXNODENAME
+1];
65 struct rpc_pipe_dir_head cl_pipedir_objects
;
66 struct rpc_clnt
* cl_parent
; /* Points to parent of clones */
67 struct rpc_rtt cl_rtt_default
;
68 struct rpc_timeout cl_timeout_default
;
69 const struct rpc_program
*cl_program
;
70 const char * cl_principal
; /* use for machine cred */
71 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
72 struct dentry
*cl_debugfs
; /* debugfs directory */
74 /* cl_work is only needed after cl_xpi is no longer used,
75 * and that are of similar size
78 struct rpc_xprt_iter cl_xpi
;
79 struct work_struct cl_work
;
81 const struct cred
*cl_cred
;
85 * General RPC program info
87 #define RPC_MAXVERSION 4
89 const char * name
; /* protocol name */
90 u32 number
; /* program number */
91 unsigned int nrvers
; /* number of versions */
92 const struct rpc_version
** version
; /* version array */
93 struct rpc_stat
* stats
; /* statistics */
94 const char * pipe_dir_name
; /* path to rpc_pipefs dir */
98 u32 number
; /* version number */
99 unsigned int nrprocs
; /* number of procs */
100 const struct rpc_procinfo
*procs
; /* procedure array */
101 unsigned int *counts
; /* call counts */
105 * Procedure information
107 struct rpc_procinfo
{
108 u32 p_proc
; /* RPC procedure number */
109 kxdreproc_t p_encode
; /* XDR encode function */
110 kxdrdproc_t p_decode
; /* XDR decode function */
111 unsigned int p_arglen
; /* argument hdr length (u32) */
112 unsigned int p_replen
; /* reply hdr length (u32) */
113 unsigned int p_timer
; /* Which RTT timer to use */
114 u32 p_statidx
; /* Which procedure to account */
115 const char * p_name
; /* name of procedure */
118 struct rpc_create_args
{
121 struct sockaddr
*address
;
123 struct sockaddr
*saddress
;
124 const struct rpc_timeout
*timeout
;
125 const char *servername
;
126 const char *nodename
;
127 const struct rpc_program
*program
;
128 u32 prognumber
; /* overrides program->number */
130 rpc_authflavor_t authflavor
;
134 struct svc_xprt
*bc_xprt
; /* NFSv4.1 backchannel */
135 const struct cred
*cred
;
138 struct rpc_add_xprt_test
{
139 void (*add_xprt_test
)(struct rpc_clnt
*clnt
,
140 struct rpc_xprt
*xprt
,
145 /* Values for "flags" field */
146 #define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
147 #define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
148 #define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
149 #define RPC_CLNT_CREATE_NOPING (1UL << 4)
150 #define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
151 #define RPC_CLNT_CREATE_QUIET (1UL << 6)
152 #define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7)
153 #define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
154 #define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9)
155 #define RPC_CLNT_CREATE_SOFTERR (1UL << 10)
156 #define RPC_CLNT_CREATE_REUSEPORT (1UL << 11)
158 struct rpc_clnt
*rpc_create(struct rpc_create_args
*args
);
159 struct rpc_clnt
*rpc_bind_new_program(struct rpc_clnt
*,
160 const struct rpc_program
*, u32
);
161 struct rpc_clnt
*rpc_clone_client(struct rpc_clnt
*);
162 struct rpc_clnt
*rpc_clone_client_set_auth(struct rpc_clnt
*,
164 int rpc_switch_client_transport(struct rpc_clnt
*,
165 struct xprt_create
*,
166 const struct rpc_timeout
*);
168 void rpc_shutdown_client(struct rpc_clnt
*);
169 void rpc_release_client(struct rpc_clnt
*);
170 void rpc_task_release_transport(struct rpc_task
*);
171 void rpc_task_release_client(struct rpc_task
*);
172 struct rpc_xprt
*rpc_task_get_xprt(struct rpc_clnt
*clnt
,
173 struct rpc_xprt
*xprt
);
175 int rpcb_create_local(struct net
*);
176 void rpcb_put_local(struct net
*);
177 int rpcb_register(struct net
*, u32
, u32
, int, unsigned short);
178 int rpcb_v4_register(struct net
*net
, const u32 program
,
180 const struct sockaddr
*address
,
182 void rpcb_getport_async(struct rpc_task
*);
184 void rpc_prepare_reply_pages(struct rpc_rqst
*req
, struct page
**pages
,
185 unsigned int base
, unsigned int len
,
186 unsigned int hdrsize
);
187 void rpc_call_start(struct rpc_task
*);
188 int rpc_call_async(struct rpc_clnt
*clnt
,
189 const struct rpc_message
*msg
, int flags
,
190 const struct rpc_call_ops
*tk_ops
,
192 int rpc_call_sync(struct rpc_clnt
*clnt
,
193 const struct rpc_message
*msg
, int flags
);
194 struct rpc_task
*rpc_call_null(struct rpc_clnt
*clnt
, struct rpc_cred
*cred
,
196 int rpc_restart_call_prepare(struct rpc_task
*);
197 int rpc_restart_call(struct rpc_task
*);
198 void rpc_setbufsize(struct rpc_clnt
*, unsigned int, unsigned int);
199 struct net
* rpc_net_ns(struct rpc_clnt
*);
200 size_t rpc_max_payload(struct rpc_clnt
*);
201 size_t rpc_max_bc_payload(struct rpc_clnt
*);
202 unsigned int rpc_num_bc_slots(struct rpc_clnt
*);
203 void rpc_force_rebind(struct rpc_clnt
*);
204 size_t rpc_peeraddr(struct rpc_clnt
*, struct sockaddr
*, size_t);
205 const char *rpc_peeraddr2str(struct rpc_clnt
*, enum rpc_display_format_t
);
206 int rpc_localaddr(struct rpc_clnt
*, struct sockaddr
*, size_t);
208 int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt
*clnt
,
209 int (*fn
)(struct rpc_clnt
*, struct rpc_xprt
*, void *),
212 int rpc_clnt_test_and_add_xprt(struct rpc_clnt
*clnt
,
213 struct rpc_xprt_switch
*xps
,
214 struct rpc_xprt
*xprt
,
216 int rpc_clnt_add_xprt(struct rpc_clnt
*, struct xprt_create
*,
217 int (*setup
)(struct rpc_clnt
*,
218 struct rpc_xprt_switch
*,
222 void rpc_set_connect_timeout(struct rpc_clnt
*clnt
,
223 unsigned long connect_timeout
,
224 unsigned long reconnect_timeout
);
226 int rpc_clnt_setup_test_and_add_xprt(struct rpc_clnt
*,
227 struct rpc_xprt_switch
*,
231 const char *rpc_proc_name(const struct rpc_task
*task
);
233 void rpc_clnt_xprt_switch_put(struct rpc_clnt
*);
234 void rpc_clnt_xprt_switch_add_xprt(struct rpc_clnt
*, struct rpc_xprt
*);
235 bool rpc_clnt_xprt_switch_has_addr(struct rpc_clnt
*clnt
,
236 const struct sockaddr
*sap
);
237 void rpc_cleanup_clids(void);
239 static inline int rpc_reply_expected(struct rpc_task
*task
)
241 return (task
->tk_msg
.rpc_proc
!= NULL
) &&
242 (task
->tk_msg
.rpc_proc
->p_decode
!= NULL
);
245 static inline void rpc_task_close_connection(struct rpc_task
*task
)
248 xprt_force_disconnect(task
->tk_xprt
);
250 #endif /* _LINUX_SUNRPC_CLNT_H */