1
2
3
4
5
6
7
8
9#ifndef _LINUX_SUNRPC_CLNT_H
10#define _LINUX_SUNRPC_CLNT_H
11
12#include <linux/types.h>
13#include <linux/socket.h>
14#include <linux/in.h>
15#include <linux/in6.h>
16
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 <linux/sunrpc/rpc_pipe_fs.h>
25#include <asm/signal.h>
26#include <linux/path.h>
27#include <net/ipv6.h>
28#include <linux/sunrpc/xprtmultipath.h>
29
30struct rpc_inode;
31
32
33
34
35struct rpc_clnt {
36 atomic_t cl_count;
37 unsigned int cl_clid;
38 struct list_head cl_clients;
39 struct list_head cl_tasks;
40 spinlock_t cl_lock;
41 struct rpc_xprt __rcu * cl_xprt;
42 struct rpc_procinfo * cl_procinfo;
43 u32 cl_prog,
44 cl_vers,
45 cl_maxproc;
46
47 struct rpc_auth * cl_auth;
48 struct rpc_stat * cl_stats;
49 struct rpc_iostats * cl_metrics;
50
51 unsigned int cl_softrtry : 1,
52 cl_discrtry : 1,
53 cl_noretranstimeo: 1,
54 cl_autobind : 1,
55 cl_chatty : 1;
56
57 struct rpc_rtt * cl_rtt;
58 const struct rpc_timeout *cl_timeout;
59
60 atomic_t cl_swapper;
61 int cl_nodelen;
62 char cl_nodename[UNX_MAXNODENAME+1];
63 struct rpc_pipe_dir_head cl_pipedir_objects;
64 struct rpc_clnt * cl_parent;
65 struct rpc_rtt cl_rtt_default;
66 struct rpc_timeout cl_timeout_default;
67 const struct rpc_program *cl_program;
68#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
69 struct dentry *cl_debugfs;
70#endif
71 struct rpc_xprt_iter cl_xpi;
72};
73
74
75
76
77#define RPC_MAXVERSION 4
78struct rpc_program {
79 const char * name;
80 u32 number;
81 unsigned int nrvers;
82 const struct rpc_version ** version;
83 struct rpc_stat * stats;
84 const char * pipe_dir_name;
85};
86
87struct rpc_version {
88 u32 number;
89 unsigned int nrprocs;
90 struct rpc_procinfo * procs;
91};
92
93
94
95
96struct rpc_procinfo {
97 u32 p_proc;
98 kxdreproc_t p_encode;
99 kxdrdproc_t p_decode;
100 unsigned int p_arglen;
101 unsigned int p_replen;
102 unsigned int p_count;
103 unsigned int p_timer;
104 u32 p_statidx;
105 const char * p_name;
106};
107
108#ifdef __KERNEL__
109
110struct rpc_create_args {
111 struct net *net;
112 int protocol;
113 struct sockaddr *address;
114 size_t addrsize;
115 struct sockaddr *saddress;
116 const struct rpc_timeout *timeout;
117 const char *servername;
118 const char *nodename;
119 const struct rpc_program *program;
120 u32 prognumber;
121 u32 version;
122 rpc_authflavor_t authflavor;
123 unsigned long flags;
124 char *client_name;
125 struct svc_xprt *bc_xprt;
126};
127
128
129#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
130#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
131#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
132#define RPC_CLNT_CREATE_NOPING (1UL << 4)
133#define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
134#define RPC_CLNT_CREATE_QUIET (1UL << 6)
135#define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7)
136#define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
137#define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9)
138
139struct rpc_clnt *rpc_create(struct rpc_create_args *args);
140struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
141 const struct rpc_program *, u32);
142struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
143struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
144 rpc_authflavor_t);
145int rpc_switch_client_transport(struct rpc_clnt *,
146 struct xprt_create *,
147 const struct rpc_timeout *);
148
149void rpc_shutdown_client(struct rpc_clnt *);
150void rpc_release_client(struct rpc_clnt *);
151void rpc_task_release_client(struct rpc_task *);
152
153int rpcb_create_local(struct net *);
154void rpcb_put_local(struct net *);
155int rpcb_register(struct net *, u32, u32, int, unsigned short);
156int rpcb_v4_register(struct net *net, const u32 program,
157 const u32 version,
158 const struct sockaddr *address,
159 const char *netid);
160void rpcb_getport_async(struct rpc_task *);
161
162void rpc_call_start(struct rpc_task *);
163int rpc_call_async(struct rpc_clnt *clnt,
164 const struct rpc_message *msg, int flags,
165 const struct rpc_call_ops *tk_ops,
166 void *calldata);
167int rpc_call_sync(struct rpc_clnt *clnt,
168 const struct rpc_message *msg, int flags);
169struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
170 int flags);
171int rpc_restart_call_prepare(struct rpc_task *);
172int rpc_restart_call(struct rpc_task *);
173void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
174int rpc_protocol(struct rpc_clnt *);
175struct net * rpc_net_ns(struct rpc_clnt *);
176size_t rpc_max_payload(struct rpc_clnt *);
177size_t rpc_max_bc_payload(struct rpc_clnt *);
178unsigned long rpc_get_timeout(struct rpc_clnt *clnt);
179void rpc_force_rebind(struct rpc_clnt *);
180size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
181const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
182int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
183
184int rpc_clnt_iterate_for_each_xprt(struct rpc_clnt *clnt,
185 int (*fn)(struct rpc_clnt *, struct rpc_xprt *, void *),
186 void *data);
187
188int rpc_clnt_test_and_add_xprt(struct rpc_clnt *clnt,
189 struct rpc_xprt_switch *xps,
190 struct rpc_xprt *xprt,
191 void *dummy);
192int rpc_clnt_add_xprt(struct rpc_clnt *, struct xprt_create *,
193 int (*setup)(struct rpc_clnt *,
194 struct rpc_xprt_switch *,
195 struct rpc_xprt *,
196 void *),
197 void *data);
198
199const char *rpc_proc_name(const struct rpc_task *task);
200#endif
201#endif
202