lockd_lock.c revision 1.29 1 1.29 christos /* $NetBSD: lockd_lock.c,v 1.29 2008/12/29 03:38:26 christos Exp $ */
2 1.1 bouyer
3 1.1 bouyer /*
4 1.1 bouyer * Copyright (c) 2000 Manuel Bouyer.
5 1.1 bouyer *
6 1.1 bouyer * Redistribution and use in source and binary forms, with or without
7 1.1 bouyer * modification, are permitted provided that the following conditions
8 1.1 bouyer * are met:
9 1.1 bouyer * 1. Redistributions of source code must retain the above copyright
10 1.1 bouyer * notice, this list of conditions and the following disclaimer.
11 1.1 bouyer * 2. Redistributions in binary form must reproduce the above copyright
12 1.1 bouyer * notice, this list of conditions and the following disclaimer in the
13 1.1 bouyer * documentation and/or other materials provided with the distribution.
14 1.1 bouyer * 3. All advertising materials mentioning features or use of this software
15 1.1 bouyer * must display the following acknowledgement:
16 1.20 bouyer * This product includes software developed by Manuel Bouyer.
17 1.20 bouyer * 4. The name of the author may not be used to endorse or promote products
18 1.20 bouyer * derived from this software without specific prior written permission.
19 1.1 bouyer *
20 1.1 bouyer * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 1.1 bouyer * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 1.1 bouyer * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 1.1 bouyer * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 1.1 bouyer * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 1.1 bouyer * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 1.1 bouyer * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 1.1 bouyer * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 1.1 bouyer * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 1.1 bouyer * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 1.1 bouyer * SUCH DAMAGE.
31 1.1 bouyer *
32 1.1 bouyer */
33 1.1 bouyer
34 1.1 bouyer #include <stdio.h>
35 1.1 bouyer #include <stdlib.h>
36 1.1 bouyer #include <unistd.h>
37 1.1 bouyer #include <fcntl.h>
38 1.1 bouyer #include <syslog.h>
39 1.1 bouyer #include <errno.h>
40 1.1 bouyer #include <string.h>
41 1.1 bouyer #include <signal.h>
42 1.1 bouyer #include <rpc/rpc.h>
43 1.1 bouyer #include <sys/socket.h>
44 1.1 bouyer #include <sys/param.h>
45 1.1 bouyer #include <sys/mount.h>
46 1.1 bouyer #include <sys/wait.h>
47 1.1 bouyer #include <rpcsvc/sm_inter.h>
48 1.4 thorpej #include <rpcsvc/nlm_prot.h>
49 1.1 bouyer #include "lockd_lock.h"
50 1.1 bouyer #include "lockd.h"
51 1.1 bouyer
52 1.1 bouyer /* A set of utilities for managing file locking */
53 1.1 bouyer LIST_HEAD(lcklst_head, file_lock);
54 1.1 bouyer struct lcklst_head lcklst_head = LIST_HEAD_INITIALIZER(lcklst_head);
55 1.1 bouyer
56 1.25 yamt #define FHANDLE_SIZE_MAX 1024 /* arbitrary big enough value */
57 1.25 yamt typedef struct {
58 1.25 yamt size_t fhsize;
59 1.25 yamt char *fhdata;
60 1.23 martin } nfs_fhandle_t;
61 1.23 martin
62 1.25 yamt static int
63 1.25 yamt fhcmp(const nfs_fhandle_t *fh1, const nfs_fhandle_t *fh2)
64 1.25 yamt {
65 1.25 yamt
66 1.25 yamt if (fh1->fhsize != fh2->fhsize) {
67 1.25 yamt return 1;
68 1.25 yamt }
69 1.25 yamt return memcmp(fh1->fhdata, fh2->fhdata, fh1->fhsize);
70 1.25 yamt }
71 1.25 yamt
72 1.25 yamt static int
73 1.25 yamt fhconv(nfs_fhandle_t *fh, const netobj *rfh)
74 1.25 yamt {
75 1.25 yamt size_t sz;
76 1.25 yamt
77 1.25 yamt sz = rfh->n_len;
78 1.25 yamt if (sz > FHANDLE_SIZE_MAX) {
79 1.25 yamt syslog(LOG_DEBUG,
80 1.26 martin "received fhandle size %zd, max supported size %d",
81 1.25 yamt sz, FHANDLE_SIZE_MAX);
82 1.25 yamt errno = EINVAL;
83 1.25 yamt return -1;
84 1.25 yamt }
85 1.25 yamt fh->fhdata = malloc(sz);
86 1.25 yamt if (fh->fhdata == NULL) {
87 1.25 yamt return -1;
88 1.25 yamt }
89 1.25 yamt fh->fhsize = sz;
90 1.28 christos (void)memcpy(fh->fhdata, rfh->n_bytes, sz);
91 1.25 yamt return 0;
92 1.25 yamt }
93 1.25 yamt
94 1.25 yamt static void
95 1.25 yamt fhfree(nfs_fhandle_t *fh)
96 1.25 yamt {
97 1.25 yamt
98 1.25 yamt free(fh->fhdata);
99 1.25 yamt }
100 1.25 yamt
101 1.1 bouyer /* struct describing a lock */
102 1.1 bouyer struct file_lock {
103 1.1 bouyer LIST_ENTRY(file_lock) lcklst;
104 1.23 martin nfs_fhandle_t filehandle; /* NFS filehandle */
105 1.1 bouyer struct sockaddr *addr;
106 1.1 bouyer struct nlm4_holder client; /* lock holder */
107 1.1 bouyer netobj client_cookie; /* cookie sent by the client */
108 1.1 bouyer char client_name[128];
109 1.1 bouyer int nsm_status; /* status from the remote lock manager */
110 1.1 bouyer int status; /* lock status, see below */
111 1.1 bouyer int flags; /* lock flags, see lockd_lock.h */
112 1.1 bouyer pid_t locker; /* pid of the child process trying to get the lock */
113 1.1 bouyer int fd; /* file descriptor for this lock */
114 1.1 bouyer };
115 1.1 bouyer
116 1.1 bouyer /* lock status */
117 1.1 bouyer #define LKST_LOCKED 1 /* lock is locked */
118 1.1 bouyer #define LKST_WAITING 2 /* file is already locked by another host */
119 1.9 wiz #define LKST_PROCESSING 3 /* child is trying to acquire the lock */
120 1.1 bouyer #define LKST_DYING 4 /* must dies when we get news from the child */
121 1.1 bouyer
122 1.25 yamt static struct file_lock *lalloc(void);
123 1.28 christos void lfree(struct file_lock *);
124 1.28 christos enum nlm_stats do_lock(struct file_lock *, int);
125 1.28 christos enum nlm_stats do_unlock(struct file_lock *);
126 1.28 christos void send_granted(struct file_lock *, int);
127 1.28 christos void siglock(void);
128 1.28 christos void sigunlock(void);
129 1.1 bouyer
130 1.1 bouyer /* list of hosts we monitor */
131 1.1 bouyer LIST_HEAD(hostlst_head, host);
132 1.1 bouyer struct hostlst_head hostlst_head = LIST_HEAD_INITIALIZER(hostlst_head);
133 1.1 bouyer
134 1.1 bouyer /* struct describing a lock */
135 1.1 bouyer struct host {
136 1.1 bouyer LIST_ENTRY(host) hostlst;
137 1.15 yamt char name[SM_MAXSTRLEN+1];
138 1.1 bouyer int refcnt;
139 1.1 bouyer };
140 1.1 bouyer
141 1.28 christos void do_mon(const char *);
142 1.1 bouyer
143 1.18 yamt #define LL_FH 0x01
144 1.18 yamt #define LL_NAME 0x02
145 1.18 yamt #define LL_SVID 0x04
146 1.18 yamt
147 1.28 christos static struct file_lock *lock_lookup(struct file_lock *, int);
148 1.18 yamt
149 1.18 yamt /*
150 1.18 yamt * lock_lookup: lookup a matching lock.
151 1.18 yamt * called with siglock held.
152 1.18 yamt */
153 1.18 yamt static struct file_lock *
154 1.28 christos lock_lookup(struct file_lock *newfl, int flags)
155 1.18 yamt {
156 1.18 yamt struct file_lock *fl;
157 1.18 yamt
158 1.18 yamt LIST_FOREACH(fl, &lcklst_head, lcklst) {
159 1.18 yamt if ((flags & LL_SVID) != 0 &&
160 1.18 yamt newfl->client.svid != fl->client.svid)
161 1.18 yamt continue;
162 1.18 yamt if ((flags & LL_NAME) != 0 &&
163 1.18 yamt strcmp(newfl->client_name, fl->client_name) != 0)
164 1.18 yamt continue;
165 1.18 yamt if ((flags & LL_FH) != 0 &&
166 1.25 yamt fhcmp(&newfl->filehandle, &fl->filehandle) != 0)
167 1.18 yamt continue;
168 1.18 yamt /* found */
169 1.18 yamt break;
170 1.18 yamt }
171 1.18 yamt
172 1.18 yamt return fl;
173 1.18 yamt }
174 1.18 yamt
175 1.1 bouyer /*
176 1.1 bouyer * testlock(): inform the caller if the requested lock would be granted or not
177 1.1 bouyer * returns NULL if lock would granted, or pointer to the current nlm4_holder
178 1.1 bouyer * otherwise.
179 1.1 bouyer */
180 1.1 bouyer
181 1.1 bouyer struct nlm4_holder *
182 1.28 christos /*ARGSUSED*/
183 1.28 christos testlock(struct nlm4_lock *lock, int flags)
184 1.1 bouyer {
185 1.1 bouyer struct file_lock *fl;
186 1.23 martin nfs_fhandle_t filehandle;
187 1.1 bouyer
188 1.1 bouyer /* convert lock to a local filehandle */
189 1.25 yamt if (fhconv(&filehandle, &lock->fh)) {
190 1.28 christos syslog(LOG_NOTICE, "fhconv failed (%m)");
191 1.25 yamt return NULL; /* XXX */
192 1.25 yamt }
193 1.1 bouyer
194 1.1 bouyer siglock();
195 1.1 bouyer /* search through the list for lock holder */
196 1.14 yamt LIST_FOREACH(fl, &lcklst_head, lcklst) {
197 1.1 bouyer if (fl->status != LKST_LOCKED)
198 1.1 bouyer continue;
199 1.25 yamt if (fhcmp(&fl->filehandle, &filehandle) != 0)
200 1.1 bouyer continue;
201 1.1 bouyer /* got it ! */
202 1.1 bouyer syslog(LOG_DEBUG, "test for %s: found lock held by %s",
203 1.1 bouyer lock->caller_name, fl->client_name);
204 1.1 bouyer sigunlock();
205 1.25 yamt fhfree(&filehandle);
206 1.1 bouyer return (&fl->client);
207 1.1 bouyer }
208 1.1 bouyer /* not found */
209 1.1 bouyer sigunlock();
210 1.25 yamt fhfree(&filehandle);
211 1.1 bouyer syslog(LOG_DEBUG, "test for %s: no lock found", lock->caller_name);
212 1.1 bouyer return NULL;
213 1.1 bouyer }
214 1.1 bouyer
215 1.1 bouyer /*
216 1.9 wiz * getlock: try to acquire the lock.
217 1.1 bouyer * If file is already locked and we can sleep, put the lock in the list with
218 1.1 bouyer * status LKST_WAITING; it'll be processed later.
219 1.1 bouyer * Otherwise try to lock. If we're allowed to block, fork a child which
220 1.1 bouyer * will do the blocking lock.
221 1.1 bouyer */
222 1.1 bouyer enum nlm_stats
223 1.28 christos getlock(nlm4_lockargs * lckarg, struct svc_req *rqstp, int flags)
224 1.1 bouyer {
225 1.1 bouyer struct file_lock *fl, *newfl;
226 1.1 bouyer enum nlm_stats retval;
227 1.19 bouyer struct sockaddr *addr;
228 1.1 bouyer
229 1.1 bouyer if (grace_expired == 0 && lckarg->reclaim == 0)
230 1.1 bouyer return (flags & LOCK_V4) ?
231 1.28 christos (enum nlm_stats)nlm4_denied_grace_period : nlm_denied_grace_period;
232 1.1 bouyer
233 1.1 bouyer /* allocate new file_lock for this request */
234 1.25 yamt newfl = lalloc();
235 1.1 bouyer if (newfl == NULL) {
236 1.28 christos syslog(LOG_NOTICE, "malloc failed (%m)");
237 1.1 bouyer /* failed */
238 1.1 bouyer return (flags & LOCK_V4) ?
239 1.28 christos (enum nlm_stats)nlm4_denied_nolock : nlm_denied_nolocks;
240 1.1 bouyer }
241 1.25 yamt if (fhconv(&newfl->filehandle, &lckarg->alock.fh)) {
242 1.28 christos syslog(LOG_NOTICE, "fhconv failed (%m)");
243 1.25 yamt lfree(newfl);
244 1.25 yamt /* failed */
245 1.25 yamt return (flags & LOCK_V4) ?
246 1.28 christos (enum nlm_stats)nlm4_denied_nolock : nlm_denied_nolocks;
247 1.1 bouyer }
248 1.19 bouyer addr = (struct sockaddr *)svc_getrpccaller(rqstp->rq_xprt)->buf;
249 1.28 christos newfl->addr = malloc((size_t)addr->sa_len);
250 1.19 bouyer if (newfl->addr == NULL) {
251 1.28 christos syslog(LOG_NOTICE, "malloc failed (%m)");
252 1.25 yamt lfree(newfl);
253 1.19 bouyer /* failed */
254 1.19 bouyer return (flags & LOCK_V4) ?
255 1.28 christos (enum nlm_stats)nlm4_denied_nolock : nlm_denied_nolocks;
256 1.19 bouyer }
257 1.28 christos (void)memcpy(newfl->addr, addr, (size_t)addr->sa_len);
258 1.1 bouyer newfl->client.exclusive = lckarg->exclusive;
259 1.1 bouyer newfl->client.svid = lckarg->alock.svid;
260 1.1 bouyer newfl->client.oh.n_bytes = malloc(lckarg->alock.oh.n_len);
261 1.1 bouyer if (newfl->client.oh.n_bytes == NULL) {
262 1.28 christos syslog(LOG_NOTICE, "malloc failed (%m)");
263 1.25 yamt lfree(newfl);
264 1.1 bouyer return (flags & LOCK_V4) ?
265 1.28 christos (enum nlm_stats)nlm4_denied_nolock : nlm_denied_nolocks;
266 1.1 bouyer }
267 1.1 bouyer newfl->client.oh.n_len = lckarg->alock.oh.n_len;
268 1.28 christos (void)memcpy(newfl->client.oh.n_bytes, lckarg->alock.oh.n_bytes,
269 1.1 bouyer lckarg->alock.oh.n_len);
270 1.1 bouyer newfl->client.l_offset = lckarg->alock.l_offset;
271 1.1 bouyer newfl->client.l_len = lckarg->alock.l_len;
272 1.1 bouyer newfl->client_cookie.n_len = lckarg->cookie.n_len;
273 1.1 bouyer newfl->client_cookie.n_bytes = malloc(lckarg->cookie.n_len);
274 1.1 bouyer if (newfl->client_cookie.n_bytes == NULL) {
275 1.28 christos syslog(LOG_NOTICE, "malloc failed (%m)");
276 1.25 yamt lfree(newfl);
277 1.1 bouyer return (flags & LOCK_V4) ?
278 1.28 christos (enum nlm_stats)nlm4_denied_nolock : nlm_denied_nolocks;
279 1.1 bouyer }
280 1.28 christos (void)memcpy(newfl->client_cookie.n_bytes, lckarg->cookie.n_bytes,
281 1.1 bouyer lckarg->cookie.n_len);
282 1.28 christos (void)strlcpy(newfl->client_name, lckarg->alock.caller_name,
283 1.16 yamt sizeof(newfl->client_name));
284 1.1 bouyer newfl->nsm_status = lckarg->state;
285 1.1 bouyer newfl->status = 0;
286 1.1 bouyer newfl->flags = flags;
287 1.1 bouyer siglock();
288 1.1 bouyer /* look for a lock rq from this host for this fh */
289 1.18 yamt fl = lock_lookup(newfl, LL_FH|LL_NAME|LL_SVID);
290 1.18 yamt if (fl) {
291 1.18 yamt /* already locked by this host ??? */
292 1.18 yamt sigunlock();
293 1.18 yamt syslog(LOG_NOTICE, "duplicate lock from %s.%"
294 1.18 yamt PRIu32,
295 1.18 yamt newfl->client_name, newfl->client.svid);
296 1.18 yamt lfree(newfl);
297 1.18 yamt switch(fl->status) {
298 1.18 yamt case LKST_LOCKED:
299 1.18 yamt return (flags & LOCK_V4) ?
300 1.28 christos (enum nlm_stats)nlm4_granted : nlm_granted;
301 1.18 yamt case LKST_WAITING:
302 1.18 yamt case LKST_PROCESSING:
303 1.18 yamt return (flags & LOCK_V4) ?
304 1.28 christos (enum nlm_stats)nlm4_blocked : nlm_blocked;
305 1.18 yamt case LKST_DYING:
306 1.18 yamt return (flags & LOCK_V4) ?
307 1.28 christos (enum nlm_stats)nlm4_denied : nlm_denied;
308 1.18 yamt default:
309 1.18 yamt syslog(LOG_NOTICE, "bad status %d",
310 1.18 yamt fl->status);
311 1.18 yamt return (flags & LOCK_V4) ?
312 1.28 christos (enum nlm_stats)nlm4_failed : nlm_denied;
313 1.18 yamt }
314 1.18 yamt /* NOTREACHED */
315 1.18 yamt }
316 1.18 yamt fl = lock_lookup(newfl, LL_FH);
317 1.18 yamt if (fl) {
318 1.18 yamt /*
319 1.18 yamt * We already have a lock for this file.
320 1.18 yamt * Put this one in waiting state if allowed to block
321 1.18 yamt */
322 1.18 yamt if (lckarg->block) {
323 1.18 yamt syslog(LOG_DEBUG, "lock from %s.%" PRIu32 ": "
324 1.18 yamt "already locked, waiting",
325 1.18 yamt lckarg->alock.caller_name,
326 1.18 yamt lckarg->alock.svid);
327 1.18 yamt newfl->status = LKST_WAITING;
328 1.18 yamt LIST_INSERT_HEAD(&lcklst_head, newfl, lcklst);
329 1.18 yamt do_mon(lckarg->alock.caller_name);
330 1.18 yamt sigunlock();
331 1.18 yamt return (flags & LOCK_V4) ?
332 1.28 christos (enum nlm_stats)nlm4_blocked : nlm_blocked;
333 1.18 yamt } else {
334 1.18 yamt sigunlock();
335 1.18 yamt syslog(LOG_DEBUG, "lock from %s.%" PRIu32 ": "
336 1.18 yamt "already locked, failed",
337 1.18 yamt lckarg->alock.caller_name,
338 1.18 yamt lckarg->alock.svid);
339 1.18 yamt lfree(newfl);
340 1.18 yamt return (flags & LOCK_V4) ?
341 1.28 christos (enum nlm_stats)nlm4_denied : nlm_denied;
342 1.1 bouyer }
343 1.18 yamt /* NOTREACHED */
344 1.1 bouyer }
345 1.18 yamt
346 1.1 bouyer /* no entry for this file yet; add to list */
347 1.1 bouyer LIST_INSERT_HEAD(&lcklst_head, newfl, lcklst);
348 1.1 bouyer /* do the lock */
349 1.1 bouyer retval = do_lock(newfl, lckarg->block);
350 1.1 bouyer switch (retval) {
351 1.1 bouyer case nlm4_granted:
352 1.1 bouyer /* case nlm_granted: is the same as nlm4_granted */
353 1.1 bouyer case nlm4_blocked:
354 1.1 bouyer /* case nlm_blocked: is the same as nlm4_blocked */
355 1.1 bouyer do_mon(lckarg->alock.caller_name);
356 1.1 bouyer break;
357 1.1 bouyer default:
358 1.5 enami lfree(newfl);
359 1.1 bouyer break;
360 1.1 bouyer }
361 1.1 bouyer sigunlock();
362 1.1 bouyer return retval;
363 1.1 bouyer }
364 1.1 bouyer
365 1.1 bouyer /* unlock a filehandle */
366 1.1 bouyer enum nlm_stats
367 1.28 christos unlock(nlm4_lock *lck, int flags)
368 1.1 bouyer {
369 1.1 bouyer struct file_lock *fl;
370 1.23 martin nfs_fhandle_t filehandle;
371 1.28 christos int err = (flags & LOCK_V4) ? (enum nlm_stats)nlm4_granted : nlm_granted;
372 1.1 bouyer
373 1.25 yamt if (fhconv(&filehandle, &lck->fh)) {
374 1.28 christos syslog(LOG_NOTICE, "fhconv failed (%m)");
375 1.28 christos return (flags & LOCK_V4) ? (enum nlm_stats)nlm4_denied : nlm_denied;
376 1.25 yamt }
377 1.1 bouyer siglock();
378 1.14 yamt LIST_FOREACH(fl, &lcklst_head, lcklst) {
379 1.1 bouyer if (strcmp(fl->client_name, lck->caller_name) ||
380 1.25 yamt fhcmp(&filehandle, &fl->filehandle) != 0 ||
381 1.1 bouyer fl->client.oh.n_len != lck->oh.n_len ||
382 1.1 bouyer memcmp(fl->client.oh.n_bytes, lck->oh.n_bytes,
383 1.1 bouyer fl->client.oh.n_len) != 0 ||
384 1.1 bouyer fl->client.svid != lck->svid)
385 1.1 bouyer continue;
386 1.1 bouyer /* Got it, unlock and remove from the queue */
387 1.17 yamt syslog(LOG_DEBUG, "unlock from %s.%" PRIu32 ": found struct, "
388 1.17 yamt "status %d", lck->caller_name, lck->svid, fl->status);
389 1.1 bouyer switch (fl->status) {
390 1.1 bouyer case LKST_LOCKED:
391 1.1 bouyer err = do_unlock(fl);
392 1.1 bouyer break;
393 1.1 bouyer case LKST_WAITING:
394 1.1 bouyer /* remove from the list */
395 1.1 bouyer LIST_REMOVE(fl, lcklst);
396 1.1 bouyer lfree(fl);
397 1.1 bouyer break;
398 1.1 bouyer case LKST_PROCESSING:
399 1.1 bouyer /*
400 1.1 bouyer * being handled by a child; will clean up
401 1.1 bouyer * when the child exits
402 1.1 bouyer */
403 1.1 bouyer fl->status = LKST_DYING;
404 1.1 bouyer break;
405 1.1 bouyer case LKST_DYING:
406 1.1 bouyer /* nothing to do */
407 1.1 bouyer break;
408 1.1 bouyer default:
409 1.1 bouyer syslog(LOG_NOTICE, "unknow status %d for %s",
410 1.1 bouyer fl->status, fl->client_name);
411 1.1 bouyer }
412 1.1 bouyer sigunlock();
413 1.25 yamt fhfree(&filehandle);
414 1.1 bouyer return err;
415 1.1 bouyer }
416 1.1 bouyer sigunlock();
417 1.1 bouyer /* didn't find a matching entry; log anyway */
418 1.1 bouyer syslog(LOG_NOTICE, "no matching entry for %s",
419 1.1 bouyer lck->caller_name);
420 1.25 yamt fhfree(&filehandle);
421 1.28 christos return (flags & LOCK_V4) ? (enum nlm_stats)nlm4_granted : nlm_granted;
422 1.1 bouyer }
423 1.1 bouyer
424 1.25 yamt static struct file_lock *
425 1.25 yamt lalloc(void)
426 1.25 yamt {
427 1.27 christos return calloc(1, sizeof(struct file_lock));
428 1.25 yamt }
429 1.25 yamt
430 1.1 bouyer void
431 1.28 christos lfree(struct file_lock *fl)
432 1.1 bouyer {
433 1.19 bouyer free(fl->addr);
434 1.1 bouyer free(fl->client.oh.n_bytes);
435 1.1 bouyer free(fl->client_cookie.n_bytes);
436 1.25 yamt fhfree(&fl->filehandle);
437 1.1 bouyer free(fl);
438 1.1 bouyer }
439 1.1 bouyer
440 1.1 bouyer void
441 1.28 christos /*ARGSUSED*/
442 1.28 christos sigchild_handler(int sig)
443 1.1 bouyer {
444 1.28 christos int sstatus;
445 1.1 bouyer pid_t pid;
446 1.1 bouyer struct file_lock *fl;
447 1.1 bouyer
448 1.28 christos for (;;) {
449 1.28 christos pid = wait4(-1, &sstatus, WNOHANG, NULL);
450 1.1 bouyer if (pid == -1) {
451 1.1 bouyer if (errno != ECHILD)
452 1.28 christos syslog(LOG_NOTICE, "wait failed (%m)");
453 1.1 bouyer else
454 1.28 christos syslog(LOG_DEBUG, "wait failed (%m)");
455 1.1 bouyer return;
456 1.1 bouyer }
457 1.1 bouyer if (pid == 0) {
458 1.1 bouyer /* no more child to handle yet */
459 1.1 bouyer return;
460 1.1 bouyer }
461 1.1 bouyer /*
462 1.1 bouyer * if we're here we have a child that exited
463 1.1 bouyer * Find the associated file_lock.
464 1.1 bouyer */
465 1.14 yamt LIST_FOREACH(fl, &lcklst_head, lcklst) {
466 1.1 bouyer if (pid == fl->locker)
467 1.1 bouyer break;
468 1.1 bouyer }
469 1.12 yamt if (fl == NULL) {
470 1.1 bouyer syslog(LOG_NOTICE, "unknow child %d", pid);
471 1.1 bouyer } else {
472 1.12 yamt /*
473 1.12 yamt * protect from pid reusing.
474 1.12 yamt */
475 1.12 yamt fl->locker = 0;
476 1.28 christos if (!WIFEXITED(sstatus) || WEXITSTATUS(sstatus) != 0) {
477 1.1 bouyer syslog(LOG_NOTICE, "child %d failed", pid);
478 1.1 bouyer /*
479 1.1 bouyer * can't do much here; we can't reply
480 1.1 bouyer * anything but OK for blocked locks
481 1.1 bouyer * Eventually the client will time out
482 1.1 bouyer * and retry.
483 1.1 bouyer */
484 1.28 christos (void)do_unlock(fl);
485 1.1 bouyer return;
486 1.1 bouyer }
487 1.1 bouyer
488 1.1 bouyer /* check lock status */
489 1.1 bouyer syslog(LOG_DEBUG, "processing child %d, status %d",
490 1.1 bouyer pid, fl->status);
491 1.1 bouyer switch(fl->status) {
492 1.1 bouyer case LKST_PROCESSING:
493 1.1 bouyer fl->status = LKST_LOCKED;
494 1.1 bouyer send_granted(fl, (fl->flags & LOCK_V4) ?
495 1.28 christos (enum nlm_stats)nlm4_granted : nlm_granted);
496 1.1 bouyer break;
497 1.1 bouyer case LKST_DYING:
498 1.28 christos (void)do_unlock(fl);
499 1.1 bouyer break;
500 1.1 bouyer default:
501 1.1 bouyer syslog(LOG_NOTICE, "bad lock status (%d) for"
502 1.1 bouyer " child %d", fl->status, pid);
503 1.1 bouyer }
504 1.1 bouyer }
505 1.1 bouyer }
506 1.1 bouyer }
507 1.1 bouyer
508 1.1 bouyer /*
509 1.1 bouyer *
510 1.9 wiz * try to acquire the lock described by fl. Eventually fork a child to do a
511 1.1 bouyer * blocking lock if allowed and required.
512 1.1 bouyer */
513 1.1 bouyer
514 1.1 bouyer enum nlm_stats
515 1.28 christos do_lock(struct file_lock *fl, int block)
516 1.1 bouyer {
517 1.1 bouyer int lflags, error;
518 1.1 bouyer struct stat st;
519 1.1 bouyer
520 1.25 yamt fl->fd = fhopen(fl->filehandle.fhdata, fl->filehandle.fhsize, O_RDWR);
521 1.1 bouyer if (fl->fd < 0) {
522 1.1 bouyer switch (errno) {
523 1.1 bouyer case ESTALE:
524 1.1 bouyer error = nlm4_stale_fh;
525 1.1 bouyer break;
526 1.1 bouyer case EROFS:
527 1.1 bouyer error = nlm4_rofs;
528 1.1 bouyer break;
529 1.1 bouyer default:
530 1.1 bouyer error = nlm4_failed;
531 1.1 bouyer }
532 1.1 bouyer if ((fl->flags & LOCK_V4) == 0)
533 1.1 bouyer error = nlm_denied;
534 1.28 christos syslog(LOG_NOTICE, "fhopen failed (from %s) (%m)",
535 1.28 christos fl->client_name);
536 1.1 bouyer LIST_REMOVE(fl, lcklst);
537 1.11 simonb return error;
538 1.1 bouyer }
539 1.1 bouyer if (fstat(fl->fd, &st) < 0) {
540 1.28 christos syslog(LOG_NOTICE, "fstat failed (from %s) (%m)",
541 1.28 christos fl->client_name);
542 1.1 bouyer }
543 1.17 yamt syslog(LOG_DEBUG, "lock from %s.%" PRIu32 " for file%s%s: "
544 1.29 christos "dev %llu ino %llu (uid %d), flags %d",
545 1.17 yamt fl->client_name, fl->client.svid,
546 1.17 yamt fl->client.exclusive ? " (exclusive)":"", block ? " (block)":"",
547 1.29 christos (unsigned long long)st.st_dev,
548 1.29 christos (unsigned long long)st.st_ino, st.st_uid, fl->flags);
549 1.1 bouyer lflags = LOCK_NB;
550 1.1 bouyer if (fl->client.exclusive == 0)
551 1.1 bouyer lflags |= LOCK_SH;
552 1.1 bouyer else
553 1.1 bouyer lflags |= LOCK_EX;
554 1.1 bouyer error = flock(fl->fd, lflags);
555 1.1 bouyer if (error != 0 && errno == EAGAIN && block) {
556 1.1 bouyer switch (fl->locker = fork()) {
557 1.1 bouyer case -1: /* fork failed */
558 1.28 christos syslog(LOG_NOTICE, "fork failed (%m)");
559 1.1 bouyer LIST_REMOVE(fl, lcklst);
560 1.28 christos (void)close(fl->fd);
561 1.1 bouyer return (fl->flags & LOCK_V4) ?
562 1.28 christos (enum nlm_stats)nlm4_denied_nolock : nlm_denied_nolocks;
563 1.1 bouyer case 0:
564 1.1 bouyer /*
565 1.1 bouyer * Attempt a blocking lock. Will have to call
566 1.1 bouyer * NLM_GRANTED later.
567 1.1 bouyer */
568 1.17 yamt setproctitle("%s.%" PRIu32,
569 1.17 yamt fl->client_name, fl->client.svid);
570 1.1 bouyer lflags &= ~LOCK_NB;
571 1.1 bouyer if(flock(fl->fd, lflags) != 0) {
572 1.28 christos syslog(LOG_NOTICE, "flock failed (%m)");
573 1.13 yamt _exit(1);
574 1.1 bouyer }
575 1.1 bouyer /* lock granted */
576 1.13 yamt _exit(0);
577 1.28 christos /*NOTREACHED*/
578 1.1 bouyer default:
579 1.17 yamt syslog(LOG_DEBUG, "lock request from %s.%" PRIu32 ": "
580 1.17 yamt "forked %d",
581 1.17 yamt fl->client_name, fl->client.svid, fl->locker);
582 1.1 bouyer fl->status = LKST_PROCESSING;
583 1.1 bouyer return (fl->flags & LOCK_V4) ?
584 1.28 christos (enum nlm_stats)nlm4_blocked : nlm_blocked;
585 1.1 bouyer }
586 1.1 bouyer }
587 1.1 bouyer /* non block case */
588 1.1 bouyer if (error != 0) {
589 1.1 bouyer switch (errno) {
590 1.1 bouyer case EAGAIN:
591 1.1 bouyer error = nlm4_denied;
592 1.1 bouyer break;
593 1.1 bouyer case ESTALE:
594 1.1 bouyer error = nlm4_stale_fh;
595 1.1 bouyer break;
596 1.1 bouyer case EROFS:
597 1.1 bouyer error = nlm4_rofs;
598 1.1 bouyer break;
599 1.1 bouyer default:
600 1.1 bouyer error = nlm4_failed;
601 1.1 bouyer }
602 1.1 bouyer if ((fl->flags & LOCK_V4) == 0)
603 1.1 bouyer error = nlm_denied;
604 1.1 bouyer if (errno != EAGAIN)
605 1.28 christos syslog(LOG_NOTICE, "flock for %s failed (%m)",
606 1.28 christos fl->client_name);
607 1.28 christos else syslog(LOG_DEBUG, "flock for %s failed (%m)",
608 1.28 christos fl->client_name);
609 1.1 bouyer LIST_REMOVE(fl, lcklst);
610 1.28 christos (void)close(fl->fd);
611 1.1 bouyer return error;
612 1.1 bouyer }
613 1.1 bouyer fl->status = LKST_LOCKED;
614 1.28 christos return (fl->flags & LOCK_V4) ? (enum nlm_stats)nlm4_granted : nlm_granted;
615 1.1 bouyer }
616 1.1 bouyer
617 1.1 bouyer void
618 1.28 christos /*ARGSUSED*/
619 1.28 christos send_granted(struct file_lock *fl, int opcode)
620 1.1 bouyer {
621 1.1 bouyer CLIENT *cli;
622 1.1 bouyer static char dummy;
623 1.1 bouyer struct timeval timeo;
624 1.1 bouyer int success;
625 1.1 bouyer static struct nlm_res retval;
626 1.1 bouyer static struct nlm4_res retval4;
627 1.1 bouyer
628 1.28 christos cli = get_client(fl->addr, (rpcvers_t)
629 1.28 christos ((fl->flags & LOCK_V4) ? NLM_VERS4 : NLM_VERS));
630 1.1 bouyer if (cli == NULL) {
631 1.17 yamt syslog(LOG_NOTICE, "failed to get CLIENT for %s.%" PRIu32,
632 1.17 yamt fl->client_name, fl->client.svid);
633 1.1 bouyer /*
634 1.1 bouyer * We fail to notify remote that the lock has been granted.
635 1.1 bouyer * The client will timeout and retry, the lock will be
636 1.1 bouyer * granted at this time.
637 1.1 bouyer */
638 1.1 bouyer return;
639 1.1 bouyer }
640 1.1 bouyer timeo.tv_sec = 0;
641 1.1 bouyer timeo.tv_usec = (fl->flags & LOCK_ASYNC) ? 0 : 500000; /* 0.5s */
642 1.1 bouyer
643 1.1 bouyer if (fl->flags & LOCK_V4) {
644 1.28 christos static nlm4_testargs result;
645 1.28 christos result.cookie = fl->client_cookie;
646 1.28 christos result.exclusive = fl->client.exclusive;
647 1.28 christos result.alock.caller_name = fl->client_name;
648 1.28 christos result.alock.fh.n_len = fl->filehandle.fhsize;
649 1.28 christos result.alock.fh.n_bytes = fl->filehandle.fhdata;
650 1.28 christos result.alock.oh = fl->client.oh;
651 1.28 christos result.alock.svid = fl->client.svid;
652 1.28 christos result.alock.l_offset = fl->client.l_offset;
653 1.28 christos result.alock.l_len = fl->client.l_len;
654 1.1 bouyer syslog(LOG_DEBUG, "sending v4 reply%s",
655 1.1 bouyer (fl->flags & LOCK_ASYNC) ? " (async)":"");
656 1.1 bouyer if (fl->flags & LOCK_ASYNC) {
657 1.1 bouyer success = clnt_call(cli, NLM4_GRANTED_MSG,
658 1.28 christos xdr_nlm4_testargs, &result, xdr_void, &dummy, timeo);
659 1.1 bouyer } else {
660 1.1 bouyer success = clnt_call(cli, NLM4_GRANTED,
661 1.28 christos xdr_nlm4_testargs, &result, xdr_nlm4_res,
662 1.1 bouyer &retval4, timeo);
663 1.1 bouyer }
664 1.1 bouyer } else {
665 1.28 christos static nlm_testargs result;
666 1.1 bouyer
667 1.28 christos result.cookie = fl->client_cookie;
668 1.28 christos result.exclusive = fl->client.exclusive;
669 1.28 christos result.alock.caller_name = fl->client_name;
670 1.28 christos result.alock.fh.n_len = fl->filehandle.fhsize;
671 1.28 christos result.alock.fh.n_bytes = fl->filehandle.fhdata;
672 1.28 christos result.alock.oh = fl->client.oh;
673 1.28 christos result.alock.svid = fl->client.svid;
674 1.28 christos result.alock.l_offset =
675 1.28 christos (unsigned int)fl->client.l_offset;
676 1.28 christos result.alock.l_len =
677 1.28 christos (unsigned int)fl->client.l_len;
678 1.1 bouyer syslog(LOG_DEBUG, "sending v1 reply%s",
679 1.1 bouyer (fl->flags & LOCK_ASYNC) ? " (async)":"");
680 1.1 bouyer if (fl->flags & LOCK_ASYNC) {
681 1.1 bouyer success = clnt_call(cli, NLM_GRANTED_MSG,
682 1.28 christos xdr_nlm_testargs, &result, xdr_void, &dummy, timeo);
683 1.1 bouyer } else {
684 1.1 bouyer success = clnt_call(cli, NLM_GRANTED,
685 1.28 christos xdr_nlm_testargs, &result, xdr_nlm_res,
686 1.1 bouyer &retval, timeo);
687 1.1 bouyer }
688 1.1 bouyer }
689 1.1 bouyer if (debug_level > 2)
690 1.1 bouyer syslog(LOG_DEBUG, "clnt_call returns %d(%s) for granted",
691 1.1 bouyer success, clnt_sperrno(success));
692 1.1 bouyer
693 1.1 bouyer }
694 1.1 bouyer
695 1.1 bouyer enum nlm_stats
696 1.28 christos do_unlock(struct file_lock *rfl)
697 1.1 bouyer {
698 1.1 bouyer struct file_lock *fl;
699 1.1 bouyer int error;
700 1.1 bouyer int lockst;
701 1.1 bouyer
702 1.10 wiz /* unlock the file: closing is enough ! */
703 1.28 christos if (close(rfl->fd) == -1) {
704 1.1 bouyer if (errno == ESTALE)
705 1.1 bouyer error = nlm4_stale_fh;
706 1.1 bouyer else
707 1.1 bouyer error = nlm4_failed;
708 1.21 lukem if ((rfl->flags & LOCK_V4) == 0)
709 1.1 bouyer error = nlm_denied;
710 1.28 christos syslog(LOG_NOTICE, "close failed (from %s) (%m)",
711 1.28 christos rfl->client_name);
712 1.1 bouyer } else {
713 1.21 lukem error = (rfl->flags & LOCK_V4) ?
714 1.28 christos (enum nlm_stats)nlm4_granted : nlm_granted;
715 1.1 bouyer }
716 1.1 bouyer LIST_REMOVE(rfl, lcklst);
717 1.1 bouyer
718 1.1 bouyer /* process the next LKST_WAITING lock request for this fh */
719 1.14 yamt LIST_FOREACH(fl, &lcklst_head, lcklst) {
720 1.1 bouyer if (fl->status != LKST_WAITING ||
721 1.25 yamt fhcmp(&rfl->filehandle, &fl->filehandle) != 0)
722 1.1 bouyer continue;
723 1.1 bouyer
724 1.1 bouyer lockst = do_lock(fl, 1); /* If it's LKST_WAITING we can block */
725 1.1 bouyer switch (lockst) {
726 1.1 bouyer case nlm4_granted:
727 1.1 bouyer /* case nlm_granted: same as nlm4_granted */
728 1.1 bouyer send_granted(fl, (fl->flags & LOCK_V4) ?
729 1.28 christos (enum nlm_stats)nlm4_granted : nlm_granted);
730 1.1 bouyer break;
731 1.1 bouyer case nlm4_blocked:
732 1.1 bouyer /* case nlm_blocked: same as nlm4_blocked */
733 1.1 bouyer break;
734 1.1 bouyer default:
735 1.1 bouyer lfree(fl);
736 1.1 bouyer break;
737 1.1 bouyer }
738 1.1 bouyer break;
739 1.1 bouyer }
740 1.8 oster lfree(rfl);
741 1.1 bouyer return error;
742 1.1 bouyer }
743 1.1 bouyer
744 1.1 bouyer void
745 1.28 christos siglock(void)
746 1.1 bouyer {
747 1.1 bouyer sigset_t block;
748 1.1 bouyer
749 1.28 christos (void)sigemptyset(&block);
750 1.28 christos (void)sigaddset(&block, SIGCHLD);
751 1.1 bouyer
752 1.1 bouyer if (sigprocmask(SIG_BLOCK, &block, NULL) < 0) {
753 1.28 christos syslog(LOG_WARNING, "siglock failed (%m)");
754 1.1 bouyer }
755 1.1 bouyer }
756 1.1 bouyer
757 1.1 bouyer void
758 1.28 christos sigunlock(void)
759 1.1 bouyer {
760 1.1 bouyer sigset_t block;
761 1.1 bouyer
762 1.28 christos (void)sigemptyset(&block);
763 1.28 christos (void)sigaddset(&block, SIGCHLD);
764 1.1 bouyer
765 1.1 bouyer if (sigprocmask(SIG_UNBLOCK, &block, NULL) < 0) {
766 1.28 christos syslog(LOG_WARNING, "sigunlock failed (%m)");
767 1.1 bouyer }
768 1.1 bouyer }
769 1.1 bouyer
770 1.1 bouyer /* monitor a host through rpc.statd, and keep a ref count */
771 1.1 bouyer void
772 1.28 christos do_mon(const char *hostname)
773 1.1 bouyer {
774 1.28 christos static char localhost[] = "localhost";
775 1.1 bouyer struct host *hp;
776 1.1 bouyer struct mon my_mon;
777 1.28 christos struct sm_stat_res result;
778 1.1 bouyer int retval;
779 1.1 bouyer
780 1.14 yamt LIST_FOREACH(hp, &hostlst_head, hostlst) {
781 1.1 bouyer if (strcmp(hostname, hp->name) == 0) {
782 1.1 bouyer /* already monitored, just bump refcnt */
783 1.1 bouyer hp->refcnt++;
784 1.1 bouyer return;
785 1.1 bouyer }
786 1.1 bouyer }
787 1.1 bouyer /* not found, have to create an entry for it */
788 1.1 bouyer hp = malloc(sizeof(struct host));
789 1.19 bouyer if (hp == NULL) {
790 1.28 christos syslog(LOG_WARNING, "can't monitor host %s (%m)",
791 1.19 bouyer hostname);
792 1.19 bouyer return;
793 1.19 bouyer }
794 1.28 christos (void)strlcpy(hp->name, hostname, sizeof(hp->name));
795 1.1 bouyer hp->refcnt = 1;
796 1.28 christos syslog(LOG_DEBUG, "monitoring host %s", hostname);
797 1.28 christos (void)memset(&my_mon, 0, sizeof(my_mon));
798 1.1 bouyer my_mon.mon_id.mon_name = hp->name;
799 1.28 christos my_mon.mon_id.my_id.my_name = localhost;
800 1.1 bouyer my_mon.mon_id.my_id.my_prog = NLM_PROG;
801 1.1 bouyer my_mon.mon_id.my_id.my_vers = NLM_SM;
802 1.1 bouyer my_mon.mon_id.my_id.my_proc = NLM_SM_NOTIFY;
803 1.28 christos if ((retval = callrpc(localhost, SM_PROG, SM_VERS, SM_MON, xdr_mon,
804 1.28 christos (void *)&my_mon, xdr_sm_stat_res, (void *)&result)) != 0) {
805 1.28 christos syslog(LOG_WARNING, "rpc to statd failed (%s)",
806 1.1 bouyer clnt_sperrno((enum clnt_stat)retval));
807 1.1 bouyer free(hp);
808 1.1 bouyer return;
809 1.1 bouyer }
810 1.28 christos if (result.res_stat == stat_fail) {
811 1.1 bouyer syslog(LOG_WARNING, "statd failed");
812 1.1 bouyer free(hp);
813 1.1 bouyer return;
814 1.1 bouyer }
815 1.1 bouyer LIST_INSERT_HEAD(&hostlst_head, hp, hostlst);
816 1.1 bouyer }
817 1.1 bouyer
818 1.1 bouyer void
819 1.28 christos notify(const char *hostname, int state)
820 1.1 bouyer {
821 1.1 bouyer struct file_lock *fl, *next_fl;
822 1.1 bouyer int err;
823 1.1 bouyer syslog(LOG_DEBUG, "notify from %s, new state %d", hostname, state);
824 1.1 bouyer /* search all lock for this host; if status changed, release the lock */
825 1.1 bouyer siglock();
826 1.1 bouyer for (fl = LIST_FIRST(&lcklst_head); fl != NULL; fl = next_fl) {
827 1.1 bouyer next_fl = LIST_NEXT(fl, lcklst);
828 1.1 bouyer if (strcmp(hostname, fl->client_name) == 0 &&
829 1.1 bouyer fl->nsm_status != state) {
830 1.1 bouyer syslog(LOG_DEBUG, "state %d, nsm_state %d, unlocking",
831 1.1 bouyer fl->status, fl->nsm_status);
832 1.1 bouyer switch(fl->status) {
833 1.1 bouyer case LKST_LOCKED:
834 1.1 bouyer err = do_unlock(fl);
835 1.1 bouyer if (err != nlm_granted)
836 1.1 bouyer syslog(LOG_DEBUG,
837 1.1 bouyer "notify: unlock failed for %s (%d)",
838 1.1 bouyer hostname, err);
839 1.1 bouyer break;
840 1.1 bouyer case LKST_WAITING:
841 1.1 bouyer LIST_REMOVE(fl, lcklst);
842 1.1 bouyer lfree(fl);
843 1.1 bouyer break;
844 1.1 bouyer case LKST_PROCESSING:
845 1.1 bouyer fl->status = LKST_DYING;
846 1.1 bouyer break;
847 1.1 bouyer case LKST_DYING:
848 1.1 bouyer break;
849 1.1 bouyer default:
850 1.1 bouyer syslog(LOG_NOTICE, "unknow status %d for %s",
851 1.1 bouyer fl->status, fl->client_name);
852 1.1 bouyer }
853 1.1 bouyer }
854 1.1 bouyer }
855 1.1 bouyer sigunlock();
856 1.1 bouyer }
857