[deliverable/linux.git] / include / linux / lockd / lockd.h

/*
 * linux/include/linux/lockd/lockd.h
 *
 * General-purpose lockd include file.
 *
 * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
 */

#ifndef LINUX_LOCKD_LOCKD_H
#define LINUX_LOCKD_LOCKD_H

#ifdef __KERNEL__

#include <linux/in.h>
#include <linux/in6.h>
#include <net/ipv6.h>
#include <linux/fs.h>
#include <linux/kref.h>
#include <linux/utsname.h>
#include <linux/nfsd/nfsfh.h>
#include <linux/lockd/bind.h>
#include <linux/lockd/xdr.h>
#ifdef CONFIG_LOCKD_V4
#include <linux/lockd/xdr4.h>
#endif
#include <linux/lockd/debug.h>

/*
 * Version string
 */
#define LOCKD_VERSION		"0.5"

/*
 * Default timeout for RPC calls (seconds)
 */
#define LOCKD_DFLT_TIMEO	10

/*
 * Lockd host handle (used both by the client and server personality).
 */
struct nlm_host {
	struct hlist_node	h_hash;		/* doubly linked list */
	struct sockaddr_storage	h_addr;		/* peer address */
	size_t			h_addrlen;
	struct sockaddr_storage	h_srcaddr;	/* our address (optional) */
	struct rpc_clnt		*h_rpcclnt;	/* RPC client to talk to peer */
	char			*h_name;		/* remote hostname */
	u32			h_version;	/* interface version */
	unsigned short		h_proto;	/* transport proto */
	unsigned short		h_reclaiming : 1,
				h_server     : 1, /* server side, not client side */
				h_noresvport : 1,
				h_inuse      : 1;
	wait_queue_head_t	h_gracewait;	/* wait while reclaiming */
	struct rw_semaphore	h_rwsem;	/* Reboot recovery lock */
	u32			h_state;	/* pseudo-state counter */
	u32			h_nsmstate;	/* true remote NSM state */
	u32			h_pidcount;	/* Pseudopids */
	atomic_t		h_count;	/* reference count */
	struct mutex		h_mutex;	/* mutex for pmap binding */
	unsigned long		h_nextrebind;	/* next portmap call */
	unsigned long		h_expires;	/* eligible for GC */
	struct list_head	h_lockowners;	/* Lockowners for the client */
	spinlock_t		h_lock;
	struct list_head	h_granted;	/* Locks in GRANTED state */
	struct list_head	h_reclaim;	/* Locks in RECLAIM state */
	struct nsm_handle	*h_nsmhandle;	/* NSM status handle */
	char			*h_addrbuf;	/* address eyecatcher */
};

/*
 * The largest string sm_addrbuf should hold is a full-size IPv6 address
 * (no "::" anywhere) with a scope ID.  The buffer size is computed to
 * hold eight groups of colon-separated four-hex-digit numbers, a
 * percent sign, a scope id (at most 32 bits, in decimal), and NUL.
 */
#define NSM_ADDRBUF		((8 * 4 + 7) + (1 + 10) + 1)

struct nsm_handle {
	struct list_head	sm_link;
	atomic_t		sm_count;
	char			*sm_name;
	struct sockaddr_storage	sm_addr;
	size_t			sm_addrlen;
	unsigned int		sm_monitored : 1,
				sm_sticky : 1;	/* don't unmonitor */
	char			sm_addrbuf[NSM_ADDRBUF];
};

/*
 * Rigorous type checking on sockaddr type conversions
 */
static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
{
	return (struct sockaddr_in *)&host->h_addr;
}

static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
{
	return (struct sockaddr *)&host->h_addr;
}

static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
{
	return (struct sockaddr_in *)&host->h_srcaddr;
}

static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
{
	return (struct sockaddr *)&host->h_srcaddr;
}

static inline struct sockaddr_in *nsm_addr_in(const struct nsm_handle *handle)
{
	return (struct sockaddr_in *)&handle->sm_addr;
}

static inline struct sockaddr *nsm_addr(const struct nsm_handle *handle)
{
	return (struct sockaddr *)&handle->sm_addr;
}

/*
 * Map an fl_owner_t into a unique 32-bit "pid"
 */
struct nlm_lockowner {
	struct list_head list;
	atomic_t count;

	struct nlm_host *host;
	fl_owner_t owner;
	uint32_t pid;
};

