lockd.h 11 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * 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>
15 16
#include <linux/in6.h>
#include <net/ipv6.h>
Linus Torvalds's avatar
Linus Torvalds committed
17
#include <linux/fs.h>
18
#include <linux/kref.h>
Linus Torvalds's avatar
Linus Torvalds committed
19 20 21 22 23 24 25
#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>
26
#include <linux/sunrpc/svc.h>
Linus Torvalds's avatar
Linus Torvalds committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

/*
 * 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 {
42
	struct hlist_node	h_hash;		/* doubly linked list */
43 44
	struct sockaddr_storage	h_addr;		/* peer address */
	size_t			h_addrlen;
45
	struct sockaddr_storage	h_srcaddr;	/* our address (optional) */
46
	size_t			h_srcaddrlen;
47 48
	struct rpc_clnt		*h_rpcclnt;	/* RPC client to talk to peer */
	char			*h_name;		/* remote hostname */
Linus Torvalds's avatar
Linus Torvalds committed
49 50 51 52
	u32			h_version;	/* interface version */
	unsigned short		h_proto;	/* transport proto */
	unsigned short		h_reclaiming : 1,
				h_server     : 1, /* server side, not client side */
53
				h_noresvport : 1,
54
				h_inuse      : 1;
Linus Torvalds's avatar
Linus Torvalds committed
55
	wait_queue_head_t	h_gracewait;	/* wait while reclaiming */
Trond Myklebust's avatar
Trond Myklebust committed
56
	struct rw_semaphore	h_rwsem;	/* Reboot recovery lock */
Linus Torvalds's avatar
Linus Torvalds committed
57 58 59 60
	u32			h_state;	/* pseudo-state counter */
	u32			h_nsmstate;	/* true remote NSM state */
	u32			h_pidcount;	/* Pseudopids */
	atomic_t		h_count;	/* reference count */
61
	struct mutex		h_mutex;	/* mutex for pmap binding */
Linus Torvalds's avatar
Linus Torvalds committed
62 63 64 65
	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;
66 67
	struct list_head	h_granted;	/* Locks in GRANTED state */
	struct list_head	h_reclaim;	/* Locks in RECLAIM state */
68
	struct nsm_handle	*h_nsmhandle;	/* NSM status handle */
69
	char			*h_addrbuf;	/* address eyecatcher */
70
	struct net		*net;		/* host net */
71
	char			nodename[UNX_MAXNODENAME + 1];
72 73
};

74 75 76 77 78 79 80 81
/*
 * 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)

82 83 84
struct nsm_handle {
	struct list_head	sm_link;
	atomic_t		sm_count;
85
	char			*sm_mon_name;
86
	char			*sm_name;
87 88
	struct sockaddr_storage	sm_addr;
	size_t			sm_addrlen;
89 90
	unsigned int		sm_monitored : 1,
				sm_sticky : 1;	/* don't unmonitor */
91
	struct nsm_private	sm_priv;
92
	char			sm_addrbuf[NSM_ADDRBUF];
Linus Torvalds's avatar
Linus Torvalds committed
93 94
};

95 96 97 98 99 100 101 102 103 104 105 106 107
/*
 * 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;
}

108 109 110 111 112 113 114 115 116 117
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;
}

Linus Torvalds's avatar
Linus Torvalds committed
118 119 120 121 122 123 124 125 126 127 128 129
/*
 * 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;
};

130 131
struct nlm_wait;

Linus Torvalds's avatar
Linus Torvalds committed
132 133 134
/*
 * Memory chunk for NLM client RPC request.
 */
135
#define NLMCLNT_OHSIZE		((__NEW_UTS_LEN) + 10u)
Linus Torvalds's avatar
Linus Torvalds committed
136
struct nlm_rqst {
137
	atomic_t		a_count;
Linus Torvalds's avatar
Linus Torvalds committed
138 139 140 141
	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 */
142
	struct nlm_block *	a_block;
143
	unsigned int		a_retries;	/* Retry count */
144
	u8			a_owner[NLMCLNT_OHSIZE];
Linus Torvalds's avatar
Linus Torvalds committed
145 146 147 148 149 150 151
};

