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
29struct rpc_inode;
30
31/*
32 * The high-level client handle
33 */
34struct rpc_clnt {
35 atomic_t cl_count; /* Number of references */
36 unsigned int cl_clid; /* client id */
37 struct list_head cl_clients; /* Global list of clients */
38 struct list_head cl_tasks; /* List of tasks */
39 spinlock_t cl_lock; /* spinlock */
40 struct rpc_xprt __rcu * cl_xprt; /* transport */
41 struct rpc_procinfo * cl_procinfo; /* procedure info */
42 u32 cl_prog, /* RPC program number */
43 cl_vers, /* RPC version number */
44 cl_maxproc; /* max procedure number */
45
46 struct rpc_auth * cl_auth; /* authenticator */
47 struct rpc_stat * cl_stats; /* per-program statistics */
48 struct rpc_iostats * cl_metrics; /* per-client statistics */
49
50 unsigned int cl_softrtry : 1,/* soft timeouts */
51 cl_discrtry : 1,/* disconnect before retry */
52 cl_noretranstimeo: 1,/* No retransmit timeouts */
53 cl_autobind : 1,/* use getport() */
54 cl_chatty : 1;/* be verbose */
55
56 struct rpc_rtt * cl_rtt; /* RTO estimator data */
57 const struct rpc_timeout *cl_timeout; /* Timeout strategy */
58
59 atomic_t cl_swapper; /* swapfile count */
60 int cl_nodelen; /* nodename length */
61 char cl_nodename[UNX_MAXNODENAME+1];
62 struct rpc_pipe_dir_head cl_pipedir_objects;
63 struct rpc_clnt * cl_parent; /* Points to parent of clones */
64 struct rpc_rtt cl_rtt_default;
65 struct rpc_timeout cl_timeout_default;
66 const struct rpc_program *cl_program;
67#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
68 struct dentry *cl_debugfs; /* debugfs directory */
69#endif
70};
71
72/*
73 * General RPC program info
74 */
75#define RPC_MAXVERSION 4
76struct rpc_program {
77 const char * name; /* protocol name */
78 u32 number; /* program number */
79 unsigned int nrvers; /* number of versions */
80 const struct rpc_version ** version; /* version array */
81 struct rpc_stat * stats; /* statistics */
82 const char * pipe_dir_name; /* path to rpc_pipefs dir */
83};
84
85struct rpc_version {
86 u32 number; /* version number */
87 unsigned int nrprocs; /* number of procs */
88 struct rpc_procinfo * procs; /* procedure array */
89};
90
91/*
92 * Procedure information
93 */
94struct rpc_procinfo {
95 u32 p_proc; /* RPC procedure number */
96 kxdreproc_t p_encode; /* XDR encode function */
97 kxdrdproc_t p_decode; /* XDR decode function */
98 unsigned int p_arglen; /* argument hdr length (u32) */
99 unsigned int p_replen; /* reply hdr length (u32) */
100 unsigned int p_count; /* call count */
101 unsigned int p_timer; /* Which RTT timer to use */
102 u32 p_statidx; /* Which procedure to account */
103 const char * p_name; /* name of procedure */
104};
105
106#ifdef __KERNEL__
107
108struct rpc_create_args {
109 struct net *net;
110 int protocol;
111 struct sockaddr *address;
112 size_t addrsize;
113 struct sockaddr *saddress;
114 const struct rpc_timeout *timeout;
115 const char *servername;
116 const char *nodename;
117 const struct rpc_program *program;
118 u32 prognumber; /* overrides program->number */
119 u32 version;
120 rpc_authflavor_t authflavor;
121 unsigned long flags;
122 char *client_name;
123 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
124};
125
126/* Values for "flags" field */
127#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
128#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
129#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
130#define RPC_CLNT_CREATE_NOPING (1UL << 4)
131#define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
132#define RPC_CLNT_CREATE_QUIET (1UL << 6)
133#define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7)
134#define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
135#define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9)
136
137struct rpc_clnt *rpc_create(struct rpc_create_args *args);
138struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
139 struct rpc_xprt *xprt);
140struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
141 const struct rpc_program *, u32);
142void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
143struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
144struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
145 rpc_authflavor_t);
146int rpc_switch_client_transport(struct rpc_clnt *,
147 struct xprt_create *,
148 const struct rpc_timeout *);
149
150void rpc_shutdown_client(struct rpc_clnt *);
151void rpc_release_client(struct rpc_clnt *);
152void rpc_task_release_client(struct rpc_task *);
153
154int rpcb_create_local(struct net *);
155void rpcb_put_local(struct net *);
156int rpcb_register(struct net *, u32, u32, int, unsigned short);
157int rpcb_v4_register(struct net *net, const u32 program,
158 const u32 version,
159 const struct sockaddr *address,
160 const char *netid);
161void rpcb_getport_async(struct rpc_task *);
162
163void rpc_call_start(struct rpc_task *);
164int rpc_call_async(struct rpc_clnt *clnt,
165 const struct rpc_message *msg, int flags,
166 const struct rpc_call_ops *tk_ops,
167 void *calldata);
168int rpc_call_sync(struct rpc_clnt *clnt,
169 const struct rpc_message *msg, int flags);
170struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
171 int flags);
172int rpc_restart_call_prepare(struct rpc_task *);
173int rpc_restart_call(struct rpc_task *);
174void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
175int rpc_protocol(struct rpc_clnt *);
176struct net * rpc_net_ns(struct rpc_clnt *);
177size_t rpc_max_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
184const char *rpc_proc_name(const struct rpc_task *task);
185#endif /* __KERNEL__ */
186#endif /* _LINUX_SUNRPC_CLNT_H */