[mirror_ubuntu-zesty-kernel.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/lockd/bind.h>
#include <linux/lockd/xdr.h>
#ifdef CONFIG_LOCKD_V4
#include <linux/lockd/xdr4.h>
#endif
#include <linux/lockd/debug.h>
#include <linux/sunrpc/svc.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) */
	size_t			h_srcaddrlen;
	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 */
	struct net		*net;		/* host net */
	char			nodename[UNX_MAXNODENAME + 1];
};

/*
 * 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_mon_name;
	char			*sm_name;
	struct sockaddr_storage	sm_addr;
	size_t			sm_addrlen;
	unsigned int		sm_monitored : 1,
				sm_sticky : 1;	/* don't unmonitor */
	struct nsm_private	sm_priv;
	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;
}

/*
 * 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 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 const 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 bool			nsm_use_hostnames;
extern u32			nsm_local_state;

/*
 * Lockd client functions
 */
struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
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 *);
void		  nlmclnt_release_call(struct nlm_rqst *);
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 *,
				  struct nlm_rqst *);
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 net *net);
void		  nlmclnt_release_host(struct nlm_host *);
struct nlm_host  *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
					const char *hostname,
					const size_t hostname_len);
void		  nlmsvc_release_host(struct nlm_host *);
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_shutdown_hosts(void);
void		  nlm_shutdown_hosts_net(struct net *net);
void		  nlm_host_rebooted(const struct net *net,
					const struct nlm_reboot *);

/*
 * Host monitoring
 */
int		  nsm_monitor(const struct nlm_host *host);
void		  nsm_unmonitor(const struct nlm_host *host);

struct nsm_handle *nsm_get_handle(const struct net *net,
					const struct sockaddr *sap,
					const size_t salen,
					const char *hostname,
					const size_t hostname_len);
struct nsm_handle *nsm_reboot_lookup(const struct net *net,
					const struct nlm_reboot *info);
void		  nsm_release(struct nsm_handle *nsm);

/*
 * 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 net *net, 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 net *net, 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);
void		  nlmsvc_release_call(struct nlm_rqst *);

/*
 * 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(struct net *);
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_inode(file->f_file);
}

static inline int __nlm_privileged_request4(const struct sockaddr *sap)
{
	const struct sockaddr_in *sin = (struct sockaddr_in *)sap;

	if (ntohs(sin->sin_port) > 1023)
		return 0;

	return ipv4_is_loopback(sin->sin_addr.s_addr);
}

#if IS_ENABLED(CONFIG_IPV6)
static inline int __nlm_privileged_request6(const struct sockaddr *sap)
{
	const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;

	if (ntohs(sin6->sin6_port) > 1023)
		return 0;

	if (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_MAPPED)
		return ipv4_is_loopback(sin6->sin6_addr.s6_addr32[3]);

	return ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK;
}
#else	/* IS_ENABLED(CONFIG_IPV6) */
static inline int __nlm_privileged_request6(const struct sockaddr *sap)
{
	return 0;
}
#endif	/* IS_ENABLED(CONFIG_IPV6) */

/*
 * 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;
	}
}

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