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