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