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 */ | |
350fce8d | 48 | h_inuse : 1; |
1da177e4 | 49 | wait_queue_head_t h_gracewait; /* wait while reclaiming */ |
28df955a | 50 | struct rw_semaphore h_rwsem; /* Reboot recovery lock */ |
1da177e4 LT |
51 | u32 h_state; /* pseudo-state counter */ |
52 | u32 h_nsmstate; /* true remote NSM state */ | |
53 | u32 h_pidcount; /* Pseudopids */ | |
54 | atomic_t h_count; /* reference count */ | |
50467914 | 55 | struct mutex h_mutex; /* mutex for pmap binding */ |
1da177e4 LT |
56 | unsigned long h_nextrebind; /* next portmap call */ |
57 | unsigned long h_expires; /* eligible for GC */ | |
58 | struct list_head h_lockowners; /* Lockowners for the client */ | |
59 | spinlock_t h_lock; | |
26bcbf96 CH |
60 | struct list_head h_granted; /* Locks in GRANTED state */ |
61 | struct list_head h_reclaim; /* Locks in RECLAIM state */ | |
8dead0db OK |
62 | struct nsm_handle * h_nsmhandle; /* NSM status handle */ |
63 | }; | |
64 | ||
65 | struct nsm_handle { | |
66 | struct list_head sm_link; | |
67 | atomic_t sm_count; | |
68 | char * sm_name; | |
69 | struct sockaddr_in sm_addr; | |
70 | unsigned int sm_monitored : 1, | |
71 | sm_sticky : 1; /* don't unmonitor */ | |
1da177e4 LT |
72 | }; |
73 | ||
74 | /* | |
75 | * Map an fl_owner_t into a unique 32-bit "pid" | |
76 | */ | |
77 | struct nlm_lockowner { | |
78 | struct list_head list; | |
79 | atomic_t count; | |
80 | ||
81 | struct nlm_host *host; | |
82 | fl_owner_t owner; | |
83 | uint32_t pid; | |
84 | }; | |
85 | ||
ecdbf769 TM |
86 | struct nlm_wait; |
87 | ||
1da177e4 LT |
88 | /* |
89 | * Memory chunk for NLM client RPC request. | |
90 | */ | |
e9ff3990 | 91 | #define NLMCLNT_OHSIZE (sizeof(utsname()->nodename)+10) |
1da177e4 LT |
92 | struct nlm_rqst { |
93 | unsigned int a_flags; /* initial RPC task flags */ | |
94 | struct nlm_host * a_host; /* host handle */ | |
95 | struct nlm_args a_args; /* arguments */ | |
96 | struct nlm_res a_res; /* result */ | |
92737230 | 97 | struct nlm_block * a_block; |
aaaa9942 | 98 | unsigned int a_retries; /* Retry count */ |
92737230 | 99 | u8 a_owner[NLMCLNT_OHSIZE]; |
1da177e4 LT |
100 | }; |
101 | ||
102 | /* | |
103 | * This struct describes a file held open by lockd on behalf of | |
104 | * an NFS client. | |
105 | */ | |
106 | struct nlm_file { | |
07ba8063 | 107 | struct hlist_node f_list; /* linked list */ |
1da177e4 LT |
108 | struct nfs_fh f_handle; /* NFS file handle */ |
109 | struct file * f_file; /* VFS file pointer */ | |
110 | struct nlm_share * f_shares; /* DOS shares */ | |
68a2d76c | 111 | struct list_head f_blocks; /* blocked locks */ |
1da177e4 LT |
112 | unsigned int f_locks; /* guesstimate # of locks */ |
113 | unsigned int f_count; /* reference count */ | |
89e63ef6 | 114 | struct mutex f_mutex; /* avoid concurrent access */ |
1da177e4 LT |
115 | }; |
116 | ||
117 | /* | |
118 | * This is a server block (i.e. a lock requested by some client which | |
119 | * couldn't be granted because of a conflicting lock). | |
120 | */ | |
121 | #define NLM_NEVER (~(unsigned long) 0) | |
122 | struct nlm_block { | |
6849c0ca | 123 | struct kref b_count; /* Reference count */ |
68a2d76c OK |
124 | struct list_head b_list; /* linked list of all blocks */ |
125 | struct list_head b_flist; /* linked list (per file) */ | |
92737230 | 126 | struct nlm_rqst * b_call; /* RPC args & callback info */ |
1da177e4 LT |
127 | struct svc_serv * b_daemon; /* NLM service */ |
128 | struct nlm_host * b_host; /* host handle for RPC clnt */ | |
129 | unsigned long b_when; /* next re-xmit */ | |
130 | unsigned int b_id; /* block id */ | |
1da177e4 | 131 | unsigned char b_granted; /* VFS granted lock */ |
1da177e4 LT |
132 | struct nlm_file * b_file; /* file in question */ |
133 | }; | |
134 | ||
1da177e4 LT |
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; | |
abd1f500 | 145 | extern int nsm_use_hostnames; |
1da177e4 LT |
146 | |
147 | /* | |
148 | * Lockd client functions | |
149 | */ | |
92737230 TM |
150 | struct nlm_rqst * nlm_alloc_call(struct nlm_host *host); |
151 | void nlm_release_call(struct nlm_rqst *); | |
152 | int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *); | |
d4716624 | 153 | int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
3a649b88 TM |
154 | struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl); |
155 | void nlmclnt_finish_block(struct nlm_wait *block); | |
156 | int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout); | |
52921e02 | 157 | __be32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *); |
5c8dd29c | 158 | void nlmclnt_recovery(struct nlm_host *); |
1da177e4 | 159 | int nlmclnt_reclaim(struct nlm_host *, struct file_lock *); |
031d869d | 160 | void nlmclnt_next_cookie(struct nlm_cookie *); |
1da177e4 LT |
161 | |
162 | /* | |
163 | * Host cache | |
164 | */ | |
db4e4c9a OK |
165 | struct nlm_host * nlmclnt_lookup_host(const struct sockaddr_in *, int, int, const char *, int); |
166 | struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *, const char *, int); | |
1da177e4 LT |
167 | struct rpc_clnt * nlm_bind_host(struct nlm_host *); |
168 | void nlm_rebind_host(struct nlm_host *); | |
169 | struct nlm_host * nlm_get_host(struct nlm_host *); | |
170 | void nlm_release_host(struct nlm_host *); | |
171 | void nlm_shutdown_hosts(void); | |
5c8dd29c | 172 | extern void nlm_host_rebooted(const struct sockaddr_in *, const char *, int, u32); |
8dead0db | 173 | void nsm_release(struct nsm_handle *); |
1da177e4 LT |
174 | |
175 | ||
f2af793d OK |
176 | /* |
177 | * This is used in garbage collection and resource reclaim | |
178 | * A return value != 0 means destroy the lock/block/share | |
179 | */ | |
180 | typedef int (*nlm_host_match_fn_t)(struct nlm_host *cur, struct nlm_host *ref); | |
181 | ||
1da177e4 LT |
182 | /* |
183 | * Server-side lock handling | |
184 | */ | |
52921e02 | 185 | __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *, |
1da177e4 | 186 | struct nlm_lock *, int, struct nlm_cookie *); |
52921e02 AV |
187 | __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *); |
188 | __be32 nlmsvc_testlock(struct nlm_file *, struct nlm_lock *, | |
1da177e4 | 189 | struct nlm_lock *); |
52921e02 | 190 | __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *); |
1da177e4 | 191 | unsigned long nlmsvc_retry_blocked(void); |
f3ee439f | 192 | void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *, |
f2af793d | 193 | nlm_host_match_fn_t match); |
e8c5c045 | 194 | void nlmsvc_grant_reply(struct nlm_cookie *, __be32); |
1da177e4 LT |
195 | |
196 | /* | |
197 | * File handling for the server personality | |
198 | */ | |
52921e02 | 199 | __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **, |
1da177e4 LT |
200 | struct nfs_fh *); |
201 | void nlm_release_file(struct nlm_file *); | |
202 | void nlmsvc_mark_resources(void); | |
203 | void nlmsvc_free_host_resources(struct nlm_host *); | |
204 | void nlmsvc_invalidate_all(void); | |
205 | ||
206 | static __inline__ struct inode * | |
207 | nlmsvc_file_inode(struct nlm_file *file) | |
208 | { | |
225a719f | 209 | return file->f_file->f_path.dentry->d_inode; |
1da177e4 LT |
210 | } |
211 | ||
212 | /* | |
213 | * Compare two host addresses (needs modifying for ipv6) | |
214 | */ | |
215 | static __inline__ int | |
5ac5f9d1 | 216 | nlm_cmp_addr(const struct sockaddr_in *sin1, const struct sockaddr_in *sin2) |
1da177e4 LT |
217 | { |
218 | return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr; | |
219 | } | |
220 | ||
221 | /* | |
222 | * Compare two NLM locks. | |
223 | * When the second lock is of type F_UNLCK, this acts like a wildcard. | |
224 | */ | |
225 | static __inline__ int | |
5ac5f9d1 | 226 | nlm_compare_locks(const struct file_lock *fl1, const struct file_lock *fl2) |
1da177e4 LT |
227 | { |
228 | return fl1->fl_pid == fl2->fl_pid | |
3134cbec | 229 | && fl1->fl_owner == fl2->fl_owner |
1da177e4 LT |
230 | && fl1->fl_start == fl2->fl_start |
231 | && fl1->fl_end == fl2->fl_end | |
232 | &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK); | |
233 | } | |
234 | ||
235 | extern struct lock_manager_operations nlmsvc_lock_operations; | |
236 | ||
237 | #endif /* __KERNEL__ */ | |
238 | ||
239 | #endif /* LINUX_LOCKD_LOCKD_H */ |