]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
1da177e4 LT |
14 | #include <linux/in.h> |
15 | #include <linux/fs.h> | |
6849c0ca | 16 | #include <linux/kref.h> |
1da177e4 LT |
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 { | |
0cea3276 | 40 | struct hlist_node h_hash; /* doubly linked list */ |
1da177e4 LT |
41 | struct sockaddr_in h_addr; /* peer address */ |
42 | struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */ | |
8dead0db | 43 | char * h_name; /* remote hostname */ |
1da177e4 LT |
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 */ | |
48 | h_inuse : 1, | |
8dead0db | 49 | h_killed : 1; |
1da177e4 | 50 | wait_queue_head_t h_gracewait; /* wait while reclaiming */ |
28df955a | 51 | struct rw_semaphore h_rwsem; /* Reboot recovery lock */ |
1da177e4 LT |
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 */ | |
50467914 | 56 | struct mutex h_mutex; /* mutex for pmap binding */ |
1da177e4 LT |
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 */ | |
60 | spinlock_t h_lock; | |
26bcbf96 CH |
61 | struct list_head h_granted; /* Locks in GRANTED state */ |
62 | struct list_head h_reclaim; /* Locks in RECLAIM state */ | |
8dead0db OK |
63 | struct nsm_handle * h_nsmhandle; /* NSM status handle */ |
64 | }; | |
65 | ||
66 | struct nsm_handle { | |
67 | struct list_head sm_link; | |
68 | atomic_t sm_count; | |
69 | char * sm_name; | |
70 | struct sockaddr_in sm_addr; | |
71 | unsigned int sm_monitored : 1, | |
72 | sm_sticky : 1; /* don't unmonitor */ | |
1da177e4 LT |
73 | }; |
74 | ||
75 | /* | |
76 | * Map an fl_owner_t into a unique 32-bit "pid" | |
77 | */ | |
78 | struct nlm_lockowner { | |
79 | struct list_head list; | |
80 | atomic_t count; | |
81 | ||
82 | struct nlm_host *host; | |
83 | fl_owner_t owner; | |
84 | uint32_t pid; | |
85 | }; | |
86 | ||
ecdbf769 TM |
87 | struct nlm_wait; |
88 | ||
1da177e4 LT |
89 | /* |
90 | * Memory chunk for NLM client RPC request. | |
91 | */ | |
e9ff3990 | 92 | #define NLMCLNT_OHSIZE (sizeof(utsname()->nodename)+10) |
1da177e4 LT |
93 | struct nlm_rqst { |
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 */ | |
92737230 | 98 | struct nlm_block * a_block; |
aaaa9942 | 99 | unsigned int a_retries; /* Retry count */ |
92737230 | 100 | u8 a_owner[NLMCLNT_OHSIZE]; |
1da177e4 LT |
101 | }; |
102 | ||
103 | /* | |
104 | * This struct describes a file held open by lockd on behalf of | |
105 | * an NFS client. | |
106 | */ | |
107 | struct nlm_file { | |
07ba8063 | 108 | struct hlist_node f_list; /* linked list */ |
1da177e4 LT |
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 */ | |
68a2d76c | 112 | struct list_head f_blocks; /* blocked locks */ |
1da177e4 LT |
113 | unsigned int f_locks; /* guesstimate # of locks */ |
114 | unsigned int f_count; /* reference count */ | |
115 | struct semaphore f_sema; /* avoid concurrent access */ | |
1da177e4 LT |
116 | }; |
117 | ||
118 | /* | |
119 | * This is a server block (i.e. a lock requested by some client which | |
120 | * couldn't be granted because of a conflicting lock). | |
121 | */ | |
122 | #define NLM_NEVER (~(unsigned long) 0) | |
123 | struct nlm_block { | |
6849c0ca | 124 | struct kref b_count; /* Reference count */ |
68a2d76c OK |
125 | struct list_head b_list; /* linked list of all blocks */ |
126 | struct list_head b_flist; /* linked list (per file) */ | |
92737230 | 127 | struct nlm_rqst * b_call; /* RPC args & callback info */ |
1da177e4 LT |
128 | struct svc_serv * b_daemon; /* NLM service */ |
129 | struct nlm_host * b_host; /* host handle for RPC clnt */ | |
130 | unsigned long b_when; /* next re-xmit */ | |
131 | unsigned int b_id; /* block id */ | |
1da177e4 | 132 | unsigned char b_granted; /* VFS granted lock */ |
1da177e4 LT |
133 | struct nlm_file * b_file; /* file in question */ |
134 | }; | |
135 | ||
136 | /* | |
137 | * Valid actions for nlmsvc_traverse_files | |
138 | */ | |
139 | #define NLM_ACT_CHECK 0 /* check for locks */ | |
140 | #define NLM_ACT_MARK 1 /* mark & sweep */ | |
141 | #define NLM_ACT_UNLOCK 2 /* release all locks */ | |
142 | ||
143 | /* | |
144 | * Global variables | |
145 | */ | |
146 | extern struct rpc_program nlm_program; | |
147 | extern struct svc_procedure nlmsvc_procedures[]; | |
148 | #ifdef CONFIG_LOCKD_V4 | |
149 | extern struct svc_procedure nlmsvc_procedures4[]; | |
150 | #endif | |
151 | extern int nlmsvc_grace_period; | |
152 | extern unsigned long nlmsvc_timeout; | |
153 | ||
154 | /* | |
155 | * Lockd client functions | |
156 | */ | |
92737230 TM |
157 | struct nlm_rqst * nlm_alloc_call(struct nlm_host *host); |
158 | void nlm_release_call(struct nlm_rqst *); | |
159 | int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *); | |
d4716624 | 160 | int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
3a649b88 TM |
161 | struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl); |
162 | void nlmclnt_finish_block(struct nlm_wait *block); | |
163 | int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout); | |
5ac5f9d1 | 164 | u32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *); |
5c8dd29c | 165 | void nlmclnt_recovery(struct nlm_host *); |
1da177e4 | 166 | int nlmclnt_reclaim(struct nlm_host *, struct file_lock *); |
1da177e4 LT |
167 | |
168 | /* | |
169 | * Host cache | |
170 | */ | |
db4e4c9a OK |
171 | struct nlm_host * nlmclnt_lookup_host(const struct sockaddr_in *, int, int, const char *, int); |
172 | struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *, const char *, int); | |
173 | struct nlm_host * nlm_lookup_host(int server, const struct sockaddr_in *, int, int, const char *, int); | |
1da177e4 LT |
174 | struct rpc_clnt * nlm_bind_host(struct nlm_host *); |
175 | void nlm_rebind_host(struct nlm_host *); | |
176 | struct nlm_host * nlm_get_host(struct nlm_host *); | |
177 | void nlm_release_host(struct nlm_host *); | |
178 | void nlm_shutdown_hosts(void); | |
179 | extern struct nlm_host *nlm_find_client(void); | |
5c8dd29c | 180 | extern void nlm_host_rebooted(const struct sockaddr_in *, const char *, int, u32); |
8dead0db OK |
181 | struct nsm_handle *nsm_find(const struct sockaddr_in *, const char *, int); |
182 | void nsm_release(struct nsm_handle *); | |
1da177e4 LT |
183 | |
184 | ||
185 | /* | |
186 | * Server-side lock handling | |
187 | */ | |
1da177e4 LT |
188 | u32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *, |
189 | struct nlm_lock *, int, struct nlm_cookie *); | |
190 | u32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *); | |
191 | u32 nlmsvc_testlock(struct nlm_file *, struct nlm_lock *, | |
192 | struct nlm_lock *); | |
193 | u32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *); | |
194 | unsigned long nlmsvc_retry_blocked(void); | |
f3ee439f | 195 | void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *, |
1da177e4 LT |
196 | int action); |
197 | void nlmsvc_grant_reply(struct svc_rqst *, struct nlm_cookie *, u32); | |
198 | ||
199 | /* | |
200 | * File handling for the server personality | |
201 | */ | |
202 | u32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **, | |
203 | struct nfs_fh *); | |
204 | void nlm_release_file(struct nlm_file *); | |
205 | void nlmsvc_mark_resources(void); | |
206 | void nlmsvc_free_host_resources(struct nlm_host *); | |
207 | void nlmsvc_invalidate_all(void); | |
208 | ||
209 | static __inline__ struct inode * | |
210 | nlmsvc_file_inode(struct nlm_file *file) | |
211 | { | |
212 | return file->f_file->f_dentry->d_inode; | |
213 | } | |
214 | ||
215 | /* | |
216 | * Compare two host addresses (needs modifying for ipv6) | |
217 | */ | |
218 | static __inline__ int | |
5ac5f9d1 | 219 | nlm_cmp_addr(const struct sockaddr_in *sin1, const struct sockaddr_in *sin2) |
1da177e4 LT |
220 | { |
221 | return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr; | |
222 | } | |
223 | ||
224 | /* | |
225 | * Compare two NLM locks. | |
226 | * When the second lock is of type F_UNLCK, this acts like a wildcard. | |
227 | */ | |
228 | static __inline__ int | |
5ac5f9d1 | 229 | nlm_compare_locks(const struct file_lock *fl1, const struct file_lock *fl2) |
1da177e4 LT |
230 | { |
231 | return fl1->fl_pid == fl2->fl_pid | |
3134cbec | 232 | && fl1->fl_owner == fl2->fl_owner |
1da177e4 LT |
233 | && fl1->fl_start == fl2->fl_start |
234 | && fl1->fl_end == fl2->fl_end | |
235 | &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK); | |
236 | } | |
237 | ||
238 | extern struct lock_manager_operations nlmsvc_lock_operations; | |
239 | ||
240 | #endif /* __KERNEL__ */ | |
241 | ||
242 | #endif /* LINUX_LOCKD_LOCKD_H */ |