[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 {
	atomic_t		cl_count;	/* Number of clones */
	atomic_t		cl_users;	/* number of references */
	struct list_head	cl_clients;	/* Global list of clients */
	struct list_head	cl_tasks;	/* List of tasks */
	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() */
				cl_oneshot  : 1,/* dispose after use */
				cl_dead     : 1;/* abandoned */

	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_ONESHOT		(1UL << 3)
#define RPC_CLNT_CREATE_NONPRIVPORT	(1UL << 4)
#define RPC_CLNT_CREATE_NOPING		(1UL << 5)
#define RPC_CLNT_CREATE_DISCRTRY	(1UL << 6)

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 *);
int		rpc_shutdown_client(struct rpc_clnt *);
int		rpc_destroy_client(struct rpc_clnt *);
void		rpc_release_client(struct rpc_clnt *);
void		rpc_register_client(struct rpc_clnt *);
void		rpc_unregister_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);
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 *);
int		rpc_ping(struct rpc_clnt *clnt, int flags);
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 {
	27	atomic_t cl_count; /* Number of clones */
	28	atomic_t cl_users; /* number of references */
6529eba0 TM	29	struct list_head cl_clients; /* Global list of clients */
6529eba0 TM	30	struct list_head cl_tasks; /* List of tasks */
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 */
1da177e4 LT	46	cl_autobind : 1,/* use getport() */
	47	cl_oneshot : 1,/* dispose after use */
	48	cl_dead : 1;/* abandoned */
	49
	50	struct rpc_rtt * cl_rtt; /* RTO estimator data */
1da177e4 LT	51
	52	int cl_nodelen; /* nodename length */
	53	char cl_nodename[UNX_MAXNODENAME];
	54	char cl_pathname[30];/* Path in rpc_pipe_fs */
54281548	55	struct vfsmount * cl_vfsmnt;
1da177e4 LT	56	struct dentry * cl_dentry; /* inode */
	57	struct rpc_clnt * cl_parent; /* Points to parent of clones */
	58	struct rpc_rtt cl_rtt_default;
3e32a5d9	59	struct rpc_program * cl_program;
1da177e4 LT	60	char cl_inline_name[32];
1da177e4 LT	61	};
1da177e4 LT	62
	63	/*
	64	* General RPC program info
	65	*/
	66	#define RPC_MAXVERSION 4
	67	struct rpc_program {
	68	char * name; /* protocol name */
	69	u32 number; /* program number */
	70	unsigned int nrvers; /* number of versions */
	71	struct rpc_version ** version; /* version array */
	72	struct rpc_stat * stats; /* statistics */
	73	char * pipe_dir_name; /* path to rpc_pipefs dir */
	74	};
	75
	76	struct rpc_version {
	77	u32 number; /* version number */
	78	unsigned int nrprocs; /* number of procs */
	79	struct rpc_procinfo * procs; /* procedure array */
	80	};
	81
	82	/*
	83	* Procedure information
	84	*/
	85	struct rpc_procinfo {
	86	u32 p_proc; /* RPC procedure number */
	87	kxdrproc_t p_encode; /* XDR encode function */
	88	kxdrproc_t p_decode; /* XDR decode function */
2bea90d4 CL	89	unsigned int p_arglen; /* argument hdr length (u32) */
2bea90d4 CL	90	unsigned int p_replen; /* reply hdr length (u32) */
1da177e4 LT	91	unsigned int p_count; /* call count */
1da177e4 LT	92	unsigned int p_timer; /* Which RTT timer to use */
cc0175c1 CL	93	u32 p_statidx; /* Which procedure to account */
cc0175c1 CL	94	char * p_name; /* name of procedure */
1da177e4 LT	95	};
1da177e4 LT	96
1da177e4 LT	97	#ifdef __KERNEL__
1da177e4 LT	98
c2866763 CL	99	struct rpc_create_args {
	100	int protocol;
	101	struct sockaddr *address;
	102	size_t addrsize;
	103	struct rpc_timeout *timeout;
	104	char *servername;
	105	struct rpc_program *program;
	106	u32 version;
	107	rpc_authflavor_t authflavor;
	108	unsigned long flags;
	109	};
	110
	111	/* Values for "flags" field */
	112	#define RPC_CLNT_CREATE_HARDRTRY (1UL << 0)
	113	#define RPC_CLNT_CREATE_INTR (1UL << 1)
	114	#define RPC_CLNT_CREATE_AUTOBIND (1UL << 2)
	115	#define RPC_CLNT_CREATE_ONESHOT (1UL << 3)
	116	#define RPC_CLNT_CREATE_NONPRIVPORT (1UL << 4)
	117	#define RPC_CLNT_CREATE_NOPING (1UL << 5)
43d78ef2	118	#define RPC_CLNT_CREATE_DISCRTRY (1UL << 6)
c2866763 CL	119
c2866763 CL	120	struct rpc_clnt rpc_create(struct rpc_create_args args);
007e251f AG	121	struct rpc_clnt rpc_bind_new_program(struct rpc_clnt ,
007e251f AG	122	struct rpc_program *, int);
1da177e4 LT	123	struct rpc_clnt rpc_clone_client(struct rpc_clnt );
	124	int rpc_shutdown_client(struct rpc_clnt *);
	125	int rpc_destroy_client(struct rpc_clnt *);
	126	void rpc_release_client(struct rpc_clnt *);
6529eba0 TM	127	void rpc_register_client(struct rpc_clnt *);
6529eba0 TM	128	void rpc_unregister_client(struct rpc_clnt *);
a509050b CL	129	int rpcb_register(u32, u32, int, unsigned short, int *);
a509050b CL	130	void rpcb_getport(struct rpc_task *);
1da177e4 LT	131
	132	void rpc_call_setup(struct rpc_task , struct rpc_message , int);
	133
	134	int rpc_call_async(struct rpc_clnt clnt, struct rpc_message msg,
963d8fe5 TM	135	int flags, const struct rpc_call_ops *tk_ops,
963d8fe5 TM	136	void *calldata);
1da177e4 LT	137	int rpc_call_sync(struct rpc_clnt clnt, struct rpc_message msg,
	138	int flags);
	139	void rpc_restart_call(struct rpc_task *);
	140	void rpc_clnt_sigmask(struct rpc_clnt clnt, sigset_t oldset);
	141	void rpc_clnt_sigunmask(struct rpc_clnt clnt, sigset_t oldset);
	142	void rpc_setbufsize(struct rpc_clnt *, unsigned int, unsigned int);
	143	size_t rpc_max_payload(struct rpc_clnt *);
35f5a422	144	void rpc_force_rebind(struct rpc_clnt *);
5ee0ed7d	145	int rpc_ping(struct rpc_clnt *clnt, int flags);
ed39440a	146	size_t rpc_peeraddr(struct rpc_clnt , struct sockaddr , size_t);
f425eba4	147	char * rpc_peeraddr2str(struct rpc_clnt *, enum rpc_display_format_t);
1da177e4	148
1da177e4 LT	149	/*
	150	* Helper function for NFSroot support
	151	*/
a509050b	152	int rpcb_getport_external(struct sockaddr_in *, __u32, __u32, int);
1da177e4 LT	153
	154	#endif /* __KERNEL__ */
	155	#endif /* _LINUX_SUNRPC_CLNT_H */