struct nlm_wait;

/*
 * Memory chunk for NLM client RPC request.
 */
#define NLMCLNT_OHSIZE		((__NEW_UTS_LEN) + 10u)
struct nlm_rqst {
	atomic_t		a_count;
	unsigned int		a_flags;	/* initial RPC task flags */
	struct nlm_host *	a_host;		/* host handle */
	struct nlm_args		a_args;		/* arguments */
	struct nlm_res		a_res;		/* result */
	struct nlm_block *	a_block;
	unsigned int		a_retries;	/* Retry count */
	u8			a_owner[NLMCLNT_OHSIZE];
};

/*
 * This struct describes a file held open by lockd on behalf of
 * an NFS client.
 */
struct nlm_file {
	struct hlist_node	f_list;		/* linked list */
	struct nfs_fh		f_handle;	/* NFS file handle */
	struct file *		f_file;		/* VFS file pointer */
	struct nlm_share *	f_shares;	/* DOS shares */
	struct list_head	f_blocks;	/* blocked locks */
	unsigned int		f_locks;	/* guesstimate # of locks */
	unsigned int		f_count;	/* reference count */
	struct mutex		f_mutex;	/* avoid concurrent access */
};

/*
 * This is a server block (i.e. a lock requested by some client which
 * couldn't be granted because of a conflicting lock).
 */
#define NLM_NEVER		(~(unsigned long) 0)
/* timeout on non-blocking call: */
#define NLM_TIMEOUT		(7 * HZ)

struct nlm_block {
	struct kref		b_count;	/* Reference count */
	struct list_head	b_list;		/* linked list of all blocks */
	struct list_head	b_flist;	/* linked list (per file) */
	struct nlm_rqst	*	b_call;		/* RPC args & callback info */
	struct svc_serv *	b_daemon;	/* NLM service */
	struct nlm_host *	b_host;		/* host handle for RPC clnt */
	unsigned long		b_when;		/* next re-xmit */
	unsigned int		b_id;		/* block id */
	unsigned char		b_granted;	/* VFS granted lock */
	struct nlm_file *	b_file;		/* file in question */
	struct cache_req *	b_cache_req;	/* deferred request handling */
	struct file_lock *	b_fl;		/* set for GETLK */
	struct cache_deferred_req * b_deferred_req;
	unsigned int		b_flags;	/* block flags */
#define B_QUEUED		1	/* lock queued */
#define B_GOT_CALLBACK		2	/* got lock or conflicting lock */
#define B_TIMED_OUT		4	/* filesystem too slow to respond */
};

/*
 * Global variables
 */
extern struct rpc_program	nlm_program;
extern struct svc_procedure	nlmsvc_procedures[];
#ifdef CONFIG_LOCKD_V4
extern struct svc_procedure	nlmsvc_procedures4[];
#endif
extern int			nlmsvc_grace_period;
extern unsigned long		nlmsvc_timeout;
extern int			nsm_use_hostnames;

/*
 * Lockd client functions
 */
struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
void		  nlm_release_call(struct nlm_rqst *);
int		  nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
int		  nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
void		  nlmclnt_finish_block(struct nlm_wait *block);
int		  nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
__be32		  nlmclnt_grant(const struct sockaddr *addr,
				const struct nlm_lock *lock);
void		  nlmclnt_recovery(struct nlm_host *);
int		  nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
void		  nlmclnt_next_cookie(struct nlm_cookie *);

/*
 * Host cache
 */
struct nlm_host  *nlmclnt_lookup_host(const struct sockaddr *sap,
					const size_t salen,
					const unsigned short protocol,
					const u32 version,
					const char *hostname,
					int noresvport);
struct nlm_host  *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
					const char *hostname,
					const size_t hostname_len);
struct rpc_clnt * nlm_bind_host(struct nlm_host *);
void		  nlm_rebind_host(struct nlm_host *);
struct nlm_host * nlm_get_host(struct nlm_host *);
void		  nlm_release_host(struct nlm_host *);
void		  nlm_shutdown_hosts(void);
extern void	  nlm_host_rebooted(const struct sockaddr_in *, const char *,
					unsigned int, u32);
void		  nsm_release(struct nsm_handle *);


/*
 * This is used in garbage collection and resource reclaim
 * A return value != 0 means destroy the lock/block/share
 */
typedef int	  (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);

/*
 * Server-side lock handling
 */
