[deliverable/linux.git] / include / linux / sunrpc / clnt.h

/*
 *  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/types.h>
#include <linux/socket.h>
#include <linux/in.h>
#include <linux/in6.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 <linux/sunrpc/rpc_pipe_fs.h>
#include <asm/signal.h>
#include <linux/path.h>
#include <net/ipv6.h>

struct rpc_inode;

/*
 * The high-level client handle
 */
struct rpc_clnt {
	atomic_t		cl_count;	/* Number of references */
	unsigned int		cl_clid;	/* client id */
	struct list_head	cl_clients;	/* Global list of clients */
	struct list_head	cl_tasks;	/* List of tasks */
	spinlock_t		cl_lock;	/* spinlock */
	struct rpc_xprt __rcu *	cl_xprt;	/* transport */
	struct rpc_procinfo *	cl_procinfo;	/* procedure info */
	u32			cl_prog,	/* RPC program number */
				cl_vers,	/* RPC version number */
				cl_maxproc;	/* max procedure number */

	struct rpc_auth *	cl_auth;	/* authenticator */
	struct rpc_stat *	cl_stats;	/* per-program statistics */
	struct rpc_iostats *	cl_metrics;	/* per-client statistics */

	unsigned int		cl_softrtry : 1,/* soft timeouts */
				cl_discrtry : 1,/* disconnect before retry */
				cl_noretranstimeo: 1,/* No retransmit timeouts */
				cl_autobind : 1,/* use getport() */
				cl_chatty   : 1;/* be verbose */

	struct rpc_rtt *	cl_rtt;		/* RTO estimator data */
	const struct rpc_timeout *cl_timeout;	/* Timeout strategy */

	atomic_t		cl_swapper;	/* swapfile count */
	int			cl_nodelen;	/* nodename length */
	char 			cl_nodename[UNX_MAXNODENAME+1];
	struct rpc_pipe_dir_head cl_pipedir_objects;
	struct rpc_clnt *	cl_parent;	/* Points to parent of clones */
	struct rpc_rtt		cl_rtt_default;
	struct rpc_timeout	cl_timeout_default;
	const struct rpc_program *cl_program;
#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
	struct dentry		*cl_debugfs;	/* debugfs directory */
#endif
};

/*
 * General RPC program info
 */
#define RPC_MAXVERSION		4
struct rpc_program {
	const char *		name;		/* protocol name */
	u32			number;		/* program number */
	unsigned int		nrvers;		/* number of versions */
	const struct rpc_version **	version;	/* version array */
	struct rpc_stat *	stats;		/* statistics */
	const 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 */
	kxdreproc_t		p_encode;	/* XDR encode function */
	kxdrdproc_t		p_decode;	/* XDR decode function */
	unsigned int		p_arglen;	/* argument hdr length (u32) */
	unsigned int		p_replen;	/* reply hdr length (u32) */
	unsigned int		p_count;	/* call count */
	unsigned int		p_timer;	/* Which RTT timer to use */
	u32			p_statidx;	/* Which procedure to account */
	const char *		p_name;		/* name of procedure */
};

#ifdef __KERNEL__

struct rpc_create_args {
	struct net		*net;
	int			protocol;
	struct sockaddr		*address;
	size_t			addrsize;
	struct sockaddr		*saddress;
	const struct rpc_timeout *timeout;
	const char		*servername;
	const char		*nodename;
	const struct rpc_program *program;
	u32			prognumber;	/* overrides program->number */
	u32			version;
	rpc_authflavor_t	authflavor;
	unsigned long		flags;
	char			*client_name;
	struct svc_xprt		*bc_xprt;	/* NFSv4.1 backchannel */
};

/* Values for "flags" field */
#define RPC_CLNT_CREATE_HARDRTRY	(1UL << 0)
#define RPC_CLNT_CREATE_AUTOBIND	(1UL << 2)
#define RPC_CLNT_CREATE_NONPRIVPORT	(1UL << 3)
#define RPC_CLNT_CREATE_NOPING		(1UL << 4)
#define RPC_CLNT_CREATE_DISCRTRY	(1UL << 5)
#define RPC_CLNT_CREATE_QUIET		(1UL << 6)
#define RPC_CLNT_CREATE_INFINITE_SLOTS	(1UL << 7)
#define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT	(1UL << 8)
#define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT	(1UL << 9)

