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 nlm_host * h_next; /* linked list (hash table) */
41 struct sockaddr_in h_addr; /* peer address */
42 struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */
43 char * h_name; /* remote hostname */
44 u32 h_version; /* interface version */
45 unsigned short h_proto; /* transport proto */
46 unsigned short h_reclaiming : 1,
47 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 */
67 struct list_head sm_link;
70 struct sockaddr_in sm_addr;
71 unsigned int sm_monitored : 1,
72 sm_sticky : 1; /* don't unmonitor */
76 * Map an fl_owner_t into a unique 32-bit "pid"
78 struct nlm_lockowner {
79 struct list_head list;
82 struct nlm_host *host;
90 * Memory chunk for NLM client RPC request.
92 #define NLMCLNT_OHSIZE (sizeof(utsname()->nodename)+10)
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 */
98 struct nlm_block * a_block;
99 unsigned int a_retries; /* Retry count */
100 u8 a_owner[NLMCLNT_OHSIZE];
104 * This struct describes a file held open by lockd on behalf of
108 struct nlm_file * f_next; /* linked list */
109 struct nfs_fh f_handle; /* NFS file handle */
110 struct file * f_file; /* VFS file pointer */
111 struct nlm_share * f_shares; /* DOS shares */
112 struct nlm_block * f_blocks; /* blocked locks */
113 unsigned int f_locks; /* guesstimate # of locks */
114 unsigned int f_count; /* reference count */
115 struct semaphore f_sema; /* avoid concurrent access */
116 int f_hash; /* hash of f_handle */
120 * This is a server block (i.e. a lock requested by some client which
121 * couldn't be granted because of a conflicting lock).
123 #define NLM_NEVER (~(unsigned long) 0)
125 struct kref b_count; /* Reference count */
126 struct nlm_block * b_next; /* linked list (all blocks) */
127 struct nlm_block * b_fnext; /* linked list (per file) */
128 struct nlm_rqst * b_call; /* RPC args & callback info */
129 struct svc_serv * b_daemon; /* NLM service */
130 struct nlm_host * b_host; /* host handle for RPC clnt */
131 unsigned long b_when; /* next re-xmit */
132 unsigned int b_id; /* block id */
133 unsigned char b_queued; /* re-queued */
134 unsigned char b_granted; /* VFS granted lock */
135 struct nlm_file * b_file; /* file in question */
139 * Valid actions for nlmsvc_traverse_files
141 #define NLM_ACT_CHECK 0 /* check for locks */
142 #define NLM_ACT_MARK 1 /* mark & sweep */
143 #define NLM_ACT_UNLOCK 2 /* release all locks */
148 extern struct rpc_program nlm_program;
149 extern struct svc_procedure nlmsvc_procedures[];
150 #ifdef CONFIG_LOCKD_V4
151 extern struct svc_procedure nlmsvc_procedures4[];
153 extern int nlmsvc_grace_period;
154 extern unsigned long nlmsvc_timeout;
157 * Lockd client functions
159 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
160 void nlm_release_call(struct nlm_rqst *);
161 int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
162 int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
163 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
164 void nlmclnt_finish_block(struct nlm_wait *block);
165 int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
166 u32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
167 void nlmclnt_recovery(struct nlm_host *, u32);
168 int nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
173 struct nlm_host * nlmclnt_lookup_host(const struct sockaddr_in *, int, int, const char *, int);
174 struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *, const char *, int);
175 struct nlm_host * nlm_lookup_host(int server, const struct sockaddr_in *, int, int, const char *, int);
176 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
177 void nlm_rebind_host(struct nlm_host *);
178 struct nlm_host * nlm_get_host(struct nlm_host *);
179 void nlm_release_host(struct nlm_host *);
180 void nlm_shutdown_hosts(void);
181 extern struct nlm_host *nlm_find_client(void);
182 extern void nlm_host_rebooted(const struct sockaddr_in *, const struct nlm_reboot *);
183 struct nsm_handle *nsm_find(const struct sockaddr_in *, const char *, int);
184 void nsm_release(struct nsm_handle *);
188 * Server-side lock handling
190 u32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
191 struct nlm_lock *, int, struct nlm_cookie *);
192 u32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
193 u32 nlmsvc_testlock(struct nlm_file *, struct nlm_lock *,
195 u32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
196 unsigned long nlmsvc_retry_blocked(void);
197 void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
199 void nlmsvc_grant_reply(struct svc_rqst *, struct nlm_cookie *, u32);
202 * File handling for the server personality
204 u32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
206 void nlm_release_file(struct nlm_file *);
207 void nlmsvc_mark_resources(void);
208 void nlmsvc_free_host_resources(struct nlm_host *);
209 void nlmsvc_invalidate_all(void);
211 static __inline__ struct inode *
212 nlmsvc_file_inode(struct nlm_file *file)
214 return file->f_file->f_dentry->d_inode;
218 * Compare two host addresses (needs modifying for ipv6)
220 static __inline__ int
221 nlm_cmp_addr(const struct sockaddr_in *sin1, const struct sockaddr_in *sin2)
223 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
227 * Compare two NLM locks.
228 * When the second lock is of type F_UNLCK, this acts like a wildcard.
230 static __inline__ int
231 nlm_compare_locks(const struct file_lock *fl1, const struct file_lock *fl2)
233 return fl1->fl_pid == fl2->fl_pid
234 && fl1->fl_owner == fl2->fl_owner
235 && fl1->fl_start == fl2->fl_start
236 && fl1->fl_end == fl2->fl_end
237 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
240 extern struct lock_manager_operations nlmsvc_lock_operations;
242 #endif /* __KERNEL__ */
244 #endif /* LINUX_LOCKD_LOCKD_H */