__be32		  nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
			      struct nlm_host *, struct nlm_lock *, int,
			      struct nlm_cookie *, int);
__be32		  nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
__be32		  nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
			struct nlm_host *, struct nlm_lock *,
			struct nlm_lock *, struct nlm_cookie *);
__be32		  nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
unsigned long	  nlmsvc_retry_blocked(void);
void		  nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
					nlm_host_match_fn_t match);
void		  nlmsvc_grant_reply(struct nlm_cookie *, __be32);

/*
 * File handling for the server personality
 */
__be32		  nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
					struct nfs_fh *);
void		  nlm_release_file(struct nlm_file *);
void		  nlmsvc_mark_resources(void);
void		  nlmsvc_free_host_resources(struct nlm_host *);
void		  nlmsvc_invalidate_all(void);

/*
 * Cluster failover support
 */
int           nlmsvc_unlock_all_by_sb(struct super_block *sb);
int           nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);

static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
{
	return file->f_file->f_path.dentry->d_inode;
}

static inline int __nlm_privileged_request4(const struct sockaddr *sap)
{
	const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
	return (sin->sin_addr.s_addr == htonl(INADDR_LOOPBACK)) &&
			(ntohs(sin->sin_port) < 1024);
}

#if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
static inline int __nlm_privileged_request6(const struct sockaddr *sap)
{
	const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
	return (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK) &&
			(ntohs(sin6->sin6_port) < 1024);
}
#else	/* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
static inline int __nlm_privileged_request6(const struct sockaddr *sap)
{
	return 0;
}
#endif	/* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */

/*
 * Ensure incoming requests are from local privileged callers.
 *
 * Return TRUE if sender is local and is connecting via a privileged port;
 * otherwise return FALSE.
 */
static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
{
	const struct sockaddr *sap = svc_addr(rqstp);

	switch (sap->sa_family) {
	case AF_INET:
		return __nlm_privileged_request4(sap);
	case AF_INET6:
		return __nlm_privileged_request6(sap);
	default:
		return 0;
	}
}

static inline int __nlm_cmp_addr4(const struct sockaddr *sap1,
				  const struct sockaddr *sap2)
{
	const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
	const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
	return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
}

static inline int __nlm_cmp_addr6(const struct sockaddr *sap1,
				  const struct sockaddr *sap2)
{
	const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
	const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
	return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
}

/*
 * Compare two host addresses
 *
 * Return TRUE if the addresses are the same; otherwise FALSE.
 */
static inline int nlm_cmp_addr(const struct sockaddr *sap1,
			       const struct sockaddr *sap2)
{
	if (sap1->sa_family == sap2->sa_family) {
		switch (sap1->sa_family) {
		case AF_INET:
			return __nlm_cmp_addr4(sap1, sap2);
		case AF_INET6:
			return __nlm_cmp_addr6(sap1, sap2);
		}
	}
	return 0;
}

/*
 * Compare two NLM locks.
 * When the second lock is of type F_UNLCK, this acts like a wildcard.
 */
static inline int nlm_compare_locks(const struct file_lock *fl1,
				    const struct file_lock *fl2)
{
	return	fl1->fl_pid   == fl2->fl_pid
	     && fl1->fl_owner == fl2->fl_owner
	     && fl1->fl_start == fl2->fl_start
	     && fl1->fl_end   == fl2->fl_end
	     &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
}

extern struct lock_manager_operations nlmsvc_lock_operations;

#endif /* __KERNEL__ */

#endif /* LINUX_LOCKD_LOCKD_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/include/linux/lockd/lockd.h
	3	*
	4	* General-purpose lockd include file.
	5	*
	6	* Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
	7	*/
	8
	9	#ifndef LINUX_LOCKD_LOCKD_H
	10	#define LINUX_LOCKD_LOCKD_H
	11
	12	#ifdef __KERNEL__
	13
