Whamcloud - gitweb
LU-16062 ldlm: improve bl_timeout for prolong
[fs/lustre-release.git] / lustre / ldlm / ldlm_lockd.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2010, 2017, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  *
31  * lustre/ldlm/ldlm_lockd.c
32  *
33  * Author: Peter Braam <braam@clusterfs.com>
34  * Author: Phil Schwan <phil@clusterfs.com>
35  */
36
37 #define DEBUG_SUBSYSTEM S_LDLM
38
39 #include <linux/kthread.h>
40 #include <linux/list.h>
41 #include <libcfs/libcfs.h>
42 #include <libcfs/linux/linux-mem.h>
43 #include <lustre_errno.h>
44 #include <lustre_dlm.h>
45 #include <obd_class.h>
46 #include "ldlm_internal.h"
47
48 static int ldlm_num_threads;
49 module_param(ldlm_num_threads, int, 0444);
50 MODULE_PARM_DESC(ldlm_num_threads, "number of DLM service threads to start");
51
52 static unsigned int ldlm_cpu_bind = 1;
53 module_param(ldlm_cpu_bind, uint, 0444);
54 MODULE_PARM_DESC(ldlm_cpu_bind,
55                  "bind DLM service threads to particular CPU partitions");
56
57 static char *ldlm_cpts;
58 module_param(ldlm_cpts, charp, 0444);
59 MODULE_PARM_DESC(ldlm_cpts, "CPU partitions ldlm threads should run on");
60
61 static DEFINE_MUTEX(ldlm_ref_mutex);
62 static int ldlm_refcount;
63
64 struct kobject *ldlm_kobj;
65 struct kset *ldlm_ns_kset;
66 struct kset *ldlm_svc_kset;
67
68 /* LDLM state */
69
70 static struct ldlm_state *ldlm_state;
71
72 /*
73  * timeout for initial callback (AST) reply (bz10399)
74  * Due to having to send a 32 bit time value over the
75  * wire return it as timeout_t instead of time64_t
76  */
77 static inline timeout_t ldlm_get_rq_timeout(void)
78 {
79         /* Non-AT value */
80         timeout_t timeout = min(ldlm_timeout, obd_timeout / 3);
81
82         return timeout < 1 ? 1 : timeout;
83 }
84
85 struct ldlm_bl_pool {
86         spinlock_t              blp_lock;
87
88         /*
89          * blp_prio_list is used for callbacks that should be handled
90          * as a priority. It is used for LDLM_FL_DISCARD_DATA requests.
91          * see b=13843
92          */
93         struct list_head        blp_prio_list;
94
95         /*
96          * blp_list is used for all other callbacks which are likely
97          * to take longer to process.
98          */
99         struct list_head        blp_list;
100
101         wait_queue_head_t       blp_waitq;
102         struct completion       blp_comp;
103         atomic_t                blp_num_threads;
104         atomic_t                blp_busy_threads;
105         int                     blp_min_threads;
106         int                     blp_max_threads;
107         int                     blp_total_locks;
108         int                     blp_total_blwis;
109 };
110
111 struct ldlm_bl_work_item {
112         struct list_head        blwi_entry;
113         struct ldlm_namespace   *blwi_ns;
114         struct ldlm_lock_desc   blwi_ld;
115         struct ldlm_lock        *blwi_lock;
116         struct list_head        blwi_head;
117         int                     blwi_count;
118         struct completion       blwi_comp;
119         enum ldlm_cancel_flags  blwi_flags;
120         int                     blwi_mem_pressure;
121 };
122
123 #ifdef HAVE_SERVER_SUPPORT
124
125 /**
126  * Protects both waiting_locks_list and expired_lock_thread.
127  */
128 static DEFINE_SPINLOCK(waiting_locks_spinlock); /* BH lock (timer) */
129
130 /**
131  * List for contended locks.
132  *
133  * As soon as a lock is contended, it gets placed on this list and
134  * expected time to get a response is filled in the lock. A special
135  * thread walks the list looking for locks that should be released and
136  * schedules client evictions for those that have not been released in
137  * time.
138  *
139  * All access to it should be under waiting_locks_spinlock.
140  */
141 static LIST_HEAD(waiting_locks_list);
142 static void waiting_locks_callback(TIMER_DATA_TYPE unused);
143 static CFS_DEFINE_TIMER(waiting_locks_timer, waiting_locks_callback, 0, 0);
144
145 enum elt_state {
146         ELT_STOPPED,
147         ELT_READY,
148         ELT_TERMINATE,
149 };
150
151 static DECLARE_WAIT_QUEUE_HEAD(expired_lock_wait_queue);
152 static enum elt_state expired_lock_thread_state = ELT_STOPPED;
153 static int expired_lock_dump;
154 static LIST_HEAD(expired_lock_list);
155
156 static int ldlm_lock_busy(struct ldlm_lock *lock);
157 static int ldlm_add_waiting_lock(struct ldlm_lock *lock, timeout_t timeout);
158 static int __ldlm_add_waiting_lock(struct ldlm_lock *lock, timeout_t timeout);
159
160 static inline int have_expired_locks(void)
161 {
162         int need_to_run;
163
164         ENTRY;
165         spin_lock_bh(&waiting_locks_spinlock);
166         need_to_run = !list_empty(&expired_lock_list);
167         spin_unlock_bh(&waiting_locks_spinlock);
168
169         RETURN(need_to_run);
170 }
171
172 /**
173  * Check expired lock list for expired locks and time them out.
174  */
175 static int expired_lock_main(void *arg)
176 {
177         struct list_head *expired = &expired_lock_list;
178         int do_dump;
179
180         ENTRY;
181
182         expired_lock_thread_state = ELT_READY;
183         wake_up(&expired_lock_wait_queue);
184
185         while (1) {
186                 wait_event_idle(expired_lock_wait_queue,
187                                 have_expired_locks() ||
188                                 expired_lock_thread_state == ELT_TERMINATE);
189
190                 spin_lock_bh(&waiting_locks_spinlock);
191                 if (expired_lock_dump) {
192                         spin_unlock_bh(&waiting_locks_spinlock);
193
194                         /* from waiting_locks_callback, but not in timer */
195                         libcfs_debug_dumplog();
196
197                         spin_lock_bh(&waiting_locks_spinlock);
198                         expired_lock_dump = 0;
199                 }
200
201                 do_dump = 0;
202
203                 while (!list_empty(expired)) {
204                         struct obd_export *export;
205                         struct ldlm_lock *lock;
206
207                         lock = list_entry(expired->next, struct ldlm_lock,
208                                           l_pending_chain);
209                         if ((void *)lock < LP_POISON + PAGE_SIZE &&
210                             (void *)lock >= LP_POISON) {
211                                 spin_unlock_bh(&waiting_locks_spinlock);
212                                 CERROR("free lock on elt list %p\n", lock);
213                                 LBUG();
214                         }
215                         list_del_init(&lock->l_pending_chain);
216                         if ((void *)lock->l_export <
217                              LP_POISON + PAGE_SIZE &&
218                             (void *)lock->l_export >= LP_POISON) {
219                                 CERROR("lock with free export on elt list %p\n",
220                                        lock->l_export);
221                                 lock->l_export = NULL;
222                                 LDLM_ERROR(lock, "free export");
223                                 /*
224                                  * release extra ref grabbed by
225                                  * ldlm_add_waiting_lock() or
226                                  * ldlm_failed_ast()
227                                  */
228                                 LDLM_LOCK_RELEASE(lock);
229                                 continue;
230                         }
231
232                         if (ldlm_is_destroyed(lock)) {
233                                 /*
234                                  * release the lock refcount where
235                                  * waiting_locks_callback() founds
236                                  */
237                                 LDLM_LOCK_RELEASE(lock);
238                                 continue;
239                         }
240                         export = class_export_lock_get(lock->l_export, lock);
241                         spin_unlock_bh(&waiting_locks_spinlock);
242
243                         /* Check if we need to prolong timeout */
244                         if (!OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_HPREQ_TIMEOUT) &&
245                             lock->l_callback_timestamp != 0 && /* not AST error */
246                             ldlm_lock_busy(lock)) {
247                                 LDLM_DEBUG(lock, "prolong the busy lock");
248                                 lock_res_and_lock(lock);
249                                 ldlm_add_waiting_lock(lock,
250                                                 ldlm_bl_timeout(lock) >> 1);
251                                 unlock_res_and_lock(lock);
252                         } else {
253                                 spin_lock_bh(&export->exp_bl_list_lock);
254                                 list_del_init(&lock->l_exp_list);
255                                 spin_unlock_bh(&export->exp_bl_list_lock);
256
257                                 LDLM_ERROR(lock,
258                                            "lock callback timer expired after %llds: evicting client at %s ",
259                                            ktime_get_seconds() -
260                                            lock->l_blast_sent,
261                                            obd_export_nid2str(export));
262                                 ldlm_lock_to_ns(lock)->ns_timeouts++;
263                                 if (do_dump_on_eviction(export->exp_obd))
264                                         do_dump++;
265                                 class_fail_export(export);
266                         }
267                         class_export_lock_put(export, lock);
268                         /*
269                          * release extra ref grabbed by ldlm_add_waiting_lock()
270                          * or ldlm_failed_ast()
271                          */
272                         LDLM_LOCK_RELEASE(lock);
273
274                         spin_lock_bh(&waiting_locks_spinlock);
275                 }
276                 spin_unlock_bh(&waiting_locks_spinlock);
277
278                 if (do_dump) {
279                         CERROR("dump the log upon eviction\n");
280                         libcfs_debug_dumplog();
281                 }
282
283                 if (expired_lock_thread_state == ELT_TERMINATE)
284                         break;
285         }
286
287         expired_lock_thread_state = ELT_STOPPED;
288         wake_up(&expired_lock_wait_queue);
289         RETURN(0);
290 }
291
292 /**
293  * Check if there is a request in the export request list
294  * which prevents the lock canceling.
295  */
296 static int ldlm_lock_busy(struct ldlm_lock *lock)
297 {
298         struct ptlrpc_request *req;
299         int match = 0;
300
301         ENTRY;
302
303         if (lock->l_export == NULL)
304                 return 0;
305
306         spin_lock(&lock->l_export->exp_rpc_lock);
307         list_for_each_entry(req, &lock->l_export->exp_hp_rpcs,
308                                 rq_exp_list) {
309                 if (req->rq_ops->hpreq_lock_match) {
310                         match = req->rq_ops->hpreq_lock_match(req, lock);
311                         if (match)
312                                 break;
313                 }
314         }
315         spin_unlock(&lock->l_export->exp_rpc_lock);
316         RETURN(match);
317 }
318
319 /* This is called from within a timer interrupt and cannot schedule */
320 static void waiting_locks_callback(TIMER_DATA_TYPE unused)
321 {
322         struct ldlm_lock *lock;
323         int need_dump = 0;
324
325         spin_lock_bh(&waiting_locks_spinlock);
326         while (!list_empty(&waiting_locks_list)) {
327                 lock = list_entry(waiting_locks_list.next, struct ldlm_lock,
328                                   l_pending_chain);
329                 if (lock->l_callback_timestamp > ktime_get_seconds() ||
330                     lock->l_req_mode == LCK_GROUP)
331                         break;
332
333                 /*
334                  * no needs to take an extra ref on the lock since it was in
335                  * the waiting_locks_list and ldlm_add_waiting_lock()
336                  * already grabbed a ref
337                  */
338                 list_move(&lock->l_pending_chain, &expired_lock_list);
339                 need_dump = 1;
340         }
341
342         if (!list_empty(&expired_lock_list)) {
343                 if (obd_dump_on_timeout && need_dump)
344                         expired_lock_dump = __LINE__;
345
346                 wake_up(&expired_lock_wait_queue);
347         }
348
349         /*
350          * Make sure the timer will fire again if we have any locks
351          * left.
352          */
353         if (!list_empty(&waiting_locks_list)) {
354                 time64_t now = ktime_get_seconds();
355                 timeout_t delta = 0;
356
357                 lock = list_entry(waiting_locks_list.next, struct ldlm_lock,
358                                   l_pending_chain);
359                 if (lock->l_callback_timestamp - now > 0)
360                         delta = lock->l_callback_timestamp - now;
361                 mod_timer(&waiting_locks_timer,
362                           jiffies + cfs_time_seconds(delta));
363         }
364         spin_unlock_bh(&waiting_locks_spinlock);
365 }
366
367 /**
368  * Add lock to the list of contended locks.
369  *
370  * Indicate that we're waiting for a client to call us back cancelling a given
371  * lock.  We add it to the pending-callback chain, and schedule the lock-timeout
372  * timer to fire appropriately.  (We round up to the next second, to avoid
373  * floods of timer firings during periods of high lock contention and traffic).
374  * As done by ldlm_add_waiting_lock(), the caller must grab a lock reference
375  * if it has been added to the waiting list (1 is returned).
376  *
377  * Called with the namespace lock held.
378  */
379 static int __ldlm_add_waiting_lock(struct ldlm_lock *lock, timeout_t delay)
380 {
381         unsigned long timeout_jiffies = jiffies;
382         time64_t deadline;
383         timeout_t timeout;
384
385         lock->l_blast_sent = ktime_get_seconds();
386         if (!list_empty(&lock->l_pending_chain))
387                 return 0;
388
389         if (OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_HPREQ_NOTIMEOUT) ||
390             OBD_FAIL_CHECK(OBD_FAIL_PTLRPC_HPREQ_TIMEOUT))
391                 delay = 1;
392
393         deadline = lock->l_blast_sent + delay;
394         if (likely(deadline > lock->l_callback_timestamp))
395                 lock->l_callback_timestamp = deadline;
396
397         timeout = clamp_t(timeout_t,
398                           lock->l_callback_timestamp - lock->l_blast_sent,
399                           0, delay);
400         timeout_jiffies += cfs_time_seconds(timeout);
401
402         if (time_before(timeout_jiffies, waiting_locks_timer.expires) ||
403             !timer_pending(&waiting_locks_timer))
404                 mod_timer(&waiting_locks_timer, timeout_jiffies);
405
406         /*
407          * if the new lock has a shorter timeout than something earlier on
408          * the list, we'll wait the longer amount of time; no big deal.
409          */
410         /* FIFO */
411         list_add_tail(&lock->l_pending_chain, &waiting_locks_list);
412         return 1;
413 }
414
415 static void ldlm_add_blocked_lock(struct ldlm_lock *lock)
416 {
417         spin_lock_bh(&lock->l_export->exp_bl_list_lock);
418         if (list_empty(&lock->l_exp_list)) {
419                 if (!ldlm_is_granted(lock))
420                         list_add_tail(&lock->l_exp_list,
421                                       &lock->l_export->exp_bl_list);
422                 else
423                         list_add(&lock->l_exp_list,
424                                  &lock->l_export->exp_bl_list);
425         }
426         spin_unlock_bh(&lock->l_export->exp_bl_list_lock);
427
428         /*
429          * A blocked lock is added. Adjust the position in
430          * the stale list if the export is in the list.
431          * If export is stale and not in the list - it is being
432          * processed and will be placed on the right position
433          * on obd_stale_export_put().
434          */
435         if (!list_empty(&lock->l_export->exp_stale_list))
436                 obd_stale_export_adjust(lock->l_export);
437 }
438
439 static int ldlm_add_waiting_lock(struct ldlm_lock *lock, timeout_t timeout)
440 {
441         int ret;
442
443         /* NB: must be called with hold of lock_res_and_lock() */
444         LASSERT(ldlm_is_res_locked(lock));
445         LASSERT(!ldlm_is_cancel_on_block(lock));
446
447         /*
448          * Do not put cross-MDT lock in the waiting list, since we
449          * will not evict it due to timeout for now
450          */
451         if (lock->l_export != NULL &&
452             (exp_connect_flags(lock->l_export) & OBD_CONNECT_MDS_MDS))
453                 return 0;
454
455         spin_lock_bh(&waiting_locks_spinlock);
456         if (ldlm_is_cancel(lock)) {
457                 spin_unlock_bh(&waiting_locks_spinlock);
458                 return 0;
459         }
460
461         if (ldlm_is_destroyed(lock)) {
462                 static time64_t next;
463
464                 spin_unlock_bh(&waiting_locks_spinlock);
465                 LDLM_ERROR(lock, "not waiting on destroyed lock (b=5653)");
466                 if (ktime_get_seconds() > next) {
467                         next = ktime_get_seconds() + 14400;
468                         libcfs_debug_dumpstack(NULL);
469                 }
470                 return 0;
471         }
472
473         ldlm_set_waited(lock);
474         ret = __ldlm_add_waiting_lock(lock, timeout);
475         if (ret) {
476                 /*
477                  * grab ref on the lock if it has been added to the
478                  * waiting list
479                  */
480                 LDLM_LOCK_GET(lock);
481         }
482         spin_unlock_bh(&waiting_locks_spinlock);
483
484         if (ret)
485                 ldlm_add_blocked_lock(lock);
486
487         LDLM_DEBUG(lock, "%sadding to wait list(timeout: %d, AT: %s)",
488                    ret == 0 ? "not re-" : "", timeout,
489                    AT_OFF ? "off" : "on");
490         return ret;
491 }
492
493 /**
494  * Remove a lock from the pending list, likely because it had its cancellation
495  * callback arrive without incident.  This adjusts the lock-timeout timer if
496  * needed.  Returns 0 if the lock wasn't pending after all, 1 if it was.
497  * As done by ldlm_del_waiting_lock(), the caller must release the lock
498  * reference when the lock is removed from any list (1 is returned).
499  *
500  * Called with namespace lock held.
501  */
502 static int __ldlm_del_waiting_lock(struct ldlm_lock *lock)
503 {
504         struct list_head *list_next;
505
506         if (list_empty(&lock->l_pending_chain))
507                 return 0;
508
509         list_next = lock->l_pending_chain.next;
510         if (lock->l_pending_chain.prev == &waiting_locks_list) {
511                 /* Removing the head of the list, adjust timer. */
512                 if (list_next == &waiting_locks_list) {
513                         /* No more, just cancel. */
514                         del_timer(&waiting_locks_timer);
515                 } else {
516                         time64_t now = ktime_get_seconds();
517                         struct ldlm_lock *next;
518                         timeout_t delta = 0;
519
520                         next = list_entry(list_next, struct ldlm_lock,
521                                           l_pending_chain);
522                         if (next->l_callback_timestamp - now > 0)
523                                 delta = lock->l_callback_timestamp - now;
524
525                         mod_timer(&waiting_locks_timer,
526                                   jiffies + cfs_time_seconds(delta));
527                 }
528         }
529         list_del_init(&lock->l_pending_chain);
530
531         return 1;
532 }
533
534 int ldlm_del_waiting_lock(struct ldlm_lock *lock)
535 {
536         int ret;
537
538         if (lock->l_export == NULL) {
539                 /* We don't have a "waiting locks list" on clients. */
540                 CDEBUG(D_DLMTRACE, "Client lock %p : no-op\n", lock);
541                 return 0;
542         }
543
544         spin_lock_bh(&waiting_locks_spinlock);
545         ret = __ldlm_del_waiting_lock(lock);
546         ldlm_clear_waited(lock);
547         spin_unlock_bh(&waiting_locks_spinlock);
548
549         /* remove the lock out of export blocking list */
550         spin_lock_bh(&lock->l_export->exp_bl_list_lock);
551         list_del_init(&lock->l_exp_list);
552         spin_unlock_bh(&lock->l_export->exp_bl_list_lock);
553
554         if (ret) {
555                 /*
556                  * release lock ref if it has indeed been removed
557                  * from a list
558                  */
559                 LDLM_LOCK_RELEASE(lock);
560         }
561
562         LDLM_DEBUG(lock, "%s", ret == 0 ? "wasn't waiting" : "removed");
563         return ret;
564 }
565
566 /**
567  * Prolong the contended lock waiting time.
568  *
569  * Called with namespace lock held.
570  */
571 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, timeout_t timeout)
572 {
573         if (lock->l_export == NULL) {
574                 /* We don't have a "waiting locks list" on clients. */
575                 LDLM_DEBUG(lock, "client lock: no-op");
576                 return 0;
577         }
578
579         if (exp_connect_flags(lock->l_export) & OBD_CONNECT_MDS_MDS) {
580                 /* We don't have a "waiting locks list" on OSP. */
581                 LDLM_DEBUG(lock, "MDS-MDS lock: no-op");
582                 return 0;
583         }
584
585         spin_lock_bh(&waiting_locks_spinlock);
586
587         if (list_empty(&lock->l_pending_chain)) {
588                 spin_unlock_bh(&waiting_locks_spinlock);
589                 LDLM_DEBUG(lock, "wasn't waiting");
590                 return 0;
591         }
592
593         /*
594          * we remove/add the lock to the waiting list, so no needs to
595          * release/take a lock reference
596          */
597         __ldlm_del_waiting_lock(lock);
598         __ldlm_add_waiting_lock(lock, timeout);
599         spin_unlock_bh(&waiting_locks_spinlock);
600
601         LDLM_DEBUG(lock, "refreshed to %ds", timeout);
602         return 1;
603 }
604 EXPORT_SYMBOL(ldlm_refresh_waiting_lock);
605
606 #else /* HAVE_SERVER_SUPPORT */
607
608 int ldlm_del_waiting_lock(struct ldlm_lock *lock)
609 {
610         RETURN(0);
611 }
612
613 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, timeout_t timeout)
614 {
615         RETURN(0);
616 }
617
618 #endif /* !HAVE_SERVER_SUPPORT */
619
620 #ifdef HAVE_SERVER_SUPPORT
621
622 /**
623  * Calculate the per-export Blocking timeout (covering BL AST, data flush,
624  * lock cancel, and their replies). Used for lock callback timeout and AST
625  * re-send period.
626  *
627  * \param[in] lock        lock which is getting the blocking callback
628  *
629  * \retval            timeout in seconds to wait for the client reply
630  */
631 timeout_t ldlm_bl_timeout(struct ldlm_lock *lock)
632 {
633         timeout_t timeout;
634
635         if (AT_OFF)
636                 return obd_timeout / 2;
637
638         /*
639          * Since these are non-updating timeouts, we should be conservative.
640          * Take more than usually, 150%
641          * It would be nice to have some kind of "early reply" mechanism for
642          * lock callbacks too...
643          */
644         timeout = at_get(&lock->l_export->exp_bl_lock_at);
645         return max_t(timeout_t, timeout + (timeout >> 1),
646                      (timeout_t)ldlm_enqueue_min);
647 }
648 EXPORT_SYMBOL(ldlm_bl_timeout);
649
650 /**
651  * Calculate the per-export Blocking timeout by the given RPC (covering the
652  * reply to this RPC and the next RPC). The next RPC could be still not CANCEL,
653  * but having the lock refresh mechanism it is enough.
654  *
655  * Used for lock refresh timeout when we are in the middle of the process -
656  * BL AST is sent, CANCEL is ahead - it is still 1 reply for the current RPC
657  * and at least 1 RPC (which will trigger another refresh if it will be not
658  * CANCEL) - but more accurate than ldlm_bl_timeout as the timeout is taken
659  * from the RPC (i.e. the view of the client on the current AT) is taken into
660  * account.
661  *
662  * \param[in] req     req which export needs the timeout calculation
663  *
664  * \retval            timeout in seconds to wait for the next client's RPC
665  */
666 timeout_t ldlm_bl_timeout_by_rpc(struct ptlrpc_request *req)
667 {
668         struct ptlrpc_service_part *svcpt = req->rq_rqbd->rqbd_svcpt;
669         timeout_t timeout, req_timeout, at_timeout, netl;
670
671         if (AT_OFF)
672                 return obd_timeout / 2;
673
674         /* A blocked lock means somebody in the cluster is waiting, and we
675          * should not consider the worst ever case, consisting of a chain of
676          * failures on each step, however this timeout should survive a
677          * recovery of at least 1 failure, let this one to be the worst one:
678          * in case a server NID is dead first re-connect is done through the
679          * same router and also times out.
680          *
681          * Either this on the next RPC times out, take the max.
682          * Considering the current RPC, take just the left time.
683          */
684         netl = at_get(&req->rq_export->exp_imp_reverse->imp_at.iat_net_latency);
685         req_timeout = req->rq_deadline - ktime_get_real_seconds() + netl;
686         at_timeout = at_est2timeout(at_get(&svcpt->scp_at_estimate)) + netl;
687         req_timeout = max(req_timeout, at_timeout);
688
689         /* Take 1 re-connect failure and 1 re-connect success into account. */
690         timeout = at_timeout + INITIAL_CONNECT_TIMEOUT + netl + req_timeout;
691
692         /* Client's timeout is calculated as at_est2timeout(), let's be a bit
693          * more conservative than client */
694         return max(timeout + (timeout >> 4), (timeout_t)ldlm_enqueue_min);
695 }
696 EXPORT_SYMBOL(ldlm_bl_timeout_by_rpc);
697
698 /**
699  * Perform lock cleanup if AST sending failed.
700  */
701 static void ldlm_failed_ast(struct ldlm_lock *lock, int rc,
702                             const char *ast_type)
703 {
704         LCONSOLE_ERROR_MSG(0x138,
705                            "%s: A client on nid %s was evicted due to a lock %s callback time out: rc %d\n",
706                            lock->l_export->exp_obd->obd_name,
707                            obd_export_nid2str(lock->l_export), ast_type, rc);
708
709         if (obd_dump_on_timeout)
710                 libcfs_debug_dumplog();
711         spin_lock_bh(&waiting_locks_spinlock);
712         if (__ldlm_del_waiting_lock(lock) == 0)
713                 /*
714                  * the lock was not in any list, grab an extra ref before adding
715                  * the lock to the expired list
716                  */
717                 LDLM_LOCK_GET(lock);
718         /* differentiate it from expired locks */
719         lock->l_callback_timestamp = 0;
720         list_add(&lock->l_pending_chain, &expired_lock_list);
721         wake_up(&expired_lock_wait_queue);
722         spin_unlock_bh(&waiting_locks_spinlock);
723 }
724
725 /**
726  * Perform lock cleanup if AST reply came with error.
727  */
728 static int ldlm_handle_ast_error(struct ldlm_lock *lock,
729                                  struct ptlrpc_request *req, int rc,
730                                  const char *ast_type)
731 {
732         struct lnet_processid *peer = &req->rq_import->imp_connection->c_peer;
733
734         if (!req->rq_replied || (rc && rc != -EINVAL)) {
735                 if (ldlm_is_cancel(lock)) {
736                         LDLM_DEBUG(lock,
737                                    "%s AST (req@%p x%llu) timeout from nid %s, but cancel was received (AST reply lost?)",
738                                    ast_type, req, req->rq_xid,
739                                    libcfs_nidstr(&peer->nid));
740                         ldlm_lock_cancel(lock);
741                         rc = -ERESTART;
742                 } else if (rc == -ENODEV || rc == -ESHUTDOWN ||
743                            (rc == -EIO &&
744                             req->rq_import->imp_state == LUSTRE_IMP_CLOSED)) {
745                         /*
746                          * Upon umount process the AST fails because cannot be
747                          * sent. This shouldn't lead to the client eviction.
748                          * -ENODEV error is returned by ptl_send_rpc() for
749                          *  new request in such import.
750                          * -SHUTDOWN is returned by ptlrpc_import_delay_req()
751                          *  if imp_invalid is set or obd_no_recov.
752                          * Meanwhile there is also check for LUSTRE_IMP_CLOSED
753                          * in ptlrpc_import_delay_req() as well with -EIO code.
754                          * In all such cases errors are ignored.
755                          */
756                         LDLM_DEBUG(lock,
757                                    "%s AST can't be sent due to a server %s failure or umount process: rc = %d\n",
758                                     ast_type,
759                                      req->rq_import->imp_obd->obd_name, rc);
760                 } else {
761                         LDLM_ERROR(lock,
762                                    "client (nid %s) %s %s AST (req@%p x%llu status %d rc %d), evict it",
763                                    libcfs_nidstr(&peer->nid),
764                                    req->rq_replied ? "returned error from" :
765                                    "failed to reply to",
766                                    ast_type, req, req->rq_xid,
767                                    (req->rq_repmsg != NULL) ?
768                                    lustre_msg_get_status(req->rq_repmsg) : 0,
769                                    rc);
770                         ldlm_failed_ast(lock, rc, ast_type);
771                 }
772                 return rc;
773         }
774
775         if (rc == -EINVAL) {
776                 struct ldlm_resource *res = lock->l_resource;
777
778                 LDLM_DEBUG(lock,
779                            "client (nid %s) returned %d from %s AST (req@%p x%llu) - normal race",
780                            libcfs_nidstr(&peer->nid),
781                            req->rq_repmsg ?
782                            lustre_msg_get_status(req->rq_repmsg) : -1,
783                            ast_type, req, req->rq_xid);
784                 if (res) {
785                         /*
786                          * update lvbo to return proper attributes.
787                          * see b=23174
788                          */
789                         ldlm_resource_getref(res);
790                         ldlm_lvbo_update(res, lock, NULL, 1);
791                         ldlm_resource_putref(res);
792                 }
793                 ldlm_lock_cancel(lock);
794                 rc = -ERESTART;
795         }
796
797         return rc;
798 }
799
800 static int ldlm_cb_interpret(const struct lu_env *env,
801                              struct ptlrpc_request *req, void *args, int rc)
802 {
803         struct ldlm_cb_async_args *ca = args;
804         struct ldlm_lock *lock = ca->ca_lock;
805         struct ldlm_cb_set_arg *arg  = ca->ca_set_arg;
806
807         ENTRY;
808
809         LASSERT(lock != NULL);
810
811         switch (arg->type) {
812         case LDLM_GL_CALLBACK:
813                 /*
814                  * Update the LVB from disk if the AST failed
815                  * (this is a legal race)
816                  *
817                  * - Glimpse callback of local lock just returns
818                  *   -ELDLM_NO_LOCK_DATA.
819                  * - Glimpse callback of remote lock might return
820                  *   -ELDLM_NO_LOCK_DATA when inode is cleared. LU-274
821                  */
822                 if (unlikely(arg->gl_interpret_reply)) {
823                         rc = arg->gl_interpret_reply(NULL, req, args, rc);
824                 } else if (rc == -ELDLM_NO_LOCK_DATA) {
825                         LDLM_DEBUG(lock,
826                                    "lost race - client has a lock but no inode");
827                         ldlm_lvbo_update(lock->l_resource, lock, NULL, 1);
828                 } else if (rc != 0) {
829                         rc = ldlm_handle_ast_error(lock, req, rc, "glimpse");
830                 } else {
831                         rc = ldlm_lvbo_update(lock->l_resource,
832                                               lock, req, 1);
833                 }
834                 break;
835         case LDLM_BL_CALLBACK:
836                 if (rc != 0)
837                         rc = ldlm_handle_ast_error(lock, req, rc, "blocking");
838                 break;
839         case LDLM_CP_CALLBACK:
840                 if (rc != 0)
841                         rc = ldlm_handle_ast_error(lock, req, rc, "completion");
842                 break;
843         default:
844                 LDLM_ERROR(lock, "invalid opcode for lock callback %d",
845                            arg->type);
846                 LBUG();
847         }
848
849         /* release extra reference taken in ldlm_ast_fini() */
850         LDLM_LOCK_RELEASE(lock);
851
852         if (rc == -ERESTART)
853                 atomic_inc(&arg->restart);
854
855         RETURN(0);
856 }
857
858 static void ldlm_update_resend(struct ptlrpc_request *req, void *data)
859 {
860         struct ldlm_cb_async_args *ca = data;
861         struct ldlm_lock *lock = ca->ca_lock;
862
863         ldlm_refresh_waiting_lock(lock, ldlm_bl_timeout(lock));
864 }
865
866 static inline int ldlm_ast_fini(struct ptlrpc_request *req,
867                                 struct ldlm_cb_set_arg *arg,
868                                 struct ldlm_lock *lock,
869                                 int instant_cancel)
870 {
871         int rc = 0;
872
873         ENTRY;
874
875         if (unlikely(instant_cancel)) {
876                 rc = ptl_send_rpc(req, 1);
877                 ptlrpc_req_finished(req);
878                 if (rc == 0)
879                         atomic_inc(&arg->restart);
880         } else {
881                 LDLM_LOCK_GET(lock);
882                 ptlrpc_set_add_req(arg->set, req);
883         }
884
885         RETURN(rc);
886 }
887
888 /**
889  * Check if there are requests in the export request list which prevent
890  * the lock canceling and make these requests high priority ones.
891  */
892 static void ldlm_lock_reorder_req(struct ldlm_lock *lock)
893 {
894         struct ptlrpc_request *req;
895
896         ENTRY;
897
898         if (lock->l_export == NULL) {
899                 LDLM_DEBUG(lock, "client lock: no-op");
900                 RETURN_EXIT;
901         }
902
903         spin_lock(&lock->l_export->exp_rpc_lock);
904         list_for_each_entry(req, &lock->l_export->exp_hp_rpcs,
905                             rq_exp_list) {
906                 /*
907                  * Do not process requests that were not yet added to there
908                  * incoming queue or were already removed from there for
909                  * processing. We evaluate ptlrpc_nrs_req_can_move() without
910                  * holding svcpt->scp_req_lock, and then redo the check with
911                  * the lock held once we need to obtain a reliable result.
912                  */
913                 if (ptlrpc_nrs_req_can_move(req) &&
914                     req->rq_ops->hpreq_lock_match &&
915                     req->rq_ops->hpreq_lock_match(req, lock))
916                         ptlrpc_nrs_req_hp_move(req);
917         }
918         spin_unlock(&lock->l_export->exp_rpc_lock);
919         EXIT;
920 }
921
922 /**
923  * ->l_blocking_ast() method for server-side locks. This is invoked when newly
924  * enqueued server lock conflicts with given one.
925  *
926  * Sends blocking AST RPC to the client owning that lock; arms timeout timer
927  * to wait for client response.
928  */
929 int ldlm_server_blocking_ast(struct ldlm_lock *lock,
930                              struct ldlm_lock_desc *desc,
931                              void *data, int flag)
932 {
933         struct ldlm_cb_async_args *ca;
934         struct ldlm_cb_set_arg *arg = data;
935         struct ldlm_request *body;
936         struct ptlrpc_request  *req;
937         int instant_cancel = 0;
938         int rc = 0;
939
940         ENTRY;
941
942         if (flag == LDLM_CB_CANCELING)
943                 /* Don't need to do anything here. */
944                 RETURN(0);
945
946         if (OBD_FAIL_PRECHECK(OBD_FAIL_LDLM_SRV_BL_AST)) {
947                 LDLM_DEBUG(lock, "dropping BL AST");
948                 RETURN(0);
949         }
950
951         LASSERT(lock);
952         LASSERT(data != NULL);
953         if (lock->l_export->exp_obd->obd_recovering != 0)
954                 LDLM_ERROR(lock, "BUG 6063: lock collide during recovery");
955
956         ldlm_lock_reorder_req(lock);
957
958         req = ptlrpc_request_alloc_pack(lock->l_export->exp_imp_reverse,
959                                         &RQF_LDLM_BL_CALLBACK,
960                                         LUSTRE_DLM_VERSION, LDLM_BL_CALLBACK);
961         if (req == NULL)
962                 RETURN(-ENOMEM);
963
964         ca = ptlrpc_req_async_args(ca, req);
965         ca->ca_set_arg = arg;
966         ca->ca_lock = lock;
967
968         req->rq_interpret_reply = ldlm_cb_interpret;
969
970         lock_res_and_lock(lock);
971         if (ldlm_is_destroyed(lock)) {
972                 /* What's the point? */
973                 unlock_res_and_lock(lock);
974                 ptlrpc_req_finished(req);
975                 RETURN(0);
976         }
977
978         if (!ldlm_is_granted(lock)) {
979                 /*
980                  * this blocking AST will be communicated as part of the
981                  * completion AST instead
982                  */
983                 ldlm_add_blocked_lock(lock);
984                 ldlm_set_waited(lock);
985                 unlock_res_and_lock(lock);
986
987                 ptlrpc_req_finished(req);
988                 LDLM_DEBUG(lock, "lock not granted, not sending blocking AST");
989                 RETURN(0);
990         }
991
992         if (ldlm_is_cancel_on_block(lock))
993                 instant_cancel = 1;
994
995         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
996         body->lock_handle[0] = lock->l_remote_handle;
997         body->lock_handle[1].cookie = lock->l_handle.h_cookie;
998         body->lock_desc = *desc;
999         body->lock_flags |= ldlm_flags_to_wire(lock->l_flags & LDLM_FL_AST_MASK);
1000
1001         LDLM_DEBUG(lock, "server preparing blocking AST");
1002
1003         ptlrpc_request_set_replen(req);
1004         ldlm_set_cbpending(lock);
1005         if (instant_cancel) {
1006                 unlock_res_and_lock(lock);
1007                 ldlm_lock_cancel(lock);
1008
1009                 req->rq_no_resend = 1;
1010         } else {
1011                 LASSERT(ldlm_is_granted(lock));
1012                 ldlm_add_waiting_lock(lock, ldlm_bl_timeout(lock));
1013                 unlock_res_and_lock(lock);
1014
1015                 /* Do not resend after lock callback timeout */
1016                 req->rq_delay_limit = ldlm_bl_timeout(lock);
1017                 req->rq_resend_cb = ldlm_update_resend;
1018         }
1019
1020         req->rq_send_state = LUSTRE_IMP_FULL;
1021         /* ptlrpc_request_alloc_pack already set timeout */
1022         if (AT_OFF)
1023                 req->rq_timeout = ldlm_get_rq_timeout();
1024
1025         if (lock->l_export && lock->l_export->exp_nid_stats &&
1026             lock->l_export->exp_nid_stats->nid_ldlm_stats)
1027                 lprocfs_counter_incr(lock->l_export->exp_nid_stats->nid_ldlm_stats,
1028                                      LDLM_BL_CALLBACK - LDLM_FIRST_OPC);
1029
1030         rc = ldlm_ast_fini(req, arg, lock, instant_cancel);
1031
1032         RETURN(rc);
1033 }
1034
1035 /**
1036  * ->l_completion_ast callback for a remote lock in server namespace.
1037  *
1038  *  Sends AST to the client notifying it of lock granting.  If initial
1039  *  lock response was not sent yet, instead of sending another RPC, just
1040  *  mark the lock as granted and client will understand
1041  */
1042 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data)
1043 {
1044         struct ldlm_cb_set_arg *arg = data;
1045         struct ldlm_request *body;
1046         struct ptlrpc_request *req;
1047         struct ldlm_cb_async_args *ca;
1048         int instant_cancel = 0;
1049         int rc = 0;
1050         int lvb_len;
1051
1052         ENTRY;
1053
1054         LASSERT(lock != NULL);
1055         LASSERT(data != NULL);
1056
1057         if (OBD_FAIL_PRECHECK(OBD_FAIL_LDLM_SRV_CP_AST)) {
1058                 LDLM_DEBUG(lock, "dropping CP AST");
1059                 RETURN(0);
1060         }
1061
1062         req = ptlrpc_request_alloc(lock->l_export->exp_imp_reverse,
1063                                    &RQF_LDLM_CP_CALLBACK);
1064         if (req == NULL)
1065                 RETURN(-ENOMEM);
1066
1067         /* server namespace, doesn't need lock */
1068         lvb_len = ldlm_lvbo_size(lock);
1069         /*
1070          * LU-3124 & LU-2187: to not return layout in completion AST because
1071          * it may deadlock for LU-2187, or client may not have enough space
1072          * for large layout. The layout will be returned to client with an
1073          * extra RPC to fetch xattr.lov
1074          */
1075         if (ldlm_has_layout(lock))
1076                 lvb_len = 0;
1077
1078         req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_CLIENT, lvb_len);
1079         rc = ptlrpc_request_pack(req, LUSTRE_DLM_VERSION, LDLM_CP_CALLBACK);
1080         if (rc) {
1081                 ptlrpc_request_free(req);
1082                 RETURN(rc);
1083         }
1084
1085         ca = ptlrpc_req_async_args(ca, req);
1086         ca->ca_set_arg = arg;
1087         ca->ca_lock = lock;
1088
1089         req->rq_interpret_reply = ldlm_cb_interpret;
1090         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1091
1092         body->lock_handle[0] = lock->l_remote_handle;
1093         body->lock_handle[1].cookie = lock->l_handle.h_cookie;
1094         body->lock_flags = ldlm_flags_to_wire(flags);
1095         ldlm_lock2desc(lock, &body->lock_desc);
1096         if (lvb_len > 0) {
1097                 void *lvb = req_capsule_client_get(&req->rq_pill, &RMF_DLM_LVB);
1098                 lvb_len = ldlm_lvbo_fill(lock, lvb, &lvb_len);
1099                 if (lvb_len < 0) {
1100                         /*
1101                          * We still need to send the RPC to wake up the blocked
1102                          * enqueue thread on the client.
1103                          *
1104                          * Consider old client, there is no better way to notify
1105                          * the failure, just zero-sized the LVB, then the client
1106                          * will fail out as "-EPROTO".
1107                          */
1108                         req_capsule_shrink(&req->rq_pill, &RMF_DLM_LVB, 0,
1109                                            RCL_CLIENT);
1110                         instant_cancel = 1;
1111                 } else {
1112                         req_capsule_shrink(&req->rq_pill, &RMF_DLM_LVB, lvb_len,
1113                                            RCL_CLIENT);
1114                 }
1115         }
1116
1117         LDLM_DEBUG(lock, "server preparing completion AST");
1118
1119         ptlrpc_request_set_replen(req);
1120
1121         req->rq_send_state = LUSTRE_IMP_FULL;
1122         /* ptlrpc_request_pack already set timeout */
1123         if (AT_OFF)
1124                 req->rq_timeout = ldlm_get_rq_timeout();
1125
1126         /* We only send real blocking ASTs after the lock is granted */
1127         lock_res_and_lock(lock);
1128         if (ldlm_is_ast_sent(lock)) {
1129                 body->lock_flags |= ldlm_flags_to_wire(LDLM_FL_AST_SENT);
1130                 /* Copy AST flags like LDLM_FL_DISCARD_DATA. */
1131                 body->lock_flags |= ldlm_flags_to_wire(lock->l_flags &
1132                                                        LDLM_FL_AST_MASK);
1133
1134                 /*
1135                  * We might get here prior to ldlm_handle_enqueue setting
1136                  * LDLM_FL_CANCEL_ON_BLOCK flag. Then we will put this lock
1137                  * into waiting list, but this is safe and similar code in
1138                  * ldlm_handle_enqueue will call ldlm_lock_cancel() still,
1139                  * that would not only cancel the lock, but will also remove
1140                  * it from waiting list
1141                  */
1142                 if (ldlm_is_cancel_on_block(lock)) {
1143                         unlock_res_and_lock(lock);
1144                         ldlm_lock_cancel(lock);
1145
1146                         instant_cancel = 1;
1147                         req->rq_no_resend = 1;
1148
1149                         lock_res_and_lock(lock);
1150                 } else {
1151                         /* start the lock-timeout clock */
1152                         ldlm_add_waiting_lock(lock, ldlm_bl_timeout(lock));
1153                         /* Do not resend after lock callback timeout */
1154                         req->rq_delay_limit = ldlm_bl_timeout(lock);
1155                         req->rq_resend_cb = ldlm_update_resend;
1156                 }
1157         }
1158         unlock_res_and_lock(lock);
1159
1160         if (lock->l_export && lock->l_export->exp_nid_stats &&
1161             lock->l_export->exp_nid_stats->nid_ldlm_stats)
1162                 lprocfs_counter_incr(lock->l_export->exp_nid_stats->nid_ldlm_stats,
1163                                      LDLM_CP_CALLBACK - LDLM_FIRST_OPC);
1164
1165         rc = ldlm_ast_fini(req, arg, lock, instant_cancel);
1166
1167         RETURN(lvb_len < 0 ? lvb_len : rc);
1168 }
1169
1170 /**
1171  * Server side ->l_glimpse_ast handler for client locks.
1172  *
1173  * Sends glimpse AST to the client and waits for reply. Then updates
1174  * lvbo with the result.
1175  */
1176 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data)
1177 {
1178         struct ldlm_cb_set_arg *arg = data;
1179         struct ldlm_request *body;
1180         struct ptlrpc_request *req;
1181         struct ldlm_cb_async_args *ca;
1182         int rc;
1183         struct req_format *req_fmt;
1184
1185         ENTRY;
1186
1187         LASSERT(lock != NULL);
1188
1189         if (arg->gl_desc != NULL)
1190                 /* There is a glimpse descriptor to pack */
1191                 req_fmt = &RQF_LDLM_GL_CALLBACK_DESC;
1192         else
1193                 req_fmt = &RQF_LDLM_GL_CALLBACK;
1194
1195         req = ptlrpc_request_alloc_pack(lock->l_export->exp_imp_reverse,
1196                                         req_fmt, LUSTRE_DLM_VERSION,
1197                                         LDLM_GL_CALLBACK);
1198
1199         if (req == NULL)
1200                 RETURN(-ENOMEM);
1201
1202         if (arg->gl_desc != NULL) {
1203                 /* copy the GL descriptor */
1204                 union ldlm_gl_desc      *desc;
1205
1206                 desc = req_capsule_client_get(&req->rq_pill, &RMF_DLM_GL_DESC);
1207                 *desc = *arg->gl_desc;
1208         }
1209
1210         body = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1211         body->lock_handle[0] = lock->l_remote_handle;
1212         ldlm_lock2desc(lock, &body->lock_desc);
1213
1214         ca = ptlrpc_req_async_args(ca, req);
1215         ca->ca_set_arg = arg;
1216         ca->ca_lock = lock;
1217
1218         /* server namespace, doesn't need lock */
1219         req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
1220                              ldlm_lvbo_size(lock));
1221         ptlrpc_request_set_replen(req);
1222
1223         req->rq_send_state = LUSTRE_IMP_FULL;
1224         /* ptlrpc_request_alloc_pack already set timeout */
1225         if (AT_OFF)
1226                 req->rq_timeout = ldlm_get_rq_timeout();
1227
1228         req->rq_interpret_reply = ldlm_cb_interpret;
1229
1230         if (lock->l_export && lock->l_export->exp_nid_stats) {
1231                 struct nid_stat *nid_stats = lock->l_export->exp_nid_stats;
1232
1233                 lprocfs_counter_incr(nid_stats->nid_ldlm_stats,
1234                                      LDLM_GL_CALLBACK - LDLM_FIRST_OPC);
1235         }
1236
1237         rc = ldlm_ast_fini(req, arg, lock, 0);
1238
1239         RETURN(rc);
1240 }
1241 EXPORT_SYMBOL(ldlm_server_glimpse_ast);
1242
1243 int ldlm_glimpse_locks(struct ldlm_resource *res,
1244                        struct list_head *gl_work_list)
1245 {
1246         int rc;
1247
1248         ENTRY;
1249
1250         rc = ldlm_run_ast_work(ldlm_res_to_ns(res), gl_work_list,
1251                                LDLM_WORK_GL_AST);
1252         if (rc == -ERESTART)
1253                 ldlm_reprocess_all(res, 0);
1254
1255         RETURN(rc);
1256 }
1257 EXPORT_SYMBOL(ldlm_glimpse_locks);
1258
1259 /* return LDLM lock associated with a lock callback request */
1260 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req)
1261 {
1262         struct ldlm_cb_async_args *ca;
1263         struct ldlm_lock *lock;
1264
1265         ENTRY;
1266
1267         ca = ptlrpc_req_async_args(ca, req);
1268         lock = ca->ca_lock;
1269         if (lock == NULL)
1270                 RETURN(ERR_PTR(-EFAULT));
1271
1272         RETURN(lock);
1273 }
1274 EXPORT_SYMBOL(ldlm_request_lock);
1275
1276 /**
1277  * Main server-side entry point into LDLM for enqueue. This is called by ptlrpc
1278  * service threads to carry out client lock enqueueing requests.
1279  */
1280 int ldlm_handle_enqueue0(struct ldlm_namespace *ns,
1281                          struct ptlrpc_request *req,
1282                          const struct ldlm_request *dlm_req,
1283                          const struct ldlm_callback_suite *cbs)
1284 {
1285         struct ldlm_reply *dlm_rep;
1286         __u64 flags;
1287         enum ldlm_error err = ELDLM_OK;
1288         struct ldlm_lock *lock = NULL;
1289         void *cookie = NULL;
1290         int rc = 0;
1291         struct ldlm_resource *res = NULL;
1292         const struct lu_env *env = req->rq_svc_thread->t_env;
1293
1294         ENTRY;
1295
1296         LDLM_DEBUG_NOLOCK("server-side enqueue handler START");
1297
1298         ldlm_request_cancel(req, dlm_req, LDLM_ENQUEUE_CANCEL_OFF, LATF_SKIP);
1299         flags = ldlm_flags_from_wire(dlm_req->lock_flags);
1300
1301         LASSERT(req->rq_export);
1302
1303         /* for intent enqueue the stat will be updated inside intent policy */
1304         if (ptlrpc_req2svc(req)->srv_stats != NULL &&
1305             !(dlm_req->lock_flags & LDLM_FL_HAS_INTENT))
1306                 ldlm_svc_get_eopc(dlm_req, ptlrpc_req2svc(req)->srv_stats);
1307
1308         if (req->rq_export && req->rq_export->exp_nid_stats &&
1309             req->rq_export->exp_nid_stats->nid_ldlm_stats)
1310                 lprocfs_counter_incr(req->rq_export->exp_nid_stats->nid_ldlm_stats,
1311                                      LDLM_ENQUEUE - LDLM_FIRST_OPC);
1312
1313         if (unlikely(dlm_req->lock_desc.l_resource.lr_type < LDLM_MIN_TYPE ||
1314                      dlm_req->lock_desc.l_resource.lr_type >= LDLM_MAX_TYPE)) {
1315                 DEBUG_REQ(D_ERROR, req, "invalid lock request type %d",
1316                           dlm_req->lock_desc.l_resource.lr_type);
1317                 GOTO(out, rc = -EFAULT);
1318         }
1319
1320         if (unlikely(dlm_req->lock_desc.l_req_mode <= LCK_MINMODE ||
1321                      dlm_req->lock_desc.l_req_mode >= LCK_MAXMODE ||
1322                      dlm_req->lock_desc.l_req_mode &
1323                      (dlm_req->lock_desc.l_req_mode-1))) {
1324                 DEBUG_REQ(D_ERROR, req, "invalid lock request mode %d",
1325                           dlm_req->lock_desc.l_req_mode);
1326                 GOTO(out, rc = -EFAULT);
1327         }
1328
1329         if (unlikely((flags & LDLM_FL_REPLAY) ||
1330                      (lustre_msg_get_flags(req->rq_reqmsg) & MSG_RESENT))) {
1331                 /* Find an existing lock in the per-export lock hash */
1332                 /*
1333                  * In the function below, .hs_keycmp resolves to
1334                  * ldlm_export_lock_keycmp()
1335                  */
1336                 /* coverity[overrun-buffer-val] */
1337                 lock = cfs_hash_lookup(req->rq_export->exp_lock_hash,
1338                                        (void *)&dlm_req->lock_handle[0]);
1339                 if (lock != NULL) {
1340                         DEBUG_REQ(D_DLMTRACE, req,
1341                                   "found existing lock cookie %#llx",
1342                                   lock->l_handle.h_cookie);
1343                         flags |= LDLM_FL_RESENT;
1344                         GOTO(existing_lock, rc = 0);
1345                 }
1346         } else {
1347                 if (ldlm_reclaim_full()) {
1348                         DEBUG_REQ(D_DLMTRACE, req,
1349                                   "Too many granted locks, reject current enqueue request and let the client retry later");
1350                         GOTO(out, rc = -EINPROGRESS);
1351                 }
1352         }
1353
1354         /* The lock's callback data might be set in the policy function */
1355         lock = ldlm_lock_create(ns, &dlm_req->lock_desc.l_resource.lr_name,
1356                                 dlm_req->lock_desc.l_resource.lr_type,
1357                                 dlm_req->lock_desc.l_req_mode,
1358                                 cbs, NULL, 0, LVB_T_NONE);
1359         if (IS_ERR(lock)) {
1360                 rc = PTR_ERR(lock);
1361                 lock = NULL;
1362                 GOTO(out, rc);
1363         }
1364
1365         lock->l_remote_handle = dlm_req->lock_handle[0];
1366         LDLM_DEBUG(lock, "server-side enqueue handler, new lock created");
1367
1368         /*
1369          * Initialize resource lvb but not for a lock being replayed since
1370          * Client already got lvb sent in this case.
1371          * This must occur early since some policy methods assume resource
1372          * lvb is available (lr_lvb_data != NULL).
1373          */
1374         res = lock->l_resource;
1375         if (!(flags & LDLM_FL_REPLAY)) {
1376                 /* non-replayed lock, delayed lvb init may need to be done */
1377                 rc = ldlm_lvbo_init(res);
1378                 if (rc < 0) {
1379                         LDLM_DEBUG(lock, "delayed lvb init failed (rc %d)", rc);
1380                         GOTO(out, rc);
1381                 }
1382         }
1383
1384         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_ENQUEUE_BLOCKED, obd_timeout * 2);
1385         /*
1386          * Don't enqueue a lock onto the export if it is been disonnected
1387          * due to eviction (b=3822) or server umount (b=24324).
1388          * Cancel it now instead.
1389          */
1390         if (req->rq_export->exp_disconnected) {
1391                 LDLM_ERROR(lock, "lock on disconnected export %p",
1392                            req->rq_export);
1393                 GOTO(out, rc = -ENOTCONN);
1394         }
1395
1396         lock->l_export = class_export_lock_get(req->rq_export, lock);
1397         if (lock->l_export->exp_lock_hash)
1398                 cfs_hash_add(lock->l_export->exp_lock_hash,
1399                              &lock->l_remote_handle,
1400                              &lock->l_exp_hash);
1401
1402         /*
1403          * Inherit the enqueue flags before the operation, because we do not
1404          * keep the res lock on return and next operations (BL AST) may proceed
1405          * without them.
1406          */
1407         lock->l_flags |= ldlm_flags_from_wire(dlm_req->lock_flags &
1408                                               LDLM_FL_INHERIT_MASK);
1409
1410         ldlm_convert_policy_to_local(req->rq_export,
1411                                      dlm_req->lock_desc.l_resource.lr_type,
1412                                      &dlm_req->lock_desc.l_policy_data,
1413                                      &lock->l_policy_data);
1414         if (dlm_req->lock_desc.l_resource.lr_type == LDLM_EXTENT) {
1415                 lock->l_req_extent = lock->l_policy_data.l_extent;
1416         } else if (dlm_req->lock_desc.l_resource.lr_type == LDLM_IBITS) {
1417                 lock->l_policy_data.l_inodebits.try_bits =
1418                         dlm_req->lock_desc.l_policy_data.l_inodebits.try_bits;
1419                 lock->l_policy_data.l_inodebits.li_gid =
1420                         dlm_req->lock_desc.l_policy_data.l_inodebits.li_gid;
1421         }
1422
1423 existing_lock:
1424         cookie = req;
1425         if (!(flags & LDLM_FL_HAS_INTENT)) {
1426                 /* based on the assumption that lvb size never changes during
1427                  * resource life time otherwise it need resource->lr_lock's
1428                  * protection */
1429                 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB,
1430                                      RCL_SERVER, ldlm_lvbo_size(lock));
1431
1432                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_ENQUEUE_EXTENT_ERR))
1433                         GOTO(out, rc = -ENOMEM);
1434
1435                 rc = req_capsule_server_pack(&req->rq_pill);
1436                 if (rc)
1437                         GOTO(out, rc);
1438         }
1439
1440         err = ldlm_lock_enqueue(env, ns, &lock, cookie, &flags);
1441         if (err) {
1442                 if ((int)err < 0)
1443                         rc = (int)err;
1444                 GOTO(out, err);
1445         }
1446
1447         dlm_rep = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
1448
1449         ldlm_lock2desc(lock, &dlm_rep->lock_desc);
1450         ldlm_lock2handle(lock, &dlm_rep->lock_handle);
1451
1452         if (lock && lock->l_resource->lr_type == LDLM_EXTENT)
1453                 OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_BL_EVICT, 6);
1454
1455         /*
1456          * We never send a blocking AST until the lock is granted, but
1457          * we can tell it right now
1458          */
1459         lock_res_and_lock(lock);
1460
1461         /*
1462          * Now take into account flags to be inherited from original lock
1463          * request both in reply to client and in our own lock flags.
1464          */
1465         dlm_rep->lock_flags = ldlm_flags_to_wire(flags);
1466         lock->l_flags |= flags & LDLM_FL_INHERIT_MASK;
1467
1468         /*
1469          * Don't move a pending lock onto the export if it has already been
1470          * disconnected due to eviction (b=5683) or server umount (b=24324).
1471          * Cancel it now instead.
1472          */
1473         if (unlikely(req->rq_export->exp_disconnected ||
1474                      OBD_FAIL_CHECK(OBD_FAIL_LDLM_ENQUEUE_OLD_EXPORT))) {
1475                 LDLM_ERROR(lock, "lock on destroyed export %p", req->rq_export);
1476                 rc = -ENOTCONN;
1477         } else if (ldlm_is_ast_sent(lock)) {
1478                 /* fill lock desc for possible lock convert */
1479                 if (lock->l_blocking_lock &&
1480                     lock->l_resource->lr_type == LDLM_IBITS) {
1481                         struct ldlm_lock *bl_lock = lock->l_blocking_lock;
1482                         struct ldlm_lock_desc *rep_desc = &dlm_rep->lock_desc;
1483
1484                         LDLM_DEBUG(lock,
1485                                    "save blocking bits %llx in granted lock",
1486                                    bl_lock->l_policy_data.l_inodebits.bits);
1487                         /*
1488                          * If lock is blocked then save blocking ibits
1489                          * in returned lock policy for the possible lock
1490                          * convert on a client.
1491                          */
1492                         rep_desc->l_policy_data.l_inodebits.cancel_bits =
1493                                 bl_lock->l_policy_data.l_inodebits.bits;
1494                 }
1495                 dlm_rep->lock_flags |= ldlm_flags_to_wire(LDLM_FL_AST_SENT);
1496                 if (ldlm_is_granted(lock)) {
1497                         /*
1498                          * Only cancel lock if it was granted, because it would
1499                          * be destroyed immediately and would never be granted
1500                          * in the future, causing timeouts on client.  Not
1501                          * granted lock will be cancelled immediately after
1502                          * sending completion AST.
1503                          */
1504                         if (ldlm_is_cancel_on_block(lock)) {
1505                                 unlock_res_and_lock(lock);
1506                                 ldlm_lock_cancel(lock);
1507                                 lock_res_and_lock(lock);
1508                         } else {
1509                                 ldlm_add_waiting_lock(lock,
1510                                                       ldlm_bl_timeout(lock));
1511                         }
1512                 }
1513         }
1514         unlock_res_and_lock(lock);
1515
1516         EXIT;
1517 out:
1518         req->rq_status = rc ?: err; /* return either error - b=11190 */
1519         if (!req->rq_packed_final) {
1520                 int rc1 = lustre_pack_reply(req, 1, NULL, NULL);
1521                 if (rc == 0)
1522                         rc = rc1;
1523         }
1524
1525         /*
1526          * The LOCK_CHANGED code in ldlm_lock_enqueue depends on this
1527          * ldlm_reprocess_all.  If this moves, revisit that code. -phil
1528          */
1529         if (lock != NULL) {
1530                 LDLM_DEBUG(lock,
1531                            "server-side enqueue handler, sending reply (err=%d, rc=%d)",
1532                            err, rc);
1533
1534                 if (rc == 0 &&
1535                     req_capsule_has_field(&req->rq_pill, &RMF_DLM_LVB,
1536                                           RCL_SERVER) &&
1537                     ldlm_lvbo_size(lock) > 0) {
1538                         void *buf;
1539                         int buflen;
1540
1541 retry:
1542                         buf = req_capsule_server_get(&req->rq_pill,
1543                                                      &RMF_DLM_LVB);
1544                         LASSERTF(buf != NULL, "req %p, lock %p\n", req, lock);
1545                         buflen = req_capsule_get_size(&req->rq_pill,
1546                                         &RMF_DLM_LVB, RCL_SERVER);
1547                         /*
1548                          * non-replayed lock, delayed lvb init may
1549                          * need to be occur now
1550                          */
1551                         if ((buflen > 0) && !(flags & LDLM_FL_REPLAY)) {
1552                                 int rc2;
1553
1554                                 rc2 = ldlm_lvbo_fill(lock, buf, &buflen);
1555                                 if (rc2 >= 0) {
1556                                         req_capsule_shrink(&req->rq_pill,
1557                                                            &RMF_DLM_LVB,
1558                                                            rc2, RCL_SERVER);
1559                                 } else if (rc2 == -ERANGE) {
1560                                         rc2 = req_capsule_server_grow(
1561                                                         &req->rq_pill,
1562                                                         &RMF_DLM_LVB, buflen);
1563                                         if (!rc2) {
1564                                                 goto retry;
1565                                         } else {
1566                                                 /*
1567                                                  * if we can't grow the buffer,
1568                                                  * it's ok to return empty lvb
1569                                                  * to client.
1570                                                  */
1571                                                 req_capsule_shrink(
1572                                                         &req->rq_pill,
1573                                                         &RMF_DLM_LVB, 0,
1574                                                         RCL_SERVER);
1575                                         }
1576                                 } else {
1577                                         rc = rc2;
1578                                 }
1579                         } else if (flags & LDLM_FL_REPLAY) {
1580                                 /* no LVB resend upon replay */
1581                                 if (buflen > 0)
1582                                         req_capsule_shrink(&req->rq_pill,
1583                                                            &RMF_DLM_LVB,
1584                                                            0, RCL_SERVER);
1585                                 else
1586                                         rc = buflen;
1587                         } else {
1588                                 rc = buflen;
1589                         }
1590                 }
1591
1592                 if (rc != 0 && !(flags & LDLM_FL_RESENT)) {
1593                         if (lock->l_export) {
1594                                 ldlm_lock_cancel(lock);
1595                         } else {
1596                                 lock_res_and_lock(lock);
1597                                 ldlm_resource_unlink_lock(lock);
1598                                 ldlm_lock_destroy_nolock(lock);
1599                                 unlock_res_and_lock(lock);
1600                         }
1601                         ldlm_reprocess_all(lock->l_resource, lock->l_policy_data.l_inodebits.bits);
1602                 }
1603
1604                 if (!err && !ldlm_is_cbpending(lock) &&
1605                     dlm_req->lock_desc.l_resource.lr_type != LDLM_FLOCK)
1606                         ldlm_reprocess_all(lock->l_resource,
1607                                            lock->l_policy_data.l_inodebits.bits);
1608
1609                 LDLM_LOCK_RELEASE(lock);
1610         }
1611
1612         LDLM_DEBUG_NOLOCK("server-side enqueue handler END (lock %p, rc %d)",
1613                           lock, rc);
1614
1615         return rc;
1616 }
1617
1618 /*
1619  * Clear the blocking lock, the race is possible between ldlm_handle_convert0()
1620  * and ldlm_work_bl_ast_lock(), so this is done under lock with check for NULL.
1621  */
1622 void ldlm_clear_blocking_lock(struct ldlm_lock *lock)
1623 {
1624         if (lock->l_blocking_lock) {
1625                 LDLM_LOCK_RELEASE(lock->l_blocking_lock);
1626                 lock->l_blocking_lock = NULL;
1627         }
1628 }
1629
1630 /* A lock can be converted to new ibits or mode and should be considered
1631  * as new lock. Clear all states related to a previous blocking AST
1632  * processing so new conflicts will cause new blocking ASTs.
1633  *
1634  * This is used during lock convert below and lock downgrade to COS mode in
1635  * ldlm_lock_mode_downgrade().
1636  */
1637 void ldlm_clear_blocking_data(struct ldlm_lock *lock)
1638 {
1639         ldlm_clear_ast_sent(lock);
1640         lock->l_bl_ast_run = 0;
1641         ldlm_clear_blocking_lock(lock);
1642 }
1643
1644 /**
1645  * Main LDLM entry point for server code to process lock conversion requests.
1646  */
1647 int ldlm_handle_convert0(struct ptlrpc_request *req,
1648                          const struct ldlm_request *dlm_req)
1649 {
1650         struct obd_export *exp = req->rq_export;
1651         struct ldlm_reply *dlm_rep;
1652         struct ldlm_lock *lock;
1653         __u64 bits;
1654         __u64 new_bits;
1655         int rc;
1656
1657         ENTRY;
1658
1659         if (exp && exp->exp_nid_stats && exp->exp_nid_stats->nid_ldlm_stats)
1660                 lprocfs_counter_incr(exp->exp_nid_stats->nid_ldlm_stats,
1661                                      LDLM_CONVERT - LDLM_FIRST_OPC);
1662
1663         rc = req_capsule_server_pack(&req->rq_pill);
1664         if (rc)
1665                 RETURN(rc);
1666
1667         dlm_rep = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
1668         dlm_rep->lock_flags = dlm_req->lock_flags;
1669
1670         lock = ldlm_handle2lock(&dlm_req->lock_handle[0]);
1671         if (!lock) {
1672                 LDLM_DEBUG_NOLOCK("server lock is canceled already");
1673                 req->rq_status = ELDLM_NO_LOCK_DATA;
1674                 RETURN(0);
1675         }
1676
1677         LDLM_DEBUG(lock, "server-side convert handler START");
1678
1679         lock_res_and_lock(lock);
1680         bits = lock->l_policy_data.l_inodebits.bits;
1681         new_bits = dlm_req->lock_desc.l_policy_data.l_inodebits.bits;
1682
1683         if (ldlm_is_cancel(lock)) {
1684                 LDLM_DEBUG(lock, "convert on canceled lock!");
1685                 unlock_res_and_lock(lock);
1686                 GOTO(out_put, rc = ELDLM_NO_LOCK_DATA);
1687         }
1688
1689         if (dlm_req->lock_desc.l_req_mode != lock->l_granted_mode) {
1690                 LDLM_ERROR(lock, "lock mode differs!");
1691                 unlock_res_and_lock(lock);
1692                 GOTO(out_put, rc = -EPROTO);
1693         }
1694
1695         if (bits == new_bits) {
1696                 /*
1697                  * This can be valid situation if CONVERT RPCs are
1698                  * re-ordered. Just finish silently
1699                  */
1700                 LDLM_DEBUG(lock, "lock is converted already!");
1701                 unlock_res_and_lock(lock);
1702         } else {
1703                 if (ldlm_is_waited(lock))
1704                         ldlm_del_waiting_lock(lock);
1705
1706                 ldlm_clear_cbpending(lock);
1707                 lock->l_policy_data.l_inodebits.cancel_bits = 0;
1708                 ldlm_inodebits_drop(lock, bits & ~new_bits);
1709
1710                 ldlm_clear_blocking_data(lock);
1711                 unlock_res_and_lock(lock);
1712
1713                 /* All old bits should be reprocessed to send new BL AST if
1714                  * it wasn't sent earlier due to LDLM_FL_AST_SENT bit set.
1715                  * */
1716                 ldlm_reprocess_all(lock->l_resource, bits);
1717         }
1718
1719         dlm_rep->lock_handle = lock->l_remote_handle;
1720         ldlm_ibits_policy_local_to_wire(&lock->l_policy_data,
1721                                         &dlm_rep->lock_desc.l_policy_data);
1722         rc = ELDLM_OK;
1723         EXIT;
1724 out_put:
1725         LDLM_DEBUG(lock, "server-side convert handler END, rc = %d", rc);
1726         LDLM_LOCK_PUT(lock);
1727         req->rq_status = rc;
1728         return 0;
1729 }
1730
1731 /**
1732  * Cancel all the locks whose handles are packed into ldlm_request
1733  *
1734  * Called by server code expecting such combined cancel activity
1735  * requests.
1736  */
1737 int ldlm_request_cancel(struct ptlrpc_request *req,
1738                         const struct ldlm_request *dlm_req,
1739                         int first, enum lustre_at_flags flags)
1740 {
1741         struct ldlm_resource *res, *pres = NULL;
1742         struct ldlm_lock *lock;
1743         int i, count, done = 0;
1744         unsigned int size;
1745
1746         ENTRY;
1747
1748         size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT);
1749         if (size <= offsetof(struct ldlm_request, lock_handle) ||
1750             (size - offsetof(struct ldlm_request, lock_handle)) /
1751              sizeof(struct lustre_handle) < dlm_req->lock_count)
1752                 RETURN(0);
1753
1754         count = dlm_req->lock_count ? dlm_req->lock_count : 1;
1755         if (first >= count)
1756                 RETURN(0);
1757
1758         if (count == 1 && dlm_req->lock_handle[0].cookie == 0)
1759                 RETURN(0);
1760
1761         /*
1762          * There is no lock on the server at the replay time,
1763          * skip lock cancelling to make replay tests to pass.
1764          */
1765         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
1766                 RETURN(0);
1767
1768         LDLM_DEBUG_NOLOCK("server-side cancel handler START: %d locks, starting at %d",
1769                           count, first);
1770
1771         for (i = first; i < count; i++) {
1772                 lock = ldlm_handle2lock(&dlm_req->lock_handle[i]);
1773                 if (!lock) {
1774                         /* below message checked in replay-single.sh test_36 */
1775                         LDLM_DEBUG_NOLOCK("server-side cancel handler stale lock (cookie %llu)",
1776                                           dlm_req->lock_handle[i].cookie);
1777                         continue;
1778                 }
1779
1780                 res = lock->l_resource;
1781                 done++;
1782
1783                 /*
1784                  * This code is an optimization to only attempt lock
1785                  * granting on the resource (that could be CPU-expensive)
1786                  * after we are done cancelling lock in that resource.
1787                  */
1788                 if (res != pres) {
1789                         if (pres != NULL) {
1790                                 ldlm_reprocess_all(pres, 0);
1791                                 LDLM_RESOURCE_DELREF(pres);
1792                                 ldlm_resource_putref(pres);
1793                         }
1794                         if (res != NULL) {
1795                                 ldlm_resource_getref(res);
1796                                 LDLM_RESOURCE_ADDREF(res);
1797
1798                                 if (!ldlm_is_discard_data(lock))
1799                                         ldlm_lvbo_update(res, lock,
1800                                                          NULL, 1);
1801                         }
1802                         pres = res;
1803                 }
1804
1805                 if ((flags & LATF_STATS) && ldlm_is_ast_sent(lock) &&
1806                     lock->l_blast_sent != 0) {
1807                         timeout_t delay = 0;
1808
1809                         if (ktime_get_seconds() > lock->l_blast_sent)
1810                                 delay = ktime_get_seconds() -
1811                                         lock->l_blast_sent;
1812                         LDLM_DEBUG(lock,
1813                                    "server cancels blocked lock after %ds",
1814                                    delay);
1815                         at_measured(&lock->l_export->exp_bl_lock_at, delay);
1816                 }
1817                 ldlm_lock_cancel(lock);
1818                 LDLM_LOCK_PUT(lock);
1819         }
1820         if (pres != NULL) {
1821                 ldlm_reprocess_all(pres, 0);
1822                 LDLM_RESOURCE_DELREF(pres);
1823                 ldlm_resource_putref(pres);
1824         }
1825         LDLM_DEBUG_NOLOCK("server-side cancel handler END");
1826         RETURN(done);
1827 }
1828 EXPORT_SYMBOL(ldlm_request_cancel);
1829
1830 /**
1831  * Main LDLM entry point for server code to cancel locks.
1832  *
1833  * Typically gets called from service handler on LDLM_CANCEL opc.
1834  */
1835 int ldlm_handle_cancel(struct ptlrpc_request *req)
1836 {
1837         struct ldlm_request *dlm_req;
1838         int rc;
1839
1840         ENTRY;
1841
1842         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
1843         if (dlm_req == NULL) {
1844                 CDEBUG(D_INFO, "bad request buffer for cancel\n");
1845                 RETURN(-EFAULT);
1846         }
1847
1848         if (req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT) <
1849             offsetof(struct ldlm_request, lock_handle[1]))
1850                 RETURN(-EPROTO);
1851
1852         if (req->rq_export && req->rq_export->exp_nid_stats &&
1853             req->rq_export->exp_nid_stats->nid_ldlm_stats)
1854                 lprocfs_counter_incr(req->rq_export->exp_nid_stats->nid_ldlm_stats,
1855                                      LDLM_CANCEL - LDLM_FIRST_OPC);
1856
1857         rc = req_capsule_server_pack(&req->rq_pill);
1858         if (rc)
1859                 RETURN(rc);
1860
1861         if (!ldlm_request_cancel(req, dlm_req, 0, LATF_STATS))
1862                 req->rq_status = LUSTRE_ESTALE;
1863
1864         RETURN(ptlrpc_reply(req));
1865 }
1866 #endif /* HAVE_SERVER_SUPPORT */
1867
1868 /**
1869  * Server may pass additional information about blocking lock.
1870  * For IBITS locks it is conflicting bits which can be used for
1871  * lock convert instead of cancel.
1872  */
1873 void ldlm_bl_desc2lock(const struct ldlm_lock_desc *ld, struct ldlm_lock *lock)
1874 {
1875         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1876
1877         check_res_locked(lock->l_resource);
1878         if (ns_is_client(ns) && ld &&
1879             (lock->l_resource->lr_type == LDLM_IBITS)) {
1880                 /*
1881                  * Lock description contains policy of blocking lock,
1882                  * and its cancel_bits is used to pass conflicting bits.
1883                  * NOTE: ld can be NULL or can be not NULL but zeroed if
1884                  * passed from ldlm_bl_thread_blwi(), check below used bits
1885                  * in ld to make sure it is valid description.
1886                  *
1887                  * If server may replace lock resource keeping the same cookie,
1888                  * never use cancel bits from different resource, full cancel
1889                  * is to be used.
1890                  */
1891                 if (ld->l_policy_data.l_inodebits.cancel_bits &&
1892                     ldlm_res_eq(&ld->l_resource.lr_name,
1893                                 &lock->l_resource->lr_name) &&
1894                     !(ldlm_is_cbpending(lock) &&
1895                       lock->l_policy_data.l_inodebits.cancel_bits == 0)) {
1896                         /* always combine conflicting ibits */
1897                         lock->l_policy_data.l_inodebits.cancel_bits |=
1898                                 ld->l_policy_data.l_inodebits.cancel_bits;
1899                 } else {
1900                         /* If cancel_bits are not obtained or
1901                          * if the lock is already CBPENDING and
1902                          * has no cancel_bits set
1903                          * - the full lock is to be cancelled
1904                          */
1905                         lock->l_policy_data.l_inodebits.cancel_bits = 0;
1906                 }
1907         }
1908 }
1909
1910 /**
1911  * Callback handler for receiving incoming blocking ASTs.
1912  *
1913  * This can only happen on client side.
1914  */
1915 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
1916                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock)
1917 {
1918         int do_ast;
1919
1920         ENTRY;
1921
1922         LDLM_DEBUG(lock, "client blocking AST callback handler");
1923
1924         lock_res_and_lock(lock);
1925
1926         /* get extra information from desc if any */
1927         ldlm_bl_desc2lock(ld, lock);
1928         ldlm_set_cbpending(lock);
1929
1930         do_ast = (!lock->l_readers && !lock->l_writers);
1931         unlock_res_and_lock(lock);
1932
1933         if (do_ast) {
1934                 CDEBUG(D_DLMTRACE,
1935                        "Lock %p already unused, calling callback (%p)\n",
1936                        lock, lock->l_blocking_ast);
1937                 if (lock->l_blocking_ast != NULL)
1938                         lock->l_blocking_ast(lock, ld, lock->l_ast_data,
1939                                              LDLM_CB_BLOCKING);
1940         } else {
1941                 CDEBUG(D_DLMTRACE,
1942                        "Lock %p is referenced, will be cancelled later\n",
1943                        lock);
1944         }
1945
1946         LDLM_DEBUG(lock, "client blocking callback handler END");
1947         LDLM_LOCK_RELEASE(lock);
1948         EXIT;
1949 }
1950
1951 static int ldlm_callback_reply(struct ptlrpc_request *req, int rc)
1952 {
1953         if (req->rq_no_reply)
1954                 return 0;
1955
1956         req->rq_status = rc;
1957         if (!req->rq_packed_final) {
1958                 rc = lustre_pack_reply(req, 1, NULL, NULL);
1959                 if (rc)
1960                         return rc;
1961         }
1962         return ptlrpc_reply(req);
1963 }
1964
1965 /**
1966  * Callback handler for receiving incoming completion ASTs.
1967  *
1968  * This only can happen on client side.
1969  */
1970 static int ldlm_handle_cp_callback(struct ptlrpc_request *req,
1971                                     struct ldlm_namespace *ns,
1972                                     struct ldlm_request *dlm_req,
1973                                     struct ldlm_lock *lock)
1974 {
1975         LIST_HEAD(ast_list);
1976         int lvb_len;
1977         int rc = 0;
1978
1979         ENTRY;
1980
1981         LDLM_DEBUG(lock, "client completion callback handler START");
1982
1983         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_BL_CB_RACE)) {
1984                 long to = cfs_time_seconds(1);
1985
1986                 ldlm_callback_reply(req, 0);
1987
1988                 while (to > 0) {
1989                         to = schedule_timeout_interruptible(to);
1990                         if (ldlm_is_granted(lock) ||
1991                             ldlm_is_destroyed(lock))
1992                                 break;
1993                 }
1994         }
1995
1996         lvb_len = req_capsule_get_size(&req->rq_pill, &RMF_DLM_LVB, RCL_CLIENT);
1997         if (lvb_len < 0) {
1998                 LDLM_ERROR(lock, "Fail to get lvb_len, rc = %d", lvb_len);
1999                 GOTO(out, rc = lvb_len);
2000         } else if (lvb_len > 0) {
2001                 if (lock->l_lvb_len > 0) {
2002                         /* for extent lock, lvb contains ost_lvb{}. */
2003                         LASSERT(lock->l_lvb_data != NULL);
2004
2005                         if (unlikely(lock->l_lvb_len < lvb_len)) {
2006                                 LDLM_ERROR(lock,
2007                                            "Replied LVB is larger than expectation, expected = %d, replied = %d",
2008                                            lock->l_lvb_len, lvb_len);
2009                                 GOTO(out, rc = -EINVAL);
2010                         }
2011                 }
2012         }
2013
2014         lock_res_and_lock(lock);
2015
2016         if (!ldlm_res_eq(&dlm_req->lock_desc.l_resource.lr_name,
2017                          &lock->l_resource->lr_name)) {
2018                 ldlm_resource_unlink_lock(lock);
2019                 unlock_res_and_lock(lock);
2020                 rc = ldlm_lock_change_resource(ns, lock,
2021                                 &dlm_req->lock_desc.l_resource.lr_name);
2022                 if (rc < 0) {
2023                         LDLM_ERROR(lock, "Failed to allocate resource");
2024                         GOTO(out, rc);
2025                 }
2026                 LDLM_DEBUG(lock, "completion AST, new resource");
2027                 lock_res_and_lock(lock);
2028         }
2029
2030         if (ldlm_is_failed(lock)) {
2031                 unlock_res_and_lock(lock);
2032                 LDLM_LOCK_RELEASE(lock);
2033                 RETURN(-EINVAL);
2034         }
2035
2036         if (ldlm_is_destroyed(lock) ||
2037             ldlm_is_granted(lock)) {
2038                 /* b=11300: the lock has already been granted */
2039                 unlock_res_and_lock(lock);
2040                 LDLM_DEBUG(lock, "Double grant race happened");
2041                 GOTO(out, rc = 0);
2042         }
2043
2044         /*
2045          * If we receive the completion AST before the actual enqueue returned,
2046          * then we might need to switch lock modes, resources, or extents.
2047          */
2048         if (dlm_req->lock_desc.l_granted_mode != lock->l_req_mode) {
2049                 lock->l_req_mode = dlm_req->lock_desc.l_granted_mode;
2050                 LDLM_DEBUG(lock, "completion AST, new lock mode");
2051         }
2052
2053         if (lock->l_resource->lr_type != LDLM_PLAIN) {
2054                 ldlm_convert_policy_to_local(req->rq_export,
2055                                           dlm_req->lock_desc.l_resource.lr_type,
2056                                           &dlm_req->lock_desc.l_policy_data,
2057                                           &lock->l_policy_data);
2058                 LDLM_DEBUG(lock, "completion AST, new policy data");
2059         }
2060
2061         ldlm_resource_unlink_lock(lock);
2062
2063         if (dlm_req->lock_flags & LDLM_FL_AST_SENT) {
2064                 /*
2065                  * BL_AST locks are not needed in LRU.
2066                  * Let ldlm_cancel_lru() be fast.
2067                  */
2068                 ldlm_lock_remove_from_lru(lock);
2069                 ldlm_bl_desc2lock(&dlm_req->lock_desc, lock);
2070                 lock->l_flags |= LDLM_FL_CBPENDING | LDLM_FL_BL_AST;
2071                 LDLM_DEBUG(lock, "completion AST includes blocking AST");
2072         }
2073
2074         if (lock->l_lvb_len > 0) {
2075                 rc = ldlm_fill_lvb(lock, &req->rq_pill, RCL_CLIENT,
2076                                    lock->l_lvb_data, lvb_len);
2077                 if (rc < 0) {
2078                         unlock_res_and_lock(lock);
2079                         GOTO(out, rc);
2080                 }
2081         }
2082
2083         ldlm_grant_lock(lock, &ast_list);
2084         unlock_res_and_lock(lock);
2085
2086         LDLM_DEBUG(lock, "callback handler finished, about to run_ast_work");
2087
2088         /*
2089          * Let Enqueue to call osc_lock_upcall() and initialize
2090          * l_ast_data
2091          */
2092         OBD_FAIL_TIMEOUT(OBD_FAIL_OSC_CP_ENQ_RACE, 2);
2093
2094         ldlm_run_ast_work(ns, &ast_list, LDLM_WORK_CP_AST);
2095
2096         LDLM_DEBUG_NOLOCK("client completion callback handler END (lock %p)",
2097                           lock);
2098         GOTO(out, rc);
2099
2100 out:
2101         if (rc < 0) {
2102                 lock_res_and_lock(lock);
2103                 ldlm_set_failed(lock);
2104                 unlock_res_and_lock(lock);
2105                 wake_up(&lock->l_waitq);
2106         }
2107         LDLM_LOCK_RELEASE(lock);
2108
2109         return 0;
2110 }
2111
2112 /**
2113  * Callback handler for receiving incoming glimpse ASTs.
2114  *
2115  * This only can happen on client side.  After handling the glimpse AST
2116  * we also consider dropping the lock here if it is unused locally for a
2117  * long time.
2118  */
2119 static void ldlm_handle_gl_callback(struct ptlrpc_request *req,
2120                                     struct ldlm_namespace *ns,
2121                                     struct ldlm_request *dlm_req,
2122                                     struct ldlm_lock *lock)
2123 {
2124         struct ldlm_lock_desc *ld = &dlm_req->lock_desc;
2125         int rc = -ENOSYS;
2126
2127         ENTRY;
2128
2129         LDLM_DEBUG(lock, "client glimpse AST callback handler");
2130
2131         if (lock->l_glimpse_ast != NULL)
2132                 rc = lock->l_glimpse_ast(lock, req);
2133
2134         if (req->rq_repmsg != NULL) {
2135                 ptlrpc_reply(req);
2136         } else {
2137                 req->rq_status = rc;
2138                 ptlrpc_error(req);
2139         }
2140
2141         lock_res_and_lock(lock);
2142         if (lock->l_granted_mode == LCK_PW &&
2143             !lock->l_readers && !lock->l_writers &&
2144             ktime_after(ktime_get(),
2145                         ktime_add(lock->l_last_used, ns->ns_dirty_age_limit))) {
2146                 unlock_res_and_lock(lock);
2147
2148                 /* For MDS glimpse it is always DOM lock, set corresponding
2149                  * cancel_bits to perform lock convert if needed
2150                  */
2151                 if (lock->l_resource->lr_type == LDLM_IBITS)
2152                         ld->l_policy_data.l_inodebits.cancel_bits =
2153                                                         MDS_INODELOCK_DOM;
2154                 if (ldlm_bl_to_thread_lock(ns, ld, lock))
2155                         ldlm_handle_bl_callback(ns, ld, lock);
2156
2157                 EXIT;
2158                 return;
2159         }
2160         unlock_res_and_lock(lock);
2161         LDLM_LOCK_RELEASE(lock);
2162         EXIT;
2163 }
2164
2165 static int __ldlm_bl_to_thread(struct ldlm_bl_work_item *blwi,
2166                                enum ldlm_cancel_flags cancel_flags)
2167 {
2168         struct ldlm_bl_pool *blp = ldlm_state->ldlm_bl_pool;
2169         char *prio = "regular";
2170         int count;
2171
2172         ENTRY;
2173
2174         spin_lock(&blp->blp_lock);
2175         /* cannot access blwi after added to list and lock is dropped */
2176         count = blwi->blwi_lock ? 1 : blwi->blwi_count;
2177
2178         /* if the server is waiting on a lock to be cancelled (bl_ast), this is
2179          * an urgent request and should go in the priority queue so it doesn't
2180          * get stuck behind non-priority work (eg, lru size management)
2181          *
2182          * We also prioritize discard_data, which is for eviction handling
2183          */
2184         if (blwi->blwi_lock &&
2185             (ldlm_is_discard_data(blwi->blwi_lock) ||
2186              ldlm_is_bl_ast(blwi->blwi_lock))) {
2187                 list_add_tail(&blwi->blwi_entry, &blp->blp_prio_list);
2188                 prio = "priority";
2189         } else {
2190                 /* other blocking callbacks are added to the regular list */
2191                 list_add_tail(&blwi->blwi_entry, &blp->blp_list);
2192         }
2193         blp->blp_total_locks += count;
2194         blp->blp_total_blwis++;
2195         spin_unlock(&blp->blp_lock);
2196
2197         wake_up(&blp->blp_waitq);
2198
2199         /* unlocked read of blp values is intentional - OK for debug */
2200         CDEBUG(D_DLMTRACE,
2201                "added %d/%d locks to %s blp list, %d blwis in pool\n",
2202                count, blp->blp_total_locks, prio, blp->blp_total_blwis);
2203
2204         /*
2205          * can not check blwi->blwi_flags as blwi could be already freed in
2206          * LCF_ASYNC mode
2207          */
2208         if (!(cancel_flags & LCF_ASYNC))
2209                 wait_for_completion(&blwi->blwi_comp);
2210
2211         RETURN(0);
2212 }
2213
2214 static inline void init_blwi(struct ldlm_bl_work_item *blwi,
2215                              struct ldlm_namespace *ns,
2216                              struct ldlm_lock_desc *ld,
2217                              struct list_head *cancels, int count,
2218                              struct ldlm_lock *lock,
2219                              enum ldlm_cancel_flags cancel_flags)
2220 {
2221         init_completion(&blwi->blwi_comp);
2222         INIT_LIST_HEAD(&blwi->blwi_head);
2223
2224         if (current->flags & PF_MEMALLOC)
2225                 blwi->blwi_mem_pressure = 1;
2226
2227         blwi->blwi_ns = ns;
2228         blwi->blwi_flags = cancel_flags;
2229         if (ld != NULL)
2230                 blwi->blwi_ld = *ld;
2231         if (count) {
2232                 list_splice_init(cancels, &blwi->blwi_head);
2233                 blwi->blwi_count = count;
2234         } else {
2235                 blwi->blwi_lock = lock;
2236         }
2237 }
2238
2239 /**
2240  * Queues a list of locks \a cancels containing \a count locks
2241  * for later processing by a blocking thread.  If \a count is zero,
2242  * then the lock referenced as \a lock is queued instead.
2243  *
2244  * The blocking thread would then call ->l_blocking_ast callback in the lock.
2245  * If list addition fails an error is returned and caller is supposed to
2246  * call ->l_blocking_ast itself.
2247  */
2248 static int ldlm_bl_to_thread(struct ldlm_namespace *ns,
2249                              struct ldlm_lock_desc *ld,
2250                              struct ldlm_lock *lock,
2251                              struct list_head *cancels, int count,
2252                              enum ldlm_cancel_flags cancel_flags)
2253 {
2254         ENTRY;
2255
2256         if (cancels && count == 0)
2257                 RETURN(0);
2258
2259         if (cancel_flags & LCF_ASYNC) {
2260                 struct ldlm_bl_work_item *blwi;
2261
2262                 OBD_ALLOC(blwi, sizeof(*blwi));
2263                 if (blwi == NULL)
2264                         RETURN(-ENOMEM);
2265                 init_blwi(blwi, ns, ld, cancels, count, lock, cancel_flags);
2266
2267                 RETURN(__ldlm_bl_to_thread(blwi, cancel_flags));
2268         } else {
2269                 /*
2270                  * if it is synchronous call do minimum mem alloc, as it could
2271                  * be triggered from kernel shrinker
2272                  */
2273                 struct ldlm_bl_work_item blwi;
2274
2275                 memset(&blwi, 0, sizeof(blwi));
2276                 init_blwi(&blwi, ns, ld, cancels, count, lock, cancel_flags);
2277                 RETURN(__ldlm_bl_to_thread(&blwi, cancel_flags));
2278         }
2279 }
2280
2281
2282 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
2283                            struct ldlm_lock *lock)
2284 {
2285         return ldlm_bl_to_thread(ns, ld, lock, NULL, 0, LCF_ASYNC);
2286 }
2287
2288 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
2289                            struct list_head *cancels, int count,
2290                            enum ldlm_cancel_flags cancel_flags)
2291 {
2292         return ldlm_bl_to_thread(ns, ld, NULL, cancels, count, cancel_flags);
2293 }
2294
2295 int ldlm_bl_to_thread_ns(struct ldlm_namespace *ns)
2296 {
2297         return ldlm_bl_to_thread(ns, NULL, NULL, NULL, 0, LCF_ASYNC);
2298 }
2299
2300 int ldlm_bl_thread_wakeup(void)
2301 {
2302         wake_up(&ldlm_state->ldlm_bl_pool->blp_waitq);
2303         return 0;
2304 }
2305
2306 /* Setinfo coming from Server (eg MDT) to Client (eg MDC)! */
2307 static int ldlm_handle_setinfo(struct ptlrpc_request *req)
2308 {
2309         struct obd_device *obd = req->rq_export->exp_obd;
2310         char *key;
2311         void *val;
2312         int keylen, vallen;
2313         int rc = -ENOSYS;
2314
2315         ENTRY;
2316
2317         DEBUG_REQ(D_HSM, req, "%s: handle setinfo", obd->obd_name);
2318
2319         req_capsule_set(&req->rq_pill, &RQF_OBD_SET_INFO);
2320
2321         key = req_capsule_client_get(&req->rq_pill, &RMF_SETINFO_KEY);
2322         if (key == NULL) {
2323                 DEBUG_REQ(D_IOCTL, req, "no set_info key");
2324                 RETURN(-EFAULT);
2325         }
2326         keylen = req_capsule_get_size(&req->rq_pill, &RMF_SETINFO_KEY,
2327                                       RCL_CLIENT);
2328         val = req_capsule_client_get(&req->rq_pill, &RMF_SETINFO_VAL);
2329         if (val == NULL) {
2330                 DEBUG_REQ(D_IOCTL, req, "no set_info val");
2331                 RETURN(-EFAULT);
2332         }
2333         vallen = req_capsule_get_size(&req->rq_pill, &RMF_SETINFO_VAL,
2334                                       RCL_CLIENT);
2335
2336         /* We are responsible for swabbing contents of val */
2337
2338         if (KEY_IS(KEY_HSM_COPYTOOL_SEND))
2339                 /* Pass it on to mdc (the "export" in this case) */
2340                 rc = obd_set_info_async(req->rq_svc_thread->t_env,
2341                                         req->rq_export,
2342                                         sizeof(KEY_HSM_COPYTOOL_SEND),
2343                                         KEY_HSM_COPYTOOL_SEND,
2344                                         vallen, val, NULL);
2345         else
2346                 DEBUG_REQ(D_WARNING, req, "ignoring unknown key '%s'", key);
2347
2348         return rc;
2349 }
2350
2351 static inline void ldlm_callback_errmsg(struct ptlrpc_request *req,
2352                                         const char *msg, int rc,
2353                                         const struct lustre_handle *handle)
2354 {
2355         DEBUG_REQ((req->rq_no_reply || rc) ? D_WARNING : D_DLMTRACE, req,
2356                   "%s, NID=%s lock=%#llx: rc = %d",
2357                   msg, libcfs_idstr(&req->rq_peer),
2358                   handle ? handle->cookie : 0, rc);
2359         if (req->rq_no_reply)
2360                 CWARN("No reply was sent, maybe cause b=21636.\n");
2361         else if (rc)
2362                 CWARN("Send reply failed, maybe cause b=21636.\n");
2363 }
2364
2365 /* TODO: handle requests in a similar way as MDT: see mdt_handle_common() */
2366 static int ldlm_callback_handler(struct ptlrpc_request *req)
2367 {
2368         struct ldlm_namespace *ns;
2369         struct ldlm_request *dlm_req;
2370         struct ldlm_lock *lock;
2371         int rc;
2372
2373         ENTRY;
2374
2375         /*
2376          * Requests arrive in sender's byte order.  The ptlrpc service
2377          * handler has already checked and, if necessary, byte-swapped the
2378          * incoming request message body, but I am responsible for the
2379          * message buffers.
2380          */
2381
2382         /* do nothing for sec context finalize */
2383         if (lustre_msg_get_opc(req->rq_reqmsg) == SEC_CTX_FINI)
2384                 RETURN(0);
2385
2386         req_capsule_init(&req->rq_pill, req, RCL_SERVER);
2387
2388         if (req->rq_export == NULL) {
2389                 rc = ldlm_callback_reply(req, -ENOTCONN);
2390                 ldlm_callback_errmsg(req, "Operate on unconnected server",
2391                                      rc, NULL);
2392                 RETURN(0);
2393         }
2394
2395         LASSERT(req->rq_export != NULL);
2396         LASSERT(req->rq_export->exp_obd != NULL);
2397
2398         switch (lustre_msg_get_opc(req->rq_reqmsg)) {
2399         case LDLM_BL_CALLBACK:
2400                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_BL_CALLBACK_NET)) {
2401                         if (cfs_fail_err)
2402                                 ldlm_callback_reply(req, -(int)cfs_fail_err);
2403                         RETURN(0);
2404                 }
2405                 break;
2406         case LDLM_CP_CALLBACK:
2407                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CP_CALLBACK_NET))
2408                         RETURN(0);
2409                 break;
2410         case LDLM_GL_CALLBACK:
2411                 if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_GL_CALLBACK_NET))
2412                         RETURN(0);
2413                 break;
2414         case LDLM_SET_INFO:
2415                 rc = ldlm_handle_setinfo(req);
2416                 ldlm_callback_reply(req, rc);
2417                 RETURN(0);
2418         default:
2419                 CERROR("unknown opcode %u\n",
2420                        lustre_msg_get_opc(req->rq_reqmsg));
2421                 ldlm_callback_reply(req, -EPROTO);
2422                 RETURN(0);
2423         }
2424
2425         ns = req->rq_export->exp_obd->obd_namespace;
2426         LASSERT(ns != NULL);
2427
2428         req_capsule_set(&req->rq_pill, &RQF_LDLM_CALLBACK);
2429
2430         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2431         if (dlm_req == NULL) {
2432                 rc = ldlm_callback_reply(req, -EPROTO);
2433                 ldlm_callback_errmsg(req, "Operate without parameter", rc,
2434                                      NULL);
2435                 RETURN(0);
2436         }
2437
2438         /*
2439          * Force a known safe race, send a cancel to the server for a lock
2440          * which the server has already started a blocking callback on.
2441          */
2442         if (OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_BL_CB_RACE) &&
2443             lustre_msg_get_opc(req->rq_reqmsg) == LDLM_BL_CALLBACK) {
2444                 rc = ldlm_cli_cancel(&dlm_req->lock_handle[0], 0);
2445                 if (rc < 0)
2446                         CERROR("ldlm_cli_cancel: %d\n", rc);
2447         }
2448
2449         lock = ldlm_handle2lock_long(&dlm_req->lock_handle[0], 0);
2450         if (!lock) {
2451                 CDEBUG(D_DLMTRACE,
2452                        "callback on lock %#llx - lock disappeared\n",
2453                        dlm_req->lock_handle[0].cookie);
2454                 rc = ldlm_callback_reply(req, -EINVAL);
2455                 ldlm_callback_errmsg(req, "Operate with invalid parameter", rc,
2456                                      &dlm_req->lock_handle[0]);
2457                 RETURN(0);
2458         }
2459
2460         if (ldlm_is_fail_loc(lock) &&
2461             lustre_msg_get_opc(req->rq_reqmsg) == LDLM_BL_CALLBACK)
2462                 OBD_RACE(OBD_FAIL_LDLM_CP_BL_RACE);
2463
2464         /* Copy hints/flags (e.g. LDLM_FL_DISCARD_DATA) from AST. */
2465         lock_res_and_lock(lock);
2466         lock->l_flags |= ldlm_flags_from_wire(dlm_req->lock_flags &
2467                                               LDLM_FL_AST_MASK);
2468         if (lustre_msg_get_opc(req->rq_reqmsg) == LDLM_BL_CALLBACK) {
2469                 /*
2470                  * If somebody cancels lock and cache is already dropped,
2471                  * or lock is failed before cp_ast received on client,
2472                  * we can tell the server we have no lock. Otherwise, we
2473                  * should send cancel after dropping the cache.
2474                  */
2475                 if ((ldlm_is_canceling(lock) && ldlm_is_bl_done(lock)) ||
2476                      ldlm_is_failed(lock)) {
2477                         LDLM_DEBUG(lock,
2478                                    "callback on lock %llx - lock disappeared",
2479                                    dlm_req->lock_handle[0].cookie);
2480                         unlock_res_and_lock(lock);
2481                         LDLM_LOCK_RELEASE(lock);
2482                         rc = ldlm_callback_reply(req, -EINVAL);
2483                         ldlm_callback_errmsg(req, "Operate on stale lock", rc,
2484                                              &dlm_req->lock_handle[0]);
2485                         RETURN(0);
2486                 }
2487                 /*
2488                  * BL_AST locks are not needed in LRU.
2489                  * Let ldlm_cancel_lru() be fast.
2490                  */
2491                 ldlm_lock_remove_from_lru(lock);
2492                 ldlm_set_bl_ast(lock);
2493         }
2494         if (lock->l_remote_handle.cookie == 0)
2495                 lock->l_remote_handle = dlm_req->lock_handle[1];
2496         unlock_res_and_lock(lock);
2497
2498         /*
2499          * We want the ost thread to get this reply so that it can respond
2500          * to ost requests (write cache writeback) that might be triggered
2501          * in the callback.
2502          *
2503          * But we'd also like to be able to indicate in the reply that we're
2504          * cancelling right now, because it's unused, or have an intent result
2505          * in the reply, so we might have to push the responsibility for sending
2506          * the reply down into the AST handlers, alas.
2507          */
2508
2509         switch (lustre_msg_get_opc(req->rq_reqmsg)) {
2510         case LDLM_BL_CALLBACK:
2511                 CDEBUG(D_INODE, "blocking ast\n");
2512                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_BL_CALLBACK);
2513                 if (!ldlm_is_cancel_on_block(lock)) {
2514                         rc = ldlm_callback_reply(req, 0);
2515                         if (req->rq_no_reply || rc)
2516                                 ldlm_callback_errmsg(req, "Normal process", rc,
2517                                                      &dlm_req->lock_handle[0]);
2518                 }
2519                 if (ldlm_bl_to_thread_lock(ns, &dlm_req->lock_desc, lock))
2520                         ldlm_handle_bl_callback(ns, &dlm_req->lock_desc, lock);
2521                 break;
2522         case LDLM_CP_CALLBACK:
2523                 CDEBUG(D_INODE, "completion ast\n");
2524                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_CP_CALLBACK);
2525                 rc = ldlm_handle_cp_callback(req, ns, dlm_req, lock);
2526                 if (!OBD_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_BL_CB_RACE))
2527                         ldlm_callback_reply(req, rc);
2528                 break;
2529         case LDLM_GL_CALLBACK:
2530                 CDEBUG(D_INODE, "glimpse ast\n");
2531                 req_capsule_extend(&req->rq_pill, &RQF_LDLM_GL_CALLBACK);
2532                 ldlm_handle_gl_callback(req, ns, dlm_req, lock);
2533                 break;
2534         default:
2535                 LBUG(); /* checked above */
2536         }
2537
2538         RETURN(0);
2539 }
2540
2541 #ifdef HAVE_SERVER_SUPPORT
2542 /**
2543  * Main handler for canceld thread.
2544  *
2545  * Separated into its own thread to avoid deadlocks.
2546  */
2547 static int ldlm_cancel_handler(struct ptlrpc_request *req)
2548 {
2549         int rc;
2550
2551         ENTRY;
2552
2553         /*
2554          * Requests arrive in sender's byte order.  The ptlrpc service
2555          * handler has already checked and, if necessary, byte-swapped the
2556          * incoming request message body, but I am responsible for the
2557          * message buffers.
2558          */
2559
2560         req_capsule_init(&req->rq_pill, req, RCL_SERVER);
2561
2562         if (req->rq_export == NULL) {
2563                 struct ldlm_request *dlm_req;
2564
2565                 CERROR("%s from %s arrived at %llu with bad export cookie %llu\n",
2566                        ll_opcode2str(lustre_msg_get_opc(req->rq_reqmsg)),
2567                        libcfs_nidstr(&req->rq_peer.nid),
2568                        (unsigned long long)req->rq_arrival_time.tv_sec,
2569                        lustre_msg_get_handle(req->rq_reqmsg)->cookie);
2570
2571                 if (lustre_msg_get_opc(req->rq_reqmsg) == LDLM_CANCEL) {
2572                         req_capsule_set(&req->rq_pill, &RQF_LDLM_CALLBACK);
2573                         dlm_req = req_capsule_client_get(&req->rq_pill,
2574                                                          &RMF_DLM_REQ);
2575                         if (dlm_req != NULL)
2576                                 ldlm_lock_dump_handle(D_ERROR,
2577                                                       &dlm_req->lock_handle[0]);
2578                 }
2579                 ldlm_callback_reply(req, -ENOTCONN);
2580                 RETURN(0);
2581         }
2582
2583         switch (lustre_msg_get_opc(req->rq_reqmsg)) {
2584         /* XXX FIXME move this back to mds/handler.c, b=249 */
2585         case LDLM_CANCEL:
2586                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CANCEL);
2587                 CDEBUG(D_INODE, "cancel\n");
2588                 if (CFS_FAIL_CHECK(OBD_FAIL_LDLM_CANCEL_NET) ||
2589                     CFS_FAIL_CHECK(OBD_FAIL_PTLRPC_CANCEL_RESEND) ||
2590                     CFS_FAIL_CHECK(OBD_FAIL_LDLM_BL_EVICT))
2591                         RETURN(0);
2592                 rc = ldlm_handle_cancel(req);
2593                 break;
2594         case LDLM_CONVERT:
2595         {
2596                 struct ldlm_request *dlm_req;
2597
2598                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CONVERT);
2599                 CDEBUG(D_INODE, "convert\n");
2600
2601                 dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2602                 if (dlm_req == NULL) {
2603                         CDEBUG(D_INFO, "bad request buffer for cancel\n");
2604                         rc = ldlm_callback_reply(req, -EPROTO);
2605                 } else {
2606                         req->rq_status = ldlm_handle_convert0(req, dlm_req);
2607                         rc = ptlrpc_reply(req);
2608                 }
2609                 break;
2610         }
2611         default:
2612                 CERROR("invalid opcode %d\n",
2613                        lustre_msg_get_opc(req->rq_reqmsg));
2614                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CALLBACK);
2615                 rc = ldlm_callback_reply(req, -EINVAL);
2616         }
2617
2618         RETURN(rc);
2619 }
2620
2621 static int ldlm_cancel_hpreq_lock_match(struct ptlrpc_request *req,
2622                                         struct ldlm_lock *lock)
2623 {
2624         struct ldlm_request *dlm_req;
2625         struct lustre_handle lockh;
2626         int rc = 0;
2627         int i;
2628
2629         ENTRY;
2630
2631         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2632         if (dlm_req == NULL)
2633                 RETURN(0);
2634
2635         ldlm_lock2handle(lock, &lockh);
2636         for (i = 0; i < dlm_req->lock_count; i++) {
2637                 if (lustre_handle_equal(&dlm_req->lock_handle[i],
2638                                         &lockh)) {
2639                         DEBUG_REQ(D_RPCTRACE, req,
2640                                   "Prio raised by lock %#llx", lockh.cookie);
2641                         rc = 1;
2642                         break;
2643                 }
2644         }
2645
2646         RETURN(rc);
2647 }
2648
2649 static int ldlm_cancel_hpreq_check(struct ptlrpc_request *req)
2650 {
2651         struct ldlm_request *dlm_req;
2652         int rc = 0;
2653         int i;
2654         unsigned int size;
2655
2656         ENTRY;
2657
2658         /* no prolong in recovery */
2659         if (lustre_msg_get_flags(req->rq_reqmsg) & MSG_REPLAY)
2660                 RETURN(0);
2661
2662         dlm_req = req_capsule_client_get(&req->rq_pill, &RMF_DLM_REQ);
2663         if (dlm_req == NULL)
2664                 RETURN(-EFAULT);
2665
2666         size = req_capsule_get_size(&req->rq_pill, &RMF_DLM_REQ, RCL_CLIENT);
2667         if (size <= offsetof(struct ldlm_request, lock_handle) ||
2668             (size - offsetof(struct ldlm_request, lock_handle)) /
2669              sizeof(struct lustre_handle) < dlm_req->lock_count)
2670                 RETURN(-EPROTO);
2671
2672         for (i = 0; i < dlm_req->lock_count; i++) {
2673                 struct ldlm_lock *lock;
2674
2675                 lock = ldlm_handle2lock(&dlm_req->lock_handle[i]);
2676                 if (lock == NULL)
2677                         continue;
2678
2679                 rc = ldlm_is_ast_sent(lock) ? 1 : 0;
2680                 if (rc)
2681                         LDLM_DEBUG(lock, "hpreq cancel/convert lock");
2682                 LDLM_LOCK_PUT(lock);
2683
2684                 if (rc)
2685                         break;
2686         }
2687
2688         RETURN(rc);
2689 }
2690
2691 static struct ptlrpc_hpreq_ops ldlm_cancel_hpreq_ops = {
2692         .hpreq_lock_match = ldlm_cancel_hpreq_lock_match,
2693         .hpreq_check      = ldlm_cancel_hpreq_check,
2694         .hpreq_fini       = NULL,
2695 };
2696
2697 static int ldlm_hpreq_handler(struct ptlrpc_request *req)
2698 {
2699         ENTRY;
2700
2701         req_capsule_init(&req->rq_pill, req, RCL_SERVER);
2702
2703         if (req->rq_export == NULL)
2704                 RETURN(0);
2705
2706         if (LDLM_CANCEL == lustre_msg_get_opc(req->rq_reqmsg)) {
2707                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CANCEL);
2708                 req->rq_ops = &ldlm_cancel_hpreq_ops;
2709         } else if (LDLM_CONVERT == lustre_msg_get_opc(req->rq_reqmsg)) {
2710                 req_capsule_set(&req->rq_pill, &RQF_LDLM_CONVERT);
2711                 req->rq_ops = &ldlm_cancel_hpreq_ops;
2712         }
2713         RETURN(0);
2714 }
2715
2716 static int ldlm_revoke_lock_cb(struct cfs_hash *hs, struct cfs_hash_bd *bd,
2717                                struct hlist_node *hnode, void *data)
2718
2719 {
2720         struct list_head *rpc_list = data;
2721         struct ldlm_lock *lock = cfs_hash_object(hs, hnode);
2722
2723         lock_res_and_lock(lock);
2724
2725         if (!ldlm_is_granted(lock)) {
2726                 unlock_res_and_lock(lock);
2727                 return 0;
2728         }
2729
2730         LASSERT(lock->l_resource);
2731         if (lock->l_resource->lr_type != LDLM_IBITS &&
2732             lock->l_resource->lr_type != LDLM_PLAIN) {
2733                 unlock_res_and_lock(lock);
2734                 return 0;
2735         }
2736
2737         if (ldlm_is_ast_sent(lock)) {
2738                 unlock_res_and_lock(lock);
2739                 return 0;
2740         }
2741
2742         LASSERT(lock->l_blocking_ast);
2743         LASSERT(!lock->l_blocking_lock);
2744
2745         ldlm_set_ast_sent(lock);
2746         if (lock->l_export && lock->l_export->exp_lock_hash) {
2747                 /*
2748                  * NB: it's safe to call cfs_hash_del() even lock isn't
2749                  * in exp_lock_hash.
2750                  */
2751                 /*
2752                  * In the function below, .hs_keycmp resolves to
2753                  * ldlm_export_lock_keycmp()
2754                  */
2755                 /* coverity[overrun-buffer-val] */
2756                 cfs_hash_del(lock->l_export->exp_lock_hash,
2757                              &lock->l_remote_handle, &lock->l_exp_hash);
2758         }
2759
2760         list_add_tail(&lock->l_rk_ast, rpc_list);
2761         LDLM_LOCK_GET(lock);
2762
2763         unlock_res_and_lock(lock);
2764         return 0;
2765 }
2766
2767 void ldlm_revoke_export_locks(struct obd_export *exp)
2768 {
2769         int rc;
2770         LIST_HEAD(rpc_list);
2771         ENTRY;
2772
2773         cfs_hash_for_each_nolock(exp->exp_lock_hash,
2774                                  ldlm_revoke_lock_cb, &rpc_list, 0);
2775         rc = ldlm_run_ast_work(exp->exp_obd->obd_namespace, &rpc_list,
2776                           LDLM_WORK_REVOKE_AST);
2777
2778         if (rc == -ERESTART)
2779                 ldlm_reprocess_recovery_done(exp->exp_obd->obd_namespace);
2780
2781         EXIT;
2782 }
2783 EXPORT_SYMBOL(ldlm_revoke_export_locks);
2784 #endif /* HAVE_SERVER_SUPPORT */
2785
2786 static int ldlm_bl_get_work(struct ldlm_bl_pool *blp,
2787                             struct ldlm_bl_work_item **p_blwi,
2788                             struct obd_export **p_exp)
2789 {
2790         struct ldlm_bl_work_item *blwi = NULL;
2791         static unsigned int num_bl;
2792         static unsigned int num_stale;
2793         int num_th = atomic_read(&blp->blp_num_threads);
2794
2795         *p_exp = obd_stale_export_get();
2796
2797         spin_lock(&blp->blp_lock);
2798         if (*p_exp != NULL) {
2799                 if (num_th == 1 || ++num_stale < num_th) {
2800                         spin_unlock(&blp->blp_lock);
2801                         return 1;
2802                 }
2803                 num_stale = 0;
2804         }
2805
2806         /* process a request from the blp_list at least every blp_num_threads */
2807         if (!list_empty(&blp->blp_list) &&
2808             (list_empty(&blp->blp_prio_list) || num_bl == 0))
2809                 blwi = list_entry(blp->blp_list.next,
2810                                   struct ldlm_bl_work_item, blwi_entry);
2811         else
2812                 if (!list_empty(&blp->blp_prio_list))
2813                         blwi = list_entry(blp->blp_prio_list.next,
2814                                           struct ldlm_bl_work_item,
2815                                           blwi_entry);
2816
2817         if (blwi) {
2818                 if (++num_bl >= num_th)
2819                         num_bl = 0;
2820                 list_del(&blwi->blwi_entry);
2821                 blp->blp_total_locks -= blwi->blwi_lock ? 1 : blwi->blwi_count;
2822                 blp->blp_total_blwis--;
2823         }
2824         spin_unlock(&blp->blp_lock);
2825         *p_blwi = blwi;
2826
2827         /* intentional unlocked read of blp values - OK for debug */
2828         if (blwi) {
2829                 CDEBUG(D_DLMTRACE,
2830                        "Got %d locks of %d total in blp.  (%d blwis in pool)\n",
2831                        blwi->blwi_lock ? 1 : blwi->blwi_count,
2832                        blp->blp_total_locks, blp->blp_total_blwis);
2833         } else {
2834                 CDEBUG(D_DLMTRACE,
2835                        "No blwi found in queue (no bl locks in queue)\n");
2836         }
2837
2838         if (*p_exp != NULL && *p_blwi != NULL) {
2839                 obd_stale_export_put(*p_exp);
2840                 *p_exp = NULL;
2841         }
2842
2843         return (*p_blwi != NULL || *p_exp != NULL) ? 1 : 0;
2844 }
2845
2846 /* This only contains temporary data until the thread starts */
2847 struct ldlm_bl_thread_data {
2848         struct ldlm_bl_pool     *bltd_blp;
2849         struct completion       bltd_comp;
2850         int                     bltd_num;
2851 };
2852
2853 static int ldlm_bl_thread_main(void *arg);
2854
2855 static int ldlm_bl_thread_start(struct ldlm_bl_pool *blp, bool check_busy)
2856 {
2857         struct ldlm_bl_thread_data bltd = { .bltd_blp = blp };
2858         struct task_struct *task;
2859
2860         init_completion(&bltd.bltd_comp);
2861
2862         bltd.bltd_num = atomic_inc_return(&blp->blp_num_threads);
2863         if (bltd.bltd_num >= blp->blp_max_threads) {
2864                 atomic_dec(&blp->blp_num_threads);
2865                 return 0;
2866         }
2867
2868         LASSERTF(bltd.bltd_num > 0, "thread num:%d\n", bltd.bltd_num);
2869         if (check_busy &&
2870             atomic_read(&blp->blp_busy_threads) < (bltd.bltd_num - 1)) {
2871                 atomic_dec(&blp->blp_num_threads);
2872                 return 0;
2873         }
2874
2875         task = kthread_run(ldlm_bl_thread_main, &bltd, "ldlm_bl_%02d",
2876                            bltd.bltd_num);
2877         if (IS_ERR(task)) {
2878                 CERROR("cannot start LDLM thread ldlm_bl_%02d: rc %ld\n",
2879                        bltd.bltd_num, PTR_ERR(task));
2880                 atomic_dec(&blp->blp_num_threads);
2881                 return PTR_ERR(task);
2882         }
2883         wait_for_completion(&bltd.bltd_comp);
2884
2885         return 0;
2886 }
2887
2888 /* Not fatal if racy and have a few too many threads */
2889 static int ldlm_bl_thread_need_create(struct ldlm_bl_pool *blp,
2890                                       struct ldlm_bl_work_item *blwi)
2891 {
2892         if (atomic_read(&blp->blp_num_threads) >= blp->blp_max_threads)
2893                 return 0;
2894
2895         if (atomic_read(&blp->blp_busy_threads) <
2896             atomic_read(&blp->blp_num_threads))
2897                 return 0;
2898
2899         if (blwi != NULL && (blwi->blwi_ns == NULL ||
2900                              blwi->blwi_mem_pressure))
2901                 return 0;
2902
2903         return 1;
2904 }
2905
2906 static int ldlm_bl_thread_blwi(struct ldlm_bl_pool *blp,
2907                                struct ldlm_bl_work_item *blwi)
2908 {
2909         /* '1' for consistency with code that checks !mpflag to restore */
2910         unsigned int mpflags = 1;
2911
2912         ENTRY;
2913
2914         if (blwi->blwi_ns == NULL)
2915                 /* added by ldlm_cleanup() */
2916                 RETURN(LDLM_ITER_STOP);
2917
2918         if (blwi->blwi_mem_pressure)
2919                 mpflags = memalloc_noreclaim_save();
2920
2921         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_PAUSE_CANCEL2, 4);
2922
2923         if (blwi->blwi_count) {
2924                 int count;
2925                 /*
2926                  * The special case when we cancel locks in lru
2927                  * asynchronously, we pass the list of locks here.
2928                  * Thus locks are marked LDLM_FL_CANCELING, but NOT
2929                  * canceled locally yet.
2930                  */
2931                 count = ldlm_cli_cancel_list_local(&blwi->blwi_head,
2932                                                    blwi->blwi_count,
2933                                                    LCF_BL_AST);
2934                 ldlm_cli_cancel_list(&blwi->blwi_head, count, NULL,
2935                                      blwi->blwi_flags);
2936         } else if (blwi->blwi_lock) {
2937                 ldlm_handle_bl_callback(blwi->blwi_ns, &blwi->blwi_ld,
2938                                         blwi->blwi_lock);
2939         } else {
2940                 ldlm_pool_recalc(&blwi->blwi_ns->ns_pool, true);
2941                 spin_lock(&blwi->blwi_ns->ns_lock);
2942                 blwi->blwi_ns->ns_rpc_recalc = 0;
2943                 spin_unlock(&blwi->blwi_ns->ns_lock);
2944                 ldlm_namespace_put(blwi->blwi_ns);
2945         }
2946
2947         if (blwi->blwi_mem_pressure)
2948                 memalloc_noreclaim_restore(mpflags);
2949
2950         if (blwi->blwi_flags & LCF_ASYNC)
2951                 OBD_FREE(blwi, sizeof(*blwi));
2952         else
2953                 complete(&blwi->blwi_comp);
2954
2955         RETURN(0);
2956 }
2957
2958 /**
2959  * Cancel stale locks on export. Cancel blocked locks first.
2960  * If the given export has blocked locks, the next in the list may have
2961  * them too, thus cancel not blocked locks only if the current export has
2962  * no blocked locks.
2963  **/
2964 static int ldlm_bl_thread_exports(struct ldlm_bl_pool *blp,
2965                                   struct obd_export *exp)
2966 {
2967         int num;
2968
2969         ENTRY;
2970
2971         OBD_FAIL_TIMEOUT(OBD_FAIL_LDLM_BL_EVICT, 4);
2972
2973         num = ldlm_export_cancel_blocked_locks(exp);
2974         if (num == 0)
2975                 ldlm_export_cancel_locks(exp);
2976
2977         obd_stale_export_put(exp);
2978
2979         RETURN(0);
2980 }
2981
2982
2983 /**
2984  * Main blocking requests processing thread.
2985  *
2986  * Callers put locks into its queue by calling ldlm_bl_to_thread.
2987  * This thread in the end ends up doing actual call to ->l_blocking_ast
2988  * for queued locks.
2989  */
2990 static int ldlm_bl_thread_main(void *arg)
2991 {
2992         struct lu_env *env;
2993         struct ldlm_bl_pool *blp;
2994         struct ldlm_bl_thread_data *bltd = arg;
2995         int rc;
2996
2997         ENTRY;
2998
2999         OBD_ALLOC_PTR(env);
3000         if (!env)
3001                 RETURN(-ENOMEM);
3002         rc = lu_env_init(env, LCT_DT_THREAD);
3003         if (rc)
3004                 GOTO(out_env, rc);
3005         rc = lu_env_add(env);
3006         if (rc)
3007                 GOTO(out_env_fini, rc);
3008
3009         blp = bltd->bltd_blp;
3010
3011         complete(&bltd->bltd_comp);
3012         /* cannot use bltd after this, it is only on caller's stack */
3013
3014         while (1) {
3015                 struct ldlm_bl_work_item *blwi = NULL;
3016                 struct obd_export *exp = NULL;
3017                 int rc;
3018
3019                 rc = ldlm_bl_get_work(blp, &blwi, &exp);
3020
3021                 if (rc == 0)
3022                         wait_event_idle_exclusive(blp->blp_waitq,
3023                                                   ldlm_bl_get_work(blp, &blwi,
3024                                                                    &exp));
3025                 atomic_inc(&blp->blp_busy_threads);
3026
3027                 if (ldlm_bl_thread_need_create(blp, blwi))
3028                         /* discard the return value, we tried */
3029                         ldlm_bl_thread_start(blp, true);
3030
3031                 if (exp)
3032                         rc = ldlm_bl_thread_exports(blp, exp);
3033                 else if (blwi)
3034                         rc = ldlm_bl_thread_blwi(blp, blwi);
3035
3036                 atomic_dec(&blp->blp_busy_threads);
3037
3038                 if (rc == LDLM_ITER_STOP)
3039                         break;
3040
3041                 /*
3042                  * If there are many namespaces, we will not sleep waiting for
3043                  * work, and must do a cond_resched to avoid holding the CPU
3044                  * for too long
3045                  */
3046                 cond_resched();
3047         }
3048
3049         atomic_dec(&blp->blp_num_threads);
3050         complete(&blp->blp_comp);
3051
3052         lu_env_remove(env);
3053 out_env_fini:
3054         lu_env_fini(env);
3055 out_env:
3056         OBD_FREE_PTR(env);
3057         RETURN(rc);
3058 }
3059
3060
3061 static int ldlm_setup(void);
3062 static int ldlm_cleanup(void);
3063
3064 int ldlm_get_ref(void)
3065 {
3066         int rc = 0;
3067
3068         ENTRY;
3069         mutex_lock(&ldlm_ref_mutex);
3070         if (++ldlm_refcount == 1) {
3071                 rc = ldlm_setup();
3072                 if (rc)
3073                         ldlm_refcount--;
3074         }
3075         mutex_unlock(&ldlm_ref_mutex);
3076
3077         RETURN(rc);
3078 }
3079
3080 void ldlm_put_ref(void)
3081 {
3082         ENTRY;
3083         mutex_lock(&ldlm_ref_mutex);
3084         if (ldlm_refcount == 1) {
3085                 int rc = ldlm_cleanup();
3086
3087                 if (rc)
3088                         CERROR("ldlm_cleanup failed: %d\n", rc);
3089                 else
3090                         ldlm_refcount--;
3091         } else {
3092                 ldlm_refcount--;
3093         }
3094         mutex_unlock(&ldlm_ref_mutex);
3095
3096         EXIT;
3097 }
3098
3099 /*
3100  * Export handle<->lock hash operations.
3101  */
3102 static unsigned
3103 ldlm_export_lock_hash(struct cfs_hash *hs, const void *key, unsigned int mask)
3104 {
3105         return cfs_hash_u64_hash(((struct lustre_handle *)key)->cookie, mask);
3106 }
3107
3108 static void *
3109 ldlm_export_lock_key(struct hlist_node *hnode)
3110 {
3111         struct ldlm_lock *lock;
3112
3113         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3114         return &lock->l_remote_handle;
3115 }
3116
3117 static void
3118 ldlm_export_lock_keycpy(struct hlist_node *hnode, void *key)
3119 {
3120         struct ldlm_lock     *lock;
3121
3122         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3123         lock->l_remote_handle = *(struct lustre_handle *)key;
3124 }
3125
3126 static int
3127 ldlm_export_lock_keycmp(const void *key, struct hlist_node *hnode)
3128 {
3129         return lustre_handle_equal(ldlm_export_lock_key(hnode), key);
3130 }
3131
3132 static void *
3133 ldlm_export_lock_object(struct hlist_node *hnode)
3134 {
3135         return hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3136 }
3137
3138 static void
3139 ldlm_export_lock_get(struct cfs_hash *hs, struct hlist_node *hnode)
3140 {
3141         struct ldlm_lock *lock;
3142
3143         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3144         LDLM_LOCK_GET(lock);
3145 }
3146
3147 static void
3148 ldlm_export_lock_put(struct cfs_hash *hs, struct hlist_node *hnode)
3149 {
3150         struct ldlm_lock *lock;
3151
3152         lock = hlist_entry(hnode, struct ldlm_lock, l_exp_hash);
3153         LDLM_LOCK_RELEASE(lock);
3154 }
3155
3156 static struct cfs_hash_ops ldlm_export_lock_ops = {
3157         .hs_hash        = ldlm_export_lock_hash,
3158         .hs_key         = ldlm_export_lock_key,
3159         .hs_keycmp      = ldlm_export_lock_keycmp,
3160         .hs_keycpy      = ldlm_export_lock_keycpy,
3161         .hs_object      = ldlm_export_lock_object,
3162         .hs_get         = ldlm_export_lock_get,
3163         .hs_put         = ldlm_export_lock_put,
3164         .hs_put_locked  = ldlm_export_lock_put,
3165 };
3166
3167 int ldlm_init_export(struct obd_export *exp)
3168 {
3169         int rc;
3170
3171         ENTRY;
3172
3173         exp->exp_lock_hash =
3174                 cfs_hash_create(obd_uuid2str(&exp->exp_client_uuid),
3175                                 HASH_EXP_LOCK_CUR_BITS,
3176                                 HASH_EXP_LOCK_MAX_BITS,
3177                                 HASH_EXP_LOCK_BKT_BITS, 0,
3178                                 CFS_HASH_MIN_THETA, CFS_HASH_MAX_THETA,
3179                                 &ldlm_export_lock_ops,
3180                                 CFS_HASH_DEFAULT | CFS_HASH_REHASH_KEY |
3181                                 CFS_HASH_NBLK_CHANGE);
3182
3183         if (!exp->exp_lock_hash)
3184                 RETURN(-ENOMEM);
3185
3186         rc = ldlm_init_flock_export(exp);
3187         if (rc)
3188                 GOTO(err, rc);
3189
3190         RETURN(0);
3191 err:
3192         ldlm_destroy_export(exp);
3193         RETURN(rc);
3194 }
3195 EXPORT_SYMBOL(ldlm_init_export);
3196
3197 void ldlm_destroy_export(struct obd_export *exp)
3198 {
3199         ENTRY;
3200         cfs_hash_putref(exp->exp_lock_hash);
3201         exp->exp_lock_hash = NULL;
3202
3203         ldlm_destroy_flock_export(exp);
3204         EXIT;
3205 }
3206 EXPORT_SYMBOL(ldlm_destroy_export);
3207
3208 static ssize_t cancel_unused_locks_before_replay_show(struct kobject *kobj,
3209                                                       struct attribute *attr,
3210                                                       char *buf)
3211 {
3212         return sprintf(buf, "%d\n", ldlm_cancel_unused_locks_before_replay);
3213 }
3214
3215 static ssize_t cancel_unused_locks_before_replay_store(struct kobject *kobj,
3216                                                        struct attribute *attr,
3217                                                        const char *buffer,
3218                                                        size_t count)
3219 {
3220         int rc;
3221         unsigned long val;
3222
3223         rc = kstrtoul(buffer, 10, &val);
3224         if (rc)
3225                 return rc;
3226
3227         ldlm_cancel_unused_locks_before_replay = val;
3228
3229         return count;
3230 }
3231 LUSTRE_RW_ATTR(cancel_unused_locks_before_replay);
3232
3233 static struct attribute *ldlm_attrs[] = {
3234         &lustre_attr_cancel_unused_locks_before_replay.attr,
3235         NULL,
3236 };
3237
3238 static struct attribute_group ldlm_attr_group = {
3239         .attrs = ldlm_attrs,
3240 };
3241
3242 static int ldlm_setup(void)
3243 {
3244         static struct ptlrpc_service_conf       conf;
3245         struct ldlm_bl_pool                    *blp = NULL;
3246 #ifdef HAVE_SERVER_SUPPORT
3247         struct task_struct *task;
3248 #endif /* HAVE_SERVER_SUPPORT */
3249         int i;
3250         int rc = 0;
3251
3252         ENTRY;
3253
3254         if (ldlm_state != NULL)
3255                 RETURN(-EALREADY);
3256
3257         OBD_ALLOC(ldlm_state, sizeof(*ldlm_state));
3258         if (ldlm_state == NULL)
3259                 RETURN(-ENOMEM);
3260
3261         ldlm_kobj = kobject_create_and_add("ldlm", &lustre_kset->kobj);
3262         if (!ldlm_kobj)
3263                 GOTO(out, -ENOMEM);
3264
3265         rc = sysfs_create_group(ldlm_kobj, &ldlm_attr_group);
3266         if (rc)
3267                 GOTO(out, rc);
3268
3269         ldlm_ns_kset = kset_create_and_add("namespaces", NULL, ldlm_kobj);
3270         if (!ldlm_ns_kset)
3271                 GOTO(out, -ENOMEM);
3272
3273         ldlm_svc_kset = kset_create_and_add("services", NULL, ldlm_kobj);
3274         if (!ldlm_svc_kset)
3275                 GOTO(out, -ENOMEM);
3276
3277         rc = ldlm_debugfs_setup();
3278         if (rc != 0)
3279                 GOTO(out, rc);
3280
3281         memset(&conf, 0, sizeof(conf));
3282         conf = (typeof(conf)) {
3283                 .psc_name               = "ldlm_cbd",
3284                 .psc_watchdog_factor    = 2,
3285                 .psc_buf                = {
3286                         .bc_nbufs               = LDLM_CLIENT_NBUFS,
3287                         .bc_buf_size            = LDLM_BUFSIZE,
3288                         .bc_req_max_size        = LDLM_MAXREQSIZE,
3289                         .bc_rep_max_size        = LDLM_MAXREPSIZE,
3290                         .bc_req_portal          = LDLM_CB_REQUEST_PORTAL,
3291                         .bc_rep_portal          = LDLM_CB_REPLY_PORTAL,
3292                 },
3293                 .psc_thr                = {
3294                         .tc_thr_name            = "ldlm_cb",
3295                         .tc_thr_factor          = LDLM_THR_FACTOR,
3296                         .tc_nthrs_init          = LDLM_NTHRS_INIT,
3297                         .tc_nthrs_base          = LDLM_NTHRS_BASE,
3298                         .tc_nthrs_max           = LDLM_NTHRS_MAX,
3299                         .tc_nthrs_user          = ldlm_num_threads,
3300                         .tc_cpu_bind            = ldlm_cpu_bind,
3301                         .tc_ctx_tags            = LCT_MD_THREAD | LCT_DT_THREAD,
3302                 },
3303                 .psc_cpt                = {
3304                         .cc_pattern             = ldlm_cpts,
3305                         .cc_affinity            = true,
3306                 },
3307                 .psc_ops                = {
3308                         .so_req_handler         = ldlm_callback_handler,
3309                 },
3310         };
3311         ldlm_state->ldlm_cb_service = \
3312                         ptlrpc_register_service(&conf, ldlm_svc_kset,
3313                                                 ldlm_svc_debugfs_dir);
3314         if (IS_ERR(ldlm_state->ldlm_cb_service)) {
3315                 CERROR("failed to start service\n");
3316                 rc = PTR_ERR(ldlm_state->ldlm_cb_service);
3317                 ldlm_state->ldlm_cb_service = NULL;
3318                 GOTO(out, rc);
3319         }
3320
3321 #ifdef HAVE_SERVER_SUPPORT
3322         memset(&conf, 0, sizeof(conf));
3323         conf = (typeof(conf)) {
3324                 .psc_name               = "ldlm_canceld",
3325                 .psc_watchdog_factor    = 6,
3326                 .psc_buf                = {
3327                         .bc_nbufs               = LDLM_SERVER_NBUFS,
3328                         .bc_buf_size            = LDLM_BUFSIZE,
3329                         .bc_req_max_size        = LDLM_MAXREQSIZE,
3330                         .bc_rep_max_size        = LDLM_MAXREPSIZE,
3331                         .bc_req_portal          = LDLM_CANCEL_REQUEST_PORTAL,
3332                         .bc_rep_portal          = LDLM_CANCEL_REPLY_PORTAL,
3333
3334                 },
3335                 .psc_thr                = {
3336                         .tc_thr_name            = "ldlm_cn",
3337                         .tc_thr_factor          = LDLM_THR_FACTOR,
3338                         .tc_nthrs_init          = LDLM_NTHRS_INIT,
3339                         .tc_nthrs_base          = LDLM_NTHRS_BASE,
3340                         .tc_nthrs_max           = LDLM_NTHRS_MAX,
3341                         .tc_nthrs_user          = ldlm_num_threads,
3342                         .tc_cpu_bind            = ldlm_cpu_bind,
3343                         .tc_ctx_tags            = LCT_MD_THREAD | \
3344                                                   LCT_DT_THREAD | \
3345                                                   LCT_CL_THREAD,
3346                 },
3347                 .psc_cpt                = {
3348                         .cc_pattern             = ldlm_cpts,
3349                         .cc_affinity            = true,
3350                 },
3351                 .psc_ops                = {
3352                         .so_req_handler         = ldlm_cancel_handler,
3353                         .so_hpreq_handler       = ldlm_hpreq_handler,
3354                 },
3355         };
3356         ldlm_state->ldlm_cancel_service = \
3357                         ptlrpc_register_service(&conf, ldlm_svc_kset,
3358                                                 ldlm_svc_debugfs_dir);
3359         if (IS_ERR(ldlm_state->ldlm_cancel_service)) {
3360                 CERROR("failed to start service\n");
3361                 rc = PTR_ERR(ldlm_state->ldlm_cancel_service);
3362                 ldlm_state->ldlm_cancel_service = NULL;
3363                 GOTO(out, rc);
3364         }
3365 #endif /* HAVE_SERVER_SUPPORT */
3366
3367         OBD_ALLOC(blp, sizeof(*blp));
3368         if (blp == NULL)
3369                 GOTO(out, rc = -ENOMEM);
3370         ldlm_state->ldlm_bl_pool = blp;
3371
3372         spin_lock_init(&blp->blp_lock);
3373         INIT_LIST_HEAD(&blp->blp_list);
3374         INIT_LIST_HEAD(&blp->blp_prio_list);
3375         init_waitqueue_head(&blp->blp_waitq);
3376         atomic_set(&blp->blp_num_threads, 0);
3377         atomic_set(&blp->blp_busy_threads, 0);
3378         blp->blp_total_locks = 0;
3379         blp->blp_total_blwis = 0;
3380
3381         if (ldlm_num_threads == 0) {
3382                 blp->blp_min_threads = LDLM_NTHRS_INIT;
3383                 blp->blp_max_threads = LDLM_NTHRS_MAX;
3384         } else {
3385                 blp->blp_min_threads = blp->blp_max_threads = \
3386                         min_t(int, LDLM_NTHRS_MAX, max_t(int, LDLM_NTHRS_INIT,
3387                                                          ldlm_num_threads));
3388         }
3389
3390         for (i = 0; i < blp->blp_min_threads; i++) {
3391                 rc = ldlm_bl_thread_start(blp, false);
3392                 if (rc < 0)
3393                         GOTO(out, rc);
3394         }
3395
3396 #ifdef HAVE_SERVER_SUPPORT
3397         task = kthread_run(expired_lock_main, NULL, "ldlm_elt");
3398         if (IS_ERR(task)) {
3399                 rc = PTR_ERR(task);
3400                 CERROR("Cannot start ldlm expired-lock thread: %d\n", rc);
3401                 GOTO(out, rc);
3402         }
3403
3404         wait_event(expired_lock_wait_queue,
3405                    expired_lock_thread_state == ELT_READY);
3406 #endif /* HAVE_SERVER_SUPPORT */
3407
3408         rc = ldlm_pools_init();
3409         if (rc) {
3410                 CERROR("Failed to initialize LDLM pools: %d\n", rc);
3411                 GOTO(out, rc);
3412         }
3413
3414         rc = ldlm_reclaim_setup();
3415         if (rc) {
3416                 CERROR("Failed to setup reclaim thread: rc = %d\n", rc);
3417                 GOTO(out, rc);
3418         }
3419         RETURN(0);
3420
3421  out:
3422         ldlm_cleanup();
3423         RETURN(rc);
3424 }
3425
3426 static int ldlm_cleanup(void)
3427 {
3428         ENTRY;
3429
3430         if (!list_empty(ldlm_namespace_list(LDLM_NAMESPACE_SERVER)) ||
3431             !list_empty(ldlm_namespace_list(LDLM_NAMESPACE_CLIENT))) {
3432                 CERROR("ldlm still has namespaces; clean these up first.\n");
3433                 ldlm_dump_all_namespaces(LDLM_NAMESPACE_SERVER, D_DLMTRACE);
3434                 ldlm_dump_all_namespaces(LDLM_NAMESPACE_CLIENT, D_DLMTRACE);
3435                 RETURN(-EBUSY);
3436         }
3437
3438         ldlm_reclaim_cleanup();
3439         ldlm_pools_fini();
3440
3441         if (ldlm_state->ldlm_bl_pool != NULL) {
3442                 struct ldlm_bl_pool *blp = ldlm_state->ldlm_bl_pool;
3443
3444                 while (atomic_read(&blp->blp_num_threads) > 0) {
3445                         struct ldlm_bl_work_item blwi = { .blwi_ns = NULL };
3446
3447                         init_completion(&blp->blp_comp);
3448
3449                         spin_lock(&blp->blp_lock);
3450                         list_add_tail(&blwi.blwi_entry, &blp->blp_list);
3451                         wake_up(&blp->blp_waitq);
3452                         spin_unlock(&blp->blp_lock);
3453
3454                         wait_for_completion(&blp->blp_comp);
3455                 }
3456
3457                 OBD_FREE(blp, sizeof(*blp));
3458         }
3459
3460         if (ldlm_state->ldlm_cb_service != NULL)
3461                 ptlrpc_unregister_service(ldlm_state->ldlm_cb_service);
3462 #ifdef HAVE_SERVER_SUPPORT
3463         if (ldlm_state->ldlm_cancel_service != NULL)
3464                 ptlrpc_unregister_service(ldlm_state->ldlm_cancel_service);
3465 #endif
3466
3467         if (ldlm_ns_kset)
3468                 kset_unregister(ldlm_ns_kset);
3469         if (ldlm_svc_kset)
3470                 kset_unregister(ldlm_svc_kset);
3471         if (ldlm_kobj) {
3472                 sysfs_remove_group(ldlm_kobj, &ldlm_attr_group);
3473                 kobject_put(ldlm_kobj);
3474         }
3475
3476         ldlm_debugfs_cleanup();
3477
3478 #ifdef HAVE_SERVER_SUPPORT
3479         if (expired_lock_thread_state != ELT_STOPPED) {
3480                 expired_lock_thread_state = ELT_TERMINATE;
3481                 wake_up(&expired_lock_wait_queue);
3482                 wait_event(expired_lock_wait_queue,
3483                            expired_lock_thread_state == ELT_STOPPED);
3484         }
3485 #endif
3486
3487         OBD_FREE(ldlm_state, sizeof(*ldlm_state));
3488         ldlm_state = NULL;
3489
3490         RETURN(0);
3491 }
3492
3493 int ldlm_init(void)
3494 {
3495         ldlm_resource_slab = kmem_cache_create("ldlm_resources",
3496                                                sizeof(struct ldlm_resource), 0,
3497                                                SLAB_HWCACHE_ALIGN, NULL);
3498         if (ldlm_resource_slab == NULL)
3499                 return -ENOMEM;
3500
3501         ldlm_lock_slab = kmem_cache_create("ldlm_locks",
3502                               sizeof(struct ldlm_lock), 0,
3503                               SLAB_HWCACHE_ALIGN, NULL);
3504         if (ldlm_lock_slab == NULL)
3505                 goto out_resource;
3506
3507         ldlm_interval_slab = kmem_cache_create("interval_node",
3508                                         sizeof(struct ldlm_interval),
3509                                         0, SLAB_HWCACHE_ALIGN, NULL);
3510         if (ldlm_interval_slab == NULL)
3511                 goto out_lock;
3512
3513         ldlm_interval_tree_slab = kmem_cache_create("interval_tree",
3514                         sizeof(struct ldlm_interval_tree) * LCK_MODE_NUM,
3515                         0, SLAB_HWCACHE_ALIGN, NULL);
3516         if (ldlm_interval_tree_slab == NULL)
3517                 goto out_interval;
3518
3519 #ifdef HAVE_SERVER_SUPPORT
3520         ldlm_inodebits_slab = kmem_cache_create("ldlm_ibits_node",
3521                                                 sizeof(struct ldlm_ibits_node),
3522                                                 0, SLAB_HWCACHE_ALIGN, NULL);
3523         if (ldlm_inodebits_slab == NULL)
3524                 goto out_interval_tree;
3525
3526         ldlm_glimpse_work_kmem = kmem_cache_create("ldlm_glimpse_work_kmem",
3527                                         sizeof(struct ldlm_glimpse_work),
3528                                         0, 0, NULL);
3529         if (ldlm_glimpse_work_kmem == NULL)
3530                 goto out_inodebits;
3531 #endif
3532
3533 #if LUSTRE_TRACKS_LOCK_EXP_REFS
3534         class_export_dump_hook = ldlm_dump_export_locks;
3535 #endif
3536         return 0;
3537 #ifdef HAVE_SERVER_SUPPORT
3538 out_inodebits:
3539         kmem_cache_destroy(ldlm_inodebits_slab);
3540 out_interval_tree:
3541         kmem_cache_destroy(ldlm_interval_tree_slab);
3542 #endif
3543 out_interval:
3544         kmem_cache_destroy(ldlm_interval_slab);
3545 out_lock:
3546         kmem_cache_destroy(ldlm_lock_slab);
3547 out_resource:
3548         kmem_cache_destroy(ldlm_resource_slab);
3549
3550         return -ENOMEM;
3551 }
3552
3553 void ldlm_exit(void)
3554 {
3555         if (ldlm_refcount)
3556                 CERROR("ldlm_refcount is %d in ldlm_exit!\n", ldlm_refcount);
3557         synchronize_rcu();
3558         kmem_cache_destroy(ldlm_resource_slab);
3559         /*
3560          * ldlm_lock_put() use RCU to call ldlm_lock_free, so need call
3561          * rcu_barrier() to wait all outstanding RCU callbacks to complete,
3562          * so that ldlm_lock_free() get a chance to be called.
3563          */
3564         rcu_barrier();
3565         kmem_cache_destroy(ldlm_lock_slab);
3566         kmem_cache_destroy(ldlm_interval_slab);
3567         kmem_cache_destroy(ldlm_interval_tree_slab);
3568 #ifdef HAVE_SERVER_SUPPORT
3569         kmem_cache_destroy(ldlm_inodebits_slab);
3570         kmem_cache_destroy(ldlm_glimpse_work_kmem);
3571 #endif
3572 }