blob: e2d1ce36b36728084d0d77538dd00b7101d1a528 [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>
15#include <linux/fs.h>
Trond Myklebust6849c0c2006-03-20 13:44:39 -050016#include <linux/kref.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/utsname.h>
18#include <linux/nfsd/nfsfh.h>
19#include <linux/lockd/bind.h>
20#include <linux/lockd/xdr.h>
21#ifdef CONFIG_LOCKD_V4
22#include <linux/lockd/xdr4.h>
23#endif
24#include <linux/lockd/debug.h>
25
26/*
27 * Version string
28 */
29#define LOCKD_VERSION "0.5"
30
31/*
32 * Default timeout for RPC calls (seconds)
33 */
34#define LOCKD_DFLT_TIMEO 10
35
36/*
37 * Lockd host handle (used both by the client and server personality).
38 */
39struct nlm_host {
Olaf Kirch0cea3272006-10-04 02:15:56 -070040 struct hlist_node h_hash; /* doubly linked list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 struct sockaddr_in h_addr; /* peer address */
Frank van Maarseveenc98451b2007-07-09 22:25:29 +020042 struct sockaddr_in h_saddr; /* our address (optional) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */
Olaf Kirch8dead0d2006-10-04 02:15:53 -070044 char * h_name; /* remote hostname */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 u32 h_version; /* interface version */
46 unsigned short h_proto; /* transport proto */
47 unsigned short h_reclaiming : 1,
48 h_server : 1, /* server side, not client side */
NeilBrown350fce82006-10-04 02:16:00 -070049 h_inuse : 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 wait_queue_head_t h_gracewait; /* wait while reclaiming */
Trond Myklebust28df9552006-06-09 09:40:27 -040051 struct rw_semaphore h_rwsem; /* Reboot recovery lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 u32 h_state; /* pseudo-state counter */
53 u32 h_nsmstate; /* true remote NSM state */
54 u32 h_pidcount; /* Pseudopids */
55 atomic_t h_count; /* reference count */
Trond Myklebust50467912006-06-09 09:40:24 -040056 struct mutex h_mutex; /* mutex for pmap binding */
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 unsigned long h_nextrebind; /* next portmap call */
58 unsigned long h_expires; /* eligible for GC */
59 struct list_head h_lockowners; /* Lockowners for the client */
60 spinlock_t h_lock;
Christoph Hellwig26bcbf92006-03-20 13:44:40 -050061 struct list_head h_granted; /* Locks in GRANTED state */
62 struct list_head h_reclaim; /* Locks in RECLAIM state */
Olaf Kirch8dead0d2006-10-04 02:15:53 -070063 struct nsm_handle * h_nsmhandle; /* NSM status handle */
64};
65
66struct nsm_handle {
67 struct list_head sm_link;
68 atomic_t sm_count;
69 char * sm_name;
70 struct sockaddr_in sm_addr;
71 unsigned int sm_monitored : 1,
72 sm_sticky : 1; /* don't unmonitor */
Linus Torvalds1da177e2005-04-16 15:20:36 -070073};
74
75/*
76 * Map an fl_owner_t into a unique 32-bit "pid"
77 */
78struct nlm_lockowner {
79 struct list_head list;
80 atomic_t count;
81
82 struct nlm_host *host;
83 fl_owner_t owner;
84 uint32_t pid;
85};
86
Trond Myklebustecdbf762005-06-22 17:16:31 +000087struct nlm_wait;
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089/*
90 * Memory chunk for NLM client RPC request.
91 */
Chuck Lever511d2e82007-03-29 16:47:47 -040092#define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093struct nlm_rqst {
94 unsigned int a_flags; /* initial RPC task flags */
95 struct nlm_host * a_host; /* host handle */
96 struct nlm_args a_args; /* arguments */
97 struct nlm_res a_res; /* result */
Trond Myklebust92737232006-03-20 13:44:45 -050098 struct nlm_block * a_block;
Trond Myklebustaaaa9942006-02-01 12:18:25 -050099 unsigned int a_retries; /* Retry count */
Trond Myklebust92737232006-03-20 13:44:45 -0500100 u8 a_owner[NLMCLNT_OHSIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101};
102
103/*
104 * This struct describes a file held open by lockd on behalf of
105 * an NFS client.
106 */
107struct nlm_file {
Olaf Kirch07ba8062006-10-04 02:15:58 -0700108 struct hlist_node f_list; /* linked list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 struct nfs_fh f_handle; /* NFS file handle */
110 struct file * f_file; /* VFS file pointer */
111 struct nlm_share * f_shares; /* DOS shares */
Olaf Kirch68a2d76c2006-10-04 02:15:57 -0700112 struct list_head f_blocks; /* blocked locks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 unsigned int f_locks; /* guesstimate # of locks */
114 unsigned int f_count; /* reference count */
Neil Brown89e63ef2006-10-04 02:16:06 -0700115 struct mutex f_mutex; /* avoid concurrent access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116};
117
118/*
119 * This is a server block (i.e. a lock requested by some client which
120 * couldn't be granted because of a conflicting lock).
121 */
122#define NLM_NEVER (~(unsigned long) 0)
Marc Eshel2b36f412006-11-28 16:26:47 -0500123/* timeout on non-blocking call: */
124#define NLM_TIMEOUT (7 * HZ)
125
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126struct nlm_block {
Trond Myklebust6849c0c2006-03-20 13:44:39 -0500127 struct kref b_count; /* Reference count */
Olaf Kirch68a2d76c2006-10-04 02:15:57 -0700128 struct list_head b_list; /* linked list of all blocks */
129 struct list_head b_flist; /* linked list (per file) */
Trond Myklebust92737232006-03-20 13:44:45 -0500130 struct nlm_rqst * b_call; /* RPC args & callback info */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 struct svc_serv * b_daemon; /* NLM service */
132 struct nlm_host * b_host; /* host handle for RPC clnt */
133 unsigned long b_when; /* next re-xmit */
134 unsigned int b_id; /* block id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 unsigned char b_granted; /* VFS granted lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 struct nlm_file * b_file; /* file in question */
Marc Eshel2b36f412006-11-28 16:26:47 -0500137 struct cache_req * b_cache_req; /* deferred request handling */
138 struct file_lock * b_fl; /* set for GETLK */
139 struct cache_deferred_req * b_deferred_req;
140 unsigned int b_flags; /* block flags */
141#define B_QUEUED 1 /* lock queued */
142#define B_GOT_CALLBACK 2 /* got lock or conflicting lock */
143#define B_TIMED_OUT 4 /* filesystem too slow to respond */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144};
145
146/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 * Global variables
148 */
149extern struct rpc_program nlm_program;
150extern struct svc_procedure nlmsvc_procedures[];
151#ifdef CONFIG_LOCKD_V4
152extern struct svc_procedure nlmsvc_procedures4[];
153#endif
154extern int nlmsvc_grace_period;
155extern unsigned long nlmsvc_timeout;
Olaf Kirchabd1f502006-10-04 02:16:01 -0700156extern int nsm_use_hostnames;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158/*
159 * Lockd client functions
160 */
Trond Myklebust92737232006-03-20 13:44:45 -0500161struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
162void nlm_release_call(struct nlm_rqst *);
163int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
Trond Myklebustd4716622006-03-20 13:44:45 -0500164int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
Trond Myklebust3a649b82006-03-20 13:44:44 -0500165struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
166void nlmclnt_finish_block(struct nlm_wait *block);
167int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
Al Viro52921e02006-10-19 23:28:46 -0700168__be32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700169void nlmclnt_recovery(struct nlm_host *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170int nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
Olaf Kirch031d8692006-10-04 02:16:02 -0700171void nlmclnt_next_cookie(struct nlm_cookie *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
173/*
174 * Host cache
175 */
Olaf Kirchdb4e4c92006-10-04 02:15:52 -0700176struct nlm_host * nlmclnt_lookup_host(const struct sockaddr_in *, int, int, const char *, int);
177struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *, const char *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178struct rpc_clnt * nlm_bind_host(struct nlm_host *);
179void nlm_rebind_host(struct nlm_host *);
180struct nlm_host * nlm_get_host(struct nlm_host *);
181void nlm_release_host(struct nlm_host *);
182void nlm_shutdown_hosts(void);
Olaf Kirch5c8dd292006-10-04 02:15:55 -0700183extern void nlm_host_rebooted(const struct sockaddr_in *, const char *, int, u32);
Olaf Kirch8dead0d2006-10-04 02:15:53 -0700184void nsm_release(struct nsm_handle *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186
187/*
Olaf Kirchf2af7932006-10-04 02:15:59 -0700188 * This is used in garbage collection and resource reclaim
189 * A return value != 0 means destroy the lock/block/share
190 */
191typedef int (*nlm_host_match_fn_t)(struct nlm_host *cur, struct nlm_host *ref);
192
193/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 * Server-side lock handling
195 */
Al Viro52921e02006-10-19 23:28:46 -0700196__be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 struct nlm_lock *, int, struct nlm_cookie *);
Al Viro52921e02006-10-19 23:28:46 -0700198__be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
Marc Eshel85f3f1b32006-11-28 16:27:06 -0500199__be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
200 struct nlm_lock *, struct nlm_lock *, struct nlm_cookie *);
Al Viro52921e02006-10-19 23:28:46 -0700201__be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202unsigned long nlmsvc_retry_blocked(void);
J. Bruce Fieldsf3ee439f2006-03-20 23:24:13 -0500203void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
Olaf Kirchf2af7932006-10-04 02:15:59 -0700204 nlm_host_match_fn_t match);
Al Viroe8c5c042006-12-13 00:35:03 -0800205void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207/*
208 * File handling for the server personality
209 */
Al Viro52921e02006-10-19 23:28:46 -0700210__be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 struct nfs_fh *);
212void nlm_release_file(struct nlm_file *);
213void nlmsvc_mark_resources(void);
214void nlmsvc_free_host_resources(struct nlm_host *);
215void nlmsvc_invalidate_all(void);
216
217static __inline__ struct inode *
218nlmsvc_file_inode(struct nlm_file *file)
219{
Josef Sipek225a7192006-12-08 02:37:18 -0800220 return file->f_file->f_path.dentry->d_inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221}
222
223/*
224 * Compare two host addresses (needs modifying for ipv6)
225 */
226static __inline__ int
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800227nlm_cmp_addr(const struct sockaddr_in *sin1, const struct sockaddr_in *sin2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
229 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
230}
231
232/*
233 * Compare two NLM locks.
234 * When the second lock is of type F_UNLCK, this acts like a wildcard.
235 */
236static __inline__ int
Trond Myklebust5ac5f9d2006-02-14 13:53:04 -0800237nlm_compare_locks(const struct file_lock *fl1, const struct file_lock *fl2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
239 return fl1->fl_pid == fl2->fl_pid
Marc Eshel3134cbe2006-06-09 09:40:20 -0400240 && fl1->fl_owner == fl2->fl_owner
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 && fl1->fl_start == fl2->fl_start
242 && fl1->fl_end == fl2->fl_end
243 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
244}
245
246extern struct lock_manager_operations nlmsvc_lock_operations;
247
248#endif /* __KERNEL__ */
249
250#endif /* LINUX_LOCKD_LOCKD_H */