1da177e4	14	#include <linux/in.h>
781b61a6 CL	15	#include <linux/in6.h>
781b61a6 CL	16	#include <net/ipv6.h>
1da177e4	17	#include <linux/fs.h>
6849c0ca	18	#include <linux/kref.h>
1da177e4 LT	19	#include <linux/utsname.h>
	20	#include <linux/nfsd/nfsfh.h>
	21	#include <linux/lockd/bind.h>
	22	#include <linux/lockd/xdr.h>
	23	#ifdef CONFIG_LOCKD_V4
	24	#include <linux/lockd/xdr4.h>
	25	#endif
	26	#include <linux/lockd/debug.h>
	27
	28	/*
	29	* Version string
	30	*/
	31	#define LOCKD_VERSION "0.5"
	32
	33	/*
	34	* Default timeout for RPC calls (seconds)
	35	*/
	36	#define LOCKD_DFLT_TIMEO 10
	37
	38	/*
	39	* Lockd host handle (used both by the client and server personality).
	40	*/
	41	struct nlm_host {
0cea3276	42	struct hlist_node h_hash; /* doubly linked list */
b4ed58fd CL	43	struct sockaddr_storage h_addr; /* peer address */
b4ed58fd CL	44	size_t h_addrlen;
90151e6e	45	struct sockaddr_storage h_srcaddr; /* our address (optional) */
7538ce1e CL	46	struct rpc_clnt h_rpcclnt; / RPC client to talk to peer */
7538ce1e CL	47	char h_name; / remote hostname */
1da177e4 LT	48	u32 h_version; /* interface version */
	49	unsigned short h_proto; /* transport proto */
	50	unsigned short h_reclaiming : 1,
	51	h_server : 1, /* server side, not client side */
0cb2659b	52	h_noresvport : 1,
350fce8d	53	h_inuse : 1;
1da177e4	54	wait_queue_head_t h_gracewait; /* wait while reclaiming */
28df955a	55	struct rw_semaphore h_rwsem; /* Reboot recovery lock */
1da177e4 LT	56	u32 h_state; /* pseudo-state counter */
	57	u32 h_nsmstate; /* true remote NSM state */
	58	u32 h_pidcount; /* Pseudopids */
	59	atomic_t h_count; /* reference count */
50467914	60	struct mutex h_mutex; /* mutex for pmap binding */
1da177e4 LT	61	unsigned long h_nextrebind; /* next portmap call */
	62	unsigned long h_expires; /* eligible for GC */
	63	struct list_head h_lockowners; /* Lockowners for the client */
	64	spinlock_t h_lock;
26bcbf96 CH	65	struct list_head h_granted; /* Locks in GRANTED state */
26bcbf96 CH	66	struct list_head h_reclaim; /* Locks in RECLAIM state */
7538ce1e	67	struct nsm_handle h_nsmhandle; / NSM status handle */
1df40b60	68	char h_addrbuf; / address eyecatcher */
8dead0db OK	69	};
8dead0db OK	70
bc995801 CL	71	/*
	72	* The largest string sm_addrbuf should hold is a full-size IPv6 address
	73	* (no "::" anywhere) with a scope ID. The buffer size is computed to
	74	* hold eight groups of colon-separated four-hex-digit numbers, a
	75	* percent sign, a scope id (at most 32 bits, in decimal), and NUL.
	76	*/
	77	#define NSM_ADDRBUF ((8 * 4 + 7) + (1 + 10) + 1)
	78
8dead0db OK	79	struct nsm_handle {
	80	struct list_head sm_link;
	81	atomic_t sm_count;
f47534f7	82	char *sm_name;
7e9d7746 CL	83	struct sockaddr_storage sm_addr;
7e9d7746 CL	84	size_t sm_addrlen;
8dead0db OK	85	unsigned int sm_monitored : 1,
8dead0db OK	86	sm_sticky : 1; /* don't unmonitor */
bc995801	87	char sm_addrbuf[NSM_ADDRBUF];
1da177e4 LT	88	};
1da177e4 LT	89
b4ed58fd CL	90	/*
	91	* Rigorous type checking on sockaddr type conversions
	92	*/
	93	static inline struct sockaddr_in nlm_addr_in(const struct nlm_host host)
	94	{
	95	return (struct sockaddr_in *)&host->h_addr;
	96	}
	97
	98	static inline struct sockaddr nlm_addr(const struct nlm_host host)
	99	{
	100	return (struct sockaddr *)&host->h_addr;
	101	}
	102
90151e6e CL	103	static inline struct sockaddr_in nlm_srcaddr_in(const struct nlm_host host)
	104	{
	105	return (struct sockaddr_in *)&host->h_srcaddr;
	106	}
	107
	108	static inline struct sockaddr nlm_srcaddr(const struct nlm_host host)
	109	{
	110	return (struct sockaddr *)&host->h_srcaddr;
	111	}
	112
