[mirror_ubuntu-bionic-kernel.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/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 {
	struct kref		cl_kref;	/* Number of references */
	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 *	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 */

	char *			cl_server;	/* server machine name */
	char *			cl_protname;	/* protocol name */
	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_intr     : 1,/* interruptible */
				cl_discrtry : 1,/* disconnect before retry */
				cl_autobind : 1;/* use getport() */

	struct rpc_rtt *	cl_rtt;		/* RTO estimator data */

	int			cl_nodelen;	/* nodename length */
	char 			cl_nodename[UNX_MAXNODENAME];
	char			cl_pathname[30];/* Path in rpc_pipe_fs */
	struct vfsmount *	cl_vfsmnt;
	struct dentry *		cl_dentry;	/* inode */
	struct rpc_clnt *	cl_parent;	/* Points to parent of clones */
	struct rpc_rtt		cl_rtt_default;
	struct rpc_program *	cl_program;
	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 */
	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 */
	char *			p_name;		/* name of procedure */
};

#ifdef __KERNEL__

struct rpc_create_args {
	int			protocol;
	struct sockaddr		*address;
	size_t			addrsize;
	struct rpc_timeout	*timeout;
	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_INTR		(1UL << 1)
#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)

struct rpc_clnt *rpc_create(struct rpc_create_args *args);
struct rpc_clnt	*rpc_bind_new_program(struct rpc_clnt *,
				struct rpc_program *, int);
struct rpc_clnt *rpc_clone_client(struct rpc_clnt *);
void		rpc_shutdown_client(struct rpc_clnt *);
void		rpc_release_client(struct rpc_clnt *);
int		rpcb_register(u32, u32, int, unsigned short, int *);
void		rpcb_getport(struct rpc_task *);

void		rpc_call_setup(struct rpc_task *, struct rpc_message *, int);

int		rpc_call_async(struct rpc_clnt *clnt, struct rpc_message *msg,
			       int flags, const struct rpc_call_ops *tk_ops,
			       void *calldata);
int		rpc_call_sync(struct rpc_clnt *clnt, struct rpc_message *msg,
			      int flags);
struct rpc_task *rpc_call_null(struct rpc_clnt *clnt, struct rpc_cred *cred,
			       int flags);
void		rpc_restart_call(struct rpc_task *);
void		rpc_clnt_sigmask(struct rpc_clnt *clnt, sigset_t *oldset);
void		rpc_clnt_sigunmask(struct rpc_clnt *clnt, sigset_t *oldset);
void		rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
size_t		rpc_max_payload(struct rpc_clnt *);
void		rpc_force_rebind(struct rpc_clnt *);
size_t		rpc_peeraddr(struct rpc_clnt *, struct sockaddr *, size_t);
char *		rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);

/*
 * Helper function for NFSroot support
 */
int		rpcb_getport_external(struct sockaddr_in *, __u32, __u32, int);

#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
	12	#include <linux/sunrpc/msg_prot.h>
	13	#include <linux/sunrpc/sched.h>
	14	#include <linux/sunrpc/xprt.h>
	15	#include <linux/sunrpc/auth.h>
	16	#include <linux/sunrpc/stats.h>
	17	#include <linux/sunrpc/xdr.h>
	18	#include <linux/sunrpc/timer.h>
	19	#include <asm/signal.h>
	20
1da177e4 LT	21	struct rpc_inode;
	22
	23	/*
	24	* The high-level client handle
	25	*/
	26	struct rpc_clnt {
34f52e35	27	struct kref cl_kref; /* Number of references */
6529eba0 TM	28	struct list_head cl_clients; /* Global list of clients */
6529eba0 TM	29	struct list_head cl_tasks; /* List of tasks */
4bef61ff	30	spinlock_t cl_lock; /* spinlock */
1da177e4 LT	31	struct rpc_xprt * cl_xprt; /* transport */
1da177e4 LT	32	struct rpc_procinfo * cl_procinfo; /* procedure info */
4a68179d CL	33	u32 cl_prog, /* RPC program number */
	34	cl_vers, /* RPC version number */
	35	cl_maxproc; /* max procedure number */
1da177e4 LT	36
	37	char * cl_server; /* server machine name */
	38	char * cl_protname; /* protocol name */
	39	struct rpc_auth * cl_auth; /* authenticator */
11c556b3 CL	40	struct rpc_stat * cl_stats; /* per-program statistics */
11c556b3 CL	41	struct rpc_iostats * cl_metrics; /* per-client statistics */
1da177e4 LT	42
	43	unsigned int cl_softrtry : 1,/* soft timeouts */
	44	cl_intr : 1,/* interruptible */
43d78ef2	45	cl_discrtry : 1,/* disconnect before retry */
90c5755f	46	cl_autobind : 1;/* use getport() */
1da177e4 LT	47
1da177e4 LT	48	struct rpc_rtt * cl_rtt; /* RTO estimator data */
1da177e4 LT	49
	50	int cl_nodelen; /* nodename length */
	51	char cl_nodename[UNX_MAXNODENAME];
	52	char cl_pathname[30];/* Path in rpc_pipe_fs */
54281548	53	struct vfsmount * cl_vfsmnt;
1da177e4 LT	54	struct dentry * cl_dentry; /* inode */
	55	struct rpc_clnt * cl_parent; /* Points to parent of clones */
	56	struct rpc_rtt cl_rtt_default;
3e32a5d9	57	struct rpc_program * cl_program;
1da177e4 LT	58	char cl_inline_name[32];
1da177e4 LT	59	};
1da177e4 LT	60
	61	/*
	62	* General RPC program info
	63	*/
	64	#define RPC_MAXVERSION 4
	65	struct rpc_program {
	66	char * name; /* protocol name */
	67	u32 number; /* program number */
	68	unsigned int nrvers; /* number of versions */
	69	struct rpc_version ** version; /* version array */
	70	struct rpc_stat * stats; /* statistics */
	71	char * pipe_dir_name; /* path to rpc_pipefs dir */
	72	};
	73
	74	struct rpc_version {
	75	u32 number; /* version number */
	76	unsigned int nrprocs; /* number of procs */
	77	struct rpc_procinfo * procs; /* procedure array */
	78	};
	79
	80	/*
	81	* Procedure information
	82	*/
	83	struct rpc_procinfo {
	84	u32 p_proc; /* RPC procedure number */
	85	kxdrproc_t p_encode; /* XDR encode function */
	86	kxdrproc_t p_decode; /* XDR decode function */
2bea90d4 CL	87	unsigned int p_arglen; /* argument hdr length (u32) */
2bea90d4 CL	88	unsigned int p_replen; /* reply hdr length (u32) */
1da177e4 LT	89	unsigned int p_count; /* call count */
1da177e4 LT	90	unsigned int p_timer; /* Which RTT timer to use */
cc0175c1 CL	91	u32 p_statidx; /* Which procedure to account */
cc0175c1 CL	92	char * p_name; /* name of procedure */
1da177e4 LT	93	};
1da177e4 LT	94
1da177e4 LT	95	#ifdef __KERNEL__
1da177e4 LT	96
c2866763 CL	97	struct rpc_create_args {
	98	int protocol;
	99	struct sockaddr *address;
	100	size_t addrsize;
	101	struct rpc_timeout *timeout;
	102	char *servername;
	103	struct rpc_program *program;
	104	u32 version;
	105	rpc_authflavor_t authflavor;
	106	unsigned long flags;
	107	};
	108
	109	/* Values for "flags" field */
	110	#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
	111	#define RPC_CLNT_CREATE_INTR (1UL << 1)
	112	#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
90c5755f TM	113	#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 3)
	114	#define RPC_CLNT_CREATE_NOPING (1UL << 4)
	115	#define RPC_CLNT_CREATE_DISCRTRY (1UL << 5)
c2866763 CL	116
c2866763 CL	117	struct rpc_clnt rpc_create(struct rpc_create_args args);
007e251f AG	118	struct rpc_clnt rpc_bind_new_program(struct rpc_clnt ,
007e251f AG	119	struct rpc_program *, int);
1da177e4	120	struct rpc_clnt rpc_clone_client(struct rpc_clnt );
4c402b40	121	void rpc_shutdown_client(struct rpc_clnt *);
1da177e4	122	void rpc_release_client(struct rpc_clnt *);
a509050b CL	123	int rpcb_register(u32, u32, int, unsigned short, int *);
a509050b CL	124	void rpcb_getport(struct rpc_task *);
1da177e4 LT	125
	126	void rpc_call_setup(struct rpc_task , struct rpc_message , int);
	127
	128	int rpc_call_async(struct rpc_clnt clnt, struct rpc_message msg,
963d8fe5 TM	129	int flags, const struct rpc_call_ops *tk_ops,
963d8fe5 TM	130	void *calldata);
1da177e4 LT	131	int rpc_call_sync(struct rpc_clnt clnt, struct rpc_message msg,
1da177e4 LT	132	int flags);
5e1550d6 TM	133	struct rpc_task rpc_call_null(struct rpc_clnt clnt, struct rpc_cred *cred,
5e1550d6 TM	134	int flags);
1da177e4 LT	135	void rpc_restart_call(struct rpc_task *);
	136	void rpc_clnt_sigmask(struct rpc_clnt clnt, sigset_t oldset);
	137	void rpc_clnt_sigunmask(struct rpc_clnt clnt, sigset_t oldset);
	138	void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
	139	size_t rpc_max_payload(struct rpc_clnt *);
35f5a422	140	void rpc_force_rebind(struct rpc_clnt *);
ed39440a	141	size_t rpc_peeraddr(struct rpc_clnt , struct sockaddr , size_t);
f425eba4	142	char * rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
1da177e4	143
1da177e4 LT	144	/*
	145	* Helper function for NFSroot support
	146	*/
a509050b	147	int rpcb_getport_external(struct sockaddr_in *, __u32, __u32, int);
1da177e4 LT	148
	149	#endif /* __KERNEL__ */
	150	#endif /* _LINUX_SUNRPC_CLNT_H */