2 * linux/include/linux/lockd/lockd.h
4 * General-purpose lockd include file.
6 * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
9 #ifndef LINUX_LOCKD_LOCKD_H
10 #define LINUX_LOCKD_LOCKD_H
16 #include <linux/kref.h>
17 #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>
24 #include <linux/lockd/debug.h>
29 #define LOCKD_VERSION "0.5"
32 * Default timeout for RPC calls (seconds)
34 #define LOCKD_DFLT_TIMEO 10
37 * Lockd host handle (used both by the client and server personality).
40 struct hlist_node h_hash; /* doubly linked list */
41 struct sockaddr_storage h_addr; /* peer address */
43 struct sockaddr_in h_saddr; /* our address (optional) */
44 struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */
45 char * h_name; /* remote hostname */
46 u32 h_version; /* interface version */
47 unsigned short h_proto; /* transport proto */
48 unsigned short h_reclaiming : 1,
49 h_server : 1, /* server side, not client side */
51 wait_queue_head_t h_gracewait; /* wait while reclaiming */
52 struct rw_semaphore h_rwsem; /* Reboot recovery lock */
53 u32 h_state; /* pseudo-state counter */
54 u32 h_nsmstate; /* true remote NSM state */
55 u32 h_pidcount; /* Pseudopids */
56 atomic_t h_count; /* reference count */
57 struct mutex h_mutex; /* mutex for pmap binding */
58 unsigned long h_nextrebind; /* next portmap call */
59 unsigned long h_expires; /* eligible for GC */
60 struct list_head h_lockowners; /* Lockowners for the client */
62 struct list_head h_granted; /* Locks in GRANTED state */
63 struct list_head h_reclaim; /* Locks in RECLAIM state */
64 struct nsm_handle * h_nsmhandle; /* NSM status handle */
66 char h_addrbuf[48], /* address eyecatchers */
71 struct list_head sm_link;
74 struct sockaddr_in sm_addr;
75 unsigned int sm_monitored : 1,
76 sm_sticky : 1; /* don't unmonitor */
77 char sm_addrbuf[48]; /* address eyecatcher */
81 * Rigorous type checking on sockaddr type conversions
83 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
85 return (struct sockaddr_in *)&host->h_addr;
88 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
90 return (struct sockaddr *)&host->h_addr;
94 * Map an fl_owner_t into a unique 32-bit "pid"
96 struct nlm_lockowner {
97 struct list_head list;
100 struct nlm_host *host;
108 * Memory chunk for NLM client RPC request.
110 #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
113 unsigned int a_flags; /* initial RPC task flags */
114 struct nlm_host * a_host; /* host handle */
115 struct nlm_args a_args; /* arguments */
116 struct nlm_res a_res; /* result */
117 struct nlm_block * a_block;
118 unsigned int a_retries; /* Retry count */
119 u8 a_owner[NLMCLNT_OHSIZE];
123 * This struct describes a file held open by lockd on behalf of
127 struct hlist_node f_list; /* linked list */
128 struct nfs_fh f_handle; /* NFS file handle */
129 struct file * f_file; /* VFS file pointer */
130 struct nlm_share * f_shares; /* DOS shares */
131 struct list_head f_blocks; /* blocked locks */
132 unsigned int f_locks; /* guesstimate # of locks */
133 unsigned int f_count; /* reference count */
134 struct mutex f_mutex; /* avoid concurrent access */
138 * This is a server block (i.e. a lock requested by some client which
139 * couldn't be granted because of a conflicting lock).
141 #define NLM_NEVER (~(unsigned long) 0)
142 /* timeout on non-blocking call: */
143 #define NLM_TIMEOUT (7 * HZ)
146 struct kref b_count; /* Reference count */
147 struct list_head b_list; /* linked list of all blocks */
148 struct list_head b_flist; /* linked list (per file) */
149 struct nlm_rqst * b_call; /* RPC args & callback info */
150 struct svc_serv * b_daemon; /* NLM service */
151 struct nlm_host * b_host; /* host handle for RPC clnt */
152 unsigned long b_when; /* next re-xmit */
153 unsigned int b_id; /* block id */
154 unsigned char b_granted; /* VFS granted lock */
155 struct nlm_file * b_file; /* file in question */
156 struct cache_req * b_cache_req; /* deferred request handling */
157 struct file_lock * b_fl; /* set for GETLK */
158 struct cache_deferred_req * b_deferred_req;
159 unsigned int b_flags; /* block flags */
160 #define B_QUEUED 1 /* lock queued */
161 #define B_GOT_CALLBACK 2 /* got lock or conflicting lock */
162 #define B_TIMED_OUT 4 /* filesystem too slow to respond */
168 extern struct rpc_program nlm_program;
169 extern struct svc_procedure nlmsvc_procedures[];
170 #ifdef CONFIG_LOCKD_V4
171 extern struct svc_procedure nlmsvc_procedures4[];
173 extern int nlmsvc_grace_period;
174 extern unsigned long nlmsvc_timeout;
175 extern int nsm_use_hostnames;
178 * Lockd client functions
180 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
181 void nlm_release_call(struct nlm_rqst *);
182 int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
183 int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
184 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
185 void nlmclnt_finish_block(struct nlm_wait *block);
186 int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
187 __be32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
188 void nlmclnt_recovery(struct nlm_host *);
189 int nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
190 void nlmclnt_next_cookie(struct nlm_cookie *);
195 struct nlm_host *nlmclnt_lookup_host(const struct sockaddr_in *sin,
196 int proto, u32 version,
197 const char *hostname,
198 unsigned int hostname_len);
199 struct nlm_host *nlmsvc_lookup_host(struct svc_rqst *, const char *,
201 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
202 void nlm_rebind_host(struct nlm_host *);
203 struct nlm_host * nlm_get_host(struct nlm_host *);
204 void nlm_release_host(struct nlm_host *);
205 void nlm_shutdown_hosts(void);
206 extern void nlm_host_rebooted(const struct sockaddr_in *, const char *,
208 void nsm_release(struct nsm_handle *);
212 * This is used in garbage collection and resource reclaim
213 * A return value != 0 means destroy the lock/block/share
215 typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
218 * Server-side lock handling
220 __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
221 struct nlm_host *, struct nlm_lock *, int,
222 struct nlm_cookie *);
223 __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
224 __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
225 struct nlm_host *, struct nlm_lock *,
226 struct nlm_lock *, struct nlm_cookie *);
227 __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
228 unsigned long nlmsvc_retry_blocked(void);
229 void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
230 nlm_host_match_fn_t match);
231 void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
234 * File handling for the server personality
236 __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
238 void nlm_release_file(struct nlm_file *);
239 void nlmsvc_mark_resources(void);
240 void nlmsvc_free_host_resources(struct nlm_host *);
241 void nlmsvc_invalidate_all(void);
244 * Cluster failover support
246 int nlmsvc_unlock_all_by_sb(struct super_block *sb);
247 int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
249 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
251 return file->f_file->f_path.dentry->d_inode;
255 * Compare two host addresses (needs modifying for ipv6)
257 static inline int nlm_cmp_addr(const struct sockaddr_in *sin1,
258 const struct sockaddr_in *sin2)
260 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
264 * Compare two NLM locks.
265 * When the second lock is of type F_UNLCK, this acts like a wildcard.
267 static inline int nlm_compare_locks(const struct file_lock *fl1,
268 const struct file_lock *fl2)
270 return fl1->fl_pid == fl2->fl_pid
271 && fl1->fl_owner == fl2->fl_owner
272 && fl1->fl_start == fl2->fl_start
273 && fl1->fl_end == fl2->fl_end
274 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
277 extern struct lock_manager_operations nlmsvc_lock_operations;
279 #endif /* __KERNEL__ */
281 #endif /* LINUX_LOCKD_LOCKD_H */