7e9d7746 CL	113	static inline struct sockaddr_in nsm_addr_in(const struct nsm_handle handle)
	114	{
	115	return (struct sockaddr_in *)&handle->sm_addr;
	116	}
	117
	118	static inline struct sockaddr nsm_addr(const struct nsm_handle handle)
	119	{
	120	return (struct sockaddr *)&handle->sm_addr;
	121	}
	122
1da177e4 LT	123	/*
	124	* Map an fl_owner_t into a unique 32-bit "pid"
	125	*/
	126	struct nlm_lockowner {
	127	struct list_head list;
	128	atomic_t count;
	129
	130	struct nlm_host *host;
	131	fl_owner_t owner;
	132	uint32_t pid;
	133	};
	134
ecdbf769 TM	135	struct nlm_wait;
ecdbf769 TM	136
1da177e4 LT	137	/*
	138	* Memory chunk for NLM client RPC request.
	139	*/
511d2e88	140	#define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
1da177e4	141	struct nlm_rqst {
5e7f37a7	142	atomic_t a_count;
1da177e4 LT	143	unsigned int a_flags; /* initial RPC task flags */
	144	struct nlm_host * a_host; /* host handle */
	145	struct nlm_args a_args; /* arguments */
	146	struct nlm_res a_res; /* result */
92737230	147	struct nlm_block * a_block;
aaaa9942	148	unsigned int a_retries; /* Retry count */
92737230	149	u8 a_owner[NLMCLNT_OHSIZE];
1da177e4 LT	150	};
	151
	152	/*
	153	* This struct describes a file held open by lockd on behalf of
	154	* an NFS client.
	155	*/
	156	struct nlm_file {
07ba8063	157	struct hlist_node f_list; /* linked list */
1da177e4 LT	158	struct nfs_fh f_handle; /* NFS file handle */
	159	struct file * f_file; /* VFS file pointer */
	160	struct nlm_share * f_shares; /* DOS shares */
68a2d76c	161	struct list_head f_blocks; /* blocked locks */
1da177e4 LT	162	unsigned int f_locks; /* guesstimate # of locks */
1da177e4 LT	163	unsigned int f_count; /* reference count */
89e63ef6	164	struct mutex f_mutex; /* avoid concurrent access */
1da177e4 LT	165	};
	166
	167	/*
	168	* This is a server block (i.e. a lock requested by some client which
	169	* couldn't be granted because of a conflicting lock).
	170	*/
	171	#define NLM_NEVER (~(unsigned long) 0)
2b36f412 ME	172	/* timeout on non-blocking call: */
	173	#define NLM_TIMEOUT (7 * HZ)
	174
1da177e4	175	struct nlm_block {
6849c0ca	176	struct kref b_count; /* Reference count */
68a2d76c OK	177	struct list_head b_list; /* linked list of all blocks */
68a2d76c OK	178	struct list_head b_flist; /* linked list (per file) */
92737230	179	struct nlm_rqst * b_call; /* RPC args & callback info */
1da177e4 LT	180	struct svc_serv * b_daemon; /* NLM service */
	181	struct nlm_host * b_host; /* host handle for RPC clnt */
	182	unsigned long b_when; /* next re-xmit */
	183	unsigned int b_id; /* block id */
1da177e4	184	unsigned char b_granted; /* VFS granted lock */
1da177e4	185	struct nlm_file * b_file; /* file in question */
2b36f412 ME	186	struct cache_req * b_cache_req; /* deferred request handling */
	187	struct file_lock * b_fl; /* set for GETLK */
	188	struct cache_deferred_req * b_deferred_req;
	189	unsigned int b_flags; /* block flags */
	190	#define B_QUEUED 1 /* lock queued */
	191	#define B_GOT_CALLBACK 2 /* got lock or conflicting lock */
	192	#define B_TIMED_OUT 4 /* filesystem too slow to respond */
1da177e4 LT	193	};
1da177e4 LT	194
1da177e4 LT	195	/*
	196	* Global variables
	197	*/
	198	extern struct rpc_program nlm_program;
	199	extern struct svc_procedure nlmsvc_procedures[];
	200	#ifdef CONFIG_LOCKD_V4
	201	extern struct svc_procedure nlmsvc_procedures4[];
	202	#endif
	203	extern int nlmsvc_grace_period;
	204	extern unsigned long nlmsvc_timeout;