struct rpc_clnt *rpc_create(struct rpc_create_args *args);
struct rpc_clnt *rpc_create_xprt(struct rpc_create_args *args,
					struct rpc_xprt *xprt);
struct rpc_clnt	*rpc_bind_new_program(struct rpc_clnt *,
				const struct rpc_program *, u32);
void rpc_task_reset_client(struct rpc_task *task, struct rpc_clnt *clnt);
struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
struct rpc_clnt *rpc_clone_client_set_auth(struct rpc_clnt *,
				rpc_authflavor_t);
int		rpc_switch_client_transport(struct rpc_clnt *,
				struct xprt_create *,
				const struct rpc_timeout *);

void		rpc_shutdown_client(struct rpc_clnt *);
void		rpc_release_client(struct rpc_clnt *);
void		rpc_task_release_client(struct rpc_task *);

int		rpcb_create_local(struct net *);
void		rpcb_put_local(struct net *);
int		rpcb_register(struct net *, u32, u32, int, unsigned short);
int		rpcb_v4_register(struct net *net, const u32 program,
				 const u32 version,
				 const struct sockaddr *address,
				 const char *netid);
void		rpcb_getport_async(struct rpc_task *);

void		rpc_call_start(struct rpc_task *);
int		rpc_call_async(struct rpc_clnt *clnt,
			       const struct rpc_message *msg, int flags,
			       const struct rpc_call_ops *tk_ops,
			       void *calldata);
int		rpc_call_sync(struct rpc_clnt *clnt,
			      const struct rpc_message *msg, int flags);
struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
			       int flags);
int		rpc_restart_call_prepare(struct rpc_task *);
int		rpc_restart_call(struct rpc_task *);
void		rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
int		rpc_protocol(struct rpc_clnt *);
struct net *	rpc_net_ns(struct rpc_clnt *);
size_t		rpc_max_payload(struct rpc_clnt *);
unsigned long	rpc_get_timeout(struct rpc_clnt *clnt);
void		rpc_force_rebind(struct rpc_clnt *);
size_t		rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
const char	*rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
int		rpc_localaddr(struct rpc_clnt *, struct sockaddr *, size_t);

const char *rpc_proc_name(const struct rpc_task *task);
#endif /* __KERNEL__ */
#endif /* _LINUX_SUNRPC_CLNT_H */
Commit	Line	Data
1da177e4 LT	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
d77385f2	12	#include <linux/types.h>
a02d6926 CL	13	#include <linux/socket.h>
	14	#include <linux/in.h>
	15	#include <linux/in6.h>
	16
