blob: c15373894a42a01a8c135a9b55619e3dbf5673a0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/in.h>
Chuck Lever781b61a2008-09-03 14:36:01 -040015#include <linux/in6.h>
16#include <net/ipv6.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/fs.h>
Trond Myklebust6849c0c2006-03-20 13:44:39 -050018#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#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>
Christoph Hellwig9c69de42014-05-06 19:37:13 +020026#include <linux/sunrpc/svc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
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 */
41struct nlm_host {
Olaf Kirch0cea3272006-10-04 02:15:56 -070042 struct hlist_node h_hash; /* doubly linked list */
Chuck Leverb4ed58f2008-09-03 14:35:39 -040043 struct sockaddr_storage h_addr; /* peer address */
44 size_t h_addrlen;
Chuck Lever90151e62008-09-03 14:35:46 -040045 struct sockaddr_storage h_srcaddr; /* our address (optional) */
Trond Myklebust8e35f8e2010-11-02 09:11:55 -040046 size_t h_srcaddrlen;
Chuck Lever7538ce12008-12-04 14:19:45 -050047 struct rpc_clnt *h_rpcclnt; /* RPC client to talk to peer */
48 char *h_name; /* remote hostname */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 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 */
Chuck Lever0cb26592008-12-23 15:21:38 -050053 h_noresvport : 1,
NeilBrown350fce82006-10-04 02:16:00 -070054 h_inuse : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 wait_queue_head_t h_gracewait; /* wait while reclaiming */
Trond Myklebust28df9552006-06-09 09:40:27 -040056 struct rw_semaphore h_rwsem; /* Reboot recovery lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 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 */
Trond Myklebust50467912006-06-09 09:40:24 -040061 struct mutex h_mutex; /* mutex for pmap binding */
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 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;
Christoph Hellwig26bcbf92006-03-20 13:44:40 -050066 struct list_head h_granted; /* Locks in GRANTED state */
67 struct list_head h_reclaim; /* Locks in RECLAIM state */
Chuck Lever7538ce12008-12-04 14:19:45 -050068 struct nsm_handle *h_nsmhandle; /* NSM status handle */
Chuck Lever1df40b62008-12-04 14:19:53 -050069 char *h_addrbuf; /* address eyecatcher */
Stanislav Kinsbursky66697bf2012-01-31 15:08:13 +040070 struct net *net; /* host net */
Andrey Ryabinin0d0f4aa2015-10-07 14:39:55 +030071 char nodename[UNX_MAXNODENAME + 1];
Olaf Kirch8dead0d2006-10-04 02:15:53 -070072};
73
Chuck Leverbc995802008-12-04 14:20:08 -050074/*
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
Olaf Kirch8dead0d2006-10-04 02:15:53 -070082struct nsm_handle {
83 struct list_head sm_link;
84 atomic_t sm_count;
Chuck Lever29ed1402008-12-04 14:20:46 -050085 char *sm_mon_name;
Chuck Leverf47534f2008-12-04 14:20:38 -050086 char *sm_name;
Chuck Lever7e9d77462008-09-03 14:35:54 -040087 struct sockaddr_storage sm_addr;
88 size_t sm_addrlen;
Olaf Kirch8dead0d2006-10-04 02:15:53 -070089 unsigned int sm_monitored : 1,
90 sm_sticky : 1; /* don't unmonitor */
Chuck Lever7e44d3b2008-12-05 19:03:16 -050091 struct nsm_private sm_priv;
Chuck Leverbc995802008-12-04 14:20:08 -050092 char sm_addrbuf[NSM_ADDRBUF];
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
94
95/*
Chuck Leverb4ed58f2008-09-03 14:35:39 -040096 * Rigorous type checking on sockaddr type conversions
97 */
98static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
99{
100 return (struct sockaddr_in *)&host->h_addr;
101}
102
103static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
104{
105 return (struct sockaddr *)&host->h_addr;
106}
107
Chuck Lever90151e62008-09-03 14:35:46 -0400108static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
109{
110 return (struct sockaddr_in *)&host->h_srcaddr;
111}
112
113static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
114{
115 return (struct sockaddr *)&host->h_srcaddr;
116}
117
Chuck Leverb4ed58f2008-09-03 14:35:39 -0400118/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 * Map an fl_owner_t into a unique 32-bit "pid"
120 */
121struct 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
Trond Myklebustecdbf762005-06-22 17:16:31 +0000130struct nlm_wait;
131
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132/*
133 * Memory chunk for NLM client RPC request.
134 */
Chuck Lever511d2e82007-03-29 16:47:47 -0400135#define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136struct nlm_rqst {
Trond Myklebust5e7f37a2008-04-01 18:58:49 -0400137 atomic_t a_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 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 */
Trond Myklebust92737232006-03-20 13:44:45 -0500142 struct nlm_block * a_block;
Trond Myklebustaaaa9942006-02-01 12:18:25 -0500143 unsigned int a_retries; /* Retry count */
Trond Myklebust92737232006-03-20 13:44:45 -0500144 u8 a_owner[NLMCLNT_OHSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145};
146
147/*
148 * This struct describes a file held open by lockd on behalf of
149 * an NFS client.
150 */
151struct nlm_file {
Olaf Kirch07ba8062006-10-04 02:15:58 -0700152 struct hlist_node f_list; /* linked list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 struct nfs_fh f_handle; /* NFS file handle */
154 struct file * f_file; /* VFS file pointer */
155 struct nlm_share * f_shares; /* DOS shares */
Olaf Kirch68a2d762006-10-04 02:15:57 -0700156 struct list_head f_blocks; /* blocked locks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 unsigned int f_locks; /* guesstimate # of locks */
158 unsigned int f_count; /* reference count */
Neil Brown89e63ef2006-10-04 02:16:06 -0700159 struct mutex f_mutex; /* avoid concurrent access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160};
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)
Marc Eshel2b36f412006-11-28 16:26:47 -0500167/* timeout on non-blocking call: */
168#define NLM_TIMEOUT (7 * HZ)
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170struct nlm_block {
Trond Myklebust6849c0c2006-03-20 13:44:39 -0500171 struct kref b_count; /* Reference count */
Olaf Kirch68a2d762006-10-04 02:15:57 -0700172 struct list_head b_list; /* linked list of all blocks */
173 struct list_head b_flist; /* linked list (per file) */
Trond Myklebust92737232006-03-20 13:44:45 -0500174 struct nlm_rqst * b_call; /* RPC args & callback info */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 unsigned char b_granted; /* VFS granted lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 struct nlm_file * b_file; /* file in question */
Marc Eshel2b36f412006-11-28 16:26:47 -0500181 struct cache_req * b_cache_req; /* deferred request handling */
Marc Eshel2b36f412006-11-28 16:26:47 -0500182 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187};
188
189/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 * Global variables
191 */
Trond Myklebusta613fa12012-01-20 13:53:56 -0500192extern const struct rpc_program nlm_program;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193extern struct svc_procedure nlmsvc_procedures[];
194#ifdef CONFIG_LOCKD_V4
195extern struct svc_procedure nlmsvc_procedures4[];
196#endif
197extern int nlmsvc_grace_period;
198extern unsigned long nlmsvc_timeout;
Rusty Russell90ab5ee2012-01-13 09:32:20 +1030199extern bool nsm_use_hostnames;
Chuck Lever6c9dc422009-06-17 18:02:10 -0700200extern u32 nsm_local_state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202/*
203 * Lockd client functions
204 */
Trond Myklebust92737232006-03-20 13:44:45 -0500205struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
Trond Myklebust92737232006-03-20 13:44:45 -0500206int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
Trond Myklebustd4716622006-03-20 13:44:45 -0500207int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
Chuck Lever7db836d2010-12-14 15:05:42 +0000208void nlmclnt_release_call(struct nlm_rqst *);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500209struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
210void nlmclnt_finish_block(struct nlm_wait *block);
211int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
Chuck Leverdcff09f2008-10-03 12:50:36 -0400212__be32 nlmclnt_grant(const struct sockaddr *addr,
213 const struct nlm_lock *lock);
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700214void nlmclnt_recovery(struct nlm_host *);
Tim Gardnerf25cc712013-02-13 08:40:16 -0700215int nlmclnt_reclaim(struct nlm_host *, struct file_lock *,
216 struct nlm_rqst *);
Olaf Kirch031d8692006-10-04 02:16:02 -0700217void nlmclnt_next_cookie(struct nlm_cookie *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219/*
220 * Host cache
221 */
Chuck Leverd7d20442008-10-03 12:50:21 -0400222struct nlm_host *nlmclnt_lookup_host(const struct sockaddr *sap,
223 const size_t salen,
224 const unsigned short protocol,
225 const u32 version,
Chuck Lever0cb26592008-12-23 15:21:38 -0500226 const char *hostname,
Stanislav Kinsbursky66697bf2012-01-31 15:08:13 +0400227 int noresvport,
228 struct net *net);
Chuck Lever8ea6ecc2010-12-14 15:05:52 +0000229void nlmclnt_release_host(struct nlm_host *);
Chuck Lever6bfbe8a2008-10-03 12:50:29 -0400230struct nlm_host *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
231 const char *hostname,
232 const size_t hostname_len);
Chuck Lever67216b92010-12-14 15:06:12 +0000233void nlmsvc_release_host(struct nlm_host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234struct rpc_clnt * nlm_bind_host(struct nlm_host *);
235void nlm_rebind_host(struct nlm_host *);
236struct nlm_host * nlm_get_host(struct nlm_host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237void nlm_shutdown_hosts(void);
Stanislav Kinsbursky3b647392012-01-31 15:08:29 +0400238void nlm_shutdown_hosts_net(struct net *net);
Andrey Ryabinin0ad95472015-09-23 15:49:29 +0300239void nlm_host_rebooted(const struct net *net,
240 const struct nlm_reboot *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Chuck Lever1e493232008-12-04 14:21:24 -0500242/*
243 * Host monitoring
244 */
245int nsm_monitor(const struct nlm_host *host);
Chuck Lever356c3eb2008-12-04 14:21:38 -0500246void nsm_unmonitor(const struct nlm_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Andrey Ryabinin0ad95472015-09-23 15:49:29 +0300248struct nsm_handle *nsm_get_handle(const struct net *net,
249 const struct sockaddr *sap,
Chuck Lever92fd91b2008-12-05 19:04:01 -0500250 const size_t salen,
Chuck Lever67c6d102008-12-05 19:02:45 -0500251 const char *hostname,
Chuck Lever92fd91b2008-12-05 19:04:01 -0500252 const size_t hostname_len);
Andrey Ryabinin0ad95472015-09-23 15:49:29 +0300253struct nsm_handle *nsm_reboot_lookup(const struct net *net,
254 const struct nlm_reboot *info);
Chuck Lever67c6d102008-12-05 19:02:45 -0500255void nsm_release(struct nsm_handle *nsm);
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257/*
Olaf Kirchf2af7932006-10-04 02:15:59 -0700258 * This is used in garbage collection and resource reclaim
259 * A return value != 0 means destroy the lock/block/share
260 */
Wendy Cheng4373ea82008-01-17 11:10:12 -0500261typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
Olaf Kirchf2af7932006-10-04 02:15:59 -0700262
263/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 * Server-side lock handling
265 */
Al Viro52921e02006-10-19 23:28:46 -0700266__be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
Jeff Layton6cde4de2008-07-15 14:26:17 -0400267 struct nlm_host *, struct nlm_lock *, int,
J. Bruce Fieldsb2b50282008-02-06 13:59:23 -0500268 struct nlm_cookie *, int);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400269__be32 nlmsvc_unlock(struct net *net, struct nlm_file *, struct nlm_lock *);
Marc Eshel85f3f1b32006-11-28 16:27:06 -0500270__be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
Jeff Layton8f920d52008-07-15 14:06:48 -0400271 struct nlm_host *, struct nlm_lock *,
272 struct nlm_lock *, struct nlm_cookie *);
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400273__be32 nlmsvc_cancel_blocked(struct net *net, struct nlm_file *, struct nlm_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274unsigned long nlmsvc_retry_blocked(void);
J. Bruce Fieldsf3ee439f2006-03-20 23:24:13 -0500275void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
Olaf Kirchf2af7932006-10-04 02:15:59 -0700276 nlm_host_match_fn_t match);
Al Viroe8c5c042006-12-13 00:35:03 -0800277void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
Chuck Lever7db836d2010-12-14 15:05:42 +0000278void nlmsvc_release_call(struct nlm_rqst *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
280/*
281 * File handling for the server personality
282 */
Al Viro52921e02006-10-19 23:28:46 -0700283__be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 struct nfs_fh *);
285void nlm_release_file(struct nlm_file *);
Stanislav Kinsburskyb26411f2012-07-25 16:55:54 +0400286void nlmsvc_mark_resources(struct net *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287void nlmsvc_free_host_resources(struct nlm_host *);
288void nlmsvc_invalidate_all(void);
289
Wendy Cheng4373ea82008-01-17 11:10:12 -0500290/*
291 * Cluster failover support
292 */
Wendy Cheng17efa372008-01-17 11:10:12 -0500293int nlmsvc_unlock_all_by_sb(struct super_block *sb);
Chuck Lever367c8c72008-06-30 18:58:14 -0400294int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
Wendy Cheng4373ea82008-01-17 11:10:12 -0500295
Chuck Leverf34ec992008-03-14 14:18:45 -0400296static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297{
Al Viro496ad9a2013-01-23 17:07:38 -0500298 return file_inode(file->f_file);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
300
Chuck Leverb85e4672008-10-03 12:50:44 -0400301static inline int __nlm_privileged_request4(const struct sockaddr *sap)
302{
303 const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
Chuck Lever57ef6922008-12-11 17:56:52 -0500304
305 if (ntohs(sin->sin_port) > 1023)
306 return 0;
307
308 return ipv4_is_loopback(sin->sin_addr.s_addr);
Chuck Leverb85e4672008-10-03 12:50:44 -0400309}
310
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000311#if IS_ENABLED(CONFIG_IPV6)
Chuck Leverb85e4672008-10-03 12:50:44 -0400312static inline int __nlm_privileged_request6(const struct sockaddr *sap)
313{
314 const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
Chuck Leverd1208f72008-12-11 17:56:44 -0500315
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;
Chuck Leverb85e4672008-10-03 12:50:44 -0400323}
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000324#else /* IS_ENABLED(CONFIG_IPV6) */
Chuck Leverb85e4672008-10-03 12:50:44 -0400325static inline int __nlm_privileged_request6(const struct sockaddr *sap)
326{
327 return 0;
328}
Eric Dumazetdfd56b82011-12-10 09:48:31 +0000329#endif /* IS_ENABLED(CONFIG_IPV6) */
Chuck Leverb85e4672008-10-03 12:50:44 -0400330
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 */
337static 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351/*
352 * Compare two NLM locks.
353 * When the second lock is of type F_UNLCK, this acts like a wildcard.
354 */
Chuck Leverf34ec992008-03-14 14:18:45 -0400355static inline int nlm_compare_locks(const struct file_lock *fl1,
356 const struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357{
358 return fl1->fl_pid == fl2->fl_pid
Marc Eshel3134cbe2006-06-09 09:40:20 -0400359 && fl1->fl_owner == fl2->fl_owner
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 && fl1->fl_start == fl2->fl_start
361 && fl1->fl_end == fl2->fl_end
362 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
363}
364
Alexey Dobriyan7b021962009-09-21 17:01:12 -0700365extern const struct lock_manager_operations nlmsvc_lock_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
367#endif /* __KERNEL__ */
368
369#endif /* LINUX_LOCKD_LOCKD_H */