clnt.h 5.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11
/*
 *  linux/include/linux/sunrpc/clnt.h
 *
 *  Declarations for the high-level RPC client interface
 *
 *  Copyright (C) 1995, 1996, Olaf Kirch <okir@monad.swb.de>
 */

#ifndef _LINUX_SUNRPC_CLNT_H
#define _LINUX_SUNRPC_CLNT_H

T
Trond Myklebust 已提交
12
#include <linux/types.h>
13 14 15 16
#include <linux/socket.h>
#include <linux/in.h>
#include <linux/in6.h>

L
Linus Torvalds 已提交
17 18 19 20 21 22 23
#include <linux/sunrpc/msg_prot.h>
#include <linux/sunrpc/sched.h>
#include <linux/sunrpc/xprt.h>
#include <linux/sunrpc/auth.h>
#include <linux/sunrpc/stats.h>
#include <linux/sunrpc/xdr.h>
#include <linux/sunrpc/timer.h>
24
#include <linux/sunrpc/rpc_pipe_fs.h>
L
Linus Torvalds 已提交
25
#include <asm/signal.h>
26
#include <linux/path.h>
27
#include <net/ipv6.h>
L
Linus Torvalds 已提交
28 29 30 31 32 33 34

struct rpc_inode;

/*
 * The high-level client handle
 */
struct rpc_clnt {
35
	atomic_t		cl_count;	/* Number of references */
36
	unsigned int		cl_clid;	/* client id */
37 38
	struct list_head	cl_clients;	/* Global list of clients */
	struct list_head	cl_tasks;	/* List of tasks */
39
	spinlock_t		cl_lock;	/* spinlock */
40
	struct rpc_xprt __rcu *	cl_xprt;	/* transport */
L
Linus Torvalds 已提交
41
	struct rpc_procinfo *	cl_procinfo;	/* procedure info */
42 43 44
	u32			cl_prog,	/* RPC program number */
				cl_vers,	/* RPC version number */
				cl_maxproc;	/* max procedure number */
L
Linus Torvalds 已提交
45 46

	struct rpc_auth *	cl_auth;	/* authenticator */
47 48
	struct rpc_stat *	cl_stats;	/* per-program statistics */
	struct rpc_iostats *	cl_metrics;	/* per-client statistics */
L
Linus Torvalds 已提交
49 50

	unsigned int		cl_softrtry : 1,/* soft timeouts */
51
				cl_discrtry : 1,/* disconnect before retry */
O
Olga Kornievskaia 已提交
52 53
				cl_autobind : 1,/* use getport() */
				cl_chatty   : 1;/* be verbose */
L
Linus Torvalds 已提交
54 55

	struct rpc_rtt *	cl_rtt;		/* RTO estimator data */
56
	const struct rpc_timeout *cl_timeout;	/* Timeout strategy */
L
Linus Torvalds 已提交
57 58 59

	int			cl_nodelen;	/* nodename length */
	char 			cl_nodename[UNX_MAXNODENAME];
60
	struct rpc_pipe_dir_head cl_pipedir_objects;
L
Linus Torvalds 已提交
61 62
	struct rpc_clnt *	cl_parent;	/* Points to parent of clones */
	struct rpc_rtt		cl_rtt_default;
63
	struct rpc_timeout	cl_timeout_default;
64
	const struct rpc_program *cl_program;
L
Linus Torvalds 已提交
65 66 67 68 69 70 71
};

/*
 * General RPC program info
 */
#define RPC_MAXVERSION		4
struct rpc_program {
72
	const char *		name;		/* protocol name */
L
Linus Torvalds 已提交
73 74
	u32			number;		/* program number */
	unsigned int		nrvers;		/* number of versions */
75
	const struct rpc_version **	version;	/* version array */
L
Linus Torvalds 已提交
76
	struct rpc_stat *	stats;		/* statistics */
77
	const char *		pipe_dir_name;	/* path to rpc_pipefs dir */
L
Linus Torvalds 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90
};

struct rpc_version {
	u32			number;		/* version number */
	unsigned int		nrprocs;	/* number of procs */
	struct rpc_procinfo *	procs;		/* procedure array */
};

/*
 * Procedure information
 */
