lockd: Use sockaddr_storage for h_saddr field
[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/in.h>
15 #include <linux/fs.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>
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  */
39 struct nlm_host {
40         struct hlist_node       h_hash;         /* doubly linked list */
41         struct sockaddr_storage h_addr;         /* peer address */
42         size_t                  h_addrlen;
43         struct sockaddr_storage h_srcaddr;      /* 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 */
50                                 h_inuse      : 1;
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 */
61         spinlock_t              h_lock;
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 */
65
66         char                    h_addrbuf[48],  /* address eyecatchers */
67                                 h_srcaddrbuf[48];
68 };
69
70 struct nsm_handle {
71         struct list_head        sm_link;
72         atomic_t                sm_count;
73         char *                  sm_name;
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 */
78 };
79
80 /*
81  * Rigorous type checking on sockaddr type conversions
82  */
83 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
84 {
85         return (struct sockaddr_in *)&host->h_addr;
86 }
87
88 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
89 {
90         return (struct sockaddr *)&host->h_addr;
91 }
92
93 static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
94 {
95         return (struct sockaddr_in *)&host->h_srcaddr;
96 }
97
98 static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
99 {
100         return (struct sockaddr *)&host->h_srcaddr;
101 }
102
103 /*
104  * Map an fl_owner_t into a unique 32-bit "pid"
105  */
106 struct nlm_lockowner {
107         struct list_head list;
108         atomic_t count;
109
110         struct nlm_host *host;
111         fl_owner_t owner;
112         uint32_t pid;
113 };
114
115 struct nlm_wait;
116
117 /*
118  * Memory chunk for NLM client RPC request.
119  */
120 #define NLMCLNT_OHSIZE          ((__NEW_UTS_LEN) + 10u)
121 struct nlm_rqst {
122         atomic_t                a_count;
123         unsigned int            a_flags;        /* initial RPC task flags */
124         struct nlm_host *       a_host;         /* host handle */
125         struct nlm_args         a_args;         /* arguments */
126         struct nlm_res          a_res;          /* result */
127         struct nlm_block *      a_block;
128         unsigned int            a_retries;      /* Retry count */
129         u8                      a_owner[NLMCLNT_OHSIZE];
130 };
131
132 /*
133  * This struct describes a file held open by lockd on behalf of
134  * an NFS client.
135  */
136 struct nlm_file {
137         struct hlist_node       f_list;         /* linked list */
138         struct nfs_fh           f_handle;       /* NFS file handle */
139         struct file *           f_file;         /* VFS file pointer */
140         struct nlm_share *      f_shares;       /* DOS shares */
141         struct list_head        f_blocks;       /* blocked locks */
142         unsigned int            f_locks;        /* guesstimate # of locks */
143         unsigned int            f_count;        /* reference count */
144         struct mutex            f_mutex;        /* avoid concurrent access */
145 };
146
147 /*
148  * This is a server block (i.e. a lock requested by some client which
149  * couldn't be granted because of a conflicting lock).
150  */
151 #define NLM_NEVER               (~(unsigned long) 0)
152 /* timeout on non-blocking call: */
153 #define NLM_TIMEOUT             (7 * HZ)
154
155 struct nlm_block {
156         struct kref             b_count;        /* Reference count */
157         struct list_head        b_list;         /* linked list of all blocks */
158         struct list_head        b_flist;        /* linked list (per file) */
159         struct nlm_rqst *       b_call;         /* RPC args & callback info */
160         struct svc_serv *       b_daemon;       /* NLM service */
161         struct nlm_host *       b_host;         /* host handle for RPC clnt */
162         unsigned long           b_when;         /* next re-xmit */
163         unsigned int            b_id;           /* block id */
164         unsigned char           b_granted;      /* VFS granted lock */
165         struct nlm_file *       b_file;         /* file in question */
166         struct cache_req *      b_cache_req;    /* deferred request handling */
167         struct file_lock *      b_fl;           /* set for GETLK */
168         struct cache_deferred_req * b_deferred_req;
169         unsigned int            b_flags;        /* block flags */
170 #define B_QUEUED                1       /* lock queued */
171 #define B_GOT_CALLBACK          2       /* got lock or conflicting lock */
172 #define B_TIMED_OUT             4       /* filesystem too slow to respond */
173 };
174
175 /*
176  * Global variables
177  */
178 extern struct rpc_program       nlm_program;
179 extern struct svc_procedure     nlmsvc_procedures[];
180 #ifdef CONFIG_LOCKD_V4
181 extern struct svc_procedure     nlmsvc_procedures4[];
182 #endif
183 extern int                      nlmsvc_grace_period;
184 extern unsigned long            nlmsvc_timeout;
185 extern int                      nsm_use_hostnames;
186
187 /*
188  * Lockd client functions
189  */
190 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
191 void              nlm_release_call(struct nlm_rqst *);
192 int               nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
193 int               nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
194 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
195 void              nlmclnt_finish_block(struct nlm_wait *block);
196 int               nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
197 __be32            nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
198 void              nlmclnt_recovery(struct nlm_host *);
199 int               nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
200 void              nlmclnt_next_cookie(struct nlm_cookie *);
201
202 /*
203  * Host cache
204  */
205 struct nlm_host  *nlmclnt_lookup_host(const struct sockaddr_in *sin,
206                                         int proto, u32 version,
207                                         const char *hostname,
208                                         unsigned int hostname_len);
209 struct nlm_host  *nlmsvc_lookup_host(struct svc_rqst *, const char *,
210                                         unsigned int);
211 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
212 void              nlm_rebind_host(struct nlm_host *);
213 struct nlm_host * nlm_get_host(struct nlm_host *);
214 void              nlm_release_host(struct nlm_host *);
215 void              nlm_shutdown_hosts(void);
216 extern void       nlm_host_rebooted(const struct sockaddr_in *, const char *,
217                                         unsigned int, u32);
218 void              nsm_release(struct nsm_handle *);
219
220
221 /*
222  * This is used in garbage collection and resource reclaim
223  * A return value != 0 means destroy the lock/block/share
224  */
225 typedef int       (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
226
227 /*
228  * Server-side lock handling
229  */
230 __be32            nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
231                               struct nlm_host *, struct nlm_lock *, int,
232                               struct nlm_cookie *);
233 __be32            nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
234 __be32            nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
235                         struct nlm_host *, struct nlm_lock *,
236                         struct nlm_lock *, struct nlm_cookie *);
237 __be32            nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
238 unsigned long     nlmsvc_retry_blocked(void);
239 void              nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
240                                         nlm_host_match_fn_t match);
241 void              nlmsvc_grant_reply(struct nlm_cookie *, __be32);
242
243 /*
244  * File handling for the server personality
245  */
246 __be32            nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
247                                         struct nfs_fh *);
248 void              nlm_release_file(struct nlm_file *);
249 void              nlmsvc_mark_resources(void);
250 void              nlmsvc_free_host_resources(struct nlm_host *);
251 void              nlmsvc_invalidate_all(void);
252
253 /*
254  * Cluster failover support
255  */
256 int           nlmsvc_unlock_all_by_sb(struct super_block *sb);
257 int           nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
258
259 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
260 {
261         return file->f_file->f_path.dentry->d_inode;
262 }
263
264 /*
265  * Compare two host addresses (needs modifying for ipv6)
266  */
267 static inline int nlm_cmp_addr(const struct sockaddr_in *sin1,
268                                const struct sockaddr_in *sin2)
269 {
270         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
271 }
272
273 /*
274  * Compare two NLM locks.
275  * When the second lock is of type F_UNLCK, this acts like a wildcard.
276  */
277 static inline int nlm_compare_locks(const struct file_lock *fl1,
278                                     const struct file_lock *fl2)
279 {
280         return  fl1->fl_pid   == fl2->fl_pid
281              && fl1->fl_owner == fl2->fl_owner
282              && fl1->fl_start == fl2->fl_start
283              && fl1->fl_end   == fl2->fl_end
284              &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
285 }
286
287 extern struct lock_manager_operations nlmsvc_lock_operations;
288
289 #endif /* __KERNEL__ */
290
291 #endif /* LINUX_LOCKD_LOCKD_H */