lockd: Add refcounting to struct nlm_block
[linux-2.6.git] / include / linux / lockd / lockd.h
1 /*
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
14 #include <linux/config.h>
15 #include <linux/in.h>
16 #include <linux/fs.h>
17 #include <linux/kref.h>
18 #include <linux/utsname.h>
19 #include <linux/nfsd/nfsfh.h>
20 #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>
26
27 /*
28  * Version string
29  */
30 #define LOCKD_VERSION           "0.5"
31
32 /*
33  * Default timeout for RPC calls (seconds)
34  */
35 #define LOCKD_DFLT_TIMEO        10
36
37 /*
38  * Lockd host handle (used both by the client and server personality).
39  */
40 struct nlm_host {
41         struct nlm_host *       h_next;         /* linked list (hash table) */
42         struct sockaddr_in      h_addr;         /* peer address */
43         struct rpc_clnt *       h_rpcclnt;      /* RPC client to talk to peer */
44         char                    h_name[20];     /* 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 */
49                                 h_inuse      : 1,
50                                 h_killed     : 1,
51                                 h_monitored  : 1;
52         wait_queue_head_t       h_gracewait;    /* wait while reclaiming */
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 semaphore        h_sema;         /* 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 */
61         spinlock_t              h_lock;
62 };
63
64 /*
65  * Map an fl_owner_t into a unique 32-bit "pid"
66  */
67 struct nlm_lockowner {
68         struct list_head list;
69         atomic_t count;
70
71         struct nlm_host *host;
72         fl_owner_t owner;
73         uint32_t pid;
74 };
75
76 struct nlm_wait;
77
78 /*
79  * Memory chunk for NLM client RPC request.
80  */
81 #define NLMCLNT_OHSIZE          (sizeof(system_utsname.nodename)+10)
82 struct nlm_rqst {
83         unsigned int            a_flags;        /* initial RPC task flags */
84         struct nlm_host *       a_host;         /* host handle */
85         struct nlm_args         a_args;         /* arguments */
86         struct nlm_res          a_res;          /* result */
87         struct nlm_wait *       a_block;
88         unsigned int            a_retries;      /* Retry count */
89         char                    a_owner[NLMCLNT_OHSIZE];
90 };
91
92 /*
93  * This struct describes a file held open by lockd on behalf of
94  * an NFS client.
95  */
96 struct nlm_file {
97         struct nlm_file *       f_next;         /* linked list */
98         struct nfs_fh           f_handle;       /* NFS file handle */
99         struct file *           f_file;         /* VFS file pointer */
100         struct nlm_share *      f_shares;       /* DOS shares */
101         struct nlm_block *      f_blocks;       /* blocked locks */
102         unsigned int            f_locks;        /* guesstimate # of locks */
103         unsigned int            f_count;        /* reference count */
104         struct semaphore        f_sema;         /* avoid concurrent access */
105         int                     f_hash;         /* hash of f_handle */
106 };
107
108 /*
109  * This is a server block (i.e. a lock requested by some client which
110  * couldn't be granted because of a conflicting lock).
111  */
112 #define NLM_NEVER               (~(unsigned long) 0)
113 struct nlm_block {
114         struct kref             b_count;        /* Reference count */
115         struct nlm_block *      b_next;         /* linked list (all blocks) */
116         struct nlm_block *      b_fnext;        /* linked list (per file) */
117         struct nlm_rqst         b_call;         /* RPC args & callback info */
118         struct svc_serv *       b_daemon;       /* NLM service */
119         struct nlm_host *       b_host;         /* host handle for RPC clnt */
120         unsigned long           b_when;         /* next re-xmit */
121         unsigned int            b_id;           /* block id */
122         unsigned char           b_queued;       /* re-queued */
123         unsigned char           b_granted;      /* VFS granted lock */
124         unsigned char           b_done;         /* callback complete */
125         struct nlm_file *       b_file;         /* file in question */
126 };
127
128 /*
129  * Valid actions for nlmsvc_traverse_files
130  */
131 #define NLM_ACT_CHECK           0               /* check for locks */
132 #define NLM_ACT_MARK            1               /* mark & sweep */
133 #define NLM_ACT_UNLOCK          2               /* release all locks */
134
135 /*
136  * Global variables
137  */
138 extern struct rpc_program       nlm_program;
139 extern struct svc_procedure     nlmsvc_procedures[];
140 #ifdef CONFIG_LOCKD_V4
141 extern struct svc_procedure     nlmsvc_procedures4[];
142 #endif
143 extern int                      nlmsvc_grace_period;
144 extern unsigned long            nlmsvc_timeout;
145
146 /*
147  * Lockd client functions
148  */
149 struct nlm_rqst * nlmclnt_alloc_call(void);
150 int               nlmclnt_prepare_block(struct nlm_rqst *req, struct nlm_host *host, struct file_lock *fl);
151 void              nlmclnt_finish_block(struct nlm_rqst *req);
152 long              nlmclnt_block(struct nlm_rqst *req, long timeout);
153 u32               nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
154 void              nlmclnt_recovery(struct nlm_host *, u32);
155 int               nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
156 int               nlmclnt_setgrantargs(struct nlm_rqst *, struct nlm_lock *);
157 void              nlmclnt_freegrantargs(struct nlm_rqst *);
158
159 /*
160  * Host cache
161  */
162 struct nlm_host * nlmclnt_lookup_host(struct sockaddr_in *, int, int);
163 struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *);
164 struct nlm_host * nlm_lookup_host(int server, struct sockaddr_in *, int, int);
165 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
166 void              nlm_rebind_host(struct nlm_host *);
167 struct nlm_host * nlm_get_host(struct nlm_host *);
168 void              nlm_release_host(struct nlm_host *);
169 void              nlm_shutdown_hosts(void);
170 extern struct nlm_host *nlm_find_client(void);
171
172
173 /*
174  * Server-side lock handling
175  */
176 int               nlmsvc_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
177 u32               nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
178                                         struct nlm_lock *, int, struct nlm_cookie *);
179 u32               nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
180 u32               nlmsvc_testlock(struct nlm_file *, struct nlm_lock *,
181                                         struct nlm_lock *);
182 u32               nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
183 unsigned long     nlmsvc_retry_blocked(void);
184 int               nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
185                                         int action);
186 void      nlmsvc_grant_reply(struct svc_rqst *, struct nlm_cookie *, u32);
187
188 /*
189  * File handling for the server personality
190  */
191 u32               nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
192                                         struct nfs_fh *);
193 void              nlm_release_file(struct nlm_file *);
194 void              nlmsvc_mark_resources(void);
195 void              nlmsvc_free_host_resources(struct nlm_host *);
196 void              nlmsvc_invalidate_all(void);
197
198 static __inline__ struct inode *
199 nlmsvc_file_inode(struct nlm_file *file)
200 {
201         return file->f_file->f_dentry->d_inode;
202 }
203
204 /*
205  * Compare two host addresses (needs modifying for ipv6)
206  */
207 static __inline__ int
208 nlm_cmp_addr(const struct sockaddr_in *sin1, const struct sockaddr_in *sin2)
209 {
210         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
211 }
212
213 /*
214  * Compare two NLM locks.
215  * When the second lock is of type F_UNLCK, this acts like a wildcard.
216  */
217 static __inline__ int
218 nlm_compare_locks(const struct file_lock *fl1, const struct file_lock *fl2)
219 {
220         return  fl1->fl_pid   == fl2->fl_pid
221              && fl1->fl_start == fl2->fl_start
222              && fl1->fl_end   == fl2->fl_end
223              &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
224 }
225
226 extern struct lock_manager_operations nlmsvc_lock_operations;
227
228 #endif /* __KERNEL__ */
229
230 #endif /* LINUX_LOCKD_LOCKD_H */