abd1f500	205	extern int nsm_use_hostnames;
1da177e4 LT	206
	207	/*
	208	* Lockd client functions
	209	*/
92737230 TM	210	struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
	211	void nlm_release_call(struct nlm_rqst *);
	212	int nlm_async_call(struct nlm_rqst , u32, const struct rpc_call_ops );
d4716624	213	int nlm_async_reply(struct nlm_rqst , u32, const struct rpc_call_ops );
3a649b88 TM	214	struct nlm_wait * nlmclnt_prepare_block(struct nlm_host host, struct file_lock fl);
	215	void nlmclnt_finish_block(struct nlm_wait *block);
	216	int nlmclnt_block(struct nlm_wait block, struct nlm_rqst req, long timeout);
dcff09f1 CL	217	__be32 nlmclnt_grant(const struct sockaddr *addr,
dcff09f1 CL	218	const struct nlm_lock *lock);
5c8dd29c	219	void nlmclnt_recovery(struct nlm_host *);
1da177e4	220	int nlmclnt_reclaim(struct nlm_host , struct file_lock );
031d869d	221	void nlmclnt_next_cookie(struct nlm_cookie *);
1da177e4 LT	222
	223	/*
	224	* Host cache
	225	*/
d7d20440 CL	226	struct nlm_host nlmclnt_lookup_host(const struct sockaddr sap,
	227	const size_t salen,
	228	const unsigned short protocol,
	229	const u32 version,
0cb2659b CL	230	const char *hostname,
0cb2659b CL	231	int noresvport);
6bfbe8af CL	232	struct nlm_host nlmsvc_lookup_host(const struct svc_rqst rqstp,
	233	const char *hostname,
	234	const size_t hostname_len);
1da177e4 LT	235	struct rpc_clnt * nlm_bind_host(struct nlm_host *);
	236	void nlm_rebind_host(struct nlm_host *);
	237	struct nlm_host * nlm_get_host(struct nlm_host *);
	238	void nlm_release_host(struct nlm_host *);
	239	void nlm_shutdown_hosts(void);
48df020a CL	240	extern void nlm_host_rebooted(const struct sockaddr_in , const char ,
48df020a CL	241	unsigned int, u32);
8dead0db	242	void nsm_release(struct nsm_handle *);
1da177e4 LT	243
1da177e4 LT	244
f2af793d OK	245	/*
	246	* This is used in garbage collection and resource reclaim
	247	* A return value != 0 means destroy the lock/block/share
	248	*/
4373ea84	249	typedef int (nlm_host_match_fn_t)(void cur, struct nlm_host *ref);
f2af793d	250
1da177e4 LT	251	/*
	252	* Server-side lock handling
	253	*/
52921e02	254	__be32 nlmsvc_lock(struct svc_rqst , struct nlm_file ,
6cde4de8	255	struct nlm_host , struct nlm_lock , int,
b2b50289	256	struct nlm_cookie *, int);
52921e02	257	__be32 nlmsvc_unlock(struct nlm_file , struct nlm_lock );
85f3f1b3	258	__be32 nlmsvc_testlock(struct svc_rqst , struct nlm_file ,
8f920d5e JL	259	struct nlm_host , struct nlm_lock ,
8f920d5e JL	260	struct nlm_lock , struct nlm_cookie );
52921e02	261	__be32 nlmsvc_cancel_blocked(struct nlm_file , struct nlm_lock );
1da177e4	262	unsigned long nlmsvc_retry_blocked(void);
f3ee439f	263	void nlmsvc_traverse_blocks(struct nlm_host , struct nlm_file ,
f2af793d	264	nlm_host_match_fn_t match);
e8c5c045	265	void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
1da177e4 LT	266
	267	/*
	268	* File handling for the server personality
	269	*/
52921e02	270	__be32 nlm_lookup_file(struct svc_rqst , struct nlm_file *,
1da177e4 LT	271	struct nfs_fh *);
	272	void nlm_release_file(struct nlm_file *);
	273	void nlmsvc_mark_resources(void);
	274	void nlmsvc_free_host_resources(struct nlm_host *);
	275	void nlmsvc_invalidate_all(void);
	276
4373ea84 WC	277	/*
	278	* Cluster failover support
	279	*/