struct rpc_procinfo {
	u32			p_proc;		/* RPC procedure number */
91
	kxdreproc_t		p_encode;	/* XDR encode function */
92
	kxdrdproc_t		p_decode;	/* XDR decode function */
93 94
	unsigned int		p_arglen;	/* argument hdr length (u32) */
	unsigned int		p_replen;	/* reply hdr length (u32) */
L
Linus Torvalds 已提交
95 96
	unsigned int		p_count;	/* call count */
	unsigned int		p_timer;	/* Which RTT timer to use */
97
	u32			p_statidx;	/* Which procedure to account */
98
	const char *		p_name;		/* name of procedure */
L
Linus Torvalds 已提交
99 100 101 102
};

#ifdef __KERNEL__

103
struct rpc_create_args {
104
	struct net		*net;
105 106 107
	int			protocol;
	struct sockaddr		*address;
	size_t			addrsize;
108
	struct sockaddr		*saddress;
109
	const struct rpc_timeout *timeout;
110
	const char		*servername;
111
	const struct rpc_program *program;
112
	u32			prognumber;	/* overrides program->number */
113 114 115
	u32			version;
	rpc_authflavor_t	authflavor;
	unsigned long		flags;
116
	char			*client_name;
117
	struct svc_xprt		*bc_xprt;	/* NFSv4.1 backchannel */
118 119 120 121 122
};

/* Values for "flags" field */
#define RPC_CLNT_CREATE_HARDRTRY	(1UL << 0)
#define RPC_CLNT_CREATE_AUTOBIND	(1UL << 2)
123 124 125
#define RPC_CLNT_CREATE_NONPRIVPORT	(1UL << 3)
#define RPC_CLNT_CREATE_NOPING		(1UL << 4)
#define RPC_CLNT_CREATE_DISCRTRY	(1UL << 5)
O
Olga Kornievskaia 已提交
126
#define RPC_CLNT_CREATE_QUIET		(1UL << 6)
127
#define RPC_CLNT_CREATE_INFINITE_SLOTS	(1UL << 7)
128
#define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT	(1UL << 8)
129 130

struct rpc_clnt *rpc_create(struct rpc_create_args *args);
131
struct rpc_clnt	*rpc_bind_new_program(struct rpc_clnt *,
132
				const struct rpc_program *, u32);
133
void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
L
Linus Torvalds 已提交
134
struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
135 136
struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
				rpc_authflavor_t);
137
void		rpc_shutdown_client(struct rpc_clnt *);
L
Linus Torvalds 已提交
138
void		rpc_release_client(struct rpc_clnt *);
139
void		rpc_task_release_client(struct rpc_task *);
140

141 142
int		rpcb_create_local(struct net *);
void		rpcb_put_local(struct net *);
143 144 145
int		rpcb_register(struct net *, u32, u32, int, unsigned short);
int		rpcb_v4_register(struct net *net, const u32 program,
				 const u32 version,
146
				 const struct sockaddr *address,
147
				 const char *netid);
148
void		rpcb_getport_async(struct rpc_task *);
L
Linus Torvalds 已提交
149

150
void		rpc_call_start(struct rpc_task *);
151 152 153
int		rpc_call_async(struct rpc_clnt *clnt,
			       const struct rpc_message *msg, int flags,
			       const struct rpc_call_ops *tk_ops,
154
			       void *calldata);
155 156
int		rpc_call_sync(struct rpc_clnt *clnt,
			      const struct rpc_message *msg, int flags);
157 158
struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
			       int flags);
159 160
int		rpc_restart_call_prepare(struct rpc_task *);
int		rpc_restart_call(struct rpc_task *);
L
Linus Torvalds 已提交
161
void		rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
162 163
int		rpc_protocol(struct rpc_clnt *);
struct net *	rpc_net_ns(struct rpc_clnt *);
L
Linus Torvalds 已提交
164
size_t		rpc_max_payload(struct rpc_clnt *);
165
unsigned long	rpc_get_timeout(struct rpc_clnt *clnt);
166
void		rpc_force_rebind(struct rpc_clnt *);
167
size_t		rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
168
const char	*rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
169
int		rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);
L
Linus Torvalds 已提交
170 171 172

#endif /* __KERNEL__ */
#endif /* _LINUX_SUNRPC_CLNT_H */