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 int cl_nodelen; /* nodename length */
60 char cl_nodename[UNX_MAXNODENAME];
61 struct rpc_pipe_dir_head cl_pipedir_objects;
62 struct rpc_clnt * cl_parent; /* Points to parent of clones */
63 struct rpc_rtt cl_rtt_default;
64 struct rpc_timeout cl_timeout_default;
65 const struct rpc_program *cl_program;
66};
67
68/*
69 * General RPC program info
70 */
71#define RPC_MAXVERSION 4
72struct rpc_program {
73 const char * name; /* protocol name */
74 u32 number; /* program number */
75 unsigned int nrvers; /* number of versions */
76 const struct rpc_version ** version; /* version array */
77 struct rpc_stat * stats; /* statistics */
78 const char * pipe_dir_name; /* path to rpc_pipefs dir */
79};
80
81struct rpc_version {
82 u32 number; /* version number */
83 unsigned int nrprocs; /* number of procs */
84 struct rpc_procinfo * procs; /* procedure array */
85};
86
87/*
88 * Procedure information
89 */
90struct rpc_procinfo {
91 u32 p_proc; /* RPC procedure number */
92 kxdreproc_t p_encode; /* XDR encode function */
93 kxdrdproc_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 const char * p_name; /* name of procedure */
100};
101
102#ifdef __KERNEL__
103
104struct rpc_create_args {
105 struct net *net;
106 int protocol;
107 struct sockaddr *address;
108 size_t addrsize;
109 struct sockaddr *saddress;
110 const struct rpc_timeout *timeout;
111 const char *servername;
112 const struct rpc_program *program;
113 u32 prognumber; /* overrides program->number */
114 u32 version;
115 rpc_authflavor_t authflavor;
116 unsigned long flags;
117 char *client_name;
118 struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
119};
120
121/* Values for "flags" field */
122#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
123#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
124#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
125#define RPC_CLNT_CREATE_NOPING (1UL << 4)
126#define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
127#define RPC_CLNT_CREATE_QUIET (1UL << 6)
128#define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7)
129#define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
130#define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9)
131
132struct rpc_clnt *rpc_create(struct rpc_create_args *args);
133struct rpc_clnt *rpc_bind_new_program(struct rpc_clnt *,
134 const struct rpc_program *, u32);
135void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
136struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
137struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
138 rpc_authflavor_t);
139int rpc_switch_client_transport(struct rpc_clnt *,
140 struct xprt_create *,
141 const struct rpc_timeout *);
142
143void rpc_shutdown_client(struct rpc_clnt *);
144void rpc_release_client(struct rpc_clnt *);
145void rpc_task_release_client(struct rpc_task *);
146
147int rpcb_create_local(struct net *);
148void rpcb_put_local(struct net *);
149int rpcb_register(struct net *, u32, u32, int, unsigned short);
150int rpcb_v4_register(struct net *net, const u32 program,
151 const u32 version,
152 const struct sockaddr *address,
153 const char *netid);
154void rpcb_getport_async(struct rpc_task *);
155
156void rpc_call_start(struct rpc_task *);
157int rpc_call_async(struct rpc_clnt *clnt,
158 const struct rpc_message *msg, int flags,
159 const struct rpc_call_ops *tk_ops,
160 void *calldata);
161int rpc_call_sync(struct rpc_clnt *clnt,
162 const struct rpc_message *msg, int flags);
163struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
164 int flags);
165int rpc_restart_call_prepare(struct rpc_task *);
166int rpc_restart_call(struct rpc_task *);
167void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
168int rpc_protocol(struct rpc_clnt *);
169struct net * rpc_net_ns(struct rpc_clnt *);
170size_t rpc_max_payload(struct rpc_clnt *);
171unsigned long rpc_get_timeout(struct rpc_clnt *clnt);
172void rpc_force_rebind(struct rpc_clnt *);
173size_t rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
174const char *rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
175int rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
176
177#endif /* __KERNEL__ */
178#endif /* _LINUX_SUNRPC_CLNT_H */