Whamcloud - gitweb
b=16367
[fs/lustre-release.git] / lustre / ldlm / ldlm_request.c
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 #define DEBUG_SUBSYSTEM S_LDLM
38 #ifndef __KERNEL__
39 #include <signal.h>
40 #include <liblustre.h>
41 #endif
42
43 #include <lustre_dlm.h>
44 #include <obd_class.h>
45 #include <obd.h>
46
47 #include "ldlm_internal.h"
48
49 int ldlm_enqueue_min = OBD_TIMEOUT_DEFAULT;
50 CFS_MODULE_PARM(ldlm_enqueue_min, "i", int, 0644,
51                 "lock enqueue timeout minimum");
52
53 static void interrupted_completion_wait(void *data)
54 {
55 }
56
57 struct lock_wait_data {
58         struct ldlm_lock *lwd_lock;
59         __u32             lwd_conn_cnt;
60 };
61
62 struct ldlm_async_args {
63         struct lustre_handle lock_handle;
64 };
65
66 int ldlm_expired_completion_wait(void *data)
67 {
68         struct lock_wait_data *lwd = data;
69         struct ldlm_lock *lock = lwd->lwd_lock;
70         struct obd_import *imp;
71         struct obd_device *obd;
72
73         ENTRY;
74         if (lock->l_conn_export == NULL) {
75                 static cfs_time_t next_dump = 0, last_dump = 0;
76
77                 if (ptlrpc_check_suspend())
78                         RETURN(0);
79
80                 LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
81                            CFS_DURATION_T"s ago); not entering recovery in "
82                            "server code, just going back to sleep",
83                            lock->l_enqueued_time.tv_sec,
84                            cfs_time_sub(cfs_time_current_sec(),
85                            lock->l_enqueued_time.tv_sec));
86                 if (cfs_time_after(cfs_time_current(), next_dump)) {
87                         last_dump = next_dump;
88                         next_dump = cfs_time_shift(300);
89                         ldlm_namespace_dump(D_DLMTRACE,
90                                             lock->l_resource->lr_namespace);
91                         if (last_dump == 0)
92                                 libcfs_debug_dumplog();
93                 }
94                 RETURN(0);
95         }
96
97         obd = lock->l_conn_export->exp_obd;
98         imp = obd->u.cli.cl_import;
99         ptlrpc_fail_import(imp, lwd->lwd_conn_cnt);
100         LDLM_ERROR(lock, "lock timed out (enqueued at "CFS_TIME_T", "
101                   CFS_DURATION_T"s ago), entering recovery for %s@%s",
102                   lock->l_enqueued_time.tv_sec,
103                   cfs_time_sub(cfs_time_current_sec(),
104                   lock->l_enqueued_time.tv_sec),
105                   obd2cli_tgt(obd), imp->imp_connection->c_remote_uuid.uuid);
106
107         RETURN(0);
108 }
109
110 /* We use the same basis for both server side and client side functions
111    from a single node. */
112 int ldlm_get_enq_timeout(struct ldlm_lock *lock)
113 {
114         int timeout = at_get(&lock->l_resource->lr_namespace->ns_at_estimate);
115         if (AT_OFF)
116                 return obd_timeout / 2;
117         /* Since these are non-updating timeouts, we should be conservative.
118            It would be nice to have some kind of "early reply" mechanism for
119            lock callbacks too... */
120         timeout = timeout + (timeout >> 1); /* 150% */
121         return max(timeout, ldlm_enqueue_min);
122 }
123
124 static int is_granted_or_cancelled(struct ldlm_lock *lock)
125 {
126         int ret = 0;
127
128         lock_res_and_lock(lock);
129         if (((lock->l_req_mode == lock->l_granted_mode) &&
130              !(lock->l_flags & LDLM_FL_CP_REQD)) ||
131             (lock->l_flags & LDLM_FL_FAILED))
132                 ret = 1;
133         unlock_res_and_lock(lock);
134
135         return ret;
136 }
137
138 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data)
139 {
140         /* XXX ALLOCATE - 160 bytes */
141         struct lock_wait_data lwd;
142         struct obd_device *obd;
143         struct obd_import *imp = NULL;
144         struct l_wait_info lwi;
145         __u32 timeout;
146         int rc = 0;
147         ENTRY;
148
149         if (flags == LDLM_FL_WAIT_NOREPROC) {
150                 LDLM_DEBUG(lock, "client-side enqueue waiting on pending lock");
151                 goto noreproc;
152         }
153
154         if (!(flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED |
155                        LDLM_FL_BLOCK_CONV))) {
156                 cfs_waitq_signal(&lock->l_waitq);
157                 RETURN(0);
158         }
159
160         LDLM_DEBUG(lock, "client-side enqueue returned a blocked lock, "
161                    "sleeping");
162         ldlm_lock_dump(D_OTHER, lock, 0);
163         ldlm_reprocess_all(lock->l_resource);
164
165 noreproc:
166
167         obd = class_exp2obd(lock->l_conn_export);
168
169         /* if this is a local lock, then there is no import */
170         if (obd != NULL) {
171                 imp = obd->u.cli.cl_import;
172         }
173
174         /* Wait a long time for enqueue - server may have to callback a
175            lock from another client.  Server will evict the other client if it
176            doesn't respond reasonably, and then give us the lock. */
177         timeout = ldlm_get_enq_timeout(lock) * 2;
178
179         lwd.lwd_lock = lock;
180
181         if (lock->l_flags & LDLM_FL_NO_TIMEOUT) {
182                 LDLM_DEBUG(lock, "waiting indefinitely because of NO_TIMEOUT");
183                 lwi = LWI_INTR(interrupted_completion_wait, &lwd);
184         } else {
185                 lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(timeout),
186                                        ldlm_expired_completion_wait,
187                                        interrupted_completion_wait, &lwd);
188         }
189
190         if (imp != NULL) {
191                 spin_lock(&imp->imp_lock);
192                 lwd.lwd_conn_cnt = imp->imp_conn_cnt;
193                 spin_unlock(&imp->imp_lock);
194         }
195
196         /* Go to sleep until the lock is granted or cancelled. */
197         rc = l_wait_event(lock->l_waitq, is_granted_or_cancelled(lock), &lwi);
198
199         if (lock->l_destroyed || lock->l_flags & LDLM_FL_FAILED) {
200                 LDLM_DEBUG(lock, "client-side enqueue waking up: destroyed");
201                 RETURN(-EIO);
202         }
203
204         if (rc) {
205                 LDLM_DEBUG(lock, "client-side enqueue waking up: failed (%d)",
206                            rc);
207                 RETURN(rc);
208         }
209
210         LDLM_DEBUG(lock, "client-side enqueue waking up: granted after "
211                    CFS_DURATION_T"s",
212                    cfs_time_sub(cfs_time_current_sec(),
213                    lock->l_enqueued_time.tv_sec));
214
215         /* Update our time estimate */
216         at_add(&lock->l_resource->lr_namespace->ns_at_estimate,
217                cfs_time_current_sec() - lock->l_enqueued_time.tv_sec);
218
219         RETURN(0);
220 }
221
222 /*
223  * ->l_blocking_ast() callback for LDLM locks acquired by server-side OBDs.
224  */
225 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
226                       void *data, int flag)
227 {
228         int do_ast;
229         ENTRY;
230
231         if (flag == LDLM_CB_CANCELING) {
232                 /* Don't need to do anything here. */
233                 RETURN(0);
234         }
235
236         lock_res_and_lock(lock);
237         /* Get this: if ldlm_blocking_ast is racing with intent_policy, such
238          * that ldlm_blocking_ast is called just before intent_policy method
239          * takes the ns_lock, then by the time we get the lock, we might not
240          * be the correct blocking function anymore.  So check, and return
241          * early, if so. */
242         if (lock->l_blocking_ast != ldlm_blocking_ast) {
243                 unlock_res_and_lock(lock);
244                 RETURN(0);
245         }
246
247         lock->l_flags |= LDLM_FL_CBPENDING;
248         do_ast = (!lock->l_readers && !lock->l_writers);
249         unlock_res_and_lock(lock);
250
251         if (do_ast) {
252                 struct lustre_handle lockh;
253                 int rc;
254
255                 LDLM_DEBUG(lock, "already unused, calling ldlm_cli_cancel");
256                 ldlm_lock2handle(lock, &lockh);
257                 rc = ldlm_cli_cancel(&lockh);
258                 if (rc < 0)
259                         CERROR("ldlm_cli_cancel: %d\n", rc);
260         } else {
261                 LDLM_DEBUG(lock, "Lock still has references, will be "
262                            "cancelled later");
263         }
264         RETURN(0);
265 }
266
267 /*
268  * ->l_glimpse_ast() for DLM extent locks acquired on the server-side. See
269  * comment in filter_intent_policy() on why you may need this.
270  */
271 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp)
272 {
273         /*
274          * Returning -ELDLM_NO_LOCK_DATA actually works, but the reason for
275          * that is rather subtle: with OST-side locking, it may so happen that
276          * _all_ extent locks are held by the OST. If client wants to obtain
277          * current file size it calls ll{,u}_glimpse_size(), and (as locks are
278          * on the server), dummy glimpse callback fires and does
279          * nothing. Client still receives correct file size due to the
280          * following fragment in filter_intent_policy():
281          *
282          * rc = l->l_glimpse_ast(l, NULL); // this will update the LVB
283          * if (rc != 0 && res->lr_namespace->ns_lvbo &&
284          *     res->lr_namespace->ns_lvbo->lvbo_update) {
285          *         res->lr_namespace->ns_lvbo->lvbo_update(res, NULL, 0, 1);
286          * }
287          *
288          * that is, after glimpse_ast() fails, filter_lvbo_update() runs, and
289          * returns correct file size to the client.
290          */
291         return -ELDLM_NO_LOCK_DATA;
292 }
293
294 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
295                            const struct ldlm_res_id *res_id,
296                            ldlm_type_t type, ldlm_policy_data_t *policy,
297                            ldlm_mode_t mode, int *flags,
298                            ldlm_blocking_callback blocking,
299                            ldlm_completion_callback completion,
300                            ldlm_glimpse_callback glimpse,
301                            void *data, __u32 lvb_len, void *lvb_swabber,
302                            struct lustre_handle *lockh)
303 {
304         struct ldlm_lock *lock;
305         int err;
306         ENTRY;
307
308         LASSERT(!(*flags & LDLM_FL_REPLAY));
309         if (unlikely(ns_is_client(ns))) {
310                 CERROR("Trying to enqueue local lock in a shadow namespace\n");
311                 LBUG();
312         }
313
314         lock = ldlm_lock_create(ns, res_id, type, mode, blocking,
315                                 completion, glimpse, data, lvb_len);
316         if (unlikely(!lock))
317                 GOTO(out_nolock, err = -ENOMEM);
318         LDLM_DEBUG(lock, "client-side local enqueue handler, new lock created");
319
320         ldlm_lock_addref_internal(lock, mode);
321         ldlm_lock2handle(lock, lockh);
322         lock_res_and_lock(lock);
323         lock->l_flags |= LDLM_FL_LOCAL;
324         if (*flags & LDLM_FL_ATOMIC_CB)
325                 lock->l_flags |= LDLM_FL_ATOMIC_CB;
326         lock->l_lvb_swabber = lvb_swabber;
327         unlock_res_and_lock(lock);
328         if (policy != NULL)
329                 lock->l_policy_data = *policy;
330         if (type == LDLM_EXTENT)
331                 lock->l_req_extent = policy->l_extent;
332
333         err = ldlm_lock_enqueue(ns, &lock, policy, flags);
334         if (unlikely(err != ELDLM_OK))
335                 GOTO(out, err);
336
337         if (policy != NULL)
338                 *policy = lock->l_policy_data;
339
340         LDLM_DEBUG_NOLOCK("client-side local enqueue handler END (lock %p)",
341                           lock);
342
343         if (lock->l_completion_ast)
344                 lock->l_completion_ast(lock, *flags, NULL);
345
346         LDLM_DEBUG(lock, "client-side local enqueue END");
347         EXIT;
348  out:
349         LDLM_LOCK_PUT(lock);
350  out_nolock:
351         return err;
352 }
353
354 static void failed_lock_cleanup(struct ldlm_namespace *ns,
355                                 struct ldlm_lock *lock,
356                                 struct lustre_handle *lockh, int mode)
357 {
358         /* Set a flag to prevent us from sending a CANCEL (bug 407) */
359         lock_res_and_lock(lock);
360         lock->l_flags |= LDLM_FL_LOCAL_ONLY;
361         unlock_res_and_lock(lock);
362         LDLM_DEBUG(lock, "setting FL_LOCAL_ONLY");
363
364         ldlm_lock_decref_and_cancel(lockh, mode);
365
366         /* XXX - HACK because we shouldn't call ldlm_lock_destroy()
367          *       from llite/file.c/ll_file_flock(). */
368         if (lock->l_resource->lr_type == LDLM_FLOCK) {
369                 ldlm_lock_destroy(lock);
370         }
371 }
372
373 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
374                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
375                           int *flags, void *lvb, __u32 lvb_len,
376                           void *lvb_swabber, struct lustre_handle *lockh,int rc)
377 {
378         struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
379         int is_replay = *flags & LDLM_FL_REPLAY;
380         struct ldlm_lock *lock;
381         struct ldlm_reply *reply;
382         int cleanup_phase = 1;
383         ENTRY;
384
385         lock = ldlm_handle2lock(lockh);
386         /* ldlm_cli_enqueue is holding a reference on this lock. */
387         if (!lock) {
388                 LASSERT(type == LDLM_FLOCK);
389                 RETURN(-ENOLCK);
390         }
391
392         if (rc != ELDLM_OK) {
393                 LASSERT(!is_replay);
394                 LDLM_DEBUG(lock, "client-side enqueue END (%s)",
395                            rc == ELDLM_LOCK_ABORTED ? "ABORTED" : "FAILED");
396                 if (rc == ELDLM_LOCK_ABORTED) {
397                         /* Before we return, swab the reply */
398                         reply = req_capsule_server_get(&req->rq_pill,
399                                                        &RMF_DLM_REP);
400                         if (reply == NULL)
401                                 rc = -EPROTO;
402                         if (lvb_len) {
403                                 struct ost_lvb *tmplvb;
404
405                                 req_capsule_set_size(&req->rq_pill,
406                                                      &RMF_DLM_LVB, RCL_SERVER,
407                                                      lvb_len);
408                             tmplvb = req_capsule_server_swab_get(&req->rq_pill,
409                                                                  &RMF_DLM_LVB,
410                                                                  lvb_swabber);
411                                 if (tmplvb == NULL)
412                                         GOTO(cleanup, rc = -EPROTO);
413                                 if (lvb != NULL)
414                                         memcpy(lvb, tmplvb, lvb_len);
415                         }
416                 }
417                 GOTO(cleanup, rc);
418         }
419
420         reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
421         if (reply == NULL)
422                 GOTO(cleanup, rc = -EPROTO);
423
424         /* lock enqueued on the server */
425         cleanup_phase = 0;
426
427         lock_res_and_lock(lock);
428         lock->l_remote_handle = reply->lock_handle;
429         *flags = reply->lock_flags;
430         lock->l_flags |= reply->lock_flags & LDLM_INHERIT_FLAGS;
431         /* move NO_TIMEOUT flag to the lock to force ldlm_lock_match()
432          * to wait with no timeout as well */
433         lock->l_flags |= reply->lock_flags & LDLM_FL_NO_TIMEOUT;
434         unlock_res_and_lock(lock);
435
436         CDEBUG(D_INFO, "local: %p, remote cookie: "LPX64", flags: 0x%x\n",
437                lock, reply->lock_handle.cookie, *flags);
438
439         /* If enqueue returned a blocked lock but the completion handler has
440          * already run, then it fixed up the resource and we don't need to do it
441          * again. */
442         if ((*flags) & LDLM_FL_LOCK_CHANGED) {
443                 int newmode = reply->lock_desc.l_req_mode;
444                 LASSERT(!is_replay);
445                 if (newmode && newmode != lock->l_req_mode) {
446                         LDLM_DEBUG(lock, "server returned different mode %s",
447                                    ldlm_lockname[newmode]);
448                         lock->l_req_mode = newmode;
449                 }
450
451                 if (memcmp(reply->lock_desc.l_resource.lr_name.name,
452                           lock->l_resource->lr_name.name,
453                           sizeof(struct ldlm_res_id))) {
454                         CDEBUG(D_INFO, "remote intent success, locking "
455                                         "(%ld,%ld,%ld) instead of "
456                                         "(%ld,%ld,%ld)\n",
457                               (long)reply->lock_desc.l_resource.lr_name.name[0],
458                               (long)reply->lock_desc.l_resource.lr_name.name[1],
459                               (long)reply->lock_desc.l_resource.lr_name.name[2],
460                               (long)lock->l_resource->lr_name.name[0],
461                               (long)lock->l_resource->lr_name.name[1],
462                               (long)lock->l_resource->lr_name.name[2]);
463
464                         rc = ldlm_lock_change_resource(ns, lock,
465                                         &reply->lock_desc.l_resource.lr_name);
466                         if (rc || lock->l_resource == NULL)
467                                 GOTO(cleanup, rc = -ENOMEM);
468                         LDLM_DEBUG(lock, "client-side enqueue, new resource");
469                 }
470                 if (with_policy)
471                         if (!(type == LDLM_IBITS && !(exp->exp_connect_flags &
472                                                     OBD_CONNECT_IBITS)))
473                                 lock->l_policy_data =
474                                                  reply->lock_desc.l_policy_data;
475                 if (type != LDLM_PLAIN)
476                         LDLM_DEBUG(lock,"client-side enqueue, new policy data");
477         }
478
479         if ((*flags) & LDLM_FL_AST_SENT ||
480             /* Cancel extent locks as soon as possible on a liblustre client,
481              * because it cannot handle asynchronous ASTs robustly (see
482              * bug 7311). */
483             (LIBLUSTRE_CLIENT && type == LDLM_EXTENT)) {
484                 lock_res_and_lock(lock);
485                 lock->l_flags |= LDLM_FL_CBPENDING |  LDLM_FL_BL_AST;
486                 unlock_res_and_lock(lock);
487                 LDLM_DEBUG(lock, "enqueue reply includes blocking AST");
488         }
489
490         /* If the lock has already been granted by a completion AST, don't
491          * clobber the LVB with an older one. */
492         if (lvb_len && (lock->l_req_mode != lock->l_granted_mode)) {
493                 void *tmplvb;
494
495                 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
496                                      lvb_len);
497                 tmplvb = req_capsule_server_swab_get(&req->rq_pill,
498                                                      &RMF_DLM_LVB,
499                                                      lvb_swabber);
500                 if (tmplvb == NULL)
501                         GOTO(cleanup, rc = -EPROTO);
502                 memcpy(lock->l_lvb_data, tmplvb, lvb_len);
503         }
504
505         if (!is_replay) {
506                 rc = ldlm_lock_enqueue(ns, &lock, NULL, flags);
507                 if (lock->l_completion_ast != NULL) {
508                         int err = lock->l_completion_ast(lock, *flags, NULL);
509                         if (!rc)
510                                 rc = err;
511                         if (rc && type != LDLM_FLOCK) /* bug 9425, bug 10250 */
512                                 cleanup_phase = 1;
513                 }
514         }
515
516         if (lvb_len && lvb != NULL) {
517                 /* Copy the LVB here, and not earlier, because the completion
518                  * AST (if any) can override what we got in the reply */
519                 memcpy(lvb, lock->l_lvb_data, lvb_len);
520         }
521
522         LDLM_DEBUG(lock, "client-side enqueue END");
523         EXIT;
524 cleanup:
525         if (cleanup_phase == 1 && rc)
526                 failed_lock_cleanup(ns, lock, lockh, mode);
527         /* Put lock 2 times, the second reference is held by ldlm_cli_enqueue */
528         LDLM_LOCK_PUT(lock);
529         LDLM_LOCK_PUT(lock);
530         return rc;
531 }
532
533 /* PAGE_SIZE-512 is to allow TCP/IP and LNET headers to fit into
534  * a single page on the send/receive side. XXX: 512 should be changed
535  * to more adequate value. */
536 static inline int ldlm_req_handles_avail(int req_size, int off)
537 {
538         int avail;
539
540         avail = min_t(int, LDLM_MAXREQSIZE, CFS_PAGE_SIZE - 512) - req_size;
541         avail /= sizeof(struct lustre_handle);
542         avail += LDLM_LOCKREQ_HANDLES - off;
543
544         return avail;
545 }
546
547 static inline int ldlm_capsule_handles_avail(struct req_capsule *pill,
548                                              enum req_location loc,
549                                              int off)
550 {
551         int size = req_capsule_msg_size(pill, loc);
552         return ldlm_req_handles_avail(size, off);
553 }
554
555 static inline int ldlm_format_handles_avail(struct obd_import *imp,
556                                             const struct req_format *fmt,
557                                             enum req_location loc, int off)
558 {
559         int size = req_capsule_fmt_size(imp->imp_msg_magic, fmt, loc);
560         return ldlm_req_handles_avail(size, off);
561 }
562
563 /* Cancel lru locks and pack them into the enqueue request. Pack there the given
564  * @count locks in @cancels. */
565 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
566                       int version, int opc, int canceloff,
567                       struct list_head *cancels, int count)
568 {
569         struct ldlm_namespace   *ns = exp->exp_obd->obd_namespace;
570         struct req_capsule      *pill = &req->rq_pill;
571         struct ldlm_request     *dlm = NULL;
572         int flags, avail, to_free, bufcount, pack = 0;
573         CFS_LIST_HEAD(head);
574         int rc;
575         ENTRY;
576
577         if (cancels == NULL)
578                 cancels = &head;
579         if (exp_connect_cancelset(exp)) {
580                 /* Estimate the amount of available space in the request. */
581                 bufcount = req_capsule_filled_sizes(pill, RCL_CLIENT);
582                 avail = ldlm_capsule_handles_avail(pill, RCL_CLIENT, canceloff);
583
584                 flags = ns_connect_lru_resize(ns) ? 
585                         LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
586                 to_free = !ns_connect_lru_resize(ns) &&
587                           opc == LDLM_ENQUEUE ? 1 : 0;
588
589                 /* Cancel lru locks here _only_ if the server supports 
590                  * EARLY_CANCEL. Otherwise we have to send extra CANCEL
591                  * rpc, what will make us slower. */
592                 if (avail > count)
593                         count += ldlm_cancel_lru_local(ns, cancels, to_free,
594                                                        avail - count, 0, flags);
595                 if (avail > count)
596                         pack = count;
597                 else
598                         pack = avail;
599                 req_capsule_set_size(pill, &RMF_DLM_REQ, RCL_CLIENT,
600                                      ldlm_request_bufsize(pack, opc));
601         }
602
603         rc = ptlrpc_request_pack(req, version, opc);
604         if (rc) {
605                 ldlm_lock_list_put(cancels, l_bl_ast, count);
606                 RETURN(rc);
607         }
608
609         if (exp_connect_cancelset(exp)) {
610                 if (canceloff) {
611                         dlm = req_capsule_client_get(pill, &RMF_DLM_REQ);
612                         LASSERT(dlm);
613                         /* Skip first lock handler in ldlm_request_pack(),
614                          * this method will incrment @lock_count according
615                          * to the lock handle amount actually written to
616                          * the buffer. */
617                         dlm->lock_count = canceloff;
618                 }
619                 /* Pack into the request @pack lock handles. */
620                 ldlm_cli_cancel_list(cancels, pack, req, 0);
621                 /* Prepare and send separate cancel rpc for others. */
622                 ldlm_cli_cancel_list(cancels, count - pack, NULL, 0);
623         } else {
624                 ldlm_lock_list_put(cancels, l_bl_ast, count);
625         }
626         RETURN(0);
627 }
628
629 int ldlm_prep_enqueue_req(struct obd_export *exp, struct ptlrpc_request *req,
630                           struct list_head *cancels, int count)
631 {
632         return ldlm_prep_elc_req(exp, req, LUSTRE_DLM_VERSION, LDLM_ENQUEUE,
633                                  LDLM_ENQUEUE_CANCEL_OFF, cancels, count);
634 }
635
636 /* If a request has some specific initialisation it is passed in @reqp,
637  * otherwise it is created in ldlm_cli_enqueue.
638  *
639  * Supports sync and async requests, pass @async flag accordingly. If a
640  * request was created in ldlm_cli_enqueue and it is the async request,
641  * pass it to the caller in @reqp. */
642 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
643                      struct ldlm_enqueue_info *einfo,
644                      const struct ldlm_res_id *res_id,
645                      ldlm_policy_data_t *policy, int *flags,
646                      void *lvb, __u32 lvb_len, void *lvb_swabber,
647                      struct lustre_handle *lockh, int async)
648 {
649         struct ldlm_namespace *ns = exp->exp_obd->obd_namespace;
650         struct ldlm_lock      *lock;
651         struct ldlm_request   *body;
652         int                    is_replay = *flags & LDLM_FL_REPLAY;
653         int                    req_passed_in = 1;
654         int                    rc, err;
655         struct ptlrpc_request *req;
656         ENTRY;
657
658         LASSERT(exp != NULL);
659
660         /* If we're replaying this lock, just check some invariants.
661          * If we're creating a new lock, get everything all setup nice. */
662         if (is_replay) {
663                 lock = ldlm_handle2lock(lockh);
664                 LASSERT(lock != NULL);
665                 LDLM_DEBUG(lock, "client-side enqueue START");
666                 LASSERT(exp == lock->l_conn_export);
667         } else {
668                 lock = ldlm_lock_create(ns, res_id, einfo->ei_type,
669                                         einfo->ei_mode, einfo->ei_cb_bl,
670                                         einfo->ei_cb_cp, einfo->ei_cb_gl,
671                                         einfo->ei_cbdata, lvb_len);
672                 if (lock == NULL)
673                         RETURN(-ENOMEM);
674                 /* for the local lock, add the reference */
675                 ldlm_lock_addref_internal(lock, einfo->ei_mode);
676                 ldlm_lock2handle(lock, lockh);
677                 lock->l_lvb_swabber = lvb_swabber;
678                 if (policy != NULL) {
679                         /* INODEBITS_INTEROP: If the server does not support
680                          * inodebits, we will request a plain lock in the
681                          * descriptor (ldlm_lock2desc() below) but use an
682                          * inodebits lock internally with both bits set.
683                          */
684                         if (einfo->ei_type == LDLM_IBITS &&
685                             !(exp->exp_connect_flags & OBD_CONNECT_IBITS))
686                                 lock->l_policy_data.l_inodebits.bits =
687                                         MDS_INODELOCK_LOOKUP |
688                                         MDS_INODELOCK_UPDATE;
689                         else
690                                 lock->l_policy_data = *policy;
691                 }
692
693                 if (einfo->ei_type == LDLM_EXTENT)
694                         lock->l_req_extent = policy->l_extent;
695                 LDLM_DEBUG(lock, "client-side enqueue START");
696         }
697
698         /* lock not sent to server yet */
699
700         if (reqp == NULL || *reqp == NULL) {
701                 req = ptlrpc_request_alloc_pack(class_exp2cliimp(exp),
702                                                 &RQF_LDLM_ENQUEUE,
703                                                 LUSTRE_DLM_VERSION,
704                                                 LDLM_ENQUEUE);
705                 if (req == NULL) {
706                         failed_lock_cleanup(ns, lock, lockh, einfo->ei_mode);
707                         LDLM_LOCK_PUT(lock);
708                         RETURN(-ENOMEM);
709                 }
710                 req_passed_in = 0;
711                 if (reqp)
712                         *reqp = req;
713         } else {
714                 int len;
715
716                 req = *reqp;
717                 len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ,
718                                            RCL_CLIENT);
719                 LASSERTF(len >= sizeof(*body), "buflen[%d] = %d, not %d\n",
720                          DLM_LOCKREQ_OFF, len, (int)sizeof(*body));
721         }
722
723         lock->l_conn_export = exp;
724         lock->l_export = NULL;
725         lock->l_blocking_ast = einfo->ei_cb_bl;
726
727         /* Dump lock data into the request buffer */
728         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
729         ldlm_lock2desc(lock, &body->lock_desc);
730         body->lock_flags = *flags;
731         body->lock_handle[0] = *lockh;
732
733         /* Continue as normal. */
734         if (!req_passed_in) {
735                 if (lvb_len > 0) {
736                         req_capsule_extend(&req->rq_pill,
737                                            &RQF_LDLM_ENQUEUE_LVB);
738                         req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB,
739                                              RCL_SERVER, lvb_len);
740                 }
741                 ptlrpc_request_set_replen(req);
742         }
743
744         /*
745          * Liblustre client doesn't get extent locks, except for O_APPEND case
746          * where [0, OBD_OBJECT_EOF] lock is taken, or truncate, where
747          * [i_size, OBD_OBJECT_EOF] lock is taken.
748          */
749         LASSERT(ergo(LIBLUSTRE_CLIENT, einfo->ei_type != LDLM_EXTENT ||
750                      policy->l_extent.end == OBD_OBJECT_EOF));
751
752         if (async) {
753                 LASSERT(reqp != NULL);
754                 RETURN(0);
755         }
756
757         LDLM_DEBUG(lock, "sending request");
758         rc = ptlrpc_queue_wait(req);
759         err = ldlm_cli_enqueue_fini(exp, req, einfo->ei_type, policy ? 1 : 0,
760                                     einfo->ei_mode, flags, lvb, lvb_len,
761                                     lvb_swabber, lockh, rc);
762
763         /* If ldlm_cli_enqueue_fini did not find the lock, we need to free
764          * one reference that we took */
765         if (err == -ENOLCK)
766                 LDLM_LOCK_PUT(lock);
767         else
768                 rc = err;
769
770         if (!req_passed_in && req != NULL) {
771                 ptlrpc_req_finished(req);
772                 if (reqp)
773                         *reqp = NULL;
774         }
775
776         RETURN(rc);
777 }
778
779 static int ldlm_cli_convert_local(struct ldlm_lock *lock, int new_mode,
780                                   __u32 *flags)
781 {
782         struct ldlm_resource *res;
783         int rc;
784         ENTRY;
785         if (ns_is_client(lock->l_resource->lr_namespace)) {
786                 CERROR("Trying to cancel local lock\n");
787                 LBUG();
788         }
789         LDLM_DEBUG(lock, "client-side local convert");
790
791         res = ldlm_lock_convert(lock, new_mode, flags);
792         if (res) {
793                 ldlm_reprocess_all(res);
794                 rc = 0;
795         } else {
796                 rc = EDEADLOCK;
797         }
798         LDLM_DEBUG(lock, "client-side local convert handler END");
799         LDLM_LOCK_PUT(lock);
800         RETURN(rc);
801 }
802
803 /* FIXME: one of ldlm_cli_convert or the server side should reject attempted
804  * conversion of locks which are on the waiting or converting queue */
805 /* Caller of this code is supposed to take care of lock readers/writers
806    accounting */
807 int ldlm_cli_convert(struct lustre_handle *lockh, int new_mode, __u32 *flags)
808 {
809         struct ldlm_request   *body;
810         struct ldlm_reply     *reply;
811         struct ldlm_lock      *lock;
812         struct ldlm_resource  *res;
813         struct ptlrpc_request *req;
814         int                    rc;
815         ENTRY;
816
817         lock = ldlm_handle2lock(lockh);
818         if (!lock) {
819                 LBUG();
820                 RETURN(-EINVAL);
821         }
822         *flags = 0;
823
824         if (lock->l_conn_export == NULL)
825                 RETURN(ldlm_cli_convert_local(lock, new_mode, flags));
826
827         LDLM_DEBUG(lock, "client-side convert");
828
829         req = ptlrpc_request_alloc_pack(class_exp2cliimp(lock->l_conn_export),
830                                         &RQF_LDLM_CONVERT, LUSTRE_DLM_VERSION,
831                                         LDLM_CONVERT);
832         if (req == NULL) {
833                 LDLM_LOCK_PUT(lock);
834                 RETURN(-ENOMEM);
835         }
836
837         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
838         body->lock_handle[0] = lock->l_remote_handle;
839
840         body->lock_desc.l_req_mode = new_mode;
841         body->lock_flags = *flags;
842
843
844         ptlrpc_request_set_replen(req);
845         rc = ptlrpc_queue_wait(req);
846         if (rc != ELDLM_OK)
847                 GOTO(out, rc);
848
849         reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
850         if (reply == NULL)
851                 GOTO(out, rc = -EPROTO);
852
853         if (req->rq_status)
854                 GOTO(out, rc = req->rq_status);
855
856         res = ldlm_lock_convert(lock, new_mode, &reply->lock_flags);
857         if (res != NULL) {
858                 ldlm_reprocess_all(res);
859                 /* Go to sleep until the lock is granted. */
860                 /* FIXME: or cancelled. */
861                 if (lock->l_completion_ast) {
862                         rc = lock->l_completion_ast(lock, LDLM_FL_WAIT_NOREPROC,
863                                                     NULL);
864                         if (rc)
865                                 GOTO(out, rc);
866                 }
867         } else {
868                 rc = EDEADLOCK;
869         }
870         EXIT;
871  out:
872         LDLM_LOCK_PUT(lock);
873         ptlrpc_req_finished(req);
874         return rc;
875 }
876
877 /* Cancel locks locally.
878  * Returns:
879  * LDLM_FL_LOCAL_ONLY if tere is no need in a CANCEL rpc to the server;
880  * LDLM_FL_CANCELING otherwise;
881  * LDLM_FL_BL_AST if there is a need in a separate CANCEL rpc. */
882 static int ldlm_cli_cancel_local(struct ldlm_lock *lock)
883 {
884         int rc = LDLM_FL_LOCAL_ONLY;
885         ENTRY;
886         
887         if (lock->l_conn_export) {
888                 int local_only;
889
890                 LDLM_DEBUG(lock, "client-side cancel");
891                 /* Set this flag to prevent others from getting new references*/
892                 lock_res_and_lock(lock);
893                 lock->l_flags |= LDLM_FL_CBPENDING;
894                 local_only = (lock->l_flags &
895                               (LDLM_FL_LOCAL_ONLY|LDLM_FL_CANCEL_ON_BLOCK));
896                 ldlm_cancel_callback(lock);
897                 rc = (lock->l_flags & LDLM_FL_BL_AST) ?
898                         LDLM_FL_BL_AST : LDLM_FL_CANCELING;
899                 unlock_res_and_lock(lock);
900
901                 if (local_only) {
902                         CDEBUG(D_DLMTRACE, "not sending request (at caller's "
903                                "instruction)\n");
904                         rc = LDLM_FL_LOCAL_ONLY;
905                 }
906                 ldlm_lock_cancel(lock);
907         } else {
908                 if (ns_is_client(lock->l_resource->lr_namespace)) {
909                         LDLM_ERROR(lock, "Trying to cancel local lock");
910                         LBUG();
911                 }
912                 LDLM_DEBUG(lock, "server-side local cancel");
913                 ldlm_lock_cancel(lock);
914                 ldlm_reprocess_all(lock->l_resource);
915                 LDLM_DEBUG(lock, "server-side local cancel handler END");
916         }
917
918         RETURN(rc);
919 }
920
921 /* Pack @count locks in @head into ldlm_request buffer at the offset @off,
922    of the request @req. */
923 static void ldlm_cancel_pack(struct ptlrpc_request *req,
924                              struct list_head *head, int count)
925 {
926         struct ldlm_request *dlm;
927         struct ldlm_lock *lock;
928         int max, packed = 0;
929         ENTRY;
930
931         dlm = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
932         LASSERT(dlm != NULL);
933
934         /* Check the room in the request buffer. */
935         max = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) - 
936                 sizeof(struct ldlm_request);
937         max /= sizeof(struct lustre_handle);
938         max += LDLM_LOCKREQ_HANDLES;
939         LASSERT(max >= dlm->lock_count + count);
940
941         /* XXX: it would be better to pack lock handles grouped by resource.
942          * so that the server cancel would call filter_lvbo_update() less
943          * frequently. */
944         list_for_each_entry(lock, head, l_bl_ast) {
945                 if (!count--)
946                         break;
947                 LASSERT(lock->l_conn_export);
948                 /* Pack the lock handle to the given request buffer. */
949                 LDLM_DEBUG(lock, "packing");
950                 dlm->lock_handle[dlm->lock_count++] = lock->l_remote_handle;
951                 packed++;
952         }
953         CDEBUG(D_DLMTRACE, "%d locks packed\n", packed);
954         EXIT;
955 }
956
957 /* Prepare and send a batched cancel rpc, it will include count lock handles
958  * of locks given in @head. */
959 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *cancels,
960                         int count, int flags)
961 {
962         struct ptlrpc_request *req = NULL;
963         struct obd_import *imp;
964         int free, sent = 0;
965         int rc = 0;
966         ENTRY;
967
968         LASSERT(exp != NULL);
969         LASSERT(count > 0);
970
971         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL, obd_fail_val);
972
973         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_RACE))
974                 RETURN(count);
975
976         free = ldlm_format_handles_avail(class_exp2cliimp(exp),
977                                          &RQF_LDLM_CANCEL, RCL_CLIENT, 0);
978         if (count > free)
979                 count = free;
980
981         while (1) {
982                 int bufcount;
983
984                 imp = class_exp2cliimp(exp);
985                 if (imp == NULL || imp->imp_invalid) {
986                         CDEBUG(D_DLMTRACE,
987                                "skipping cancel on invalid import %p\n", imp);
988                         RETURN(count);
989                 }
990
991                 req = ptlrpc_request_alloc(imp, &RQF_LDLM_CANCEL);
992                 if (req == NULL)
993                         GOTO(out, rc = -ENOMEM);
994
995                 bufcount = req_capsule_filled_sizes(&req->rq_pill, RCL_CLIENT);
996                 req_capsule_set_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT,
997                                      ldlm_request_bufsize(count, LDLM_CANCEL));
998
999                 rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CANCEL);
1000                 if (rc) {
1001                         ptlrpc_request_free(req);
1002                         GOTO(out, rc);
1003                 }
1004                 req->rq_no_resend = 1;
1005                 req->rq_no_delay = 1;
1006
1007                 req->rq_request_portal = LDLM_CANCEL_REQUEST_PORTAL;
1008                 req->rq_reply_portal = LDLM_CANCEL_REPLY_PORTAL;
1009                 ptlrpc_at_set_req_timeout(req);
1010
1011                 ldlm_cancel_pack(req, cancels, count);
1012
1013                 ptlrpc_request_set_replen(req);
1014                 if (flags & LDLM_FL_ASYNC) {
1015                         ptlrpcd_add_req(req);
1016                         sent = count;
1017                         GOTO(out, 0);
1018                 } else {
1019                         rc = ptlrpc_queue_wait(req);
1020                 }
1021                 if (rc == ESTALE) {
1022                         CDEBUG(D_DLMTRACE, "client/server (nid %s) "
1023                                "out of sync -- not fatal\n",
1024                                libcfs_nid2str(req->rq_import->
1025                                               imp_connection->c_peer.nid));
1026                         rc = 0;
1027                 } else if (rc == -ETIMEDOUT && /* check there was no reconnect*/
1028                            req->rq_import_generation == imp->imp_generation) {
1029                         ptlrpc_req_finished(req);
1030                         continue;
1031                 } else if (rc != ELDLM_OK) {
1032                         CERROR("Got rc %d from cancel RPC: canceling "
1033                                "anyway\n", rc);
1034                         break;
1035                 }
1036                 sent = count;
1037                 break;
1038         }
1039
1040         ptlrpc_req_finished(req);
1041         EXIT;
1042 out:
1043         return sent ? sent : rc;
1044 }
1045
1046 static inline struct ldlm_pool *ldlm_imp2pl(struct obd_import *imp)
1047 {
1048         LASSERT(imp != NULL);
1049         return &imp->imp_obd->obd_namespace->ns_pool;
1050 }
1051
1052 /**
1053  * Update client's obd pool related fields with new SLV and Limit from \a req.
1054  */
1055 int ldlm_cli_update_pool(struct ptlrpc_request *req)
1056 {
1057         struct obd_device *obd;
1058         __u64 old_slv, new_slv;
1059         __u32 new_limit;
1060         ENTRY;
1061     
1062         if (unlikely(!req->rq_import || !req->rq_import->imp_obd || 
1063                      !imp_connect_lru_resize(req->rq_import)))
1064         {
1065                 /* 
1066                  * Do nothing for corner cases. 
1067                  */
1068                 RETURN(0);
1069         }
1070
1071         /* 
1072          * In some cases RPC may contain slv and limit zeroed out. This is 
1073          * the case when server does not support lru resize feature. This is
1074          * also possible in some recovery cases when server side reqs have no
1075          * ref to obd export and thus access to server side namespace is no 
1076          * possible. 
1077          */
1078         if (lustre_msg_get_slv(req->rq_repmsg) == 0 || 
1079             lustre_msg_get_limit(req->rq_repmsg) == 0) {
1080                 DEBUG_REQ(D_HA, req, "Zero SLV or Limit found "
1081                           "(SLV: "LPU64", Limit: %u)", 
1082                           lustre_msg_get_slv(req->rq_repmsg), 
1083                           lustre_msg_get_limit(req->rq_repmsg));
1084                 RETURN(0);
1085         }
1086
1087         new_limit = lustre_msg_get_limit(req->rq_repmsg);
1088         new_slv = lustre_msg_get_slv(req->rq_repmsg);
1089         obd = req->rq_import->imp_obd;
1090
1091         /* 
1092          * Set new SLV and Limit to obd fields to make accessible for pool 
1093          * thread. We do not access obd_namespace and pool directly here
1094          * as there is no reliable way to make sure that they are still
1095          * alive in cleanup time. Evil races are possible which may cause
1096          * oops in that time. 
1097          */
1098         write_lock(&obd->obd_pool_lock);
1099         old_slv = obd->obd_pool_slv;
1100         obd->obd_pool_slv = new_slv;
1101         obd->obd_pool_limit = new_limit;
1102         write_unlock(&obd->obd_pool_lock);
1103
1104         RETURN(0);
1105 }
1106 EXPORT_SYMBOL(ldlm_cli_update_pool);
1107
1108 int ldlm_cli_cancel(struct lustre_handle *lockh)
1109 {
1110         struct obd_export *exp;
1111         int avail, flags, count = 1, rc = 0;
1112         struct ldlm_namespace *ns;
1113         struct ldlm_lock *lock;
1114         CFS_LIST_HEAD(cancels);
1115         ENTRY;
1116
1117         /* concurrent cancels on the same handle can happen */
1118         lock = __ldlm_handle2lock(lockh, LDLM_FL_CANCELING);
1119         if (lock == NULL) {
1120                 LDLM_DEBUG_NOLOCK("lock is already being destroyed\n");
1121                 RETURN(0);
1122         }
1123
1124         rc = ldlm_cli_cancel_local(lock);
1125         if (rc < 0 || rc == LDLM_FL_LOCAL_ONLY) {
1126                 LDLM_LOCK_PUT(lock);
1127                 RETURN(rc < 0 ? rc : 0);
1128         }
1129         /* Even if the lock is marked as LDLM_FL_BL_AST, this is a LDLM_CANCEL
1130          * rpc which goes to canceld portal, so we can cancel other lru locks
1131          * here and send them all as one LDLM_CANCEL rpc. */
1132         LASSERT(list_empty(&lock->l_bl_ast));
1133         list_add(&lock->l_bl_ast, &cancels);
1134
1135         exp = lock->l_conn_export;
1136         if (exp_connect_cancelset(exp)) {
1137                 avail = ldlm_format_handles_avail(class_exp2cliimp(exp),
1138                                                   &RQF_LDLM_CANCEL,
1139                                                   RCL_CLIENT, 0);
1140                 LASSERT(avail > 0);
1141
1142                 ns = lock->l_resource->lr_namespace;
1143                 flags = ns_connect_lru_resize(ns) ?
1144                         LDLM_CANCEL_LRUR : LDLM_CANCEL_AGED;
1145                 count += ldlm_cancel_lru_local(ns, &cancels, 0, avail - 1,
1146                                                LDLM_FL_BL_AST, flags);
1147         }
1148         ldlm_cli_cancel_list(&cancels, count, NULL, 0);
1149         RETURN(0);
1150 }
1151
1152 /* XXX until we will have compound requests and can cut cancels from generic rpc
1153  * we need send cancels with LDLM_FL_BL_AST flag as separate rpc */
1154 static int ldlm_cancel_list(struct list_head *cancels, int count, int flags)
1155 {
1156         CFS_LIST_HEAD(head);
1157         struct ldlm_lock *lock, *next;
1158         int left = 0, bl_ast = 0, rc;
1159
1160         left = count;
1161         list_for_each_entry_safe(lock, next, cancels, l_bl_ast) {
1162                 if (left-- == 0)
1163                         break;
1164
1165                 if (flags & LDLM_FL_LOCAL_ONLY) {
1166                         rc = LDLM_FL_LOCAL_ONLY;
1167                         ldlm_lock_cancel(lock);
1168                 } else {
1169                         rc = ldlm_cli_cancel_local(lock);
1170                 }
1171                 if (!(flags & LDLM_FL_BL_AST) && (rc == LDLM_FL_BL_AST)) {
1172                         LDLM_DEBUG(lock, "Cancel lock separately");
1173                         list_del_init(&lock->l_bl_ast);
1174                         list_add(&lock->l_bl_ast, &head);
1175                         bl_ast ++;
1176                         continue;
1177                 }
1178                 if (rc == LDLM_FL_LOCAL_ONLY) {
1179                         /* CANCEL RPC should not be sent to server. */
1180                         list_del_init(&lock->l_bl_ast);
1181                         LDLM_LOCK_PUT(lock);
1182                         count--;
1183                 }
1184
1185         }
1186         if (bl_ast > 0) {
1187                 count -= bl_ast;
1188                 ldlm_cli_cancel_list(&head, bl_ast, NULL, 0);
1189         }
1190
1191         RETURN(count);
1192 }
1193
1194 /** 
1195  * Callback function for shrink policy. Makes decision whether to keep
1196  * \a lock in LRU for current \a LRU size \a unused, added in current scan
1197  * \a added and number of locks to be preferably canceled \a count.
1198  *
1199  * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1200  *
1201  * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1202  */
1203 static ldlm_policy_res_t ldlm_cancel_shrink_policy(struct ldlm_namespace *ns,
1204                                                    struct ldlm_lock *lock,
1205                                                    int unused, int added, 
1206                                                    int count)
1207 {
1208         int lock_cost;
1209         __u64 page_nr;
1210
1211         /* 
1212          * Stop lru processing when we reached passed @count or checked all 
1213          * locks in lru. 
1214          */
1215         if (count && added >= count)
1216                 return LDLM_POLICY_KEEP_LOCK;
1217
1218         if (lock->l_resource->lr_type == LDLM_EXTENT) {
1219                 struct ldlm_extent *l_extent;
1220
1221                 /* 
1222                  * For all extent locks cost is 1 + number of pages in
1223                  * their extent. 
1224                  */
1225                 l_extent = &lock->l_policy_data.l_extent;
1226                 page_nr = (l_extent->end - l_extent->start);
1227                 do_div(page_nr, CFS_PAGE_SIZE);
1228
1229 #ifdef __KERNEL__
1230                 /* 
1231                  * XXX: In fact this is evil hack, we can't access inode
1232                  * here. For doing it right we need somehow to have number
1233                  * of covered by lock. This should be fixed later when 10718 
1234                  * is landed. 
1235                  */
1236                 if (lock->l_ast_data != NULL) {
1237                         struct inode *inode = lock->l_ast_data;
1238                         if (page_nr > inode->i_mapping->nrpages)
1239                                 page_nr = inode->i_mapping->nrpages;
1240                 }
1241 #endif
1242                 lock_cost = 1 + page_nr;
1243         } else {
1244                 /* 
1245                  * For all locks which are not extent ones cost is 1 
1246                  */
1247                 lock_cost = 1;
1248         }
1249
1250         /* 
1251          * Keep all expensive locks in lru for the memory pressure time
1252          * cancel policy. They anyways may be canceled by lru resize
1253          * pplicy if they have not small enough CLV. 
1254          */
1255         return lock_cost > ns->ns_shrink_thumb ? 
1256                 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1257 }
1258
1259 /**
1260  * Callback function for lru-resize policy. Makes decision whether to keep
1261  * \a lock in LRU for current \a LRU size \a unused, added in current scan
1262  * \a added and number of locks to be preferably canceled \a count.
1263  *
1264  * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1265  *
1266  * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1267  */
1268 static ldlm_policy_res_t ldlm_cancel_lrur_policy(struct ldlm_namespace *ns,
1269                                                  struct ldlm_lock *lock, 
1270                                                  int unused, int added, 
1271                                                  int count)
1272 {
1273         cfs_time_t cur = cfs_time_current();
1274         struct ldlm_pool *pl = &ns->ns_pool;
1275         __u64 slv, lvf, lv;
1276         cfs_time_t la;
1277
1278         /* 
1279          * Stop lru processing when we reached passed @count or checked all 
1280          * locks in lru.
1281          */
1282         if (count && added >= count)
1283                 return LDLM_POLICY_KEEP_LOCK;
1284
1285         slv = ldlm_pool_get_slv(pl);
1286         lvf = ldlm_pool_get_lvf(pl);
1287         la = cfs_duration_sec(cfs_time_sub(cur, 
1288                               lock->l_last_used));
1289
1290         /* 
1291          * Stop when slv is not yet come from server or lv is smaller than 
1292          * it is.
1293          */
1294         lv = lvf * la * unused;
1295         
1296         /* 
1297          * Inform pool about current CLV to see it via proc. 
1298          */
1299         ldlm_pool_set_clv(pl, lv);
1300         return (slv == 1 || lv < slv) ? 
1301                 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1302 }
1303
1304 /**
1305  * Callback function for proc used policy. Makes decision whether to keep
1306  * \a lock in LRU for current \a LRU size \a unused, added in current scan
1307  * \a added and number of locks to be preferably canceled \a count.
1308  *
1309  * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1310  *
1311  * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1312  */
1313 static ldlm_policy_res_t ldlm_cancel_passed_policy(struct ldlm_namespace *ns,
1314                                                    struct ldlm_lock *lock, 
1315                                                    int unused, int added,
1316                                                    int count)
1317 {
1318         /* 
1319          * Stop lru processing when we reached passed @count or checked all 
1320          * locks in lru. 
1321          */
1322         return (added >= count) ? 
1323                 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1324 }
1325
1326 /**
1327  * Callback function for aged policy. Makes decision whether to keep
1328  * \a lock in LRU for current \a LRU size \a unused, added in current scan
1329  * \a added and number of locks to be preferably canceled \a count.
1330  *
1331  * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1332  *
1333  * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1334  */
1335 static ldlm_policy_res_t ldlm_cancel_aged_policy(struct ldlm_namespace *ns,
1336                                                  struct ldlm_lock *lock, 
1337                                                  int unused, int added,
1338                                                  int count)
1339 {
1340         /* 
1341          * Stop lru processing if young lock is found and we reached passed 
1342          * @count. 
1343          */
1344         return ((added >= count) && 
1345                 cfs_time_before(cfs_time_current(),
1346                                 cfs_time_add(lock->l_last_used,
1347                                              ns->ns_max_age))) ? 
1348                 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1349 }
1350
1351 /**
1352  * Callback function for default policy. Makes decision whether to keep
1353  * \a lock in LRU for current \a LRU size \a unused, added in current scan
1354  * \a added and number of locks to be preferably canceled \a count.
1355  *
1356  * \retval LDLM_POLICY_KEEP_LOCK keep lock in LRU in stop scanning
1357  *
1358  * \retval LDLM_POLICY_CANCEL_LOCK cancel lock from LRU
1359  */
1360 static ldlm_policy_res_t ldlm_cancel_default_policy(struct ldlm_namespace *ns,
1361                                                     struct ldlm_lock *lock, 
1362                                                     int unused, int added,
1363                                                     int count)
1364 {
1365         /* 
1366          * Stop lru processing when we reached passed @count or checked all 
1367          * locks in lru. 
1368          */
1369         return (added >= count) ? 
1370                 LDLM_POLICY_KEEP_LOCK : LDLM_POLICY_CANCEL_LOCK;
1371 }
1372
1373 typedef ldlm_policy_res_t (*ldlm_cancel_lru_policy_t)(struct ldlm_namespace *, 
1374                                                       struct ldlm_lock *, int, 
1375                                                       int, int);
1376
1377 static ldlm_cancel_lru_policy_t
1378 ldlm_cancel_lru_policy(struct ldlm_namespace *ns, int flags)
1379 {
1380         if (ns_connect_lru_resize(ns)) {
1381                 if (flags & LDLM_CANCEL_SHRINK)
1382                         return ldlm_cancel_shrink_policy;
1383                 else if (flags & LDLM_CANCEL_LRUR)
1384                         return ldlm_cancel_lrur_policy;
1385                 else if (flags & LDLM_CANCEL_PASSED)
1386                         return ldlm_cancel_passed_policy;
1387         } else {
1388                 if (flags & LDLM_CANCEL_AGED)
1389                         return ldlm_cancel_aged_policy;
1390         }
1391         
1392         return ldlm_cancel_default_policy;
1393 }
1394  
1395 /* - Free space in lru for @count new locks,
1396  *   redundant unused locks are canceled locally;
1397  * - also cancel locally unused aged locks;
1398  * - do not cancel more than @max locks;
1399  * - GET the found locks and add them into the @cancels list.
1400  *
1401  * A client lock can be added to the l_bl_ast list only when it is
1402  * marked LDLM_FL_CANCELING. Otherwise, somebody is already doing CANCEL.
1403  * There are the following use cases: ldlm_cancel_resource_local(),
1404  * ldlm_cancel_lru_local() and ldlm_cli_cancel(), which check&set this
1405  * flag properly. As any attempt to cancel a lock rely on this flag,
1406  * l_bl_ast list is accessed later without any special locking.
1407  *
1408  * Calling policies for enabled lru resize:
1409  * ----------------------------------------
1410  * flags & LDLM_CANCEL_LRUR - use lru resize policy (SLV from server) to
1411  *                            cancel not more than @count locks;
1412  *
1413  * flags & LDLM_CANCEL_PASSED - cancel @count number of old locks (located at
1414  *                              the beginning of lru list);
1415  *
1416  * flags & LDLM_CANCEL_SHRINK - cancel not more than @count locks according to
1417  *                              memory pressre policy function;
1418  *
1419  * flags & LDLM_CANCEL_AGED -   cancel alocks according to "aged policy".
1420  */
1421 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, struct list_head *cancels,
1422                           int count, int max, int cancel_flags, int flags)
1423 {
1424         ldlm_cancel_lru_policy_t pf;
1425         struct ldlm_lock *lock, *next;
1426         int added = 0, unused;
1427         ENTRY;
1428
1429         spin_lock(&ns->ns_unused_lock);
1430         unused = ns->ns_nr_unused;
1431
1432         if (!ns_connect_lru_resize(ns))
1433                 count += unused - ns->ns_max_unused;
1434
1435         pf = ldlm_cancel_lru_policy(ns, flags);
1436         LASSERT(pf != NULL);
1437         
1438         while (!list_empty(&ns->ns_unused_list)) {
1439                 /* For any flags, stop scanning if @max is reached. */
1440                 if (max && added >= max)
1441                         break;
1442
1443                 list_for_each_entry_safe(lock, next, &ns->ns_unused_list, l_lru){
1444                         /* No locks which got blocking requests. */
1445                         LASSERT(!(lock->l_flags & LDLM_FL_BL_AST));
1446
1447                         /* Somebody is already doing CANCEL. No need in this
1448                          * lock in lru, do not traverse it again. */
1449                         if (!(lock->l_flags & LDLM_FL_CANCELING))
1450                                 break;
1451
1452                         ldlm_lock_remove_from_lru_nolock(lock);
1453                 }
1454                 if (&lock->l_lru == &ns->ns_unused_list)
1455                         break;
1456
1457                 /* Pass the lock through the policy filter and see if it
1458                  * should stay in lru.
1459                  *
1460                  * Even for shrinker policy we stop scanning if
1461                  * we find a lock that should stay in the cache.
1462                  * We should take into account lock age anyway
1463                  * as new lock even if it is small of weight is
1464                  * valuable resource. 
1465                  *
1466                  * That is, for shrinker policy we drop only
1467                  * old locks, but additionally chose them by
1468                  * their weight. Big extent locks will stay in 
1469                  * the cache. */
1470                 if (pf(ns, lock, unused, added, count) == LDLM_POLICY_KEEP_LOCK)
1471                         break;
1472
1473                 LDLM_LOCK_GET(lock); /* dropped by bl thread */
1474                 spin_unlock(&ns->ns_unused_lock);
1475
1476                 lock_res_and_lock(lock);
1477                 /* Check flags again under the lock. */
1478                 if ((lock->l_flags & LDLM_FL_CANCELING) ||
1479                     (ldlm_lock_remove_from_lru(lock) == 0)) {
1480                         /* other thread is removing lock from lru or
1481                          * somebody is already doing CANCEL or
1482                          * there is a blocking request which will send
1483                          * cancel by itseft or the lock is matched
1484                          * is already not unused. */
1485                         unlock_res_and_lock(lock);
1486                         LDLM_LOCK_PUT(lock);
1487                         spin_lock(&ns->ns_unused_lock);
1488                         continue;
1489                 }
1490                 LASSERT(!lock->l_readers && !lock->l_writers);
1491
1492                 /* If we have chosen to cancel this lock voluntarily, we
1493                  * better send cancel notification to server, so that it
1494                  * frees appropriate state. This might lead to a race 
1495                  * where while we are doing cancel here, server is also 
1496                  * silently cancelling this lock. */
1497                 lock->l_flags &= ~LDLM_FL_CANCEL_ON_BLOCK;
1498
1499                 /* Setting the CBPENDING flag is a little misleading,
1500                  * but prevents an important race; namely, once
1501                  * CBPENDING is set, the lock can accumulate no more
1502                  * readers/writers. Since readers and writers are
1503                  * already zero here, ldlm_lock_decref() won't see
1504                  * this flag and call l_blocking_ast */
1505                 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING;
1506
1507                 /* We can't re-add to l_lru as it confuses the
1508                  * refcounting in ldlm_lock_remove_from_lru() if an AST
1509                  * arrives after we drop ns_lock below. We use l_bl_ast
1510                  * and can't use l_pending_chain as it is used both on
1511                  * server and client nevertheless bug 5666 says it is
1512                  * used only on server */
1513                 LASSERT(list_empty(&lock->l_bl_ast));
1514                 list_add(&lock->l_bl_ast, cancels);
1515                 unlock_res_and_lock(lock);
1516                 spin_lock(&ns->ns_unused_lock);
1517                 added++;
1518                 unused--;
1519         }
1520         spin_unlock(&ns->ns_unused_lock);
1521         RETURN(ldlm_cancel_list(cancels, added, cancel_flags));
1522 }
1523
1524 /* Returns number of locks which could be canceled next time when 
1525  * ldlm_cancel_lru() is called. Used from locks pool shrinker. */
1526 int ldlm_cancel_lru_estimate(struct ldlm_namespace *ns,
1527                              int count, int max, int flags)
1528 {
1529         ldlm_cancel_lru_policy_t pf;
1530         struct ldlm_lock *lock;
1531         int added = 0, unused;
1532         ENTRY;
1533
1534         pf = ldlm_cancel_lru_policy(ns, flags);
1535         LASSERT(pf != NULL);
1536         spin_lock(&ns->ns_unused_lock);
1537         unused = ns->ns_nr_unused;
1538
1539         list_for_each_entry(lock, &ns->ns_unused_list, l_lru) {
1540                 /* For any flags, stop scanning if @max is reached. */
1541                 if (max && added >= max)
1542                         break;
1543
1544                 /* Somebody is already doing CANCEL or there is a
1545                  * blocking request will send cancel. Let's not count 
1546                  * this lock. */
1547                 if ((lock->l_flags & LDLM_FL_CANCELING) ||
1548                     (lock->l_flags & LDLM_FL_BL_AST)) 
1549                         continue;
1550
1551                 /* Pass the lock through the policy filter and see if it
1552                  * should stay in lru. */
1553                 if (pf(ns, lock, unused, added, count) == LDLM_POLICY_KEEP_LOCK)
1554                         break;
1555
1556                 added++;
1557                 unused--;
1558         }
1559         spin_unlock(&ns->ns_unused_lock);
1560         RETURN(added);
1561 }
1562
1563 /* when called with LDLM_ASYNC the blocking callback will be handled
1564  * in a thread and this function will return after the thread has been
1565  * asked to call the callback.  when called with LDLM_SYNC the blocking
1566  * callback will be performed in this function. */
1567 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync, 
1568                     int flags)
1569 {
1570         CFS_LIST_HEAD(cancels);
1571         int count, rc;
1572         ENTRY;
1573
1574 #ifndef __KERNEL__
1575         sync = LDLM_SYNC; /* force to be sync in user space */
1576 #endif
1577         count = ldlm_cancel_lru_local(ns, &cancels, nr, 0, 0, flags);
1578         if (sync == LDLM_ASYNC) {
1579                 rc = ldlm_bl_to_thread_list(ns, NULL, &cancels, count);
1580                 if (rc == 0)
1581                         RETURN(count);
1582         }
1583
1584         /* If an error occured in ASYNC mode, or
1585          * this is SYNC mode, cancel the list. */
1586         ldlm_cli_cancel_list(&cancels, count, NULL, 0);
1587         RETURN(count);
1588 }
1589
1590 /* Find and cancel locally unused locks found on resource, matched to the
1591  * given policy, mode. GET the found locks and add them into the @cancels
1592  * list. */
1593 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1594                                struct list_head *cancels,
1595                                ldlm_policy_data_t *policy,
1596                                ldlm_mode_t mode, int lock_flags,
1597                                int cancel_flags, void *opaque)
1598 {
1599         struct ldlm_lock *lock;
1600         int count = 0;
1601         ENTRY;
1602
1603         lock_res(res);
1604         list_for_each_entry(lock, &res->lr_granted, l_res_link) {
1605                 if (opaque != NULL && lock->l_ast_data != opaque) {
1606                         LDLM_ERROR(lock, "data %p doesn't match opaque %p",
1607                                    lock->l_ast_data, opaque);
1608                         //LBUG();
1609                         continue;
1610                 }
1611
1612                 if (lock->l_readers || lock->l_writers) {
1613                         if (cancel_flags & LDLM_FL_WARN) {
1614                                 LDLM_ERROR(lock, "lock in use");
1615                                 //LBUG();
1616                         }
1617                         continue;
1618                 }
1619
1620                 /* If somebody is already doing CANCEL, or blocking ast came,
1621                  * skip this lock. */
1622                 if (lock->l_flags & LDLM_FL_BL_AST || 
1623                     lock->l_flags & LDLM_FL_CANCELING)
1624                         continue;
1625
1626                 if (lockmode_compat(lock->l_granted_mode, mode))
1627                         continue;
1628
1629                 /* If policy is given and this is IBITS lock, add to list only
1630                  * those locks that match by policy. */
1631                 if (policy && (lock->l_resource->lr_type == LDLM_IBITS) &&
1632                     !(lock->l_policy_data.l_inodebits.bits &
1633                       policy->l_inodebits.bits))
1634                         continue;
1635
1636                 /* See CBPENDING comment in ldlm_cancel_lru */
1637                 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_CANCELING |
1638                                  lock_flags;
1639
1640                 LASSERT(list_empty(&lock->l_bl_ast));
1641                 list_add(&lock->l_bl_ast, cancels);
1642                 LDLM_LOCK_GET(lock);
1643                 count++;
1644         }
1645         unlock_res(res);
1646
1647         RETURN(ldlm_cancel_list(cancels, count, cancel_flags));
1648 }
1649
1650 /* If @req is NULL, send CANCEL request to server with handles of locks 
1651  * in the @cancels. If EARLY_CANCEL is not supported, send CANCEL requests 
1652  * separately per lock.
1653  * If @req is not NULL, put handles of locks in @cancels into the request 
1654  * buffer at the offset @off.
1655  * Destroy @cancels at the end. */
1656 int ldlm_cli_cancel_list(struct list_head *cancels, int count,
1657                          struct ptlrpc_request *req, int flags)
1658 {
1659         struct ldlm_lock *lock;
1660         int res = 0;
1661         ENTRY;
1662
1663         if (list_empty(cancels) || count == 0)
1664                 RETURN(0);
1665         
1666         /* XXX: requests (both batched and not) could be sent in parallel. 
1667          * Usually it is enough to have just 1 RPC, but it is possible that
1668          * there are to many locks to be cancelled in LRU or on a resource.
1669          * It would also speed up the case when the server does not support
1670          * the feature. */
1671         while (count > 0) {
1672                 LASSERT(!list_empty(cancels));
1673                 lock = list_entry(cancels->next, struct ldlm_lock, l_bl_ast);
1674                 LASSERT(lock->l_conn_export);
1675
1676                 if (exp_connect_cancelset(lock->l_conn_export)) {
1677                         res = count;
1678                         if (req)
1679                                 ldlm_cancel_pack(req, cancels, count);
1680                         else
1681                                 res = ldlm_cli_cancel_req(lock->l_conn_export,
1682                                                           cancels, count,
1683                                                           flags);
1684                 } else {
1685                         res = ldlm_cli_cancel_req(lock->l_conn_export,
1686                                                   cancels, 1, flags);
1687                 }
1688
1689                 if (res < 0) {
1690                         CERROR("ldlm_cli_cancel_list: %d\n", res);
1691                         res = count;
1692                 }
1693
1694                 count -= res;
1695                 ldlm_lock_list_put(cancels, l_bl_ast, res);
1696         }
1697         LASSERT(count == 0);
1698         RETURN(0);
1699 }
1700
1701 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1702                                     const struct ldlm_res_id *res_id,
1703                                     ldlm_policy_data_t *policy,
1704                                     ldlm_mode_t mode, int flags, void *opaque)
1705 {
1706         struct ldlm_resource *res;
1707         CFS_LIST_HEAD(cancels);
1708         int count;
1709         int rc;
1710         ENTRY;
1711
1712         res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1713         if (res == NULL) {
1714                 /* This is not a problem. */
1715                 CDEBUG(D_INFO, "No resource "LPU64"\n", res_id->name[0]);
1716                 RETURN(0);
1717         }
1718
1719         count = ldlm_cancel_resource_local(res, &cancels, policy, mode,
1720                                            0, flags, opaque);
1721         rc = ldlm_cli_cancel_list(&cancels, count, NULL, flags);
1722         if (rc != ELDLM_OK)
1723                 CERROR("ldlm_cli_cancel_unused_resource: %d\n", rc);
1724
1725         ldlm_resource_putref(res);
1726         RETURN(0);
1727 }
1728
1729 static inline int have_no_nsresource(struct ldlm_namespace *ns)
1730 {
1731         int no_resource = 0;
1732
1733         spin_lock(&ns->ns_hash_lock);
1734         if (ns->ns_resources == 0)
1735                 no_resource = 1;
1736         spin_unlock(&ns->ns_hash_lock);
1737
1738         RETURN(no_resource);
1739 }
1740
1741 /* Cancel all locks on a namespace (or a specific resource, if given)
1742  * that have 0 readers/writers.
1743  *
1744  * If flags & LDLM_FL_LOCAL_ONLY, throw the locks away without trying
1745  * to notify the server. */
1746 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns,
1747                            const struct ldlm_res_id *res_id,
1748                            int flags, void *opaque)
1749 {
1750         int i;
1751         ENTRY;
1752
1753         if (ns == NULL)
1754                 RETURN(ELDLM_OK);
1755
1756         if (res_id)
1757                 RETURN(ldlm_cli_cancel_unused_resource(ns, res_id, NULL,
1758                                                        LCK_MINMODE, flags,
1759                                                        opaque));
1760
1761         spin_lock(&ns->ns_hash_lock);
1762         for (i = 0; i < RES_HASH_SIZE; i++) {
1763                 struct list_head *tmp;
1764                 tmp = ns->ns_hash[i].next;
1765                 while (tmp != &(ns->ns_hash[i])) {
1766                         struct ldlm_resource *res;
1767                         int rc;
1768
1769                         res = list_entry(tmp, struct ldlm_resource, lr_hash);
1770                         ldlm_resource_getref(res);
1771                         spin_unlock(&ns->ns_hash_lock);
1772
1773                         rc = ldlm_cli_cancel_unused_resource(ns, &res->lr_name,
1774                                                              NULL, LCK_MINMODE,
1775                                                              flags, opaque);
1776
1777                         if (rc)
1778                                 CERROR("ldlm_cli_cancel_unused ("LPU64"): %d\n",
1779                                        res->lr_name.name[0], rc);
1780
1781                         spin_lock(&ns->ns_hash_lock);
1782                         tmp = tmp->next;
1783                         ldlm_resource_putref_locked(res);
1784                 }
1785         }
1786         spin_unlock(&ns->ns_hash_lock);
1787
1788         RETURN(ELDLM_OK);
1789 }
1790
1791 /* join/split resource locks to/from lru list */
1792 int ldlm_cli_join_lru(struct ldlm_namespace *ns,
1793                       const struct ldlm_res_id *res_id, int join)
1794 {
1795         struct ldlm_resource *res;
1796         struct ldlm_lock *lock, *n;
1797         int count = 0;
1798         ENTRY;
1799
1800         LASSERT(ns_is_client(ns));
1801
1802         res = ldlm_resource_get(ns, NULL, res_id, LDLM_EXTENT, 0);
1803         if (res == NULL)
1804                 RETURN(count);
1805         LASSERT(res->lr_type == LDLM_EXTENT);
1806
1807         lock_res(res);
1808         if (!join)
1809                 goto split;
1810
1811         list_for_each_entry_safe (lock, n, &res->lr_granted, l_res_link) {
1812                 if (list_empty(&lock->l_lru) &&
1813                     !lock->l_readers && !lock->l_writers &&
1814                     !(lock->l_flags & LDLM_FL_LOCAL) &&
1815                     !(lock->l_flags & LDLM_FL_CBPENDING) &&
1816                     !(lock->l_flags & LDLM_FL_BL_AST)) {
1817                         ldlm_lock_add_to_lru(lock);
1818                         lock->l_flags &= ~LDLM_FL_NO_LRU;
1819                         LDLM_DEBUG(lock, "join lock to lru");
1820                         count++;
1821                 }
1822         }
1823         goto unlock;
1824 split:
1825         spin_lock(&ns->ns_unused_lock);
1826         list_for_each_entry_safe (lock, n, &ns->ns_unused_list, l_lru) {
1827                 if (lock->l_resource == res) {
1828                         ldlm_lock_remove_from_lru_nolock(lock);
1829                         lock->l_flags |= LDLM_FL_NO_LRU;
1830                         LDLM_DEBUG(lock, "split lock from lru");
1831                         count++;
1832                 }
1833         }
1834         spin_unlock(&ns->ns_unused_lock);
1835 unlock:
1836         unlock_res(res);
1837         ldlm_resource_putref(res);
1838         RETURN(count);
1839 }
1840
1841 /* Lock iterators. */
1842
1843 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1844                           void *closure)
1845 {
1846         struct list_head *tmp, *next;
1847         struct ldlm_lock *lock;
1848         int rc = LDLM_ITER_CONTINUE;
1849
1850         ENTRY;
1851
1852         if (!res)
1853                 RETURN(LDLM_ITER_CONTINUE);
1854
1855         lock_res(res);
1856         list_for_each_safe(tmp, next, &res->lr_granted) {
1857                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
1858
1859                 if (iter(lock, closure) == LDLM_ITER_STOP)
1860                         GOTO(out, rc = LDLM_ITER_STOP);
1861         }
1862
1863         list_for_each_safe(tmp, next, &res->lr_converting) {
1864                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
1865
1866                 if (iter(lock, closure) == LDLM_ITER_STOP)
1867                         GOTO(out, rc = LDLM_ITER_STOP);
1868         }
1869
1870         list_for_each_safe(tmp, next, &res->lr_waiting) {
1871                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
1872
1873                 if (iter(lock, closure) == LDLM_ITER_STOP)
1874                         GOTO(out, rc = LDLM_ITER_STOP);
1875         }
1876  out:
1877         unlock_res(res);
1878         RETURN(rc);
1879 }
1880
1881 struct iter_helper_data {
1882         ldlm_iterator_t iter;
1883         void *closure;
1884 };
1885
1886 static int ldlm_iter_helper(struct ldlm_lock *lock, void *closure)
1887 {
1888         struct iter_helper_data *helper = closure;
1889         return helper->iter(lock, helper->closure);
1890 }
1891
1892 static int ldlm_res_iter_helper(struct ldlm_resource *res, void *closure)
1893 {
1894         return ldlm_resource_foreach(res, ldlm_iter_helper, closure);
1895 }
1896
1897 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1898                            void *closure)
1899 {
1900         struct iter_helper_data helper = { iter: iter, closure: closure };
1901         return ldlm_namespace_foreach_res(ns, ldlm_res_iter_helper, &helper);
1902 }
1903
1904 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
1905                                ldlm_res_iterator_t iter, void *closure)
1906 {
1907         int i, rc = LDLM_ITER_CONTINUE;
1908         struct ldlm_resource *res;
1909         struct list_head *tmp;
1910
1911         ENTRY;
1912         spin_lock(&ns->ns_hash_lock);
1913         for (i = 0; i < RES_HASH_SIZE; i++) {
1914                 tmp = ns->ns_hash[i].next;
1915                 while (tmp != &(ns->ns_hash[i])) {
1916                         res = list_entry(tmp, struct ldlm_resource, lr_hash);
1917                         ldlm_resource_getref(res);
1918                         spin_unlock(&ns->ns_hash_lock);
1919
1920                         rc = iter(res, closure);
1921
1922                         spin_lock(&ns->ns_hash_lock);
1923                         tmp = tmp->next;
1924                         ldlm_resource_putref_locked(res);
1925                         if (rc == LDLM_ITER_STOP)
1926                                 GOTO(out, rc);
1927                 }
1928         }
1929  out:
1930         spin_unlock(&ns->ns_hash_lock);
1931         RETURN(rc);
1932 }
1933
1934 /* non-blocking function to manipulate a lock whose cb_data is being put away.*/
1935 void ldlm_resource_iterate(struct ldlm_namespace *ns,
1936                            const struct ldlm_res_id *res_id,
1937                            ldlm_iterator_t iter, void *data)
1938 {
1939         struct ldlm_resource *res;
1940         ENTRY;
1941
1942         if (ns == NULL) {
1943                 CERROR("must pass in namespace\n");
1944                 LBUG();
1945         }
1946
1947         res = ldlm_resource_get(ns, NULL, res_id, 0, 0);
1948         if (res == NULL) {
1949                 EXIT;
1950                 return;
1951         }
1952
1953         ldlm_resource_foreach(res, iter, data);
1954         ldlm_resource_putref(res);
1955         EXIT;
1956 }
1957
1958 /* Lock replay */
1959
1960 static int ldlm_chain_lock_for_replay(struct ldlm_lock *lock, void *closure)
1961 {
1962         struct list_head *list = closure;
1963
1964         /* we use l_pending_chain here, because it's unused on clients. */
1965         LASSERTF(list_empty(&lock->l_pending_chain),"lock %p next %p prev %p\n",
1966                  lock, &lock->l_pending_chain.next,&lock->l_pending_chain.prev);
1967         /* bug 9573: don't replay locks left after eviction */
1968         if (!(lock->l_flags & LDLM_FL_FAILED))
1969                 list_add(&lock->l_pending_chain, list);
1970         return LDLM_ITER_CONTINUE;
1971 }
1972
1973 static int replay_lock_interpret(struct ptlrpc_request *req,
1974                                  struct ldlm_async_args *aa, int rc)
1975 {
1976         struct ldlm_lock  *lock;
1977         struct ldlm_reply *reply;
1978
1979         ENTRY;
1980         atomic_dec(&req->rq_import->imp_replay_inflight);
1981         if (rc != ELDLM_OK)
1982                 GOTO(out, rc);
1983
1984
1985         reply = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
1986         if (reply == NULL)
1987                 GOTO(out, rc = -EPROTO);
1988
1989         lock = ldlm_handle2lock(&aa->lock_handle);
1990         if (!lock) {
1991                 CERROR("received replay ack for unknown local cookie "LPX64
1992                        " remote cookie "LPX64 " from server %s id %s\n",
1993                        aa->lock_handle.cookie, reply->lock_handle.cookie,
1994                        req->rq_export->exp_client_uuid.uuid,
1995                        libcfs_id2str(req->rq_peer));
1996                 GOTO(out, rc = -ESTALE);
1997         }
1998
1999         lock->l_remote_handle = reply->lock_handle;
2000         LDLM_DEBUG(lock, "replayed lock:");
2001         ptlrpc_import_recovery_state_machine(req->rq_import);
2002         LDLM_LOCK_PUT(lock);
2003 out:
2004         if (rc != ELDLM_OK)
2005                 ptlrpc_connect_import(req->rq_import, NULL);
2006
2007
2008         RETURN(rc);
2009 }
2010
2011 static int replay_one_lock(struct obd_import *imp, struct ldlm_lock *lock)
2012 {
2013         struct ptlrpc_request *req;
2014         struct ldlm_async_args *aa;
2015         struct ldlm_request   *body;
2016         int flags;
2017         ENTRY;
2018
2019
2020         /* Bug 11974: Do not replay a lock which is actively being canceled */
2021         if (lock->l_flags & LDLM_FL_CANCELING) {
2022                 LDLM_DEBUG(lock, "Not replaying canceled lock:");
2023                 RETURN(0);
2024         }
2025
2026         /* If this is reply-less callback lock, we cannot replay it, since
2027          * server might have long dropped it, but notification of that event was
2028          * lost by network. (and server granted conflicting lock already) */
2029         if (lock->l_flags & LDLM_FL_CANCEL_ON_BLOCK) {
2030                 LDLM_DEBUG(lock, "Not replaying reply-less lock:");
2031                 ldlm_lock_cancel(lock);
2032                 RETURN(0);
2033         }
2034         /*
2035          * If granted mode matches the requested mode, this lock is granted.
2036          *
2037          * If they differ, but we have a granted mode, then we were granted
2038          * one mode and now want another: ergo, converting.
2039          *
2040          * If we haven't been granted anything and are on a resource list,
2041          * then we're blocked/waiting.
2042          *
2043          * If we haven't been granted anything and we're NOT on a resource list,
2044          * then we haven't got a reply yet and don't have a known disposition.
2045          * This happens whenever a lock enqueue is the request that triggers
2046          * recovery.
2047          */
2048         if (lock->l_granted_mode == lock->l_req_mode)
2049                 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_GRANTED;
2050         else if (lock->l_granted_mode)
2051                 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_CONV;
2052         else if (!list_empty(&lock->l_res_link))
2053                 flags = LDLM_FL_REPLAY | LDLM_FL_BLOCK_WAIT;
2054         else
2055                 flags = LDLM_FL_REPLAY;
2056
2057         req = ptlrpc_request_alloc_pack(imp, &RQF_LDLM_ENQUEUE,
2058                                         LUSTRE_DLM_VERSION, LDLM_ENQUEUE);
2059         if (req == NULL)
2060                 RETURN(-ENOMEM);
2061
2062         /* We're part of recovery, so don't wait for it. */
2063         req->rq_send_state = LUSTRE_IMP_REPLAY_LOCKS;
2064
2065         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2066         ldlm_lock2desc(lock, &body->lock_desc);
2067         body->lock_flags = flags;
2068
2069         ldlm_lock2handle(lock, &body->lock_handle[0]);
2070         if (lock->l_lvb_len != 0) {
2071                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_ENQUEUE_LVB);
2072                 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
2073                                      lock->l_lvb_len);
2074         }
2075         ptlrpc_request_set_replen(req);
2076         /* notify the server we've replayed all requests.
2077          * also, we mark the request to be put on a dedicated
2078          * queue to be processed after all request replayes.
2079          * bug 6063 */
2080         lustre_msg_set_flags(req->rq_reqmsg, MSG_REQ_REPLAY_DONE);
2081
2082         LDLM_DEBUG(lock, "replaying lock:");
2083
2084         atomic_inc(&req->rq_import->imp_replay_inflight);
2085         CLASSERT(sizeof(*aa) <= sizeof(req->rq_async_args));
2086         aa = ptlrpc_req_async_args(req);
2087         aa->lock_handle = body->lock_handle[0];
2088         req->rq_interpret_reply = replay_lock_interpret;
2089         ptlrpcd_add_req(req);
2090
2091         RETURN(0);
2092 }
2093
2094 int ldlm_replay_locks(struct obd_import *imp)
2095 {
2096         struct ldlm_namespace *ns = imp->imp_obd->obd_namespace;
2097         CFS_LIST_HEAD(list);
2098         struct ldlm_lock *lock, *next;
2099         int rc = 0;
2100
2101         ENTRY;
2102
2103         LASSERT(atomic_read(&imp->imp_replay_inflight) == 0);
2104
2105         /* ensure this doesn't fall to 0 before all have been queued */
2106         atomic_inc(&imp->imp_replay_inflight);
2107
2108         (void)ldlm_namespace_foreach(ns, ldlm_chain_lock_for_replay, &list);
2109
2110         list_for_each_entry_safe(lock, next, &list, l_pending_chain) {
2111                 list_del_init(&lock->l_pending_chain);
2112                 if (rc)
2113                         continue; /* or try to do the rest? */
2114                 rc = replay_one_lock(imp, lock);
2115         }
2116
2117         atomic_dec(&imp->imp_replay_inflight);
2118
2119         RETURN(rc);
2120 }