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_in h_addr; /* peer address */
42 struct sockaddr_in h_saddr; /* our address (optional) */
43 struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */
44 char * h_name; /* remote hostname */
45 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 */
50 wait_queue_head_t h_gracewait; /* wait while reclaiming */
51 struct rw_semaphore h_rwsem; /* Reboot recovery lock */
52 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 */
56 struct mutex h_mutex; /* mutex for pmap binding */
57 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 */
61 struct list_head h_granted; /* Locks in GRANTED state */
62 struct list_head h_reclaim; /* Locks in RECLAIM state */
63 struct nsm_handle * h_nsmhandle; /* NSM status handle */
65 char h_addrbuf[48], /* address eyecatchers */
70 struct list_head sm_link;
73 struct sockaddr_in sm_addr;
74 unsigned int sm_monitored : 1,
75 sm_sticky : 1; /* don't unmonitor */
76 char sm_addrbuf[48]; /* address eyecatcher */
80 * Map an fl_owner_t into a unique 32-bit "pid"
82 struct nlm_lockowner {
83 struct list_head list;
86 struct nlm_host *host;
94 * Memory chunk for NLM client RPC request.
96 #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
99 unsigned int a_flags; /* initial RPC task flags */
100 struct nlm_host * a_host; /* host handle */
101 struct nlm_args a_args; /* arguments */
102 struct nlm_res a_res; /* result */
103 struct nlm_block * a_block;
104 unsigned int a_retries; /* Retry count */
105 u8 a_owner[NLMCLNT_OHSIZE];
109 * This struct describes a file held open by lockd on behalf of
113 struct hlist_node f_list; /* linked list */
114 struct nfs_fh f_handle; /* NFS file handle */
115 struct file * f_file; /* VFS file pointer */
116 struct nlm_share * f_shares; /* DOS shares */
117 struct list_head f_blocks; /* blocked locks */
118 unsigned int f_locks; /* guesstimate # of locks */
119 unsigned int f_count; /* reference count */
120 struct mutex f_mutex; /* avoid concurrent access */
124 * This is a server block (i.e. a lock requested by some client which
125 * couldn't be granted because of a conflicting lock).
127 #define NLM_NEVER (~(unsigned long) 0)
128 /* timeout on non-blocking call: */
129 #define NLM_TIMEOUT (7 * HZ)
132 struct kref b_count; /* Reference count */
133 struct list_head b_list; /* linked list of all blocks */
134 struct list_head b_flist; /* linked list (per file) */
135 struct nlm_rqst * b_call; /* RPC args & callback info */
136 struct svc_serv * b_daemon; /* NLM service */
137 struct nlm_host * b_host; /* host handle for RPC clnt */
138 unsigned long b_when; /* next re-xmit */
139 unsigned int b_id; /* block id */
140 unsigned char b_granted; /* VFS granted lock */
141 struct nlm_file * b_file; /* file in question */
142 struct cache_req * b_cache_req; /* deferred request handling */
143 struct file_lock * b_fl; /* set for GETLK */
144 struct cache_deferred_req * b_deferred_req;
145 unsigned int b_flags; /* block flags */
146 #define B_QUEUED 1 /* lock queued */
147 #define B_GOT_CALLBACK 2 /* got lock or conflicting lock */
148 #define B_TIMED_OUT 4 /* filesystem too slow to respond */
154 extern struct rpc_program nlm_program;
155 extern struct svc_procedure nlmsvc_procedures[];
156 #ifdef CONFIG_LOCKD_V4
157 extern struct svc_procedure nlmsvc_procedures4[];
159 extern int nlmsvc_grace_period;
160 extern unsigned long nlmsvc_timeout;
161 extern int nsm_use_hostnames;
164 * Lockd client functions
166 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
167 void nlm_release_call(struct nlm_rqst *);
168 int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
169 int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
170 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
171 void nlmclnt_finish_block(struct nlm_wait *block);
172 int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
173 __be32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
174 void nlmclnt_recovery(struct nlm_host *);
175 int nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
176 void nlmclnt_next_cookie(struct nlm_cookie *);
181 struct nlm_host *nlmclnt_lookup_host(const struct sockaddr_in *sin,
182 int proto, u32 version,
183 const char *hostname,
184 unsigned int hostname_len);
185 struct nlm_host *nlmsvc_lookup_host(struct svc_rqst *, const char *,
187 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
188 void nlm_rebind_host(struct nlm_host *);
189 struct nlm_host * nlm_get_host(struct nlm_host *);
190 void nlm_release_host(struct nlm_host *);
191 void nlm_shutdown_hosts(void);
192 extern void nlm_host_rebooted(const struct sockaddr_in *, const char *,
194 void nsm_release(struct nsm_handle *);
198 * This is used in garbage collection and resource reclaim
199 * A return value != 0 means destroy the lock/block/share
201 typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
204 * Server-side lock handling
206 __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
207 struct nlm_host *, struct nlm_lock *, int,
208 struct nlm_cookie *);
209 __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
210 __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
211 struct nlm_host *, struct nlm_lock *,
212 struct nlm_lock *, struct nlm_cookie *);
213 __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
214 unsigned long nlmsvc_retry_blocked(void);
215 void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
216 nlm_host_match_fn_t match);
217 void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
220 * File handling for the server personality
222 __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
224 void nlm_release_file(struct nlm_file *);
225 void nlmsvc_mark_resources(void);
226 void nlmsvc_free_host_resources(struct nlm_host *);
227 void nlmsvc_invalidate_all(void);
230 * Cluster failover support
232 int nlmsvc_unlock_all_by_sb(struct super_block *sb);
233 int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
235 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
237 return file->f_file->f_path.dentry->d_inode;
241 * Compare two host addresses (needs modifying for ipv6)
243 static inline int nlm_cmp_addr(const struct sockaddr_in *sin1,
244 const struct sockaddr_in *sin2)
246 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
250 * Compare two NLM locks.
251 * When the second lock is of type F_UNLCK, this acts like a wildcard.
253 static inline int nlm_compare_locks(const struct file_lock *fl1,
254 const struct file_lock *fl2)
256 return fl1->fl_pid == fl2->fl_pid
257 && fl1->fl_owner == fl2->fl_owner
258 && fl1->fl_start == fl2->fl_start
259 && fl1->fl_end == fl2->fl_end
260 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
263 extern struct lock_manager_operations nlmsvc_lock_operations;
265 #endif /* __KERNEL__ */
267 #endif /* LINUX_LOCKD_LOCKD_H */