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