1da177e4 LT	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>
6739ffb7	24	#include <linux/sunrpc/rpc_pipe_fs.h>
1da177e4	25	#include <asm/signal.h>
7d217cac	26	#include <linux/path.h>
4516fc04	27	#include <net/ipv6.h>
1da177e4	28
1da177e4 LT	29	struct rpc_inode;
	30
	31	/*
	32	* The high-level client handle
	33	*/
	34	struct rpc_clnt {
006abe88	35	atomic_t cl_count; /* Number of references */
2f048db4	36	unsigned int cl_clid; /* client id */
6529eba0 TM	37	struct list_head cl_clients; /* Global list of clients */
6529eba0 TM	38	struct list_head cl_tasks; /* List of tasks */
4bef61ff	39	spinlock_t cl_lock; /* spinlock */
2446ab60	40	struct rpc_xprt __rcu * cl_xprt; /* transport */
1da177e4	41	struct rpc_procinfo * cl_procinfo; /* procedure info */
4a68179d CL	42	u32 cl_prog, /* RPC program number */
	43	cl_vers, /* RPC version number */
	44	cl_maxproc; /* max procedure number */
1da177e4	45
1da177e4	46	struct rpc_auth * cl_auth; /* authenticator */
11c556b3 CL	47	struct rpc_stat * cl_stats; /* per-program statistics */
11c556b3 CL	48	struct rpc_iostats * cl_metrics; /* per-client statistics */
1da177e4 LT	49
1da177e4 LT	50	unsigned int cl_softrtry : 1,/* soft timeouts */
43d78ef2	51	cl_discrtry : 1,/* disconnect before retry */
8a19a0b6	52	cl_noretranstimeo: 1,/* No retransmit timeouts */
b6b6152c OK	53	cl_autobind : 1,/* use getport() */
b6b6152c OK	54	cl_chatty : 1;/* be verbose */
1da177e4 LT	55
1da177e4 LT	56	struct rpc_rtt * cl_rtt; /* RTO estimator data */
ba7392bb	57	const struct rpc_timeout cl_timeout; / Timeout strategy */
1da177e4	58
3c87ef6e	59	atomic_t cl_swapper; /* swapfile count */
1da177e4	60	int cl_nodelen; /* nodename length */
03a9a42a	61	char cl_nodename[UNX_MAXNODENAME+1];
6739ffb7	62	struct rpc_pipe_dir_head cl_pipedir_objects;
1da177e4 LT	63	struct rpc_clnt * cl_parent; /* Points to parent of clones */
1da177e4 LT	64	struct rpc_rtt cl_rtt_default;
ba7392bb	65	struct rpc_timeout cl_timeout_default;
a613fa16	66	const struct rpc_program *cl_program;
b4b9d2cc JL	67	#if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
	68	struct dentry cl_debugfs; / debugfs directory */
	69	#endif
1da177e4	70	};
1da177e4 LT	71
	72	/*
	73	* General RPC program info
	74	*/
	75	#define RPC_MAXVERSION 4
	76	struct rpc_program {
080b794c	77	const char * name; /* protocol name */
1da177e4 LT	78	u32 number; /* program number */
1da177e4 LT	79	unsigned int nrvers; /* number of versions */
a613fa16	80	const struct rpc_version ** version; /* version array */
1da177e4	81	struct rpc_stat * stats; /* statistics */
080b794c	82	const char * pipe_dir_name; /* path to rpc_pipefs dir */
1da177e4 LT	83	};
	84
	85	struct 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	*/
	94	struct rpc_procinfo {
	95	u32 p_proc; /* RPC procedure number */
9f06c719	96	kxdreproc_t p_encode; /* XDR encode function */
bf269551	97	kxdrdproc_t p_decode; /* XDR decode function */
2bea90d4 CL	98	unsigned int p_arglen; /* argument hdr length (u32) */
2bea90d4 CL	99	unsigned int p_replen; /* reply hdr length (u32) */
1da177e4 LT	100	unsigned int p_count; /* call count */
1da177e4 LT	101	unsigned int p_timer; /* Which RTT timer to use */
cc0175c1	102	u32 p_statidx; /* Which procedure to account */
6eac7d3f	103	const char * p_name; /* name of procedure */
1da177e4 LT	104	};
1da177e4 LT	105
1da177e4 LT	106	#ifdef __KERNEL__
1da177e4 LT	107
c2866763	108	struct rpc_create_args {
c653ce3f	109	struct net *net;
c2866763 CL	110	int protocol;
	111	struct sockaddr *address;
	112	size_t addrsize;
d3bc9a1d	113	struct sockaddr *saddress;
ba7392bb	114	const struct rpc_timeout *timeout;
6eac7d3f	115	const char *servername;
03a9a42a	116	const char *nodename;
a613fa16	117	const struct rpc_program *program;
d5b337b4	118	u32 prognumber; /* overrides program->number */
c2866763 CL	119	u32 version;
	120	rpc_authflavor_t authflavor;
	121	unsigned long flags;
608207e8	122	char *client_name;
f300baba	123	struct svc_xprt bc_xprt; / NFSv4.1 backchannel */
c2866763 CL	124	};
	125
	126	/* Values for "flags" field */
	127	#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
c2866763	128	#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
90c5755f TM	129	#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
	130	#define RPC_CLNT_CREATE_NOPING (1UL << 4)
	131	#define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