/*
 * This struct describes a file held open by lockd on behalf of
 * an NFS client.
 */
struct nlm_file {
152
	struct hlist_node	f_list;		/* linked list */
Linus Torvalds's avatar
Linus Torvalds committed
153 154 155
	struct nfs_fh		f_handle;	/* NFS file handle */
	struct file *		f_file;		/* VFS file pointer */
	struct nlm_share *	f_shares;	/* DOS shares */
156
	struct list_head	f_blocks;	/* blocked locks */
Linus Torvalds's avatar
Linus Torvalds committed
157 158
	unsigned int		f_locks;	/* guesstimate # of locks */
	unsigned int		f_count;	/* reference count */
159
	struct mutex		f_mutex;	/* avoid concurrent access */
Linus Torvalds's avatar
Linus Torvalds committed
160 161 162 163 164 165 166
};

/*
 * 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)
167 168 169
/* timeout on non-blocking call: */
#define NLM_TIMEOUT		(7 * HZ)

Linus Torvalds's avatar
Linus Torvalds committed
170
struct nlm_block {
171
	struct kref		b_count;	/* Reference count */
172 173
	struct list_head	b_list;		/* linked list of all blocks */
	struct list_head	b_flist;	/* linked list (per file) */
174
	struct nlm_rqst	*	b_call;		/* RPC args & callback info */
Linus Torvalds's avatar
Linus Torvalds committed
175 176 177 178 179 180
	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 */
181 182 183 184 185 186
	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 */
Linus Torvalds's avatar
Linus Torvalds committed
187 188 189 190 191
};

/*
 * Global variables
 */
192
extern const struct rpc_program	nlm_program;
Linus Torvalds's avatar
Linus Torvalds committed
193 194 195 196 197 198
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;
199
extern bool			nsm_use_hostnames;
200
extern u32			nsm_local_state;
Linus Torvalds's avatar
Linus Torvalds committed
201 202 203 204

/*
 * Lockd client functions
 */
205 206
struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
int		  nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
207
int		  nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
208
void		  nlmclnt_release_call(struct nlm_rqst *);
209 210 211
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);
212 213
__be32		  nlmclnt_grant(const struct sockaddr *addr,
				const struct nlm_lock *lock);
214
void		  nlmclnt_recovery(struct nlm_host *);
215 216
int		  nlmclnt_reclaim(struct nlm_host *, struct file_lock *,
				  struct nlm_rqst *);
217
void		  nlmclnt_next_cookie(struct nlm_cookie *);
Linus Torvalds's avatar
Linus Torvalds committed
218 219 220 221

/*
 * Host cache
 */
222 223 224 225
struct nlm_host  *nlmclnt_lookup_host(const struct sockaddr *sap,
					const size_t salen,
					const unsigned short protocol,
					const u32 version,
226
					const char *hostname,
227 228
					int noresvport,
					struct net *net);
229
void		  nlmclnt_release_host(struct nlm_host *);
230 231 232
struct nlm_host  *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
					const char *hostname,
					const size_t hostname_len);
233
void		  nlmsvc_release_host(struct nlm_host *);
Linus Torvalds's avatar
Linus Torvalds committed
234 235 236 237
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);
238
void		  nlm_shutdown_hosts_net(struct net *net);
239 240
void		  nlm_host_rebooted(const struct net *net,
					const struct nlm_reboot *);
Linus Torvalds's avatar
Linus Torvalds committed
241

242 243 244 245
/*
 * Host monitoring
 */
int		  nsm_monitor(const struct nlm_host *host);
246
void		  nsm_unmonitor(const struct nlm_host *host);
Linus Torvalds's avatar
Linus Torvalds committed
247

