clnt.h 4.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/*
 *  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

#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>
#include <asm/signal.h>

struct rpc_inode;

/*
 * The high-level client handle
 */
struct rpc_clnt {
27
	struct kref		cl_kref;	/* Number of references */
28 29
	struct list_head	cl_clients;	/* Global list of clients */
	struct list_head	cl_tasks;	/* List of tasks */
30
	spinlock_t		cl_lock;	/* spinlock */
L
Linus Torvalds 已提交
31 32
	struct rpc_xprt *	cl_xprt;	/* transport */
	struct rpc_procinfo *	cl_procinfo;	/* procedure info */
33 34 35
	u32			cl_prog,	/* RPC program number */
				cl_vers,	/* RPC version number */
				cl_maxproc;	/* max procedure number */
L
Linus Torvalds 已提交
36 37 38 39

	char *			cl_server;	/* server machine name */
	char *			cl_protname;	/* protocol name */
	struct rpc_auth *	cl_auth;	/* authenticator */
40 41
	struct rpc_stat *	cl_stats;	/* per-program statistics */
	struct rpc_iostats *	cl_metrics;	/* per-client statistics */
L
Linus Torvalds 已提交
42 43

	unsigned int		cl_softrtry : 1,/* soft timeouts */
44
				cl_discrtry : 1,/* disconnect before retry */
O
Olga Kornievskaia 已提交
45 46
				cl_autobind : 1,/* use getport() */
				cl_chatty   : 1;/* be verbose */
L
Linus Torvalds 已提交
47 48

	struct rpc_rtt *	cl_rtt;		/* RTO estimator data */
49
	const struct rpc_timeout *cl_timeout;	/* Timeout strategy */
L
Linus Torvalds 已提交
50 51 52 53

	int			cl_nodelen;	/* nodename length */
	char 			cl_nodename[UNX_MAXNODENAME];
	char			cl_pathname[30];/* Path in rpc_pipe_fs */
54
	struct vfsmount *	cl_vfsmnt;
L
Linus Torvalds 已提交
55 56 57
	struct dentry *		cl_dentry;	/* inode */
	struct rpc_clnt *	cl_parent;	/* Points to parent of clones */
	struct rpc_rtt		cl_rtt_default;
58
	struct rpc_timeout	cl_timeout_default;
59
	struct rpc_program *	cl_program;
L
Linus Torvalds 已提交
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
	char			cl_inline_name[32];
};

/*
 * General RPC program info
 */
#define RPC_MAXVERSION		4
struct rpc_program {
	char *			name;		/* protocol name */
	u32			number;		/* program number */
	unsigned int		nrvers;		/* number of versions */
	struct rpc_version **	version;	/* version array */
	struct rpc_stat *	stats;		/* statistics */
	char *			pipe_dir_name;	/* path to rpc_pipefs dir */
};

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 */
	kxdrproc_t		p_encode;	/* XDR encode function */
	kxdrproc_t		p_decode;	/* XDR decode function */
89 90
	unsigned int		p_arglen;	/* argument hdr length (u32) */
	unsigned int		p_replen;	/* reply hdr length (u32) */
L
Linus Torvalds 已提交
91 92
	unsigned int		p_count;	/* call count */
	unsigned int		p_timer;	/* Which RTT timer to use */
93 94
	u32			p_statidx;	/* Which procedure to account */
	char *			p_name;		/* name of procedure */
L
Linus Torvalds 已提交
95 96 97 98
};

#ifdef __KERNEL__

99 100 101 102
struct rpc_create_args {
	int			protocol;
	struct sockaddr		*address;
	size_t			addrsize;
103
	struct sockaddr		*saddress;
104
	const struct rpc_timeout *timeout;
105 106 107 108 109 110 111 112 113 114
	char			*servername;
	struct rpc_program	*program;
	u32			version;
	rpc_authflavor_t	authflavor;
	unsigned long		flags;
};

/* Values for "flags" field */
#define RPC_CLNT_CREATE_HARDRTRY	(1UL << 0)
#define RPC_CLNT_CREATE_AUTOBIND	(1UL << 2)
115 116 117
#define RPC_CLNT_CREATE_NONPRIVPORT	(1UL << 3)
#define RPC_CLNT_CREATE_NOPING		(1UL << 4)
#define RPC_CLNT_CREATE_DISCRTRY	(1UL << 5)
O
Olga Kornievskaia 已提交
118
#define RPC_CLNT_CREATE_QUIET		(1UL << 6)
119 120

struct rpc_clnt *rpc_create(struct rpc_create_args *args);
121
struct rpc_clnt	*rpc_bind_new_program(struct rpc_clnt *,
122
				struct rpc_program *, u32);
L
Linus Torvalds 已提交
123
struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
124
void		rpc_shutdown_client(struct rpc_clnt *);
L
Linus Torvalds 已提交
125
void		rpc_release_client(struct rpc_clnt *);
126

127
int		rpcb_register(u32, u32, int, unsigned short, int *);
128 129 130
int		rpcb_v4_register(const u32 program, const u32 version,
				 const struct sockaddr *address,
				 const char *netid, int *result);
131
int		rpcb_getport_sync(struct sockaddr_in *, u32, u32, int);
132
void		rpcb_getport_async(struct rpc_task *);
L
Linus Torvalds 已提交
133

134
void		rpc_call_start(struct rpc_task *);
135 136 137
int		rpc_call_async(struct rpc_clnt *clnt,
			       const struct rpc_message *msg, int flags,
			       const struct rpc_call_ops *tk_ops,
138
			       void *calldata);
139 140
int		rpc_call_sync(struct rpc_clnt *clnt,
			      const struct rpc_message *msg, int flags);
141 142
struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
			       int flags);
L
Linus Torvalds 已提交
143 144 145
void		rpc_restart_call(struct rpc_task *);
void		rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
size_t		rpc_max_payload(struct rpc_clnt *);
146
void		rpc_force_rebind(struct rpc_clnt *);
147
size_t		rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
148
const char	*rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
L
Linus Torvalds 已提交
149 150 151

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