b6b6152c	132	#define RPC_CLNT_CREATE_QUIET (1UL << 6)
b7993ceb	133	#define RPC_CLNT_CREATE_INFINITE_SLOTS (1UL << 7)
33d90ac0	134	#define RPC_CLNT_CREATE_NO_IDLE_TIMEOUT (1UL << 8)
8a19a0b6	135	#define RPC_CLNT_CREATE_NO_RETRANS_TIMEOUT (1UL << 9)
c2866763 CL	136
c2866763 CL	137	struct rpc_clnt rpc_create(struct rpc_create_args args);
83ddfebd KM	138	struct rpc_clnt rpc_create_xprt(struct rpc_create_args args,
83ddfebd KM	139	struct rpc_xprt *xprt);
007e251f	140	struct rpc_clnt rpc_bind_new_program(struct rpc_clnt ,
a613fa16	141	const struct rpc_program *, u32);
cbdabc7f	142	void rpc_task_reset_client(struct rpc_task task, struct rpc_clnt clnt);
1da177e4	143	struct rpc_clnt rpc_clone_client(struct rpc_clnt );
ba9b584c CL	144	struct rpc_clnt rpc_clone_client_set_auth(struct rpc_clnt ,
ba9b584c CL	145	rpc_authflavor_t);
40b00b6b TM	146	int rpc_switch_client_transport(struct rpc_clnt *,
	147	struct xprt_create *,
	148	const struct rpc_timeout *);
	149
4c402b40	150	void rpc_shutdown_client(struct rpc_clnt *);
1da177e4	151	void rpc_release_client(struct rpc_clnt *);
58f9612c	152	void rpc_task_release_client(struct rpc_task *);
cce63cd6	153
f7a30c18 SK	154	int rpcb_create_local(struct net *);
f7a30c18 SK	155	void rpcb_put_local(struct net *);
977ac315 SK	156	int rpcb_register(struct net *, u32, u32, int, unsigned short);
	157	int rpcb_v4_register(struct net *net, const u32 program,
	158	const u32 version,
c2e1b09f	159	const struct sockaddr *address,
14aeb211	160	const char *netid);
45160d62	161	void rpcb_getport_async(struct rpc_task *);
1da177e4	162
77de2c59	163	void rpc_call_start(struct rpc_task *);
cbc20059 TM	164	int rpc_call_async(struct rpc_clnt *clnt,
	165	const struct rpc_message *msg, int flags,
	166	const struct rpc_call_ops *tk_ops,
963d8fe5	167	void *calldata);
cbc20059 TM	168	int rpc_call_sync(struct rpc_clnt *clnt,
cbc20059 TM	169	const struct rpc_message *msg, int flags);
5e1550d6 TM	170	struct rpc_task rpc_call_null(struct rpc_clnt clnt, struct rpc_cred *cred,
5e1550d6 TM	171	int flags);
f1f88fc7 TM	172	int rpc_restart_call_prepare(struct rpc_task *);
f1f88fc7 TM	173	int rpc_restart_call(struct rpc_task *);
1da177e4	174	void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
2446ab60 TM	175	int rpc_protocol(struct rpc_clnt *);
2446ab60 TM	176	struct net * rpc_net_ns(struct rpc_clnt *);
1da177e4	177	size_t rpc_max_payload(struct rpc_clnt *);
edddbb1e	178	unsigned long rpc_get_timeout(struct rpc_clnt *clnt);
35f5a422	179	void rpc_force_rebind(struct rpc_clnt *);
ed39440a	180	size_t rpc_peeraddr(struct rpc_clnt , struct sockaddr , size_t);
b454ae90	181	const char rpc_peeraddr2str(struct rpc_clnt , enum rpc_display_format_t);
2e738fdc	182	int rpc_localaddr(struct rpc_clnt , struct sockaddr , size_t);
1da177e4	183
b4b9d2cc	184	const char rpc_proc_name(const struct rpc_task task);
1da177e4 LT	185	#endif /* __KERNEL__ */
1da177e4 LT	186	#endif /* _LINUX_SUNRPC_CLNT_H */