248 249
struct nsm_handle *nsm_get_handle(const struct net *net,
					const struct sockaddr *sap,
250
					const size_t salen,
251
					const char *hostname,
252
					const size_t hostname_len);
253 254
struct nsm_handle *nsm_reboot_lookup(const struct net *net,
					const struct nlm_reboot *info);
255 256
void		  nsm_release(struct nsm_handle *nsm);

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

Linus Torvalds's avatar
Linus Torvalds committed
263 264 265
/*
 * Server-side lock handling
 */
266
__be32		  nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
267
			      struct nlm_host *, struct nlm_lock *, int,
268
			      struct nlm_cookie *, int);
269
__be32		  nlmsvc_unlock(struct net *net, struct nlm_file *, struct nlm_lock *);
270
__be32		  nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
271 272
			struct nlm_host *, struct nlm_lock *,
			struct nlm_lock *, struct nlm_cookie *);
273
__be32		  nlmsvc_cancel_blocked(struct net *net, struct nlm_file *, struct nlm_lock *);
Linus Torvalds's avatar
Linus Torvalds committed
274
unsigned long	  nlmsvc_retry_blocked(void);
275
void		  nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
276
					nlm_host_match_fn_t match);
277
void		  nlmsvc_grant_reply(struct nlm_cookie *, __be32);
278
void		  nlmsvc_release_call(struct nlm_rqst *);
Linus Torvalds's avatar
Linus Torvalds committed
279 280 281 282

/*
 * File handling for the server personality
 */
283
__be32		  nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
Linus Torvalds's avatar
Linus Torvalds committed
284 285
					struct nfs_fh *);
void		  nlm_release_file(struct nlm_file *);
286
void		  nlmsvc_mark_resources(struct net *);
Linus Torvalds's avatar
Linus Torvalds committed
287 288 289
void		  nlmsvc_free_host_resources(struct nlm_host *);
void		  nlmsvc_invalidate_all(void);

290 291 292
/*
 * Cluster failover support
 */
293
int           nlmsvc_unlock_all_by_sb(struct super_block *sb);
294
int           nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
295

296
static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
Linus Torvalds's avatar
Linus Torvalds committed
297
{
Al Viro's avatar
Al Viro committed
298
	return file_inode(file->f_file);
Linus Torvalds's avatar
Linus Torvalds committed
299 300
}

301 302 303
static inline int __nlm_privileged_request4(const struct sockaddr *sap)
{
	const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
304 305 306 307 308

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

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

311
#if IS_ENABLED(CONFIG_IPV6)
312 313 314
static inline int __nlm_privileged_request6(const struct sockaddr *sap)
{
	const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
315 316 317 318 319 320 321 322

	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;
323
}
324
#else	/* IS_ENABLED(CONFIG_IPV6) */
325 326 327 328
static inline int __nlm_privileged_request6(const struct sockaddr *sap)
{
	return 0;
}
329
#endif	/* IS_ENABLED(CONFIG_IPV6) */
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350

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

Linus Torvalds's avatar
Linus Torvalds committed
351 352 353 354
/*
 * Compare two NLM locks.
 * When the second lock is of type F_UNLCK, this acts like a wildcard.
 */
355 356
static inline int nlm_compare_locks(const struct file_lock *fl1,
				    const struct file_lock *fl2)
Linus Torvalds's avatar
Linus Torvalds committed
357 358
{
	return	fl1->fl_pid   == fl2->fl_pid
359
	     && fl1->fl_owner == fl2->fl_owner
Linus Torvalds's avatar
Linus Torvalds committed
360 361 362 363 364
	     && fl1->fl_start == fl2->fl_start
	     && fl1->fl_end   == fl2->fl_end
	     &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
}

365
extern const struct lock_manager_operations nlmsvc_lock_operations;
Linus Torvalds's avatar
Linus Torvalds committed
366 367 368 369

#endif /* __KERNEL__ */

#endif /* LINUX_LOCKD_LOCKD_H */