17efa372	280	int nlmsvc_unlock_all_by_sb(struct super_block *sb);
367c8c7b	281	int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
4373ea84	282
f34ec991	283	static inline struct inode nlmsvc_file_inode(struct nlm_file file)
1da177e4	284	{
225a719f	285	return file->f_file->f_path.dentry->d_inode;
1da177e4 LT	286	}
1da177e4 LT	287
b85e4676 CL	288	static inline int __nlm_privileged_request4(const struct sockaddr *sap)
	289	{
	290	const struct sockaddr_in sin = (struct sockaddr_in )sap;
	291	return (sin->sin_addr.s_addr == htonl(INADDR_LOOPBACK)) &&
	292	(ntohs(sin->sin_port) < 1024);
	293	}
	294
	295	#if defined(CONFIG_IPV6) \|\| defined(CONFIG_IPV6_MODULE)
	296	static inline int __nlm_privileged_request6(const struct sockaddr *sap)
	297	{
	298	const struct sockaddr_in6 sin6 = (struct sockaddr_in6 )sap;
	299	return (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK) &&
	300	(ntohs(sin6->sin6_port) < 1024);
	301	}
	302	#else /* defined(CONFIG_IPV6) \|\| defined(CONFIG_IPV6_MODULE) */
	303	static inline int __nlm_privileged_request6(const struct sockaddr *sap)
	304	{
	305	return 0;
	306	}
	307	#endif /* defined(CONFIG_IPV6) \|\| defined(CONFIG_IPV6_MODULE) */
	308
	309	/*
	310	* Ensure incoming requests are from local privileged callers.
	311	*
	312	* Return TRUE if sender is local and is connecting via a privileged port;
	313	* otherwise return FALSE.
	314	*/
	315	static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
	316	{
	317	const struct sockaddr *sap = svc_addr(rqstp);
	318
	319	switch (sap->sa_family) {
	320	case AF_INET:
	321	return __nlm_privileged_request4(sap);
	322	case AF_INET6:
	323	return __nlm_privileged_request6(sap);
	324	default:
	325	return 0;
	326	}
	327	}
	328
781b61a6 CL	329	static inline int __nlm_cmp_addr4(const struct sockaddr *sap1,
	330	const struct sockaddr *sap2)
	331	{
	332	const struct sockaddr_in sin1 = (const struct sockaddr_in )sap1;
	333	const struct sockaddr_in sin2 = (const struct sockaddr_in )sap2;
	334	return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
	335	}
	336
	337	static inline int __nlm_cmp_addr6(const struct sockaddr *sap1,
	338	const struct sockaddr *sap2)
	339	{
	340	const struct sockaddr_in6 sin1 = (const struct sockaddr_in6 )sap1;
	341	const struct sockaddr_in6 sin2 = (const struct sockaddr_in6 )sap2;
	342	return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
	343	}
	344
1da177e4	345	/*
781b61a6 CL	346	* Compare two host addresses
	347	*
	348	* Return TRUE if the addresses are the same; otherwise FALSE.
1da177e4	349	*/
781b61a6 CL	350	static inline int nlm_cmp_addr(const struct sockaddr *sap1,
781b61a6 CL	351	const struct sockaddr *sap2)
1da177e4	352	{
781b61a6 CL	353	if (sap1->sa_family == sap2->sa_family) {
	354	switch (sap1->sa_family) {
	355	case AF_INET:
	356	return __nlm_cmp_addr4(sap1, sap2);
	357	case AF_INET6:
	358	return __nlm_cmp_addr6(sap1, sap2);
	359	}
	360	}
	361	return 0;
1da177e4 LT	362	}
	363
	364	/*
	365	* Compare two NLM locks.
	366	* When the second lock is of type F_UNLCK, this acts like a wildcard.
	367	*/
f34ec991 CL	368	static inline int nlm_compare_locks(const struct file_lock *fl1,
f34ec991 CL	369	const struct file_lock *fl2)
1da177e4 LT	370	{
1da177e4 LT	371	return fl1->fl_pid == fl2->fl_pid
3134cbec	372	&& fl1->fl_owner == fl2->fl_owner
1da177e4 LT	373	&& fl1->fl_start == fl2->fl_start
	374	&& fl1->fl_end == fl2->fl_end
	375	&&(fl1->fl_type == fl2->fl_type \|\| fl2->fl_type == F_UNLCK);
	376	}
	377
	378	extern struct lock_manager_operations nlmsvc_lock_operations;
	379
	380	#endif /* __KERNEL__ */
	381
	382	#endif /* LINUX_LOCKD_LOCKD_H */