Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * linux/include/linux/sunrpc/clnt.h
3 *
4 * Declarations for the high-level RPC client interface
5 *
6 * Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
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 * The high-level client handle
34 */
35struct rpc_clnt {
36 atomic_t cl_count; /* Number of references */
37 unsigned int cl_clid; /* client id */
38 struct list_head cl_clients; /* Global list of clients */
39 struct list_head cl_tasks; /* List of tasks */
40 spinlock_t cl_lock; /* spinlock */
41 struct rpc_xprt __rcu * cl_xprt; /* transport */
42 struct rpc_procinfo * cl_procinfo; /* procedure info */
43 u32 cl_prog, /* RPC program number */
44 cl_vers, /* RPC version number */
45 cl_maxproc; /* max procedure number */
46
47 struct rpc_auth * cl_auth; /* authenticator */
48 struct rpc_stat * cl_stats; /* per-program statistics */
49 struct rpc_iostats * cl_metrics; /* per-client statistics */
50
51 unsigned int cl_softrtry : 1,/* soft timeouts */
52 cl_discrtry : 1,/* disconnect before retry */
53 cl_noretranstimeo: 1,/* No retransmit timeouts */
54 cl_autobind : 1,/* use getport() */
55 cl_chatty : 1;/* be verbose */
56
57 struct rpc_rtt * cl_rtt; /* RTO estimator data */
58 const struct rpc_timeout *cl_timeout; /* Timeout strategy */
59
60 atomic_t cl_swapper; /* swapfile count */
61 int cl_nodelen; /* nodename length */
62 char cl_nodename[UNX_MAXNODENAME+1];
63 struct rpc_pipe_dir_head cl_pipedir_objects;
64 struct rpc_clnt * cl_parent; /* Points to parent of clones */
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; /* debugfs directory */
70#endif
71 struct rpc_xprt_iter cl_xpi;
72};
73
74/*
75 * General RPC program info
76 */
77#define RPC_MAXVERSION 4
78struct rpc_program {
79 const char * name; /* protocol name */
80 u32 number; /* program number */
81 unsigned int nrvers; /* number of versions */
82 const struct rpc_version ** version; /* version array */
83 struct rpc_stat * stats; /* statistics */
84 const char * pipe_dir_name; /* path to rpc_pipefs dir */
85};
86
87struct rpc_version {
88 u32 number; /* version number */
89 unsigned int nrprocs; /* number of procs */
90 struct rpc_procinfo * procs; /* procedure array */
91};
92
93/*
94 * Procedure information
95 */
96struct rpc_procinfo {
97 u32 p_proc; /* RPC procedure number */
98 kxdreproc_t p_encode; /* XDR encode function */
99 kxdrdproc_t p_decode; /* XDR decode function */
100 unsigned int p_arglen; /* argument hdr length (u32) */
101 unsigned int p_replen; /* reply hdr length (u32) */
102 unsigned int p_count; /* call count */
103 unsigned int p_timer; /* Which RTT timer to use */
104 u32 p_statidx; /* Which procedure to account */
105 const char * p_name; /* name of procedure */
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; /* overrides program->number */
121 u32 version;
122 rpc_authflavor_t authflavor;
123 unsigned long flags;
124 char *client_name;
125 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
126};
127
128/* Values for "flags" field */
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);
198void rpc_cap_max_reconnect_timeout(struct rpc_clnt *clnt,
199 unsigned long timeo);
200
201const char *rpc_proc_name(const struct rpc_task *task);
202#endif /* __KERNEL__ */
203#endif /* _LINUX_SUNRPC_CLNT_H */