[linux-block.git] / include / linux / lockd / lockd.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * 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];
	const struct nlmclnt_operations	*h_nlmclnt_ops;	/* Callback ops for NLM users */
};

/*
 * 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];
	void *	a_callback_data; /* sent to nlmclnt_operations callbacks */
};

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