Whamcloud - gitweb
LU-11719 ldlm: Adjust search_* functions
[fs/lustre-release.git] / lustre / ldlm / ldlm_lock.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2010, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  *
32  * lustre/ldlm/ldlm_lock.c
33  *
34  * Author: Peter Braam <braam@clusterfs.com>
35  * Author: Phil Schwan <phil@clusterfs.com>
36  */
37
38 #define DEBUG_SUBSYSTEM S_LDLM
39
40 #include <libcfs/libcfs.h>
41
42 #include <lustre_swab.h>
43 #include <obd_class.h>
44
45 #include "ldlm_internal.h"
46
47 struct kmem_cache *ldlm_glimpse_work_kmem;
48 EXPORT_SYMBOL(ldlm_glimpse_work_kmem);
49
50 /* lock types */
51 char *ldlm_lockname[] = {
52         [0] = "--",
53         [LCK_EX] = "EX",
54         [LCK_PW] = "PW",
55         [LCK_PR] = "PR",
56         [LCK_CW] = "CW",
57         [LCK_CR] = "CR",
58         [LCK_NL] = "NL",
59         [LCK_GROUP] = "GROUP",
60         [LCK_COS] = "COS"
61 };
62 EXPORT_SYMBOL(ldlm_lockname);
63
64 char *ldlm_typename[] = {
65         [LDLM_PLAIN] = "PLN",
66         [LDLM_EXTENT] = "EXT",
67         [LDLM_FLOCK] = "FLK",
68         [LDLM_IBITS] = "IBT",
69 };
70
71 static ldlm_policy_wire_to_local_t ldlm_policy_wire_to_local[] = {
72         [LDLM_PLAIN - LDLM_MIN_TYPE]  = ldlm_plain_policy_wire_to_local,
73         [LDLM_EXTENT - LDLM_MIN_TYPE] = ldlm_extent_policy_wire_to_local,
74         [LDLM_FLOCK - LDLM_MIN_TYPE]  = ldlm_flock_policy_wire_to_local,
75         [LDLM_IBITS - LDLM_MIN_TYPE]  = ldlm_ibits_policy_wire_to_local,
76 };
77
78 static ldlm_policy_local_to_wire_t ldlm_policy_local_to_wire[] = {
79         [LDLM_PLAIN - LDLM_MIN_TYPE]  = ldlm_plain_policy_local_to_wire,
80         [LDLM_EXTENT - LDLM_MIN_TYPE] = ldlm_extent_policy_local_to_wire,
81         [LDLM_FLOCK - LDLM_MIN_TYPE]  = ldlm_flock_policy_local_to_wire,
82         [LDLM_IBITS - LDLM_MIN_TYPE]  = ldlm_ibits_policy_local_to_wire,
83 };
84
85 /**
86  * Converts lock policy from local format to on the wire lock_desc format
87  */
88 void ldlm_convert_policy_to_wire(enum ldlm_type type,
89                                  const union ldlm_policy_data *lpolicy,
90                                  union ldlm_wire_policy_data *wpolicy)
91 {
92         ldlm_policy_local_to_wire_t convert;
93
94         convert = ldlm_policy_local_to_wire[type - LDLM_MIN_TYPE];
95
96         convert(lpolicy, wpolicy);
97 }
98
99 /**
100  * Converts lock policy from on the wire lock_desc format to local format
101  */
102 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
103                                   const union ldlm_wire_policy_data *wpolicy,
104                                   union ldlm_policy_data *lpolicy)
105 {
106         ldlm_policy_wire_to_local_t convert;
107
108         convert = ldlm_policy_wire_to_local[type - LDLM_MIN_TYPE];
109
110         convert(wpolicy, lpolicy);
111 }
112
113 const char *ldlm_it2str(enum ldlm_intent_flags it)
114 {
115         switch (it) {
116         case IT_OPEN:
117                 return "open";
118         case IT_CREAT:
119                 return "creat";
120         case (IT_OPEN | IT_CREAT):
121                 return "open|creat";
122         case IT_READDIR:
123                 return "readdir";
124         case IT_GETATTR:
125                 return "getattr";
126         case IT_LOOKUP:
127                 return "lookup";
128         case IT_GETXATTR:
129                 return "getxattr";
130         case IT_LAYOUT:
131                 return "layout";
132         default:
133                 CERROR("Unknown intent 0x%08x\n", it);
134                 return "UNKNOWN";
135         }
136 }
137 EXPORT_SYMBOL(ldlm_it2str);
138
139 extern struct kmem_cache *ldlm_lock_slab;
140
141 #ifdef HAVE_SERVER_SUPPORT
142 static ldlm_processing_policy ldlm_processing_policy_table[] = {
143         [LDLM_PLAIN]    = ldlm_process_plain_lock,
144         [LDLM_EXTENT]   = ldlm_process_extent_lock,
145         [LDLM_FLOCK]    = ldlm_process_flock_lock,
146         [LDLM_IBITS]    = ldlm_process_inodebits_lock,
147 };
148
149 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res)
150 {
151         return ldlm_processing_policy_table[res->lr_type];
152 }
153 EXPORT_SYMBOL(ldlm_get_processing_policy);
154 #endif /* HAVE_SERVER_SUPPORT */
155
156 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg)
157 {
158         ns->ns_policy = arg;
159 }
160 EXPORT_SYMBOL(ldlm_register_intent);
161
162 /*
163  * REFCOUNTED LOCK OBJECTS
164  */
165
166
167 /**
168  * Get a reference on a lock.
169  *
170  * Lock refcounts, during creation:
171  *   - one special one for allocation, dec'd only once in destroy
172  *   - one for being a lock that's in-use
173  *   - one for the addref associated with a new lock
174  */
175 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock)
176 {
177         atomic_inc(&lock->l_refc);
178         return lock;
179 }
180 EXPORT_SYMBOL(ldlm_lock_get);
181
182 /**
183  * Release lock reference.
184  *
185  * Also frees the lock if it was last reference.
186  */
187 void ldlm_lock_put(struct ldlm_lock *lock)
188 {
189         ENTRY;
190
191         LASSERT(lock->l_resource != LP_POISON);
192         LASSERT(atomic_read(&lock->l_refc) > 0);
193         if (atomic_dec_and_test(&lock->l_refc)) {
194                 struct ldlm_resource *res;
195
196                 LDLM_DEBUG(lock,
197                            "final lock_put on destroyed lock, freeing it.");
198
199                 res = lock->l_resource;
200                 LASSERT(ldlm_is_destroyed(lock));
201                 LASSERT(list_empty(&lock->l_exp_list));
202                 LASSERT(list_empty(&lock->l_res_link));
203                 LASSERT(list_empty(&lock->l_pending_chain));
204
205                 lprocfs_counter_decr(ldlm_res_to_ns(res)->ns_stats,
206                                      LDLM_NSS_LOCKS);
207                 lu_ref_del(&res->lr_reference, "lock", lock);
208                 ldlm_resource_putref(res);
209                 lock->l_resource = NULL;
210                 if (lock->l_export) {
211                         class_export_lock_put(lock->l_export, lock);
212                         lock->l_export = NULL;
213                 }
214
215                 if (lock->l_lvb_data != NULL)
216                         OBD_FREE_LARGE(lock->l_lvb_data, lock->l_lvb_len);
217
218                 ldlm_interval_free(ldlm_interval_detach(lock));
219                 lu_ref_fini(&lock->l_reference);
220                 OBD_FREE_RCU(lock, sizeof(*lock), &lock->l_handle);
221         }
222
223         EXIT;
224 }
225 EXPORT_SYMBOL(ldlm_lock_put);
226
227 /**
228  * Removes LDLM lock \a lock from LRU. Assumes LRU is already locked.
229  */
230 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock)
231 {
232         int rc = 0;
233         if (!list_empty(&lock->l_lru)) {
234                 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
235
236                 LASSERT(lock->l_resource->lr_type != LDLM_FLOCK);
237                 if (ns->ns_last_pos == &lock->l_lru)
238                         ns->ns_last_pos = lock->l_lru.prev;
239                 list_del_init(&lock->l_lru);
240                 LASSERT(ns->ns_nr_unused > 0);
241                 ns->ns_nr_unused--;
242                 rc = 1;
243         }
244         return rc;
245 }
246
247 /**
248  * Removes LDLM lock \a lock from LRU. Obtains the LRU lock first.
249  *
250  * If \a last_use is non-zero, it will remove the lock from LRU only if
251  * it matches lock's l_last_used.
252  *
253  * \retval 0 if \a last_use is set, the lock is not in LRU list or \a last_use
254  *           doesn't match lock's l_last_used;
255  *           otherwise, the lock hasn't been in the LRU list.
256  * \retval 1 the lock was in LRU list and removed.
257  */
258 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use)
259 {
260         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
261         int rc = 0;
262
263         ENTRY;
264         if (ldlm_is_ns_srv(lock)) {
265                 LASSERT(list_empty(&lock->l_lru));
266                 RETURN(0);
267         }
268
269         spin_lock(&ns->ns_lock);
270         if (!ktime_compare(last_use, ktime_set(0, 0)) ||
271             !ktime_compare(last_use, lock->l_last_used))
272                 rc = ldlm_lock_remove_from_lru_nolock(lock);
273         spin_unlock(&ns->ns_lock);
274
275         RETURN(rc);
276 }
277
278 /**
279  * Adds LDLM lock \a lock to namespace LRU. Assumes LRU is already locked.
280  */
281 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock)
282 {
283         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
284
285         lock->l_last_used = ktime_get();
286         LASSERT(list_empty(&lock->l_lru));
287         LASSERT(lock->l_resource->lr_type != LDLM_FLOCK);
288         list_add_tail(&lock->l_lru, &ns->ns_unused_list);
289         LASSERT(ns->ns_nr_unused >= 0);
290         ns->ns_nr_unused++;
291 }
292
293 /**
294  * Adds LDLM lock \a lock to namespace LRU. Obtains necessary LRU locks
295  * first.
296  */
297 void ldlm_lock_add_to_lru(struct ldlm_lock *lock)
298 {
299         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
300
301         ENTRY;
302         spin_lock(&ns->ns_lock);
303         ldlm_lock_add_to_lru_nolock(lock);
304         spin_unlock(&ns->ns_lock);
305         EXIT;
306 }
307
308 /**
309  * Moves LDLM lock \a lock that is already in namespace LRU to the tail of
310  * the LRU. Performs necessary LRU locking
311  */
312 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock)
313 {
314         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
315
316         ENTRY;
317         if (ldlm_is_ns_srv(lock)) {
318                 LASSERT(list_empty(&lock->l_lru));
319                 EXIT;
320                 return;
321         }
322
323         spin_lock(&ns->ns_lock);
324         if (!list_empty(&lock->l_lru)) {
325                 ldlm_lock_remove_from_lru_nolock(lock);
326                 ldlm_lock_add_to_lru_nolock(lock);
327         }
328         spin_unlock(&ns->ns_lock);
329         EXIT;
330 }
331
332 /**
333  * Helper to destroy a locked lock.
334  *
335  * Used by ldlm_lock_destroy and ldlm_lock_destroy_nolock
336  * Must be called with l_lock and lr_lock held.
337  *
338  * Does not actually free the lock data, but rather marks the lock as
339  * destroyed by setting l_destroyed field in the lock to 1.  Destroys a
340  * handle->lock association too, so that the lock can no longer be found
341  * and removes the lock from LRU list.  Actual lock freeing occurs when
342  * last lock reference goes away.
343  *
344  * Original comment (of some historical value):
345  * This used to have a 'strict' flag, which recovery would use to mark an
346  * in-use lock as needing-to-die.  Lest I am ever tempted to put it back, I
347  * shall explain why it's gone: with the new hash table scheme, once you call
348  * ldlm_lock_destroy, you can never drop your final references on this lock.
349  * Because it's not in the hash table anymore.  -phil
350  */
351 static int ldlm_lock_destroy_internal(struct ldlm_lock *lock)
352 {
353         ENTRY;
354
355         if (lock->l_readers || lock->l_writers) {
356                 LDLM_ERROR(lock, "lock still has references");
357                 LBUG();
358         }
359
360         if (!list_empty(&lock->l_res_link)) {
361                 LDLM_ERROR(lock, "lock still on resource");
362                 LBUG();
363         }
364
365         if (ldlm_is_destroyed(lock)) {
366                 LASSERT(list_empty(&lock->l_lru));
367                 EXIT;
368                 return 0;
369         }
370         ldlm_set_destroyed(lock);
371
372         if (lock->l_export && lock->l_export->exp_lock_hash) {
373                 /* NB: it's safe to call cfs_hash_del() even lock isn't
374                  * in exp_lock_hash. */
375                 /* In the function below, .hs_keycmp resolves to
376                  * ldlm_export_lock_keycmp() */
377                 /* coverity[overrun-buffer-val] */
378                 cfs_hash_del(lock->l_export->exp_lock_hash,
379                              &lock->l_remote_handle, &lock->l_exp_hash);
380         }
381
382         ldlm_lock_remove_from_lru(lock);
383         class_handle_unhash(&lock->l_handle);
384
385         EXIT;
386         return 1;
387 }
388
389 /**
390  * Destroys a LDLM lock \a lock. Performs necessary locking first.
391  */
392 void ldlm_lock_destroy(struct ldlm_lock *lock)
393 {
394         int first;
395         ENTRY;
396         lock_res_and_lock(lock);
397         first = ldlm_lock_destroy_internal(lock);
398         unlock_res_and_lock(lock);
399
400         /* drop reference from hashtable only for first destroy */
401         if (first) {
402                 lu_ref_del(&lock->l_reference, "hash", lock);
403                 LDLM_LOCK_RELEASE(lock);
404         }
405         EXIT;
406 }
407
408 /**
409  * Destroys a LDLM lock \a lock that is already locked.
410  */
411 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock)
412 {
413         int first;
414         ENTRY;
415         first = ldlm_lock_destroy_internal(lock);
416         /* drop reference from hashtable only for first destroy */
417         if (first) {
418                 lu_ref_del(&lock->l_reference, "hash", lock);
419                 LDLM_LOCK_RELEASE(lock);
420         }
421         EXIT;
422 }
423
424 /* this is called by portals_handle2object with the handle lock taken */
425 static void lock_handle_addref(void *lock)
426 {
427         LDLM_LOCK_GET((struct ldlm_lock *)lock);
428 }
429
430 static void lock_handle_free(void *lock, int size)
431 {
432         LASSERT(size == sizeof(struct ldlm_lock));
433         OBD_SLAB_FREE(lock, ldlm_lock_slab, size);
434 }
435
436 static struct portals_handle_ops lock_handle_ops = {
437         .hop_addref = lock_handle_addref,
438         .hop_free   = lock_handle_free,
439 };
440
441 /**
442  *
443  * Allocate and initialize new lock structure.
444  *
445  * usage: pass in a resource on which you have done ldlm_resource_get
446  *        new lock will take over the refcount.
447  * returns: lock with refcount 2 - one for current caller and one for remote
448  */
449 static struct ldlm_lock *ldlm_lock_new(struct ldlm_resource *resource)
450 {
451         struct ldlm_lock *lock;
452         ENTRY;
453
454         if (resource == NULL)
455                 LBUG();
456
457         OBD_SLAB_ALLOC_PTR_GFP(lock, ldlm_lock_slab, GFP_NOFS);
458         if (lock == NULL)
459                 RETURN(NULL);
460
461         spin_lock_init(&lock->l_lock);
462         lock->l_resource = resource;
463         lu_ref_add(&resource->lr_reference, "lock", lock);
464
465         atomic_set(&lock->l_refc, 2);
466         INIT_LIST_HEAD(&lock->l_res_link);
467         INIT_LIST_HEAD(&lock->l_lru);
468         INIT_LIST_HEAD(&lock->l_pending_chain);
469         INIT_LIST_HEAD(&lock->l_bl_ast);
470         INIT_LIST_HEAD(&lock->l_cp_ast);
471         INIT_LIST_HEAD(&lock->l_rk_ast);
472         init_waitqueue_head(&lock->l_waitq);
473         lock->l_blocking_lock = NULL;
474         INIT_LIST_HEAD(&lock->l_sl_mode);
475         INIT_LIST_HEAD(&lock->l_sl_policy);
476         INIT_HLIST_NODE(&lock->l_exp_hash);
477         INIT_HLIST_NODE(&lock->l_exp_flock_hash);
478
479         lprocfs_counter_incr(ldlm_res_to_ns(resource)->ns_stats,
480                              LDLM_NSS_LOCKS);
481         INIT_LIST_HEAD_RCU(&lock->l_handle.h_link);
482         class_handle_hash(&lock->l_handle, &lock_handle_ops);
483
484         lu_ref_init(&lock->l_reference);
485         lu_ref_add(&lock->l_reference, "hash", lock);
486         lock->l_callback_timeout = 0;
487         lock->l_activity = 0;
488
489 #if LUSTRE_TRACKS_LOCK_EXP_REFS
490         INIT_LIST_HEAD(&lock->l_exp_refs_link);
491         lock->l_exp_refs_nr = 0;
492         lock->l_exp_refs_target = NULL;
493 #endif
494         INIT_LIST_HEAD(&lock->l_exp_list);
495
496         RETURN(lock);
497 }
498
499 /**
500  * Moves LDLM lock \a lock to another resource.
501  * This is used on client when server returns some other lock than requested
502  * (typically as a result of intent operation)
503  */
504 int ldlm_lock_change_resource(struct ldlm_namespace *ns, struct ldlm_lock *lock,
505                               const struct ldlm_res_id *new_resid)
506 {
507         struct ldlm_resource *oldres = lock->l_resource;
508         struct ldlm_resource *newres;
509         int type;
510         ENTRY;
511
512         LASSERT(ns_is_client(ns));
513
514         lock_res_and_lock(lock);
515         if (memcmp(new_resid, &lock->l_resource->lr_name,
516                    sizeof(lock->l_resource->lr_name)) == 0) {
517                 /* Nothing to do */
518                 unlock_res_and_lock(lock);
519                 RETURN(0);
520         }
521
522         LASSERT(new_resid->name[0] != 0);
523
524         /* This function assumes that the lock isn't on any lists */
525         LASSERT(list_empty(&lock->l_res_link));
526
527         type = oldres->lr_type;
528         unlock_res_and_lock(lock);
529
530         newres = ldlm_resource_get(ns, NULL, new_resid, type, 1);
531         if (IS_ERR(newres))
532                 RETURN(PTR_ERR(newres));
533
534         lu_ref_add(&newres->lr_reference, "lock", lock);
535         /*
536          * To flip the lock from the old to the new resource, lock, oldres and
537          * newres have to be locked. Resource spin-locks are nested within
538          * lock->l_lock, and are taken in the memory address order to avoid
539          * dead-locks.
540          */
541         spin_lock(&lock->l_lock);
542         oldres = lock->l_resource;
543         if (oldres < newres) {
544                 lock_res(oldres);
545                 lock_res_nested(newres, LRT_NEW);
546         } else {
547                 lock_res(newres);
548                 lock_res_nested(oldres, LRT_NEW);
549         }
550         LASSERT(memcmp(new_resid, &oldres->lr_name,
551                        sizeof oldres->lr_name) != 0);
552         lock->l_resource = newres;
553         unlock_res(oldres);
554         unlock_res_and_lock(lock);
555
556         /* ...and the flowers are still standing! */
557         lu_ref_del(&oldres->lr_reference, "lock", lock);
558         ldlm_resource_putref(oldres);
559
560         RETURN(0);
561 }
562
563 /** \defgroup ldlm_handles LDLM HANDLES
564  * Ways to get hold of locks without any addresses.
565  * @{
566  */
567
568 /**
569  * Fills in handle for LDLM lock \a lock into supplied \a lockh
570  * Does not take any references.
571  */
572 void ldlm_lock2handle(const struct ldlm_lock *lock, struct lustre_handle *lockh)
573 {
574         lockh->cookie = lock->l_handle.h_cookie;
575 }
576 EXPORT_SYMBOL(ldlm_lock2handle);
577
578 /**
579  * Obtain a lock reference by handle.
580  *
581  * if \a flags: atomically get the lock and set the flags.
582  *              Return NULL if flag already set
583  */
584 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *handle,
585                                      __u64 flags)
586 {
587         struct ldlm_lock *lock;
588         ENTRY;
589
590         LASSERT(handle);
591
592         lock = class_handle2object(handle->cookie, NULL);
593         if (lock == NULL)
594                 RETURN(NULL);
595
596         if (lock->l_export != NULL && lock->l_export->exp_failed) {
597                 CDEBUG(D_INFO, "lock export failed: lock %p, exp %p\n",
598                        lock, lock->l_export);
599                 LDLM_LOCK_PUT(lock);
600                 RETURN(NULL);
601         }
602
603         /* It's unlikely but possible that someone marked the lock as
604          * destroyed after we did handle2object on it */
605         if ((flags == 0) && !ldlm_is_destroyed(lock)) {
606                 lu_ref_add(&lock->l_reference, "handle", current);
607                 RETURN(lock);
608         }
609
610         lock_res_and_lock(lock);
611
612         LASSERT(lock->l_resource != NULL);
613
614         lu_ref_add_atomic(&lock->l_reference, "handle", current);
615         if (unlikely(ldlm_is_destroyed(lock))) {
616                 unlock_res_and_lock(lock);
617                 CDEBUG(D_INFO, "lock already destroyed: lock %p\n", lock);
618                 LDLM_LOCK_PUT(lock);
619                 RETURN(NULL);
620         }
621
622         /* If we're setting flags, make sure none of them are already set. */
623         if (flags != 0) {
624                 if ((lock->l_flags & flags) != 0) {
625                         unlock_res_and_lock(lock);
626                         LDLM_LOCK_PUT(lock);
627                         RETURN(NULL);
628                 }
629
630                 lock->l_flags |= flags;
631         }
632
633         unlock_res_and_lock(lock);
634         RETURN(lock);
635 }
636 EXPORT_SYMBOL(__ldlm_handle2lock);
637 /** @} ldlm_handles */
638
639 /**
640  * Fill in "on the wire" representation for given LDLM lock into supplied
641  * lock descriptor \a desc structure.
642  */
643 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc)
644 {
645         ldlm_res2desc(lock->l_resource, &desc->l_resource);
646         desc->l_req_mode = lock->l_req_mode;
647         desc->l_granted_mode = lock->l_granted_mode;
648         ldlm_convert_policy_to_wire(lock->l_resource->lr_type,
649                                     &lock->l_policy_data,
650                                     &desc->l_policy_data);
651 }
652
653 /**
654  * Add a lock to list of conflicting locks to send AST to.
655  *
656  * Only add if we have not sent a blocking AST to the lock yet.
657  */
658 static void ldlm_add_bl_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
659                                   struct list_head *work_list)
660 {
661         if (!ldlm_is_ast_sent(lock)) {
662                 LDLM_DEBUG(lock, "lock incompatible; sending blocking AST.");
663                 ldlm_set_ast_sent(lock);
664                 /* If the enqueuing client said so, tell the AST recipient to
665                  * discard dirty data, rather than writing back. */
666                 if (ldlm_is_ast_discard_data(new))
667                         ldlm_set_discard_data(lock);
668
669                 /* Lock can be converted from a blocking state back to granted
670                  * after lock convert or COS downgrade but still be in an
671                  * older bl_list because it is controlled only by
672                  * ldlm_work_bl_ast_lock(), let it be processed there.
673                  */
674                 if (list_empty(&lock->l_bl_ast)) {
675                         list_add(&lock->l_bl_ast, work_list);
676                         LDLM_LOCK_GET(lock);
677                 }
678                 LASSERT(lock->l_blocking_lock == NULL);
679                 lock->l_blocking_lock = LDLM_LOCK_GET(new);
680         }
681 }
682
683 /**
684  * Add a lock to list of just granted locks to send completion AST to.
685  */
686 static void ldlm_add_cp_work_item(struct ldlm_lock *lock,
687                                   struct list_head *work_list)
688 {
689         if (!ldlm_is_cp_reqd(lock)) {
690                 ldlm_set_cp_reqd(lock);
691                 LDLM_DEBUG(lock, "lock granted; sending completion AST.");
692                 LASSERT(list_empty(&lock->l_cp_ast));
693                 list_add(&lock->l_cp_ast, work_list);
694                 LDLM_LOCK_GET(lock);
695         }
696 }
697
698 /**
699  * Aggregator function to add AST work items into a list. Determines
700  * what sort of an AST work needs to be done and calls the proper
701  * adding function.
702  * Must be called with lr_lock held.
703  */
704 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
705                             struct list_head *work_list)
706 {
707         ENTRY;
708         check_res_locked(lock->l_resource);
709         if (new)
710                 ldlm_add_bl_work_item(lock, new, work_list);
711         else
712                 ldlm_add_cp_work_item(lock, work_list);
713         EXIT;
714 }
715
716 /**
717  * Add specified reader/writer reference to LDLM lock with handle \a lockh.
718  * r/w reference type is determined by \a mode
719  * Calls ldlm_lock_addref_internal.
720  */
721 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode)
722 {
723         struct ldlm_lock *lock;
724
725         lock = ldlm_handle2lock(lockh);
726         LASSERTF(lock != NULL, "Non-existing lock: %#llx\n", lockh->cookie);
727         ldlm_lock_addref_internal(lock, mode);
728         LDLM_LOCK_PUT(lock);
729 }
730 EXPORT_SYMBOL(ldlm_lock_addref);
731
732 /**
733  * Helper function.
734  * Add specified reader/writer reference to LDLM lock \a lock.
735  * r/w reference type is determined by \a mode
736  * Removes lock from LRU if it is there.
737  * Assumes the LDLM lock is already locked.
738  */
739 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *lock,
740                                       enum ldlm_mode mode)
741 {
742         ldlm_lock_remove_from_lru(lock);
743         if (mode & (LCK_NL | LCK_CR | LCK_PR)) {
744                 lock->l_readers++;
745                 lu_ref_add_atomic(&lock->l_reference, "reader", lock);
746         }
747         if (mode & (LCK_EX | LCK_CW | LCK_PW | LCK_GROUP | LCK_COS)) {
748                 lock->l_writers++;
749                 lu_ref_add_atomic(&lock->l_reference, "writer", lock);
750         }
751         LDLM_LOCK_GET(lock);
752         lu_ref_add_atomic(&lock->l_reference, "user", lock);
753         LDLM_DEBUG(lock, "ldlm_lock_addref(%s)", ldlm_lockname[mode]);
754 }
755
756 /**
757  * Attempts to add reader/writer reference to a lock with handle \a lockh, and
758  * fails if lock is already LDLM_FL_CBPENDING or destroyed.
759  *
760  * \retval 0 success, lock was addref-ed
761  *
762  * \retval -EAGAIN lock is being canceled.
763  */
764 int ldlm_lock_addref_try(const struct lustre_handle *lockh, enum ldlm_mode mode)
765 {
766         struct ldlm_lock *lock;
767         int               result;
768
769         result = -EAGAIN;
770         lock = ldlm_handle2lock(lockh);
771         if (lock != NULL) {
772                 lock_res_and_lock(lock);
773                 if (lock->l_readers != 0 || lock->l_writers != 0 ||
774                     !ldlm_is_cbpending(lock)) {
775                         ldlm_lock_addref_internal_nolock(lock, mode);
776                         result = 0;
777                 }
778                 unlock_res_and_lock(lock);
779                 LDLM_LOCK_PUT(lock);
780         }
781         return result;
782 }
783 EXPORT_SYMBOL(ldlm_lock_addref_try);
784
785 /**
786  * Add specified reader/writer reference to LDLM lock \a lock.
787  * Locks LDLM lock and calls ldlm_lock_addref_internal_nolock to do the work.
788  * Only called for local locks.
789  */
790 void ldlm_lock_addref_internal(struct ldlm_lock *lock, enum ldlm_mode mode)
791 {
792         lock_res_and_lock(lock);
793         ldlm_lock_addref_internal_nolock(lock, mode);
794         unlock_res_and_lock(lock);
795 }
796
797 /**
798  * Removes reader/writer reference for LDLM lock \a lock.
799  * Assumes LDLM lock is already locked.
800  * only called in ldlm_flock_destroy and for local locks.
801  * Does NOT add lock to LRU if no r/w references left to accomodate flock locks
802  * that cannot be placed in LRU.
803  */
804 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *lock,
805                                       enum ldlm_mode mode)
806 {
807         LDLM_DEBUG(lock, "ldlm_lock_decref(%s)", ldlm_lockname[mode]);
808         if (mode & (LCK_NL | LCK_CR | LCK_PR)) {
809                 LASSERT(lock->l_readers > 0);
810                 lu_ref_del(&lock->l_reference, "reader", lock);
811                 lock->l_readers--;
812         }
813         if (mode & (LCK_EX | LCK_CW | LCK_PW | LCK_GROUP | LCK_COS)) {
814                 LASSERT(lock->l_writers > 0);
815                 lu_ref_del(&lock->l_reference, "writer", lock);
816                 lock->l_writers--;
817         }
818
819         lu_ref_del(&lock->l_reference, "user", lock);
820         LDLM_LOCK_RELEASE(lock);    /* matches the LDLM_LOCK_GET() in addref */
821 }
822
823 /**
824  * Removes reader/writer reference for LDLM lock \a lock.
825  * Locks LDLM lock first.
826  * If the lock is determined to be client lock on a client and r/w refcount
827  * drops to zero and the lock is not blocked, the lock is added to LRU lock
828  * on the namespace.
829  * For blocked LDLM locks if r/w count drops to zero, blocking_ast is called.
830  */
831 void ldlm_lock_decref_internal(struct ldlm_lock *lock, enum ldlm_mode mode)
832 {
833         struct ldlm_namespace *ns;
834         ENTRY;
835
836         lock_res_and_lock(lock);
837
838         ns = ldlm_lock_to_ns(lock);
839
840         ldlm_lock_decref_internal_nolock(lock, mode);
841
842         if ((ldlm_is_local(lock) || lock->l_req_mode == LCK_GROUP) &&
843             !lock->l_readers && !lock->l_writers) {
844                 /* If this is a local lock on a server namespace and this was
845                  * the last reference, cancel the lock.
846                  *
847                  * Group locks are special:
848                  * They must not go in LRU, but they are not called back
849                  * like non-group locks, instead they are manually released.
850                  * They have an l_writers reference which they keep until
851                  * they are manually released, so we remove them when they have
852                  * no more reader or writer references. - LU-6368 */
853                 ldlm_set_cbpending(lock);
854         }
855
856         if (!lock->l_readers && !lock->l_writers && ldlm_is_cbpending(lock)) {
857                 /* If we received a blocked AST and this was the last reference,
858                  * run the callback. */
859                 if (ldlm_is_ns_srv(lock) && lock->l_export)
860                         CERROR("FL_CBPENDING set on non-local lock--just a "
861                                "warning\n");
862
863                 LDLM_DEBUG(lock, "final decref done on cbpending lock");
864
865                 LDLM_LOCK_GET(lock); /* dropped by bl thread */
866                 ldlm_lock_remove_from_lru(lock);
867                 unlock_res_and_lock(lock);
868
869                 if (ldlm_is_fail_loc(lock))
870                         OBD_RACE(OBD_FAIL_LDLM_CP_BL_RACE);
871
872                 if (ldlm_is_atomic_cb(lock) ||
873                     ldlm_bl_to_thread_lock(ns, NULL, lock) != 0)
874                         ldlm_handle_bl_callback(ns, NULL, lock);
875         } else if (ns_is_client(ns) &&
876                    !lock->l_readers && !lock->l_writers &&
877                    !ldlm_is_no_lru(lock) &&
878                    !ldlm_is_bl_ast(lock) &&
879                    !ldlm_is_converting(lock)) {
880
881                 LDLM_DEBUG(lock, "add lock into lru list");
882
883                 /* If this is a client-side namespace and this was the last
884                  * reference, put it on the LRU. */
885                 ldlm_lock_add_to_lru(lock);
886                 unlock_res_and_lock(lock);
887
888                 if (ldlm_is_fail_loc(lock))
889                         OBD_RACE(OBD_FAIL_LDLM_CP_BL_RACE);
890
891                 /* Call ldlm_cancel_lru() only if EARLY_CANCEL and LRU RESIZE
892                  * are not supported by the server, otherwise, it is done on
893                  * enqueue. */
894                 if (!exp_connect_cancelset(lock->l_conn_export) &&
895                     !ns_connect_lru_resize(ns))
896                         ldlm_cancel_lru(ns, 0, LCF_ASYNC, 0);
897         } else {
898                 LDLM_DEBUG(lock, "do not add lock into lru list");
899                 unlock_res_and_lock(lock);
900         }
901
902         EXIT;
903 }
904
905 /**
906  * Decrease reader/writer refcount for LDLM lock with handle \a lockh
907  */
908 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode)
909 {
910         struct ldlm_lock *lock = __ldlm_handle2lock(lockh, 0);
911         LASSERTF(lock != NULL, "Non-existing lock: %#llx\n", lockh->cookie);
912         ldlm_lock_decref_internal(lock, mode);
913         LDLM_LOCK_PUT(lock);
914 }
915 EXPORT_SYMBOL(ldlm_lock_decref);
916
917 /**
918  * Decrease reader/writer refcount for LDLM lock with handle
919  * \a lockh and mark it for subsequent cancellation once r/w refcount
920  * drops to zero instead of putting into LRU.
921  *
922  */
923 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
924                                  enum ldlm_mode mode)
925 {
926         struct ldlm_lock *lock = __ldlm_handle2lock(lockh, 0);
927         ENTRY;
928
929         LASSERT(lock != NULL);
930
931         LDLM_DEBUG(lock, "ldlm_lock_decref(%s)", ldlm_lockname[mode]);
932         lock_res_and_lock(lock);
933         ldlm_set_cbpending(lock);
934         unlock_res_and_lock(lock);
935         ldlm_lock_decref_internal(lock, mode);
936         LDLM_LOCK_PUT(lock);
937 }
938 EXPORT_SYMBOL(ldlm_lock_decref_and_cancel);
939
940 struct sl_insert_point {
941         struct list_head *res_link;
942         struct list_head *mode_link;
943         struct list_head *policy_link;
944 };
945
946 /**
947  * Finds a position to insert the new lock into granted lock list.
948  *
949  * Used for locks eligible for skiplist optimization.
950  *
951  * Parameters:
952  *      queue [input]:  the granted list where search acts on;
953  *      req [input]:    the lock whose position to be located;
954  *      prev [output]:  positions within 3 lists to insert @req to
955  * Return Value:
956  *      filled @prev
957  * NOTE: called by
958  *  - ldlm_grant_lock_with_skiplist
959  */
960 static void search_granted_lock(struct list_head *queue,
961                                 struct ldlm_lock *req,
962                                 struct sl_insert_point *prev)
963 {
964         struct list_head *tmp;
965         struct ldlm_lock *lock, *mode_end, *policy_end;
966         ENTRY;
967
968         list_for_each(tmp, queue) {
969                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
970
971                 mode_end = list_entry(lock->l_sl_mode.prev,
972                                           struct ldlm_lock, l_sl_mode);
973
974                 if (lock->l_req_mode != req->l_req_mode) {
975                         /* jump to last lock of mode group */
976                         tmp = &mode_end->l_res_link;
977                         continue;
978                 }
979
980                 /* suitable mode group is found */
981                 if (lock->l_resource->lr_type == LDLM_PLAIN) {
982                         /* insert point is last lock of the mode group */
983                         prev->res_link = &mode_end->l_res_link;
984                         prev->mode_link = &mode_end->l_sl_mode;
985                         prev->policy_link = &req->l_sl_policy;
986                         EXIT;
987                         return;
988                 } else if (lock->l_resource->lr_type == LDLM_IBITS) {
989                         for (;;) {
990                                 policy_end =
991                                         list_entry(lock->l_sl_policy.prev,
992                                                        struct ldlm_lock,
993                                                        l_sl_policy);
994
995                                 if (lock->l_policy_data.l_inodebits.bits ==
996                                     req->l_policy_data.l_inodebits.bits) {
997                                         /* insert point is last lock of
998                                          * the policy group */
999                                         prev->res_link =
1000                                                 &policy_end->l_res_link;
1001                                         prev->mode_link =
1002                                                 &policy_end->l_sl_mode;
1003                                         prev->policy_link =
1004                                                 &policy_end->l_sl_policy;
1005                                         EXIT;
1006                                         return;
1007                                 }
1008
1009                                 if (policy_end == mode_end)
1010                                         /* done with mode group */
1011                                         break;
1012
1013                                 /* go to next policy group within mode group */
1014                                 tmp = policy_end->l_res_link.next;
1015                                 lock = list_entry(tmp, struct ldlm_lock,
1016                                                       l_res_link);
1017                         }  /* loop over policy groups within the mode group */
1018
1019                         /* insert point is last lock of the mode group,
1020                          * new policy group is started */
1021                         prev->res_link = &mode_end->l_res_link;
1022                         prev->mode_link = &mode_end->l_sl_mode;
1023                         prev->policy_link = &req->l_sl_policy;
1024                         EXIT;
1025                         return;
1026                 } else {
1027                         LDLM_ERROR(lock,"is not LDLM_PLAIN or LDLM_IBITS lock");
1028                         LBUG();
1029                 }
1030         }
1031
1032         /* insert point is last lock on the queue,
1033          * new mode group and new policy group are started */
1034         prev->res_link = queue->prev;
1035         prev->mode_link = &req->l_sl_mode;
1036         prev->policy_link = &req->l_sl_policy;
1037         EXIT;
1038         return;
1039 }
1040
1041 /**
1042  * Add a lock into resource granted list after a position described by
1043  * \a prev.
1044  */
1045 static void ldlm_granted_list_add_lock(struct ldlm_lock *lock,
1046                                        struct sl_insert_point *prev)
1047 {
1048         struct ldlm_resource *res = lock->l_resource;
1049         ENTRY;
1050
1051         check_res_locked(res);
1052
1053         ldlm_resource_dump(D_INFO, res);
1054         LDLM_DEBUG(lock, "About to add lock:");
1055
1056         if (ldlm_is_destroyed(lock)) {
1057                 CDEBUG(D_OTHER, "Lock destroyed, not adding to resource\n");
1058                 return;
1059         }
1060
1061         LASSERT(list_empty(&lock->l_res_link));
1062         LASSERT(list_empty(&lock->l_sl_mode));
1063         LASSERT(list_empty(&lock->l_sl_policy));
1064
1065         /*
1066          * lock->link == prev->link means lock is first starting the group.
1067          * Don't re-add to itself to suppress kernel warnings.
1068          */
1069         if (&lock->l_res_link != prev->res_link)
1070                 list_add(&lock->l_res_link, prev->res_link);
1071         if (&lock->l_sl_mode != prev->mode_link)
1072                 list_add(&lock->l_sl_mode, prev->mode_link);
1073         if (&lock->l_sl_policy != prev->policy_link)
1074                 list_add(&lock->l_sl_policy, prev->policy_link);
1075
1076         EXIT;
1077 }
1078
1079 /**
1080  * Add a lock to granted list on a resource maintaining skiplist
1081  * correctness.
1082  */
1083 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock)
1084 {
1085         struct sl_insert_point prev;
1086
1087         LASSERT(lock->l_req_mode == lock->l_granted_mode);
1088
1089         search_granted_lock(&lock->l_resource->lr_granted, lock, &prev);
1090         ldlm_granted_list_add_lock(lock, &prev);
1091 }
1092
1093 /**
1094  * Perform lock granting bookkeeping.
1095  *
1096  * Includes putting the lock into granted list and updating lock mode.
1097  * NOTE: called by
1098  *  - ldlm_lock_enqueue
1099  *  - ldlm_reprocess_queue
1100  *
1101  * must be called with lr_lock held
1102  */
1103 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list)
1104 {
1105         struct ldlm_resource *res = lock->l_resource;
1106         ENTRY;
1107
1108         check_res_locked(res);
1109
1110         lock->l_granted_mode = lock->l_req_mode;
1111
1112         if (work_list && lock->l_completion_ast != NULL)
1113                 ldlm_add_ast_work_item(lock, NULL, work_list);
1114
1115         if (res->lr_type == LDLM_PLAIN || res->lr_type == LDLM_IBITS)
1116                 ldlm_grant_lock_with_skiplist(lock);
1117         else if (res->lr_type == LDLM_EXTENT)
1118                 ldlm_extent_add_lock(res, lock);
1119         else if (res->lr_type == LDLM_FLOCK) {
1120                 /* We should not add locks to granted list in the following
1121                  * cases:
1122                  * - this is an UNLOCK but not a real lock;
1123                  * - this is a TEST lock;
1124                  * - this is a F_CANCELLK lock (async flock has req_mode == 0)
1125                  * - this is a deadlock (flock cannot be granted) */
1126                 if (lock->l_req_mode == 0 ||
1127                     lock->l_req_mode == LCK_NL ||
1128                     ldlm_is_test_lock(lock) ||
1129                     ldlm_is_flock_deadlock(lock))
1130                         RETURN_EXIT;
1131                 ldlm_resource_add_lock(res, &res->lr_granted, lock);
1132         } else {
1133                 LBUG();
1134         }
1135
1136         ldlm_pool_add(&ldlm_res_to_ns(res)->ns_pool, lock);
1137         EXIT;
1138 }
1139
1140 /**
1141  * Describe the overlap between two locks.  itree_overlap_cb data.
1142  */
1143 struct lock_match_data {
1144         struct ldlm_lock        *lmd_old;
1145         struct ldlm_lock        *lmd_lock;
1146         enum ldlm_mode          *lmd_mode;
1147         union ldlm_policy_data  *lmd_policy;
1148         __u64                    lmd_flags;
1149         int                      lmd_unref;
1150 };
1151
1152 /**
1153  * Check if the given @lock meets the criteria for a match.
1154  * A reference on the lock is taken if matched.
1155  *
1156  * \param lock     test-against this lock
1157  * \param data     parameters
1158  */
1159 static int lock_matches(struct ldlm_lock *lock, struct lock_match_data *data)
1160 {
1161         union ldlm_policy_data *lpol = &lock->l_policy_data;
1162         enum ldlm_mode match;
1163
1164         if (lock == data->lmd_old)
1165                 return INTERVAL_ITER_STOP;
1166
1167         /* Check if this lock can be matched.
1168          * Used by LU-2919(exclusive open) for open lease lock */
1169         if (ldlm_is_excl(lock))
1170                 return INTERVAL_ITER_CONT;
1171
1172         /* llite sometimes wants to match locks that will be
1173          * canceled when their users drop, but we allow it to match
1174          * if it passes in CBPENDING and the lock still has users.
1175          * this is generally only going to be used by children
1176          * whose parents already hold a lock so forward progress
1177          * can still happen. */
1178         if (ldlm_is_cbpending(lock) &&
1179             !(data->lmd_flags & LDLM_FL_CBPENDING))
1180                 return INTERVAL_ITER_CONT;
1181         if (!data->lmd_unref && ldlm_is_cbpending(lock) &&
1182             lock->l_readers == 0 && lock->l_writers == 0)
1183                 return INTERVAL_ITER_CONT;
1184
1185         if (!(lock->l_req_mode & *data->lmd_mode))
1186                 return INTERVAL_ITER_CONT;
1187         match = lock->l_req_mode;
1188
1189         switch (lock->l_resource->lr_type) {
1190         case LDLM_EXTENT:
1191                 if (lpol->l_extent.start > data->lmd_policy->l_extent.start ||
1192                     lpol->l_extent.end < data->lmd_policy->l_extent.end)
1193                         return INTERVAL_ITER_CONT;
1194
1195                 if (unlikely(match == LCK_GROUP) &&
1196                     data->lmd_policy->l_extent.gid != LDLM_GID_ANY &&
1197                     lpol->l_extent.gid != data->lmd_policy->l_extent.gid)
1198                         return INTERVAL_ITER_CONT;
1199                 break;
1200         case LDLM_IBITS:
1201                 /* We match if we have existing lock with same or wider set
1202                    of bits. */
1203                 if ((lpol->l_inodebits.bits &
1204                      data->lmd_policy->l_inodebits.bits) !=
1205                     data->lmd_policy->l_inodebits.bits)
1206                         return INTERVAL_ITER_CONT;
1207                 break;
1208         default:
1209                 ;
1210         }
1211
1212         /* We match if we have existing lock with same or wider set
1213            of bits. */
1214         if (!data->lmd_unref && LDLM_HAVE_MASK(lock, GONE))
1215                 return INTERVAL_ITER_CONT;
1216
1217         if (!equi(data->lmd_flags & LDLM_FL_LOCAL_ONLY, ldlm_is_local(lock)))
1218                 return INTERVAL_ITER_CONT;
1219
1220         if (data->lmd_flags & LDLM_FL_TEST_LOCK) {
1221                 LDLM_LOCK_GET(lock);
1222                 ldlm_lock_touch_in_lru(lock);
1223         } else {
1224                 ldlm_lock_addref_internal_nolock(lock, match);
1225         }
1226
1227         *data->lmd_mode = match;
1228         data->lmd_lock = lock;
1229
1230         return INTERVAL_ITER_STOP;
1231 }
1232
1233 static unsigned int itree_overlap_cb(struct interval_node *in, void *args)
1234 {
1235         struct ldlm_interval *node = to_ldlm_interval(in);
1236         struct lock_match_data *data = args;
1237         struct ldlm_lock *lock;
1238         int rc;
1239
1240         list_for_each_entry(lock, &node->li_group, l_sl_policy) {
1241                 rc = lock_matches(lock, data);
1242                 if (rc == INTERVAL_ITER_STOP)
1243                         return INTERVAL_ITER_STOP;
1244         }
1245         return INTERVAL_ITER_CONT;
1246 }
1247
1248 /**
1249  * Search for a lock with given parameters in interval trees.
1250  *
1251  * \param res      search for a lock in this resource
1252  * \param data     parameters
1253  *
1254  * \retval a referenced lock or NULL.
1255  */
1256 static struct ldlm_lock *search_itree(struct ldlm_resource *res,
1257                                       struct lock_match_data *data)
1258 {
1259         struct interval_node_extent ext = {
1260                 .start     = data->lmd_policy->l_extent.start,
1261                 .end       = data->lmd_policy->l_extent.end
1262         };
1263         int idx;
1264
1265         data->lmd_lock = NULL;
1266
1267         for (idx = 0; idx < LCK_MODE_NUM; idx++) {
1268                 struct ldlm_interval_tree *tree = &res->lr_itree[idx];
1269
1270                 if (tree->lit_root == NULL)
1271                         continue;
1272
1273                 if (!(tree->lit_mode & *data->lmd_mode))
1274                         continue;
1275
1276                 interval_search(tree->lit_root, &ext,
1277                                 itree_overlap_cb, data);
1278                 if (data->lmd_lock)
1279                         return data->lmd_lock;
1280         }
1281
1282         return NULL;
1283 }
1284
1285
1286 /**
1287  * Search for a lock with given properties in a queue.
1288  *
1289  * \param queue    search for a lock in this queue
1290  * \param data     parameters
1291  *
1292  * \retval a referenced lock or NULL.
1293  */
1294 static struct ldlm_lock *search_queue(struct list_head *queue,
1295                                       struct lock_match_data *data)
1296 {
1297         struct ldlm_lock *lock;
1298         int rc;
1299
1300         data->lmd_lock = NULL;
1301
1302         list_for_each_entry(lock, queue, l_res_link) {
1303                 rc = lock_matches(lock, data);
1304                 if (rc == INTERVAL_ITER_STOP)
1305                         return data->lmd_lock;
1306         }
1307
1308         return NULL;
1309 }
1310
1311 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock)
1312 {
1313         if ((lock->l_flags & LDLM_FL_FAIL_NOTIFIED) == 0) {
1314                 lock->l_flags |= LDLM_FL_FAIL_NOTIFIED;
1315                 wake_up_all(&lock->l_waitq);
1316         }
1317 }
1318 EXPORT_SYMBOL(ldlm_lock_fail_match_locked);
1319
1320 void ldlm_lock_fail_match(struct ldlm_lock *lock)
1321 {
1322         lock_res_and_lock(lock);
1323         ldlm_lock_fail_match_locked(lock);
1324         unlock_res_and_lock(lock);
1325 }
1326
1327 /**
1328  * Mark lock as "matchable" by OST.
1329  *
1330  * Used to prevent certain races in LOV/OSC where the lock is granted, but LVB
1331  * is not yet valid.
1332  * Assumes LDLM lock is already locked.
1333  */
1334 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock)
1335 {
1336         ldlm_set_lvb_ready(lock);
1337         wake_up_all(&lock->l_waitq);
1338 }
1339 EXPORT_SYMBOL(ldlm_lock_allow_match_locked);
1340
1341 /**
1342  * Mark lock as "matchable" by OST.
1343  * Locks the lock and then \see ldlm_lock_allow_match_locked
1344  */
1345 void ldlm_lock_allow_match(struct ldlm_lock *lock)
1346 {
1347         lock_res_and_lock(lock);
1348         ldlm_lock_allow_match_locked(lock);
1349         unlock_res_and_lock(lock);
1350 }
1351 EXPORT_SYMBOL(ldlm_lock_allow_match);
1352
1353 /**
1354  * Attempt to find a lock with specified properties.
1355  *
1356  * Typically returns a reference to matched lock unless LDLM_FL_TEST_LOCK is
1357  * set in \a flags
1358  *
1359  * Can be called in two ways:
1360  *
1361  * If 'ns' is NULL, then lockh describes an existing lock that we want to look
1362  * for a duplicate of.
1363  *
1364  * Otherwise, all of the fields must be filled in, to match against.
1365  *
1366  * If 'flags' contains LDLM_FL_LOCAL_ONLY, then only match local locks on the
1367  *     server (ie, connh is NULL)
1368  * If 'flags' contains LDLM_FL_BLOCK_GRANTED, then only locks on the granted
1369  *     list will be considered
1370  * If 'flags' contains LDLM_FL_CBPENDING, then locks that have been marked
1371  *     to be canceled can still be matched as long as they still have reader
1372  *     or writer refernces
1373  * If 'flags' contains LDLM_FL_TEST_LOCK, then don't actually reference a lock,
1374  *     just tell us if we would have matched.
1375  *
1376  * \retval 1 if it finds an already-existing lock that is compatible; in this
1377  * case, lockh is filled in with a addref()ed lock
1378  *
1379  * We also check security context, and if that fails we simply return 0 (to
1380  * keep caller code unchanged), the context failure will be discovered by
1381  * caller sometime later.
1382  */
1383 enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1384                                const struct ldlm_res_id *res_id,
1385                                enum ldlm_type type,
1386                                union ldlm_policy_data *policy,
1387                                enum ldlm_mode mode,
1388                                struct lustre_handle *lockh, int unref)
1389 {
1390         struct lock_match_data data = {
1391                 .lmd_old        = NULL,
1392                 .lmd_lock       = NULL,
1393                 .lmd_mode       = &mode,
1394                 .lmd_policy     = policy,
1395                 .lmd_flags      = flags,
1396                 .lmd_unref      = unref,
1397         };
1398         struct ldlm_resource *res;
1399         struct ldlm_lock *lock;
1400         int rc = 0;
1401         ENTRY;
1402
1403         if (ns == NULL) {
1404                 data.lmd_old = ldlm_handle2lock(lockh);
1405                 LASSERT(data.lmd_old != NULL);
1406
1407                 ns = ldlm_lock_to_ns(data.lmd_old);
1408                 res_id = &data.lmd_old->l_resource->lr_name;
1409                 type = data.lmd_old->l_resource->lr_type;
1410                 *data.lmd_mode = data.lmd_old->l_req_mode;
1411         }
1412
1413         res = ldlm_resource_get(ns, NULL, res_id, type, 0);
1414         if (IS_ERR(res)) {
1415                 LASSERT(data.lmd_old == NULL);
1416                 RETURN(0);
1417         }
1418
1419         LDLM_RESOURCE_ADDREF(res);
1420         lock_res(res);
1421
1422         if (res->lr_type == LDLM_EXTENT)
1423                 lock = search_itree(res, &data);
1424         else
1425                 lock = search_queue(&res->lr_granted, &data);
1426         if (lock != NULL)
1427                 GOTO(out, rc = 1);
1428         if (flags & LDLM_FL_BLOCK_GRANTED)
1429                 GOTO(out, rc = 0);
1430         lock = search_queue(&res->lr_waiting, &data);
1431         if (lock != NULL)
1432                 GOTO(out, rc = 1);
1433
1434         EXIT;
1435  out:
1436         unlock_res(res);
1437         LDLM_RESOURCE_DELREF(res);
1438         ldlm_resource_putref(res);
1439
1440         if (lock) {
1441                 ldlm_lock2handle(lock, lockh);
1442                 if ((flags & LDLM_FL_LVB_READY) &&
1443                     (!ldlm_is_lvb_ready(lock))) {
1444                         __u64 wait_flags = LDLM_FL_LVB_READY |
1445                                 LDLM_FL_DESTROYED | LDLM_FL_FAIL_NOTIFIED;
1446                         struct l_wait_info lwi;
1447                         if (lock->l_completion_ast) {
1448                                 int err = lock->l_completion_ast(lock,
1449                                                           LDLM_FL_WAIT_NOREPROC,
1450                                                                  NULL);
1451                                 if (err) {
1452                                         if (flags & LDLM_FL_TEST_LOCK)
1453                                                 LDLM_LOCK_RELEASE(lock);
1454                                         else
1455                                                 ldlm_lock_decref_internal(lock,
1456                                                                           mode);
1457                                         rc = 0;
1458                                         goto out2;
1459                                 }
1460                         }
1461
1462                         lwi = LWI_TIMEOUT_INTR(cfs_time_seconds(obd_timeout),
1463                                                NULL, LWI_ON_SIGNAL_NOOP, NULL);
1464
1465                         /* XXX FIXME see comment on CAN_MATCH in lustre_dlm.h */
1466                         l_wait_event(lock->l_waitq,
1467                                      lock->l_flags & wait_flags,
1468                                      &lwi);
1469                         if (!ldlm_is_lvb_ready(lock)) {
1470                                 if (flags & LDLM_FL_TEST_LOCK)
1471                                         LDLM_LOCK_RELEASE(lock);
1472                                 else
1473                                         ldlm_lock_decref_internal(lock, mode);
1474                                 rc = 0;
1475                         }
1476                 }
1477         }
1478  out2:
1479         if (rc) {
1480                 LDLM_DEBUG(lock, "matched (%llu %llu)",
1481                            (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1482                                 res_id->name[2] : policy->l_extent.start,
1483                            (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1484                                 res_id->name[3] : policy->l_extent.end);
1485
1486                 /* check user's security context */
1487                 if (lock->l_conn_export &&
1488                     sptlrpc_import_check_ctx(
1489                                 class_exp2cliimp(lock->l_conn_export))) {
1490                         if (!(flags & LDLM_FL_TEST_LOCK))
1491                                 ldlm_lock_decref_internal(lock, mode);
1492                         rc = 0;
1493                 }
1494
1495                 if (flags & LDLM_FL_TEST_LOCK)
1496                         LDLM_LOCK_RELEASE(lock);
1497
1498         } else if (!(flags & LDLM_FL_TEST_LOCK)) {/*less verbose for test-only*/
1499                 LDLM_DEBUG_NOLOCK("not matched ns %p type %u mode %u res "
1500                                   "%llu/%llu (%llu %llu)", ns,
1501                                   type, mode, res_id->name[0], res_id->name[1],
1502                                   (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1503                                         res_id->name[2] :policy->l_extent.start,
1504                                   (type == LDLM_PLAIN || type == LDLM_IBITS) ?
1505                                         res_id->name[3] : policy->l_extent.end);
1506         }
1507         if (data.lmd_old != NULL)
1508                 LDLM_LOCK_PUT(data.lmd_old);
1509
1510         return rc ? mode : 0;
1511 }
1512 EXPORT_SYMBOL(ldlm_lock_match);
1513
1514 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1515                                            __u64 *bits)
1516 {
1517         struct ldlm_lock *lock;
1518         enum ldlm_mode mode = 0;
1519         ENTRY;
1520
1521         lock = ldlm_handle2lock(lockh);
1522         if (lock != NULL) {
1523                 lock_res_and_lock(lock);
1524                 if (LDLM_HAVE_MASK(lock, GONE))
1525                         GOTO(out, mode);
1526
1527                 if (ldlm_is_cbpending(lock) &&
1528                     lock->l_readers == 0 && lock->l_writers == 0)
1529                         GOTO(out, mode);
1530
1531                 if (bits)
1532                         *bits = lock->l_policy_data.l_inodebits.bits;
1533                 mode = lock->l_granted_mode;
1534                 ldlm_lock_addref_internal_nolock(lock, mode);
1535         }
1536
1537         EXIT;
1538
1539 out:
1540         if (lock != NULL) {
1541                 unlock_res_and_lock(lock);
1542                 LDLM_LOCK_PUT(lock);
1543         }
1544         return mode;
1545 }
1546 EXPORT_SYMBOL(ldlm_revalidate_lock_handle);
1547
1548 /** The caller must guarantee that the buffer is large enough. */
1549 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
1550                   enum req_location loc, void *data, int size)
1551 {
1552         void *lvb;
1553         ENTRY;
1554
1555         LASSERT(data != NULL);
1556         LASSERT(size >= 0);
1557
1558         switch (lock->l_lvb_type) {
1559         case LVB_T_OST:
1560                 if (size == sizeof(struct ost_lvb)) {
1561                         if (loc == RCL_CLIENT)
1562                                 lvb = req_capsule_client_swab_get(pill,
1563                                                 &RMF_DLM_LVB,
1564                                                 lustre_swab_ost_lvb);
1565                         else
1566                                 lvb = req_capsule_server_swab_get(pill,
1567                                                 &RMF_DLM_LVB,
1568                                                 lustre_swab_ost_lvb);
1569                         if (unlikely(lvb == NULL)) {
1570                                 LDLM_ERROR(lock, "no LVB");
1571                                 RETURN(-EPROTO);
1572                         }
1573
1574                         memcpy(data, lvb, size);
1575                 } else if (size == sizeof(struct ost_lvb_v1)) {
1576                         struct ost_lvb *olvb = data;
1577
1578                         if (loc == RCL_CLIENT)
1579                                 lvb = req_capsule_client_swab_get(pill,
1580                                                 &RMF_DLM_LVB,
1581                                                 lustre_swab_ost_lvb_v1);
1582                         else
1583                                 lvb = req_capsule_server_sized_swab_get(pill,
1584                                                 &RMF_DLM_LVB, size,
1585                                                 lustre_swab_ost_lvb_v1);
1586                         if (unlikely(lvb == NULL)) {
1587                                 LDLM_ERROR(lock, "no LVB");
1588                                 RETURN(-EPROTO);
1589                         }
1590
1591                         memcpy(data, lvb, size);
1592                         olvb->lvb_mtime_ns = 0;
1593                         olvb->lvb_atime_ns = 0;
1594                         olvb->lvb_ctime_ns = 0;
1595                 } else {
1596                         LDLM_ERROR(lock, "Replied unexpected ost LVB size %d",
1597                                    size);
1598                         RETURN(-EINVAL);
1599                 }
1600                 break;
1601         case LVB_T_LQUOTA:
1602                 if (size == sizeof(struct lquota_lvb)) {
1603                         if (loc == RCL_CLIENT)
1604                                 lvb = req_capsule_client_swab_get(pill,
1605                                                 &RMF_DLM_LVB,
1606                                                 lustre_swab_lquota_lvb);
1607                         else
1608                                 lvb = req_capsule_server_swab_get(pill,
1609                                                 &RMF_DLM_LVB,
1610                                                 lustre_swab_lquota_lvb);
1611                         if (unlikely(lvb == NULL)) {
1612                                 LDLM_ERROR(lock, "no LVB");
1613                                 RETURN(-EPROTO);
1614                         }
1615
1616                         memcpy(data, lvb, size);
1617                 } else {
1618                         LDLM_ERROR(lock, "Replied unexpected lquota LVB size %d",
1619                                    size);
1620                         RETURN(-EINVAL);
1621                 }
1622                 break;
1623         case LVB_T_LAYOUT:
1624                 if (size == 0)
1625                         break;
1626
1627                 if (loc == RCL_CLIENT)
1628                         lvb = req_capsule_client_get(pill, &RMF_DLM_LVB);
1629                 else
1630                         lvb = req_capsule_server_get(pill, &RMF_DLM_LVB);
1631                 if (unlikely(lvb == NULL)) {
1632                         LDLM_ERROR(lock, "no LVB");
1633                         RETURN(-EPROTO);
1634                 }
1635
1636                 memcpy(data, lvb, size);
1637                 break;
1638         default:
1639                 LDLM_ERROR(lock, "Unknown LVB type: %d", lock->l_lvb_type);
1640                 libcfs_debug_dumpstack(NULL);
1641                 RETURN(-EINVAL);
1642         }
1643
1644         RETURN(0);
1645 }
1646
1647 /**
1648  * Create and fill in new LDLM lock with specified properties.
1649  * Returns a referenced lock
1650  */
1651 struct ldlm_lock *ldlm_lock_create(struct ldlm_namespace *ns,
1652                                    const struct ldlm_res_id *res_id,
1653                                    enum ldlm_type type,
1654                                    enum ldlm_mode mode,
1655                                    const struct ldlm_callback_suite *cbs,
1656                                    void *data, __u32 lvb_len,
1657                                    enum lvb_type lvb_type)
1658 {
1659         struct ldlm_lock        *lock;
1660         struct ldlm_resource    *res;
1661         int                     rc;
1662         ENTRY;
1663
1664         res = ldlm_resource_get(ns, NULL, res_id, type, 1);
1665         if (IS_ERR(res))
1666                 RETURN(ERR_CAST(res));
1667
1668         lock = ldlm_lock_new(res);
1669         if (lock == NULL)
1670                 RETURN(ERR_PTR(-ENOMEM));
1671
1672         lock->l_req_mode = mode;
1673         lock->l_ast_data = data;
1674         lock->l_pid = current_pid();
1675         if (ns_is_server(ns))
1676                 ldlm_set_ns_srv(lock);
1677         if (cbs) {
1678                 lock->l_blocking_ast = cbs->lcs_blocking;
1679                 lock->l_completion_ast = cbs->lcs_completion;
1680                 lock->l_glimpse_ast = cbs->lcs_glimpse;
1681         }
1682
1683         lock->l_tree_node = NULL;
1684         /* if this is the extent lock, allocate the interval tree node */
1685         if (type == LDLM_EXTENT)
1686                 if (ldlm_interval_alloc(lock) == NULL)
1687                         GOTO(out, rc = -ENOMEM);
1688
1689         if (lvb_len) {
1690                 lock->l_lvb_len = lvb_len;
1691                 OBD_ALLOC_LARGE(lock->l_lvb_data, lvb_len);
1692                 if (lock->l_lvb_data == NULL)
1693                         GOTO(out, rc = -ENOMEM);
1694         }
1695
1696         lock->l_lvb_type = lvb_type;
1697         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_NEW_LOCK))
1698                 GOTO(out, rc = -ENOENT);
1699
1700         RETURN(lock);
1701
1702 out:
1703         ldlm_lock_destroy(lock);
1704         LDLM_LOCK_RELEASE(lock);
1705         RETURN(ERR_PTR(rc));
1706 }
1707
1708 #ifdef HAVE_SERVER_SUPPORT
1709 static enum ldlm_error ldlm_lock_enqueue_helper(struct ldlm_lock *lock,
1710                                              __u64 *flags)
1711 {
1712         struct ldlm_resource *res = lock->l_resource;
1713         enum ldlm_error rc = ELDLM_OK;
1714         struct list_head rpc_list = LIST_HEAD_INIT(rpc_list);
1715         ldlm_processing_policy policy;
1716         ENTRY;
1717
1718         policy = ldlm_processing_policy_table[res->lr_type];
1719 restart:
1720         policy(lock, flags, LDLM_PROCESS_ENQUEUE, &rc, &rpc_list);
1721         if (rc == ELDLM_OK && lock->l_granted_mode != lock->l_req_mode &&
1722             res->lr_type != LDLM_FLOCK) {
1723                 rc = ldlm_handle_conflict_lock(lock, flags, &rpc_list);
1724                 if (rc == -ERESTART)
1725                         GOTO(restart, rc);
1726         }
1727
1728         if (!list_empty(&rpc_list))
1729                 ldlm_discard_bl_list(&rpc_list);
1730
1731         RETURN(rc);
1732 }
1733 #endif
1734
1735 /**
1736  * Enqueue (request) a lock.
1737  *
1738  * Does not block. As a result of enqueue the lock would be put
1739  * into granted or waiting list.
1740  *
1741  * If namespace has intent policy sent and the lock has LDLM_FL_HAS_INTENT flag
1742  * set, skip all the enqueueing and delegate lock processing to intent policy
1743  * function.
1744  */
1745 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
1746                                   struct ldlm_namespace *ns,
1747                                   struct ldlm_lock **lockp,
1748                                   void *cookie, __u64 *flags)
1749 {
1750         struct ldlm_lock *lock = *lockp;
1751         struct ldlm_resource *res = lock->l_resource;
1752         int local = ns_is_client(ldlm_res_to_ns(res));
1753         enum ldlm_error rc = ELDLM_OK;
1754         struct ldlm_interval *node = NULL;
1755         ENTRY;
1756
1757         /* policies are not executed on the client or during replay */
1758         if ((*flags & (LDLM_FL_HAS_INTENT|LDLM_FL_REPLAY)) == LDLM_FL_HAS_INTENT
1759             && !local && ns->ns_policy) {
1760                 rc = ns->ns_policy(env, ns, lockp, cookie, lock->l_req_mode,
1761                                    *flags, NULL);
1762                 if (rc == ELDLM_LOCK_REPLACED) {
1763                         /* The lock that was returned has already been granted,
1764                          * and placed into lockp.  If it's not the same as the
1765                          * one we passed in, then destroy the old one and our
1766                          * work here is done. */
1767                         if (lock != *lockp) {
1768                                 ldlm_lock_destroy(lock);
1769                                 LDLM_LOCK_RELEASE(lock);
1770                         }
1771                         *flags |= LDLM_FL_LOCK_CHANGED;
1772                         RETURN(0);
1773                 } else if (rc != ELDLM_OK &&
1774                            lock->l_req_mode == lock->l_granted_mode) {
1775                         LASSERT(*flags & LDLM_FL_RESENT);
1776                         /* It may happen that ns_policy returns an error in
1777                          * resend case, object may be unlinked or just some
1778                          * error occurs. It is unclear if lock reached the
1779                          * client in the original reply, just leave the lock on
1780                          * server, not returning it again to client. Due to
1781                          * LU-6529, the server will not OOM. */
1782                         RETURN(rc);
1783                 } else if (rc != ELDLM_OK ||
1784                            (rc == ELDLM_OK && (*flags & LDLM_FL_INTENT_ONLY))) {
1785                         ldlm_lock_destroy(lock);
1786                         RETURN(rc);
1787                 }
1788         }
1789
1790         if (*flags & LDLM_FL_RESENT) {
1791                 /* Reconstruct LDLM_FL_SRV_ENQ_MASK @flags for reply.
1792                  * Set LOCK_CHANGED always.
1793                  * Check if the lock is granted for BLOCK_GRANTED.
1794                  * Take NO_TIMEOUT from the lock as it is inherited through
1795                  * LDLM_FL_INHERIT_MASK */
1796                 *flags |= LDLM_FL_LOCK_CHANGED;
1797                 if (lock->l_req_mode != lock->l_granted_mode)
1798                         *flags |= LDLM_FL_BLOCK_GRANTED;
1799                 *flags |= lock->l_flags & LDLM_FL_NO_TIMEOUT;
1800                 RETURN(ELDLM_OK);
1801         }
1802
1803         /* For a replaying lock, it might be already in granted list. So
1804          * unlinking the lock will cause the interval node to be freed, we
1805          * have to allocate the interval node early otherwise we can't regrant
1806          * this lock in the future. - jay */
1807         if (!local && (*flags & LDLM_FL_REPLAY) && res->lr_type == LDLM_EXTENT)
1808                 OBD_SLAB_ALLOC_PTR_GFP(node, ldlm_interval_slab, GFP_NOFS);
1809
1810         lock_res_and_lock(lock);
1811         if (local && lock->l_req_mode == lock->l_granted_mode) {
1812                 /* The server returned a blocked lock, but it was granted
1813                  * before we got a chance to actually enqueue it.  We don't
1814                  * need to do anything else. */
1815                 *flags &= ~LDLM_FL_BLOCKED_MASK;
1816                 GOTO(out, rc = ELDLM_OK);
1817         }
1818
1819         ldlm_resource_unlink_lock(lock);
1820         if (res->lr_type == LDLM_EXTENT && lock->l_tree_node == NULL) {
1821                 if (node == NULL) {
1822                         ldlm_lock_destroy_nolock(lock);
1823                         GOTO(out, rc = -ENOMEM);
1824                 }
1825
1826                 INIT_LIST_HEAD(&node->li_group);
1827                 ldlm_interval_attach(node, lock);
1828                 node = NULL;
1829         }
1830
1831         /* Some flags from the enqueue want to make it into the AST, via the
1832          * lock's l_flags. */
1833         if (*flags & LDLM_FL_AST_DISCARD_DATA)
1834                 ldlm_set_ast_discard_data(lock);
1835         if (*flags & LDLM_FL_TEST_LOCK)
1836                 ldlm_set_test_lock(lock);
1837         if (*flags & LDLM_FL_COS_INCOMPAT)
1838                 ldlm_set_cos_incompat(lock);
1839         if (*flags & LDLM_FL_COS_ENABLED)
1840                 ldlm_set_cos_enabled(lock);
1841
1842         /* This distinction between local lock trees is very important; a client
1843          * namespace only has information about locks taken by that client, and
1844          * thus doesn't have enough information to decide for itself if it can
1845          * be granted (below).  In this case, we do exactly what the server
1846          * tells us to do, as dictated by the 'flags'.
1847          *
1848          * We do exactly the same thing during recovery, when the server is
1849          * more or less trusting the clients not to lie.
1850          *
1851          * FIXME (bug 268): Detect obvious lies by checking compatibility in
1852          * granted queue. */
1853         if (local) {
1854                 if (*flags & (LDLM_FL_BLOCK_WAIT | LDLM_FL_BLOCK_GRANTED))
1855                         ldlm_resource_add_lock(res, &res->lr_waiting, lock);
1856                 else
1857                         ldlm_grant_lock(lock, NULL);
1858                 GOTO(out, rc = ELDLM_OK);
1859 #ifdef HAVE_SERVER_SUPPORT
1860         } else if (*flags & LDLM_FL_REPLAY) {
1861                 if (*flags & LDLM_FL_BLOCK_WAIT) {
1862                         ldlm_resource_add_lock(res, &res->lr_waiting, lock);
1863                         GOTO(out, rc = ELDLM_OK);
1864                 } else if (*flags & LDLM_FL_BLOCK_GRANTED) {
1865                         ldlm_grant_lock(lock, NULL);
1866                         GOTO(out, rc = ELDLM_OK);
1867                 }
1868                 /* If no flags, fall through to normal enqueue path. */
1869         }
1870
1871         rc = ldlm_lock_enqueue_helper(lock, flags);
1872         GOTO(out, rc);
1873 #else
1874         } else {
1875                 CERROR("This is client-side-only module, cannot handle "
1876                        "LDLM_NAMESPACE_SERVER resource type lock.\n");
1877                 LBUG();
1878         }
1879 #endif
1880
1881 out:
1882         unlock_res_and_lock(lock);
1883         if (node)
1884                 OBD_SLAB_FREE(node, ldlm_interval_slab, sizeof(*node));
1885         return rc;
1886 }
1887
1888 #ifdef HAVE_SERVER_SUPPORT
1889 /**
1890  * Iterate through all waiting locks on a given resource queue and attempt to
1891  * grant them.
1892  *
1893  * Must be called with resource lock held.
1894  */
1895 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
1896                          struct list_head *work_list,
1897                          enum ldlm_process_intention intention)
1898 {
1899         struct list_head *tmp, *pos;
1900         ldlm_processing_policy policy;
1901         __u64 flags;
1902         int rc = LDLM_ITER_CONTINUE;
1903         enum ldlm_error err;
1904         struct list_head bl_ast_list = LIST_HEAD_INIT(bl_ast_list);
1905         ENTRY;
1906
1907         check_res_locked(res);
1908
1909         policy = ldlm_processing_policy_table[res->lr_type];
1910         LASSERT(policy);
1911         LASSERT(intention == LDLM_PROCESS_RESCAN ||
1912                 intention == LDLM_PROCESS_RECOVERY);
1913
1914 restart:
1915         list_for_each_safe(tmp, pos, queue) {
1916                 struct ldlm_lock *pending;
1917                 struct list_head rpc_list = LIST_HEAD_INIT(rpc_list);
1918
1919                 pending = list_entry(tmp, struct ldlm_lock, l_res_link);
1920
1921                 CDEBUG(D_INFO, "Reprocessing lock %p\n", pending);
1922
1923                 flags = 0;
1924                 rc = policy(pending, &flags, intention, &err, &rpc_list);
1925                 if (pending->l_granted_mode == pending->l_req_mode ||
1926                     res->lr_type == LDLM_FLOCK) {
1927                         list_splice(&rpc_list, work_list);
1928                 } else {
1929                         list_splice(&rpc_list, &bl_ast_list);
1930                 }
1931                 /*
1932                  * When this is called from recovery done, we always want
1933                  * to scan the whole list no matter what 'rc' is returned.
1934                  */
1935                 if (rc != LDLM_ITER_CONTINUE &&
1936                     intention == LDLM_PROCESS_RESCAN)
1937                         break;
1938         }
1939
1940         if (!list_empty(&bl_ast_list)) {
1941                 unlock_res(res);
1942
1943                 rc = ldlm_run_ast_work(ldlm_res_to_ns(res), &bl_ast_list,
1944                                        LDLM_WORK_BL_AST);
1945
1946                 lock_res(res);
1947                 if (rc == -ERESTART)
1948                         GOTO(restart, rc);
1949         }
1950
1951         if (!list_empty(&bl_ast_list))
1952                 ldlm_discard_bl_list(&bl_ast_list);
1953
1954         RETURN(intention == LDLM_PROCESS_RESCAN ? rc : LDLM_ITER_CONTINUE);
1955 }
1956
1957 /**
1958  * Conflicting locks are detected for a lock to be enqueued, add the lock
1959  * into waiting list and send blocking ASTs to the conflicting locks.
1960  *
1961  * \param[in] lock              The lock to be enqueued.
1962  * \param[out] flags            Lock flags for the lock to be enqueued.
1963  * \param[in] rpc_list          Conflicting locks list.
1964  *
1965  * \retval -ERESTART:   Some lock was instantly canceled while sending
1966  *                      blocking ASTs, caller needs to re-check conflicting
1967  *                      locks.
1968  * \retval -EAGAIN:     Lock was destroyed, caller should return error.
1969  * \reval 0:            Lock is successfully added in waiting list.
1970  */
1971 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
1972                               struct list_head *rpc_list)
1973 {
1974         struct ldlm_resource *res = lock->l_resource;
1975         int rc;
1976         ENTRY;
1977
1978         check_res_locked(res);
1979
1980         /* If either of the compat_queue()s returned failure, then we
1981          * have ASTs to send and must go onto the waiting list.
1982          *
1983          * bug 2322: we used to unlink and re-add here, which was a
1984          * terrible folly -- if we goto restart, we could get
1985          * re-ordered!  Causes deadlock, because ASTs aren't sent! */
1986         if (list_empty(&lock->l_res_link))
1987                 ldlm_resource_add_lock(res, &res->lr_waiting, lock);
1988         unlock_res(res);
1989
1990         rc = ldlm_run_ast_work(ldlm_res_to_ns(res), rpc_list,
1991                                LDLM_WORK_BL_AST);
1992
1993         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_OST_FAIL_RACE) &&
1994             !ns_is_client(ldlm_res_to_ns(res)))
1995                 class_fail_export(lock->l_export);
1996
1997         lock_res(res);
1998         if (rc == -ERESTART) {
1999                 /* 15715: The lock was granted and destroyed after
2000                  * resource lock was dropped. Interval node was freed
2001                  * in ldlm_lock_destroy. Anyway, this always happens
2002                  * when a client is being evicted. So it would be
2003                  * ok to return an error. -jay */
2004                 if (ldlm_is_destroyed(lock))
2005                         RETURN(-EAGAIN);
2006
2007                 /* lock was granted while resource was unlocked. */
2008                 if (lock->l_granted_mode == lock->l_req_mode) {
2009                         /* bug 11300: if the lock has been granted,
2010                          * break earlier because otherwise, we will go
2011                          * to restart and ldlm_resource_unlink will be
2012                          * called and it causes the interval node to be
2013                          * freed. Then we will fail at
2014                          * ldlm_extent_add_lock() */
2015                         *flags &= ~LDLM_FL_BLOCKED_MASK;
2016                         RETURN(0);
2017                 }
2018
2019                 RETURN(rc);
2020         }
2021         *flags |= LDLM_FL_BLOCK_GRANTED;
2022
2023         RETURN(0);
2024 }
2025
2026 /**
2027  * Discard all AST work items from list.
2028  *
2029  * If for whatever reason we do not want to send ASTs to conflicting locks
2030  * anymore, disassemble the list with this function.
2031  */
2032 void ldlm_discard_bl_list(struct list_head *bl_list)
2033 {
2034         struct ldlm_lock *lock, *tmp;
2035
2036         ENTRY;
2037
2038         list_for_each_entry_safe(lock, tmp, bl_list, l_bl_ast) {
2039                 LASSERT(!list_empty(&lock->l_bl_ast));
2040                 list_del_init(&lock->l_bl_ast);
2041                 ldlm_clear_ast_sent(lock);
2042                 LASSERT(lock->l_bl_ast_run == 0);
2043                 ldlm_clear_blocking_lock(lock);
2044                 LDLM_LOCK_RELEASE(lock);
2045         }
2046         EXIT;
2047 }
2048
2049 /**
2050  * Process a call to blocking AST callback for a lock in ast_work list
2051  */
2052 static int
2053 ldlm_work_bl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2054 {
2055         struct ldlm_cb_set_arg *arg = opaq;
2056         struct ldlm_lock *lock;
2057         struct ldlm_lock_desc d;
2058         struct ldlm_bl_desc bld;
2059         int rc;
2060
2061         ENTRY;
2062
2063         if (list_empty(arg->list))
2064                 RETURN(-ENOENT);
2065
2066         lock = list_entry(arg->list->next, struct ldlm_lock, l_bl_ast);
2067
2068         /* nobody should touch l_bl_ast but some locks in the list may become
2069          * granted after lock convert or COS downgrade, these locks should be
2070          * just skipped here and removed from the list.
2071          */
2072         lock_res_and_lock(lock);
2073         list_del_init(&lock->l_bl_ast);
2074
2075         /* lock is not blocking lock anymore, but was kept in the list because
2076          * it can managed only here.
2077          */
2078         if (!ldlm_is_ast_sent(lock)) {
2079                 unlock_res_and_lock(lock);
2080                 LDLM_LOCK_RELEASE(lock);
2081                 RETURN(0);
2082         }
2083
2084         LASSERT(lock->l_blocking_lock);
2085         ldlm_lock2desc(lock->l_blocking_lock, &d);
2086         /* copy blocking lock ibits in cancel_bits as well,
2087          * new client may use them for lock convert and it is
2088          * important to use new field to convert locks from
2089          * new servers only
2090          */
2091         d.l_policy_data.l_inodebits.cancel_bits =
2092                 lock->l_blocking_lock->l_policy_data.l_inodebits.bits;
2093
2094         /* Blocking lock is being destroyed here but some information about it
2095          * may be needed inside l_blocking_ast() function below,
2096          * e.g. in mdt_blocking_ast(). So save needed data in bl_desc.
2097          */
2098         bld.bl_same_client = lock->l_client_cookie ==
2099                              lock->l_blocking_lock->l_client_cookie;
2100         bld.bl_cos_incompat = ldlm_is_cos_incompat(lock->l_blocking_lock);
2101         arg->bl_desc = &bld;
2102
2103         LASSERT(ldlm_is_ast_sent(lock));
2104         LASSERT(lock->l_bl_ast_run == 0);
2105         lock->l_bl_ast_run++;
2106         ldlm_clear_blocking_lock(lock);
2107         unlock_res_and_lock(lock);
2108
2109         rc = lock->l_blocking_ast(lock, &d, (void *)arg, LDLM_CB_BLOCKING);
2110
2111         LDLM_LOCK_RELEASE(lock);
2112
2113         RETURN(rc);
2114 }
2115
2116 /**
2117  * Process a call to revocation AST callback for a lock in ast_work list
2118  */
2119 static int
2120 ldlm_work_revoke_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2121 {
2122         struct ldlm_cb_set_arg *arg = opaq;
2123         struct ldlm_lock_desc   desc;
2124         int                     rc;
2125         struct ldlm_lock       *lock;
2126         ENTRY;
2127
2128         if (list_empty(arg->list))
2129                 RETURN(-ENOENT);
2130
2131         lock = list_entry(arg->list->next, struct ldlm_lock, l_rk_ast);
2132         list_del_init(&lock->l_rk_ast);
2133
2134         /* the desc just pretend to exclusive */
2135         ldlm_lock2desc(lock, &desc);
2136         desc.l_req_mode = LCK_EX;
2137         desc.l_granted_mode = 0;
2138
2139         rc = lock->l_blocking_ast(lock, &desc, (void*)arg, LDLM_CB_BLOCKING);
2140         LDLM_LOCK_RELEASE(lock);
2141
2142         RETURN(rc);
2143 }
2144
2145 /**
2146  * Process a call to glimpse AST callback for a lock in ast_work list
2147  */
2148 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2149 {
2150         struct ldlm_cb_set_arg          *arg = opaq;
2151         struct ldlm_glimpse_work        *gl_work;
2152         struct ldlm_lock                *lock;
2153         int                              rc = 0;
2154         ENTRY;
2155
2156         if (list_empty(arg->list))
2157                 RETURN(-ENOENT);
2158
2159         gl_work = list_entry(arg->list->next, struct ldlm_glimpse_work,
2160                                  gl_list);
2161         list_del_init(&gl_work->gl_list);
2162
2163         lock = gl_work->gl_lock;
2164
2165         /* transfer the glimpse descriptor to ldlm_cb_set_arg */
2166         arg->gl_desc = gl_work->gl_desc;
2167         arg->gl_interpret_reply = gl_work->gl_interpret_reply;
2168         arg->gl_interpret_data = gl_work->gl_interpret_data;
2169
2170         /* invoke the actual glimpse callback */
2171         if (lock->l_glimpse_ast(lock, (void*)arg) == 0)
2172                 rc = 1;
2173
2174         LDLM_LOCK_RELEASE(lock);
2175         if (gl_work->gl_flags & LDLM_GL_WORK_SLAB_ALLOCATED)
2176                 OBD_SLAB_FREE_PTR(gl_work, ldlm_glimpse_work_kmem);
2177         else
2178                 OBD_FREE_PTR(gl_work);
2179
2180         RETURN(rc);
2181 }
2182 #endif
2183
2184 /**
2185  * Process a call to completion AST callback for a lock in ast_work list
2186  */
2187 static int
2188 ldlm_work_cp_ast_lock(struct ptlrpc_request_set *rqset, void *opaq)
2189 {
2190         struct ldlm_cb_set_arg *arg = opaq;
2191         struct ldlm_lock *lock;
2192         ldlm_completion_callback completion_callback;
2193         int rc = 0;
2194
2195         ENTRY;
2196
2197         if (list_empty(arg->list))
2198                 RETURN(-ENOENT);
2199
2200         lock = list_entry(arg->list->next, struct ldlm_lock, l_cp_ast);
2201
2202         /* It's possible to receive a completion AST before we've set
2203          * the l_completion_ast pointer: either because the AST arrived
2204          * before the reply, or simply because there's a small race
2205          * window between receiving the reply and finishing the local
2206          * enqueue. (bug 842)
2207          *
2208          * This can't happen with the blocking_ast, however, because we
2209          * will never call the local blocking_ast until we drop our
2210          * reader/writer reference, which we won't do until we get the
2211          * reply and finish enqueueing. */
2212
2213         /* nobody should touch l_cp_ast */
2214         lock_res_and_lock(lock);
2215         list_del_init(&lock->l_cp_ast);
2216         LASSERT(ldlm_is_cp_reqd(lock));
2217         /* save l_completion_ast since it can be changed by
2218          * mds_intent_policy(), see bug 14225 */
2219         completion_callback = lock->l_completion_ast;
2220         ldlm_clear_cp_reqd(lock);
2221         unlock_res_and_lock(lock);
2222
2223         if (completion_callback != NULL)
2224                 rc = completion_callback(lock, 0, (void *)arg);
2225         LDLM_LOCK_RELEASE(lock);
2226
2227         RETURN(rc);
2228 }
2229
2230 /**
2231  * Process list of locks in need of ASTs being sent.
2232  *
2233  * Used on server to send multiple ASTs together instead of sending one by
2234  * one.
2235  */
2236 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
2237                       ldlm_desc_ast_t ast_type)
2238 {
2239         struct ldlm_cb_set_arg *arg;
2240         set_producer_func work_ast_lock;
2241         int rc;
2242
2243         if (list_empty(rpc_list))
2244                 RETURN(0);
2245
2246         OBD_ALLOC_PTR(arg);
2247         if (arg == NULL)
2248                 RETURN(-ENOMEM);
2249
2250         atomic_set(&arg->restart, 0);
2251         arg->list = rpc_list;
2252
2253         switch (ast_type) {
2254         case LDLM_WORK_CP_AST:
2255                 arg->type = LDLM_CP_CALLBACK;
2256                 work_ast_lock = ldlm_work_cp_ast_lock;
2257                 break;
2258 #ifdef HAVE_SERVER_SUPPORT
2259         case LDLM_WORK_BL_AST:
2260                 arg->type = LDLM_BL_CALLBACK;
2261                 work_ast_lock = ldlm_work_bl_ast_lock;
2262                 break;
2263         case LDLM_WORK_REVOKE_AST:
2264                 arg->type = LDLM_BL_CALLBACK;
2265                 work_ast_lock = ldlm_work_revoke_ast_lock;
2266                 break;
2267         case LDLM_WORK_GL_AST:
2268                 arg->type = LDLM_GL_CALLBACK;
2269                 work_ast_lock = ldlm_work_gl_ast_lock;
2270                 break;
2271 #endif
2272         default:
2273                 LBUG();
2274         }
2275
2276         /* We create a ptlrpc request set with flow control extension.
2277          * This request set will use the work_ast_lock function to produce new
2278          * requests and will send a new request each time one completes in order
2279          * to keep the number of requests in flight to ns_max_parallel_ast */
2280         arg->set = ptlrpc_prep_fcset(ns->ns_max_parallel_ast ? : UINT_MAX,
2281                                      work_ast_lock, arg);
2282         if (arg->set == NULL)
2283                 GOTO(out, rc = -ENOMEM);
2284
2285         ptlrpc_set_wait(NULL, arg->set);
2286         ptlrpc_set_destroy(arg->set);
2287
2288         rc = atomic_read(&arg->restart) ? -ERESTART : 0;
2289         GOTO(out, rc);
2290 out:
2291         OBD_FREE_PTR(arg);
2292         return rc;
2293 }
2294
2295 /**
2296  * Try to grant all waiting locks on a resource.
2297  *
2298  * Calls ldlm_reprocess_queue on waiting queue.
2299  *
2300  * Typically called after some resource locks are cancelled to see
2301  * if anything could be granted as a result of the cancellation.
2302  */
2303 static void __ldlm_reprocess_all(struct ldlm_resource *res,
2304                                  enum ldlm_process_intention intention)
2305 {
2306         struct list_head rpc_list;
2307 #ifdef HAVE_SERVER_SUPPORT
2308         struct obd_device *obd;
2309         int rc;
2310         ENTRY;
2311
2312         INIT_LIST_HEAD(&rpc_list);
2313         /* Local lock trees don't get reprocessed. */
2314         if (ns_is_client(ldlm_res_to_ns(res))) {
2315                 EXIT;
2316                 return;
2317         }
2318
2319         /* Disable reprocess during lock replay stage but allow during
2320          * request replay stage.
2321          */
2322         obd = ldlm_res_to_ns(res)->ns_obd;
2323         if (obd->obd_recovering &&
2324             atomic_read(&obd->obd_req_replay_clients) == 0)
2325                 RETURN_EXIT;
2326 restart:
2327         lock_res(res);
2328         ldlm_reprocess_queue(res, &res->lr_waiting, &rpc_list, intention);
2329         unlock_res(res);
2330
2331         rc = ldlm_run_ast_work(ldlm_res_to_ns(res), &rpc_list,
2332                                LDLM_WORK_CP_AST);
2333         if (rc == -ERESTART) {
2334                 LASSERT(list_empty(&rpc_list));
2335                 goto restart;
2336         }
2337 #else
2338         ENTRY;
2339
2340         INIT_LIST_HEAD(&rpc_list);
2341         if (!ns_is_client(ldlm_res_to_ns(res))) {
2342                 CERROR("This is client-side-only module, cannot handle "
2343                        "LDLM_NAMESPACE_SERVER resource type lock.\n");
2344                 LBUG();
2345         }
2346 #endif
2347         EXIT;
2348 }
2349
2350 void ldlm_reprocess_all(struct ldlm_resource *res)
2351 {
2352         __ldlm_reprocess_all(res, LDLM_PROCESS_RESCAN);
2353 }
2354 EXPORT_SYMBOL(ldlm_reprocess_all);
2355
2356 static int ldlm_reprocess_res(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2357                               struct hlist_node *hnode, void *arg)
2358 {
2359         struct ldlm_resource *res = cfs_hash_object(hs, hnode);
2360
2361         /* This is only called once after recovery done. LU-8306. */
2362         __ldlm_reprocess_all(res, LDLM_PROCESS_RECOVERY);
2363         return 0;
2364 }
2365
2366 /**
2367  * Iterate through all resources on a namespace attempting to grant waiting
2368  * locks.
2369  */
2370 void ldlm_reprocess_recovery_done(struct ldlm_namespace *ns)
2371 {
2372         ENTRY;
2373
2374         if (ns != NULL) {
2375                 cfs_hash_for_each_nolock(ns->ns_rs_hash,
2376                                          ldlm_reprocess_res, NULL, 0);
2377         }
2378         EXIT;
2379 }
2380
2381 /**
2382  * Helper function to call blocking AST for LDLM lock \a lock in a
2383  * "cancelling" mode.
2384  */
2385 void ldlm_cancel_callback(struct ldlm_lock *lock)
2386 {
2387         check_res_locked(lock->l_resource);
2388         if (!ldlm_is_cancel(lock)) {
2389                 ldlm_set_cancel(lock);
2390                 if (lock->l_blocking_ast) {
2391                         unlock_res_and_lock(lock);
2392                         lock->l_blocking_ast(lock, NULL, lock->l_ast_data,
2393                                              LDLM_CB_CANCELING);
2394                         lock_res_and_lock(lock);
2395                 } else {
2396                         LDLM_DEBUG(lock, "no blocking ast");
2397                 }
2398
2399                 /* only canceller can set bl_done bit */
2400                 ldlm_set_bl_done(lock);
2401                 wake_up_all(&lock->l_waitq);
2402         } else if (!ldlm_is_bl_done(lock)) {
2403                 struct l_wait_info lwi = { 0 };
2404
2405                 /* The lock is guaranteed to have been canceled once
2406                  * returning from this function. */
2407                 unlock_res_and_lock(lock);
2408                 l_wait_event(lock->l_waitq, is_bl_done(lock), &lwi);
2409                 lock_res_and_lock(lock);
2410         }
2411 }
2412
2413 /**
2414  * Remove skiplist-enabled LDLM lock \a req from granted list
2415  */
2416 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req)
2417 {
2418         if (req->l_resource->lr_type != LDLM_PLAIN &&
2419             req->l_resource->lr_type != LDLM_IBITS)
2420                 return;
2421
2422         list_del_init(&req->l_sl_policy);
2423         list_del_init(&req->l_sl_mode);
2424 }
2425
2426 /**
2427  * Attempts to cancel LDLM lock \a lock that has no reader/writer references.
2428  */
2429 void ldlm_lock_cancel(struct ldlm_lock *lock)
2430 {
2431         struct ldlm_resource *res;
2432         struct ldlm_namespace *ns;
2433         ENTRY;
2434
2435         lock_res_and_lock(lock);
2436
2437         res = lock->l_resource;
2438         ns  = ldlm_res_to_ns(res);
2439
2440         /* Please do not, no matter how tempting, remove this LBUG without
2441          * talking to me first. -phik */
2442         if (lock->l_readers || lock->l_writers) {
2443                 LDLM_ERROR(lock, "lock still has references");
2444                 unlock_res_and_lock(lock);
2445                 LBUG();
2446         }
2447
2448         if (ldlm_is_waited(lock))
2449                 ldlm_del_waiting_lock(lock);
2450
2451         /* Releases cancel callback. */
2452         ldlm_cancel_callback(lock);
2453
2454         /* Yes, second time, just in case it was added again while we were
2455          * running with no res lock in ldlm_cancel_callback */
2456         if (ldlm_is_waited(lock))
2457                 ldlm_del_waiting_lock(lock);
2458
2459         ldlm_resource_unlink_lock(lock);
2460         ldlm_lock_destroy_nolock(lock);
2461
2462         if (lock->l_granted_mode == lock->l_req_mode)
2463                 ldlm_pool_del(&ns->ns_pool, lock);
2464
2465         /* Make sure we will not be called again for same lock what is possible
2466          * if not to zero out lock->l_granted_mode */
2467         lock->l_granted_mode = LCK_MINMODE;
2468         unlock_res_and_lock(lock);
2469
2470         EXIT;
2471 }
2472 EXPORT_SYMBOL(ldlm_lock_cancel);
2473
2474 /**
2475  * Set opaque data into the lock that only makes sense to upper layer.
2476  */
2477 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data)
2478 {
2479         struct ldlm_lock *lock = ldlm_handle2lock(lockh);
2480         int rc = -EINVAL;
2481         ENTRY;
2482
2483         if (lock) {
2484                 if (lock->l_ast_data == NULL)
2485                         lock->l_ast_data = data;
2486                 if (lock->l_ast_data == data)
2487                         rc = 0;
2488                 LDLM_LOCK_PUT(lock);
2489         }
2490         RETURN(rc);
2491 }
2492 EXPORT_SYMBOL(ldlm_lock_set_data);
2493
2494 struct export_cl_data {
2495         const struct lu_env     *ecl_env;
2496         struct obd_export       *ecl_exp;
2497         int                     ecl_loop;
2498 };
2499
2500 static void ldlm_cancel_lock_for_export(struct obd_export *exp,
2501                                         struct ldlm_lock *lock,
2502                                         struct export_cl_data *ecl)
2503 {
2504         struct ldlm_resource *res;
2505
2506         res = ldlm_resource_getref(lock->l_resource);
2507
2508         ldlm_lvbo_update(ecl->ecl_env, res, lock, NULL, 1);
2509         ldlm_lock_cancel(lock);
2510         if (!exp->exp_obd->obd_stopping)
2511                 ldlm_reprocess_all(res);
2512         ldlm_resource_putref(res);
2513
2514         ecl->ecl_loop++;
2515         if ((ecl->ecl_loop & -ecl->ecl_loop) == ecl->ecl_loop) {
2516                 CDEBUG(D_INFO, "Export %p, %d locks cancelled.\n",
2517                        exp, ecl->ecl_loop);
2518         }
2519 }
2520
2521 /**
2522  * Iterator function for ldlm_export_cancel_locks.
2523  * Cancels passed locks.
2524  */
2525 static int
2526 ldlm_cancel_locks_for_export_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2527                                 struct hlist_node *hnode, void *data)
2528
2529 {
2530         struct export_cl_data   *ecl = (struct export_cl_data *)data;
2531         struct obd_export       *exp  = ecl->ecl_exp;
2532         struct ldlm_lock        *lock = cfs_hash_object(hs, hnode);
2533
2534         LDLM_LOCK_GET(lock);
2535         ldlm_cancel_lock_for_export(exp, lock, ecl);
2536         LDLM_LOCK_RELEASE(lock);
2537
2538         return 0;
2539 }
2540
2541 /**
2542  * Cancel all blocked locks for given export.
2543  *
2544  * Typically called on client disconnection/eviction
2545  */
2546 int ldlm_export_cancel_blocked_locks(struct obd_export *exp)
2547 {
2548         struct lu_env env;
2549         struct export_cl_data   ecl = {
2550                 .ecl_exp        = exp,
2551                 .ecl_loop       = 0,
2552         };
2553         int rc;
2554
2555         rc = lu_env_init(&env, LCT_DT_THREAD);
2556         if (rc)
2557                 RETURN(rc);
2558         ecl.ecl_env = &env;
2559
2560         while (!list_empty(&exp->exp_bl_list)) {
2561                 struct ldlm_lock *lock;
2562
2563                 spin_lock_bh(&exp->exp_bl_list_lock);
2564                 if (!list_empty(&exp->exp_bl_list)) {
2565                         lock = list_entry(exp->exp_bl_list.next,
2566                                           struct ldlm_lock, l_exp_list);
2567                         LDLM_LOCK_GET(lock);
2568                         list_del_init(&lock->l_exp_list);
2569                 } else {
2570                         lock = NULL;
2571                 }
2572                 spin_unlock_bh(&exp->exp_bl_list_lock);
2573
2574                 if (lock == NULL)
2575                         break;
2576
2577                 ldlm_cancel_lock_for_export(exp, lock, &ecl);
2578                 LDLM_LOCK_RELEASE(lock);
2579         }
2580
2581         lu_env_fini(&env);
2582
2583         CDEBUG(D_DLMTRACE, "Export %p, canceled %d locks, "
2584                "left on hash table %d.\n", exp, ecl.ecl_loop,
2585                atomic_read(&exp->exp_lock_hash->hs_count));
2586
2587         return ecl.ecl_loop;
2588 }
2589
2590 /**
2591  * Cancel all locks for given export.
2592  *
2593  * Typically called after client disconnection/eviction
2594  */
2595 int ldlm_export_cancel_locks(struct obd_export *exp)
2596 {
2597         struct export_cl_data ecl;
2598         struct lu_env env;
2599         int rc;
2600
2601         rc = lu_env_init(&env, LCT_DT_THREAD);
2602         if (rc)
2603                 RETURN(rc);
2604         ecl.ecl_env = &env;
2605         ecl.ecl_exp = exp;
2606         ecl.ecl_loop = 0;
2607
2608         cfs_hash_for_each_empty(exp->exp_lock_hash,
2609                                 ldlm_cancel_locks_for_export_cb, &ecl);
2610
2611         CDEBUG(D_DLMTRACE, "Export %p, canceled %d locks, "
2612                "left on hash table %d.\n", exp, ecl.ecl_loop,
2613                atomic_read(&exp->exp_lock_hash->hs_count));
2614
2615         if (ecl.ecl_loop > 0 &&
2616             atomic_read(&exp->exp_lock_hash->hs_count) == 0 &&
2617             exp->exp_obd->obd_stopping)
2618                 ldlm_reprocess_recovery_done(exp->exp_obd->obd_namespace);
2619
2620         lu_env_fini(&env);
2621
2622         return ecl.ecl_loop;
2623 }
2624
2625 /**
2626  * Downgrade an PW/EX lock to COS mode.
2627  *
2628  * A lock mode convertion from PW/EX mode to less conflict mode. The
2629  * convertion may fail if lock was canceled before downgrade, but it doesn't
2630  * indicate any problem, because such lock has no reader or writer, and will
2631  * be released soon.
2632  *
2633  * Used by Commit on Sharing (COS) code to force object changes commit in case
2634  * of conflict. Converted lock is considered as new lock and all blocking AST
2635  * things are cleared, so any pending or new blocked lock on that lock will
2636  * cause new call to blocking_ast and force resource object commit.
2637  *
2638  * \param lock A lock to convert
2639  * \param new_mode new lock mode
2640  */
2641 void ldlm_lock_mode_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode)
2642 {
2643 #ifdef HAVE_SERVER_SUPPORT
2644         ENTRY;
2645
2646         LASSERT(new_mode == LCK_COS);
2647
2648         lock_res_and_lock(lock);
2649
2650         if (!(lock->l_granted_mode & (LCK_PW | LCK_EX))) {
2651                 unlock_res_and_lock(lock);
2652
2653                 LASSERT(lock->l_granted_mode == LCK_MINMODE);
2654                 LDLM_DEBUG(lock, "lock was canceled before downgrade");
2655                 RETURN_EXIT;
2656         }
2657
2658         ldlm_resource_unlink_lock(lock);
2659         /*
2660          * Remove the lock from pool as it will be added again in
2661          * ldlm_grant_lock() called below.
2662          */
2663         ldlm_pool_del(&ldlm_lock_to_ns(lock)->ns_pool, lock);
2664
2665         /* Consider downgraded lock as a new lock and clear all states
2666          * related to a previous blocking AST processing.
2667          */
2668         ldlm_clear_blocking_data(lock);
2669
2670         lock->l_req_mode = new_mode;
2671         ldlm_grant_lock(lock, NULL);
2672         unlock_res_and_lock(lock);
2673
2674         ldlm_reprocess_all(lock->l_resource);
2675
2676         EXIT;
2677 #endif
2678 }
2679 EXPORT_SYMBOL(ldlm_lock_mode_downgrade);
2680
2681 /**
2682  * Print lock with lock handle \a lockh description into debug log.
2683  *
2684  * Used when printing all locks on a resource for debug purposes.
2685  */
2686 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh)
2687 {
2688         struct ldlm_lock *lock;
2689
2690         if (!((libcfs_debug | D_ERROR) & level))
2691                 return;
2692
2693         lock = ldlm_handle2lock(lockh);
2694         if (lock == NULL)
2695                 return;
2696
2697         LDLM_DEBUG_LIMIT(level, lock, "###");
2698
2699         LDLM_LOCK_PUT(lock);
2700 }
2701 EXPORT_SYMBOL(ldlm_lock_dump_handle);
2702
2703 /**
2704  * Print lock information with custom message into debug log.
2705  * Helper function.
2706  */
2707 void _ldlm_lock_debug(struct ldlm_lock *lock,
2708                       struct libcfs_debug_msg_data *msgdata,
2709                       const char *fmt, ...)
2710 {
2711         va_list args;
2712         struct obd_export *exp = lock->l_export;
2713         struct ldlm_resource *resource = NULL;
2714         char *nid = "local";
2715
2716         /* on server-side resource of lock doesn't change */
2717         if ((lock->l_flags & LDLM_FL_NS_SRV) != 0) {
2718                 if (lock->l_resource != NULL)
2719                         resource = ldlm_resource_getref(lock->l_resource);
2720         } else if (spin_trylock(&lock->l_lock)) {
2721                 if (lock->l_resource != NULL)
2722                         resource = ldlm_resource_getref(lock->l_resource);
2723                 spin_unlock(&lock->l_lock);
2724         }
2725
2726         va_start(args, fmt);
2727
2728         if (exp && exp->exp_connection) {
2729                 nid = obd_export_nid2str(exp);
2730         } else if (exp && exp->exp_obd != NULL) {
2731                 struct obd_import *imp = exp->exp_obd->u.cli.cl_import;
2732                 nid = obd_import_nid2str(imp);
2733         }
2734
2735         if (resource == NULL) {
2736                 libcfs_debug_vmsg2(msgdata, fmt, args,
2737                        " ns: \?\? lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s "
2738                        "res: \?\? rrc=\?\? type: \?\?\? flags: %#llx nid: %s "
2739                        "remote: %#llx expref: %d pid: %u timeout: %lld "
2740                        "lvb_type: %d\n",
2741                        lock,
2742                        lock->l_handle.h_cookie, atomic_read(&lock->l_refc),
2743                        lock->l_readers, lock->l_writers,
2744                        ldlm_lockname[lock->l_granted_mode],
2745                        ldlm_lockname[lock->l_req_mode],
2746                        lock->l_flags, nid, lock->l_remote_handle.cookie,
2747                        exp ? atomic_read(&exp->exp_refcount) : -99,
2748                        lock->l_pid, lock->l_callback_timeout, lock->l_lvb_type);
2749                 va_end(args);
2750                 return;
2751         }
2752
2753         switch (resource->lr_type) {
2754         case LDLM_EXTENT:
2755                 libcfs_debug_vmsg2(msgdata, fmt, args,
2756                         " ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s "
2757                         "res: "DLDLMRES" rrc: %d type: %s [%llu->%llu] "
2758                         "(req %llu->%llu) flags: %#llx nid: %s remote: "
2759                         "%#llx expref: %d pid: %u timeout: %lld lvb_type: %d\n",
2760                         ldlm_lock_to_ns_name(lock), lock,
2761                         lock->l_handle.h_cookie, atomic_read(&lock->l_refc),
2762                         lock->l_readers, lock->l_writers,
2763                         ldlm_lockname[lock->l_granted_mode],
2764                         ldlm_lockname[lock->l_req_mode],
2765                         PLDLMRES(resource),
2766                         atomic_read(&resource->lr_refcount),
2767                         ldlm_typename[resource->lr_type],
2768                         lock->l_policy_data.l_extent.start,
2769                         lock->l_policy_data.l_extent.end,
2770                         lock->l_req_extent.start, lock->l_req_extent.end,
2771                         lock->l_flags, nid, lock->l_remote_handle.cookie,
2772                         exp ? atomic_read(&exp->exp_refcount) : -99,
2773                         lock->l_pid, lock->l_callback_timeout,
2774                         lock->l_lvb_type);
2775                 break;
2776
2777         case LDLM_FLOCK:
2778                 libcfs_debug_vmsg2(msgdata, fmt, args,
2779                         " ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s "
2780                         "res: "DLDLMRES" rrc: %d type: %s pid: %d "
2781                         "[%llu->%llu] flags: %#llx nid: %s "
2782                         "remote: %#llx expref: %d pid: %u timeout: %lld\n",
2783                         ldlm_lock_to_ns_name(lock), lock,
2784                         lock->l_handle.h_cookie, atomic_read(&lock->l_refc),
2785                         lock->l_readers, lock->l_writers,
2786                         ldlm_lockname[lock->l_granted_mode],
2787                         ldlm_lockname[lock->l_req_mode],
2788                         PLDLMRES(resource),
2789                         atomic_read(&resource->lr_refcount),
2790                         ldlm_typename[resource->lr_type],
2791                         lock->l_policy_data.l_flock.pid,
2792                         lock->l_policy_data.l_flock.start,
2793                         lock->l_policy_data.l_flock.end,
2794                         lock->l_flags, nid, lock->l_remote_handle.cookie,
2795                         exp ? atomic_read(&exp->exp_refcount) : -99,
2796                         lock->l_pid, lock->l_callback_timeout);
2797                 break;
2798
2799         case LDLM_IBITS:
2800                 libcfs_debug_vmsg2(msgdata, fmt, args,
2801                         " ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s "
2802                         "res: "DLDLMRES" bits %#llx/%#llx rrc: %d type: %s "
2803                         "flags: %#llx nid: %s remote: %#llx expref: %d "
2804                         "pid: %u timeout: %lld lvb_type: %d\n",
2805                         ldlm_lock_to_ns_name(lock),
2806                         lock, lock->l_handle.h_cookie,
2807                         atomic_read(&lock->l_refc),
2808                         lock->l_readers, lock->l_writers,
2809                         ldlm_lockname[lock->l_granted_mode],
2810                         ldlm_lockname[lock->l_req_mode],
2811                         PLDLMRES(resource),
2812                         lock->l_policy_data.l_inodebits.bits,
2813                         lock->l_policy_data.l_inodebits.try_bits,
2814                         atomic_read(&resource->lr_refcount),
2815                         ldlm_typename[resource->lr_type],
2816                         lock->l_flags, nid, lock->l_remote_handle.cookie,
2817                         exp ? atomic_read(&exp->exp_refcount) : -99,
2818                         lock->l_pid, lock->l_callback_timeout,
2819                         lock->l_lvb_type);
2820                 break;
2821
2822         default:
2823                 libcfs_debug_vmsg2(msgdata, fmt, args,
2824                         " ns: %s lock: %p/%#llx lrc: %d/%d,%d mode: %s/%s "
2825                         "res: "DLDLMRES" rrc: %d type: %s flags: %#llx "
2826                         "nid: %s remote: %#llx expref: %d pid: %u "
2827                         "timeout: %lld lvb_type: %d\n",
2828                         ldlm_lock_to_ns_name(lock),
2829                         lock, lock->l_handle.h_cookie,
2830                         atomic_read(&lock->l_refc),
2831                         lock->l_readers, lock->l_writers,
2832                         ldlm_lockname[lock->l_granted_mode],
2833                         ldlm_lockname[lock->l_req_mode],
2834                         PLDLMRES(resource),
2835                         atomic_read(&resource->lr_refcount),
2836                         ldlm_typename[resource->lr_type],
2837                         lock->l_flags, nid, lock->l_remote_handle.cookie,
2838                         exp ? atomic_read(&exp->exp_refcount) : -99,
2839                         lock->l_pid, lock->l_callback_timeout,
2840                         lock->l_lvb_type);
2841                 break;
2842         }
2843         va_end(args);
2844         ldlm_resource_putref(resource);
2845 }
2846 EXPORT_SYMBOL(_ldlm_lock_debug);