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